Struct Histogram

Source

pub struct Histogram { /* private fields */ }

Expand description

A histogram that tracks the distribution of observed values across pre-defined buckets.

Each bucket counter and the running sum/count are stored as atomics so that recording an observation never blocks readers.

Implementations§

Source §

impl Histogram

Source

pub fn new(buckets: Vec<f64>) -> Self

Create a new histogram with the given bucket upper bounds.

The buckets are automatically sorted and de-duplicated.

Source

pub fn with_defaults() -> Self

Create a histogram with the default bucket boundaries.

Source

pub fn observe(&self, value: f64)

Record an observation.

Source

pub fn count(&self) -> u64

Get the total count of observations.

Source

pub fn sum(&self) -> f64

Get the running sum of all observations.

Source

pub fn bucket_counts(&self) -> Vec<(f64, u64)>

Return (upper_bound, cumulative_count) for each bucket.

Trait Implementations§

Source §

impl Debug for Histogram

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl UnwindSafe for Histogram

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §