support ExtendedOpenTelemetry in GlobalOpenTelemetry

Author: zeitlinger

api/all/src/main/java/io/opentelemetry/api/GlobalOpenTelemetry.java

@@ -7,7 +7,7 @@
 
 import io.opentelemetry.api.internal.ConfigUtil;
 import io.opentelemetry.api.internal.GuardedBy;
-import io.opentelemetry.api.logs.LoggerProvider;
+import io.opentelemetry.api.internal.IncubatingUtil;
 import io.opentelemetry.api.metrics.Meter;
 import io.opentelemetry.api.metrics.MeterBuilder;
 import io.opentelemetry.api.metrics.MeterProvider;
@@ -21,7 +21,6 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import javax.annotation.Nullable;
-import javax.annotation.concurrent.ThreadSafe;
 
 /**
  * A global singleton for the entrypoint to telemetry functionality for tracing, metrics and
@@ -56,7 +55,7 @@ public final class GlobalOpenTelemetry {
 
   @SuppressWarnings("NonFinalStaticField")
   @Nullable
-  private static volatile ObfuscatedOpenTelemetry globalOpenTelemetry;
+  private static volatile OpenTelemetry globalOpenTelemetry;
 
   @SuppressWarnings("NonFinalStaticField")
   @GuardedBy("mutex")
@@ -112,7 +111,7 @@ public static void set(OpenTelemetry openTelemetry) {
                 + "instead. Previous invocation set to cause of this exception.",
             setGlobalCaller);
       }
-      globalOpenTelemetry = new ObfuscatedOpenTelemetry(openTelemetry);
+      globalOpenTelemetry = IncubatingUtil.obfuscatedOpenTelemetry(openTelemetry);
       setGlobalCaller = new Throwable();
     }
   }
@@ -261,7 +260,7 @@ private static OpenTelemetry maybeAutoConfigureAndSetGlobal() {
       Object autoConfiguredSdk = initialize.invoke(null);
       Method getOpenTelemetrySdk =
           openTelemetrySdkAutoConfiguration.getMethod("getOpenTelemetrySdk");
-      return new ObfuscatedOpenTelemetry(
+      return IncubatingUtil.obfuscatedOpenTelemetry(
           (OpenTelemetry) getOpenTelemetrySdk.invoke(autoConfiguredSdk));
     } catch (NoSuchMethodException | IllegalAccessException e) {
       throw new IllegalStateException(
@@ -276,44 +275,4 @@ private static OpenTelemetry maybeAutoConfigureAndSetGlobal() {
       return null;
     }
   }
-
-  /**
-   * Static global instances 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 (OpenTelemetrySdk) GlobalOpenTelemetry.get()}.
-   */
-  @ThreadSafe
-  static class ObfuscatedOpenTelemetry implements OpenTelemetry {
-
-    private final OpenTelemetry delegate;
-
-    ObfuscatedOpenTelemetry(OpenTelemetry delegate) {
-      this.delegate = delegate;
-    }
-
-    @Override
-    public TracerProvider getTracerProvider() {
-      return delegate.getTracerProvider();
-    }
-
-    @Override
-    public MeterProvider getMeterProvider() {
-      return delegate.getMeterProvider();
-    }
-
-    @Override
-    public LoggerProvider getLogsBridge() {
-      return delegate.getLogsBridge();
-    }
-
-    @Override
-    public ContextPropagators getPropagators() {
-      return delegate.getPropagators();
-    }
-
-    @Override
-    public TracerBuilder tracerBuilder(String instrumentationScopeName) {
-      return delegate.tracerBuilder(instrumentationScopeName);
-    }
-  }
 }

api/all/src/main/java/io/opentelemetry/api/internal/IncubatingUtil.java

@@ -5,6 +5,13 @@
 
 package io.opentelemetry.api.internal;
 
+import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.api.logs.LoggerProvider;
+import io.opentelemetry.api.metrics.MeterProvider;
+import io.opentelemetry.api.trace.TracerBuilder;
+import io.opentelemetry.api.trace.TracerProvider;
+import io.opentelemetry.context.propagation.ContextPropagators;
+import javax.annotation.concurrent.ThreadSafe;
 import java.lang.reflect.Method;
 
 /**
@@ -26,4 +33,63 @@ public static <T> T incubatingApiIfAvailable(T stableApi, String incubatingClass
       return stableApi;
     }
   }
+
+  public static OpenTelemetry obfuscatedOpenTelemetry(OpenTelemetry openTelemetry) {
+    try {
+      Class<?> extendedClass =
+          Class.forName("io.opentelemetry.api.incubator.ExtendedOpenTelemetry");
+      if (extendedClass.isInstance(openTelemetry)) {
+        Class<?> incubatingClass =
+            Class.forName(
+                "io.opentelemetry.api.incubator.internal.ObfuscatedExtendedOpenTelemetry");
+        return (OpenTelemetry)
+            incubatingClass
+                .getDeclaredConstructor(extendedClass)
+                .newInstance(extendedClass.cast(openTelemetry));
+      }
+    } catch (Exception e) {
+      // incubator not available
+    }
+    return new ObfuscatedOpenTelemetry(openTelemetry);
+  }
+
+  /**
+   * Static global instances 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 (OpenTelemetrySdk) GlobalOpenTelemetry.get()}.
+   */
+  @ThreadSafe
+  static class ObfuscatedOpenTelemetry implements OpenTelemetry {
+
+    private final OpenTelemetry delegate;
+
+    ObfuscatedOpenTelemetry(OpenTelemetry delegate) {
+      this.delegate = delegate;
+    }
+
+    @Override
+    public TracerProvider getTracerProvider() {
+      return delegate.getTracerProvider();
+    }
+
+    @Override
+    public MeterProvider getMeterProvider() {
+      return delegate.getMeterProvider();
+    }
+
+    @Override
+    public LoggerProvider getLogsBridge() {
+      return delegate.getLogsBridge();
+    }
+
+    @Override
+    public ContextPropagators getPropagators() {
+      return delegate.getPropagators();
+    }
+
+    @Override
+    public TracerBuilder tracerBuilder(String instrumentationScopeName) {
+      return delegate.tracerBuilder(instrumentationScopeName);
+    }
+  }
 }

api/incubator/src/main/java/io/opentelemetry/api/incubator/internal/ObfuscatedExtendedOpenTelemetry.java

@@ -0,0 +1,63 @@
+package io.opentelemetry.api.incubator.internal;
+
+import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.api.incubator.ExtendedOpenTelemetry;
+import io.opentelemetry.api.incubator.config.ConfigProvider;
+import io.opentelemetry.api.logs.LoggerProvider;
+import io.opentelemetry.api.metrics.MeterProvider;
+import io.opentelemetry.api.trace.TracerBuilder;
+import io.opentelemetry.api.trace.TracerProvider;
+import io.opentelemetry.context.propagation.ContextPropagators;
+import javax.annotation.concurrent.ThreadSafe;
+
+/**
+ * Static global instances 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 (OpenTelemetrySdk) GlobalOpenTelemetry.get()}.
+ *
+ * <p>This class is internal and is hence not for public use. Its APIs are unstable and can change
+ * at any time.
+ */
+@ThreadSafe
+public final class ObfuscatedExtendedOpenTelemetry implements ExtendedOpenTelemetry {
+
+  private final ExtendedOpenTelemetry delegate;
+
+  /**
+   * This constructor is called via reflection from {@link
+   * io.opentelemetry.api.internal.IncubatingUtil#obfuscatedOpenTelemetry(OpenTelemetry)}
+   */
+  public ObfuscatedExtendedOpenTelemetry(ExtendedOpenTelemetry delegate) {
+    this.delegate = delegate;
+  }
+
+  @Override
+  public TracerProvider getTracerProvider() {
+    return delegate.getTracerProvider();
+  }
+
+  @Override
+  public MeterProvider getMeterProvider() {
+    return delegate.getMeterProvider();
+  }
+
+  @Override
+  public LoggerProvider getLogsBridge() {
+    return delegate.getLogsBridge();
+  }
+
+  @Override
+  public ContextPropagators getPropagators() {
+    return delegate.getPropagators();
+  }
+
+  @Override
+  public TracerBuilder tracerBuilder(String instrumentationScopeName) {
+    return delegate.tracerBuilder(instrumentationScopeName);
+  }
+
+  @Override
+  public ConfigProvider getConfigProvider() {
+    return delegate.getConfigProvider();
+  }
+}

api/incubator/src/test/java/io/opentelemetry/api/incubator/ExtendedOpenTelemetryTest.java

@@ -7,6 +7,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
+import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.api.incubator.logs.ExtendedDefaultLoggerProvider;
 import io.opentelemetry.api.incubator.logs.ExtendedLogger;
@@ -19,6 +20,11 @@
 import io.opentelemetry.api.testing.internal.AbstractOpenTelemetryTest;
 import io.opentelemetry.api.trace.TracerProvider;
 import io.opentelemetry.context.propagation.ContextPropagators;
+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 org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
 class ExtendedOpenTelemetryTest extends AbstractOpenTelemetryTest {
@@ -38,12 +44,26 @@ protected LoggerProvider getLoggerProvider() {
     return ExtendedDefaultLoggerProvider.getNoop();
   }
 
+  @BeforeEach
+  void setUp() {
+    GlobalOpenTelemetry.resetForTest();
+  }
+
   @Test
   void incubatingApiIsLoaded() {
     assertIsExtended(OpenTelemetry.noop());
     assertIsExtended(OpenTelemetry.propagating(ContextPropagators.noop()));
   }
 
+  @Test
+  void globalOpenTelemetry() {
+    GlobalOpenTelemetry.set(
+        ExtendedOpenTelemetrySdk.create(
+            OpenTelemetrySdk.builder().build(),
+            SdkConfigProvider.create(new OpenTelemetryConfigurationModel())));
+    assertThat(GlobalOpenTelemetry.get()).isInstanceOf(ExtendedOpenTelemetry.class);
+  }
+
   private static void assertIsExtended(OpenTelemetry openTelemetry) {
     assertThat(openTelemetry.getMeter("test").counterBuilder("test"))
         .isInstanceOf(ExtendedLongCounterBuilder.class);