Skip to content

Commit

Permalink
add docs for health checks (#599)
Browse files Browse the repository at this point in the history
  • Loading branch information
cortopy authored May 1, 2021
1 parent 7f1af64 commit 4b26e78
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
16 changes: 16 additions & 0 deletions examples/src/health/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Health checks

gRPC has a [health checking protocol](https://github.com/grpc/grpc/blob/master/doc/health-checking.md) that defines how health checks for services should be carried out. Tonic supports this protocol with the optional [tonic health crate](https://docs.rs/tonic-health).

This example uses the crate to set up a HealthServer that will run alongside the application service. In order to test it, you may use community tools like [grpc_health_probe](https://github.com/grpc-ecosystem/grpc-health-probe).

For example, running the following bash script:

```bash
while [ true ]; do
./grpc_health_probe -addr=[::1]:50051 -service=helloworld.Greeter
sleep 1
done
```

will show the change in health status of the service over time.
4 changes: 3 additions & 1 deletion tonic-health/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# tonic-health

A `tonic` based gRPC healthcheck implementation.
A `tonic` based gRPC healthcheck implementation. It closely follows the official [health checking protocol](https://github.com/grpc/grpc/blob/master/doc/health-checking.md), although it may not implement all features described in the specs.

Please follow the example in the [main repo](https://github.com/hyperium/tonic/tree/master/examples/src/health) to see how it works.

## Features

Expand Down

0 comments on commit 4b26e78

Please sign in to comment.