DOC-226: Document per-entity client quota metrics (26.2)#1779
Open
Feediver1 wants to merge 2 commits into
Open
DOC-226: Document per-entity client quota metrics (26.2)#1779Feediver1 wants to merge 2 commits into
Feediver1 wants to merge 2 commits into
Conversation
Adds a "Track quota use per entity" subsection to the Monitor client throughput section, documenting ENG-37 (redpanda PR #30832): - kafka_per_entity_quota_metrics cluster property (opt-in, no restart) - The two new per-entity counters on /public_metrics and /metrics - Entity/quota-type label scheme and cardinality bounding behavior - Utilization calculation guidance with a PromQL example Builds on the existing aggregate-metrics content rather than duplicating it. Gated to Self-Managed pending confirmation of Cloud support for the new cluster property. DRAFT-VERIFY comments mark items to confirm against a 26.2 build. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Intro now follows the situation / what-it-does / benefit / when-to-use formula instead of leading with the metrics mechanics. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Description
Documents the new per-entity client quota metrics shipping in v26.2 (ENG-37 "Metrics: Throughput Quota Utilization", implemented in redpanda#30832, merged to dev 2026-06-24). This answers the customer ask behind the epic: track how much of an enforced quota each client is actually using.
Resolves https://redpandadata.atlassian.net/browse/DOC-226
Review deadline:
What's new
One subsection,
Track quota use per entity, added to the existing "Monitor client throughput" section of manage-throughput.adoc:kafka_per_entity_quota_metricscluster property (opt-in, default false, no restart)/public_metricsand/metricsredpanda_quota_type+ user/client-id/group labels) and the cardinality-bounding behavior (series exist only while an entity is throttled; cleaned up after idle)rpk cluster quotas describeDeliberately NOT in this PR (anti-duplication)
The v24.2 client quota changes from the eng context doc (KIP-546/rpk cluster quotas, prefix quotas, per-broker semantics, deprecated cluster configs, the two aggregate histograms, and the
kafka_quotaslogger) are already documented — verified on beta in manage-throughput.adoc, about-throughput-quotas.adoc, both metrics references, and upgrade/deprecated. This PR only adds the 26.2 delta.Generated-content notes
/gen-metricsat 26.2 release — plain code spans used for now, with a DRAFT-VERIFY to convert to xrefs after regeneration (anchors don't exist yet)kafka_per_entity_quota_metricsarrives via/gen-propsat release — not hand-added/metrics) exposed names for the two counters against a 26.2 buildredpanda_quota_group_name= client-ID-prefix quotas (agent-inferred; confirm with @mnajda-redpanda)kafka_per_entity_quota_metrics— subsection isifndef::env-cloudgated until confirmedPage previews
Checks
🤖 Generated with Claude Code