Struct prometrics::metrics::Gauge

pub struct Gauge(_);

Gauge is a metric that represents a single numerical value that can arbitrarily go up and down.

Cloned gauges share the same value.

Methods

impl Gauge

pub fn new(name: &str) -> Result<Self>

Makes a new Gauge instance.

Note that it is recommended to create this via GaugeBuilder.

pub fn metric_name(&self) -> &MetricName

Returns the name of this gauge.

pub fn help(&self) -> Option<&str>

Returns the help of this gauge.

pub fn labels(&self) -> &Labels

Returns the labels of this gauge.

pub fn labels_mut(&mut self) -> LabelsMut

Returns the mutable labels of this gauge.

pub fn timestamp(&self) -> &Timestamp

Returns the timestamp of this gauge.

pub fn timestamp_mut(&self) -> TimestampMut

Returns the mutable timestamp of this gauge.

pub fn value(&self) -> f64

Returns the value of this gauge.

pub fn increment(&self)

Increments this gauge.

pub fn add(&self, count: f64)

Adds count to this gauge.

pub fn decrement(&self)

Decrements this gauge.

pub fn subtract(&self, count: f64)

Subtracts count from this gauge.

pub fn set(&self, value: f64)

Sets this gauge to value.

pub fn set_to_current_time(&self)

Sets this gauge to the current unixtime in seconds.

pub fn track_inprogress<F, T>(&self, f: F) -> T where
    F: FnOnce() -> T, 

Tracks in-progress processings in some piece of code/function.

Examples

use prometrics::metrics::GaugeBuilder;

let mut gauge0 = GaugeBuilder::new("foo").finish().unwrap();
let gauge1 = gauge0.clone();

assert_eq!(gauge0.value(), 0.0);
gauge0.track_inprogress(|| {
    assert_eq!(gauge1.value(), 1.0);
});
assert_eq!(gauge0.value(), 0.0);

pub fn time<F, T>(&self, f: F) -> T where
    F: FnOnce() -> T, 

Measures the exeuction time of f and sets this gauge to its duration in seconds.

pub fn collector(&self) -> GaugeCollector

Returns a collector for this gauge.

Trait Implementations

impl Clone for Gauge

fn clone(&self) -> Gauge

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Gauge

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

Formats the value using the given formatter.

impl Display for Gauge

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

Formats the value using the given formatter.

impl From<Gauge> for Metric

fn from(f: Gauge) -> Self

Performs the conversion.