Add a AutoConfiguredComponentWrapper SPI

docs/apidiffs/current_vs_latest/opentelemetry-sdk-extension-autoconfigure-spi.txt

@@ -1,5 +1,8 @@
 Comparing source compatibility of  against 
-+++  NEW INTERFACE: PUBLIC(+) ABSTRACT(+) io.opentelemetry.sdk.autoconfigure.spi.traces.SpanExporterWrapper  (not serializable)
++++  NEW INTERFACE: PUBLIC(+) ABSTRACT(+) io.opentelemetry.sdk.autoconfigure.spi.AutoConfiguredComponentWrapper  (not serializable)
 	+++  CLASS FILE FORMAT VERSION: 52.0 <- n.a.
 	+++  NEW SUPERCLASS: java.lang.Object
-	+++  NEW METHOD: PUBLIC(+) ABSTRACT(+) io.opentelemetry.sdk.trace.export.SpanExporter wrap(io.opentelemetry.sdk.trace.export.SpanExporter, io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties)
+	+++  NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.resources.Resource wrap(io.opentelemetry.sdk.resources.Resource, io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties)
+	+++  NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.trace.samplers.Sampler wrap(io.opentelemetry.sdk.trace.samplers.Sampler, io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties)
+	+++  NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.trace.export.SpanExporter wrap(io.opentelemetry.sdk.trace.export.SpanExporter, io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties)
+	+++  NEW METHOD: PUBLIC(+) io.opentelemetry.context.propagation.TextMapPropagator wrap(io.opentelemetry.context.propagation.TextMapPropagator, io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties)

sdk-extensions/autoconfigure-spi/src/main/java/io/opentelemetry/sdk/autoconfigure/spi/AutoConfiguredComponentWrapper.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.sdk.autoconfigure.spi;
+
+import io.opentelemetry.context.propagation.TextMapPropagator;
+import io.opentelemetry.sdk.resources.Resource;
+import io.opentelemetry.sdk.trace.export.SpanExporter;
+import io.opentelemetry.sdk.trace.samplers.Sampler;
+
+/**
+ * A service provider interface (SPI) for wrapping autoconfigured components. For any component
+ * automatically created by autoconfiguration, for example a span exporter, implementations of this
+ * interface will be invoked to replace it, resulting in the final used component.
+ */
+public interface AutoConfiguredComponentWrapper {
+
+  /** Wraps a {@link Resource}. */
+  default Resource wrap(Resource resource, ConfigProperties config) {
+    return resource;
+  }
+
+  /** Wraps a {@link Sampler}. */
+  default Sampler wrap(Sampler sampler, ConfigProperties config) {
+    return sampler;
+  }
+
+  /**
+   * Wraps a {@link SpanExporter}. It is common to use in conjunction with {@link
+   * io.opentelemetry.sdk.trace.data.DelegatingSpanData} to adjust the exported data.
+   */
+  default SpanExporter wrap(SpanExporter exporter, ConfigProperties config) {
+    return exporter;
+  }
+
+  /** Wraps a {@link TextMapPropagator}. */
+  default TextMapPropagator wrap(TextMapPropagator propagator, ConfigProperties config) {
+    return propagator;
+  }
+}

sdk-extensions/autoconfigure-spi/src/main/java/io/opentelemetry/sdk/autoconfigure/spi/internal/ComponentWrapping.java

@@ -0,0 +1,71 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.sdk.autoconfigure.spi.internal;
+
+import io.opentelemetry.context.propagation.TextMapPropagator;
+import io.opentelemetry.sdk.autoconfigure.spi.AutoConfiguredComponentWrapper;
+import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
+import io.opentelemetry.sdk.resources.Resource;
+import io.opentelemetry.sdk.trace.export.SpanExporter;
+import io.opentelemetry.sdk.trace.samplers.Sampler;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import java.util.ServiceLoader;
+
+/**
+ * Wraps components with SPI implementations.
+ *
+ * <p>This class is internal and is hence not for public use. Its APIs are unstable and can change
+ * at any time.
+ */
+public final class ComponentWrapping {
+
+  private static final List<AutoConfiguredComponentWrapper> wrappers;
+
+  static {
+    List<AutoConfiguredComponentWrapper> loaded = new ArrayList<>();
+    ServiceLoader.load(AutoConfiguredComponentWrapper.class).forEach(loaded::add);
+    wrappers = Collections.unmodifiableList(loaded);
+  }
+
+  /** Wraps a {@link Resource}. */
+  public static Resource wrap(Resource resource, ConfigProperties config) {
+    for (AutoConfiguredComponentWrapper wrapper : wrappers) {
+      resource = wrapper.wrap(resource, config);
+    }
+    return resource;
+  }
+
+  /** Wraps a {@link Sampler}. */
+  public static Sampler wrap(Sampler sampler, ConfigProperties config) {
+    for (AutoConfiguredComponentWrapper wrapper : wrappers) {
+      sampler = wrapper.wrap(sampler, config);
+    }
+    return sampler;
+  }
+
+  /**
+   * Wraps a {@link SpanExporter}. It is common to use in conjunction with {@link
+   * io.opentelemetry.sdk.trace.data.DelegatingSpanData} to adjust the exported data.
+   */
+  public static SpanExporter wrap(SpanExporter exporter, ConfigProperties config) {
+    for (AutoConfiguredComponentWrapper wrapper : wrappers) {
+      exporter = wrapper.wrap(exporter, config);
+    }
+    return exporter;
+  }
+
+  /** Wraps a {@link TextMapPropagator}. */
+  public static TextMapPropagator wrap(TextMapPropagator propagator, ConfigProperties config) {
+    for (AutoConfiguredComponentWrapper wrapper : wrappers) {
+      propagator = wrapper.wrap(propagator, config);
+    }
+    return propagator;
+  }
+
+  private ComponentWrapping() {}
+}

sdk-extensions/autoconfigure-spi/src/main/java/io/opentelemetry/sdk/autoconfigure/spi/internal/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/** Internal utilities for autoconfiguration. */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.sdk.autoconfigure.spi.internal;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/SpanExporterConfiguration.java

@@ -24,16 +24,14 @@
 import io.opentelemetry.exporter.zipkin.ZipkinSpanExporterBuilder;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigurationException;
+import io.opentelemetry.sdk.autoconfigure.spi.internal.ComponentWrapping;
 import io.opentelemetry.sdk.autoconfigure.spi.traces.ConfigurableSpanExporterProvider;
-import io.opentelemetry.sdk.autoconfigure.spi.traces.SpanExporterWrapper;
 import io.opentelemetry.sdk.trace.export.SpanExporter;
 import java.time.Duration;
-import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
-import java.util.ServiceLoader;
 import java.util.Set;
 import java.util.function.Function;
 
@@ -76,19 +74,13 @@ static Map<String, SpanExporter> configureSpanExporters(ConfigProperties config)
             ConfigurableSpanExporterProvider::createExporter,
             config);
 
-    List<SpanExporterWrapper> wrappers = new ArrayList<>();
-    ServiceLoader.load(SpanExporterWrapper.class).forEach(wrappers::add);
-
     return exporterNames.stream()
         .collect(
             toMap(
                 Function.identity(),
                 exporterName -> {
                   SpanExporter exporter = configureExporter(exporterName, config, spiExporters);
-                  for (SpanExporterWrapper wrapper : wrappers) {
-                    exporter = wrapper.wrap(exporter, config);
-                  }
-                  return exporter;
+                  return ComponentWrapping.wrap(exporter, config);
                 }));
   }
 

sdk-extensions/autoconfigure/src/testFullConfig/java/io/opentelemetry/sdk/autoconfigure/ConfigurableSpanExporterTest.java

@@ -36,7 +36,7 @@ void configureSpanExporters_spiExporter() {
         .hasSize(1)
         .containsKey("testExporter")
         .extracting(map -> map.get("testExporter"))
-        .isInstanceOf(TestSpanExporterWrapper.WrappingSpanExporter.class)
+        .isInstanceOf(TestComponentWrapper.WrappingSpanExporter.class)
         .extracting("delegate")
         .isInstanceOf(TestConfigurableSpanExporterProvider.TestSpanExporter.class)
         .extracting("config")

sdk-extensions/autoconfigure/src/testFullConfig/java/io/opentelemetry/sdk/autoconfigure/TestSpanExporterWrapper.java → sdk-extensions/autoconfigure/src/testFullConfig/java/io/opentelemetry/sdk/autoconfigure/TestComponentWrapper.java

@@ -6,8 +6,8 @@
 package io.opentelemetry.sdk.autoconfigure;
 
 import io.opentelemetry.api.common.Attributes;
+import io.opentelemetry.sdk.autoconfigure.spi.AutoConfiguredComponentWrapper;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
-import io.opentelemetry.sdk.autoconfigure.spi.traces.SpanExporterWrapper;
 import io.opentelemetry.sdk.common.CompletableResultCode;
 import io.opentelemetry.sdk.trace.data.DelegatingSpanData;
 import io.opentelemetry.sdk.trace.data.SpanData;
@@ -16,7 +16,7 @@
 import java.util.List;
 import java.util.stream.Collectors;
 
-public final class TestSpanExporterWrapper implements SpanExporterWrapper {
+public final class TestComponentWrapper implements AutoConfiguredComponentWrapper {
   @Override
   public SpanExporter wrap(SpanExporter delegate, ConfigProperties config) {
     return new WrappingSpanExporter(delegate) {

sdk-extensions/autoconfigure/src/testFullConfig/resources/META-INF/services/io.opentelemetry.sdk.autoconfigure.spi.AutoConfiguredComponentWrapper

@@ -0,0 +1 @@
+io.opentelemetry.sdk.autoconfigure.TestComponentWrapper