OpenTelemetry 指标
gRPC 中可用的 OpenTelemetry 指标
OpenTelemetry 指标
概述
gRPC 提供了对 OpenTelemetry 插件的支持,该插件提供可帮助您的指标:
- 排除系统故障
- 迭代改进系统性能
- 设置持续监控和警报。
背景
OpenTelemetry 是一个用于创建和管理遥测数据的可观测性框架。gRPC 之前通过 OpenCensus 提供可观测性支持,但为了支持 OpenTelemetry,OpenCensus 已经退役。
工具
gRPC OpenTelemetry 插件接受一个 MeterProvider,并依赖于 OpenTelemetry API 来创建一个 Meter,该 Meter 标识正在使用的 gRPC 库,例如,版本为 1.57.1
的 grpc-c++
。以下列出的工具是使用此 Meter 创建的。用户应使用 OpenTelemetry SDK 来自定义 OpenTelemetry 导出的视图。
越来越多的 gRPC 组件正在被检测以实现可观测性。目前,我们已经检测了以下组件:
- 每次调用(稳定,默认启用):观察 RPC 本身(例如,延迟)。
- 客户端每次调用:观察客户端调用
- 客户端每次尝试:观察客户端调用的尝试,因为由于重试或对冲,一个调用可能有多次尝试。
- 服务器:观察服务器接收到的调用。
- 负载均衡策略:观察各种负载均衡策略
- 加权轮询(实验性)
- 先选(实验性)
- XdsClient(实验性)
注意 某些工具默认是关闭的,需要从 gRPC OpenTelemetry 插件 API 中显式启用。实验性指标始终默认关闭。(参考 C++ API)
每次调用指标
客户端每次调用工具
名称 | 类型 | 单位 | 标签(必需) | 描述 |
---|---|---|---|---|
grpc.client.call.duration | 直方图 | 秒 | grpc.method,grpc.target,grpc.status | 此指标旨在衡量 gRPC 库从应用程序的角度完成 RPC 所花费的端到端时间。 |
有关详细信息,请参阅 A66:OpenTelemetry 指标。
客户端每次尝试工具
名称 | 类型 | 单位 | 标签(处置) | 描述 |
---|---|---|---|---|
grpc.client.attempt. started | 计数器 | {attempt} | grpc.method(必需),grpc.target(必需) | 启动的 RPC 尝试总数,包括尚未完成的尝试。 |
grpc.client.attempt. duration | 直方图 | 秒 | grpc.method(必需),grpc.target(必需),grpc.status(必需),grpc.lb.locality(可选) | 完成 RPC 尝试所花费的端到端时间,包括选择子通道所花费的时间。 |
grpc.client.attempt. sent_total_compressed_message_size | 直方图 | 字节 | grpc.method(必需),grpc.target(必需),grpc.status(必需),grpc.lb.locality(可选) | 每个 RPC 尝试发送的所有请求消息(不包括元数据)的压缩总字节数(但未加密);不包括 grpc 或传输帧字节。 |
grpc.client.attempt. rcvd_total_compressed_message_size | 直方图 | 字节 | grpc.method(必需),grpc.target(必需),grpc.status(必需),grpc.lb.locality(可选) | 每个 RPC 尝试接收的所有响应消息(不包括元数据)的压缩总字节数(但未加密);不包括 grpc 或传输帧字节。 |
有关详细信息,请参阅 A66:OpenTelemetry 指标。
服务器工具
名称 | 类型 | 单位 | 标签(必需) | 描述 |
---|---|---|---|---|
grpc.server.call. started | 计数器 | {call} | grpc.method | 启动的 RPC 总数,包括尚未完成的 RPC。 |
grpc.server.call. sent_total_compressed_message_size | 直方图 | 字节 | grpc.method,grpc.status | 每个 RPC 发送的所有响应消息(不包括元数据)的压缩总字节数(但未加密);不包括 grpc 或传输帧字节。 |
grpc.server.call. rcvd_total_compressed_message_size | 直方图 | 字节 | grpc.method,grpc.status | 每个 RPC 收到的所有请求消息(不包括元数据)的总字节数(已压缩但未加密);不包括 gRPC 或传输帧字节。 |
grpc.server.call. duration | 直方图 | 秒 | grpc.method,grpc.status | 此指标旨在衡量从服务器传输(HTTP2/进程内)角度来看,RPC 所需的端到端时间。 |
有关详细信息,请参阅 A66:OpenTelemetry 指标。
负载均衡策略工具
加权轮询负载均衡策略工具
名称 | 类型 | 单位 | 标签(处置) | 描述 |
---|---|---|---|---|
grpc.lb.wrr. rr_fallback | 计数器 | {update} | grpc.target (必选), grpc.lb.locality (可选) | 实验性:调度器更新中,没有足够具有有效权重的端点,导致 WRR 策略回退到 RR 行为的次数。 |
grpc.lb.wrr. endpoint_weight_not_yet_usable | 计数器 | {endpoint} | grpc.target (必选), grpc.lb.locality (可选) | 实验性:每次调度器更新中,尚不具有可用权重信息的端点数量(即,尚未收到负载报告,或处于黑名单期内)。 |
grpc.lb.wrr. endpoint_weight_stale | 计数器 | {endpoint} | grpc.target (必选), grpc.lb.locality (可选) | 实验性:每次调度器更新中,其最新权重早于过期时间的端点数量。 |
grpc.lb.wrr. endpoint_weights | 直方图 | {weight} | grpc.target (必选), grpc.lb.locality (可选) | 实验性:每次调度器更新记录的端点权重。 |
详情请参考 A78:用于 WRR、Pick First 和 XdsClient 的 gRPC OTel 指标。
先选负载均衡策略工具
名称 | 类型 | 单位 | 标签(必需) | 描述 |
---|---|---|---|---|
grpc.lb.pick_first. disconnections | 计数器 | {disconnection} | grpc.target | 实验性:选定的子通道断开连接的次数。 |
grpc.lb.pick_first. connection_attempts_succeeded | 计数器 | {attempt} | grpc.target | 实验性:成功连接尝试的次数。 |
grpc.lb.pick_first. connection_attempts_failed | 计数器 | {attempt} | grpc.target | 实验性:失败连接尝试的次数。 |
详情请参考 A78:用于 WRR、Pick First 和 XdsClient 的 gRPC OTel 指标。
XdsClient 工具
名称 | 类型 | 单位 | 标签(必需) | 描述 |
---|---|---|---|---|
grpc.xds_client. connected | Gauge (仪表盘) | {bool} | grpc.target, grpc.xds.server | 实验性:xDS 客户端当前是否具有与 xDS 服务器正常工作的 ADS 流。 |
grpc.xds_client. server_failure | 计数器 | {failure} | grpc.target, grpc.xds.server | 实验性:xDS 服务器从健康变为不健康的计数器。 |
grpc.xds_client. resource_updates_valid | 计数器 | {resource} | grpc.target, grpc.xds.server, grpc.xds.resource_type | 实验性:接收到的被认为是有效的资源计数器,即使没有更改。 |
grpc.xds_client. resource_updates_invalid | 计数器 | {resource} | grpc.target, grpc.xds.server, grpc.xds.resource_type | 实验性:接收到的被认为是无效的资源计数器。 |
grpc.xds_client. resources | Gauge (仪表盘) | {resource} | grpc.target, grpc.xds.authority, grpc.xds.cache_state, grpc.xds.resource_type | 实验性:xDS 资源的数量。 |
详情请参考 A78:用于 WRR、Pick First 和 XdsClient 的 gRPC OTel 指标。
标签/属性
对于乐器记录的测量值,gRPC 可能会提供一些其他信息作为属性或标签。例如,grpc.client.attempt.started
具有标签 grpc.method
和 grpc.target
以及每个测量值,这些标签告诉我们所观察到的 RPC 尝试的方法和目标。
注意 一些属性在乐器上标记为可选。这些需要从 gRPC OpenTelemetry 插件 API 显式启用。(参考 C++ API)
名称 | 描述 |
---|---|
grpc.method | 完整的 gRPC 方法名称,包括包、服务和方法,例如“google.bigtable.v2.Bigtable/CheckAndMutateRow”。 |
grpc.status | 接收到的 gRPC 服务器状态码,例如“OK”、“CANCELLED”、“DEADLINE_EXCEEDED”。 |
grpc.target | 创建 gRPC 通道时使用的规范化目标 URI,例如“dns:///pubsub.googleapis.com:443”、“xds:///helloworld-gke:8000”。 |
grpc.lb.locality | 流量被发送到的区域。 |
grpc.xds.server | 对于客户端,表示使用 XdsClient 的 gRPC 通道的目标。对于服务器,将是字符串“#server”。 |
grpc.xds.authority | xDS 授权。对于旧式非 xdstp 资源名称,该值将为“#old”。 |
grpc.xds.cache_state | 指示 xDS 资源的缓存状态(“requested”、“does_not_exist”、“acked”、“nacked”、“nacked_but_cached”)。 |
grpc.xds.resource_type | xDS 资源类型,例如“envoy.config.listener.v3.Listener”。 |
常见问题解答
问:如何获取吞吐量或 QPS(每秒查询数)?
在延迟直方图指标上使用计数聚合 - grpc.client.attempt.duration
/ grpc.client.call.duration
(对于客户端)或 grpc.server.call.duration
(对于服务器)。
问:如何获取 RPC 的错误率?
可以通过在延迟直方图指标 grpc.client.attempt.duration
/ grpc.client.call.duration
(对于客户端)或 grpc.server.call.duration
(对于服务器)上使用 grpc.status != OK
值的过滤器来计算错误计数。
语言示例
语言 | 示例 |
---|---|
C++ | C++ 示例 |
Go | Go 示例 |
Java | Java 示例 |
Python | Python 示例 |