declarative config: early init and property mapping (#14184)

Co-authored-by: otelbot <[email protected]>

Author: zeitlinger

instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/config/internal/CommonConfig.java

@@ -7,13 +7,17 @@
 
 import static java.util.Collections.emptyMap;
 
+import io.opentelemetry.api.incubator.config.ConfigProvider;
+import io.opentelemetry.api.incubator.config.InstrumentationConfigUtil;
 import io.opentelemetry.instrumentation.api.incubator.log.LoggingContextConstants;
 import io.opentelemetry.instrumentation.api.incubator.semconv.net.PeerServiceResolver;
 import io.opentelemetry.instrumentation.api.internal.HttpConstants;
 import java.util.ArrayList;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Set;
+import java.util.function.Function;
+import java.util.function.Supplier;
 
 /**
  * This class is internal and is hence not for public use. Its APIs are unstable and can change at
@@ -39,16 +43,32 @@ public final class CommonConfig {
   public CommonConfig(InstrumentationConfig config) {
     peerServiceResolver =
         PeerServiceResolver.create(
-            config.getMap("otel.instrumentation.common.peer-service-mapping", emptyMap()));
+            getFromConfigProviderOrFallback(
+                config,
+                InstrumentationConfigUtil::peerServiceMapping,
+                () ->
+                    config.getMap("otel.instrumentation.common.peer-service-mapping", emptyMap())));
 
     clientRequestHeaders =
-        config.getList("otel.instrumentation.http.client.capture-request-headers");
+        getFromConfigProviderOrFallback(
+            config,
+            InstrumentationConfigUtil::httpClientRequestCapturedHeaders,
+            () -> config.getList("otel.instrumentation.http.client.capture-request-headers"));
     clientResponseHeaders =
-        config.getList("otel.instrumentation.http.client.capture-response-headers");
+        getFromConfigProviderOrFallback(
+            config,
+            InstrumentationConfigUtil::httpClientResponseCapturedHeaders,
+            () -> config.getList("otel.instrumentation.http.client.capture-response-headers"));
     serverRequestHeaders =
-        config.getList("otel.instrumentation.http.server.capture-request-headers");
+        getFromConfigProviderOrFallback(
+            config,
+            InstrumentationConfigUtil::httpServerRequestCapturedHeaders,
+            () -> config.getList("otel.instrumentation.http.server.capture-request-headers"));
     serverResponseHeaders =
-        config.getList("otel.instrumentation.http.server.capture-response-headers");
+        getFromConfigProviderOrFallback(
+            config,
+            InstrumentationConfigUtil::httpServerResponseCapturedHeaders,
+            () -> config.getList("otel.instrumentation.http.server.capture-response-headers"));
     knownHttpRequestMethods =
         new HashSet<>(
             config.getList(
@@ -130,4 +150,15 @@ public String getSpanIdKey() {
   public String getTraceFlagsKey() {
     return loggingTraceFlagsKey;
   }
+
+  private static <T> T getFromConfigProviderOrFallback(
+      InstrumentationConfig config,
+      Function<ConfigProvider, T> getFromConfigProvider,
+      Supplier<T> fallback) {
+    ConfigProvider configProvider = config.getConfigProvider();
+    if (configProvider != null) {
+      return getFromConfigProvider.apply(configProvider);
+    }
+    return fallback.get();
+  }
 }

instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/config/internal/InstrumentationConfig.java

@@ -7,6 +7,7 @@
 
 import static java.util.Collections.emptyList;
 
+import io.opentelemetry.api.incubator.config.ConfigProvider;
 import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
 import java.time.Duration;
 import java.util.List;
@@ -109,17 +110,30 @@ default List<String> getList(String name) {
    */
   Map<String, String> getMap(String name, Map<String, String> defaultValue);
 
+  /** Returns {@code true} if declarative configuration is used in this configuration. */
+  boolean isDeclarative();
+
   /**
-   * Returns a {@link DeclarativeConfigProperties} for the given instrumentation name, or {@code
-   * null} if no declarative configuration is available for that instrumentation.
+   * Returns a {@link DeclarativeConfigProperties} for the given node name, which is usually an
+   * instrumentation name
+   *
+   * <p>Call {@link #isDeclarative()} first to check if declarative configuration is used.
    *
    * <p>Declarative configuration is used to configure instrumentation properties in a declarative
    * way, such as through YAML or JSON files.
    *
-   * @param instrumentationName the name of the instrumentation
-   * @return the declarative configuration properties for the given instrumentation name, or {@code
-   *     null} if not available
+   * @param node the name of the instrumentation (e.g. "log4j"), the vendor name (e.g. "google"), or
+   *     "common" for common Java settings that don't apply to other languages.
+   * @return the declarative configuration properties for the given node name
+   * @throws IllegalStateException if {@link #isDeclarative()} returns {@code false}
+   */
+  DeclarativeConfigProperties getDeclarativeConfig(String node);
+
+  /**
+   * Returns the {@link ConfigProvider} if declarative configuration is used.
+   *
+   * @return the {@link ConfigProvider} or {@code null} if no provider is available
    */
   @Nullable
-  DeclarativeConfigProperties getDeclarativeConfig(String instrumentationName);
+  ConfigProvider getConfigProvider();
 }

instrumentation/jmx-metrics/javaagent/src/main/java/io/opentelemetry/instrumentation/javaagent/jmx/JmxMetricInsightInstaller.java

@@ -14,8 +14,8 @@
 import io.opentelemetry.instrumentation.jmx.engine.MetricConfiguration;
 import io.opentelemetry.instrumentation.jmx.yaml.RuleParser;
 import io.opentelemetry.javaagent.extension.AgentListener;
-import io.opentelemetry.javaagent.extension.internal.ConfigPropertiesUtil;
 import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
+import io.opentelemetry.sdk.autoconfigure.internal.AutoConfigureUtil;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import java.io.InputStream;
 import java.nio.file.Files;
@@ -29,7 +29,7 @@ public class JmxMetricInsightInstaller implements AgentListener {
 
   @Override
   public void afterAgent(AutoConfiguredOpenTelemetrySdk autoConfiguredSdk) {
-    ConfigProperties config = ConfigPropertiesUtil.resolveConfigProperties(autoConfiguredSdk);
+    ConfigProperties config = AutoConfigureUtil.getConfig(autoConfiguredSdk);
 
     if (config.getBoolean("otel.jmx.enabled", true)) {
       JmxMetricInsight service =

instrumentation/methods/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/methods/MethodInstrumentationModule.java

@@ -10,8 +10,8 @@
 import static java.util.Collections.singletonMap;
 
 import com.google.auto.service.AutoService;
-import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
 import io.opentelemetry.api.trace.SpanKind;
+import io.opentelemetry.instrumentation.api.incubator.config.internal.InstrumentationConfig;
 import io.opentelemetry.javaagent.bootstrap.internal.AgentInstrumentationConfig;
 import io.opentelemetry.javaagent.extension.instrumentation.InstrumentationModule;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
@@ -34,10 +34,11 @@ public MethodInstrumentationModule() {
   }
 
   private static List<TypeInstrumentation> createInstrumentations() {
-    DeclarativeConfigProperties methods =
-        AgentInstrumentationConfig.get().getDeclarativeConfig("methods");
+    InstrumentationConfig config = AgentInstrumentationConfig.get();
     List<TypeInstrumentation> list =
-        methods != null ? MethodsConfig.parseDeclarativeConfig(methods) : parseConfigProperties();
+        config.isDeclarative()
+            ? MethodsConfig.parseDeclarativeConfig(config.getDeclarativeConfig("methods"))
+            : parseConfigProperties();
     // ensure that there is at least one instrumentation so that muzzle reference collection could
     // work
     if (list.isEmpty()) {

instrumentation/oshi/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/oshi/OshiMetricsInstaller.java

@@ -7,8 +7,8 @@
 
 import com.google.auto.service.AutoService;
 import io.opentelemetry.javaagent.extension.AgentListener;
-import io.opentelemetry.javaagent.extension.internal.ConfigPropertiesUtil;
 import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
+import io.opentelemetry.sdk.autoconfigure.internal.AutoConfigureUtil;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import java.lang.reflect.Method;
 
@@ -21,7 +21,7 @@ public class OshiMetricsInstaller implements AgentListener {
 
   @Override
   public void afterAgent(AutoConfiguredOpenTelemetrySdk autoConfiguredSdk) {
-    ConfigProperties config = ConfigPropertiesUtil.resolveConfigProperties(autoConfiguredSdk);
+    ConfigProperties config = AutoConfigureUtil.getConfig(autoConfiguredSdk);
 
     boolean defaultEnabled = config.getBoolean("otel.instrumentation.common.default-enabled", true);
     if (!config.getBoolean("otel.instrumentation.oshi.enabled", defaultEnabled)) {

instrumentation/runtime-telemetry/runtime-telemetry-java8/javaagent/src/main/java/io/opentelemetry/instrumentation/javaagent/runtimemetrics/java8/JarAnalyzerInstaller.java

@@ -7,9 +7,9 @@
 
 import com.google.auto.service.AutoService;
 import io.opentelemetry.javaagent.bootstrap.InstrumentationHolder;
-import io.opentelemetry.javaagent.extension.internal.ConfigPropertiesUtil;
 import io.opentelemetry.javaagent.tooling.BeforeAgentListener;
 import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
+import io.opentelemetry.sdk.autoconfigure.internal.AutoConfigureUtil;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import java.lang.instrument.Instrumentation;
 
@@ -19,8 +19,7 @@ public class JarAnalyzerInstaller implements BeforeAgentListener {
 
   @Override
   public void beforeAgent(AutoConfiguredOpenTelemetrySdk autoConfiguredOpenTelemetrySdk) {
-    ConfigProperties config =
-        ConfigPropertiesUtil.resolveConfigProperties(autoConfiguredOpenTelemetrySdk);
+    ConfigProperties config = AutoConfigureUtil.getConfig(autoConfiguredOpenTelemetrySdk);
 
     boolean enabled =
         config.getBoolean("otel.instrumentation.runtime-telemetry.package-emitter.enabled", false);

instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/ConfigPropertiesBridge.java

@@ -5,6 +5,7 @@
 
 package io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties;
 
+import io.opentelemetry.api.incubator.config.ConfigProvider;
 import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
 import io.opentelemetry.instrumentation.api.incubator.config.internal.InstrumentationConfig;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
@@ -110,10 +111,21 @@ public Map<String, String> getMap(String name, Map<String, String> defaultValue)
     }
   }
 
+  @Override
+  public boolean isDeclarative() {
+    return false;
+  }
+
+  @Override
+  public DeclarativeConfigProperties getDeclarativeConfig(String node) {
+    throw new IllegalStateException(
+        "Declarative configuration is not supported in spring boot autoconfigure yet");
+  }
+
   @Nullable
   @Override
-  public DeclarativeConfigProperties getDeclarativeConfig(String instrumentationName) {
-    // create a spring boot bridge for DeclarativeConfigProperties
+  public ConfigProvider getConfigProvider() {
+    // declarative config support will be added in the future
     return null;
   }
 }

javaagent-extension-api/src/main/java/io/opentelemetry/javaagent/bootstrap/internal/EmptyInstrumentationConfig.java

@@ -5,6 +5,7 @@
 
 package io.opentelemetry.javaagent.bootstrap.internal;
 
+import io.opentelemetry.api.incubator.config.ConfigProvider;
 import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
 import io.opentelemetry.instrumentation.api.incubator.config.internal.InstrumentationConfig;
 import java.time.Duration;
@@ -60,9 +61,20 @@ public Map<String, String> getMap(String name, Map<String, String> defaultValue)
     return defaultValue;
   }
 
+  @Override
+  public boolean isDeclarative() {
+    return false;
+  }
+
+  @Override
+  public DeclarativeConfigProperties getDeclarativeConfig(String node) {
+    throw new IllegalStateException(
+        "Declarative configuration is not supported in the empty instrumentation config");
+  }
+
   @Nullable
   @Override
-  public DeclarativeConfigProperties getDeclarativeConfig(String instrumentationName) {
+  public ConfigProvider getConfigProvider() {
     return null;
   }
 }