Remove getOrSet, restore isSet

Author: jack-berg

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

@@ -46,21 +46,20 @@
  *       not the OpenTelemetry javaagent is installed.
  * </ul>
  *
- * <p>Applications with custom instrumentation should call {@link #getOrSet(Supplier)} once during
- * initialization, and pass the resulting instance around manually (or with dependency injection) to
- * install custom instrumentation. This results in the following behavior:
+ * <p>Applications with custom instrumentation should call {@link #isSet()} once during
+ * initialization to access the javaagent instance or initialize (e.g. {@code isSet() ?
+ * GlobalOpenTelemetry.get() : initializeSdk()}), and pass the resulting instance around manually
+ * (or with dependency injection) to install custom instrumentation. This results in the following
+ * behavior:
  *
  * <ul>
  *   <li>If the OpenTelemetry javaagent is installed, custom instrumentation will use the {@link
  *       OpenTelemetry} it installs.
- *   <li>If the OpenTelemetry javaagent is not installed, custom instrumentation will use the {@link
- *       OpenTelemetry} instance returned by {@link Supplier} passed to {@link #getOrSet(Supplier)}.
+ *   <li>If the OpenTelemetry javaagent is not installed, custom instrumentation will use an {@link
+ *       OpenTelemetry} instance initialized by the application.
  * </ul>
- *
- * @see TracerProvider
- * @see ContextPropagators
  */
-// We intentionally assign to be use for error reporting.
+// We intentionally assign for error reporting.
 @SuppressWarnings("StaticAssignmentOfThrowable")
 public final class GlobalOpenTelemetry {
 
@@ -102,26 +101,14 @@ public static OpenTelemetry getOrNoop() {
   }
 
   /**
-   * Returns the registered global {@link OpenTelemetry} if set, or else calls {@link
-   * #set(Supplier)} with the {@code supplier}.
-   *
-   * <p>NOTE: if the global instance is set, the response is obfuscated to prevent callers from
-   * casting to SDK implementation instances and inappropriately accessing non-instrumentation APIs.
-   *
-   * <p>NOTE: This does not result in the {@link #set(OpenTelemetry)} side effects of {@link
-   * #get()}.
+   * Returns {@code true} if {@link GlobalOpenTelemetry} is set, otherwise {@code false}.
    *
    * <p>Application custom instrumentation should use this method during initialization. See class
    * javadoc for more details.
    */
-  public static OpenTelemetry getOrSet(Supplier<OpenTelemetry> supplier) {
+  public static boolean isSet() {
     synchronized (mutex) {
-      if (globalOpenTelemetry == null) {
-        OpenTelemetry openTelemetry = supplier.get();
-        set(openTelemetry);
-        return openTelemetry;
-      }
-      return globalOpenTelemetry;
+      return globalOpenTelemetry != null;
     }
   }
 
@@ -133,11 +120,11 @@ public static OpenTelemetry getOrSet(Supplier<OpenTelemetry> supplier) {
    * <p>NOTE: all returned instanced are obfuscated to prevent callers from casting to SDK
    * implementation instances and inappropriately accessing non-instrumentation APIs.
    *
-   * <p>Native instrumentations should use {@link #getOrNoop()} instad. See class javadoc for more
+   * <p>Native instrumentations should use {@link #getOrNoop()} instead. See class javadoc for more
    * details.
    *
-   * <p>Application custom instrumentation should use {@link #getOrSet(Supplier)} instead. See class
-   * javadoc for more details.
+   * <p>Application custom instrumentation should use {@link #isSet()} and only call this if the
+   * response is {@code true}. See class javadoc for more details.
    *
    * <p>If the global instance has not been set, and {@code
    * io.opentelemetry:opentelemetry-sdk-extension-autoconfigure} is present, and {@value

api/testing-internal/src/main/java/io/opentelemetry/api/testing/internal/AbstractOpenTelemetryTest.java

@@ -14,8 +14,6 @@
 import io.opentelemetry.api.metrics.MeterProvider;
 import io.opentelemetry.api.trace.TracerProvider;
 import io.opentelemetry.context.propagation.ContextPropagators;
-import java.util.concurrent.atomic.AtomicInteger;
-import java.util.function.Supplier;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
@@ -88,9 +86,9 @@ void independentNonGlobalPropagators() {
 
   @Test
   void setThenSet() {
-    assertThat(GlobalOpenTelemetry.getOrNoop()).isSameAs(OpenTelemetry.noop());
+    assertThat(GlobalOpenTelemetry.isSet()).isFalse();
     setOpenTelemetry();
-    assertThat(GlobalOpenTelemetry.getOrNoop()).isNotSameAs(OpenTelemetry.noop());
+    assertThat(GlobalOpenTelemetry.isSet()).isTrue();
     assertThatThrownBy(() -> GlobalOpenTelemetry.set(getOpenTelemetry()))
         .isInstanceOf(IllegalStateException.class)
         .hasMessageContaining("GlobalOpenTelemetry.set has already been called")
@@ -99,7 +97,9 @@ void setThenSet() {
 
   @Test
   void getThenSet() {
+    assertThat(GlobalOpenTelemetry.isSet()).isFalse();
     assertThat(GlobalOpenTelemetry.getOrNoop()).isSameAs(OpenTelemetry.noop());
+
     // Calling GlobalOpenTelemetry.get() has the side affect of setting GlobalOpenTelemetry to an
     // (obfuscated) noop.
     // Call GlobalOpenTelemetry.get() using a utility method so we can later assert it was
@@ -111,7 +111,10 @@ void getThenSet() {
                     .isEqualTo("io.opentelemetry.api.GlobalOpenTelemetry$ObfuscatedOpenTelemetry"))
         .extracting("delegate")
         .isSameAs(OpenTelemetry.noop());
+
+    assertThat(GlobalOpenTelemetry.isSet()).isTrue();
     assertThat(GlobalOpenTelemetry.getOrNoop()).isNotSameAs(OpenTelemetry.noop());
+
     assertThatThrownBy(() -> GlobalOpenTelemetry.set(getOpenTelemetry()))
         .isInstanceOf(IllegalStateException.class)
         .hasMessageContaining("GlobalOpenTelemetry.set has already been called")
@@ -131,42 +134,6 @@ void getOrNoop() {
     assertThat(GlobalOpenTelemetry.getOrNoop()).isNotSameAs(OpenTelemetry.noop());
   }
 
-  @Test
-  void getOrSet_NotPreviouslySet() {
-    AtomicInteger supplierCallCount = new AtomicInteger();
-    Supplier<OpenTelemetry> supplier =
-        () -> {
-          supplierCallCount.incrementAndGet();
-          return OpenTelemetry.noop();
-        };
-
-    assertThat(GlobalOpenTelemetry.getOrSet(supplier)).isSameAs(OpenTelemetry.noop());
-    assertThat(supplierCallCount.get()).isEqualTo(1);
-
-    // The second time getOrSet is called, we get an obfuscated instance
-    assertThat(GlobalOpenTelemetry.getOrSet(supplier).getClass().getName())
-        .isEqualTo("io.opentelemetry.api.GlobalOpenTelemetry$ObfuscatedOpenTelemetry");
-    assertThat(supplierCallCount.get()).isEqualTo(1);
-  }
-
-  @Test
-  void getOrSet_PreviouslySet() {
-    setOpenTelemetry();
-
-    AtomicInteger supplierCallCount = new AtomicInteger();
-    Supplier<OpenTelemetry> supplier =
-        () -> {
-          supplierCallCount.incrementAndGet();
-          return OpenTelemetry.noop();
-        };
-
-    assertThat(GlobalOpenTelemetry.getOrSet(supplier).getClass().getName())
-        .isEqualTo("io.opentelemetry.api.GlobalOpenTelemetry$ObfuscatedOpenTelemetry");
-    assertThat(GlobalOpenTelemetry.getOrSet(supplier).getClass().getName())
-        .isEqualTo("io.opentelemetry.api.GlobalOpenTelemetry$ObfuscatedOpenTelemetry");
-    assertThat(supplierCallCount.get()).isEqualTo(0);
-  }
-
   @Test
   void toString_noop_Valid() {
     assertThat(getOpenTelemetry().toString())

docs/apidiffs/current_vs_latest/opentelemetry-api.txt

@@ -2,4 +2,4 @@ Comparing source compatibility of opentelemetry-api-1.57.0-SNAPSHOT.jar against
 ***  MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.api.GlobalOpenTelemetry  (not serializable)
 	===  CLASS FILE FORMAT VERSION: 52.0 <- 52.0
 	+++  NEW METHOD: PUBLIC(+) STATIC(+) io.opentelemetry.api.OpenTelemetry getOrNoop()
-	+++  NEW METHOD: PUBLIC(+) STATIC(+) io.opentelemetry.api.OpenTelemetry getOrSet(java.util.function.Supplier<io.opentelemetry.api.OpenTelemetry>)
+	+++  NEW METHOD: PUBLIC(+) STATIC(+) boolean isSet()