跳到主要内容

监控

可以调用三个 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 ​

/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

使用环境变量配置实例的更多信息,请参阅配置方式。

相关资源 ​

本文为社区中文翻译。查看对应英文原文