SET STATISTICS

Changes some of the values that control the accumulation and recording of CICS® statistics.

Syntax

SET STATISTICS

Read syntax diagramSkip visual syntax diagramSET STATISTICS( name)ENDOFDAY( hhmmss)ENDOFDAYHRS( data-value)ENDOFDAYMINS( data-value)ENDOFDAYSECS( data-value)INTERVAL( hhmmss)INTERVALHRS( data-value)INTERVALMINS( data-value)INTERVALSECS( data-value)RECORDING( cvda)

Condition: INVREQ

Note: Not supported for C or C++ programs.

 

For more information about the use of CICS-value data areas (CVDAs), see CVDAs recognized by the translator.

Description

SET STATISTICS allows you to change some of the values that control 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 that is in the Region Definitions (RD).

Two formats for the ENDOFDAY and INTERVAL options are possible:

The arrival of the end-of-day time, as set 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.

Changing the end-of-day value has no effect on the times at which INTERVAL statistics are recorded until the new end-of-day time is reached. At the new end-of-day time, the current interval is ended, as described in the previous paragraph, and a new interval is started.

When you change any of the INTERVAL values (and also when CICS is initialized), the length of the current (or first) interval is adjusted so that it expires after an integral number of intervals from the end-of-day time.

Options

ENDOFDAY(hhmmss)
(This option is for COBOL only.) This option specifies the time at which you want CICS to record the values of the statistics counters in an operating system file and to reset them ready for the next recording period. The valid range of ENDOFDAY time is 000000 through 235959.

The end-of-day time is specified by using either the ENDOFDAY option or a combination of the ENDOFDAYHRS, ENDOFDAYMINS, and ENDOFDAYSECS options. The default end-of-day time is 12 midnight (000000).

ENDOFDAYHRS(value)
Specifies, as 32-bit binary values, the hours portion of the individual end-of-day options. (Used with ENDOFDAYMINS and ENDOFDAYSECS.) When more than one of these options is specified, the allowed ranges are:
  • ENDOFDAYHRS 0 through 23
  • ENDOFDAYMINS 0 through 59
  • ENDOFDAYSECS 0 through 59

These values are concatenated and checked to be in the range 00:00:00 through 23:59:59. A value that is not specified defaults to zero.

When only one of these values is specified, the two missing values default to zero. The allowed ranges are:
  • ENDOFDAYHRS 0 through 23
  • ENDOFDAYMINS 0 through 1439
  • ENDOFDAYSECS 0 through 86399
ENDOFDAYMINS(value)
Specifies, as 32-bit binary values, the minutes portion of the individual end-of-day options. (Used with ENDOFDAYHRS and ENDOFDAYSECS.) When more than one of these options is specified, the allowed ranges are:
  • ENDOFDAYHRS 0 through 23
  • ENDOFDAYMINS 0 through 59
  • ENDOFDAYSECS 0 through 59

These values are concatenated and checked to be in the range 00:00:00 through 23:59:59. A value that is not specified defaults to zero.

When only one of these values is specified, the two missing values default to zero. The allowed ranges are:
  • ENDOFDAYHRS 0 through 23
  • ENDOFDAYMINS 0 through 1439
  • ENDOFDAYSECS 0 through 86399
ENDOFDAYSECS(value)
Specifies, as 32-bit binary values, the seconds portion of the individual end-of-day options. (Used with ENDOFDAYHRS and ENDOFDAYMINS.) When more than one of these options is specified, the allowed ranges are:
  • ENDOFDAYHRS 0 through 23
  • ENDOFDAYMINS 0 through 59
  • ENDOFDAYSECS 0 through 59

These values are concatenated and checked to be in the range 00:00:00 through 23:59:59. A value that is not specified defaults to zero.

When only one of these values is specified, the two missing values default to zero. The allowed ranges are:
  • ENDOFDAYHRS 0 through 23
  • ENDOFDAYMINS 0 through 1439
  • ENDOFDAYSECS 0 through 86399
INTERVAL(hhmmss)
(This option is for COBOL only.) This option specifies the interval of time during which the statistics counters are incremented. At the end of each interval, the statistics are recorded and the statistics counters are reset. The interval time is specified by using either the INTERVAL option or a combination of the INTERVALHRS, INTERVALMINS, and INTERVALSECS options. The default interval is 3 hours (030000). The valid range of INTERVAL is 000100 to 240000.
Note: INTERVAL is calculated from the end-of-day time.
INTERVALHRS(value)
Specifies, as 32-bit binary values, the hours portion of the individual interval options. (Used with INTERVALMINS and INTERVALSECS.) The possible settings are similar to those for the end-of-day options but not identical because some allowed ranges are different.
When more than one value is specified, the allowed ranges are:
  • INTERVALHRS 0 through 24
  • INTERVALMINS 0 through 59
  • INTERVALSECS 0 through 59

The values are concatenated and checked to be in the range 1 minute through 24 hours. A value that is not specified defaults to zero.

When only one of the values is set up, the missing values default to zero. The allowed ranges are:
  • INTERVALHRS 1 through 24
  • INTERVALMINS 1 through 1440
  • INTERVALSECS 60 through 86400

These interval collections occur only if the RECORDING status is set to ON. You can set the statistics recording status ON (or OFF) by using the RECORDING option on this command, or you can set it ON initially by setting the StatsRecord attribute that is in the RD to yes.

Note: INTERVALHRS is calculated from the end-of-day time.
INTERVALMINS(value)
Specifies, as 32-bit binary values, the minutes portion of the individual interval options. (Used with INTERVALHRS and INTERVALSECS.) The possible settings are similar to those for the end-of-day options but not identical because some allowed ranges are different.
When more than one value is specified, the allowed ranges are:
  • INTERVALHRS 0 through 24
  • INTERVALMINS 0 through 59
  • INTERVALSECS 0 through 59

The values are concatenated and checked to be in the range 1 minute through 24 hours. A value that is not specified defaults to zero.

When only one of the values is set up, the missing values default to zero. The allowed ranges are:
  • INTERVALHRS 1 through 24
  • INTERVALMINS 1 through 1440
  • INTERVALSECS 60 through 86400

These interval collections occur only if the RECORDING status is set to ON. You can set the statistics recording status ON (or OFF) by using the RECORDING option on this command, or you can set it ON initially by setting the StatsRecord attribute in the RD to yes.

Note: INTERVALMINS is calculated from the end-of-day time.
INTERVALSECS(value)
Specifies, as 32-bit binary values, the seconds portion of the individual interval options. (Used with INTERVALHRS and INTERVALMINS.) The possible settings are similar to those for the end-of-day options but not identical because some allowed ranges are different.
When more than one value is specified, the allowed ranges are:
  • INTERVALHRS 0 through 24
  • INTERVALMINS 0 through 59
  • INTERVALSECS 0 through 59

The values are concatenated and checked to be in the range 1 minute through 24 hours. A value that is not specified defaults to zero.

When only one of the values is set up, the missing values default to zero. The allowed ranges are:
  • INTERVALHRS 1 through 24
  • INTERVALMINS 1 through 1440
  • INTERVALSECS 60 through 86400

These interval collections occur only if the RECORDING status is set to ON. You can set the statistics recording status ON (or OFF) by using the RECORDING option on this command, or you can set it ON initially by setting the StatsRecord attribute in the RD to yes.

Note: INTERVALSECS is calculated from the end-of-day time.
RECORDING(cvda)
Specifies whether CICS is to record the 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 that are called for by a PERFORM STATISTICS RECORD command, which is described in PERFORM STATISTICS RECORD.) Valid CVDA values for the RECORDING option are ON and OFF:
ON
Switches on the recording of interval and unsolicited statistics. Counters are incremented as usual, and are reset at the expiry of each interval and at the end-of-day time.
OFF
Switches off the recording of interval and unsolicited statistics. Counters are still incremented as usual and the end-of-day recording is still made.

Conditions

INVREQ
Occurs for the following conditions, depending on the options that are specified on the SET STATISTICS command:
  • The specified interval time is outside the range (RESP2=1).
  • The specified end-of-day time is outside the range (RESP2=2).
  • RECORDING has an invalid CVDA value (RESP2=3).

Default action: Terminates the task abnormally.