com.linecorp.armeria.server.logging

Class DropwizardMetricCollectingService<I extends Request,O extends Response>

java.lang.Object

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

com.linecorp.armeria.server.logging.DropwizardMetricCollectingService<I,O>

Type Parameters:

I - the Request type

O - the Response type

All Implemented Interfaces:

Service<I,O>

public final class DropwizardMetricCollectingService<I extends Request,O extends Response>
extends DecoratingService<I,O,I,O>

Decorates a Service to collect metrics into Dropwizard MetricRegistry. To use, simply prepare a MetricRegistry and add this decorator to a service specification.

Example:

 MetricRegistry metricRegistry = new MetricRegistry();
 serverBuilder.serviceAt(
         "/service",
         ThriftService.of(handler).decorate(
                 DropwizardMetricCollectingService.newDecorator(metricRegistry, "services")));
 
 

It is generally recommended to define your own name for the service instead of using something like the Java class to make sure otherwise safe changes like renames don't break metrics.

Method Summary

Modifier and Type	Method and Description
static <I extends Request,O extends Response> java.util.function.Function<Service<? super I,? extends O>,DropwizardMetricCollectingService<I,O>>	newDecorator(com.codahale.metrics.MetricRegistry metricRegistry, java.util.function.Function<? super RequestLog,java.lang.String> metricNameFunc) Returns a new Service decorator that tracks request stats using the Dropwizard metrics library.
static <I extends Request,O extends Response> java.util.function.Function<Service<? super I,? extends O>,DropwizardMetricCollectingService<I,O>>	newDecorator(com.codahale.metrics.MetricRegistry metricRegistry, java.lang.String metricNamePrefix) Returns a new Service decorator that tracks request stats using the Dropwizard metrics library.
O	serve(ServiceRequestContext ctx, I req) Serves an incoming Request.

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

as, delegate, serviceAdded, 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

decorate, decorate, decorate

Method Detail

newDecorator

public static <I extends Request,O extends Response> java.util.function.Function<Service<? super I,? extends O>,DropwizardMetricCollectingService<I,O>> newDecorator(com.codahale.metrics.MetricRegistry metricRegistry,
                                                                                                                                                                     java.util.function.Function<? super RequestLog,java.lang.String> metricNameFunc)

Returns a new Service decorator that tracks request stats using the Dropwizard metrics library.

Parameters:

metricRegistry - the MetricRegistry to store metrics into.

metricNameFunc - the function that transforms a RequestLog into a metric name

newDecorator

public static <I extends Request,O extends Response> java.util.function.Function<Service<? super I,? extends O>,DropwizardMetricCollectingService<I,O>> newDecorator(com.codahale.metrics.MetricRegistry metricRegistry,
                                                                                                                                                                     java.lang.String metricNamePrefix)

Returns a new Service decorator that tracks request stats using the Dropwizard metrics library.

Parameters:

metricRegistry - the MetricRegistry to store metrics into.

metricNamePrefix - the prefix of the names of the metrics created by the returned decorator.

serve

public O serve(ServiceRequestContext ctx,
               I req)
        throws java.lang.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:

java.lang.Exception