Struct Registry 

pub struct Registry { /* private fields */ }

Wraps prometheus::Registry with an embedded Filter so that register_*_with_registry! macros can decide at construction time whether a metric should be active.

Metrics registered through the wrapper macros are recorded with their module path and level, so Registry::gather can apply the filter’s exposure directives to them.

Implementations

impl Registry

pub fn new() -> Self

Creates a registry whose filter is resolved from the METRICS_FILTER env var (permissive when unset).

pub fn new_custom( prefix: Option<String>, labels: Option<HashMap<String, String>>, filter: Option<Arc<Filter>>, ) -> Result<Self>

Creates a custom-prefixed registry.

pub fn filter(&self) -> Arc<Filter>

Returns the registry’s filter, so related registries can be built to share it via Registry::new_custom.

pub fn record(&self, name: &str, module: &str, level: MetricLevel)

Used by the wrapper macros: records a registering metric’s module path and level, so Registry::gather can apply the filter’s exposure directives to it.

pub fn inner(&self) -> &Registry

Returns the underlying prometheus::Registry for use inside wrapper macros.

pub fn register(&self, c: Box<dyn Collector>) -> Result<()>

pub fn unregister(&self, c: Box<dyn Collector>) -> Result<()>

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

Gathers the registry’s metric families, dropping those disabled by the filter’s exposure directives. Families not registered through the wrapper macros (e.g. direct collectors) always pass through.

Trait Implementations

impl Clone for Registry

fn clone(&self) -> Registry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Registry

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

Formats the value using the given formatter.

impl Default for Registry

fn default() -> Self

Returns the “default value” for a type.