Skip to content

Remove references to max_series_per_query from docs #6889

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

Jump to bottom
Open
wants to merge 12 commits into
base: master
Choose a base branch
from
Open

Remove references to max_series_per_query from docs #6889

wants to merge 12 commits into from
+3,865 −303

Conversation

aclaygray
Copy link

What this PR does:

Updates documentation to remove reference to deprecated max-series-per-query that was removed here, but some of its documentation remained.

I found these during an investigation to why I received the following error when upgrading from 1.17.1 to 1.19.0:

error loading config from /etc/cortex/config.yaml: Error parsing config file: yaml: unmarshal errors:
  line 104: field max_series_per_query not found in type validation.plain

Figured it would save someone else some time if it were to pop up after copying over some existing examples from the docs.

Which issue(s) this PR fixes:
Fixes #

Checklist

  • Tests updated
  • Documentation added
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX]

yeya24
yeya24 approved these changes Jul 17, 2025
View reviewed changes
Copy link
Contributor

@yeya24 yeya24 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching this. Just some small comments. Maybe we can replace max_series_per_query to the new limit name and also remove max_samples_per_query

docs/configuration/arguments.md
@@ -316,11 +316,9 @@ overrides:
tenant1:
ingestion_rate: 10000
max_series_per_metric: 100000
max_series_per_query: 100000
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can probably change max_series_per_query to max_fetched_series_per_query as it is the new limit.

docs/configuration/arguments.md Outdated
@@ -316,11 +316,9 @@ overrides:
tenant1:
ingestion_rate: 10000
max_series_per_metric: 100000
max_series_per_query: 100000
tenant2:
max_samples_per_query: 1000000
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's also remove max_samples_per_query? It is removed as well

@friedrichg
Copy link
Member

@aclaygray thank you!. Do you mind also signing the DCO?

@pull-request-size pull-request-size bot added size/S and removed size/XS labels Aug 1, 2025
@aclaygray aclaygray force-pushed the RemoveMaxSeriesPerQueryReferences branch 2 times, most recently from aa7c67c to ee93cff Compare August 1, 2025 21:09
@aclaygray aclaygray requested a review from yeya24 August 4, 2025 14:02
@aclaygray
Copy link
Author

@yeya24 , @friedrichg , sorry took me a little while to get back to this.

I believe I have done all the required steps. Please let me know otherwise, thanks!

friedrichg
friedrichg reviewed Aug 7, 2025
View reviewed changes
docs/configuration/arguments.md
max_series_per_metric: 100000
max_series_per_query: 100000
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it should be max_fetched_series_per_query for consistency

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤦 , thanks for pointing this out.

docs/configuration/arguments.md
@@ -348,11 +346,8 @@ overrides:
tenant1:
ingestion_rate: 10000
max_series_per_metric: 100000
max_series_per_query: 100000
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

docs/configuration/arguments.md
max_series_per_metric: 100000
max_series_per_query: 100000
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

docs/guides/overrides-exporter-runtime.yaml
@@ -8,5 +8,3 @@ overrides:
max_global_series_per_user: 300000
max_series_per_metric: 0
max_series_per_user: 0
max_samples_per_query: 100000
max_series_per_query: 100000
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

docs/guides/overrides-exporter.md
@@ -36,8 +36,6 @@ overrides:
max_global_series_per_user: 300000
max_series_per_metric: 0
max_series_per_user: 0
max_samples_per_query: 100000
max_series_per_query: 100000
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

aclaygray and others added 12 commits August 7, 2025 16:18
@aclaygray
Remove references to max_series_per_query from docs
ed011fa 
Remove references to max_samples_per_query from docs

Signed-off-by: Andrew Gray <[email protected]>
@dependabot @aclaygray
Bump github/codeql-action in the actions-dependencies group (cortexpr…
0dd23e2 
…oject#6898)

---
updated-dependencies:
- dependency-name: github/codeql-action
  dependency-version: 3.29.3
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: actions-dependencies
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: Andrew Gray <[email protected]>
@SungJin1212 @aclaygray
OTLP: Add a AllowDeltaTemporality flag to ingest delta temporality me…
748d62f 
…tric (cortexproject#6934)

Signed-off-by: Andrew Gray <[email protected]>
@yeya24 @aclaygray
allow parquet converter for memberlist KV (cortexproject#6938)
4a4f8b3 
Signed-off-by: yeya24 <[email protected]>
Signed-off-by: Andrew Gray <[email protected]>
@CharlieTLe @aclaygray
Update roadmap.md (cortexproject#6939)
9eed914 
Fixing typo

Signed-off-by: Charlie Le <[email protected]>
Signed-off-by: Andrew Gray <[email protected]>
@CharlieTLe @aclaygray
Update parquet-mode.md (cortexproject#6943)
e012cbb 
k logs cortex-parquet-converter-0
error loading config from /etc/cortex/cortex.yaml: Error parsing config file: yaml: unmarshal errors:
  line 59: cannot unmarshal !!str `100MB` into int
  line 60: cannot unmarshal !!str `1GB` into int

Signed-off-by: Charlie Le <[email protected]>
Signed-off-by: Andrew Gray <[email protected]>
@rubywtl @aclaygray
allow queriers to execute from logical query plans (cortexproject#6929)
7971f3c 
Signed-off-by: rubywtl <[email protected]>
Signed-off-by: Andrew Gray <[email protected]>
@yeya24 @aclaygray
Upgrade parquet common and expose parquet labels cache config (cortex…
43a8841 
…project#6937)

* update parquet common and expose parquet labels cache config

Signed-off-by: yeya24 <[email protected]>

* update docs

Signed-off-by: Ben Ye <[email protected]>

---------

Signed-off-by: yeya24 <[email protected]>
Signed-off-by: Ben Ye <[email protected]>
Signed-off-by: Andrew Gray <[email protected]>
@erlan-z @aclaygray
Blog: Query Rejection (cortexproject#6944)
5cfdb66 
Signed-off-by: Erlan Zholdubai uulu <[email protected]>
Signed-off-by: Andrew Gray <[email protected]>
@SungJin1212 @aclaygray
Change prometheus image of TestNativeHistogramFuzz (cortexproject#6942)
9b42e39 
* Change prometheus image of TestNativeHistogramFuzz

Signed-off-by: SungJin1212 <[email protected]>

* Add prometheus v3.5.0 to preload image

Signed-off-by: SungJin1212 <[email protected]>

* Delete unused prometheus images

Signed-off-by: SungJin1212 <[email protected]>

---------

Signed-off-by: SungJin1212 <[email protected]>
Signed-off-by: Andrew Gray <[email protected]>
@SungJin1212 @aclaygray
Support remote write v2 by converting request (cortexproject#6330)
78f4e84 
* Support remote write v2 by converting request

Signed-off-by: SungJin1212 <[email protected]>

* Change to not break exist behavior

Signed-off-by: SungJin1212 <[email protected]>

* Add benchmarks

Signed-off-by: SungJin1212 <[email protected]>

* rebase from stream connection

Signed-off-by: SungJin1212 <[email protected]>

* Change to expose header at Distributor side

Signed-off-by: SungJin1212 <[email protected]>

* get rebase

Signed-off-by: SungJin1212 <[email protected]>

* Change distributor.remote-write2-enabled naming

Signed-off-by: SungJin1212 <[email protected]>

---------

Signed-off-by: SungJin1212 <[email protected]>
Signed-off-by: Andrew Gray <[email protected]>
@aclaygray
PR feedback: Add max_fetched_series_per_query properly to examples
5b647dc 
Signed-off-by: Andrew Gray <[email protected]>
@aclaygray aclaygray force-pushed the RemoveMaxSeriesPerQueryReferences branch from 627a189 to 5b647dc Compare August 7, 2025 21:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@friedrichg friedrichg friedrichg left review comments

@yeya24 yeya24 Awaiting requested review from yeya24

Assignees
No one assigned
Labels
component/documentation size/XXL
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@aclaygray @friedrichg @yeya24 @SungJin1212 @CharlieTLe @rubywtl @erlan-z