mirror of
https://github.com/qdrant/landing_page.git
synced 2026-09-29 07:58:31 +02:00
83 lines
4.8 KiB
Markdown
83 lines
4.8 KiB
Markdown
---
|
|
title: Monitoring
|
|
weight: 155
|
|
aliases:
|
|
- ../monitoring
|
|
---
|
|
|
|
# Monitoring
|
|
|
|
Qdrant exposes its metrics in [Prometheus](https://prometheus.io/docs/instrumenting/exposition_formats/#text-based-format)/[OpenMetrics](https://github.com/OpenObservability/OpenMetrics) format, so you can integrate them easily
|
|
with the compatible tools and monitor Qdrant with your own monitoring system. You can
|
|
use the `/metrics` endpoint and configure it as a scrape target.
|
|
|
|
Metrics endpoint: <http://localhost:6333/metrics>
|
|
|
|
The integration with Qdrant is easy to
|
|
[configure](https://prometheus.io/docs/prometheus/latest/getting_started/#configure-prometheus-to-monitor-the-sample-targets)
|
|
with Prometheus and Grafana.
|
|
|
|
## Monitoring multi-node clusters
|
|
|
|
When scraping metrics from multi-node Qdrant clusters, it is important to scrape from
|
|
each node individually instead of using a load-balanced URL. Otherwise, your metrics will appear inconsistent after each scrape.
|
|
|
|
## Monitoring in Qdrant Cloud
|
|
|
|
To scrape metrics from a Qdrant cluster running in Qdrant Cloud, note that an [API key](/documentation/cloud/authentication/) is required to access `/metrics`. Qdrant Cloud also supports supplying the API key as a [Bearer token](https://www.rfc-editor.org/rfc/rfc6750.html), which may be required by some providers.
|
|
|
|
## Exposed metrics
|
|
|
|
Each Qdrant server will expose the following metrics.
|
|
|
|
| Name | Type | Meaning |
|
|
|-------------------------------------|---------|---------------------------------------------------|
|
|
| app_info | counter | Information about Qdrant server |
|
|
| app_status_recovery_mode | counter | If Qdrant is currently started in recovery mode |
|
|
| collections_total | gauge | Number of collections |
|
|
| collections_vector_total | gauge | Total number of vectors in all collections |
|
|
| collections_full_total | gauge | Number of full collections |
|
|
| collections_aggregated_total | gauge | Number of aggregated collections |
|
|
| rest_responses_total | counter | Total number of responses through REST API |
|
|
| rest_responses_fail_total | counter | Total number of failed responses through REST API |
|
|
| rest_responses_avg_duration_seconds | gauge | Average response duration in REST API |
|
|
| rest_responses_min_duration_seconds | gauge | Minimum response duration in REST API |
|
|
| rest_responses_max_duration_seconds | gauge | Maximum response duration in REST API |
|
|
| grpc_responses_total | counter | Total number of responses through gRPC API |
|
|
| grpc_responses_fail_total | counter | Total number of failed responses through REST API |
|
|
| grpc_responses_avg_duration_seconds | gauge | Average response duration in gRPC API |
|
|
| grpc_responses_min_duration_seconds | gauge | Minimum response duration in gRPC API |
|
|
| grpc_responses_max_duration_seconds | gauge | Maximum response duration in gRPC API |
|
|
| cluster_enabled | gauge | Whether the cluster support is enabled |
|
|
|
|
### Cluster related metrics
|
|
|
|
There are also some metrics which are exposed in distributed mode only.
|
|
|
|
| Name | Type | Meaning |
|
|
|----------------------------------|---------|------------------------------------------------------------------------|
|
|
| cluster_peers_total | gauge | Total number of cluster peers |
|
|
| cluster_term | counter | Current cluster term |
|
|
| 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`](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.
|
|
|
|
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/).
|