Struct metrix::instruments::Histogram

pub struct Histogram { /* fields omitted */ }

For tracking values. E.g. request latencies

Methods

impl Histogram

pub fn new_with_defaults<T: Into<String>>(name: T) -> Histogram

pub fn name(&self) -> &str

pub fn set_name<T: Into<String>>(&mut self, name: T)

pub fn set_title<T: Into<String>>(&mut self, title: T)

pub fn set_description<T: Into<String>>(&mut self, description: T)

pub fn set_inactivity_limit(&mut self, limit: Duration)

Sets the maximum amount of time this histogram may be inactive until no more snapshots are taken

Default is no inactivity tracking.

pub fn reset_after_inactivity(&mut self, reset: bool)

Reset the histogram if inactivity tracking was enabled and the histogram was inactive.

The default is true. Only has an effect if a max_inactivity_duration is set.

Trait Implementations

impl Updates for Histogram

fn update(&mut self, with: &Update) -> usize

Update the internal state according to the given Update.

impl Instrument for Histogram

impl Descriptive for Histogram

fn title(&self) -> Option<&str>

fn description(&self) -> Option<&str>

impl PutsSnapshot for Histogram

fn put_snapshot(&self, into: &mut Snapshot, descriptive: bool)

Puts the current snapshot values into the given Snapshot thereby following the guidelines of PutsSnapshot.