Skip to content

docs: add ClickHouse Agents integration page - #3479

Open
jannikmaierhoefer wants to merge 1 commit into
mainfrom
claude/clickhouse-agents-integration-ae44e5
Open

docs: add ClickHouse Agents integration page#3479
jannikmaierhoefer wants to merge 1 commit into
mainfrom
claude/clickhouse-agents-integration-ae44e5

Conversation

@jannikmaierhoefer

@jannikmaierhoefer jannikmaierhoefer commented Aug 7, 2026

Copy link
Copy Markdown
Member

Adds a dedicated integration page for ClickHouse Agents — the managed LibreChat / agentic analytics service in ClickHouse Cloud — covering its built-in Langfuse connection.

Requested by Marc in the #langfuse thread on the ClickHouse Agents ↔ Langfuse rollout: a page focused on ClickHouse Agents, separate from LibreChat.

Why

An org admin adds Langfuse keys under Settings → Langfuse and every agent run in that org is traced to their own project — no code, no deployment changes. That flow wasn't documented anywhere. The existing LibreChat and Agentic Data Stack pages only cover self-managed setups configured with env vars, which doesn't apply to a managed multi-tenant deployment.

What changed

  • New page content/integrations/other/clickhouse-agents.mdx — what gets traced (agent runs, model calls, ClickHouse MCP / code-interpreter tool calls, thumbs up/down as user-feedback scores, org attribution tags), how it works, the admin settings flow with the three Langfuse Cloud destinations, connection management, and troubleshooting keyed to the actual in-app error strings.
  • Registered in content/integrations/other/meta.json (MDX page — no _routes.json entry, no cookbook build needed).
  • Cross-links: added to the Learn More list on the Agentic Data Stack page and to the homepage integrations grid.
  • Logo: reuses the existing /images/integrations/clickhouse_icon.svg.

Where the content came from

clickhouse.com/docs has no Langfuse section yet, so every step is sourced from the merged LibreChat implementation rather than partner docs:

Detail Source
UI flow, status + error strings danny-avila/LibreChat#14108, client/src/locales/en/translation.json
eu / us / jp destinations packages/api/src/langfuse/tenantDestinations.ts
Admin-only visibility conditions packages/api/src/langfuse/policy.ts
Encrypted secret storage, masked keys danny-avila/LibreChat#14107
user-feedback score from thumbs up/down danny-avila/LibreChat#13544
tenant:<id> tag + librechat.tenant.id metadata danny-avila/LibreChat#13808
Fanout / OTLP export mechanism danny-avila/LibreChat#13872, otel/langfuse-fanout/README.md

Reviewer notes

The page is written as generally available, with no beta or gating language. That was a deliberate call, but two things point the other way: the feature is still behind a sysadmin feature toggle on prod as of this week, and the in-app panel itself says "This feature is in beta." ClickHouse's own Agents docs also carry a beta banner. Worth timing the merge with the rollout, or adding a one-line callout if it slips.

No screenshots or example-trace link — I couldn't run this end-to-end (needs an org with the toggle on), so the trace structure is described in prose, matching the existing developer-tools pages. This also avoids the missing-image link-check failure.

The LibreChat page has no link to this one: content/integrations/other/librechat.mdx is generated from cookbook/integration_librechat.ipynb, so adding it means editing the notebook and running the ~10 min scripts/update_cookbook_docs.sh. Left out of this PR — happy to do it as a follow-up.

Verification

  • Renders clean on the dev server — <Steps>, <Callout>, and the region table all fine, no console errors, sidebar entry appears under Other
  • All 10 internal links return 200
  • prettier --check passes on all four files
  • scripts/check-h1-headings.js passes
  • scripts/copy_md_sources.js confirms the Callout text survives into public/md-src/

🤖 Generated with Claude Code


Note

Low Risk
Documentation and navigation only; no application logic, auth, or data handling changes.

Overview
Adds documentation for ClickHouse Cloud’s managed ClickHouse Agents product and its built-in Langfuse connection (admin UI + OTLP), distinct from self-hosted LibreChat / Agentic Data Stack env-var setup.

A new clickhouse-agents.mdx page covers what is traced (runs, model/tool calls, user-feedback scores, org tags), EU/US/Japan destinations, connection management, and troubleshooting aligned with in-app errors. The page is registered in meta.json, linked from Agentic Data Stack Learn More, and surfaced on the homepage integrations marquee as ClickHouse Agents.

Reviewed by Cursor Bugbot for commit b58933d. Bugbot is set up for automated code reviews on this repo. Configure here.

Greptile Summary

Adds a dedicated ClickHouse Agents integration guide and registers it in the integration sidebar, homepage grid, and related Agentic Data Stack documentation.

  • Documents traced data, organization-level setup, connection management, and troubleshooting.
  • Adds navigation and cross-links for the new integration page.

Confidence Score: 4/5

The documentation should be corrected before merging because it currently directs self-hosted users into a setup flow they cannot complete.

The new page offers self-hosting in its project-creation step, but the following destination selector documents only fixed Langfuse Cloud endpoints and no custom URL.

Files Needing Attention: content/integrations/other/clickhouse-agents.mdx

Prompt To Fix All With AI
### Issue 1
content/integrations/other/clickhouse-agents.mdx:37
**Self-hosted setup has no destination**

When an organization admin follows the documented self-hosting option, the subsequent destination step offers only EU, US, and Japan Langfuse Cloud endpoints and no custom URL, so the admin cannot connect the self-hosted instance or complete the documented setup flow.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Reviews (1): Last reviewed commit: "docs: add ClickHouse Agents integration ..." | Re-trigger Greptile

Greptile also left 1 inline comment on this PR.

Context used:

ClickHouse Agents (managed LibreChat in ClickHouse Cloud) now has a
built-in Langfuse connection: an org admin adds Langfuse keys under
Settings -> Langfuse and every agent run in that org is traced to their
own project. That flow was not documented anywhere — the existing
LibreChat and Agentic Data Stack pages only cover self-managed setups
with env vars.

Adds a dedicated page covering what gets traced (agent runs, model
calls, MCP/code-interpreter tool calls, thumbs up/down as user-feedback
scores, org attribution tags), the admin settings flow with the three
Langfuse Cloud destinations, connection management, and troubleshooting
keyed to the actual in-app error strings.

Content is sourced from the merged LibreChat implementation rather than
partner docs, which do not cover Langfuse yet: PR #14108 and
translation.json for the UI flow and status strings, tenantDestinations.ts
for the eu/us/jp destinations, policy.ts for admin visibility, #14107 for
encrypted secret storage, #13544 for feedback scores, #13808 for the
tenant tag and metadata.

Also registers the page in the Other category, links it from the Agentic
Data Stack page, and adds it to the homepage integrations grid.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@dosubot dosubot Bot added size:L This PR changes 100-499 lines, ignoring generated files. documentation Improvements or additions to documentation labels Aug 7, 2026
@vercel

vercel Bot commented Aug 7, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
langfuse-docs Ready Ready Preview Aug 7, 2026 6:46am

Request Review

@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown

@claude review


### Create a Langfuse project

Sign up for [Langfuse Cloud](https://cloud.langfuse.com) or [self-host Langfuse](/self-hosting), then create a project. Copy the **public key** and **secret key** from the project settings.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P1 Self-hosted setup has no destination

When an organization admin follows the documented self-hosting option, the subsequent destination step offers only EU, US, and Japan Langfuse Cloud endpoints and no custom URL, so the admin cannot connect the self-hosted instance or complete the documented setup flow.

Prompt To Fix With AI
This is a comment left during a code review.
Path: content/integrations/other/clickhouse-agents.mdx
Line: 37

Comment:
**Self-hosted setup has no destination**

When an organization admin follows the documented self-hosting option, the subsequent destination step offers only EU, US, and Japan Langfuse Cloud endpoints and no custom URL, so the admin cannot connect the self-hosted instance or complete the documented setup flow.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I didn't find any code-level bugs in this docs PR, but I'd like a human to weigh in before merging: the page documents ClickHouse Agents' Langfuse connection as fully generally available, while the PR description itself notes the feature is still behind a sysadmin toggle in prod and the in-app panel says "This feature is in beta." That's a content-accuracy/timing call (whether to add beta language or hold the merge until rollout) rather than something the automated review should decide on its own.

Extended reasoning...

Overview

This PR adds a new integration page (content/integrations/other/clickhouse-agents.mdx) documenting the built-in Langfuse connection in ClickHouse Cloud's managed ClickHouse Agents product, plus cross-links from the Agentic Data Stack page, a homepage marquee entry, and a meta.json registration. All changes are documentation/navigation — no application logic, auth, or data-handling code is touched.

Security risks

None. This is static MDX content plus a marquee entry in a React component; no user input, secrets, or executable logic is introduced.

Level of scrutiny

Docs-only PRs are normally safe to approve mechanically, but this one carries a content-accuracy question the author raised themselves: the page is written as GA with no beta/gating language, yet the PR body states the feature is still behind a sysadmin toggle on prod and the in-app settings panel says "This feature is in beta," matching ClickHouse's own beta banner on their Agents docs. Publishing this as GA risks confusing readers if the feature isn't broadly available yet, and the right call (ship as-is, add a callout, or hold for the rollout) is a product/timing decision, not something to rubber-stamp.

Other factors

The bug-hunting system's verifier concluded the GA-vs-beta framing isn't a code bug, which is technically correct, but it's still an open editorial question the author flagged as unresolved rather than something they resolved before submitting. Everything else in the diff (meta.json registration, cross-links, marquee entry, logo reuse) is mechanical and correct — I verified the ClickHouse icon asset exists and no md-override file exists for this route.

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

Labels

documentation Improvements or additions to documentation size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant