Skip to content
SHC Docs

shc leader health

show what the leader’s node-health walk has observed

Render the observing leader’s view of every node the cluster registry lists: the state its last probe found, when that probe ran, and the reason for any non-healthy verdict.

The walk is leader-only, so this refuses on a follower rather than presenting another node’s leftovers. It also refuses, naming the nodes, when the walk has no current observation for every registered node, because a short list of healthy nodes is indistinguishable from a healthy cluster of that size.

A refusal naming a just-enrolled node is expected. Enrolment writes the node’s registry row before any walk has reached it, so between the join and the leader’s next pass over that row this command refuses and names the new node. It clears on its own within one walk period and needs no action. The same refusal naming a node that has been in the cluster a while, or one that persists past the window quoted in the message, is the real condition: the walk is not reaching that node, or is not running at all.

The window scales with the cluster. The walk is serial and pays each unreachable peer’s probe budget in turn, so its period grows with the node count and the freshness rule grows with it; the message quotes the window that cluster actually applied.

shc leader health [flags]
-h, --help help for health
--config stringArray extra YAML config file to layer on top of auto-discovered config; repeatable, later files win
-d, --debug enable debug mode (default: $SHC_DEBUG)
-e, --environment string environment name (default: "prod", or "default" on an estate with no licence and no trial; $SHC_ENVIRONMENT and shc ctx -e override it, and the "master" tenant is always "default")
--exclude string comma-separated dotted paths to drop
--fields string comma-separated columns/keys to show (and their order)
--filter string comma-separated dotted paths to keep (drops everything else)
-o, --output string output format: tty|text|json|yaml (default: $SHC_OUTPUT)
-s, --stack string stack name (default: $SHC_STACK)
-t, --tenant string tenant name (default: $SHC_TENANT)
-v, --verbose verbose output (default: $SHC_VERBOSE)
  • shc leader - leader-state queries (am-I-leader, node health)