#macro-derive #instantiation #boilerplate #storage #generate #write #register

prometheus-metric-storage

Derive macro to instantiate and register prometheus metrics without having to write tons of boilerplate code

6 releases (breaking)

0.5.0 May 10, 2022
0.4.0 Oct 6, 2021
0.3.0 Sep 14, 2021
0.2.0 Sep 8, 2021
0.1.1 Sep 7, 2021

#1673 in Rust patterns

Download history 236/week @ 2024-11-17 268/week @ 2024-11-24 254/week @ 2024-12-01 275/week @ 2024-12-08 325/week @ 2024-12-15 120/week @ 2024-12-22 257/week @ 2024-12-29 301/week @ 2025-01-05 247/week @ 2025-01-12 359/week @ 2025-01-19 311/week @ 2025-01-26 307/week @ 2025-02-02 400/week @ 2025-02-09 289/week @ 2025-02-16 399/week @ 2025-02-23 435/week @ 2025-03-02

1,546 downloads per month
Used in 2 crates

MIT license

28KB
216 lines

Prometheus metric storage

tests



When instrumenting code with prometheus metrics, one is required to write quite a bit of boilerplate code.

This crate will generate most of said boilerplate for you:

#[derive(prometheus_metric_storage::MetricStorage)]
#[metric(subsystem = "transport", labels("endpoint"))]
struct Metrics {
    /// Number of requests that are currently inflight.
    inflight: prometheus::IntGauge,

    /// Number of finished requests by response code.
    #[metric(labels("status"))]
    requests_finished: prometheus::IntCounterVec,

    /// Number of finished requests by total processing duration.
    #[metric(buckets(0.1, 0.2, 0.5, 1, 2, 4, 8))]
    requests_duration_seconds: prometheus::Histogram,
}

fn main() {
    let metrics = Metrics::new(
        prometheus::default_registry(),
        /* endpoint = */ "0.0.0.0:8080"
    ).unwrap();

    metrics.inflight.inc();
    metrics.requests_finished.with_label_values(&["200"]).inc();
    metrics.requests_duration_seconds.observe(0.015);
}

Dependencies

~3.5–8.5MB
~92K SLoC