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

Class MetricsWebClientFilterFunction

java.lang.Object

org.springframework.boot.actuate.metrics.web.reactive.client.MetricsWebClientFilterFunction

All Implemented Interfaces:

org.springframework.web.reactive.function.client.ExchangeFilterFunction

public class MetricsWebClientFilterFunction
extends Object
implements org.springframework.web.reactive.function.client.ExchangeFilterFunction

ExchangeFilterFunction applied via a MetricsWebClientCustomizer to record metrics.

Since:

2.1.0

Author:

Brian Clozel, Tadaya Tsuyukubo

Constructor Summary

Constructors

Constructor and Description
MetricsWebClientFilterFunction(io.micrometer.core.instrument.MeterRegistry meterRegistry, WebClientExchangeTagsProvider tagProvider, String metricName) Deprecated. since 2.2.0 in favor of MetricsWebClientFilterFunction(MeterRegistry, WebClientExchangeTagsProvider, String, AutoTimer)
MetricsWebClientFilterFunction(io.micrometer.core.instrument.MeterRegistry meterRegistry, WebClientExchangeTagsProvider tagProvider, String metricName, AutoTimer autoTimer) Create a new MetricsWebClientFilterFunction.

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<org.springframework.web.reactive.function.client.ClientResponse>	filter(org.springframework.web.reactive.function.client.ClientRequest request, org.springframework.web.reactive.function.client.ExchangeFunction next)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.web.reactive.function.client.ExchangeFilterFunction

andThen, apply, ofRequestProcessor, ofResponseProcessor

Constructor Detail

MetricsWebClientFilterFunction

@Deprecated
public MetricsWebClientFilterFunction(io.micrometer.core.instrument.MeterRegistry meterRegistry,
                                                  WebClientExchangeTagsProvider tagProvider,
                                                  String metricName)

Deprecated. since 2.2.0 in favor of MetricsWebClientFilterFunction(MeterRegistry, WebClientExchangeTagsProvider, String, AutoTimer)

Create a new MetricsWebClientFilterFunction.

Parameters:

meterRegistry - the registry to which metrics are recorded

tagProvider - provider for metrics tags

metricName - name of the metric to record

MetricsWebClientFilterFunction

public MetricsWebClientFilterFunction(io.micrometer.core.instrument.MeterRegistry meterRegistry,
                                      WebClientExchangeTagsProvider tagProvider,
                                      String metricName,
                                      AutoTimer autoTimer)

Create a new MetricsWebClientFilterFunction.

Parameters:

meterRegistry - the registry to which metrics are recorded

tagProvider - provider for metrics tags

metricName - name of the metric to record

autoTimer - the auto-timer configuration or null to disable

Since:

2.2.0

Method Detail

filter

public reactor.core.publisher.Mono<org.springframework.web.reactive.function.client.ClientResponse> filter(org.springframework.web.reactive.function.client.ClientRequest request,
                                                                                                           org.springframework.web.reactive.function.client.ExchangeFunction next)

Specified by:

filter in interface org.springframework.web.reactive.function.client.ExchangeFilterFunction