使用 Grafana 可视化指标
在 n8n 中启用 Prometheus 指标端点,然后通过 Prometheus 实例连接 Grafana 以可视化您的 n8n 数据。在遵循本指南之前,请参阅 启用 Prometheus 指标。
提示
功能可用性
/metrics 端点可用于:
- 自托管: 所有版本
它在 n8n Cloud 上不可用。
可重复使用的仪表板模板
为 n8n 实例启用 Prometheus 指标后,您将需要构建仪表板来观察它们。
n8n 在此 GitHub 项目中为多个受支持的 Prometheus 指标发布可复用的 Grafana 仪表板:n8n-observability。
配置 Prometheus 抓取 n8n
Prometheus 按计划抓取 n8n 的 /metrics 端点并存储数据。然后 Grafana 查询 Prometheus 来显示它。
在 prometheus.yml 中添加针对 n8n 实例的抓取作业:
scrape_configs:
- job_name: n8n
static_configs:
- targets:
- <n8n-host>:<n8n-port>
metrics_path: /metrics
将 <n8n-host> 和 <n8n-port> 替换为您的 n8n 实例地址。默认 n8n 端口为 5678。
编辑后,重新加载或重新启动 Prometheus 以应用更改。
添加 Prometheus 作为 Grafana 数据源
- 在 Grafana 中,转到 连接 > 数据源。
- 选择添加新数据源。
- 选择 Prometheus。
- 将 Prometheus 服务器 URL 设置为您的 Prometheus 实例地址,例如
http://prometheus:9090。 - 选择保存并测试。
Grafana 通过成功消息确认连接。
Webhook 可观测性
提示
功能可用性
Webhook 可观察性可从 n8n 2.28.0 开始使用。
n8n 为每个 Webhook 调用公开一个 n8n_webhook_request_duration_seconds 直方图。启用这些环境变量来收集它:
| 变量 | 默认值 | 说明 |
|---|---|---|
N8N_METRICS_INCLUDE_WEBHOOK_METRICS |
false |
显示 n8n_webhook_request_duration_seconds 直方图。 |
N8N_METRICS_INCLUDE_WORKFLOW_INFO |
false |
公开 n8n_workflow_info 仪表以获取人类可读的工作流程名称。参见 工作流程名称查找。 |
您可以在我们的 n8n 可观测性项目中找到此直方图的 即用型仪表板。
指标跟踪什么
n8n_webhook_request_duration_seconds 是 Prometheus 直方图。对于每个 webhook 调用,n8n 记录请求花费的时间(“收到请求”->“发送响应”的时间)。该指标公开了每个标签组合的三个系列:
| 系列 | 描述 |
|---|---|
_bucket{le="<bound>"} |
<bound> 秒内完成的请求的累积计数。 |
_sum |
所有请求花费的总秒数。 |
_count |
请求总数。 |
每个系列都带有以下标签:
| 标签 | 示例 | 说明 |
|---|---|---|
method |
GET |
HTTP 传入请求的方法。 |
status_code |
200 |
n8n 返回的 HTTP 状态代码。 |
webhook_path |
294febd8-… |
UUID 标识 Webhook 端点的路径。 |
workflow_id |
KhcGg7EmAMoa7Bmv |
Webhook 所属工作流的 ID。 |
仪表板想法
| 面板 | PromQL |
|---|---|
| 每个工作流程的请求率 | sum by (workflow_id) (rate(n8n_webhook_request_duration_seconds_count[5m])) |
| 所有 Webhooks 的 p95 延迟 | histogram_quantile(0.95, sum by (le) (rate(n8n_webhook_request_duration_seconds_bucket[5m]))) |
| 每个工作流程的 p95 延迟 | histogram_quantile(0.95, sum by (le, workflow_id) (rate(n8n_webhook_request_duration_seconds_bucket[5m]))) |
| 错误率(非 2xx) | sum by (workflow_id) (rate(n8n_webhook_request_duration_seconds_count{status_code!="2.."}[5m])) |
| 平均请求持续时间 | rate(n8n_webhook_request_duration_seconds_sum[5m]) / rate(n8n_webhook_request_duration_seconds_count[5m]) |
表单提交可观测性
提示
功能可用性
从 n8n 2.28.0 开始,表单提交可观察性可用。
n8n 为每个表单提交公开一个 n8n_form_submission_duration_seconds 直方图。启用这些环境变量来收集它:
| 变量 | 默认值 | 说明 |
|---|---|---|
N8N_METRICS_INCLUDE_FORM_METRICS |
false |
显示 n8n_form_submission_duration_seconds 直方图。 |
N8N_METRICS_INCLUDE_WORKFLOW_INFO |
false |
公开 n8n_workflow_info 仪表以获取人类可读的工作流程名称。参见 工作流程名称查找。 |
您可以在我们的 n8n 可观测性项目中找到此直方图的 即用型仪表板。
指标跟踪什么
n8n_form_submission_duration_seconds 是 Prometheus 直方图。对于每个表单提交,n8n 记录从“用户按下提交”到“用户获得表单提交反馈”所花费的时间。该指标公开了每个标签组合的三个系列:
| 系列 | 描述 |
|---|---|
_bucket{le="<bound>"} |
在 <bound> 秒内完成的提交的累积计数。 |
_sum |
处理所有提交所花费的总秒数。 |
_count |
提交总数。 |
每个系列都带有这些标签:
| 标签 | 示例 | 描述 |
|---|---|---|
status_code |
200 |
HTTP 返回状态代码 n8n。 |
form_path |
b395d2e2-… |
UUID 标识表单端点的路径。 |
workflow_id |
qTzTyGlEROwSuVlY |
表单所属工作流的 ID。 |
提示
无方法标签
表单提交不包含 method 标签,因为 n8n 仅通过 POST 接受表单数据。
仪表板想法
| 面板 | PromQL |
|---|---|
| 每个工作流程的提交率 | sum by (workflow_id) (rate(n8n_form_submission_duration_seconds_count[5m])) |
| p95 跨所有表格的处理时间 | histogram_quantile(0.95, sum by (le) (rate(n8n_form_submission_duration_seconds_bucket[5m]))) |
| 每个工作流程的 p95 处理时间 | histogram_quantile(0.95, sum by (le, workflow_id) (rate(n8n_form_submission_duration_seconds_bucket[5m]))) |
| 错误率(非 2xx) | sum by (workflow_id) (rate(n8n_form_submission_duration_seconds_count{status_code!="2.."}[5m])) |
| 平均处理时间 | rate(n8n_form_submission_duration_seconds_sum[5m]) / rate(n8n_form_submission_duration_seconds_count[5m]) |
持久调度器可观测性
n8n 会公开持久调度器的队列深度、调度延迟、分派、重试和死信指标。使用 N8N_METRICS_INCLUDE_SCHEDULER_METRICS 启用这些指标,然后参阅持久调度器可观测性了解各指标的含义。n8n 为这些指标发布了即用型仪表板。
轮询触发器可观测性
n8n 会公开轮询触发器的轮询持续时间、轮询错误、重叠轮询和游标提交指标。使用 N8N_METRICS_INCLUDE_POLL_TRIGGER_METRICS 启用这些指标,然后参阅轮询触发器指标了解各指标的含义。n8n 为这些指标发布了即用型仪表板。
系统任务可观测性
n8n 会为自身的系统任务(用于修剪和压缩数据的维护任务)公开运行持续时间、最后成功时间、正在运行、跳过和计时器延迟指标。使用 N8N_METRICS_INCLUDE_SYSTEM_TASK_METRICS 启用这些指标,然后参阅系统任务可观测性了解各指标的含义。n8n 还为这些指标发布了即用型仪表板。
工作流名称查找
提示
功能可用性
从 n8n 2.28.0 开始可进行工作流程名称查找。
当您启用 N8N_METRICS_INCLUDE_WORKFLOW_INFO 时,n8n 会为每个工作流程公开一个仪表:
n8n_workflow_info{workflow_id="VaQPuPmx9tPpo6BX",workflow_name="My workflow"} 1
通过 workflow_id 将其连接到任何其他 n8n 指标,以在 Grafana 面板中用人类可读的名称替换不透明的 ID。例如,要按工作流名称显示 Webhook 请求率:
sum by (workflow_name) (
rate(n8n_webhook_request_duration_seconds_count[5m])
* on(workflow_id) group_left(workflow_name)
n8n_workflow_info
)