健康检查

解释了 gRPC 服务器如何暴露健康检查服务,以及如何配置客户端自动检查其连接的服务器的健康状况。

健康检查

解释了 gRPC 服务器如何暴露健康检查服务,以及如何配置客户端自动检查其连接的服务器的健康状况。

概述

gRPC 为针对 gRPC 服务器执行健康检查调用指定了一个标准服务 API (health/v1)。提供此服务的实现,但您有责任更新服务的健康状态。

在客户端,您可以让客户端自动与后端的健康服务通信。这使客户端可以避开被认为不健康的服务器。

服务端健康服务

gRPC 服务器上的健康检查服务支持两种操作模式

  • Check rpc 端点的单向调用
    • 适用于集中监控或负载均衡解决方案,但不能扩展以支持大量 gRPC 客户端不断进行健康检查
  • 通过使用 Watch rpc 端点来流式传输健康更新
    • 由 gRPC 客户端中的客户端健康检查功能使用

在服务器上启用健康检查服务涉及以下步骤

  1. 使用提供的健康检查库创建健康检查服务
  2. 将健康检查服务添加到您的服务器。
  3. 当您的某个服务的健康状况发生变化时,通知健康检查库。
    • 如果您的服务目前无法接受请求,则为 NOT_SERVING
    • 如果您的服务已开放业务,则为 SERVING
    • 如果您不关心各个服务的健康状况,则可以使用空字符串 ("") 来表示整个服务器的健康状况。
  4. 确保您在服务器关闭时通知健康检查库,以便它可以通知所有连接的客户端。

具体细节因语言而异,请参阅下面的 语言支持 部分。

启用客户端健康检查

可以通过修改通道的服务配置来配置 gRPC 客户端对它连接的服务器执行健康检查。例如,要监控 foo 服务的健康状况,您将使用(JSON 格式)

{
  "healthCheckConfig": {
    "serviceName": "foo"
  }
}

请注意,如果您的服务器报告空字符串 ("") 服务的健康状况,表示整个服务器的健康状况,您也可以在此处使用空字符串。

启用健康检查会更改调用服务器的某些行为

  • 客户端将在建立连接时额外调用健康检查服务上的 Watch RPC
    • 如果调用失败,将进行重试(带有指数退避),除非调用因状态 UNIMPLEMENTED 而失败,在这种情况下,健康检查将被禁用。
  • 在健康检查服务为被调用的服务发送健康状态之前,不会发送请求
  • 如果健康的服务变得不健康,客户端将不再为该服务发送请求
  • 如果服务稍后变得健康,则调用将恢复
  • 如果该功能与策略不符(例如,pick_first会这样做),则某些负载均衡策略可以选择禁用健康检查

更具体地说,子通道(表示与服务器的物理连接)的状态会根据它连接的服务的健康状况经历这些状态。

stateDiagram-v2
    [*] --> IDLE
    IDLE --> CONNECTING : Connection requested
    CONNECTING --> READY : Health check#colon;\nSERVING
    CONNECTING --> TRANSIENT_FAILURE : Health check#colon;\nNOT_SERVING\nor call fails
    READY --> TRANSIENT_FAILURE : Health check#colon;\nNOT_SERVING
    READY --> IDLE : Connection breaks\nor times out
    TRANSIENT_FAILURE --> READY : Health check#colon;\nSERVING
    note right of TRANSIENT_FAILURE : Allows the load balancer to choose\nanother, working subchannel 

同样,启用客户端健康检查的具体方法因语言而异,请参阅 语言支持 部分中的示例。

语言支持

语言示例
JavaJava 示例
GoGo 示例
PythonPython 示例
C++C++ 示例
上次修改时间为 2024 年 5 月 20 日:添加 C++ 健康检查示例的链接 (#1289) (571730d)