Support @Timed annotation for WebFlux

Update `MetricsWebFilter` to support `@Timed` annotations on the WebFlux
handler methods or beans.

See gh-23112
This commit is contained in:
anshlykov
2020-08-26 14:42:17 +03:00
committed by Phillip Webb
parent 816bd1462a
commit 4ff4a9b082
2 changed files with 185 additions and 5 deletions

View File

@@ -16,18 +16,27 @@
package org.springframework.boot.actuate.metrics.web.reactive.server;
import java.lang.reflect.AnnotatedElement;
import java.util.Collections;
import java.util.Set;
import java.util.concurrent.TimeUnit;
import io.micrometer.core.annotation.Timed;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Tag;
import io.micrometer.core.instrument.Timer;
import org.reactivestreams.Publisher;
import reactor.core.publisher.Mono;
import org.springframework.boot.actuate.metrics.AutoTimer;
import org.springframework.boot.web.reactive.error.ErrorAttributes;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.MergedAnnotationCollectors;
import org.springframework.core.annotation.MergedAnnotations;
import org.springframework.core.annotation.Order;
import org.springframework.http.server.reactive.ServerHttpResponse;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.reactive.HandlerMapping;
import org.springframework.web.server.ServerWebExchange;
import org.springframework.web.server.WebFilter;
import org.springframework.web.server.WebFilterChain;
@@ -68,9 +77,6 @@ public class MetricsWebFilter implements WebFilter {
@Override
public Mono<Void> filter(ServerWebExchange exchange, WebFilterChain chain) {
if (!this.autoTimer.isEnabled()) {
return chain.filter(exchange);
}
return chain.filter(exchange).transformDeferred((call) -> filter(exchange, call));
}
@@ -97,9 +103,45 @@ public class MetricsWebFilter implements WebFilter {
if (cause == null) {
cause = exchange.getAttribute(ErrorAttributes.ERROR_ATTRIBUTE);
}
Object handler = exchange.getAttribute(HandlerMapping.BEST_MATCHING_HANDLER_ATTRIBUTE);
Set<Timed> annotations = getTimedAnnotations(handler);
Iterable<Tag> tags = this.tagsProvider.httpRequestTags(exchange, cause);
this.autoTimer.builder(this.metricName).tags(tags).register(this.registry).record(System.nanoTime() - start,
TimeUnit.NANOSECONDS);
long duration = System.nanoTime() - start;
if (annotations.isEmpty()) {
if (this.autoTimer.isEnabled()) {
this.autoTimer.builder(this.metricName).tags(tags).register(this.registry).record(duration,
TimeUnit.NANOSECONDS);
}
}
else {
for (Timed annotation : annotations) {
Timer.builder(annotation, this.metricName).tags(tags).register(this.registry).record(duration,
TimeUnit.NANOSECONDS);
}
}
}
private Set<Timed> getTimedAnnotations(Object handler) {
if (!(handler instanceof HandlerMethod)) {
return Collections.emptySet();
}
return getTimedAnnotations((HandlerMethod) handler);
}
private Set<Timed> getTimedAnnotations(HandlerMethod handler) {
Set<Timed> methodAnnotations = findTimedAnnotations(handler.getMethod());
if (!methodAnnotations.isEmpty()) {
return methodAnnotations;
}
return findTimedAnnotations(handler.getBeanType());
}
private Set<Timed> findTimedAnnotations(AnnotatedElement element) {
MergedAnnotations annotations = MergedAnnotations.from(element);
if (!annotations.isPresent(Timed.class)) {
return Collections.emptySet();
}
return annotations.stream(Timed.class).collect(MergedAnnotationCollectors.toAnnotationSet());
}
}