What's New: cluster health metrics (DOC-2308) - #656
Conversation
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughAdds a July 2026 “Cluster health metrics” entry documenting Prometheus cluster health summaries for BYOC and Dedicated clusters. The metrics are exposed through the public metrics endpoint with the Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://cdn.github.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@modules/get-started/pages/whats-new-cloud.adoc`:
- Around line 22-24: Update the “Cluster health metrics” section to explicitly
enumerate all 12 redpanda_cluster_health_* metric names, or replace/augment the
Monitor Redpanda Cloud link with a reference to a section that clearly lists all
12 metrics. Preserve the existing enablement property and overview.
🪄 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: d24c11b0-e514-441c-840d-31ee2ad5fad7
📒 Files selected for processing (1)
modules/get-started/pages/whats-new-cloud.adoc
| === Cluster health metrics | ||
|
|
||
| BYOC and Dedicated clusters can now export a cluster health summary as Prometheus metrics on the public metrics endpoint, so you can alert on overall cluster health, such as brokers down, leaderless partitions, or a missing controller, directly from your metrics system. The metrics are prefixed with `redpanda_cluster_health_` and are disabled by default: enable them with the `health_monitor_metrics_enabled` cluster property. See xref:manage:monitor-cloud.adoc#cluster-health[Monitor Redpanda Cloud]. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Describe the twelve health metrics explicitly or link to their exact reference.
The entry names the prefix and three example health conditions, but does not identify the 12 redpanda_cluster_health_* metrics required by the PR objective. Add the metric names here, or ensure the linked section clearly enumerates all 12.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@modules/get-started/pages/whats-new-cloud.adoc` around lines 22 - 24, Update
the “Cluster health metrics” section to explicitly enumerate all 12
redpanda_cluster_health_* metric names, or replace/augment the Monitor Redpanda
Cloud link with a reference to a section that clearly lists all 12 metrics.
Preserve the existing enablement property and overview.
1 participant
Summary
July 2026 What's New entry for DOC-2308: metrics-based cluster health monitoring on BYOC/Dedicated.
Companion to redpanda-data/docs#1855, which un-gates the single-sourced content (the Cluster health section in
monitor-health.adocand the 12redpanda_cluster_health_*entries in the metrics reference) for Cloud builds. Merge #1855 first — this entry deep-linksmanage:monitor-cloud.adoc#cluster-health, an anchor that reaches cloud-docs through the single-source include.The entry sits after the AWS-regions entry so its hunk doesn't conflict with #654 or #655, which edit other parts of the July section.
health_monitor_metrics_enabledis customer-settable in the Cloud Console (see the follow-up flagged on #1855) — if it turns out to be support-only, the entry's "enable them with the cluster property" wording needs adjusting.🤖 Generated with Claude Code
Preview pages
Note: the entry's link to
monitor-cloud.adoc#cluster-healthresolves to the page top in this preview — the anchor arrives via the single-source include only after docs#1855 merges.