BCM Web API log format

BCM Web API log types

The BCM Web API log types are as follows:

BCM Web API server startup record (ARGS)
Received message record (RECV)
Sent message record (SEND)
Sending error record (SERR)
CLI start record (CLIS)
CLI end record (CLIE)
Message record (MESG)

BCM Web API log records are output in text in EBCDIC encoding. Any text exceeding the maximum record length (32,756) is discarded.

BCM Web API log format

The following describes the log record format.

The following describes the variable values used in the explanation.

yyyymmdd: Date when the log data was output
hh:mm:ss.uuuuuu: Local time when the log data is output
user-ID: User ID of the z/OS user who runs the BCM Web API request
ASID: ID of the TSO/E address space where the BCM Web API server was run (4-digit hexadecimal number)

BCM Web API server startup record (ARGS) format

This record is output when the BCM Web API server starts.

yyyymmdd△hh:mm:ss.uuuuuu△user-ID(ASID)△ARGS△input-argument-of-the-BCM-Web-API-server

Received message record (RECV) format

This record is output when the BCM Web API server receives a request from z/OSMF.

yyyymmdd△hh:mm:ss.uuuuuu△user-ID(ASID)△RECV△reception-time△request-body-received-by-the-BCM-Web-API-server

reception-time is the UTC time (total number of seconds from 1970/1/1 0:00) when z/OSMF received the request.

request-body-received-by-the-BCM-Web-API-server is converted to EBCDIC encoding (codepage 1047) and output.

Sent message record (SEND) format

This record is output before the BCM Web API server outputs a response message to the sending queue.

yyyymmdd△hh:mm:ss.uuuuuu△user-ID(ASID)△SEND△sent-size△JSON-text-in-the-AppData-key-of-the-response-body-sent-by-the-BCM-Web-API-server

JSON-text-in-the-AppData-key-of-the-response-body-sent-by-the-BCM-Web-API-server is output in EBCDIC encoding before being converted. This might be discarded.

Sending error record (SERR) format

This record is output when the BCM Web API server cannot send data.

yyyymmdd△hh:mm:ss.uuuuuu△user-ID(ASID)△SERR△reason-for-sending-error

CLI start record (CLIS) format

This record is output before a CLI command is run on the BCM Web API server.

yyyymmdd△hh:mm:ss.uuuuuu△user-ID(ASID)△CLIS△CLI-name△CLI-parameter

CLI end record (CLIE) format

This record is output when the CLI command ends on the BCM Web API server.

yyyymmdd△hh:mm:ss.uuuuuu△user-ID(ASID)△CLIE△CLI-name△CLI-return-code

Message record (MESG) format

This record is output when the BCM Web API server outputs a TSO/E message.

yyyymmdd△hh:mm:ss.uuuuuu△user-ID(ASID)△MESG△message-ID△message-text