LOGGER - System Logger report and extract

The LOGGER operand requests the System Logger report or extract.

The command format for the System Logger report is:

CICSPA LOGGER(
            [OUTPUT(ddname),]
            [EXTERNAL(ddname),]
            [SUMMARY[(SUMMARYINTERVAL(hh:mm))],]
            [LIST[(ALTER,TIMESEQ)],]
            [INTERVAL(minutes),]
            [SORT(LOGSTREAM|STRUCTURE),]
            [TITLE1('...up to 64 characters...'),]
            [TITLE2('...up to 64 characters...'),]
            [SELECT(LOGGER(INCLUDE|EXCLUDE(field1(values1),...), ...))]
            [LOGSTREAM('name.or.pattern'),]
            [STRUCTURE('name.or.pattern'),])

The command format for the System Logger extract is:

CICSPA LOGGER( 
            [OUTPUT(ddname),]
            [DDNAME(ddname),]
            [DELIMIT('field-delimiter'),]
            [LABELS|NOLABELS,]
            [FLOAT,]
            [SELECT(LOGGER(INCLUDE|EXCLUDE(field1(values1),...), ...))]
            [LOGSTREAM('name.or.pattern'),]
            [STRUCTURE('name.or.pattern'),])
The options are:
OUTPUT
Controls the report output DDname. See OUTPUT for further information. If not specified, CICS PA assigns a DDname in the format xxxxnnnn where nnnn is the report sequence number 0001-9999 to uniquely identify the output, and xxxx is:
  • LOGR for the System Logger report.
  • LOEX for the Recap report for the System Logger extract.
DDNAME
Specifies the DDname of the extract data set where the extracted data is written. When this operand is specified, instead of producing the report, CICS PA produces the extract file, and a Recap of the extract process is written to the OUTPUT operand report file.

The DDname can be up to 8 alphanumeric characters, with the first non-numeric. The CICS PA dialog assigns DDnames in the format CPAOEXnn where nn is the extract sequence number 01-99. (See the sample JCL in Figure 1).

DELIMIT
Specifies the field delimiter, enclosed in quotes, to be used to separate each data field in the extract data set. The default is a semicolon DELIMIT(';').
LABELS|NOLABELS
LABELS indicates that the first record to be written to the extract data set is to be a field labels record. This is the default.

NOLABELS indicates that CICS PA is not to write a field labels record to the extract data set.

FLOAT
Write numeric fields in the extract in S390 FLOAT format.

Specify FLOAT format if you plan to import the extract into a DB2® table. When the DB2 Load Utility is used, it will interpret all numerical fields reliably and consistently in FLOAT format.

If FLOAT is not specified, the numeric fields are written in a mixture of integer, real and exponential using character digits. This is the default and is suitable when importing the extract data into a PC spreadsheet tool.

EXTERNAL
Specifies the DDname for the work data set used by the external sort facility. If not specified, CICS PA assigns an External Work File from a pool of External Work Files with DDnames in the format CPAXWnnn where nnn is the sequence number 001-999. See EXTERNAL for further information.
SUMMARY
Requests the System Logger Logstream Summary and Structure Summary reports. This is the default.

To present a single summary of records for the entire reporting period, omit the optional SUMMARYINTERVAL suboperand (this is the default). To summarize records at intervals within the reporting period, specify SUMMARYINTERVAL with a multiple of the SMF reporting interval, from 00:01 to 23:59. For example, if the SMF reporting interval was 5 minutes at the time that the logger records were written, then you can generate a System Logger Summary report that summarizes the logger records at any multiple of 5 minutes: 05:00, 10:00, 15:00 etc.

If you specify SUMMARYINTERVAL, then ensure that the value you specify is an exact multiple of the SMF reporting interval. Otherwise, each of the summaries in the report might not be calculated from the same number of records.

LIST
Requests the System Logger List report, a detailed list of Logstream writes, Logstream deletes, and Logstream events.

Specify ALTER to also report Structure Alter events. These apply to Structures, not individual Logstreams, and are reported with a Logstream name of *ALTER*.

By default, the List report entries are printed in Logstream or Structure name sequence according to the SORT operand. However, by specifying TIMESEQ, the entries are printed in Logstream or Structure name sequence within each Interval expiry period.

INTERVAL
Specifies the SMF global recording interval as specified in the INTVAL parameter of the SMFPRMnn PARMLIB member.

Specify an interval from 1 to 60 minutes. If not specified, CICS PA uses the recording interval in effect on the reporting system. The interval value is used by CICS PA for rate per second calculations in the System Logger Summary reports. If the interval used by CICS PA does not match the data, the total interval and rate calculations will be incorrect.

SORT
Specifies the sort sequence for the List and Summary reports.

Specify LOGSTREAM to sort by Logstream name, MVS™ ID, Structure name, then time stamp. This is the default.

Specify STRUCTURE to sort by Structure name, Logstream name, MVS ID, then time stamp.

LOGSTREAM
Optional filter on Logstream name. Specify a name or pattern enclosed in quotes. Masking characters % and * are allowed. The percent (%) is for a single character substitution and the asterisk (*) is for many or none. For example:
LOGSTREAM('TEST.DFHLOG')
must match exactly
LOGSTREAM('PROD.*')
can match PROD.DFHLOG
LOGSTREAM('PROD.MVSA%')
can match PROD.MVSA1, but not PROD.MVSA1LOG
STRUCTURE
Optional filter on Structure name. Specify a name or pattern enclosed in quotes. Masking characters % and * are allowed. For example:
STRUCTURE('TEST.DFHLOG')
must match exactly
STRUCTURE('PROD.*')
can match PROD.DFHLOG
STRUCTURE('PROD.MVSA%')
can match PROD.MVS1, but not PROD.MVS1LOG
TITLE1, TITLE2
Controls the report title (left and right half of subheading line). See TITLE1 and TITLE2 for further information.
SELECT(LOGGER(INCLUDE|EXCLUDE
Specifies what data to include or exclude from the report or extract based on data field values. See Using SELECT statements for an explanation and examples.