Document Datadog integration options for ClickHouse#6419
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.
|
@dhtclk Am I blocking anything from merging this PR? |
dhtclk
left a comment
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!
Co-authored-by: Dominic Tran <dominic.tran@clickhouse.com>
Co-authored-by: Dominic Tran <dominic.tran@clickhouse.com>
Co-authored-by: Dominic Tran <dominic.tran@clickhouse.com>
Co-authored-by: Dominic Tran <dominic.tran@clickhouse.com>
|
@dhtclk TYSM! Went through and resolved |
- Address the reader as "you" (not "the customer"/"users") - Fix broken onboarding link to Datadog's ClickHouse Cloud guide - Correct the API integration description: OAuth Connect Accounts flow with push-based metrics, not an API key with Datadog polling - Use "OSS" consistently; remove duplicated Prometheus link Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Hey Mihir! I pushed a few fixes. Please review and let me know before I merge. Fact-check flag on line 33 (the API integration). The original described it as "provide a Datadog API key" + "Datadog periodically polls the ClickHouse Cloud API… using a push-based method." Two issues:
I rewrote it to: OAuth handshake (Connect Accounts) + ClickHouse Cloud pushes metrics to Datadog, rather than Datadog polling the service. The OAuth-not-API-key part is solid — it's stated on Datadog's page. The push-vs-poll direction is my inference from the idling behavior + the OAuth write scope, so since this is private preview, can you confirm with the integration owner that metrics are pushed, not pulled? Sources: https://docs.datadoghq.com/integrations/clickhouse-cloud/ , https://docs.datadoghq.com/developers/integrations/oauth_for_integrations/ |
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.