fix: improve discoverability of partition_autobalancing_mode and redpanda_memory_allocated_memory#1656
Open
franrob-projects wants to merge 1 commit intoredpanda-data:mainfrom
Conversation
…anda_memory_allocated_memory Closes redpanda-data#1508 Closes redpanda-data#1503 partition_autobalancing_mode (cluster-balancing.adoc): - Added explicit [[partition_autobalancing_mode]] anchor to the Partition balancing settings section so the property is reachable by URL fragment and indexed by site search - Added rpk commands showing how to get and set the property - Clarified that node_add is the default without an enterprise license and continuous is the default with one redpanda_memory_allocated_memory (public-metrics-reference.adoc): - Expanded the entry to explain why the metric can appear high even without memory pressure (batch cache inclusion) - Clarified when to use this metric vs redpanda_memory_available_memory - Added example PromQL queries for per-shard and per-broker views
✅ Deploy Preview for redpanda-docs-preview ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
📝 WalkthroughWalkthroughThis pull request updates documentation across two AsciiDoc files to address gaps in searchability and clarity. The first change expands the Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@modules/reference/pages/public-metrics-reference.adoc`:
- Around line 892-900: The docs are inconsistent: update the monitoring page
text in monitor-health.adoc to match the new definition that
redpanda_memory_allocated_memory includes reclaimable batch cache memory; change
the wording where it currently states allocated memory excludes reclaimable
cache to instead state it includes reclaimable batch cache memory and update any
alerting guidance/examples to recommend using redpanda_memory_available_memory
for measuring actual free memory (and adjust any formulas that presumed
allocated excluded reclaimable memory).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: dd0fc0f5-38cb-489d-b45f-80331fe70480
📒 Files selected for processing (2)
modules/manage/pages/cluster-maintenance/cluster-balancing.adocmodules/reference/pages/public-metrics-reference.adoc
Comment on lines
+892
to
+900
| Total memory allocated (in bytes) per CPU shard. This includes all memory currently held by Redpanda on that shard, including memory in the batch cache that has been allocated but could be reclaimed. | ||
|
|
||
| *Type*: gauge | ||
|
|
||
| *Labels*: | ||
|
|
||
| * `shard` | ||
|
|
||
| *Usage*: This metric includes reclaimable memory from the batch cache. For monitoring memory pressure, consider using `redpanda_memory_available_memory` instead, which provides a more accurate picture of memory that can be immediately reallocated. | ||
| *Usage*: This metric counts all allocated memory, including reclaimable batch cache memory, so it may appear high even when the system is not under memory pressure. To monitor for memory exhaustion, use xref:reference:public-metrics-reference.adoc#redpanda_memory_available_memory[`redpanda_memory_available_memory`] instead, which deducts reclaimable memory and gives a more accurate view of how much memory is actually free. |
Contributor
There was a problem hiding this comment.
Inconsistent memory semantics across docs after this update
Line 892 now says redpanda_memory_allocated_memory includes reclaimable batch cache memory, but modules/manage/partials/monitor-health.adoc (lines 63-86) still states allocated memory does not include reclaimable cache memory. Please align that monitoring page to this new definition to avoid conflicting guidance for alerting formulas.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@modules/reference/pages/public-metrics-reference.adoc` around lines 892 -
900, The docs are inconsistent: update the monitoring page text in
monitor-health.adoc to match the new definition that
redpanda_memory_allocated_memory includes reclaimable batch cache memory; change
the wording where it currently states allocated memory excludes reclaimable
cache to instead state it includes reclaimable batch cache memory and update any
alerting guidance/examples to recommend using redpanda_memory_available_memory
for measuring actual free memory (and adjust any formulas that presumed
allocated excluded reclaimable memory).
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.
Summary
Addresses two issues where users reported finding no search results for configuration and metrics properties that are documented but not easily discoverable.
Closes #1508
Closes #1503
partition_autobalancing_mode (
cluster-balancing.adoc)The property was referenced only as an xref to the reference partial, with no anchor on the manage-side page itself. Users searching for
partition_autobalancing_modelanded nowhere actionable.Changes:
[[partition_autobalancing_mode]]anchor directly to the Partition balancing settings section, making it reachable by URL fragment and indexed by site searchrpk cluster config getandrpk cluster config setcommands so users know immediately how to inspect and change the valuenode_addwithout an enterprise license,continuouswith oneredpanda_memory_allocated_memory (
public-metrics-reference.adoc)The original entry was two sentences. Users trying to understand what this metric measures — particularly why it can read high without the system being under memory pressure — had no explanation.
Changes:
redpanda_memory_available_memoryChecks