Skip to content

Commit 2fe1e75

Browse files
committed
Add info about custom health endpoint to Monitoring and Queue mode
1 parent 8df175e commit 2fe1e75

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

docs/hosting/logging-monitoring/monitoring.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,17 @@ Access the endpoint:
4040
/// info | Feature availability
4141
The `/metrics` endpoint isn't available on n8n Cloud.
4242
///
43+
44+
## Customizing the health check endpoint
45+
46+
You can customize the health check endpoint path using the `N8N_ENDPOINT_HEALTH` [environment variable](/hosting/configuration/environment-variables/endpoints.md).
47+
4348
<!-- vale off -->
44-
## Enable metrics and healthz for self-hosted n8n
49+
## Enable metrics and health checks for self-hosted n8n
4550
<!-- vale on -->
46-
The `/metrics` and `/healthz` endpoints are disabled by default. To enable them, configure your n8n instance:
51+
The `/metrics` endpoint is disabled by default. For the main n8n server, the health endpoint is always enabled. However, for worker servers in [queue mode](/hosting/scaling/queue-mode.md), the `/healthz` endpoint is disabled by default.
52+
53+
To enable them, configure your n8n instance:
4754

4855
```shell
4956
# metrics

docs/hosting/scaling/queue-mode.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,10 @@ Each worker process runs a server that exposes optional endpoints:
123123
- [credentials overwrite endpoint](/embed/configuration.md#credential-overwrites)
124124
- [`/metrics`](/hosting/configuration/configuration-examples/prometheus.md)
125125

126+
/// note | Customizing health check endpoints
127+
You can customize the health check endpoint path using the [`N8N_ENDPOINT_HEALTH`](/hosting/configuration/environment-variables/endpoints.md) environment variable.
128+
///
129+
126130
#### View running workers
127131

128132
/// info | Feature availability

0 commit comments

Comments
 (0)