Monitoring InterSystems IRIS Using the irisstat Utility
This topic provides an overview of how to use the irisstat utility. It is intended as an introduction for new users and a reference for experienced users.
When using this utility, you should consult with the InterSystems Worldwide Response Center (WRC)Opens in a new tab for guidance about specifying appropriate irisstat options and assistance in interpreting the data produced by the utility.
irisstat is a C executable that is distributed with InterSystems IRIS® data platform. It is a diagnostic tool for system level problems, including InterSystems IRIS hangs, network problems, and performance issues. When run, irisstat attaches to the shared memory segment allocated by InterSystems IRIS at start time, and displays an InterSystems IRIS instance’s internal structures and tables in a readable format. The shared memory segment contains the global buffers, lock table, journal buffers, and a wide variety of other memory structures which need to be accessible to all InterSystems IRIS processes. Processes also maintain their own process private memory for their own variables and stack information. The basic display-only options of irisstat are fast and non-invasive to InterSystems IRIS.
More advanced (undocumented) options may alter shared memory and should be used with care. These advanced options should be used only at the direction of InterSystems Support personnel; for information, contact the InterSystems Worldwide Response Center (WRC)Opens in a new tab.
Basics of Running irisstat
In the event of a system problem, the irisstat report is often the most important tool that InterSystems has to determine the cause of the problem. Use the following guidelines to ensure that the irisstat report contains all of the necessary information:
Run irisstat at the time of the event.
Check the contents of the irisstat report to ensure it is valid.
Since irisstat is a separate executable file included with InterSystems IRIS, it is run outside of InterSystems IRIS, at an operating system prompt. Therefore, the details of running it depend on the operating system:
Running irisstat with no options is not a common way to run it, but doing so produces a basic report which is the equivalent of running it with the following default options:
-f (global module flags)
-p (PID table)
For information about irisstat options, see Running irisstat with Options.
Running irisstat on Windows
The irisstat executable is located in the install-dir\bin directory. Starting with a Windows command prompt running as Administrator, you can run it as follows:
C:\>cd install-dir\bin C:\install-dir\bin>irisstat
If you run irisstat from a directory other than install-dir\bin or install-dir\mgr, you must include the -s argument to specify the location of the install-dir\mgr directory. For example:
Running irisstat on UNIX®
The irisstat executable is located in the install-dir/bin directory. If you run irisstat from a directory other than install-dir\bin or install-dir\mgr, you must include the -s argument to specify the location of the install-dir\mgr directory.
Starting with a UNIX® command prompt running as root, change to the install-dir/bin directory or the install-dir/mgr directory and run the irisstat command:
From the InterSystems IRIS installation directory, the command would be as follows:
bash-3.00$ ./bin/irisstat -smgr
You can also invoke irisstat via the iris command, which can be run from any directory as shown in the following example:
bash-3.00$ iris stat iris_instance_name
where iris_instance_name is the name of the InterSystems IRIS instance on which you are running irisstat.
Running irisstat with Options
Running irisstat without options produces a basic report. Generally, you run irisstat to obtain specific information. To specify target information, you can include or exclude options as follows:
To include (turn on) an option, specify a flag followed by a 1 (or other level).
To exclude (turn off) an option, specify a flag followed by a 0.
For example, to include the Global File Table (GFILETAB) section in the irisstat report, use the -m1 option:
or, to turn off the default basic options, use the -a0 option:
Many options have more detailed levels than 0 and 1. These additional levels are described as having “bits,” which are displayed in decimal as powers of two and control specific types of information about the option. For example, the basic -p option, which displays the PID table, is turned on with a 1; however, using a 2 adds a swcheck column, a 4 adds a pstate column. and so on. These bits can be combined; for example, if you want to see the information displayed by both the 2 and 4 bits, specify -p6. To ask for all bits, use -1, as follows:
bash-3.00$ ./irisstat -p-1
In addition, multiple flags can be combined in a single irisstat command. For example, the following command turns off the basic options, then turns on all bits for the global module flags and PID table, as well as a detailed level for the GFILETAB:
bash-3.00$ ./irisstat -a0 -f-1 -p-1 -m3
It is common for irisstat commands to have many flags when you start diagnosing a complex problem; however, the options that make modifications are typically used alone. For example, the -d option requests a process dump; before using this option, you might run irisstat with multiple options to identify the process to dump, but when using -d, typically no other options are selected.
The irisstat Options table describes the options that you can use with the irisstat command.
For assistance in interpreting the data produced by the irisstat options described in this table, contact the InterSystems Worldwide Response Center (WRC)Opens in a new tab.
|–a[0/1]||Displays all information described in this table.|
Displays information about global buffer descriptors blocks (BDBs). You can specify a combination of the following bits:
Running irisstat -b64 may require extra time.
Displays counters, which are statistics on system performance. You can specify a combination of the following bits:
Creates dump of InterSystems IRIS processes. You can specify the following options:
Displays the InterSystems IRIS system error log (see InterSystems IRIS System Error Log in the “Monitoring InterSystems IRIS Using the Management Portal” chapter); –e2 displays additional process information (in hex).
Displays global module flags. You can specify a combination of the following bits:
Displays ^GLOSTAT information; for information see the “Gathering Global Activity Statistics Using ^GLOSTAT” chapter in this document.
Displays irisstat usage information.
Displays the journal system master structure, which lists information about journaling status. –j32 displays mirror server information.
|-k||Displays information about prefetch daemons used by the $PREFETCHON function; see $PREFETCHON in the ObjectScript Reference.|
Displays information about least recently used (LRU) global buffer descriptor block (BDB) queue, but not the contents of the BDBs. You can specify a combination of the following bits:
See also –b.
Displays Global File Table (GFILETAB), which contains information about all databases, listed by SFN, that have been mounted since the instance of InterSystems IRIS started up. You can specify a combination of the following bits:
Displays information about network structures and local/remote SFN translations; irisstat -n-1 also displays namespace structures.
|-o1||Clears the resource statistics displayed by irisstat -c to reestablish a base situation without rebooting InterSystems IRIS. No output is produced.|
Displays information about processes that are running in InterSystems IRIS. The information is obtained from the process ID table (PIDTAB). You can specify a combination of the following flags:
Displays information about hibernation semaphores.
|-s[dir]||Specifies the directory containing the irisstat executable when running the command from other than the mgr or bin directories.|
|-t[seconds]||Runs irisstat repeatedly in a loop every seconds seconds until halted. Only the global module flags section is displayed, as when -f1 is specified.|
Displays information about InterSystems IRIS locks stored in the lock table (see Monitoring Locks in the “Monitoring InterSystems IRIS Using the Management Portal” chapter of this guide). You can specify a combination of the following bits:
|-v1||Ensures that the InterSystems IRIS executable associated with the shared memory segment irisstat is being run on and the irisstat executable are from the same version; if not, irisstat will not run.|
Displays information about BDBs in write daemon queues.
Displays, in hex, the contents of blocks held in GBFSPECQ.
Displays configuration information for inter-job communication (IJC) devices.
Displays resource statistics over an interval of ‘secs’ seconds. Sample block collisions ever ‘msec’ milliseconds.
Resource information same as –c.
The ^BLKCOL utility, described in the “Monitoring Block Collisions Using ^BLKCOL” chapter of this guide, provides more detailed information about block collisions.
Displays status of cluster on platforms that support clustering. You can specify a combination of the following bits:
Displays, in hex, the contents of the global buffer descriptors and the global buffer for a specific buffer descriptor block (BDB).
Same as –H except that the information is displayed by BDB.
Displays, in hex, the contents of the global buffer descriptors and the global buffer for a specific system file number (sfn) and block number (blk) pair.
Same as –G except that the information is displayed by system file number and block number pair.
The block must be in the buffer pool.
Displays the incremental backup data structures.
Displays the license.
Same as ^CKEY and %SYSTEM.License.CKEYOpens in a new tab method.
Displays the mailbox log.
Disabled by default. A special build is required to capture and log the mailbox messages; additional logging may be required.
Displays ECP network information. You can specify a combination of the following values:
Displays information about routine buffers in use (or changing), class control blocks (CCB), and least recently used (LRU) queues. You can specify a combination of the following values:
Displays information about the cause of a hang based on a self diagnosis of whether or not the system is hung. You can specify a combination of the following bits:
In a cluster, this option should be run all cluster members.
Displays hex values of many in-memory tables, including National Language Settings (NLS) tables.
Displays variables that are part of the process memory structures; of limited value unless you have access to the source code.
Windows only. Run from the directory that contains the pid.dmp file.
|-W||Performs the same function as the Backup.General.ExternalThaw()Opens in a new tab classmethod, and may be used to resume the write daemon after Backup.General.ExternalFreeze()Opens in a new tab has been called in cases when a new InterSystems IRIS session cannot be started. (See External Backup in the “Backup and Restore” chapter of the Data Integrity Guide for information on the use of these methods.) This option will not unfreeze the write daemon from any hang or suspension caused by anything other than a backup. Use of this option is recorded in the messages log.|
Displays the contents of the device translation table. It is organized by device number and shows both the numeric and plaintext class identifiers.
Viewing irisstat Output
irisstat data can be viewed immediately (via a terminal) or redirected to an output file for later analysis. The most common methods for viewing the data are:
When InterSystems IRIS is forcibly shut down, irisstat is run in order to capture the current state of the system. The output is added to the messages log as part of the emergency shutdown procedure.
irisstat Text File
irisstat reports can be redirected to a file instead of the terminal, which might be useful if you want to collect a set of irisstat options that are not provided by one of the InterSystems IRIS tools (Diagnostic Report Task, IRISHung Script, ^SystemPerformance Utility) or if you are having trouble running those tools.
Diagnostic Report Task
The Diagnostic Report task creates an HTML log file containing both basic and advanced information, which can be used by the InterSystems Worldwide Response Center (WRC)Opens in a new tab to resolve system problems. For information about the Diagnostic Report task, including the irisstat options that it uses, see the “Using the InterSystems Diagnostic Report” chapter in this guide.
The Diagnostic Report task cannot be run on a hung system; if your system is hung, see IRISHung Script in this appendix.
The IRISHung script is an OS tool used to collect data on the system when an InterSystems IRIS instance is hung. The name of the script, which is located in the install-dir\bin directory, is platform-specific, as specified in the following table:
The IRISHung script should be run with Administrator privileges. Like the Diagnostic Report Task, the IRISHung script runs irisstat twice, 30 seconds apart, in case the status is changing, and bundles the reports into an html file together with the other collected data. The irisstat reports taken from IRISHung use the following options:
irisstat -e2 -f-1 -m-1 -n3 -j5 -g1 -L1 -u-1 -v1 -p-1 -c-1 -q1 -w2 -E-1 -N65535
IRISHung also runs a third irisstat using only the -S2 option, which it writes to a separate section of output called “Self-Diagnosis.” The -S2 option causes suspect processes to leave mini-dumps; therefore, running IRISHung is likely to collect information about the specific processes responsible for the hang, whereas simply forcing the instance down does not collect this information.
In addition, IRISHung generates irisstat output files that are often very large, in which case they are saved to separate .txt files. Remember to check for these files when collecting the output.
The ^SystemPerformance utility collects detailed performance data about an InterSystems IRIS instance and the platform on which it is running. It runs inside InterSystems IRIS for a configurable amount of time, collects samples over the that interval, and generates a report when it finishes. For information about the ^SystemPerformance utility, including the irisstat options that it uses, see the “Monitoring Performance Using ^SystemPerformance” chapter in this guide.