using stable conventions

Author: l-trotta

java-client/build.gradle.kts

@@ -179,7 +179,7 @@ dependencies {
     // the Java API client coexists with a 8.x HLRC work fine
     val elasticsearchVersion = "9.0.0"
     val jacksonVersion = "2.18.3"
-    val openTelemetryVersion = "1.29.0"
+    val openTelemetryVersion = "1.32.0"
 
     // Apache 2.0
     // https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/java-rest-low.html
@@ -211,8 +211,7 @@ dependencies {
     // Apache 2.0
     // https://github.com/open-telemetry/opentelemetry-java
     implementation("io.opentelemetry", "opentelemetry-api", openTelemetryVersion)
-    // Use it once it's stable (see Instrumentation.java). Limited to tests for now.
-    testImplementation("io.opentelemetry", "opentelemetry-semconv", "$openTelemetryVersion-alpha")
+    implementation("io.opentelemetry.semconv","opentelemetry-semconv", openTelemetryVersion)
     testImplementation("io.opentelemetry", "opentelemetry-sdk", openTelemetryVersion)
 
     // EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0

java-client/src/main/java/co/elastic/clients/transport/instrumentation/OpenTelemetryForElasticsearch.java

@@ -31,6 +31,9 @@
 import io.opentelemetry.api.trace.StatusCode;
 import io.opentelemetry.api.trace.Tracer;
 import io.opentelemetry.context.Scope;
+import io.opentelemetry.semconv.HttpAttributes;
+import io.opentelemetry.semconv.ServerAttributes;
+import io.opentelemetry.semconv.UrlAttributes;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
@@ -69,18 +72,14 @@ public class OpenTelemetryForElasticsearch implements Instrumentation {
         "search"
     ));
 
-    private static final AttributeKey<String> ATTR_DB_SYSTEM = AttributeKey.stringKey("db.system");
-    private static final AttributeKey<String> ATTR_DB_OPERATION = AttributeKey.stringKey("db.operation");
-    private static final AttributeKey<String> ATTR_DB_STATEMENT = AttributeKey.stringKey("db.statement");
-    // Use Semantic Convention keys once opentelemetry-semconv is stable
-    //private static final AttributeKey<String> ATTR_DB_SYSTEM = SemanticAttributes.DB_SYSTEM;
-    //private static final AttributeKey<String> ATTR_DB_OPERATION = SemanticAttributes.DB_OPERATION;
-    //private static final AttributeKey<String> ATTR_DB_STATEMENT = SemanticAttributes.DB_STATEMENT;
+    private static final AttributeKey<String> ATTR_DB_SYSTEM = AttributeKey.stringKey("db.system.name");
+    private static final AttributeKey<String> ATTR_DB_OPERATION = AttributeKey.stringKey("db.operation.name");
+    private static final AttributeKey<String> ATTR_DB_QUERY = AttributeKey.stringKey("db.query.text");
 
-    private static final AttributeKey<String> ATTR_HTTP_REQUEST_METHOD = AttributeKey.stringKey("http.request.method");
-    private static final AttributeKey<String> ATTR_URL_FULL = AttributeKey.stringKey("url.full");
-    private static final AttributeKey<String> ATTR_SERVER_ADDRESS = AttributeKey.stringKey("server.address");
-    private static final AttributeKey<Long> ATTR_SERVER_PORT = AttributeKey.longKey("server.port");
+    private static final AttributeKey<String> ATTR_HTTP_REQUEST_METHOD = HttpAttributes.HTTP_REQUEST_METHOD;
+    private static final AttributeKey<String> ATTR_URL_FULL = UrlAttributes.URL_FULL;
+    private static final AttributeKey<String> ATTR_SERVER_ADDRESS = ServerAttributes.SERVER_ADDRESS;
+    private static final AttributeKey<Long> ATTR_SERVER_PORT = ServerAttributes.SERVER_PORT;
 
     // Caching attributes keys to avoid unnecessary memory allocation
     private static final Map<String, AttributeKey<String>> attributesKeyCache = new ConcurrentHashMap<>();
@@ -222,7 +221,7 @@ public void beforeSendingHttpRequest(TransportHttpClient.Request httpRequest, Tr
                         sb.append(StandardCharsets.UTF_8.decode(buf));
                         buf.reset();
                     }
-                    span.setAttribute(ATTR_DB_STATEMENT, sb.toString());
+                    span.setAttribute(ATTR_DB_QUERY, sb.toString());
                 }
             } catch (Exception e) {
                 logger.debug("Failed reading HTTP body content for an OpenTelemetry span.", e);

java-client/src/test/java/co/elastic/clients/transport/instrumentation/OpenTelemetryForElasticsearchTest.java

@@ -38,8 +38,6 @@
 import io.opentelemetry.sdk.trace.data.SpanData;
 import io.opentelemetry.sdk.trace.export.SimpleSpanProcessor;
 import io.opentelemetry.sdk.trace.export.SpanExporter;
-import io.opentelemetry.semconv.resource.attributes.ResourceAttributes;
-import io.opentelemetry.semconv.trace.attributes.SemanticAttributes;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.BeforeAll;
@@ -57,6 +55,8 @@
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.TimeoutException;
 
+import static io.opentelemetry.semconv.ServiceAttributes.SERVICE_NAME;
+
 public class OpenTelemetryForElasticsearchTest {
     private static final String INDEX = "test-index";
     private static final String DOC_ID = "1234567";
@@ -100,7 +100,9 @@ public class OpenTelemetryForElasticsearchTest {
             "    ]\n" +
             "  }\n" +
             "}";
-    public static final String DB_OPERATION = "db.operation";
+    public static final String DB_SYSTEM = "db.system.name";
+    public static final String DB_OPERATION = "db.operation.name";
+    public static final String DB_QUERY = "db.query.text";
     public static final String URL_FULL = "url.full";
     public static final String SERVER_ADDRESS = "server.address";
     public static final String SERVER_PORT = "server.port";
@@ -162,7 +164,7 @@ private static void setupHttpServer() throws IOException {
 
     private static void setupOTel() {
         Resource resource = Resource.getDefault()
-                .merge(Resource.create(Attributes.of(ResourceAttributes.SERVICE_NAME, "es-api-test")));
+                .merge(Resource.create(Attributes.of(SERVICE_NAME, "es-api-test")));
 
         spanExporter = new MockSpanExporter();
 
@@ -189,7 +191,7 @@ public void testGetRequest() throws IOException, InterruptedException {
         Assertions.assertEquals("get", span.getName());
         Assertions.assertEquals("get", span.getAttributes().get(AttributeKey.stringKey(DB_OPERATION)));
         Assertions.assertEquals("GET", span.getAttributes().get(AttributeKey.stringKey(HTTP_REQUEST_METHOD)));
-        Assertions.assertEquals("elasticsearch", span.getAttributes().get(SemanticAttributes.DB_SYSTEM));
+        Assertions.assertEquals("elasticsearch", span.getAttributes().get(AttributeKey.stringKey(DB_SYSTEM)));
 
         String url = "http://" + httpServer.getAddress().getHostString() + ":" + httpServer.getAddress().getPort() +
             "/" + INDEX + "/_doc/" + DOC_ID + "?refresh=true";
@@ -214,7 +216,7 @@ public void testSearchRequest() throws IOException, InterruptedException {
         Assertions.assertEquals(spanExporter.getSpans().size(), 1);
         SpanData span = spanExporter.getSpans().get(0);
         Assertions.assertEquals("search", span.getName());
-        Assertions.assertEquals(queryAsString, span.getAttributes().get(SemanticAttributes.DB_STATEMENT));
+        Assertions.assertEquals(queryAsString, span.getAttributes().get(AttributeKey.stringKey(DB_QUERY)));
     }
 
     @Test
@@ -228,7 +230,7 @@ public void testAsyncSearchRequest() throws IOException, InterruptedException, T
         Assertions.assertEquals("search", span.getName());
 
         // We're not capturing bodies by default
-        Assertions.assertNull(span.getAttributes().get(SemanticAttributes.DB_STATEMENT));
+        Assertions.assertNull(span.getAttributes().get(AttributeKey.stringKey(DB_QUERY)));
     }
 
     private static class MockSpanExporter implements SpanExporter {