Move extractFromRequest() to internal (#6585)

* Move extractFromRequest() to internal * Javadoc
open-telemetry · Sep 12, 2022 · 54c41f7 · 54c41f7
1 parent 1ab6265
commit 54c41f7
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 19 deletions.
diff --git a/...i/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/SpanLinksExtractor.java b/...i/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/SpanLinksExtractor.java
@@ -7,8 +7,6 @@
 
 import io.opentelemetry.api.trace.SpanContext;
 import io.opentelemetry.context.Context;
-import io.opentelemetry.context.propagation.TextMapGetter;
-import io.opentelemetry.context.propagation.TextMapPropagator;
 
 /** Extractor of span links for a request. */
 @FunctionalInterface
@@ -19,13 +17,4 @@ public interface SpanLinksExtractor<REQUEST> {
    * {@code spanLinks}.
    */
   void extract(SpanLinksBuilder spanLinks, Context parentContext, REQUEST request);
-
-  /**
-   * Returns a new {@link SpanLinksExtractor} that will extract a {@link SpanContext} from the
-   * request using configured {@link TextMapPropagator}.
-   */
-  static <REQUEST> SpanLinksExtractor<REQUEST> extractFromRequest(
-      TextMapPropagator propagator, TextMapGetter<REQUEST> getter) {
-    return new PropagatorBasedSpanLinksExtractor<>(propagator, getter);
-  }
 }
diff --git a/...er/PropagatorBasedSpanLinksExtractor.java → ...al/PropagatorBasedSpanLinksExtractor.java b/...er/PropagatorBasedSpanLinksExtractor.java → ...al/PropagatorBasedSpanLinksExtractor.java
@@ -3,18 +3,27 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.api.instrumenter;
+package io.opentelemetry.instrumentation.api.internal;
 
 import io.opentelemetry.api.trace.Span;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.context.propagation.TextMapGetter;
 import io.opentelemetry.context.propagation.TextMapPropagator;
+import io.opentelemetry.instrumentation.api.instrumenter.SpanLinksBuilder;
+import io.opentelemetry.instrumentation.api.instrumenter.SpanLinksExtractor;
+
+/**
+ * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+ * any time.
+ */
+public final class PropagatorBasedSpanLinksExtractor<REQUEST>
+    implements SpanLinksExtractor<REQUEST> {
 
-final class PropagatorBasedSpanLinksExtractor<REQUEST> implements SpanLinksExtractor<REQUEST> {
   private final TextMapPropagator propagator;
   private final TextMapGetter<REQUEST> getter;
 
-  PropagatorBasedSpanLinksExtractor(TextMapPropagator propagator, TextMapGetter<REQUEST> getter) {
+  public PropagatorBasedSpanLinksExtractor(
+      TextMapPropagator propagator, TextMapGetter<REQUEST> getter) {
     this.propagator = propagator;
     this.getter = getter;
   }

diff --git a/...opentelemetry/instrumentation/api/instrumenter/PropagatorBasedSpanLinksExtractorTest.java b/...opentelemetry/instrumentation/api/instrumenter/PropagatorBasedSpanLinksExtractorTest.java
@@ -17,6 +17,7 @@
 import io.opentelemetry.context.Context;
 import io.opentelemetry.context.propagation.TextMapGetter;
 import io.opentelemetry.context.propagation.TextMapPropagator;
+import io.opentelemetry.instrumentation.api.internal.PropagatorBasedSpanLinksExtractor;
 import java.util.Map;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
@@ -36,7 +37,7 @@ void shouldExtractSpanLink() {
     TextMapPropagator propagator = W3CTraceContextPropagator.getInstance();
 
     SpanLinksExtractor<Map<String, String>> underTest =
-        SpanLinksExtractor.extractFromRequest(propagator, new MapGetter());
+        new PropagatorBasedSpanLinksExtractor<>(propagator, new MapGetter());
 
     Map<String, String> request =
         singletonMap("traceparent", String.format("00-%s-%s-01", TRACE_ID, SPAN_ID));

diff --git a/.../io/opentelemetry/instrumentation/kafka/internal/KafkaBatchProcessSpanLinksExtractor.java b/.../io/opentelemetry/instrumentation/kafka/internal/KafkaBatchProcessSpanLinksExtractor.java
@@ -9,6 +9,7 @@
 import io.opentelemetry.context.propagation.TextMapPropagator;
 import io.opentelemetry.instrumentation.api.instrumenter.SpanLinksBuilder;
 import io.opentelemetry.instrumentation.api.instrumenter.SpanLinksExtractor;
+import io.opentelemetry.instrumentation.api.internal.PropagatorBasedSpanLinksExtractor;
 import org.apache.kafka.clients.consumer.ConsumerRecord;
 import org.apache.kafka.clients.consumer.ConsumerRecords;
 
@@ -19,7 +20,7 @@ final class KafkaBatchProcessSpanLinksExtractor
 
   KafkaBatchProcessSpanLinksExtractor(TextMapPropagator propagator) {
     this.singleRecordLinkExtractor =
-        SpanLinksExtractor.extractFromRequest(propagator, KafkaConsumerRecordGetter.INSTANCE);
+        new PropagatorBasedSpanLinksExtractor<>(propagator, KafkaConsumerRecordGetter.INSTANCE);
   }
 
   @Override

diff --git a/...c/main/java/io/opentelemetry/instrumentation/kafka/internal/KafkaInstrumenterFactory.java b/...c/main/java/io/opentelemetry/instrumentation/kafka/internal/KafkaInstrumenterFactory.java
@@ -13,11 +13,11 @@
 import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter;
 import io.opentelemetry.instrumentation.api.instrumenter.InstrumenterBuilder;
 import io.opentelemetry.instrumentation.api.instrumenter.SpanKindExtractor;
-import io.opentelemetry.instrumentation.api.instrumenter.SpanLinksExtractor;
 import io.opentelemetry.instrumentation.api.instrumenter.messaging.MessageOperation;
 import io.opentelemetry.instrumentation.api.instrumenter.messaging.MessagingAttributesExtractor;
 import io.opentelemetry.instrumentation.api.instrumenter.messaging.MessagingAttributesGetter;
 import io.opentelemetry.instrumentation.api.instrumenter.messaging.MessagingSpanNameExtractor;
+import io.opentelemetry.instrumentation.api.internal.PropagatorBasedSpanLinksExtractor;
 import java.util.Collections;
 import java.util.List;
 import org.apache.kafka.clients.consumer.ConsumerRecord;
@@ -135,7 +135,7 @@ public KafkaInstrumenterFactory setMessagingReceiveInstrumentationEnabled(
       return builder.buildInstrumenter(SpanKindExtractor.alwaysConsumer());
     } else if (messagingReceiveInstrumentationEnabled) {
       builder.addSpanLinksExtractor(
-          SpanLinksExtractor.extractFromRequest(
+          new PropagatorBasedSpanLinksExtractor<ConsumerRecord<?, ?>>(
               openTelemetry.getPropagators().getTextMapPropagator(),
               KafkaConsumerRecordGetter.INSTANCE));
       return builder.buildInstrumenter(SpanKindExtractor.alwaysConsumer());

diff --git a/.../src/main/java/io/opentelemetry/instrumentation/rocketmq/RocketMqInstrumenterFactory.java b/.../src/main/java/io/opentelemetry/instrumentation/rocketmq/RocketMqInstrumenterFactory.java
@@ -18,6 +18,7 @@
 import io.opentelemetry.instrumentation.api.instrumenter.messaging.MessagingAttributesExtractor;
 import io.opentelemetry.instrumentation.api.instrumenter.messaging.MessagingAttributesGetter;
 import io.opentelemetry.instrumentation.api.instrumenter.messaging.MessagingSpanNameExtractor;
+import io.opentelemetry.instrumentation.api.internal.PropagatorBasedSpanLinksExtractor;
 import java.util.List;
 import org.apache.rocketmq.client.hook.SendMessageContext;
 import org.apache.rocketmq.common.message.MessageExt;
@@ -110,7 +111,7 @@ private static Instrumenter<MessageExt, Void> createProcessInstrumenter(
 
     if (batch) {
       SpanLinksExtractor<MessageExt> spanLinksExtractor =
-          SpanLinksExtractor.extractFromRequest(
+          new PropagatorBasedSpanLinksExtractor<>(
               openTelemetry.getPropagators().getTextMapPropagator(),
               TextMapExtractAdapter.INSTANCE);