Setting up logging

Log messages are an important diagnostic tool for investigating the behavior of IBM® Cognos® Analytics.

Log messages, in addition to error messages, provide information about the status of components and a high-level view of important events. For example, log messages can provide information about attempts to start and stop services, completion of processing requests, and indicators for fatal errors. Audit logs, which are available from a logging database, provide information about user and report activity.

The IBM Cognos services on each computer send information about errors and events to a local log server. A local log server is installed in the install_location/logs folder on every IBM Cognos Analytics computer that contains Content Manager or Application Tier Components. Because the log server uses a different port from the other IBM Cognos Analytics components, it continues to process events even if other services on the local computer, such as the dispatcher, are disabled.

By default, log messages are saved to the cogaudit.log file located in the Cognos Analytics install_location\logs directory. The log messages can also be saved in a database. For more information, see the IBM Cognos Analytics Installation and Configuration Guide.

For information about the log service, see Dispatchers and Services.

Note: Interactive queries in dashboarding do not record the original dashboard name with each interactive change. The reason for this is that there is no guarantee that the saved object will not be saved as another name, thereby attributing the dashboard usage stats to the wrong dashboard.

The following workflow shows the tasks that are required to set up logging.

  • During planning, determine the logging configuration that is suitable for your environment.

    For example, evaluate various log message repositories, such as remote log servers and log files, such as the UNIX or Linux syslog or the Windows NT Event log, in addition to the local log file. You can also send only audit logging information to a database. Consider security, such as methods available for protecting log files from system failures and user tampering.

  • During configuration, define the startup properties for logging, such as connection settings for databases.

    You must also create a logging database if you plan to collect audit logs. If communication between a local log server and a remote log server must be secured, make the appropriate configuration changes on both IBM Cognos Analytics computers. You can also enable certain logging features, such as user-specific logging.

    For more information, see the IBM Cognos Analytics Installation and Configuration Guide.

  • Specify the level of detail to log to focus messages on the information that is relevant in your organization.

    Audit reports may also be set up to track user and report activity.

For information about using log messages to solve problems and resolving logging-related issues, see the IBM Cognos Analytics Troubleshooting Guide.