Struct prometrics::metrics::Gauge
[−]
[src]
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
[src]
pub fn new(name: &str) -> Result<Self>
[src]
Makes a new Gauge
instance.
Note that it is recommended to create this via GaugeBuilder
.
pub fn metric_name(&self) -> &MetricName
[src]
Returns the name of this gauge.
pub fn help(&self) -> Option<&str>
[src]
Returns the help of this gauge.
pub fn labels(&self) -> &Labels
[src]
Returns the labels of this gauge.
pub fn labels_mut(&mut self) -> LabelsMut
[src]
Returns the mutable labels of this gauge.
pub fn timestamp(&self) -> &Timestamp
[src]
Returns the timestamp of this gauge.
pub fn timestamp_mut(&mut self) -> TimestampMut
[src]
Returns the mutable timestamp of this gauge.
pub fn value(&self) -> f64
[src]
Returns the value of this gauge.
pub fn increment(&self)
[src]
Increments this gauge.
pub fn add(&self, count: f64)
[src]
Adds count
to this gauge.
pub fn decrement(&self)
[src]
Decrements this gauge.
pub fn subtract(&self, count: f64)
[src]
Subtracts count
from this gauge.
pub fn set(&self, value: f64)
[src]
Sets this gauge to value
.
pub fn set_to_current_time(&self)
[src]
Sets this gauge to the current unixtime in seconds.
pub fn track_inprogress<F, T>(&self, f: F) -> T where
F: FnOnce() -> T,
[src]
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,
[src]
F: FnOnce() -> T,
Measures the exeuction time of f
and sets this gauge to its duration in seconds.
pub fn collector(&self) -> GaugeCollector
[src]
Returns a collector for this gauge.
Trait Implementations
impl From<Gauge> for Metric
[src]
impl Debug for Gauge
[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl Clone for Gauge
[src]
fn clone(&self) -> Gauge
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more