Struct Registry

pub struct Registry { /* private fields */ }

A struct for registering Prometheus collectors, collecting their metrics, and gathering them into MetricFamilies for exposition.

Implementations

impl Registry

pub fn new() -> Registry

new creates a Registry.

pub fn new_custom( prefix: Option<String>, labels: Option<HashMap<String, String>>, ) -> Result<Registry, Error>

Create a new registry, with optional custom prefix and labels.

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 Clone for Registry

fn clone(&self) -> Registry

Returns a copy 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<(), Error>

Formats the value using the given formatter.

impl Default for Registry

fn default() -> Registry

Returns the “default value” for a type.