docs: add rate limiting guide#7659
Open
CharlieTLe wants to merge 2 commits into
Open
Conversation
Add a new guide explaining the write-path rate limiters: the per-tenant token bucket (ingestion_rate / ingestion_burst_size) including the local vs. global strategy, the separate native histogram limiter, and the per-instance distributor and ingester caps. Covers configuration, error responses, and relevant metrics. Also cross-link to the new guide from the per-tenant limits section in docs/configuration/arguments.md. Signed-off-by: Charlie Le <charlie_le@apple.com>
SungJin1212
reviewed
Jul 1, 2026
Co-authored-by: SungJin1212 <tjdwls1201@gmail.com> Signed-off-by: Charlie Le <charlie_le@apple.com>
krunaljain
approved these changes
Jul 1, 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
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.
Summary
Adds a new guide at
docs/guides/rate-limiting.mddocumenting the write-path rate limiters, which were previously only partially documented indocs/configuration/arguments.mdand the auto-generated config reference.The new page covers:
totalNcounts (samples + exemplars + metadata), and the 10s recheck for runtime overrides.localvsglobalstrategy — including the load-balancing assumption and the fact thatingestion_burst_sizeis not divided byNunder the global strategy.-distributor.instance-limits.max-ingestion-rateand-ingester.instance-limits.max-ingestion-rate(EWMA-based, HTTP 503 / gRPC error).retry_on_http_429behavior, and the relevantcortex_distributor_*,cortex_discarded_*, andcortex_overridesmetrics.Also adds a cross-link to the new guide from the per-tenant limits section in
docs/configuration/arguments.md.Docs-only change — no CHANGELOG entry.
Test plan
arguments.mdresolves../overrides.md,./overrides-exporter.md,../configuration/arguments.md.