Spring starter declarative config

.fossa.yml

@@ -40,6 +40,9 @@ targets:
     - type: gradle
       path: ./
       target: ':sdk-autoconfigure-support'
+    - type: gradle
+      path: ./
+      target: ':sdk-bridge'
     - type: gradle
       path: ./
       target: ':testing-common'

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

@@ -1,2 +1,5 @@
 Comparing source compatibility of opentelemetry-spring-boot-autoconfigure-2.19.0-SNAPSHOT.jar against opentelemetry-spring-boot-autoconfigure-2.18.1.jar
-No changes.
+===  UNCHANGED CLASS: PUBLIC io.opentelemetry.instrumentation.spring.autoconfigure.OpenTelemetryAutoConfiguration  (not serializable)
+	===  CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+	---  REMOVED ANNOTATION: org.springframework.boot.context.properties.EnableConfigurationProperties
+		---  REMOVED 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.OtelSpringProperties (-)

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

@@ -5,6 +5,7 @@
 
 package io.opentelemetry.instrumentation.api.incubator.config.internal;
 
+import static java.util.Collections.emptyList;
 import static java.util.Collections.emptyMap;
 
 import io.opentelemetry.api.incubator.config.ConfigProvider;
@@ -46,28 +47,33 @@ public CommonConfig(InstrumentationConfig config) {
             getFromConfigProviderOrFallback(
                 config,
                 InstrumentationConfigUtil::peerServiceMapping,
+                emptyMap(),
                 () ->
                     config.getMap("otel.instrumentation.common.peer-service-mapping", emptyMap())));
 
     clientRequestHeaders =
         getFromConfigProviderOrFallback(
             config,
             InstrumentationConfigUtil::httpClientRequestCapturedHeaders,
+            emptyList(),
             () -> config.getList("otel.instrumentation.http.client.capture-request-headers"));
     clientResponseHeaders =
         getFromConfigProviderOrFallback(
             config,
             InstrumentationConfigUtil::httpClientResponseCapturedHeaders,
+            emptyList(),
             () -> config.getList("otel.instrumentation.http.client.capture-response-headers"));
     serverRequestHeaders =
         getFromConfigProviderOrFallback(
             config,
             InstrumentationConfigUtil::httpServerRequestCapturedHeaders,
+            emptyList(),
             () -> config.getList("otel.instrumentation.http.server.capture-request-headers"));
     serverResponseHeaders =
         getFromConfigProviderOrFallback(
             config,
             InstrumentationConfigUtil::httpServerResponseCapturedHeaders,
+            emptyList(),
             () -> config.getList("otel.instrumentation.http.server.capture-response-headers"));
     knownHttpRequestMethods =
         new HashSet<>(
@@ -154,11 +160,14 @@ public String getTraceFlagsKey() {
   private static <T> T getFromConfigProviderOrFallback(
       InstrumentationConfig config,
       Function<ConfigProvider, T> getFromConfigProvider,
+      T defaultValue,
       Supplier<T> fallback) {
     ConfigProvider configProvider = config.getConfigProvider();
     if (configProvider != null) {
-      return getFromConfigProvider.apply(configProvider);
+      T value = getFromConfigProvider.apply(configProvider);
+      return value != null ? value : defaultValue;
     }
+    // fallback doesn't return null, so we can safely call it
     return fallback.get();
   }
 }

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

@@ -36,6 +36,9 @@ dependencies {
   annotationProcessor("org.springframework.boot:spring-boot-autoconfigure-processor:$springBootVersion")
   annotationProcessor("org.springframework.boot:spring-boot-configuration-processor:$springBootVersion")
   implementation("javax.validation:validation-api")
+  // snake yaml is already used by "spring-boot-resources"
+  // and less likely to cause problems compared to jackson
+  implementation("org.snakeyaml:snakeyaml-engine")
 
   implementation(project(":instrumentation-annotations-support"))
   implementation(project(":instrumentation:kafka:kafka-clients:kafka-clients-2.6:library"))
@@ -66,7 +69,9 @@ dependencies {
   library("org.springframework.boot:spring-boot-starter-data-jdbc:$springBootVersion")
 
   implementation("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure")
+  implementation("io.opentelemetry:opentelemetry-sdk-extension-incubator")
   implementation(project(":sdk-autoconfigure-support"))
+  implementation(project(":sdk-bridge"))
   compileOnly("io.opentelemetry:opentelemetry-extension-trace-propagators")
   compileOnly("io.opentelemetry.contrib:opentelemetry-aws-xray-propagator")
   compileOnly("io.opentelemetry:opentelemetry-exporter-logging")
@@ -174,6 +179,16 @@ testing {
         }
       }
     }
+
+    val testDeclarativeConfig by registering(JvmTestSuite::class) {
+      dependencies {
+        implementation(project())
+        implementation("io.opentelemetry:opentelemetry-sdk")
+        implementation("org.springframework.boot:spring-boot-starter-test:$springBootVersion") {
+          exclude("org.junit.vintage", "junit-vintage-engine")
+        }
+      }
+    }
   }
 }
 

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

@@ -0,0 +1,91 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.spring.autoconfigure;
+
+import io.opentelemetry.sdk.extension.incubator.fileconfig.DeclarativeConfiguration;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.OpenTelemetryConfigurationModel;
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.charset.StandardCharsets;
+import java.util.Map;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import javax.annotation.Nullable;
+import org.snakeyaml.engine.v2.api.Dump;
+import org.snakeyaml.engine.v2.api.DumpSettings;
+import org.snakeyaml.engine.v2.api.Load;
+import org.snakeyaml.engine.v2.api.LoadSettings;
+import org.springframework.boot.env.OriginTrackedMapPropertySource;
+import org.springframework.core.env.ConfigurableEnvironment;
+import org.springframework.core.env.PropertySource;
+
+class EmbeddedConfigFile {
+
+  private EmbeddedConfigFile() {
+    // Utility class
+  }
+
+  private static final Pattern PATTERN =
+      Pattern.compile(
+          "^Config resource 'class path resource \\[(.+)]' via location 'optional:classpath:/'$");
+
+  static OpenTelemetryConfigurationModel extractModel(ConfigurableEnvironment environment)
+      throws IOException {
+    for (PropertySource<?> propertySource : environment.getPropertySources()) {
+      if (propertySource instanceof OriginTrackedMapPropertySource) {
+        return getModel(environment, (OriginTrackedMapPropertySource) propertySource);
+      }
+    }
+    throw new IllegalStateException("No application.yaml file found.");
+  }
+
+  private static OpenTelemetryConfigurationModel getModel(
+      ConfigurableEnvironment environment, OriginTrackedMapPropertySource source)
+      throws IOException {
+    Matcher matcher = PATTERN.matcher(source.getName());
+    if (matcher.matches()) {
+      String file = matcher.group(1);
+
+      try (InputStream resourceAsStream =
+          environment.getClass().getClassLoader().getResourceAsStream(file)) {
+        if (resourceAsStream != null) {
+          return extractOtelConfigFile(resourceAsStream);
+        } else {
+          throw new IllegalStateException("Unable to load " + file + " in the classpath.");
+        }
+      }
+    } else {
+      throw new IllegalStateException(
+          "No OpenTelemetry configuration found in the application.yaml file.");
+    }
+  }
+
+  @Nullable
+  @SuppressWarnings("unchecked")
+  private static String parseOtelNode(InputStream in) {
+    Load load = new Load(LoadSettings.builder().build());
+    Dump dump = new Dump(DumpSettings.builder().build());
+    for (Object o : load.loadAllFromInputStream(in)) {
+      Map<String, Object> data = (Map<String, Object>) o;
+      Map<String, Map<String, Object>> otel = (Map<String, Map<String, Object>>) data.get("otel");
+      if (otel != null) {
+        return dump.dumpToString(otel);
+      }
+    }
+    throw new IllegalStateException("No 'otel' configuration found in the YAML file.");
+  }
+
+  private static OpenTelemetryConfigurationModel extractOtelConfigFile(InputStream content) {
+    String node = parseOtelNode(content);
+    if (node == null || node.isEmpty()) {
+      throw new IllegalStateException("otel node is empty or null in the YAML file.");
+    }
+
+    return DeclarativeConfiguration.parse(
+        new ByteArrayInputStream(node.getBytes(StandardCharsets.UTF_8)));
+  }
+}