Move WebMvc observation auto-config into spring-boot-webmvc
This commit is contained in:
Andy Wilkinson
committed by
Phillip Webb
Phillip Webb
parent
46a5ea0ee7
commit
9c634d2fb0
@@ -0,0 +1,99 @@
|
||||
/*
|
||||
* Copyright 2012-2025 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.boot.webmvc.observation.autoconfigure;
|
||||
|
||||
import io.micrometer.core.instrument.MeterRegistry;
|
||||
import io.micrometer.core.instrument.config.MeterFilter;
|
||||
import io.micrometer.observation.Observation;
|
||||
import io.micrometer.observation.ObservationRegistry;
|
||||
import jakarta.servlet.DispatcherType;
|
||||
|
||||
import org.springframework.beans.factory.ObjectProvider;
|
||||
import org.springframework.boot.autoconfigure.AutoConfiguration;
|
||||
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingFilterBean;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
|
||||
import org.springframework.boot.context.properties.EnableConfigurationProperties;
|
||||
import org.springframework.boot.metrics.OnlyOnceLoggingDenyMeterFilter;
|
||||
import org.springframework.boot.metrics.autoconfigure.MetricsProperties;
|
||||
import org.springframework.boot.micrometer.observation.autoconfigure.ObservationProperties;
|
||||
import org.springframework.boot.web.servlet.FilterRegistrationBean;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.core.Ordered;
|
||||
import org.springframework.core.annotation.Order;
|
||||
import org.springframework.http.server.observation.DefaultServerRequestObservationConvention;
|
||||
import org.springframework.http.server.observation.ServerRequestObservationConvention;
|
||||
import org.springframework.web.filter.ServerHttpObservationFilter;
|
||||
import org.springframework.web.servlet.DispatcherServlet;
|
||||
|
||||
/**
|
||||
* {@link EnableAutoConfiguration Auto-configuration} for instrumentation of Spring Web
|
||||
* MVC servlet-based request mappings.
|
||||
*
|
||||
* @author Brian Clozel
|
||||
* @author Jon Schneider
|
||||
* @author Dmytro Nosan
|
||||
* @since 4.0.0
|
||||
*/
|
||||
@AutoConfiguration(
|
||||
afterName = { "org.springframework.boot.metrics.autoconfigure.CompositeMeterRegistryAutoConfiguration",
|
||||
"org.springframework.boot.metrics.autoconfigure.MetricsAutoConfiguration",
|
||||
"org.springframework.boot.metrics.autoconfigure.export.simple.SimpleMetricsExportAutoConfiguration",
|
||||
"org.springframework.boot.micrometer.observation.autoconfigure.ObservationAutoConfiguration" })
|
||||
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
|
||||
@ConditionalOnClass({ DispatcherServlet.class, Observation.class })
|
||||
@ConditionalOnBean(ObservationRegistry.class)
|
||||
@EnableConfigurationProperties({ MetricsProperties.class, ObservationProperties.class })
|
||||
public class WebMvcObservationAutoConfiguration {
|
||||
|
||||
@Bean
|
||||
@ConditionalOnMissingFilterBean
|
||||
public FilterRegistrationBean<ServerHttpObservationFilter> webMvcObservationFilter(ObservationRegistry registry,
|
||||
ObjectProvider<ServerRequestObservationConvention> customConvention,
|
||||
ObservationProperties observationProperties) {
|
||||
String name = observationProperties.getHttp().getServer().getRequests().getName();
|
||||
ServerRequestObservationConvention convention = customConvention
|
||||
.getIfAvailable(() -> new DefaultServerRequestObservationConvention(name));
|
||||
ServerHttpObservationFilter filter = new ServerHttpObservationFilter(registry, convention);
|
||||
FilterRegistrationBean<ServerHttpObservationFilter> registration = new FilterRegistrationBean<>(filter);
|
||||
registration.setOrder(Ordered.HIGHEST_PRECEDENCE + 1);
|
||||
registration.setDispatcherTypes(DispatcherType.REQUEST, DispatcherType.ASYNC);
|
||||
return registration;
|
||||
}
|
||||
|
||||
@Configuration(proxyBeanMethods = false)
|
||||
@ConditionalOnClass(MeterRegistry.class)
|
||||
@ConditionalOnBean(MeterRegistry.class)
|
||||
static class MeterFilterConfiguration {
|
||||
|
||||
@Bean
|
||||
@Order(0)
|
||||
MeterFilter metricsHttpServerUriTagFilter(ObservationProperties observationProperties,
|
||||
MetricsProperties metricsProperties) {
|
||||
String name = observationProperties.getHttp().getServer().getRequests().getName();
|
||||
MeterFilter filter = new OnlyOnceLoggingDenyMeterFilter(
|
||||
() -> String.format("Reached the maximum number of URI tags for '%s'.", name));
|
||||
return MeterFilter.maximumAllowableTags(name, "uri", metricsProperties.getWeb().getServer().getMaxUriTags(),
|
||||
filter);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
/*
|
||||
* Copyright 2012-2025 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Auto-configuration for Spring MVC observation support.
|
||||
*/
|
||||
package org.springframework.boot.webmvc.observation.autoconfigure;
|
||||
@@ -2,3 +2,4 @@ org.springframework.boot.webmvc.actuate.autoconfigure.health.WebMvcHealthEndpoin
|
||||
org.springframework.boot.webmvc.autoconfigure.DispatcherServletAutoConfiguration
|
||||
org.springframework.boot.webmvc.autoconfigure.WebMvcAutoConfiguration
|
||||
org.springframework.boot.webmvc.autoconfigure.error.ErrorMvcAutoConfiguration
|
||||
org.springframework.boot.webmvc.observation.autoconfigure.WebMvcObservationAutoConfiguration
|
||||
|
||||
@@ -0,0 +1,275 @@
|
||||
/*
|
||||
* Copyright 2012-2025 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.boot.webmvc.observation.autoconfigure;
|
||||
|
||||
import java.util.EnumSet;
|
||||
|
||||
import io.micrometer.core.instrument.MeterRegistry;
|
||||
import io.micrometer.core.instrument.observation.DefaultMeterObservationHandler;
|
||||
import io.micrometer.core.instrument.observation.DefaultMeterObservationHandler.IgnoredMeters;
|
||||
import io.micrometer.core.instrument.observation.MeterObservationHandler;
|
||||
import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
|
||||
import io.micrometer.observation.Observation.Context;
|
||||
import io.micrometer.observation.tck.TestObservationRegistry;
|
||||
import jakarta.servlet.DispatcherType;
|
||||
import jakarta.servlet.Filter;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.junit.jupiter.api.extension.ExtendWith;
|
||||
|
||||
import org.springframework.boot.autoconfigure.AutoConfigurations;
|
||||
import org.springframework.boot.metrics.autoconfigure.MetricsAutoConfiguration;
|
||||
import org.springframework.boot.micrometer.observation.autoconfigure.ObservationAutoConfiguration;
|
||||
import org.springframework.boot.test.context.assertj.AssertableWebApplicationContext;
|
||||
import org.springframework.boot.test.context.runner.WebApplicationContextRunner;
|
||||
import org.springframework.boot.test.system.CapturedOutput;
|
||||
import org.springframework.boot.test.system.OutputCaptureExtension;
|
||||
import org.springframework.boot.web.servlet.FilterRegistrationBean;
|
||||
import org.springframework.boot.webmvc.autoconfigure.WebMvcAutoConfiguration;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.core.Ordered;
|
||||
import org.springframework.http.server.observation.DefaultServerRequestObservationConvention;
|
||||
import org.springframework.test.web.servlet.assertj.MockMvcTester;
|
||||
import org.springframework.web.bind.annotation.GetMapping;
|
||||
import org.springframework.web.bind.annotation.RestController;
|
||||
import org.springframework.web.filter.ServerHttpObservationFilter;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.mockito.Mockito.mock;
|
||||
|
||||
/**
|
||||
* Tests for {@link WebMvcObservationAutoConfiguration}.
|
||||
*
|
||||
* @author Andy Wilkinson
|
||||
* @author Dmytro Nosan
|
||||
* @author Tadaya Tsuyukubo
|
||||
* @author Madhura Bhave
|
||||
* @author Chanhyeong LEE
|
||||
*/
|
||||
@ExtendWith(OutputCaptureExtension.class)
|
||||
class WebMvcObservationAutoConfigurationTests {
|
||||
|
||||
private final WebApplicationContextRunner contextRunner = new WebApplicationContextRunner()
|
||||
.withConfiguration(
|
||||
AutoConfigurations.of(ObservationAutoConfiguration.class, WebMvcObservationAutoConfiguration.class))
|
||||
.withBean(SimpleMeterRegistry.class);
|
||||
|
||||
@Test
|
||||
void backsOffWhenObservationRegistryIsMissing() {
|
||||
new WebApplicationContextRunner()
|
||||
.withConfiguration(AutoConfigurations.of(WebMvcObservationAutoConfiguration.class))
|
||||
.run((context) -> assertThat(context).doesNotHaveBean(FilterRegistrationBean.class));
|
||||
}
|
||||
|
||||
@Test
|
||||
void definesFilterWhenRegistryIsPresent() {
|
||||
this.contextRunner.run((context) -> {
|
||||
assertThat(context).hasSingleBean(FilterRegistrationBean.class);
|
||||
assertThat(context.getBean(FilterRegistrationBean.class).getFilter())
|
||||
.isInstanceOf(ServerHttpObservationFilter.class);
|
||||
});
|
||||
}
|
||||
|
||||
@Test
|
||||
void customConventionWhenPresent() {
|
||||
this.contextRunner.withUserConfiguration(CustomConventionConfiguration.class)
|
||||
.run((context) -> assertThat(context.getBean(FilterRegistrationBean.class).getFilter())
|
||||
.extracting("observationConvention")
|
||||
.isInstanceOf(CustomConvention.class));
|
||||
}
|
||||
|
||||
@Test
|
||||
void filterRegistrationHasExpectedDispatcherTypesAndOrder() {
|
||||
this.contextRunner.run((context) -> {
|
||||
FilterRegistrationBean<?> registration = context.getBean(FilterRegistrationBean.class);
|
||||
assertThat(registration).hasFieldOrPropertyWithValue("dispatcherTypes",
|
||||
EnumSet.of(DispatcherType.REQUEST, DispatcherType.ASYNC));
|
||||
assertThat(registration.getOrder()).isEqualTo(Ordered.HIGHEST_PRECEDENCE + 1);
|
||||
});
|
||||
}
|
||||
|
||||
@Test
|
||||
void filterRegistrationBacksOffWithAnotherServerHttpObservationFilterRegistration() {
|
||||
this.contextRunner.withUserConfiguration(TestServerHttpObservationFilterRegistrationConfiguration.class)
|
||||
.run((context) -> {
|
||||
assertThat(context).hasSingleBean(FilterRegistrationBean.class);
|
||||
assertThat(context.getBean(FilterRegistrationBean.class))
|
||||
.isSameAs(context.getBean("testServerHttpObservationFilter"));
|
||||
});
|
||||
}
|
||||
|
||||
@Test
|
||||
void filterRegistrationBacksOffWithAnotherServerHttpObservationFilter() {
|
||||
this.contextRunner.withUserConfiguration(TestServerHttpObservationFilterConfiguration.class)
|
||||
.run((context) -> assertThat(context).doesNotHaveBean(FilterRegistrationBean.class)
|
||||
.hasSingleBean(ServerHttpObservationFilter.class));
|
||||
}
|
||||
|
||||
@Test
|
||||
void filterRegistrationDoesNotBackOffWithOtherFilterRegistration() {
|
||||
this.contextRunner.withUserConfiguration(TestFilterRegistrationConfiguration.class)
|
||||
.run((context) -> assertThat(context).hasBean("testFilter").hasBean("webMvcObservationFilter"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void filterRegistrationDoesNotBackOffWithOtherFilter() {
|
||||
this.contextRunner.withUserConfiguration(TestFilterConfiguration.class)
|
||||
.run((context) -> assertThat(context).hasBean("testFilter").hasBean("webMvcObservationFilter"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void afterMaxUrisReachedFurtherUrisAreDenied(CapturedOutput output) {
|
||||
this.contextRunner.withUserConfiguration(TestController.class, MetricsConfiguration.class)
|
||||
.withConfiguration(AutoConfigurations.of(MetricsAutoConfiguration.class, ObservationAutoConfiguration.class,
|
||||
WebMvcAutoConfiguration.class))
|
||||
.withPropertyValues("management.metrics.web.server.max-uri-tags=2")
|
||||
.run((context) -> {
|
||||
MeterRegistry registry = getInitializedMeterRegistry(context);
|
||||
assertThat(registry.get("http.server.requests").meters()).hasSizeLessThanOrEqualTo(2);
|
||||
assertThat(output).contains("Reached the maximum number of URI tags for 'http.server.requests'");
|
||||
});
|
||||
}
|
||||
|
||||
@Test
|
||||
void afterMaxUrisReachedFurtherUrisAreDeniedWhenUsingCustomObservationName(CapturedOutput output) {
|
||||
this.contextRunner.withUserConfiguration(TestController.class, MetricsConfiguration.class)
|
||||
.withConfiguration(AutoConfigurations.of(MetricsAutoConfiguration.class, ObservationAutoConfiguration.class,
|
||||
WebMvcAutoConfiguration.class))
|
||||
.withPropertyValues("management.metrics.web.server.max-uri-tags=2",
|
||||
"management.observations.http.server.requests.name=my.http.server.requests")
|
||||
.run((context) -> {
|
||||
MeterRegistry registry = getInitializedMeterRegistry(context);
|
||||
assertThat(registry.get("my.http.server.requests").meters()).hasSizeLessThanOrEqualTo(2);
|
||||
assertThat(output).contains("Reached the maximum number of URI tags for 'my.http.server.requests'");
|
||||
});
|
||||
}
|
||||
|
||||
@Test
|
||||
void shouldNotDenyNorLogIfMaxUrisIsNotReached(CapturedOutput output) {
|
||||
this.contextRunner.withUserConfiguration(TestController.class, MetricsConfiguration.class)
|
||||
.withConfiguration(AutoConfigurations.of(MetricsAutoConfiguration.class, ObservationAutoConfiguration.class,
|
||||
WebMvcAutoConfiguration.class))
|
||||
.withPropertyValues("management.metrics.web.server.max-uri-tags=5")
|
||||
.run((context) -> {
|
||||
MeterRegistry registry = getInitializedMeterRegistry(context);
|
||||
assertThat(registry.get("http.server.requests").meters()).hasSize(3);
|
||||
assertThat(output).doesNotContain("Reached the maximum number of URI tags for 'http.server.requests'");
|
||||
});
|
||||
}
|
||||
|
||||
private MeterRegistry getInitializedMeterRegistry(AssertableWebApplicationContext context) {
|
||||
return getInitializedMeterRegistry(context, "/test0", "/test1", "/test2");
|
||||
}
|
||||
|
||||
private MeterRegistry getInitializedMeterRegistry(AssertableWebApplicationContext context, String... urls) {
|
||||
assertThat(context).hasSingleBean(FilterRegistrationBean.class);
|
||||
Filter filter = context.getBean(FilterRegistrationBean.class).getFilter();
|
||||
assertThat(filter).isInstanceOf(ServerHttpObservationFilter.class);
|
||||
MockMvcTester mvc = MockMvcTester.from(context, (builder) -> builder.addFilters(filter).build());
|
||||
for (String url : urls) {
|
||||
assertThat(mvc.get().uri(url)).hasStatusOk();
|
||||
}
|
||||
return context.getBean(MeterRegistry.class);
|
||||
}
|
||||
|
||||
@Configuration(proxyBeanMethods = false)
|
||||
static class TestServerHttpObservationFilterRegistrationConfiguration {
|
||||
|
||||
@Bean
|
||||
@SuppressWarnings("unchecked")
|
||||
FilterRegistrationBean<ServerHttpObservationFilter> testServerHttpObservationFilter() {
|
||||
return mock(FilterRegistrationBean.class);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@Configuration(proxyBeanMethods = false)
|
||||
static class TestServerHttpObservationFilterConfiguration {
|
||||
|
||||
@Bean
|
||||
ServerHttpObservationFilter testServerHttpObservationFilter() {
|
||||
return new ServerHttpObservationFilter(TestObservationRegistry.create());
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@Configuration(proxyBeanMethods = false)
|
||||
static class TestFilterRegistrationConfiguration {
|
||||
|
||||
@Bean
|
||||
@SuppressWarnings("unchecked")
|
||||
FilterRegistrationBean<Filter> testFilter() {
|
||||
return mock(FilterRegistrationBean.class);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@Configuration(proxyBeanMethods = false)
|
||||
static class TestFilterConfiguration {
|
||||
|
||||
@Bean
|
||||
Filter testFilter() {
|
||||
return mock(Filter.class);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@Configuration(proxyBeanMethods = false)
|
||||
static class CustomConventionConfiguration {
|
||||
|
||||
@Bean
|
||||
CustomConvention customConvention() {
|
||||
return new CustomConvention();
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
static class CustomConvention extends DefaultServerRequestObservationConvention {
|
||||
|
||||
}
|
||||
|
||||
@Configuration(proxyBeanMethods = false)
|
||||
static class MetricsConfiguration {
|
||||
|
||||
@Bean
|
||||
MeterObservationHandler<Context> meterObservationHandler(MeterRegistry registry) {
|
||||
return new DefaultMeterObservationHandler(registry, IgnoredMeters.LONG_TASK_TIMER);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@RestController
|
||||
static class TestController {
|
||||
|
||||
@GetMapping("test0")
|
||||
String test0() {
|
||||
return "test0";
|
||||
}
|
||||
|
||||
@GetMapping("test1")
|
||||
String test1() {
|
||||
return "test1";
|
||||
}
|
||||
|
||||
@GetMapping("test2")
|
||||
String test2() {
|
||||
return "test2";
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user