Package io.micrometer.core.instrument.binder.httpcomponents.hc5

Class MicrometerHttpRequestExecutor.Builder

java.lang.Object

io.micrometer.core.instrument.binder.httpcomponents.hc5.MicrometerHttpRequestExecutor.Builder

Enclosing class:

MicrometerHttpRequestExecutor

public static class MicrometerHttpRequestExecutor.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
MicrometerHttpRequestExecutor	build()
MicrometerHttpRequestExecutor.Builder	exportTagsForRoute(boolean exportTagsForRoute)	Allows to expose the target scheme, host and port with every metric.
MicrometerHttpRequestExecutor.Builder	observationConvention(ApacheHttpClientObservationConvention convention)	Provide a custom convention to override the default convention used when instrumenting with the Observation API.
MicrometerHttpRequestExecutor.Builder	observationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)	Configure an observation registry to instrument using the Observation API instead of directly with a Timer.
MicrometerHttpRequestExecutor.Builder	tags(Iterable<Tag> tags)	These tags will not be applied when instrumentation is performed with the Observation API.
MicrometerHttpRequestExecutor.Builder	uriMapper(Function<org.apache.hc.core5.http.HttpRequest,String> uriMapper)	Allows to register a mapping function for exposing request URIs.
MicrometerHttpRequestExecutor.Builder	waitForContinue(org.apache.hc.core5.util.Timeout waitForContinue)

Methods inherited from class java.lang.Object

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

Method Details

waitForContinue

public MicrometerHttpRequestExecutor.Builder waitForContinue(org.apache.hc.core5.util.Timeout waitForContinue)

Parameters:

waitForContinue - Overrides the wait for continue time for this request executor. See HttpRequestExecutor for details.

Returns:

This builder instance.

tags

public MicrometerHttpRequestExecutor.Builder tags(Iterable<Tag> tags)

These tags will not be applied when instrumentation is performed with the Observation API. Configure an ApacheHttpClientObservationConvention instead with the extra key values.

Parameters:

tags - Additional tags which should be exposed with every value.

Returns:

This builder instance.

See Also:

• observationConvention(ApacheHttpClientObservationConvention)
• observationRegistry(ObservationRegistry)
• DefaultApacheHttpClientObservationConvention

uriMapper

public MicrometerHttpRequestExecutor.Builder uriMapper(Function<org.apache.hc.core5.http.HttpRequest,String> uriMapper)

Allows to register a mapping function for exposing request URIs. Be careful, exposing request URIs could result in a huge number of tag values, which could cause problems in your meter registry. By default, this feature is almost disabled. It only exposes values of the "URI_PATTERN" HTTP header.

Parameters:

uriMapper - A mapper that allows mapping and exposing request paths.

Returns:

This builder instance.

See Also:

• DefaultUriMapper

exportTagsForRoute

public MicrometerHttpRequestExecutor.Builder exportTagsForRoute(boolean exportTagsForRoute)

Allows to expose the target scheme, host and port with every metric. Be careful with enabling this feature: If your client accesses a huge number of remote servers, this would result in a huge number of tag values, which could cause cardinality problems. By default, this feature is disabled.

Parameters:

exportTagsForRoute - Set this to true, if the metrics should be tagged with the target route.

Returns:

This builder instance.

observationRegistry

public MicrometerHttpRequestExecutor.Builder observationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)

Configure an observation registry to instrument using the Observation API instead of directly with a Timer.

Parameters:

observationRegistry - registry with which to instrument

Returns:

This builder instance.

observationConvention

public MicrometerHttpRequestExecutor.Builder observationConvention(ApacheHttpClientObservationConvention convention)

Provide a custom convention to override the default convention used when instrumenting with the Observation API. This only takes effect when an observationRegistry(ObservationRegistry) is configured.

Parameters:

convention - semantic convention to use

Returns:

This builder instance.

See Also:

• observationRegistry(ObservationRegistry)

build

public MicrometerHttpRequestExecutor build()

Returns:

Creates an instance of MicrometerHttpRequestExecutor with all the configured properties.