Introduction
When you install CICS® Transaction Gateway, a C header file and a IBM® z/OS® assembler copy macro are provided to define the SMF record structure. The C header file is CTGSMF, located in the SCTGINCL data set and the IBM z/OS assembler copy macro is file CTGSMFA, located in the SCTGMAC data set.
Figure 1. SMF record format
- SMF header data structure
The format of the header for the SMF record for type 111 records is fixed and is common to SMF records from other CICS products. The Gateway daemon completes the following fields that are marked with "*". The SMF subsystem fills in the rest of the fields. User applications are not required to complete any SMF fields. - SMF product section data structure
The Gateway daemon fills in all the fields in the generic product section for the SMF record for type 111 records. Parts of the record are of fixed format and common to all SMF products. Some parts of this record are specific to CICS Transaction Gateway and have the prefix "CTG". - Statistics record header
The data section contains a number of statistics records. Each statistics record has a header. The header is common to all CICS Transaction Gateway statistics records. You can work out the type of data that follows the record from the CTG_RECORDID and CTG_RECVER fields. - Connection Manager (CM) statistics SMF data
CICS Transaction Gateway CM statistics use this format for writing SMF records. - CICS Server all (CS) statistics SMF data
CICS Transaction Gateway CS statistics use this format for writing SMF records. - CICS Server Instance (CSx) SMF statistics for EXCI
CICS Transaction Gateway statistics records normally have only one instance. The exceptions are CSx and WSx statistics. - CICS Server Instance (CSx) SMF statistics for IPIC
CICS Transaction Gateway statistics records normally have only one instance. The exceptions are CSx and WSx statistics. - Gateway daemon (GD) statistics SMF data
CICS Transaction Gateway daemon statistics use this format for writing SMF records. - Protocol handler (PH) statistics SMF data
CICS Transaction Gateway PH statistics have this format. - System environment (SE) statistics SMF data
CICS Transaction Gateway SE statistics have this format. - Worker thread (WT) statistics SMF data
CICS Transaction Gateway WT statistics have this format. - Web service all (WS) statistics SMF data
CICS Transaction Gateway WS statistics use this format for writing SMF records. - Web service instance (WSx) SMF statistics
CICS Transaction Gateway statistics records normally have only one instance. The exceptions are CSx and WSx statistics. - SMF date format - byte packed date format
Definition of the format used to represent dates in SMF. - SMF data format - sample values
Sample values for CTG_COLTIME and CTG_LOCOFFSET.
Fields
Stored in ctgip
| SMF Field | DB Column name | Description | Unit |
|---|---|---|---|
| ctghd_rty | Value is always CTG7 | ||
| SMF11_SID | ctghd_sid | SID | |
| SMF111_SDTE | ctghd_dttm | Date-Time the record was written | |
| SMF111_VRM | ctghd_vrm | Record version | |
| SMF111_PRN | ctghd_prn | Generic Product Name | |
| SMF111_SPN | ctghd_spn | Gateway daemon identifier | |
| CTG_STATTYPE | ctghd_statype | Statistics type. This event drives the statistic to be recorded | |
| CTG_COLDATE CTG_COLTIME |
ctghd_coldttm | Collection date and time | |
| CTG_LOCOFFSET | ctghd_locoffset | Offset from GMT to local time | second |
| CTG_LSTRESET | ctghd_lstreset | Last reset time or initialization time | second |
| CTG_INTERVAL | ctghd_interval | Length of time remaining before the next interval. | second |
| CTG_INTVCOUNT | ctghd_intvcount | A sequence number that increments each time an interval is requested | |
| CTG_STARTDATE CTG_STARTTIME |
ctghd_startdttm | Gateway start date and time | |
| CTG_CSX_IPIC_SERVER | ctgip_server | CICS server name | |
| CTG_CSX_IPIC_IREQDATA | ctgip_ireqdata | The amount of request data sent to connected CICS server x. This amount includes both application and CICS protocol data | byte |
| CTG_CSX_IPIC_LREQDATA | ctgip_lreqdata | The amount of request data sent to connected CICS server x. This amount includes both application and CICS protocol data. For IPIC, the data comprises COMMAREA and CICS headers. | byte |
| CTG_CSX_IPIC_IRESPDATA | ctgip_irespdata | The amount of response data received from connected CICS server x. This amount includes both application and CICS protocol data. | byte |
| CTG_CSX_IPIC_lRESPDATA | ctgip_lrespdata | The amount of response data received from connected CICS server x. This amount includes both application and CICS protocol data. For IPIC, the data comprises COMMAREA and CICS headers. | byte |
| CTG_CSX_IPIC_IALLREQ | ctgip_iallreq | The number of requests to CICS server x (successful and failed) that have been processed. | |
| CTG_CSX_IPIC_lALLREQ | ctgip_lallreq | The number of requests to CICS server x (successful and failed) that have been processed. | |
| CTG_CSX_IPIC_ICONNFAIL | ctgip_iconnfail | The number of times an attempt to connect to a CICS server has failed. | |
| CTG_CSX_IPIC_LCONNFAIL | ctgip_lconnfail | The number of times an attempt to connect to a CICS server has failed. | |
| CTG_CSX_IPIC_ILOSTCONN | ctgip_ilostconn | The number of times an established connection with a CICS server has been lost. | |
| CTG_CSX_IPIC_lLOSTCONN | ctgip_llostconn | The number of times an established connection with a CICS server has been lost. | |
| CTG_CSX_IPIC_IIDLETIMEOUT | ctgip_iidletimeout | The number of times a connection to CICS server x has timed out. | |
| CTG_CSX_IPIC_LIDLETIMEOUT | ctgip_lidletimeout | The number of times a connection to CICS server x has timed out. | |
| CTG_CSX_IPIC_SIPADDR | ctgip_sipaddr | CICS server TCP/IP address | |
| CTG_CSX_IPIC_SIPPORT | ctgip_sipport | CICS server TCP/IP port | |
| CTG_CSX_IPIC_CSESSCURR | ctgip_csesscurr | Number of IPIC sessions in use | |
| CTG_CSX_IPIC_CSESSMAX | ctgip_csessmax | Number of negotiated IPIC sessions | |
| CTG_CSX_IPIC_SSESSMAX | ctgip_ssessmax | Number of requested IPIC sessions | |
| CTG_CSX_IPIC_LSESSFAIL | ctgip_lsessfail | Number of IPIC session failures | |
| CTG_CSX_IPIC_ISESSFAIL | ctgip_isessfail | Number of IPIC session failures | |
| CTG_CSX_IPIC_SPROTOCOL | ctgip_sprotocol | CICS server protocol | |
| CTG_CSX_IPIC_LCOMMSFAIL | ctgip_lcommsfail | Number of CICS communication failures | |
| CTG_CSX_IPIC_ICOMMSFAIL | ctgip_icommsfail | Number of CICS communication failures | |
| CTG_CSX_IPIC_CWAITING | ctgip_cwaiting | Number of requests waiting on a response | |
| CTG_CSX_IPIC_IAVRESP | ctgip_iavresp | The average time taken for connected CICS server x to respond to the Gateway daemon. | millisecond |
| CTG_CSX_IPIC_LAVRESP | ctgip_lavresp | The average time taken for connected CICS server x to respond. | millisecond |
| CTG_CSX_IPIC_CAPPLIDQ | ctgip_capplidq | IPIC network ID of CICS server | |
| CTG_CSX_IPIC_CAPPLID | ctgip_capplid | APPLID of CICS server | |
| CTG_CSX_IPIC_CSTATUS | ctgip_cstatus | CICS server status |