metriken-derive

Crates.iometriken-derive
lib.rsmetriken-derive
version0.4.1
sourcesrc
created_at2023-01-17 21:53:21.52131
updated_at2024-01-18 19:28:08.566574
descriptionProc macros for metriken
homepagehttps://github.com/pelikan-io/rustcommon
repositoryhttps://github.com/pelikan-io/rustcommon
max_upload_size
id761323
size14,844
Brian Martin (brayniac)

documentation

README

metriken

Easily registered distributed metrics.

metriken allows you to easily declare static metrics throughout your codebase. Then, when you want to expose those metrics, you can access them all in one place.

use metriken::{metric, Counter, Gauge, Value};

/// A counter metric named "<crate name>::COUNTER"
#[metric]
static COUNTER: Counter = Counter::new();

/// A gauge metric named "my.metric"
#[metric(name = "my.metric")]
static GAUGE: Gauge = Gauge::new();

fn main() {
    COUNTER.increment();

    for metric in &metriken::metrics() {
        let name = metric.name();

        match metric.value() {
            Some(Value::Counter(val)) => println!("{name}: {val}"),
            Some(Value::Gauge(val)) => println!("{name}: {val}"),
            _ => println!("{name}: <custom>")
        }
    }
}

Code updating the metrics can always access them without needing to go through any indirections. (It just means accessing a static!). Using linkme, the metrics are all gathered into a single global array that can then be used to read all of them and expose them.

Commit count: 218

cargo fmt