INQUIRE STATISTICS
Retrieves information about the accumulation and recording of CICS® statistics.
Syntax
For more information about the use of CICS-value data areas (CVDAs), see CVDAs recognized by the translator.
Description
INQUIRE STATISTICS retrieves information about the accumulation and recording of CICS resource and system statistics. When statistics are recorded, they are written out to an operating system file that is defined by the StatFile attribute in the Region Definitions (RD).
- A composite option with argument type hhmmss (COBOL only). For more information, see Replaced arguments when programming with COBOL.
- Separate -HRS, -MINS, and -SECS options.
When using the separate options, you must specify all three options to get a complete answer. For example, ENDOFDAYHRS, ENDOFDAYMINS and ENDOFDAYSECS must all be used to get the correct end-of-day time.
The arrival of the end-of-day time, as indicated by the ENDOFDAY option (or a combination of the ENDOFDAYHRS, ENDOFDAYMINS, and ENDOFDAYSECS options) always causes the current interval to be ended (possibly prematurely) and a new interval to be started. Only end-of-day statistics are recorded at the end-of-day time, even if it coincides exactly with the expiry of an interval.
For details about the effects of changing the ENDOFDAY, INTERVAL, and NEXTTIME values, see SET STATISTICS.
Options
- ENDOFDAY(hhmmss)
- (This
option is for COBOL only.) This option returns a packed decimal field, declared
as PIC S9(7) COMP-3, that indicates the end-of-day time for recording statistics.
At the end-of-day time, the current values of the CICS statistics counters are written out
to an operating system file and the statistics counters are reset.
End-of-day times are in the range 000000 through 235959. The default end-of-day time is 12 midnight (000000).
The ENDOFDAY option is not supported for C or C++ programs, which should use the separate ENDOFDAYHRS, ENDOFDAYMINS, and ENDOFDAYSECS options instead.
- ENDOFDAYHRS(data-value)
- Returns
32-bit binary fields that indicate the hours portion of the end-of-day time
for recording statistics. (Used with ENDOFDAYMINS and ENDOFDAYSECS.) At the
end-of-day time, the current values of the CICS statistics counters are written out
to an operating system file and the statistics counters are reset. The following ranges apply to the returned end-of-day times:
- ENDOFDAYHRS 0-23
- ENDOFDAYMINS 0-59
- ENDOFDAYSECS 0-59
The default end-of-day time is 12 midnight (that is, 0 for all three options).
- ENDOFDAYMINS(data-value)
- Returns
32-bit binary fields that indicate the minutes portion of the end-of-day time
for recording statistics. (Used with ENDOFDAYHRS and ENDOFDAYSECS.) At the
end-of-day time, the current values of the CICS statistics counters are written out
to an operating system file and the statistics counters are reset. The following ranges apply to the returned end-of-day times:
- ENDOFDAYHRS 0-23
- ENDOFDAYMINS 0-59
- ENDOFDAYSECS 0-59
The default end-of-day time is 12 midnight (that is, 0 for all three options).
- ENDOFDAYSECS(data-value)
- Returns
32-bit binary fields that indicate the seconds portion of the end-of-day time
for recording statistics. (Used with ENDOFDAYHRS and ENDOFDAYMINS.) At the
end-of-day time, the current values of the CICS statistics counters are written out
to an operating system file and the statistics counters are reset. The following ranges apply to the returned end-of-day times:
- ENDOFDAYHRS 0-23
- ENDOFDAYMINS 0-59
- ENDOFDAYSECS 0-59
The default end-of-day time is 12 midnight (that is, 0 for all three options).
- INTERVAL(hhmmss)
- (This
option is for COBOL only.) This option returns a packed decimal field, declared
as PIC S9(7) COMP-3, that indicates the interval during which the statistics
counters are incremented. At the end of each interval, provided that the RECORDING
option is ON, the accumulated statistics are written out to an operating system
file and the statistics counters are reset.
Interval values for INTERVAL are in the range 000100 through 240000. The default interval value for INTERVAL is 030000.
The INTERVAL option is not supported for C or C++ programs, which should use the separate INTERVALHRS, INTERVALMINS, and INTERVALSECS options instead.
- INTERVALHRS(data-value)
- Returns
32-bit binary fields that indicate the hours portion of the interval during
which the statistics counters are incremented. (Used with INTERVALMINS and
INTERVALSECS.) At the end of each interval, the accumulated statistics are
written out to an operating system file and the statistics counters are reset
(provided that the RECORDING option is ON). The following ranges apply to the returned interval values:
- INTERVALHRS 0-24 (default 3)
- INTERVALMINS 0-59 (default 0)
- INTERVALSECS 0-59 (default 0)
The minimum permissible interval is 1 minute and the maximum is 24 hours.
- INTERVALMINS(data-value)
- Returns
32-bit binary fields that indicate the minutes portion of the interval during
which the statistics counters are incremented. (Used with INTERVALHRS and
INTERVALSECS.) At the end of each interval, the accumulated statistics are
written out to an operating system file and the statistics counters are reset
(provided that the RECORDING option is ON). The following ranges apply to the returned interval values:
- INTERVALHRS 0-24 (default 3)
- INTERVALMINS 0-59 (default 0)
- INTERVALSECS 0-59 (default 0)
The minimum permissible interval is 1 minute and the maximum is 24 hours.
- INTERVALSECS(data-value)
- Returns
32-bit binary fields that indicate the seconds portion of the interval during
which the statistics counters are incremented. (Used with INTERVALHRS and
INTERVALMINS.) At the end of each interval, the accumulated statistics are
written out to an operating system file and the statistics counters are reset
(provided that the RECORDING option is ON). The following ranges apply to the returned interval values:
- INTERVALHRS 0-24 (default 3)
- INTERVALMINS 0-59 (default 0)
- INTERVALSECS 0-59 (default 0)
The minimum permissible interval is 1 minute and the maximum is 24 hours.
- NEXTTIME(hhmmss)
- (This
option is for COBOL only.) This option returns a packed decimal field, declared
as PIC S9(7) COMP-3, that indicates the next time for statistics to be recorded
and reset. This is the expiry time of the current interval or the end-of-day
time, whichever is earlier.
The NEXTTIME option is not supported for C or C++ programs, which should use the separate NEXTTIMEHRS, NEXTTIMEMINS, and NEXTTIMESECS options instead.
- NEXTTIMEHRS(data-value)
- Return 32-bit binary fields that indicates the hours portion of the next time for statistics to be recorded and reset. This is the expiry time of the current interval or the end-of-day time, whichever is earlier. This option is usually used with NEXTTIMEMINS and NEXTTIMESECS.
- NEXTTIMEMINS(data-value)
- Returns 32-bit binary fields that indicate the seconds portion of the next time for statistics to be recorded and reset. This is the expiry time of the current interval or the end-of-day time, whichever is earlier. This option is usually used with NEXTTIMEHRS and NEXTTIMESECS.
- NEXTTIMESECS(data-value)
- Returns 32-bit binary fields that indicate the seconds portion of the next time for statistics to be recorded and reset. This is the expiry time of the current interval or the end-of-day time, whichever is earlier. This option is usually used with NEXTTIMEHRS and NEXTTIMEMINS.
- RECORDING(cvda)
- Returns
a CVDA value that indicates the recording status for interval and unsolicited
statistics. End-of-day statistics and requested statistics are always recorded,
irrespective of the setting of the RECORDING option. (Requested statistics
are those called for by a PERFORM STATISTICS RECORD command, which is described
in PERFORM STATISTICS RECORD).
CVDA values for the RECORDING option are ON and OFF:
- ON
- The recording of interval and unsolicited statistics is active. Counters are incremented as usual, and are reset at the expiry of each interval and at the end-of-day time.
- OFF
- The recording of interval and unsolicited statistics is not active. Counters are still incremented as usual and the end-of-day recording is still made.