Extended opentelemetry (open-telemetry#7496)

zeitlinger · jsuereth · jack-berg · the-clam · commit 59ef480ec650 · 2025-11-06T11:08:18.000-05:00
Co-authored-by: Josh Suereth &lt;Joshua.Suereth@gmail.com&gt;
Co-authored-by: jack-berg &lt;34418638+jack-berg@users.noreply.github.com&gt;
Co-authored-by: Josh Suereth &lt;joshuasuereth@google.com&gt;
diff --git a/api/incubator/src/main/java/io/opentelemetry/api/incubator/ExtendedOpenTelemetry.java b/api/incubator/src/main/java/io/opentelemetry/api/incubator/ExtendedOpenTelemetry.java
@@ -0,0 +1,17 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.api.incubator;
+
+import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.api.incubator.config.ConfigProvider;
+
+/** Extension to {@link OpenTelemetry} with experimental APIs. */
+public interface ExtendedOpenTelemetry extends OpenTelemetry {
+  /** Returns the {@link ConfigProvider} for this {@link OpenTelemetry}. */
+  default ConfigProvider getConfigProvider() {
+    return ConfigProvider.noop();
+  }
+}
diff --git a/docs/apidiffs/current_vs_latest/opentelemetry-sdk.txt b/docs/apidiffs/current_vs_latest/opentelemetry-sdk.txt
@@ -1,2 +1,10 @@
 Comparing source compatibility of opentelemetry-sdk-1.55.0-SNAPSHOT.jar against opentelemetry-sdk-1.54.0.jar
-No changes.
+***  MODIFIED CLASS: PUBLIC NON_FINAL (<- FINAL) io.opentelemetry.sdk.OpenTelemetrySdk  (not serializable)
+	===  CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+	***  MODIFIED METHOD: PUBLIC FINAL (<- NON_FINAL) io.opentelemetry.api.logs.LoggerProvider getLogsBridge()
+	***  MODIFIED METHOD: PUBLIC FINAL (<- NON_FINAL) io.opentelemetry.api.metrics.MeterProvider getMeterProvider()
+	***  MODIFIED METHOD: PUBLIC FINAL (<- NON_FINAL) io.opentelemetry.context.propagation.ContextPropagators getPropagators()
+	***  MODIFIED METHOD: PUBLIC FINAL (<- NON_FINAL) io.opentelemetry.sdk.logs.SdkLoggerProvider getSdkLoggerProvider()
+	***  MODIFIED METHOD: PUBLIC FINAL (<- NON_FINAL) io.opentelemetry.sdk.metrics.SdkMeterProvider getSdkMeterProvider()
+	***  MODIFIED METHOD: PUBLIC FINAL (<- NON_FINAL) io.opentelemetry.sdk.trace.SdkTracerProvider getSdkTracerProvider()
+	***  MODIFIED METHOD: PUBLIC FINAL (<- NON_FINAL) io.opentelemetry.api.trace.TracerProvider getTracerProvider()
diff --git a/sdk-extensions/autoconfigure/src/testDeclarativeConfigSpi/java/io/opentelemetry/sdk/autoconfigure/DeclarativeConfigurationSpiTest.java b/sdk-extensions/autoconfigure/src/testDeclarativeConfigSpi/java/io/opentelemetry/sdk/autoconfigure/DeclarativeConfigurationSpiTest.java
@@ -13,6 +13,9 @@
 import io.opentelemetry.exporter.logging.LoggingSpanExporter;
 import io.opentelemetry.internal.testing.CleanupExtension;
 import io.opentelemetry.sdk.OpenTelemetrySdk;
+import io.opentelemetry.sdk.extension.incubator.ExtendedOpenTelemetrySdk;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.SdkConfigProvider;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.OpenTelemetryConfigurationModel;
 import io.opentelemetry.sdk.resources.Resource;
 import io.opentelemetry.sdk.trace.SdkTracerProvider;
 import io.opentelemetry.sdk.trace.export.SimpleSpanProcessor;
@@ -25,15 +28,17 @@ class DeclarativeConfigurationSpiTest {
 
   @Test
   void configFromSpi() {
-    OpenTelemetrySdk expectedSdk =
-        OpenTelemetrySdk.builder()
-            .setTracerProvider(
-                SdkTracerProvider.builder()
-                    .setResource(
-                        Resource.getDefault().toBuilder().put("service.name", "test").build())
-                    .addSpanProcessor(SimpleSpanProcessor.create(LoggingSpanExporter.create()))
-                    .build())
-            .build();
+    ExtendedOpenTelemetrySdk expectedSdk =
+        ExtendedOpenTelemetrySdk.create(
+            OpenTelemetrySdk.builder()
+                .setTracerProvider(
+                    SdkTracerProvider.builder()
+                        .setResource(
+                            Resource.getDefault().toBuilder().put("service.name", "test").build())
+                        .addSpanProcessor(SimpleSpanProcessor.create(LoggingSpanExporter.create()))
+                        .build())
+                .build(),
+            SdkConfigProvider.create(new OpenTelemetryConfigurationModel()));
     cleanup.addCloseable(expectedSdk);
     AutoConfiguredOpenTelemetrySdkBuilder builder = spy(AutoConfiguredOpenTelemetrySdk.builder());
     Thread thread = new Thread();
diff --git a/sdk-extensions/autoconfigure/src/testIncubating/java/io/opentelemetry/sdk/autoconfigure/DeclarativeConfigurationTest.java b/sdk-extensions/autoconfigure/src/testIncubating/java/io/opentelemetry/sdk/autoconfigure/DeclarativeConfigurationTest.java
@@ -33,6 +33,7 @@
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigurationException;
 import io.opentelemetry.sdk.autoconfigure.spi.internal.DefaultConfigProperties;
+import io.opentelemetry.sdk.extension.incubator.ExtendedOpenTelemetrySdk;
 import io.opentelemetry.sdk.resources.Resource;
 import io.opentelemetry.sdk.trace.SdkTracerProvider;
 import io.opentelemetry.sdk.trace.export.SimpleSpanProcessor;
@@ -117,16 +118,6 @@ void configFile_Valid() {
     ConfigProperties config =
         DefaultConfigProperties.createFromMap(
             Collections.singletonMap("otel.experimental.config.file", configFilePath.toString()));
-    OpenTelemetrySdk expectedSdk =
-        OpenTelemetrySdk.builder()
-            .setTracerProvider(
-                SdkTracerProvider.builder()
-                    .setResource(
-                        Resource.getDefault().toBuilder().put("service.name", "test").build())
-                    .addSpanProcessor(SimpleSpanProcessor.create(LoggingSpanExporter.create()))
-                    .build())
-            .build();
-    cleanup.addCloseable(expectedSdk);
     AutoConfiguredOpenTelemetrySdkBuilder builder = spy(AutoConfiguredOpenTelemetrySdk.builder());
     Thread thread = new Thread();
     doReturn(thread).when(builder).shutdownHook(any());
@@ -135,8 +126,20 @@ void configFile_Valid() {
         builder.setConfig(config).build();
     cleanup.addCloseable(autoConfiguredOpenTelemetrySdk.getOpenTelemetrySdk());
 
-    assertThat(autoConfiguredOpenTelemetrySdk.getOpenTelemetrySdk().toString())
-        .isEqualTo(expectedSdk.toString());
+    OpenTelemetrySdk openTelemetrySdk = autoConfiguredOpenTelemetrySdk.getOpenTelemetrySdk();
+    ExtendedOpenTelemetrySdk expectedSdk =
+        ExtendedOpenTelemetrySdk.create(
+            OpenTelemetrySdk.builder()
+                .setTracerProvider(
+                    SdkTracerProvider.builder()
+                        .setResource(
+                            Resource.getDefault().toBuilder().put("service.name", "test").build())
+                        .addSpanProcessor(SimpleSpanProcessor.create(LoggingSpanExporter.create()))
+                        .build())
+                .build(),
+            ((ExtendedOpenTelemetrySdk) openTelemetrySdk).getSdkConfigProvider());
+    cleanup.addCloseable(expectedSdk);
+    assertThat(openTelemetrySdk.toString()).hasToString(expectedSdk.toString());
     // AutoConfiguredOpenTelemetrySdk#getResource() is set to a dummy value when configuring from
     // file
     assertThat(autoConfiguredOpenTelemetrySdk.getResource()).isEqualTo(Resource.getDefault());
diff --git a/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/ExtendedOpenTelemetrySdk.java b/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/ExtendedOpenTelemetrySdk.java
@@ -0,0 +1,86 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.sdk.extension.incubator;
+
+import io.opentelemetry.api.incubator.ExtendedOpenTelemetry;
+import io.opentelemetry.api.incubator.config.ConfigProvider;
+import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
+import io.opentelemetry.sdk.OpenTelemetrySdk;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.SdkConfigProvider;
+import java.io.Closeable;
+import javax.annotation.Nullable;
+import javax.annotation.concurrent.ThreadSafe;
+
+/** A new interface for creating OpenTelemetrySdk that supports getting {@link ConfigProvider}. */
+public final class ExtendedOpenTelemetrySdk extends OpenTelemetrySdk
+    implements ExtendedOpenTelemetry, Closeable {
+
+  private final OpenTelemetrySdk openTelemetrySdk;
+  private final ObfuscatedConfigProvider configProvider;
+
+  private ExtendedOpenTelemetrySdk(
+      OpenTelemetrySdk openTelemetrySdk, SdkConfigProvider configProvider) {
+    super(
+        openTelemetrySdk.getSdkTracerProvider(),
+        openTelemetrySdk.getSdkMeterProvider(),
+        openTelemetrySdk.getSdkLoggerProvider(),
+        openTelemetrySdk.getPropagators());
+    this.openTelemetrySdk = openTelemetrySdk;
+    this.configProvider = new ObfuscatedConfigProvider(configProvider);
+  }
+
+  public static ExtendedOpenTelemetrySdk create(
+      OpenTelemetrySdk openTelemetrySdk, SdkConfigProvider sdkConfigProvider) {
+    return new ExtendedOpenTelemetrySdk(openTelemetrySdk, sdkConfigProvider);
+  }
+
+  @Override
+  public ConfigProvider getConfigProvider() {
+    return configProvider;
+  }
+
+  /** Returns the {@link SdkConfigProvider} for this {@link ExtendedOpenTelemetrySdk}. */
+  public SdkConfigProvider getSdkConfigProvider() {
+    return configProvider.unobfuscate();
+  }
+
+  @Override
+  public String toString() {
+    return "ExtendedOpenTelemetrySdk{"
+        + "openTelemetrySdk="
+        + openTelemetrySdk
+        + ", configProvider="
+        + configProvider.unobfuscate()
+        + "}";
+  }
+
+  /**
+   * This class allows the SDK to unobfuscate an obfuscated provider.
+   *
+   * <p>Static global providers are obfuscated when they are returned from the API to prevent users
+   * from casting them to their SDK specific implementation. For example, we do not want users to
+   * use patterns like {@code (SdkConfigProvider) openTelemetry.getConfigProvider()}.
+   */
+  @ThreadSafe
+  private static class ObfuscatedConfigProvider implements ConfigProvider {
+
+    private final SdkConfigProvider delegate;
+
+    private ObfuscatedConfigProvider(SdkConfigProvider delegate) {
+      this.delegate = delegate;
+    }
+
+    @Override
+    @Nullable
+    public DeclarativeConfigProperties getInstrumentationConfig() {
+      return delegate.getInstrumentationConfig();
+    }
+
+    private SdkConfigProvider unobfuscate() {
+      return delegate;
+    }
+  }
+}
diff --git a/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/DeclarativeConfiguration.java b/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/DeclarativeConfiguration.java
@@ -15,6 +15,7 @@
 import io.opentelemetry.sdk.OpenTelemetrySdk;
 import io.opentelemetry.sdk.autoconfigure.internal.SpiHelper;
 import io.opentelemetry.sdk.autoconfigure.spi.internal.ComponentProvider;
+import io.opentelemetry.sdk.extension.incubator.ExtendedOpenTelemetrySdk;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.OpenTelemetryConfigurationModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.SamplerModel;
 import io.opentelemetry.sdk.trace.samplers.Sampler;
@@ -82,7 +83,7 @@ private DeclarativeConfiguration() {}
    *
    * @throws DeclarativeConfigException if unable to parse or interpret
    */
-  public static OpenTelemetrySdk parseAndCreate(InputStream inputStream) {
+  public static ExtendedOpenTelemetrySdk parseAndCreate(InputStream inputStream) {
     OpenTelemetryConfigurationModel configurationModel = parse(inputStream);
     return create(configurationModel);
   }
@@ -95,7 +96,8 @@ public static OpenTelemetrySdk parseAndCreate(InputStream inputStream) {
    * @return the {@link OpenTelemetrySdk}
    * @throws DeclarativeConfigException if unable to interpret
    */
-  public static OpenTelemetrySdk create(OpenTelemetryConfigurationModel configurationModel) {
+  public static ExtendedOpenTelemetrySdk create(
+      OpenTelemetryConfigurationModel configurationModel) {
     return create(configurationModel, DEFAULT_COMPONENT_LOADER);
   }
 
@@ -109,7 +111,7 @@ public static OpenTelemetrySdk create(OpenTelemetryConfigurationModel configurat
    * @return the {@link OpenTelemetrySdk}
    * @throws DeclarativeConfigException if unable to interpret
    */
-  public static OpenTelemetrySdk create(
+  public static ExtendedOpenTelemetrySdk create(
       OpenTelemetryConfigurationModel configurationModel, ComponentLoader componentLoader) {
     SpiHelper spiHelper = SpiHelper.create(componentLoader);
 
diff --git a/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/OpenTelemetryConfigurationFactory.java b/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/OpenTelemetryConfigurationFactory.java
@@ -8,14 +8,15 @@
 import io.opentelemetry.api.incubator.config.DeclarativeConfigException;
 import io.opentelemetry.sdk.OpenTelemetrySdk;
 import io.opentelemetry.sdk.OpenTelemetrySdkBuilder;
+import io.opentelemetry.sdk.extension.incubator.ExtendedOpenTelemetrySdk;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.OpenTelemetryConfigurationModel;
 import io.opentelemetry.sdk.metrics.SdkMeterProvider;
 import io.opentelemetry.sdk.resources.Resource;
 import java.util.Objects;
 import java.util.regex.Pattern;
 
 final class OpenTelemetryConfigurationFactory
-    implements Factory<OpenTelemetryConfigurationModel, OpenTelemetrySdk> {
+    implements Factory<OpenTelemetryConfigurationModel, ExtendedOpenTelemetrySdk> {
 
   private static final Pattern SUPPORTED_FILE_FORMATS = Pattern.compile("^(0.4)|(1.0(-rc.\\d*)?)$");
 
@@ -29,8 +30,9 @@ static OpenTelemetryConfigurationFactory getInstance() {
   }
 
   @Override
-  public OpenTelemetrySdk create(
+  public ExtendedOpenTelemetrySdk create(
       OpenTelemetryConfigurationModel model, DeclarativeConfigContext context) {
+    SdkConfigProvider sdkConfigProvider = SdkConfigProvider.create(model);
     OpenTelemetrySdkBuilder builder = OpenTelemetrySdk.builder();
     String fileFormat = model.getFileFormat();
     if (fileFormat == null || !SUPPORTED_FILE_FORMATS.matcher(fileFormat).matches()) {
@@ -41,7 +43,7 @@ public OpenTelemetrySdk create(
     // behavior for experimental properties.
 
     if (Objects.equals(true, model.getDisabled())) {
-      return builder.build();
+      return ExtendedOpenTelemetrySdk.create(builder.build(), sdkConfigProvider);
     }
 
     if (model.getPropagator() != null) {
@@ -88,6 +90,7 @@ public OpenTelemetrySdk create(
                   .build()));
     }
 
-    return context.addCloseable(builder.build());
+    OpenTelemetrySdk openTelemetrySdk = context.addCloseable(builder.build());
+    return ExtendedOpenTelemetrySdk.create(openTelemetrySdk, sdkConfigProvider);
   }
 }
diff --git a/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/SdkConfigProvider.java b/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/SdkConfigProvider.java
@@ -50,4 +50,9 @@ public static SdkConfigProvider create(
   public DeclarativeConfigProperties getInstrumentationConfig() {
     return instrumentationConfig;
   }
+
+  @Override
+  public String toString() {
+    return "SdkConfigProvider{" + "instrumentationConfig=" + instrumentationConfig + '}';
+  }
 }
diff --git a/sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/DeclarativeConfigurationCreateTest.java b/sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/DeclarativeConfigurationCreateTest.java
@@ -15,7 +15,7 @@
 import io.opentelemetry.api.incubator.config.DeclarativeConfigException;
 import io.opentelemetry.common.ComponentLoader;
 import io.opentelemetry.internal.testing.CleanupExtension;
-import io.opentelemetry.sdk.OpenTelemetrySdk;
+import io.opentelemetry.sdk.extension.incubator.ExtendedOpenTelemetrySdk;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.OpenTelemetryConfigurationModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.SpanProcessorModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.TracerProviderModel;
@@ -157,7 +157,7 @@ void create_ModelCustomizer() {
             .withProcessors(
                 Collections.singletonList(
                     new SpanProcessorModel().withAdditionalProperty("test", null))));
-    OpenTelemetrySdk sdk =
+    ExtendedOpenTelemetrySdk sdk =
         DeclarativeConfiguration.create(
             model,
             // customizer is TestDeclarativeConfigurationCustomizerProvider
diff --git a/sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/OpenTelemetryConfigurationFactoryTest.java b/sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/OpenTelemetryConfigurationFactoryTest.java
diff --git a/sdk/all/src/main/java/io/opentelemetry/sdk/OpenTelemetrySdk.java b/sdk/all/src/main/java/io/opentelemetry/sdk/OpenTelemetrySdk.java
diff --git a/sdk/all/src/test/java/io/opentelemetry/sdk/OpenTelemetrySdkTest.java b/sdk/all/src/test/java/io/opentelemetry/sdk/OpenTelemetrySdkTest.java

Original file line number	Diff line number	Diff line change
`@@ -50,4 +50,9 @@ public static SdkConfigProvider create(`
`50`	`50`	`public DeclarativeConfigProperties getInstrumentationConfig() {`
`51`	`51`	`return instrumentationConfig;`
`52`	`52`	`}`
	`53`	`+`
	`54`	`+ @Override`
	`55`	`+ public String toString() {`
	`56`	`+ return "SdkConfigProvider{" + "instrumentationConfig=" + instrumentationConfig + '}';`
	`57`	`+ }`
`53`	`58`	`}`