Skip to content

Document Datadog integration options for ClickHouse#6419

Open
mihir119CH wants to merge 10 commits into
mainfrom
mihir119CH-patch-2
Open

Document Datadog integration options for ClickHouse#6419
mihir119CH wants to merge 10 commits into
mainfrom
mihir119CH-patch-2

Conversation

@mihir119CH

@mihir119CH mihir119CH commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

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.

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.
@mihir119CH mihir119CH requested a review from a team as a code owner June 18, 2026 21:18
@vercel

vercel Bot commented Jun 18, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
clickhouse-docs Ready Ready Preview, Comment Jul 7, 2026 4:21pm
clickhouse-docs-jp Building Building Preview, Comment Jul 7, 2026 4:21pm
3 Skipped Deployments
Project Deployment Actions Updated (UTC)
clickhouse-docs-ko Ignored Ignored Preview Jul 7, 2026 4:21pm
clickhouse-docs-ru Ignored Ignored Preview Jul 7, 2026 4:21pm
clickhouse-docs-zh Ignored Ignored Preview Jul 7, 2026 4:21pm

Request Review

@CLAassistant

CLAassistant commented Jun 18, 2026

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ dhtclk
❌ mihir119CH
You have signed the CLA already but the status is still pending? Let us recheck it.

Updated the section on Datadog integration to clarify recommendations and removed outdated warnings about ClickHouse Cloud compatibility.
@mihir119CH

Copy link
Copy Markdown
Contributor Author

@dhtclk Am I blocking anything from merging this PR?

@dhtclk dhtclk left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mihir119CH - when through and did a deeper review, just a few things before we can merge. Happy to help with any of this!

Comment thread docs/cloud/features/08_monitoring/integrations.md Outdated
Comment thread docs/cloud/features/08_monitoring/integrations.md Outdated
Comment thread docs/cloud/features/08_monitoring/integrations.md Outdated
Comment thread docs/cloud/features/08_monitoring/integrations.md Outdated
Comment thread docs/cloud/features/08_monitoring/integrations.md
mihir119CH and others added 4 commits July 6, 2026 18:12
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>
@mihir119CH

Copy link
Copy Markdown
Contributor Author

@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>
@dhtclk

dhtclk commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator

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:

  • Auth: Datadog's setup docs describe a Connect Accounts OAuth flow (no API key handed over).
  • Direction: the value of this integration over the Agent/Prometheus options is that it doesn't poll the service — which is why it doesn't block idling. "Datadog periodically polls" also contradicts "push-based method" in the same sentence.

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/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants