Add opt-in Vec TTL via MetricVec and TTLRegistry#1989
Open
jpinsonneau wants to merge 4 commits into
Open
Conversation
9ca0d4c to
530bbbe
Compare
Introduce NewMetricVecWithTTL and per-child lastAccessed tracking so stale label sets can be omitted from Collect and removed with CleanupExpired. Store vec children as pointers to satisfy atomic copying rules. Keep default NewCounterVec/NewGaugeVec/NewHistogramVec on NewMetricVec without TTL for backwards compatibility. Opt-in TTLRegistry wraps a dedicated Registry, exposes New*Vec constructors with a fixed ttl, and runs CleanupExpired before each Gather. Relates to prometheus#1983 Signed-off-by: Julien Pinsonneau <jpinsonn@redhat.com> Made-with: Cursor
530bbbe to
384151c
Compare
This was referenced Apr 23, 2026
kakkoyun
reviewed
May 19, 2026
Member
kakkoyun
left a comment
There was a problem hiding this comment.
Thanks for the PR. This is close to the finish line.
Please see my comments.
Move TTL logic to ttlMetricMap so metricMap stays unchanged for default Vecs. Wrap TTL tests with synctest instead of real sleeps. Signed-off-by: Julien Pinsonneau <jpinsonn@redhat.com> Made-with: Cursor
There was a problem hiding this comment.
Pull request overview
This PR introduces an opt-in TTL mechanism for *Vec metrics to automatically omit and optionally delete stale label sets, aimed at reducing unbounded growth for high-cardinality / ephemeral labels while preserving backwards compatibility for existing New*Vec constructors.
Changes:
- Add
NewMetricVecWithTTLplusCleanupExpiredand per-childlastAccessedtracking to support TTL-based expiration. - Add
TTLRegistry, a dedicated registry withNew*Vecconstructors that enable TTL and runCleanupExpiredbefore eachGather. - Refactor
CounterVec,GaugeVec, andHistogramVecconstructors to share internalnew*VecWithTTLhelpers, and add test coverage for TTL behavior.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| prometheus/vec.go | Adds TTL-enabled MetricVec construction, routes core vec operations through TTL map when enabled, and exposes CleanupExpired. |
| prometheus/ttl_vec.go | Implements TTL-backed metric storage with per-child lastAccessed, TTL-aware Collect, and cleanupExpired. |
| prometheus/ttl_registry.go | Introduces TTLRegistry that auto-registers TTL vecs and runs cleanup before Gather. |
| prometheus/counter.go | Refactors vec creation into newCounterVecWithTTL and wires TTL registry support. |
| prometheus/gauge.go | Refactors vec creation into newGaugeVecWithTTL and wires TTL registry support. |
| prometheus/histogram.go | Refactors vec creation into newHistogramVecWithTTL and wires TTL registry support. |
| prometheus/vec_test.go | Adds TTL behavior tests for Counter/Gauge/Histogram vecs and helper for counting collected metrics. |
| prometheus/ttl_registry_test.go | Adds tests ensuring NewTTLRegistry validation and that Gather triggers cleanup. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Handle ttl<=0 in NewMetricVecWithTTL, nil slice tails in cleanupExpired for GC, and untrack Vecs on TTLRegistry.Unregister. Signed-off-by: Julien Pinsonneau <jpinsonn@redhat.com> Made-with: Cursor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Introduce NewMetricVecWithTTL and per-child lastAccessed tracking so
stale label sets can be omitted from Collect and removed with
CleanupExpired. Store vec children as pointers to satisfy atomic
copying rules.
Keep default NewCounterVec/NewGaugeVec/NewHistogramVec on NewMetricVec
without TTL for backwards compatibility. Opt-in TTLRegistry wraps a
dedicated Registry, exposes New*Vec constructors with a fixed ttl, and
runs CleanupExpired before each Gather.
Relates to #1983
Signed-off-by: Julien Pinsonneau jpinsonn@redhat.com
Made-with: Cursor