From 43c2f1c03cca31de8d6314c552323c7aec1b119b Mon Sep 17 00:00:00 2001 From: Johnny Lim Date: Sun, 19 Jun 2022 23:39:03 +0900 Subject: [PATCH] Polish AutoConfigureObservability changes See gh-31457 --- .../autoconfigure/tracing/OnTracingEnabledConditionTests.java | 2 ++ .../autoconfigure/actuate/metrics/AutoConfigureMetrics.java | 3 ++- .../actuate/observability/AutoConfigureObservability.java | 2 +- .../observability/ObservabilityContextCustomizerFactory.java | 4 ++-- 4 files changed, 7 insertions(+), 4 deletions(-) diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/tracing/OnTracingEnabledConditionTests.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/tracing/OnTracingEnabledConditionTests.java index 45e1a1a759..e5a276bf39 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/tracing/OnTracingEnabledConditionTests.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/tracing/OnTracingEnabledConditionTests.java @@ -29,6 +29,8 @@ import static org.mockito.BDDMockito.given; import static org.mockito.Mockito.mock; /** + * Tests for {@link OnTracingEnabledCondition}. + * * @author Moritz Halbritter */ class OnTracingEnabledConditionTests { diff --git a/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/actuate/metrics/AutoConfigureMetrics.java b/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/actuate/metrics/AutoConfigureMetrics.java index 6ec6ada754..f6ae74dd97 100644 --- a/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/actuate/metrics/AutoConfigureMetrics.java +++ b/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/actuate/metrics/AutoConfigureMetrics.java @@ -31,7 +31,8 @@ import org.springframework.boot.test.autoconfigure.actuate.observability.AutoCon * * @author Chris Bono * @since 2.4.0 - * @deprecated use {@link AutoConfigureObservability} instead + * @deprecated since 3.0.0 for removal in 3.2.0 in favor of + * {@link AutoConfigureObservability @AutoConfigureObservability} */ @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) diff --git a/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/actuate/observability/AutoConfigureObservability.java b/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/actuate/observability/AutoConfigureObservability.java index a72bf7c4c4..fb16e8d103 100644 --- a/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/actuate/observability/AutoConfigureObservability.java +++ b/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/actuate/observability/AutoConfigureObservability.java @@ -44,7 +44,7 @@ public @interface AutoConfigureObservability { /** * Whether tracing should be enabled in the test. - * @return whether metrics should be enabled in the test + * @return whether tracing should be enabled in the test */ boolean tracing() default true; diff --git a/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/actuate/observability/ObservabilityContextCustomizerFactory.java b/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/actuate/observability/ObservabilityContextCustomizerFactory.java index f22fbaf997..f2b3be1954 100644 --- a/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/actuate/observability/ObservabilityContextCustomizerFactory.java +++ b/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/actuate/observability/ObservabilityContextCustomizerFactory.java @@ -28,8 +28,8 @@ import org.springframework.test.context.MergedContextConfiguration; import org.springframework.test.context.TestContextAnnotationUtils; /** - * {@link ContextCustomizerFactory} that globally disables metrics export unless - * {@link AutoConfigureObservability} is set on the test class. + * {@link ContextCustomizerFactory} that globally disables metrics export and tracing + * unless {@link AutoConfigureObservability} is set on the test class. * * @author Chris Bono * @author Moritz Halbritter