Convert AttributesExtractor to interface (open-telemetry#4363)

RashmiRam · May 23, 2022 · 0426b65 · 0426b65
1 parent 40f43bb
commit 0426b65
Show file tree

Hide file tree

Showing 41 changed files with 120 additions and 119 deletions.
diff --git a/...o/opentelemetry/instrumentation/api/annotation/support/MethodSpanAttributesExtractor.java b/...o/opentelemetry/instrumentation/api/annotation/support/MethodSpanAttributesExtractor.java
@@ -15,7 +15,7 @@
 
 /** Extractor of {@link io.opentelemetry.api.common.Attributes} for a traced method. */
 public final class MethodSpanAttributesExtractor<REQUEST, RESPONSE>
-    extends AttributesExtractor<REQUEST, RESPONSE> {
+    implements AttributesExtractor<REQUEST, RESPONSE> {
 
   private final MethodExtractor<REQUEST> methodExtractor;
   private final MethodArgumentsExtractor<REQUEST> methodArgumentsExtractor;
@@ -46,7 +46,7 @@ public static <REQUEST, RESPONSE> MethodSpanAttributesExtractor<REQUEST, RESPONS
   }
 
   @Override
-  protected void onStart(AttributesBuilder attributes, REQUEST request) {
+  public void onStart(AttributesBuilder attributes, REQUEST request) {
     Method method = methodExtractor.extract(request);
     AttributeBindings bindings = cache.computeIfAbsent(method, this::bind);
     if (!bindings.isEmpty()) {
@@ -56,7 +56,7 @@ protected void onStart(AttributesBuilder attributes, REQUEST request) {
   }
 
   @Override
-  protected void onEnd(
+  public void onEnd(
       AttributesBuilder attributes,
       REQUEST request,
       @Nullable RESPONSE response,

diff --git a/.../src/main/java/io/opentelemetry/instrumentation/api/instrumenter/AttributesExtractor.java b/.../src/main/java/io/opentelemetry/instrumentation/api/instrumenter/AttributesExtractor.java
@@ -24,18 +24,18 @@
  * @see HttpClientAttributesExtractor
  * @see NetServerAttributesExtractor
  */
-public abstract class AttributesExtractor<REQUEST, RESPONSE> {
+public interface AttributesExtractor<REQUEST, RESPONSE> {
   /**
    * Extracts attributes from the {@link REQUEST} into the {@link AttributesBuilder} at the
    * beginning of a request.
    */
-  protected abstract void onStart(AttributesBuilder attributes, REQUEST request);
+  void onStart(AttributesBuilder attributes, REQUEST request);
 
   /**
    * Extracts attributes from the {@link REQUEST} and either {@link RESPONSE} or {@code error} into
    * the {@link AttributesBuilder} at the end of a request.
    */
-  protected abstract void onEnd(
+  void onEnd(
       AttributesBuilder attributes,
       REQUEST request,
       @Nullable RESPONSE response,
@@ -45,8 +45,7 @@ protected abstract void onEnd(
    * Sets the {@code value} with the given {@code key} to the {@link AttributesBuilder} if {@code
    * value} is not {@code null}.
    */
-  protected static <T> void set(
-      AttributesBuilder attributes, AttributeKey<T> key, @Nullable T value) {
+  default <T> void set(AttributesBuilder attributes, AttributeKey<T> key, @Nullable T value) {
     if (value != null) {
       attributes.put(key, value);
     }
@@ -56,7 +55,7 @@ protected static <T> void set(
    * Returns an {@link AttributesExtractor} implementation that always extracts the provided
    * constant value.
    */
-  public static <REQUEST, RESPONSE, T> AttributesExtractor<REQUEST, RESPONSE> constant(
+  static <REQUEST, RESPONSE, T> AttributesExtractor<REQUEST, RESPONSE> constant(
       AttributeKey<T> attributeKey, T attributeValue) {
     return new ConstantAttributesExtractor<>(attributeKey, attributeValue);
   }

diff --git a/...n/java/io/opentelemetry/instrumentation/api/instrumenter/ConstantAttributesExtractor.java b/...n/java/io/opentelemetry/instrumentation/api/instrumenter/ConstantAttributesExtractor.java
@@ -10,7 +10,7 @@
 import org.checkerframework.checker.nullness.qual.Nullable;
 
 final class ConstantAttributesExtractor<REQUEST, RESPONSE, T>
-    extends AttributesExtractor<REQUEST, RESPONSE> {
+    implements AttributesExtractor<REQUEST, RESPONSE> {
 
   private final AttributeKey<T> attributeKey;
   private final T attributeValue;
@@ -21,12 +21,12 @@ final class ConstantAttributesExtractor<REQUEST, RESPONSE, T>
   }
 
   @Override
-  protected void onStart(AttributesBuilder attributes, REQUEST request) {
+  public void onStart(AttributesBuilder attributes, REQUEST request) {
     attributes.put(attributeKey, attributeValue);
   }
 
   @Override
-  protected void onEnd(
+  public void onEnd(
       AttributesBuilder attributes,
       REQUEST request,
       @Nullable RESPONSE response,

diff --git a/...ava/io/opentelemetry/instrumentation/api/instrumenter/PeerServiceAttributesExtractor.java b/...ava/io/opentelemetry/instrumentation/api/instrumenter/PeerServiceAttributesExtractor.java
@@ -22,7 +22,7 @@
  * comma-separated list of {@code host=name} pairs.
  */
 public final class PeerServiceAttributesExtractor<REQUEST, RESPONSE>
-    extends AttributesExtractor<REQUEST, RESPONSE> {
+    implements AttributesExtractor<REQUEST, RESPONSE> {
   private static final Map<String, String> JAVAAGENT_PEER_SERVICE_MAPPING =
       Config.get().getMap("otel.instrumentation.common.peer-service-mapping");
 
@@ -48,10 +48,10 @@ public static <REQUEST, RESPONSE> PeerServiceAttributesExtractor<REQUEST, RESPON
   }
 
   @Override
-  protected void onStart(AttributesBuilder attributes, REQUEST request) {}
+  public void onStart(AttributesBuilder attributes, REQUEST request) {}
 
   @Override
-  protected void onEnd(
+  public void onEnd(
       AttributesBuilder attributes,
       REQUEST request,
       @Nullable RESPONSE response,

diff --git a/.../java/io/opentelemetry/instrumentation/api/instrumenter/code/CodeAttributesExtractor.java b/.../java/io/opentelemetry/instrumentation/api/instrumenter/code/CodeAttributesExtractor.java
@@ -16,10 +16,10 @@
  * code attributes</a>.
  */
 public abstract class CodeAttributesExtractor<REQUEST, RESPONSE>
-    extends AttributesExtractor<REQUEST, RESPONSE> {
+    implements AttributesExtractor<REQUEST, RESPONSE> {
 
   @Override
-  protected final void onStart(AttributesBuilder attributes, REQUEST request) {
+  public final void onStart(AttributesBuilder attributes, REQUEST request) {
     Class<?> cls = codeClass(request);
     if (cls != null) {
       set(attributes, SemanticAttributes.CODE_NAMESPACE, cls.getName());
@@ -30,7 +30,7 @@ protected final void onStart(AttributesBuilder attributes, REQUEST request) {
   }
 
   @Override
-  protected final void onEnd(
+  public final void onEnd(
       AttributesBuilder attributes,
       REQUEST request,
       @Nullable RESPONSE response,

diff --git a/...main/java/io/opentelemetry/instrumentation/api/instrumenter/db/DbAttributesExtractor.java b/...main/java/io/opentelemetry/instrumentation/api/instrumenter/db/DbAttributesExtractor.java
@@ -20,9 +20,9 @@
  * specification.
  */
 public abstract class DbAttributesExtractor<REQUEST, RESPONSE>
-    extends AttributesExtractor<REQUEST, RESPONSE> {
+    implements AttributesExtractor<REQUEST, RESPONSE> {
   @Override
-  protected void onStart(AttributesBuilder attributes, REQUEST request) {
+  public void onStart(AttributesBuilder attributes, REQUEST request) {
     set(attributes, SemanticAttributes.DB_SYSTEM, system(request));
     set(attributes, SemanticAttributes.DB_USER, user(request));
     set(attributes, SemanticAttributes.DB_NAME, name(request));
@@ -32,7 +32,7 @@ protected void onStart(AttributesBuilder attributes, REQUEST request) {
   }
 
   @Override
-  protected final void onEnd(
+  public final void onEnd(
       AttributesBuilder attributes,
       REQUEST request,
       @Nullable RESPONSE response,

diff --git a/...ain/java/io/opentelemetry/instrumentation/api/instrumenter/db/SqlAttributesExtractor.java b/...ain/java/io/opentelemetry/instrumentation/api/instrumenter/db/SqlAttributesExtractor.java
@@ -26,7 +26,7 @@ public abstract class SqlAttributesExtractor<REQUEST, RESPONSE>
     extends DbAttributesExtractor<REQUEST, RESPONSE> {
 
   @Override
-  protected final void onStart(AttributesBuilder attributes, REQUEST request) {
+  public final void onStart(AttributesBuilder attributes, REQUEST request) {
     super.onStart(attributes, request);
     AttributeKey<String> dbTable = dbTableAttribute();
     if (dbTable != null) {

diff --git a/...io/opentelemetry/instrumentation/api/instrumenter/http/HttpClientAttributesExtractor.java b/...io/opentelemetry/instrumentation/api/instrumenter/http/HttpClientAttributesExtractor.java
@@ -40,13 +40,13 @@ protected HttpClientAttributesExtractor() {
   }
 
   @Override
-  protected final void onStart(AttributesBuilder attributes, REQUEST request) {
+  public final void onStart(AttributesBuilder attributes, REQUEST request) {
     super.onStart(attributes, request);
     set(attributes, SemanticAttributes.HTTP_URL, url(request));
   }
 
   @Override
-  protected final void onEnd(
+  public final void onEnd(
       AttributesBuilder attributes,
       REQUEST request,
       @Nullable RESPONSE response,

diff --git a/...io/opentelemetry/instrumentation/api/instrumenter/http/HttpCommonAttributesExtractor.java b/...io/opentelemetry/instrumentation/api/instrumenter/http/HttpCommonAttributesExtractor.java
@@ -22,7 +22,7 @@
  * attributes</a> that are common to client and server instrumentations.
  */
 public abstract class HttpCommonAttributesExtractor<REQUEST, RESPONSE>
-    extends AttributesExtractor<REQUEST, RESPONSE> {
+    implements AttributesExtractor<REQUEST, RESPONSE> {
 
   private final CapturedHttpHeaders capturedHttpHeaders;
 
@@ -31,7 +31,7 @@ public abstract class HttpCommonAttributesExtractor<REQUEST, RESPONSE>
   }
 
   @Override
-  protected void onStart(AttributesBuilder attributes, REQUEST request) {
+  public void onStart(AttributesBuilder attributes, REQUEST request) {
     set(attributes, SemanticAttributes.HTTP_METHOD, method(request));
     set(attributes, SemanticAttributes.HTTP_USER_AGENT, userAgent(request));
 
@@ -44,7 +44,7 @@ protected void onStart(AttributesBuilder attributes, REQUEST request) {
   }
 
   @Override
-  protected void onEnd(
+  public void onEnd(
       AttributesBuilder attributes,
       REQUEST request,
       @Nullable RESPONSE response,

diff --git a/...io/opentelemetry/instrumentation/api/instrumenter/http/HttpServerAttributesExtractor.java b/...io/opentelemetry/instrumentation/api/instrumenter/http/HttpServerAttributesExtractor.java
@@ -43,7 +43,7 @@ protected HttpServerAttributesExtractor() {
   }
 
   @Override
-  protected final void onStart(AttributesBuilder attributes, REQUEST request) {
+  public final void onStart(AttributesBuilder attributes, REQUEST request) {
     super.onStart(attributes, request);
 
     set(attributes, SemanticAttributes.HTTP_FLAVOR, flavor(request));
@@ -55,7 +55,7 @@ protected final void onStart(AttributesBuilder attributes, REQUEST request) {
   }
 
   @Override
-  protected final void onEnd(
+  public final void onEnd(
       AttributesBuilder attributes,
       REQUEST request,
       @Nullable RESPONSE response,

diff --git a/...pentelemetry/instrumentation/api/instrumenter/messaging/MessagingAttributesExtractor.java b/...pentelemetry/instrumentation/api/instrumenter/messaging/MessagingAttributesExtractor.java
@@ -20,11 +20,11 @@
  * best compliance with the OpenTelemetry specification.
  */
 public abstract class MessagingAttributesExtractor<REQUEST, RESPONSE>
-    extends AttributesExtractor<REQUEST, RESPONSE> {
+    implements AttributesExtractor<REQUEST, RESPONSE> {
   public static final String TEMP_DESTINATION_NAME = "(temporary)";
 
   @Override
-  protected final void onStart(AttributesBuilder attributes, REQUEST request) {
+  public final void onStart(AttributesBuilder attributes, REQUEST request) {
     set(attributes, SemanticAttributes.MESSAGING_SYSTEM, system(request));
     set(attributes, SemanticAttributes.MESSAGING_DESTINATION_KIND, destinationKind(request));
     boolean isTemporaryDestination = temporaryDestination(request);
@@ -53,7 +53,7 @@ protected final void onStart(AttributesBuilder attributes, REQUEST request) {
   }
 
   @Override
-  protected final void onEnd(
+  public final void onEnd(
       AttributesBuilder attributes,
       REQUEST request,
       @Nullable RESPONSE response,

diff --git a/...a/io/opentelemetry/instrumentation/api/instrumenter/net/NetClientAttributesExtractor.java b/...a/io/opentelemetry/instrumentation/api/instrumenter/net/NetClientAttributesExtractor.java
@@ -17,13 +17,13 @@
  * it is more convenient to use {@link InetSocketAddressNetClientAttributesExtractor}.
  */
 public abstract class NetClientAttributesExtractor<REQUEST, RESPONSE>
-    extends AttributesExtractor<REQUEST, RESPONSE> {
+    implements AttributesExtractor<REQUEST, RESPONSE> {
 
   @Override
-  protected final void onStart(AttributesBuilder attributes, REQUEST request) {}
+  public final void onStart(AttributesBuilder attributes, REQUEST request) {}
 
   @Override
-  protected final void onEnd(
+  public final void onEnd(
       AttributesBuilder attributes,
       REQUEST request,
       @Nullable RESPONSE response,

diff --git a/...a/io/opentelemetry/instrumentation/api/instrumenter/net/NetServerAttributesExtractor.java b/...a/io/opentelemetry/instrumentation/api/instrumenter/net/NetServerAttributesExtractor.java
@@ -17,10 +17,10 @@
  * it is more convenient to use {@link InetSocketAddressNetServerAttributesExtractor}.
  */
 public abstract class NetServerAttributesExtractor<REQUEST, RESPONSE>
-    extends AttributesExtractor<REQUEST, RESPONSE> {
+    implements AttributesExtractor<REQUEST, RESPONSE> {
 
   @Override
-  protected final void onStart(AttributesBuilder attributes, REQUEST request) {
+  public final void onStart(AttributesBuilder attributes, REQUEST request) {
     set(attributes, SemanticAttributes.NET_TRANSPORT, transport(request));
 
     String peerIp = peerIp(request);
@@ -38,7 +38,7 @@ protected final void onStart(AttributesBuilder attributes, REQUEST request) {
   }
 
   @Override
-  protected final void onEnd(
+  public final void onEnd(
       AttributesBuilder attributes,
       REQUEST request,
       @Nullable RESPONSE response,

diff --git a/...in/java/io/opentelemetry/instrumentation/api/instrumenter/rpc/RpcAttributesExtractor.java b/...in/java/io/opentelemetry/instrumentation/api/instrumenter/rpc/RpcAttributesExtractor.java
@@ -20,17 +20,17 @@
  * specification.
  */
 public abstract class RpcAttributesExtractor<REQUEST, RESPONSE>
-    extends AttributesExtractor<REQUEST, RESPONSE> {
+    implements AttributesExtractor<REQUEST, RESPONSE> {
 
   @Override
-  protected final void onStart(AttributesBuilder attributes, REQUEST request) {
+  public final void onStart(AttributesBuilder attributes, REQUEST request) {
     set(attributes, SemanticAttributes.RPC_SYSTEM, system(request));
     set(attributes, SemanticAttributes.RPC_SERVICE, service(request));
     set(attributes, SemanticAttributes.RPC_METHOD, method(request));
   }
 
   @Override
-  protected final void onEnd(
+  public final void onEnd(
       AttributesBuilder attributes,
       REQUEST request,
       @Nullable RESPONSE response,

diff --git a/.../test/java/io/opentelemetry/instrumentation/api/instrumenter/AttributesExtractorTest.java b/.../test/java/io/opentelemetry/instrumentation/api/instrumenter/AttributesExtractorTest.java
@@ -19,16 +19,16 @@
 class AttributesExtractorTest {
 
   static class TestAttributesExtractor
-      extends AttributesExtractor<Map<String, String>, Map<String, String>> {
+      implements AttributesExtractor<Map<String, String>, Map<String, String>> {
 
     @Override
-    protected void onStart(AttributesBuilder attributes, Map<String, String> request) {
+    public void onStart(AttributesBuilder attributes, Map<String, String> request) {
       set(attributes, AttributeKey.stringKey("animal"), request.get("animal"));
       set(attributes, AttributeKey.stringKey("country"), request.get("country"));
     }
 
     @Override
-    protected void onEnd(
+    public void onEnd(
         AttributesBuilder attributes,
         Map<String, String> request,
         @Nullable Map<String, String> response,

diff --git a/...api/src/test/java/io/opentelemetry/instrumentation/api/instrumenter/InstrumenterTest.java b/...api/src/test/java/io/opentelemetry/instrumentation/api/instrumenter/InstrumenterTest.java
@@ -73,16 +73,16 @@ class InstrumenterTest {
               .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue)));
 
   static class AttributesExtractor1
-      extends AttributesExtractor<Map<String, String>, Map<String, String>> {
+      implements AttributesExtractor<Map<String, String>, Map<String, String>> {
 
     @Override
-    protected void onStart(AttributesBuilder attributes, Map<String, String> request) {
+    public void onStart(AttributesBuilder attributes, Map<String, String> request) {
       attributes.put("req1", request.get("req1"));
       attributes.put("req2", request.get("req2"));
     }
 
     @Override
-    protected void onEnd(
+    public void onEnd(
         AttributesBuilder attributes,
         Map<String, String> request,
         Map<String, String> response,
@@ -93,16 +93,16 @@ protected void onEnd(
   }
 
   static class AttributesExtractor2
-      extends AttributesExtractor<Map<String, String>, Map<String, String>> {
+      implements AttributesExtractor<Map<String, String>, Map<String, String>> {
 
     @Override
-    protected void onStart(AttributesBuilder attributes, Map<String, String> request) {
+    public void onStart(AttributesBuilder attributes, Map<String, String> request) {
       attributes.put("req3", request.get("req3"));
       attributes.put("req2", request.get("req2_2"));
     }
 
     @Override
-    protected void onEnd(
+    public void onEnd(
         AttributesBuilder attributes,
         Map<String, String> request,
         Map<String, String> response,

diff --git a/...nt/instrumentation/asynchttpclient/v2_0/AsyncHttpClientAdditionalAttributesExtractor.java b/...nt/instrumentation/asynchttpclient/v2_0/AsyncHttpClientAdditionalAttributesExtractor.java
@@ -13,13 +13,13 @@
 import org.checkerframework.checker.nullness.qual.Nullable;
 
 public class AsyncHttpClientAdditionalAttributesExtractor
-    extends AttributesExtractor<RequestContext, Response> {
+    implements AttributesExtractor<RequestContext, Response> {
 
   @Override
-  protected void onStart(AttributesBuilder attributes, RequestContext requestContext) {}
+  public void onStart(AttributesBuilder attributes, RequestContext requestContext) {}
 
   @Override
-  protected void onEnd(
+  public void onEnd(
       AttributesBuilder attributes,
       RequestContext requestContext,
       @Nullable Response response,