Skip to content

监控#

您可以调用三个 API 端点来检查实例的状态：/healthz、healthz/readiness 和 /metrics。

healthz 和 healthz/readiness#

/healthz 端点返回标准的 HTTP 状态码。200 表示实例可达。它不表示数据库状态。它适用于自托管和云用户。

访问端点：

1
<your-instance-url>/healthz

/healthz/readiness 端点类似于 /healthz 端点，但如果数据库已连接并迁移，因此实例准备好接受流量，它会返回 HTTP 状态码 200。

访问端点：

1
<your-instance-url>/healthz/readiness

自定义健康检查端点

您可以使用 N8N_ENDPOINT_HEALTH 环境变量自定义健康检查端点路径。

metrics#

/metrics 端点提供有关实例当前状态的更详细信息。

访问端点：

1
<your-instance-url>/metrics

功能可用性

/metrics 端点在 n8n Cloud 上不可用。

为自托管 n8n 启用 metrics 和健康检查#

/metrics 端点默认禁用。健康检查端点在主 n8n 服务器上始终启用；在队列模式下的 worker 服务器中，健康检查端点默认禁用。

要启用这些功能，请配置您的 n8n 实例：

1
2
3
4
# metrics
N8N_METRICS=true
# healthz
QUEUE_HEALTH_CHECK_ACTIVE=true

有关如何使用环境变量配置实例的更多信息，请参考配置方法。