centersl/n8n-docs
1
0
Fork 0
mirror of https://github.com/n8n-io/n8n-docs.git synced 2026-03-27 09:28:43 +07:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add /healthz/readiness endpoint (#2455)

Browse Source 
Co-authored-by: Kate Mueller <freakwriter@users.noreply.github.com>
This commit is contained in:
Iván Ovejero
2024-09-10 16:23:12 +02:00
committed by GitHub
parent 58b44f8959
commit 5b40f5c97f
1 changed files with 11 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/hosting/logging-monitoring/monitoring.md
View File

@@ -6,12 +6,12 @@ contentType: howto
# Monitoring
There are two API endpoints you can call to check the status of your instance: `/healthz` and `/metrics`.
There are three API endpoints you can call to check the status of your instance: `/healthz`, `healthz/readiness`, and `/metrics`.
<!-- vale off -->
## healthz
## healthz and healthz/readiness
<!-- vale on -->
The `/healthz` endpoint returns a standard HTTP status code. 200 indicates the instance is reachable. It's available for both self-hosted and Cloud users.
The `/healthz` endpoint returns a standard HTTP status code. 200 indicates the instance is reachable. It doesn't indicate DB status. It's available for both self-hosted and Cloud users.
Access the endpoint:
@@ -19,6 +19,14 @@ Access the endpoint:
<your-instance-url>/healthz
```
The `/healthz/readiness` endpoint is similar to the `/healthz` endpoint, but it returns a HTTP status code of 200 if the DB is connected and migrated and therefore the instance is ready to accept traffic.
Access the endpoint:
```
<your-instance-url>/healthz/readiness
```
## metrics