Control parameters of the DFHSTUP program

This topic describes the parameters that you can use to control the output of statistics data by the DFHSTUP program.

Note:
If you want the statistics output in uppercase only, you must code the UPPERCASE=YES parameter first in the parameter list.

If you do not code any parameter, the DFHSTUP program formats all the collection types for all APPLIDs, to a page size of 60 lines.

SELECT APPLID={applid|(applid1[,applid2]..[,applidN])}
specifies the applids of the CICS® regions for which you want statistics to be formatted and printed. The parameter keywords must be coded as shown, with one blank between the two words. Code only one SELECT APPLID parameter or one IGNORE APPLID parameter, with up to 250 APPLIDs. If you specify more than 250 APPLIDs, the results are unpredictable.

If your CICS regions are defined with both generic and specific APPLIDs, it is the specific APPLID that you must specify on the SELECT APPLID parameter.

If you do not code this parameter, the DFHSTUP program reports statistics for all APPLIDs found in the DFHSTATS data set, other than those APPLIDs specified on an IGNORE APPLID parameter.

IGNORE APPLID={applid|(applid1[,applid2]..[,applidN])}
specifies the APPLIDs of the CICS regions for which you want the statistics ignored. The parameter keywords must be coded as shown, with one blank between the two keywords. Code only one SELECT APPLID parameter or one IGNORE APPLID parameter, with up to 250 APPLIDs. If you specify two or more APPLIDs, you must enclose them in parentheses, and separate them by commas. If you specify more than 250 APPLIDs, the results are unpredictable.

If your CICS regions are defined with both generic and specific APPLIDs, it is the specific APPLID that you must specify on the IGNORE APPLID parameter.

If you do not code this parameter, the DFHSTUP program reports statistics for all APPLIDs found in the DFHSTATS data set, according to the SELECT APPLID parameter.

SELECT TYPE={type|(type1[,type2]...[,typeN])}
specifies the resource types for which you want statistics to be formatted and printed. The parameter keywords must be coded as shown, with one blank between the two words. If you specify two or more resource types, you must enclose them in parentheses, and separate them by commas.

Code either the SELECT TYPE parameter or the IGNORE TYPE parameter but not both.

If you do not code this parameter, the DFHSTUP program reports statistics for all resource types found in the DFHSTATS data set, other than those resource types specified on an IGNORE TYPE parameter.

The resource types that you can code on the SELECT TYPE parameter are listed below.

When you use SELECT TYPE, if you want to reduce the size of your statistics reports, you can code the summary resource types DB2CONN, LOADER, TRANMGR and TRANDATA instead of the complete resource types DB2, PROGRAM, TDQUEUE and TRANSACTION. To get an overview statistics report, comprising Transaction Manager Global statistics, Dispatcher Global statistics, Loader Global statistics and Storage Manager statistics, code the OVERVIEW resource type.

IGNORE TYPE={type|(type1[,type2]...[,typeN])}
specifies the resource types for which you want the statistics ignored. The parameter keywords must be coded as shown, with one blank between the two keywords. If you specify two or more resource types, you must enclose them in parentheses, and separate them by commas.

Code either the SELECT TYPE parameter or the IGNORE TYPE parameter but not both. When you use IGNORE TYPE, you can code most of the resource types listed above for the SELECT TYPE parameter, except for the OVERVIEW resource type and the summary resource types (DB2CONN, LOADER, TRANMGR and TRANDATA). The IGNORE TYPE parameter can only be used to ignore complete resource types, and it does not ignore resource types that are subsets or combinations of other resource types.

If you do not code this parameter, the DFHSTUP program reports statistics for the resource types found in the DFHSTATS data set, depending on the SELECT TYPE parameter.

COLLECTION TYPE={ALL3|[,INT][,EOD][,REQ][,RRT][,USS]}
specifies the statistics records to be included in the formatted reports for the selected APPLIDs, according to their collection type. The parameter keywords must be coded as shown, with one blank between the two words. The operands are as follows:
ALL
Format the statistics for all types of collection, for all the specified APPLIDs. This is normally the default. However, if you specify the EXTRACT control parameter but not COLLECTION TYPE, only the extract exit is invoked and no other statistics output is produced.
INT
Format the statistics that were collected at specified intervals, for all of the selected APPLIDs.
EOD
Format end-of-day type statistics for all of the selected APPLIDs. The end-of-day collection type is simply another interval collection, being the final collection of statistics for the last interval at the time of shut down or logical end-of-day. Because the specified interval over which interval statistics are being collected may not have elapsed, the actual interval spanning the end-of-day collection can be a short interval.
REQ
Format requested statistics for all of the selected APPLIDs.
RRT
Format requested reset statistics for all of the selected APPLIDs. These are statistics asked for by using the CEMT or EXEC CICS PERFORM STATISTICS RESETNOW command or, when changing the statistics recording status, the CEMT or EXEC CICS SET STATISTICS ON|OFF RECORDNOW RESETNOW command.
USS
Format unsolicited statistics for all of the selected APPLIDs. CICS collects unsolicited statistics for:
Autoinstall
Whenever an autoinstalled terminal entry in the TCT is deleted (after the terminal logs off), CICS collects statistics covering the autoinstalled period since the last interval. This period covers any delay interval specified on the SIT parameter AILDELAY.

If an autoinstall terminal logs on again before the expiry of the delay interval, the accumulation of statistics continues until the next interval. At that interval, the accumulation of statistics is restarted.

CorbaServer
Whenever a CorbaServer is discarded, CICS collects the statistics for that CorbaServer covering the period from the last interval.
DBCTL
Whenever CICS disconnects from DBCTL, CICS collects the statistics covering the whole of the DBCTL connection period.
DB2
Whenever CICS disconnects from DB2, CICS collects the statistics for the DB2 connection and all DB2ENTRYs covering the period from the last interval.

Whenever a DB2ENTRY is discarded, CICS collects the statistics for that DB2ENTRY covering the period from the last interval.

FEPI connections
Unsolicited connection statistics are produced when a connection is destroyed. This could occur with a DISCARD TARGET, DISCARD NODE, DISCARD POOL, DELETE POOL, DISCARD NODELIST, or DISCARD TARGETLIST command is used.
FEPI pools
Unsolicited Pool statistics are produced when a pool is discarded (DISCARD POOL or DELETE POOL).
FEPI targets
Unsolicited target statistics are produced when a target is destroyed or removed from a pool. This occurs when a DELETE POOL, DISCARD POOL, DISCARD TARGET, or DISCARD TARGETLIST command is used.
Files
Whenever CICS closes a file, CICS collects statistics covering the period from the last interval.
Journalnames
Unsolicited Journalnames statistics are produced when a journalname is discarded (DISCARD JOURNALNAME).
Logstreams
Unsolicited Logstream statistics are produced when a logstream is disconnected from the MVS™ logger.
LSRpool
When CICS closes the last file in an LSRpool, CICS collects the statistics for the LSRpool. The following peak values are reset to the current value at each interval collection:
  • Peak number of requests waiting for a string
  • Maximum number of concurrent active file control strings.

The other statistics, which are not reset at an interval collection, cover the entire period from the time the LSRpool is created (when the first file is opened) until the LSRpool is deleted (when the last file is closed).

Start of changePipelineEnd of change
Start of changeWhenever a pipeline is discarded, CICS collects the statistics for that pipeline covering the period from the last interval.End of change
Programs
Whenever an installed program definition is discarded, CICS collects the statistics covering the installed period since the last interval.
Requestmodel
Whenever a Requestmodel is discarded, CICS collects the statistics for that Requestmodel covering the period from the last interval.
System dumps
Whenever a system dump table entry is deleted, CICS collects the statistics covering the period since the last interval.
TCP/IP services
Unsolicited TCP/IP service statistics are produced whenever a TCP/IP service is closed.
Transactions
Whenever an installed transaction definition is discarded, CICS collects the statistics covering the installed period since the last interval.
Transaction classes
Whenever an installed transaction class definition is discarded, CICS collects the statistics covering the installed period since the last interval.
Transaction dumps
Whenever a transaction dump table entry is deleted, CICS collects the statistics covering the period since the last interval.
Transient data queues
Unsolicited Transient data queue statistics are produced when a transient data queue is discarded (DISCARD TDQUEUE), or when an extrapartition transient data queue is closed.
Start of changeURIMAP definitionsEnd of change
Start of changeWhenever a URIMAP definition is discarded, CICS collects the statistics for that definition covering the period from the last interval.End of change
Start of changeWEBSERVICE definitionsEnd of change
Start of changeWhenever a WEBSERVICE definition is discarded, CICS collects the statistics for that definition covering the period from the last interval.End of change
EXTRACT USERPROGRAM=progname
specifies a user program that can process statistics records to create reports of statistics data allowing you to produce tailored statistics reports.
USERPROGRAM
is the name of the user-written program that is to process the data retrieved by the EXTRACT command. You must supply a USERPROGRAM value.

Specifying the EXTRACT exit changes the default DFHSTUP report settings. If you specify only the EXTRACT exit, only the extract exit is driven; other DFHSTUP reports are suppressed. If the EXTRACT control statement is specified, other statistics report control statements, such as SUMMARY, must also be specified to ensure that the appropriate reports are produced. See The DFHSTUP extract statistics reporting function for guidance.

TIME START=hh.mm.ss,STOP=hh.mm.ss,ELAPSED|DAILY
specifies that the DFHSTUP program is to print only the statistics collected during the specified period. The period is determined by a combination of the START time to STOP time, the ELAPSED|DAILY keyword and the DATE parameter as follows:
ELAPSED
This is the default. If ELAPSED is coded, DFHSTUP will process every statistics record between the DATE START and TIME START until the DATE STOP and TIME STOP.
DAILY
If DAILY is coded. DFHSTUP will process every statistics record between the TIME START and TIME STOP for each day between the specified DATE START and DATE STOP.
If no DATE parameter is coded, statistics collected during the specified period are printed regardless of the date on which they were collected. The parameter keywords must be coded exactly as shown, with one blank between the first two words, and with both START and STOP times specified. The start and stop times must be specified as:
hh.mm.ss
where:
  • hh = number of hours (24 hour clock notation)
  • mm = number of minutes
  • ss = number of seconds.
Notes:
  1. If the specified period (START time to STOP time) spans across midnight, you must also code the DATE parameter.
  2. If interval statistics are not collected and written to the SMF data set during the specified period (START time to STOP time), DFHSTUP might not be able to show you the information you are looking for. If you want to see a particular piece of information, ensure that your specified period covers a statistics collection that includes the item you want.

    For example, you might want to see statistics relating to a transaction that was run at 10:00 hours. If your recording interval is set at the default, 3 hours, then interval statistics are written to the SMF data set at 09:00 hours, and again at 12:00 hours. If you run DFHSTUP specifying a START time of 09:30 and a STOP time of 10:30, DFHSTUP will not show you the statistics relating to the transaction that was run at 10:00 hours, because the SMF data set during that period contains only the interval statistics that were collected at 09:00 hours. The statistics relating to the transaction that was run at 10:00 hours will be written to the SMF data set at the next statistics collection, at 12:00 hours.

    The times of statistics collections are controlled by the system initialization parameters STATINT and STATEOD. You can also perform a statistics collection at any time using the CEMT or EXEC CICS PERFORM STATISTICS RECORD command. In the example above, if you did not want to wait till 12:00 hours to see statistics relating to the transaction that was run at 10:00 hours, you could enter the PERFORM STATISTICS RECORD command to perform a statistics collection, and then run DFHSTUP, specifying a period that includes the time when you entered the command.

Examples

  1. To process every statistics record written between 10th September 2001 at 10:00 hours and 16th September 2001 at 20:00 hours, you can code the following TIME and DATE control statements:

    TIME START=10.00.00,STOP=20.00.00,ELAPSED

    DATE START=09/10/2001,STOP=09/16/2001

  2. To process every statistics record written between 10:00 hours and 20:00 hours each day starting on 10th September 2001 and stopping on 16th September 2001, you can code the following TIME and DATE control statements:

    TIME START=10.00.00,STOP=20.00.00,DAILY

    DATE START=09/10/2001,STOP=09/16/2001

DATE START=mm/dd/yy or mm/dd/yyyy,STOP=mm/dd/yy or mm/dd/yyyy
specifies that the DFHSTUP program is to print only statistics collected during the specified period (START date to STOP date). This parameter should be used in conjunction with the TIME parameter. If no TIME parameter is coded, statistics collected at any time during the specified period are printed. The parameter keywords must be coded exactly as shown, with one blank between the first two words, and with both START and STOP dates specified. The start and stop dates must be specified as:
mm/dd/yy or mm/dd/yyyy
where:
  • mm = month of the year
  • dd = day of the month
  • yy = year of the twentieth century
  • yyyy = year

For the twenty-first century the year must be represented by yyyy. If yy is coded the twentieth century is assumed. For example, a date of 12/20/96 is for the 20th December 1996 and a date of 12/20/2005 is for the 20th December 2005.

PAGE SIZE=number
specifies the number of lines to be formatted per page, in the range 20 to 99. The default page size is 60 lines.
SUMMARY
specifies that the DFHSTUP program is to produce a summary report for each APPLID selected. A summary report is composed by adding together the statistics contained in the interval, requested reset, end-of-day, and unsolicited collections. The summary report statistics are listed in almost the same order as interval and end-of-day reports. The only difference is that DBCTL statistics appear at the end of the summary. DBCTL statistics are unsolicited only, so you do not get them for interval, requested reset, or end-of-day collections.

The DFHSTUP reports list statistics records in the following type order:

Note:
The statistics produced in the summary report for SELECT TYPE(LSRPOOL) do not contain buffer information for individual LSR pools.

If the SMF data set (or data sets) contains CICS statistics from several runs of CICS with the same applid, you must use the TIME parameter, and if necessary the DATE parameter, to produce the summary report for one run of CICS. If you do not use the TIME and DATE parameters to specify one of several runs of CICS, the results are unpredictable.

You can save a lot of paper if you code this parameter and omit the COLLECTION TYPE parameter.

If this parameter is not coded, a summary report is not produced.

UPPERCASE=YES
specifies that the statistics output is to be in uppercase only. The parameter must be coded as shown in uppercase characters with no spaces between words. The parameter must be the first one coded in the parameter list. If you want output in mixed case (the default), do not code this parameter. This parameter is ignored in an EXTRACT report.

Related reference
Statistics utility program (DFHSTUP)
Setting the statistics recording status, end-of-day time and recording interval
The DFHSTUP extract statistics reporting function
Job to run the DFHSTUP program

3.
ALL is not the default if you specify the EXTRACT exit

[[ Contents Previous Page | Next Page Index ]]