Opensearch Metadata

docs/instrumentation-list.yaml

@@ -5820,22 +5820,141 @@ libraries:
         - name: gen_ai.usage.output_tokens
           type: LONG
   opensearch:
+  - name: opensearch-java-3.0
+    description: |
+      This instrumentation enables database client spans and database client metrics for the OpenSearch Java client.
+    semantic_conventions:
+    - DATABASE_CLIENT_SPANS
+    - DATABASE_CLIENT_METRICS
+    library_link: https://docs.opensearch.org/latest/clients/java/
+    source_path: instrumentation/opensearch/opensearch-java-3.0
+    minimum_java_version: 11
+    scope:
+      name: io.opentelemetry.opensearch-java-3.0
+    target_versions:
+      javaagent:
+      - org.opensearch.client:opensearch-java:[3.0,)
+    telemetry:
+    - when: default
+      spans:
+      - span_kind: CLIENT
+        attributes:
+        - name: db.operation
+          type: STRING
+        - name: db.statement
+          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.query.text
+          type: STRING
+        - name: db.system.name
+          type: STRING
   - name: opensearch-rest-1.0
+    description: |
+      This instrumentation enables database client spans and database client metrics for OpenSearch REST clients.
+    semantic_conventions:
+    - DATABASE_CLIENT_SPANS
+    - DATABASE_CLIENT_METRICS
+    library_link: https://docs.opensearch.org/latest/clients/
     source_path: instrumentation/opensearch/opensearch-rest-1.0
     minimum_java_version: 11
     scope:
       name: io.opentelemetry.opensearch-rest-1.0
     target_versions:
       javaagent:
       - org.opensearch.client:opensearch-rest-client:[1.0,3.0)
+    telemetry:
+    - when: default
+      spans:
+      - span_kind: CLIENT
+        attributes:
+        - name: db.operation
+          type: STRING
+        - name: db.statement
+          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.query.text
+          type: STRING
+        - name: db.system.name
+          type: STRING
   - name: opensearch-rest-3.0
+    description: |
+      This instrumentation enables database client spans and database client metrics for OpenSearch REST clients.
+    semantic_conventions:
+    - DATABASE_CLIENT_SPANS
+    - DATABASE_CLIENT_METRICS
+    library_link: https://docs.opensearch.org/latest/clients/
     source_path: instrumentation/opensearch/opensearch-rest-3.0
     minimum_java_version: 11
     scope:
       name: io.opentelemetry.opensearch-rest-3.0
     target_versions:
       javaagent:
       - org.opensearch.client:opensearch-rest-client:[3.0,)
+    telemetry:
+    - when: default
+      spans:
+      - span_kind: CLIENT
+        attributes:
+        - name: db.operation
+          type: STRING
+        - name: db.statement
+          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.query.text
+          type: STRING
+        - name: db.system.name
+          type: STRING
   oracle:
   - name: oracle-ucp-11.2
     description: The Oracle Universal Connection Pool (UCP) instrumentation generates

instrumentation-docs/instrumentations.sh

@@ -129,6 +129,12 @@ readonly INSTRUMENTATIONS=(
   "okhttp:okhttp-2.2:javaagent:test"
   "okhttp:okhttp-3.0:javaagent:test"
   "openai:openai-java-1.1:javaagent:test"
+  "opensearch:opensearch-java-3.0:javaagent:test"
+  "opensearch:opensearch-java-3.0:javaagent:testStableSemconv"
+  "opensearch:opensearch-rest-1.0:javaagent:test"
+  "opensearch:opensearch-rest-1.0:javaagent:testStableSemconv"
+  "opensearch:opensearch-rest-3.0:javaagent:test"
+  "opensearch:opensearch-rest-3.0:javaagent:testStableSemconv"
   "oshi:javaagent:test"
   "oshi:javaagent:testExperimental"
   "pekko:pekko-http-1.0:javaagent:test"

instrumentation/opensearch/opensearch-java-3.0/javaagent/build.gradle.kts

@@ -34,14 +34,16 @@ dependencies {
 }
 
 tasks {
-  test {
+  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 {

instrumentation/opensearch/opensearch-java-3.0/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/opensearch/v3_0/AbstractOpenSearchTest.java

@@ -5,8 +5,11 @@
 
 package io.opentelemetry.javaagent.instrumentation.opensearch.v3_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.DbAttributes.DB_OPERATION_NAME;
+import static io.opentelemetry.semconv.DbAttributes.DB_SYSTEM_NAME;
 import static io.opentelemetry.semconv.HttpAttributes.HTTP_REQUEST_METHOD;
 import static io.opentelemetry.semconv.HttpAttributes.HTTP_RESPONSE_STATUS_CODE;
 import static io.opentelemetry.semconv.NetworkAttributes.NETWORK_PROTOCOL_VERSION;
@@ -151,4 +154,15 @@ void shouldGetStatusAsyncWithTraces() throws Exception {
                             .hasKind(SpanKind.INTERNAL)
                             .hasParent(trace.getSpan(1))));
   }
+
+  @Test
+  void shouldRecordMetrics() throws IOException {
+    HealthResponse healthResponse = openSearchClient.cluster().health();
+    assertThat(healthResponse).isNotNull();
+
+    getTesting().waitForTraces(1);
+
+    assertDurationMetric(
+        getTesting(), "io.opentelemetry.opensearch-java-3.0", DB_OPERATION_NAME, DB_SYSTEM_NAME);
+  }
 }

instrumentation/opensearch/opensearch-java-3.0/metadata.yaml

@@ -0,0 +1,7 @@
+description: >
+  This instrumentation enables database client spans and database client metrics for the OpenSearch
+  Java client.
+library_link: https://docs.opensearch.org/latest/clients/java/
+semantic_conventions:
+  - DATABASE_CLIENT_SPANS
+  - DATABASE_CLIENT_METRICS

instrumentation/opensearch/opensearch-rest-1.0/javaagent/build.gradle.kts

@@ -40,14 +40,16 @@ dependencies {
 }
 
 tasks {
-  test {
+  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 {

instrumentation/opensearch/opensearch-rest-1.0/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/opensearch/rest/v1_0/OpenSearchRestTest.java

@@ -57,4 +57,9 @@ protected RestClient buildRestClient() throws Exception {
   protected int getResponseStatus(Response response) {
     return response.getStatusLine().getStatusCode();
   }
+
+  @Override
+  protected String getInstrumentationName() {
+    return "io.opentelemetry.opensearch-rest-1.0";
+  }
 }

instrumentation/opensearch/opensearch-rest-1.0/metadata.yaml

@@ -0,0 +1,7 @@
+description: >
+  This instrumentation enables database client spans and database client metrics for OpenSearch
+  REST clients.
+library_link: https://docs.opensearch.org/latest/clients/
+semantic_conventions:
+  - DATABASE_CLIENT_SPANS
+  - DATABASE_CLIENT_METRICS

instrumentation/opensearch/opensearch-rest-3.0/javaagent/build.gradle.kts

@@ -33,14 +33,16 @@ dependencies {
 }
 
 tasks {
-  test {
+  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 {

instrumentation/opensearch/opensearch-rest-3.0/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/opensearch/rest/v3_0/OpenSearchRest3Test.java

@@ -68,4 +68,9 @@ protected RestClient buildRestClient() throws Exception {
   protected int getResponseStatus(Response response) {
     return response.getStatusLine().getStatusCode();
   }
+
+  @Override
+  protected String getInstrumentationName() {
+    return "io.opentelemetry.opensearch-rest-3.0";
+  }
 }

instrumentation/opensearch/opensearch-rest-3.0/metadata.yaml

@@ -0,0 +1,7 @@
+description: >
+  This instrumentation enables database client spans and database client metrics for OpenSearch
+  REST clients.
+library_link: https://docs.opensearch.org/latest/clients/
+semantic_conventions:
+  - DATABASE_CLIENT_SPANS
+  - DATABASE_CLIENT_METRICS

instrumentation/opensearch/opensearch-rest-common/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/opensearch/rest/AbstractOpenSearchRestTest.java

@@ -5,8 +5,11 @@
 
 package io.opentelemetry.javaagent.instrumentation.opensearch.rest;
 
+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_OPERATION_NAME;
+import static io.opentelemetry.semconv.DbAttributes.DB_SYSTEM_NAME;
 import static io.opentelemetry.semconv.HttpAttributes.HTTP_REQUEST_METHOD;
 import static io.opentelemetry.semconv.HttpAttributes.HTTP_RESPONSE_STATUS_CODE;
 import static io.opentelemetry.semconv.NetworkAttributes.NETWORK_PROTOCOL_VERSION;
@@ -49,6 +52,8 @@ public abstract class AbstractOpenSearchRestTest {
 
   protected abstract int getResponseStatus(Response response);
 
+  protected abstract String getInstrumentationName();
+
   @BeforeAll
   void setUp() throws Exception {
     opensearch =
@@ -169,4 +174,14 @@ public void onFailure(Exception e) {
                             .hasKind(SpanKind.INTERNAL)
                             .hasParent(trace.getSpan(0))));
   }
+
+  @Test
+  void shouldRecordMetrics() throws IOException {
+    Response response = client.performRequest(new Request("GET", "_cluster/health"));
+    assertThat(getResponseStatus(response)).isEqualTo(200);
+
+    getTesting().waitForTraces(1);
+
+    assertDurationMetric(getTesting(), getInstrumentationName(), DB_OPERATION_NAME, DB_SYSTEM_NAME);
+  }
 }