Skip to main content

Logging Configuration

The Logging.config file contains settings related to logging and tracing, on both the CDM Client and Server.

To open the location for the client application:

  1. Start CDM.
  2. Open Windows Task Manager.
  3. In the Processes tab, right-click the Ibm.CognosDM.exe *32 process and click Open File Location.

Make sure you read the following important notes:

  • Make a backup of the configuration file before making a change.
  • The XML-based settings must not contain xml validation errors, otherwise the logging will stop.
  • Changes to the logging levels in the Logging.config file can have an effect on performance.
  • The name Logging.config must not change.
  • For the server, the log files generated by CDM are Application.log, Performance.log, and Refresh.log.
  • For the client, the log files are AllErrors.log, Application.log, and Trace.log.

File Structure

The Logging.config file that controls the output to the generated log files has the following structure (the logging module is based on the log4net logging framework):

<root> <level value="INFO" /> <appender-ref ref="AllErrorsLog" /> </root> <logger name="Ibm.CognosDM"> <level value="ALL" /> <appender-ref ref="ApplicationLog" /> </logger> <!--appender--> <appender name="AllErrorsLog" type="log4net.Appender.RollingFileAppender"> <appender name="ApplicationLog" type="log4net.Appender.RollingFileAppender">

An appender is an output destination for a log file. In the example structure two appenders are shown: one that logs only the errors in the application, another that logs everything. Appenders should only be defined, created or changed when necessary.

The root node defines a reference to one appender. The logger node contains a reference to the second appender. You can group multiple appenders together, and specify a logging level for the group. The logging level filters the logging output. The logging module is based on the log4net logging framework.

Available Settings

The following table lists the configuration settings available in Logging.config, along with a description and possible values that you may assign. Never edit settings that are not included in this table.

Key

Description

Value for the Client

Value for the Server

<level value="INFO" />

The logging level for the appenders group.

ALL, OFF, INFO, WARNING, ERROR, DEBUG

INFO, WARNING, ERROR, DEBUG

<file value="LogFiles\AllErrors"/>

The location of the log file.

Path and file name

Path and file name

<datePattern value=".yyMMdd.'log'"/>

The date format.

yyMMdd, ddMMyy, MMddyy

yyMMdd, ddMMyy, MMddyy

<appendToFile value="true" />

Enables and disables the output of the appender.

true/false

true/false

<levelMin value="INFO" />

The minimum logging level for the appender.

ALL, OFF, INFO, WARNING, ERROR, DEBUG

INFO, WARNING, ERROR, DEBUG

<levelMax value="OFF" />

The maximum logging level for the appender.

ALL, OFF, INFO, WARNING, ERROR, DEBUG

INFO, WARNING, ERROR, >DEBUG

Note: If both levelMin and levelMax are set to OFF, the appender is disabled and no output will be present in the log file.

Was this article helpful?

We're sorry to hear that.