Package com.linecorp.armeria.server.metric

Class MetricCollectingService

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<HttpRequest,HttpResponse>

com.linecorp.armeria.server.SimpleDecoratingHttpService

com.linecorp.armeria.server.metric.MetricCollectingService

All Implemented Interfaces:

Unwrappable, HttpService, Service<HttpRequest,HttpResponse>

public final class MetricCollectingService
extends SimpleDecoratingHttpService

Decorates an HttpService 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 MetricCollectingServiceBuilder	builder(MeterIdPrefixFunction meterIdPrefixFunction)	Returns a newly created MetricCollectingServiceBuilder.
static Function<? super HttpService,MetricCollectingService>	newDecorator(MeterIdPrefixFunction meterIdPrefixFunction)	Returns a new HttpService decorator that tracks request stats using MeterRegistry.
HttpResponse	serve(ServiceRequestContext ctx, HttpRequest req)	Serves an incoming Request.
void	serviceAdded(ServiceConfig cfg)	Invoked when this service has been added to a Server with the specified configuration.

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

exchangeType

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

shouldCachePath

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

as, toString, unwrap, unwrapAll

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

decorate, decorate

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

as, shouldCachePath, unwrap

Methods inherited from interface com.linecorp.armeria.common.util.Unwrappable

equalsIgnoreWrapper, unwrapAll

Method Details

newDecorator

public static Function<? super HttpService,MetricCollectingService> newDecorator(MeterIdPrefixFunction meterIdPrefixFunction)

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

builder

public static MetricCollectingServiceBuilder builder(MeterIdPrefixFunction meterIdPrefixFunction)

Returns a newly created MetricCollectingServiceBuilder.

serve

public HttpResponse serve(ServiceRequestContext ctx,
 HttpRequest 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

serviceAdded

public void serviceAdded(ServiceConfig cfg)
                  throws Exception

Description copied from interface: Service

Invoked when this service has been added to a Server with the specified configuration. Please note that this method can be invoked more than once if this service has been added more than once.

Specified by:

serviceAdded in interface Service<HttpRequest,HttpResponse>

Overrides:

serviceAdded in class DecoratingService<HttpRequest,HttpResponse,HttpRequest,HttpResponse>

Throws:

Exception