Struct ore::metrics::MetricsRegistry

pub struct MetricsRegistry {
    inner: Registry,
    third_party: Registry,
}

This is supported on crate feature metrics only.

The materialize metrics registry.

Fields

inner: Registry

third_party: Registry

Implementations

impl MetricsRegistry

pub fn new() -> Self

Creates a new metrics registry.

pub fn register<M>(&self, opts: Opts) -> M where
    M: MakeCollector, 

Register a metric defined with the metric macro.

pub fn register_computed_gauge<F, P>(
    &self,
    opts: Opts,
    f: F
) -> ComputedGenericGauge<P> where
    F: Fn() -> P::T + Send + Sync + 'static,
    P: Atomic + 'static, 

Registers a gauge whose value is computed when observed.

pub fn register_third_party_visible<M>(&self, opts: Opts) -> ThirdPartyMetric<M> where
    M: MakeCollector, 

Register a metric that can be scraped from both the “normal” registry, as well as the registry that is accessible to third parties (like cloud providers and infrastructure orchestrators).

Take care to vet metrics that are visible to third parties: metrics containing sensitive information as labels (e.g. source/sink names or other user-defined identifiers), or “traffic” type labels can lead to information getting exposed that users might not be comfortable sharing.

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

Register a pre-defined prometheus collector.

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

Gather all the metrics from the metrics registry for reporting.

See also prometheus::Registry::gather.

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

Gather all the metrics from the metrics registry that’s visible to third parties.

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.