feat(ingester): Add active series tracker for pattern-based monitoring#7476
Open
yeya24 wants to merge 1 commit intocortexproject:masterfrom
Open
feat(ingester): Add active series tracker for pattern-based monitoring#7476yeya24 wants to merge 1 commit intocortexproject:masterfrom
yeya24 wants to merge 1 commit intocortexproject:masterfrom
Conversation
dosubot
Bot
added
component/ingester
type/feature
type/observability
yeya24
force-pushed
the
feat/active-series-tracker
branch
4 times, most recently
from
c3dae35 to
48fbe69
Compare
friedrichg
reviewed
May 5, 2026
| "default": [], | ||
| "description": "List of active series tracker configurations. Each tracker counts active series matching its matchers and exposes the count as a metric.", | ||
| "items": { | ||
| "type": "string" |
Member
There was a problem hiding this comment.
Suggested change
| "type": "string" | |
| "$ref": "#/definitions/ActiveSeriesTrackerConfig" |
Contributor
Author
There was a problem hiding this comment.
I would not modify the schema by hand. This is what's generated from the build. We need to support it in the schema generator instead
yeya24
force-pushed
the
feat/active-series-tracker
branch
3 times, most recently
from
7d8668b to
a55cd3e
Compare
SungJin1212
reviewed
May 6, 2026
Comment on lines
+32
to
+62
| func (tc *trackerCounter) updateConfig(ctx context.Context, db *tsdb.DB, trackers validation.ActiveSeriesTrackersConfig) { | ||
| tc.mu.Lock() | ||
| defer tc.mu.Unlock() | ||
|
|
||
| newMatchers := make(map[string][]*labels.Matcher, len(trackers)) | ||
| for i := range trackers { | ||
| newMatchers[trackers[i].Name] = trackers[i].ParsedMatchers() | ||
| } | ||
|
|
||
| if trackerMatchersEqual(tc.matchers, newMatchers) { | ||
| return | ||
| } | ||
|
|
||
| // Config changed — backfill counts from TSDB head. | ||
| tc.matchers = newMatchers | ||
| tc.counts = make(map[string]int, len(newMatchers)) | ||
|
|
||
| if db == nil || len(newMatchers) == 0 { | ||
| return | ||
| } | ||
|
|
||
| ir, err := db.Head().Index() | ||
| if err != nil { | ||
| return | ||
| } | ||
| defer ir.Close() | ||
|
|
||
| all, err := ir.Postings(ctx, "", "") | ||
| if err != nil { | ||
| return | ||
| } |
Member
There was a problem hiding this comment.
Overall, LGTM.
I have one question.
We need to scan the entire TSDB head index while holding the lock. Is it fine in high cardinality environments, considering we also need to acquire this lock every time a new series is created?
Contributor
Author
There was a problem hiding this comment.
This is a good catch and definitely needs to be fixed. We should never scan all postings. I will fix in next commit.
But updateConfig is a single thread async process. We don't need to scan head index for every new series
Add a new active series tracker feature that counts active series by
configurable label matchers (including regex) and exposes the counts as
Prometheus metrics. This is designed for internal monitoring without
enforcing any limits.
Key changes:
- Add ActiveSeriesTrackersConfig type in validation package with PromQL
matcher syntax support
- Add ActiveSeriesTrackers field to Limits struct for per-tenant config
with default fallback
- Add ActiveForMatchers() method to ActiveSeries for counting matching
series across all stripes
- Add cortex_ingester_active_series_per_tracker gauge metric
- Integrate into updateActiveSeries() periodic tick
- Matchers are validated and compiled during config unmarshalling
- Runtime hot-reloadable via existing runtime config overrides
Configuration example:
overrides:
tenant-123:
active_series_trackers:
- name: api_metrics
matchers: '{__name__=~"api_.*"}'
Metric emitted:
cortex_ingester_active_series_per_tracker{user="tenant", name="api_metrics"} 42
Signed-off-by: Ben Ye <benye@amazon.com>
yeya24
force-pushed
the
feat/active-series-tracker
branch
from
a55cd3e to
9b57f52
Compare
SungJin1212
approved these changes
May 6, 2026
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
3 participants
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.
Add a new active series tracker feature that counts active series by configurable label matchers (including regex) and exposes the counts as Prometheus metrics. This is designed for internal monitoring without enforcing any limits.
Key changes:
Configuration example:
Metric emitted:
What this PR does:
Which issue(s) this PR fixes:
Fixes #
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX]docs/configuration/v1-guarantees.mdupdated if this PR introduces experimental flags