Package com.linecorp.armeria.server.metric

Class MetricCollectingService<I extends Request,O extends Response>

java.lang.Object

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

com.linecorp.armeria.server.DecoratingService<I,O,I,O>

com.linecorp.armeria.server.SimpleDecoratingService<I,O>

com.linecorp.armeria.server.metric.MetricCollectingService<I,O>

Type Parameters:

I - the Request type

O - the Response type

All Implemented Interfaces:

Unwrappable, Service<I,O>

public final class MetricCollectingService<I extends Request,O extends Response>
extends SimpleDecoratingService<I,O>

Decorates a Service to collect metrics into MeterRegistry.

Example:

 serverBuilder.service(
         "/service",
         THttpService.of(handler)
                     .decorate(MetricCollectingService.newDecorator(
                             MeterIdPrefixFunction.ofDefault("myService"))));
 
 

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 <I extends Request,O extends Response> Function<Service<I,O>,MetricCollectingService<I,O>>	newDecorator(MeterIdPrefixFunction meterIdPrefixFunction)	Returns a new Service decorator that tracks request stats using MeterRegistry.
O	serve(ServiceRequestContext ctx, I req)	Serves an incoming Request.

Methods inherited from class com.linecorp.armeria.server.DecoratingService

serviceAdded, shouldCachePath

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

as, delegate, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.server.Service

as, decorate, decorate, decorate

Method Detail

newDecorator

public static <I extends Request,O extends Response> Function<Service<I,O>,MetricCollectingService<I,O>> newDecorator(MeterIdPrefixFunction meterIdPrefixFunction)

Returns a new Service decorator that tracks request stats using MeterRegistry.

serve

public O serve(ServiceRequestContext ctx,
               I req)
        throws Exception

Description copied from interface: Service

Serves an incoming Request.

Parameters:

ctx - the context of the received Request

req - the received Request

Returns:

the Response

Throws:

Exception