Skip to content

Commit

Permalink
Merge pull request #1335 from qdrant/feat/bashofmann/cloud-docs-impro…
Browse files Browse the repository at this point in the history
…vement

Further improvements of cloud docs
  • Loading branch information
davidmyriel authored Dec 10, 2024
2 parents ee51aeb + 8ef88ed commit 58cdf61
Show file tree
Hide file tree
Showing 8 changed files with 64 additions and 19 deletions.
13 changes: 6 additions & 7 deletions qdrant-landing/content/documentation/cloud/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,16 @@ weight: 30

# Database Authentication in Qdrant Managed Cloud

This page shows you how to use the Qdrant Cloud Console to create a custom API key for a cluster. You will learn how to connect to your cluster using the new API key.
This page shows you how to use the Qdrant Cloud Console to create a Database API key for a cluster. You will learn how to connect to your cluster using the new API key.

## Create API keys
## Create Database API keys

The API key is only shown once after creation. If you lose it, you will need to create a new one.
However, we recommend rotating the keys from time to time. To create additional API keys do the following.

1. Go to the [Cloud Dashboard](https://qdrant.to/cloud).
2. Select **Access Management** to display available API keys, or go to the **API Keys** section of the Cluster detail page.
3. Click **Create** and choose a cluster name from the dropdown menu.
> **Note:** You can create a key that provides access to multiple clusters. Select desired clusters in the dropdown box.
2. Go to the **API Keys** section of the Cluster detail page.
3. Click **Create**. If you have granular access control activated, you can now configure the permissions for the new key.
4. Click **OK** and retrieve your API key.

## Test cluster access
Expand All @@ -38,8 +37,8 @@ Open Terminal and run the request. You should get a response that looks like thi
## Authenticate via SDK

Now that you have created your first cluster and key, you might want to access Qdrant Cloud from within your application.
Our official Qdrant clients for Python, TypeScript, Go, Rust, .NET and Java all support the API key parameter.
Now that you have created your first cluster and key, you might want to access your database from within your application.
Our [official Qdrant clients](/documentation/interfaces/) for Python, TypeScript, Go, Rust, .NET and Java all support the API key parameter.

```bash
curl \
Expand Down
30 changes: 30 additions & 0 deletions qdrant-landing/content/documentation/cloud/cluster-access.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: Cluster Access
weight: 35
---

# Accessing Qdrant Cloud Clusters

Once you [created](/documentation/cloud/create-cluster/) a cluster, and set up an [API key](/documentation/cloud/authentication/), you can access your cluster through the integrated Web UI, the REST API and the GRPC API.

## Web UI

There is the convenient link on the cluster detail page in the Qdrant Cloud Console to access the [Web UI](/documentation/web-ui/) of your cluster.

![Cluster Web UI](/documentation/cloud/cloud-db-dashboard.png)

## API

The REST API is exposed on your cluster endpoint at port `6333`. The GRPC API is exposed on your cluster endpoint at port `6334`. When accessing the cluster endpoint, traffic is automatically load balanced across all healthy Qdrant nodes in the cluster. For all operations, but the few mentioned at [Node specific endpoints](#node-specific-endpoints), you should use the cluster endpoint. It does not matter which node in the cluster you land on. All nodes can handle all search and write requests.

![Cluster cluster endpoint](/documentation/cloud/cloud-endpoint.png)

Have a look at the [API reference](/documentation/interfaces/#api-reference) and the official [client libraries](/documentation/interfaces/#client-libraries) for more information on how to interact with the Qdrant Cloud API.

## Node specific endpoints

Next to the cluster endpoint which loadbalances requests across all healthy Qdrant nodes, each node in the cluster has its own endpoint as well. This is mainly usefull for monitoring or manual shard management purpuses.

You can finde the node specific endpoints on the cluster detail page in the Qdrant Cloud Console.

![Cluster node endpoints](/documentation/cloud/cloud-node-endpoints.png)
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,11 @@ Logs of the database cluster are available in the Qdrant Cloud Console in the **
## Alerts

You will receive automatic alerts via email before your cluster reaches the currently configured memory or storage limits, including recommendations for scaling your cluster.

## Qdrant database metrics and telemetry

You can also directly access the metrics and telemetry that the Qdrant database nodes provide.

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.
8 changes: 6 additions & 2 deletions qdrant-landing/content/documentation/guides/monitoring.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Monitoring
title: Monitoring & Telemetry
weight: 155
aliases:
- ../monitoring
---

# Monitoring
# Monitoring & Telemetry

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
Expand Down Expand Up @@ -62,6 +62,10 @@ There are also some metrics which are exposed in distributed mode only.
| 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. 1 - VOTER |

## Telemetry endpoint

Qdrant also provides a `/telemetry` endpoint, which provides information about the current state of the database, including the number of vectors, shards, and other useful information. You can find a full documentation of this endpoint in the [API reference](https://api.qdrant.tech/api-reference/service/telemetry).

## Kubernetes health endpoints

*Available as of v1.5.0*
Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,20 @@
---
title: Telemetry
weight: 150
title: Usage Statistics
weight: 166
aliases:
- ../telemetry
- /documentation/guides/telemetry
---

# Telemetry
# Usage statistics

Qdrant collects anonymized usage statistics from users in order to improve the engine.
You can [deactivate](#deactivate-telemetry) at any time, and any data that has already been collected can be [deleted on request](#request-information-deletion).
The Qdrant open-source container image collects anonymized usage statistics from users in order to improve the engine by default. You can [deactivate](#deactivate-telemetry) at any time, and any data that has already been collected can be [deleted on request](#request-information-deletion).

## Why do we collect telemetry?
Deactivating this will not affect your ability to monitor the Qdrant database yourself by accessing the `/metrics` or `/telemetry` endpoints of your database. It will just stop sending independend, anonymized usage statistics to the Qdrant team.

<aside role="status">When using Qdrant Cloud, this setting does not apply and anonymized usage statistics are disabled by default.</aside>

## Why do we collect usage statistics?

We want to make Qdrant fast and reliable. To do this, we need to understand how it performs in real-world scenarios.
We do a lot of benchmarking internally, but it is impossible to cover all possible use cases, hardware, and configurations.
Expand Down Expand Up @@ -55,17 +59,17 @@ You can see exact version of anomymized collected data by accessing the [telemet
For example, <http://localhost:6333/telemetry?details_level=6&anonymize=true>


## Deactivate telemetry
## Deactivate usage statistics

You can deactivate telemetry by:
You can deactivate usage statistics by:

- setting the `QDRANT__TELEMETRY_DISABLED` environment variable to `true`
- setting the config option `telemetry_disabled` to `true` in the `config/production.yaml` or `config/config.yaml` files
- using cli option `--disable-telemetry`

Any of these options will prevent Qdrant from sending any telemetry data.
Any of these options will prevent Qdrant from sending any usage statistics data.

If you decide to deactivate telemetry, we kindly ask you to share your feedback with us in the [Discord community](https://qdrant.to/discord) or GitHub [discussions](https://github.com/qdrant/qdrant/discussions)
If you decide to deactivate usage statistics, we kindly ask you to share your feedback with us in the [Discord community](https://qdrant.to/discord) or GitHub [discussions](https://github.com/qdrant/qdrant/discussions)

## Request information deletion

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 58cdf61

Please sign in to comment.