跳转到内容
Telemetry
集成指南

n8n 工作流程 Telemetry

通过 HTTP 请求节点将 n8n 工作流完成、失败、重试、项目计数和下游交付结果发送到有界 Telemetry 事件。

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

有用于
  • 工作流程完成情况监控
  • 自动化故障和重试分析
  • 预定集成可靠性
实施证据

n8n Workflow Telemetry:从边界到验证行

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

  1. 1

    选择结果

    工作流程完成情况监控

  2. 2

    定义合同

    execution_id、workflow_name、workflow_version、trigger_type、schedule_name 和释放

  3. 3

    埋点边界

    使用单独的显式成功和错误分支,以便 HTTP 请求节点接收最终工作流结果而不是中间节点结果。

  4. 4

    核实证据

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

开始之前

先决条件和界限

  • 放置在显式成功或错误分支上的 n8n HTTP 请求节点
  • 包含 Telemetry API 密钥而不是嵌入到工作流程中的值的标头身份验证凭据
  • 仅准备批准的工作流元数据和有界结果字段的 Set 节点

交货设置

安装并初始化服务器端

使用服务器端密钥和有限的 HTTP 超时将记录的 JSON 形状发送到日志 API。 将摄取凭据保留在浏览器包、客户端可见的环境变量、源代码控制、日志和异常消息之外。

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

片段

从一个结构化事件开始

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

n8n

n8n Workflow Telemetry事件

json
{
  "method": "POST",
  "url": "https://api.telemetry.sh/log",
  "authentication": "predefined-header-credential",
  "timeout_ms": 2000,
  "body": {
    "table": "n8n_workflow_completed",
    "data": {
      "execution_id": "={{ $json.execution_id }}",
      "workflow_name": "={{ $json.workflow_name }}",
      "workflow_version": "={{ $json.workflow_version }}",
      "trigger_type": "={{ $json.trigger_type }}",
      "status": "={{ $json.status }}",
      "duration_ms": "={{ $json.duration_ms }}",
      "retry_count": "={{ $json.retry_count }}",
      "item_count": "={{ $json.item_count }}",
      "error_type": "={{ $json.error_type }}",
      "release": "={{ $json.release }}"
    }
  }
}

活动合约

execution_id、workflow_name、workflow_version、trigger_type、schedule_name 和释放

状态、duration_ms、retry_count、item_count、failed_step 和 error_type

account_id、integration_name、delivery_status、批准后的环境和地区

实施检查点

检查站 1

使用单独的显式成功和错误分支,以便 HTTP 请求节点接收最终工作流结果而不是中间节点结果。

检查站 2

根据是否允许可观测性交付影响自动化结果,配置有界超时和失败时继续。

检查站 3

不要发送包含私有数据的源项主体、凭证、令牌、表达式、任意错误消息或完整的 n8n 执行数据。

验证

证明事件已到达

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

n8n-验证

n8n Workflow Telemetry 验证查询

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

实施参考

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

生产边界

保持结果事件小且可恢复

该模式提供了

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

该模式不提供

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

事件架构起点

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

相关产品功能

继续此工作流程 告警

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

相关 SQL 查询示例

用 SQL 回答下一个问题

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

浏览所有查询示例

按实施系列浏览

比较相关集成模式

与此集成配对的模板

更多集成