IBM Content Navigator, Version 2.0.3         

Configuring logging

IBM® Content Navigator server logging captures information about IBM Content Navigator. Server logging also captures information about the transactions between IBM Content Navigator and your repositories.

About this task

You enable and set the level of IBM Content Navigator server logging by using the IBM Content Navigator administration tool. Logging information is written to the IBM WebSphere® Application Server SystemOut.log file or the Oracle WebLogic Server AdminServer.log, access.log, and domain_name.log files.

Procedure

To enable the IBM Content Navigator server logging level:

  1. In the Settings tab in the administration tool, in the Logging subtab, set the level of logging information to write to the server log file:
    Logging level Description
    No logging This setting disables IBM Content Navigator server logging.
    Error

    This setting records information about unfulfilled requests and internal errors.

    Error-level logging can provide information that the program encountered unrecoverable errors and must stop operating immediately, or that the program encountered recoverable errors but can continue operating.

    Warning Warning-level logging is the default setting.

    This setting records all error messages, actions that the system administrator must take, and information about system conditions, such as insufficient disk space.

    Warning message logging provides information that the program detected as a problem but could continue operating normally.

    Information

    This setting records all warning messages and significant event messages, such as successful connection to the server.

    Debug

    This setting records diagnostic information from the server.

    Debug-level logging provides parameters, return data information, and output information that is used to debug errors.

    Important: Do not enable debug logging in a production environment. It can negatively affect system performance and it enables users to view server messages in the web client.
    You can set debug logging to a particular user, set of users, host computer, or set of host computers by specifying those users or hosts in the debug logging settings.
    Tip: If you know that a problem does not occur for a specific Java class or package, you can exclude classes or packages from your log. Similarly, if you want to enable logging for only a subset of packages or classes, you can specify particular packages or classes to include in your log file.
  2. If you know that a problem occurs for a specific client host machine or users, target your debug logging. To target your debug logging to a client host machine or users, enter the Client host machine (IP address) or Users in the IBM Content Navigator administration view under the logging tab.
    Important: If you specify a client host machine or user, this setting overrides any other logging settings. After you capture the information that you need, set this option to None to resume standard logging for your environment.
    Restriction: Start of changeThe task manager component does not support debug logging for specific client machines or users.End of change
  3. IBM Content Manager users only.If you are using a IBM Content Manager system, modify the cmblogconfig.properties file to enable or modify IBM Content Manager API logging. Typically, the IBM Content Manager INI files are in the navigator.war/WEB-INF/classes/connectors directory. However, in IBM Content Navigator the cmblogconfig.properties file is in the navigator.war/WEB-INF/classes/cmgmt/connectors directory.
  4. Restart the IBM Content Navigator server for the logging changes to take effect.