Struct histogram::AtomicHistogram

pub struct AtomicHistogram { /* private fields */ }

A histogram that uses atomic 64bit counters for each bucket.

Unlike the non-atomic variant, it cannot be used directly to report percentiles. Instead, a snapshot must be taken which captures the state of the histogram at a point in time.

Implementations

impl AtomicHistogram

pub fn new(p: u8, n: u8) -> Result<Self, Error>

Construct a new atomic histogram from the provided parameters. See the documentation for crate::Config to understand their meaning.

pub fn with_config(config: &Config) -> Self

Creates a new atomic histogram using a provided crate::Config.

pub fn increment(&self, value: u64) -> Result<(), Error>

Increment the bucket that contains the value by one.

This is a convenience method that uses Instant::now() as the time associated with the observation. If you already have a timestamp, you may wish to use increment_at instead.

pub fn add(&self, value: u64, count: u64) -> Result<(), Error>

Increment the bucket that contains the value by some count.

This is a convenience method that uses Instant::now() as the time associated with the observation. If you already have a timestamp, you may wish to use the add_at instead.

pub fn snapshot(&self) -> Snapshot

Produce a snapshot from this histogram.