onstat command syntax

The complete syntax for the onstat command, including information about the interactive mode and how to have options to execute repeatedly.

Read syntax diagramSkip visual syntax diagram
                                        .- -pu-.   
>>-onstat--+-------------------------+--+------+---------------->
           |                     (1) |             
           '-|  -FILE option   |-----'             

     .---------------------------------------.                     
     V                                       |             (2)     
>--+---+-----------------------------------+-+--+--------+-----+-><
   |   +- -a-------------------------------+    '-infile-'     |   
   |   +- -b-------------------------------+                   |   
   |   +- -B-------------------------------+                   |   
   |   +- -c-------------------------------+                   |   
   |   +- -C-------------------------------+                   |   
   |   +- -d-------------------------------+                   |   
   |   +- -D-------------------------------+                   |   
   |   +- -f-------------------------------+                   |   
   |   +- -F-------------------------------+                   |   
   |   +- -g--monitoring_option------------+                   |   
   |   +- -G-------------------------------+                   |   
   |   +- -h-------------------------------+                   |   
   |   +- -i-------------------------------+                   |   
   |   +- -j-------------------------------+                   |   
   |   +- -k-------------------------------+                   |   
   |   +- -l-------------------------------+                   |   
   |   +- -m-------------------------------+                   |   
   |   +- -o--+---------+----+---------+---+                   |   
   |   |      +-nobuffs-+    '-outfile-'   |                   |   
   |   |      '-full----'                  |                   |   
   |   +- -O-------------------------------+                   |   
   |   +- -p-------------------------------+                   |   
   |   +- -P-------------------------------+                   |   
   |   +- -r--+---------+------------------+                   |   
   |   |      '-seconds-'                  |                   |   
   |   +- -R-------------------------------+                   |   
   |   +- -s-------------------------------+                   |   
   |   +- -t-------------------------------+                   |   
   |   +- -T-------------------------------+                   |   
   |   +- -u-------------------------------+                   |   
   |   +- -x-------------------------------+                   |   
   |   +- -X-------------------------------+                   |   
   |   '- -z-------------------------------'                   |   
   +- - -------------------------------------------------------+   
   +- -- ------------------------------------------------------+   
   +- -V-------------------------------------------------------+   
   '- -version-------------------------------------------------'   

Notes:
  1. See The -FILE option.
  2. Only one occurrence of each item is allowed. More than one option can be specified on a single onstat command invocation.
Element Purpose Key Considerations
- Displays the output header only. See onstat - command: Print output header.
-- Displays a listing of all onstat options and their functions

See onstat -- command: Print onstat options and functions.

This option cannot be combined with any other onstat option.

-a Interpreted as onstat -cuskbtdlp. Displays output in that order. See onstat -a command: Print overall status of the database server.
-b Displays information about buffers currently in use, including number of resident pages in the buffer pool See onstat -b command: Print buffer information for buffers in use.
-B Obtains information about all database server buffers, not just buffers currently in use. See onstat -B command: Prints information about used buffers.
-c Displays the ONCONFIG file:
  • $INFORMIXDIR/etc/$ONCONFIG for UNIX
  • %INFORMIXDIR%\etc\ %ONCONFIG% for Windows
See onstat -c command: Print ONCONFIG file contents.
-C Prints B-tree scanner information See onstat -C command: Print B-tree scanner information.
-d Displays information for chunks in each storage space See onstat -d command: Print chunk information.
-D Displays page-read and page-write information for the first 50 chunks in each dbspace See onstat -D command: Print page-read and page-write information.
-f Lists the dbspaces currently affected by the DATASKIP feature See onstat -f command: Print dbspace information affected by dataskip.
-F Displays a count for each type of write that flushes pages to disk See onstat -F command: Print counts.
-g option Prints monitoring option See onstat -g monitoring options.
-G Prints global transaction IDs See onstat -G command: Print TP/XA transaction information.
-h Provides information on the buffer header hash chains See onstat -h command: Print buffer header hash chain information.
-i Puts the onstat utility into interactive mode See onstat -i command: Initiate interactive mode.
-j Prints the interactive status of the active onpload process See onstat -j command: Provide onpload status information.
-k Displays information about active locks See onstat -k command: Print active lock information.
-l Displays information about physical and logical logs, including page addresses See onstat -l command: Print physical and logical log information.
-m Displays the 20 most recent lines of the database server message log Output from this option lists the full pathname of the message-log file and the 20 file entries. A date-and-time header separates the entries for each day. A time stamp prefaces single entries within each day. The name of the message log is specified as MSGPATH in the ONCONFIG file.

See onstat -m command: Print recent system message log information.

-o Saves a copy of the shared-memory segments to outfile See onstat -o command: Output shared memory contents to a file.
-p Displays profile counts. See onstat -p command: Print profile counts.
-P Displays for all partitions the partition number and the break-up of the buffer-pool pages that belong to the partition See onstat -P command: Print partition information.
-pu If you invoke onstat without any options, the command is interpreted as onstat -pu (-p option and -u option). Displays profile counts and prints a profile of user activity See onstat -p command: Print profile counts and onstat -u command: Print user activity profile.
-r seconds Repeats the accompanying onstat options after a wait time specified in seconds between each execution See onstat -r command: Repeatedly print selected statistics.
-R Displays detailed information about the LRU queues, FLRU queues, and MLRU queues See onstat -R command: Print LRU, FLRU, and MLRU queue information.
-s Displays general latch information See onstat -s command: Print latch information.
-t Displays tblspace information, including residency state, for active tblspaces See onstat -t and onstat -T commands: Print tblspace information.
-T Displays tblspace information for all tblspaces See onstat -t and onstat -T commands: Print tblspace information.
-u Prints a profile of user activity See onstat -u command: Print user activity profile.
-V Displays the software version number and the serial number. This option cannot be combined with any other onstat option. See Obtaining utility version information.
-version Displays the build version, host, OS, number and date, as well as the GLS version. This option cannot be combined with any other onstat option. See Obtaining utility version information.
-x Displays information about transactions See onstat -x command: Print database server transaction information.
-X Obtains precise information about the threads that are sharing and waiting for buffers See onstat -X command: Print thread information.
-z Sets the profile counts to 0 See onstat -z command: Clear statistics.
infile Specifies a source file for the onstat command This file must include a previously stored shared-memory segment that you created with the onstat -o command.

For instructions on how to create the infile with onstat -o, see onstat -o command: Output shared memory contents to a file.

For information about running onstat on the source file, see Running onstat Commands on a Shared Memory Dump File.

Interactive execution

To put the onstat utility in interactive mode, use the -i option. Interactive mode allows you to enter multiple options, one after the other, without exiting the program. For information on using interactive mode, see onstat -i command: Initiate interactive mode.

Continuous onstat command execution

Use the onstat -r option combined with other onstat options to cause the other options to execute repeatedly at a specified interval. For information, see onstat -r command: Repeatedly print selected statistics.


Copyright© 2019 HCL Technologies Limited