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

Class MetricsWebClientCustomizer

java.lang.Object

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

All Implemented Interfaces:

WebClientCustomizer

public class MetricsWebClientCustomizer
extends Object
implements WebClientCustomizer

WebClientCustomizer that configures the WebClient to record request metrics.

Since:

2.1.0

Author:

Brian Clozel

Constructor Summary

Constructors

Constructor and Description
MetricsWebClientCustomizer(io.micrometer.core.instrument.MeterRegistry meterRegistry, WebClientExchangeTagsProvider tagProvider, String metricName) Deprecated. since 2.2.0 in favor of MetricsWebClientCustomizer(MeterRegistry, WebClientExchangeTagsProvider, String, AutoTimer)
MetricsWebClientCustomizer(io.micrometer.core.instrument.MeterRegistry meterRegistry, WebClientExchangeTagsProvider tagProvider, String metricName, AutoTimer autoTimer) Create a new MetricsWebClientFilterFunction that will record metrics using the given meterRegistry with tags provided by the given tagProvider.

Method Summary

Modifier and Type	Method and Description
void	customize(org.springframework.web.reactive.function.client.WebClient.Builder webClientBuilder)

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricsWebClientCustomizer

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

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

Create a new MetricsWebClientFilterFunction that will record metrics using the given meterRegistry with tags provided by the given tagProvider.

Parameters:

meterRegistry - the meter registry

tagProvider - the tag provider

metricName - the name of the recorded metric

MetricsWebClientCustomizer

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

Create a new MetricsWebClientFilterFunction that will record metrics using the given meterRegistry with tags provided by the given tagProvider.

Parameters:

meterRegistry - the meter registry

tagProvider - the tag provider

metricName - the name of the recorded metric

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

Since:

2.2.0

Method Detail

customize

public void customize(org.springframework.web.reactive.function.client.WebClient.Builder webClientBuilder)

Specified by:

customize in interface WebClientCustomizer