服务配置
服务配置如何被服务所有者用于控制客户端行为。
服务配置
服务配置如何被服务所有者用于控制客户端行为。
概述
服务配置规定了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)