Gathering logs with the LogCollector user interface

Applies to: On Cloud Cloud Pak for Data On premises

Use the LogCollector user interface to collect log files and diagnostic data from the IBM OpenPages® environment and from OpenPages databases.

If you prefer to enable trace logging that uses the auroralogging.properties file, see Enable trace logging.

LogCollector gathers log files into a .zip file that you can download. When your application servers are clustered, a .zip file is available for each application server.

LogCollector doesn't collect Cognos logs or global search logs.

Important: You can disallow access to the LogCollector UI by removing the Open Administration menu Administration menu > Other > Logs menu item. To remove the menu item, set Applications > Common > Administration > Enable Manage Logs to false.

This video demonstrates how to collect log files and diagnostic data:

Before you begin

The menu item Open Administration menu Administration menu > Other > Logs is visible only to the following users:
  • Super Administrators
  • Administrators who have the All/SOX/Administration/Logs application permission and access to the LogCollector Documents folder. For more information about assigning access control to folders, see Managing system files and folders.

Procedure

  1. Click Open Administration menu Administration menu > Other > Logs.
  2. Click Launch.
    The Launch Log Collector panel is displayed.
  3. If you want to collect log files, set Log Files to True.
  4. If you want to gather database diagnostics, set Database Diagnostics to True.
  5. Click Add.

    When the Log Collector has gathered the logs, a .zip file that contains the logs is displayed. You can download and decompress this file to view its contents.

  6. Optional: If you want to take a snapshot of diagnostic data to troubleshoot database issues, click System tracing options.
    1. Click Capture to take a capture of the diagnostic data as a baseline.
    2. After the capture completes successfully, perform the action that demonstrates the functional or performance issue.
    3. Return to the Logs tab and click System tracing options.
    4. Click Capture to take a capture of the diagnostic data after the issue occurs.
    5. After the capture completes successfully, click Cancel.
    6. Run the LogCollector as you did in steps 2 to 5.
    The .zip file will contain the diagnostic data before and after the issue occurred for comparison.
  7. 9.1.2 and later If you want to change the logging format, click System tracing options. Select an option from the Logging format drop-down list. Tabular is the default format, but you can also choose CSV or JSON.
  8. 9.1.2 and later If you want to create a custom logger appender, click System tracing options. Complete the following steps and repeat for as many custom logger appender items that you want to create.
    1. For Custom logger appender, click Add.
    2. Enter a Logger appender name. This name must not contain spaces and special characters.
    3. Enable the logger appender for it to be added.
    4. Enter the Logger package. The logger package should follow the com.<mycompany> format.
    5. Enter a numeric value for the Log size (MB). The value must be within 1 and 100.
    6. Enter a Log max count between the values 1 and 20.
    7. Click Create to add your custom logger appender item.
  9. Required: 9.1.2 and later To change the maximum log file size and the maximum number of backup of logs, click System tracing options. If you prefer to change the maximum file size in the auroralogging.properties file, see Changing the size and number of backups of the aurora log file.
    1. Enter a numeric value for the Log size (MB). The value must be within 1 and 100. The default log size and unit is 10 MB.
    2. Enter a Log max count between the values 1 and 20. The default is 20.
  10. Optional: If you want to enable tracing logs, click System tracing options.
    1. Enable the tracing activities that you need by setting them to On.
    2. Click Save.
    The next time that you launch LogCollector, the .zip file will contain the trace logs.