openethereum-node-status/README.md

18 lines
488 B
Markdown

### openethereum-node-status
> ⚠️ WIP
A tiny stateless service to return health status and useful metrics from OpenEthereum/Parity nodes. Requires the [following API's](https://openethereum.github.io/JSONRPC) to be enabled:
- eth
- parity
#### Endpoints
- `/health` (Expect 200 for health with an additional JSON object with more info)
- `/metrics` (Expect 200 with an additional JSON object with more info)
#### Development
`DEBUG_ENABLED=true go run cmd/node-status/main.go`