跳转到内容
Telemetry
集成指南

RabbitMQ 队列 Telemetry

通过结构化事件跟踪 RabbitMQ 发布确认、传送、确认、重新传送、队列等待、重试和死信结果。

审阅者 Telemetry产品团队 . 埋点合约、隐私边界和实施指南. 审查标准和所有权

有用于
  • 队列可靠性
  • 重新投递和重试分析
  • 死信监控
实施证据

RabbitMQ Queue Telemetry:从边界到验证行

在受控应用程序边界使用 RabbitMQ Queue Telemetry,保持事件契约较小,并在构建聚合视图之前验证已知结果。

  1. 1

    选择结果

    队列可靠性

  2. 2

    定义合同

    message_id、message_type、交换、routing_key、queue_name、发布

  3. 3

    埋点边界

    将发布者确认和消费者确认视为不同的边界;两者都不能证明下游业务行动已完成。

  4. 4

    核实证据

    Exercise a known fixture, then inspect rabbitmq_message_completed for one correctly typed terminal row.

开始之前

先决条件和界限

  • amqplib 和 telemetry-sh 在可信生产者或消费者进程中初始化
  • 稳定的逻辑消息 ID、队列分类和终端结果定义
  • 当工作流程需要交付证据时,出版商确认并手动向消费者确认

交货设置

安装并初始化服务器端

在仅服务器代码中导入 telemetry-sh 并使用 process.env.TELEMETRY_API_KEY 对其进行一次初始化。 将摄取凭据保留在浏览器包、客户端可见的环境变量、源代码控制、日志和异常消息之外。

rabbitmq-安装

npm安装

bash
npm install telemetry-sh
  1. 1准备一个具有有限网络行为的可重用服务器端交付客户端。
  2. 2在成功、失败、重试或超时边界处添加结果事件。
  3. 3在启用警报之前发送受控装置并检查存储的行。

片段

从一个结构化事件开始

在工作流程完成、失败或重试的位置添加此形状。然后从真实的字段构建仪表板。

rabbitmq

RabbitMQ Queue Telemetry事件

javascript
await telemetry.log("rabbitmq_message_completed", {
  message_id: message.properties.messageId,
  message_type: "invoice_recalculation",
  exchange: "billing",
  routing_key: message.fields.routingKey,
  queue_name: "billing.recalculate",
  status: "success",
  attempt: Number(message.properties.headers?.attempt ?? 1),
  redelivered: message.fields.redelivered,
  wait_ms: Date.now() - Number(message.properties.timestamp) * 1000,
  duration_ms: Math.round(performance.now() - startedAt),
  dead_lettered: false,
  consumer_name: "billing-worker",
  release: process.env.APP_RELEASE,
});

活动合约

message_id、message_type、交换、routing_key、queue_name、发布

状态、尝试、重新投递、wait_ms、duration_ms 和 error_type

published_at、acknowledged_at、dead_lettered 和 consumer_name

实施检查点

检查站 1

将发布者确认和消费者确认视为不同的边界;两者都不能证明下游业务行动已完成。

检查站 2

在重新交付中使用稳定的 message_id 和单独的尝试值,以便重试保持可见,而不会夸大最终结果。

检查站 3

从批准的已发布时间戳开始测量队列等待,并且切勿将消息正文或不受限制的代理错误复制到事件中。

验证

证明事件已到达

在演练已知的成功和失败案例后运行此命令。如果您的最终事件契约与代码片段不同,请替换后备表名称。

rabbitmq-验证

RabbitMQ Queue Telemetry 验证查询

sql
SELECT *
FROM rabbitmq_message_completed
ORDER BY timestamp_utc DESC
LIMIT 20;
确认每个逻辑结果的一个终端行,以及预期状态、标识符、单位和 UTC 时间。
检查推断的架构并验证重试不会更改字段类型或生成新的逻辑事件 ID。
在存储的字段中搜索凭据、原始有效负载、提示、私有内容和无限制的错误消息。
在将仪表板视为完整之前,请执行提供程序超时、摄取拒绝和进程关闭。

实施参考

在启用新的生产路径之前,请检查事件合同、数据安全指南和上游主要文档。

生产边界

保持结果事件小且可恢复

该模式提供了

  • 除了上游工作流程之外,还有一个有界的、SQL 就绪的结果。
  • 用于仪表板、警报和跨事件关联的稳定字段。
  • 用于验证成功、失败、重试和超时行为的夹具驱动路径。

该模式不提供

  • OTLP 导出器、自动收集管道或详细跟踪和诊断日志的替代品。
  • 仅因为有效负载包含事件 ID,所以仅传送一次。
  • 收集原始提供商有效负载、用户内容、凭证或受监管数据的权限。

事件架构起点

在将查询或代码片段适应生产之前,请检查行粒度、发出边界、所需类型、隐私类、示例有效负载和验证清单。

相关产品功能

继续此工作流程 告警

将经过审查的可靠性查询提升到拥有的阈值和响应工作流程中。

相关 SQL 查询示例

用 SQL 回答下一个问题

针对此工作流程中的结构化字段运行查询,检查示例结果,并将有用的答案转换为仪表板或警报。

浏览所有查询示例
完整系列后台任务 SQL

按实施系列浏览

比较相关集成模式

与此集成配对的模板

更多集成