Struct vise::MetricsCollection

pub struct MetricsCollection<F = fn(_: &MetricGroupDescriptor) -> bool> { /* private fields */ }

Configures collection of registered metrics.

Examples

See Registry docs for examples of usage.

Implementations

impl MetricsCollection

pub fn lazy() -> Self

Specifies that metrics should be lazily exported.

By default, Global metrics are eagerly collected into a Registry; i.e., metrics will get exported even if they were never modified by the app / library logic. This is usually fine (e.g., this allows getting all metrics metadata on the first scrape), but sometimes you may want to export only metrics touched by the app / library logic. E.g., you have a single app binary that exposes different sets of metrics depending on configuration, and exporting all metrics is confusing and/or unacceptably bloats exported data size.

lazy() solves this issue. It will configure the created Registry so that Global metrics are only exported after they are touched by the app / library logic. Beware that this includes being touched by an eager MetricsCollection (only metrics actually included into the collection are touched).

pub fn filter<F>(self, filter_fn: F) -> MetricsCollection<F>

where F: FnMut(&MetricGroupDescriptor) -> bool,

Configures a filtering predicate for this collection. Only Metrics with a descriptor satisfying this will be collected.

impl<F: FnMut(&MetricGroupDescriptor) -> bool> MetricsCollection<F>

pub fn collect(self) -> Registry

Creates a registry with all registered Global metrics and Collectors. If a filtering predicate was provided, only metrics satisfying this function will be collected.

Trait Implementations

impl<F: Debug> Debug for MetricsCollection<F>

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

Formats the value using the given formatter.

impl Default for MetricsCollection

fn default() -> Self

Returns the “default value” for a type.