查询消息轨迹

消息轨迹数据

云消息队列 RocketMQ 版系统中，一条消息的完整链路包含生产者、服务端、消费者三个角色，每个角色处理消息的过程中都会在轨迹链路中增加相关的信息，将这些信息汇聚即可获取任意消息当前的状态。

使用说明

所有类型的消息正常发送后，即可根据消息的属性在云消息队列 RocketMQ 版控制台上查询到消息的发送轨迹，但查询轨迹需要注意以下几点。

支持查询的时间范围

由于消息在云消息队列 RocketMQ 版中存储的时间默认为3天，即只能查询当前时间起最大3天内的消息轨迹。例如，当前时间是2023年11月30日15:09:48，那么能查询到的消息轨迹最早的时间点为2023年11月27日15:09:48。

消费状态对查询结果的影响

各语言SDK支持消息轨迹的版本

增强版消息轨迹使用条件

增强版消息轨迹功能指的是若您使用的实例及客户端SDK版本符合以下条件，您可在控制台查看更多的轨迹数据，包括消息消费环节的轨迹数据、定时和延时消息及事务消息的相关轨迹数据等，具体的轨迹参数说明，请参见消息轨迹参数说明。

• TCP协议Java SDK：

  • SDK版本：升级至2.x.x.Final版本。

  • 实例所属地域：华东1（杭州）、华北1（青岛）、华北2（北京）、华北3（张家口）、华北5（呼和浩特）、华南1（深圳）、西南1（成都）、德国（法兰克福）和印度尼西亚（雅加达）。

• TCP协议C++ SDK：

  • SDK版本：升级至3.x.x版本。

  • 实例所属地域：所有地域均支持。

使用场景

在生产环境的消息收发不符合预期时，可以通过Message ID、Message Key或Topic的时间范围查询相关的消息轨迹，找到消息的实际收发状态，帮助您快速诊断消息问题。

使用示例

假设您根据业务日志里的信息来诊断某条消息为何一直没有收到，则可以参照以下步骤，利用消息轨迹来排查问题。

1. 收集疑似有问题的消息信息，包括Message ID、Message Key、Topic以及大概的发送时间。

2. 进入云消息队列 RocketMQ 版控制台，根据已有的信息创建查询任务，查询相关的消息的轨迹。

3. 查看结果并分析判断原因。

   • 如果轨迹显示尚未消费，则可以前往Group 管理页面查看消费者状态，确认消息是否因堆积而导致尚未消费。具体步骤，请参见查看消费者状态。

   • 如果发现已经消费，请根据消费端的信息，找到对应的客户端机器和时间，登录客户端机器查看相关日志。

操作入口

1. 登录云消息队列 RocketMQ 版控制台，在左侧导航栏单击实例列表。

2. 在顶部菜单栏选择地域，如华东1（杭州），然后在实例列表中，单击目标实例名称。

3. 在左侧导航栏单击消息轨迹，然后在页面左上角单击创建查询任务。

4. 在弹出的创建消息轨迹查询任务面板中，按需选择查询条件并按提示输入信息，单击确定完成创建。

   重要

   查询时，尽可能精确地设置时间范围，以便缩小查询范围，提高速度。

   消息轨迹查询功能支持三种查询方式，具体说明如下：

   • 按 Message ID 查询：该方式属于精确查询、速度快、精确匹配，推荐使用。

   • 按 Message Key 查询：该方式属于模糊查询，最多查询1000条轨迹。仅适用于您没有记录Message ID但是设置了Message Key，同时Message Key具有区分度的情况。

   • 按 Topic 查询：该方式属于范围查询，适用于没有上述Message ID和Message Key，而且消息量比较小的场景。因为时间范围内消息很多，且不具备区分度，所以不推荐使用。

   您创建查询任务后，即可在消息轨迹页面查看到刚创建的查询任务，若状态显示查询中，说明暂不能查看消息轨迹。您需要在任务列表的右上角，单击按钮，直到状态切换至查询完成。

消息轨迹参数说明

在消息轨迹的任务列表页，单击某任务操作列的查询结果会显示消息的发送状态和消费状态；具体的消息轨迹详情中的生产者和消费者区域也会分别显示消息的发送和消费状态。这些状态的说明如下：

消息轨迹常见问题

为什么查询不到消息轨迹？

• 检查客户端的SDK版本是否正确。具体支持的版本，请参见各语言SDK支持消息轨迹的版本。

• 查询的时间范围是否正确。

  由于消息在云消息队列 RocketMQ 版中存储的时间默认为3天，即只能查询当前时间起最大3天内的消息轨迹。例如，当前时间是2023年11月30日15:09:48，那么能查询到的消息轨迹最早的时间点为2023年11月27日15:09:48。

  重要

  由于轨迹存储空间不足，可能导致轨迹数据发生滚动，从而无法保存完整的三天轨迹数据。若需保存完整的三天轨迹，建议采用铂金版实例固定存储大小。

• 由于消息轨迹采用异步链路，因此，不保证轨迹数据一定完整。当查询条件正确时，仍会有小概率查询不到结果，请以实际业务消费情况为准，您可以通过查看客户端日志获取详细状态。具体信息，请参见日志配置。

相关文档

除了控制台，云消息队列 RocketMQ 版还支持通过API接口查询消息轨迹。

• OnsTraceQueryByMsgId - 根据MsgId创建轨迹查询任务

• OnsTraceQueryByMsgKey - 根据Message Key创建轨迹查询任务

• OnsTraceGetResult - 获取轨迹查询结果