gaspersic/solana
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

RPC: Add health check URI (bp #9499) (#9505)

Browse Source 
automerge
This commit is contained in:
mergify[bot]
2020-04-15 11:33:20 -07:00
committed by GitHub
parent 6f95524be3
commit cf9936a314
3 changed files with 220 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/src/apps/jsonrpc-api.md
View File

@@ -115,6 +115,16 @@ Many methods that take a commitment parameter return an RpcResponse JSON object
* `value` : The value returned by the operation itself.
## Health Check
Although not a JSON RPC API, a `GET /heath` at the RPC HTTP Endpoint provides a
health-check mechanism for use by load balancers or other network
infrastructure. This request will always return a HTTP 200 OK response with a body of
"ok" or "behind" based on the following conditions:
1. If one or more `--trusted-validator` arguments are provided to `solana-validator`, "ok" is returned
when the node has within `HEALTH_CHECK_SLOT_DISTANCE` slots of the highest trusted validator,
otherwise "behind" is returned.
2. "ok" is always returned if no trusted validators are provided.
## JSON RPC API Reference
### getAccountInfo