diff --git a/docs/cloud/features/08_monitoring/integrations.md b/docs/cloud/features/08_monitoring/integrations.md index cf70a0a697d..6f167e94825 100644 --- a/docs/cloud/features/08_monitoring/integrations.md +++ b/docs/cloud/features/08_monitoring/integrations.md @@ -9,18 +9,65 @@ doc_type: 'guide' --- import CommunityMonitoring from '@site/docs/_snippets/_community_monitoring.md'; +import PrivatePreviewBadge from '@theme/badges/PrivatePreviewBadge'; -## Direct Datadog integration {#direct-datadog} +## Datadog integration {#direct-datadog} -Datadog offers a ClickHouse Monitoring plugin for its agent which queries system tables directly. This integration provides comprehensive database monitoring with cluster awareness through `clusterAllReplicas` functionality. +For Prometheus endpoint setup details, see the [Prometheus integration page](/integrations/prometheus#integrating-with-datadog). -:::warning[Not recommended for ClickHouse Cloud] -The direct Datadog agent integration that queries system tables isn't recommended for ClickHouse Cloud deployments due to incompatibility with cost-optimizing idle behavior and operational limitations of the cloud proxy layer. -::: +For users interested in monitoring their ClickHouse deployment in Datadog, ClickHouse offers multiple integrations, suited to different deployment modes. Each has its own tradeoffs, and some are owned by ClickHouse while others are owned by Datadog. Integrations are listed in recommended order. -Instead, use the Datadog [Agent](https://docs.datadoghq.com/agent/?tab=Linux) and [OpenMetrics integration](https://docs.datadoghq.com/integrations/openmetrics/) to collect metrics from the ClickHouse Cloud Prometheus endpoint. This approach respects service idling behavior and maintains operational separation between monitoring and production workloads. For configuration guidance, see [Datadog's Prometheus and OpenMetrics integration documentation](https://docs.datadoghq.com/integrations/openmetrics/). +| Integration | Docs | Deployment | Signals | +|---|---|---|---| +| [ClickHouse Cloud Datadog API integration](#clickhouse-cloud-datadog-api-integration) *(recommended)* | [docs.datadoghq.com](https://docs.datadoghq.com/integrations/clickhouse-cloud/) | Cloud | Metrics | +| [ClickHouse Cloud Prometheus integration](#clickhouse-cloud-prometheus-integration) | [clickhouse.com/docs](https://clickhouse.com/docs/integrations/prometheus) | Cloud | Metrics | +| [ClickHouse Datadog Agent integration](#clickhouse-datadog-agent-integration) | [docs.datadoghq.com](https://docs.datadoghq.com/integrations/clickhouse/?tab=host) | OSS / Cloud | Logs, Metrics | +| [ClickHouse Datadog DBM](#clickhouse-datadog-dbm) | [datadoghq.com](https://www.datadoghq.com/product-preview/database-monitoring-for-clickhouse/) | OSS / Cloud | Logs, Metrics, Query Insights | -For Prometheus endpoint setup details, see the [Prometheus integration page](/integrations/prometheus#integrating-with-datadog). +### ClickHouse Cloud Datadog API integration {#clickhouse-cloud-datadog-api-integration} + + + +The recommended way to serve service-level metrics from ClickHouse Cloud in Datadog. + +The customer provides a Datadog API key, and Datadog periodically polls the ClickHouse Cloud API to collect metrics using a push-based method authenticated via an OAuth handshake. + +- **Cloud only** — not suitable for OSS ClickHouse +- Metrics are **not** treated as custom metrics by Datadog +- Does **not** prevent the service from idling +- Ships with a pre-configured set of dashboards and monitors +For onboarding steps, see [ClickHouse Cloud & Datadog - Integration](#). + +### ClickHouse Cloud Prometheus integration {#clickhouse-cloud-prometheus-integration} + +The most common and universal way to collect service-level and org-level telemetry from ClickHouse Cloud. + +The customer configures the Datadog Agent with the [OpenMetrics integration](https://docs.datadoghq.com/integrations/openmetrics/) to periodically poll the ClickHouse Cloud API and collect metrics. See the [Prometheus integration page](/integrations/prometheus#integrating-with-datadog) for configuration details. + +- **Cloud only** — not suitable for OSS ClickHouse +- Metrics are treated as **custom metrics** by Datadog +- Does **not** prevent the service from going idle + +### ClickHouse Datadog Agent integration {#clickhouse-datadog-agent-integration} + +The most common way to get data from on-premises ClickHouse services into Datadog. It also works with ClickHouse Cloud, with some caveats. + +The Datadog Agent periodically polls the ClickHouse instance and collects metrics and logs. This integration ships with a pre-configured set of dashboards. + +**OSS ClickHouse:** logs and metrics fully supported. + +**ClickHouse Cloud (partial support):** +- Metrics only — logs are not supported +- Requires `datadog-cluster-agent` instead of `datadog-agent` +- **Will prevent the service from going idle** + +### ClickHouse Datadog DBM {#clickhouse-datadog-dbm} + +Database Monitoring (DBM) for ClickHouse is developed and maintained by Datadog. It works by configuring the Datadog Agent to collect system tables data from the ClickHouse instance, providing query-level performance insights similar to what the ClickHouse Cloud Console provides natively. ClickHouse has no involvement in this integration — issues should be directed to Datadog or resolved by the customer. + +- Metrics are free; the customer pays extra for logs and system tables data ingestion +- **OSS ClickHouse:** fully supported +- **ClickHouse Cloud (partial support):** requires `datadog-cluster-agent` instead of `datadog-agent`; **will prevent the service from going idle** diff --git a/scripts/aspell-ignore/en/aspell-dict.txt b/scripts/aspell-ignore/en/aspell-dict.txt index 5428b1e8a3f..b28c8aad987 100644 --- a/scripts/aspell-ignore/en/aspell-dict.txt +++ b/scripts/aspell-ignore/en/aspell-dict.txt @@ -1,4 +1,4 @@ -personal_ws-1.1 en 4047 +personal_ws-1.1 en 4049 AArch ACLs AICPA @@ -307,6 +307,7 @@ DB's DBAPI DBAs DBFS +DBM DBMSs DBPedia DBeaver @@ -2163,6 +2164,7 @@ damerauLevenshteinDistance dashboarding datacenter datacenters +datadoghq datafiles dataframe datagrip diff --git a/styles/ClickHouse/Headings.yml b/styles/ClickHouse/Headings.yml index ef4bcc1437a..563f1dde11e 100644 --- a/styles/ClickHouse/Headings.yml +++ b/styles/ClickHouse/Headings.yml @@ -65,6 +65,7 @@ exceptions: - Docker - Docker Compose - DigitalOcean Spaces + - Datadog Agent - Duo SAML - EDOT - Elastic Agent