org.ballerinalang.util.metrics.spi

Interface MetricProvider

All Known Implementing Classes:

NoOpMetricProvider

public interface MetricProvider

This represents the Java SPI interface for a metric provider to be used with MetricRegistry.

Method Summary

Modifier and Type	Method and Description
String	getName() Returns a unique name of the Metric Provider.
void	initialize() This will be called when initializing the default MetricRegistry.
<T> CallbackGauge	newCallbackGauge(MetricId metricId, T obj, ToDoubleFunction<T> toDoubleFunction)
Counter	newCounter(MetricId metricId)
Gauge	newGauge(MetricId metricId)
Summary	newSummary(MetricId metricId)
Timer	newTimer(MetricId metricId)

Method Detail

getName

String getName()

Returns a unique name of the Metric Provider. This will be used when loading the metric provider implementation in MetricRegistry

Returns:

the Metric Provider name.

initialize

void initialize()

This will be called when initializing the default MetricRegistry.

newCounter

Counter newCounter(MetricId metricId)

newGauge

Gauge newGauge(MetricId metricId)

newCallbackGauge

<T> CallbackGauge newCallbackGauge(MetricId metricId,
                                   T obj,
                                   ToDoubleFunction<T> toDoubleFunction)

newSummary

Summary newSummary(MetricId metricId)

newTimer

Timer newTimer(MetricId metricId)