Spring starter declarative config #14062

zeitlinger · 2025-06-18T16:13:15Z

Based on #14184

Todo:

the distro resource provider and customizers are missing
- wait for add missing declarative config resource providers #14222 to be merged
- move ResourceCustomizerProvider to sdk-autoconfigure-support to add distribution and service resources
- copy and adapt DistroComponentProvider
- take the patch below as starting point

Subject: [PATCH] add docs
---
Index: smoke-tests-otel-starter/spring-boot-2/src/testDeclarativeConfig/java/io/opentelemetry/spring/smoketest/OtelSpringStarterSmokeTest.java
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/smoke-tests-otel-starter/spring-boot-2/src/testDeclarativeConfig/java/io/opentelemetry/spring/smoketest/OtelSpringStarterSmokeTest.java b/smoke-tests-otel-starter/spring-boot-2/src/testDeclarativeConfig/java/io/opentelemetry/spring/smoketest/OtelSpringStarterSmokeTest.java
--- a/smoke-tests-otel-starter/spring-boot-2/src/testDeclarativeConfig/java/io/opentelemetry/spring/smoketest/OtelSpringStarterSmokeTest.java	(revision 07f537fbb250c00b5f195ac421eb0aabf4f1cea2)
+++ b/smoke-tests-otel-starter/spring-boot-2/src/testDeclarativeConfig/java/io/opentelemetry/spring/smoketest/OtelSpringStarterSmokeTest.java	(date 1752759689238)
@@ -5,8 +5,13 @@
 
 package io.opentelemetry.spring.smoketest;
 
+import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.satisfies;
+
 import io.opentelemetry.api.trace.SpanKind;
 import io.opentelemetry.semconv.HttpAttributes;
+import io.opentelemetry.semconv.incubating.ServiceIncubatingAttributes;
+import io.opentelemetry.semconv.incubating.TelemetryIncubatingAttributes;
+import org.assertj.core.api.AbstractCharSequenceAssert;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
@@ -44,7 +49,21 @@
             traceAssert.hasSpansSatisfyingExactly(
                 span -> HttpSpanDataAssert.create(span).assertClientGetRequest("/ping"),
                 span ->
-                    span.hasKind(SpanKind.SERVER).hasAttribute(HttpAttributes.HTTP_ROUTE, "/ping"),
+                    span.hasKind(SpanKind.SERVER)
+                        .hasResourceSatisfying(
+                            r ->
+                                r.hasAttribute(
+                                        TelemetryIncubatingAttributes.TELEMETRY_DISTRO_NAME,
+                                        "opentelemetry-spring-boot-starter")
+                                    .hasAttribute(
+                                        satisfies(
+                                            TelemetryIncubatingAttributes.TELEMETRY_DISTRO_VERSION,
+                                            AbstractCharSequenceAssert::isNotBlank))
+                                    .hasAttribute(
+                                        satisfies(
+                                            ServiceIncubatingAttributes.SERVICE_INSTANCE_ID,
+                                            AbstractCharSequenceAssert::isNotBlank)))
+                        .hasAttribute(HttpAttributes.HTTP_ROUTE, "/ping"),
                 AbstractSpringStarterSmokeTest::withSpanAssert));
   }
 }
Index: instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfiguration.java
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfiguration.java b/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfiguration.java
--- a/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfiguration.java	(revision 07f537fbb250c00b5f195ac421eb0aabf4f1cea2)
+++ b/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfiguration.java	(date 1752760335777)
@@ -73,16 +73,8 @@
   @Configuration
   @Conditional(OtelEnabled.class)
   @ConditionalOnMissingBean(OpenTelemetry.class)
+  @SuppressWarnings("OtelPrivateConstructorForUtilityClass")
   static class OpenTelemetrySdkConfig {
-    @Bean
-    public ResourceProvider otelSpringResourceProvider(Optional<BuildProperties> buildProperties) {
-      return new SpringResourceProvider(buildProperties);
-    }
-
-    @Bean
-    public ResourceProvider otelDistroVersionResourceProvider() {
-      return new DistroVersionResourceProvider();
-    }
 
     @Configuration
     @EnableConfigurationProperties({
@@ -93,6 +85,17 @@
     @Conditional(DeclarativeConfigDisabled.class)
     static class PropertiesConfig {
 
+      @Bean
+      public ResourceProvider otelSpringResourceProvider(
+          Optional<BuildProperties> buildProperties) {
+        return new SpringResourceProvider(buildProperties);
+      }
+
+      @Bean
+      public ResourceProvider otelDistroVersionResourceProvider() {
+        return new DistroVersionResourceProvider();
+      }
+
       @Bean
       @ConfigurationPropertiesBinding
       OtelMapConverter otelMapConverter() {

otelbot-java-instrumentation · 2025-06-18T16:19:13Z

🔧 The result from spotlessApply was committed to the PR branch.

zeitlinger · 2025-06-19T17:48:25Z

@laurit can you help me figure out what the problem is?

AgentInstrumentationTest > classPathSetUp() FAILED	
    java.lang.NoClassDefFoundError: io/opentelemetry/sdk/autoconfigure/spi/ConfigProperties	
        at java.lang.Class.forName0(Native Method)	
        at java.lang.Class.forName(Class.java:348)	
        at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:328)	
        at java.lang.ClassLoader.loadClass(ClassLoader.java:351)	
        at java.lang.Class.forName0(Native Method)	
        at java.lang.Class.forName(Class.java:264)	
        at instrumentation.AgentInstrumentationTest.classPathSetUp(AgentInstrumentationTest.java:53)

zeitlinger · 2025-06-20T06:20:26Z

@laurit can you help me figure out what the problem is?

AgentInstrumentationTest > classPathSetUp() FAILED	
    java.lang.NoClassDefFoundError: io/opentelemetry/sdk/autoconfigure/spi/ConfigProperties	
        at java.lang.Class.forName0(Native Method)	
        at java.lang.Class.forName(Class.java:348)	
        at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:328)	
        at java.lang.ClassLoader.loadClass(ClassLoader.java:351)	
        at java.lang.Class.forName0(Native Method)	
        at java.lang.Class.forName(Class.java:264)	
        at instrumentation.AgentInstrumentationTest.classPathSetUp(AgentInstrumentationTest.java:53)

tried to fix that with cbb070b

laurit · 2025-06-20T12:35:14Z

@laurit can you help me figure out what the problem is?

AgentInstrumentationTest > classPathSetUp() FAILED	
    java.lang.NoClassDefFoundError: io/opentelemetry/sdk/autoconfigure/spi/ConfigProperties	
        at java.lang.Class.forName0(Native Method)	
        at java.lang.Class.forName(Class.java:348)	
        at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:328)	
        at java.lang.ClassLoader.loadClass(ClassLoader.java:351)	
        at java.lang.Class.forName0(Native Method)	
        at java.lang.Class.forName(Class.java:264)	
        at instrumentation.AgentInstrumentationTest.classPathSetUp(AgentInstrumentationTest.java:53)

tried to fix that with cbb070b

DeclarativeConfigPropertiesBridge is in boot loader but it depends on io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties that is not in boot loader

zeitlinger · 2025-06-20T13:05:38Z

DeclarativeConfigPropertiesBridge is in boot loader but it depends on io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties that is not in boot loader

I can't figure out what change could have caused that.

Is the solution to not used ConfigProperties in the agent config?

zeitlinger · 2025-06-20T13:11:53Z

DeclarativeConfigPropertiesBridge is in boot loader but it depends on io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties that is not in boot loader

I can't figure out what change could have caused that.

Is the solution to not used ConfigProperties in the agent config?

Let's see if it's 7116de1

laurit · 2025-06-20T13:26:50Z

Let's see if it's 7116de1

I don't think this is going to help. javaagent-extension-api belongs to boot loader, any class you are going to use there also needs to be in boot loader. Since based on that DeclarativeConfigPropertiesBridge needs to be in boot loader, it implements io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties that is not in boot loader, and shouldn't be there. Based on that I'd say the design is broken and needs to be rethought.

zeitlinger · 2025-06-20T13:31:11Z

Let's see if it's 7116de1

I don't think this is going to help. javaagent-extension-api belongs to boot loader, any class you are going to use there also needs to be in boot loader. Since based on that DeclarativeConfigPropertiesBridge needs to be in boot loader, it implements io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties that is not in boot loader, and shouldn't be there. Based on that I'd say the design is broken and needs to be rethought.

Why is it not failing on main? DeclarativeConfigPropertiesBridge is not changed (unless I miss something)

laurit · 2025-06-20T13:50:47Z

Why is it not failing on main? DeclarativeConfigPropertiesBridge is not changed (unless I miss something)

Because on main you don't have it in boot loader. Actually I was wrong about javaagent-extension-api belonging to boot loader. During agent packaging some of it is moved to boot loader and other parts are moved to agent loader. See

opentelemetry-java-instrumentation/javaagent/build.gradle.kts

Line 63 in 3d8ed9f

bootstrapLibs(project(":javaagent-extension-api")) {

and

opentelemetry-java-instrumentation/javaagent/build.gradle.kts

Line 147 in 3d8ed9f

    
           // exclude the agent part of the javaagent-extension-api; these classes will be added in relocate tasks

and

opentelemetry-java-instrumentation/javaagent/build.gradle.kts

Line 432 in 3d8ed9f

// exclude the bootstrap part of the javaagent-extension-api

I'd try excluding the bridge in

opentelemetry-java-instrumentation/javaagent/build.gradle.kts

Line 69 in 3d8ed9f

exclude("io.opentelemetry", "opentelemetry-sdk-extension-autoconfigure-spi")

zeitlinger · 2025-06-20T15:50:32Z

I'd try excluding the bridge in

opentelemetry-java-instrumentation/javaagent/build.gradle.kts

Line 69 in 3d8ed9f

exclude("io.opentelemetry", "opentelemetry-sdk-extension-autoconfigure-spi")

That worked - thanks a lot!

otelbot-java-instrumentation · 2025-06-30T09:36:21Z

🔧 The result from spotlessApply was committed to the PR branch.

zeitlinger self-assigned this Jun 18, 2025

github-actions bot added the test native This label can be applied to PRs to trigger them to run native tests label Jun 18, 2025

zeitlinger marked this pull request as ready for review June 19, 2025 16:09

zeitlinger requested a review from a team as a code owner June 19, 2025 16:09

zeitlinger force-pushed the spring-starter-declarative-config branch 2 times, most recently from 17d949a to f81444f Compare June 19, 2025 16:57

zeitlinger added this to Declarative Configuration: Java Jun 20, 2025

zeitlinger removed this from Declarative Configuration: Java Jun 20, 2025

zeitlinger mentioned this pull request Jun 20, 2025

Vendor specific instrumentation config options handling #14016

Merged

zeitlinger mentioned this pull request Jun 20, 2025

Internal telemetry always uses GlobalOpenTelemetry when declarative config is used open-telemetry/opentelemetry-java#7435

Open

zeitlinger marked this pull request as draft June 25, 2025 07:07

zeitlinger force-pushed the spring-starter-declarative-config branch from bf6b7f8 to 9427fe6 Compare June 30, 2025 09:31

zeitlinger marked this pull request as ready for review June 30, 2025 10:42

zeitlinger marked this pull request as draft June 30, 2025 10:48

zeitlinger added this to Declarative Configuration: Java Jun 30, 2025

zeitlinger moved this to Blocked in Declarative Configuration: Java Jun 30, 2025

zeitlinger moved this from Blocked to In Progress in Declarative Configuration: Java Jul 4, 2025

zeitlinger removed this from Declarative Configuration: Java Jul 4, 2025

use _ instead of - in declarative config

f8cdbe6

zeitlinger and others added 23 commits July 7, 2025 14:36

use InstrumentationConfig for encapsulation

26cc485

create component loader directly (doesn't work otherwise)

e5e1bd6

fix disabled config

2d718e4

add test

41d4093

add test

18d793e

add test

85c616f

add test

d83ce06

add test

997ee98

add test

7f62856

add test

7b86b21

add test

2a4f712

add test

ab52876

add test

245beb2

cleanup

3448365

cleanup

0dafa23

format

d243d76

fix classpath

23b18ed

fix classpath

46a7a7e

fix classpath

cb06605

fix rebase

22b83bd

fix rebase

9f48ed3

./gradlew spotlessApply

c5b9a40

fix rebase

5fcca3f

zeitlinger force-pushed the spring-starter-declarative-config branch from 482c0be to 5fcca3f Compare July 7, 2025 12:56

zeitlinger added 5 commits July 7, 2025 15:10

extract condition

4ccca89

fix rebase

8995a1b

use _

4cb9b47

use declarative config properties

41898c4

use declarative config properties

07f537f

zeitlinger mentioned this pull request Aug 12, 2025

declarative config: early init and property mapping #14184

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Spring starter declarative config #14062

Spring starter declarative config #14062

zeitlinger commented Jun 18, 2025 •

edited

Loading

Uh oh!

otelbot-java-instrumentation bot commented Jun 18, 2025

Uh oh!

zeitlinger commented Jun 19, 2025

Uh oh!

zeitlinger commented Jun 20, 2025

Uh oh!

laurit commented Jun 20, 2025

Uh oh!

zeitlinger commented Jun 20, 2025

Uh oh!

zeitlinger commented Jun 20, 2025

Uh oh!

laurit commented Jun 20, 2025

Uh oh!

zeitlinger commented Jun 20, 2025

Uh oh!

laurit commented Jun 20, 2025

Uh oh!

zeitlinger commented Jun 20, 2025

Uh oh!

otelbot-java-instrumentation bot commented Jun 30, 2025

Uh oh!

Uh oh!

Spring starter declarative config #14062

Are you sure you want to change the base?

Spring starter declarative config #14062

Conversation

zeitlinger commented Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

otelbot-java-instrumentation bot commented Jun 18, 2025

Uh oh!

zeitlinger commented Jun 19, 2025

Uh oh!

zeitlinger commented Jun 20, 2025

Uh oh!

laurit commented Jun 20, 2025

Uh oh!

zeitlinger commented Jun 20, 2025

Uh oh!

zeitlinger commented Jun 20, 2025

Uh oh!

laurit commented Jun 20, 2025

Uh oh!

zeitlinger commented Jun 20, 2025

Uh oh!

laurit commented Jun 20, 2025

Uh oh!

zeitlinger commented Jun 20, 2025

Uh oh!

otelbot-java-instrumentation bot commented Jun 30, 2025

Uh oh!

Uh oh!

zeitlinger commented Jun 18, 2025 •

edited

Loading