org.springframework.boot.actuate.metrics.web.reactive.server

Class MetricsWebFilter

java.lang.Object

org.springframework.boot.actuate.metrics.web.reactive.server.MetricsWebFilter

All Implemented Interfaces:

org.springframework.web.server.WebFilter

@Order(value=-2147483647)
public class MetricsWebFilter
extends Object
implements org.springframework.web.server.WebFilter

Intercepts incoming HTTP requests handled by Spring WebFlux handlers.

Since:

2.0.0

Author:

Jon Schneider, Brian Clozel

Constructor Summary

Constructors

Constructor and Description
MetricsWebFilter(io.micrometer.core.instrument.MeterRegistry registry, WebFluxTagsProvider tagsProvider, String metricName, AutoTimer autoTimer) Create a new MetricsWebFilter.
MetricsWebFilter(io.micrometer.core.instrument.MeterRegistry registry, WebFluxTagsProvider tagsProvider, String metricName, boolean autoTimeRequests) Deprecated. since 2.2.0 in favor of MetricsWebFilter(MeterRegistry, WebFluxTagsProvider, String, AutoTimer)

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<Void>	filter(org.springframework.web.server.ServerWebExchange exchange, org.springframework.web.server.WebFilterChain chain)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetricsWebFilter

@Deprecated
public MetricsWebFilter(io.micrometer.core.instrument.MeterRegistry registry,
                                    WebFluxTagsProvider tagsProvider,
                                    String metricName,
                                    boolean autoTimeRequests)

Deprecated. since 2.2.0 in favor of MetricsWebFilter(MeterRegistry, WebFluxTagsProvider, String, AutoTimer)

Create a new MetricsWebFilter.

Parameters:

registry - the registry to which metrics are recorded

tagsProvider - provider for metrics tags

metricName - name of the metric to record

autoTimeRequests - if requests should be automatically timed

MetricsWebFilter

public MetricsWebFilter(io.micrometer.core.instrument.MeterRegistry registry,
                        WebFluxTagsProvider tagsProvider,
                        String metricName,
                        AutoTimer autoTimer)

Create a new MetricsWebFilter.

Parameters:

registry - the registry to which metrics are recorded

tagsProvider - provider for metrics tags

metricName - name of the metric to record

autoTimer - the auto-timers to apply or null to disable auto-timing

Since:

2.2.0

Method Detail

filter

public reactor.core.publisher.Mono<Void> filter(org.springframework.web.server.ServerWebExchange exchange,
                                                org.springframework.web.server.WebFilterChain chain)

Specified by:

filter in interface org.springframework.web.server.WebFilter