Logging Options

Logging options apply to most CSM logs, such as the Cherwell® Service Host, Cherwell Application Server, and the Cherwell REST API. Users can create custom logs from the CSM Desktop Client, as well. For each CSM log, you can choose to log to the event log, to a file, or to Splunk.

From the Logging Options window, select one of the following log locations:

  • Select Log to event log to log CSM events to the Windows Event Viewer. Then, the log level:
    • Debug and above: Very verbose messages. This level is space and resource intensive.

      For best results, log debug messages (Debug and above) to a file or to Splunk, and NOT to an event log. CSM logs numerous debug messages, so a log would be slow and might require more resources.

    • Stats and above: Detailed messages that track performance.
    • Info and above: Informational messages that can be used to diagnose a problem.
    • Warning and above: Warning messages that occurred.
    • Error and above: Errors that were encountered.
    • Fatal only: Errors that caused the service or process to stop.

    In the Windows Event Viewer, CSM events are visible under Applications and Services Logs > CSM - Cherwell Service Management.

  • Select Log to file to write the logs to a specific location and file for the selected service. Then, set your file limits.
    • Log Level: Select a log level.
    • File Name: Select the ellipses button to select a location and file name for the log file. When you configure log files:
      • For the Browser Client and CSM Portal, the logging path is automatically modified using the application name. For example, if the user chooses the file path c:/logs/logs.log, the system will use c:/logs/{application name}/logs.log.
      • For the Cherwell Service Host, specify a file location and name.
      • For the Cherwell Service Host microservices, you only need to specify a file location. A log file is automatically created for each microservice leader and worker.
      • For the Cherwell Web API (Cherwell REST API), which is required for CSM authentication, the recommended setting is to log warnings and above to the Windows Event Viewer and debug and above to a specified file location.
    • By default, the file size is set to 10 MB, but can be changed by entering a new value in the File Size Limit field.
    • File Count Limit: Rolling event logs are used, so that when the maximum file size is reached for a log file, a new file is created. By default, the number of files is set to 20 (but can be changed), after which the oldest log file is overwritten by continued logging.
  • Select Log to Splunk to write the logs to a Splunk server, and then configure Splunk logging.