Package com.linecorp.armeria.client.metric

Class MetricCollectingClientBuilder

java.lang.Object

com.linecorp.armeria.common.metric.AbstractMetricCollectingBuilder

com.linecorp.armeria.client.metric.MetricCollectingClientBuilder

public final class MetricCollectingClientBuilder
extends AbstractMetricCollectingBuilder

Builds a MetricCollectingClient instance.

Method Summary

Modifier and Type	Method	Description
MetricCollectingClient	build(HttpClient delegate)	Returns a newly-created MetricCollectingClient decorating HttpClient based on the properties of this builder.
Function<? super HttpClient,MetricCollectingClient>	newDecorator()	Returns a newly-created MetricCollectingClient decorator based on the properties of this builder and applies MeterIdPrefixFunction.
MetricCollectingClientBuilder	successFunction(BiPredicate<? super RequestContext,? super RequestLog> successFunction)	Defines a custom BiPredicate to allow custom definition of successful responses.

Methods inherited from class com.linecorp.armeria.common.metric.AbstractMetricCollectingBuilder

meterIdPrefixFunction, successFunction

Methods inherited from class java.lang.Object

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

Method Details

successFunction

public MetricCollectingClientBuilder successFunction(BiPredicate<? super RequestContext,? super RequestLog> successFunction)

Description copied from class: AbstractMetricCollectingBuilder

Defines a custom BiPredicate to allow custom definition of successful responses. In other words, specify which responses should increment metrics.success() and which - metrics.failure().

Example:

     MetricCollectingService
         .builder(MeterIdPrefixFunction.ofDefault("hello"))
         .successFunction((context, log) -> {
             final int statusCode = log.responseHeaders().status().code();
             return (statusCode >= 200 && statusCode < 400) || statusCode == 404;
         })
         .newDecorator();
 

Overrides:

successFunction in class AbstractMetricCollectingBuilder

build

public MetricCollectingClient build(HttpClient delegate)

Returns a newly-created MetricCollectingClient decorating HttpClient based on the properties of this builder.

newDecorator

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

Returns a newly-created MetricCollectingClient decorator based on the properties of this builder and applies MeterIdPrefixFunction.