diff --git a/qdrant-landing/content/documentation/headless/content/tutorials/operations.md b/qdrant-landing/content/documentation/headless/content/tutorials/operations.md index a2aeecad1d..7913b8c57d 100644 --- a/qdrant-landing/content/documentation/headless/content/tutorials/operations.md +++ b/qdrant-landing/content/documentation/headless/content/tutorials/operations.md @@ -7,4 +7,5 @@ | [Large-Scale Search](/documentation/tutorials-operations/large-scale-search/) | Cost-efficient search for LAION-400M datasets. | Any | 48h | Advanced | | [Secure a Self-Hosted Instance](/documentation/tutorials-operations/secure-qdrant/) | Enable TLS, API keys, and JWT access control. | Any | 45m | Intermediate | | [Qdrant Cloud Prometheus Monitoring](/documentation/ops-monitoring/managed-cloud-prometheus/) | Observability with Prometheus and Grafana. | Prometheus | 30m | Intermediate | -| [Self-Hosted Prometheus Monitoring](/documentation/ops-monitoring/hybrid-cloud-prometheus/) | Observability for hybrid/private cloud setups. | Prometheus | 30m | Intermediate | \ No newline at end of file +| [Self-Hosted Prometheus Monitoring](/documentation/ops-monitoring/hybrid-cloud-prometheus/) | Observability for hybrid/private cloud setups. | Prometheus | 30m | Intermediate | +| [Monitoring Hybrid/Private Cloud with Datadog](/documentation/ops-monitoring/hybrid-cloud-datadog/) | Observability for hybrid/private cloud setups with Datadog. | Datadog | 20m | Intermediate | \ No newline at end of file diff --git a/qdrant-landing/content/documentation/ops-monitoring/_index.md b/qdrant-landing/content/documentation/ops-monitoring/_index.md index b86d61447e..561b7383f4 100644 --- a/qdrant-landing/content/documentation/ops-monitoring/_index.md +++ b/qdrant-landing/content/documentation/ops-monitoring/_index.md @@ -21,3 +21,7 @@ These pages cover how to observe and measure a running Qdrant deployment using i ## Self-Hosted Prometheus Monitoring [Self-Hosted Prometheus Monitoring](/documentation/ops-monitoring/hybrid-cloud-prometheus/) is a step-by-step tutorial for setting up Prometheus and Grafana monitoring for Qdrant running in a Hybrid Cloud or Private Cloud environment. + +## Monitoring Hybrid/Private Cloud with Datadog + +[Monitoring Hybrid/Private Cloud with Datadog](/documentation/ops-monitoring/hybrid-cloud-datadog/) is a step-by-step tutorial for setting up Datadog to monitor Qdrant running in a Hybrid Cloud or Private Cloud environment. diff --git a/qdrant-landing/content/documentation/ops-monitoring/hybrid-cloud-datadog.md b/qdrant-landing/content/documentation/ops-monitoring/hybrid-cloud-datadog.md new file mode 100644 index 0000000000..28960ddea8 --- /dev/null +++ b/qdrant-landing/content/documentation/ops-monitoring/hybrid-cloud-datadog.md @@ -0,0 +1,109 @@ +--- +title: Monitoring with Datadog +short_description: "Monitor Qdrant Hybrid Cloud and Private Cloud deployments by setting up the Datadog Operator and Agent in your Kubernetes cluster." +description: "Set up the Datadog Operator in Kubernetes to scrape Qdrant metrics from Hybrid Cloud and Private Cloud clusters using OpenMetrics, and visualize them in Datadog." +weight: 20 +--- + +# Monitoring Hybrid/Private Cloud with Datadog + +| Time: 20 min | Level: Intermediate | +| --- | ----------- | + +This tutorial will guide you through the process of setting up Datadog to monitor Qdrant clusters running in a Kubernetes cluster used for Hybrid or Private Cloud. + +## Prerequisites + +- A Kubernetes cluster with a Qdrant database deployed, using either a Hybrid Cloud or Private Cloud deployment +- `kubectl` and `helm` configured to interact with your cluster +- A Datadog account and a [Datadog API key](https://docs.datadoghq.com/account_management/api-app-keys/) + +## Step 1: Install the Datadog Operator + +If you haven't installed Datadog in your cluster yet, you can use the [Datadog Operator](https://docs.datadoghq.com/containers/datadog_operator/) to deploy and manage the Datadog Agent. The Operator runs the Agent as a DaemonSet, with one pod on every node of your cluster. + +Add the Datadog Helm repository and install the Operator: + +```shell +helm repo add datadog https://helm.datadoghq.com + +helm install datadog-operator datadog/datadog-operator --namespace datadog --create-namespace +``` + +Next, create a Kubernetes secret that holds your Datadog API key. The Agent reads this secret to authenticate with Datadog: + +```shell +kubectl create secret generic datadog-secret --namespace datadog --from-literal api-key= +``` + +Replace `` with your own API key. + +## Step 2: Configure the Datadog Agent to Scrape Qdrant Metrics + +To monitor Qdrant, configure the Datadog Agent to scrape metrics from your Qdrant database. Create a `DatadogAgent` resource that adds an [OpenMetrics](https://docs.datadoghq.com/integrations/openmetrics/) check through the Agent's Autodiscovery mechanism. + +The Agent uses the `ad_identifiers` values to discover the Qdrant cluster exporter and operator pods, then scrapes the OpenMetrics endpoint that each pod exposes. The `%%host%%` template variable resolves to the IP of the discovered pod at runtime. + +```yaml +apiVersion: datadoghq.com/v2alpha1 +kind: DatadogAgent +metadata: + name: datadog + namespace: datadog +spec: + global: + site: datadoghq.com + credentials: + apiSecret: + secretName: datadog-secret + keyName: api-key + override: + nodeAgent: + extraConfd: + configDataMap: + openmetrics.yaml: |- + ad_identifiers: + - qdrant-cluster-exporter + - operator + init_config: + instances: + # Instance 1: Qdrant Metrics Exporter + - openmetrics_endpoint: http://%%host%%:9090/metrics + namespace: qdrant.exporter + metrics: + - .* + + # Instance 2: Qdrant Operator Metrics + - openmetrics_endpoint: http://%%host%%:9290/metrics + namespace: qdrant.operator + metrics: + - .* +``` + +Apply the manifest: + +```shell +kubectl apply -f datadog-agent.yaml +``` + +A few notes on this configuration: + +- **The first instance** scrapes the Qdrant cluster exporter on port 9090 and namespaces its metrics under `qdrant.exporter`. +- **The second instance** scrapes the Qdrant operator on port 9290 and namespaces its metrics under `qdrant.operator`. +- **`metrics: - .*`** collects every metric the endpoint exposes. To reduce the volume of custom metrics, replace this with an explicit list of metric names. + +This example assumes that your Qdrant cluster, the cloud platform exporter, and the operator are deployed in the `qdrant` namespace. The Datadog node Agent discovers pods running on its own node regardless of their namespace, so no namespace selector is required. Adjust the ports and identifiers only if your deployment differs from the defaults. + +## Step 3: View Qdrant Metrics in Datadog + +Once the Agent is running and scraping Qdrant, confirm that metrics are flowing. + +First, check that the OpenMetrics check is healthy. Find a node Agent pod and run the status command: + +```shell +kubectl exec -it --namespace datadog -- agent status +``` + +Look for the `openmetrics` check in the output. It should report the Qdrant instances with no errors and a non-zero number of metric samples. + +Next, open Datadog and go to **Metrics > Explorer**. Search for metrics that start with `qdrant.exporter.` or `qdrant.operator.` to confirm that Datadog is receiving them.