From 07b400b7f447e6555df084327ae66fce0fdb7a8a Mon Sep 17 00:00:00 2001 From: timvisee Date: Thu, 7 Sep 2023 14:17:26 +0200 Subject: [PATCH 1/2] Document Kubernetes healthz, readyz and livez endpoints --- .../content/documentation/guides/monitoring.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/qdrant-landing/content/documentation/guides/monitoring.md b/qdrant-landing/content/documentation/guides/monitoring.md index 957e3c0f3..e2b3085a9 100644 --- a/qdrant-landing/content/documentation/guides/monitoring.md +++ b/qdrant-landing/content/documentation/guides/monitoring.md @@ -51,3 +51,19 @@ There are also some metrics which are exposed in distributed mode only. | cluster_commit | counter | Index of last committed (finalized) operation cluster peer is aware of | | cluster_pending_operations_total | gauge | Total number of pending operations for cluster peer | | cluster_voter | gauge | Whether the cluster peer is a voter or learner | + +## Kubernetes health endpoints + +*Available as of v1.5.0* + +Qdrant exposes three endpoints, namely `/healthz`, `/livez` and `/readyz`, to +indicate the current status of the Qdrant server. + +These currently provide the most basic status response, returning HTTP 200 if +Qdrant is started and ready to be used. + +Regardless of whether an [API key](../security#authentication) is configured, +the endpoints are always accessible. + +You can read more about Kubernetes health endpoints +[here](https://kubernetes.io/docs/reference/using-api/health-checks/). From 8fc374b20a9e2fb2ce6dd79b3cda3ef302e9ac97 Mon Sep 17 00:00:00 2001 From: timvisee Date: Thu, 7 Sep 2023 14:21:19 +0200 Subject: [PATCH 2/2] Hyperlink endpoints --- qdrant-landing/content/documentation/guides/monitoring.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/qdrant-landing/content/documentation/guides/monitoring.md b/qdrant-landing/content/documentation/guides/monitoring.md index e2b3085a9..697f995ec 100644 --- a/qdrant-landing/content/documentation/guides/monitoring.md +++ b/qdrant-landing/content/documentation/guides/monitoring.md @@ -56,8 +56,11 @@ There are also some metrics which are exposed in distributed mode only. *Available as of v1.5.0* -Qdrant exposes three endpoints, namely `/healthz`, `/livez` and `/readyz`, to -indicate the current status of the Qdrant server. +Qdrant exposes three endpoints, namely +[`/healthz`](http://localhost:6333/healthz), +[`/livez`](http://localhost:6333/livez) and +[`/readyz`](http://localhost:6333/readyz), to indicate the current status of the +Qdrant server. These currently provide the most basic status response, returning HTTP 200 if Qdrant is started and ready to be used.