Table 102 summarizes the statistics domain’s specific
gate. It shows the level-1 trace point IDs of the modules providing the functions
for the gate, the functions provided by the gate, and whether or not the functions
are available through the exit programming interface (XPI).
Table 102. Statistics domain’s specific gate
Gate |
Trace |
Function |
XPI |
STST |
ST 0003
ST 0004
|
INQ_STATISTICS_OPTIONS
SET_STATISTICS_OPTIONS
REQUEST_STATISTICS
RECORD_STATISTICS
STATISTICS_COLLECTION
DISABLE_STATISTICS
|
NO
NO
NO
NO
NO
NO
|
The INQ_STATISTICS_OPTIONS function of the STST gate is used to return
information associated with the statistics domain options.
Input parameters
None.
Output parameters
- COLLECT
- indicates whether interval statistics are being collected (and their
counts reset). It can have either of these values:
YES|NO
- INTERVAL
- is the interval at which statistics are being collected if COLLECT is
YES.
- EOD_TIME_OF_DAY
- is the time of day at which end-of-day statistics are collected.
- NEXT_COLLECTION_TIME
- is the time of the next collection of statistics. If COLLECT is YES,
it is the earlier of the next interval collection time and the logical end-of-day
time; if COLLECT is NO, it is the logical end-of-day time.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|INVALID|KERNERROR|DISASTER
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
The SET_STATISTICS_OPTIONS function of the STST gate is used to set statistics
options.
Input parameters
- [COLLECT]
- indicates whether interval statistics are to be collected (and their
counts reset). It can have either of these values:
YES|NO
- [INTERVAL]
- is the interval at which statistics are to be collected if COLLECT is
YES.
- [EOD_TIME_OF_DAY]
- is the time of day at which end-of-day statistics are to be collected.
- [COLLECT_UPDATE_ACTION]
- is the action to be taken when changing the COLLECT option value from
NO to YES, or from YES to NO. It can have any one of these values:
NOACTION|RESETNOW|RECORDNOW|RECORD_RESETNOW
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|INVALID|KERNERROR|DISASTER
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
EXCEPTION |
COLL_ACTION_NO_UPDATE |
INVALID |
INVALID_COLLECT
INVALID_INTERVAL
INVALID_EOD_TIME_OF_DAY
INV_COLL_UPDATE_ACTION
|
The REQUEST_STATISTICS function of the STST gate is used to request a collection
of statistics.
Input parameters
- [DOMAIN_TOKEN]
- identifies the domain from which the statistics are to be collected.
- [RESOURCE_TYPE]
- indicates the resource in the AP domain on which statistics are to be
collected.
- REQUEST_TOKEN
- uniquely identifies the collection of statistics requested by the caller.
- RESET
- indicates whether certain statistics fields are to be reset.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|INVALID|EXCEPTION|PURGED|KERNERROR|DISASTER
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
EXCEPTION |
TYPE_NOT_FOUND
NOT_AVAILABLE
INCOMPLETE_DATA
|
INVALID |
INVALID_RESET |
The RECORD_STATISTICS function of the STST gate is used to record statistics.
Input parameters
- STATISTICS_DATA
- specifies the address and length of data requested.
- STATISTICS_TYPE
- indicates the type of statistics collection, either a normal collection
or unsolicited. It can have either of these values:
COLLECTION|USS
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|INVALID|KERNERROR|DISASTER
- [REASON]
- is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
INVALID |
INVALID_DATA_FORMAT |
The STATISTICS_COLLECTION function of the STST gate is used to initiate
a collection of statistics.
Input parameters
- RESET
- indicates whether certain statistics fields are to be reset.
- DATA
- indicates whether the domain being called is requested to return its
statistics to the caller.
- END_OF_DAY
- indicates whether all statistics fields are to be reset.
- COLLECTION_TYPE
- indicates whether this is an interval collection or end-of-day collection
of statistics. It can have either of these values:
INT|EOD
- [SYSTEM_TERMINATING]
- indicates whether this is the last collection for the CICS® run. It can
have either of these values:
YES|NO
YES is used for the end-of-day
collection that is taken when CICS is shut down.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|INVALID|KERNERROR|DISASTER
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
The DISABLE_STATISTICS function of the STST gate is used to disable statistics
interval collections.
Input parameters
None.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|INVALID|KERNERROR|DISASTER
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
[[ Contents Previous Page | Next Page Index ]]