aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/health-checking.md
diff options
context:
space:
mode:
authorGravatar yang-g <yangg@google.com>2015-08-10 23:47:07 -0700
committerGravatar yang-g <yangg@google.com>2015-08-10 23:47:07 -0700
commitbc435e7ee99c37d8ffcad15c957dc75c947c9e7b (patch)
treeaffcc0db3bdb61a8dc1e3a857c5b88d52ddcb444 /doc/health-checking.md
parent481b016e2e4a90875230952d5b95ccdd2538962e (diff)
recommend to require empty service name
Diffstat (limited to 'doc/health-checking.md')
-rw-r--r--doc/health-checking.md11
1 files changed, 6 insertions, 5 deletions
diff --git a/doc/health-checking.md b/doc/health-checking.md
index fb6566577c..0b3f9c6a03 100644
--- a/doc/health-checking.md
+++ b/doc/health-checking.md
@@ -58,11 +58,12 @@ a response must be sent back with an `OK` status and the status field should be
set to `SERVING` or `NOT_SERVING` accordingly. If the service name is not
registered, the server returns a `NOT_FOUND` GRPC status.
-It is recommended that the server use an empty string as the key for server’s
-health status as a whole. The server can just do exact matching of the
-service name support any kind of wildcard matching. However, the service owner
-has the freedom to implement more complicated matching semantics that both the
-client and server agree upon.
+The server should use an empty string as the key for server’s
+overall health status, so that a client not interested in a specific service can
+query the server's status with an empty request. The server can just do exact
+matching of the service name without support of any kind of wildcard matching.
+However, the service owner has the freedom to implement more complicated
+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