fix(docs): correct typos and improve clarity in monitoring and some relevance docs

This commit is contained in:
goodnight
2026-03-31 00:53:46 +01:00
parent 21b09707b5
commit 48d8d761f2
8 changed files with 35 additions and 35 deletions
@@ -176,7 +176,7 @@ The account owner will receive automatic alerts via email if your cluster has an
**What can I do to resolve this?**
You can upgrade you cluster version by visiting the cluster details page.
You can upgrade your cluster version by visiting the cluster details page.
**Where can I learn more about this alert?**
@@ -188,11 +188,11 @@ The account owner will receive automatic alerts via email if your cluster has an
content: |
**Why am I getting this alert?**
A Database Key is expiring at soon.
A Database Key is expiring soon.
**What does this mean for me?**
Requests using an expired key won’t be successful, this could lead to fail queries and application failures.
Requests using an expired key won’t be successful, which could lead to failed queries and application failures.
**What can I do to resolve this?**
@@ -230,7 +230,7 @@ The account owner will receive automatic alerts via email if your cluster has an
**Where can I learn more about this alert?**
Learn about how to optimizer Qdrant for performance and how to configure indexing [here](/documentation/concepts/indexing/) and [here](/documentation/guides/optimize/).
Learn how to optimize Qdrant for performance and configure indexing [here](/documentation/concepts/indexing/) and [here](/documentation/guides/optimize/).
Learn about optimizers [here](/documentation/concepts/optimizer/).
@@ -294,7 +294,7 @@ To scrape metrics from a Qdrant cluster running in Qdrant Cloud, an [API key](/d
### Qdrant Node Metrics
Metrics in a Prometheus compatible format are available at the `/metrics` endpoint of each Qdrant database node. When scraping, you should use the [node specific URLs](/documentation/cloud/cluster-access/#node-specific-endpoints) to ensure that you are scraping metrics from all nodes in each cluster. For more information see [Qdrant monitoring](/documentation/guides/monitoring/).
Metrics in a Prometheus-compatible format are available at the `/metrics` endpoint of each Qdrant database node. When scraping, you should use the [node specific URLs](/documentation/cloud/cluster-access/#node-specific-endpoints) to ensure that you are scraping metrics from all nodes in each cluster. For more information, see [Qdrant monitoring](/documentation/guides/monitoring/).
You can also access the `/telemetry` [endpoint](https://api.qdrant.tech/api-reference/service/telemetry) of your database. This endpoint is available on the cluster endpoint and provides information about the current state of the database, including the number of vectors, shards, and other useful information.
@@ -304,17 +304,17 @@ For more information, see [Qdrant monitoring](/documentation/guides/monitoring/)
Cluster system metrics is a cloud-only endpoint that not only shares all the information about the database from `/metrics` but also provides additional operational data from our infrastructure about your cluster, including information from our load balancers, ingresses, and cluster workloads themselves.
Metrics in a Prometheus-compatible format are available at the `/sys_metrics` cluster endpoint. Database API Keys are used to authenticate access to cluster system metrics. `/sys_metrics` only need to be queried once per cluster on the main load-balanced cluster endpoint. You don't need to scrape each cluster node individually, instead it will always provide metrics about all nodes.
Metrics in a Prometheus-compatible format are available at the `/sys_metrics` cluster endpoint. Database API Keys are used to authenticate access to cluster system metrics. `/sys_metrics` only needs to be queried once per cluster on the main load-balanced cluster endpoint. You don't need to scrape each cluster node individually, instead it will always provide metrics about all nodes.
## Grafana Dashboard
If you scrape your Qdrant Cluster system metrics into your own monitoring system, and your are using Grafana, you can use our [Grafana dashboard](https://github.com/qdrant/qdrant-cloud-grafana-dashboard) to visualize these metrics.
If you scrape your Qdrant cluster system metrics into your own monitoring system, and you are using Grafana, you can use our [Grafana dashboard](https://github.com/qdrant/qdrant-cloud-grafana-dashboard) to visualize these metrics.
![Grafa dashboard](/documentation/cloud/cloud-grafana-dashboard.png)
![Grafana dashboard](/documentation/cloud/cloud-grafana-dashboard.png)
<iframe width="560" height="315" src="https://www.youtube.com/embed/pKPP-tL5_6w?si=ASKiG1P61m2YYk9J" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
### Cluster System Mtrics `/sys_metrics`
### Cluster System Metrics `/sys_metrics`
In Qdrant Cloud, each Qdrant cluster will expose the following metrics. This endpoint is not available when running Qdrant open-source.
@@ -325,7 +325,7 @@ In Qdrant Cloud, each Qdrant cluster will expose the following metrics. This end
| app_info | gauge | Information about the Qdrant server |
| app_status_recovery_mode | gauge | If Qdrant is currently started in recovery mode |
| cluster_commit | | |
| cluster_enabled | | Indicates wether multi-node clustering is enabled |
| cluster_enabled | | Indicates whether multi-node clustering is enabled |
| cluster_peers_total | counter | Total number of cluster peers |
| cluster_pending_operations_total | counter | Total number of pending operations in the cluster |
| cluster_term | | |