docs: add clarification about memory usage #1237
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthroughThe changes update documentation related to memory monitoring in Redpanda. The previous guidance, which focused on allocated and free memory, is replaced with a recommendation to use the Sequence Diagram(s)sequenceDiagram
participant User
participant Documentation
participant Monitoring System
User->>Documentation: Refer to memory monitoring section
Documentation->>User: Recommend using redpanda_memory_available_memory
User->>Monitoring System: Query redpanda_memory_available_memory
Monitoring System-->>User: Return available memory data
User->>Documentation: Refer to PromQL queries for memory pressure
Documentation->>User: Provide queries for available memory and pressure
User->>Monitoring System: Query redpanda_memory_available_memory_low_water_mark
Monitoring System-->>User: Return historical low water mark data
Estimated code review effort🎯 2 (Simple) | ⏱️ ~7 minutes Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
❌ Deploy Preview for redpanda-docs-preview failed. Why did it fail? →
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
modules/reference/pages/public-metrics-reference.adoc (1)
700-702: Minor wording tweak.“To … be immediately allocated” reads awkwardly. Suggest “…can be immediately reallocated” or “…can be allocated immediately”.
modules/manage/partials/monitor-health.adoc (1)
67-74: Consider emitting a 0-100 gauge instead of teaching users to derive one.The “memory pressure” query is just
1-<previous expr>multiplied by 100. Shipping a ready-made gauge (redpanda_memory_pressure_ratio) would simplify dashboards and avoid copy-paste errors.If adding a new metric is out-of-scope, at least multiply by 100 in the example so the unit matches “percentage” in the prose.
-1 - (sum(...)) +(1 - (sum(...))) * 100
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
modules/manage/partials/monitor-health.adoc(1 hunks)modules/reference/pages/public-metrics-reference.adoc(2 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: JakeSCahill
PR: redpanda-data/docs#1192
File: modules/deploy/partials/requirements.adoc:91-93
Timestamp: 2025-07-02T14:54:03.506Z
Learning: In Redpanda documentation, use GiB (binary units, powers of 2) for Kubernetes-specific memory requirements because Kubernetes treats memory units like Mi, Gi as binary units. Use GB (decimal units, powers of 10) for general broker memory requirements in non-Kubernetes contexts.
Learnt from: Feediver1
PR: redpanda-data/docs#1153
File: antora.yml:3-5
Timestamp: 2025-07-14T19:28:43.296Z
Learning: In Redpanda docs, during beta releases, the version metadata may intentionally show inconsistencies where the header displays the beta version (e.g., 25.2 Beta) while internal attributes like full-version, latest-redpanda-tag, operator-beta-tag still reference the stable version (e.g., 25.1). This is resolved during the GA merge process when all version references are synchronized.
Learnt from: Feediver1
PR: redpanda-data/docs#1153
File: modules/reference/pages/properties/topic-properties.adoc:45-50
Timestamp: 2025-07-16T19:33:20.420Z
Learning: In the Redpanda documentation, topic property cross-references like <<max.compaction.lag.ms>> and <<min.compaction.lag.ms>> require corresponding property definition sections with anchors like [[maxcompactionlagms]] and [[mincompactionlagms]] to prevent broken links.
Learnt from: paulohtb6
PR: redpanda-data/docs#0
File: :0-0
Timestamp: 2025-07-15T20:38:27.458Z
Learning: In Redpanda documentation, "Redpanda Data" refers to the company name, while "Redpanda" refers to the product name. These terms should be used appropriately based on context.
modules/manage/partials/monitor-health.adoc (1)
Learnt from: JakeSCahill
PR: #1192
File: modules/deploy/partials/requirements.adoc:91-93
Timestamp: 2025-07-02T14:54:03.506Z
Learning: In Redpanda documentation, use GiB (binary units, powers of 2) for Kubernetes-specific memory requirements because Kubernetes treats memory units like Mi, Gi as binary units. Use GB (decimal units, powers of 10) for general broker memory requirements in non-Kubernetes contexts.
modules/reference/pages/public-metrics-reference.adoc (3)
Learnt from: JakeSCahill
PR: #1192
File: modules/deploy/partials/requirements.adoc:91-93
Timestamp: 2025-07-02T14:54:03.506Z
Learning: In Redpanda documentation, use GiB (binary units, powers of 2) for Kubernetes-specific memory requirements because Kubernetes treats memory units like Mi, Gi as binary units. Use GB (decimal units, powers of 10) for general broker memory requirements in non-Kubernetes contexts.
Learnt from: Feediver1
PR: #1153
File: modules/reference/pages/properties/topic-properties.adoc:45-50
Timestamp: 2025-07-16T19:33:20.420Z
Learning: In the Redpanda documentation, topic property cross-references like <<max.compaction.lag.ms>> and <<min.compaction.lag.ms>> require corresponding property definition sections with anchors like [[maxcompactionlagms]] and [[mincompactionlagms]] to prevent broken links.
Learnt from: Feediver1
PR: #1153
File: antora.yml:3-5
Timestamp: 2025-07-14T19:28:43.296Z
Learning: In Redpanda docs, during beta releases, the version metadata may intentionally show inconsistencies where the header displays the beta version (e.g., 25.2 Beta) while internal attributes like full-version, latest-redpanda-tag, operator-beta-tag still reference the stable version (e.g., 25.1). This is resolved during the GA merge process when all version references are synchronized.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - redpanda-docs-preview
- GitHub Check: Header rules - redpanda-docs-preview
- GitHub Check: Pages changed - redpanda-docs-preview
🔇 Additional comments (2)
modules/manage/partials/monitor-health.adoc (2)
78-79: Broken context anchor.After deleting the duplicate block in the metrics reference file, ensure this link still resolves:
redpanda_memory_available_memory_low_water_markIf the anchor moves, update this reference or add
[[redpanda_memory_available_memory_low_water_mark]]in the canonical section.
56-66: Existing memory‐availability formula is correct—no double count of reclaimableThe current query
sum(redpanda_memory_available_memory) / (sum(redpanda_memory_free_memory) + sum(redpanda_memory_allocated_memory))already computes
• numerator = free + reclaimable
• denominator = free + (reclaimable + non-reclaimable) = total memoryThere is no duplicate reclaimable term. Please ignore the suggested diff.
Likely an incorrect or invalid review comment.
travisdowns
left a comment
travisdowns
left a comment
There was a problem hiding this comment.
some suggestions on the files
Co-authored-by: Travis Downs <travis.downs@gmail.com>
|
What's the current status of this @paulohtb6? thx |
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
|
@Feediver1 waiting on re-review after I applied the review points. |
masapanda
left a comment
masapanda
left a comment
There was a problem hiding this comment.
Thank you for completing this request!
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
Description
Resolves https://redpandadata.atlassian.net/browse/DOC-1426
Review deadline: 30th July
Page previews
Checks