Struct MetricsRegistry

pub struct MetricsRegistry {
    inner: Registry,
    postprocessors: Arc<Mutex<Vec<Box<dyn FnMut(&mut Vec<MetricFamily>) + Send + Sync>>>>,
}

Available on crate feature metrics only.

The materialize metrics registry.

Fields

inner: Registry

postprocessors: Arc<Mutex<Vec<Box<dyn FnMut(&mut Vec<MetricFamily>) + Send + Sync>>>>

Implementations

impl MetricsRegistry

pub fn new() -> Self

Creates a new metrics registry.

pub fn register<M>(&self, opts: MakeCollectorOpts) -> M

where M: MakeCollector,

Register a metric defined with the metric macro.

pub fn register_computed_gauge<P>( &self, opts: MakeCollectorOpts, f: impl Fn() -> P::T + Send + Sync + 'static, ) -> ComputedGenericGauge<P>

where P: Atomic + 'static,

Registers a gauge whose value is computed when observed.

pub fn register_collector<C: 'static + Collector>(&self, collector: C)

Register a pre-defined prometheus collector.

pub fn register_postprocessor<F>(&self, f: F)

where F: FnMut(&mut Vec<MetricFamily>) + Send + Sync + 'static,

Registers a metric postprocessor.

Postprocessors are invoked on every call to MetricsRegistry::gather in the order that they are registered.

pub fn gather(&self) -> Vec<MetricFamily>

Gather all the metrics from the metrics registry for reporting.

This function invokes the postprocessors on all gathered metrics (see MetricsRegistry::register_postprocessor) in the order the postprocessors were registered.

See also prometheus::Registry::gather.

Trait Implementations

impl Clone for MetricsRegistry

fn clone(&self) -> MetricsRegistry

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MetricsRegistry

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

Formats the value using the given formatter.