Document Datadog integration options for ClickHouse#6419
Open
mihir119CH wants to merge 4 commits into
Open
Conversation
Added details on various Datadog integrations with ClickHouse, including API, Prometheus, Agent, and DBM integrations. Each integration's deployment mode, signals, and specific considerations are outlined.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
3 Skipped Deployments
|
|
|
Updated the section on Datadog integration to clarify recommendations and removed outdated warnings about ClickHouse Cloud compatibility.
Contributor
Author
|
@dhtclk Am I blocking anything from merging this PR? |
dhtclk
requested changes
Jul 2, 2026
dhtclk
left a comment
dhtclk
left a comment
Collaborator
There was a problem hiding this comment.
@mihir119CH - when through and did a deeper review, just a few things before we can merge. Happy to help with any of this!
Comment on lines
+38
to
+39
| - Ships with a pre-configured set of dashboards and monitors | ||
| For onboarding steps, see [ClickHouse Cloud & Datadog - Integration](#). |
Collaborator
There was a problem hiding this comment.
Suggested change
| - Ships with a pre-configured set of dashboards and monitors | |
| For onboarding steps, see [ClickHouse Cloud & Datadog - Integration](#). | |
| - Ships with a pre-configured set of dashboards and monitors | |
| For onboarding steps, see [ClickHouse Cloud & Datadog - Integration](#). |
Missing line break and missing link here
|
|
||
| ### 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. |
Collaborator
There was a problem hiding this comment.
Suggested change
| 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. | |
| 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. |
|
|
||
| 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 |
Collaborator
There was a problem hiding this comment.
Suggested change
| - Metrics are free; the customer pays extra for logs and system tables data ingestion | |
| - Metrics are free; you pay extra for logs and system tables data ingestion |
|
|
||
| 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. |
Collaborator
There was a problem hiding this comment.
Suggested change
| 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. | |
| You provide 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. |
Docs voice addresses the reader as "you" for a more informal, second person voice vs third person "the customer". There are a few instances of this throughout the doc.
| 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] |
Collaborator
There was a problem hiding this comment.
Curious if we want to soften the warning here with the system tables approach, or if we want to keep this.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added details on various Datadog integrations with ClickHouse, including API, Prometheus, Agent, and DBM integrations. Each integration's deployment mode, signals, and specific considerations are outlined.
Summary
Checklist
Note
Low Risk
Documentation-only changes with no runtime or security impact; the API integration onboarding link is still a stub (
#).Overview
Replaces the short “direct Datadog agent not recommended” section with a Datadog integration overview that compares four options in a comparison table (Cloud API, Cloud Prometheus/OpenMetrics, Datadog Agent, and Datadog DBM), ordered by recommendation.
Each option gets its own subsection with deployment fit (Cloud vs OSS), signals, billing/idling tradeoffs (custom metrics, idle prevention,
datadog-cluster-agent), and links to Datadog or ClickHouse docs. The ClickHouse Cloud Datadog API path is marked recommended with a Private Preview badge; onboarding is pointed to a placeholder anchor for a future guide.Supporting edits add Datadog Agent to heading style exceptions and DBM / datadoghq to the spell-check dictionary.
Reviewed by Cursor Bugbot for commit 8d04dec. Bugbot is set up for automated code reviews on this repo. Configure here.