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

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

#1394 in Rust patterns

Download history 123/week @ 2024-07-21 140/week @ 2024-07-28 225/week @ 2024-08-04 163/week @ 2024-08-11 267/week @ 2024-08-18 180/week @ 2024-08-25 322/week @ 2024-09-01 226/week @ 2024-09-08 175/week @ 2024-09-15 198/week @ 2024-09-22 280/week @ 2024-09-29 350/week @ 2024-10-06 241/week @ 2024-10-13 339/week @ 2024-10-20 340/week @ 2024-10-27 248/week @ 2024-11-03

1,194 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–8MB
~87K SLoC