SET OTEL
6.3 Applies to 6.3.
Enables control over the participation of a CICS® region in an OpenTelemetry (OTel) function.
Syntax
Activate security checks on commands by specifying the XCMD system initialization parameter and by ensuring that command security checking is active for the transaction (either by specifying CMDSEC(YES) on the TRANSACTION resource definition or by specifying ALWAYS on the CMDSEC system initialization parameter).
Conditions: INVREQ, NOTAUTH
NOHANDLE, RESP, and
RESP2 are common options that can be added to all EXEC CICS
commands to process error conditions. They are not explicitly included in the command syntax diagram
and option descriptions. For information about these common options and EXEC CICS
command syntax, see EXEC CICS command format and programming considerations. For more information
about the use of CVDAs, see CICS-value data areas (CVDAs).
Description
The SET OTEL command controls whether a CICS region participates in OTel. Use the command to change the CICS region OTel setting that was initiated from the OTELTRACE SIT parameter. When changing the setting from NOOTELTRACE to OTELTRACE, any accumulated task span data for completed tasks is written to SMF. Active task span data for in-flight tasks is lost.
Options
- TRACE(cvda)
- Enables a CICS region to participate in OpenTelemetry tracing scenarios. CVDA values
are as follows:
- NOOTELTRACE
- This is the default value and specifies that CICS is not participating in OTel tracing scenarios. This means that CICS neither propagates received OTel trace context nor produces any span data records, regardless of transaction-level settings.
- OTELTRACE
- Specifies that CICS participates in OTel tracing scenarios when the OTELPROP and OTELEMIT transaction resource attributes are configured to propagate received OTel trace context and produce span data records at the transaction level.
Conditions
- INVREQ
- RESP2 values:
- 1
- The value is not a valid CVDA value.
- NOTAUTH
- RESP2 values:
- 100
- The user associated with the issuing task is not authorized to use this command.