From 5b40f5c97fcb4e5e493f22577dee8d59992d55fa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Iv=C3=A1n=20Ovejero?= Date: Tue, 10 Sep 2024 16:23:12 +0200 Subject: [PATCH] docs: Add `/healthz/readiness` endpoint (#2455) Co-authored-by: Kate Mueller --- docs/hosting/logging-monitoring/monitoring.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/hosting/logging-monitoring/monitoring.md b/docs/hosting/logging-monitoring/monitoring.md index 9b9d992d1..1bd38abc1 100644 --- a/docs/hosting/logging-monitoring/monitoring.md +++ b/docs/hosting/logging-monitoring/monitoring.md @@ -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`. -## healthz +## healthz and healthz/readiness -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: /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: + +``` +/healthz/readiness +``` + ## metrics