Struct metriki_core::MetricsRegistry

pub struct MetricsRegistry { /* private fields */ }

Entrypoint of all metrics

Implementations

impl MetricsRegistry

pub fn new() -> MetricsRegistry

Create a default metrics registry

pub fn arc() -> Arc<MetricsRegistry>

Create a default metrics registry wrapped in an Arc.

pub fn meter(&self, name: &str) -> Arc<Meter>

Return Meter that has been registered and create if not found.

Meter a metric to measure rate of an event. It will report rate in 1 minute, 5 minutes and 15 minutes, which is similar to Linux load.

Panics

This function may panic if a metric is already registered with type other than meter.

pub fn histogram(&self, name: &str) -> Arc<Histogram>

Return Histogram that has been registered and create if not found.

Histogram a metric to measure distribution of a series of data. The distribution will be reported with max, min, mean, stddev and the value at particular percentile.

Panics

This function may panic if a metric is already registered with type other than histogram.

pub fn counter(&self, name: &str) -> Arc<Counter>

Return Counter that has been registered and create if not found.

Counter a metric to measure the number of some state.

Panics

This function may panic if a metric is already registered with type other than counter.

pub fn timer(&self, name: &str) -> Arc<Timer>

Return Timer that has been registered and create if not found.

Timer is a combination of meter and histogram. The meter part is to track rate of the event. And the histogram part maintains the distribution of time spent for the event.

Panics

This function may panic if a metric is already registered with type other than counter.

pub fn gauge(&self, name: &str, func: Box<dyn GaugeFn>)

Register a Gauge with given function.

The guage will return a value when any reporter wants to fetch data from it.

pub fn snapshots(&self) -> HashMap<String, Metric>

Returns all the metrics hold in the registry. Metrics is filtered if a filter is set for this registry.

This is useful for reporters to fetch all values from the registry.

pub fn set_filter(&mut self, filter: Option<Box<dyn MetricsFilter + 'static>>)

Set a filter for this registry. The filter will apply to snapshots function.

pub fn register_metrics_set(
    &self,
    name: &str,
    mset: Arc<dyn MetricsSet + 'static>
)

Register a MetricsSet implementation.

A MetricsSet returns a set of metrics when snapshots() is called on the registry. This provides dynamic metrics that can be added into registry based custom rules.

The name has nothing to do with metrics it added to snapshots() results. It’s just for identify the metrics set for dedup and removal.

pub fn unregister_metrics_set(&self, name: &str)

Unregister a MetricsSet implementation by its name.

Trait Implementations

impl Debug for MetricsRegistry

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

Formats the value using the given formatter.

impl Default for MetricsRegistry

fn default() -> MetricsRegistry

Returns the “default value” for a type.

impl Serialize for MetricsRegistry

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.