Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Move MVC metrics to Observation auto-configuration

Browse Source 
This commit moves the entire Metrics auto-configuration for Spring MVC
to the new `Observation` API and the instrumentation contributed in
Spring Framework.

Closes gh-32538
This commit is contained in:
Brian Clozel
2022-10-19 19:33:31 +02:00
parent e6c69061b5
commit b2fe807d47
29 changed files with 455 additions and 1773 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/web/servlet/DefaultWebMvcTagsProvider.java
View File

@@ -29,7 +29,11 @@ import jakarta.servlet.http.HttpServletResponse;
*
* @author Jon Schneider
* @since 2.0.0
* @deprecated since 3.0.0 for removal in 3.2.0 in favor of
* {@link org.springframework.http.observation.ServerRequestObservationConvention}
*/
@Deprecated(since = "3.0.0", forRemoval = true)
@SuppressWarnings("removal")
public class DefaultWebMvcTagsProvider implements WebMvcTagsProvider {
private final boolean ignoreTrailingSlash;

165
spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/web/servlet/LongTaskTimingHandlerInterceptor.java
View File

@@ -1,165 +0,0 @@
/*
* Copyright 2012-2022 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.actuate.metrics.web.servlet;
import java.lang.reflect.AnnotatedElement;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Set;
import io.micrometer.core.annotation.Timed;
import io.micrometer.core.instrument.LongTaskTimer;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Tag;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.core.annotation.MergedAnnotationCollectors;
import org.springframework.core.annotation.MergedAnnotations;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
/**
* A {@link HandlerInterceptor} that supports Micrometer's long task timers configured on
* a handler using {@link Timed @Timed} with {@link Timed#longTask() longTask} set to
* {@code true}.
*
* @author Andy Wilkinson
* @since 2.0.7
*/
public class LongTaskTimingHandlerInterceptor implements HandlerInterceptor {
private static final Log logger = LogFactory.getLog(LongTaskTimingHandlerInterceptor.class);
private final MeterRegistry registry;
private final WebMvcTagsProvider tagsProvider;
/**
* Creates a new {@code LongTaskTimingHandlerInterceptor} that will create
* {@link LongTaskTimer LongTaskTimers} using the given registry. Timers will be
* tagged using the given {@code tagsProvider}.
* @param registry the registry
* @param tagsProvider the tags provider
*/
public LongTaskTimingHandlerInterceptor(MeterRegistry registry, WebMvcTagsProvider tagsProvider) {
this.registry = registry;
this.tagsProvider = tagsProvider;
}
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
throws Exception {
LongTaskTimingContext timingContext = LongTaskTimingContext.get(request);
if (timingContext == null) {
startAndAttachTimingContext(request, handler);
}
return true;
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
throws Exception {
if (!request.isAsyncStarted()) {
stopLongTaskTimers(LongTaskTimingContext.get(request));
}
}
private void startAndAttachTimingContext(HttpServletRequest request, Object handler) {
Set<Timed> annotations = getTimedAnnotations(handler);
Collection<LongTaskTimer.Sample> longTaskTimerSamples = getLongTaskTimerSamples(request, handler, annotations);
LongTaskTimingContext timingContext = new LongTaskTimingContext(longTaskTimerSamples);
timingContext.attachTo(request);
}
private Collection<LongTaskTimer.Sample> getLongTaskTimerSamples(HttpServletRequest request, Object handler,
Set<Timed> annotations) {
List<LongTaskTimer.Sample> samples = new ArrayList<>();
try {
annotations.stream().filter(Timed::longTask).forEach((annotation) -> {
Iterable<Tag> tags = this.tagsProvider.getLongRequestTags(request, handler);
LongTaskTimer.Builder builder = LongTaskTimer.builder(annotation).tags(tags);
LongTaskTimer timer = builder.register(this.registry);
samples.add(timer.start());
});
}
catch (Exception ex) {
logger.warn("Failed to start long task timers", ex);
// Allow request-response exchange to continue, unaffected by metrics problem
}
return samples;
}
private Set<Timed> getTimedAnnotations(Object handler) {
if (handler instanceof HandlerMethod handlerMethod) {
return getTimedAnnotations(handlerMethod);
}
return Collections.emptySet();
}
private Set<Timed> getTimedAnnotations(HandlerMethod handler) {
Set<Timed> timed = findTimedAnnotations(handler.getMethod());
if (timed.isEmpty()) {
return findTimedAnnotations(handler.getBeanType());
}
return timed;
}
private Set<Timed> findTimedAnnotations(AnnotatedElement element) {
return MergedAnnotations.from(element).stream(Timed.class)
.collect(MergedAnnotationCollectors.toAnnotationSet());
}
private void stopLongTaskTimers(LongTaskTimingContext timingContext) {
for (LongTaskTimer.Sample sample : timingContext.getLongTaskTimerSamples()) {
sample.stop();
}
}
/**
* Context object attached to a request to retain information across the multiple
* interceptor calls that happen with async requests.
*/
static class LongTaskTimingContext {
private static final String ATTRIBUTE = LongTaskTimingContext.class.getName();
private final Collection<LongTaskTimer.Sample> longTaskTimerSamples;
LongTaskTimingContext(Collection<LongTaskTimer.Sample> longTaskTimerSamples) {
this.longTaskTimerSamples = longTaskTimerSamples;
}
Collection<LongTaskTimer.Sample> getLongTaskTimerSamples() {
return this.longTaskTimerSamples;
}
void attachTo(HttpServletRequest request) {
request.setAttribute(ATTRIBUTE, this);
}
static LongTaskTimingContext get(HttpServletRequest request) {
return (LongTaskTimingContext) request.getAttribute(ATTRIBUTE);
}
}
}

190
spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/web/servlet/WebMvcMetricsFilter.java
View File

@@ -1,190 +0,0 @@
/*
* Copyright 2012-2022 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.actuate.metrics.web.servlet;
import java.io.IOException;
import java.util.Collections;
import java.util.Set;
import io.micrometer.core.annotation.Timed;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Timer;
import io.micrometer.core.instrument.Timer.Builder;
import io.micrometer.core.instrument.Timer.Sample;
import jakarta.servlet.FilterChain;
import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.boot.actuate.metrics.AutoTimer;
import org.springframework.boot.actuate.metrics.annotation.TimedAnnotations;
import org.springframework.boot.web.servlet.error.ErrorAttributes;
import org.springframework.http.HttpStatus;
import org.springframework.web.filter.OncePerRequestFilter;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.DispatcherServlet;
import org.springframework.web.servlet.HandlerMapping;
/**
* Intercepts incoming HTTP requests handled by Spring MVC handlers and records metrics
* about execution time and results.
*
* @author Jon Schneider
* @author Phillip Webb
* @author Chanhyeong LEE
* @since 2.0.0
*/
public class WebMvcMetricsFilter extends OncePerRequestFilter {
private static final Log logger = LogFactory.getLog(WebMvcMetricsFilter.class);
private final MeterRegistry registry;
private final WebMvcTagsProvider tagsProvider;
private final String metricName;
private final AutoTimer autoTimer;
/**
* Create a new {@link WebMvcMetricsFilter} instance.
* @param registry the meter registry
* @param tagsProvider the tags provider
* @param metricName the metric name
* @param autoTimer the auto-timers to apply or {@code null} to disable auto-timing
* @since 2.2.0
*/
public WebMvcMetricsFilter(MeterRegistry registry, WebMvcTagsProvider tagsProvider, String metricName,
AutoTimer autoTimer) {
this.registry = registry;
this.tagsProvider = tagsProvider;
this.metricName = metricName;
this.autoTimer = autoTimer;
}
@Override
protected boolean shouldNotFilterAsyncDispatch() {
return false;
}
@Override
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
throws ServletException, IOException {
TimingContext timingContext = TimingContext.get(request);
if (timingContext == null) {
timingContext = startAndAttachTimingContext(request);
}
try {
filterChain.doFilter(request, response);
if (!request.isAsyncStarted()) {
// Only record when async processing has finished or never been started.
// If async was started by something further down the chain we wait
// until the second filter invocation (but we'll be using the
// TimingContext that was attached to the first)
Throwable exception = fetchException(request);
record(timingContext, request, response, exception);
}
}
catch (Exception ex) {
response.setStatus(HttpStatus.INTERNAL_SERVER_ERROR.value());
record(timingContext, request, response, unwrapServletException(ex));
throw ex;
}
}
private Throwable unwrapServletException(Throwable ex) {
return (ex instanceof ServletException) ? ex.getCause() : ex;
}
private TimingContext startAndAttachTimingContext(HttpServletRequest request) {
Timer.Sample timerSample = Timer.start(this.registry);
TimingContext timingContext = new TimingContext(timerSample);
timingContext.attachTo(request);
return timingContext;
}
private Throwable fetchException(HttpServletRequest request) {
Throwable exception = (Throwable) request.getAttribute(ErrorAttributes.ERROR_ATTRIBUTE);
if (exception == null) {
exception = (Throwable) request.getAttribute(DispatcherServlet.EXCEPTION_ATTRIBUTE);
}
return exception;
}
private void record(TimingContext timingContext, HttpServletRequest request, HttpServletResponse response,
Throwable exception) {
try {
Object handler = getHandler(request);
Set<Timed> annotations = getTimedAnnotations(handler);
Timer.Sample timerSample = timingContext.getTimerSample();
AutoTimer.apply(this.autoTimer, this.metricName, annotations, (builder) -> timerSample
.stop(getTimer(builder, handler, request, response, exception).register(this.registry)));
}
catch (Exception ex) {
logger.warn("Failed to record timer metrics", ex);
// Allow request-response exchange to continue, unaffected by metrics problem
}
}
private Object getHandler(HttpServletRequest request) {
return request.getAttribute(HandlerMapping.BEST_MATCHING_HANDLER_ATTRIBUTE);
}
private Set<Timed> getTimedAnnotations(Object handler) {
if (handler instanceof HandlerMethod handlerMethod) {
return TimedAnnotations.get(handlerMethod.getMethod(), handlerMethod.getBeanType());
}
return Collections.emptySet();
}
private Timer.Builder getTimer(Builder builder, Object handler, HttpServletRequest request,
HttpServletResponse response, Throwable exception) {
return builder.description("Duration of HTTP server request handling")
.tags(this.tagsProvider.getTags(request, response, handler, exception));
}
/**
* Context object attached to a request to retain information across the multiple
* filter calls that happen with async requests.
*/
private static class TimingContext {
private static final String ATTRIBUTE = TimingContext.class.getName();
private final Timer.Sample timerSample;
TimingContext(Sample timerSample) {
this.timerSample = timerSample;
}
Timer.Sample getTimerSample() {
return this.timerSample;
}
void attachTo(HttpServletRequest request) {
request.setAttribute(ATTRIBUTE, this);
}
static TimingContext get(HttpServletRequest request) {
return (TimingContext) request.getAttribute(ATTRIBUTE);
}
}
}

3
spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/web/servlet/WebMvcTags.java
View File

@@ -37,7 +37,10 @@ import org.springframework.web.util.pattern.PathPattern;
* @author Brian Clozel
* @author Michael McFadyen
* @since 2.0.0
* @deprecated since 3.0.0 for removal in 3.2.0 in favor of
* {@link org.springframework.http.observation.ServerRequestObservationConvention}
*/
@Deprecated(since = "3.0.0", forRemoval = true)
public final class WebMvcTags {
private static final String DATA_REST_PATH_PATTERN_ATTRIBUTE = "org.springframework.data.rest.webmvc.RepositoryRestHandlerMapping.EFFECTIVE_REPOSITORY_RESOURCE_LOOKUP_PATH";

3
spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/web/servlet/WebMvcTagsContributor.java
View File

@@ -27,7 +27,10 @@ import jakarta.servlet.http.HttpServletResponse;
*
* @author Andy Wilkinson
* @since 2.3.0
* @deprecated since 3.0.0 for removal in 3.2.0 in favor of
* {@link org.springframework.http.observation.ServerRequestObservationConvention}
*/
@Deprecated(since = "3.0.0", forRemoval = true)
public interface WebMvcTagsContributor {
/**

3
spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/web/servlet/WebMvcTagsProvider.java
View File

@@ -27,7 +27,10 @@ import jakarta.servlet.http.HttpServletResponse;
* @author Jon Schneider
* @author Andy Wilkinson
* @since 2.0.0
* @deprecated since 3.0.0 for removal in 3.2.0 in favor of
* {@link org.springframework.http.observation.ServerRequestObservationConvention}
*/
@Deprecated(since = "3.0.0", forRemoval = true)
public interface WebMvcTagsProvider {
/**

1
spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/endpoint/web/servlet/DefaultWebMvcTagsProviderTests.java
View File

@@ -40,6 +40,7 @@ import static org.assertj.core.api.Assertions.assertThat;
*
* @author Andy Wilkinson
*/
@SuppressWarnings("removal")
class DefaultWebMvcTagsProviderTests {
@Test

1
spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/endpoint/web/servlet/WebMvcTagsTests.java
View File

@@ -34,6 +34,7 @@ import static org.assertj.core.api.Assertions.assertThat;
* @author Brian Clozel
* @author Michael McFadyen
*/
@SuppressWarnings("removal")
class WebMvcTagsTests {
private final MockHttpServletRequest request = new MockHttpServletRequest();

60
spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/web/servlet/FaultyWebMvcTagsProvider.java
View File

@@ -1,60 +0,0 @@
/*
* Copyright 2012-2022 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.actuate.metrics.web.servlet;
import java.util.concurrent.atomic.AtomicBoolean;
import io.micrometer.core.instrument.Tag;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
/**
* {@link WebMvcTagsProvider} used for testing that can be configured to fail when getting
* tags or long task tags.
*
* @author Andy Wilkinson
*/
class FaultyWebMvcTagsProvider extends DefaultWebMvcTagsProvider {
private final AtomicBoolean fail = new AtomicBoolean();
FaultyWebMvcTagsProvider() {
super(true);
}
@Override
public Iterable<Tag> getTags(HttpServletRequest request, HttpServletResponse response, Object handler,
Throwable exception) {
if (this.fail.compareAndSet(true, false)) {
throw new RuntimeException();
}
return super.getTags(request, response, handler, exception);
}
@Override
public Iterable<Tag> getLongRequestTags(HttpServletRequest request, Object handler) {
if (this.fail.compareAndSet(true, false)) {
throw new RuntimeException();
}
return super.getLongRequestTags(request, handler);
}
void failOnce() {
this.fail.set(true);
}
}

216
spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/web/servlet/LongTaskTimingHandlerInterceptorTests.java
View File

@@ -1,216 +0,0 @@
/*
* Copyright 2012-2022 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.actuate.metrics.web.servlet;
import java.util.concurrent.Callable;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CyclicBarrier;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicReference;
import io.micrometer.core.annotation.Timed;
import io.micrometer.core.instrument.Clock;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.MockClock;
import io.micrometer.core.instrument.simple.SimpleConfig;
import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
import jakarta.servlet.ServletException;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import org.springframework.test.context.junit.jupiter.SpringExtension;
import org.springframework.test.context.web.WebAppConfiguration;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.MvcResult;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
import static org.assertj.core.api.Assertions.fail;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.asyncDispatch;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.request;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
/**
* Tests for {@link LongTaskTimingHandlerInterceptor}.
*
* @author Andy Wilkinson
*/
@ExtendWith(SpringExtension.class)
@WebAppConfiguration
class LongTaskTimingHandlerInterceptorTests {
@Autowired
private SimpleMeterRegistry registry;
@Autowired
private WebApplicationContext context;
@Autowired
private CyclicBarrier callableBarrier;
@Autowired
private FaultyWebMvcTagsProvider tagsProvider;
private MockMvc mvc;
@BeforeEach
void setUpMockMvc() {
this.mvc = MockMvcBuilders.webAppContextSetup(this.context).build();
}
@Test
void asyncRequestThatThrowsUncheckedException() throws Exception {
MvcResult result = this.mvc.perform(get("/api/c1/completableFutureException"))
.andExpect(request().asyncStarted()).andReturn();
assertThat(this.registry.get("my.long.request.exception").longTaskTimer().activeTasks()).isEqualTo(1);
assertThatExceptionOfType(ServletException.class).isThrownBy(() -> this.mvc.perform(asyncDispatch(result)))
.withRootCauseInstanceOf(RuntimeException.class);
assertThat(this.registry.get("my.long.request.exception").longTaskTimer().activeTasks()).isEqualTo(0);
}
@Test
void asyncCallableRequest() throws Exception {
AtomicReference<MvcResult> result = new AtomicReference<>();
Thread backgroundRequest = new Thread(() -> {
try {
result.set(
this.mvc.perform(get("/api/c1/callable/10")).andExpect(request().asyncStarted()).andReturn());
}
catch (Exception ex) {
fail("Failed to execute async request", ex);
}
});
backgroundRequest.start();
this.callableBarrier.await();
assertThat(this.registry.get("my.long.request").tags("region", "test").longTaskTimer().activeTasks())
.isEqualTo(1);
this.callableBarrier.await();
backgroundRequest.join();
this.mvc.perform(asyncDispatch(result.get())).andExpect(status().isOk());
assertThat(this.registry.get("my.long.request").tags("region", "test").longTaskTimer().activeTasks())
.isEqualTo(0);
}
@Test
void whenMetricsRecordingFailsResponseIsUnaffected() throws Exception {
this.tagsProvider.failOnce();
AtomicReference<MvcResult> result = new AtomicReference<>();
Thread backgroundRequest = new Thread(() -> {
try {
result.set(
this.mvc.perform(get("/api/c1/callable/10")).andExpect(request().asyncStarted()).andReturn());
}
catch (Exception ex) {
fail("Failed to execute async request", ex);
}
});
backgroundRequest.start();
this.callableBarrier.await(10, TimeUnit.SECONDS);
this.callableBarrier.await(10, TimeUnit.SECONDS);
backgroundRequest.join();
this.mvc.perform(asyncDispatch(result.get())).andExpect(status().isOk());
}
@Configuration(proxyBeanMethods = false)
@EnableWebMvc
@Import(Controller1.class)
static class MetricsInterceptorConfiguration {
@Bean
Clock micrometerClock() {
return new MockClock();
}
@Bean
SimpleMeterRegistry simple(Clock clock) {
return new SimpleMeterRegistry(SimpleConfig.DEFAULT, clock);
}
@Bean
CyclicBarrier callableBarrier() {
return new CyclicBarrier(2);
}
@Bean
FaultyWebMvcTagsProvider webMvcTagsProvider() {
return new FaultyWebMvcTagsProvider();
}
@Bean
WebMvcConfigurer handlerInterceptorConfigurer(MeterRegistry meterRegistry, WebMvcTagsProvider tagsProvider) {
return new WebMvcConfigurer() {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new LongTaskTimingHandlerInterceptor(meterRegistry, tagsProvider));
}
};
}
}
@RestController
@RequestMapping("/api/c1")
static class Controller1 {
@Autowired
private CyclicBarrier callableBarrier;
@Timed
@Timed(value = "my.long.request", extraTags = { "region", "test" }, longTask = true)
@GetMapping("/callable/{id}")
Callable<String> asyncCallable(@PathVariable Long id) throws Exception {
this.callableBarrier.await();
return () -> {
try {
this.callableBarrier.await();
}
catch (InterruptedException ex) {
throw new RuntimeException(ex);
}
return id.toString();
};
}
@Timed
@Timed(value = "my.long.request.exception", longTask = true)
@GetMapping("/completableFutureException")
CompletableFuture<String> asyncCompletableFutureException() {
return CompletableFuture.supplyAsync(() -> {
throw new RuntimeException("boom");
});
}
}
}

120
spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/web/servlet/WebMvcMetricsFilterAutoTimedTests.java
View File

@@ -1,120 +0,0 @@
/*
* Copyright 2012-2019 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.actuate.metrics.web.servlet;
import io.micrometer.core.instrument.Clock;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.MockClock;
import io.micrometer.core.instrument.Timer;
import io.micrometer.core.instrument.distribution.HistogramSnapshot;
import io.micrometer.core.instrument.simple.SimpleConfig;
import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import org.springframework.test.context.junit.jupiter.SpringExtension;
import org.springframework.test.context.web.WebAppConfiguration;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import static org.assertj.core.api.Assertions.assertThat;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
/**
* Test for {@link WebMvcMetricsFilter} with auto-timed enabled.
*
* @author Jon Schneider
* @author Tadaya Tsuyukubo
*/
@ExtendWith(SpringExtension.class)
@WebAppConfiguration
class WebMvcMetricsFilterAutoTimedTests {
@Autowired
private MeterRegistry registry;
@Autowired
private WebApplicationContext context;
private MockMvc mvc;
@Autowired
private WebMvcMetricsFilter filter;
@BeforeEach
void setupMockMvc() {
this.mvc = MockMvcBuilders.webAppContextSetup(this.context).addFilters(this.filter).build();
}
@Test
void metricsCanBeAutoTimed() throws Exception {
this.mvc.perform(get("/api/10")).andExpect(status().isOk());
Timer timer = this.registry.get("http.server.requests").tags("status", "200").timer();
assertThat(timer.count()).isEqualTo(1L);
HistogramSnapshot snapshot = timer.takeSnapshot();
assertThat(snapshot.percentileValues()).hasSize(2);
assertThat(snapshot.percentileValues()[0].percentile()).isEqualTo(0.5);
assertThat(snapshot.percentileValues()[1].percentile()).isEqualTo(0.95);
}
@Configuration(proxyBeanMethods = false)
@EnableWebMvc
@Import({ Controller.class })
static class TestConfiguration {
@Bean
MockClock clock() {
return new MockClock();
}
@Bean
MeterRegistry meterRegistry(Clock clock) {
return new SimpleMeterRegistry(SimpleConfig.DEFAULT, clock);
}
@Bean
WebMvcMetricsFilter webMetricsFilter(WebApplicationContext context, MeterRegistry registry) {
return new WebMvcMetricsFilter(registry, new DefaultWebMvcTagsProvider(), "http.server.requests",
(builder) -> builder.publishPercentiles(0.5, 0.95).publishPercentileHistogram(true));
}
}
@RestController
@RequestMapping("/api")
static class Controller {
@GetMapping("/{id}")
String successful(@PathVariable Long id) {
return id.toString();
}
}
}

573
spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/web/servlet/WebMvcMetricsFilterTests.java
View File

@@ -1,573 +0,0 @@
/*
* Copyright 2012-2022 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.actuate.metrics.web.servlet;
import java.io.IOException;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.time.Duration;
import java.util.Collection;
import java.util.concurrent.BrokenBarrierException;
import java.util.concurrent.Callable;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CyclicBarrier;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicReference;
import io.micrometer.core.annotation.Timed;
import io.micrometer.core.instrument.Clock;
import io.micrometer.core.instrument.Meter;
import io.micrometer.core.instrument.Meter.Id;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.MockClock;
import io.micrometer.core.instrument.Tag;
import io.micrometer.core.instrument.composite.CompositeMeterRegistry;
import io.micrometer.core.instrument.config.MeterFilter;
import io.micrometer.core.instrument.config.MeterFilterReply;
import io.micrometer.core.instrument.simple.SimpleConfig;
import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
import io.micrometer.prometheus.PrometheusConfig;
import io.micrometer.prometheus.PrometheusMeterRegistry;
import io.prometheus.client.CollectorRegistry;
import jakarta.servlet.FilterChain;
import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.boot.actuate.metrics.AutoTimer;
import org.springframework.boot.web.servlet.error.ErrorAttributes;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import org.springframework.context.annotation.Primary;
import org.springframework.http.HttpStatus;
import org.springframework.test.context.junit.jupiter.SpringExtension;
import org.springframework.test.context.web.WebAppConfiguration;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.MvcResult;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.filter.OncePerRequestFilter;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.PathMatchConfigurer;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyEmitter;
import org.springframework.web.util.pattern.PathPatternParser;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatCode;
import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
import static org.assertj.core.api.Assertions.assertThatIOException;
import static org.assertj.core.api.Assertions.fail;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.asyncDispatch;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.request;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
/**
* Tests for {@link WebMvcMetricsFilter}.
*
* @author Jon Schneider
*/
@ExtendWith(SpringExtension.class)
@WebAppConfiguration
class WebMvcMetricsFilterTests {
@Autowired
private SimpleMeterRegistry registry;
@Autowired
private PrometheusMeterRegistry prometheusRegistry;
@Autowired
private WebApplicationContext context;
@Autowired
private WebMvcMetricsFilter filter;
private MockMvc mvc;
@Autowired
@Qualifier("callableBarrier")
private CyclicBarrier callableBarrier;
@Autowired
@Qualifier("completableFutureBarrier")
private CyclicBarrier completableFutureBarrier;
@Autowired
private FaultyWebMvcTagsProvider tagsProvider;
@BeforeEach
void setupMockMvc() {
this.mvc = MockMvcBuilders.webAppContextSetup(this.context).addFilters(this.filter, new CustomBehaviorFilter())
.build();
}
@Test
void timedMethod() throws Exception {
this.mvc.perform(get("/api/c1/10")).andExpect(status().isOk());
assertThat(this.registry.get("http.server.requests")
.tags("status", "200", "uri", "/api/c1/{id}", "public", "true").timer().count()).isEqualTo(1);
}
@Test
void subclassedTimedMethod() throws Exception {
this.mvc.perform(get("/api/c1/metaTimed/10")).andExpect(status().isOk());
assertThat(this.registry.get("http.server.requests").tags("status", "200", "uri", "/api/c1/metaTimed/{id}")
.timer().count()).isEqualTo(1L);
}
@Test
void untimedMethod() throws Exception {
this.mvc.perform(get("/api/c1/untimed/10")).andExpect(status().isOk());
assertThat(this.registry.find("http.server.requests").tags("uri", "/api/c1/untimed/10").timer()).isNull();
}
@Test
void timedControllerClass() throws Exception {
this.mvc.perform(get("/api/c2/10")).andExpect(status().isOk());
assertThat(this.registry.get("http.server.requests").tags("status", "200").timer().count()).isEqualTo(1L);
}
@Test
void badClientRequest() throws Exception {
this.mvc.perform(get("/api/c1/oops")).andExpect(status().is4xxClientError());
assertThat(this.registry.get("http.server.requests").tags("status", "400").timer().count()).isEqualTo(1L);
}
@Test
void redirectRequest() throws Exception {
this.mvc.perform(get("/api/redirect").header(CustomBehaviorFilter.TEST_STATUS_HEADER, "302"))
.andExpect(status().is3xxRedirection());
assertThat(this.registry.get("http.server.requests").tags("uri", "REDIRECTION").tags("status", "302").timer())
.isNotNull();
}
@Test
void notFoundRequest() throws Exception {
this.mvc.perform(get("/api/not/found").header(CustomBehaviorFilter.TEST_STATUS_HEADER, "404"))
.andExpect(status().is4xxClientError());
assertThat(this.registry.get("http.server.requests").tags("uri", "NOT_FOUND").tags("status", "404").timer())
.isNotNull();
}
@Test
void unhandledError() {
assertThatCode(() -> this.mvc.perform(get("/api/c1/unhandledError/10")))
.hasRootCauseInstanceOf(RuntimeException.class);
assertThat(this.registry.get("http.server.requests").tags("exception", "RuntimeException").timer().count())
.isEqualTo(1L);
}
@Test
void unhandledServletException() {
assertThatCode(() -> this.mvc
.perform(get("/api/filterError").header(CustomBehaviorFilter.TEST_SERVLET_EXCEPTION_HEADER, "throw")))
.isInstanceOf(ServletException.class);
Id meterId = this.registry.get("http.server.requests").tags("exception", "IllegalStateException").timer()
.getId();
assertThat(meterId.getTag("status")).isEqualTo("500");
}
@Test
void streamingError() throws Exception {
MvcResult result = this.mvc.perform(get("/api/c1/streamingError")).andExpect(request().asyncStarted())
.andReturn();
assertThatIOException().isThrownBy(() -> this.mvc.perform(asyncDispatch(result)).andReturn());
Id meterId = this.registry.get("http.server.requests").tags("exception", "IOException").timer().getId();
// Response is committed before error occurs so status is 200 (OK)
assertThat(meterId.getTag("status")).isEqualTo("200");
}
@Test
void whenMetricsRecordingFailsResponseIsUnaffected() throws Exception {
this.tagsProvider.failOnce();
this.mvc.perform(get("/api/c1/10")).andExpect(status().isOk());
}
@Test
void anonymousError() {
try {
this.mvc.perform(get("/api/c1/anonymousError/10"));
}
catch (Throwable ignore) {
}
Id meterId = this.registry.get("http.server.requests").tag("uri", "/api/c1/anonymousError/{id}").timer()
.getId();
assertThat(meterId.getTag("exception")).endsWith("$1");
assertThat(meterId.getTag("status")).isEqualTo("500");
}
@Test
void asyncCallableRequest() throws Exception {
AtomicReference<MvcResult> result = new AtomicReference<>();
Thread backgroundRequest = new Thread(() -> {
try {
result.set(
this.mvc.perform(get("/api/c1/callable/10")).andExpect(request().asyncStarted()).andReturn());
}
catch (Exception ex) {
fail("Failed to execute async request", ex);
}
});
backgroundRequest.start();
assertThat(this.registry.find("http.server.requests").tags("uri", "/api/c1/async").timer())
.describedAs("Request isn't prematurely recorded as complete").isNull();
// once the mapping completes, we can gather information about status, etc.
this.callableBarrier.await();
MockClock.clock(this.registry).add(Duration.ofSeconds(2));
this.callableBarrier.await();
backgroundRequest.join();
this.mvc.perform(asyncDispatch(result.get())).andExpect(status().isOk());
assertThat(this.registry.get("http.server.requests").tags("status", "200").tags("uri", "/api/c1/callable/{id}")
.timer().totalTime(TimeUnit.SECONDS)).isEqualTo(2L);
}
@Test
void asyncRequestThatThrowsUncheckedException() throws Exception {
MvcResult result = this.mvc.perform(get("/api/c1/completableFutureException"))
.andExpect(request().asyncStarted()).andReturn();
assertThatExceptionOfType(ServletException.class).isThrownBy(() -> this.mvc.perform(asyncDispatch(result)))
.withRootCauseInstanceOf(RuntimeException.class);
assertThat(this.registry.get("http.server.requests").tags("uri", "/api/c1/completableFutureException").timer()
.count()).isEqualTo(1);
}
@Test
void asyncCompletableFutureRequest() throws Exception {
AtomicReference<MvcResult> result = new AtomicReference<>();
Thread backgroundRequest = new Thread(() -> {
try {
result.set(this.mvc.perform(get("/api/c1/completableFuture/{id}", 1))
.andExpect(request().asyncStarted()).andReturn());
}
catch (Exception ex) {
fail("Failed to execute async request", ex);
}
});
backgroundRequest.start();
this.completableFutureBarrier.await();
MockClock.clock(this.registry).add(Duration.ofSeconds(2));
this.completableFutureBarrier.await();
backgroundRequest.join();
this.mvc.perform(asyncDispatch(result.get())).andExpect(status().isOk());
assertThat(this.registry.get("http.server.requests").tags("uri", "/api/c1/completableFuture/{id}").timer()
.totalTime(TimeUnit.SECONDS)).isEqualTo(2);
}
@Test
void endpointThrowsError() throws Exception {
this.mvc.perform(get("/api/c1/error/10")).andExpect(status().is4xxClientError());
assertThat(this.registry.get("http.server.requests").tags("status", "422", "exception", "IllegalStateException")
.timer().count()).isEqualTo(1L);
}
@Test
void regexBasedRequestMapping() throws Exception {
this.mvc.perform(get("/api/c1/regex/.abc")).andExpect(status().isOk());
assertThat(
this.registry.get("http.server.requests").tags("uri", "/api/c1/regex/{id:\\.[a-z]+}").timer().count())
.isEqualTo(1L);
}
@Test
void recordQuantiles() throws Exception {
this.mvc.perform(get("/api/c1/percentiles/10")).andExpect(status().isOk());
assertThat(this.prometheusRegistry.scrape()).contains("quantile=\"0.5\"");
assertThat(this.prometheusRegistry.scrape()).contains("quantile=\"0.95\"");
}
@Test
void recordHistogram() throws Exception {
this.mvc.perform(get("/api/c1/histogram/10")).andExpect(status().isOk());
assertThat(this.prometheusRegistry.scrape()).contains("le=\"0.001\"");
assertThat(this.prometheusRegistry.scrape()).contains("le=\"30.0\"");
}
@Test
void trailingSlashShouldNotRecordDuplicateMetrics() throws Exception {
this.mvc.perform(get("/api/c1/simple/10")).andExpect(status().isOk());
this.mvc.perform(get("/api/c1/simple/10/")).andExpect(status().isOk());
assertThat(this.registry.get("http.server.requests").tags("status", "200", "uri", "/api/c1/simple/{id}").timer()
.count()).isEqualTo(2);
}
@Target({ ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Timed(percentiles = 0.95)
@interface Timed95 {
}
@Configuration(proxyBeanMethods = false)
@EnableWebMvc
@Import({ Controller1.class, Controller2.class })
static class MetricsFilterApp implements WebMvcConfigurer {
@Bean
Clock micrometerClock() {
return new MockClock();
}
@Primary
@Bean
MeterRegistry meterRegistry(Collection<MeterRegistry> registries, Clock clock) {
CompositeMeterRegistry composite = new CompositeMeterRegistry(clock);
registries.forEach(composite::add);
return composite;
}
@Bean
SimpleMeterRegistry simple(Clock clock) {
return new SimpleMeterRegistry(SimpleConfig.DEFAULT, clock);
}
@Bean
PrometheusMeterRegistry prometheus(Clock clock) {
PrometheusMeterRegistry r = new PrometheusMeterRegistry(PrometheusConfig.DEFAULT, new CollectorRegistry(),
clock);
r.config().meterFilter(new MeterFilter() {
@Override
public MeterFilterReply accept(Meter.Id id) {
for (Tag tag : id.getTags()) {
if (tag.getKey().equals("uri")
&& (tag.getValue().contains("histogram") || tag.getValue().contains("percentiles"))) {
return MeterFilterReply.ACCEPT;
}
}
return MeterFilterReply.DENY;
}
});
return r;
}
@Bean
CustomBehaviorFilter customBehaviorFilter() {
return new CustomBehaviorFilter();
}
@Bean(name = "callableBarrier")
CyclicBarrier callableBarrier() {
return new CyclicBarrier(2);
}
@Bean(name = "completableFutureBarrier")
CyclicBarrier completableFutureBarrier() {
return new CyclicBarrier(2);
}
@Bean
WebMvcMetricsFilter webMetricsFilter(MeterRegistry registry, FaultyWebMvcTagsProvider tagsProvider,
WebApplicationContext ctx) {
return new WebMvcMetricsFilter(registry, tagsProvider, "http.server.requests", AutoTimer.ENABLED);
}
@Bean
FaultyWebMvcTagsProvider faultyWebMvcTagsProvider() {
return new FaultyWebMvcTagsProvider();
}
@Override
@SuppressWarnings("deprecation")
public void configurePathMatch(PathMatchConfigurer configurer) {
PathPatternParser pathPatternParser = new PathPatternParser();
pathPatternParser.setMatchOptionalTrailingSeparator(true);
configurer.setPatternParser(pathPatternParser);
}
}
@RestController
@RequestMapping("/api/c1")
static class Controller1 {
@Autowired
@Qualifier("callableBarrier")
private CyclicBarrier callableBarrier;
@Autowired
@Qualifier("completableFutureBarrier")
private CyclicBarrier completableFutureBarrier;
@Timed(extraTags = { "public", "true" })
@GetMapping("/{id}")
String successfulWithExtraTags(@PathVariable Long id) {
return id.toString();
}
@GetMapping("/simple/{id}")
String simpleMapping(@PathVariable Long id) {
return id.toString();
}
@Timed
@Timed(value = "my.long.request", extraTags = { "region", "test" }, longTask = true)
@GetMapping("/callable/{id}")
Callable<String> asyncCallable(@PathVariable Long id) throws Exception {
this.callableBarrier.await();
return () -> {
try {
this.callableBarrier.await();
}
catch (InterruptedException ex) {
throw new RuntimeException(ex);
}
return id.toString();
};
}
@Timed
@GetMapping("/completableFuture/{id}")
CompletableFuture<String> asyncCompletableFuture(@PathVariable Long id) throws Exception {
this.completableFutureBarrier.await();
return CompletableFuture.supplyAsync(() -> {
try {
this.completableFutureBarrier.await();
}
catch (InterruptedException | BrokenBarrierException ex) {
throw new RuntimeException(ex);
}
return id.toString();
});
}
@Timed
@Timed(value = "my.long.request.exception", longTask = true)
@GetMapping("/completableFutureException")
CompletableFuture<String> asyncCompletableFutureException() {
return CompletableFuture.supplyAsync(() -> {
throw new RuntimeException("boom");
});
}
@GetMapping("/untimed/{id}")
String successfulButUntimed(@PathVariable Long id) {
return id.toString();
}
@Timed
@GetMapping("/error/{id}")
String alwaysThrowsException(@PathVariable Long id) {
throw new IllegalStateException("Boom on " + id + "!");
}
@Timed
@GetMapping("/anonymousError/{id}")
String alwaysThrowsAnonymousException(@PathVariable Long id) throws Exception {
throw new Exception("this exception won't have a simple class name") {
};
}
@Timed
@GetMapping("/unhandledError/{id}")
String alwaysThrowsUnhandledException(@PathVariable Long id) {
throw new RuntimeException("Boom on " + id + "!");
}
@GetMapping("/streamingError")
ResponseBodyEmitter streamingError() throws IOException {
ResponseBodyEmitter emitter = new ResponseBodyEmitter();
emitter.send("some data");
emitter.send("some more data");
emitter.completeWithError(new IOException("error while writing to the response"));
return emitter;
}
@Timed
@GetMapping("/regex/{id:\\.[a-z]+}")
String successfulRegex(@PathVariable String id) {
return id;
}
@Timed(percentiles = { 0.50, 0.95 })
@GetMapping("/percentiles/{id}")
String percentiles(@PathVariable String id) {
return id;
}
@Timed(histogram = true)
@GetMapping("/histogram/{id}")
String histogram(@PathVariable String id) {
return id;
}
@Timed95
@GetMapping("/metaTimed/{id}")
String meta(@PathVariable String id) {
return id;
}
@ExceptionHandler(IllegalStateException.class)
@ResponseStatus(HttpStatus.UNPROCESSABLE_ENTITY)
ModelAndView defaultErrorHandler(HttpServletRequest request, Exception e) {
// this is done by ErrorAttributes implementations
request.setAttribute(ErrorAttributes.ERROR_ATTRIBUTE, e);
return new ModelAndView("myerror");
}
}
@RestController
@Timed
@RequestMapping("/api/c2")
static class Controller2 {
@GetMapping("/{id}")
String successful(@PathVariable Long id) {
return id.toString();
}
}
static class CustomBehaviorFilter extends OncePerRequestFilter {
static final String TEST_STATUS_HEADER = "x-test-status";
static final String TEST_SERVLET_EXCEPTION_HEADER = "x-test-servlet-exception";
@Override
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response,
FilterChain filterChain) throws ServletException, IOException {
String misbehaveStatus = request.getHeader(TEST_STATUS_HEADER);
if (misbehaveStatus != null) {
response.setStatus(Integer.parseInt(misbehaveStatus));
return;
}
if (request.getHeader(TEST_SERVLET_EXCEPTION_HEADER) != null) {
throw new ServletException(new IllegalStateException());
}
filterChain.doFilter(request, response);
}
}
}

163
spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/web/servlet/WebMvcMetricsIntegrationTests.java
View File

@@ -1,163 +0,0 @@
/*
* Copyright 2012-2022 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.actuate.metrics.web.servlet;
import io.micrometer.core.annotation.Timed;
import io.micrometer.core.instrument.Clock;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.MockClock;
import io.micrometer.core.instrument.simple.SimpleConfig;
import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
import jakarta.servlet.ServletException;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.actuate.metrics.AutoTimer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.test.context.TestPropertySource;
import org.springframework.test.context.junit.jupiter.SpringExtension;
import org.springframework.test.context.web.WebAppConfiguration;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
/**
* Tests for {@link WebMvcMetricsFilter} in the presence of a custom exception handler.
*
* @author Jon Schneider
*/
@ExtendWith(SpringExtension.class)
@WebAppConfiguration
@TestPropertySource(properties = "security.ignored=/**")
class WebMvcMetricsIntegrationTests {
@Autowired
private WebApplicationContext context;
@Autowired
private SimpleMeterRegistry registry;
@Autowired
private WebMvcMetricsFilter filter;
private MockMvc mvc;
@BeforeEach
void setupMockMvc() {
this.mvc = MockMvcBuilders.webAppContextSetup(this.context).addFilters(this.filter).build();
}
@Test
void handledExceptionIsRecordedInMetricTag() throws Exception {
this.mvc.perform(get("/api/handledError")).andExpect(status().is5xxServerError());
assertThat(this.registry.get("http.server.requests").tags("exception", "Exception1", "status", "500").timer()
.count()).isEqualTo(1L);
}
@Test
void rethrownExceptionIsRecordedInMetricTag() {
assertThatExceptionOfType(ServletException.class)
.isThrownBy(() -> this.mvc.perform(get("/api/rethrownError")).andReturn());
assertThat(this.registry.get("http.server.requests").tags("exception", "Exception2", "status", "500").timer()
.count()).isEqualTo(1L);
}
@Configuration(proxyBeanMethods = false)
@EnableWebMvc
static class TestConfiguration {
@Bean
MockClock clock() {
return new MockClock();
}
@Bean
MeterRegistry meterRegistry(Clock clock) {
return new SimpleMeterRegistry(SimpleConfig.DEFAULT, clock);
}
@Bean
WebMvcMetricsFilter webMetricsFilter(MeterRegistry registry, WebApplicationContext ctx) {
return new WebMvcMetricsFilter(registry, new DefaultWebMvcTagsProvider(), "http.server.requests",
AutoTimer.ENABLED);
}
@Configuration(proxyBeanMethods = false)
@RestController
@RequestMapping("/api")
@Timed
static class Controller1 {
@Bean
CustomExceptionHandler controllerAdvice() {
return new CustomExceptionHandler();
}
@GetMapping("/handledError")
String handledError() {
throw new Exception1();
}
@GetMapping("/rethrownError")
String rethrownError() {
throw new Exception2();
}
}
}
static class Exception1 extends RuntimeException {
}
static class Exception2 extends RuntimeException {
}
@ControllerAdvice
static class CustomExceptionHandler {
@ExceptionHandler
ResponseEntity<String> handleError(Exception1 ex) {
return new ResponseEntity<>("this is a custom exception body", HttpStatus.INTERNAL_SERVER_ERROR);
}
@ExceptionHandler
ResponseEntity<String> rethrowError(Exception2 ex) {
throw ex;
}
}
}