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

Class MetricsRestTemplateCustomizer

java.lang.Object

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

All Implemented Interfaces:

RestTemplateCustomizer

public class MetricsRestTemplateCustomizer
extends Object
implements RestTemplateCustomizer

RestTemplateCustomizer that configures the RestTemplate to record request metrics.

Since:

2.0.0

Author:

Andy Wilkinson, Phillip Webb

Constructor Summary

Constructors

Constructor and Description
MetricsRestTemplateCustomizer(io.micrometer.core.instrument.MeterRegistry meterRegistry, RestTemplateExchangeTagsProvider tagProvider, String metricName) Deprecated. since 2.2.0 in favor of MetricsRestTemplateCustomizer(MeterRegistry, RestTemplateExchangeTagsProvider, String, AutoTimer)
MetricsRestTemplateCustomizer(io.micrometer.core.instrument.MeterRegistry meterRegistry, RestTemplateExchangeTagsProvider tagProvider, String metricName, AutoTimer autoTimer) Creates a new MetricsRestTemplateInterceptor.

Method Summary

Modifier and Type	Method and Description
void	customize(RestTemplate restTemplate) Callback to customize a RestTemplate instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricsRestTemplateCustomizer

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

Deprecated. since 2.2.0 in favor of MetricsRestTemplateCustomizer(MeterRegistry, RestTemplateExchangeTagsProvider, String, AutoTimer)

Creates a new MetricsRestTemplateInterceptor 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

MetricsRestTemplateCustomizer

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

Creates a new MetricsRestTemplateInterceptor. When autoTimeRequests is set to true, the interceptor records metrics using the given meterRegistry with tags provided by the given tagProvider and with auto-timed configuration.

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(RestTemplate restTemplate)

Description copied from interface: RestTemplateCustomizer

Callback to customize a RestTemplate instance.

Specified by:

customize in interface RestTemplateCustomizer

Parameters:

restTemplate - the template to customize