Struct metrix::instruments::Meter

pub struct Meter { /* fields omitted */ }

For measuring rates, e.g. request/s

This meter count occurrences. An occurrence with values is counted as 1 occurrence.

To get rates on values use instruments::other_instruments::ValueMeter

Methods

impl Meter

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

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

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_lower_cutoff(&mut self, cutoff: f64)

Rates below this value will be shown as zero.

Default is 0.001

pub fn lower_cutoff(self, cutoff: f64) -> Self

Rates below this value will be shown as zero.

Default is 0.001

pub fn set_one_minute_rate_enabled(&mut self, enabled: bool)

Enable tracking of one minute rates.

Default: enabled

pub fn one_minute_rate_enabled(self, enabled: bool) -> Self

Enable tracking of one minute rates.

Default: enabled

pub fn set_five_minute_rate_enabled(&mut self, enabled: bool)

Enable tracking of five minute rates.

Default: disabled

pub fn five_minute_rate_enabled(self, enabled: bool) -> Self

Enable tracking of five minute rates.

Default: disabled

pub fn set_fifteen_minute_rate_enabled(&mut self, enabled: bool)

Enable tracking of one minute rates.

Default: disabled

pub fn fifteen_minute_rate_enabled(self, enabled: bool) -> Self

Enable tracking of one minute rates.

Default: disabled

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 Meter

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

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

impl Instrument for Meter

impl PutsSnapshot for Meter

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 Meter

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

Update the internal state according to the given Update.