vertx-redis: avoid double span creation and double handler calls (DataDog#6334)

amarziali · web-flow · commit 5307b46fe395 · 2023-12-08T16:40:53.000+01:00
* vertx-redis: avoid double span creation

* vertx-redis: avoid double span creation
diff --git a/dd-java-agent/instrumentation/vertx-redis-client-3.9/src/main/java/datadog/trace/instrumentation/vertx_redis_client/RedisSendAdvice.java b/dd-java-agent/instrumentation/vertx-redis-client-3.9/src/main/java/datadog/trace/instrumentation/vertx_redis_client/RedisSendAdvice.java
@@ -4,6 +4,7 @@
 import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.activeSpan;
 import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.captureSpan;
 import static datadog.trace.instrumentation.vertx_redis_client.VertxRedisClientDecorator.DECORATE;
+import static datadog.trace.instrumentation.vertx_redis_client.VertxRedisClientDecorator.REDIS_COMMAND;
 
 import datadog.trace.bootstrap.CallDepthThreadLocalMap;
 import datadog.trace.bootstrap.ContextStore;
@@ -52,8 +53,14 @@ public static AgentScope beforeSend(
       return AgentTracer.NoopAgentScope.INSTANCE;
     }
 
-    AgentSpan parentSan = activeSpan();
-    AgentScope.Continuation parentContinuation = null == parentSan ? null : captureSpan(parentSan);
+    AgentSpan parentSpan = activeSpan();
+
+    if (parentSpan != null && REDIS_COMMAND.equals(parentSpan.getOperationName())) {
+      return null;
+    }
+
+    AgentScope.Continuation parentContinuation =
+        null == parentSpan ? null : captureSpan(parentSpan);
     final AgentSpan clientSpan =
         DECORATE.startAndDecorateSpan(
             request.command(), InstrumentationContext.get(Command.class, UTF8BytesString.class));
diff --git a/dd-java-agent/instrumentation/vertx-redis-client-3.9/src/main/java/datadog/trace/instrumentation/vertx_redis_client/ResponseHandler.java b/dd-java-agent/instrumentation/vertx-redis-client-3.9/src/main/java/datadog/trace/instrumentation/vertx_redis_client/ResponseHandler.java
@@ -13,6 +13,7 @@ public class ResponseHandler implements Handler<AsyncResult<Response>> {
   public final AgentSpan clientSpan;
   private final AgentScope.Continuation continuation;
   private final Promise<Response> promise;
+  private boolean handled = false;
 
   public ResponseHandler(
       final Promise<Response> promise,
@@ -25,7 +26,8 @@ public ResponseHandler(
 
   @Override
   public void handle(final AsyncResult<Response> event) {
-    if (clientSpan != null) {
+    if (!handled && clientSpan != null) {
+      handled = true;
       AgentScope scope = null;
       try {
         // Close client scope and span
diff --git a/dd-java-agent/instrumentation/vertx-redis-client-3.9/src/main/java/datadog/trace/instrumentation/vertx_redis_client/ResponseHandlerWrapper.java b/dd-java-agent/instrumentation/vertx-redis-client-3.9/src/main/java/datadog/trace/instrumentation/vertx_redis_client/ResponseHandlerWrapper.java
@@ -31,6 +31,7 @@ public void handle(final AsyncResult<Response> event) {
        already set so the handler state must be tracked here to prevent double execution
     */
     if (!handled) {
+      handled = true;
       AgentScope scope = null;
       try {
         if (null != clientSpan) {
@@ -44,7 +45,6 @@ public void handle(final AsyncResult<Response> event) {
         if (null != scope) {
           scope.close();
         }
-        handled = true;
       }
     }
   }

Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,7 @@ public void handle(final AsyncResult<Response> event) {`
`31`	`31`	`already set so the handler state must be tracked here to prevent double execution`
`32`	`32`	`*/`
`33`	`33`	`if (!handled) {`
	`34`	`+ handled = true;`
`34`	`35`	`AgentScope scope = null;`
`35`	`36`	`try {`
`36`	`37`	`if (null != clientSpan) {`
`@@ -44,7 +45,6 @@ public void handle(final AsyncResult<Response> event) {`
`44`	`45`	`if (null != scope) {`
`45`	`46`	`scope.close();`
`46`	`47`	`}`
`47`		`- handled = true;`
`48`	`48`	`}`
`49`	`49`	`}`
`50`	`50`	`}`