Struct MetricsRegistry 

pub struct MetricsRegistry { /* private fields */ }

A lightweight, thread-safe metrics registry that can export its state in Prometheus text format.

Metrics are keyed by a full name that includes labels encoded as name{label1="val1",label2="val2"}. The helper methods counter_with_labels etc. build these keys automatically.

Implementations

impl MetricsRegistry

pub fn new() -> Self

Create a new empty registry.

pub fn register_counter(&self, name: &str, help: &str)

Register a counter with help text.

pub fn register_gauge(&self, name: &str, help: &str)

Register a gauge with help text.

pub fn register_histogram(&self, name: &str, help: &str)

Register a histogram with help text.

pub fn counter_inc(&self, key: &str)

Increment a counter by 1.

pub fn counter_add(&self, key: &str, n: u64)

Increment a counter by n.

pub fn counter_with_labels(&self, name: &str, labels: &[(&str, &str)])

Build a label-encoded key and increment the counter by 1.

pub fn counter_add_with_labels( &self, name: &str, labels: &[(&str, &str)], n: u64, )

Build a label-encoded key and add n to the counter.

pub fn counter_get(&self, key: &str) -> u64

Get the current value of a counter.

pub fn gauge_set(&self, key: &str, value: i64)

Set a gauge to an absolute value.

pub fn gauge_inc(&self, key: &str)

Increment a gauge by 1.

pub fn gauge_dec(&self, key: &str)

Decrement a gauge by 1.

pub fn gauge_add(&self, key: &str, delta: i64)

Add a signed value to a gauge.

pub fn gauge_get(&self, key: &str) -> i64

Get the current value of a gauge.

pub fn histogram_observe(&self, key: &str, value: f64)

Record a value in a histogram, creating it with default buckets if it does not yet exist.

pub fn histogram_observe_with_labels( &self, name: &str, labels: &[(&str, &str)], value: f64, )

Record a value in a histogram with labels.

pub fn histogram_get(&self, key: &str) -> Option<(Vec<(f64, u64)>, f64, u64)>

Get a histogram’s snapshot: (buckets, sum, count).

pub fn export_prometheus(&self) -> String

Export all metrics in Prometheus text exposition format.

Trait Implementations

impl Debug for MetricsRegistry

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

Formats the value using the given formatter.

impl Default for MetricsRegistry

fn default() -> Self

Returns the “default value” for a type.