Struct REGISTRY

pub struct REGISTRY { /* private fields */ }

Global Prometheus registry.

This registry holds all metrics defined in this module and is used to gather metrics for exposure via the metrics endpoint.

Methods from Deref<Target = Registry>

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

register registers a new [Collector] to be included in metrics collection. It returns an error if the descriptors provided by the [Collector] are invalid or if they — in combination with descriptors of already registered Collectors — do not fulfill the consistency and uniqueness criteria described in the documentation of Desc.

If the provided [Collector] is equal to a [Collector] already registered (which includes the case of re-registering the same [Collector]), the AlreadyReg error returns.

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

unregister unregisters the [Collector] that equals the [Collector] passed in as an argument. (Two Collectors are considered equal if their Describe method yields the same set of descriptors.) The function returns error when the [Collector] is not registered.

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

gather calls the Collect method of the registered Collectors and then gathers the collected metrics into a lexicographically sorted slice of MetricFamily protobufs.

Trait Implementations

impl Deref for REGISTRY

type Target = Registry

The resulting type after dereferencing.

fn deref(&self) -> &Registry

Dereferences the value.

impl LazyStatic for REGISTRY