Quarkus r2dbc and rediscala metadata (#15738)

jaydeluca · laurit · web-flow · commit daf2a048bff8 · 2026-01-05T12:49:15.000Z
Co-authored-by: Lauri Tulmin &lt;ltulmin@splunk.com&gt;
diff --git a/docs/instrumentation-list.yaml b/docs/instrumentation-list.yaml
@@ -10510,6 +10510,12 @@ libraries:
           type: LONG
   quarkus:
   - name: quarkus-resteasy-reactive
+    display_name: Quarkus RESTEasy Reactive
+    description: |
+      This instrumentation enriches HTTP server spans with route information for Quarkus RESTEasy Reactive, it does not emit any telemetry on its own.
+    library_link: https://quarkus.io/guides/resteasy-reactive/
+    features:
+    - HTTP_ROUTE
     source_path: instrumentation/quarkus-resteasy-reactive
     scope:
       name: io.opentelemetry.quarkus-resteasy-reactive
@@ -10528,6 +10534,13 @@ libraries:
       - org.quartz-scheduler:quartz:2.0.0
   r2dbc:
   - name: r2dbc-1.0
+    display_name: R2DBC
+    description: |
+      This instrumentation enables database client spans and database client metrics for R2DBC (Reactive Relational Database Connectivity).
+    semantic_conventions:
+    - DATABASE_CLIENT_SPANS
+    - DATABASE_CLIENT_METRICS
+    library_link: https://r2dbc.io/
     source_path: instrumentation/r2dbc-1.0
     scope:
       name: io.opentelemetry.r2dbc-1.0
@@ -10536,6 +10549,87 @@ libraries:
       - io.r2dbc:r2dbc-spi:[1.0.0.RELEASE,)
       library:
       - io.r2dbc:r2dbc-spi:1.0.0.RELEASE
+    configurations:
+    - name: otel.instrumentation.r2dbc.statement-sanitizer.enabled
+      description: |
+        Enables statement sanitization for database queries. Takes precedence over otel.instrumentation.common.db-statement-sanitizer.enabled.
+      type: boolean
+      default: true
+    - name: otel.instrumentation.common.db-statement-sanitizer.enabled
+      description: Enables statement sanitization for database queries.
+      type: boolean
+      default: true
+    - name: otel.instrumentation.r2dbc.experimental.sqlcommenter.enabled
+      description: |
+        Enables augmenting queries with a comment containing the tracing information. See [sqlcommenter](https://google.github.io/sqlcommenter/) for more info. WARNING: augmenting queries with tracing context will make query texts unique, which may have adverse impact on database performance.
+      type: boolean
+      default: false
+    - 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: ''
+    telemetry:
+    - when: default
+      spans:
+      - span_kind: CLIENT
+        attributes:
+        - name: db.connection_string
+          type: STRING
+        - name: db.name
+          type: STRING
+        - name: db.operation
+          type: STRING
+        - name: db.sql.table
+          type: STRING
+        - name: db.statement
+          type: STRING
+        - name: db.system
+          type: STRING
+        - name: db.user
+          type: STRING
+        - name: peer.service
+          type: STRING
+        - name: server.address
+          type: STRING
+        - name: server.port
+          type: LONG
+    - when: otel.semconv-stability.opt-in=database
+      metrics:
+      - name: db.client.operation.duration
+        description: Duration of database client operations.
+        type: HISTOGRAM
+        unit: s
+        attributes:
+        - name: db.namespace
+          type: STRING
+        - name: db.operation.name
+          type: STRING
+        - name: db.system.name
+          type: STRING
+        - name: server.address
+          type: STRING
+        - name: server.port
+          type: LONG
+      spans:
+      - span_kind: CLIENT
+        attributes:
+        - name: db.collection.name
+          type: STRING
+        - name: db.namespace
+          type: STRING
+        - name: db.operation.name
+          type: STRING
+        - name: db.query.text
+          type: STRING
+        - name: db.system.name
+          type: STRING
+        - name: peer.service
+          type: STRING
+        - name: server.address
+          type: STRING
+        - name: server.port
+          type: LONG
   rabbitmq:
   - name: rabbitmq-2.7
     display_name: RabbitMQ
@@ -10781,6 +10875,13 @@ libraries:
           type: STRING
   rediscala:
   - name: rediscala-1.8
+    display_name: Rediscala
+    description: |
+      This instrumentation enables database client spans and database client metrics for Rediscala.
+    semantic_conventions:
+    - DATABASE_CLIENT_SPANS
+    - DATABASE_CLIENT_METRICS
+    library_link: https://github.com/rediscala/rediscala
     source_path: instrumentation/rediscala-1.8
     scope:
       name: io.opentelemetry.rediscala-1.8
@@ -10793,6 +10894,33 @@ libraries:
       - io.github.rediscala:rediscala_2.13:[1.10.0,)
       - com.github.etaty:rediscala_2.13:[1.9.0,)
       - com.github.Ma27:rediscala_2.12:[1.8.1,)
+    telemetry:
+    - when: default
+      spans:
+      - span_kind: CLIENT
+        attributes:
+        - name: db.operation
+          type: STRING
+        - name: db.system
+          type: STRING
+    - when: otel.semconv-stability.opt-in=database
+      metrics:
+      - name: db.client.operation.duration
+        description: Duration of database client operations.
+        type: HISTOGRAM
+        unit: s
+        attributes:
+        - name: db.operation.name
+          type: STRING
+        - name: db.system.name
+          type: STRING
+      spans:
+      - span_kind: CLIENT
+        attributes:
+        - name: db.operation.name
+          type: STRING
+        - name: db.system.name
+          type: STRING
   redisson:
   - name: redisson-3.0
     source_path: instrumentation/redisson/redisson-3.0
diff --git a/instrumentation-docs/instrumentations.sh b/instrumentation-docs/instrumentations.sh
@@ -202,10 +202,14 @@ readonly INSTRUMENTATIONS=(
   "powerjob-4.0:javaagent:testExperimental"
   "pulsar:pulsar-2.8:javaagent:test"
   "pulsar:pulsar-2.8:javaagent:testExperimental"
+  "r2dbc-1.0:javaagent:test"
+  "r2dbc-1.0:javaagent:testStableSemconv"
   "rabbitmq-2.7:javaagent:test"
   "rabbitmq-2.7:javaagent:testExperimental"
   "reactor:reactor-netty:reactor-netty-0.9:javaagent:test"
   "reactor:reactor-netty:reactor-netty-1.0:javaagent:test"
+  "rediscala-1.8:javaagent:test"
+  "rediscala-1.8:javaagent:testStableSemconv"
   "spring:spring-batch-3.0:javaagent:test"
   "spring:spring-data:spring-data-1.8:javaagent:test"
   "spring:spring-integration-4.1:javaagent:test"
@@ -222,14 +226,11 @@ readonly INSTRUMENTATIONS=(
   "spring:spring-web:spring-web-3.1:library:test"
   "spring:spring-web:spring-web-6.0:javaagent:test"
   "spring:spring-webflux:spring-webflux-5.0:javaagent:test"
-  "spring:spring-webflux:spring-webflux-5.0:javaagent:test"
   "spring:spring-webflux:spring-webflux-5.3:library:test"
   "spring:spring-webmvc:spring-webmvc-3.1:javaagent:test"
   "spring:spring-webmvc:spring-webmvc-3.1:javaagent:testExperimental"
-  "spring:spring-webmvc:spring-webmvc-3.1:javaagent:testExperimental"
   "spring:spring-webmvc:spring-webmvc-5.3:library:test"
   "spring:spring-webmvc:spring-webmvc-6.0:javaagent:test"
-  "spring:spring-webmvc:spring-webmvc-6.0:javaagent:test"
   "spring:spring-webmvc:spring-webmvc-6.0:javaagent:testExperimental"
   "tomcat:tomcat-jdbc:javaagent:test"
   "tomcat:tomcat-jdbc:javaagent:testStableSemconv"
diff --git a/instrumentation/quarkus-resteasy-reactive/metadata.yaml b/instrumentation/quarkus-resteasy-reactive/metadata.yaml
@@ -0,0 +1,7 @@
+display_name: Quarkus RESTEasy Reactive
+description: >
+  This instrumentation enriches HTTP server spans with route information for Quarkus
+  RESTEasy Reactive, it does not emit any telemetry on its own.
+features:
+  - HTTP_ROUTE
+library_link: https://quarkus.io/guides/resteasy-reactive/
diff --git a/instrumentation/r2dbc-1.0/javaagent/build.gradle.kts b/instrumentation/r2dbc-1.0/javaagent/build.gradle.kts
@@ -33,12 +33,14 @@ 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/r2dbc-1.0/metadata.yaml b/instrumentation/r2dbc-1.0/metadata.yaml
@@ -0,0 +1,31 @@
+display_name: R2DBC
+description: >
+  This instrumentation enables database client spans and database client metrics for R2DBC
+  (Reactive Relational Database Connectivity).
+semantic_conventions:
+  - DATABASE_CLIENT_SPANS
+  - DATABASE_CLIENT_METRICS
+library_link: https://r2dbc.io/
+configurations:
+  - name: otel.instrumentation.r2dbc.statement-sanitizer.enabled
+    description: >
+      Enables statement sanitization for database queries. Takes precedence over
+      otel.instrumentation.common.db-statement-sanitizer.enabled.
+    type: boolean
+    default: true
+  - name: otel.instrumentation.common.db-statement-sanitizer.enabled
+    description: Enables statement sanitization for database queries.
+    type: boolean
+    default: true
+  - name: otel.instrumentation.r2dbc.experimental.sqlcommenter.enabled
+    description: >
+      Enables augmenting queries with a comment containing the tracing information. See
+      [sqlcommenter](https://google.github.io/sqlcommenter/) for more info. WARNING: augmenting
+      queries with tracing context will make query texts unique, which may have adverse impact on
+      database performance.
+    type: boolean
+    default: false
+  - 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/r2dbc-1.0/testing/src/main/java/io/opentelemetry/instrumentation/r2dbc/v1_0/AbstractR2dbcStatementTest.java b/instrumentation/r2dbc-1.0/testing/src/main/java/io/opentelemetry/instrumentation/r2dbc/v1_0/AbstractR2dbcStatementTest.java
@@ -6,8 +6,11 @@
 package io.opentelemetry.instrumentation.r2dbc.v1_0;
 
 import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableDatabaseSemconv;
+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.DbAttributes.DB_NAMESPACE;
+import static io.opentelemetry.semconv.DbAttributes.DB_OPERATION_NAME;
 import static io.opentelemetry.semconv.ServerAttributes.SERVER_ADDRESS;
 import static io.opentelemetry.semconv.ServerAttributes.SERVER_PORT;
 import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_CONNECTION_STRING;
@@ -16,6 +19,7 @@
 import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_SQL_TABLE;
 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.DbIncubatingAttributes.DB_USER;
 import static io.opentelemetry.semconv.incubating.PeerIncubatingAttributes.PEER_SERVICE;
 import static io.r2dbc.spi.ConnectionFactoryOptions.CONNECT_TIMEOUT;
@@ -38,6 +42,7 @@
 import java.util.Map;
 import java.util.stream.Stream;
 import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.TestInstance;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.Arguments;
@@ -238,6 +243,41 @@ private static Stream<Arguments> provideParameters() {
                                 "SELECT")))));
   }
 
+  @Test
+  @SuppressWarnings("deprecation") // uses deprecated semconv
+  void testMetrics() {
+    DbSystemProps props = SYSTEMS.get(MARIADB.system);
+    startContainer(props);
+    ConnectionFactory connectionFactory =
+        createProxyConnectionFactory(
+            ConnectionFactoryOptions.builder()
+                .option(DRIVER, props.system)
+                .option(HOST, container.getHost())
+                .option(PORT, port)
+                .option(USER, USER_DB)
+                .option(PASSWORD, PW_DB)
+                .option(DATABASE, DB)
+                .option(CONNECT_TIMEOUT, Duration.ofSeconds(30))
+                .build());
+
+    Mono.from(connectionFactory.create())
+        .flatMapMany(
+            connection ->
+                Mono.from(connection.createStatement("SELECT 3").execute())
+                    .flatMapMany(result -> result.map((row, metadata) -> ""))
+                    .concatWith(Mono.from(connection.close()).cast(String.class)))
+        .blockLast(Duration.ofMinutes(1));
+
+    assertDurationMetric(
+        getTesting(),
+        "io.opentelemetry.r2dbc-1.0",
+        DB_SYSTEM_NAME,
+        DB_NAMESPACE,
+        DB_OPERATION_NAME,
+        SERVER_ADDRESS,
+        SERVER_PORT);
+  }
+
   private static class Parameter {
 
     final String system;
diff --git a/instrumentation/rediscala-1.8/javaagent/build.gradle.kts b/instrumentation/rediscala-1.8/javaagent/build.gradle.kts
@@ -61,8 +61,23 @@ dependencies {
 }
 
 tasks {
-  test {
+  withType<Test>().configureEach {
+    systemProperty("testLatestDeps", findProperty("testLatestDeps") as Boolean)
     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 {
+    dependsOn(testStableSemconv)
   }
 
   if (findProperty("denyUnsafe") as Boolean) {
diff --git a/instrumentation/rediscala-1.8/javaagent/src/test/scala/io/opentelemetry/javaagent/instrumentation/rediscala/RediscalaClientTest.scala b/instrumentation/rediscala-1.8/javaagent/src/test/scala/io/opentelemetry/javaagent/instrumentation/rediscala/RediscalaClientTest.scala
@@ -8,12 +8,14 @@ package rediscala
 import io.opentelemetry.api.trace.SpanKind.CLIENT
 import io.opentelemetry.instrumentation.testing.junit.db.SemconvStabilityUtil
 import io.opentelemetry.instrumentation.testing.junit.AgentInstrumentationExtension
+import io.opentelemetry.instrumentation.testing.junit.db.DbClientMetricsTestUtil.assertDurationMetric
 import io.opentelemetry.instrumentation.testing.util.ThrowingSupplier
 import io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo
 import io.opentelemetry.sdk.testing.assertj.{SpanDataAssert, TraceAssert}
 import io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_OPERATION
 import io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_SYSTEM
 import io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DbSystemIncubatingValues.REDIS
+import io.opentelemetry.semconv.DbAttributes.{DB_OPERATION_NAME, DB_SYSTEM_NAME}
 import org.assertj.core.api.Assertions.assertThat
 import org.junit.jupiter.api.{AfterAll, BeforeAll, Test, TestInstance}
 import org.junit.jupiter.api.extension.RegisterExtension
@@ -127,6 +129,13 @@ class RediscalaClientTest {
           }
         )
     })
+
+    assertDurationMetric(
+      testing,
+      "io.opentelemetry.rediscala-1.8",
+      DB_SYSTEM_NAME,
+      DB_OPERATION_NAME
+    )
   }
 
   @Test def testGetCommand(): Unit = {
diff --git a/instrumentation/rediscala-1.8/metadata.yaml b/instrumentation/rediscala-1.8/metadata.yaml
@@ -0,0 +1,7 @@
+display_name: Rediscala
+description: >
+  This instrumentation enables database client spans and database client metrics for Rediscala.
+semantic_conventions:
+  - DATABASE_CLIENT_SPANS
+  - DATABASE_CLIENT_METRICS
+library_link: https://github.com/rediscala/rediscala

Original file line number	Diff line number	Diff line change
`@@ -33,12 +33,14 @@ dependencies {`
`33`	`33`	`tasks {`
`34`	`34`	`withType<Test>().configureEach {`
`35`	`35`	`usesService(gradle.sharedServices.registrations["testcontainersBuildService"].service)`
	`36`	`+ systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")`
`36`	`37`	`}`
`37`	`38`
`38`	`39`	`val testStableSemconv by registering(Test::class) {`
`39`	`40`	`testClassesDirs = sourceSets.test.get().output.classesDirs`
`40`	`41`	`classpath = sourceSets.test.get().runtimeClasspath`
`41`	`42`	`jvmArgs("-Dotel.semconv-stability.opt-in=database")`
	`43`	`+ systemProperty("metadataConfig", "otel.semconv-stability.opt-in=database")`
`42`	`44`	`}`
`43`	`45`
`44`	`46`	`check {`