The most direct way to generate the report is by going to the Diagnostic Report page (System Operation > Diagnostic Reports) of the Management Portal and entering the appropriate information for the Diagnostic Report task. You can edit this information at any time by returning to this page. If you do not wish to edit any of the fields, click Run to generate the report using the current settings.

If you do not enter any information and click Run, the task generates a detailed report and places it in the manager’s directory of the Caché instance (install-dir\mgr) as an HTML file. The file name is in CustomerNameYYYYMMDDHHMM.html format.

For example, on September 24, 2011 at 8:46 p.m., running the Diagnostic Report task with a license key issued to MyCompany on an instance installed in C:\MyCache generates a report file named:

There are several fields on the page you can set that affect when the task runs, where the file is saved, and whether or not to send the file to the WRC. The Configuring Diagnostic Report Settings section describes these settings. If you click Close, your changes are discarded and the report task does not run.

The Caché installation contains a predefined on-demand Diagnostic Report task. The first time you go to the Diagnostic Report page, fill in the pertinent information to update the settings for this task. Depending on which fields you enter, you have the following choices of what to do with the Diagnostic Report:

To save the report to a specific archive directory other than the manager’s directory, enter a directory name.

To send the report to the WRC, enter information in the outgoing mail fields.

To both save and send the report, enter the information from the two previous options.

To run the report automatically on a regular schedule, enable WRC HealthCheck.

The following list contains the settings for the Diagnostic Report and a description of each:

Directory for archived reports  location to store the reports. Defaults to the manager’s directory, install-dir\mgr, if you do not enter any information on the page. If you leave this setting blank and enter outgoing mail settings the report is not saved in the manager’s directory. Click Browse to select an existing directory.

Enable automatic WRC HealthCheck updates  select this check box to send periodic reports to the WRC. InterSystems highly recommends that you enable the WRC HealthCheck feature. If selected, the Diagnostic Report task runs at regular intervals and sends the report to the WRC. These regular reports allow the WRC to better assist you. Selecting this feature requires you to enter the SMTP server information.

Important:

The report task does not send any private application information, and InterSystems keeps all configuration data strictly confidential.

The Diagnostic Report task retains the information you enter in all but one of the settings; the task runs with the WRC issue number only once and then clears it. You cannot edit task settings while the report is running.

Diagnostic Report Contents

When the Diagnostic Report task runs, it creates an HTML log file containing both basic and advanced information, which is used by the WRC to resolve issues. The following sections describe the sections of the report:

Displays the output of the cstat utility run with the same options as the first snapshot one minute later.

If the cstat output files are too large, they are saved to a separate file and not sent with the report. If separate files were created, a message similar to the following is posted in the cstat section of the Diagnostic Report:

File /cache/cachetestsys/mgr/cstat201103151102.html is too big to be appended to
the Log File. A copy has been left in the Directory.

Although these files have an html extension, they are plain text and should be viewed in a text editor rather than a browser.