Remove incubating semconv dependency from library instrumentation (#1…

…1324)
open-telemetry · May 15, 2024 · 3a9972b · 3a9972b
1 parent c78277e
commit 3a9972b
Show file tree

Hide file tree

Showing 71 changed files with 595 additions and 297 deletions.
diff --git a/conventions/src/main/kotlin/otel.javaagent-instrumentation.gradle.kts b/conventions/src/main/kotlin/otel.javaagent-instrumentation.gradle.kts
@@ -22,3 +22,7 @@ configurations {
     extendsFrom(bootstrap)
   }
 }
+
+dependencies {
+  api("io.opentelemetry.semconv:opentelemetry-semconv-incubating")
+}
diff --git a/instrumentation-api-incubator/build.gradle.kts b/instrumentation-api-incubator/build.gradle.kts
@@ -12,7 +12,6 @@ group = "io.opentelemetry.instrumentation"
 
 dependencies {
   api("io.opentelemetry.semconv:opentelemetry-semconv")
-  api("io.opentelemetry.semconv:opentelemetry-semconv-incubating")
   api(project(":instrumentation-api"))
   implementation("io.opentelemetry:opentelemetry-api-incubator")
 

diff --git a/.../io/opentelemetry/instrumentation/api/incubator/semconv/code/CodeAttributesExtractor.java b/.../io/opentelemetry/instrumentation/api/incubator/semconv/code/CodeAttributesExtractor.java
@@ -7,10 +7,10 @@
 
 import static io.opentelemetry.instrumentation.api.internal.AttributesExtractorUtil.internalSet;
 
+import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
-import io.opentelemetry.semconv.incubating.CodeIncubatingAttributes;
 import javax.annotation.Nullable;
 
 /**
@@ -21,6 +21,11 @@
 public final class CodeAttributesExtractor<REQUEST, RESPONSE>
     implements AttributesExtractor<REQUEST, RESPONSE> {
 
+  // copied from CodeIncubatingAttributes
+  private static final AttributeKey<String> CODE_FUNCTION = AttributeKey.stringKey("code.function");
+  private static final AttributeKey<String> CODE_NAMESPACE =
+      AttributeKey.stringKey("code.namespace");
+
   /** Creates the code attributes extractor. */
   public static <REQUEST, RESPONSE> AttributesExtractor<REQUEST, RESPONSE> create(
       CodeAttributesGetter<REQUEST> getter) {
@@ -37,9 +42,9 @@ private CodeAttributesExtractor(CodeAttributesGetter<REQUEST> getter) {
   public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {
     Class<?> cls = getter.getCodeClass(request);
     if (cls != null) {
-      internalSet(attributes, CodeIncubatingAttributes.CODE_NAMESPACE, cls.getName());
+      internalSet(attributes, CODE_NAMESPACE, cls.getName());
     }
-    internalSet(attributes, CodeIncubatingAttributes.CODE_FUNCTION, getter.getMethodName(request));
+    internalSet(attributes, CODE_FUNCTION, getter.getMethodName(request));
   }
 
   @Override

diff --git a/...o/opentelemetry/instrumentation/api/incubator/semconv/db/DbClientAttributesExtractor.java b/...o/opentelemetry/instrumentation/api/incubator/semconv/db/DbClientAttributesExtractor.java
@@ -7,10 +7,10 @@
 
 import static io.opentelemetry.instrumentation.api.internal.AttributesExtractorUtil.internalSet;
 
+import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
-import io.opentelemetry.semconv.incubating.DbIncubatingAttributes;
 
 /**
  * Extractor of <a
@@ -24,6 +24,10 @@ public final class DbClientAttributesExtractor<REQUEST, RESPONSE>
     extends DbClientCommonAttributesExtractor<
         REQUEST, RESPONSE, DbClientAttributesGetter<REQUEST>> {
 
+  // copied from DbIncubatingAttributes
+  private static final AttributeKey<String> DB_STATEMENT = AttributeKey.stringKey("db.statement");
+  private static final AttributeKey<String> DB_OPERATION = AttributeKey.stringKey("db.operation");
+
   /** Creates the database client attributes extractor with default configuration. */
   public static <REQUEST, RESPONSE> AttributesExtractor<REQUEST, RESPONSE> create(
       DbClientAttributesGetter<REQUEST> getter) {
@@ -38,7 +42,7 @@ public static <REQUEST, RESPONSE> AttributesExtractor<REQUEST, RESPONSE> create(
   public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {
     super.onStart(attributes, parentContext, request);
 
-    internalSet(attributes, DbIncubatingAttributes.DB_STATEMENT, getter.getStatement(request));
-    internalSet(attributes, DbIncubatingAttributes.DB_OPERATION, getter.getOperation(request));
+    internalSet(attributes, DB_STATEMENT, getter.getStatement(request));
+    internalSet(attributes, DB_OPERATION, getter.getOperation(request));
   }
 }
diff --git a/...telemetry/instrumentation/api/incubator/semconv/db/DbClientCommonAttributesExtractor.java b/...telemetry/instrumentation/api/incubator/semconv/db/DbClientCommonAttributesExtractor.java
@@ -7,18 +7,23 @@
 
 import static io.opentelemetry.instrumentation.api.internal.AttributesExtractorUtil.internalSet;
 
+import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
 import io.opentelemetry.instrumentation.api.internal.SpanKey;
 import io.opentelemetry.instrumentation.api.internal.SpanKeyProvider;
-import io.opentelemetry.semconv.incubating.DbIncubatingAttributes;
 import javax.annotation.Nullable;
 
 abstract class DbClientCommonAttributesExtractor<
         REQUEST, RESPONSE, GETTER extends DbClientCommonAttributesGetter<REQUEST>>
     implements AttributesExtractor<REQUEST, RESPONSE>, SpanKeyProvider {
 
+  // copied from DbIncubatingAttributes
+  private static final AttributeKey<String> DB_NAME = AttributeKey.stringKey("db.name");
+  private static final AttributeKey<String> DB_SYSTEM = AttributeKey.stringKey("db.system");
+  private static final AttributeKey<String> DB_USER = AttributeKey.stringKey("db.user");
+
   final GETTER getter;
 
   DbClientCommonAttributesExtractor(GETTER getter) {
@@ -27,9 +32,9 @@ abstract class DbClientCommonAttributesExtractor<
 
   @Override
   public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {
-    internalSet(attributes, DbIncubatingAttributes.DB_SYSTEM, getter.getSystem(request));
-    internalSet(attributes, DbIncubatingAttributes.DB_USER, getter.getUser(request));
-    internalSet(attributes, DbIncubatingAttributes.DB_NAME, getter.getName(request));
+    internalSet(attributes, DB_SYSTEM, getter.getSystem(request));
+    internalSet(attributes, DB_USER, getter.getUser(request));
+    internalSet(attributes, DB_NAME, getter.getName(request));
   }
 
   @Override

diff --git a/.../opentelemetry/instrumentation/api/incubator/semconv/db/SqlClientAttributesExtractor.java b/.../opentelemetry/instrumentation/api/incubator/semconv/db/SqlClientAttributesExtractor.java
@@ -11,22 +11,25 @@
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
-import io.opentelemetry.semconv.incubating.DbIncubatingAttributes;
 
 /**
  * Extractor of <a
  * href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-spans.md">database
  * attributes</a>. This class is designed with SQL (or SQL-like) database clients in mind.
  *
  * <p>It sets the same set of attributes as {@link DbClientAttributesExtractor} plus an additional
- * <code>{@link DbIncubatingAttributes#DB_SQL_TABLE}</code> attribute. The raw SQL statements
- * returned by the {@link SqlClientAttributesGetter#getRawStatement(Object)} method are sanitized
- * before use, all statement parameters are removed.
+ * <code>db.sql.table</code> attribute. The raw SQL statements returned by the {@link
+ * SqlClientAttributesGetter#getRawStatement(Object)} method are sanitized before use, all statement
+ * parameters are removed.
  */
 public final class SqlClientAttributesExtractor<REQUEST, RESPONSE>
     extends DbClientCommonAttributesExtractor<
         REQUEST, RESPONSE, SqlClientAttributesGetter<REQUEST>> {
 
+  // copied from DbIncubatingAttributes
+  private static final AttributeKey<String> DB_OPERATION = AttributeKey.stringKey("db.operation");
+  private static final AttributeKey<String> DB_STATEMENT = AttributeKey.stringKey("db.statement");
+
   /** Creates the SQL client attributes extractor with default configuration. */
   public static <REQUEST, RESPONSE> AttributesExtractor<REQUEST, RESPONSE> create(
       SqlClientAttributesGetter<REQUEST> getter) {
@@ -62,9 +65,8 @@ public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST
 
     SqlStatementInfo sanitizedStatement = sanitizer.sanitize(getter.getRawStatement(request));
     String operation = sanitizedStatement.getOperation();
-    internalSet(
-        attributes, DbIncubatingAttributes.DB_STATEMENT, sanitizedStatement.getFullStatement());
-    internalSet(attributes, DbIncubatingAttributes.DB_OPERATION, operation);
+    internalSet(attributes, DB_STATEMENT, sanitizedStatement.getFullStatement());
+    internalSet(attributes, DB_OPERATION, operation);
     if (!SQL_CALL.equals(operation)) {
       internalSet(attributes, dbTableAttribute, sanitizedStatement.getMainIdentifier());
     }

diff --git a/...lemetry/instrumentation/api/incubator/semconv/db/SqlClientAttributesExtractorBuilder.java b/...lemetry/instrumentation/api/incubator/semconv/db/SqlClientAttributesExtractorBuilder.java
@@ -10,13 +10,15 @@
 import com.google.errorprone.annotations.CanIgnoreReturnValue;
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
-import io.opentelemetry.semconv.incubating.DbIncubatingAttributes;
 
 /** A builder of {@link SqlClientAttributesExtractor}. */
 public final class SqlClientAttributesExtractorBuilder<REQUEST, RESPONSE> {
 
+  // copied from DbIncubatingAttributes
+  private static final AttributeKey<String> DB_SQL_TABLE = AttributeKey.stringKey("db.sql.table");
+
   final SqlClientAttributesGetter<REQUEST> getter;
-  AttributeKey<String> dbTableAttribute = DbIncubatingAttributes.DB_SQL_TABLE;
+  AttributeKey<String> dbTableAttribute = DB_SQL_TABLE;
   boolean statementSanitizationEnabled = true;
 
   SqlClientAttributesExtractorBuilder(SqlClientAttributesGetter<REQUEST> getter) {
@@ -26,7 +28,7 @@ public final class SqlClientAttributesExtractorBuilder<REQUEST, RESPONSE> {
   /**
    * Configures the extractor to set the table value extracted by the {@link
    * SqlClientAttributesExtractor} under the {@code dbTableAttribute} key. By default, the <code>
-   * {@link DbIncubatingAttributes#DB_SQL_TABLE}</code> attribute is used.
+   * db.sql.table</code> attribute is used.
    *
    * @param dbTableAttribute The {@link AttributeKey} under which the table extracted by the {@link
    *     SqlClientAttributesExtractor} will be stored.

diff --git a/.../instrumentation/api/incubator/semconv/http/HttpClientPeerServiceAttributesExtractor.java b/.../instrumentation/api/incubator/semconv/http/HttpClientPeerServiceAttributesExtractor.java
@@ -5,13 +5,13 @@
 
 package io.opentelemetry.instrumentation.api.incubator.semconv.http;
 
+import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.instrumentation.api.incubator.semconv.net.PeerServiceResolver;
 import io.opentelemetry.instrumentation.api.incubator.semconv.net.internal.UrlParser;
 import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
 import io.opentelemetry.instrumentation.api.semconv.http.HttpClientAttributesGetter;
-import io.opentelemetry.semconv.incubating.PeerIncubatingAttributes;
 import java.util.function.Supplier;
 import javax.annotation.Nullable;
 
@@ -23,6 +23,9 @@
 public final class HttpClientPeerServiceAttributesExtractor<REQUEST, RESPONSE>
     implements AttributesExtractor<REQUEST, RESPONSE> {
 
+  // copied from PeerIncubatingAttributes
+  private static final AttributeKey<String> PEER_SERVICE = AttributeKey.stringKey("peer.service");
+
   private final HttpClientAttributesGetter<REQUEST, RESPONSE> attributesGetter;
   private final PeerServiceResolver peerServiceResolver;
 
@@ -67,7 +70,7 @@ public void onEnd(
     Supplier<String> pathSupplier = () -> getUrlPath(attributesGetter, request);
     String peerService = mapToPeerService(serverAddress, serverPort, pathSupplier);
     if (peerService != null) {
-      attributes.put(PeerIncubatingAttributes.PEER_SERVICE, peerService);
+      attributes.put(PEER_SERVICE, peerService);
     }
   }
 

diff --git a/...metry/instrumentation/api/incubator/semconv/http/HttpExperimentalAttributesExtractor.java b/...metry/instrumentation/api/incubator/semconv/http/HttpExperimentalAttributesExtractor.java
@@ -7,19 +7,25 @@
 
 import static io.opentelemetry.instrumentation.api.internal.AttributesExtractorUtil.internalSet;
 
+import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
 import io.opentelemetry.instrumentation.api.semconv.http.HttpClientAttributesGetter;
 import io.opentelemetry.instrumentation.api.semconv.http.HttpCommonAttributesGetter;
 import io.opentelemetry.instrumentation.api.semconv.http.HttpServerAttributesGetter;
-import io.opentelemetry.semconv.incubating.HttpIncubatingAttributes;
 import java.util.List;
 import javax.annotation.Nullable;
 
 public final class HttpExperimentalAttributesExtractor<REQUEST, RESPONSE>
     implements AttributesExtractor<REQUEST, RESPONSE> {
 
+  // copied from HttpIncubatingAttributes
+  static final AttributeKey<Long> HTTP_REQUEST_BODY_SIZE =
+      AttributeKey.longKey("http.request.body.size");
+  static final AttributeKey<Long> HTTP_RESPONSE_BODY_SIZE =
+      AttributeKey.longKey("http.response.body.size");
+
   public static <REQUEST, RESPONSE> AttributesExtractor<REQUEST, RESPONSE> create(
       HttpClientAttributesGetter<REQUEST, RESPONSE> getter) {
     return new HttpExperimentalAttributesExtractor<>(getter);
@@ -49,11 +55,11 @@ public void onEnd(
       @Nullable Throwable error) {
 
     Long requestBodySize = requestBodySize(request);
-    internalSet(attributes, HttpIncubatingAttributes.HTTP_REQUEST_BODY_SIZE, requestBodySize);
+    internalSet(attributes, HTTP_REQUEST_BODY_SIZE, requestBodySize);
 
     if (response != null) {
       Long responseBodySize = responseBodySize(request, response);
-      internalSet(attributes, HttpIncubatingAttributes.HTTP_RESPONSE_BODY_SIZE, responseBodySize);
+      internalSet(attributes, HTTP_RESPONSE_BODY_SIZE, responseBodySize);
     }
   }
 

diff --git a/.../io/opentelemetry/instrumentation/api/incubator/semconv/http/HttpMessageBodySizeUtil.java b/.../io/opentelemetry/instrumentation/api/incubator/semconv/http/HttpMessageBodySizeUtil.java
@@ -7,19 +7,19 @@
 
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.Attributes;
-import io.opentelemetry.semconv.incubating.HttpIncubatingAttributes;
 import javax.annotation.Nullable;
 
 final class HttpMessageBodySizeUtil {
 
   @Nullable
   static Long getHttpRequestBodySize(Attributes... attributesList) {
-    return getAttribute(HttpIncubatingAttributes.HTTP_REQUEST_BODY_SIZE, attributesList);
+    return getAttribute(HttpExperimentalAttributesExtractor.HTTP_REQUEST_BODY_SIZE, attributesList);
   }
 
   @Nullable
   static Long getHttpResponseBodySize(Attributes... attributesList) {
-    return getAttribute(HttpIncubatingAttributes.HTTP_RESPONSE_BODY_SIZE, attributesList);
+    return getAttribute(
+        HttpExperimentalAttributesExtractor.HTTP_RESPONSE_BODY_SIZE, attributesList);
   }
 
   @Nullable