Struct Counter

pub struct Counter(/* private fields */);

Counter is a cumulative metric that represents a single numerical value that only ever goes up.

Cloned counters share the same value.

Examples

use prometrics::metrics::CounterBuilder;

let mut counter = CounterBuilder::new("foo_total").namespace("example").finish().unwrap();
assert_eq!(counter.metric_name().to_string(), "example_foo_total");
assert_eq!(counter.value(), 0.0);

counter.increment();
assert_eq!(counter.value(), 1.0);

Implementations

impl Counter

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

Makes a new Counter instance.

Note that it is recommended to create this via CounterBuilder.

pub fn metric_name(&self) -> &MetricName

Returns the name of this counter.

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

Returns the help of this counter.

pub fn labels(&self) -> &Labels

Returns the labels of this counter.

pub fn labels_mut(&mut self) -> LabelsMut<'_>

Returns the mutable labels of this counter.

pub fn timestamp(&self) -> &Timestamp

Returns the timestamp of this counter.

pub fn timestamp_mut(&self) -> TimestampMut<'_>

Returns the mutable timestamp of this counter.

pub fn value(&self) -> f64

Returns the value of this counter.

pub fn increment(&self)

Increments this counter.

pub fn add(&self, count: f64) -> Result<()>

Adds count to this counter.

pub fn add_u64(&self, count: u64)

Adds count to this counter.

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

where F: FnOnce() -> T,

Measures the exeuction time of f and adds its duration to the counter in seconds.

pub fn collector(&self) -> CounterCollector

Returns a collector for this counter.

Trait Implementations

impl Clone for Counter

fn clone(&self) -> Counter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Counter

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

Formats the value using the given formatter.

impl Display for Counter

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

Formats the value using the given formatter.

impl From<Counter> for Metric

fn from(f: Counter) -> Self

Converts to this type from the input type.