服务配置
服务所有者如何使用服务配置来控制客户端行为。
服务配置
服务所有者如何使用服务配置来控制客户端行为。
概述
服务配置指定 gRPC 客户端在与 gRPC 服务器交互时应如何表现。服务所有者可以提供服务配置,其中包含所有服务客户端的预期行为。服务配置中的设置始终应用于特定的目标字符串(例如“api.myapp.com”),而不是全局应用。
由服务配置控制的行为
服务配置中的设置会影响客户端负载均衡、调用行为和健康检查。
此页面概述了服务配置中的选项,但完整的服务配置数据结构在 protobuf 定义 中进行了文档记录。
负载均衡
一个服务可以由多个服务器组成,负载均衡配置指定来自客户端的调用应如何在这些服务器之间分配。默认情况下,使用 pick_first
负载均衡策略,但可以在服务配置中指定另一种策略。例如,指定 round_robin
策略将使客户端轮流使用服务器,而不是重复使用第一个服务器。
调用行为
RPC 可以通过多种方式配置
- 启用 wait-for-ready 后,如果客户端无法连接到后端,则 RPC 将被延迟,而不是立即失败。
- 可以提供调用超时,指示客户端在放弃 RPC 之前应等待的最大时间。
- 以下之一:
注意
这些调用行为设置可以限制为单个服务或方法。
可以通过设置重试限制策略来进一步调整重试和对冲策略,但它将应用于所有服务和方法。
健康检查
可以通过提供健康检查名称来配置客户端执行健康检查。然后,客户端将使用标准的 gRPC 健康检查服务。
获取服务配置
可以通过名称解析或客户端应用程序通过编程方式向客户端提供服务配置。
名称解析
gRPC 名称解析机制 允许可插拔的名称解析器实现。这些实现返回与名称关联的地址以及关联的服务配置。这是服务所有者可以用来将其服务配置分发到 gRPC 客户端队列的机制。
- xDS 名称解析器将从控制平面接收的 xDS 配置转换为相应的服务配置。
- Go 实现中的标准 DNS 名称解析器支持 存储为 TXT 记录 在名称服务器上的服务配置。
注意
即使服务配置结构使用 protobuf 定义进行了文档记录,客户端中的内部表示形式也是 JSON。名称解析器实现可以自由地以他们喜欢的任何方式存储服务配置信息,只要它们在名称解析时以 JSON 格式提供即可。通过编程方式
gRPC 客户端 API 提供了一种以 JSON 格式指定服务配置的方法。这用于提供在名称解析器未提供服务配置的情况下将使用的默认服务配置。它在某些测试情况下也可能很有用。
服务配置示例
以下示例执行以下操作:
- 启用
round_robin
负载均衡策略。 - 设置 1 秒的默认调用超时,该超时应用于所有服务中的所有方法。
- 将该超时覆盖为
foo
服务中bar
方法以及baz
服务中所有方法的 2 秒。
{
"loadBalancingConfig": [ { "round_robin": {} } ],
"methodConfig": [
{
"name": [{}],
"timeout": "1s"
},
{
"name": [
{ "service": "foo", "method": "bar" },
{ "service": "baz" }
],
"timeout": "2s"
}
]
}
上次修改时间 2024 年 2 月 29 日: 使用绝对路径而不是绝对 URL (#1268) (4f733b4)