Package com.linecorp.armeria.client.metric

Class MetricCollectingRpcClient

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.MetricCollectingRpcClient

All Implemented Interfaces:

Client<RpcRequest,RpcResponse>, RpcClient, Unwrappable

public final class MetricCollectingRpcClient
extends SimpleDecoratingClient<I,O>
implements RpcClient

Decorates an RpcClient to collect metrics into MeterRegistry.

Example:

 MyService.Iface client =
     Clients.builder(uri)
            .rpcDecorator(MetricCollectingRpcClient.newDecorator(MeterIdPrefixFunction.ofDefault("myClient")))
            .build(MyService.Iface.class);
 

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 MetricCollectingRpcClientBuilder	builder(MeterIdPrefixFunction meterIdPrefixFunction)	Returns a new MetricCollectingRpcClientBuilder instance.
RpcResponse	execute(ClientRequestContext ctx, RpcRequest req)	Sends a Request to a remote Endpoint, as specified in ClientRequestContext.endpoint().
static Function<? super RpcClient,MetricCollectingRpcClient>	newDecorator(MeterIdPrefixFunction meterIdPrefixFunction)	Returns an RpcClient 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.RpcClient

execute

Method Details

newDecorator

public static Function<? super RpcClient,MetricCollectingRpcClient> newDecorator(MeterIdPrefixFunction meterIdPrefixFunction)

Returns an RpcClient decorator that tracks request stats using MeterRegistry.

builder

public static MetricCollectingRpcClientBuilder builder(MeterIdPrefixFunction meterIdPrefixFunction)

Returns a new MetricCollectingRpcClientBuilder instance.

execute

public final RpcResponse execute(ClientRequestContext ctx,
RpcRequest 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