Package io.prometheus.metrics.core.metrics

Class Gauge

Object

Metric

MetricWithFixedMetadata

StatefulMetric<GaugeDataPoint,Gauge.DataPoint>

Gauge

All Implemented Interfaces:

DataPoint, GaugeDataPoint, TimerApi, Collector

public class Gauge
extends StatefulMetric<GaugeDataPoint,Gauge.DataPoint>
implements GaugeDataPoint

Gauge metric.

Example usage:

 Gauge currentActiveUsers = Gauge.builder()
     .name("current_active_users")
     .help("Number of users that are currently active")
     .labelNames("region")
     .register();

 public void login(String region) {
     currentActiveUsers.labelValues(region).inc();
     // perform login
 }

 public void logout(String region) {
     currentActiveUsers.labelValues(region).dec();
     // perform logout
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Gauge.Builder

Method Summary

Modifier and Type	Method	Description
static Gauge.Builder	builder()
static Gauge.Builder	builder(PrometheusProperties config)
GaugeSnapshot	collect()	Called when the Prometheus server scrapes metrics.
double	get()	Get the current value.
void	inc(double amount)	Add amount.
void	incWithExemplar(double amount, Labels labels)	Add amount, and create a custom exemplar with the given labels.
void	set(double value)	Set the gauge to value.
void	setWithExemplar(double value, Labels labels)	Set the gauge to value, and create a custom exemplar with the given labels.

Methods inherited from class StatefulMetric

clear, initLabelValues, labelValues, remove, removeIf

Methods inherited from class MetricWithFixedMetadata

getPrometheusName

Methods inherited from class Object

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

Methods inherited from interface Collector

collect, collect, collect

Methods inherited from interface GaugeDataPoint

dec, dec, decWithExemplar, decWithExemplar, inc, incWithExemplar, startTimer

Methods inherited from interface TimerApi

time, time, timeChecked

Method Details

inc

public void inc(double amount)

Description copied from interface: GaugeDataPoint

Add amount.

Specified by:

inc in interface GaugeDataPoint

get

public double get()

Description copied from interface: GaugeDataPoint

Get the current value.

Specified by:

get in interface GaugeDataPoint

incWithExemplar

public void incWithExemplar(double amount,
 Labels labels)

Description copied from interface: GaugeDataPoint

Add amount, and create a custom exemplar with the given labels.

Specified by:

incWithExemplar in interface GaugeDataPoint

set

public void set(double value)

Description copied from interface: GaugeDataPoint

Set the gauge to value.

Specified by:

set in interface GaugeDataPoint

setWithExemplar

public void setWithExemplar(double value,
 Labels labels)

Description copied from interface: GaugeDataPoint

Set the gauge to value, and create a custom exemplar with the given labels.

Specified by:

setWithExemplar in interface GaugeDataPoint

collect

public GaugeSnapshot collect()

Description copied from interface: Collector

Called when the Prometheus server scrapes metrics.

Specified by:

collect in interface Collector

Overrides:

collect in class StatefulMetric<GaugeDataPoint,Gauge.DataPoint>

builder

public static Gauge.Builder builder()

builder

public static Gauge.Builder builder(PrometheusProperties config)