vertx-http-client-5.0

Author: SylvainJuge

instrumentation/vertx/vertx-http-client/vertx-http-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/v5_0/client/HttpRequestInstrumentation.java

@@ -7,6 +7,7 @@
 
 import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
 import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.implementsInterface;
+import static io.opentelemetry.javaagent.instrumentation.vertx.v5_0.client.VertxClientSingletons.CONTEXTS;
 import static io.opentelemetry.javaagent.instrumentation.vertx.v5_0.client.VertxClientSingletons.instrumenter;
 import static net.bytebuddy.matcher.ElementMatchers.isMethod;
 import static net.bytebuddy.matcher.ElementMatchers.isPrivate;
@@ -16,7 +17,6 @@
 
 import io.opentelemetry.context.Context;
 import io.opentelemetry.context.Scope;
-import io.opentelemetry.instrumentation.api.util.VirtualField;
 import io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
@@ -25,7 +25,10 @@
 import io.vertx.core.Handler;
 import io.vertx.core.http.HttpClientRequest;
 import io.vertx.core.http.HttpClientResponse;
+import javax.annotation.Nullable;
 import net.bytebuddy.asm.Advice;
+import net.bytebuddy.asm.Advice.AssignReturned;
+import net.bytebuddy.asm.Advice.AssignReturned.ToArguments.ToArgument;
 import net.bytebuddy.description.type.TypeDescription;
 import net.bytebuddy.matcher.ElementMatcher;
 
@@ -85,35 +88,47 @@ public void transform(TypeTransformer transformer) {
   @SuppressWarnings("unused")
   public static class EndRequestAdvice {
 
-    @Advice.OnMethodEnter(suppress = Throwable.class)
-    public static void attachContext(
-        @Advice.This HttpClientRequest request,
-        @Advice.Local("otelContext") Context context,
-        @Advice.Local("otelScope") Scope scope) {
-      Context parentContext = Java8BytecodeBridge.currentContext();
+    public static class AdviceScope {
+      private final Context context;
+      private final Scope scope;
+
+      private AdviceScope(Context context, Scope scope) {
+        this.context = context;
+        this.scope = scope;
+      }
 
-      if (!instrumenter().shouldStart(parentContext, request)) {
-        return;
+      @Nullable
+      public static AdviceScope startAndAttachContext(HttpClientRequest request) {
+        Context parentContext = Java8BytecodeBridge.currentContext();
+        if (!instrumenter().shouldStart(parentContext, request)) {
+          return null;
+        }
+        Context context = instrumenter().start(parentContext, request);
+        CONTEXTS.set(request, new Contexts(parentContext, context));
+        return new AdviceScope(context, context.makeCurrent());
       }
 
-      context = instrumenter().start(parentContext, request);
-      Contexts contexts = new Contexts(parentContext, context);
-      VirtualField.find(HttpClientRequest.class, Contexts.class).set(request, contexts);
+      public void end(HttpClientRequest request, @Nullable Throwable throwable) {
+        scope.close();
+        if (throwable != null) {
+          instrumenter().end(context, request, null, throwable);
+        }
+      }
+    }
 
-      scope = context.makeCurrent();
+    @Nullable
+    @Advice.OnMethodEnter(suppress = Throwable.class)
+    public static AdviceScope attachContext(@Advice.This HttpClientRequest request) {
+      return AdviceScope.startAndAttachContext(request);
     }
 
     @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
     public static void endScope(
         @Advice.This HttpClientRequest request,
-        @Advice.Local("otelContext") Context context,
-        @Advice.Local("otelScope") Scope scope,
-        @Advice.Thrown Throwable throwable) {
-      if (scope != null) {
-        scope.close();
-      }
-      if (throwable != null) {
-        instrumenter().end(context, request, null, throwable);
+        @Advice.Thrown @Nullable Throwable throwable,
+        @Advice.Enter @Nullable AdviceScope adviceScope) {
+      if (adviceScope != null) {
+        adviceScope.end(request, throwable);
       }
     }
   }
@@ -122,24 +137,21 @@ public static void endScope(
   public static class HandleExceptionAdvice {
 
     @Advice.OnMethodEnter(suppress = Throwable.class)
-    public static void handleException(
-        @Advice.This HttpClientRequest request,
-        @Advice.Argument(0) Throwable t,
-        @Advice.Local("otelScope") Scope scope) {
-      Contexts contexts = VirtualField.find(HttpClientRequest.class, Contexts.class).get(request);
-
+    public static Scope handleException(
+        @Advice.This HttpClientRequest request, @Advice.Argument(0) Throwable t) {
+      Contexts contexts = CONTEXTS.get(request);
       if (contexts == null) {
-        return;
+        return null;
       }
 
       instrumenter().end(contexts.context, request, null, t);
 
       // Scoping all potential callbacks etc to the parent context
-      scope = contexts.parentContext.makeCurrent();
+      return contexts.parentContext.makeCurrent();
     }
 
     @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
-    public static void handleResponseExit(@Advice.Local("otelScope") Scope scope) {
+    public static void handleResponseExit(@Advice.Enter Scope scope) {
       if (scope != null) {
         scope.close();
       }
@@ -150,24 +162,22 @@ public static void handleResponseExit(@Advice.Local("otelScope") Scope scope) {
   public static class HandleResponseAdvice {
 
     @Advice.OnMethodEnter(suppress = Throwable.class)
-    public static void handleResponseEnter(
-        @Advice.This HttpClientRequest request,
-        @Advice.Argument(1) HttpClientResponse response,
-        @Advice.Local("otelScope") Scope scope) {
-      Contexts contexts = VirtualField.find(HttpClientRequest.class, Contexts.class).get(request);
+    public static Scope handleResponseEnter(
+        @Advice.This HttpClientRequest request, @Advice.Argument(1) HttpClientResponse response) {
+      Contexts contexts = CONTEXTS.get(request);
 
       if (contexts == null) {
-        return;
+        return null;
       }
 
       instrumenter().end(contexts.context, request, response, null);
 
       // Scoping all potential callbacks etc to the parent context
-      scope = contexts.parentContext.makeCurrent();
+      return contexts.parentContext.makeCurrent();
     }
 
     @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
-    public static void handleResponseExit(@Advice.Local("otelScope") Scope scope) {
+    public static void handleResponseExit(@Advice.Enter Scope scope) {
       if (scope != null) {
         scope.close();
       }
@@ -178,18 +188,17 @@ public static void handleResponseExit(@Advice.Local("otelScope") Scope scope) {
   public static class MountContextAdvice {
 
     @Advice.OnMethodEnter(suppress = Throwable.class)
-    public static void mountContext(
-        @Advice.This HttpClientRequest request, @Advice.Local("otelScope") Scope scope) {
-      Contexts contexts = VirtualField.find(HttpClientRequest.class, Contexts.class).get(request);
+    public static Scope mountContext(@Advice.This HttpClientRequest request) {
+      Contexts contexts = CONTEXTS.get(request);
       if (contexts == null) {
-        return;
+        return null;
       }
 
-      scope = contexts.context.makeCurrent();
+      return contexts.context.makeCurrent();
     }
 
     @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
-    public static void unmountContext(@Advice.Local("otelScope") Scope scope) {
+    public static void unmountContext(@Advice.Enter Scope scope) {
       if (scope != null) {
         scope.close();
       }
@@ -199,15 +208,16 @@ public static void unmountContext(@Advice.Local("otelScope") Scope scope) {
   @SuppressWarnings("unused")
   public static class ExceptionHandlerAdvice {
 
+    @AssignReturned.ToArguments(@ToArgument(0))
     @Advice.OnMethodEnter(suppress = Throwable.class)
-    public static void wrapExceptionHandler(
+    public static Handler<Throwable> wrapExceptionHandler(
         @Advice.This HttpClientRequest request,
-        @Advice.Argument(value = 0, readOnly = false) Handler<Throwable> handler) {
+        @Advice.Argument(0) Handler<Throwable> originalHandler) {
+      Handler<Throwable> handler = originalHandler;
       if (handler != null) {
-        VirtualField<HttpClientRequest, Contexts> virtualField =
-            VirtualField.find(HttpClientRequest.class, Contexts.class);
-        handler = ExceptionHandlerWrapper.wrap(instrumenter(), request, virtualField, handler);
+        handler = ExceptionHandlerWrapper.wrap(instrumenter(), request, CONTEXTS, handler);
       }
+      return handler;
     }
   }
 }

instrumentation/vertx/vertx-http-client/vertx-http-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/v5_0/client/ResourceManagerInstrumentation.java

@@ -12,6 +12,7 @@
 import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
 import io.vertx.core.Future;
 import net.bytebuddy.asm.Advice;
+import net.bytebuddy.asm.Advice.AssignReturned;
 import net.bytebuddy.description.type.TypeDescription;
 import net.bytebuddy.matcher.ElementMatcher;
 
@@ -32,9 +33,10 @@ public void transform(TypeTransformer transformer) {
 
   @SuppressWarnings("unused")
   public static class WithResourceAsyncAdvice {
+    @AssignReturned.ToReturned
     @Advice.OnMethodExit(suppress = Throwable.class)
-    public static void wrapFuture(@Advice.Return(readOnly = false) Future<?> future) {
-      future = VertxClientSingletons.wrapFuture(future);
+    public static Future<?> wrapFuture(@Advice.Return Future<?> future) {
+      return VertxClientSingletons.wrapFuture(future);
     }
   }
 }

instrumentation/vertx/vertx-http-client/vertx-http-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/v5_0/client/VertxClientInstrumentationModule.java

@@ -11,11 +11,13 @@
 import com.google.auto.service.AutoService;
 import io.opentelemetry.javaagent.extension.instrumentation.InstrumentationModule;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
+import io.opentelemetry.javaagent.extension.instrumentation.internal.ExperimentalInstrumentationModule;
 import java.util.List;
 import net.bytebuddy.matcher.ElementMatcher;
 
 @AutoService(InstrumentationModule.class)
-public class VertxClientInstrumentationModule extends InstrumentationModule {
+public class VertxClientInstrumentationModule extends InstrumentationModule
+    implements ExperimentalInstrumentationModule {
 
   public VertxClientInstrumentationModule() {
     super("vertx-http-client", "vertx-http-client-5.0", "vertx");
@@ -34,4 +36,9 @@ public List<TypeInstrumentation> typeInstrumentations() {
         new HttpClientRequestBaseInstrumentation(),
         new ResourceManagerInstrumentation());
   }
+
+  @Override
+  public boolean isIndyReady() {
+    return true;
+  }
 }

instrumentation/vertx/vertx-http-client/vertx-http-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/v5_0/client/VertxClientSingletons.java

@@ -9,6 +9,7 @@
 import io.opentelemetry.context.Scope;
 import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter;
 import io.opentelemetry.instrumentation.api.util.VirtualField;
+import io.opentelemetry.javaagent.instrumentation.vertx.client.Contexts;
 import io.opentelemetry.javaagent.instrumentation.vertx.client.VertxClientInstrumenterFactory;
 import io.vertx.core.Future;
 import io.vertx.core.http.HttpClientRequest;
@@ -29,6 +30,9 @@ public static Instrumenter<HttpClientRequest, HttpClientResponse> instrumenter()
   private static final VirtualField<HttpClientRequest, HostAndPort> authorityField =
       VirtualField.find(HttpClientRequest.class, HostAndPort.class);
 
+  public static final VirtualField<HttpClientRequest, Contexts> CONTEXTS =
+      VirtualField.find(HttpClientRequest.class, Contexts.class);
+
   public static void setAuthority(HttpClientRequest request, HostAndPort authority) {
     authorityField.set(request, authority);
   }