#prometheus #metric #storage #metrics #derive #macro #bit #prometheus-metrics #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
Download history 64/week @ 2022-06-03 17/week @ 2022-06-10 30/week @ 2022-06-17 23/week @ 2022-06-24 32/week @ 2022-07-01 35/week @ 2022-07-08 34/week @ 2022-07-15 31/week @ 2022-07-22 31/week @ 2022-07-29 39/week @ 2022-08-05 35/week @ 2022-08-12 32/week @ 2022-08-19 35/week @ 2022-08-26 34/week @ 2022-09-02 47/week @ 2022-09-09 22/week @ 2022-09-16

150 downloads per month
Used in websocat

MIT license

26KB
185 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

~1.1–6.5MB
~111K SLoC