Modifying the logging configuration file for the IBM Content Manager connectors

The configuration file is installed in the cmgmt directory of the IBM Content Manager working directory. The file is named cmblogconfig.properties.

About this task

The cmblogconfig.properties file contains the following default settings. Do not change these default settings in case the configuration file cannot be found or errors with user-defined settings occur:
  • Log4j is set as the default log manager. The default log file name is user ID.dklog.log. The default location of the log file is IBMCMWorkingDirectory/log/connectors.
  • The dklog.log file is placed in the current working directory where an application enabled for IBM Content Manager is run.
  • The logging priority is set to Error.
  • The maximum number of exceptions of the same error message ID to allow is five (5).

To update the settings in the cmblogconfig.properties file:

Procedure

  1. Open the cmblogconfig.properties file in a text editor.
  2. Change the settings as required to meet your system logging requirements.
    Option Description
    Section 0 - Global Settings Determines maximum exception count.
    Section 1 - Log Manager Factory Setting Determines whether you use the default log manager or log4j.
    Section 2 - Default Log Manager Setup Section 2 has three subsections:
    • Section 2.1 - Specify Log Priority. Eight priority settings are available. The default priority setting is Error.
    • Section 2.2 - Log Output Destination Setting. Three settings are available:
      1. Log to a file
      2. Log to Standard Error
      3. Log to Standard Console
      The default setting is Log to file.
    • Section 2.3 - Log File Name Setting. Use only when the option in section 2.2 is set to Log to file.

      The default log file name is user ID.dklog.log.

      The default location of the log file is IBMCMWorkingDirectory/log/connectors.

      If any backslashes are used, the log file path must include double backslash (\\) or single slash (/) characters in place of the single backslashes. If you do not specify a path, the log is always located in the current working directory where the application is executed.
      The log file location is controlled by the following settings:
      • DKLogOutputFileName for default logger (Java™)
      • Log4j.appender.apiAppender.File for log4j

      The maximum number of backup files to keep by setting DKLogOutputFileSave for default logger (Java) or log4j.appender.apiAppender.MaxBackupIndex for log4j.

      The maximum file size by setting DKLogOutputFileSize for default logger (Java) or log4j.appender.apiAppender.MaxFileSize for log4j.
  3. Optional: Modify the following priority levels in cmblogconfig.properties file.
    Option Description
    DISABLE Disables logging.
    FATAL Notification that the program encountered unrecoverable errors and must cease operating immediately. Stopping the program is not initiated by the logging facility.
    ERROR Notification that the program encountered recoverable or unrecoverable errors, but is able to continue operating.
    PERF Collects output information for measuring performance.
    INFO Provides significant event messages, such as successful logon.
    TRACE_NATIVE_API Logs parameters and return data information before and after a native call.
    TRACE_ENTRY_EXIT Signals entries and exits of program modules (or code blocks).
    TRACE Records additional diagnostic information, such as program state changes, function parameter information, and function return value information.
    DEBUG Displays information for debugging errors.
  4. Save the file.