Browse Source

Switch property backing OnEnabledTracingExportCondition

It's now management.tracing.export.{name}.enabled

Closes gh-47959
pull/47991/head
Moritz Halbritter 1 month ago
parent
commit
4866f1a395
  1. 11
      module/spring-boot-micrometer-tracing-brave/src/main/resources/META-INF/additional-spring-configuration-metadata.json
  2. 2
      module/spring-boot-micrometer-tracing-brave/src/test/java/org/springframework/boot/micrometer/tracing/brave/autoconfigure/zipkin/ZipkinWithBraveTracingAutoConfigurationTests.java
  3. 9
      module/spring-boot-micrometer-tracing-opentelemetry/src/main/resources/META-INF/additional-spring-configuration-metadata.json
  4. 2
      module/spring-boot-micrometer-tracing-opentelemetry/src/test/java/org/springframework/boot/micrometer/tracing/opentelemetry/autoconfigure/otlp/OtlpTracingAutoConfigurationTests.java
  5. 2
      module/spring-boot-micrometer-tracing-opentelemetry/src/test/java/org/springframework/boot/micrometer/tracing/opentelemetry/autoconfigure/zipkin/ZipkinWithOpenTelemetryTracingAutoConfigurationTests.java
  6. 2
      module/spring-boot-micrometer-tracing/src/main/java/org/springframework/boot/micrometer/tracing/autoconfigure/ConditionalOnEnabledTracingExport.java
  7. 2
      module/spring-boot-micrometer-tracing/src/main/java/org/springframework/boot/micrometer/tracing/autoconfigure/OnEnabledTracingExportCondition.java
  8. 16
      module/spring-boot-micrometer-tracing/src/test/java/org/springframework/boot/micrometer/tracing/autoconfigure/OnEnabledTracingExportConditionTests.java

11
module/spring-boot-micrometer-tracing-brave/src/main/resources/META-INF/additional-spring-configuration-metadata.json

@ -2,9 +2,16 @@ @@ -2,9 +2,16 @@
"groups": [],
"properties": [
{
"name": "management.zipkin.tracing.export.enabled",
"name": "management.tracing.export.zipkin.enabled",
"type": "java.lang.Boolean",
"description": "Whether auto-configuration of tracing is enabled to export Zipkin traces."
}
},
{
"name": "management.zipkin.tracing.export.enabled",
"deprecation": {
"replacement": "management.tracing.export.zipkin.enabled",
"level": "error"
}
}
]
}

2
module/spring-boot-micrometer-tracing-brave/src/test/java/org/springframework/boot/micrometer/tracing/brave/autoconfigure/zipkin/ZipkinWithBraveTracingAutoConfigurationTests.java

@ -96,7 +96,7 @@ class ZipkinWithBraveTracingAutoConfigurationTests { @@ -96,7 +96,7 @@ class ZipkinWithBraveTracingAutoConfigurationTests {
@Test
void shouldNotSupplyAsyncZipkinSpanHandlerIfZipkinTracingIsDisabled() {
this.contextRunner.withPropertyValues("management.zipkin.tracing.export.enabled=false")
this.contextRunner.withPropertyValues("management.tracing.export.zipkin.enabled=false")
.withUserConfiguration(SenderConfiguration.class)
.run((context) -> assertThat(context).doesNotHaveBean(AsyncZipkinSpanHandler.class));
}

9
module/spring-boot-micrometer-tracing-opentelemetry/src/main/resources/META-INF/additional-spring-configuration-metadata.json

@ -2,9 +2,16 @@ @@ -2,9 +2,16 @@
"groups": [],
"properties": [
{
"name": "management.otlp.tracing.export.enabled",
"name": "management.tracing.export.otlp.enabled",
"type": "java.lang.Boolean",
"description": "Whether auto-configuration of tracing is enabled to export OTLP traces."
},
{
"name": "management.otlp.tracing.export.enabled",
"deprecation": {
"replacement": "management.tracing.export.otlp.enabled",
"level": "error"
}
}
]
}

2
module/spring-boot-micrometer-tracing-opentelemetry/src/test/java/org/springframework/boot/micrometer/tracing/opentelemetry/autoconfigure/otlp/OtlpTracingAutoConfigurationTests.java

@ -136,7 +136,7 @@ class OtlpTracingAutoConfigurationTests { @@ -136,7 +136,7 @@ class OtlpTracingAutoConfigurationTests {
@Test
void shouldNotSupplyBeansIfOtlpTracingIsDisabled() {
this.contextRunner.withPropertyValues("management.otlp.tracing.export.enabled=false")
this.contextRunner.withPropertyValues("management.tracing.export.otlp.enabled=false")
.run((context) -> assertThat(context).doesNotHaveBean(SpanExporter.class));
}

2
module/spring-boot-micrometer-tracing-opentelemetry/src/test/java/org/springframework/boot/micrometer/tracing/opentelemetry/autoconfigure/zipkin/ZipkinWithOpenTelemetryTracingAutoConfigurationTests.java

@ -135,7 +135,7 @@ class ZipkinWithOpenTelemetryTracingAutoConfigurationTests { @@ -135,7 +135,7 @@ class ZipkinWithOpenTelemetryTracingAutoConfigurationTests {
@Test
void shouldNotSupplyZipkinSpanExporterIfZipkinTracingIsDisabled() {
this.contextRunner.withPropertyValues("management.zipkin.tracing.export.enabled=false")
this.contextRunner.withPropertyValues("management.tracing.export.zipkin.enabled=false")
.withUserConfiguration(SenderConfiguration.class)
.run((context) -> assertThat(context).doesNotHaveBean(ZipkinSpanExporter.class));
}

2
module/spring-boot-micrometer-tracing/src/main/java/org/springframework/boot/micrometer/tracing/autoconfigure/ConditionalOnEnabledTracingExport.java

@ -28,7 +28,7 @@ import org.springframework.context.annotation.Conditional; @@ -28,7 +28,7 @@ import org.springframework.context.annotation.Conditional;
* {@link Conditional @Conditional} that checks whether tracing is enabled. It matches if
* the value of the {@code management.tracing.export.enabled} property is {@code true} or
* if it is not configured. If the {@link #value() tracing exporter name} is set, the
* {@code management.<name>.tracing.export.enabled} property can be used to control the
* {@code management.tracing.export.<name>.enabled} property can be used to control the
* behavior for the specific tracing exporter. In that case, the exporter specific
* property takes precedence over the global property.
*

2
module/spring-boot-micrometer-tracing/src/main/java/org/springframework/boot/micrometer/tracing/autoconfigure/OnEnabledTracingExportCondition.java

@ -37,7 +37,7 @@ class OnEnabledTracingExportCondition extends SpringBootCondition { @@ -37,7 +37,7 @@ class OnEnabledTracingExportCondition extends SpringBootCondition {
private static final String GLOBAL_PROPERTY = "management.tracing.export.enabled";
private static final String EXPORTER_PROPERTY = "management.%s.tracing.export.enabled";
private static final String EXPORTER_PROPERTY = "management.tracing.export.%s.enabled";
@Override
public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) {

16
module/spring-boot-micrometer-tracing/src/test/java/org/springframework/boot/micrometer/tracing/autoconfigure/OnEnabledTracingExportConditionTests.java

@ -69,44 +69,44 @@ class OnEnabledTracingExportConditionTests { @@ -69,44 +69,44 @@ class OnEnabledTracingExportConditionTests {
void shouldNotMatchIfExporterPropertyIsFalse() {
OnEnabledTracingExportCondition condition = new OnEnabledTracingExportCondition();
ConditionOutcome outcome = condition.getMatchOutcome(
mockConditionContext(Map.of("management.zipkin.tracing.export.enabled", "false")),
mockConditionContext(Map.of("management.tracing.export.zipkin.enabled", "false")),
mockMetadata("zipkin"));
assertThat(outcome.isMatch()).isFalse();
assertThat(outcome.getMessage())
.isEqualTo("@ConditionalOnEnabledTracingExport management.zipkin.tracing.export.enabled is false");
.isEqualTo("@ConditionalOnEnabledTracingExport management.tracing.export.zipkin.enabled is false");
}
@Test
void shouldMatchIfExporterPropertyIsTrue() {
OnEnabledTracingExportCondition condition = new OnEnabledTracingExportCondition();
ConditionOutcome outcome = condition.getMatchOutcome(
mockConditionContext(Map.of("management.zipkin.tracing.export.enabled", "true")),
mockConditionContext(Map.of("management.tracing.export.zipkin.enabled", "true")),
mockMetadata("zipkin"));
assertThat(outcome.isMatch()).isTrue();
assertThat(outcome.getMessage())
.isEqualTo("@ConditionalOnEnabledTracingExport management.zipkin.tracing.export.enabled is true");
.isEqualTo("@ConditionalOnEnabledTracingExport management.tracing.export.zipkin.enabled is true");
}
@Test
void exporterPropertyShouldOverrideGlobalPropertyIfTrue() {
OnEnabledTracingExportCondition condition = new OnEnabledTracingExportCondition();
ConditionOutcome outcome = condition.getMatchOutcome(mockConditionContext(Map
.of("management.tracing.export.enabled", "false", "management.zipkin.tracing.export.enabled", "true")),
.of("management.tracing.export.enabled", "false", "management.tracing.export.zipkin.enabled", "true")),
mockMetadata("zipkin"));
assertThat(outcome.isMatch()).isTrue();
assertThat(outcome.getMessage())
.isEqualTo("@ConditionalOnEnabledTracingExport management.zipkin.tracing.export.enabled is true");
.isEqualTo("@ConditionalOnEnabledTracingExport management.tracing.export.zipkin.enabled is true");
}
@Test
void exporterPropertyShouldOverrideGlobalPropertyIfFalse() {
OnEnabledTracingExportCondition condition = new OnEnabledTracingExportCondition();
ConditionOutcome outcome = condition.getMatchOutcome(mockConditionContext(Map
.of("management.tracing.export.enabled", "true", "management.zipkin.tracing.export.enabled", "false")),
.of("management.tracing.export.enabled", "true", "management.tracing.export.zipkin.enabled", "false")),
mockMetadata("zipkin"));
assertThat(outcome.isMatch()).isFalse();
assertThat(outcome.getMessage())
.isEqualTo("@ConditionalOnEnabledTracingExport management.zipkin.tracing.export.enabled is false");
.isEqualTo("@ConditionalOnEnabledTracingExport management.tracing.export.zipkin.enabled is false");
}
private ConditionContext mockConditionContext() {

Loading…
Cancel
Save