Deprecate NetClientAttribitesExtractor

open-telemetry · Aug 11, 2023 · f1feb68 · f1feb68
1 parent 42f07ee
commit f1feb68
Show file tree

Hide file tree

Showing 61 changed files with 267 additions and 270 deletions.
diff --git a/...io/opentelemetry/instrumentation/api/instrumenter/http/HttpClientAttributesExtractor.java b/...io/opentelemetry/instrumentation/api/instrumenter/http/HttpClientAttributesExtractor.java
@@ -10,7 +10,6 @@
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
-import io.opentelemetry.instrumentation.api.instrumenter.net.NetClientAttributesGetter;
 import io.opentelemetry.instrumentation.api.instrumenter.net.internal.InternalNetClientAttributesExtractor;
 import io.opentelemetry.instrumentation.api.instrumenter.network.internal.InternalNetworkAttributesExtractor;
 import io.opentelemetry.instrumentation.api.instrumenter.network.internal.InternalServerAttributesExtractor;
@@ -52,7 +51,9 @@ public static <REQUEST, RESPONSE> AttributesExtractor<REQUEST, RESPONSE> create(
   @Deprecated
   public static <REQUEST, RESPONSE> AttributesExtractor<REQUEST, RESPONSE> create(
       HttpClientAttributesGetter<REQUEST, RESPONSE> httpAttributesGetter,
-      NetClientAttributesGetter<REQUEST, RESPONSE> netAttributesGetter) {
+      io.opentelemetry.instrumentation.api.instrumenter.net.NetClientAttributesGetter<
+              REQUEST, RESPONSE>
+          netAttributesGetter) {
     return builder(httpAttributesGetter, netAttributesGetter).build();
   }
 
@@ -76,7 +77,9 @@ public static <REQUEST, RESPONSE> HttpClientAttributesExtractorBuilder<REQUEST,
   @Deprecated
   public static <REQUEST, RESPONSE> HttpClientAttributesExtractorBuilder<REQUEST, RESPONSE> builder(
       HttpClientAttributesGetter<REQUEST, RESPONSE> httpAttributesGetter,
-      NetClientAttributesGetter<REQUEST, RESPONSE> netAttributesGetter) {
+      io.opentelemetry.instrumentation.api.instrumenter.net.NetClientAttributesGetter<
+              REQUEST, RESPONSE>
+          netAttributesGetter) {
     return new HttpClientAttributesExtractorBuilder<>(httpAttributesGetter, netAttributesGetter);
   }
 

diff --git a/...telemetry/instrumentation/api/instrumenter/http/HttpClientAttributesExtractorBuilder.java b/...telemetry/instrumentation/api/instrumenter/http/HttpClientAttributesExtractorBuilder.java
@@ -10,7 +10,6 @@
 import com.google.errorprone.annotations.CanIgnoreReturnValue;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
-import io.opentelemetry.instrumentation.api.instrumenter.net.NetClientAttributesGetter;
 import io.opentelemetry.instrumentation.api.instrumenter.net.internal.InternalNetClientAttributesExtractor;
 import io.opentelemetry.instrumentation.api.instrumenter.network.internal.InternalNetworkAttributesExtractor;
 import io.opentelemetry.instrumentation.api.instrumenter.network.internal.InternalServerAttributesExtractor;
@@ -26,7 +25,12 @@
 public final class HttpClientAttributesExtractorBuilder<REQUEST, RESPONSE> {
 
   final HttpClientAttributesGetter<REQUEST, RESPONSE> httpAttributesGetter;
-  final NetClientAttributesGetter<REQUEST, RESPONSE> netAttributesGetter;
+
+  @SuppressWarnings("deprecation") // using the net extractor for the old->stable semconv story
+  final io.opentelemetry.instrumentation.api.instrumenter.net.NetClientAttributesGetter<
+          REQUEST, RESPONSE>
+      netAttributesGetter;
+
   final HttpAddressPortExtractor<REQUEST> addressPortExtractor;
   List<String> capturedRequestHeaders = emptyList();
   List<String> capturedResponseHeaders = emptyList();
@@ -35,7 +39,10 @@ public final class HttpClientAttributesExtractorBuilder<REQUEST, RESPONSE> {
 
   HttpClientAttributesExtractorBuilder(
       HttpClientAttributesGetter<REQUEST, RESPONSE> httpAttributesGetter,
-      NetClientAttributesGetter<REQUEST, RESPONSE> netAttributesGetter) {
+      @SuppressWarnings("deprecation") // using the net extractor for the old->stable semconv story
+          io.opentelemetry.instrumentation.api.instrumenter.net.NetClientAttributesGetter<
+                  REQUEST, RESPONSE>
+              netAttributesGetter) {
     this.httpAttributesGetter = httpAttributesGetter;
     this.netAttributesGetter = netAttributesGetter;
     addressPortExtractor = new HttpAddressPortExtractor<>(httpAttributesGetter);

diff --git a/...va/io/opentelemetry/instrumentation/api/instrumenter/http/HttpClientAttributesGetter.java b/...va/io/opentelemetry/instrumentation/api/instrumenter/http/HttpClientAttributesGetter.java
@@ -5,7 +5,6 @@
 
 package io.opentelemetry.instrumentation.api.instrumenter.http;
 
-import io.opentelemetry.instrumentation.api.instrumenter.net.NetClientAttributesGetter;
 import io.opentelemetry.instrumentation.api.instrumenter.network.NetworkAttributesGetter;
 import io.opentelemetry.instrumentation.api.instrumenter.network.ServerAttributesGetter;
 import javax.annotation.Nullable;
@@ -17,9 +16,13 @@
  * library/framework. It will be used by the {@link HttpClientAttributesExtractor} to obtain the
  * various HTTP client attributes in a type-generic way.
  */
+@SuppressWarnings(
+    "deprecation") // implementing the NetClientAttributesGetter for the old->stable semconv story;
+// will be removed in 2.0
 public interface HttpClientAttributesGetter<REQUEST, RESPONSE>
     extends HttpCommonAttributesGetter<REQUEST, RESPONSE>,
-        NetClientAttributesGetter<REQUEST, RESPONSE>,
+        io.opentelemetry.instrumentation.api.instrumenter.net.NetClientAttributesGetter<
+            REQUEST, RESPONSE>,
         NetworkAttributesGetter<REQUEST, RESPONSE>,
         ServerAttributesGetter<REQUEST, RESPONSE> {
 

diff --git a/...a/io/opentelemetry/instrumentation/api/instrumenter/net/NetClientAttributesExtractor.java b/...a/io/opentelemetry/instrumentation/api/instrumenter/net/NetClientAttributesExtractor.java
@@ -23,7 +23,11 @@
  *
  * <p>This class delegates to a type-specific {@link NetClientAttributesGetter} for individual
  * attribute extraction from request/response objects.
+ *
+ * @deprecated Make sure that your instrumentation uses the extractors from the {@code ...network}
+ *     package instead. This class will be removed in the 2.0 release.
  */
+@Deprecated
 public final class NetClientAttributesExtractor<REQUEST, RESPONSE>
     implements AttributesExtractor<REQUEST, RESPONSE> {
 

diff --git a/...java/io/opentelemetry/instrumentation/api/instrumenter/net/NetClientAttributesGetter.java b/...java/io/opentelemetry/instrumentation/api/instrumenter/net/NetClientAttributesGetter.java
@@ -18,7 +18,11 @@
  * <p>Instrumentation authors will create implementations of this interface for their specific
  * library/framework. It will be used by the NetClientAttributesExtractor to obtain the various
  * network attributes in a type-generic way.
+ *
+ * @deprecated Make sure that your instrumentation implements the getters from the {@code
+ *     ...network} package instead. This class will be removed in the 2.0 release.
  */
+@Deprecated
 public interface NetClientAttributesGetter<REQUEST, RESPONSE>
     extends NetworkAttributesGetter<REQUEST, RESPONSE>, ServerAttributesGetter<REQUEST, RESPONSE> {
 

diff --git a/...io/opentelemetry/instrumentation/api/instrumenter/net/internal/InetSocketAddressUtil.java b/...io/opentelemetry/instrumentation/api/instrumenter/net/internal/InetSocketAddressUtil.java
@@ -5,6 +5,7 @@
 
 package io.opentelemetry.instrumentation.api.instrumenter.net.internal;
 
+import java.net.Inet4Address;
 import java.net.Inet6Address;
 import java.net.InetAddress;
 import java.net.InetSocketAddress;
@@ -42,7 +43,12 @@ public static String getNetworkType(
       return null;
     }
     InetAddress remoteAddress = address.getAddress();
-    return remoteAddress instanceof Inet6Address ? "ipv6" : "ipv4";
+    if (remoteAddress instanceof Inet4Address) {
+      return "ipv6";
+    } else if (remoteAddress instanceof Inet6Address) {
+      return "ipv6";
+    }
+    return null;
   }
 
   @Nullable

diff --git a/...y/instrumentation/api/instrumenter/net/internal/InternalNetClientAttributesExtractor.java b/...y/instrumentation/api/instrumenter/net/internal/InternalNetClientAttributesExtractor.java
@@ -8,7 +8,6 @@
 import static io.opentelemetry.instrumentation.api.internal.AttributesExtractorUtil.internalSet;
 
 import io.opentelemetry.api.common.AttributesBuilder;
-import io.opentelemetry.instrumentation.api.instrumenter.net.NetClientAttributesGetter;
 import io.opentelemetry.instrumentation.api.instrumenter.network.internal.AddressAndPort;
 import io.opentelemetry.instrumentation.api.instrumenter.network.internal.FallbackAddressPortExtractor;
 import io.opentelemetry.semconv.trace.attributes.SemanticAttributes;
@@ -18,14 +17,19 @@
  * This class is internal and is hence not for public use. Its APIs are unstable and can change at
  * any time.
  */
+@SuppressWarnings("deprecation") // this class will be removed in the 2.0 version
 public final class InternalNetClientAttributesExtractor<REQUEST, RESPONSE> {
 
-  private final NetClientAttributesGetter<REQUEST, RESPONSE> getter;
+  private final io.opentelemetry.instrumentation.api.instrumenter.net.NetClientAttributesGetter<
+          REQUEST, RESPONSE>
+      getter;
   private final FallbackAddressPortExtractor<REQUEST> fallbackAddressPortExtractor;
   private final boolean emitOldHttpAttributes;
 
   public InternalNetClientAttributesExtractor(
-      NetClientAttributesGetter<REQUEST, RESPONSE> getter,
+      io.opentelemetry.instrumentation.api.instrumenter.net.NetClientAttributesGetter<
+              REQUEST, RESPONSE>
+          getter,
       FallbackAddressPortExtractor<REQUEST> fallbackAddressPortExtractor,
       boolean emitOldHttpAttributes) {
     this.getter = getter;

diff --git a/.../instrumentation/api/instrumenter/net/InetSocketAddressNetClientAttributesGetterTest.java b/.../instrumentation/api/instrumenter/net/InetSocketAddressNetClientAttributesGetterTest.java
@@ -19,6 +19,7 @@
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.mockito.junit.jupiter.MockitoExtension;
 
+@SuppressWarnings("deprecation") // testing deprecated class
 @ExtendWith(MockitoExtension.class)
 class InetSocketAddressNetClientAttributesGetterTest {
 

diff --git a/.../opentelemetry/instrumentation/api/instrumenter/net/NetClientAttributesExtractorTest.java b/.../opentelemetry/instrumentation/api/instrumenter/net/NetClientAttributesExtractorTest.java
@@ -21,6 +21,7 @@
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 
+@SuppressWarnings("deprecation") // testing deprecated class
 class NetClientAttributesExtractorTest {
 
   static class TestNetClientAttributesGetter

diff --git a/...try/instrumentation/api/instrumenter/net/NetClientAttributesExtractorBothSemconvTest.java b/...try/instrumentation/api/instrumenter/net/NetClientAttributesExtractorBothSemconvTest.java
@@ -20,6 +20,7 @@
 import javax.annotation.Nullable;
 import org.junit.jupiter.api.Test;
 
+@SuppressWarnings("deprecation") // testing deprecated class
 class NetClientAttributesExtractorBothSemconvTest {
 
   static class TestNetClientAttributesGetter

diff --git a/...y/instrumentation/api/instrumenter/net/NetClientAttributesExtractorStableSemconvTest.java b/...y/instrumentation/api/instrumenter/net/NetClientAttributesExtractorStableSemconvTest.java
@@ -19,6 +19,7 @@
 import javax.annotation.Nullable;
 import org.junit.jupiter.api.Test;
 
+@SuppressWarnings("deprecation") // testing deprecated class
 class NetClientAttributesExtractorStableSemconvTest {
 
   static class TestNetClientAttributesGetter

diff --git a/...java/io/opentelemetry/javaagent/instrumentation/apachedubbo/v2_7/OpenTelemetryFilter.java b/...java/io/opentelemetry/javaagent/instrumentation/apachedubbo/v2_7/OpenTelemetryFilter.java
@@ -7,7 +7,7 @@
 
 import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.instrumentation.apachedubbo.v2_7.DubboTelemetry;
-import io.opentelemetry.instrumentation.apachedubbo.v2_7.internal.DubboNetClientAttributesGetter;
+import io.opentelemetry.instrumentation.apachedubbo.v2_7.internal.DubboClientNetworkAttributesGetter;
 import io.opentelemetry.instrumentation.api.instrumenter.net.PeerServiceAttributesExtractor;
 import io.opentelemetry.javaagent.bootstrap.internal.CommonConfig;
 import org.apache.dubbo.common.extension.Activate;
@@ -26,7 +26,7 @@ public OpenTelemetryFilter() {
         DubboTelemetry.builder(GlobalOpenTelemetry.get())
             .addAttributesExtractor(
                 PeerServiceAttributesExtractor.create(
-                    new DubboNetClientAttributesGetter(),
+                    new DubboClientNetworkAttributesGetter(),
                     CommonConfig.get().getPeerServiceMapping()))
             .build()
             .newFilter();

diff --git a/...rc/main/java/io/opentelemetry/instrumentation/apachedubbo/v2_7/DubboTelemetryBuilder.java b/...rc/main/java/io/opentelemetry/instrumentation/apachedubbo/v2_7/DubboTelemetryBuilder.java
@@ -7,12 +7,11 @@
 
 import com.google.errorprone.annotations.CanIgnoreReturnValue;
 import io.opentelemetry.api.OpenTelemetry;
-import io.opentelemetry.instrumentation.apachedubbo.v2_7.internal.DubboNetClientAttributesGetter;
+import io.opentelemetry.instrumentation.apachedubbo.v2_7.internal.DubboClientNetworkAttributesGetter;
 import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
 import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter;
 import io.opentelemetry.instrumentation.api.instrumenter.InstrumenterBuilder;
 import io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor;
-import io.opentelemetry.instrumentation.api.instrumenter.net.NetClientAttributesExtractor;
 import io.opentelemetry.instrumentation.api.instrumenter.network.ClientAttributesExtractor;
 import io.opentelemetry.instrumentation.api.instrumenter.network.ServerAttributesExtractor;
 import io.opentelemetry.instrumentation.api.instrumenter.rpc.RpcClientAttributesExtractor;
@@ -62,7 +61,8 @@ public DubboTelemetry build() {
     DubboRpcAttributesGetter rpcAttributesGetter = DubboRpcAttributesGetter.INSTANCE;
     SpanNameExtractor<DubboRequest> spanNameExtractor =
         RpcSpanNameExtractor.create(rpcAttributesGetter);
-    DubboNetClientAttributesGetter netClientAttributesGetter = new DubboNetClientAttributesGetter();
+    DubboClientNetworkAttributesGetter netClientAttributesGetter =
+        new DubboClientNetworkAttributesGetter();
     DubboNetworkServerAttributesGetter netServerAttributesGetter =
         new DubboNetworkServerAttributesGetter();
 
@@ -79,7 +79,7 @@ public DubboTelemetry build() {
         Instrumenter.<DubboRequest, Result>builder(
                 openTelemetry, INSTRUMENTATION_NAME, spanNameExtractor)
             .addAttributesExtractor(RpcClientAttributesExtractor.create(rpcAttributesGetter))
-            .addAttributesExtractor(NetClientAttributesExtractor.create(netClientAttributesGetter))
+            .addAttributesExtractor(ServerAttributesExtractor.create(netClientAttributesGetter))
             .addAttributesExtractors(attributesExtractors);
 
     if (peerService != null) {

diff --git a/...ernal/DubboNetClientAttributesGetter.java → ...l/DubboClientNetworkAttributesGetter.java b/...ernal/DubboNetClientAttributesGetter.java → ...l/DubboClientNetworkAttributesGetter.java
@@ -6,7 +6,7 @@
 package io.opentelemetry.instrumentation.apachedubbo.v2_7.internal;
 
 import io.opentelemetry.instrumentation.apachedubbo.v2_7.DubboRequest;
-import io.opentelemetry.instrumentation.api.instrumenter.net.NetClientAttributesGetter;
+import io.opentelemetry.instrumentation.api.instrumenter.network.ServerAttributesGetter;
 import java.net.InetSocketAddress;
 import javax.annotation.Nullable;
 import org.apache.dubbo.rpc.Result;
@@ -15,8 +15,8 @@
  * This class is internal and is hence not for public use. Its APIs are unstable and can change at
  * any time.
  */
-public final class DubboNetClientAttributesGetter
-    implements NetClientAttributesGetter<DubboRequest, Result> {
+public final class DubboClientNetworkAttributesGetter
+    implements ServerAttributesGetter<DubboRequest, Result> {
 
   @Nullable
   @Override

diff --git a/...ra/v3_0/CassandraNetAttributesGetter.java → ...3_0/CassandraNetworkAttributesGetter.java b/...ra/v3_0/CassandraNetAttributesGetter.java → ...3_0/CassandraNetworkAttributesGetter.java
@@ -6,24 +6,12 @@
 package io.opentelemetry.javaagent.instrumentation.cassandra.v3_0;
 
 import com.datastax.driver.core.ExecutionInfo;
-import io.opentelemetry.instrumentation.api.instrumenter.net.NetClientAttributesGetter;
+import io.opentelemetry.instrumentation.api.instrumenter.network.ServerAttributesGetter;
 import java.net.InetSocketAddress;
 import javax.annotation.Nullable;
 
-final class CassandraNetAttributesGetter
-    implements NetClientAttributesGetter<CassandraRequest, ExecutionInfo> {
-
-  @Nullable
-  @Override
-  public String getServerAddress(CassandraRequest request) {
-    return null;
-  }
-
-  @Nullable
-  @Override
-  public Integer getServerPort(CassandraRequest request) {
-    return null;
-  }
+final class CassandraNetworkAttributesGetter
+    implements ServerAttributesGetter<CassandraRequest, ExecutionInfo> {
 
   @Override
   @Nullable

diff --git a/...n/java/io/opentelemetry/javaagent/instrumentation/cassandra/v3_0/CassandraSingletons.java b/...n/java/io/opentelemetry/javaagent/instrumentation/cassandra/v3_0/CassandraSingletons.java
@@ -11,7 +11,7 @@
 import io.opentelemetry.instrumentation.api.instrumenter.SpanKindExtractor;
 import io.opentelemetry.instrumentation.api.instrumenter.db.DbClientSpanNameExtractor;
 import io.opentelemetry.instrumentation.api.instrumenter.db.SqlClientAttributesExtractor;
-import io.opentelemetry.instrumentation.api.instrumenter.net.NetClientAttributesExtractor;
+import io.opentelemetry.instrumentation.api.instrumenter.network.ServerAttributesExtractor;
 import io.opentelemetry.javaagent.bootstrap.internal.CommonConfig;
 import io.opentelemetry.semconv.trace.attributes.SemanticAttributes;
 
@@ -37,7 +37,7 @@ public final class CassandraSingletons {
                         CommonConfig.get().isStatementSanitizationEnabled())
                     .build())
             .addAttributesExtractor(
-                NetClientAttributesExtractor.create(new CassandraNetAttributesGetter()))
+                ServerAttributesExtractor.create(new CassandraNetworkAttributesGetter()))
             .buildInstrumenter(SpanKindExtractor.alwaysClient());
   }
 

diff --git a/...ra/v4_0/CassandraNetAttributesGetter.java → ...4_0/CassandraNetworkAttributesGetter.java b/...ra/v4_0/CassandraNetAttributesGetter.java → ...4_0/CassandraNetworkAttributesGetter.java
@@ -7,25 +7,13 @@
 
 import com.datastax.oss.driver.api.core.cql.ExecutionInfo;
 import com.datastax.oss.driver.api.core.metadata.Node;
-import io.opentelemetry.instrumentation.api.instrumenter.net.NetClientAttributesGetter;
+import io.opentelemetry.instrumentation.api.instrumenter.network.ServerAttributesGetter;
 import java.net.InetSocketAddress;
 import java.net.SocketAddress;
 import javax.annotation.Nullable;
 
-final class CassandraNetAttributesGetter
-    implements NetClientAttributesGetter<CassandraRequest, ExecutionInfo> {
-
-  @Nullable
-  @Override
-  public String getServerAddress(CassandraRequest request) {
-    return null;
-  }
-
-  @Nullable
-  @Override
-  public Integer getServerPort(CassandraRequest request) {
-    return null;
-  }
+final class CassandraNetworkAttributesGetter
+    implements ServerAttributesGetter<CassandraRequest, ExecutionInfo> {
 
   @Override
   @Nullable

diff --git a/...n/java/io/opentelemetry/javaagent/instrumentation/cassandra/v4_0/CassandraSingletons.java b/...n/java/io/opentelemetry/javaagent/instrumentation/cassandra/v4_0/CassandraSingletons.java
@@ -11,7 +11,7 @@
 import io.opentelemetry.instrumentation.api.instrumenter.SpanKindExtractor;
 import io.opentelemetry.instrumentation.api.instrumenter.db.DbClientSpanNameExtractor;
 import io.opentelemetry.instrumentation.api.instrumenter.db.SqlClientAttributesExtractor;
-import io.opentelemetry.instrumentation.api.instrumenter.net.NetClientAttributesExtractor;
+import io.opentelemetry.instrumentation.api.instrumenter.network.ServerAttributesExtractor;
 import io.opentelemetry.javaagent.bootstrap.internal.CommonConfig;
 import io.opentelemetry.semconv.trace.attributes.SemanticAttributes;
 
@@ -36,7 +36,7 @@ public final class CassandraSingletons {
                         CommonConfig.get().isStatementSanitizationEnabled())
                     .build())
             .addAttributesExtractor(
-                NetClientAttributesExtractor.create(new CassandraNetAttributesGetter()))
+                ServerAttributesExtractor.create(new CassandraNetworkAttributesGetter()))
             .addAttributesExtractor(new CassandraAttributesExtractor())
             .buildInstrumenter(SpanKindExtractor.alwaysClient());
   }

diff --git a/...ra/v4_4/CassandraNetAttributesGetter.java → ...4_4/CassandraNetworkAttributesGetter.java b/...ra/v4_4/CassandraNetAttributesGetter.java → ...4_4/CassandraNetworkAttributesGetter.java
@@ -7,25 +7,13 @@
 
 import com.datastax.oss.driver.api.core.cql.ExecutionInfo;
 import com.datastax.oss.driver.api.core.metadata.Node;
-import io.opentelemetry.instrumentation.api.instrumenter.net.NetClientAttributesGetter;
+import io.opentelemetry.instrumentation.api.instrumenter.network.ServerAttributesGetter;
 import java.net.InetSocketAddress;
 import java.net.SocketAddress;
 import javax.annotation.Nullable;
 
-final class CassandraNetAttributesGetter
-    implements NetClientAttributesGetter<CassandraRequest, ExecutionInfo> {
-
-  @Nullable
-  @Override
-  public String getServerAddress(CassandraRequest request) {
-    return null;
-  }
-
-  @Nullable
-  @Override
-  public Integer getServerPort(CassandraRequest request) {
-    return null;
-  }
+final class CassandraNetworkAttributesGetter
+    implements ServerAttributesGetter<CassandraRequest, ExecutionInfo> {
 
   @Override
   @Nullable