[26.2] Improved cluster health summary#1805
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
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 |
fe40cd7 to
d04e2fa
Compare
|
|
||
| ==== Enable cluster health metrics | ||
|
|
||
| Set xref:reference:properties/cluster-properties.adoc#health_monitor_metrics_enabled[`health_monitor_metrics_enabled`] to `true`. This property requires a broker restart to take effect. |
There was a problem hiding this comment.
Surprised this is opt in @tyson-redpanda . Not high cardinality at all and quite useful in the general case
| |xref:reference:public-metrics-reference.adoc#redpanda_cluster_health_refreshes_total[`redpanda_cluster_health_refreshes_total`] |counter |Number of successful refreshes on the broker. | ||
| |=== | ||
|
|
||
| NOTE: The informational metrics (`cluster_size`, `nodes_in_recovery_mode`, and `bytes_in_cloud_storage`) don't affect whether the cluster is considered healthy. |
There was a problem hiding this comment.
Surprised nodes in recovery node would not impact cluster health @pgellert @tyson-redpanda
|
Minor, non-blocking suggestions
No blocking issues from my read — the technical content (PromQL, property name, defaults) is internally consistent, prior review feedback is fully incorporated, and it already has two approvals. This looks mergeable as-is. |
Description
This pull request updates the Redpanda release notes to document new features and configuration options, most notably the addition of cluster health metrics export as Prometheus metrics. It also removes several older release note sections and details on new configuration properties, streamlining the release notes and focusing on the most impactful changes.
New Feature Documentation:
rpk cluster health. The metrics mirrorrpk cluster healthoutput and are disabled by default.health_monitor_metrics_enabledproperty and restarting brokers, with a reference to the documentation for available metrics and query examples.Release Notes Streamlining:
Resolves https://redpandadata.atlassian.net/browse/DOC-2016
Review deadline: 23 July
Page previews
Preview links resolve once the Netlify build for this PR completes.
Checks