From 18a9e00b333d8aa6d2a270ce229ae32657033baa Mon Sep 17 00:00:00 2001 From: Sanjay Pujare Date: Wed, 22 May 2019 09:53:18 -0700 Subject: [PATCH] Document the Watch() method that got added to health/v1/health.proto --- doc/health-checking.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/health-checking.md b/doc/health-checking.md index 7be8107b60f..22b6e1b4c09 100644 --- a/doc/health-checking.md +++ b/doc/health-checking.md @@ -43,6 +43,8 @@ message HealthCheckResponse { service Health { rpc Check(HealthCheckRequest) returns (HealthCheckResponse); + + rpc Watch(HealthCheckRequest) returns (stream HealthCheckResponse); } ``` @@ -68,3 +70,8 @@ matching semantics that both the client and server agree upon. A client can declare the server as unhealthy if the rpc is not finished after some amount of time. The client should be able to handle the case where server does not have the Health service. + +A client can call the `Watch` method to perform a streaming health-check. +The server will immediately send back a message indicating the current +serving status. It will then subsequently send a new message whenever +the service's serving status changes.