Struct metrics_prometheus::storage::Mutable

pub struct Mutable { /* private fields */ }

metrics::registry::Storage backed by a prometheus::Registry and allowing to change a help description of the registered prometheus metrics in runtime.

This metrics::registry::Storage is capable of registering metrics in its prometheus::Registry on the fly. By default, the prometheus::default_registry() is used.

Errors

This Mutable storage returns metric::Fallible in its metrics::registry::Storage interface, because it cannot panic, as is called inside metrics::Registry and, so, may poison its inner locks. That’s why possible errors are passed through up to the metrics::Recorder using this Mutable storage, and should be resolved there.

Implementations

impl Mutable

pub fn describe<M>(&self, name: &str, description: String)where
    M: Bundled,
    <M as Bundled>::Bundle: Clone,
    Self: GetCollection<<M as Bundled>::Bundle>,

Changes the help description of the prometheus Metric identified by its name.

Accepts only the following prometheus Metrics:

• prometheus::IntCounter, prometheus::IntCounterVec
• prometheus::Gauge, prometheus::GaugeVec
• prometheus::Histogram, prometheus::HistogramVec

Intended to be used in metrics::Recorder::describe_counter(), metrics::Recorder::describe_gauge() and metrics::Recorder::describe_histogram() implementations.

pub fn register_external<M>(&self, metric: M) -> Result<()>where
    M: Bundled + Collector,
    <M as Bundled>::Bundle: Collector + Clone + 'static,
    Self: GetCollection<<M as Bundled>::Bundle>,

Registers the provided prometheus metric in the underlying prometheus::Registry in the way making it usable via this metrics::registry::Storage (and, so, metrics crate interfaces).

Accepts only the following prometheus metrics:

• prometheus::IntCounter, prometheus::IntCounterVec
• prometheus::Gauge, prometheus::GaugeVec
• prometheus::Histogram, prometheus::HistogramVec

Errors

If the underlying prometheus::Registry fails to register the provided metric.

Trait Implementations

impl Clone for Mutable

fn clone(&self) -> Mutable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Mutable

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

Formats the value using the given formatter.

impl Default for Mutable

fn default() -> Self

Returns the “default value” for a type.

impl GetCollection<Either<GenericCounter<AtomicU64>, MetricVec<CounterVecBuilder<AtomicU64>>>> for Mutable

fn collection(&self) -> &Collection<PrometheusIntCounter>

Returns a Collection of Metrics stored in a Mutable storage.

impl GetCollection<Either<GenericGauge<AtomicF64>, MetricVec<GaugeVecBuilder<AtomicF64>>>> for Mutable

fn collection(&self) -> &Collection<PrometheusGauge>

Returns a Collection of Metrics stored in a Mutable storage.

impl GetCollection<Either<Histogram, MetricVec<HistogramVecBuilder>>> for Mutable

fn collection(&self) -> &Collection<PrometheusHistogram>

Returns a Collection of Metrics stored in a Mutable storage.

impl Storage<Key> for Mutable

type Counter = Fallible<GenericCounter<AtomicU64>>

The type used for counters.

type Gauge = Fallible<GenericGauge<AtomicF64>>

The type used for gauges.

type Histogram = Fallible<Histogram>

The type used for histograms.

fn counter(&self, key: &Key) -> Self::Counter

Creates an empty counter.

fn gauge(&self, key: &Key) -> Self::Gauge

Creates an empty gauge.

fn histogram(&self, key: &Key) -> Self::Histogram

Creates an empty histogram.