Instrument new GlobalOpenTelemetry methods introduced in 1.57 (#15620)

Co-authored-by: Gregor Zeitlinger <[email protected]>
Co-authored-by: Trask Stalnaker <[email protected]>

Author: 3 people

.fossa.yml

@@ -838,6 +838,9 @@ targets:
     - type: gradle
       path: ./
       target: ':instrumentation:opentelemetry-api:opentelemetry-api-1.56:javaagent'
+    - type: gradle
+      path: ./
+      target: ':instrumentation:opentelemetry-api:opentelemetry-api-1.57:javaagent'
     - type: gradle
       path: ./
       target: ':instrumentation:pekko:pekko-actor-1.0:javaagent'

docs/instrumentation-list.yaml

@@ -12071,6 +12071,10 @@ internal:
   source_path: instrumentation/opentelemetry-api/opentelemetry-api-1.56
   scope:
     name: io.opentelemetry.opentelemetry-api-1.56
+- name: opentelemetry-api-1.57
+  source_path: instrumentation/opentelemetry-api/opentelemetry-api-1.57
+  scope:
+    name: io.opentelemetry.opentelemetry-api-1.57
 - name: opentelemetry-instrumentation-api
   source_path: instrumentation/opentelemetry-instrumentation-api
   scope:

instrumentation/opentelemetry-api/opentelemetry-api-1.57/javaagent/build.gradle.kts

@@ -0,0 +1,7 @@
+plugins {
+  id("otel.javaagent-instrumentation")
+}
+
+dependencies {
+  compileOnly(project(":opentelemetry-api-shaded-for-instrumenting", configuration = "v1_57"))
+}

instrumentation/opentelemetry-api/opentelemetry-api-1.57/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/opentelemetryapi/v1_57/OpenTelemetryApInstrumentationModule.java

@@ -0,0 +1,39 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.opentelemetryapi.v1_57;
+
+import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
+import static java.util.Collections.singletonList;
+
+import com.google.auto.service.AutoService;
+import io.opentelemetry.javaagent.extension.instrumentation.InstrumentationModule;
+import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
+import io.opentelemetry.javaagent.extension.instrumentation.internal.ExperimentalInstrumentationModule;
+import java.util.List;
+import net.bytebuddy.matcher.ElementMatcher;
+
+@AutoService(InstrumentationModule.class)
+public class OpenTelemetryApInstrumentationModule extends InstrumentationModule
+    implements ExperimentalInstrumentationModule {
+  public OpenTelemetryApInstrumentationModule() {
+    super("opentelemetry-api", "opentelemetry-api-1.57");
+  }
+
+  @Override
+  public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
+    return hasClassesNamed("application.io.opentelemetry.api.GlobalOpenTelemetry");
+  }
+
+  @Override
+  public List<TypeInstrumentation> typeInstrumentations() {
+    return singletonList(new OpenTelemetryInstrumentation());
+  }
+
+  @Override
+  public String getModuleGroup() {
+    return "opentelemetry-api-bridge";
+  }
+}

instrumentation/opentelemetry-api/opentelemetry-api-1.57/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/opentelemetryapi/v1_57/OpenTelemetryInstrumentation.java

@@ -0,0 +1,63 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.opentelemetryapi.v1_57;
+
+import static net.bytebuddy.matcher.ElementMatchers.isMethod;
+import static net.bytebuddy.matcher.ElementMatchers.isStatic;
+import static net.bytebuddy.matcher.ElementMatchers.named;
+import static net.bytebuddy.matcher.ElementMatchers.returns;
+import static net.bytebuddy.matcher.ElementMatchers.takesArguments;
+
+import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
+import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
+import net.bytebuddy.asm.Advice;
+import net.bytebuddy.asm.Advice.AssignReturned;
+import net.bytebuddy.description.type.TypeDescription;
+import net.bytebuddy.matcher.ElementMatcher;
+
+public class OpenTelemetryInstrumentation implements TypeInstrumentation {
+
+  @Override
+  public ElementMatcher<TypeDescription> typeMatcher() {
+    return named("application.io.opentelemetry.api.GlobalOpenTelemetry");
+  }
+
+  @Override
+  public void transform(TypeTransformer transformer) {
+    transformer.applyAdviceToMethod(
+        isMethod()
+            .and(isStatic())
+            .and(named("isSet"))
+            .and(takesArguments(0))
+            .and(returns(boolean.class)),
+        OpenTelemetryInstrumentation.class.getName() + "$IsSetAdvice");
+    transformer.applyAdviceToMethod(
+        isMethod()
+            .and(isStatic())
+            .and(named("getOrNoop"))
+            .and(takesArguments(0))
+            .and(returns(named("application.io.opentelemetry.api.OpenTelemetry"))),
+        OpenTelemetryInstrumentation.class.getName() + "$GetOrNoopAdvice");
+  }
+
+  @SuppressWarnings("unused")
+  public static class IsSetAdvice {
+    @AssignReturned.ToReturned
+    @Advice.OnMethodExit
+    public static boolean methodExit() {
+      return true;
+    }
+  }
+
+  @SuppressWarnings("unused")
+  public static class GetOrNoopAdvice {
+    @AssignReturned.ToReturned
+    @Advice.OnMethodExit
+    public static application.io.opentelemetry.api.OpenTelemetry methodExit() {
+      return application.io.opentelemetry.api.GlobalOpenTelemetry.get();
+    }
+  }
+}

instrumentation/opentelemetry-api/opentelemetry-api-1.57/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/opentelemetryapi/v1_57/GlobalOpenTelemetryTest.java

@@ -0,0 +1,28 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.opentelemetryapi.v1_57;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import io.opentelemetry.api.GlobalOpenTelemetry;
+import io.opentelemetry.instrumentation.testing.junit.AgentInstrumentationExtension;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+class GlobalOpenTelemetryTest {
+  @RegisterExtension
+  static final AgentInstrumentationExtension testing = AgentInstrumentationExtension.create();
+
+  @Test
+  void isSet() {
+    assertThat(GlobalOpenTelemetry.isSet()).isTrue();
+  }
+
+  @Test
+  void getOrNoop() {
+    assertThat(GlobalOpenTelemetry.getOrNoop()).isEqualTo(GlobalOpenTelemetry.get());
+  }
+}

instrumentation/opentelemetry-api/opentelemetry-api-1.57/metadata.yaml

@@ -0,0 +1 @@
+classification: internal

javaagent/build.gradle.kts

@@ -91,6 +91,7 @@ dependencies {
   baseJavaagentLibs(project(":instrumentation:opentelemetry-api:opentelemetry-api-1.50:javaagent"))
   baseJavaagentLibs(project(":instrumentation:opentelemetry-api:opentelemetry-api-1.52:javaagent"))
   baseJavaagentLibs(project(":instrumentation:opentelemetry-api:opentelemetry-api-1.56:javaagent"))
+  baseJavaagentLibs(project(":instrumentation:opentelemetry-api:opentelemetry-api-1.57:javaagent"))
   baseJavaagentLibs(project(":instrumentation:opentelemetry-instrumentation-api:javaagent"))
   baseJavaagentLibs(project(":instrumentation:opentelemetry-instrumentation-annotations-1.16:javaagent"))
   baseJavaagentLibs(project(":instrumentation:executors:javaagent"))

opentelemetry-api-shaded-for-instrumenting/build.gradle.kts

@@ -100,6 +100,13 @@ val v1_56Deps by configurations.creating {
   exclude("io.opentelemetry", "opentelemetry-bom")
   exclude("io.opentelemetry", "opentelemetry-bom-alpha")
 }
+val v1_57Deps by configurations.creating {
+  isCanBeResolved = true
+  isCanBeConsumed = false
+  // exclude the bom added by dependencyManagement
+  exclude("io.opentelemetry", "opentelemetry-bom")
+  exclude("io.opentelemetry", "opentelemetry-bom-alpha")
+}
 // configuration for publishing the shadowed artifact
 val v1_10 by configurations.creating {
   isCanBeConsumed = true
@@ -153,6 +160,10 @@ val v1_56 by configurations.creating {
   isCanBeConsumed = true
   isCanBeResolved = false
 }
+val v1_57 by configurations.creating {
+  isCanBeConsumed = true
+  isCanBeResolved = false
+}
 
 dependencies {
   latestDeps("io.opentelemetry:opentelemetry-api")
@@ -239,6 +250,11 @@ dependencies {
         strictly("1.56.0-alpha")
       }
     }
+    v1_57Deps("io.opentelemetry:$it") {
+      version {
+        strictly("1.57.0-alpha")
+      }
+    }
   }
 }
 
@@ -306,6 +322,10 @@ tasks {
     configurations = listOf(v1_56Deps)
     archiveClassifier.set("v1_56")
   }
+  val v1_57Shadow by registering(ShadowJar::class) {
+    configurations = listOf(v1_57Deps)
+    archiveClassifier.set("v1_57")
+  }
 
   artifacts {
     add(v1_10.name, v1_10Shadow)
@@ -321,5 +341,6 @@ tasks {
     add(v1_50.name, v1_50Shadow)
     add(v1_52.name, v1_52Shadow)
     add(v1_56.name, v1_56Shadow)
+    add(v1_57.name, v1_57Shadow)
   }
 }

settings.gradle.kts

@@ -505,6 +505,7 @@ include(":instrumentation:opentelemetry-api:opentelemetry-api-1.47:javaagent")
 include(":instrumentation:opentelemetry-api:opentelemetry-api-1.50:javaagent")
 include(":instrumentation:opentelemetry-api:opentelemetry-api-1.52:javaagent")
 include(":instrumentation:opentelemetry-api:opentelemetry-api-1.56:javaagent")
+include(":instrumentation:opentelemetry-api:opentelemetry-api-1.57:javaagent")
 include(":instrumentation:opentelemetry-extension-annotations-1.0:javaagent")
 include(":instrumentation:opentelemetry-extension-kotlin-1.0:javaagent")
 include(":instrumentation:opentelemetry-instrumentation-annotations-1.16:javaagent")