Add metrics for number of series queried by yeya24 · Pull Request #7173 · cortexproject/cortex · GitHub
Skip to content

Add metrics for number of series queried #7173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yeya24 merged 4 commits into from
Dec 23, 2025
Merged

Add metrics for number of series queried #7173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9c92423
Add metrics for active series queried
yeya24 Dec 23, 2025
b7b05dc
lint
yeya24 Dec 23, 2025
25ab015
lint
yeya24 Dec 23, 2025
971f4f5
address comments
yeya24 Dec 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
24 changes: 24 additions & 0 deletions docs/configuration/config-file-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3702,6 +3702,30 @@ lifecycler:
# CLI flag: -ingester.active-series-metrics-idle-timeout
[active_series_metrics_idle_timeout: <duration> | default = 10m]

# Enable tracking of active queried series using probabilistic data structure
# and export them as metrics.
# CLI flag: -ingester.active-queried-series-metrics-enabled
[active_queried_series_metrics_enabled: <boolean> | default = false]

# How often to update active queried series metrics.
# CLI flag: -ingester.active-queried-series-metrics-update-period
[active_queried_series_metrics_update_period: <duration> | default = 1m]

# Duration of each sub-window for active queried series tracking (e.g., 1
# minute). Used to divide the total tracking period into smaller windows.
# CLI flag: -ingester.active-queried-series-metrics-window-duration
[active_queried_series_metrics_window_duration: <duration> | default = 15m]

# Sampling rate for active queried series tracking (1.0 = 100% sampling, 0.1 =
# 10% sampling). By default, all queries are sampled.
# CLI flag: -ingester.active-queried-series-metrics-sample-rate
[active_queried_series_metrics_sample_rate: <float> | default = 1]

# Time windows to expose queried series metric. Each window tracks queried
# series within that time period.
# CLI flag: -ingester.active-queried-series-metrics-windows
[active_queried_series_metrics_windows: <list of duration> | default = 2h0m0s]

# Enable uploading compacted blocks.
# CLI flag: -ingester.upload-compacted-blocks-enabled
[upload_compacted_blocks_enabled: <boolean> | default = true]
Expand Down
6 changes: 6 additions & 0 deletions docs/configuration/v1-guarantees.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,3 +133,9 @@ Currently experimental features are:
- Distributor/Ingester: Stream push connection
- Enable stream push connection between distributor and ingester by setting `-distributor.use-stream-push=true` on Distributor.
- Add `__type__` and `__unit__` labels to OTLP and remote write v2 requests (`-distributor.enable-type-and-unit-labels`)
- Ingester: Series Queried Metric
- Enable on Ingester via `-ingester.active-queried-series-metrics-enabled=true`
- Set the time window to expose via metrics using `-ingester.active-queried-series-metrics-windows=2h`. At least 1 time window is required to expose the metric.
- `-ingester.active-queried-series-metrics-update-period` metric update interval
- `-ingester.active-queried-series-metrics-window-duration` each HyperLogLog time window size
- `-ingester.active-queried-series-metrics-sample-rate` query sampling rate
2 changes: 2 additions & 0 deletions go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ require (
github.com/aws/aws-sdk-go-v2 v1.39.2
github.com/aws/aws-sdk-go-v2/config v1.31.12
github.com/aws/aws-sdk-go-v2/service/dynamodb v1.50.1
github.com/axiomhq/hyperloglog v0.2.6
github.com/bboreham/go-loser v0.0.0-20230920113527-fcc2c21820a3
github.com/cespare/xxhash/v2 v2.3.0
github.com/go-openapi/swag/jsonutils v0.25.1
Expand Down Expand Up @@ -202,6 +203,7 @@ require (
github.com/jessevdk/go-flags v1.6.1 // indirect
github.com/jpillora/backoff v1.0.0 // indirect
github.com/julienschmidt/httprouter v1.3.0 // indirect
github.com/kamstrup/intmap v0.5.2 // indirect
github.com/klauspost/cpuid/v2 v2.2.10 // indirect
github.com/knadh/koanf/maps v0.1.2 // indirect
github.com/knadh/koanf/providers/confmap v1.0.0 // indirect
Expand Down
4 changes: 4 additions & 0 deletions go.sum
View file
Open in desktop
Loading
Loading