Deprecate AttributesExtractor#set() method

open-telemetry · Apr 4, 2022 · 17be6e0 · 17be6e0
1 parent 56e3ed6
commit 17be6e0
Show file tree

Hide file tree

Showing 34 changed files with 238 additions and 164 deletions.
diff --git a/.../java/io/opentelemetry/instrumentation/api/instrumenter/code/CodeAttributesExtractor.java b/.../java/io/opentelemetry/instrumentation/api/instrumenter/code/CodeAttributesExtractor.java
@@ -5,6 +5,8 @@
 
 package io.opentelemetry.instrumentation.api.instrumenter.code;
 
+import static io.opentelemetry.instrumentation.api.internal.AttributesExtractorUtil.setAttr;
+
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
@@ -35,9 +37,9 @@ private CodeAttributesExtractor(CodeAttributesGetter<REQUEST> getter) {
   public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {
     Class<?> cls = getter.codeClass(request);
     if (cls != null) {
-      set(attributes, SemanticAttributes.CODE_NAMESPACE, cls.getName());
+      setAttr(attributes, SemanticAttributes.CODE_NAMESPACE, cls.getName());
     }
-    set(attributes, SemanticAttributes.CODE_FUNCTION, getter.methodName(request));
+    setAttr(attributes, SemanticAttributes.CODE_FUNCTION, getter.methodName(request));
   }
 
   @Override

diff --git a/...ava/io/opentelemetry/instrumentation/api/instrumenter/db/DbClientAttributesExtractor.java b/...ava/io/opentelemetry/instrumentation/api/instrumenter/db/DbClientAttributesExtractor.java
@@ -5,6 +5,8 @@
 
 package io.opentelemetry.instrumentation.api.instrumenter.db;
 
+import static io.opentelemetry.instrumentation.api.internal.AttributesExtractorUtil.setAttr;
+
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.semconv.trace.attributes.SemanticAttributes;
@@ -35,7 +37,7 @@ public static <REQUEST, RESPONSE> DbClientAttributesExtractor<REQUEST, RESPONSE>
   public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {
     super.onStart(attributes, parentContext, request);
 
-    set(attributes, SemanticAttributes.DB_STATEMENT, getter.statement(request));
-    set(attributes, SemanticAttributes.DB_OPERATION, getter.operation(request));
+    setAttr(attributes, SemanticAttributes.DB_STATEMENT, getter.statement(request));
+    setAttr(attributes, SemanticAttributes.DB_OPERATION, getter.operation(request));
   }
 }
diff --git a/.../opentelemetry/instrumentation/api/instrumenter/db/DbClientCommonAttributesExtractor.java b/.../opentelemetry/instrumentation/api/instrumenter/db/DbClientCommonAttributesExtractor.java
@@ -5,6 +5,8 @@
 
 package io.opentelemetry.instrumentation.api.instrumenter.db;
 
+import static io.opentelemetry.instrumentation.api.internal.AttributesExtractorUtil.setAttr;
+
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.instrumentation.api.annotations.UnstableApi;
@@ -26,10 +28,10 @@ abstract class DbClientCommonAttributesExtractor<
 
   @Override
   public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {
-    set(attributes, SemanticAttributes.DB_SYSTEM, getter.system(request));
-    set(attributes, SemanticAttributes.DB_USER, getter.user(request));
-    set(attributes, SemanticAttributes.DB_NAME, getter.name(request));
-    set(attributes, SemanticAttributes.DB_CONNECTION_STRING, getter.connectionString(request));
+    setAttr(attributes, SemanticAttributes.DB_SYSTEM, getter.system(request));
+    setAttr(attributes, SemanticAttributes.DB_USER, getter.user(request));
+    setAttr(attributes, SemanticAttributes.DB_NAME, getter.name(request));
+    setAttr(attributes, SemanticAttributes.DB_CONNECTION_STRING, getter.connectionString(request));
   }
 
   @Override

diff --git a/...va/io/opentelemetry/instrumentation/api/instrumenter/db/SqlClientAttributesExtractor.java b/...va/io/opentelemetry/instrumentation/api/instrumenter/db/SqlClientAttributesExtractor.java
@@ -5,6 +5,8 @@
 
 package io.opentelemetry.instrumentation.api.instrumenter.db;
 
+import static io.opentelemetry.instrumentation.api.internal.AttributesExtractorUtil.setAttr;
+
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.context.Context;
@@ -55,8 +57,8 @@ public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST
 
     SqlStatementInfo sanitizedStatement =
         SqlStatementSanitizer.sanitize(getter.rawStatement(request));
-    set(attributes, SemanticAttributes.DB_STATEMENT, sanitizedStatement.getFullStatement());
-    set(attributes, SemanticAttributes.DB_OPERATION, sanitizedStatement.getOperation());
-    set(attributes, dbTableAttribute, sanitizedStatement.getTable());
+    setAttr(attributes, SemanticAttributes.DB_STATEMENT, sanitizedStatement.getFullStatement());
+    setAttr(attributes, SemanticAttributes.DB_OPERATION, sanitizedStatement.getOperation());
+    setAttr(attributes, dbTableAttribute, sanitizedStatement.getTable());
   }
 }
diff --git a/...io/opentelemetry/instrumentation/api/instrumenter/http/HttpClientAttributesExtractor.java b/...io/opentelemetry/instrumentation/api/instrumenter/http/HttpClientAttributesExtractor.java
@@ -5,6 +5,8 @@
 
 package io.opentelemetry.instrumentation.api.instrumenter.http;
 
+import static io.opentelemetry.instrumentation.api.internal.AttributesExtractorUtil.setAttr;
+
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.instrumentation.api.annotations.UnstableApi;
@@ -53,7 +55,7 @@ public static <REQUEST, RESPONSE> HttpClientAttributesExtractorBuilder<REQUEST,
   @Override
   public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {
     super.onStart(attributes, parentContext, request);
-    set(attributes, SemanticAttributes.HTTP_URL, getter.url(request));
+    setAttr(attributes, SemanticAttributes.HTTP_URL, getter.url(request));
   }
 
   @Override
@@ -64,7 +66,7 @@ public void onEnd(
       @Nullable RESPONSE response,
       @Nullable Throwable error) {
     super.onEnd(attributes, context, request, response, error);
-    set(attributes, SemanticAttributes.HTTP_FLAVOR, getter.flavor(request, response));
+    setAttr(attributes, SemanticAttributes.HTTP_FLAVOR, getter.flavor(request, response));
   }
 
   /**

diff --git a/...io/opentelemetry/instrumentation/api/instrumenter/http/HttpCommonAttributesExtractor.java b/...io/opentelemetry/instrumentation/api/instrumenter/http/HttpCommonAttributesExtractor.java
@@ -8,6 +8,7 @@
 import static io.opentelemetry.instrumentation.api.instrumenter.http.CapturedHttpHeadersUtil.lowercase;
 import static io.opentelemetry.instrumentation.api.instrumenter.http.CapturedHttpHeadersUtil.requestAttributeKey;
 import static io.opentelemetry.instrumentation.api.instrumenter.http.CapturedHttpHeadersUtil.responseAttributeKey;
+import static io.opentelemetry.instrumentation.api.internal.AttributesExtractorUtil.setAttr;
 
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.context.Context;
@@ -38,13 +39,13 @@ abstract class HttpCommonAttributesExtractor<
 
   @Override
   public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {
-    set(attributes, SemanticAttributes.HTTP_METHOD, getter.method(request));
-    set(attributes, SemanticAttributes.HTTP_USER_AGENT, userAgent(request));
+    setAttr(attributes, SemanticAttributes.HTTP_METHOD, getter.method(request));
+    setAttr(attributes, SemanticAttributes.HTTP_USER_AGENT, userAgent(request));
 
     for (String name : capturedRequestHeaders) {
       List<String> values = getter.requestHeader(request, name);
       if (!values.isEmpty()) {
-        set(attributes, requestAttributeKey(name), values);
+        setAttr(attributes, requestAttributeKey(name), values);
       }
     }
   }
@@ -57,33 +58,33 @@ public void onEnd(
       @Nullable RESPONSE response,
       @Nullable Throwable error) {
 
-    set(
+    setAttr(
         attributes,
         SemanticAttributes.HTTP_REQUEST_CONTENT_LENGTH,
         getter.requestContentLength(request, response));
-    set(
+    setAttr(
         attributes,
         SemanticAttributes.HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED,
         getter.requestContentLengthUncompressed(request, response));
 
     if (response != null) {
       Integer statusCode = getter.statusCode(request, response);
       if (statusCode != null && statusCode > 0) {
-        set(attributes, SemanticAttributes.HTTP_STATUS_CODE, (long) statusCode);
+        setAttr(attributes, SemanticAttributes.HTTP_STATUS_CODE, (long) statusCode);
       }
-      set(
+      setAttr(
           attributes,
           SemanticAttributes.HTTP_RESPONSE_CONTENT_LENGTH,
           getter.responseContentLength(request, response));
-      set(
+      setAttr(
           attributes,
           SemanticAttributes.HTTP_RESPONSE_CONTENT_LENGTH_UNCOMPRESSED,
           getter.responseContentLengthUncompressed(request, response));
 
       for (String name : capturedResponseHeaders) {
         List<String> values = getter.responseHeader(request, response, name);
         if (!values.isEmpty()) {
-          set(attributes, responseAttributeKey(name), values);
+          setAttr(attributes, responseAttributeKey(name), values);
         }
       }
     }

diff --git a/...io/opentelemetry/instrumentation/api/instrumenter/http/HttpServerAttributesExtractor.java b/...io/opentelemetry/instrumentation/api/instrumenter/http/HttpServerAttributesExtractor.java
@@ -9,6 +9,7 @@
 import static io.opentelemetry.instrumentation.api.instrumenter.http.ForwardedHeaderParser.extractClientIpFromForwardedHeader;
 import static io.opentelemetry.instrumentation.api.instrumenter.http.ForwardedHeaderParser.extractProtoFromForwardedHeader;
 import static io.opentelemetry.instrumentation.api.instrumenter.http.ForwardedHeaderParser.extractProtoFromForwardedProtoHeader;
+import static io.opentelemetry.instrumentation.api.internal.AttributesExtractorUtil.setAttr;
 
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.context.Context;
@@ -68,17 +69,15 @@ public static <REQUEST, RESPONSE> HttpServerAttributesExtractorBuilder<REQUEST,
   public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {
     super.onStart(attributes, parentContext, request);
 
-    set(attributes, SemanticAttributes.HTTP_FLAVOR, getter.flavor(request));
+    setAttr(attributes, SemanticAttributes.HTTP_FLAVOR, getter.flavor(request));
     String forwardedProto = forwardedProto(request);
-    set(
-        attributes,
-        SemanticAttributes.HTTP_SCHEME,
-        forwardedProto != null ? forwardedProto : getter.scheme(request));
-    set(attributes, SemanticAttributes.HTTP_HOST, host(request));
-    set(attributes, SemanticAttributes.HTTP_TARGET, getter.target(request));
-    set(attributes, SemanticAttributes.HTTP_ROUTE, getter.route(request));
-    set(attributes, SemanticAttributes.HTTP_SERVER_NAME, getter.serverName(request));
-    set(attributes, SemanticAttributes.HTTP_CLIENT_IP, clientIp(request));
+    String value = forwardedProto != null ? forwardedProto : getter.scheme(request);
+    setAttr(attributes, SemanticAttributes.HTTP_SCHEME, value);
+    setAttr(attributes, SemanticAttributes.HTTP_HOST, host(request));
+    setAttr(attributes, SemanticAttributes.HTTP_TARGET, getter.target(request));
+    setAttr(attributes, SemanticAttributes.HTTP_ROUTE, getter.route(request));
+    setAttr(attributes, SemanticAttributes.HTTP_SERVER_NAME, getter.serverName(request));
+    setAttr(attributes, SemanticAttributes.HTTP_CLIENT_IP, clientIp(request));
   }
 
   @Override
@@ -90,7 +89,7 @@ public void onEnd(
       @Nullable Throwable error) {
 
     super.onEnd(attributes, context, request, response, error);
-    set(attributes, SemanticAttributes.HTTP_ROUTE, httpRouteHolderGetter.apply(context));
+    setAttr(attributes, SemanticAttributes.HTTP_ROUTE, httpRouteHolderGetter.apply(context));
   }
 
   @Nullable

diff --git a/...pentelemetry/instrumentation/api/instrumenter/messaging/MessagingAttributesExtractor.java b/...pentelemetry/instrumentation/api/instrumenter/messaging/MessagingAttributesExtractor.java
@@ -7,6 +7,7 @@
 
 import static io.opentelemetry.instrumentation.api.instrumenter.messaging.MessageOperation.PROCESS;
 import static io.opentelemetry.instrumentation.api.instrumenter.messaging.MessageOperation.RECEIVE;
+import static io.opentelemetry.instrumentation.api.internal.AttributesExtractorUtil.setAttr;
 
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.context.Context;
@@ -50,29 +51,32 @@ private MessagingAttributesExtractor(
   @SuppressWarnings("deprecation") // operationName
   @Override
   public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {
-    set(attributes, SemanticAttributes.MESSAGING_SYSTEM, getter.system(request));
-    set(attributes, SemanticAttributes.MESSAGING_DESTINATION_KIND, getter.destinationKind(request));
+    setAttr(attributes, SemanticAttributes.MESSAGING_SYSTEM, getter.system(request));
+    setAttr(
+        attributes, SemanticAttributes.MESSAGING_DESTINATION_KIND, getter.destinationKind(request));
     boolean isTemporaryDestination = getter.temporaryDestination(request);
     if (isTemporaryDestination) {
-      set(attributes, SemanticAttributes.MESSAGING_TEMP_DESTINATION, true);
-      set(attributes, SemanticAttributes.MESSAGING_DESTINATION, TEMP_DESTINATION_NAME);
+      setAttr(attributes, SemanticAttributes.MESSAGING_TEMP_DESTINATION, true);
+      setAttr(attributes, SemanticAttributes.MESSAGING_DESTINATION, TEMP_DESTINATION_NAME);
     } else {
-      set(attributes, SemanticAttributes.MESSAGING_DESTINATION, getter.destination(request));
+      setAttr(attributes, SemanticAttributes.MESSAGING_DESTINATION, getter.destination(request));
     }
-    set(attributes, SemanticAttributes.MESSAGING_PROTOCOL, getter.protocol(request));
-    set(attributes, SemanticAttributes.MESSAGING_PROTOCOL_VERSION, getter.protocolVersion(request));
-    set(attributes, SemanticAttributes.MESSAGING_URL, getter.url(request));
-    set(attributes, SemanticAttributes.MESSAGING_CONVERSATION_ID, getter.conversationId(request));
-    set(
+    setAttr(attributes, SemanticAttributes.MESSAGING_PROTOCOL, getter.protocol(request));
+    setAttr(
+        attributes, SemanticAttributes.MESSAGING_PROTOCOL_VERSION, getter.protocolVersion(request));
+    setAttr(attributes, SemanticAttributes.MESSAGING_URL, getter.url(request));
+    setAttr(
+        attributes, SemanticAttributes.MESSAGING_CONVERSATION_ID, getter.conversationId(request));
+    setAttr(
         attributes,
         SemanticAttributes.MESSAGING_MESSAGE_PAYLOAD_SIZE_BYTES,
         getter.messagePayloadSize(request));
-    set(
+    setAttr(
         attributes,
         SemanticAttributes.MESSAGING_MESSAGE_PAYLOAD_COMPRESSED_SIZE_BYTES,
         getter.messagePayloadCompressedSize(request));
     if (operation == RECEIVE || operation == PROCESS) {
-      set(attributes, SemanticAttributes.MESSAGING_OPERATION, operation.operationName());
+      setAttr(attributes, SemanticAttributes.MESSAGING_OPERATION, operation.operationName());
     }
   }
 
@@ -83,7 +87,8 @@ public void onEnd(
       REQUEST request,
       @Nullable RESPONSE response,
       @Nullable Throwable error) {
-    set(attributes, SemanticAttributes.MESSAGING_MESSAGE_ID, getter.messageId(request, response));
+    setAttr(
+        attributes, SemanticAttributes.MESSAGING_MESSAGE_ID, getter.messageId(request, response));
   }
 
   /**

diff --git a/...a/io/opentelemetry/instrumentation/api/instrumenter/net/NetClientAttributesExtractor.java b/...a/io/opentelemetry/instrumentation/api/instrumenter/net/NetClientAttributesExtractor.java
@@ -5,6 +5,8 @@
 
 package io.opentelemetry.instrumentation.api.instrumenter.net;
 
+import static io.opentelemetry.instrumentation.api.internal.AttributesExtractorUtil.setAttr;
+
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
@@ -45,19 +47,19 @@ public void onEnd(
       @Nullable RESPONSE response,
       @Nullable Throwable error) {
 
-    set(attributes, SemanticAttributes.NET_TRANSPORT, getter.transport(request, response));
+    setAttr(attributes, SemanticAttributes.NET_TRANSPORT, getter.transport(request, response));
 
     String peerIp = getter.peerIp(request, response);
     String peerName = getter.peerName(request, response);
 
     if (peerName != null && !peerName.equals(peerIp)) {
-      set(attributes, SemanticAttributes.NET_PEER_NAME, peerName);
+      setAttr(attributes, SemanticAttributes.NET_PEER_NAME, peerName);
     }
-    set(attributes, SemanticAttributes.NET_PEER_IP, peerIp);
+    setAttr(attributes, SemanticAttributes.NET_PEER_IP, peerIp);
 
     Integer peerPort = getter.peerPort(request, response);
     if (peerPort != null && peerPort > 0) {
-      set(attributes, SemanticAttributes.NET_PEER_PORT, (long) peerPort);
+      setAttr(attributes, SemanticAttributes.NET_PEER_PORT, (long) peerPort);
     }
   }
 }
diff --git a/...a/io/opentelemetry/instrumentation/api/instrumenter/net/NetServerAttributesExtractor.java b/...a/io/opentelemetry/instrumentation/api/instrumenter/net/NetServerAttributesExtractor.java
@@ -5,6 +5,8 @@
 
 package io.opentelemetry.instrumentation.api.instrumenter.net;
 
+import static io.opentelemetry.instrumentation.api.internal.AttributesExtractorUtil.setAttr;
+
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
@@ -33,15 +35,15 @@ private NetServerAttributesExtractor(NetServerAttributesGetter<REQUEST> getter)
 
   @Override
   public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {
-    set(attributes, SemanticAttributes.NET_TRANSPORT, getter.transport(request));
+    setAttr(attributes, SemanticAttributes.NET_TRANSPORT, getter.transport(request));
 
     String peerIp = getter.peerIp(request);
 
-    set(attributes, SemanticAttributes.NET_PEER_IP, peerIp);
+    setAttr(attributes, SemanticAttributes.NET_PEER_IP, peerIp);
 
     Integer peerPort = getter.peerPort(request);
     if (peerPort != null && peerPort > 0) {
-      set(attributes, SemanticAttributes.NET_PEER_PORT, (long) peerPort);
+      setAttr(attributes, SemanticAttributes.NET_PEER_PORT, (long) peerPort);
     }
   }
 

diff --git a/...a/io/opentelemetry/instrumentation/api/instrumenter/rpc/RpcCommonAttributesExtractor.java b/...a/io/opentelemetry/instrumentation/api/instrumenter/rpc/RpcCommonAttributesExtractor.java
@@ -5,6 +5,8 @@
 
 package io.opentelemetry.instrumentation.api.instrumenter.rpc;
 
+import static io.opentelemetry.instrumentation.api.internal.AttributesExtractorUtil.setAttr;
+
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
@@ -22,9 +24,9 @@ abstract class RpcCommonAttributesExtractor<REQUEST, RESPONSE>
 
   @Override
   public final void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {
-    set(attributes, SemanticAttributes.RPC_SYSTEM, getter.system(request));
-    set(attributes, SemanticAttributes.RPC_SERVICE, getter.service(request));
-    set(attributes, SemanticAttributes.RPC_METHOD, getter.method(request));
+    setAttr(attributes, SemanticAttributes.RPC_SYSTEM, getter.system(request));
+    setAttr(attributes, SemanticAttributes.RPC_SERVICE, getter.service(request));
+    setAttr(attributes, SemanticAttributes.RPC_METHOD, getter.method(request));
   }
 
   @Override

diff --git a/.../src/main/java/io/opentelemetry/instrumentation/api/instrumenter/AttributesExtractor.java b/.../src/main/java/io/opentelemetry/instrumentation/api/instrumenter/AttributesExtractor.java
@@ -8,6 +8,7 @@
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.context.Context;
+import io.opentelemetry.instrumentation.api.internal.AttributesExtractorUtil;
 import javax.annotation.Nullable;
 
 /**
@@ -40,11 +41,13 @@ void onEnd(
   /**
    * Sets the {@code value} with the given {@code key} to the {@link AttributesBuilder} if {@code
    * value} is not {@code null}.
+   *
+   * @deprecated This method will be removed.
    */
+  // TODO: remove after 1.13 release
+  @Deprecated
   default <T> void set(AttributesBuilder attributes, AttributeKey<T> key, @Nullable T value) {
-    if (value != null) {
-      attributes.put(key, value);
-    }
+    AttributesExtractorUtil.setAttr(attributes, key, value);
   }
 
   /**