uid |
---|
Dashboards_and_Low_Code_Apps_Logging |
The logging for Dashboards and Low-Code Apps is located in the folder C:\Skyline DataMiner\Logging\Web
. There are two distinct types of logging, each serving specific purposes:
-
Client metric logging (available from DataMiner 10.3.0 [CU14]/10.4.0 [CU2]/10.4.5 onwards)
This category of logging records various events occurring within the Web API. Depending on the configuration, different types of logs can be enabled or disabled:
-
Debug logging provides information about various actions taken when handling a request from a client. It captures details about connections, unexpected errors, etc.
-
Allowed operation logging is utilized to record information about requests permitted or blocked by the Web Application Firewall (WAF) of a shared dashboard. It offers insight into unexpectedly blocked calls. It also logs information about WAF rules that take a long time to execute.
Note
This type of logging is available from DataMiner 10.2.0/10.1.8 onwards.
Client metric logging is employed to record different performance and issue indicators of clients connecting to Dashboards and Low-Code Apps. These logs encompass everything from unexpected errors to the load time of a dashboard or low-code app page. This logging data is stored in the client
subfolder of the web logs.
Note
This type of logging is available from DataMiner 10.3.0 [CU14]/10.4.0 [CU2]/10.4.5 onwards.
Both types of logging can be configured through a shared configuration file named log.conf
, located in the root folder of the web logs. This file comprises various customizable settings:
Setting name | Setting type | Default value | Description |
---|---|---|---|
EnableDebugLogging | Boolean | false | Enables or disables the logging of debug information. |
EnableAllowedOperationLogging | Boolean | false | Enables or disables the logging of WAF information. |
EnableClientMetricLogging | Boolean | true | Enables or disables the client metric logging (available from DataMiner 10.3.0 [CU14]/10.4.0 [CU2]/10.4.5 onwards). |
MaxFileSize | Number | 3145728 (3 MB) | The maximum size of a single log file. |
FilesToKeep | Number | 14 | The number of files to keep for each type of log. |
RollingInterval | String | Day | The time period included in each log file. |
AsyncBufferSize | Number | 10000 | The size of the buffer of the worker writing the log file to disk. |
BlockWhenAsyncBufferIsFull | Boolean | false | If true, the logger will wait until there is room in the buffer; otherwise, log entries will be dropped when the buffer is full. |
HealthCheckInterval | Number | 2500 | The number of log entries before a health check of the logger is performed. |
FlushToDiskInterval | Timespan | 00:00:01 | The time span between the log being written to memory and the result being flushed to disk. |
Filename | String | web.log | The file name of the Web API log files. |
ClientMetricFilename | String | web.clientmetric.log | The file name of the client metric log files. |
Note
- Before DataMiner 10.1.12/10.2.0, the config file is named
SLWAF.conf
. - Before DataMiner 10.3.0 [CU13]/10.4.0 [CU1]/10.4.4, the default value for the MaxFileSize setting is 52428800 (50 MB).