全部产品
云市场

OnsConsumerStatus

更新时间:2019-08-14 15:52:08

使用 OnsConsumerStatus 查询指定 Group ID 的详细状态数据,包含订阅关系检查、消费 TPS 统计、负载均衡状态、消费端连接等。

描述

使用本接口时,请注意以下几点:

  • 本接口一般用于在粗略判断消费堆积以及客户端在线情况后,需要排查消费异常的原因时调用,可以判断出指定 Group ID 的订阅关系是否一致、负载均衡是否正常以及获取在线客户端的 Jstack 信息等。

  • 本接口需要调用后端大量接口完成数据聚合,因此查询速度慢,不建议频繁调用。

请求参数列表

名称 类型 是否必需 描述
InstanceId String 需查询的 Group ID 所对应的实例 ID
PreventCache Long 用于 CSRF 校验,设置为系统当前时间即可,单位毫秒(ms)
GroupId String 需要查询的消费端 Group ID
Detail Boolean 是否查询详细信息。取值说明如下:
  • true:要查询详细信息
  • false:不查询详细信息
NeedJstack Boolean 是否打印 JStack 信息

返回参数列表

名称 类型 描述
RequestId String 为公共参数,每个请求的 ID 都是唯一的
HelpUrl String 帮助链接
Data ConsumerStatusDo 查询结果

ConsumerStatusDo 数据结构列表

名称 类型 描述
Online Boolean 是否在线
TotalDiff Long 集群总的消费堆积
ConsumeTps Long 总消费 TPS
LastTimestamp Long 最后更新时间
DelayTime Long 延迟时间
ConsumeModel Long 消费模型
SubscriptionSame Boolean 订阅关系是否一致
RebalanceOK Boolean 客户端 Rebalance 是否正常。取值说明如下:
  • true:正常
  • false:不正常
ConnectionSet List(ConnectionDo) 该集群当前在线客户端信息
DetailInTopicList List(DetailInTopicDo) 各个 Topic 的消费情况
ConsumerConnectionInfoList List(ConsumerConnectionInfoDo) 该集群在线客户端详细信息,包含 Jstack、消费 RT 时间等信息

ConnectionDo 数据结构列表

名称 类型 描述
ClientId String 消费实例的 ID
ClientAddr String 该消费实例的地址和端口
Language String 消费端语言
Version String 消费端版本
RemoteIP String 宿主机IP或公网IP

DetailInTopicDo 数据结构列表

名称 类型 描述
Topic String Topic 名称
TotalDiff Long 该 Topic 消费总堆积数
LastTimestamp Long 最后更新时间
DelayTime Long 延迟时间

ConsumerConnectionInfoDo 数据结构列表

名称 类型 描述
ClientId String 消费实例的 ID
Connection String 连接信息
Language String 客户端语言
Version String 客户端版本号
ConsumeModel String 消费类型。取值说明如下:
  • CLUSTERING:集群消费模式
  • BROADCASTING:广播消费模式
ConsumeType String 从何处消费
ThreadCount Integer 消费线程数
StartTimeStamp Long 开始时间
LastTimeStamp Long 最后更新时间
SubscriptionSet List(SubscriptionData) 订阅关系集合
RunningDataList List(ConsumerRunningDataDo) 实时状态统计
Jstack List(ThreadTrackDo) Jstack 堆栈信息

SubscriptionData 数据结构列表

名称 类型 描述
Topic String 订阅的 Topic 名称
SubString String 订阅该 Topic 的子类别 Tag 表达式
SubVersion Long 订阅关系版本号,为自增 Long 型
TagsSet List(String) 订阅的 Tag 集合

ConsumerRunningDataDo 数据结构列表

名称 类型 描述
GroupId String 订阅方的 Group ID
Topic String 订阅的 Topic 名称
Rt Float 消费 RT 时间,单位 ms
OkTps Float 消费消息成功的 TPS 统计
FailedTps Float 消费消息失败的 TPS 统计
FailedCountPerHour Long 每小时内消费失败的消息数统计

ThreadTrackDo 数据结构列表

名称 类型 描述
Thread String 线程名称
TrackList List(String) Jstack 堆栈信息字符串

使用示例

示例代码请参见管控 API 示例代码和接入点列表