Modify the Compass core log properties in tslogger.properties

This topic describes the Compass core log properties that you can modify in the tslogger.properties file.

When Compass is installed, a log properties file, tslogger.properties, is created in the following location:
On Windows™:
install-dir\HCL\Compass\config\log\cqcore\
On the UNIX™ system and Linux™:
/opt/hcl/compass/config/log/cqcore

The tslogger.properties file contains default property settings for the Compass error and message log files. The error log file always contains fatal errors and errors. By default, the message log file contains all the errors in the error log file plus warning messages. You can change the log-level setting for the message log file to include informational messages as well by modifying the corresponding property in tslogger.properties. Modifiable log properties in the tslogger.properties file describes all the log properties that you can modify in tslogger.properties. Modification of any other properties in this file is not supported.

Table 1. Modifiable log properties in the tslogger.properties file
Property Description
logger.dc.logging Enable or disable logging.
Valid values are:
  • on
  • off

Default: on
logger.dc.msg.level Log level for writing messages to the message log file.
Valid values are:
  • WARNING

    Writes warning messages to the message log file as well as fatal errors and errors.

  • INFO

    Writes informational and warning messages to the message log file as well as fatal errors and errors.

Default: WARNING
handler.file.maxFileBytes Maximum size of the error log or message log file, in bytes. When a log file reaches the maximum file size, messages are written to a new log file.

Default:20480000
handler.file.maxFiles Maximum number of log files that are written to the file system before the log files are overwritten in sequential order. Log-file names are reused after reaching this maximum.

Default: 20
handler.file.dc.err.fileName File-name prefix or full path name, including the file-name prefix, for the error log file.

If the file-name prefix only is specified, for example, handler.file.dc.err.fileName=SystemErr, then the error log file is created in the default log directory using the specified prefix and following this format: SystemErryear_time_pid.log. For example, SystemErr20080530_074357_4528.log.

If the full path name including the file-name prefix are specified, for example, handler.file.dc.err.fileName=/tmp/SystemErr, then the error log file is created in the specified directory using the specified prefix. For example, /tmp/SystemErr20080530_074357_4528.log.

Default: SystemErr

handler.file.dc.msg.fileName

 File-name prefix or full path name, including the file-name prefix, for the message log file.

If the file-name prefix only is specified, for example, handler.file.dc.msg.fileName=SystemOut, then the message log file is created in the default log directory using the specified prefix and following this format: SystemOutyear_time_pid.log. For example, SystemOut20080530_074357_4528.log.

If the full path name including the file-name prefix are specified, for example, handler.file.dc.msg.fileName=/tmp/SystemOut, then the message log file is created in the specified directory using the specified prefix. For example, /tmp/SystemOut20080530_074357_4528.log.

Default: SystemOut