GRPC Health Checking Protocol

GRPC Health Checking Protocol

健康检查用于侦测是否服务器能够处理rpcs。客户端向服务器的健康检查能点到点的进行，或者通过一些控制系统。服务器可能选择回复 “unhealthy”，因为没有准备好接受请求，正在关闭或者一些其他原因。客户端可以依据在一定的time window内没有收到消息，或者响应回复unhealthy。

一个简单的GRPC服务被用作健康检查机制，不论是简单的 client-to-server 情境还是其他控制系统例如load_balancing。作为一个高层级的服务提供了一些好处。首先，因为它自身是一个GPRC服务，做一个健康检查与普通的rpc操作相同。其次，它含有丰富的语义，例如每个服务的健康状态。第三，作为一个gRPC服务，它能够重用所有已存在的 billing, quota infrastructure 等，因此，服务器对健康检查服务具有完全的控制权。

Service Definition

服务器应当导出一个如下proto文件定义的服务：

syntax = "proto3"
package grpc.health.v1
message HealthCheckRequest {
	string service = 1;
}

message HealthCheckResponse {
	enum ServingStatus {
		UNKNOWN = 0;
		SERVING = 1;
		NOT_SERVING = 2;
		SERVICE_UNKNOWN = 3; // Used only by the Watch method.
	}
	ServingStatus status = 1;
}

service Health {
	rpc Check(HealthCheckRequest) returns (HealthCheckResponse);
	rpc Watch(HealthCheckRequest) returns (stream HealthCheckResponse);
}

客户端可以通过调用Check方法来询问服务器的健康状态，且rpc应当设置deadline。客户端可以可选的设置想要查询健康状态服务的服务名。建议的服务名格式是package_names.ServiceName，例如grpc.health.v1.Health。
服务器应当手动的注册所有的服务，且设置单独的状态，包含一个空的服务名和它的状态。对每个收到的请求，服务名都能在注册表中找到，响应必须携带一个OK的状态回送，且status字段应当被设置为SERVING 或 NOT_SERVING。如果服务名没有注册，服务器返回一个 NOT_FOUND GRPC 状态。
服务器应当使用空的字符串作为服务器全部健康状态的key，所以对特定的服务不感兴趣的客户端能够通过使用一个空的请求来询问服务器的状态。服务器可以只做服务名的精确匹配，而不支持任何通配符匹配。但是，服务所有者可以自由实现更复杂的匹配语义，只要服务器和客户端对此能达成一致。
一个客户端能够声明一个服务器是不健康的，如果rpc在一定时间内没有完成。客户端应当能处理服务器没有健康服务的情况。
客户端能够调用Watch方法来执行流式健康检查。服务器将立刻返回表明当前服务状态的消息，无论何时服务状态改变随后都会向客户端发送新的数据。