Jedis and Jetty metadata updates (#15202)

jaydeluca · web-flow · commit e43b3d5cb68e · 2025-11-03T14:59:05.000+02:00
diff --git a/docs/instrumentation-list.yaml b/docs/instrumentation-list.yaml
diff --git a/instrumentation-docs/instrumentations.sh b/instrumentation-docs/instrumentations.sh
@@ -128,6 +128,15 @@ readonly INSTRUMENTATIONS=(
   "jaxws:jaxws-cxf-3.0:javaagent:test"
   "jaxws:jaxws-jws-api-1.1:javaagent:test"
   "jaxws:jaxws-metro-2.2:javaagent:test"
+  "jedis:jedis-1.4:javaagent:test"
+  "jedis:jedis-1.4:javaagent:testStableSemconv"
+  "jedis:jedis-3.0:javaagent:test"
+  "jedis:jedis-3.0:javaagent:testStableSemconv"
+  "jedis:jedis-4.0:javaagent:test"
+  "jedis:jedis-4.0:javaagent:testStableSemconv"
+  "jetty:jetty-8.0:javaagent:test"
+  "jetty:jetty-11.0:javaagent:test"
+  "jetty:jetty-12.0:javaagent:test"
   "jetty-httpclient:jetty-httpclient-12.0:javaagent:test"
   "jetty-httpclient:jetty-httpclient-9.2:javaagent:test"
   "jodd-http-4.2:javaagent:test"
diff --git a/instrumentation/jedis/jedis-1.4/javaagent/build.gradle.kts b/instrumentation/jedis/jedis-1.4/javaagent/build.gradle.kts
@@ -41,13 +41,15 @@ testing {
 tasks {
   withType<Test>().configureEach {
     usesService(gradle.sharedServices.registrations["testcontainersBuildService"].service)
+    systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
   }
 
   val testStableSemconv by registering(Test::class) {
     testClassesDirs = sourceSets.test.get().output.classesDirs
     classpath = sourceSets.test.get().runtimeClasspath
 
     jvmArgs("-Dotel.semconv-stability.opt-in=database")
+    systemProperty("metadataConfig", "otel.semconv-stability.opt-in=database")
   }
 
   check {
diff --git a/instrumentation/jedis/jedis-1.4/metadata.yaml b/instrumentation/jedis/jedis-1.4/metadata.yaml
@@ -0,0 +1,14 @@
+description: This instrumentation enables database client spans and database client metrics for Jedis Redis operations.
+semantic_conventions:
+  - DATABASE_CLIENT_SPANS
+  - DATABASE_CLIENT_METRICS
+library_link: https://github.com/redis/jedis
+configurations:
+  - name: otel.instrumentation.common.db-statement-sanitizer.enabled
+    description: Enables statement sanitization for database queries.
+    type: boolean
+    default: true
+  - name: otel.instrumentation.common.peer-service-mapping
+    description: Used to specify a mapping from host names or IP addresses to peer services.
+    type: map
+    default: ""
diff --git a/instrumentation/jedis/jedis-1.4/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/jedis/AbstractJedisTest.java b/instrumentation/jedis/jedis-1.4/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/jedis/AbstractJedisTest.java
@@ -5,13 +5,16 @@
 
 package io.opentelemetry.javaagent.instrumentation.jedis;
 
+import static io.opentelemetry.instrumentation.testing.junit.db.DbClientMetricsTestUtil.assertDurationMetric;
 import static io.opentelemetry.instrumentation.testing.junit.db.SemconvStabilityUtil.maybeStable;
 import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo;
 import static io.opentelemetry.semconv.ServerAttributes.SERVER_ADDRESS;
 import static io.opentelemetry.semconv.ServerAttributes.SERVER_PORT;
 import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_OPERATION;
+import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_OPERATION_NAME;
 import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_STATEMENT;
 import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_SYSTEM;
+import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_SYSTEM_NAME;
 import static io.opentelemetry.semconv.incubating.PeerIncubatingAttributes.PEER_SERVICE;
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -76,6 +79,14 @@ void setCommand() {
                             equalTo(PEER_SERVICE, "test-peer-service"),
                             equalTo(SERVER_ADDRESS, host),
                             equalTo(SERVER_PORT, port))));
+
+    assertDurationMetric(
+        testing,
+        "io.opentelemetry.jedis-1.4",
+        DB_SYSTEM_NAME,
+        DB_OPERATION_NAME,
+        SERVER_ADDRESS,
+        SERVER_PORT);
   }
 
   @Test
diff --git a/instrumentation/jedis/jedis-3.0/javaagent/build.gradle.kts b/instrumentation/jedis/jedis-3.0/javaagent/build.gradle.kts
@@ -31,13 +31,15 @@ dependencies {
 tasks {
   withType<Test>().configureEach {
     usesService(gradle.sharedServices.registrations["testcontainersBuildService"].service)
+    systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
   }
 
   val testStableSemconv by registering(Test::class) {
     testClassesDirs = sourceSets.test.get().output.classesDirs
     classpath = sourceSets.test.get().runtimeClasspath
 
     jvmArgs("-Dotel.semconv-stability.opt-in=database")
+    systemProperty("metadataConfig", "otel.semconv-stability.opt-in=database")
   }
 
   check {
diff --git a/instrumentation/jedis/jedis-3.0/metadata.yaml b/instrumentation/jedis/jedis-3.0/metadata.yaml
@@ -0,0 +1,14 @@
+description: This instrumentation enables database client spans and database client metrics for Jedis Redis operations.
+semantic_conventions:
+  - DATABASE_CLIENT_SPANS
+  - DATABASE_CLIENT_METRICS
+library_link: https://github.com/redis/jedis
+configurations:
+  - name: otel.instrumentation.common.db-statement-sanitizer.enabled
+    description: Enables statement sanitization for database queries.
+    type: boolean
+    default: true
+  - name: otel.instrumentation.common.peer-service-mapping
+    description: Used to specify a mapping from host names or IP addresses to peer services.
+    type: map
+    default: ""
diff --git a/instrumentation/jedis/jedis-4.0/javaagent/build.gradle.kts b/instrumentation/jedis/jedis-4.0/javaagent/build.gradle.kts
@@ -29,13 +29,15 @@ tasks {
     // latest dep test fails because peer ip is 0:0:0:0:0:0:0:1 instead of 127.0.0.1
     jvmArgs("-Djava.net.preferIPv4Stack=true")
     usesService(gradle.sharedServices.registrations["testcontainersBuildService"].service)
+    systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
   }
 
   val testStableSemconv by registering(Test::class) {
     testClassesDirs = sourceSets.test.get().output.classesDirs
     classpath = sourceSets.test.get().runtimeClasspath
 
     jvmArgs("-Dotel.semconv-stability.opt-in=database")
+    systemProperty("metadataConfig", "otel.semconv-stability.opt-in=database")
   }
 
   check {
diff --git a/instrumentation/jedis/jedis-4.0/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/jedis/v4_0/Jedis40ClientTest.java b/instrumentation/jedis/jedis-4.0/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/jedis/v4_0/Jedis40ClientTest.java
@@ -5,14 +5,17 @@
 
 package io.opentelemetry.javaagent.instrumentation.jedis.v4_0;
 
+import static io.opentelemetry.instrumentation.testing.junit.db.DbClientMetricsTestUtil.assertDurationMetric;
 import static io.opentelemetry.instrumentation.testing.junit.db.SemconvStabilityUtil.maybeStable;
 import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo;
 import static io.opentelemetry.semconv.NetworkAttributes.NETWORK_PEER_ADDRESS;
 import static io.opentelemetry.semconv.NetworkAttributes.NETWORK_PEER_PORT;
 import static io.opentelemetry.semconv.NetworkAttributes.NETWORK_TYPE;
 import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_OPERATION;
+import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_OPERATION_NAME;
 import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_STATEMENT;
 import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_SYSTEM;
+import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_SYSTEM_NAME;
 import static org.assertj.core.api.Assertions.assertThat;
 
 import io.opentelemetry.api.trace.SpanKind;
@@ -79,6 +82,14 @@ void setCommand() {
                             equalTo(NETWORK_TYPE, "ipv4"),
                             equalTo(NETWORK_PEER_PORT, port),
                             equalTo(NETWORK_PEER_ADDRESS, ip))));
+
+    assertDurationMetric(
+        testing,
+        "io.opentelemetry.jedis-4.0",
+        DB_SYSTEM_NAME,
+        DB_OPERATION_NAME,
+        NETWORK_PEER_ADDRESS,
+        NETWORK_PEER_PORT);
   }
 
   @Test
diff --git a/instrumentation/jedis/jedis-4.0/metadata.yaml b/instrumentation/jedis/jedis-4.0/metadata.yaml
@@ -0,0 +1,10 @@
+description: This instrumentation enables database client spans and database client metrics for Jedis Redis operations.
+semantic_conventions:
+  - DATABASE_CLIENT_SPANS
+  - DATABASE_CLIENT_METRICS
+library_link: https://github.com/redis/jedis
+configurations:
+  - name: otel.instrumentation.common.db-statement-sanitizer.enabled
+    description: Enables statement sanitization for database queries.
+    type: boolean
+    default: true
diff --git a/instrumentation/jetty-httpclient/jetty-httpclient-12.0/metadata.yaml b/instrumentation/jetty-httpclient/jetty-httpclient-12.0/metadata.yaml
@@ -0,0 +1,35 @@
+description: This instrumentation enables HTTP client spans and HTTP client metrics for Jetty HTTP Client.
+semantic_conventions:
+  - HTTP_CLIENT_SPANS
+  - HTTP_CLIENT_METRICS
+library_link: https://eclipse.dev/jetty/
+configurations:
+  - name: otel.instrumentation.http.known-methods
+    description: >
+      Configures the instrumentation to recognize an alternative set of HTTP request methods. All
+      other methods will be treated as `_OTHER`.
+    type: list
+    default: "CONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACE"
+  - name: otel.instrumentation.http.client.capture-request-headers
+    description: List of HTTP request headers to capture in HTTP client telemetry.
+    type: list
+    default: ""
+  - name: otel.instrumentation.http.client.capture-response-headers
+    description: List of HTTP response headers to capture in HTTP client telemetry.
+    type: list
+    default: ""
+  - name: otel.instrumentation.common.peer-service-mapping
+    description: Used to specify a mapping from host names or IP addresses to peer services.
+    type: map
+    default: ""
+  - name: otel.instrumentation.http.client.emit-experimental-telemetry
+    description: >
+      Enable the capture of experimental HTTP client telemetry. Adds the `http.request.body.size`
+      and `http.response.body.size` attributes to spans, and records `http.client.request.size` and
+      `http.client.response.size` metrics.
+    type: boolean
+    default: false
+  - name: otel.instrumentation.http.client.experimental.redact-query-parameters
+    description: Redact sensitive URL parameters. See https://opentelemetry.io/docs/specs/semconv/http/http-spans.
+    type: boolean
+    default: true
diff --git a/instrumentation/jetty-httpclient/jetty-httpclient-9.2/metadata.yaml b/instrumentation/jetty-httpclient/jetty-httpclient-9.2/metadata.yaml
@@ -0,0 +1,35 @@
+description: This instrumentation enables HTTP client spans and HTTP client metrics for Jetty HTTP Client.
+semantic_conventions:
+  - HTTP_CLIENT_SPANS
+  - HTTP_CLIENT_METRICS
+library_link: https://eclipse.dev/jetty/
+configurations:
+  - name: otel.instrumentation.http.known-methods
+    description: >
+      Configures the instrumentation to recognize an alternative set of HTTP request methods. All
+      other methods will be treated as `_OTHER`.
+    type: list
+    default: "CONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACE"
+  - name: otel.instrumentation.http.client.capture-request-headers
+    description: List of HTTP request headers to capture in HTTP client telemetry.
+    type: list
+    default: ""
+  - name: otel.instrumentation.http.client.capture-response-headers
+    description: List of HTTP response headers to capture in HTTP client telemetry.
+    type: list
+    default: ""
+  - name: otel.instrumentation.common.peer-service-mapping
+    description: Used to specify a mapping from host names or IP addresses to peer services.
+    type: map
+    default: ""
+  - name: otel.instrumentation.http.client.emit-experimental-telemetry
+    description: >
+      Enable the capture of experimental HTTP client telemetry. Adds the `http.request.body.size`
+      and `http.response.body.size` attributes to spans, and records `http.client.request.size` and
+      `http.client.response.size` metrics.
+    type: boolean
+    default: false
+  - name: otel.instrumentation.http.client.experimental.redact-query-parameters
+    description: Redact sensitive URL parameters. See https://opentelemetry.io/docs/specs/semconv/http/http-spans.
+    type: boolean
+    default: true
diff --git a/instrumentation/jetty/jetty-11.0/javaagent/build.gradle.kts b/instrumentation/jetty/jetty-11.0/javaagent/build.gradle.kts
@@ -28,3 +28,7 @@ dependencies {
 otelJava {
   minJavaVersionSupported.set(JavaVersion.VERSION_11)
 }
+
+tasks.test {
+  systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
+}
diff --git a/instrumentation/jetty/jetty-11.0/metadata.yaml b/instrumentation/jetty/jetty-11.0/metadata.yaml
@@ -0,0 +1,27 @@
+description: This instrumentation enables HTTP server spans and HTTP server metrics for Jetty.
+semantic_conventions:
+  - HTTP_SERVER_SPANS
+  - HTTP_SERVER_METRICS
+library_link: https://eclipse.dev/jetty/
+configurations:
+  - name: otel.instrumentation.http.known-methods
+    description: >
+      Configures the instrumentation to recognize an alternative set of HTTP request methods. All
+      other methods will be treated as `_OTHER`.
+    type: list
+    default: "CONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACE"
+  - name: otel.instrumentation.http.server.capture-request-headers
+    description: List of HTTP request headers to capture in HTTP server telemetry.
+    type: list
+    default: ""
+  - name: otel.instrumentation.http.server.capture-response-headers
+    description: List of HTTP response headers to capture in HTTP server telemetry.
+    type: list
+    default: ""
+  - name: otel.instrumentation.http.server.emit-experimental-telemetry
+    description: >
+      Enable the capture of experimental HTTP server telemetry. Adds the `http.request.body.size`
+      and `http.response.body.size` attributes to spans, and records `http.server.request.size` and
+      `http.server.response.size` metrics.
+    type: boolean
+    default: false
diff --git a/instrumentation/jetty/jetty-12.0/javaagent/build.gradle.kts b/instrumentation/jetty/jetty-12.0/javaagent/build.gradle.kts
@@ -25,3 +25,7 @@ dependencies {
 otelJava {
   minJavaVersionSupported.set(JavaVersion.VERSION_17)
 }
+
+tasks.test {
+  systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
+}
diff --git a/instrumentation/jetty/jetty-12.0/metadata.yaml b/instrumentation/jetty/jetty-12.0/metadata.yaml
@@ -0,0 +1,27 @@
+description: This instrumentation enables HTTP server spans and HTTP server metrics for Jetty.
+semantic_conventions:
+  - HTTP_SERVER_SPANS
+  - HTTP_SERVER_METRICS
+library_link: https://eclipse.dev/jetty/
+configurations:
+  - name: otel.instrumentation.http.known-methods
+    description: >
+      Configures the instrumentation to recognize an alternative set of HTTP request methods. All
+      other methods will be treated as `_OTHER`.
+    type: list
+    default: "CONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACE"
+  - name: otel.instrumentation.http.server.capture-request-headers
+    description: List of HTTP request headers to capture in HTTP server telemetry.
+    type: list
+    default: ""
+  - name: otel.instrumentation.http.server.capture-response-headers
+    description: List of HTTP response headers to capture in HTTP server telemetry.
+    type: list
+    default: ""
+  - name: otel.instrumentation.http.server.emit-experimental-telemetry
+    description: >
+      Enable the capture of experimental HTTP server telemetry. Adds the `http.request.body.size`
+      and `http.response.body.size` attributes to spans, and records `http.server.request.size` and
+      `http.server.response.size` metrics.
+    type: boolean
+    default: false
diff --git a/instrumentation/jetty/jetty-8.0/javaagent/build.gradle.kts b/instrumentation/jetty/jetty-8.0/javaagent/build.gradle.kts
@@ -38,3 +38,7 @@ if (latestDepTest) {
     minJavaVersionSupported.set(JavaVersion.VERSION_11)
   }
 }
+
+tasks.test {
+  systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
+}
diff --git a/instrumentation/jetty/jetty-8.0/metadata.yaml b/instrumentation/jetty/jetty-8.0/metadata.yaml
@@ -0,0 +1,29 @@
+description: This instrumentation enables HTTP server spans and HTTP server metrics for Jetty.
+semantic_conventions:
+  - HTTP_SERVER_SPANS
+  - HTTP_SERVER_METRICS
+features:
+  - CONTEXT_PROPAGATION
+library_link: https://eclipse.dev/jetty/
+configurations:
+  - name: otel.instrumentation.http.known-methods
+    description: >
+      Configures the instrumentation to recognize an alternative set of HTTP request methods. All
+      other methods will be treated as `_OTHER`.
+    type: list
+    default: "CONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACE"
+  - name: otel.instrumentation.http.server.capture-request-headers
+    description: List of HTTP request headers to capture in HTTP server telemetry.
+    type: list
+    default: ""
+  - name: otel.instrumentation.http.server.capture-response-headers
+    description: List of HTTP response headers to capture in HTTP server telemetry.
+    type: list
+    default: ""
+  - name: otel.instrumentation.http.server.emit-experimental-telemetry
+    description: >
+      Enable the capture of experimental HTTP server telemetry. Adds the `http.request.body.size`
+      and `http.response.body.size` attributes to spans, and records `http.server.request.size` and
+      `http.server.response.size` metrics.
+    type: boolean
+    default: false

Original file line number	Diff line number	Diff line change
`@@ -41,13 +41,15 @@ testing {`
`41`	`41`	`tasks {`
`42`	`42`	`withType<Test>().configureEach {`
`43`	`43`	`usesService(gradle.sharedServices.registrations["testcontainersBuildService"].service)`
	`44`	`+ systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")`
`44`	`45`	`}`
`45`	`46`
`46`	`47`	`val testStableSemconv by registering(Test::class) {`
`47`	`48`	`testClassesDirs = sourceSets.test.get().output.classesDirs`
`48`	`49`	`classpath = sourceSets.test.get().runtimeClasspath`
`49`	`50`
`50`	`51`	`jvmArgs("-Dotel.semconv-stability.opt-in=database")`
	`52`	`+ systemProperty("metadataConfig", "otel.semconv-stability.opt-in=database")`
`51`	`53`	`}`
`52`	`54`
`53`	`55`	`check {`
Original file line number	Diff line number	Diff line change
`@@ -31,13 +31,15 @@ dependencies {`
`31`	`31`	`tasks {`
`32`	`32`	`withType<Test>().configureEach {`
`33`	`33`	`usesService(gradle.sharedServices.registrations["testcontainersBuildService"].service)`
	`34`	`+ systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")`
`34`	`35`	`}`
`35`	`36`
`36`	`37`	`val testStableSemconv by registering(Test::class) {`
`37`	`38`	`testClassesDirs = sourceSets.test.get().output.classesDirs`
`38`	`39`	`classpath = sourceSets.test.get().runtimeClasspath`
`39`	`40`
`40`	`41`	`jvmArgs("-Dotel.semconv-stability.opt-in=database")`
	`42`	`+ systemProperty("metadataConfig", "otel.semconv-stability.opt-in=database")`
`41`	`43`	`}`
`42`	`44`
`43`	`45`	`check {`
Original file line number	Diff line number	Diff line change
`@@ -29,13 +29,15 @@ tasks {`
`29`	`29`	`// latest dep test fails because peer ip is 0:0:0:0:0:0:0:1 instead of 127.0.0.1`
`30`	`30`	`jvmArgs("-Djava.net.preferIPv4Stack=true")`
`31`	`31`	`usesService(gradle.sharedServices.registrations["testcontainersBuildService"].service)`
	`32`	`+ systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")`
`32`	`33`	`}`
`33`	`34`
`34`	`35`	`val testStableSemconv by registering(Test::class) {`
`35`	`36`	`testClassesDirs = sourceSets.test.get().output.classesDirs`
`36`	`37`	`classpath = sourceSets.test.get().runtimeClasspath`
`37`	`38`
`38`	`39`	`jvmArgs("-Dotel.semconv-stability.opt-in=database")`
	`40`	`+ systemProperty("metadataConfig", "otel.semconv-stability.opt-in=database")`
`39`	`41`	`}`
`40`	`42`
`41`	`43`	`check {`