fix spring declarative config with env var substitution by zeitlinger · Pull Request #15775 · open-telemetry/opentelemetry-java-instrumentation

zeitlinger · 2026-01-06T14:36:10Z

Reverts the "simplify" approach (commit 7fc9b04808) that replaced SpringDeclarativeConfigProperties + SpringConfigProvider with CoercingDeclarativeConfigProperties wrapping YamlDeclarativeConfigProperties.

The wrapper approach triggers noisy WARN logs from YamlDeclarativeConfigProperties when values are stored as strings (which is the case with Spring property resolution).

Reverting to the original approach avoids this issue. The upstream fix can be revisited via open-telemetry/opentelemetry-java#8101.

trask

I'd prefer if we can find a way to map to typed data based on the yaml content only instead of dynamically coercing based on whether getInt or getString happens to be called by the user

zeitlinger · 2026-01-15T11:56:30Z

@trask please have a look

zeitlinger · 2026-01-27T10:31:03Z

@trask please have a look

trask

sent a possible simplification: zeitlinger#8

Signed-off-by: Gregor Zeitlinger <[email protected]>

- Delete SpringConfigProvider, use lambda for ConfigProvider since it's a functional interface - Make CoercingDeclarativeConfigProperties.wrap() handle null - Merge duplicate withType<Test>().configureEach blocks in build.gradle.kts Signed-off-by: Gregor Zeitlinger <[email protected]>

In CoercingDeclarativeConfigProperties, try getString() first before the typed getter (getBoolean, getInt, etc). This avoids triggering the warning in YamlDeclarativeConfigProperties when a value is stored as String instead of its native type. Signed-off-by: Gregor Zeitlinger <[email protected]>

zeitlinger · 2026-02-18T18:38:32Z

CI fix

The OtelSpringStarterSmokeTest > restClient() failure was caused by YamlDeclarativeConfigProperties logging a WARN for emit_experimental_telemetry/development — it found a String where it expected Boolean.

Root cause: environment.getProperty() returns all values as String, so YAML true becomes "true". CoercingDeclarativeConfigProperties.getBoolean() was calling delegate.getBoolean() first, which triggered the warning in YamlDeclarativeConfigProperties before returning null. The coercing wrapper then correctly fell through to getString() + parse, but the warning was already emitted.

Fix: Flip the order in CoercingDeclarativeConfigProperties — try delegate.getString() first, and only fall back to the typed getter when the value isn't a string. This avoids triggering the warning while still handling both string and natively-typed values.

…simplify getString Signed-off-by: Gregor Zeitlinger <[email protected]>

… SpringConfigProvider The CoercingDeclarativeConfigProperties wrapper triggers noisy WARN logs from YamlDeclarativeConfigProperties when values are stored as strings. Revert to the original approach of SpringDeclarativeConfigProperties + SpringConfigProvider which handles type coercion directly. Signed-off-by: Gregor Zeitlinger <[email protected]>

Address review: remove cross-type conversions (Long->Integer, Integer->Long, Float->Double, Boolean native) and only coerce from String, since that's the only case Spring produces. Signed-off-by: Gregor Zeitlinger <[email protected]>

…oader passthrough Signed-off-by: Gregor Zeitlinger <[email protected]>

…es in coercion Signed-off-by: Gregor Zeitlinger <[email protected]>

zeitlinger · 2026-02-20T18:22:55Z

Addressed both review comments:

Extract var — extracted componentLoader variable shared across both calls in OpenTelemetryAutoConfiguration.
Handle native types — added instanceof checks for Boolean, Long, Double in the coercion methods. Also added Integer→Long conversion in longOrNull since YAML parsers produce Integer for small numbers.

Signed-off-by: Gregor Zeitlinger <[email protected]>

Copilot

Pull request overview

Reverts the prior declarative-config “wrapper” approach for Spring Boot and restores a Spring-specific DeclarativeConfigProperties implementation to avoid noisy WARN logs when Spring resolves values as strings (notably with env var substitution).

Changes:

Add Spring-specific DeclarativeConfigProperties + ConfigProvider to coerce scalar types without triggering YAML-type warnings.
Adjust Spring embedded-config extraction to treat resolved Spring properties as String values and convert them into an OpenTelemetryConfigurationModel.
Expand declarative-config tests (including env var substitution/overrides) and update Gradle JVM args to support env var mutation in tests.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
instrumentation/spring/spring-boot-autoconfigure/src/testDeclarativeConfig/resources/application.yaml	Expands declarative-config sample properties to cover scalar types and env var substitution (quoted/unquoted).
instrumentation/spring/spring-boot-autoconfigure/src/testDeclarativeConfig/java/io/opentelemetry/instrumentation/spring/autoconfigure/DeclarativeConfigTest.java	Updates tests to assert typed access/coercion and validates env var overrides in both Spring-style and Otel-style forms.
instrumentation/spring/spring-boot-autoconfigure/src/test/java/io/opentelemetry/instrumentation/spring/autoconfigure/EmbeddedConfigFileTest.java	Aligns tests with the flat-props map now being `Map<String, String>`.
instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/SpringDeclarativeConfigProperties.java	Introduces Spring-specific declarative properties implementation with scalar coercion logic.
instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/SpringConfigProvider.java	Adds Spring-specific `ConfigProvider` that feeds the coerced declarative properties to `SpringOpenTelemetrySdk`.
instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfiguration.java	Wires declarative-config startup to return `SpringOpenTelemetrySdk` backed by the new Spring config provider.
instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/EmbeddedConfigFile.java	Changes extraction to collect resolved Spring properties as strings and converts them into the OTel configuration model.
instrumentation/spring/spring-boot-autoconfigure/build.gradle.kts	Adds an additional `--add-opens` needed for env var mutation via JUnit Pioneer on newer JDKs.

trask

Thanks!

zeitlinger self-assigned this Jan 6, 2026

zeitlinger requested a review from a team as a code owner January 6, 2026 14:36

zeitlinger added this to Declarative Configuration: Java Jan 6, 2026

github-actions Bot added the test native This label can be applied to PRs to trigger them to run native tests label Jan 6, 2026

trask reviewed Jan 7, 2026

View reviewed changes

Comment thread ...tation/spring/spring-boot-autoconfigure/src/testDeclarativeConfig/resources/application.yaml

zeitlinger mentioned this pull request Jan 7, 2026

Spring config type safe coercion #15784

Closed

trask added this to the v2.24.0 milestone Jan 9, 2026

zeitlinger moved this to Awaiting Review in Declarative Configuration: Java Jan 12, 2026

trask reviewed Jan 13, 2026

View reviewed changes

Comment thread ...Config/java/io/opentelemetry/instrumentation/spring/autoconfigure/DeclarativeConfigTest.java

zeitlinger added 6 commits January 14, 2026 10:31

add spring config test

ec89061

fix

4a8b96f

fix

ff1d6fb

improve test

34cafc0

pr review

e1fccb0

fix

722ccd6

zeitlinger force-pushed the spring-config-test branch from 15656d2 to 722ccd6 Compare January 14, 2026 09:32

fix

01ee628

trask removed this from the v2.24.0 milestone Jan 16, 2026

zeitlinger mentioned this pull request Feb 12, 2026

fix: Add system property substitution to declarative config open-telemetry/opentelemetry-java#8073

Merged

trask mentioned this pull request Feb 14, 2026

Remove unchecked warning open-telemetry/opentelemetry-java#8090

Merged

trask reviewed Feb 14, 2026

View reviewed changes

zeitlinger and others added 4 commits February 17, 2026 12:36

pr review

643c34b

Signed-off-by: Gregor Zeitlinger <[email protected]>

simplify

7fc9b04

zeitlinger force-pushed the spring-config-test branch from c52e7ec to c8b74c7 Compare February 18, 2026 18:38

Merge branch 'main' into spring-config-test

e27052c

trask reviewed Feb 18, 2026

View reviewed changes

trask mentioned this pull request Feb 18, 2026

DeclarativeConfigProperties: no way to coerce types without triggering warnings open-telemetry/opentelemetry-java#8101

Open

zeitlinger added 3 commits February 19, 2026 13:29

Address review comments: cache wrapped config, remove unused method, …

c73e197

…simplify getString Signed-off-by: Gregor Zeitlinger <[email protected]>

Simplify type coercion: only coerce from String

1abe589

Address review: remove cross-type conversions (Long->Integer, Integer->Long, Float->Double, Boolean native) and only coerce from String, since that's the only case Spring produces. Signed-off-by: Gregor Zeitlinger <[email protected]>

trask reviewed Feb 20, 2026

View reviewed changes

Address review comments: type safety, error handling, and component l…

6513c0b

…oader passthrough Signed-off-by: Gregor Zeitlinger <[email protected]>

trask reviewed Feb 20, 2026

View reviewed changes

Comment thread ...va/io/opentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfiguration.java Outdated

Comment thread ...io/opentelemetry/instrumentation/spring/autoconfigure/SpringDeclarativeConfigProperties.java

Address review: extract shared componentLoader var, handle native typ…

a99a2c4

…es in coercion Signed-off-by: Gregor Zeitlinger <[email protected]>

zeitlinger and others added 4 commits February 20, 2026 19:45

spotlessApply

8bea13a

Signed-off-by: Gregor Zeitlinger <[email protected]>

Merge branch 'main' into spring-config-test

a76e78f

add comment

f70fb87

spotless

08b6c66

trask reviewed Feb 20, 2026

View reviewed changes

Comment thread ...io/opentelemetry/instrumentation/spring/autoconfigure/SpringDeclarativeConfigProperties.java

trask requested a review from Copilot February 23, 2026 19:20

Copilot started reviewing on behalf of trask February 23, 2026 19:21 View session

Copilot AI reviewed Feb 23, 2026

View reviewed changes

Comment thread ...io/opentelemetry/instrumentation/spring/autoconfigure/SpringDeclarativeConfigProperties.java

Comment thread ...io/opentelemetry/instrumentation/spring/autoconfigure/SpringDeclarativeConfigProperties.java Outdated

trask added 4 commits February 23, 2026 13:16

feedback

da154b4

Merge remote-tracking branch 'upstream/main' into spring-config-test

f471326

spotless

29f6188

one more coercion

8e84d4d

trask approved these changes Feb 23, 2026

View reviewed changes

trask enabled auto-merge (squash) February 23, 2026 22:12

trask merged commit f7cba3b into open-telemetry:main Feb 23, 2026
165 of 167 checks passed

github-project-automation Bot moved this from Awaiting Review to Done in Declarative Configuration: Java Feb 23, 2026

zeitlinger deleted the spring-config-test branch February 24, 2026 05:37

Conversation

zeitlinger commented Jan 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

trask left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

zeitlinger commented Jan 15, 2026

Uh oh!

zeitlinger commented Jan 27, 2026

Uh oh!

trask left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

zeitlinger commented Feb 18, 2026

CI fix

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

zeitlinger commented Feb 20, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

trask left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

zeitlinger commented Jan 6, 2026 •

edited

Loading