Struct metrics_util::DebuggingRecorder

pub struct DebuggingRecorder { /* fields omitted */ }

A simplistic recorder that can be installed and used for debugging or testing.

Callers can easily take snapshots of the metrics at any given time and get access to the raw values.

Implementations

impl DebuggingRecorder

pub fn new() -> DebuggingRecorder

Creates a new DebuggingRecorder.

pub fn with_ordering(ordered: bool) -> Self

Creates a new DebuggingRecorder with ordering enabled or disabled.

When ordering is enabled, any snapshotter derived from this recorder will iterate the collected metrics in order of when the metric was first observed. If ordering is disabled, then the iteration order is undefined.

pub fn snapshotter(&self) -> Snapshotter

Gets a Snapshotter attached to this recorder.

pub fn install(self) -> Result<(), SetRecorderError>

Installs this recorder as the global recorder.

Trait Implementations

impl Default for DebuggingRecorder

fn default() -> Self

Returns the “default value” for a type.

impl Recorder for DebuggingRecorder

fn register_counter(
    &self,
    key: &Key,
    unit: Option<Unit>,
    description: Option<&'static str>
)

Registers a counter.

fn register_gauge(
    &self,
    key: &Key,
    unit: Option<Unit>,
    description: Option<&'static str>
)

Registers a gauge.

fn register_histogram(
    &self,
    key: &Key,
    unit: Option<Unit>,
    description: Option<&'static str>
)

Registers a histogram.

fn increment_counter(&self, key: &Key, value: u64)

Increments a counter.

fn update_gauge(&self, key: &Key, value: GaugeValue)

Updates a gauge.

fn record_histogram(&self, key: &Key, value: f64)

Records a histogram.