suppress instrumentation: move to api + generic context key (#6546)

Author: SylvainJuge

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

@@ -0,0 +1,40 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.api.internal;
+
+import io.opentelemetry.context.Context;
+import io.opentelemetry.context.ContextKey;
+import java.util.Objects;
+
+/**
+ * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+ * any time.
+ */
+public final class InstrumentationUtil {
+  private static final ContextKey<Boolean> SUPPRESS_INSTRUMENTATION_KEY =
+      ContextKey.named("suppress_instrumentation");
+
+  private InstrumentationUtil() {}
+
+  /**
+   * Adds a Context boolean key that will allow to identify HTTP calls coming from OTel exporters.
+   * The key later be checked by an automatic instrumentation to avoid tracing OTel exporter's
+   * calls.
+   */
+  public static void suppressInstrumentation(Runnable runnable) {
+    Context.current().with(SUPPRESS_INSTRUMENTATION_KEY, true).wrap(runnable).run();
+  }
+
+  /**
+   * Checks if an automatic instrumentation should be suppressed with the provided Context.
+   *
+   * @return TRUE to suppress the automatic instrumentation, FALSE to continue with the
+   *     instrumentation.
+   */
+  public static boolean shouldSuppressInstrumentation(Context context) {
+    return Objects.equals(context.get(SUPPRESS_INSTRUMENTATION_KEY), true);
+  }
+}

api/all/src/test/java/io/opentelemetry/api/internal/InstrumentationUtilTest.java

@@ -0,0 +1,27 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.api.internal;
+
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import io.opentelemetry.context.Context;
+import org.junit.jupiter.api.Test;
+
+class InstrumentationUtilTest {
+  @Test
+  void verifySuppressInstrumentation() {
+    // Should be false by default.
+    assertFalse(InstrumentationUtil.shouldSuppressInstrumentation(Context.current()));
+
+    // Should be true inside the Runnable passed to InstrumentationUtil.suppressInstrumentation.
+    InstrumentationUtil.suppressInstrumentation(
+        () -> assertTrue(InstrumentationUtil.shouldSuppressInstrumentation(Context.current())));
+
+    // Should be false after the runnable finishes.
+    assertFalse(InstrumentationUtil.shouldSuppressInstrumentation(Context.current()));
+  }
+}

exporters/common/src/main/java/io/opentelemetry/exporter/internal/InstrumentationUtil.java

@@ -6,16 +6,16 @@
 package io.opentelemetry.exporter.internal;
 
 import io.opentelemetry.context.Context;
-import io.opentelemetry.context.ContextKey;
-import java.util.Objects;
 
 /**
  * This class is internal and is hence not for public use. Its APIs are unstable and can change at
- * any time.
+ * any time
+ *
+ * @deprecated use {@link io.opentelemetry.api.internal.InstrumentationUtil} instead. This class
+ *     should be removed once instrumentation does not refer to it anymore.
  */
+@Deprecated
 public final class InstrumentationUtil {
-  private static final ContextKey<Boolean> SUPPRESS_INSTRUMENTATION_KEY =
-      ContextKey.named("suppress_internal_exporter_instrumentation");
 
   private InstrumentationUtil() {}
 
@@ -25,7 +25,7 @@ private InstrumentationUtil() {}
    * calls.
    */
   public static void suppressInstrumentation(Runnable runnable) {
-    Context.current().with(SUPPRESS_INSTRUMENTATION_KEY, true).wrap(runnable).run();
+    io.opentelemetry.api.internal.InstrumentationUtil.suppressInstrumentation(runnable);
   }
 
   /**
@@ -35,6 +35,6 @@ public static void suppressInstrumentation(Runnable runnable) {
    *     instrumentation.
    */
   public static boolean shouldSuppressInstrumentation(Context context) {
-    return Objects.equals(context.get(SUPPRESS_INSTRUMENTATION_KEY), true);
+    return io.opentelemetry.api.internal.InstrumentationUtil.shouldSuppressInstrumentation(context);
   }
 }

exporters/common/src/test/java/io/opentelemetry/exporter/internal/InstrumentationUtilTest.java

@@ -12,7 +12,10 @@
 import org.junit.jupiter.api.Test;
 
 class InstrumentationUtilTest {
+
+  // testing deprecated implementation until it's removed
   @Test
+  @SuppressWarnings("deprecation")
   void verifySuppressInstrumentation() {
     // Should be false by default.
     assertFalse(InstrumentationUtil.shouldSuppressInstrumentation(Context.current()));

exporters/sender/okhttp/src/main/java/io/opentelemetry/exporter/sender/okhttp/internal/OkHttpGrpcSender.java

@@ -23,7 +23,7 @@
 
 package io.opentelemetry.exporter.sender.okhttp.internal;
 
-import io.opentelemetry.exporter.internal.InstrumentationUtil;
+import io.opentelemetry.api.internal.InstrumentationUtil;
 import io.opentelemetry.exporter.internal.RetryUtil;
 import io.opentelemetry.exporter.internal.compression.Compressor;
 import io.opentelemetry.exporter.internal.grpc.GrpcExporterUtil;

exporters/sender/okhttp/src/main/java/io/opentelemetry/exporter/sender/okhttp/internal/OkHttpHttpSender.java

@@ -5,7 +5,7 @@
 
 package io.opentelemetry.exporter.sender.okhttp.internal;
 
-import io.opentelemetry.exporter.internal.InstrumentationUtil;
+import io.opentelemetry.api.internal.InstrumentationUtil;
 import io.opentelemetry.exporter.internal.RetryUtil;
 import io.opentelemetry.exporter.internal.auth.Authenticator;
 import io.opentelemetry.exporter.internal.compression.Compressor;

exporters/sender/okhttp/src/test/java/io/opentelemetry/exporter/sender/okhttp/internal/AbstractOkHttpSuppressionTest.java

@@ -7,8 +7,8 @@
 
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
+import io.opentelemetry.api.internal.InstrumentationUtil;
 import io.opentelemetry.context.Context;
-import io.opentelemetry.exporter.internal.InstrumentationUtil;
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.atomic.AtomicBoolean;
 import org.junit.jupiter.api.AfterEach;