Skip to content

Add instrumentation for vertx-sql-client 5.0 #13914

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 29, 2025
Merged

Add instrumentation for vertx-sql-client 5.0 #13914

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
77ed62e
Add instrumentation for vertx-sql-client 5.0
laurit May 23, 2025
ff02659
Merge branch 'main' into vertx-sql-client5
laurit May 23, 2025
5a3b1b4
update fossa conf
laurit May 23, 2025
884cf8d
set min java version to 11
laurit May 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions .fossa.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down Expand Up @@ -1117,6 +1114,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:
Expand Down
2 changes: 1 addition & 1 deletion instrumentation/hibernate/hibernate-reactive-1.0/javaagent/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down
132 changes: 0 additions & 132 deletions ...a/io/opentelemetry/javaagent/instrumentation/vertx/v4_0/sql/VertxSqlClientSingletons.java
View file
Open in desktop

This file was deleted.

12 changes: 7 additions & 5 deletions ...sql-client-4.0/javaagent/build.gradle.kts → ...sql-client-4.0/javaagent/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
0 ...tation/vertx/v4_0/sql/HandlerWrapper.java → ...tation/vertx/v4_0/sql/HandlerWrapper.java
View file
Open in desktop
File renamed without changes.
20 changes: 9 additions & 11 deletions ...n/vertx/v4_0/sql/PoolInstrumentation.java → ...n/vertx/v4_0/sql/PoolInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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);
}
}
Expand All @@ -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);
}
}
}
6 changes: 4 additions & 2 deletions ...4_0/sql/QueryExecutorInstrumentation.java → ...4_0/sql/QueryExecutorInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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;
Expand Down Expand Up @@ -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)
Expand Down
7 changes: 4 additions & 3 deletions ...ql/QueryResultBuilderInstrumentation.java → ...ql/QueryResultBuilderInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down Expand Up @@ -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)
Expand All @@ -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)
Expand Down
14 changes: 5 additions & 9 deletions ...4_0/sql/SqlClientBaseInstrumentation.java → ...4_0/sql/SqlClientBaseInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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());
}
}

Expand All @@ -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);
}

Expand Down
0 ...0/sql/TransactionImplInstrumentation.java → ...0/sql/TransactionImplInstrumentation.java
View file
Open in desktop
File renamed without changes.
8 changes: 8 additions & 0 deletions .../VertxSqlClientInstrumentationModule.java → .../VertxSqlClientInstrumentationModule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

package io.opentelemetry.javaagent.instrumentation.vertx.v4_0.sql;

import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
import static java.util.Arrays.asList;
import static java.util.Collections.singletonList;

Expand All @@ -13,6 +14,7 @@
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 VertxSqlClientInstrumentationModule extends InstrumentationModule
Expand All @@ -22,6 +24,12 @@ public VertxSqlClientInstrumentationModule() {
super("vertx-sql-client", "vertx-sql-client-4.0", "vertx");
}

@Override
public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
// removed in 5.0
return hasClassesNamed("io.vertx.sqlclient.impl.SqlClientBase");
}

@Override
public boolean isHelperClass(String className) {
return "io.vertx.sqlclient.impl.QueryExecutorUtil".equals(className);
Expand Down
Loading
Loading