From 5b092f5d80970c9797219823995090d15ee5da58 Mon Sep 17 00:00:00 2001 From: Brian Clozel Date: Fri, 30 Sep 2022 12:52:22 +0200 Subject: [PATCH] Polish See gh-32518 --- .../autoconfigure/metrics/MetricsProperties.java | 1 + .../HttpClientObservationsAutoConfiguration.java | 15 ++++++++++----- .../ClientObservationConventionAdapterTests.java | 2 +- .../WebClientObservationConfigurationTests.java | 2 +- .../DefaultWebClientExchangeTagsProvider.java | 3 ++- ...DefaultWebClientExchangeTagsProviderTests.java | 2 +- .../client/WebClientExchangeTagsTests.java | 2 +- 7 files changed, 17 insertions(+), 10 deletions(-) diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsProperties.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsProperties.java index 141be9b6ea..0c1d64a426 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsProperties.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsProperties.java @@ -149,6 +149,7 @@ public class MetricsProperties { */ private String metricName = "http.client.requests"; + @Deprecated @DeprecatedConfigurationProperty(replacement = "management.observations.http.client.requests.name") public String getMetricName() { return this.metricName; diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/web/client/HttpClientObservationsAutoConfiguration.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/web/client/HttpClientObservationsAutoConfiguration.java index 81ea628a32..57dd668dd8 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/web/client/HttpClientObservationsAutoConfiguration.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/web/client/HttpClientObservationsAutoConfiguration.java @@ -25,6 +25,7 @@ import org.springframework.boot.actuate.autoconfigure.metrics.CompositeMeterRegi import org.springframework.boot.actuate.autoconfigure.metrics.MetricsProperties; import org.springframework.boot.actuate.autoconfigure.metrics.OnlyOnceLoggingDenyMeterFilter; import org.springframework.boot.actuate.autoconfigure.observation.ObservationAutoConfiguration; +import org.springframework.boot.actuate.autoconfigure.observation.ObservationProperties; import org.springframework.boot.autoconfigure.AutoConfiguration; import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; @@ -61,11 +62,15 @@ public class HttpClientObservationsAutoConfiguration { @Bean @Order(0) - MeterFilter metricsHttpClientUriTagFilter(MetricsProperties properties) { - String metricName = properties.getWeb().getClient().getRequest().getMetricName(); - MeterFilter denyFilter = new OnlyOnceLoggingDenyMeterFilter(() -> String.format( - "Reached the maximum number of URI tags for '%s'. Are you using 'uriVariables'?", metricName)); - return MeterFilter.maximumAllowableTags(metricName, "uri", properties.getWeb().getClient().getMaxUriTags(), + @SuppressWarnings("deprecation") + MeterFilter metricsHttpClientUriTagFilter(ObservationProperties observationProperties, + MetricsProperties metricsProperties) { + String metricName = metricsProperties.getWeb().getClient().getRequest().getMetricName(); + String observationName = observationProperties.getHttp().getClient().getRequests().getName(); + String name = (observationName != null) ? observationName : metricName; + MeterFilter denyFilter = new OnlyOnceLoggingDenyMeterFilter(() -> String + .format("Reached the maximum number of URI tags for '%s'. Are you using 'uriVariables'?", name)); + return MeterFilter.maximumAllowableTags(name, "uri", metricsProperties.getWeb().getClient().getMaxUriTags(), denyFilter); } diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/web/client/ClientObservationConventionAdapterTests.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/web/client/ClientObservationConventionAdapterTests.java index 786a68d2a5..616b377fca 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/web/client/ClientObservationConventionAdapterTests.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/web/client/ClientObservationConventionAdapterTests.java @@ -37,7 +37,7 @@ import static org.assertj.core.api.Assertions.assertThat; * * @author Brian Clozel */ -@SuppressWarnings("deprecation") +@SuppressWarnings({ "deprecation", "removal" }) class ClientObservationConventionAdapterTests { private static final String TEST_METRIC_NAME = "test.metric.name"; diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/web/client/WebClientObservationConfigurationTests.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/web/client/WebClientObservationConfigurationTests.java index ca3dc1bbe3..31c70049c8 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/web/client/WebClientObservationConfigurationTests.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/web/client/WebClientObservationConfigurationTests.java @@ -55,7 +55,7 @@ import static org.mockito.Mockito.mock; * @author Stephane Nicoll */ @ExtendWith(OutputCaptureExtension.class) -@SuppressWarnings("deprecation") +@SuppressWarnings({ "deprecation", "removal" }) class WebClientObservationConfigurationTests { private final ApplicationContextRunner contextRunner = new ApplicationContextRunner().with(MetricsRun.simple()) diff --git a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/web/reactive/client/DefaultWebClientExchangeTagsProvider.java b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/web/reactive/client/DefaultWebClientExchangeTagsProvider.java index 2fde367ae6..c99b89aa2b 100644 --- a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/web/reactive/client/DefaultWebClientExchangeTagsProvider.java +++ b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/web/reactive/client/DefaultWebClientExchangeTagsProvider.java @@ -32,7 +32,8 @@ import org.springframework.web.reactive.function.client.ClientResponse; * @deprecated since 3.0.0 for removal in 3.2.0 in favor of * {@link org.springframework.web.reactive.function.client.DefaultClientObservationConvention} */ -@Deprecated +@Deprecated(since = "3.0.0", forRemoval = true) +@SuppressWarnings({ "deprecation", "removal" }) public class DefaultWebClientExchangeTagsProvider implements WebClientExchangeTagsProvider { @Override diff --git a/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/web/reactive/client/DefaultWebClientExchangeTagsProviderTests.java b/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/web/reactive/client/DefaultWebClientExchangeTagsProviderTests.java index b8758ff941..80962805a9 100644 --- a/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/web/reactive/client/DefaultWebClientExchangeTagsProviderTests.java +++ b/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/web/reactive/client/DefaultWebClientExchangeTagsProviderTests.java @@ -39,7 +39,7 @@ import static org.mockito.Mockito.mock; * @author Brian Clozel * @author Nishant Raut */ -@SuppressWarnings("deprecation") +@SuppressWarnings({ "deprecation", "removal" }) class DefaultWebClientExchangeTagsProviderTests { private static final String URI_TEMPLATE_ATTRIBUTE = WebClient.class.getName() + ".uriTemplate"; diff --git a/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/web/reactive/client/WebClientExchangeTagsTests.java b/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/web/reactive/client/WebClientExchangeTagsTests.java index 0bae055072..96f67e8e1b 100644 --- a/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/web/reactive/client/WebClientExchangeTagsTests.java +++ b/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/web/reactive/client/WebClientExchangeTagsTests.java @@ -40,7 +40,7 @@ import static org.mockito.Mockito.mock; * @author Brian Clozel * @author Nishant Raut */ -@SuppressWarnings({"deprecation", "removal"}) +@SuppressWarnings({ "deprecation", "removal" }) class WebClientExchangeTagsTests { private static final String URI_TEMPLATE_ATTRIBUTE = WebClient.class.getName() + ".uriTemplate";