fix spring declarative config with env var substitution (#15775)

Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>

Author: zeitlinger

instrumentation/spring/spring-boot-autoconfigure/build.gradle.kts

@@ -302,6 +302,8 @@ tasks {
 
     // required on jdk17
     jvmArgs("--add-opens=java.base/java.lang=ALL-UNNAMED")
+    // for @SetEnvironmentVariable
+    jvmArgs("--add-opens=java.base/java.util=ALL-UNNAMED")
     jvmArgs("-XX:+IgnoreUnrecognizedVMOptions")
   }
 

instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/EmbeddedConfigFile.java

@@ -46,25 +46,20 @@ class EmbeddedConfigFile {
   private EmbeddedConfigFile() {}
 
   static OpenTelemetryConfigurationModel extractModel(ConfigurableEnvironment environment) {
-    Map<String, Object> props = extractSpringProperties(environment);
-    Map<String, Object> nested = convertFlatPropsToNested(props);
-    return MAPPER.convertValue(nested, OpenTelemetryConfigurationModel.class);
+    Map<String, String> props = extractSpringProperties(environment);
+    return convertToOpenTelemetryConfigurationModel(props);
   }
 
-  private static Map<String, Object> extractSpringProperties(ConfigurableEnvironment environment) {
+  private static Map<String, String> extractSpringProperties(ConfigurableEnvironment environment) {
     MutablePropertySources propertySources = environment.getPropertySources();
 
-    Map<String, Object> props = new HashMap<>();
+    Map<String, String> props = new HashMap<>();
     for (PropertySource<?> propertySource : propertySources) {
       if (propertySource instanceof EnumerablePropertySource<?>) {
         for (String propertyName :
             ((EnumerablePropertySource<?>) propertySource).getPropertyNames()) {
           if (propertyName.startsWith("otel.")) {
-            Object property = propertySource.getProperty(propertyName);
-            // Resolve ${} placeholders in String values while preserving types for others
-            if (property instanceof String) {
-              property = environment.resolvePlaceholders((String) property);
-            }
+            String property = environment.getProperty(propertyName);
             if (Objects.equals(property, "")) {
               property = null; // spring returns empty string for yaml null
             }
@@ -100,18 +95,29 @@ private static Map<String, Object> extractSpringProperties(ConfigurableEnvironme
     return props;
   }
 
+  static OpenTelemetryConfigurationModel convertToOpenTelemetryConfigurationModel(
+      Map<String, String> flatProps) {
+    Map<String, Object> nested = convertFlatPropsToNested(flatProps);
+
+    return MAPPER.convertValue(nested, OpenTelemetryConfigurationModel.class);
+  }
+
+  static ObjectMapper getObjectMapper() {
+    return MAPPER;
+  }
+
   /**
    * Convert flat property map to nested structure. e.g. "otel.instrumentation.java.list[0]" = "one"
    * and "otel.instrumentation.java.list[1]" = "two" becomes: {otel: {instrumentation: {java: {list:
    * ["one", "two"]}}}}
    */
   @SuppressWarnings("unchecked")
-  static Map<String, Object> convertFlatPropsToNested(Map<String, Object> flatProps) {
+  static Map<String, Object> convertFlatPropsToNested(Map<String, String> flatProps) {
     Map<String, Object> result = new HashMap<>();
 
-    for (Map.Entry<String, Object> entry : flatProps.entrySet()) {
+    for (Map.Entry<String, String> entry : flatProps.entrySet()) {
       String key = entry.getKey();
-      Object value = entry.getValue();
+      String value = entry.getValue();
 
       // Split the key by dots
       String[] parts = key.split("\\.");

instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfiguration.java

@@ -7,7 +7,6 @@
 
 import static java.util.Collections.emptyMap;
 import static java.util.Objects.requireNonNull;
-import static java.util.stream.Collectors.toList;
 
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.api.incubator.ExtendedOpenTelemetry;
@@ -45,6 +44,7 @@
 import java.util.Optional;
 import java.util.function.Function;
 import java.util.function.Supplier;
+import java.util.stream.Collectors;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
@@ -164,12 +164,12 @@ public OpenTelemetryConfigurationModel openTelemetryConfigurationModel(
       @Bean
       public OpenTelemetry openTelemetry(
           OpenTelemetryConfigurationModel model, ApplicationContext applicationContext) {
-        OpenTelemetrySdk sdk =
-            DeclarativeConfiguration.create(
-                model, new OpenTelemetrySdkComponentLoader(applicationContext));
+        OpenTelemetrySdkComponentLoader componentLoader =
+            new OpenTelemetrySdkComponentLoader(applicationContext);
+        OpenTelemetrySdk sdk = DeclarativeConfiguration.create(model, componentLoader);
         Runtime.getRuntime().addShutdownHook(new Thread(sdk::close));
         logStart();
-        return sdk;
+        return new SpringOpenTelemetrySdk(sdk, SpringConfigProvider.create(model, componentLoader));
       }
 
       /**
@@ -272,7 +272,7 @@ public OpenTelemetrySdkComponentLoader(ApplicationContext applicationContext) {
     public <T> Iterable<T> load(Class<T> spiClass) {
       List<T> spi = spiHelper.load(spiClass);
       List<T> beans =
-          applicationContext.getBeanProvider(spiClass).orderedStream().collect(toList());
+          applicationContext.getBeanProvider(spiClass).orderedStream().collect(Collectors.toList());
       spi.addAll(beans);
       return spi;
     }

instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/SpringConfigProvider.java

@@ -0,0 +1,68 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.spring.autoconfigure;
+
+import static java.util.Collections.emptyMap;
+
+import com.fasterxml.jackson.core.type.TypeReference;
+import io.opentelemetry.api.incubator.config.ConfigProvider;
+import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
+import io.opentelemetry.common.ComponentLoader;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.OpenTelemetryConfigurationModel;
+import java.util.Map;
+
+/**
+ * Spring flavor of {@link io.opentelemetry.sdk.extension.incubator.fileconfig.SdkConfigProvider}
+ * that tries to coerce types, because spring doesn't tell what the original type was.
+ *
+ * <p>The entire class is a copy of <a
+ * href="https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/SdkConfigProvider.java">SdkConfigProvider</a>
+ * which uses {@link SpringDeclarativeConfigProperties} instead of {@link
+ * io.opentelemetry.sdk.extension.incubator.fileconfig.YamlDeclarativeConfigProperties}.
+ */
+final class SpringConfigProvider implements ConfigProvider {
+
+  private final DeclarativeConfigProperties instrumentationConfig;
+
+  private SpringConfigProvider(
+      OpenTelemetryConfigurationModel model, ComponentLoader componentLoader) {
+    DeclarativeConfigProperties configProperties = toConfigProperties(model, componentLoader);
+    this.instrumentationConfig = configProperties.get("instrumentation/development");
+  }
+
+  private static DeclarativeConfigProperties toConfigProperties(
+      OpenTelemetryConfigurationModel model, ComponentLoader componentLoader) {
+    Map<String, Object> configurationMap =
+        EmbeddedConfigFile.getObjectMapper()
+            .convertValue(model, new TypeReference<Map<String, Object>>() {});
+    if (configurationMap == null) {
+      configurationMap = emptyMap();
+    }
+    return SpringDeclarativeConfigProperties.create(configurationMap, componentLoader);
+  }
+
+  /**
+   * Create a {@link SpringConfigProvider} from the {@code model}.
+   *
+   * @param model the configuration model
+   * @param componentLoader the component loader
+   * @return the {@link SpringConfigProvider}
+   */
+  static SpringConfigProvider create(
+      OpenTelemetryConfigurationModel model, ComponentLoader componentLoader) {
+    return new SpringConfigProvider(model, componentLoader);
+  }
+
+  @Override
+  public DeclarativeConfigProperties getInstrumentationConfig() {
+    return instrumentationConfig;
+  }
+
+  @Override
+  public String toString() {
+    return "SpringConfigProvider{instrumentationConfig=" + instrumentationConfig + '}';
+  }
+}