Skip to content

Skip registering all OTLP tracing related beans if tracing is disabled #46166

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+14 −2
Open

Skip registering all OTLP tracing related beans if tracing is disabled #46166

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions ...ava/org/springframework/boot/tracing/autoconfigure/otlp/OtlpTracingAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.boot.tracing.autoconfigure.ConditionalOnEnabledTracing;
import org.springframework.context.annotation.Import;

/**
Expand All @@ -44,10 +45,12 @@
* @author Jonatan Ivanov
* @author Moritz Halbritter
* @author Eddú Meléndez
* @author Yanming Zhou
* @since 4.0.0
*/
@AutoConfiguration
@ConditionalOnClass({ OtelTracer.class, SdkTracerProvider.class, OpenTelemetry.class, OtlpHttpSpanExporter.class })
@ConditionalOnEnabledTracing("otlp")
@EnableConfigurationProperties(OtlpTracingProperties.class)
@Import({ OtlpTracingConfigurations.ConnectionDetails.class, OtlpTracingConfigurations.Exporters.class })
public class OtlpTracingAutoConfiguration {
Expand Down
3 changes: 1 addition & 2 deletions ...n/java/org/springframework/boot/tracing/autoconfigure/otlp/OtlpTracingConfigurations.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.tracing.autoconfigure.ConditionalOnEnabledTracing;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.util.Assert;
Expand All @@ -38,6 +37,7 @@
*
* @author Moritz Halbritter
* @author Eddú Meléndez
* @author Yanming Zhou
*/
final class OtlpTracingConfigurations {

Expand Down Expand Up @@ -77,7 +77,6 @@ public String getUrl(Transport transport) {
@Configuration(proxyBeanMethods = false)
@ConditionalOnMissingBean({ OtlpGrpcSpanExporter.class, OtlpHttpSpanExporter.class })
@ConditionalOnBean(OtlpTracingConnectionDetails.class)
@ConditionalOnEnabledTracing("otlp")
static class Exporters {

@Bean
Expand Down
10 changes: 10 additions & 0 deletions ...rg/springframework/boot/tracing/autoconfigure/otlp/OtlpTracingAutoConfigurationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
* @author Jonatan Ivanov
* @author Moritz Halbritter
* @author Eddú Meléndez
* @author Yanming Zhou
*/
class OtlpTracingAutoConfigurationTests {

Expand Down Expand Up @@ -71,6 +72,15 @@ void shouldSupplyBeans() {
.hasSingleBean(SpanExporter.class));
}

@Test
void shouldNotSupplyBeansIfTracingDisabled() {
this.tracingDisabledContextRunner
.withPropertyValues("management.otlp.tracing.endpoint=http://localhost:4318/v1/traces")
.run((context) -> assertThat(context).doesNotHaveBean(OtlpTracingProperties.class)
.doesNotHaveBean(OtlpTracingConnectionDetails.class)
.doesNotHaveBean(SpanExporter.class));
}

@Test
void shouldCustomizeHttpTransportWithProperties() {
this.contextRunner
Expand Down