Caché Monitoring Guide
Using the Caché Diagnostic Report
[Home] [Back] [Next]
InterSystems: The power behind what matters   
Class Reference   
Search:    

InterSystems provides a mechanism to run a diagnostic report on your Caché instance and send the results to the InterSystems Worldwide Response Center (WRC) to help diagnose system problems.

You configure and run the Diagnostic Report as a task from the Management Portal. The following sections describe the tasks, settings, and contents of the Diagnostic Report option:
For more information on this task see the %SYS.Task.DiagnosticReport entry in the InterSystems Class Reference.
Running the Diagnostic Report Task
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:
C:\MyCache\mgr\MyCompany201109242046.html
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.
Viewing the Diagnostic Report Task History
Click Task History at the top of the Diagnostic Report page to display the history for the Diagnostic Report task. (See Using the Task Manager in the “Managing Caché” chapter of the Caché System Administration Guide for information about tasks and task history.).
Configuring Diagnostic Report Settings
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:
  1. To save the report to a specific archive directory other than the manager’s directory, enter a directory name.
  2. To send the report to the WRC, enter information in the outgoing mail fields.
  3. To both save and send the report, enter the information from the two previous options.
  4. 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:
Information required to send the report directly to the WRC — if you enter the outgoing mail settings, the report is sent to WRCHealthCheck@InterSystems.com.
Additional information for the WRC:
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:
Note:
On Microsoft Windows 32-bit systems the report uses the following third-party utilities developed by SysInternals Software:
Basic Information
The basic information includes the following categories:
General
Displays the following information:
Key File
Displays active license information including the location of the license key file, the contents of the license key, and license availability ($System.License.CKEY() output).
License Counts
Displays license usage information ($System.License.ShowCounts() output).
%SS
Displays system status information (^%SS output — two snapshots taken thirty seconds apart).
Operating System Processes List
Displays operating system process information (only on Windows systems if the PsList.Exe utility is in the Caché Bin directory).
Spin Counts
Displays spin count information.
CPF File
Displays the contents of the active Caché configuration file (cache.cpf).
SysLog
Displays the contents of the Caché system error log; see Caché System Error Log in the “Monitoring Caché Using the Management Portal” chapter for more information.
Security
Displays a listing of the following security information:
Audit
Displays audit information including a listing of events and the contents of the audit log database.
Shadowing
Displays the contents of the shadowing globals for this instance both as a shadow source and a shadow destination.
cconsole
Displays the contents of the cconsole.log (if its size does not exceed 5MB).
Note:
To produce a report that contains only the basic information:
  1. Navigate to [Home] > [Task Manager] > [View Task Schedule].
  2. In the Diagnostic Report row, click Details.
  3. On the Task Scheduler Wizard page, clear the AdvancedReport check box, and click Finish.
  4. On the Task Details page (System Operation > Task Manager > View Task Schedule > Task Details), in the Diagnostic Report row, click Run.
  5. On the Run Task page, click Perform Action Now.
  6. Click Close.
Advanced Information
The advanced information includes the following categories:
cstat Snapshot #1
Displays output of the Caché statistics utility (cstat) run with the following options:
cstat -e2 -m-1 -n3 -j5 -g1 -m3 -L1 -u-1 -v1 -p-1 -c-1 -q1 -w2 -S-1 -E-1 -N65535 -s<mgr_dir>
For more information about the cstat utility, see the Monitoring Caché Using the cstat Utility appendix of this guide.
cstat Snapshot #2
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.
Network Status
Displays network information — output of the following utilities:
Dump License
Displays local license table entries and key information ($System.License.DumpLocalInUse() and $System.License.DumpKeys() output).
Dump Files in Caché Manager’s Directory
Displays a list of core or *.dmp files, if any.
GloStat
Displays global statistic information (^GLOSTAT output —ten snapshots taken every ten seconds).