Skip to content

Use the new configuration bridge in spring boot starter #15714

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
trask merged 8 commits into from
Dec 27, 2025
+116 −498
Merged

Use the new configuration bridge in spring boot starter #15714

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7eaf6f3
Use the one configuration bridge in spring boot starter
trask Dec 20, 2025
6bc1c0f
fix
trask Dec 22, 2025
277d5e8
remove
trask Dec 23, 2025
9137432
Fix types
trask Dec 23, 2025
3af7e85
revert
trask Dec 23, 2025
3b81610
revert
trask Dec 23, 2025
d3d35f6
simplify
trask Dec 26, 2025
b245582
remove unused
trask Dec 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions instrumentation/spring/spring-boot-autoconfigure/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ dependencies {

testImplementation("io.opentelemetry:opentelemetry-sdk")
testImplementation("io.opentelemetry:opentelemetry-sdk-testing")
testImplementation("io.opentelemetry:opentelemetry-api-incubator")
testImplementation(project(":instrumentation:resources:library"))
testImplementation("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure-spi")
testImplementation("io.opentelemetry:opentelemetry-extension-trace-propagators")
Expand Down
32 changes: 13 additions & 19 deletions ...c/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/EmbeddedConfigFile.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,20 +46,25 @@ class EmbeddedConfigFile {
private EmbeddedConfigFile() {}

static OpenTelemetryConfigurationModel extractModel(ConfigurableEnvironment environment) {
Map<String, String> props = extractSpringProperties(environment);
return convertToOpenTelemetryConfigurationModel(props);
Map<String, Object> props = extractSpringProperties(environment);
Map<String, Object> nested = convertFlatPropsToNested(props);
return MAPPER.convertValue(nested, OpenTelemetryConfigurationModel.class);
}

private static Map<String, String> extractSpringProperties(ConfigurableEnvironment environment) {
private static Map<String, Object> extractSpringProperties(ConfigurableEnvironment environment) {
MutablePropertySources propertySources = environment.getPropertySources();

Map<String, String> props = new HashMap<>();
Map<String, Object> props = new HashMap<>();
for (PropertySource<?> propertySource : propertySources) {
if (propertySource instanceof EnumerablePropertySource<?>) {
for (String propertyName :
((EnumerablePropertySource<?>) propertySource).getPropertyNames()) {
if (propertyName.startsWith("otel.")) {
String property = environment.getProperty(propertyName);
Object property = propertySource.getProperty(propertyName);

@trask trask Dec 23, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change preserves boolean values across the bridge

@zeitlinger zeitlinger Dec 23, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this needed for this PR?

@trask trask Dec 23, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah. the reason it worked before is that all of the spring boot starter config access was done via ConfigProperties which is string based anyways

and I've updated some places in this PR to now access config via Declarative Config API (which ignores properties if they're not the requested type instead of converting them)

@zeitlinger zeitlinger Dec 24, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

spring was using type coercion before - because I thought it was necessary.
I'll play around with this PR a little more to get a better picture.

@zeitlinger zeitlinger Dec 24, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I figured it out: the wrong config provider was used: trask#101

@trask trask Dec 26, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

left a question: https://github.com/trask/opentelemetry-java-instrumentation/pull/101/changes#r2648454257

// Resolve ${} placeholders in String values while preserving types for others
if (property instanceof String) {
property = environment.resolvePlaceholders((String) property);
}
if (Objects.equals(property, "")) {
property = null; // spring returns empty string for yaml null
}
Expand Down Expand Up @@ -95,29 +100,18 @@ private static Map<String, String> extractSpringProperties(ConfigurableEnvironme
return props;
}

static OpenTelemetryConfigurationModel convertToOpenTelemetryConfigurationModel(
Map<String, String> flatProps) {
Map<String, Object> nested = convertFlatPropsToNested(flatProps);

return getObjectMapper().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, String> flatProps) {
static Map<String, Object> convertFlatPropsToNested(Map<String, Object> flatProps) {
Map<String, Object> result = new HashMap<>();

for (Map.Entry<String, String> entry : flatProps.entrySet()) {
for (Map.Entry<String, Object> entry : flatProps.entrySet()) {
String key = entry.getKey();
String value = entry.getValue();
Object value = entry.getValue();

// Split the key by dots
String[] parts = key.split("\\.");
Expand Down
19 changes: 15 additions & 4 deletions ...io/opentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@
import static java.util.Objects.requireNonNull;

import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.api.incubator.ExtendedOpenTelemetry;
import io.opentelemetry.api.incubator.config.ConfigProvider;
import io.opentelemetry.api.trace.TracerProvider;
import io.opentelemetry.common.ComponentLoader;
import io.opentelemetry.instrumentation.api.incubator.config.internal.InstrumentationConfig;
import io.opentelemetry.instrumentation.api.internal.EmbeddedInstrumentationProperties;
import io.opentelemetry.instrumentation.config.bridge.ConfigPropertiesBackedConfigProvider;
import io.opentelemetry.instrumentation.config.bridge.DeclarativeConfigPropertiesBridgeBuilder;
import io.opentelemetry.instrumentation.spring.autoconfigure.internal.DeclarativeConfigDisabled;
import io.opentelemetry.instrumentation.spring.autoconfigure.internal.DeclarativeConfigEnabled;
Expand Down Expand Up @@ -125,9 +127,12 @@ public AutoConfiguredOpenTelemetrySdk autoConfiguredOpenTelemetrySdk(

@Bean
public OpenTelemetry openTelemetry(
AutoConfiguredOpenTelemetrySdk autoConfiguredOpenTelemetrySdk) {
AutoConfiguredOpenTelemetrySdk autoConfiguredOpenTelemetrySdk,
ConfigProperties otelProperties) {
logStart();
return autoConfiguredOpenTelemetrySdk.getOpenTelemetrySdk();
OpenTelemetrySdk openTelemetry = autoConfiguredOpenTelemetrySdk.getOpenTelemetrySdk();
ConfigProvider configProvider = ConfigPropertiesBackedConfigProvider.create(otelProperties);
return new SpringOpenTelemetrySdk(openTelemetry, configProvider);

@trask trask Dec 23, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A test failed when I just implemented OpenTelemetry instead of OpenTelemetrySdk

  • OpenTelemetryAutoConfigurationTest.shouldInitializeSdkWhenNotDisabled

I guess it could be considered a breaking change if anyone is relying on it really being an instance of OpenTelemetrySdk, so went with OpenTelemetrySdk instead.

@zeitlinger zeitlinger Dec 24, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the test was just meant to assert that it's not the noop instance

}

@Bean
Expand Down Expand Up @@ -171,9 +176,11 @@ public OpenTelemetry openTelemetry(
return sdk;
}

// TODO remove once ConfigProperties usage is removed from remaining
// spring boot starter instrumentations
@Bean
public ConfigProvider configProvider(OpenTelemetryConfigurationModel model) {
return SpringConfigProvider.create(model);
public ConfigProvider configProvider(OpenTelemetry openTelemetry) {
return ((ExtendedOpenTelemetry) openTelemetry).getConfigProvider();
}

/**
Expand All @@ -182,12 +189,16 @@ public ConfigProvider configProvider(OpenTelemetryConfigurationModel model) {
* <p>Not using spring boot properties directly, because declarative configuration does not
* integrate with spring boot properties.
*/
// TODO remove once ConfigProperties usage is removed from remaining
// spring boot starter instrumentations
@Bean
public ConfigProperties otelProperties(ConfigProvider configProvider) {
return new DeclarativeConfigPropertiesBridgeBuilder()
.buildFromInstrumentationConfig(configProvider.getInstrumentationConfig());
}

// TODO remove once ConfigProperties usage is removed from remaining
// spring boot starter instrumentations
@Bean
public InstrumentationConfig instrumentationConfig(
ConfigProperties properties, ConfigProvider configProvider) {
Expand Down
68 changes: 0 additions & 68 deletions ...main/java/io/opentelemetry/instrumentation/spring/autoconfigure/SpringConfigProvider.java
View file
Open in desktop

This file was deleted.

Loading
Loading