use DefaultHttpClientInstrumenterBuilder and DefaultHttpServerInstrum…

…enterBuilder for armeria (#11797) Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
open-telemetry · Aug 15, 2024 · b00ccd7 · b00ccd7
1 parent 023f30c
commit b00ccd7
Show file tree

Hide file tree

Showing 21 changed files with 289 additions and 214 deletions.
diff --git a/.../instrumentation/api/incubator/builder/internal/DefaultHttpClientInstrumenterBuilder.java b/.../instrumentation/api/incubator/builder/internal/DefaultHttpClientInstrumenterBuilder.java
@@ -7,6 +7,7 @@
 
 import com.google.errorprone.annotations.CanIgnoreReturnValue;
 import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.context.propagation.TextMapSetter;
 import io.opentelemetry.instrumentation.api.incubator.config.internal.CommonConfig;
 import io.opentelemetry.instrumentation.api.incubator.semconv.http.HttpClientExperimentalMetrics;
@@ -18,6 +19,7 @@
 import io.opentelemetry.instrumentation.api.instrumenter.InstrumenterBuilder;
 import io.opentelemetry.instrumentation.api.instrumenter.SpanKindExtractor;
 import io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor;
+import io.opentelemetry.instrumentation.api.instrumenter.SpanStatusExtractor;
 import io.opentelemetry.instrumentation.api.semconv.http.HttpClientAttributesExtractor;
 import io.opentelemetry.instrumentation.api.semconv.http.HttpClientAttributesExtractorBuilder;
 import io.opentelemetry.instrumentation.api.semconv.http.HttpClientAttributesGetter;
@@ -39,18 +41,25 @@
  */
 public final class DefaultHttpClientInstrumenterBuilder<REQUEST, RESPONSE> {
 
+  // copied from PeerIncubatingAttributes
+  private static final AttributeKey<String> PEER_SERVICE = AttributeKey.stringKey("peer.service");
+
   private final String instrumentationName;
   private final OpenTelemetry openTelemetry;
 
   private final List<AttributesExtractor<? super REQUEST, ? super RESPONSE>> additionalExtractors =
       new ArrayList<>();
+  private Function<
+          SpanStatusExtractor<? super REQUEST, ? super RESPONSE>,
+          ? extends SpanStatusExtractor<? super REQUEST, ? super RESPONSE>>
+      statusExtractorTransformer = Function.identity();
   private final HttpClientAttributesExtractorBuilder<REQUEST, RESPONSE>
       httpAttributesExtractorBuilder;
   private final HttpClientAttributesGetter<REQUEST, RESPONSE> attributesGetter;
   private final HttpSpanNameExtractorBuilder<REQUEST> httpSpanNameExtractorBuilder;
 
   @Nullable private TextMapSetter<REQUEST> headerSetter;
-  private Function<SpanNameExtractor<REQUEST>, ? extends SpanNameExtractor<? super REQUEST>>
+  private Function<SpanNameExtractor<? super REQUEST>, ? extends SpanNameExtractor<? super REQUEST>>
       spanNameExtractorTransformer = Function.identity();
   private boolean emitExperimentalHttpClientMetrics = false;
   private Consumer<InstrumenterBuilder<REQUEST, RESPONSE>> builderCustomizer = b -> {};
@@ -77,6 +86,16 @@ public DefaultHttpClientInstrumenterBuilder<REQUEST, RESPONSE> addAttributeExtra
     return this;
   }
 
+  @CanIgnoreReturnValue
+  public DefaultHttpClientInstrumenterBuilder<REQUEST, RESPONSE> setStatusExtractor(
+      Function<
+              SpanStatusExtractor<? super REQUEST, ? super RESPONSE>,
+              ? extends SpanStatusExtractor<? super REQUEST, ? super RESPONSE>>
+          statusExtractor) {
+    this.statusExtractorTransformer = statusExtractor;
+    return this;
+  }
+
   /**
    * Configures the HTTP request headers that will be captured as span attributes.
    *
@@ -145,7 +164,7 @@ public DefaultHttpClientInstrumenterBuilder<REQUEST, RESPONSE> setHeaderSetter(
   /** Sets custom {@link SpanNameExtractor} via transform function. */
   @CanIgnoreReturnValue
   public DefaultHttpClientInstrumenterBuilder<REQUEST, RESPONSE> setSpanNameExtractor(
-      Function<SpanNameExtractor<REQUEST>, ? extends SpanNameExtractor<? super REQUEST>>
+      Function<SpanNameExtractor<? super REQUEST>, ? extends SpanNameExtractor<? super REQUEST>>
           spanNameExtractorTransformer) {
     this.spanNameExtractorTransformer = spanNameExtractorTransformer;
     return this;
@@ -159,6 +178,13 @@ public DefaultHttpClientInstrumenterBuilder<REQUEST, RESPONSE> setPeerServiceRes
         HttpClientPeerServiceAttributesExtractor.create(attributesGetter, peerServiceResolver));
   }
 
+  /** Sets the {@code peer.service} attribute for http client spans. */
+  @CanIgnoreReturnValue
+  public DefaultHttpClientInstrumenterBuilder<REQUEST, RESPONSE> setPeerService(
+      String peerService) {
+    return addAttributeExtractor(AttributesExtractor.constant(PEER_SERVICE, peerService));
+  }
+
   @CanIgnoreReturnValue
   public DefaultHttpClientInstrumenterBuilder<REQUEST, RESPONSE> setBuilderCustomizer(
       Consumer<InstrumenterBuilder<REQUEST, RESPONSE>> builderCustomizer) {
@@ -174,7 +200,8 @@ public Instrumenter<REQUEST, RESPONSE> build() {
     InstrumenterBuilder<REQUEST, RESPONSE> builder =
         Instrumenter.<REQUEST, RESPONSE>builder(
                 openTelemetry, instrumentationName, spanNameExtractor)
-            .setSpanStatusExtractor(HttpSpanStatusExtractor.create(attributesGetter))
+            .setSpanStatusExtractor(
+                statusExtractorTransformer.apply(HttpSpanStatusExtractor.create(attributesGetter)))
             .addAttributesExtractor(httpAttributesExtractorBuilder.build())
             .addAttributesExtractors(additionalExtractors)
             .addOperationMetrics(HttpClientMetrics.get());

diff --git a/.../instrumentation/api/incubator/builder/internal/DefaultHttpServerInstrumenterBuilder.java b/.../instrumentation/api/incubator/builder/internal/DefaultHttpServerInstrumenterBuilder.java
@@ -54,7 +54,7 @@ public final class DefaultHttpServerInstrumenterBuilder<REQUEST, RESPONSE> {
   private final HttpSpanNameExtractorBuilder<REQUEST> httpSpanNameExtractorBuilder;
 
   @Nullable private TextMapGetter<REQUEST> headerGetter;
-  private Function<SpanNameExtractor<REQUEST>, ? extends SpanNameExtractor<? super REQUEST>>
+  private Function<SpanNameExtractor<? super REQUEST>, ? extends SpanNameExtractor<? super REQUEST>>
       spanNameExtractorTransformer = Function.identity();
   private final HttpServerRouteBuilder<REQUEST> httpServerRouteBuilder;
   private final HttpServerAttributesGetter<REQUEST, RESPONSE> attributesGetter;
@@ -162,7 +162,7 @@ public DefaultHttpServerInstrumenterBuilder<REQUEST, RESPONSE> setHeaderGetter(
   /** Sets custom {@link SpanNameExtractor} via transform function. */
   @CanIgnoreReturnValue
   public DefaultHttpServerInstrumenterBuilder<REQUEST, RESPONSE> setSpanNameExtractor(
-      Function<SpanNameExtractor<REQUEST>, ? extends SpanNameExtractor<? super REQUEST>>
+      Function<SpanNameExtractor<? super REQUEST>, ? extends SpanNameExtractor<? super REQUEST>>
           spanNameExtractorTransformer) {
     this.spanNameExtractorTransformer = spanNameExtractorTransformer;
     return this;

diff --git a/...opentelemetry/instrumentation/apachehttpclient/v4_3/ApacheHttpClientTelemetryBuilder.java b/...opentelemetry/instrumentation/apachehttpclient/v4_3/ApacheHttpClientTelemetryBuilder.java
@@ -98,7 +98,7 @@ public ApacheHttpClientTelemetryBuilder setEmitExperimentalHttpClientMetrics(
   @CanIgnoreReturnValue
   public ApacheHttpClientTelemetryBuilder setSpanNameExtractor(
       Function<
-              SpanNameExtractor<ApacheHttpClientRequest>,
+              SpanNameExtractor<? super ApacheHttpClientRequest>,
               ? extends SpanNameExtractor<? super ApacheHttpClientRequest>>
           spanNameExtractorTransformer) {
     builder.setSpanNameExtractor(spanNameExtractorTransformer);

diff --git a/...pentelemetry/instrumentation/apachehttpclient/v5_2/ApacheHttpClient5TelemetryBuilder.java b/...pentelemetry/instrumentation/apachehttpclient/v5_2/ApacheHttpClient5TelemetryBuilder.java
@@ -100,7 +100,7 @@ public ApacheHttpClient5TelemetryBuilder setEmitExperimentalHttpClientMetrics(
   @CanIgnoreReturnValue
   public ApacheHttpClient5TelemetryBuilder setSpanNameExtractor(
       Function<
-              SpanNameExtractor<ApacheHttpClient5Request>,
+              SpanNameExtractor<? super ApacheHttpClient5Request>,
               ? extends SpanNameExtractor<? super ApacheHttpClient5Request>>
           spanNameExtractorTransformer) {
     builder.setSpanNameExtractor(spanNameExtractorTransformer);

diff --git a/.../main/java/io/opentelemetry/javaagent/instrumentation/armeria/v1_3/ArmeriaSingletons.java b/.../main/java/io/opentelemetry/javaagent/instrumentation/armeria/v1_3/ArmeriaSingletons.java
@@ -8,9 +8,10 @@
 import com.linecorp.armeria.client.HttpClient;
 import com.linecorp.armeria.server.HttpService;
 import io.opentelemetry.api.GlobalOpenTelemetry;
-import io.opentelemetry.instrumentation.api.incubator.semconv.http.HttpClientPeerServiceAttributesExtractor;
+import io.opentelemetry.instrumentation.api.incubator.config.internal.CommonConfig;
 import io.opentelemetry.instrumentation.armeria.v1_3.ArmeriaTelemetry;
-import io.opentelemetry.instrumentation.armeria.v1_3.internal.ArmeriaHttpClientAttributesGetter;
+import io.opentelemetry.instrumentation.armeria.v1_3.ArmeriaTelemetryBuilder;
+import io.opentelemetry.instrumentation.armeria.v1_3.internal.ArmeriaInstrumenterBuilderUtil;
 import io.opentelemetry.javaagent.bootstrap.internal.AgentCommonConfig;
 import java.util.function.Function;
 
@@ -22,28 +23,15 @@ public final class ArmeriaSingletons {
   public static final Function<? super HttpService, ? extends HttpService> SERVER_DECORATOR;
 
   static {
-    ArmeriaTelemetry telemetry =
-        ArmeriaTelemetry.builder(GlobalOpenTelemetry.get())
-            .setCapturedClientRequestHeaders(AgentCommonConfig.get().getClientRequestHeaders())
-            .setCapturedClientResponseHeaders(AgentCommonConfig.get().getClientResponseHeaders())
-            .setCapturedServerRequestHeaders(AgentCommonConfig.get().getServerRequestHeaders())
-            .setCapturedServerResponseHeaders(AgentCommonConfig.get().getServerResponseHeaders())
-            .setKnownMethods(AgentCommonConfig.get().getKnownHttpRequestMethods())
-            .addClientAttributeExtractor(
-                HttpClientPeerServiceAttributesExtractor.create(
-                    ArmeriaHttpClientAttributesGetter.INSTANCE,
-                    AgentCommonConfig.get().getPeerServiceResolver()))
-            .setEmitExperimentalHttpClientMetrics(
-                AgentCommonConfig.get().shouldEmitExperimentalHttpClientTelemetry())
-            .setEmitExperimentalHttpServerMetrics(
-                AgentCommonConfig.get().shouldEmitExperimentalHttpServerTelemetry())
-            .build();
+    ArmeriaTelemetryBuilder builder = ArmeriaTelemetry.builder(GlobalOpenTelemetry.get());
+    CommonConfig config = AgentCommonConfig.get();
+    ArmeriaInstrumenterBuilderUtil.getClientBuilderExtractor().apply(builder).configure(config);
+    ArmeriaInstrumenterBuilderUtil.getServerBuilderExtractor().apply(builder).configure(config);
+    ArmeriaTelemetry telemetry = builder.build();
 
     CLIENT_DECORATOR = telemetry.newClientDecorator();
     Function<? super HttpService, ? extends HttpService> libraryDecorator =
-        telemetry
-            .newServiceDecorator()
-            .compose(service -> new ResponseCustomizingDecorator(service));
+        telemetry.newServiceDecorator().compose(ResponseCustomizingDecorator::new);
     SERVER_DECORATOR = service -> new ServerDecorator(service, libraryDecorator.apply(service));
   }