From aef4b0459eabdefe3a4af357c246771d74abe847 Mon Sep 17 00:00:00 2001 From: Stuart McCulloch Date: Thu, 12 Nov 2026 16:36:16 +0000 Subject: [PATCH 1/5] Categorize and deprecate selected AgentTracer methods in anticipation of their removal --- .../instrumentation/api/AgentTracer.java | 150 ++++++++++-------- 1 file changed, 80 insertions(+), 70 deletions(-) diff --git a/internal-api/src/main/java/datadog/trace/bootstrap/instrumentation/api/AgentTracer.java b/internal-api/src/main/java/datadog/trace/bootstrap/instrumentation/api/AgentTracer.java index 6964e526047..6fc03d26617 100644 --- a/internal-api/src/main/java/datadog/trace/bootstrap/instrumentation/api/AgentTracer.java +++ b/internal-api/src/main/java/datadog/trace/bootstrap/instrumentation/api/AgentTracer.java @@ -81,6 +81,10 @@ public static ContextScope activateSpan(final AgentSpan span) { return get().activateSpan(span); } + public static AgentSpan activeSpan() { + return get().activeSpan(); + } + /** * Activate a span which will be closed by {@link #closeActive()} instead of a scope. * @@ -91,6 +95,17 @@ public static void activateSpanWithoutScope(final AgentSpan span) { get().activateSpanWithoutScope(span); } + /** + * Closes the scope for the currently active span. + * + * @deprecated This should only be used when the span was previously activated with {@link + * #activateSpanWithoutScope} because the instrumented code didn't align with a scope. + */ + @Deprecated + public static void closeActive() { + get().closeActive(); + } + /** * Checkpoints the active scope. A subsequent call to {@link #rollbackActiveToCheckpoint()} closes * outstanding scopes up to but not including the most recent checkpointed scope. @@ -115,21 +130,11 @@ public static void rollbackActiveToCheckpoint() { get().rollbackActiveToCheckpoint(); } - /** - * Closes the scope for the currently active span. - * - * @deprecated This should only be used when the span was previously activated with {@link - * #activateSpanWithoutScope} because the instrumented code didn't align with a scope. - */ - @Deprecated - public static void closeActive() { - get().closeActive(); - } - /** * Closes the immediately previous iteration scope. Should be called before creating a new span * for {@link #activateNext(AgentSpan)}. */ + @Deprecated public static void closePrevious(final boolean finishSpan) { get().closePrevious(finishSpan); } @@ -139,6 +144,7 @@ public static void closePrevious(final boolean finishSpan) { * * @see datadog.trace.api.config.TracerConfig#SCOPE_ITERATION_KEEP_ALIVE */ + @Deprecated public static ContextScope activateNext(final AgentSpan span) { return get().activateNext(span); } @@ -151,10 +157,6 @@ public static TraceConfig traceConfig() { return get().captureTraceConfig(); } - public static AgentSpan activeSpan() { - return get().activeSpan(); - } - /** * Returns the noop span instance. * @@ -264,50 +266,13 @@ AgentSpan startSpan( AgentSpanContext parent, long startTimeMicros); - /** Activate a span from inside auto-instrumentation. */ - ContextScope activateSpan(AgentSpan span); - - /** Activate a span from outside auto-instrumentation, i.e. a manual or custom span. */ - ContextScope activateManualSpan(AgentSpan span); - - /** Activate a span which will be closed by {@link #closeActive()} instead of a scope. */ - void activateSpanWithoutScope(AgentSpan span); - - @Override - default boolean isAsyncPropagationEnabled() { - return Context.isCaptureEnabled(); - } - - @Override - default void setAsyncPropagationEnabled(boolean asyncPropagationEnabled) { - Context.setCaptureEnabled(asyncPropagationEnabled); - } - - @Override - default TraceScope.Continuation captureActiveSpan() { - Context current = currentContext(); - if (AgentSpan.fromContext(current) == null) { - return NoopTraceScope.NoopContinuation.INSTANCE; - } - // captureActiveSpan is deprecated; use a best-effort wrapper - return new TraceScopeContinuationWrapper(capture(current)); - } - - void checkpointActiveForRollback(); - - void rollbackActiveToCheckpoint(); - - void closeActive(); - - void closePrevious(boolean finishSpan); - - ContextScope activateNext(AgentSpan span); - - AgentSpan activeSpan(); - - default AgentSpan blackholeSpan() { - final AgentSpan active = activeSpan(); - return new BlackHoleSpan(active != null ? active.getTraceId() : DDTraceId.ZERO); + /** + * Creates and starts a span seeded from a {@link SpanPrototype}. This is the + * auto-instrumentation entry point mirroring {@link #startSpan(String, CharSequence)}; see + * {@link #buildSpan(SpanPrototype, CharSequence)}. + */ + default AgentSpan startSpan(@Nonnull SpanPrototype prototype, CharSequence operationName) { + return buildSpan(prototype, operationName).start(); } /** @@ -332,22 +297,16 @@ default SpanBuilder buildSpan(@Nonnull SpanPrototype prototype, CharSequence ope operationName != null ? operationName : prototype.operationName()); } - /** - * Creates and starts a span seeded from a {@link SpanPrototype}. This is the - * auto-instrumentation entry point mirroring {@link #startSpan(String, CharSequence)}; see - * {@link #buildSpan(SpanPrototype, CharSequence)}. - */ - default AgentSpan startSpan(@Nonnull SpanPrototype prototype, CharSequence operationName) { - return buildSpan(prototype, operationName).start(); - } - /** * Returns a SpanBuilder that can be used to produce one and only one span. By imposing the * single span creation limitation, this method is more efficient than {@link #buildSpan} */ SpanBuilder singleSpanBuilder(String instrumentationName, CharSequence spanName); - void close(); + default AgentSpan blackholeSpan() { + final AgentSpan active = activeSpan(); + return new BlackHoleSpan(active != null ? active.getTraceId() : DDTraceId.ZERO); + } /** * Attach a scope listener to the global scope manager @@ -388,7 +347,58 @@ default AgentSpan startSpan(@Nonnull SpanPrototype prototype, CharSequence opera void addShutdownListener(Runnable listener); - // these methods are only used for legacy context manager migration + void close(); + + // internal scope methods which will soon be replaced with their Context equivalents + + /** Activate a span from inside auto-instrumentation. */ + ContextScope activateSpan(AgentSpan span); + + /** Activate a span from outside auto-instrumentation, i.e. a manual or custom span. */ + ContextScope activateManualSpan(AgentSpan span); + + AgentSpan activeSpan(); + + /** Activate a span which will be closed by {@link #closeActive()} instead of a scope. */ + void activateSpanWithoutScope(AgentSpan span); + + void closeActive(); + + // deprecated public Tracer API methods which we can't remove yet for compatibility reasons + + @Override + default boolean isAsyncPropagationEnabled() { + return Context.isCaptureEnabled(); + } + + @Override + default void setAsyncPropagationEnabled(boolean asyncPropagationEnabled) { + Context.setCaptureEnabled(asyncPropagationEnabled); + } + + @Override + default TraceScope.Continuation captureActiveSpan() { + Context current = currentContext(); + if (AgentSpan.fromContext(current) == null) { + return NoopTraceScope.NoopContinuation.INSTANCE; + } + // captureActiveSpan is deprecated; use a best-effort wrapper + return new TraceScopeContinuationWrapper(capture(current)); + } + + // deprecated temporary methods only used for legacy context manager migration + + @Deprecated + void checkpointActiveForRollback(); + + @Deprecated + void rollbackActiveToCheckpoint(); + + @Deprecated + void closePrevious(boolean finishSpan); + + @Deprecated + ContextScope activateNext(AgentSpan span); @Deprecated Context currentContext(); From ec4a44202008c04dc12a6337b4d4d91e9723a372 Mon Sep 17 00:00:00 2001 From: Stuart McCulloch Date: Thu, 12 Nov 2026 16:50:14 +0000 Subject: [PATCH 2/5] Remove static AgentTracer helpers for deprecated iteration/checkpoint scope operations Require explicit access through AgentTracer.get() to discourage their use while retaining TracerAPI support for legacy code paths. Update instrumentations and test support to use the instance methods. --- .../test/InstrumentationSpecification.groovy | 3 +- .../AkkaActorCellInstrumentation.java | 7 ++- .../AkkaMailboxInstrumentation.java | 7 ++- .../aws/v1/sqs/TracingIterator.java | 8 ++-- .../aws/v1/sqs/TracingListIterator.java | 5 +-- .../aws/v2/sqs/TracingIterator.java | 8 ++-- .../aws/v2/sqs/TracingListIterator.java | 5 +-- .../src/test/java/SqsClientTest.java | 2 +- .../JMSMessageConsumerInstrumentation.java | 9 ++-- .../kafka_clients/TracingIterator.java | 8 ++-- .../kafka_clients/TracingListIterator.java | 5 +-- .../kafka_clients38/TracingIterator.java | 8 ++-- .../kafka_clients38/TracingListIterator.java | 5 +-- .../PekkoActorCellInstrumentation.java | 7 ++- .../PekkoMailboxInstrumentation.java | 7 ++- ...ssageListenerContainerInstrumentation.java | 4 +- .../instrumentation/api/AgentTracer.java | 43 ------------------- 17 files changed, 40 insertions(+), 101 deletions(-) diff --git a/dd-java-agent/instrumentation-testing/src/main/groovy/datadog/trace/agent/test/InstrumentationSpecification.groovy b/dd-java-agent/instrumentation-testing/src/main/groovy/datadog/trace/agent/test/InstrumentationSpecification.groovy index 77ba0c985bf..58853b9b4fb 100644 --- a/dd-java-agent/instrumentation-testing/src/main/groovy/datadog/trace/agent/test/InstrumentationSpecification.groovy +++ b/dd-java-agent/instrumentation-testing/src/main/groovy/datadog/trace/agent/test/InstrumentationSpecification.groovy @@ -7,7 +7,6 @@ import static datadog.trace.agent.test.utils.TestAgentPort.parse import static datadog.trace.api.config.DebuggerConfig.DYNAMIC_INSTRUMENTATION_SNAPSHOT_URL import static datadog.trace.api.config.DebuggerConfig.DYNAMIC_INSTRUMENTATION_VERIFY_BYTECODE import static datadog.trace.api.config.TraceInstrumentationConfig.CODE_ORIGIN_FOR_SPANS_ENABLED -import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.closePrevious import static datadog.trace.util.AgentThreadFactory.AgentThread.TASK_SCHEDULER import ch.qos.logback.classic.Level @@ -471,7 +470,7 @@ abstract class InstrumentationSpecification extends DDSpecification implements A assertThreadsEachCleanup = false - closePrevious(true) // in case the previous test left a lingering iteration span + AgentTracer.get().closePrevious(true) // in case the previous test left a lingering iteration span assert TEST_TRACER.activeSpan() == null: "Span is active before test has started: " + TEST_TRACER.activeSpan() // Config is reset before each test. Thus, configurePreAgent() has to be called before each test diff --git a/dd-java-agent/instrumentation/akka/akka-actor-2.5/src/main/java/datadog/trace/instrumentation/akka/concurrent/AkkaActorCellInstrumentation.java b/dd-java-agent/instrumentation/akka/akka-actor-2.5/src/main/java/datadog/trace/instrumentation/akka/concurrent/AkkaActorCellInstrumentation.java index d2859649d5f..a140a3932f1 100644 --- a/dd-java-agent/instrumentation/akka/akka-actor-2.5/src/main/java/datadog/trace/instrumentation/akka/concurrent/AkkaActorCellInstrumentation.java +++ b/dd-java-agent/instrumentation/akka/akka-actor-2.5/src/main/java/datadog/trace/instrumentation/akka/concurrent/AkkaActorCellInstrumentation.java @@ -1,8 +1,6 @@ package datadog.trace.instrumentation.akka.concurrent; import static datadog.trace.agent.tooling.bytebuddy.matcher.NameMatchers.named; -import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.checkpointActiveForRollback; -import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.rollbackActiveToCheckpoint; import static datadog.trace.bootstrap.instrumentation.api.Java8BytecodeBridge.currentContext; import static java.util.Collections.singletonMap; import static net.bytebuddy.matcher.ElementMatchers.isMethod; @@ -15,6 +13,7 @@ import datadog.trace.agent.tooling.InstrumenterModule; import datadog.trace.api.InstrumenterConfig; import datadog.trace.bootstrap.InstrumentationContext; +import datadog.trace.bootstrap.instrumentation.api.AgentTracer; import datadog.trace.bootstrap.instrumentation.java.concurrent.AdviceUtils; import datadog.trace.bootstrap.instrumentation.java.concurrent.State; import java.util.Map; @@ -68,7 +67,7 @@ public static ContextHandle enter( if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { // remember the currently active scope so we can roll back to this point - checkpointActiveForRollback(); + AgentTracer.get().checkpointActiveForRollback(); return null; } else { return currentContext().swap(); @@ -82,7 +81,7 @@ public static void exit( if (checkpointContext == null) { // Clean up any leaking scopes from akka-streams/akka-http etc. - rollbackActiveToCheckpoint(); + AgentTracer.get().rollbackActiveToCheckpoint(); } else { checkpointContext.swap(); } diff --git a/dd-java-agent/instrumentation/akka/akka-actor-2.5/src/main/java/datadog/trace/instrumentation/akka/concurrent/AkkaMailboxInstrumentation.java b/dd-java-agent/instrumentation/akka/akka-actor-2.5/src/main/java/datadog/trace/instrumentation/akka/concurrent/AkkaMailboxInstrumentation.java index f9d77d8d87d..199c0757fa2 100644 --- a/dd-java-agent/instrumentation/akka/akka-actor-2.5/src/main/java/datadog/trace/instrumentation/akka/concurrent/AkkaMailboxInstrumentation.java +++ b/dd-java-agent/instrumentation/akka/akka-actor-2.5/src/main/java/datadog/trace/instrumentation/akka/concurrent/AkkaMailboxInstrumentation.java @@ -1,8 +1,6 @@ package datadog.trace.instrumentation.akka.concurrent; import static datadog.trace.agent.tooling.bytebuddy.matcher.NameMatchers.named; -import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.checkpointActiveForRollback; -import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.rollbackActiveToCheckpoint; import static datadog.trace.bootstrap.instrumentation.api.Java8BytecodeBridge.currentContext; import static net.bytebuddy.matcher.ElementMatchers.isMethod; @@ -11,6 +9,7 @@ import datadog.trace.agent.tooling.Instrumenter; import datadog.trace.agent.tooling.InstrumenterModule; import datadog.trace.api.InstrumenterConfig; +import datadog.trace.bootstrap.instrumentation.api.AgentTracer; import net.bytebuddy.asm.Advice; @AutoService(InstrumenterModule.class) @@ -48,7 +47,7 @@ public static final class SuppressMailboxRunAdvice { public static ContextHandle enter() { if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { // remember the currently active scope so we can roll back to this point - checkpointActiveForRollback(); + AgentTracer.get().checkpointActiveForRollback(); return null; } else { return currentContext().swap(); @@ -59,7 +58,7 @@ public static ContextHandle enter() { public static void exit(@Advice.Enter final ContextHandle checkpointContext) { if (checkpointContext == null) { // Clean up any leaking scopes from akka-streams/akka-http etc. - rollbackActiveToCheckpoint(); + AgentTracer.get().rollbackActiveToCheckpoint(); } else { checkpointContext.swap(); } diff --git a/dd-java-agent/instrumentation/aws-java/aws-java-sqs-1.0/src/main/java/datadog/trace/instrumentation/aws/v1/sqs/TracingIterator.java b/dd-java-agent/instrumentation/aws-java/aws-java-sqs-1.0/src/main/java/datadog/trace/instrumentation/aws/v1/sqs/TracingIterator.java index 29181b5d363..7b6d8e1c0c4 100644 --- a/dd-java-agent/instrumentation/aws-java/aws-java-sqs-1.0/src/main/java/datadog/trace/instrumentation/aws/v1/sqs/TracingIterator.java +++ b/dd-java-agent/instrumentation/aws-java/aws-java-sqs-1.0/src/main/java/datadog/trace/instrumentation/aws/v1/sqs/TracingIterator.java @@ -4,8 +4,6 @@ import static datadog.trace.api.datastreams.DataStreamsTags.Direction.INBOUND; import static datadog.trace.api.datastreams.DataStreamsTags.create; import static datadog.trace.bootstrap.instrumentation.api.AgentPropagation.extractContextAndGetSpanContext; -import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.activateNext; -import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.closePrevious; import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.startSpan; import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.traceConfig; import static datadog.trace.bootstrap.instrumentation.api.URIUtils.urlFileName; @@ -48,7 +46,7 @@ public boolean hasNext() { if (!moreMessages) { // no more messages, use this as a signal to close the last iteration scope if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { - closePrevious(true); + AgentTracer.get().closePrevious(true); } else { final AgentSpan previousSpan = AgentSpan.fromContext(Context.root().swap()); if (previousSpan != null) { @@ -69,7 +67,7 @@ public Message next() { protected void startNewMessageSpan(Message message) { try { if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { - closePrevious(true); + AgentTracer.get().closePrevious(true); } else if (message == null) { // previous message span was the last final AgentSpan previousSpan = AgentSpan.fromContext(Context.root().swap()); if (previousSpan != null) { @@ -116,7 +114,7 @@ protected void startNewMessageSpan(Message message) { CONSUMER_DECORATE.afterStart(span); CONSUMER_DECORATE.onConsume(span, queueUrl); if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { - activateNext(span); + AgentTracer.get().activateNext(span); } else { final AgentSpan previousSpan = AgentSpan.fromContext(span.swap()); if (previousSpan != null) { diff --git a/dd-java-agent/instrumentation/aws-java/aws-java-sqs-1.0/src/main/java/datadog/trace/instrumentation/aws/v1/sqs/TracingListIterator.java b/dd-java-agent/instrumentation/aws-java/aws-java-sqs-1.0/src/main/java/datadog/trace/instrumentation/aws/v1/sqs/TracingListIterator.java index d7f8174cd8c..2c89ccf429c 100644 --- a/dd-java-agent/instrumentation/aws-java/aws-java-sqs-1.0/src/main/java/datadog/trace/instrumentation/aws/v1/sqs/TracingListIterator.java +++ b/dd-java-agent/instrumentation/aws-java/aws-java-sqs-1.0/src/main/java/datadog/trace/instrumentation/aws/v1/sqs/TracingListIterator.java @@ -1,11 +1,10 @@ package datadog.trace.instrumentation.aws.v1.sqs; -import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.closePrevious; - import com.amazonaws.services.sqs.model.Message; import datadog.context.Context; import datadog.trace.api.InstrumenterConfig; import datadog.trace.bootstrap.instrumentation.api.AgentSpan; +import datadog.trace.bootstrap.instrumentation.api.AgentTracer; import java.util.ListIterator; public class TracingListIterator extends TracingIterator> @@ -21,7 +20,7 @@ public boolean hasPrevious() { if (!moreMessages) { // no more messages, use this as a signal to close the last iteration scope if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { - closePrevious(true); + AgentTracer.get().closePrevious(true); } else { final AgentSpan previousSpan = AgentSpan.fromContext(Context.root().swap()); if (previousSpan != null) { diff --git a/dd-java-agent/instrumentation/aws-java/aws-java-sqs-2.0/src/main/java/datadog/trace/instrumentation/aws/v2/sqs/TracingIterator.java b/dd-java-agent/instrumentation/aws-java/aws-java-sqs-2.0/src/main/java/datadog/trace/instrumentation/aws/v2/sqs/TracingIterator.java index ec563d11a50..73bcd130f25 100644 --- a/dd-java-agent/instrumentation/aws-java/aws-java-sqs-2.0/src/main/java/datadog/trace/instrumentation/aws/v2/sqs/TracingIterator.java +++ b/dd-java-agent/instrumentation/aws-java/aws-java-sqs-2.0/src/main/java/datadog/trace/instrumentation/aws/v2/sqs/TracingIterator.java @@ -4,8 +4,6 @@ import static datadog.trace.api.datastreams.DataStreamsTags.Direction.INBOUND; import static datadog.trace.api.datastreams.DataStreamsTags.create; import static datadog.trace.bootstrap.instrumentation.api.AgentPropagation.extractContextAndGetSpanContext; -import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.activateNext; -import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.closePrevious; import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.startSpan; import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.traceConfig; import static datadog.trace.bootstrap.instrumentation.api.URIUtils.urlFileName; @@ -52,7 +50,7 @@ public boolean hasNext() { if (!moreMessages) { // no more messages, use this as a signal to close the last iteration scope if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { - closePrevious(true); + AgentTracer.get().closePrevious(true); } else { final AgentSpan previousSpan = AgentSpan.fromContext(Context.root().swap()); if (previousSpan != null) { @@ -73,7 +71,7 @@ public Message next() { protected void startNewMessageSpan(Message message) { try { if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { - closePrevious(true); + AgentTracer.get().closePrevious(true); } else if (message == null) { // previous message span was the last final AgentSpan previousSpan = AgentSpan.fromContext(Context.root().swap()); if (previousSpan != null) { @@ -120,7 +118,7 @@ protected void startNewMessageSpan(Message message) { CONSUMER_DECORATE.afterStart(span); CONSUMER_DECORATE.onConsume(span, queueUrl, queueName, requestId); if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { - activateNext(span); + AgentTracer.get().activateNext(span); } else { final AgentSpan previousSpan = AgentSpan.fromContext(span.swap()); if (previousSpan != null) { diff --git a/dd-java-agent/instrumentation/aws-java/aws-java-sqs-2.0/src/main/java/datadog/trace/instrumentation/aws/v2/sqs/TracingListIterator.java b/dd-java-agent/instrumentation/aws-java/aws-java-sqs-2.0/src/main/java/datadog/trace/instrumentation/aws/v2/sqs/TracingListIterator.java index f3f471db89d..445ab16ea80 100644 --- a/dd-java-agent/instrumentation/aws-java/aws-java-sqs-2.0/src/main/java/datadog/trace/instrumentation/aws/v2/sqs/TracingListIterator.java +++ b/dd-java-agent/instrumentation/aws-java/aws-java-sqs-2.0/src/main/java/datadog/trace/instrumentation/aws/v2/sqs/TracingListIterator.java @@ -1,10 +1,9 @@ package datadog.trace.instrumentation.aws.v2.sqs; -import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.closePrevious; - import datadog.context.Context; import datadog.trace.api.InstrumenterConfig; import datadog.trace.bootstrap.instrumentation.api.AgentSpan; +import datadog.trace.bootstrap.instrumentation.api.AgentTracer; import java.util.ListIterator; import software.amazon.awssdk.services.sqs.model.Message; @@ -21,7 +20,7 @@ public boolean hasPrevious() { if (!moreMessages) { // no more messages, use this as a signal to close the last iteration scope if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { - closePrevious(true); + AgentTracer.get().closePrevious(true); } else { final AgentSpan previousSpan = AgentSpan.fromContext(Context.root().swap()); if (previousSpan != null) { diff --git a/dd-java-agent/instrumentation/aws-java/aws-java-sqs-2.0/src/test/java/SqsClientTest.java b/dd-java-agent/instrumentation/aws-java/aws-java-sqs-2.0/src/test/java/SqsClientTest.java index 5569f7898fc..bde3f1baa74 100644 --- a/dd-java-agent/instrumentation/aws-java/aws-java-sqs-2.0/src/test/java/SqsClientTest.java +++ b/dd-java-agent/instrumentation/aws-java/aws-java-sqs-2.0/src/test/java/SqsClientTest.java @@ -596,7 +596,7 @@ static void stopSqsServer() { @BeforeEach void setUpAwsCredentials() { if (closePreviousBeforeTest()) { - AgentTracer.closePrevious(true); + AgentTracer.get().closePrevious(true); } System.setProperty(SdkSystemSetting.AWS_ACCESS_KEY_ID.property(), "my-access-key"); System.setProperty(SdkSystemSetting.AWS_SECRET_ACCESS_KEY.property(), "my-secret-key"); diff --git a/dd-java-agent/instrumentation/jms/javax-jms-1.1/src/main/java/datadog/trace/instrumentation/jms/JMSMessageConsumerInstrumentation.java b/dd-java-agent/instrumentation/jms/javax-jms-1.1/src/main/java/datadog/trace/instrumentation/jms/JMSMessageConsumerInstrumentation.java index 06d53e1ba3b..920aad447cf 100644 --- a/dd-java-agent/instrumentation/jms/javax-jms-1.1/src/main/java/datadog/trace/instrumentation/jms/JMSMessageConsumerInstrumentation.java +++ b/dd-java-agent/instrumentation/jms/javax-jms-1.1/src/main/java/datadog/trace/instrumentation/jms/JMSMessageConsumerInstrumentation.java @@ -6,8 +6,6 @@ import static datadog.trace.api.datastreams.DataStreamsTags.Direction.INBOUND; import static datadog.trace.api.datastreams.DataStreamsTags.create; import static datadog.trace.bootstrap.instrumentation.api.AgentPropagation.extractContextAndGetSpanContext; -import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.activateNext; -import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.closePrevious; import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.startSpan; import static datadog.trace.bootstrap.instrumentation.api.Java8BytecodeBridge.rootContext; import static datadog.trace.bootstrap.instrumentation.api.Java8BytecodeBridge.spanFromContext; @@ -94,7 +92,7 @@ public static MessageConsumerState beforeReceive(@Advice.This final MessageConsu boolean finishSpan = consumerState.getSessionState().isAutoAcknowledge(); if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { - closePrevious(finishSpan); + AgentTracer.get().closePrevious(finishSpan); } else { final AgentSpan previousSpan = spanFromContext(rootContext().swap()); if (previousSpan != null) { @@ -175,7 +173,8 @@ public static void afterReceive( CONSUMER_DECORATE.onError(span, throwable); if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { - activateNext(span); // scope is left open until next message or it times out + // scope is left open until next message or it times out + AgentTracer.get().activateNext(span); } else { final AgentSpan previousSpan = spanFromContext(span.swap()); if (previousSpan != null) { @@ -207,7 +206,7 @@ public static void beforeClose(@Advice.This final MessageConsumer consumer) { if (null != consumerState) { boolean finishSpan = consumerState.getSessionState().isAutoAcknowledge(); if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { - closePrevious(finishSpan); + AgentTracer.get().closePrevious(finishSpan); } else { final AgentSpan previousSpan = spanFromContext(rootContext().swap()); if (previousSpan != null) { diff --git a/dd-java-agent/instrumentation/kafka/kafka-clients-0.11/src/main/java/datadog/trace/instrumentation/kafka_clients/TracingIterator.java b/dd-java-agent/instrumentation/kafka/kafka-clients-0.11/src/main/java/datadog/trace/instrumentation/kafka_clients/TracingIterator.java index 87efda5badc..1e00e561215 100644 --- a/dd-java-agent/instrumentation/kafka/kafka-clients-0.11/src/main/java/datadog/trace/instrumentation/kafka_clients/TracingIterator.java +++ b/dd-java-agent/instrumentation/kafka/kafka-clients-0.11/src/main/java/datadog/trace/instrumentation/kafka_clients/TracingIterator.java @@ -6,8 +6,6 @@ import static datadog.trace.api.datastreams.DataStreamsTags.create; import static datadog.trace.bootstrap.instrumentation.api.AgentPropagation.DSM_CONCERN; import static datadog.trace.bootstrap.instrumentation.api.AgentPropagation.extractContextAndGetSpanContext; -import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.activateNext; -import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.closePrevious; import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.startSpan; import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.traceConfig; import static datadog.trace.instrumentation.kafka_clients.KafkaDecorator.BROKER_DECORATE; @@ -70,7 +68,7 @@ public boolean hasNext() { if (!moreRecords) { // no more records, use this as a signal to close the last iteration scope if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { - closePrevious(true); + AgentTracer.get().closePrevious(true); } else { final AgentSpan previousSpan = AgentSpan.fromContext(Context.root().swap()); if (previousSpan != null) { @@ -91,7 +89,7 @@ public boolean hasNext() { protected void startNewRecordSpan(ConsumerRecord val) { try { if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { - closePrevious(true); + AgentTracer.get().closePrevious(true); } else if (val == null) { // previous message span was the last final AgentSpan previousSpan = AgentSpan.fromContext(Context.root().swap()); if (previousSpan != null) { @@ -157,7 +155,7 @@ protected void startNewRecordSpan(ConsumerRecord val) { decorator.afterStart(span); decorator.onConsume(span, val, group, clusterId, bootstrapServers); if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { - activateNext(span); + AgentTracer.get().activateNext(span); } else { final AgentSpan previousSpan = AgentSpan.fromContext(span.swap()); if (previousSpan != null) { diff --git a/dd-java-agent/instrumentation/kafka/kafka-clients-0.11/src/main/java/datadog/trace/instrumentation/kafka_clients/TracingListIterator.java b/dd-java-agent/instrumentation/kafka/kafka-clients-0.11/src/main/java/datadog/trace/instrumentation/kafka_clients/TracingListIterator.java index 34e7bbe00df..b3d8fcbc165 100644 --- a/dd-java-agent/instrumentation/kafka/kafka-clients-0.11/src/main/java/datadog/trace/instrumentation/kafka_clients/TracingListIterator.java +++ b/dd-java-agent/instrumentation/kafka/kafka-clients-0.11/src/main/java/datadog/trace/instrumentation/kafka_clients/TracingListIterator.java @@ -1,10 +1,9 @@ package datadog.trace.instrumentation.kafka_clients; -import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.closePrevious; - import datadog.context.Context; import datadog.trace.api.InstrumenterConfig; import datadog.trace.bootstrap.instrumentation.api.AgentSpan; +import datadog.trace.bootstrap.instrumentation.api.AgentTracer; import java.util.ListIterator; import org.apache.kafka.clients.consumer.ConsumerRecord; @@ -30,7 +29,7 @@ public boolean hasPrevious() { if (!moreRecords) { // no more records, use this as a signal to close the last iteration scope if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { - closePrevious(true); + AgentTracer.get().closePrevious(true); } else { final AgentSpan previousSpan = AgentSpan.fromContext(Context.root().swap()); if (previousSpan != null) { diff --git a/dd-java-agent/instrumentation/kafka/kafka-clients-3.8/src/main/java17/datadog/trace/instrumentation/kafka_clients38/TracingIterator.java b/dd-java-agent/instrumentation/kafka/kafka-clients-3.8/src/main/java17/datadog/trace/instrumentation/kafka_clients38/TracingIterator.java index d1ef4394d69..30e0e7d5298 100644 --- a/dd-java-agent/instrumentation/kafka/kafka-clients-3.8/src/main/java17/datadog/trace/instrumentation/kafka_clients38/TracingIterator.java +++ b/dd-java-agent/instrumentation/kafka/kafka-clients-3.8/src/main/java17/datadog/trace/instrumentation/kafka_clients38/TracingIterator.java @@ -6,8 +6,6 @@ import static datadog.trace.api.datastreams.DataStreamsTags.create; import static datadog.trace.bootstrap.instrumentation.api.AgentPropagation.DSM_CONCERN; import static datadog.trace.bootstrap.instrumentation.api.AgentPropagation.extractContextAndGetSpanContext; -import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.activateNext; -import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.closePrevious; import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.startSpan; import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.traceConfig; import static datadog.trace.instrumentation.kafka_clients38.KafkaDecorator.JAVA_KAFKA; @@ -65,7 +63,7 @@ public boolean hasNext() { if (!moreRecords) { // no more records, use this as a signal to close the last iteration scope if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { - closePrevious(true); + AgentTracer.get().closePrevious(true); } else { final AgentSpan previousSpan = AgentSpan.fromContext(Context.root().swap()); if (previousSpan != null) { @@ -86,7 +84,7 @@ public boolean hasNext() { protected void startNewRecordSpan(ConsumerRecord val) { try { if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { - closePrevious(true); + AgentTracer.get().closePrevious(true); } else if (val == null) { // previous message span was the last final AgentSpan previousSpan = AgentSpan.fromContext(Context.root().swap()); if (previousSpan != null) { @@ -154,7 +152,7 @@ protected void startNewRecordSpan(ConsumerRecord val) { decorator.afterStart(span); decorator.onConsume(span, val, group, clusterId, bootstrapServers); if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { - activateNext(span); + AgentTracer.get().activateNext(span); } else { final AgentSpan previousSpan = AgentSpan.fromContext(span.swap()); if (previousSpan != null) { diff --git a/dd-java-agent/instrumentation/kafka/kafka-clients-3.8/src/main/java17/datadog/trace/instrumentation/kafka_clients38/TracingListIterator.java b/dd-java-agent/instrumentation/kafka/kafka-clients-3.8/src/main/java17/datadog/trace/instrumentation/kafka_clients38/TracingListIterator.java index 3b17006d562..e6abfa931ae 100644 --- a/dd-java-agent/instrumentation/kafka/kafka-clients-3.8/src/main/java17/datadog/trace/instrumentation/kafka_clients38/TracingListIterator.java +++ b/dd-java-agent/instrumentation/kafka/kafka-clients-3.8/src/main/java17/datadog/trace/instrumentation/kafka_clients38/TracingListIterator.java @@ -1,10 +1,9 @@ package datadog.trace.instrumentation.kafka_clients38; -import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.closePrevious; - import datadog.context.Context; import datadog.trace.api.InstrumenterConfig; import datadog.trace.bootstrap.instrumentation.api.AgentSpan; +import datadog.trace.bootstrap.instrumentation.api.AgentTracer; import java.util.ListIterator; import org.apache.kafka.clients.consumer.ConsumerRecord; @@ -30,7 +29,7 @@ public boolean hasPrevious() { if (!moreRecords) { // no more records, use this as a signal to close the last iteration scope if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { - closePrevious(true); + AgentTracer.get().closePrevious(true); } else { final AgentSpan previousSpan = AgentSpan.fromContext(Context.root().swap()); if (previousSpan != null) { diff --git a/dd-java-agent/instrumentation/pekko/pekko-concurrent-1.0/src/main/java/datadog/trace/instrumentation/pekko/concurrent/PekkoActorCellInstrumentation.java b/dd-java-agent/instrumentation/pekko/pekko-concurrent-1.0/src/main/java/datadog/trace/instrumentation/pekko/concurrent/PekkoActorCellInstrumentation.java index 1b37a2c7748..1909c985a4d 100644 --- a/dd-java-agent/instrumentation/pekko/pekko-concurrent-1.0/src/main/java/datadog/trace/instrumentation/pekko/concurrent/PekkoActorCellInstrumentation.java +++ b/dd-java-agent/instrumentation/pekko/pekko-concurrent-1.0/src/main/java/datadog/trace/instrumentation/pekko/concurrent/PekkoActorCellInstrumentation.java @@ -1,8 +1,6 @@ package datadog.trace.instrumentation.pekko.concurrent; import static datadog.trace.agent.tooling.bytebuddy.matcher.NameMatchers.named; -import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.checkpointActiveForRollback; -import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.rollbackActiveToCheckpoint; import static datadog.trace.bootstrap.instrumentation.api.Java8BytecodeBridge.currentContext; import static java.util.Collections.singletonMap; import static net.bytebuddy.matcher.ElementMatchers.isMethod; @@ -14,6 +12,7 @@ import datadog.trace.agent.tooling.InstrumenterModule; import datadog.trace.api.InstrumenterConfig; import datadog.trace.bootstrap.InstrumentationContext; +import datadog.trace.bootstrap.instrumentation.api.AgentTracer; import datadog.trace.bootstrap.instrumentation.java.concurrent.AdviceUtils; import datadog.trace.bootstrap.instrumentation.java.concurrent.State; import java.util.Map; @@ -68,7 +67,7 @@ public static ContextHandle enter( if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { // remember the currently active scope so we can roll back to this point - checkpointActiveForRollback(); + AgentTracer.get().checkpointActiveForRollback(); return null; } else { return currentContext().swap(); @@ -82,7 +81,7 @@ public static void exit( if (checkpointContext == null) { // Clean up any leaking scopes from pekko-streams/pekko-http etc. - rollbackActiveToCheckpoint(); + AgentTracer.get().rollbackActiveToCheckpoint(); } else { checkpointContext.swap(); } diff --git a/dd-java-agent/instrumentation/pekko/pekko-concurrent-1.0/src/main/java/datadog/trace/instrumentation/pekko/concurrent/PekkoMailboxInstrumentation.java b/dd-java-agent/instrumentation/pekko/pekko-concurrent-1.0/src/main/java/datadog/trace/instrumentation/pekko/concurrent/PekkoMailboxInstrumentation.java index 17be8e7476f..2da7adb16d3 100644 --- a/dd-java-agent/instrumentation/pekko/pekko-concurrent-1.0/src/main/java/datadog/trace/instrumentation/pekko/concurrent/PekkoMailboxInstrumentation.java +++ b/dd-java-agent/instrumentation/pekko/pekko-concurrent-1.0/src/main/java/datadog/trace/instrumentation/pekko/concurrent/PekkoMailboxInstrumentation.java @@ -1,8 +1,6 @@ package datadog.trace.instrumentation.pekko.concurrent; import static datadog.trace.agent.tooling.bytebuddy.matcher.NameMatchers.named; -import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.checkpointActiveForRollback; -import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.rollbackActiveToCheckpoint; import static datadog.trace.bootstrap.instrumentation.api.Java8BytecodeBridge.currentContext; import static net.bytebuddy.matcher.ElementMatchers.isMethod; @@ -11,6 +9,7 @@ import datadog.trace.agent.tooling.Instrumenter; import datadog.trace.agent.tooling.InstrumenterModule; import datadog.trace.api.InstrumenterConfig; +import datadog.trace.bootstrap.instrumentation.api.AgentTracer; import net.bytebuddy.asm.Advice; @AutoService(InstrumenterModule.class) @@ -48,7 +47,7 @@ public static final class SuppressMailboxRunAdvice { public static ContextHandle enter() { if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { // remember the currently active scope so we can roll back to this point - checkpointActiveForRollback(); + AgentTracer.get().checkpointActiveForRollback(); return null; } else { return currentContext().swap(); @@ -59,7 +58,7 @@ public static ContextHandle enter() { public static void exit(@Advice.Enter final ContextHandle checkpointContext) { if (checkpointContext == null) { // Clean up any leaking scopes from pekko-streams/pekko-http etc. - rollbackActiveToCheckpoint(); + AgentTracer.get().rollbackActiveToCheckpoint(); } else { checkpointContext.swap(); } diff --git a/dd-java-agent/instrumentation/spring/spring-jms-3.1/src/main/java/datadog/trace/instrumentation/springjms/AbstractPollingMessageListenerContainerInstrumentation.java b/dd-java-agent/instrumentation/spring/spring-jms-3.1/src/main/java/datadog/trace/instrumentation/springjms/AbstractPollingMessageListenerContainerInstrumentation.java index 3ad07247953..240f4dc3c3d 100644 --- a/dd-java-agent/instrumentation/spring/spring-jms-3.1/src/main/java/datadog/trace/instrumentation/springjms/AbstractPollingMessageListenerContainerInstrumentation.java +++ b/dd-java-agent/instrumentation/spring/spring-jms-3.1/src/main/java/datadog/trace/instrumentation/springjms/AbstractPollingMessageListenerContainerInstrumentation.java @@ -1,7 +1,6 @@ package datadog.trace.instrumentation.springjms; import static datadog.trace.agent.tooling.bytebuddy.matcher.NameMatchers.named; -import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.closePrevious; import static datadog.trace.bootstrap.instrumentation.api.Java8BytecodeBridge.rootContext; import static datadog.trace.bootstrap.instrumentation.api.Java8BytecodeBridge.spanFromContext; import static java.util.Collections.singletonMap; @@ -13,6 +12,7 @@ import datadog.trace.api.InstrumenterConfig; import datadog.trace.bootstrap.InstrumentationContext; import datadog.trace.bootstrap.instrumentation.api.AgentSpan; +import datadog.trace.bootstrap.instrumentation.api.AgentTracer; import datadog.trace.bootstrap.instrumentation.jms.MessageConsumerState; import java.util.Map; import javax.jms.MessageConsumer; @@ -60,7 +60,7 @@ public static void afterExecute(@Advice.Argument(2) final MessageConsumer consum if (null != consumerState) { boolean finishSpan = consumerState.getSessionState().isAutoAcknowledge(); if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { - closePrevious(finishSpan); + AgentTracer.get().closePrevious(finishSpan); } else { final AgentSpan previousSpan = spanFromContext(rootContext().swap()); if (previousSpan != null) { diff --git a/internal-api/src/main/java/datadog/trace/bootstrap/instrumentation/api/AgentTracer.java b/internal-api/src/main/java/datadog/trace/bootstrap/instrumentation/api/AgentTracer.java index 6fc03d26617..5365fc160b3 100644 --- a/internal-api/src/main/java/datadog/trace/bootstrap/instrumentation/api/AgentTracer.java +++ b/internal-api/src/main/java/datadog/trace/bootstrap/instrumentation/api/AgentTracer.java @@ -106,49 +106,6 @@ public static void closeActive() { get().closeActive(); } - /** - * Checkpoints the active scope. A subsequent call to {@link #rollbackActiveToCheckpoint()} closes - * outstanding scopes up to but not including the most recent checkpointed scope. - * - * @deprecated This should only be used when scopes might leak onto the scope stack which cannot - * be cleaned up by other means. - */ - @Deprecated - public static void checkpointActiveForRollback() { - get().checkpointActiveForRollback(); - } - - /** - * Closes outstanding scopes up to but not including the most recent scope checkpointed with - * {@link #checkpointActiveForRollback()}. Closes all scopes if none have been checkpointed. - * - * @deprecated This should only be used when scopes have leaked onto the scope stack that cannot - * be cleaned up by other means. - */ - @Deprecated - public static void rollbackActiveToCheckpoint() { - get().rollbackActiveToCheckpoint(); - } - - /** - * Closes the immediately previous iteration scope. Should be called before creating a new span - * for {@link #activateNext(AgentSpan)}. - */ - @Deprecated - public static void closePrevious(final boolean finishSpan) { - get().closePrevious(finishSpan); - } - - /** - * Activates a new iteration scope; closes automatically after a fixed period. - * - * @see datadog.trace.api.config.TracerConfig#SCOPE_ITERATION_KEEP_ALIVE - */ - @Deprecated - public static ContextScope activateNext(final AgentSpan span) { - return get().activateNext(span); - } - public static TraceConfig traceConfig(final AgentSpan span) { return null != span ? span.traceConfig() : traceConfig(); } From c7dc19d2f0edc167bcaa94ee0e55f0e52e50078b Mon Sep 17 00:00:00 2001 From: Stuart McCulloch Date: Thu, 12 Nov 2026 17:03:11 +0000 Subject: [PATCH 3/5] Guard instrumentation test iteration cleanup with legacy mode Restore each test's configuration before checking the context manager mode, and only close lingering iteration scopes when legacy mode is enabled. --- .../trace/agent/test/InstrumentationSpecification.groovy | 9 ++++++--- .../aws-java-sqs-2.0/src/test/java/SqsClientTest.java | 3 +-- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/dd-java-agent/instrumentation-testing/src/main/groovy/datadog/trace/agent/test/InstrumentationSpecification.groovy b/dd-java-agent/instrumentation-testing/src/main/groovy/datadog/trace/agent/test/InstrumentationSpecification.groovy index 58853b9b4fb..00e7fba4b5b 100644 --- a/dd-java-agent/instrumentation-testing/src/main/groovy/datadog/trace/agent/test/InstrumentationSpecification.groovy +++ b/dd-java-agent/instrumentation-testing/src/main/groovy/datadog/trace/agent/test/InstrumentationSpecification.groovy @@ -44,6 +44,7 @@ import datadog.trace.agent.tooling.bytebuddy.matcher.ClassLoaderMatchers import datadog.trace.agent.tooling.bytebuddy.matcher.GlobalIgnores import datadog.trace.api.Config import datadog.trace.api.IdGenerationStrategy +import datadog.trace.api.InstrumenterConfig import datadog.trace.api.Pair import datadog.trace.api.ProcessTags import datadog.trace.api.TraceConfig @@ -470,13 +471,15 @@ abstract class InstrumentationSpecification extends DDSpecification implements A assertThreadsEachCleanup = false - AgentTracer.get().closePrevious(true) // in case the previous test left a lingering iteration span - assert TEST_TRACER.activeSpan() == null: "Span is active before test has started: " + TEST_TRACER.activeSpan() - // Config is reset before each test. Thus, configurePreAgent() has to be called before each test // even though the agent is already installed configurePreAgent() + if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { + TEST_TRACER.closePrevious(true) // in case the previous test left a lingering iteration span + } + assert TEST_TRACER.activeSpan() == null: "Span is active before test has started: " + TEST_TRACER.activeSpan() + println "Starting test: ${getSpecificationContext().getCurrentIteration().getName()} from ${specificationContext.currentSpec.name}" TEST_TRACER.flush() diff --git a/dd-java-agent/instrumentation/aws-java/aws-java-sqs-2.0/src/test/java/SqsClientTest.java b/dd-java-agent/instrumentation/aws-java/aws-java-sqs-2.0/src/test/java/SqsClientTest.java index bde3f1baa74..63d836ac30e 100644 --- a/dd-java-agent/instrumentation/aws-java/aws-java-sqs-2.0/src/test/java/SqsClientTest.java +++ b/dd-java-agent/instrumentation/aws-java/aws-java-sqs-2.0/src/test/java/SqsClientTest.java @@ -16,7 +16,6 @@ import datadog.trace.api.config.TraceInstrumentationConfig; import datadog.trace.api.config.TracerConfig; import datadog.trace.api.naming.SpanNaming; -import datadog.trace.bootstrap.instrumentation.api.AgentTracer; import datadog.trace.bootstrap.instrumentation.api.InstrumentationTags; import datadog.trace.bootstrap.instrumentation.api.Tags; import datadog.trace.core.DDSpan; @@ -596,7 +595,7 @@ static void stopSqsServer() { @BeforeEach void setUpAwsCredentials() { if (closePreviousBeforeTest()) { - AgentTracer.get().closePrevious(true); + tracer.closePrevious(true); } System.setProperty(SdkSystemSetting.AWS_ACCESS_KEY_ID.property(), "my-access-key"); System.setProperty(SdkSystemSetting.AWS_SECRET_ACCESS_KEY.property(), "my-secret-key"); From 46751e8b8c9b97dc4b2ceece35352c7f66fd9ef9 Mon Sep 17 00:00:00 2001 From: Stuart McCulloch Date: Thu, 12 Nov 2026 17:13:36 +0000 Subject: [PATCH 4/5] Guard Akka and Pekko scope rollback with legacy mode Check the context manager mode before rolling back scopes in actor and mailbox exit advice. In context-swap mode, tolerate a missing saved context after a suppressed entry failure and still close the actor task scope. Add regression tests for both frameworks. --- .../AkkaActorCellInstrumentation.java | 4 +- .../AkkaMailboxInstrumentation.java | 4 +- .../ActorScopeCleanupForkedTest.java | 43 +++++++++++++++++++ .../PekkoActorCellInstrumentation.java | 4 +- .../PekkoMailboxInstrumentation.java | 4 +- .../ActorScopeCleanupForkedTest.java | 43 +++++++++++++++++++ 6 files changed, 94 insertions(+), 8 deletions(-) create mode 100644 dd-java-agent/instrumentation/akka/akka-actor-2.5/src/test/java/datadog/trace/instrumentation/akka/concurrent/ActorScopeCleanupForkedTest.java create mode 100644 dd-java-agent/instrumentation/pekko/pekko-concurrent-1.0/src/test/java/datadog/trace/instrumentation/pekko/concurrent/ActorScopeCleanupForkedTest.java diff --git a/dd-java-agent/instrumentation/akka/akka-actor-2.5/src/main/java/datadog/trace/instrumentation/akka/concurrent/AkkaActorCellInstrumentation.java b/dd-java-agent/instrumentation/akka/akka-actor-2.5/src/main/java/datadog/trace/instrumentation/akka/concurrent/AkkaActorCellInstrumentation.java index a140a3932f1..fd6592ad7e4 100644 --- a/dd-java-agent/instrumentation/akka/akka-actor-2.5/src/main/java/datadog/trace/instrumentation/akka/concurrent/AkkaActorCellInstrumentation.java +++ b/dd-java-agent/instrumentation/akka/akka-actor-2.5/src/main/java/datadog/trace/instrumentation/akka/concurrent/AkkaActorCellInstrumentation.java @@ -79,10 +79,10 @@ public static void exit( @Advice.Local("taskScope") ContextScope taskScope, @Advice.Enter ContextHandle checkpointContext) { - if (checkpointContext == null) { + if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { // Clean up any leaking scopes from akka-streams/akka-http etc. AgentTracer.get().rollbackActiveToCheckpoint(); - } else { + } else if (checkpointContext != null) { checkpointContext.swap(); } diff --git a/dd-java-agent/instrumentation/akka/akka-actor-2.5/src/main/java/datadog/trace/instrumentation/akka/concurrent/AkkaMailboxInstrumentation.java b/dd-java-agent/instrumentation/akka/akka-actor-2.5/src/main/java/datadog/trace/instrumentation/akka/concurrent/AkkaMailboxInstrumentation.java index 199c0757fa2..be0dda66e4e 100644 --- a/dd-java-agent/instrumentation/akka/akka-actor-2.5/src/main/java/datadog/trace/instrumentation/akka/concurrent/AkkaMailboxInstrumentation.java +++ b/dd-java-agent/instrumentation/akka/akka-actor-2.5/src/main/java/datadog/trace/instrumentation/akka/concurrent/AkkaMailboxInstrumentation.java @@ -56,10 +56,10 @@ public static ContextHandle enter() { @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class) public static void exit(@Advice.Enter final ContextHandle checkpointContext) { - if (checkpointContext == null) { + if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { // Clean up any leaking scopes from akka-streams/akka-http etc. AgentTracer.get().rollbackActiveToCheckpoint(); - } else { + } else if (checkpointContext != null) { checkpointContext.swap(); } } diff --git a/dd-java-agent/instrumentation/akka/akka-actor-2.5/src/test/java/datadog/trace/instrumentation/akka/concurrent/ActorScopeCleanupForkedTest.java b/dd-java-agent/instrumentation/akka/akka-actor-2.5/src/test/java/datadog/trace/instrumentation/akka/concurrent/ActorScopeCleanupForkedTest.java new file mode 100644 index 00000000000..d0c664954e4 --- /dev/null +++ b/dd-java-agent/instrumentation/akka/akka-actor-2.5/src/test/java/datadog/trace/instrumentation/akka/concurrent/ActorScopeCleanupForkedTest.java @@ -0,0 +1,43 @@ +package datadog.trace.instrumentation.akka.concurrent; + +import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import datadog.context.Context; +import datadog.context.ContextScope; +import datadog.trace.agent.test.AbstractInstrumentationTest; +import datadog.trace.api.config.TraceInstrumentationConfig; +import datadog.trace.test.junit.utils.config.WithConfig; +import org.junit.jupiter.api.Test; + +@WithConfig(key = TraceInstrumentationConfig.LEGACY_CONTEXT_MANAGER_ENABLED, value = "false") +class ActorScopeCleanupForkedTest extends AbstractInstrumentationTest { + + @Test + void actorExitClosesTaskScopeWhenEntryFailedBeforeSavingContext() { + RecordingScope taskScope = new RecordingScope(); + + assertDoesNotThrow(() -> AkkaActorCellInstrumentation.InvokeAdvice.exit(taskScope, null)); + + assertTrue(taskScope.closed); + } + + @Test + void mailboxExitToleratesEntryFailureBeforeSavingContext() { + assertDoesNotThrow(() -> AkkaMailboxInstrumentation.SuppressMailboxRunAdvice.exit(null)); + } + + private static final class RecordingScope implements ContextScope { + private boolean closed; + + @Override + public Context context() { + return Context.root(); + } + + @Override + public void close() { + closed = true; + } + } +} diff --git a/dd-java-agent/instrumentation/pekko/pekko-concurrent-1.0/src/main/java/datadog/trace/instrumentation/pekko/concurrent/PekkoActorCellInstrumentation.java b/dd-java-agent/instrumentation/pekko/pekko-concurrent-1.0/src/main/java/datadog/trace/instrumentation/pekko/concurrent/PekkoActorCellInstrumentation.java index 1909c985a4d..f7c666a36e9 100644 --- a/dd-java-agent/instrumentation/pekko/pekko-concurrent-1.0/src/main/java/datadog/trace/instrumentation/pekko/concurrent/PekkoActorCellInstrumentation.java +++ b/dd-java-agent/instrumentation/pekko/pekko-concurrent-1.0/src/main/java/datadog/trace/instrumentation/pekko/concurrent/PekkoActorCellInstrumentation.java @@ -79,10 +79,10 @@ public static void exit( @Advice.Local("taskScope") ContextScope taskScope, @Advice.Enter ContextHandle checkpointContext) { - if (checkpointContext == null) { + if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { // Clean up any leaking scopes from pekko-streams/pekko-http etc. AgentTracer.get().rollbackActiveToCheckpoint(); - } else { + } else if (checkpointContext != null) { checkpointContext.swap(); } diff --git a/dd-java-agent/instrumentation/pekko/pekko-concurrent-1.0/src/main/java/datadog/trace/instrumentation/pekko/concurrent/PekkoMailboxInstrumentation.java b/dd-java-agent/instrumentation/pekko/pekko-concurrent-1.0/src/main/java/datadog/trace/instrumentation/pekko/concurrent/PekkoMailboxInstrumentation.java index 2da7adb16d3..c742d01fca8 100644 --- a/dd-java-agent/instrumentation/pekko/pekko-concurrent-1.0/src/main/java/datadog/trace/instrumentation/pekko/concurrent/PekkoMailboxInstrumentation.java +++ b/dd-java-agent/instrumentation/pekko/pekko-concurrent-1.0/src/main/java/datadog/trace/instrumentation/pekko/concurrent/PekkoMailboxInstrumentation.java @@ -56,10 +56,10 @@ public static ContextHandle enter() { @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class) public static void exit(@Advice.Enter final ContextHandle checkpointContext) { - if (checkpointContext == null) { + if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { // Clean up any leaking scopes from pekko-streams/pekko-http etc. AgentTracer.get().rollbackActiveToCheckpoint(); - } else { + } else if (checkpointContext != null) { checkpointContext.swap(); } } diff --git a/dd-java-agent/instrumentation/pekko/pekko-concurrent-1.0/src/test/java/datadog/trace/instrumentation/pekko/concurrent/ActorScopeCleanupForkedTest.java b/dd-java-agent/instrumentation/pekko/pekko-concurrent-1.0/src/test/java/datadog/trace/instrumentation/pekko/concurrent/ActorScopeCleanupForkedTest.java new file mode 100644 index 00000000000..7e1181d52af --- /dev/null +++ b/dd-java-agent/instrumentation/pekko/pekko-concurrent-1.0/src/test/java/datadog/trace/instrumentation/pekko/concurrent/ActorScopeCleanupForkedTest.java @@ -0,0 +1,43 @@ +package datadog.trace.instrumentation.pekko.concurrent; + +import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import datadog.context.Context; +import datadog.context.ContextScope; +import datadog.trace.agent.test.AbstractInstrumentationTest; +import datadog.trace.api.config.TraceInstrumentationConfig; +import datadog.trace.test.junit.utils.config.WithConfig; +import org.junit.jupiter.api.Test; + +@WithConfig(key = TraceInstrumentationConfig.LEGACY_CONTEXT_MANAGER_ENABLED, value = "false") +class ActorScopeCleanupForkedTest extends AbstractInstrumentationTest { + + @Test + void actorExitClosesTaskScopeWhenEntryFailedBeforeSavingContext() { + RecordingScope taskScope = new RecordingScope(); + + assertDoesNotThrow(() -> PekkoActorCellInstrumentation.InvokeAdvice.exit(taskScope, null)); + + assertTrue(taskScope.closed); + } + + @Test + void mailboxExitToleratesEntryFailureBeforeSavingContext() { + assertDoesNotThrow(() -> PekkoMailboxInstrumentation.SuppressMailboxRunAdvice.exit(null)); + } + + private static final class RecordingScope implements ContextScope { + private boolean closed; + + @Override + public Context context() { + return Context.root(); + } + + @Override + public void close() { + closed = true; + } + } +} From 750252b9fb6471b27f86df7ae954740153905244 Mon Sep 17 00:00:00 2001 From: Stuart McCulloch Date: Thu, 12 Nov 2026 17:30:46 +0000 Subject: [PATCH 5/5] Check for active spans during instrumentation test teardown Finish lingering legacy iteration spans and check for remaining active spans in the test that created them. Reset context to root during setup so a failed test does not carry its active context into the next test. Preserve existing scope diagnostics and failure aggregation. --- .../agent/test/InstrumentationSpecification.groovy | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/dd-java-agent/instrumentation-testing/src/main/groovy/datadog/trace/agent/test/InstrumentationSpecification.groovy b/dd-java-agent/instrumentation-testing/src/main/groovy/datadog/trace/agent/test/InstrumentationSpecification.groovy index 00e7fba4b5b..88d21922243 100644 --- a/dd-java-agent/instrumentation-testing/src/main/groovy/datadog/trace/agent/test/InstrumentationSpecification.groovy +++ b/dd-java-agent/instrumentation-testing/src/main/groovy/datadog/trace/agent/test/InstrumentationSpecification.groovy @@ -24,6 +24,7 @@ import com.datadog.debugger.sink.DebuggerSink import com.datadog.debugger.sink.ProbeStatusSink import com.google.common.collect.Sets import datadog.communication.ddagent.DDAgentFeaturesDiscovery +import datadog.context.Context import datadog.instrument.classinject.ClassInjector import datadog.metrics.agent.AgentMeter import datadog.metrics.api.Monitoring @@ -475,10 +476,7 @@ abstract class InstrumentationSpecification extends DDSpecification implements A // even though the agent is already installed configurePreAgent() - if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { - TEST_TRACER.closePrevious(true) // in case the previous test left a lingering iteration span - } - assert TEST_TRACER.activeSpan() == null: "Span is active before test has started: " + TEST_TRACER.activeSpan() + Context.root().swap() println "Starting test: ${getSpecificationContext().getCurrentIteration().getName()} from ${specificationContext.currentSpec.name}" TEST_TRACER.flush() @@ -518,6 +516,10 @@ abstract class InstrumentationSpecification extends DDSpecification implements A void cleanup() { try { + if (InstrumenterConfig.get().isLegacyContextManagerEnabled()) { + TEST_TRACER.closePrevious(true) // finish the last iteration span before checking for leaks + } + if (isTestAgentEnabled()) { // save Datadog environment to DDAgentWriter header addEnvironmentVariablesToHeaders(TEST_AGENT_API) @@ -555,6 +557,9 @@ abstract class InstrumentationSpecification extends DDSpecification implements A // check for instrumentation issues while running each test assert InstrumentationErrors.noErrors(): InstrumentationErrors.describeErrors() + + final AgentSpan activeSpan = TEST_TRACER.activeSpan() + assert activeSpan == null: "Span is active after test has finished: " + activeSpan } catch (Throwable cleanupFailure) { if (scopeDiagnosticsFailure != null) { cleanupFailure.addSuppressed(scopeDiagnosticsFailure)