Struct metrix::instruments::Histogram

pub struct Histogram { /* fields omitted */ }

For tracking values. E.g. request latencies

Implementations

impl Histogram

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

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

pub fn get_name(&self) -> &str

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

pub fn name<T: Into<String>>(self, name: T) -> Self

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

pub fn title<T: Into<String>>(self, title: T) -> Self

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

pub fn description<T: Into<String>>(self, description: T) -> Self

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 inactivity_limit(self, limit: Duration) -> Self

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

Default is no inactivity tracking.

pub fn set_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.

pub fn reset_after_inactivity(self, reset: bool) -> Self

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.

pub fn set_show_activity_state(&mut self, show: bool)

Set whether to show if the histogram is inactive or not if inactivity_limit is set.

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

pub fn show_activity_state(self, show: bool) -> Self

Set whether to show if the histogram is inactive or not if inactivity_limit is set.

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

pub fn set_display_time_unit(&mut self, display_time_unit: TimeUnit)

pub fn display_time_unit(self, display_time_unit: TimeUnit) -> Self

pub fn accept<L: Eq + Send + 'static, F: Into<LabelFilter<L>>>(
    self,
    accept: F
) -> InstrumentAdapter<L, Self>

pub fn for_label<L: Eq + Send + 'static>(
    self,
    label: L
) -> InstrumentAdapter<L, Self>

Creates an InstrumentAdapter that makes this instrument react on observations on the given label.

pub fn for_labels<L: Eq + Send + 'static>(
    self,
    labels: Vec<L>
) -> InstrumentAdapter<L, Self>

Creates an InstrumentAdapter that makes this instrument react on observations with the given labels.

If labels is empty the instrument will not react to any observations

pub fn for_all_labels<L: Eq + Send + 'static>(
    self
) -> InstrumentAdapter<L, Self>

Creates an InstrumentAdapter that makes this instrument react on all observations.

pub fn for_labels_by_predicate<L, P>(
    self,
    label_predicate: P
) -> InstrumentAdapter<L, Self> where
    L: Eq + Send + 'static,
    P: Fn(&L) -> bool + Send + 'static, 

Creates an InstrumentAdapter that makes this instrument react on observations with labels specified by the predicate.

pub fn adapter<L: Eq + Send + 'static>(self) -> InstrumentAdapter<L, Self>

Creates an InstrumentAdapter that makes this instrument to no observations.

Trait Implementations

impl Descriptive for Histogram

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

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

impl Instrument for Histogram

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.

impl Updates for Histogram

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

Update the internal state according to the given Update.