com.netflix.concurrency.limits

Interface MetricRegistry

All Known Implementing Classes:

EmptyMetricRegistry

public interface MetricRegistry

Simple abstraction for tracking metrics in the limiters.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MetricRegistry.Counter
static interface	MetricRegistry.SampleListener Listener to receive samples for a distribution

Method Summary

Modifier and Type	Method and Description
default MetricRegistry.Counter	counter(java.lang.String id, java.lang.String... tagNameValuePairs) Create a counter that will be increment when an event occurs.
default MetricRegistry.SampleListener	distribution(java.lang.String id, java.lang.String... tagNameValuePairs) Register a sample distribution.
default void	gauge(java.lang.String id, java.util.function.Supplier<java.lang.Number> supplier, java.lang.String... tagNameValuePairs) Register a gauge using the provided supplier.
default MetricRegistry.SampleListener	registerDistribution(java.lang.String id, java.lang.String... tagNameValuePairs) Deprecated. Use distribution(String, String...)
default void	registerGauge(java.lang.String id, java.util.function.Supplier<java.lang.Number> supplier, java.lang.String... tagNameValuePairs) Deprecated. Use gauge(String, Supplier, String...)
default void	registerGuage(java.lang.String id, java.util.function.Supplier<java.lang.Number> supplier, java.lang.String... tagNameValuePairs) Deprecated. Call MetricRegistry#registerGauge

Method Detail

registerDistribution

@Deprecated
default MetricRegistry.SampleListener registerDistribution(java.lang.String id,
                                                                       java.lang.String... tagNameValuePairs)

Deprecated. Use distribution(String, String...)

distribution

default MetricRegistry.SampleListener distribution(java.lang.String id,
                                                   java.lang.String... tagNameValuePairs)

Register a sample distribution. Samples are added to the distribution via the returned MetricRegistry.SampleListener. Will reuse an existing MetricRegistry.SampleListener if the distribution already exists.

Parameters:

id -

tagNameValuePairs - Pairs of tag name and tag value. Number of parameters must be a multiple of 2.

Returns:

SampleListener for the caller to add samples

registerGauge

@Deprecated
default void registerGauge(java.lang.String id,
                                       java.util.function.Supplier<java.lang.Number> supplier,
                                       java.lang.String... tagNameValuePairs)

Deprecated. Use gauge(String, Supplier, String...)

gauge

default void gauge(java.lang.String id,
                   java.util.function.Supplier<java.lang.Number> supplier,
                   java.lang.String... tagNameValuePairs)

Register a gauge using the provided supplier. The supplier will be polled whenever the guage value is flushed by the registry.

Parameters:

id -

tagNameValuePairs - Pairs of tag name and tag value. Number of parameters must be a multiple of 2.

supplier -

counter

default MetricRegistry.Counter counter(java.lang.String id,
                                       java.lang.String... tagNameValuePairs)

Create a counter that will be increment when an event occurs. Counters normally translate in an action per second metric.

Parameters:

id -

tagNameValuePairs -

registerGuage

@Deprecated
default void registerGuage(java.lang.String id,
                                       java.util.function.Supplier<java.lang.Number> supplier,
                                       java.lang.String... tagNameValuePairs)

Deprecated. Call MetricRegistry#registerGauge