Setting up logging

Administrators can configure both session logging and diagnostic logging.

Session logging

Session logging is used to log detailed user activity in every IBM® Cognos® Analytics component and service that is associated with the user's request.

The user does not need to know the components, services, or logging configuration details. There is no performance impact on other users.

Session logging is typically used when a user can reproduce a problem. It can be stopped at any time by the user.

Unique log files are generated for each user who enables session logging. The file names include a unique Log identifier that is generated when session logging is turned on by the user.

The administrator must enable session logging for the system, and then individual users can turn it on or off for themselves.

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.
Diagnostic logging

Diagnostic logging creates server log files that allow administrators and support personnel to troubleshoot intermittent or service-specific problems. The same diagnostic logging configuration is automatically set on all servers.

For more information, see Diagnostic logging.

Procedure

  1. Go to Manage > Configuration > System, and select Logging.
  2. Specify values, as required, for the following settings:
    Property Setting Result

    Size limit for server log file (MB)

    number

    Default=200

    The maximum size, in MB, of the server log file. After a server log file reaches its size limit, a new rolling log file is created.

    Tip: Server log files are used for Diagnostic logging.
    Maximum number of backup server log files

    number

    Default=10

    The maximum number of server rolling log files that are stored as backups.

    Tip: Server log files are used for Diagnostic logging.
    Enable user session logging

    Enabled(default)

    User session logging occurs.

    Tip: When this setting is turned on, the option Log my session is available for all users in their personal settings.
    Disabled User session logging does not occur.
    Size limit for user session log file (MB)

    number

    Default=25

    		 The maximum size, in MB, of the user session log file for each user session. After a user session log file reaches its size limit, a new rolling log file is created.
    Maximum number of backup log files (per user session number

    Default=10

    		 The maximum number of user session rolling log files that are stored as backups.
    Delete session log files after 48 hours Enabled(default) All user session files log files are deleted after 48 hours.
    Disabled User session files log files are not deleted.
  3. Click OK to apply the changes.

    You do not need to restart the IBM Cognos Analytics service.

Results

The configuration changes are saved and propagated to all dispatchers. You do not need to restart the service for the changes to take effect.

What to do next

Users can now enable session logging in their personal settings, by selecting the Log my session option, and turning on the setting Session logging. The users should record the Log identifier that is generated for the session before they turn off logging or close the browser. The administrator will need this identifier to find the session log files, cognosserver-session-log_identifier.log and dataset-service-session-session_id.log, in the install_location/logs directory.