z/OS SMF records for message flow accounting and statistics data

Certain information is written to z/OS® SMF records for message flow accounting and statistics data.

The data records are type 117 records with the following identifiers:

  • BipSMFDate
  • BipSMFRecordHdr
  • BipSMFTriplet
  • BipSMFMessageFlow
  • BipSMFThread
  • BipSMFNode
  • BipSMFTerminal

The following tables describe the contents of each of these records.

The following table describes the contents of the BipSMFDate record.

Field Data type Details
YYYY signed short int 2 byte year
MM char 1 byte month
DD char 1 byte day

The following table describes the contents of the BipSMFRecordHdr record.

Field Data type Details
SM117LEN unsigned short int SMF record length
SM117SEG unsigned short int System reserved
SM117FLG char System indicator
SM117RTY char Record type 117 (x'75')
SM117TME unsigned int Time when SMF moved the record (time since midnight in hundredths of a second)
SM117DTE unsigned int Date when SMF moved the record in packed decimal form 0cyydddF where:
c is 0 (19xx) or 1 (20xx)
yy is the current year (0-99)
ddd is the current day (1-366)
F is the sign
SM117SID unsigned int System ID
SM117SSI unsigned int Subsystem ID
SM117STY unsigned short int Record subtype, one of :
  • 1 (only message flow or threads data is being collected)
  • 2 (node data is being collected)1
SM117TCT unsigned int Count of triplets
SM117SRT unsigned char Record type, one of:
  • Archive
  • Snapshot
SM117SRC unsigned char Record code, one of:
  • 00 = None
  • 01 = Major Interval
  • 02 = Snapshot
  • 03 = Shutdown
  • 04 = Redeploy
  • 05 = Stats Settings Modified
SM117RSQ unsigned short int Sequence number of the record when multiple records are written for a collection interval.
SM117NOR unsigned short int Total number of related records in a collection interval.
Note:
  1. When only nodes data is being collected, a single subtype 2 record is written. If nodes and terminals data is being collected, multiple subtype 2 records are written.

The following table describes the contents of the BipSMFTriplet record.

Field Data type Details
TRPLTOSE signed int Offset of record from start of SMF record
TRPLTDLE signed short int Length of data type
TRPLTNDR signed short int Number of data types in SMF record

The following table describes the contents of the BipSMFMessageFlow record.

Field Data type Details
IMFLID short int Control block hex ID (BipSMFMessageFlow_ID)
IMFLLEN short int Length of control block
IMFLEYE char[4] Eyecatcher (IMFL)
IMFLVER int Version number (BipSMFRecordVersion)
IMFLBKNM1 char[32] Integration node name
IMFLBKID char[36] Integration node universal unique identifier
IMFLEXNM char[32] Integration server name
IMFLEXID char[36] Integration server universal unique identifier
IMFLMFNM1 char[32] Message flow name
IMFLSTDT BipSMFDate Interval start date
IMFLSTTM unsigned int Interval start time (format as for SM117TME)
IMFLSTTS char[26] Interval start date and time (universal timestamp in ISO8601)
IMFLENDT BipSMFDate Interval end date
IMFLENTM unsigned int Interval end time (format as for SM117TME)
IMFLENTS char[26] Interval end date and time (universal timestamp in ISO8601)
IMFLTPTM long long int Total elapsed time spent processing input messages (8 bytes binary, microseconds)
IMFLMXTM long long int Maximum elapsed time spent processing an input message (8 bytes binary, microseconds)
IMFLMNTM long long int Minimum elapsed time spent processing an input message (8 bytes binary, microseconds)
IMFLTPCP long long int Total processor time spent processing input messages (8 bytes binary, microseconds)
IMFLMXCP long long int Maximum processor time spent processing an input message (8 bytes binary, microseconds)
IMFLMNCP long long int Minimum processor time spent processing an input message (8 bytes binary, microseconds)
IMFLWTCP long long int Total processor time spent waiting for input messages (8 bytes binary, microseconds)
IMFLWTIN long long int Total elapsed time spent waiting for input messages (8 bytes binary, microseconds)
IMFLTPMG unsigned int Total number of messages processed
IMFLTSMG long long int Total size of input messages (bytes)
IMFLMXMG long long int Maximum input message size (bytes)
IMFLMNMG long long int Minimum input message size (bytes)
IMFLTHDP unsigned int Number of threads in pool
IMFLTHDM unsigned int Number of times the maximum number of threads is reached
IMFLERMQ2 unsigned int Number of MQGET errors (MQInput node) or web services errors (HTTPInput node)
IMFLERMG3 unsigned int Number of messages that contain errors
IMFLERPR unsigned int Number of errors processing a message
IMFLTMOU unsigned int Number of timeouts processing a message (AggregateReply node only)
IMFLCMIT unsigned int Number of transaction commits
IMFLBKOU unsigned int Number of transaction backouts
IMFLACCT char[32] Accounting origin
Notes:
  1. For example, a conversion error occurs when the message is got from the queue.
  2. These include exceptions that are thrown downstream of the input node, and errors detected by the input node after it has successfully retrieved the message from the queue (for example, a format error).

The following table describes the contents of the BipSMFThread record.

Field Data type Details
ITHDID short int Control block hex ID (BipSMFThread_ID)
ITHDLEN short int Length of control block
ITHDEYE char[4] Eyecatcher (ITHD)
ITHDVER int Version number (BipSMFRecordVersion)
ITHDNBR unsigned int Relative thread number in pool
ITHDTPMG unsigned int Total number of messages processed by thread
ITHDTPTM long long int Total elapsed time spent processing input messages (8 bytes binary, microseconds)
ITHDTPCP long long int Total processor time spent processing input messages (8 bytes binary, microseconds)
ITHDWTCP long long int Total processor time spent waiting for input messages (8 bytes binary, microseconds)
ITHDWTIN long long int Total elapsed time spent waiting for input messages (8 bytes binary, microseconds)
ITHDTSMG long long int Total size of input messages (bytes)
ITHDMXMG long long int Maximum size of input messages (bytes)
ITHDMNMG long long int Minimum size of input messages (bytes)

The following table describes the contents of the BipSMFNode record.

Field Data type Details
INODID short int Control block hex ID (BipSMFNode_ID)
INODLEN short int Length of control block
INODEYE char[4] Eyecatcher (INOD)
INODVER int Version number (BipSMFRecordVersion)
INODNDNM char[32] Name of node (Label)
INODTYPE char[32] Type of node
INODTPTM long long int Total elapsed time spent processing input messages (8 bytes binary, microseconds)
INODMXTM long long int Maximum elapsed time spent processing input messages (8 bytes binary, microseconds)
INODMNTM long long int Minimum elapsed time spent processing input messages (8 bytes binary, microseconds)
INODTPCP long long int Total processor time spent processing input messages (8 bytes binary, microseconds)
INODMXCP long long int Maximum processor time spent processing input messages (8 bytes binary, microseconds)
INODMNCP long long int Minimum processor time spent processing input messages (8 bytes binary, microseconds)
INODTPMG unsigned int Total number of messages processed by this node
INODNITL unsigned int Number of input terminals
INODNOTL unsigned int Number of output terminals

The following table describes the contents of the BipSMFTerminal record.

Field Data type Details
ITRMID short int Control block hex ID (BipSMFTerminal_ID)
ITRMLEN short int Length of control block
ITRMEYE char[4] Eyecatcher (ITRM)
ITRMVER int Version number (BipSMFRecordVersion)
ITRMTLNM char[32] Name of terminal
ITRMTYPE char[8] Type of terminal, one of:
  • Input
  • Output
ITRMTINV unsigned int Total number of invocations