feat(node): report per-component health with p2p peer count on GET /status - #25181
Closed
spalladino wants to merge 1 commit into
Closed
feat(node): report per-component health with p2p peer count on GET /status#25181spalladino wants to merge 1 commit into
spalladino wants to merge 1 commit into
Conversation
…tatus
A validator ran for hours with a dead p2p stack and zero peers while `GET /status` kept answering a plain 200
with an empty body, so neither operators nor k8s probes had anything to key off. The endpoint now reports the
health of each registered RPC namespace.
`GET /status` returns a JSON body: `{ "ok": true, "components": { "<namespace>": { "healthy": true, ... } } }`,
where each component entry carries its healthy flag plus whatever details its health check reports. The 200/500
semantics are unchanged: 500 when any component is unhealthy, 200 otherwise. Servers with no component-level
checks answer with just `{ "ok": true }`. Health check functions may keep returning a plain boolean, which is
read as `{ healthy: <boolean> }`, so existing checks are unaffected. `SafeJsonRpcServer.isHealthy()` keeps its
boolean contract; the detailed shape is available through the new `getStatus()`.
The node registers a health check for its `p2p` namespace that reports `enabled` and `connectedPeers` from
`getP2PConnectivity()`. It is healthy when p2p is disabled by configuration, or when the connected peer count is
at least the new `p2pHealthMinPeers` p2p option (`P2P_HEALTH_MIN_PEERS`). That floor defaults to 0, so out of the
box the peer count is reported but never fails the check: the first node of a fresh network legitimately runs
with no peers, and failing readiness by default would prevent bootstrapping the network. Operators who want the
check to fail on a peerless node opt in by raising the floor.
Part of A-1701.
This was referenced Aug 11, 2026
Contributor
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A validator ran for hours with a dead p2p stack and zero peers while
GET /statuskept answering a plain 200with an empty body, so neither operators nor k8s probes had anything to key off. The endpoint now reports the
health of each registered RPC namespace.
GET /statusreturns a JSON body:{ "ok": true, "components": { "<namespace>": { "healthy": true, ... } } },where each component entry carries its healthy flag plus whatever details its health check reports. The 200/500
semantics are unchanged: 500 when any component is unhealthy, 200 otherwise. Servers with no component-level
checks answer with just
{ "ok": true }. Health check functions may keep returning a plain boolean, which isread as
{ healthy: <boolean> }, so existing checks are unaffected.SafeJsonRpcServer.isHealthy()keeps itsboolean contract; the detailed shape is available through the new
getStatus().The node registers a health check for its
p2pnamespace that reportsenabledandconnectedPeersfromgetP2PConnectivity(). It is healthy when p2p is disabled by configuration, or when the connected peer count isat least the new
p2pHealthMinPeersp2p option (P2P_HEALTH_MIN_PEERS). That floor defaults to 0, so out of thebox the peer count is reported but never fails the check: the first node of a fresh network legitimately runs
with no peers, and failing readiness by default would prevent bootstrapping the network. Operators who want the
check to fail on a peerless node opt in by raising the floor.
Part of A-1701.
Part of a stacked-PR chain (bottom → top) hardening the node against running with a dead p2p stack; each PR targets the branch below it and the bottom targets
merge-train/spartan-v5:GET /statussendTxwhen the node has no peers to propagate the tx