use delegation

Author: zeitlinger

instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/builder/AbstractHttpClientTelemetryBuilder.java renamed to instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/builder/DefaultHttpClientTelemetryBuilder.java

@@ -31,7 +31,8 @@
 import java.util.function.Consumer;
 import java.util.function.Function;
 
-public abstract class AbstractHttpClientTelemetryBuilder<SELF, REQUEST, RESPONSE> {
+public class DefaultHttpClientTelemetryBuilder<SELF, REQUEST, RESPONSE>
+    implements HttpClientTelemetryBuilder<SELF, REQUEST, RESPONSE> {
 
   private final String instrumentationName;
   protected final OpenTelemetry openTelemetry;
@@ -47,7 +48,7 @@ public abstract class AbstractHttpClientTelemetryBuilder<SELF, REQUEST, RESPONSE
       spanNameExtractorTransformer = Function.identity();
   private boolean emitExperimentalHttpClientMetrics = false;
 
-  public AbstractHttpClientTelemetryBuilder(
+  public DefaultHttpClientTelemetryBuilder(
       String instrumentationName,
       OpenTelemetry openTelemetry,
       HttpClientAttributesGetter<REQUEST, RESPONSE> attributesGetter,
@@ -60,72 +61,44 @@ public AbstractHttpClientTelemetryBuilder(
     this.headerSetter = headerSetter;
   }
 
-  /**
-   * Adds an additional {@link AttributesExtractor} to invoke to set attributes to instrumented
-   * items. The {@link AttributesExtractor} will be executed after all default extractors.
-   */
+  @Override
   @CanIgnoreReturnValue
   public SELF addAttributeExtractor(
       AttributesExtractor<? super REQUEST, ? super RESPONSE> attributesExtractor) {
     additionalExtractors.add(attributesExtractor);
     return self();
   }
 
-  /**
-   * Configures the HTTP request headers that will be captured as span attributes.
-   *
-   * @param requestHeaders A list of HTTP header names.
-   */
+  @Override
   @CanIgnoreReturnValue
   public SELF setCapturedRequestHeaders(List<String> requestHeaders) {
     httpAttributesExtractorBuilder.setCapturedRequestHeaders(requestHeaders);
     return self();
   }
 
-  /**
-   * Configures the HTTP response headers that will be captured as span attributes.
-   *
-   * @param responseHeaders A list of HTTP header names.
-   */
+  @Override
   @CanIgnoreReturnValue
   public SELF setCapturedResponseHeaders(List<String> responseHeaders) {
     httpAttributesExtractorBuilder.setCapturedResponseHeaders(responseHeaders);
     return self();
   }
 
-  /**
-   * Configures the instrumentation to recognize an alternative set of HTTP request methods.
-   *
-   * <p>By default, this instrumentation defines "known" methods as the ones listed in <a
-   * href="https://www.rfc-editor.org/rfc/rfc9110.html#name-methods">RFC9110</a> and the PATCH
-   * method defined in <a href="https://www.rfc-editor.org/rfc/rfc5789.html">RFC5789</a>.
-   *
-   * <p>Note: calling this method <b>overrides</b> the default known method sets completely; it does
-   * not supplement it.
-   *
-   * @param knownMethods A set of recognized HTTP request methods.
-   * @see HttpClientAttributesExtractorBuilder#setKnownMethods(Set)
-   */
+  @Override
   @CanIgnoreReturnValue
   public SELF setKnownMethods(Set<String> knownMethods) {
     httpAttributesExtractorBuilder.setKnownMethods(knownMethods);
     httpSpanNameExtractorBuilder.setKnownMethods(knownMethods);
     return self();
   }
 
-  /**
-   * Configures the instrumentation to emit experimental HTTP client metrics.
-   *
-   * @param emitExperimentalHttpClientMetrics {@code true} if the experimental HTTP client metrics
-   *     are to be emitted.
-   */
+  @Override
   @CanIgnoreReturnValue
   public SELF setEmitExperimentalHttpClientMetrics(boolean emitExperimentalHttpClientMetrics) {
     this.emitExperimentalHttpClientMetrics = emitExperimentalHttpClientMetrics;
     return self();
   }
 
-  /** Sets custom {@link SpanNameExtractor} via transform function. */
+  @Override
   @CanIgnoreReturnValue
   public SELF setSpanNameExtractor(
       Function<SpanNameExtractor<REQUEST>, ? extends SpanNameExtractor<? super REQUEST>>
@@ -174,4 +147,8 @@ public Instrumenter<REQUEST, RESPONSE> instrumenter(
   private SELF self() {
     return (SELF) this;
   }
+
+  public OpenTelemetry getOpenTelemetry() {
+    return openTelemetry;
+  }
 }

instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/builder/HttpClientTelemetryBuilder.java

@@ -0,0 +1,71 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.api.incubator.builder;
+
+import com.google.errorprone.annotations.CanIgnoreReturnValue;
+import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
+import io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor;
+import io.opentelemetry.instrumentation.api.semconv.http.HttpClientAttributesExtractorBuilder;
+import java.util.List;
+import java.util.Set;
+import java.util.function.Function;
+
+public interface HttpClientTelemetryBuilder<SELF, REQUEST, RESPONSE> {
+  /**
+   * Adds an additional {@link AttributesExtractor} to invoke to set attributes to instrumented
+   * items. The {@link AttributesExtractor} will be executed after all default extractors.
+   */
+  @CanIgnoreReturnValue
+  SELF addAttributeExtractor(
+      AttributesExtractor<? super REQUEST, ? super RESPONSE> attributesExtractor);
+
+  /**
+   * Configures the HTTP request headers that will be captured as span attributes.
+   *
+   * @param requestHeaders A list of HTTP header names.
+   */
+  @CanIgnoreReturnValue
+  SELF setCapturedRequestHeaders(List<String> requestHeaders);
+
+  /**
+   * Configures the HTTP response headers that will be captured as span attributes.
+   *
+   * @param responseHeaders A list of HTTP header names.
+   */
+  @CanIgnoreReturnValue
+  SELF setCapturedResponseHeaders(List<String> responseHeaders);
+
+  /**
+   * Configures the instrumentation to recognize an alternative set of HTTP request methods.
+   *
+   * <p>By default, this instrumentation defines "known" methods as the ones listed in <a
+   * href="https://www.rfc-editor.org/rfc/rfc9110.html#name-methods">RFC9110</a> and the PATCH
+   * method defined in <a href="https://www.rfc-editor.org/rfc/rfc5789.html">RFC5789</a>.
+   *
+   * <p>Note: calling this method <b>overrides</b> the default known method sets completely; it does
+   * not supplement it.
+   *
+   * @param knownMethods A set of recognized HTTP request methods.
+   * @see HttpClientAttributesExtractorBuilder#setKnownMethods(Set)
+   */
+  @CanIgnoreReturnValue
+  SELF setKnownMethods(Set<String> knownMethods);
+
+  /**
+   * Configures the instrumentation to emit experimental HTTP client metrics.
+   *
+   * @param emitExperimentalHttpClientMetrics {@code true} if the experimental HTTP client metrics
+   *     are to be emitted.
+   */
+  @CanIgnoreReturnValue
+  SELF setEmitExperimentalHttpClientMetrics(boolean emitExperimentalHttpClientMetrics);
+
+  /** Sets custom {@link SpanNameExtractor} via transform function. */
+  @CanIgnoreReturnValue
+  SELF setSpanNameExtractor(
+      Function<SpanNameExtractor<REQUEST>, ? extends SpanNameExtractor<? super REQUEST>>
+          spanNameExtractorTransformer);
+}

instrumentation/apache-httpclient/apache-httpclient-4.3/library/src/main/java/io/opentelemetry/instrumentation/apachehttpclient/v4_3/ApacheHttpClientTelemetryBuilder.java

@@ -5,24 +5,78 @@
 
 package io.opentelemetry.instrumentation.apachehttpclient.v4_3;
 
+import com.google.errorprone.annotations.CanIgnoreReturnValue;
 import io.opentelemetry.api.OpenTelemetry;
-import io.opentelemetry.instrumentation.api.incubator.builder.AbstractHttpClientTelemetryBuilder;
+import io.opentelemetry.instrumentation.api.incubator.builder.DefaultHttpClientTelemetryBuilder;
+import io.opentelemetry.instrumentation.api.incubator.builder.HttpClientTelemetryBuilder;
+import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
+import io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor;
+import java.util.List;
 import java.util.Optional;
+import java.util.Set;
+import java.util.function.Function;
 import org.apache.http.HttpResponse;
 
 /** A builder for {@link ApacheHttpClientTelemetry}. */
 public final class ApacheHttpClientTelemetryBuilder
-    extends AbstractHttpClientTelemetryBuilder<
+    implements HttpClientTelemetryBuilder<
         ApacheHttpClientTelemetryBuilder, ApacheHttpClientRequest, HttpResponse> {
 
   private static final String INSTRUMENTATION_NAME = "io.opentelemetry.apache-httpclient-4.3";
+  private final DefaultHttpClientTelemetryBuilder<
+          ApacheHttpClientTelemetryBuilder, ApacheHttpClientRequest, HttpResponse>
+      builder;
 
   ApacheHttpClientTelemetryBuilder(OpenTelemetry openTelemetry) {
-    super(
-        INSTRUMENTATION_NAME,
-        openTelemetry,
-        ApacheHttpClientHttpAttributesGetter.INSTANCE,
-        Optional.empty());
+    builder =
+        new DefaultHttpClientTelemetryBuilder<>(
+            INSTRUMENTATION_NAME,
+            openTelemetry,
+            ApacheHttpClientHttpAttributesGetter.INSTANCE,
+            Optional.empty());
+  }
+
+  @Override
+  @CanIgnoreReturnValue
+  public ApacheHttpClientTelemetryBuilder addAttributeExtractor(
+      AttributesExtractor<? super ApacheHttpClientRequest, ? super HttpResponse>
+          attributesExtractor) {
+    return builder.addAttributeExtractor(attributesExtractor);
+  }
+
+  @Override
+  @CanIgnoreReturnValue
+  public ApacheHttpClientTelemetryBuilder setCapturedRequestHeaders(List<String> requestHeaders) {
+    return builder.setCapturedRequestHeaders(requestHeaders);
+  }
+
+  @Override
+  @CanIgnoreReturnValue
+  public ApacheHttpClientTelemetryBuilder setCapturedResponseHeaders(List<String> responseHeaders) {
+    return builder.setCapturedResponseHeaders(responseHeaders);
+  }
+
+  @Override
+  @CanIgnoreReturnValue
+  public ApacheHttpClientTelemetryBuilder setKnownMethods(Set<String> knownMethods) {
+    return builder.setKnownMethods(knownMethods);
+  }
+
+  @Override
+  @CanIgnoreReturnValue
+  public ApacheHttpClientTelemetryBuilder setEmitExperimentalHttpClientMetrics(
+      boolean emitExperimentalHttpClientMetrics) {
+    return builder.setEmitExperimentalHttpClientMetrics(emitExperimentalHttpClientMetrics);
+  }
+
+  @Override
+  @CanIgnoreReturnValue
+  public ApacheHttpClientTelemetryBuilder setSpanNameExtractor(
+      Function<
+              SpanNameExtractor<ApacheHttpClientRequest>,
+              ? extends SpanNameExtractor<? super ApacheHttpClientRequest>>
+          spanNameExtractorTransformer) {
+    return builder.setSpanNameExtractor(spanNameExtractorTransformer);
   }
 
   /**
@@ -31,6 +85,7 @@ public final class ApacheHttpClientTelemetryBuilder
    */
   public ApacheHttpClientTelemetry build() {
     // We manually inject because we need to inject internal requests for redirects.
-    return new ApacheHttpClientTelemetry(instrumenter(), openTelemetry.getPropagators());
+    return new ApacheHttpClientTelemetry(
+        builder.instrumenter(), builder.getOpenTelemetry().getPropagators());
   }
 }

instrumentation/apache-httpclient/apache-httpclient-5.2/library/src/main/java/io/opentelemetry/instrumentation/apachehttpclient/v5_2/ApacheHttpClient5TelemetryBuilder.java

@@ -5,32 +5,88 @@
 
 package io.opentelemetry.instrumentation.apachehttpclient.v5_2;
 
+import com.google.errorprone.annotations.CanIgnoreReturnValue;
 import io.opentelemetry.api.OpenTelemetry;
-import io.opentelemetry.instrumentation.api.incubator.builder.AbstractHttpClientTelemetryBuilder;
+import io.opentelemetry.instrumentation.api.incubator.builder.DefaultHttpClientTelemetryBuilder;
+import io.opentelemetry.instrumentation.api.incubator.builder.HttpClientTelemetryBuilder;
+import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
+import io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor;
+import java.util.List;
 import java.util.Optional;
+import java.util.Set;
+import java.util.function.Function;
 import org.apache.hc.core5.http.HttpResponse;
 
 /** A builder for {@link ApacheHttpClient5Telemetry}. */
 public final class ApacheHttpClient5TelemetryBuilder
-    extends AbstractHttpClientTelemetryBuilder<
+    implements HttpClientTelemetryBuilder<
         ApacheHttpClient5TelemetryBuilder, ApacheHttpClient5Request, HttpResponse> {
 
   private static final String INSTRUMENTATION_NAME = "io.opentelemetry.apache-httpclient-5.2";
+  private final DefaultHttpClientTelemetryBuilder<
+          ApacheHttpClient5TelemetryBuilder, ApacheHttpClient5Request, HttpResponse>
+      builder;
 
   ApacheHttpClient5TelemetryBuilder(OpenTelemetry openTelemetry) {
-    super(
-        INSTRUMENTATION_NAME,
-        openTelemetry,
-        ApacheHttpClient5HttpAttributesGetter.INSTANCE,
-        // We manually inject because we need to inject internal requests for redirects.
-        Optional.empty());
+    builder =
+        new DefaultHttpClientTelemetryBuilder<>(
+            INSTRUMENTATION_NAME,
+            openTelemetry,
+            ApacheHttpClient5HttpAttributesGetter.INSTANCE,
+            // We manually inject because we need to inject internal requests for redirects.
+            Optional.empty());
+  }
+
+  @Override
+  @CanIgnoreReturnValue
+  public ApacheHttpClient5TelemetryBuilder addAttributeExtractor(
+      AttributesExtractor<? super ApacheHttpClient5Request, ? super HttpResponse>
+          attributesExtractor) {
+    return builder.addAttributeExtractor(attributesExtractor);
+  }
+
+  @Override
+  @CanIgnoreReturnValue
+  public ApacheHttpClient5TelemetryBuilder setCapturedRequestHeaders(List<String> requestHeaders) {
+    return builder.setCapturedRequestHeaders(requestHeaders);
+  }
+
+  @Override
+  @CanIgnoreReturnValue
+  public ApacheHttpClient5TelemetryBuilder setCapturedResponseHeaders(
+      List<String> responseHeaders) {
+    return builder.setCapturedResponseHeaders(responseHeaders);
+  }
+
+  @Override
+  @CanIgnoreReturnValue
+  public ApacheHttpClient5TelemetryBuilder setKnownMethods(Set<String> knownMethods) {
+    return builder.setKnownMethods(knownMethods);
+  }
+
+  @Override
+  @CanIgnoreReturnValue
+  public ApacheHttpClient5TelemetryBuilder setEmitExperimentalHttpClientMetrics(
+      boolean emitExperimentalHttpClientMetrics) {
+    return builder.setEmitExperimentalHttpClientMetrics(emitExperimentalHttpClientMetrics);
+  }
+
+  @Override
+  @CanIgnoreReturnValue
+  public ApacheHttpClient5TelemetryBuilder setSpanNameExtractor(
+      Function<
+              SpanNameExtractor<ApacheHttpClient5Request>,
+              ? extends SpanNameExtractor<? super ApacheHttpClient5Request>>
+          spanNameExtractorTransformer) {
+    return builder.setSpanNameExtractor(spanNameExtractorTransformer);
   }
 
   /**
    * Returns a new {@link ApacheHttpClient5Telemetry} configured with this {@link
    * ApacheHttpClient5TelemetryBuilder}.
    */
   public ApacheHttpClient5Telemetry build() {
-    return new ApacheHttpClient5Telemetry(instrumenter(), openTelemetry.getPropagators());
+    return new ApacheHttpClient5Telemetry(
+        builder.instrumenter(), builder.getOpenTelemetry().getPropagators());
   }
 }