Type Alias Gauge

pub type Gauge = GenericGauge<AtomicF64>;

A [Metric] represents a single numerical value that can arbitrarily go up and down.

Aliased Type

struct Gauge { /* private fields */ }

Implementations

impl<P> GenericGauge<P>

where P: Atomic,

pub fn new<S1, S2>(name: S1, help: S2) -> Result<GenericGauge<P>, Error>

where S1: Into<String>, S2: Into<String>,

Create a [GenericGauge] with the name and help arguments.

pub fn with_opts(opts: Opts) -> Result<GenericGauge<P>, Error>

Create a [GenericGauge] with the opts options.

pub fn set(&self, v: <P as Atomic>::T)

Set the gauge to an arbitrary value.

pub fn inc(&self)

Increase the gauge by 1.

pub fn dec(&self)

Decrease the gauge by 1.

pub fn add(&self, v: <P as Atomic>::T)

Add the given value to the gauge. (The value can be negative, resulting in a decrement of the gauge.)

pub fn sub(&self, v: <P as Atomic>::T)

Subtract the given value from the gauge. (The value can be negative, resulting in an increment of the gauge.)

pub fn get(&self) -> <P as Atomic>::T

Return the gauge value.

Trait Implementations

impl<P> Clone for GenericGauge<P>

where P: Atomic,

fn clone(&self) -> GenericGauge<P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P> Collector for GenericGauge<P>

where P: Atomic,

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

Return descriptors for metrics.

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

Collect metrics.

impl<P> Debug for GenericGauge<P>

where P: Debug + Atomic,

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

Formats the value using the given formatter.

impl<P> Metric for GenericGauge<P>

where P: Atomic,

fn metric(&self) -> Metric

Return the protocol Metric.