org.ballerinalang.util.metrics

Class MetricRegistry

java.lang.Object

org.ballerinalang.util.metrics.MetricRegistry

public class MetricRegistry
extends Object

Registry for keeping metrics by name.

Constructor Summary

Constructors

Constructor and Description
MetricRegistry(MetricProvider metricProvider)

Method Summary

Modifier and Type	Method and Description
<T> CallbackGauge	callbackGauge(MetricId id, T obj, ToDoubleFunction<T> valueFunction) Use CallbackGauge.builder(String, Object, ToDoubleFunction).
Counter	counter(MetricId id) Use Counter.builder(String).
Gauge	gauge(MetricId id) Use Gauge.builder(String).
void	remove(String name) Removes the metric with the given name.
Summary	summary(MetricId id) Use Summary.builder(String).
Timer	timer(MetricId id) Use Timer.builder(String).

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricRegistry

public MetricRegistry(MetricProvider metricProvider)

Method Detail

counter

public Counter counter(MetricId id)

Use Counter.builder(String).

Parameters:

id - The MetricId.

Returns:

A existing or a new Counter metric.

gauge

public Gauge gauge(MetricId id)

Use Gauge.builder(String).

Parameters:

id - The MetricId.

Returns:

A existing or a new Gauge metric.

callbackGauge

public <T> CallbackGauge callbackGauge(MetricId id,
                                       T obj,
                                       ToDoubleFunction<T> valueFunction)

Use CallbackGauge.builder(String, Object, ToDoubleFunction).

Type Parameters:

T - The type of the state object from which the gauge value is extracted.

Parameters:

id - The MetricId.

obj - State object used to compute a value.

valueFunction - Function that produces an instantaneous gauge value from the state object.

Returns:

A existing or a new CallbackGauge metric.

summary

public Summary summary(MetricId id)

Use Summary.builder(String).

Parameters:

id - The MetricId.

Returns:

A existing or a new Summary metric.

timer

public Timer timer(MetricId id)

Use Timer.builder(String).

Parameters:

id - The MetricId.

Returns:

A existing or a new Timer metric.

remove

public void remove(String name)

Removes the metric with the given name.

Parameters:

name - the name of the metric