org.ballerinalang.util.metrics

Interface Gauge

All Superinterfaces:

Metric

All Known Implementing Classes:

NoOpGauge

public interface Gauge
extends Metric

Gauge is used to track a value that goes up and down. Gauge can also report instantaneous values.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Gauge.Builder Builder for Gauges.

Method Summary

Modifier and Type	Method and Description
static Gauge.Builder	builder(String name) Create new builder for Gauge.
default void	decrement() Decrement the gauge by one.
void	decrement(double amount) Decrement the gauge by amount.
double	get()
default void	increment() Increment the gauge by one.
void	increment(double amount) Increment the gauge by amount.
void	set(double value) Set the gauge to the given value.

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

getId

Method Detail

builder

static Gauge.Builder builder(String name)

Create new builder for Gauge.

Parameters:

name - The name of the metric.

Returns:

The builder for Gauge.

increment

default void increment()

Increment the gauge by one.

increment

void increment(double amount)

Increment the gauge by amount.

Parameters:

amount - Amount to add to the gauge.

decrement

default void decrement()

Decrement the gauge by one.

decrement

void decrement(double amount)

Decrement the gauge by amount.

Parameters:

amount - Amount to subtract from the gauge.

set

void set(double value)

Set the gauge to the given value. This will overwrite existing value.

Parameters:

value - The value to set to the gauge.

get

double get()

Returns:

The value of the gauge.