no problematic api changes

zeitlinger · zeitlinger · commit df73512a5777 · 2025-07-18T10:11:46.000+02:00
diff --git a/docs/apidiffs/current_vs_latest/opentelemetry-sdk.txt b/docs/apidiffs/current_vs_latest/opentelemetry-sdk.txt
@@ -1,2 +1,11 @@
 Comparing source compatibility of opentelemetry-sdk-1.53.0-SNAPSHOT.jar against opentelemetry-sdk-1.52.0.jar
-No changes.
+***! MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.sdk.OpenTelemetrySdk  (not serializable)
+	===  CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+	---! REMOVED METHOD: PUBLIC(-) void close()
++++  NEW INTERFACE: PUBLIC(+) ABSTRACT(+) io.opentelemetry.sdk.WithShutdown  (not serializable)
+	+++  CLASS FILE FORMAT VERSION: 52.0 <- n.a.
+	+++  NEW INTERFACE: java.io.Closeable
+	+++  NEW INTERFACE: java.lang.AutoCloseable
+	+++  NEW SUPERCLASS: java.lang.Object
+	+++  NEW METHOD: PUBLIC(+) void close()
+	+++  NEW METHOD: PUBLIC(+) ABSTRACT(+) io.opentelemetry.sdk.common.CompletableResultCode shutdown()
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
@@ -8,30 +8,19 @@
 import io.opentelemetry.api.incubator.ExtendedOpenTelemetry;
 import io.opentelemetry.api.incubator.config.ConfigProvider;
 import io.opentelemetry.sdk.OpenTelemetrySdk;
-import io.opentelemetry.sdk.common.CompletableResultCode;
-import io.opentelemetry.sdk.logs.SdkLoggerProvider;
-import io.opentelemetry.sdk.metrics.SdkMeterProvider;
-import io.opentelemetry.sdk.trace.SdkTracerProvider;
-import javax.annotation.Nullable;
-import java.io.Closeable;
+import io.opentelemetry.sdk.WithShutdown;
 import java.lang.reflect.Field;
+import javax.annotation.Nullable;
 
 /** A new interface for creating OpenTelemetrySdk that supports getting {@link ConfigProvider}. */
-public interface ExtendedOpenTelemetrySdk extends ExtendedOpenTelemetry, Closeable {
-  /**
-   * Shutdown the SDK. Calls {@link SdkTracerProvider#shutdown()}, {@link
-   * SdkMeterProvider#shutdown()}, and {@link SdkLoggerProvider#shutdown()}.
-   *
-   * @return a {@link CompletableResultCode} which completes when all providers are shutdown
-   */
-  CompletableResultCode shutdown();
-
+public interface ExtendedOpenTelemetrySdk extends ExtendedOpenTelemetry, WithShutdown {
   /** Returns a builder for {@link ExtendedOpenTelemetrySdk}. */
   static ExtendedOpenTelemetrySdkBuilder builder() {
     return new ExtendedOpenTelemetrySdkBuilder();
   }
 
-  @Nullable default ExtendedOpenTelemetrySdk fromOpenTelemetrySdk(OpenTelemetrySdk openTelemetry) {
+  @Nullable
+  static ExtendedOpenTelemetrySdk fromOpenTelemetrySdk(OpenTelemetrySdk openTelemetry) {
     try {
       Class<?> sdk = Class.forName("io.opentelemetry.sdk.OpenTelemetrySdk");
       Field extendedOpenTelemetrySdk = sdk.getDeclaredField("extendedOpenTelemetrySdk");
diff --git a/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/ExtendedOpenTelemetrySdkBuilder.java b/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/ExtendedOpenTelemetrySdkBuilder.java
@@ -10,6 +10,7 @@
 import io.opentelemetry.context.propagation.ContextPropagators;
 import io.opentelemetry.sdk.OpenTelemetrySdk;
 import io.opentelemetry.sdk.OpenTelemetrySdkBuilder;
+import io.opentelemetry.sdk.WithShutdown;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.SdkConfigProvider;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.OpenTelemetryConfigurationModel;
 import io.opentelemetry.sdk.logs.SdkLoggerProvider;
@@ -120,7 +121,7 @@ public OpenTelemetrySdk build() {
 
     try {
       Method setExtendedOpenTelemetrySdk =
-          builder.getClass().getDeclaredMethod("setExtendedOpenTelemetrySdk", Object.class);
+          builder.getClass().getDeclaredMethod("setExtendedOpenTelemetrySdk", WithShutdown.class);
       setExtendedOpenTelemetrySdk.setAccessible(true);
       setExtendedOpenTelemetrySdk.invoke(builder, extendedOpenTelemetrySdk);
     } catch (NoSuchMethodException | IllegalAccessException | InvocationTargetException e) {
diff --git a/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/ObfuscatedExtendedOpenTelemetrySdk.java b/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/ObfuscatedExtendedOpenTelemetrySdk.java
@@ -20,7 +20,6 @@
 import io.opentelemetry.sdk.trace.SdkTracerProvider;
 import java.util.ArrayList;
 import java.util.List;
-import java.util.concurrent.TimeUnit;
 import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.logging.Logger;
 import javax.annotation.concurrent.ThreadSafe;
@@ -63,11 +62,6 @@ public CompletableResultCode shutdown() {
     return CompletableResultCode.ofAll(results);
   }
 
-  @Override
-  public void close() {
-    shutdown().join(10, TimeUnit.SECONDS);
-  }
-
   @Override
   public ConfigProvider getConfigProvider() {
     return configProvider;
diff --git a/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/DeclarativeConfigContext.java b/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/DeclarativeConfigContext.java
@@ -43,6 +43,7 @@ List<Closeable> getCloseables() {
   ComponentLoader getComponentLoader() {
     return spiHelper.getComponentLoader();
   }
+
   /**
    * Find a registered {@link ComponentProvider} with {@link ComponentProvider#getType()} matching
    * {@code type}, {@link ComponentProvider#getName()} matching {@code name}, and call {@link
diff --git a/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/LoggerProviderFactory.java b/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/LoggerProviderFactory.java
@@ -32,7 +32,8 @@ static LoggerProviderFactory getInstance() {
 
   public void configure(
       SdkLoggerProviderBuilder builder,
-      LoggerProviderAndAttributeLimits model, DeclarativeConfigContext context) {
+      LoggerProviderAndAttributeLimits model,
+      DeclarativeConfigContext context) {
 
     LoggerProviderModel loggerProviderModel = model.getLoggerProvider();
     if (loggerProviderModel == null) {
@@ -81,7 +82,6 @@ public void configure(
       }
       SdkLoggerProviderUtil.setLoggerConfigurator(builder, configuratorBuilder.build());
     }
-
   }
 
   private static class LoggerConfigFactory
diff --git a/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/MeterProviderFactory.java b/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/MeterProviderFactory.java
@@ -91,7 +91,6 @@ public void configure(
       }
       SdkMeterProviderUtil.setMeterConfigurator(builder, configuratorBuilder.build());
     }
-
   }
 
   private static class MeterConfigFactory
diff --git a/sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/TestExtendedOpenTelemetrySdk.java b/sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/TestExtendedOpenTelemetrySdk.java
@@ -0,0 +1,32 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.sdk.extension.incubator;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import io.opentelemetry.sdk.OpenTelemetrySdk;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.SdkConfigProvider;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.OpenTelemetryConfigurationModel;
+import io.opentelemetry.sdk.testing.exporter.InMemoryMetricReader;
+import org.junit.jupiter.api.Test;
+
+class TestExtendedOpenTelemetrySdk {
+  private final InMemoryMetricReader sdkMeterReader = InMemoryMetricReader.create();
+
+  @Test
+  void extractExtendedSdk() {
+    SdkConfigProvider configProvider =
+        SdkConfigProvider.create(new OpenTelemetryConfigurationModel());
+    OpenTelemetrySdk sdk =
+        ExtendedOpenTelemetrySdk.builder()
+            .withMeterProvider(builder -> builder.registerMetricReader(sdkMeterReader))
+            .setConfigProvider(configProvider)
+            .build();
+    ExtendedOpenTelemetrySdk extendedSdk = ExtendedOpenTelemetrySdk.fromOpenTelemetrySdk(sdk);
+    assertThat(extendedSdk).isNotNull();
+    assertThat(extendedSdk.getConfigProvider()).isEqualTo(configProvider);
+  }
+}
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
@@ -24,7 +24,6 @@
 import io.opentelemetry.internal.testing.CleanupExtension;
 import io.opentelemetry.sdk.OpenTelemetrySdk;
 import io.opentelemetry.sdk.autoconfigure.internal.SpiHelper;
-import io.opentelemetry.sdk.extension.incubator.ExtendedOpenTelemetrySdk;
 import io.opentelemetry.sdk.extension.incubator.ExtendedOpenTelemetrySdkBuilder;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.AlwaysOnSamplerModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.AttributeNameValueModel;
@@ -125,8 +124,7 @@ void create_Defaults() {
             .build();
     cleanup.addCloseable(expectedSdk);
 
-    ExtendedOpenTelemetrySdk sdk =
-        OpenTelemetryConfigurationFactory.getInstance().create(model, context);
+    OpenTelemetrySdk sdk = OpenTelemetryConfigurationFactory.getInstance().create(model, context);
     cleanup.addCloseable(sdk);
     cleanup.addCloseables(closeables);
 
@@ -136,10 +134,10 @@ void create_Defaults() {
   @Test
   void create_Disabled() {
     List<Closeable> closeables = new ArrayList<>();
-    ExtendedOpenTelemetrySdk expectedSdk = new ExtendedOpenTelemetrySdkBuilder().build();
+    OpenTelemetrySdk expectedSdk = OpenTelemetrySdk.builder().build();
     cleanup.addCloseable(expectedSdk);
 
-    ExtendedOpenTelemetrySdk sdk =
+    OpenTelemetrySdk sdk =
         OpenTelemetryConfigurationFactory.getInstance()
             .create(
                 new OpenTelemetryConfigurationModel()
@@ -254,7 +252,7 @@ void create_Configured() {
                                         .withName("stream-name")
                                         .withAttributeKeys(null)))));
 
-    ExtendedOpenTelemetrySdk expectedSdk =
+    OpenTelemetrySdk expectedSdk =
         new ExtendedOpenTelemetrySdkBuilder()
             .setConfigProvider(SdkConfigProvider.create(model))
             .setPropagators(
@@ -312,8 +310,7 @@ void create_Configured() {
             .build();
     cleanup.addCloseable(expectedSdk);
 
-    ExtendedOpenTelemetrySdk sdk =
-        OpenTelemetryConfigurationFactory.getInstance().create(model, context);
+    OpenTelemetrySdk sdk = OpenTelemetryConfigurationFactory.getInstance().create(model, context);
     cleanup.addCloseable(sdk);
     cleanup.addCloseables(closeables);
 
diff --git a/sdk/all/src/main/java/io/opentelemetry/sdk/OpenTelemetrySdk.java b/sdk/all/src/main/java/io/opentelemetry/sdk/OpenTelemetrySdk.java
@@ -21,15 +21,14 @@
 import java.io.Closeable;
 import java.util.ArrayList;
 import java.util.List;
-import java.util.concurrent.TimeUnit;
 import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.logging.Logger;
 import javax.annotation.Nullable;
 import javax.annotation.concurrent.ThreadSafe;
 
 /** The SDK implementation of {@link OpenTelemetry}. */
 @ThreadSafe
-public final class OpenTelemetrySdk implements OpenTelemetry, Closeable {
+public final class OpenTelemetrySdk implements OpenTelemetry, Closeable, WithShutdown {
 
   private static final Logger LOGGER = Logger.getLogger(OpenTelemetrySdk.class.getName());
 
@@ -38,14 +37,14 @@ public final class OpenTelemetrySdk implements OpenTelemetry, Closeable {
   private final ObfuscatedMeterProvider meterProvider;
   private final ObfuscatedLoggerProvider loggerProvider;
   private final ContextPropagators propagators;
-  @Nullable private final Object extendedOpenTelemetrySdk;
+  @Nullable private final WithShutdown extendedOpenTelemetrySdk;
 
   OpenTelemetrySdk(
       SdkTracerProvider tracerProvider,
       SdkMeterProvider meterProvider,
       SdkLoggerProvider loggerProvider,
       ContextPropagators propagators,
-      @Nullable Object extendedOpenTelemetrySdk) {
+      @Nullable WithShutdown extendedOpenTelemetrySdk) {
     this.tracerProvider = new ObfuscatedTracerProvider(tracerProvider);
     this.meterProvider = new ObfuscatedMeterProvider(meterProvider);
     this.loggerProvider = new ObfuscatedLoggerProvider(loggerProvider);
@@ -100,13 +99,13 @@ public ContextPropagators getPropagators() {
     return propagators;
   }
 
-  /**
-   * Shutdown the SDK. Calls {@link SdkTracerProvider#shutdown()}, {@link
-   * SdkMeterProvider#shutdown()}, and {@link SdkLoggerProvider#shutdown()}.
-   *
-   * @return a {@link CompletableResultCode} which completes when all providers are shutdown
-   */
+  @Override
   public CompletableResultCode shutdown() {
+    if (extendedOpenTelemetrySdk != null) {
+      // If an ExtendedOpenTelemetrySdk is present, we delegate the shutdown to it.
+      return extendedOpenTelemetrySdk.shutdown();
+    }
+
     if (!isShutdown.compareAndSet(false, true)) {
       LOGGER.info("Multiple shutdown calls");
       return CompletableResultCode.ofSuccess();
@@ -118,11 +117,6 @@ public CompletableResultCode shutdown() {
     return CompletableResultCode.ofAll(results);
   }
 
-  @Override
-  public void close() {
-    shutdown().join(10, TimeUnit.SECONDS);
-  }
-
   @Override
   public String toString() {
     return "OpenTelemetrySdk{"
diff --git a/sdk/all/src/main/java/io/opentelemetry/sdk/OpenTelemetrySdkBuilder.java b/sdk/all/src/main/java/io/opentelemetry/sdk/OpenTelemetrySdkBuilder.java
@@ -21,7 +21,7 @@ public final class OpenTelemetrySdkBuilder {
   @Nullable private SdkTracerProvider tracerProvider;
   @Nullable private SdkMeterProvider meterProvider;
   @Nullable private SdkLoggerProvider loggerProvider;
-  @Nullable private Object extendedOpenTelemetrySdk;
+  @Nullable private WithShutdown extendedOpenTelemetrySdk;
 
   /**
    * Package protected to disallow direct initialization.
@@ -72,11 +72,11 @@ public OpenTelemetrySdkBuilder setPropagators(ContextPropagators propagators) {
   }
 
   /**
-   * Sets the ExtendedOpenTelemetrySdk to use. This can be used to configure extended
-   * OpenTelemetry settings.
+   * Sets the ExtendedOpenTelemetrySdk to use. This can be used to configure extended OpenTelemetry
+   * settings.
    */
   OpenTelemetrySdkBuilder setExtendedOpenTelemetrySdk(
-      @Nullable Object extendedOpenTelemetrySdk) {
+      @Nullable WithShutdown extendedOpenTelemetrySdk) {
     this.extendedOpenTelemetrySdk = extendedOpenTelemetrySdk;
     return this;
   }
@@ -122,6 +122,7 @@ public OpenTelemetrySdk build() {
       loggerProvider = SdkLoggerProvider.builder().build();
     }
 
-    return new OpenTelemetrySdk(tracerProvider, meterProvider, loggerProvider, propagators, extendedOpenTelemetrySdk);
+    return new OpenTelemetrySdk(
+        tracerProvider, meterProvider, loggerProvider, propagators, extendedOpenTelemetrySdk);
   }
 }
diff --git a/sdk/all/src/main/java/io/opentelemetry/sdk/WithShutdown.java b/sdk/all/src/main/java/io/opentelemetry/sdk/WithShutdown.java
@@ -0,0 +1,28 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.sdk;
+
+import io.opentelemetry.sdk.common.CompletableResultCode;
+import io.opentelemetry.sdk.logs.SdkLoggerProvider;
+import io.opentelemetry.sdk.metrics.SdkMeterProvider;
+import io.opentelemetry.sdk.trace.SdkTracerProvider;
+import java.io.Closeable;
+import java.util.concurrent.TimeUnit;
+
+public interface WithShutdown extends Closeable {
+  /**
+   * Shutdown the SDK. Calls {@link SdkTracerProvider#shutdown()}, {@link
+   * SdkMeterProvider#shutdown()}, and {@link SdkLoggerProvider#shutdown()}.
+   *
+   * @return a {@link CompletableResultCode} which completes when all providers are shutdown
+   */
+  CompletableResultCode shutdown();
+
+  @Override
+  default void close() {
+    shutdown().join(10, TimeUnit.SECONDS);
+  }
+}

Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,7 @@ List<Closeable> getCloseables() {`
`43`	`43`	`ComponentLoader getComponentLoader() {`
`44`	`44`	`return spiHelper.getComponentLoader();`
`45`	`45`	`}`
	`46`	`+`
`46`	`47`	`/**`
`47`	`48`	`* Find a registered {@link ComponentProvider} with {@link ComponentProvider#getType()} matching`
`48`	`49`	`* {@code type}, {@link ComponentProvider#getName()} matching {@code name}, and call {@link`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,8 @@ static LoggerProviderFactory getInstance() {`
`32`	`32`
`33`	`33`	`public void configure(`
`34`	`34`	`SdkLoggerProviderBuilder builder,`
`35`		`- LoggerProviderAndAttributeLimits model, DeclarativeConfigContext context) {`
	`35`	`+ LoggerProviderAndAttributeLimits model,`
	`36`	`+ DeclarativeConfigContext context) {`
`36`	`37`
`37`	`38`	`LoggerProviderModel loggerProviderModel = model.getLoggerProvider();`
`38`	`39`	`if (loggerProviderModel == null) {`
`@@ -81,7 +82,6 @@ public void configure(`
`81`	`82`	`}`
`82`	`83`	`SdkLoggerProviderUtil.setLoggerConfigurator(builder, configuratorBuilder.build());`
`83`	`84`	`}`
`84`		`-`
`85`	`85`	`}`
`86`	`86`
`87`	`87`	`private static class LoggerConfigFactory`
Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,6 @@ public void configure(`
`91`	`91`	`}`
`92`	`92`	`SdkMeterProviderUtil.setMeterConfigurator(builder, configuratorBuilder.build());`
`93`	`93`	`}`
`94`		`-`
`95`	`94`	`}`
`96`	`95`
`97`	`96`	`private static class MeterConfigFactory`