Struct prometheus::PullingGauge

pub struct PullingGauge { /* private fields */ }

A Gauge that returns the value from a provided function on every collect run.

This metric is the equivalant of Go’s https://pkg.go.dev/github.com/prometheus/client_golang@v1.11.0/prometheus#GaugeFunc

Examples

let registry = Registry::new();
let gauge = PullingGauge::new(
    "available_parallelism",
    "The available parallelism, usually the numbers of logical cores.",
    Box::new(|| available_parallelism())
).unwrap();
registry.register(Box::new(gauge));

Implementations

impl PullingGauge

pub fn new<S1: Into<String>, S2: Into<String>>( name: S1, help: S2, value: Box<dyn Fn() -> f64 + Send + Sync> ) -> Result<Self>

Create a new PullingGauge.

Trait Implementations

impl Clone for PullingGauge

fn clone(&self) -> PullingGauge

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Collector for PullingGauge

fn desc(&self) -> Vec<&Desc>

Return descriptors for metrics.

fn collect(&self) -> Vec<MetricFamily>

Collect metrics.

impl Debug for PullingGauge

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

Formats the value using the given formatter.