监控 n8n
您可以调用三个 API 端点来检查实例的状态:/healthz、healthz/readiness 和 /metrics。
healthz 和 healthz/readiness
/healthz 端点返回标准 HTTP 状态代码。状态码 200 表示实例可访问,但不表示数据库状态。它适用于自托管和 Cloud 用户。
访问端点:
<your-instance-url>/healthz
/healthz/readiness 端点与 /healthz 端点类似,但如果数据库已连接并迁移,则它会返回 HTTP 状态代码 200,因此实例已准备好接受流量。
访问端点:
<your-instance-url>/healthz/readiness
提示
自定义健康检查端点
您可以使用 N8N_ENDPOINT_HEALTH 环境变量自定义运行状况检查端点路径。
指标
/metrics 端点提供有关实例当前状态的更多详细信息。
访问端点:
<your-instance-url>/metrics
提示
功能可用性
/metrics 端点可用于:
- 自托管: 所有版本
它在 n8n Cloud 上不可用。
如何启用指标和运行状况检查?
默认情况下,/metrics 端点处于禁用状态。主 n8n 服务器上始终启用运行状况端点。对于 队列模式 中的工作服务器,默认情况下禁用运行状况端点。
要启用它们,请配置您的 n8n 实例:
# metrics <a href="#metrics" id="metrics"></a>
N8N_METRICS=true
# healthz <a href="#healthz" id="healthz"></a>
QUEUE_HEALTH_CHECK_ACTIVE=true
有关如何使用环境变量配置实例的更多信息,请参阅 配置方法。
相关资源
不想自己部署和维护 n8n?n8ncn 托管 n8n 云服务:开通账号即可使用,不用买服务器;也可以在 n8ncn 工作流库 找现成的中文工作流。