obfuscate sdk config provider

Author: zeitlinger

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.extension.incubator.fileconfig.SdkConfigProvider;
 import io.opentelemetry.sdk.logs.SdkLoggerProvider;
 import io.opentelemetry.sdk.logs.SdkLoggerProviderBuilder;
 import io.opentelemetry.sdk.metrics.SdkMeterProvider;
@@ -19,14 +20,15 @@
 import java.io.Closeable;
 import java.util.Objects;
 import java.util.function.Consumer;
+import javax.annotation.Nullable;
 
 /** A new interface for creating OpenTelemetrySdk that supports {@link ConfigProvider}. */
 public final class ExtendedOpenTelemetrySdkBuilder {
   private final SdkTracerProviderBuilder tracerProviderBuilder = SdkTracerProvider.builder();
   private final SdkMeterProviderBuilder meterProviderBuilder = SdkMeterProvider.builder();
   private final SdkLoggerProviderBuilder loggerProviderBuilder = SdkLoggerProvider.builder();
   private ContextPropagators propagators = ContextPropagators.noop();
-  private ConfigProvider configProvider = ConfigProvider.noop();
+  @Nullable private SdkConfigProvider configProvider;
   private Consumer<Closeable> closeableConsumer =
       closeable -> {
         // Default no-op closeable consumer
@@ -39,7 +41,7 @@ public ExtendedOpenTelemetrySdkBuilder setPropagators(ContextPropagators propaga
   }
 
   /** Sets the {@link ConfigProvider} to use. */
-  public ExtendedOpenTelemetrySdkBuilder setConfigProvider(ConfigProvider configProvider) {
+  public ExtendedOpenTelemetrySdkBuilder setConfigProvider(SdkConfigProvider configProvider) {
     this.configProvider = Objects.requireNonNull(configProvider, "configProvider must not be null");
     return this;
   }

sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/ObfuscatedExtendedOpenTelemetrySdk.java

@@ -6,6 +6,7 @@
 package io.opentelemetry.sdk.extension.incubator;
 
 import io.opentelemetry.api.incubator.config.ConfigProvider;
+import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
 import io.opentelemetry.api.logs.LoggerBuilder;
 import io.opentelemetry.api.logs.LoggerProvider;
 import io.opentelemetry.api.metrics.MeterBuilder;
@@ -15,6 +16,7 @@
 import io.opentelemetry.api.trace.TracerProvider;
 import io.opentelemetry.context.propagation.ContextPropagators;
 import io.opentelemetry.sdk.common.CompletableResultCode;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.SdkConfigProvider;
 import io.opentelemetry.sdk.logs.SdkLoggerProvider;
 import io.opentelemetry.sdk.metrics.SdkMeterProvider;
 import io.opentelemetry.sdk.trace.SdkTracerProvider;
@@ -23,6 +25,7 @@
 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 ExtendedOpenTelemetrySdk}. */
@@ -34,16 +37,16 @@ final class ObfuscatedExtendedOpenTelemetrySdk implements ExtendedOpenTelemetryS
   private final ObfuscatedTracerProvider tracerProvider;
   private final ObfuscatedMeterProvider meterProvider;
   private final ObfuscatedLoggerProvider loggerProvider;
-  private final ConfigProvider configProvider;
+  private final ObfuscatedConfigProvider configProvider;
   private final ContextPropagators propagators;
 
   ObfuscatedExtendedOpenTelemetrySdk(
-      ConfigProvider configProvider,
+      @Nullable SdkConfigProvider configProvider,
       SdkTracerProvider tracerProvider,
       SdkMeterProvider meterProvider,
       SdkLoggerProvider loggerProvider,
       ContextPropagators propagators) {
-    this.configProvider = configProvider;
+    this.configProvider = new ObfuscatedConfigProvider(configProvider);
     this.tracerProvider = new ObfuscatedTracerProvider(tracerProvider);
     this.meterProvider = new ObfuscatedMeterProvider(meterProvider);
     this.loggerProvider = new ObfuscatedLoggerProvider(loggerProvider);
@@ -97,7 +100,7 @@ public ContextPropagators getPropagators() {
   public String toString() {
     return "ExtendedOpenTelemetrySdk{"
         + "configProvider="
-        + configProvider
+        + configProvider.unobfuscate()
         + ", tracerProvider="
         + tracerProvider.unobfuscate()
         + ", meterProvider="
@@ -199,4 +202,36 @@ public SdkLoggerProvider unobfuscate() {
       return delegate;
     }
   }
+
+  /**
+   * This class allows the SDK to unobfuscate an obfuscated static global 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 (SdkMeterProvider) openTelemetry.getMeterProvider()}.
+   */
+  @ThreadSafe
+  // Visible for testing
+  static class ObfuscatedConfigProvider implements ConfigProvider {
+
+    @Nullable private final SdkConfigProvider delegate;
+
+    ObfuscatedConfigProvider(@Nullable SdkConfigProvider delegate) {
+      this.delegate = delegate;
+    }
+
+    @Override
+    @Nullable
+    public DeclarativeConfigProperties getInstrumentationConfig() {
+      if (delegate == null) {
+        return null;
+      }
+      return delegate.getInstrumentationConfig();
+    }
+
+    @Nullable
+    public SdkConfigProvider unobfuscate() {
+      return delegate;
+    }
+  }
 }