인스턴스의 상태를 확인하기 위해 호출할 수 있는 API 엔드포인트는 /healthz, healthz/readiness, /metrics 세 가지입니다.

healthz 및 healthz/readiness#

/healthz 엔드포인트는 표준 HTTP 상태 코드를 반환합니다. 200은 인스턴스에 접근 가능함을 나타냅니다. 이는 DB 상태를 나타내지 않습니다. 셀프 호스팅 및 Cloud 사용자 모두 이용할 수 있습니다.

엔드포인트에 접근하려면:

<your-instance-url>/healthz

/healthz/readiness 엔드포인트는 /healthz 엔드포인트와 유사하지만, DB가 연결되고 마이그레이션이 완료되어 인스턴스가 트래픽을 수신할 준비가 된 경우 HTTP 상태 코드 200을 반환합니다.

엔드포인트에 접근하려면:

<your-instance-url>/healthz/readiness

metrics#

/metrics 엔드포인트는 인스턴스의 현재 상태에 대한 더 자세한 정보를 제공합니다.

엔드포인트에 접근하려면:

<your-instance-url>/metrics

셀프 호스팅 n8n에서 메트릭 및 헬스 체크 활성화하기#

/metrics 엔드포인트는 기본적으로 비활성화되어 있습니다. 헬스 엔드포인트는 메인 n8n 서버에서 항상 활성화되어 있습니다. 큐 모드의 워커 서버의 경우, 헬스 엔드포인트는 기본적으로 비활성화되어 있습니다.

이를 활성화하려면 n8n 인스턴스를 다음과 같이 구성하세요.

# metrics
N8N_METRICS=true
# healthz
QUEUE_HEALTH_CHECK_ACTIVE=true

환경 변수를 사용하여 인스턴스를 구성하는 방법에 대한 자세한 내용은 구성 방법을 참조하세요.