Skip to content

integrations.md

Latest commit

 

History

History
77 lines (51 loc) · 4.8 KB

integrations.md

File metadata and controls

77 lines (51 loc) · 4.8 KB
Raw
title Community and partner integrations
slug /cloud/monitoring/integrations
description Third-party monitoring integrations and the Billing & Usage API for ClickHouse Cloud
keywords
cloud
monitoring
datadog
grafana
community
billing
usage api
sidebar_label Integrations
sidebar_position 6
doc_type guide

import CommunityMonitoring from '@site/docs/_snippets/_community_monitoring.md'; import PrivatePreviewBadge from '@theme/badges/PrivatePreviewBadge';

Datadog integration {#direct-datadog}

To monitor your ClickHouse deployment in Datadog, ClickHouse offers several 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.

Integration Docs Deployment Signals
ClickHouse Cloud Datadog API integration (recommended) docs.datadoghq.com Cloud Metrics
ClickHouse Cloud Prometheus integration clickhouse.com/docs Cloud Metrics
ClickHouse Datadog Agent integration docs.datadoghq.com OSS / Cloud Logs, Metrics
ClickHouse Datadog DBM datadoghq.com OSS / Cloud Logs, Metrics, Query Insights

ClickHouse Cloud Datadog API integration {#clickhouse-cloud-datadog-api-integration}

The recommended way to serve service-level metrics from ClickHouse Cloud in Datadog.

You connect your Datadog account to ClickHouse Cloud through an OAuth handshake (Connect Accounts in the Datadog integration tile). ClickHouse Cloud then pushes service-level metrics to Datadog, rather than Datadog polling the service directly.

  • 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 Datadog's ClickHouse Cloud integration guide.

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.

You configure the Datadog Agent with the OpenMetrics integration to periodically poll the ClickHouse Cloud API and collect metrics. See the Prometheus integration page 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 OSS 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 — direct any issues to Datadog rather than ClickHouse.

  • Metrics are free; you pay 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

Billing and Usage API {#billing-usage-api}

The Billing & Usage API can be used to programmatically access your Cloud organization's billing and usage records. This is useful for building custom cost monitoring dashboards or integrating billing data into existing financial reporting workflows.

For full API reference, see the Billing API documentation.