prometheus / prometheus/client_rust
Support deriving metric storage
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 606
- Forks
- 113
- Avg merge
- 9h 7m
- Merged PRs (30d)
- 8
Description
It would be super useful to have derives for metrics storages, like was done for the prometheus crate (essentially porting https://crates.io/crates/prometheus-metric-storage).
#[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);
}
This would enable to not forget to register metrics that are in a struct into the registry.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by studying the referenced prometheus-metric-storage crate and the client_rust APIs used to define and register metrics. Compare its derive behavior with the shown Metrics example; done should include deriving storage for the struct fields, applying subsystem, label, and bucket attributes, and registering the metrics.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- prometheus, rust
- Domain
- observability-sre
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100