prometheus / prometheus/client_rust
Public encoding functions?
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 606
- Forks
- 113
- Avg merge
- 9h 7m
- Merged PRs (30d)
- 8
Description
Sometimes I have already e.g. nodes: Vec<Node> in the application state where Node is like
struct Node {
url: String,
requests: AtomicU64,
}
(When you are already working with a &Node, bumping the requests counter is just an atomic inc. It's much more efficient than get_or_create(...).inc().)
And I'd like to expose the requests counter of all nodes as a metric family. It might be possible with the collector API, but it would still require quite some boxing, cloning and iterator mapping.
Instead I'd like to encode the metrics myself, e.g.:
encode_descriptor(&mut buf, ...);
for n in &ctx.nodes {
encode_counter_with_labels(&mut buf, [("node", &n.url)], n.requests.load(...));
}
encode_eof(&mut buf);
This will not require any extra allocation or cloning. By fusing the collecting and encoding phase, metrics can be encoded very efficiently.
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 reviewing the collector API and the existing metric encoding paths. Determine how public descriptor, labeled-counter, and end-of-output functions could support collecting and encoding in one pass without the allocations described in the issue. Done means the proposed public API is defined and its behavior is covered by the relevant tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- observability
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100