Rename "db.client.connections.usage" to "db.client.connection.count" (#…

…12886)
open-telemetry · Dec 14, 2024 · 5daa37e · 5daa37e
1 parent 4a17266
commit 5daa37e
Show file tree

Hide file tree

Showing 9 changed files with 34 additions and 9 deletions.
diff --git a/...va/io/opentelemetry/instrumentation/api/incubator/semconv/db/DbConnectionPoolMetrics.java b/...va/io/opentelemetry/instrumentation/api/incubator/semconv/db/DbConnectionPoolMetrics.java
@@ -6,6 +6,7 @@
 package io.opentelemetry.instrumentation.api.incubator.semconv.db;
 
 import static io.opentelemetry.api.common.AttributeKey.stringKey;
+import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableDatabaseSemconv;
 
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.api.common.AttributeKey;
@@ -56,8 +57,10 @@ public static DbConnectionPoolMetrics create(
   }
 
   public ObservableLongMeasurement connections() {
+    String metricName =
+        emitStableDatabaseSemconv() ? "db.client.connection.count" : "db.client.connections.usage";
     return meter
-        .upDownCounterBuilder("db.client.connections.usage")
+        .upDownCounterBuilder(metricName)
         .setUnit("{connections}")
         .setDescription(
             "The number of connections that are currently in state described by the state attribute.")

diff --git a/.../java/io/opentelemetry/instrumentation/alibabadruid/AbstractDruidInstrumentationTest.java b/.../java/io/opentelemetry/instrumentation/alibabadruid/AbstractDruidInstrumentationTest.java
@@ -5,6 +5,7 @@
 
 package io.opentelemetry.instrumentation.alibabadruid;
 
+import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableDatabaseSemconv;
 import static org.assertj.core.api.Assertions.assertThat;
 
 import com.alibaba.druid.pool.DruidDataSource;
@@ -73,7 +74,9 @@ void shouldReportMetrics() throws Exception {
     Set<String> metricNames =
         new HashSet<>(
             Arrays.asList(
-                "db.client.connections.usage",
+                emitStableDatabaseSemconv()
+                    ? "db.client.connection.count"
+                    : "db.client.connections.usage",
                 "db.client.connections.idle.min",
                 "db.client.connections.idle.max",
                 "db.client.connections.max",

diff --git a/...va/io/opentelemetry/instrumentation/apachedbcp/AbstractApacheDbcpInstrumentationTest.java b/...va/io/opentelemetry/instrumentation/apachedbcp/AbstractApacheDbcpInstrumentationTest.java
@@ -5,6 +5,7 @@
 
 package io.opentelemetry.instrumentation.apachedbcp;
 
+import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableDatabaseSemconv;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.anyInt;
@@ -75,7 +76,9 @@ void shouldReportMetrics() throws Exception {
     Set<String> metricNames =
         new HashSet<>(
             Arrays.asList(
-                "db.client.connections.usage",
+                emitStableDatabaseSemconv()
+                    ? "db.client.connection.count"
+                    : "db.client.connections.usage",
                 "db.client.connections.idle.min",
                 "db.client.connections.idle.max",
                 "db.client.connections.max"));

diff --git a/.../src/main/java/io/opentelemetry/instrumentation/c3p0/AbstractC3p0InstrumentationTest.java b/.../src/main/java/io/opentelemetry/instrumentation/c3p0/AbstractC3p0InstrumentationTest.java
@@ -5,6 +5,7 @@
 
 package io.opentelemetry.instrumentation.c3p0;
 
+import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableDatabaseSemconv;
 import static org.assertj.core.api.Assertions.assertThat;
 
 import com.mchange.v2.c3p0.ComboPooledDataSource;
@@ -66,7 +67,11 @@ void shouldReportMetrics() throws Exception {
     // then
     Set<String> metricNames =
         new HashSet<>(
-            Arrays.asList("db.client.connections.usage", "db.client.connections.pending_requests"));
+            Arrays.asList(
+                emitStableDatabaseSemconv()
+                    ? "db.client.connection.count"
+                    : "db.client.connections.usage",
+                "db.client.connections.pending_requests"));
     assertThat(testing().metrics())
         .filteredOn(
             metricData ->

diff --git a/...ain/java/io/opentelemetry/instrumentation/hikaricp/AbstractHikariInstrumentationTest.java b/...ain/java/io/opentelemetry/instrumentation/hikaricp/AbstractHikariInstrumentationTest.java
@@ -5,6 +5,7 @@
 
 package io.opentelemetry.instrumentation.hikaricp;
 
+import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableDatabaseSemconv;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.catchException;
 import static org.mockito.ArgumentMatchers.anyLong;
@@ -81,7 +82,9 @@ void shouldReportMetrics() throws SQLException, InterruptedException {
     testing()
         .waitAndAssertMetrics(
             "io.opentelemetry.hikaricp-3.0",
-            "db.client.connections.usage",
+            emitStableDatabaseSemconv()
+                ? "db.client.connection.count"
+                : "db.client.connections.usage",
             AbstractIterableAssert::isEmpty);
     testing()
         .waitAndAssertMetrics(

diff --git a/...java/io/opentelemetry/instrumentation/oracleucp/AbstractOracleUcpInstrumentationTest.java b/...java/io/opentelemetry/instrumentation/oracleucp/AbstractOracleUcpInstrumentationTest.java
@@ -5,6 +5,7 @@
 
 package io.opentelemetry.instrumentation.oracleucp;
 
+import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableDatabaseSemconv;
 import static org.assertj.core.api.Assertions.assertThat;
 
 import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
@@ -117,7 +118,9 @@ void shouldReportMetrics(boolean setExplicitPoolName) throws Exception {
     Set<String> metricNames =
         new HashSet<>(
             Arrays.asList(
-                "db.client.connections.usage",
+                emitStableDatabaseSemconv()
+                    ? "db.client.connection.count"
+                    : "db.client.connections.usage",
                 "db.client.connections.max",
                 "db.client.connections.pending_requests"));
     assertThat(testing().metrics())

diff --git a/...io/opentelemetry/javaagent/instrumentation/tomcat/jdbc/TomcatJdbcInstrumentationTest.java b/...io/opentelemetry/javaagent/instrumentation/tomcat/jdbc/TomcatJdbcInstrumentationTest.java
@@ -5,6 +5,7 @@
 
 package io.opentelemetry.javaagent.instrumentation.tomcat.jdbc;
 
+import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableDatabaseSemconv;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.Mockito.when;
 
@@ -77,7 +78,7 @@ private static void assertConnectionPoolMetrics(String poolName) {
   private static void assertNoConnectionPoolMetrics() {
     testing.waitAndAssertMetrics(
         "io.opentelemetry.tomcat-jdbc",
-        "db.client.connections.usage",
+        emitStableDatabaseSemconv() ? "db.client.connection.count" : "db.client.connections.usage",
         AbstractIterableAssert::isEmpty);
     testing.waitAndAssertMetrics(
         "io.opentelemetry.tomcat-jdbc",

diff --git a/...ain/java/io/opentelemetry/instrumentation/viburdbcp/AbstractViburInstrumentationTest.java b/...ain/java/io/opentelemetry/instrumentation/viburdbcp/AbstractViburInstrumentationTest.java
@@ -5,6 +5,7 @@
 
 package io.opentelemetry.instrumentation.viburdbcp;
 
+import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableDatabaseSemconv;
 import static org.mockito.Mockito.when;
 
 import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
@@ -72,9 +73,11 @@ void shouldReportMetrics() throws SQLException, InterruptedException {
     Thread.sleep(100);
 
     // then
+    String countMetricName =
+        emitStableDatabaseSemconv() ? "db.client.connection.count" : "db.client.connections.usage";
     testing()
         .waitAndAssertMetrics(
-            INSTRUMENTATION_NAME, "db.client.connections.usage", AbstractIterableAssert::isEmpty);
+            INSTRUMENTATION_NAME, countMetricName, AbstractIterableAssert::isEmpty);
     testing()
         .waitAndAssertMetrics(
             INSTRUMENTATION_NAME, "db.client.connections.max", AbstractIterableAssert::isEmpty);

diff --git a/.../io/opentelemetry/instrumentation/testing/junit/db/DbConnectionPoolMetricsAssertions.java b/.../io/opentelemetry/instrumentation/testing/junit/db/DbConnectionPoolMetricsAssertions.java
@@ -6,6 +6,7 @@
 package io.opentelemetry.instrumentation.testing.junit.db;
 
 import static io.opentelemetry.api.common.AttributeKey.stringKey;
+import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableDatabaseSemconv;
 import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.assertThat;
 import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo;
 
@@ -126,7 +127,7 @@ public void assertConnectionPoolEmitsMetrics() {
   private void verifyConnectionUsage() {
     testing.waitAndAssertMetrics(
         instrumentationName,
-        "db.client.connections.usage",
+        emitStableDatabaseSemconv() ? "db.client.connection.count" : "db.client.connections.usage",
         metrics -> metrics.anySatisfy(this::verifyUsageMetric));
   }