Struct metriken::Gauge

pub struct Gauge(/* private fields */);

A gauge. Indicates the current value of some host parameter.

In case of overflow/underflow the gauge will wrap around. However, internally it uses a signed 64-bit integer so for most use cases this should be unlikely.

Example

#[metric(name = "my.gauge")]
static A_METHOD_RUNNING: Gauge = Gauge::new();

fn a_method() {
    A_METHOD_RUNNING.increment();
    // ...
    A_METHOD_RUNNING.decrement();
}

Implementations

impl Gauge

pub const fn new() -> Self

Create a new guage with the default value of 0.

pub const fn with_value(value: i64) -> Self

Create a new guage with the provided initial value.

pub fn increment(&self) -> i64

Increment the value of this gauge by 1.

Returns the old value of the gauge.

pub fn decrement(&self) -> i64

Decrement the value of this gauge by 1.

Returns the old value of the gauge.

pub fn add(&self, value: i64) -> i64

Increase the value of this gauge by value.

Returns the od value of the gauge.

pub fn sub(&self, value: i64) -> i64

Decrease the value of this gauge by value.

Returns the od value of the gauge.

pub fn value(&self) -> i64

pub fn set(&self, value: i64) -> i64

pub fn reset(&self) -> i64

Trait Implementations

impl Debug for Gauge

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

Formats the value using the given formatter.

impl Default for Gauge

fn default() -> Gauge

Returns the “default value” for a type.

impl Metric for Gauge

fn as_any(&self) -> Option<&dyn Any>

Get the current metric as an Any instance. This is meant to allow custom processing for known metric types.

fn value(&self) -> Option<Value<'_>>

Get the value of the current metric, should it be enabled.

fn is_enabled(&self) -> bool

Indicate whether this metric has been set up.