org.ballerinalang.util.metrics

Interface CallbackGauge

All Superinterfaces:

Metric

All Known Implementing Classes:

NoOpCallbackGauge

public interface CallbackGauge
extends Metric

Gauge to report instantaneous values by using a callback function.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CallbackGauge.Builder<T> Builder for CallbackGauges.

Method Summary

Modifier and Type	Method and Description
static <T> CallbackGauge.Builder<T>	builder(String name, T obj, ToDoubleFunction<T> valueFunction) Create new builder for CallbackGauge.
double	get()

Methods inherited from interface org.ballerinalang.util.metrics.Metric

getId

Method Detail

builder

static <T> CallbackGauge.Builder<T> builder(String name,
                                            T obj,
                                            ToDoubleFunction<T> valueFunction)

Create new builder for CallbackGauge.

Type Parameters:

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

Parameters:

name - The name of the metric.

obj - State object used to compute a value.

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

Returns:

The builder for CallbackGauge.

get

double get()

Returns:

The value of the gauge.