Trace log

Under IMS TM, the Gateway-Library trace facility writes header, data, and API tracing information to the IMS TM log. The same IMS TM log contains errors, tracing, and accounting, so each record needs to indicate the type of record it is. This information comes from IxHost, a JCL member with configuration options for Server Options.

Trace log layout

NoteThe structures of the trace log have the same layout in CICS as in IMS TM, although the log headers differ slightly.

Table 5-1: Trace log layout

Position

Field name

Field type

Field description

1-2

log-length

Unsigned 2-byte integer

Record length. The total length of this record. (Maximum size is 640.)

3

log-type

Unsigned byte

Type of record, either trace or accounting:

  • The trace type can be an error record (TDS-ERR-REC, with a value of 1) or a trace record (TDS-TRACE, with a value of 2).

  • The accounting log type value is 0.

4

log-direction

Unsigned byte

Communication state that shows whether the mainframe is in send or receive mode.

5-68

log-key

Unsigned byte (max. length = 30)

Unsigned byte (length=8)

Unsigned byte (length = 24) Unsigned 2-byte integer

Structure containing:

user_id – server login ID of the client, from the login packet.

trace_resid – trace resource I, which, in CICS, keeps track of who is doing the tracing.

datetime – date and time the SNA conversation or TCP/IP session started (TDACCEPT was issued).

uniquekey – reserved for future use to ensure record has unique key.

69-82

log-txp-name

Unsigned byte

Transaction name.

82-112

log-conn-id

Unsigned byte

Connection ID. Name by which the connection is known to TRS.

113

log-connp

Unsigned byte

Name of associated TDPROC structure.

114-117

log-error-rc

4-byte integer

Value returned to the RETURN-CODE parameter of a Server Option function (TDS-xxxx). See the Mainframe Connect Client Option and Server Option Messages and Codes for more information about return codes.

118-121

log-err-type

4-byte integer

Type of error detected.

122-123

log-err-reserved

2-byte integer

Reserved for future use.

124-125

log-data-length

2-byte integer

Length of the data to be logged.

126-637

log-data

Unsigned byte

Data, including the packet header and the data. For TDWRTLOG, this is the message being written to the log.

637-640

log_filler

Unsigned byte (length=36)

Filler to fill out record to 640 bytes.