Logging - Revision history

NNE at 07:49, 1 September 2022

2022-09-01T07:49:09Z

NNE at 07:47, 1 September 2022

2022-09-01T07:47:55Z

NNE at 09:48, 16 November 2020

2020-11-16T09:48:56Z

NNE at 09:45, 16 November 2020

2020-11-16T09:45:24Z

NNE at 09:43, 16 November 2020

2020-11-16T09:43:55Z

KNO at 18:36, 11 May 2015

2015-05-11T18:36:02Z

KNO at 18:30, 11 May 2015

2015-05-11T18:30:02Z

KNO at 18:29, 11 May 2015

2015-05-11T18:29:48Z

KNO: Created page with "Internal, system driven events of different types (debug messages, errors, warnings, etc.) occuring within in {{UBIK}} are recorded by a logging mechanism. This information su..."

2015-05-11T18:25:23Z

Created page with "Internal, system driven events of different types (debug messages, errors, warnings, etc.) occuring within in {{UBIK}} are recorded by a logging mechanism. This information su..."

New page

Internal, system driven events of different types (debug messages, errors, warnings, etc.) occuring within in {{UBIK}} are recorded by a logging mechanism. This information supports the user in finding issues in the design process or to identify the reasons for problems at runtime. The mechanisms can be configured for the [[Web Service]], the {{UBIK Studio}} as well as for the {{UBIK Enterprise Service}}. A general description of the technique used can be found on the Microsoft page for [http://msdn.microsoft.com/en-us/library/ms733830%28v=vs.110%29.aspx Configuring Services].

Since {{Version/Server|2.4.3}} the configuration has to be done in the [[Configuration_Files/Logging.config|Logging.config]] file. For older versions the configuration has to be done in one of the main [[[[Configuration_Files|configuration files]].

==Logging categories==
{{UBIK}} has different types of categories configured for the logging mechanism. The following categories can be configured in the configuration files. Categories with the remark '''internal''' are available via customizing code, but are used to log internal events. As it is not recommended to mix logging of internal events together with others, the two additional categories '''CUSTOMIZING''' and '''WORKFLOW''' have been created.

{| class="wikitable" | width = "88%"

|-
! Type!! Description!! Access
|-
| CUSTOMIZING || Log for events that occured in the customizing. This method is available by calling <code>UBIKKernel.LogCustomizing(...)</code> from the customizing code. || public
|-
| WORKFLOW || Log for events that occured when running workflows which is provided by the [[WriteLogEntry_(Activity)|WriteLogEntry Activity]] || public
|-
| ASSERTION || Log for failed Assertions || internal
|-
| WARNING || Log for events that created a warning || internal
|-
| ERROR || Log for events that created an error || internal
|-
| DEBUG || Log for events that have to be investigated in the development || internal
|-
| SQL || Log for events related to SQL queries || internal
|-
| EXCEPTION || Log for events that caused an exception || internal
|-
|}

@@ Line 87: / Line 87: @@
 <!-- DO NOT REMOVE THIS -->{{Template:Activity/End}}<!-- DO NOT REMOVE THIS -->
 == Version 3.5 or erlier ==
@@ Line 125: / Line 121: @@
 |-
 |}
 == See also ==

@@ Line 1: / Line 1: @@
-Internal, system driven events of different types (debug messages, errors, warnings, etc.) occuring within in {{UBIK}} are recorded by a logging mechanism. This information supports the user in finding issues in the design process or to identify the reasons for problems at runtime. The mechanisms can be configured for the [[Web Service]], the {{UBIK Studio}} as well as for the {{UBIK Enterprise Service}}. A general description of the technique used can be found on the Microsoft page for [http://msdn.microsoft.com/en-us/library/ms733830%28v=vs.110%29.aspx Configuring Services].
+Internal, system-driven events of different types (debug messages, errors, warnings, etc.) occurring within {{UBIK}} are recorded by a logging mechanism. This information supports the user in finding issues in the design process or identifying the reasons for problems at runtime. The mechanisms can be configured for the [[Web Service]], the {{UBIK Studio}} as well as for the {{UBIK Enterprise Service}}. A general description of the technique used can be found on the Microsoft page for [http://msdn.microsoft.com/en-us/library/ms733830%28v=vs.110%29.aspx Configuring Services].
 == Version 3.6 ==
-* With Version 3.6 we Replaced our existing Microsoft.Practices.EnterpriseLibrary.Logging with more up-to-date solution like Serilog.
+* With Version 3.6 we Replaced our existing Microsoft.Practices.EnterpriseLibrary.Logging with more up-to-date solutions like Serilog.
 === What is Serilog ===
-Serilog is a portable and structured logging framework to record diagnostic logs into files, console and SQL/NoSQL databases.
+Serilog is a portable and structured logging framework to record diagnostic logs into files, consoles, and SQL/NoSQL databases.
 ===Serilog existing log event levels===
-*Log Levels taken from  the Serilog doku : https://github.com/serilog/serilog/wiki/Configuration-Basics
+*Log Levels are taken from  the Serilog doku : https://github.com/serilog/serilog/wiki/Configuration-Basics
 {| class="wikitable sortable" | width = "50%"
 |-
@@ Line 18: / Line 18: @@
 | Debug || Debug is used for internal system events that are not necessarily observable from the outside, but useful when determining how something happened. For example, the details of requests and responses made to and from external integration points would often be logged at this level.
 |- align="left"
-| Information  || Information events describe things happening in the system that correspond to its responsibilities and functions. Generally, these are the observable actions the system can perform. For example, processing a payment or updating a user's details will be logged at this level.
+| Information  || Information events describe things happening in the system that corresponds to its responsibilities and functions. Generally, these are the observable actions the system can perform. For example, processing a payment or updating a user's details will be logged at this level.
 |- align="left"
-| Warning || When service is degraded, endangered, or may be behaving outside of its expected parameters, Warning level events are used. A warning event should only be emitted when the condition is either transient or can be investigated and fixed - use restraint to avoid polluting the log with spurious warnings. For example, slow response times from a critical database would be logged as warnings.
+| Warning || When service is degraded, endangered or may be behaving outside of its expected parameters, Warning level events are used. A warning event should only be emitted when the condition is either transient or can be investigated and fixed - use restraint to avoid polluting the log with spurious warnings. For example, slow response times from a critical database would be logged as warnings.
 |- align="left"
-| Error  || When functionality is unavailable or expectations broken, an Error event is used. For example, receiving an exception when trying to commit a database transaction is an event at this level.
+| Error  || When functionality is unavailable or expectations are broken, an Error event is used. For example, receiving an exception when trying to commit a database transaction is an event at this level.
 |- align="left"
 | Fatal  ||  The most critical level, Fatal events demand immediate attention. For example, an application failing during startup will log a Fatal event. If you have a pager, it goes off when one of these occurs.
@@ Line 39: / Line 39: @@
 | LogInformation || Information || method for writing an information log message to the output log file logged as Information event level. (new)
 |- align="left"
-| LogSQLStatement  LogSQLCommand || Information || method for writing a sql log message to the output log file logged as Information event level.
+| LogSQLStatement  LogSQLCommand || Information || method for writing a SQL log message to the output log file logged as Information event level.
 |- align="left"
 | LogCustomizing || Information || method for writing a customizing log message to the output log file logged as Information event level.
@@ Line 61: / Line 61: @@
 === How To Configure Logging ===
-*Added a way for the User to configure the default log path, the file count limit, the log event level and rolling policies through Logger.config with changing only the “values”, which are set on their default.
+*Added a way for the User to configure the default log path, the file count limit, the log event level, and rolling policies through Logger.config with changing only the “values”, which are set on their default.
 **The default Log path is set to the installation directory of UBIK. Its value can be changed to any local path (e.g. value="C:\logs").
 **Using OS Environment Variables (e.g. value="%SYSTEMDRIVE%\logs") is possible.
 **Using Relative path's (e.g. value="..\logs" used for moving up in the hierarchy from the current directory) or (e.g. value=".\logs" represents the current directory itself) is possible.
-**The default for the event level is set to Debug and its values can be changed to Verbose, Information, Warning, Error or Fatal.
+**The default for the event level is set to Debug and its values can be changed to Verbose, Information, Warning, Error, or Fatal.
 *File default count limit is set to 31 and its values can be changed to any positive number.
-*The default Rolling policies is set to Day and its values can be changed to "Day", "Month" or "Year".
+*The default Rolling policies are set to Day and its values can be changed to "Day", "Month" or "Year".
 <source lang="xml">
@@ Line 73: / Line 73: @@
 <LoggingConfiguration>
    <add key="LogRootPath" value=""/>
-   <!-- Values can be "Verbose", "Debug", "Information", "Warning", "Error", "Fatal". Normally "Debug" should be fine and you should only change if you know well what you do. -->
+   <!-- Values can be "Verbose", "Debug", "Information", "Warning", "Error", "Fatal". Normally "Debug" should be fine and you should only change it if you know well what you do. -->
    <add key="LogLevel" value="Debug"/>
    <!-- The most recent 31 files are retained by default (i.e. one long month). If the value is empty the default will be applied. You must specifically set value="null" to remove this limit and all log files will be kept. You can set any other positive number -->
@@ Line 87: / Line 87: @@
 <!-- DO NOT REMOVE THIS -->{{Template:Activity/End}}<!-- DO NOT REMOVE THIS -->
+When creating UBIK.Studio in Windows, the right for the application packages is not available in the standard case and must be added manually.
 == Version 3.5 or erlier ==
@@ Line 99: / Line 101: @@
 ==Logging categories==
-{{UBIK}} has different types of categories configured for the logging mechanism. The following categories can be configured in the configuration files. Categories with the remark '''internal''' are available via customizing code, but are used to log internal events. As it is not recommended to mix logging of internal events together with others, the two additional categories '''CUSTOMIZING''' and '''WORKFLOW''' have been created.
+{{UBIK}} has different types of categories configured for the logging mechanism. The following categories can be configured in the configuration files. Categories with the remark '''internal''' are available via customizing code but are used to log internal events. As it is not recommended to mix logging of internal events together with others, the two additional categories '''CUSTOMIZING''' and '''WORKFLOW''' have been created.
 {| class="wikitable" | width = "88%"
@@ Line 106: / Line 108: @@
 ! Type!! Description!! Access
 |-
-| CUSTOMIZING ||  Log for events that occured in the customizing. This method is available by calling <code>UBIKKernel.LogCustomizing(...)</code> from the customizing code. || public
+| CUSTOMIZING ||  Log for events that occurred in the customizing. This method is available by calling <code>UBIKKernel.LogCustomizing(...)</code> from the customizing code. || public
 |-
-| WORKFLOW || Log for events that occured when running workflows which is provided by the [[WriteLogEntry_(Activity)|WriteLogEntry Activity]] || public
+| WORKFLOW || Log for events that occurred when running workflows which are provided by the [[WriteLogEntry_(Activity)|WriteLogEntry Activity]] || public
 |-
 | ASSERTION || Log for failed Assertions || internal

@@ Line 86: / Line 86: @@
 <!-- DO NOT REMOVE THIS -->{{Template:Activity/End}}<!-- DO NOT REMOVE THIS -->
@@ Line 96: / Line 93: @@
 Since {{Version/Server|2.4.3}} the configuration has to be done in the [[Configuration_Files/Logging.config|Logging.config]] file. For older versions the configuration has to be done in one of the main [[Configuration_Files|configuration files]].
 ==Logging categories==

@@ Line 1: / Line 1: @@
 Internal, system driven events of different types (debug messages, errors, warnings, etc.) occuring within in {{UBIK}} are recorded by a logging mechanism. This information supports the user in finding issues in the design process or to identify the reasons for problems at runtime. The mechanisms can be configured for the [[Web Service]], the {{UBIK Studio}} as well as for the {{UBIK Enterprise Service}}. A general description of the technique used can be found on the Microsoft page for [http://msdn.microsoft.com/en-us/library/ms733830%28v=vs.110%29.aspx Configuring Services].
-== Logging version 3.6 ==
+== Version 3.6 ==
 * With Version 3.6 we Replaced our existing Microsoft.Practices.EnterpriseLibrary.Logging with more up-to-date solution like Serilog.
@@ Line 93: / Line 93: @@
-== Logging version 3.5 or erlier ==
+== Version 3.5 or erlier ==
 Since {{Version/Server|2.4.3}} the configuration has to be done in the [[Configuration_Files/Logging.config|Logging.config]] file. For older versions the configuration has to be done in one of the main [[Configuration_Files|configuration files]].
@@ Line 130: / Line 130: @@
 {{Category/Version|3.6.0}}
 [[Category:Installing|Logging]]
 [[Category:Server|Logging]]
 [[Category:Web service|Logging]]

@@ Line 1: / Line 1: @@
 Internal, system driven events of different types (debug messages, errors, warnings, etc.) occuring within in {{UBIK}} are recorded by a logging mechanism. This information supports the user in finding issues in the design process or to identify the reasons for problems at runtime. The mechanisms can be configured for the [[Web Service]], the {{UBIK Studio}} as well as for the {{UBIK Enterprise Service}}. A general description of the technique used can be found on the Microsoft page for [http://msdn.microsoft.com/en-us/library/ms733830%28v=vs.110%29.aspx Configuring Services].
 Since {{Version/Server|2.4.3}} the configuration has to be done in the [[Configuration_Files/Logging.config|Logging.config]] file. For older versions the configuration has to be done in one of the main [[Configuration_Files|configuration files]].
@@ Line 32: / Line 126: @@
 * [[HowTo:Configure_Logging]]
 * [[Configuration_Files]]
-[[Category:Installing]]
+[[Category:Installing|Logging]]
-[[Category:Server]]
+[[Category:Server|Logging]]
-[[Category:Web service]]
+[[Category:Web service|Logging]]

← Older revision		Revision as of 18:30, 11 May 2015
Line 35:		Line 35:
	[[Category:Installing]]		[[Category:Installing]]
	[[Category:Server]]		[[Category:Server]]
		+	[[Category:Web service]]

← Older revision		Revision as of 18:29, 11 May 2015
Line 28:		Line 28:
	\|-		\|-
	\|}		\|}
		+
		+	== See also ==
		+	* [[HowTo:Configure_Logging]]
		+	* [[Configuration_Files]]
		+
		+	[[Category:Installing]]
		+	[[Category:Server]]