Add instrumentation for vertx-sql-client 5.0 (#13914)

Author: laurit

.fossa.yml

@@ -958,9 +958,6 @@ targets:
     - type: gradle
       path: ./
       target: ':instrumentation:vertx:vertx-rx-java-3.5:javaagent'
-    - type: gradle
-      path: ./
-      target: ':instrumentation:vertx:vertx-sql-client-4.0:javaagent'
     - type: gradle
       path: ./
       target: ':instrumentation:vertx:vertx-web-3.0:javaagent'
@@ -1120,6 +1117,15 @@ targets:
     - type: gradle
       path: ./
       target: ':instrumentation:vertx:vertx-http-client:vertx-http-client-common:javaagent'
+    - type: gradle
+      path: ./
+      target: ':instrumentation:vertx:vertx-sql-client:vertx-sql-client-4.0:javaagent'
+    - type: gradle
+      path: ./
+      target: ':instrumentation:vertx:vertx-sql-client:vertx-sql-client-5.0:javaagent'
+    - type: gradle
+      path: ./
+      target: ':instrumentation:vertx:vertx-sql-client:vertx-sql-client-common:javaagent'
 
 experimental:
   gradle:

instrumentation/hibernate/hibernate-reactive-1.0/javaagent/build.gradle.kts

@@ -15,7 +15,7 @@ dependencies {
   compileOnly("org.hibernate.reactive:hibernate-reactive-core:1.0.0.Final")
 
   testInstrumentation(project(":instrumentation:netty:netty-4.1:javaagent"))
-  testInstrumentation(project(":instrumentation:vertx:vertx-sql-client-4.0:javaagent"))
+  testInstrumentation(project(":instrumentation:vertx:vertx-sql-client:vertx-sql-client-4.0:javaagent"))
 
   library("io.vertx:vertx-sql-client:4.4.2")
   compileOnly("io.vertx:vertx-codegen:4.4.2")

instrumentation/vertx/vertx-sql-client-4.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/v4_0/sql/VertxSqlClientSingletons.java

@@ -14,16 +14,18 @@ muzzle {
 dependencies {
   val version = "4.0.0"
   library("io.vertx:vertx-sql-client:$version")
-  compileOnly("io.vertx:vertx-codegen:$version")
+  library("io.vertx:vertx-codegen:$version")
+
+  implementation(project(":instrumentation:vertx:vertx-sql-client:vertx-sql-client-common:javaagent"))
 
   testInstrumentation(project(":instrumentation:netty:netty-4.1:javaagent"))
+  testInstrumentation(project(":instrumentation:vertx:vertx-sql-client:vertx-sql-client-5.0:javaagent"))
 
   testLibrary("io.vertx:vertx-pg-client:$version")
-  testLibrary("io.vertx:vertx-codegen:$version")
 
-  latestDepTestLibrary("io.vertx:vertx-sql-client:4.+") // documented limitation, 5.x not supported yet
-  latestDepTestLibrary("io.vertx:vertx-pg-client:4.+") // documented limitation, 5.x not supported yet
-  latestDepTestLibrary("io.vertx:vertx-codegen:4.+") // documented limitation, 5.x not supported yet
+  latestDepTestLibrary("io.vertx:vertx-sql-client:4.+") // see vertx-sql-client-5.0 module
+  latestDepTestLibrary("io.vertx:vertx-pg-client:4.+") // see vertx-sql-client-5.0 module
+  latestDepTestLibrary("io.vertx:vertx-codegen:4.+") // see vertx-sql-client-5.0 module
 }
 
 tasks {

instrumentation/vertx/vertx-sql-client-4.0/javaagent/build.gradle.kts renamed to instrumentation/vertx/vertx-sql-client/vertx-sql-client-4.0/javaagent/build.gradle.kts

@@ -7,15 +7,18 @@
 
 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.v4_0.sql.VertxSqlClientSingletons.setSqlConnectOptions;
+import static io.opentelemetry.javaagent.instrumentation.vertx.sql.VertxSqlClientUtil.getPoolSqlConnectOptions;
+import static io.opentelemetry.javaagent.instrumentation.vertx.sql.VertxSqlClientUtil.setPoolConnectOptions;
+import static io.opentelemetry.javaagent.instrumentation.vertx.sql.VertxSqlClientUtil.setSqlConnectOptions;
+import static io.opentelemetry.javaagent.instrumentation.vertx.sql.VertxSqlClientUtil.wrapContext;
+import static io.opentelemetry.javaagent.instrumentation.vertx.v4_0.sql.VertxSqlClientSingletons.attachConnectOptions;
 import static net.bytebuddy.matcher.ElementMatchers.isStatic;
 import static net.bytebuddy.matcher.ElementMatchers.named;
 import static net.bytebuddy.matcher.ElementMatchers.returns;
 import static net.bytebuddy.matcher.ElementMatchers.takesArgument;
 import static net.bytebuddy.matcher.ElementMatchers.takesArguments;
 import static net.bytebuddy.matcher.ElementMatchers.takesNoArguments;
 
-import io.opentelemetry.instrumentation.api.util.VirtualField;
 import io.opentelemetry.javaagent.bootstrap.CallDepth;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
@@ -78,10 +81,7 @@ public static void onExit(
         return;
       }
 
-      VirtualField<Pool, SqlConnectOptions> virtualField =
-          VirtualField.find(Pool.class, SqlConnectOptions.class);
-      virtualField.set(pool, sqlConnectOptions);
-
+      setPoolConnectOptions(pool, sqlConnectOptions);
       setSqlConnectOptions(null);
     }
   }
@@ -92,12 +92,10 @@ public static class GetConnectionAdvice {
     public static void onExit(
         @Advice.This Pool pool, @Advice.Return(readOnly = false) Future<SqlConnection> future) {
       // copy connect options stored on pool to new connection
-      VirtualField<Pool, SqlConnectOptions> virtualField =
-          VirtualField.find(Pool.class, SqlConnectOptions.class);
-      SqlConnectOptions sqlConnectOptions = virtualField.get(pool);
+      SqlConnectOptions sqlConnectOptions = getPoolSqlConnectOptions(pool);
 
-      future = VertxSqlClientSingletons.attachConnectOptions(future, sqlConnectOptions);
-      future = VertxSqlClientSingletons.wrapContext(future);
+      future = attachConnectOptions(future, sqlConnectOptions);
+      future = wrapContext(future);
     }
   }
 }

instrumentation/vertx/vertx-sql-client-4.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/v4_0/sql/HandlerWrapper.java renamed to instrumentation/vertx/vertx-sql-client/vertx-sql-client-4.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/v4_0/sql/HandlerWrapper.java

@@ -6,7 +6,7 @@
 package io.opentelemetry.javaagent.instrumentation.vertx.v4_0.sql;
 
 import static io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge.currentContext;
-import static io.opentelemetry.javaagent.instrumentation.vertx.v4_0.sql.VertxSqlClientSingletons.getSqlConnectOptions;
+import static io.opentelemetry.javaagent.instrumentation.vertx.sql.VertxSqlClientUtil.getSqlConnectOptions;
 import static io.opentelemetry.javaagent.instrumentation.vertx.v4_0.sql.VertxSqlClientSingletons.instrumenter;
 import static net.bytebuddy.matcher.ElementMatchers.isConstructor;
 import static net.bytebuddy.matcher.ElementMatchers.named;
@@ -17,6 +17,8 @@
 import io.opentelemetry.javaagent.bootstrap.CallDepth;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
+import io.opentelemetry.javaagent.instrumentation.vertx.sql.VertxSqlClientRequest;
+import io.opentelemetry.javaagent.instrumentation.vertx.sql.VertxSqlClientUtil;
 import io.vertx.core.impl.future.PromiseInternal;
 import io.vertx.sqlclient.impl.PreparedStatement;
 import io.vertx.sqlclient.impl.QueryExecutorUtil;
@@ -95,7 +97,7 @@ public static void onEnter(
 
       context = instrumenter().start(parentContext, otelRequest);
       scope = context.makeCurrent();
-      VertxSqlClientSingletons.attachRequest(promiseInternal, otelRequest, context, parentContext);
+      VertxSqlClientUtil.attachRequest(promiseInternal, otelRequest, context, parentContext);
     }
 
     @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)

instrumentation/vertx/vertx-sql-client-4.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/v4_0/sql/PoolInstrumentation.java renamed to instrumentation/vertx/vertx-sql-client/vertx-sql-client-4.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/v4_0/sql/PoolInstrumentation.java

@@ -5,7 +5,8 @@
 
 package io.opentelemetry.javaagent.instrumentation.vertx.v4_0.sql;
 
-import static io.opentelemetry.javaagent.instrumentation.vertx.v4_0.sql.VertxSqlClientSingletons.endQuerySpan;
+import static io.opentelemetry.javaagent.instrumentation.vertx.sql.VertxSqlClientUtil.endQuerySpan;
+import static io.opentelemetry.javaagent.instrumentation.vertx.v4_0.sql.VertxSqlClientSingletons.instrumenter;
 import static net.bytebuddy.matcher.ElementMatchers.named;
 import static net.bytebuddy.matcher.ElementMatchers.takesArguments;
 
@@ -38,7 +39,7 @@ public void transform(TypeTransformer transformer) {
   public static class CompleteAdvice {
     @Advice.OnMethodEnter(suppress = Throwable.class)
     public static Scope onEnter(@Advice.FieldValue("handler") Promise<?> promise) {
-      return endQuerySpan(promise, null);
+      return endQuerySpan(instrumenter(), promise, null);
     }
 
     @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
@@ -54,7 +55,7 @@ public static class FailAdvice {
     @Advice.OnMethodEnter(suppress = Throwable.class)
     public static Scope onEnter(
         @Advice.Argument(0) Throwable throwable, @Advice.FieldValue("handler") Promise<?> promise) {
-      return endQuerySpan(promise, throwable);
+      return endQuerySpan(instrumenter(), promise, throwable);
     }
 
     @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)

instrumentation/vertx/vertx-sql-client-4.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/v4_0/sql/QueryExecutorInstrumentation.java renamed to instrumentation/vertx/vertx-sql-client/vertx-sql-client-4.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/v4_0/sql/QueryExecutorInstrumentation.java

@@ -5,13 +5,14 @@
 
 package io.opentelemetry.javaagent.instrumentation.vertx.v4_0.sql;
 
+import static io.opentelemetry.javaagent.instrumentation.vertx.sql.VertxSqlClientUtil.getSqlConnectOptions;
+import static io.opentelemetry.javaagent.instrumentation.vertx.sql.VertxSqlClientUtil.setSqlConnectOptions;
+import static io.opentelemetry.javaagent.instrumentation.vertx.v4_0.sql.VertxSqlClientSingletons.attachConnectOptions;
 import static io.opentelemetry.javaagent.instrumentation.vertx.v4_0.sql.VertxSqlClientSingletons.getSqlConnectOptions;
-import static io.opentelemetry.javaagent.instrumentation.vertx.v4_0.sql.VertxSqlClientSingletons.setSqlConnectOptions;
 import static net.bytebuddy.matcher.ElementMatchers.isConstructor;
 import static net.bytebuddy.matcher.ElementMatchers.named;
 import static net.bytebuddy.matcher.ElementMatchers.namedOneOf;
 
-import io.opentelemetry.instrumentation.api.util.VirtualField;
 import io.opentelemetry.javaagent.bootstrap.CallDepth;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
@@ -42,10 +43,7 @@ public static class ConstructorAdvice {
     @Advice.OnMethodExit(suppress = Throwable.class)
     public static void onExit(@Advice.This SqlClientBase<?> sqlClientBase) {
       // copy connection options from ThreadLocal to VirtualField
-      // this virtual field is also set in VertxSqlClientSingletons.attachConnectOptions
-      VirtualField<SqlClientBase<?>, SqlConnectOptions> virtualField =
-          VirtualField.find(SqlClientBase.class, SqlConnectOptions.class);
-      virtualField.set(sqlClientBase, getSqlConnectOptions());
+      attachConnectOptions(sqlClientBase, getSqlConnectOptions());
     }
   }
 
@@ -61,9 +59,7 @@ public static void onEnter(
       }
 
       // set connection options to ThreadLocal, they will be read in QueryExecutor constructor
-      VirtualField<SqlClientBase<?>, SqlConnectOptions> virtualField =
-          VirtualField.find(SqlClientBase.class, SqlConnectOptions.class);
-      SqlConnectOptions sqlConnectOptions = virtualField.get(sqlClientBase);
+      SqlConnectOptions sqlConnectOptions = getSqlConnectOptions(sqlClientBase);
       setSqlConnectOptions(sqlConnectOptions);
     }