Struct witchcraft_metrics::Timer

pub struct Timer { /* private fields */ }

A metric tracking the duration and rate of events.

The timer’s default reservoir implementation (used by its Default implementation) is the ExponentiallyDecayingReservoir.

Implementations

impl Timer

pub fn new<R>(reservoir: R) -> Timer where
    R: Reservoir, 

Creates a new timer.

pub fn new_with<R>(reservoir: R, clock: Arc<dyn Clock>) -> Self where
    R: Reservoir, 

Creates a new timer using the provided Clock as its time source.

pub fn update(&self, duration: Duration)

Adds a new timed event to the metric.

pub fn time(&self) -> Time<'_>

Returns a guard type which reports the time elapsed since its creation when it drops.

pub fn count(&self) -> i64

Returns the number of events reported to the metric.

pub fn one_minute_rate(&self) -> f64

Returns the one minute rolling average rate of the occurrence of events measured in events per second.

pub fn five_minute_rate(&self) -> f64

Returns the five minute rolling average rate of the occurrence of events measured in events per second.

pub fn fifteen_minute_rate(&self) -> f64

Returns the fifteen minute rolling average rate of the occurrence of events measured in events per second.

pub fn mean_rate(&self) -> f64

Returns the mean rate of the occurrence of events since the creation of the timer measured in events per second.

pub fn snapshot(&self) -> Box<dyn Snapshot>

Returns a snapshot of the statistical distribution of durations of events, measured in nanoseconds.

Trait Implementations

impl Default for Timer

fn default() -> Timer

Returns the “default value” for a type.