Struct Gauge

pub struct Gauge<V: GaugeValue = i64>(/* private fields */);

Gauge metric.

Gauges are integer or floating-point values that can go up or down. Logically, a reported gauge value can be treated as valid until the next value is reported.

Gauge values must implement the GaugeValue trait.

Implementations

impl<V: GaugeValue> Gauge<V>

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

Increases this Gauge by v, returning the previous value.

pub fn inc_guard(&self, v: V) -> GaugeGuard<V>

Increases this Gauge by v and returns a guard that will decrement this value back when dropped. This can be useful for gauges that measure consumption of a certain resource.

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

Decreases this Gauge by v, returning the previous value.

Panics

Depending on the value type, this method may panic on underflow; use with care.

pub fn set(&self, value: V) -> V

Sets the value of this Gauge returning the previous value.

pub fn get(&self) -> V

Gets the current value of the gauge.

Trait Implementations

impl<V: GaugeValue> BuildMetric for Gauge<V>

type Builder = MetricBuilder

Metric builder used to construct a metric.

fn build(_builder: Self::Builder) -> Self

Creates a metric given its builder.

impl<V: GaugeValue> Clone for Gauge<V>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<V: GaugeValue> Debug for Gauge<V>

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

Formats the value using the given formatter.

impl<V: GaugeValue> Default for Gauge<V>

fn default() -> Self

Returns the “default value” for a type.

impl<V: GaugeValue> EncodeMetric for Gauge<V>

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

Encode the given instance in the OpenMetrics text encoding.

fn metric_type(&self) -> MetricType

The OpenMetrics metric type of the instance.

impl<V: GaugeValue> TypedMetric for Gauge<V>

const TYPE: MetricType = MetricType::Gauge

The OpenMetrics metric type.