Struct metrix::instruments::Meter

pub struct Meter { /* fields omitted */ }

For measuring rates, e.g. request/s

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

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

Methods

impl Meter

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

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

Rates below this value will be shown as zero.

Default is 0.001

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

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 set_fifteen_minute_rate_enabled(&mut self, enabled: bool)

Enable tracking of one minute rates.

Default: disabled

Trait Implementations

impl Updates for Meter

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

Update the internal state according to the given Update.

impl Instrument for Meter

impl Descriptive for Meter

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

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

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.