collect metrics from http clients

jaydeluca · jaydeluca · commit 0108ba68cf8d · 2025-06-14T07:01:55.000-04:00
diff --git a/docs/instrumentation-list.yaml b/docs/instrumentation-list.yaml
diff --git a/instrumentation-docs/collect.sh b/instrumentation-docs/collect.sh
@@ -14,39 +14,59 @@ fi
 
 readonly INSTRUMENTATIONS=(
   # <module path (colon-separated)> : <javaagent|library> : [ gradle-task-suffix ]
-#  "akka:akka-http-10.0:javaagent:test"
-#  "apache-httpasyncclient-4.1:javaagent:test"
-#  "alibaba-druid-1.0:javaagent:test"
-#  "alibaba-druid-1.0:javaagent:testStableSemconv"
-#  "apache-dbcp-2.0:javaagent:test"
-#  "apache-dbcp-2.0:javaagent:testStableSemconv"
-#  "apache-httpclient:apache-httpclient-5.0:javaagent:test"
-#  "c3p0-0.9:javaagent:test"
-#  "c3p0-0.9:javaagent:testStableSemconv"
-#  "clickhouse-client-0.5:javaagent:test"
-#  "clickhouse-client-0.5:javaagent:testStableSemconv"
-#  "aws-sdk:aws-sdk-1.11:javaagent:test"
-#  "google-http-client-1.19:javaagent:test"
-#  "http-url-connection:javaagent:test"
-#  "java-http-client:javaagent:test"
-#  "jetty-httpclient:jetty-httpclient-9.2:javaagent:test"
-#  "jetty-httpclient:jetty-httpclient-12.0:javaagent:test"
-#  "jodd-http-4.2:javaagent:test"
+  "akka:akka-http-10.0:javaagent:test"
+  "apache-httpasyncclient-4.1:javaagent:test"
+  "alibaba-druid-1.0:javaagent:test"
+  "alibaba-druid-1.0:javaagent:testStableSemconv"
+  "apache-dbcp-2.0:javaagent:test"
+  "apache-dbcp-2.0:javaagent:testStableSemconv"
+  "apache-httpclient:apache-httpclient-5.0:javaagent:test"
+  "c3p0-0.9:javaagent:test"
+  "c3p0-0.9:javaagent:testStableSemconv"
+  "clickhouse-client-0.5:javaagent:test"
+  "clickhouse-client-0.5:javaagent:testStableSemconv"
+  "aws-sdk:aws-sdk-1.11:javaagent:test"
+  "google-http-client-1.19:javaagent:test"
+  "http-url-connection:javaagent:test"
+  "java-http-client:javaagent:test"
+  "jetty-httpclient:jetty-httpclient-9.2:javaagent:test"
+  "jetty-httpclient:jetty-httpclient-12.0:javaagent:test"
+  "jodd-http-4.2:javaagent:test"
   "netty:netty-3.8:javaagent:test"
-#  "aws-sdk:aws-sdk-1.11:javaagent:testStableSemconv"
-#  "aws-sdk:aws-sdk-2.2:javaagent:test"
-#  "aws-sdk:aws-sdk-2.2:javaagent:testStableSemconv"
-#  "aws-sdk:aws-sdk-2.2:javaagent:testBedrockRuntime"
-#  "hikaricp-3.0:javaagent:test"
-#  "hikaricp-3.0:javaagent:testStableSemconv"
-#  "tomcat:tomcat-jdbc:javaagent:test"
-#  "tomcat:tomcat-jdbc:javaagent:testStableSemconv"
-#  "oracle-ucp-11.2:javaagent:test"
-#  "oracle-ucp-11.2:javaagent:testStableSemconv"
-#  "oshi:javaagent:test"
-#  "oshi:javaagent:testExperimental"
-#  "vibur-dbcp-11.0:javaagent:test"
-#  "vibur-dbcp-11.0:javaagent:testStableSemconv"
+  "netty:netty-4.0:javaagent:test"
+  "netty:netty-4.1:javaagent:test"
+  "okhttp:okhttp-2.2:javaagent:test"
+  "okhttp:okhttp-3.0:javaagent:test"
+  "pekko:pekko-http-1.0:javaagent:test"
+  "play:play-ws:play-ws-1.0:javaagent:test"
+  "play:play-ws:play-ws-2.0:javaagent:test"
+  "play:play-ws:play-ws-2.1:javaagent:test"
+  "reactor:reactor-netty:reactor-netty-0.9:javaagent:test"
+  "reactor:reactor-netty:reactor-netty-1.0:javaagent:test"
+  "spring:spring-webflux:spring-webflux-5.0:javaagent:test"
+  "vertx:vertx-http-client:vertx-http-client-3.0:javaagent:test"
+  "vertx:vertx-http-client:vertx-http-client-4.0:javaagent:test"
+  "vertx:vertx-http-client:vertx-http-client-5.0:javaagent:test"
+  "vertx:vertx-redis-client-4.0:javaagent:test"
+  "vertx:vertx-redis-client-4.0:javaagent:testStableSemconv"
+  "vertx:vertx-sql-client:vertx-sql-client-4.0:javaagent:test"
+  "vertx:vertx-sql-client:vertx-sql-client-4.0:javaagent:testStableSemconv"
+  "vertx:vertx-sql-client:vertx-sql-client-5.0:javaagent:test"
+  "vertx:vertx-sql-client:vertx-sql-client-5.0:javaagent:testStableSemconv"
+  "aws-sdk:aws-sdk-1.11:javaagent:testStableSemconv"
+  "aws-sdk:aws-sdk-2.2:javaagent:test"
+  "aws-sdk:aws-sdk-2.2:javaagent:testStableSemconv"
+  "aws-sdk:aws-sdk-2.2:javaagent:testBedrockRuntime"
+  "hikaricp-3.0:javaagent:test"
+  "hikaricp-3.0:javaagent:testStableSemconv"
+  "tomcat:tomcat-jdbc:javaagent:test"
+  "tomcat:tomcat-jdbc:javaagent:testStableSemconv"
+  "oracle-ucp-11.2:javaagent:test"
+  "oracle-ucp-11.2:javaagent:testStableSemconv"
+  "oshi:javaagent:test"
+  "oshi:javaagent:testExperimental"
+  "vibur-dbcp-11.0:javaagent:test"
+  "vibur-dbcp-11.0:javaagent:testStableSemconv"
 )
 
 readonly TELEMETRY_DIR_NAME=".telemetry"
diff --git a/instrumentation/netty/netty-4.0/javaagent/build.gradle.kts b/instrumentation/netty/netty-4.0/javaagent/build.gradle.kts
@@ -48,6 +48,8 @@ tasks {
   }
 
   test {
+    systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
+
     filter {
       excludeTestsMatching("Netty40ConnectionSpanTest")
       excludeTestsMatching("Netty40ClientSslTest")
diff --git a/instrumentation/netty/netty-4.0/metadata.yaml b/instrumentation/netty/netty-4.0/metadata.yaml
@@ -0,0 +1,9 @@
+configurations:
+  - name: otel.instrumentation.netty.connection-telemetry.enabled
+    description: Enable the creation of Connect and DNS spans
+    default: false
+    type: boolean
+  - name: otel.instrumentation.netty.ssl-telemetry.enabled
+    description: Enable SSL telemetry
+    default: false
+    type: boolean
diff --git a/instrumentation/netty/netty-4.1/javaagent/build.gradle.kts b/instrumentation/netty/netty-4.1/javaagent/build.gradle.kts
@@ -56,6 +56,7 @@ tasks {
 
   test {
     systemProperty("testLatestDeps", findProperty("testLatestDeps") as Boolean)
+    systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
 
     filter {
       excludeTestsMatching("Netty41ConnectionSpanTest")
diff --git a/instrumentation/netty/netty-4.1/metadata.yaml b/instrumentation/netty/netty-4.1/metadata.yaml
@@ -0,0 +1,9 @@
+configurations:
+  - name: otel.instrumentation.netty.connection-telemetry.enabled
+    description: Enable the creation of Connect and DNS spans
+    default: false
+    type: boolean
+  - name: otel.instrumentation.netty.ssl-telemetry.enabled
+    description: Enable SSL telemetry
+    default: false
+    type: boolean
diff --git a/instrumentation/okhttp/okhttp-2.2/javaagent/build.gradle.kts b/instrumentation/okhttp/okhttp-2.2/javaagent/build.gradle.kts
@@ -22,3 +22,9 @@ dependencies {
 
   latestDepTestLibrary("com.squareup.okhttp:okhttp:2.+") // see okhttp-3.0 module
 }
+
+tasks {
+  test {
+    systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
+  }
+}
diff --git a/instrumentation/okhttp/okhttp-3.0/javaagent/build.gradle.kts b/instrumentation/okhttp/okhttp-3.0/javaagent/build.gradle.kts
@@ -43,4 +43,8 @@ tasks {
   check {
     dependsOn(testing.suites)
   }
+
+  test {
+    systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
+  }
 }
diff --git a/instrumentation/pekko/pekko-http-1.0/javaagent/build.gradle.kts b/instrumentation/pekko/pekko-http-1.0/javaagent/build.gradle.kts
@@ -92,6 +92,7 @@ tasks {
     jvmArgs("-XX:+IgnoreUnrecognizedVMOptions")
 
     systemProperty("testLatestDeps", findProperty("testLatestDeps") as Boolean)
+    systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
   }
 
   check {
diff --git a/instrumentation/play/play-ws/play-ws-1.0/javaagent/build.gradle.kts b/instrumentation/play/play-ws/play-ws-1.0/javaagent/build.gradle.kts
@@ -39,3 +39,9 @@ dependencies {
 
   latestDepTestLibrary("com.typesafe.play:play-ahc-ws-standalone_$scalaVersion:1.+") // see play-ws-2.0 module
 }
+
+tasks {
+  test {
+    systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
+  }
+}
diff --git a/instrumentation/play/play-ws/play-ws-2.0/javaagent/build.gradle.kts b/instrumentation/play/play-ws/play-ws-2.0/javaagent/build.gradle.kts
@@ -45,3 +45,9 @@ dependencies {
 
   latestDepTestLibrary("com.typesafe.play:play-ahc-ws-standalone_$scalaVersion:2.0.+") // see play-ws-2.1 module
 }
+
+tasks {
+  test {
+    systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
+  }
+}
diff --git a/instrumentation/play/play-ws/play-ws-2.1/javaagent/build.gradle.kts b/instrumentation/play/play-ws/play-ws-2.1/javaagent/build.gradle.kts
@@ -67,6 +67,10 @@ tasks {
     enabled = testLatestDeps
   }
 
+  test {
+    systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
+  }
+
   check {
     dependsOn(testing.suites)
   }
diff --git a/instrumentation/play/play-ws/play-ws-common/javaagent/build.gradle.kts b/instrumentation/play/play-ws/play-ws-common/javaagent/build.gradle.kts
@@ -7,3 +7,9 @@ val scalaVersion = "2.12"
 dependencies {
   compileOnly("com.typesafe.play:play-ahc-ws-standalone_$scalaVersion:1.0.2")
 }
+
+tasks {
+  test {
+    systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
+  }
+}
diff --git a/instrumentation/reactor/reactor-netty/reactor-netty-0.9/javaagent/build.gradle.kts b/instrumentation/reactor/reactor-netty/reactor-netty-0.9/javaagent/build.gradle.kts
@@ -42,6 +42,8 @@ tasks {
   }
 
   test {
+    systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
+
     filter {
       excludeTestsMatching("ReactorNettyConnectionSpanTest")
     }
diff --git a/instrumentation/reactor/reactor-netty/reactor-netty-1.0/javaagent/build.gradle.kts b/instrumentation/reactor/reactor-netty/reactor-netty-1.0/javaagent/build.gradle.kts
@@ -56,6 +56,8 @@ tasks {
   }
 
   test {
+    systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
+
     filter {
       excludeTestsMatching("ReactorNettyConnectionSpanTest")
       excludeTestsMatching("ReactorNettyClientSslTest")
diff --git a/instrumentation/reactor/reactor-netty/reactor-netty-1.0/metadata.yaml b/instrumentation/reactor/reactor-netty/reactor-netty-1.0/metadata.yaml
@@ -0,0 +1,5 @@
+configurations:
+  - name: otel.instrumentation.reactor-netty.connection-telemetry.enabled
+    description: Enable the creation of Connect and DNS spans.
+    type: boolean
+    default: false
diff --git a/instrumentation/spring/spring-webflux/spring-webflux-5.0/javaagent/build.gradle.kts b/instrumentation/spring/spring-webflux/spring-webflux-5.0/javaagent/build.gradle.kts
@@ -70,6 +70,7 @@ tasks.withType<Test>().configureEach {
   jvmArgs("-Dotel.instrumentation.common.experimental.controller-telemetry.enabled=true")
 
   systemProperty("testLatestDeps", findProperty("testLatestDeps") as Boolean)
+  systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
 }
 
 val latestDepTest = findProperty("testLatestDeps") as Boolean
diff --git a/instrumentation/vertx/vertx-http-client/vertx-http-client-3.0/javaagent/build.gradle.kts b/instrumentation/vertx/vertx-http-client/vertx-http-client-3.0/javaagent/build.gradle.kts
@@ -37,5 +37,6 @@ dependencies {
 tasks {
   withType<Test>().configureEach {
     systemProperty("testLatestDeps", findProperty("testLatestDeps") as Boolean)
+    systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
   }
 }
diff --git a/instrumentation/vertx/vertx-http-client/vertx-http-client-4.0/javaagent/build.gradle.kts b/instrumentation/vertx/vertx-http-client/vertx-http-client-4.0/javaagent/build.gradle.kts
@@ -24,3 +24,9 @@ dependencies {
   latestDepTestLibrary("io.vertx:vertx-core:4.+") // see vertx-http-client-5.0 module
   latestDepTestLibrary("io.vertx:vertx-codegen:4.+") // see vertx-http-client-5.0 module
 }
+
+tasks {
+  test {
+    systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
+  }
+}
diff --git a/instrumentation/vertx/vertx-http-client/vertx-http-client-5.0/javaagent/build.gradle.kts b/instrumentation/vertx/vertx-http-client/vertx-http-client-5.0/javaagent/build.gradle.kts
@@ -26,3 +26,9 @@ dependencies {
   testInstrumentation(project(":instrumentation:netty:netty-4.1:javaagent"))
   testInstrumentation(project(":instrumentation:vertx:vertx-http-client:vertx-http-client-4.0:javaagent"))
 }
+
+tasks {
+  test {
+    systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
+  }
+}
diff --git a/instrumentation/vertx/vertx-redis-client-4.0/javaagent/build.gradle.kts b/instrumentation/vertx/vertx-redis-client-4.0/javaagent/build.gradle.kts
@@ -20,13 +20,19 @@ dependencies {
   testLibrary("io.vertx:vertx-codegen:4.0.0")
 }
 
+val collectMetadata = findProperty("collectMetadata")?.toString() ?: "false"
+
 tasks {
   withType<Test>().configureEach {
     usesService(gradle.sharedServices.registrations["testcontainersBuildService"].service)
+    systemProperty("collectMetadata", collectMetadata)
   }
 
   val testStableSemconv by registering(Test::class) {
     jvmArgs("-Dotel.semconv-stability.opt-in=database")
+
+    systemProperty("collectMetadata", collectMetadata)
+    systemProperty("metaDataConfig", "otel.semconv-stability.opt-in=database")
   }
 
   check {
diff --git a/instrumentation/vertx/vertx-redis-client-4.0/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/vertx/v4_0/redis/VertxRedisClientTest.java b/instrumentation/vertx/vertx-redis-client-4.0/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/vertx/v4_0/redis/VertxRedisClientTest.java
@@ -89,6 +89,12 @@ void setCommand() throws Exception {
                     span.hasName("SET")
                         .hasKind(SpanKind.CLIENT)
                         .hasAttributesSatisfyingExactly(redisSpanAttributes("SET", "SET foo ?"))));
+
+    if (emitStableDatabaseSemconv()) {
+      testing.waitAndAssertMetrics(
+          "io.opentelemetry.vertx-redis-client-4.0",
+          metric -> metric.hasName("db.client.operation.duration"));
+    }
   }
 
   @Test
diff --git a/instrumentation/vertx/vertx-sql-client/vertx-sql-client-4.0/javaagent/build.gradle.kts b/instrumentation/vertx/vertx-sql-client/vertx-sql-client-4.0/javaagent/build.gradle.kts
@@ -28,13 +28,18 @@ dependencies {
   latestDepTestLibrary("io.vertx:vertx-codegen:4.+") // see vertx-sql-client-5.0 module
 }
 
+val collectMetadata = findProperty("collectMetadata")?.toString() ?: "false"
+
 tasks {
   withType<Test>().configureEach {
     usesService(gradle.sharedServices.registrations["testcontainersBuildService"].service)
+    systemProperty("collectMetadata", collectMetadata)
   }
 
   val testStableSemconv by registering(Test::class) {
     jvmArgs("-Dotel.semconv-stability.opt-in=database")
+
+    systemProperty("metaDataConfig", "otel.semconv-stability.opt-in=database")
   }
 
   check {
diff --git a/instrumentation/vertx/vertx-sql-client/vertx-sql-client-4.0/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/vertx/v4_0/sql/VertxSqlClientTest.java b/instrumentation/vertx/vertx-sql-client/vertx-sql-client-4.0/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/vertx/v4_0/sql/VertxSqlClientTest.java
@@ -231,6 +231,12 @@ void testPreparedSelect() throws Exception {
         .get(30, TimeUnit.SECONDS);
 
     assertPreparedSelect();
+
+    if (emitStableDatabaseSemconv()) {
+      testing.waitAndAssertMetrics(
+          "io.opentelemetry.vertx-sql-client-4.0",
+          metric -> metric.hasName("db.client.operation.duration"));
+    }
   }
 
   private static void assertPreparedSelect() {
diff --git a/instrumentation/vertx/vertx-sql-client/vertx-sql-client-5.0/javaagent/build.gradle.kts b/instrumentation/vertx/vertx-sql-client/vertx-sql-client-5.0/javaagent/build.gradle.kts
@@ -28,13 +28,18 @@ dependencies {
   testLibrary("io.vertx:vertx-pg-client:$version")
 }
 
+val collectMetadata = findProperty("collectMetadata")?.toString() ?: "false"
+
 tasks {
   withType<Test>().configureEach {
     usesService(gradle.sharedServices.registrations["testcontainersBuildService"].service)
+    systemProperty("collectMetadata", collectMetadata)
   }
 
   val testStableSemconv by registering(Test::class) {
     jvmArgs("-Dotel.semconv-stability.opt-in=database")
+
+    systemProperty("metaDataConfig", "otel.semconv-stability.opt-in=database")
   }
 
   check {
diff --git a/instrumentation/vertx/vertx-sql-client/vertx-sql-client-5.0/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/vertx/v5_0/sql/VertxSqlClientTest.java b/instrumentation/vertx/vertx-sql-client/vertx-sql-client-5.0/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/vertx/v5_0/sql/VertxSqlClientTest.java
@@ -156,6 +156,12 @@ void testSimpleSelect() throws Exception {
                     span.hasName("callback")
                         .hasKind(SpanKind.INTERNAL)
                         .hasParent(trace.getSpan(0))));
+
+    if (emitStableDatabaseSemconv()) {
+      testing.waitAndAssertMetrics(
+          "io.opentelemetry.vertx-sql-client-5.0",
+          metric -> metric.hasName("db.client.operation.duration"));
+    }
   }
 
   @Test

Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,8 @@ tasks {`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`test {`
	`51`	`+ systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")`
	`52`	`+`
`51`	`53`	`filter {`
`52`	`54`	`excludeTestsMatching("Netty40ConnectionSpanTest")`
`53`	`55`	`excludeTestsMatching("Netty40ClientSslTest")`
Original file line number	Diff line number	Diff line change
`@@ -22,3 +22,9 @@ dependencies {`
`22`	`22`
`23`	`23`	`latestDepTestLibrary("com.squareup.okhttp:okhttp:2.+") // see okhttp-3.0 module`
`24`	`24`	`}`
	`25`	`+`
	`26`	`+tasks {`
	`27`	`+ test {`
	`28`	`+ systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")`
	`29`	`+ }`
	`30`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -43,4 +43,8 @@ tasks {`
`43`	`43`	`check {`
`44`	`44`	`dependsOn(testing.suites)`
`45`	`45`	`}`
	`46`	`+`
	`47`	`+ test {`
	`48`	`+ systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")`
	`49`	`+ }`
`46`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -92,6 +92,7 @@ tasks {`
`92`	`92`	`jvmArgs("-XX:+IgnoreUnrecognizedVMOptions")`
`93`	`93`
`94`	`94`	`systemProperty("testLatestDeps", findProperty("testLatestDeps") as Boolean)`
	`95`	`+ systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")`
`95`	`96`	`}`
`96`	`97`
`97`	`98`	`check {`
Original file line number	Diff line number	Diff line change
`@@ -39,3 +39,9 @@ dependencies {`
`39`	`39`
`40`	`40`	`latestDepTestLibrary("com.typesafe.play:play-ahc-ws-standalone_$scalaVersion:1.+") // see play-ws-2.0 module`
`41`	`41`	`}`
	`42`	`+`
	`43`	`+tasks {`
	`44`	`+ test {`
	`45`	`+ systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")`
	`46`	`+ }`
	`47`	`+}`