Replace TraceScope.capture() with Tracer.captureActiveSpan()

Author: mcculls

dd-java-agent/instrumentation/servicetalk/src/test/groovy/ContextPreservingInstrumentationTest.groovy

@@ -113,7 +113,7 @@ class ContextPreservingInstrumentationTest extends AgentTestRunner {
    */
   private class ParentContext {
     final ContextMap contextMap = AsyncContext.context().copy()
-    final AgentScope.Continuation spanContinuation = AgentTracer.captureSpan(AgentTracer.activeSpan())
+    final AgentScope.Continuation spanContinuation = AgentTracer.captureActiveSpan()
 
     def releaseParentSpan() {
       spanContinuation.cancel()

dd-java-agent/instrumentation/zio/zio-2.0/src/main/java/datadog/trace/instrumentation/zio/v2_0/FiberContext.java

@@ -1,10 +1,8 @@
 package datadog.trace.instrumentation.zio.v2_0;
 
-import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.activeSpan;
-import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.captureSpan;
+import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.captureActiveSpan;
 
 import datadog.trace.bootstrap.instrumentation.api.AgentScope;
-import datadog.trace.bootstrap.instrumentation.api.AgentSpan;
 import datadog.trace.bootstrap.instrumentation.api.AgentTracer;
 import datadog.trace.bootstrap.instrumentation.api.ScopeState;
 
@@ -18,8 +16,7 @@ private FiberContext(ScopeState state) {
     this.state = state;
     this.scope = null;
     this.oldState = null;
-    AgentSpan span = activeSpan();
-    this.continuation = null != span ? captureSpan(span) : null;
+    this.continuation = captureActiveSpan();
   }
 
   public static FiberContext create() {

dd-trace-api/src/main/java/datadog/trace/api/GlobalTracer.java

@@ -26,22 +26,27 @@ public String getSpanId() {
         }
 
         @Override
-        public boolean isAsyncPropagationEnabled() {
+        public boolean addTraceInterceptor(TraceInterceptor traceInterceptor) {
           return false;
         }
 
         @Override
-        public void setAsyncPropagationEnabled(boolean asyncPropagationEnabled) {}
+        public TraceScope muteTracing() {
+          return NoopTraceScope.INSTANCE;
+        }
 
         @Override
-        public boolean addTraceInterceptor(TraceInterceptor traceInterceptor) {
-          return false;
+        public TraceScope.Continuation captureActiveSpan() {
+          return NoopTraceScope.NoopContinuation.INSTANCE;
         }
 
         @Override
-        public TraceScope muteTracing() {
-          return NoopTraceScope.INSTANCE;
+        public boolean isAsyncPropagationEnabled() {
+          return false;
         }
+
+        @Override
+        public void setAsyncPropagationEnabled(boolean asyncPropagationEnabled) {}
       };
 
   private static final Collection<Callback> installationCallbacks = new ArrayList<>();

dd-trace-api/src/main/java/datadog/trace/api/Tracer.java

@@ -14,6 +14,29 @@ public interface Tracer {
    */
   String getSpanId();
 
+  /**
+   * Add a new interceptor to the tracer. Interceptors with duplicate priority to existing ones are
+   * ignored.
+   *
+   * @param traceInterceptor
+   * @return false if an interceptor with same priority exists.
+   */
+  boolean addTraceInterceptor(TraceInterceptor traceInterceptor);
+
+  TraceScope muteTracing();
+
+  /**
+   * Prevent the currently active trace from reporting until the returned Continuation is either
+   * activated (and the returned scope is closed), or canceled.
+   *
+   * <p>Should be called on the parent thread.
+   *
+   * @deprecated Unstable API. Might be removed at any time.
+   * @return Continuation of the active span, no-op continuation if there's no active span.
+   */
+  @Deprecated
+  TraceScope.Continuation captureActiveSpan();
+
   /**
    * Checks whether asynchronous propagation is enabled, meaning this context will propagate across
    * asynchronous boundaries.
@@ -36,15 +59,4 @@ public interface Tracer {
    */
   @Deprecated
   void setAsyncPropagationEnabled(boolean asyncPropagationEnabled);
-
-  /**
-   * Add a new interceptor to the tracer. Interceptors with duplicate priority to existing ones are
-   * ignored.
-   *
-   * @param traceInterceptor
-   * @return false if an interceptor with same priority exists.
-   */
-  boolean addTraceInterceptor(TraceInterceptor traceInterceptor);
-
-  TraceScope muteTracing();
 }

dd-trace-api/src/main/java/datadog/trace/context/TraceScope.java

@@ -6,24 +6,29 @@
 
 /** An object which can propagate a datadog trace across multiple threads. */
 public interface TraceScope extends Closeable {
+
+  /** Close the activated context and allow any underlying spans to finish. */
+  @Override
+  void close();
+
   /**
-   * Prevent the trace attached to this TraceScope from reporting until the returned Continuation is
-   * either activated (and the returned scope is closed), or canceled.
-   *
-   * <p>Should be called on the parent thread.
+   * @deprecated Replaced by {@link Tracer#captureActiveSpan()}.
+   *     <p>Prevent the currently active trace from reporting until the returned Continuation is
+   *     either activated (and the returned scope is closed), or canceled. Should be called on the
+   *     parent thread.
+   * @return Continuation of the active span, no-op continuation if there's no active span.
    */
-  Continuation capture();
+  @Deprecated
+  default Continuation capture() {
+    return GlobalTracer.get().captureActiveSpan();
+  }
 
   /** @deprecated Replaced by {@code capture().hold()}. */
   @Deprecated
   default Continuation captureConcurrent() {
     return capture().hold();
   }
 
-  /** Close the activated context and allow any underlying spans to finish. */
-  @Override
-  void close();
-
   /**
    * @deprecated Replaced by {@link Tracer#isAsyncPropagationEnabled()}.
    *     <p>Calling this method will check whether asynchronous propagation is active <strong>for

dd-trace-core/src/main/java/datadog/trace/core/CoreTracer.java

@@ -932,6 +932,16 @@ public AgentScope activateSpan(AgentSpan span, ScopeSource source, boolean isAsy
     return scopeManager.activate(span, source, isAsyncPropagating);
   }
 
+  @Override
+  public AgentScope.Continuation captureActiveSpan() {
+    AgentSpan span = scopeManager.activeSpan();
+    if (null != span) {
+      return scopeManager.captureSpan(span);
+    } else {
+      return AgentTracer.noopContinuation();
+    }
+  }
+
   @Override
   public AgentScope.Continuation captureSpan(final AgentSpan span) {
     return scopeManager.captureSpan(span);

dd-trace-ot/src/main/java/datadog/opentracing/DDTracer.java

@@ -430,23 +430,28 @@ public String getSpanId() {
   }
 
   @Override
-  public boolean isAsyncPropagationEnabled() {
-    return tracer.isAsyncPropagationEnabled();
+  public boolean addTraceInterceptor(final TraceInterceptor traceInterceptor) {
+    return tracer.addTraceInterceptor(traceInterceptor);
   }
 
   @Override
-  public void setAsyncPropagationEnabled(boolean asyncPropagationEnabled) {
-    tracer.setAsyncPropagationEnabled(asyncPropagationEnabled);
+  public TraceScope muteTracing() {
+    return tracer.muteTracing();
   }
 
   @Override
-  public boolean addTraceInterceptor(final TraceInterceptor traceInterceptor) {
-    return tracer.addTraceInterceptor(traceInterceptor);
+  public TraceScope.Continuation captureActiveSpan() {
+    return tracer.captureActiveSpan();
   }
 
   @Override
-  public TraceScope muteTracing() {
-    return tracer.muteTracing();
+  public boolean isAsyncPropagationEnabled() {
+    return tracer.isAsyncPropagationEnabled();
+  }
+
+  @Override
+  public void setAsyncPropagationEnabled(boolean asyncPropagationEnabled) {
+    tracer.setAsyncPropagationEnabled(asyncPropagationEnabled);
   }
 
   @Override

internal-api/src/main/java/datadog/trace/bootstrap/instrumentation/api/AgentTracer.java

@@ -94,6 +94,10 @@ public static AgentScope activateSpan(final AgentSpan span, final boolean isAsyn
     return get().activateSpan(span, ScopeSource.INSTRUMENTATION, isAsyncPropagating);
   }
 
+  public static AgentScope.Continuation captureActiveSpan() {
+    return get().captureActiveSpan();
+  }
+
   public static AgentScope.Continuation captureSpan(final AgentSpan span) {
     return get().captureSpan(span);
   }
@@ -286,6 +290,9 @@ AgentSpan startSpan(
 
     AgentScope activateSpan(AgentSpan span, ScopeSource source, boolean isAsyncPropagating);
 
+    @Override
+    AgentScope.Continuation captureActiveSpan();
+
     AgentScope.Continuation captureSpan(AgentSpan span);
 
     void closePrevious(boolean finishSpan);
@@ -425,6 +432,11 @@ public AgentScope activateSpan(
       return NoopScope.INSTANCE;
     }
 
+    @Override
+    public AgentScope.Continuation captureActiveSpan() {
+      return NoopContinuation.INSTANCE;
+    }
+
     @Override
     public AgentScope.Continuation captureSpan(final AgentSpan span) {
       return NoopContinuation.INSTANCE;