use DeclarativeConfigUtil for library config usage (#15656)

Co-authored-by: Abhilash Garapati <abhilashgarapati12@gmail.com>

Author: zeitlinger

declarative-config-bridge/src/main/java/io/opentelemetry/instrumentation/config/bridge/ConfigPropertiesBackedDeclarativeConfigProperties.java

@@ -73,10 +73,17 @@ public final class ConfigPropertiesBackedDeclarativeConfigProperties
     SPECIAL_MAPPINGS.put(
         "java.common.gen_ai.capture_message_content",
         "otel.instrumentation.genai.capture-message-content");
+    // top-level common configs
+    SPECIAL_MAPPINGS.put(
+        "java.common.span_suppression_strategy/development",
+        "otel.instrumentation.experimental.span-suppression-strategy");
     // renaming to match instrumentation module name
     SPECIAL_MAPPINGS.put(
         "java.opentelemetry_extension_annotations.exclude_methods",
         "otel.instrumentation.opentelemetry-annotations.exclude-methods");
+    // renaming to avoid top level config
+    SPECIAL_MAPPINGS.put(
+        "java.servlet.javascript_snippet/development", "otel.experimental.javascript-snippet");
   }
 
   private final ConfigProperties configProperties;

instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/InstrumenterBuilder.java

@@ -5,11 +5,14 @@
 
 package io.opentelemetry.instrumentation.api.instrumenter;
 
+import static io.opentelemetry.api.incubator.config.DeclarativeConfigProperties.empty;
 import static java.util.Objects.requireNonNull;
 import static java.util.logging.Level.WARNING;
 
 import com.google.errorprone.annotations.CanIgnoreReturnValue;
 import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.api.incubator.ExtendedOpenTelemetry;
+import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
 import io.opentelemetry.api.metrics.Meter;
 import io.opentelemetry.api.metrics.MeterBuilder;
 import io.opentelemetry.api.trace.SpanKind;
@@ -48,11 +51,7 @@
 public final class InstrumenterBuilder<REQUEST, RESPONSE> {
 
   private static final Logger logger = Logger.getLogger(InstrumenterBuilder.class.getName());
-
-  private static final SpanSuppressionStrategy spanSuppressionStrategy =
-      SpanSuppressionStrategy.fromConfig(
-          ConfigPropertiesUtil.getString(
-              "otel.instrumentation.experimental.span-suppression-strategy"));
+  private static final boolean supportsDeclarativeConfig = supportsDeclarativeConfig();
 
   final OpenTelemetry openTelemetry;
   final String instrumentationName;
@@ -76,6 +75,20 @@ public final class InstrumenterBuilder<REQUEST, RESPONSE> {
   boolean propagateOperationListenersToOnEnd = false;
   boolean enabled = true;
 
+  private static boolean supportsDeclarativeConfig() {
+    try {
+      Class.forName("io.opentelemetry.api.incubator.ExtendedOpenTelemetry");
+      return true;
+    } catch (ClassNotFoundException e) {
+      // The incubator module is not available.
+      // This only happens in OpenTelemetry API instrumentation tests, where an older version of
+      // OpenTelemetry API is used that does not have ExtendedOpenTelemetry.
+      // Having the incubator module without ExtendedOpenTelemetry class should still return false
+      // for those tests to avoid a ClassNotFoundException.
+      return false;
+    }
+  }
+
   static {
     Experimental.internalAddOperationListenerAttributesExtractor(
         (builder, operationListenerAttributesExtractor) ->
@@ -374,7 +387,28 @@ private String getSchemaUrl() {
 
   SpanSuppressor buildSpanSuppressor() {
     return new SpanSuppressors.ByContextKey(
-        spanSuppressionStrategy.create(getSpanKeysFromAttributesExtractors()));
+        SpanSuppressionStrategy.fromConfig(getSpanSuppressionStrategy())
+            .create(getSpanKeysFromAttributesExtractors()));
+  }
+
+  @Nullable
+  private String getSpanSuppressionStrategy() {
+    // we cannot use DeclarativeConfigUtil here because it's not available in instrumentation-api
+    if (maybeDeclarativeConfig(openTelemetry)) {
+      DeclarativeConfigProperties instrumentationConfig =
+          ((ExtendedOpenTelemetry) openTelemetry).getConfigProvider().getInstrumentationConfig();
+      if (instrumentationConfig == null) {
+        return null;
+      }
+
+      return instrumentationConfig
+          .getStructured("java", empty())
+          .getStructured("common", empty())
+          .getString("span_suppression_strategy/development");
+    } else {
+      return ConfigPropertiesUtil.getString(
+          "otel.instrumentation.experimental.span-suppression-strategy");
+    }
   }
 
   private Set<SpanKey> getSpanKeysFromAttributesExtractors() {
@@ -454,6 +488,15 @@ public void setSpanStatusExtractorCustomizer(
     }
   }
 
+  /**
+   * Returns true if the current classpath supports declarative config and the instance may support
+   * declarative config (the agent implements ExtendedOpenTelemetry even when declarative config
+   * isn't used).
+   */
+  private static boolean maybeDeclarativeConfig(OpenTelemetry openTelemetry) {
+    return supportsDeclarativeConfig && openTelemetry instanceof ExtendedOpenTelemetry;
+  }
+
   private interface InstrumenterConstructor<RQ, RS> {
     Instrumenter<RQ, RS> create(InstrumenterBuilder<RQ, RS> builder);
 

instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/internal/ConfigPropertiesUtil.java

@@ -17,11 +17,38 @@
  */
 public final class ConfigPropertiesUtil {
 
+  /**
+   * Returns the boolean value of the given property name from system properties and environment
+   * variables.
+   *
+   * <p>It's recommended to use {@link io.opentelemetry.api.incubator.config.ConfigProvider} instead
+   * to support Declarative Config.
+   */
   public static boolean getBoolean(String propertyName, boolean defaultValue) {
+    Boolean value = getBoolean(propertyName);
+    return value == null ? defaultValue : value;
+  }
+
+  /**
+   * Returns the boolean value of the given property name from system properties and environment
+   * variables.
+   *
+   * <p>It's recommended to use {@link io.opentelemetry.api.incubator.config.ConfigProvider} instead
+   * to support Declarative Config.
+   */
+  @Nullable
+  public static Boolean getBoolean(String propertyName) {
     String strValue = getString(propertyName);
-    return strValue == null ? defaultValue : Boolean.parseBoolean(strValue);
+    return strValue == null ? null : Boolean.parseBoolean(strValue);
   }
 
+  /**
+   * Returns the int value of the given property name from system properties and environment
+   * variables.
+   *
+   * <p>It's recommended to use {@link io.opentelemetry.api.incubator.config.ConfigProvider} instead
+   * to support Declarative Config.
+   */
   public static int getInt(String propertyName, int defaultValue) {
     String strValue = getString(propertyName);
     if (strValue == null) {
@@ -34,6 +61,13 @@ public static int getInt(String propertyName, int defaultValue) {
     }
   }
 
+  /**
+   * Returns the string value of the given property name from system properties and environment
+   * variables.
+   *
+   * <p>It's recommended to use {@link io.opentelemetry.api.incubator.config.ConfigProvider} instead
+   * to support Declarative Config.
+   */
   @Nullable
   public static String getString(String propertyName) {
     String value = System.getProperty(propertyName);
@@ -43,11 +77,26 @@ public static String getString(String propertyName) {
     return System.getenv(toEnvVarName(propertyName));
   }
 
+  /**
+   * Returns the string value of the given property name from system properties and environment
+   * variables, or the default value if not found.
+   *
+   * <p>It's recommended to use {@link io.opentelemetry.api.incubator.config.ConfigProvider} instead
+   * to support Declarative Config.
+   */
   public static String getString(String propertyName, String defaultValue) {
     String strValue = getString(propertyName);
     return strValue == null ? defaultValue : strValue;
   }
 
+  /**
+   * Returns the list of strings value of the given property name from system properties and
+   * environment variables, or the default value if not found. The property value is expected to be
+   * a comma-separated list.
+   *
+   * <p>It's recommended to use {@link io.opentelemetry.api.incubator.config.ConfigProvider} instead
+   * to support Declarative Config.
+   */
   public static List<String> getList(String propertyName, List<String> defaultValue) {
     String value = getString(propertyName);
     if (value == null) {

instrumentation/aws-sdk/aws-sdk-1.11/library-autoconfigure/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/autoconfigure/TracingRequestHandler.java

@@ -12,6 +12,9 @@
 import com.amazonaws.Response;
 import com.amazonaws.handlers.RequestHandler2;
 import io.opentelemetry.api.GlobalOpenTelemetry;
+import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.instrumentation.api.incubator.config.internal.DeclarativeConfigUtil;
+import io.opentelemetry.instrumentation.api.incubator.config.internal.ExtendedDeclarativeConfigProperties;
 import io.opentelemetry.instrumentation.api.internal.ConfigPropertiesUtil;
 import io.opentelemetry.instrumentation.awssdk.v1_11.AwsSdkTelemetry;
 
@@ -20,19 +23,35 @@
  */
 public class TracingRequestHandler extends RequestHandler2 {
 
-  private static final RequestHandler2 DELEGATE =
-      AwsSdkTelemetry.builder(GlobalOpenTelemetry.get())
-          .setCaptureExperimentalSpanAttributes(
-              ConfigPropertiesUtil.getBoolean(
-                  "otel.instrumentation.aws-sdk.experimental-span-attributes", false))
-          .setMessagingReceiveTelemetryEnabled(
-              ConfigPropertiesUtil.getBoolean(
-                  "otel.instrumentation.messaging.experimental.receive-telemetry.enabled", false))
-          .setCapturedHeaders(
-              ConfigPropertiesUtil.getList(
-                  "otel.instrumentation.messaging.experimental.capture-headers", emptyList()))
-          .build()
-          .newRequestHandler();
+  private static final RequestHandler2 DELEGATE = buildDelegate(GlobalOpenTelemetry.get());
+
+  private static RequestHandler2 buildDelegate(OpenTelemetry openTelemetry) {
+    ExtendedDeclarativeConfigProperties messaging =
+        DeclarativeConfigUtil.getInstrumentationConfig(openTelemetry, "common").get("messaging");
+    return AwsSdkTelemetry.builder(openTelemetry)
+        .setCaptureExperimentalSpanAttributes(
+            DeclarativeConfigUtil.getInstrumentationConfig(openTelemetry, "aws_sdk")
+                .getBoolean(
+                    "experimental_span_attributes/development",
+                    ConfigPropertiesUtil.getBoolean(
+                        "otel.instrumentation.aws-sdk.experimental-span-attributes", false)))
+        .setMessagingReceiveTelemetryEnabled(
+            messaging
+                .get("receive_telemetry/development")
+                .getBoolean(
+                    "enabled",
+                    ConfigPropertiesUtil.getBoolean(
+                        "otel.instrumentation.messaging.experimental.receive-telemetry.enabled",
+                        false)))
+        .setCapturedHeaders(
+            messaging.getScalarList(
+                "capture_headers/development",
+                String.class,
+                ConfigPropertiesUtil.getList(
+                    "otel.instrumentation.messaging.experimental.capture-headers", emptyList())))
+        .build()
+        .newRequestHandler();
+  }
 
   @Override
   public void beforeRequest(Request<?> request) {

instrumentation/aws-sdk/aws-sdk-2.2/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/awssdk/v2_2/AwsSdkSingletons.java

@@ -6,36 +6,15 @@
 package io.opentelemetry.javaagent.instrumentation.awssdk.v2_2;
 
 import io.opentelemetry.instrumentation.awssdk.v2_2.AwsSdkTelemetry;
-import io.opentelemetry.instrumentation.awssdk.v2_2.internal.AbstractAwsSdkTelemetryFactory;
-import io.opentelemetry.javaagent.bootstrap.internal.AgentInstrumentationConfig;
-import io.opentelemetry.javaagent.bootstrap.internal.ExperimentalConfig;
-import java.util.List;
+import io.opentelemetry.instrumentation.awssdk.v2_2.internal.AwsSdkTelemetryFactory;
 
 public final class AwsSdkSingletons {
 
-  private static final AwsSdkTelemetry TELEMETRY = new AwsSdkTelemetryFactory().telemetry();
+  private static final AwsSdkTelemetry TELEMETRY = AwsSdkTelemetryFactory.telemetry();
 
   public static AwsSdkTelemetry telemetry() {
     return TELEMETRY;
   }
 
-  private static class AwsSdkTelemetryFactory extends AbstractAwsSdkTelemetryFactory {
-
-    @Override
-    protected List<String> getCapturedHeaders() {
-      return ExperimentalConfig.get().getMessagingHeaders();
-    }
-
-    @Override
-    protected boolean messagingReceiveTelemetryEnabled() {
-      return ExperimentalConfig.get().messagingReceiveInstrumentationEnabled();
-    }
-
-    @Override
-    protected boolean getBoolean(String name, boolean defaultValue) {
-      return AgentInstrumentationConfig.get().getBoolean(name, defaultValue);
-    }
-  }
-
   private AwsSdkSingletons() {}
 }

instrumentation/aws-sdk/aws-sdk-2.2/library-autoconfigure/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/autoconfigure/AwsSdkSingletons.java

@@ -5,40 +5,16 @@
 
 package io.opentelemetry.instrumentation.awssdk.v2_2.autoconfigure;
 
-import static java.util.Collections.emptyList;
-
-import io.opentelemetry.instrumentation.api.internal.ConfigPropertiesUtil;
 import io.opentelemetry.instrumentation.awssdk.v2_2.AwsSdkTelemetry;
-import io.opentelemetry.instrumentation.awssdk.v2_2.internal.AbstractAwsSdkTelemetryFactory;
-import java.util.List;
+import io.opentelemetry.instrumentation.awssdk.v2_2.internal.AwsSdkTelemetryFactory;
 
 public final class AwsSdkSingletons {
 
-  private static final AwsSdkTelemetry TELEMETRY = new AwsSdkTelemetryFactory().telemetry();
+  private static final AwsSdkTelemetry TELEMETRY = AwsSdkTelemetryFactory.legacyLibraryTelemetry();
 
   public static AwsSdkTelemetry telemetry() {
     return TELEMETRY;
   }
 
-  private static class AwsSdkTelemetryFactory extends AbstractAwsSdkTelemetryFactory {
-
-    @Override
-    protected List<String> getCapturedHeaders() {
-      return ConfigPropertiesUtil.getList(
-          "otel.instrumentation.messaging.experimental.capture-headers", emptyList());
-    }
-
-    @Override
-    protected boolean messagingReceiveTelemetryEnabled() {
-      return ConfigPropertiesUtil.getBoolean(
-          "otel.instrumentation.messaging.experimental.receive-telemetry.enabled", false);
-    }
-
-    @Override
-    protected boolean getBoolean(String name, boolean defaultValue) {
-      return ConfigPropertiesUtil.getBoolean(name, defaultValue);
-    }
-  }
-
   private AwsSdkSingletons() {}
 }