Enable Diagnostics

This topic describes tasks performed by administrators and BI Authors to enable the diagnostics logs.

Enable Diagnostics for Scheduler Jobs

You can enable diagnostics for a scheduler job in the Schedule Report Job page, and download the diagnostic logs from Report Job History.

You must have BI Administrator or BI Data Model Developer privileges to access the Diagnostics tab in the Schedule Report Job page. Perform the following steps to enable diagnostics.

To enable and download diagnostics for a scheduler job:

  1. From the New menu, select Report Job.
  2. Select the report to schedule, and click the Diagnostics tab.
  3. Select and enable the required diagnostics.
    Option Description
    Enable SQL Explain Plan Generates a diagnostic log with Explain plan/SQL monitor report information.
    Enable Data Engine Diagnostic Generates a data processor log.
    Enable Report Processor Diagnostic Generates FO (Formatting Options) and server related log information.
    Enable Consolidated Job Diagnostic Generates the entire log, which includes scheduler log, data processor log, FO and server log details.
  4. Submit the report.
  5. After the report job runs, in the Report Job History page, select your report to view the details.
  6. Under Output & Delivery, click Diagnostic Log to download the job diagnostic log and view the details.
    Use the Manage Job Diagnostics Log page to purge the old job diagnostic logs.

Enable Diagnostics for Online Reports

In the Report Viewer, you can enable diagnostics for online reports.

Administrators and BI Authors can enable diagnostics before running the online report, and then download the diagnostic logs after the report finishes. Diagnostics are disabled by default.

If you enable diagnostics for an online report with interactive output, you can:

  • Download the following diagnostic logs in a .zip file:

    • SQL logs

    • Data engine logs

    • Report Processor logs

  • View the following details in the diagnostic logs:

    • Exceptions

    • Memory guard limits

    • SQL query

To enable diagnostics and download the diagnostic logs for an online report:

  1. If the report is running, click Cancel to stop the report execution.
  2. Click Actions in the Report Viewer.
  3. Select Enable Diagnostics from the Online Diagnostics option.
  4. Submit the report.
  5. To download the diagnostic logs after the report runs:
    1. Click Actions in the Report Viewer.
    2. Select Download Diagnostics from the Online Diagnostics option.