IBM Support

Enable JDBC Trace in Cognos Analytics Using the Diagnostic Logging Feature

How To


Summary

This document describes how to enable a JDBC trace in Cognos Analytics version 11 and above using the Diagnostic Logging feature in the Cognos Analytics portal. This trace allows you to view connection information, native SQL sent to the database, get metadata calls, open and close statements, and more. This is the preferred method since you do not need to modify server files directly on the dispatcher machines. The older method (link below if required) requires a change to a system diagnostic file on each dispatcher machine. The method described here is centralized.

Steps

Steps to enable a JDBC trace using the preferred method:

  1. Download the XQE topic located in the diagnostic logging section under Manage > Configuration > Diagnostic logging. Click the Show all check box, scroll down to the XQE topic, click the three dots to the right of the topic, and then click Download topic.
  2. Open the downloaded file in a text editor and then:

    1. Under "loggerName": "XQE.JDBC", change "level": "WARN"  to "level": "INFO".

      {
      "loggerName": "XQE.JDBC",
      "level": "INFO",
      "additivity": true
      }

    2. To see the JDBC API calls, you may also choose to change the "loggerName": "XQE.JDBCAPITrace" level setting to INFO as well.
    3. At the bottom of the file, change the topic name to XQEJDBC (or something similar to indicate what the trace is doing) and then, save the file.
    4. Back in the Cognos Analytics portal, go to the Custom topics tab, click on the Upload arrow beside Upload topic and then navigate to the file you just modified and upload the file.
    5. Select the new custom topic that appears and then, in the bottom right, click Apply. Wait a few moments and then run your dashboard or report to capture the trace.
    6. On the dispatcher machine, under the logs folder, open the dataset-service.log file to see the trace output. For multiple dispatcher environments, you will need to look at each dataset-service.log log file to find the dispatcher that serviced the request. Use the time stamp of when you ran the query to quickly find the correct trace output.

 

You can also enable the JDBC trace using an older method under Related Information section below. 

We recommend to use the preferred method mentioned above.

Document Location

Worldwide

[{"Type":"MASTER","Line of Business":{"code":"LOB76","label":"Data Platform"},"Business Unit":{"code":"BU048","label":"IBM Software"},"Product":{"code":"SSEP7J","label":"IBM Cognos Analytics"},"ARM Category":[{"code":"a8m0z0000001joxAAA","label":"Troubleshooting-\u003ELogging"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"and future releases;11.2.0;11.2.1;11.2.2;11.2.3;11.2.4;12.0.0;12.0.1;12.0.2;12.0.3;12.0.4;12.1.0;12.1.1;12.1.2"}]

Document Information

Modified date:
08 May 2026

UID

ibm17272414

Page Feedback