Struct metrics_util::debugging::DebuggingRecorder

pub struct DebuggingRecorder { /* private fields */ }

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 per_thread() -> DebuggingRecorder

Creates a new DebuggingRecorder in per-thread mode.

This sends all metrics to a per-thread registry, such that the snapshotter will only see metrics emitted in the thread that the Snapshotter is used from. Additionally, as keeping a reference to the original Snapshotter around can be tricky, Snapshotter::current_thread_snapshot can be used to get all of the metrics currently present in the registry for the calling thread, if any were emitted.

Please note that this recorder must still be installed, but it can be installed multiple times (if the error from install is ignored) without clearing or removing any of the existing per-thread metrics, so it’s safe to re-create and re-install multiple times in the same test binary if necessary.

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 describe_counter(
    &self,
    key: KeyName,
    unit: Option<Unit>,
    description: SharedString
)

Describes a counter.

fn describe_gauge(
    &self,
    key: KeyName,
    unit: Option<Unit>,
    description: SharedString
)

Describes a gauge.

fn describe_histogram(
    &self,
    key: KeyName,
    unit: Option<Unit>,
    description: SharedString
)

Describes a histogram.

fn register_counter(&self, key: &Key) -> Counter

Registers a counter.

fn register_gauge(&self, key: &Key) -> Gauge

Registers a gauge.

fn register_histogram(&self, key: &Key) -> Histogram

Registers a histogram.