Configuring logs for BMC Helix Digital Workplace
To configure logging from the BMC Helix Digital Workplace Admin console
The BMC Helix Digital Workplace administrator can set the log level directly from the BMC Helix Digital Workplace Admin console.
- In the BMC Helix Digital Workplace Admin console, go to Configuration > Logging.
- Select the Override the log config file settings check box.
- In the Log Level list, select an appropriate log level.
The log level is changed on all nodes.
To configure self-managing logs
The dwp.timeStamp.part.n.log.gz logs are self-managing based on the settings defined in the dwp-tomcat docker image.
In the dwp-tomcat docker image, modify the following settings:
Setting
Default value
Description
PROJECT_NAME
dwp
The prefix of the log file name.
DWP_LOG_MAX_AGE
7
The number of days for which the logging history is kept.
DWP_LOG_MAX_SIZE
100 MB
The maximum disk capacity for storing the archived logs.
DWP_LOG_CONSOLE_OUTPUT_ENABLED
true
The setting defines if the logs are directed to the standard output and error streams that adhere to The twelve-factor app methodology .
LOG_FILE_SIZE
20 MB
The maximum log file size.
When the maximum defined log file size is reached, a new log file is created, and the n counter in the log file name is incremented to n+1.
LOG_FILES_LOCATION
${catalina.base}/logs/
The location path for storing the logs. The users subfolder is used if a user-specific logging is enabled.
Log files retention
When the maximum defined log file size (LOG_FILE_SIZE) is reached, a rollover is triggered, and a new log file is created. The n counter in the log file name is incremented to n+1. The original file is compressed by the by gzip algorithm and moved to the archive folder. The archived logs are kept for the period of time that is defined by DWP_LOG_MAX_AGE. Any files older than the maximum age are removed automatically. When the disk capacity for storing the archived logs is reached (DWP_LOG_MAX_SIZE), the oldest file or files are removed automatically. You can customize the DWP_LOG_MAX_AGE and DWP_LOG_MAX_SIZE settings to expand the disk capacity and the duration for retaining log files.