Package com.linecorp.armeria.client.metric

Class MetricCollectingClient

java.lang.Object

com.linecorp.armeria.common.util.AbstractUnwrappable<Client<T_I,T_O>>

com.linecorp.armeria.client.DecoratingClient<I,O,I,O>

com.linecorp.armeria.client.SimpleDecoratingClient<I,O>

com.linecorp.armeria.client.metric.MetricCollectingClient

All Implemented Interfaces:

Client<HttpRequest,HttpResponse>, HttpClient, Unwrappable

public final class MetricCollectingClient
extends SimpleDecoratingClient<I,O>
implements HttpClient

Decorates an HttpClient to collect metrics into MeterRegistry.

Example:

 WebClient client = WebClient
         .builder(uri)
         .decorator(MetricCollectingClient.newDecorator(MeterIdPrefixFunction.ofDefault("myClient")))
         .build();
 
 

It is generally recommended not to use a class or package name as a metric name, because otherwise seemingly harmless refactoring such as rename may break metric collection.

Method Summary

Modifier and Type	Method	Description
static MetricCollectingClientBuilder	builder(MeterIdPrefixFunction meterIdPrefixFunction)	Returns a new MetricCollectingClientBuilder instance.
HttpResponse	execute(ClientRequestContext ctx, HttpRequest req)	Sends a Request to a remote Endpoint, as specified in ClientRequestContext.endpoint().
static Function<? super HttpClient,MetricCollectingClient>	newDecorator(MeterIdPrefixFunction meterIdPrefixFunction)	Returns an HttpClient decorator that tracks request stats using MeterRegistry.

Methods inherited from class com.linecorp.armeria.common.util.AbstractUnwrappable

as, toString, unwrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.client.Client

as, unwrap

Methods inherited from interface com.linecorp.armeria.client.HttpClient

execute

Method Details

newDecorator

public static Function<? super HttpClient,MetricCollectingClient> newDecorator(MeterIdPrefixFunction meterIdPrefixFunction)

Returns an HttpClient decorator that tracks request stats using MeterRegistry.

builder

public static MetricCollectingClientBuilder builder(MeterIdPrefixFunction meterIdPrefixFunction)

Returns a new MetricCollectingClientBuilder instance.

execute

public final HttpResponse execute(ClientRequestContext ctx,
 HttpRequest req)
                           throws Exception

Description copied from interface: Client

Sends a Request to a remote Endpoint, as specified in ClientRequestContext.endpoint().

Returns:

the Response to the specified Request

Throws:

Exception