#prometheus-metrics #macro-derive #boilerplate #instantiation #write #storage #generate

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

#1304 in Rust patterns

Download history 112/week @ 2024-03-14 133/week @ 2024-03-21 269/week @ 2024-03-28 167/week @ 2024-04-04 109/week @ 2024-04-11 161/week @ 2024-04-18 158/week @ 2024-04-25 210/week @ 2024-05-02 181/week @ 2024-05-09 162/week @ 2024-05-16 107/week @ 2024-05-23 185/week @ 2024-05-30 237/week @ 2024-06-06 233/week @ 2024-06-13 204/week @ 2024-06-20 106/week @ 2024-06-27

819 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–9MB
~87K SLoC