Struct GaugeGuard 

pub struct GaugeGuard<G: GenericGauge>(/* private fields */);

Available on (crate features logging or metrics or telemetry or tracing) and crate feature metrics only.

Increments a gauge metric when created, and decrements it when dropped.

Example

use rustfoundry::telemetry::metrics::{metrics, Gauge, GaugeGuard};

#[metrics]
pub mod my_app_metrics {
    /// Number of clients currently connected
    pub fn client_connections_active() -> Gauge;
}

fn usage() {
    let client_metric = GaugeGuard::new(my_app_metrics::client_connections_active());
    // Do some work where you want the metric to remain incremented.
    // When it leaves scope, the metric will be decremented.
    // Alternatively, move ownership to another scope to change the lifetime...
    tokio::spawn(async move {
        // Do some work with arbitrary lifetime on another thread.
        // Manually drop to force `client_metric` ownership to this async task.
        drop(client_metric);
    });
}

Implementations

impl<G: GenericGauge> GaugeGuard<G>

pub fn new(gauge: G) -> Self

Creates a new GaugeGuard to increment the Gauge metric and automatically decrement it when dropped.

Trait Implementations

impl<G: GenericGauge> Drop for GaugeGuard<G>

fn drop(&mut self)

Executes the destructor for this type.