Use a HandlerInterceptor for timing long tasks
Closes gh-15204
This commit is contained in:
@@ -27,6 +27,7 @@ import org.springframework.boot.actuate.autoconfigure.metrics.MetricsProperties.
|
||||
import org.springframework.boot.actuate.autoconfigure.metrics.OnlyOnceLoggingDenyMeterFilter;
|
||||
import org.springframework.boot.actuate.autoconfigure.metrics.export.simple.SimpleMetricsExportAutoConfiguration;
|
||||
import org.springframework.boot.actuate.metrics.web.servlet.DefaultWebMvcTagsProvider;
|
||||
import org.springframework.boot.actuate.metrics.web.servlet.LongTaskTimingHandlerInterceptor;
|
||||
import org.springframework.boot.actuate.metrics.web.servlet.WebMvcMetricsFilter;
|
||||
import org.springframework.boot.actuate.metrics.web.servlet.WebMvcTagsProvider;
|
||||
import org.springframework.boot.autoconfigure.AutoConfigureAfter;
|
||||
@@ -41,8 +42,9 @@ 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.web.context.WebApplicationContext;
|
||||
import org.springframework.web.servlet.DispatcherServlet;
|
||||
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
|
||||
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
|
||||
|
||||
/**
|
||||
* {@link EnableAutoConfiguration Auto-configuration} for instrumentation of Spring Web
|
||||
@@ -75,11 +77,10 @@ public class WebMvcMetricsAutoConfiguration {
|
||||
|
||||
@Bean
|
||||
public FilterRegistrationBean<WebMvcMetricsFilter> webMvcMetricsFilter(
|
||||
MeterRegistry registry, WebMvcTagsProvider tagsProvider,
|
||||
WebApplicationContext context) {
|
||||
MeterRegistry registry, WebMvcTagsProvider tagsProvider) {
|
||||
Server serverProperties = this.properties.getWeb().getServer();
|
||||
WebMvcMetricsFilter filter = new WebMvcMetricsFilter(context, registry,
|
||||
tagsProvider, serverProperties.getRequestsMetricName(),
|
||||
WebMvcMetricsFilter filter = new WebMvcMetricsFilter(registry, tagsProvider,
|
||||
serverProperties.getRequestsMetricName(),
|
||||
serverProperties.isAutoTimeRequests());
|
||||
FilterRegistrationBean<WebMvcMetricsFilter> registration = new FilterRegistrationBean<>(
|
||||
filter);
|
||||
@@ -98,4 +99,30 @@ public class WebMvcMetricsAutoConfiguration {
|
||||
this.properties.getWeb().getServer().getMaxUriTags(), filter);
|
||||
}
|
||||
|
||||
@Bean
|
||||
public MetricsWebMvcConfigurer metricsWebMvcConfigurer(MeterRegistry meterRegistry,
|
||||
WebMvcTagsProvider tagsProvider) {
|
||||
return new MetricsWebMvcConfigurer(meterRegistry, tagsProvider);
|
||||
}
|
||||
|
||||
static class MetricsWebMvcConfigurer implements WebMvcConfigurer {
|
||||
|
||||
private final MeterRegistry meterRegistry;
|
||||
|
||||
private final WebMvcTagsProvider tagsProvider;
|
||||
|
||||
MetricsWebMvcConfigurer(MeterRegistry meterRegistry,
|
||||
WebMvcTagsProvider tagsProvider) {
|
||||
this.meterRegistry = meterRegistry;
|
||||
this.tagsProvider = tagsProvider;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void addInterceptors(InterceptorRegistry registry) {
|
||||
registry.addInterceptor(new LongTaskTimingHandlerInterceptor(
|
||||
this.meterRegistry, this.tagsProvider));
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@@ -33,6 +33,7 @@ import org.junit.Test;
|
||||
import org.springframework.boot.actuate.autoconfigure.metrics.MetricsAutoConfiguration;
|
||||
import org.springframework.boot.actuate.autoconfigure.metrics.web.TestController;
|
||||
import org.springframework.boot.actuate.metrics.web.servlet.DefaultWebMvcTagsProvider;
|
||||
import org.springframework.boot.actuate.metrics.web.servlet.LongTaskTimingHandlerInterceptor;
|
||||
import org.springframework.boot.actuate.metrics.web.servlet.WebMvcMetricsFilter;
|
||||
import org.springframework.boot.actuate.metrics.web.servlet.WebMvcTagsProvider;
|
||||
import org.springframework.boot.autoconfigure.AutoConfigurations;
|
||||
@@ -47,6 +48,7 @@ import org.springframework.core.Ordered;
|
||||
import org.springframework.test.web.servlet.MockMvc;
|
||||
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
|
||||
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
|
||||
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
|
||||
@@ -140,6 +142,22 @@ public class WebMvcMetricsAutoConfigurationTests {
|
||||
});
|
||||
}
|
||||
|
||||
@Test
|
||||
@SuppressWarnings("rawtypes")
|
||||
public void longTaskTimingInterceptorIsRegistered() {
|
||||
this.contextRunner
|
||||
.withUserConfiguration(TestController.class,
|
||||
MeterRegistryConfiguration.class)
|
||||
.withConfiguration(AutoConfigurations.of(MetricsAutoConfiguration.class,
|
||||
WebMvcAutoConfiguration.class))
|
||||
.run((context) -> {
|
||||
assertThat(context.getBean(RequestMappingHandlerMapping.class))
|
||||
.extracting("interceptors").element(0).asList()
|
||||
.extracting((item) -> (Class) item.getClass())
|
||||
.contains(LongTaskTimingHandlerInterceptor.class);
|
||||
});
|
||||
}
|
||||
|
||||
private MeterRegistry getInitializedMeterRegistry(
|
||||
AssertableWebApplicationContext context) throws Exception {
|
||||
assertThat(context).hasSingleBean(FilterRegistrationBean.class);
|
||||
|
||||
Reference in New Issue
Block a user