Using the InterSystems Diagnostic Report
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
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 InterSystems IRIS instance (iris-install-dir\mgr
) as an HTML file. The file name is in CustomerNameYYYYMMDDHHMM.html
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:\MyInstallDir
generates a report file named:
Viewing the Diagnostic Report Task History
The InterSystems IRIS 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.
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.
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:
On Microsoft Windows 32-bit systems the report uses the following third-party utilities developed by SysInternals Software:
Displays process information at the operating system level
The basic information includes the following categories:
Displays the following information:
Full host name (with domain)
Date and time report was created
InterSystems IRIS objects version string
InterSystems ODBC/JDBC server version information
National Language Support (NLS) information
Free block count information
Operating system version (uname -a
on UNIX® systems)
Extended system information (only on Windows systems if the PsInfo.Exe
utility is in the InterSystems IRIS Bin
Displays active license information including the location of the license key file, the contents of the license key, and license availability ($System.License.CKEY()
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 InterSystems IRIS Bin
Displays spin count information.
Displays the contents of the active InterSystems IRIS configuration file (iris.cpf
Displays a listing of the following security information:
Current login failures
Displays audit information including a listing of events and the contents of the audit log database.
Displays the contents of the messages.log
(if its size does not exceed 5MB).
To produce a report that contains only the basic information:
In the Diagnostic Report row, click Details
The advanced information includes the following categories:
irisstat Snapshot #1
Displays output of the InterSystems statistics utility (irisstat
) run with the following options:
irisstat -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>
irisstat Snapshot #2
Displays the output of the irisstat
utility run with the same options as the first snapshot one minute later.
If the irisstat
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 irisstat section of the Diagnostic Report:
File /iris/iristestsys/mgr/irisstat201103151102.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.
Displays network information output of the following utilities:
Dump Files in Manager’s Directory
Displays a list of core or *.dmp
files, if any.
Displays global statistic information (^GLOSTAT
output ten snapshots taken every ten seconds).
Content Date/Time: 2019-07-18 06:47:29