Trait polkadot_node_subsystem_util::metrics::Metrics

pub trait Metrics: Default + Clone {
    // Required method
    fn try_register(registry: &Registry) -> Result<Self, Error>;

    // Provided method
    fn register(registry: Option<&Registry>) -> Result<Self, Error> { ... }
}

Subsystem- or job-specific Prometheus metrics.

Usually implemented as a wrapper for Option<ActualMetrics> to ensure Default bounds or as a dummy type (). Prometheus metrics internally hold an Arc reference, so cloning them is fine.

Required Methods

fn try_register(registry: &Registry) -> Result<Self, Error>

Try to register metrics in the Prometheus registry.

Provided Methods

fn register(registry: Option<&Registry>) -> Result<Self, Error>

Convenience method to register metrics in the optional Prometheus registry.

If no registry is provided, returns Default::default(). Otherwise, returns the same thing that try_register does.

Object Safety

This trait is not object safe.

Implementations on Foreign Types

impl Metrics for ()

fn try_register(_registry: &Registry) -> Result<(), Error>

impl Metrics for Metrics

fn try_register(registry: &Registry) -> Result<Metrics, Error>

Implementors