This documentation supports the 22.1 version of BMC Helix Digital Workplace Basic and BMC Helix Digital Workplace Advanced. Icons distinguish capabilities available only for the Advanced and External license levels. For more information, see License types and features.

Configuring logs for BMC Helix Digital Workplace

This topic describes how to configure logs for BMC Helix Digital Workplace. For information about the available logs, see Contents of the logs.

To enable logs for BMC Helix Digital Workplace Catalog, see  Enabling and downloading logs from BMC Helix Innovation Studio Open link .

  • When you enable logs for BMC Helix Digital Workplace Catalog, select the com.bmc.myservice.catalog bundle in Step 2.
  • You can change the default fileName in Step 3 and enter a custom name of the log file. 
 

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.

  1. In the BMC Helix Digital Workplace Admin console, go to Configuration > Logging.
  2. Select the Override the log config file settings check box.
  3. In the Log Level list, select an appropriate log level. 
    The log level is changed on all nodes.


Best practice

To troubleshoot a problem, we recommend that you set the log level to DEBUG. After troubleshooting a problem, set the log level to WARN. If you leave DEBUG enabled, you must monitor log growth and manage it accordingly.

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:

    SettingDefault valueDescription
    PROJECT_NAMEdwpThe prefix of the log file name.
    DWP_LOG_MAX_AGE7The number of days for which the logging history is kept.
    DWP_LOG_MAX_SIZE100 MBThe maximum disk capacity for storing the archived logs.
    DWP_LOG_CONSOLE_OUTPUT_ENABLEDtrue

    The setting defines if the logs are directed to the standard output and error streams that adhere to The twelve-factor app methodology Open link .

    LOG_FILE_SIZE20 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. 

Example

When the dwp.2014.12.31.part.0.log file reaches the maximum log file size, a rollover is triggered, and the dwp.2014.12.31.part.1.log file is created. The dwp.2014.12.31.part.0.log file is compressed by the zip algorithm and moved to the 2014-12-week5/ folder, and its name changes to dwp.2014.12.31.part0.log.gz. When the defined log retention period elapses, the dwp.2014.12.31.part0.log.gz file is automatically removed from the 2014-12-week5/ folder.

Was this page helpful? Yes No Submitting... Thank you

Comments