livepeer / livepeer/go-livepeer
Register gRPC health check server when running gRPC server as an O
@RiccardoBiosas is already working on this.
Since Jul 22, 2022.
- Dominant language
- Go
- Stars
- 586
- Forks
- 226
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 19
Description
At the moment, the easiest way to run a health check for an O is to query the CLI server that O starts i.e. `curl localhost:7935/status`. However, this just tells us if the CLI server is up. It'd be nice to have a health check that can tell us if the gRPC server for the O is up as well. This can be done using [gRPC health checking](https://github.com/grpc/grpc/blob/master/doc/health-checking.md). We just need to register the health server with the gRPC server as an O. Then, you could use a [gRPC health probe](https://github.com/grpc-ecosystem/grpc-health-probe) to check on the health of the gRPC server.
See [this example of registering the health server for livepeer_router](https://github.com/livepeer/go-livepeer/blob/f59cbd572c428a6d259d462f55eb758dffccec92/server/router.go#L53).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.