Application Diagnostic Reporting for Enterprise Server

Application diagnostic reporting can be enabled and configured to collect and package a number of reports, trace, and log files into a single report file.

The diagnostic report reduces the time spent searching for relevant diagnostic information stored at multiple locations. The diagnostic report will collect information on CICS API failures and Run-Time System (RTS) errors.

To enable application diagnostic reporting, add the following to your enterprise server region's Configuration Information field on the Properties page in ESCWA:

[ES-Environment]
ES_FAILURE_REPORT_ENABLED=Y

The default value is N.

Note: To enable a failure report you must set either Dump on ABEND Sys or Dump on ABEND Tran. An RTS error requires the Dump on ABEND Sys to be set, and a CICS API failure requires Dump on ABEND Tran to be set. See ES Control for more information.

You can perform additional report configuration using the following variables:

ES_FAILURE_REPORT_CORE=Y|N: Set this option to disable the generation of the core dump component of the diagnostic report.
If failure reporting has been enabled the default value is Y.
ES_FAILURE_REPORT_PRINTENV=Y|N: Set this option to disable printing of the contents of COBCONFIG and MFTRACE_CONFIG.
If failure reporting has been enabled the default value is Y.
ES_FAILURE_REPORT_LOCALTRACE=Y|N: Set this option to disable printing the local trace table.
If failure reporting has been enabled the default value is Y.
ES_DUMP_LIMIT=number: Specifies the limit for minimum time interval (ms) between storage dumps/reports created for errors with the same DUMPCODE and CALLER.

Note: Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure these environment variable. See Advanced Region Properties for more information.

The diagnostic reporting can also be configured from the ESCWA ES Control page. See ES Control for more information.

The following message is displayed in the console log when an application diagnostic report is created:

DU0006I Failure report file (%1$s) created

Or if it fails to create the report:

DU0007W Unable to create failure report file (%1$s)

The diagnostic report is written to the default System Directory, located by default in %USERPROFILE%\Documents\Micro Focus User\Enterprise Developer\WORKAREA\ESName (Windows) or /var/mfcobol/es/ESName (UNIX). This is typically the location of the console.log file.

The following is an example of the start of the diagnostic report:

Start of Enterprise server failure report       Date: 12/18/2020 (mm/dd/yyyy)  Time: 13:49:10.24                                                Process ID: 00001818  Thread ID: 69914880  Failure type: RTS-Err
...

Where the Failure type can be:

RTS-Err: Run-Time System (RTS) errors.
CICS-API: CICS API failures.

A failure summary is then displayed. This is specific to the failure type and the report configuration.