prometheus / prometheus/client_rust

Provide a way to prevent unbounded metric growth

Open
#197 8 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
606
Forks
113
Avg merge
9h 7m
Merged PRs (30d)
8

Description

We are interested in a mechanism to control unbounded growth of metrics. While we generally follow best practices around limiting cardinality, for extreme long lived processes this is still problematic. For instance, its common to record the binary version of something in a metric, but with 100s of rollouts over days or months, these can explode in time series if the metrics collection is never restarted.

We would like some way to control this in our application.


Currently, there is a a .clear() and .remove(). These are good building blocks, but I am not sure they are sufficient on their own.

remove() is challenging on its own because we don't have any way to understand the entire set of labels stored in the metric at any point. In theory you could use EncodeMetric::encode and parse the results, but that is quite hacky.

clear() is also challenging, because it is all or nothing.


Ideally, I think we would have some interface like:

family.retain_if(|(labelset, metric)| {
 Instant::now().duration_since(metric.last_write()) < Duration::from_secs(3600)
})  

(remove any metrics not modified for an hour)

This would require a method on the family, but also maybe some changes on the metric type as well to make this easier to encode.

In https://github.com/prometheus/client_rust/pull/196 I have put up a small draft of what this could look like, but very open to alternatives

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing family.clear() and family.remove() behavior, then inspect EncodeMetric::encode and the draft in PR #196. Define and agree on the retention API and metric access needed to remove entries by last_write without requiring callers to parse encoded output; done means the chosen approach controls stale metric growth.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
observability-sre
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.