cluster_health
Check Kafka cluster health in one call: get controller, broker details, and all problem partitions with offline, replication, ISR, or error issues.
Instructions
Check the health of the cluster this endpoint serves in one call: cluster id, controller, every broker (id, host, port, rack, and how many partitions it leads), a summary count, and every partition that is not fully healthy.
A problem partition lists its issues:
offline: no leader, so nothing can be produced to or consumed from it.
under_replicated: fewer in-sync replicas than replicas, so a broker is down or falling behind.
under_min_isr: fewer in-sync replicas than the topic's min.insync.replicas, so producers using acks=all fail with NOT_ENOUGH_REPLICAS.
error: the broker returned an error for the partition.
healthy is true only when there are no problems. Use search to limit the check to topics whose name contains a substring (case-insensitive); internal topics are skipped unless include_internal is true. min_isr_unknown lists topics whose min.insync.replicas the broker did not report, so under_min_isr was not judged for them.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| search | No | Optional case-insensitive substring that a topic name must contain to be checked. Omit to check every topic. Brokers and the controller are always reported. | |
| include_internal | No | Optional. When true, also check Kafka's internal topics such as __consumer_offsets. Defaults to false. An unhealthy internal topic breaks every consumer group, so include them when groups fail across the board. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| brokers | Yes | ||
| healthy | Yes | ||
| summary | Yes | ||
| problems | Yes | ||
| warnings | Yes | ||
| cluster_id | Yes | ||
| controller | Yes | ||
| min_isr_unknown | No |