Feature: CICS tracing #10269
Open
Feature: CICS tracing #10269
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- ECIInteraction.execute -- instruments the entry point for CICS calls via IBM's javax.resource.cci.Interaction implementation, creating "cics.execute" span and recording a few tags. - JavaGatewayInstrumentation.flow -- records the peer.* tags on the "cics.execute" span created above, or if it doesn't exist, creates a new "gateway.flow" span. The tests don't fully exercise the CICS client-side code, however they exercise enough to ensure the instrumentation creates spans and adds tags as expected. This requires a few JAR files from IBM's CICS SDK for compliation and testing that are not available in Maven Central. A tar.gz artifact is downloaded from IBM's public CICS support archive and the necessary JARs are extracted, following the same pattern used for the JBoss Wildfly smoke tests.
PerfectSlayer
added
tag: community
mcculls
reviewed
Jan 7, 2026
| ":dd-java-agent:instrumentation:azure-functions-1.2.2", | ||
| ":dd-java-agent:instrumentation:caffeine-1.0", | ||
| ":dd-java-agent:instrumentation:cdi-1.2", | ||
| ":dd-java-agent:instrumentation:cics", |
Contributor
There was a problem hiding this comment.
FYI, we've recently added a rule that all instrumentation module names must include the lowest library version the instrumentation is compatible with: https://github.com/DataDog/dd-trace-java/blob/master/docs/how_instrumentations_work.md#gradle-module-names
The naming rules can be checked when running ./gradlew checkInstrumentationNaming
Contributor
There was a problem hiding this comment.
I can do a commit in #10269 to move that to cics-9.1
mcculls
reviewed
Jan 7, 2026
| try { | ||
| runUnderTrace("parent") { | ||
| // Simulate being inside ECIInteraction.execute() (cics.execute operation) | ||
| CallDepthThreadLocalMap.incrementCallDepth(ECIInteraction.class) |
Contributor
There was a problem hiding this comment.
Suggested change
| CallDepthThreadLocalMap.incrementCallDepth(ECIInteraction.class) | |
| CallDepthThreadLocalMap.incrementCallDepth(ECIInteraction) |
remove unnecessary .class here to avoid CI warning
mcculls
reviewed
Jan 7, 2026
| try { | ||
| new JavaGateway("127.0.0.1", port) // use IPv4 address so we can make sure peer.ipv4 is in the tags | ||
| } finally { | ||
| CallDepthThreadLocalMap.decrementCallDepth(ECIInteraction.class) |
Contributor
There was a problem hiding this comment.
Suggested change
| CallDepthThreadLocalMap.decrementCallDepth(ECIInteraction.class) | |
| CallDepthThreadLocalMap.decrementCallDepth(ECIInteraction) |
remove unnecessary .class here to avoid CI warning
Contributor
|
Hi @deejgregor - FYI @amarziali has left a few comments/suggestions on #10301 (a mirror of this PR that we use for CI testing) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What Does This Do
Adds tracing for CICS calls made to an IBM CICS Transaction Gateway (CTG).
Motivation
Outbound client calls to CICS functions are valuable to be traced similar to outbound REST calls or other RPC calls. This adds basic tracing (but not context propagation) to these calls, in addition to setting a peer.hostname to allow the downstream CICS Transaction Gateway (CTG) host to be shown as an inferred service.
Additional Notes
Methods instrumented
ECIInteraction.execute
Instruments the entry point for CICS
calls via IBM's javax.resource.cci.Interaction implementation,
creating
cics.executespan and recording a few tags.A few tags from the
OTEL RPC semantic conventions
are added, as well.
JavaGatewayInstrumentation.flow
Records the
peer.*tags onthe
cics.executespan created above, or if it doesn't exist,creates a new
gateway.flowspan.Once a connection is made, some the peer and local IP address and port are recorded.
Datadog does not normally record the the local side of
network connection details, but this was added to assist with debugging network issues and as an example of how to add this data.
Other notes
The tests don't fully exercise the CICS client-side code, however
they exercise enough to ensure the instrumentation creates spans
and adds tags as expected.
This requires a few JAR files from IBM's CICS SDK for compliation
and testing that are not available in Maven Central. A tar.gz
artifact is downloaded from IBM's public CICS support archive
and the necessary JARs are extracted, following the same pattern
used for the JBoss Wildfly smoke tests.
Contributor Checklist
type:and (comp:orinst:) labels in addition to any useful labelsclose,fixor any linking keywords when referencing an issue.Use
solvesinstead, and assign the PR milestone to the issueJira ticket: [PROJ-IDENT]