SMF123_01_V2
record type
SMF123_01_V2
records (SMF type 123 subtype 1 version 2 records) contain
data about individual API provider requests and responses for IBM® z/OS® Connect Enterprise Edition.
Data stream definition for SMF123_01_V2 data
Table 1 indicates the configuration values to use in defining this data stream in the Z Common Data Provider Configuration Tool.
Type of node in the policy | Required configuration value |
---|---|
Data Stream | SMF123_01_V2 To select this data stream in the Configuration Tool: In the
Select data streamwindow, click , and select the SMF123_01_V2 check box. |
Filter Transform | Not required |
Subscriber | For the appropriate values, see Subscriber configuration.
Important: When you use the Generic Kafka subscriber protocol, you must select the CSV format. Key-Value format is not supported for this data stream definition.
|
Annotated fields for SMF123_01_V2 data
In the following table, the column that is titled Corresponding SMF field
indicates the name of the SMF field that corresponds to the field name in the annotation.
Field | Description | Corresponding SMF field |
---|---|---|
API_NAME |
API name | SMF123S1_API_NAME |
ELAPSED_TIME |
The time duration, in seconds, for the API request and response | SMF123S1_TIME_ZC_EXIT-F123S1_TIME_ZC_ENTRY |
END_TIME |
The time when the API response completed | TIMESTAMP |
HTTP_RESP_CODE |
HTTP response code | SMF123S1_HTTP_RESP_CODE |
MAX_ELAPSED_TIME |
The time duration, in seconds, for the API request and response | SMF123S1_TIME_ZC_EXIT-F123S1_TIME_ZC_ENTRY |
MAX_SOR_ELAPSED_TIME |
The time duration, in seconds, that is spent in the system of record | SMF123S1_TIME_SOR_RECV-SMF123S1_TIME_SOR_SENT |
MAX_ZCONN_ELAPSED_TIME |
The time duration, in seconds, that the API request and response is spent in z/OS Connect Enterprise Edition | ZCONN_INTV |
MVS_SYSTEM_ID |
The MVS system ID, which is also the SMF system ID | SM123_SID |
REC_COUNT |
For this record type, this value is always 1. | Not applicable |
REQ_HDR1 |
Request header
header1name:header1value |
SMF123S1_REQ_HDR1 |
REQ_HDR2 |
Request header
header2name:header2value |
SMF123S1_REQ_HDR2 |
REQ_HDR3 |
Request header
header3name:header3value |
SMF123S1_REQ_HDR3 |
REQ_HDR4 |
Request header
header4name:header4value |
SMF123S1_REQ_HDR4 |
REQ_ID |
Request identifier that is unique within an z/OS Connect Enterprise Edition server instance | SMF123S1_REQ_ID |
REQ_METHOD This field is used to group records. |
The HTTP request method for this API request, which is, for example, one of
the following values:
|
SMF123S1_REQ_METHOD |
REQ_SIZE |
The payload length, in bytes, for the API request | SMF123S1_REQ_PAYLOAD_LEN |
REQ_TARGET_URI This field is used to group records. |
The target URI for the API request | SMF123S1_REQ_TARGET_URI |
RESP_HDR1 |
Response header
header1name:header1value |
SMF123S1_RESP_HDR1 |
RESP_HDR2 |
Response header
header2name:header2value |
SMF123S1_RESP_HDR2 |
RESP_HDR3 |
Response header
header3name:header3value |
SMF123S1_RESP_HDR3 |
RESP_HDR4 |
Response header
header4name:header4value |
SMF123S1_RESP_HDR4 |
RESP_SIZE |
The payload length, in bytes, for the API response | SMF123S1_RESP_PAYLOAD_LEN |
SERVER_JOBID |
The job ID of the z/OS Connect Enterprise Edition server (JSABJBID) | SMF123_SERVER_JOBID |
SERVER_JOBNAME This field is used to group records. |
The job name of the z/OS Connect Enterprise Edition server (JSABJBNM) | SMF123_SERVER_JOBNAME |
SERVER_STOKEN |
The token that uniquely identifies the address space for the z/OS Connect Enterprise Edition server (ASSBSTKN) | SMF123_SERVER_STOKEN |
SERVER_SYSPLEX |
The name of the sysplex (ECVTSPLX) where the z/OS Connect Enterprise Edition server is running | SMF123_SERVER_SYSPLEX |
SERVER_SYSTEM |
The name of the system (CVTSNAME) where the z/OS Connect Enterprise Edition server is running | SMF123_SERVER_SYSTEM |
SERVICE_NAME This field is used to group records. |
The name of the z/OS Connect Enterprise Edition service that processes the API request | SMF123S1_SERVICE_NAME |
SOR_ELAPSED_TIME |
The time duration, in seconds, that is spent in the system of record | SMF123S1_TIME_SOR_RECV-SMF123S1_TIME_SOR_SENT |
SOR_IDENTIFIER |
The identifier for the system of record. This value is the value of the
'com.ibm.zosconnect.spi.Data.getData( SOR_IDENTIFIER)' method. |
SMF123S1_SOR_IDENTIFIER |
SOR_REFERENCE |
A reference to the element in the server.xml file that
identifies the connection to the system of record. This value is the value of the
'com.ibm.zosconnect.spi.Data.getData( SOR_REFERENCE)' method. |
SMF123S1_SOR_REFERENCE |
SOR_RESOURCE |
The system of record resource. This value is the value of the
'com.ibm.zosconnect.spi.Data.getData( SOR_RESOURCE)' method. |
SMF123S1_SOR_RESOURCE |
SP_NAME |
The service provider name. This value is the value of the
'com.ibm.zosconnect.spi.Data.getData( SERVICE_PROVIDER_NAME)' method. |
SMF123S1_SP_NAME |
START_TIME |
The time when the API request was initiated | TIMESTAMP |
SUB_SYSTEM_ID |
The subsystem ID, which is set by the SUBSYS parameter that is specified in the SMF macros. The default value for the SUBSYS parameter is ZCON. | SM123_SSI |
TIME_SOR_RECV |
The time when the API response was received from the system of record | SMF123S1_TIME_SOR_RECV |
TIME_SOR_SENT |
The time when the API request was sent to the system of record | SMF123S1_TIME_SOR_SENT |
TIME_ZC_ENTRY |
The time when the API request was received by the z/OS Connect Enterprise Edition server | SMF123S1_TIME_ZC_ENTRY |
TIME_ZC_EXIT |
The time when the response was ready to be returned to the HTTP client | SMF123S1_TIME_ZC_EXIT |
TRACKING_TOKEN |
Tracking token | SMF123S1_TRACKING_TOKEN |
USER_NAME |
The user name, which is a distributed or System Authorization Facility (SAF) identity | SMF123S1_USER_NAME |
USER_NAME_MAPPED |
SAF mapped user name | SMF123S1_USER_NAME_MAPPED |
ZCONN_ELAPSED_TIME |
The total time duration, in seconds, for the API request and response in z/OS Connect Enterprise Edition | ZCONN_INTV |