Struct prometheus_client::metrics::gauge::Gauge

pub struct Gauge<N = i64, A = AtomicI64> { /* private fields */ }

Open Metrics Gauge to record current measurements.

Single increasing, decreasing or constant value metric.

Gauge is generic over the actual data type tracking the Gauge state as well as the data type used to interact with the Gauge. Out of convenience the generic type parameters are set to use an AtomicI64 as a storage and i64 on the interface by default.

Examples

Using AtomicI64 as storage and i64 on the interface

let gauge: Gauge = Gauge::default();
gauge.set(42);
let _value = gauge.get();

Using AtomicU64 as storage and f64 on the interface

let gauge = Gauge::<f64, AtomicU64>::default();
gauge.set(42.0);
let _value: f64 = gauge.get();

Implementations

impl<N, A: Atomic<N>> Gauge<N, A>

pub fn inc(&self) -> N

Increase the Gauge by 1, returning the previous value.

pub fn inc_by(&self, v: N) -> N

Increase the Gauge by v, returning the previous value.

pub fn dec(&self) -> N

Decrease the Gauge by 1, returning the previous value.

pub fn dec_by(&self, v: N) -> N

Decrease the Gauge by v, returning the previous value.

pub fn set(&self, v: N) -> N

Sets the Gauge to v, returning the previous value.

pub fn get(&self) -> N

Get the current value of the Gauge.

pub fn inner(&self) -> &A

Exposes the inner atomic type of the Gauge.

This should only be used for advanced use-cases which are not directly supported by the library.

Trait Implementations

impl<N, A> Clone for Gauge<N, A>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<N: Debug, A: Debug> Debug for Gauge<N, A>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<N, A: Default> Default for Gauge<N, A>

fn default() -> Self

Returns the “default value” for a type.

impl<N, A> EncodeMetric for Gauge<N, A>

where N: EncodeGaugeValue, A: Atomic<N>,

fn encode(&self, encoder: MetricEncoder<'_>) -> Result<(), Error>

Encode the given instance in the OpenMetrics text encoding.

fn metric_type(&self) -> MetricType

The OpenMetrics metric type of the instance.

impl<N, A> TypedMetric for Gauge<N, A>

const TYPE: MetricType = MetricType::Gauge

The OpenMetrics metric type.