Skip to content

docs(javascript): Add ClickHouse integration page - #20863

Draft
sentry-junior[bot] wants to merge 3 commits into
masterfrom
jpeer/docs-js-clickhouse-integration
Draft

sentry-junior[bot] wants to merge 3 commits into
masterfrom
jpeer/docs-js-clickhouse-integration

Conversation

@sentry-junior

@sentry-junior sentry-junior Bot commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

This adds a page for Sentry.clickhouseIntegration, the new ClickHouse integration of the JavaScript SDK from getsentry/sentry-javascript#26211 by @adityareddy-dev. Without a page, users can't see which ClickHouse clients and runtimes are traced, or what query data ends up in their spans. It covers:

  • that the integration is on by default when tracing is enabled
  • runtime notes: Node.js runtime only on Next.js, the import hook on Deno, and sentryBunPlugin() on Bun and Elysia
  • which client methods are traced (query, command, exec, insert) and that spans need an active parent span
  • span names and attributes, and how query text is sanitized (literals, comments, inline insert data, {name:Type} parameters)
  • that failed calls set an error status on the span but aren't captured as errors
  • Cloudflare Workers: @clickhouse/client-web is traced when the Worker is built with the Sentry Cloudflare Vite plugin
  • supported versions: @clickhouse/client and @clickhouse/client-web >=1.1.0 <2

Open decisions:

  • feat(node): add ClickHouse instrumentation sentry-javascript#26211 merged after 11.16.0, so <AvailableSince version="11.17.0" /> assumes it ships in the next minor. Merge after 11.17.0 is released.
  • The per-platform default integration tables in platform-includes/configuration/integrations/ aren't updated. They don't list other recent integrations, such as Neon or Postgres.js, either.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace YYYY-MM-DD with the due date. You can update this information later by editing the PR description.

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've supplied a deadline.

Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

EXTRA RESOURCES

via @JPeer264.

--

View Session [Sentry]

Co-Authored-By: Jan Peer Stöcklmair <10677263+JPeer264@users.noreply.github.com>
@vercel

vercel Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
sentry-docs Ready Ready Preview Nov 21, 2026 10:27am UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Nov 21, 2026 10:27am UTC

Request Review

Co-Authored-By: Jan Peer Stöcklmair <10677263+JPeer264@users.noreply.github.com>

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — b57c2313 Deployed Nov 21, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Normal Docs review has no urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant