Package com.linecorp.armeria.common.metric

Class AbstractMetricCollectingBuilder

java.lang.Object

com.linecorp.armeria.common.metric.AbstractMetricCollectingBuilder

Direct Known Subclasses:

MetricCollectingClientBuilder, MetricCollectingRpcClientBuilder, MetricCollectingServiceBuilder

public abstract class AbstractMetricCollectingBuilder
extends Object

Builds an implementing class of AbstractMetricCollectingBuilder instance.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMetricCollectingBuilder(MeterIdPrefixFunction meterIdPrefixFunction)	Creates a new instance with the specified MeterIdPrefixFunction.

Method Summary

Modifier and Type	Method	Description
protected final DistributionStatisticConfig	distributionStatisticConfig()	Returns the distributionStatisticConfig.
AbstractMetricCollectingBuilder	distributionStatisticConfig(DistributionStatisticConfig distributionStatisticConfig)	Defines a custom DistributionStatisticConfig to use for the distribution config.
protected MeterIdPrefixFunction	meterIdPrefixFunction()	Returns the MeterIdPrefixFunction.
protected final @Nullable BiPredicate<? super RequestContext,? super RequestLog>	successFunction()	Returns the successFunction.
AbstractMetricCollectingBuilder	successFunction(BiPredicate<? super RequestContext,? super RequestLog> successFunction)	Deprecated. Use ClientBuilder.successFunction(SuccessFunction) or ServerBuilder.successFunction(SuccessFunction).

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractMetricCollectingBuilder

protected AbstractMetricCollectingBuilder(MeterIdPrefixFunction meterIdPrefixFunction)

Creates a new instance with the specified MeterIdPrefixFunction.

Method Details

meterIdPrefixFunction

protected MeterIdPrefixFunction meterIdPrefixFunction()

Returns the MeterIdPrefixFunction.

successFunction

@Nullable
protected final @Nullable BiPredicate<? super RequestContext,? super RequestLog> successFunction()

Returns the successFunction.

successFunction

@Deprecated
public AbstractMetricCollectingBuilder successFunction(BiPredicate<? super RequestContext,? super RequestLog> successFunction)

Deprecated.

Use ClientBuilder.successFunction(SuccessFunction) or ServerBuilder.successFunction(SuccessFunction).

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();
 

distributionStatisticConfig

protected final DistributionStatisticConfig distributionStatisticConfig()

Returns the distributionStatisticConfig.

distributionStatisticConfig

public AbstractMetricCollectingBuilder distributionStatisticConfig(DistributionStatisticConfig distributionStatisticConfig)

Defines a custom DistributionStatisticConfig to use for the distribution config.