Migrate annotation instrumentation to declarative config API

Author: trask

instrumentation/opentelemetry-extension-annotations-1.0/javaagent/build.gradle.kts

@@ -39,4 +39,16 @@ tasks {
   test {
     jvmArgs("-Dotel.instrumentation.opentelemetry-annotations.exclude-methods=io.opentelemetry.test.annotation.TracedWithSpan[ignored]")
   }
+
+  val testDeclarativeConfig by registering(Test::class) {
+    testClassesDirs = sourceSets.test.get().output.classesDirs
+    classpath = sourceSets.test.get().runtimeClasspath
+    jvmArgs(
+      "-Dotel.experimental.config.file=$projectDir/src/test/resources/declarative-config.yaml"
+    )
+  }
+
+  check {
+    dependsOn(testDeclarativeConfig)
+  }
 }

instrumentation/opentelemetry-extension-annotations-1.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/extensionannotations/WithSpanInstrumentation.java

@@ -22,6 +22,7 @@
 import io.opentelemetry.context.Scope;
 import io.opentelemetry.instrumentation.api.annotation.support.async.AsyncOperationEndSupport;
 import io.opentelemetry.instrumentation.api.incubator.config.internal.DeclarativeConfigUtil;
+import io.opentelemetry.instrumentation.api.incubator.config.internal.ExtendedDeclarativeConfigProperties;
 import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
@@ -97,10 +98,9 @@ static ElementMatcher.Junction<MethodDescription> configureExcludedMethods() {
     ElementMatcher.Junction<MethodDescription> result = none();
 
     Map<String, Set<String>> excludedMethods =
-        MethodsConfigurationParser.parse(
+        MethodsConfigurationParser.parseExcludeMethods(
             DeclarativeConfigUtil.getInstrumentationConfig(
-                    GlobalOpenTelemetry.get(), "opentelemetry_extension_annotations")
-                .getString("exclude_methods"));
+                GlobalOpenTelemetry.get(), "opentelemetry_extension_annotations"));
     for (Map.Entry<String, Set<String>> entry : excludedMethods.entrySet()) {
       String className = entry.getKey();
       ElementMatcher.Junction<ByteCodeElement> matcher =

instrumentation/opentelemetry-extension-annotations-1.0/javaagent/src/test/resources/declarative-config.yaml

@@ -0,0 +1,8 @@
+file_format: "1.0-rc.1"
+instrumentation/development:
+  java:
+    opentelemetry_extension_annotations:
+      exclude_methods:
+        - class: io.opentelemetry.test.annotation.TracedWithSpan
+          methods:
+            - ignored

instrumentation/opentelemetry-instrumentation-annotations-1.16/javaagent/build.gradle.kts

@@ -41,4 +41,16 @@ tasks {
   test {
     jvmArgs("-Dotel.instrumentation.opentelemetry-instrumentation-annotations.exclude-methods=io.opentelemetry.test.annotation.TracedWithSpan[ignored]")
   }
+
+  val testDeclarativeConfig by registering(Test::class) {
+    testClassesDirs = sourceSets.test.get().output.classesDirs
+    classpath = sourceSets.test.get().runtimeClasspath
+    jvmArgs(
+      "-Dotel.experimental.config.file=$projectDir/src/test/resources/declarative-config.yaml"
+    )
+  }
+
+  check {
+    dependsOn(testDeclarativeConfig)
+  }
 }

instrumentation/opentelemetry-instrumentation-annotations-1.16/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/instrumentationannotations/AnnotationExcludedMethods.java

@@ -11,6 +11,7 @@
 
 import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.instrumentation.api.incubator.config.internal.DeclarativeConfigUtil;
+import io.opentelemetry.instrumentation.api.incubator.config.internal.ExtendedDeclarativeConfigProperties;
 import io.opentelemetry.javaagent.tooling.config.MethodsConfigurationParser;
 import java.util.Map;
 import java.util.Set;
@@ -29,10 +30,9 @@ public static ElementMatcher.Junction<MethodDescription> configureExcludedMethod
     ElementMatcher.Junction<MethodDescription> result = none();
 
     Map<String, Set<String>> excludedMethods =
-        MethodsConfigurationParser.parse(
+        MethodsConfigurationParser.parseExcludeMethods(
             DeclarativeConfigUtil.getInstrumentationConfig(
-                    GlobalOpenTelemetry.get(), "opentelemetry_instrumentation_annotations")
-                .getString("exclude_methods"));
+                GlobalOpenTelemetry.get(), "opentelemetry_instrumentation_annotations"));
     for (Map.Entry<String, Set<String>> entry : excludedMethods.entrySet()) {
       String className = entry.getKey();
       ElementMatcher.Junction<ByteCodeElement> matcher =

instrumentation/opentelemetry-instrumentation-annotations-1.16/javaagent/src/test/resources/declarative-config.yaml

@@ -0,0 +1,8 @@
+file_format: "1.0-rc.1"
+instrumentation/development:
+  java:
+    opentelemetry_instrumentation_annotations:
+      exclude_methods:
+        - class: io.opentelemetry.test.annotation.TracedWithSpan
+          methods:
+            - ignored

javaagent-tooling/src/main/java/io/opentelemetry/javaagent/tooling/config/MethodsConfigurationParser.java

@@ -5,14 +5,20 @@
 
 package io.opentelemetry.javaagent.tooling.config;
 
+import static java.util.Collections.emptyList;
+import static java.util.Collections.emptyMap;
 import static java.util.logging.Level.WARNING;
 
+import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
+import io.opentelemetry.instrumentation.api.incubator.config.internal.ExtendedDeclarativeConfigProperties;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.HashSet;
+import java.util.List;
 import java.util.Map;
 import java.util.Set;
 import java.util.logging.Logger;
+import java.util.stream.Collectors;
 
 public final class MethodsConfigurationParser {
 
@@ -23,6 +29,49 @@ public final class MethodsConfigurationParser {
   private static final String CONFIG_FORMAT =
       PACKAGE_CLASS_NAME_REGEX + "(?:\\[" + METHOD_LIST_REGEX + "])?";
 
+  /**
+   * Parse exclude methods configuration from declarative config.
+   *
+   * <p>First tries structured declarative config (YAML format), then falls back to old string/list
+   * property format for backward compatibility.
+   *
+   * <p>Example YAML structure:
+   *
+   * <pre>{@code
+   * exclude_methods:
+   *   - class: com.example.MyClass
+   *     methods: [method1, method2]
+   *   - class: com.example.AnotherClass
+   *     methods: [someMethod]
+   * }</pre>
+   */
+  public static Map<String, Set<String>> parseExcludeMethods(
+      ExtendedDeclarativeConfigProperties config) {
+    // First try structured declarative config (YAML format)
+    List<DeclarativeConfigProperties> excludeList = config.getStructuredList("exclude_methods");
+    if (excludeList != null) {
+      return excludeList.stream()
+          .filter(
+              entry -> {
+                String className = entry.getString("class");
+                return className != null && !className.isEmpty();
+              })
+          .collect(
+              Collectors.toMap(
+                  entry -> entry.getString("class"),
+                  entry ->
+                      new HashSet<>(entry.getScalarList("methods", String.class, emptyList()))));
+    }
+
+    // Fall back to old string property format for backward compatibility
+    String excludeMethodsString = config.getString("exclude_methods");
+    if (excludeMethodsString != null) {
+      return parse(excludeMethodsString);
+    }
+
+    return emptyMap();
+  }
+
   /**
    * This method takes a string in a form of {@code
    * "io.package.ClassName[method1,method2];my.example[someMethodName];"} and returns a map where
@@ -32,13 +81,13 @@ public final class MethodsConfigurationParser {
    */
   public static Map<String, Set<String>> parse(String configString) {
     if (configString == null || configString.trim().isEmpty()) {
-      return Collections.emptyMap();
+      return emptyMap();
     } else if (!validateConfigString(configString)) {
       logger.log(
           WARNING,
           "Invalid trace method config \"{0}\". Must match 'package.Class$Name[method1,method2];*'.",
           configString);
-      return Collections.emptyMap();
+      return emptyMap();
     } else {
       Map<String, Set<String>> toTrace = new HashMap<>();
       String[] classMethods = configString.split(";", -1);