Logging

Log Levels

TurboPlayer service includes a configurable logging mechanism that controls the level of detail recorded in logs. The following log levels are supported:


Critical	Logs only the most essential system events. Does not include errors or warnings.
Error	Includes Critical messages. Logs all error events that indicate system failures.
Warning	Includes Error and Critical messages. Adds warnings that may signal potential issues.
Information	Includes Warning, Error, and Critical messages. Adds detailed operational logs such as API calls and system activity. Warning: May generate large logs and impact performance. Use when full visibility is needed.
Debug	Includes Information, Warning, Error, and Critical messages. Adds highly detailed diagnostic logs for troubleshooting. Warning Can produce very large logs and significantly affect performance. Enable only when requested by support.

Logging Architecture Overview

The system uses two parallel logging mechanisms:

DPE Log Service
Local File Log (file-based logging)

These two systems operate in tandem, with distinct roles and fallback behavior depending on the log level and system availability.

1. DPE Log Service

Purpose: Stores only high-priority logs to minimize data volume in the DPE log system.

Accepted log levels	Not supported log levels
`Critical` `Error` `Warning`	`Information` `Debug` (excluded due to excessive volume)

Behavior:
- If the DPE Log Service is available, supported log levels (Critical, Error, Warning) are sent directly to it.
- If the DPE Log Service is unavailable, these logs are temporarily stored in the local file log and automatically transferred to DPE once the service becomes available again.
- If the DPE log functionality is explicitly disabled (via the UseDPELog parameter), logs will only be written to the local file log.

2. Local File Log

Purpose: Full local logging for diagnostics, always enabled.

Accepted log levels	Not supported log levels
`Critical` `Error` `Warning` `Information` `Debug`	n/a

Behavior:
- Always captures all log levels, including Debug.
- Used as a fallback when the DPE Log Service is unavailable or disabled.
- All Debug level logs are written only to the local file log, regardless of DPE availability.

TurboPlayer Service Logging Overview

Log Level	DPE Log Service	File Log
Critical	Yes	Always
Error	Yes	Always
Warning	Yes	Always
Information	No	Always
Debug	No	Always

Additional Notes

The DPE Log Service can be seen as an optional feature, intended for collecting high-priority log entries.
The File Log acts as the primary and reliable log destination, ensuring no loss of data, even if DPE is unavailable or not configured.
Enabling DPE does not disable the file log; both systems operate simultaneously according to the rules above.

For configuration, refer to: DigaSystem registry subkeys and parameters – TurboPlayerService ConfigurationName

log4net.config

this file contains configuration for the file-based logger. File-based logger is used if the log service isn't available or specified log level creates too much log information. File logger has various parameters and can be strong customized.

This file contains configuration for the file log. By default, file logs will be created in the subdirectory "log\ServiceConfigurationName", split per 50 MB size files and formatted as "YYYY-MM-DD HH:MM:SS.sss LogLevel Message". E.g.

CODE

2022-04-14 12:18:58.144 INFO Application started

Hint. By the first installation rename the file template_log4net.config to log4net.config This file contains a typical configuration for file log and can be used without changes in mostly standard workflows even with multiple service configurations workflows or can be used as a start point to optimize file log for custom workflows

log4net.config requirements

Service use the log4net.config as a template to create separated file logs for every configuration. All file logs are created under the main log directory in subdirectories with the configuration names. All parameters in configuration file can be changed except followed

logger with name "DefaultLogger" must be present in configuration file. Service use this logger as a template to create separated loggers for every configuration
appender with name "DefaultAppender" must be present in configuration file. Service use this appender as a template to create separated appenders for every configuration
- Parameter “file” in appender section must be located to the main log directory. Service create subdirectories for all used configurations in this directory

See here information about configuration files
https://logging.apache.org/log4net/release/manual/configuration.html

See here configuration file examples
https://logging.apache.org/log4net/release/config-examples.html