add support for missing list properties in spring starter

Author: zeitlinger

docs/apidiffs/current_vs_latest/opentelemetry-spring-boot-autoconfigure.txt

@@ -1,2 +1,5 @@
 Comparing source compatibility of opentelemetry-spring-boot-autoconfigure-2.9.0-SNAPSHOT.jar against opentelemetry-spring-boot-autoconfigure-2.8.0.jar
-No changes.
+===  UNCHANGED CLASS: PUBLIC io.opentelemetry.instrumentation.spring.autoconfigure.OpenTelemetryAutoConfiguration  (not serializable)
+	===  CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+	***  MODIFIED ANNOTATION: org.springframework.boot.context.properties.EnableConfigurationProperties
+		***  MODIFIED ELEMENT: value=io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.OtlpExporterProperties,io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.OtelResourceProperties,io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.SpringOtelProperties (<- io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.OtlpExporterProperties,io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.OtelResourceProperties,io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.PropagationProperties)

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

@@ -11,8 +11,8 @@
 import io.opentelemetry.instrumentation.spring.autoconfigure.internal.SdkEnabled;
 import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.OtelResourceProperties;
 import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.OtlpExporterProperties;
-import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.PropagationProperties;
 import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.SpringConfigProperties;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.SpringOtelProperties;
 import io.opentelemetry.instrumentation.spring.autoconfigure.internal.resources.DistroVersionResourceProvider;
 import io.opentelemetry.instrumentation.spring.autoconfigure.internal.resources.SpringResourceProvider;
 import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
@@ -51,7 +51,7 @@
 @EnableConfigurationProperties({
   OtlpExporterProperties.class,
   OtelResourceProperties.class,
-  PropagationProperties.class
+  SpringOtelProperties.class
 })
 public class OpenTelemetryAutoConfiguration {
 
@@ -90,7 +90,7 @@ public AutoConfiguredOpenTelemetrySdk autoConfiguredOpenTelemetrySdk(
         Environment env,
         OtlpExporterProperties otlpExporterProperties,
         OtelResourceProperties resourceProperties,
-        PropagationProperties propagationProperties,
+        SpringOtelProperties springOtelProperties,
         OpenTelemetrySdkComponentLoader componentLoader) {
 
       return AutoConfigureUtil.setComponentLoader(
@@ -101,7 +101,7 @@ public AutoConfiguredOpenTelemetrySdk autoConfiguredOpenTelemetrySdk(
                           env,
                           otlpExporterProperties,
                           resourceProperties,
-                          propagationProperties,
+                          springOtelProperties,
                           c)),
               componentLoader)
           .build();

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

@@ -7,13 +7,15 @@
 
 import io.opentelemetry.api.internal.ConfigUtil;
 import io.opentelemetry.exporter.otlp.internal.OtlpConfigUtil;
+import io.opentelemetry.instrumentation.resources.ResourceProviderPropertiesCustomizer;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import io.opentelemetry.sdk.autoconfigure.spi.internal.DefaultConfigProperties;
 import java.time.Duration;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.function.Function;
 import javax.annotation.Nullable;
 import org.springframework.core.env.Environment;
 import org.springframework.expression.ExpressionParser;
@@ -29,37 +31,87 @@ public class SpringConfigProperties implements ConfigProperties {
   private final ExpressionParser parser;
   private final OtlpExporterProperties otlpExporterProperties;
   private final OtelResourceProperties resourceProperties;
-  private final PropagationProperties propagationProperties;
+  private final SpringOtelProperties springOtelProperties;
   private final ConfigProperties otelSdkProperties;
+  private final ConfigProperties customizedResourceProviderProperties;
+
+  private static final Map<String, Function<SpringOtelProperties, List<String>>> LIST_PROPERTIES =
+      new HashMap<>();
+
+  static final String DISABLED_KEY = "otel.java.disabled.resource.providers";
+  static final String ENABLED_KEY = "otel.java.enabled.resource.providers";
+
+  static {
+    LIST_PROPERTIES.put(ENABLED_KEY, SpringOtelProperties::getJavaEnabledResourceProviders);
+    LIST_PROPERTIES.put(DISABLED_KEY, SpringOtelProperties::getJavaDisabledResourceProviders);
+    LIST_PROPERTIES.put(
+        "otel.experimental.metrics.view.config",
+        SpringOtelProperties::getExperimentalMetricsViewConfig);
+    LIST_PROPERTIES.put(
+        "otel.experimental.resource.disabled.keys",
+        SpringOtelProperties::getExperimentalResourceDisabledKeys);
+    LIST_PROPERTIES.put("otel.propagators", SpringOtelProperties::getPropagators);
+  }
 
   public SpringConfigProperties(
       Environment environment,
       ExpressionParser parser,
       OtlpExporterProperties otlpExporterProperties,
       OtelResourceProperties resourceProperties,
-      PropagationProperties propagationProperties,
+      SpringOtelProperties springOtelProperties,
       ConfigProperties otelSdkProperties) {
     this.environment = environment;
     this.parser = parser;
     this.otlpExporterProperties = otlpExporterProperties;
     this.resourceProperties = resourceProperties;
-    this.propagationProperties = propagationProperties;
+    this.springOtelProperties = springOtelProperties;
     this.otelSdkProperties = otelSdkProperties;
+    this.customizedResourceProviderProperties =
+        createCustomizedProperties(otelSdkProperties, springOtelProperties);
+  }
+
+  private static void addList(
+      Map<String, String> map, String key, List<String> list, ConfigProperties configProperties) {
+    if (!list.isEmpty()) {
+      map.put(key, String.join(",", list));
+    } else {
+      String defaultValue = configProperties.getString(key);
+      if (defaultValue != null) {
+        map.put(key, defaultValue);
+      }
+    }
+  }
+
+  private static ConfigProperties createCustomizedProperties(
+      ConfigProperties configProperties, SpringOtelProperties springOtelProperties) {
+    // find a better way to do this
+    Map<String, String> map = new HashMap<>();
+    addList(
+        map, ENABLED_KEY, springOtelProperties.getJavaEnabledResourceProviders(), configProperties);
+    addList(
+        map,
+        DISABLED_KEY,
+        springOtelProperties.getJavaDisabledResourceProviders(),
+        configProperties);
+
+    return DefaultConfigProperties.createFromMap(
+        new ResourceProviderPropertiesCustomizer()
+            .customize(DefaultConfigProperties.createFromMap(map)));
   }
 
   // visible for testing
   public static ConfigProperties create(
       Environment env,
       OtlpExporterProperties otlpExporterProperties,
       OtelResourceProperties resourceProperties,
-      PropagationProperties propagationProperties,
+      SpringOtelProperties springOtelProperties,
       ConfigProperties fallback) {
     return new SpringConfigProperties(
         env,
         new SpelExpressionParser(),
         otlpExporterProperties,
         resourceProperties,
-        propagationProperties,
+        springOtelProperties,
         fallback);
   }
 
@@ -114,8 +166,13 @@ public List<String> getList(String name) {
 
     String normalizedName = ConfigUtil.normalizeEnvironmentVariableKey(name);
 
-    if (normalizedName.equals("otel.propagators")) {
-      return propagationProperties.getPropagators();
+    Function<SpringOtelProperties, List<String>> get = LIST_PROPERTIES.get(normalizedName);
+    if (get != null) {
+      List<String> c = customizedResourceProviderProperties.getList(name);
+      if (!c.isEmpty()) {
+        return c;
+      }
+      return get.apply(springOtelProperties);
     }
 
     return or(environment.getProperty(normalizedName, List.class), otelSdkProperties.getList(name));