docs: fix ClickStack collector env var CLICKHOUSE_USERNAME -> CLICKHOUSE_USER#6389
Open
andrewdunndev wants to merge 1 commit into
Open
Conversation
…USE_USER
The OTel collector ingesting-data page names CLICKHOUSE_USERNAME in its prose
(four places), but the collector's bundled config reads ${env:CLICKHOUSE_USER}
and every code example on the same page already uses CLICKHOUSE_USER.
CLICKHOUSE_USERNAME is not read by the collector, so it is silently ignored:
the username resolves empty and authentication fails against a password-
protected ClickHouse. Align the prose with the code examples and the config.
Signed-off-by: Andrew G. Dunn <andrew@dunn.dev>
|
@andrewdunndev is attempting to deploy a commit to the ClickHouse Team on Vercel. A member of the Team first needs to authorize it. |
|
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
2 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.
What
The ClickStack OpenTelemetry collector ingestion page describes the ClickHouse user env var as
CLICKHOUSE_USERNAMEin its prose, but the collector readsCLICKHOUSE_USER. This corrects the four prose references to match.Why
The page contradicts itself. The prose (4 places) says
CLICKHOUSE_USERNAME, while every code example on the same page (HelmextraEnvs, thedocker runlines, the compose snippets) usesCLICKHOUSE_USER, and the collector's bundledconfig.standalone.yamlinterpolatesusername: ${env:CLICKHOUSE_USER}.CLICKHOUSE_USERNAMEis not read anywhere in the collector.The failure is quiet: setting
CLICKHOUSE_USERNAMEis ignored, the username resolves to an empty string, and ingestion still works against the default auth-less ClickHouse. It only surfaces once ClickHouse requires a password, where the empty user fails authentication. Anyone following the prose to point the collector at a password-protected ClickHouse hits this.Change
Four prose occurrences of
CLICKHOUSE_USERNAMEtoCLICKHOUSE_USERindocs/use-cases/observability/clickstack/ingesting-data/collector.md. The code examples were already correct and are untouched.Note
Low Risk
Documentation-only wording fix with no runtime or config changes.
Overview
Updates four prose references on the ClickStack OpenTelemetry collector ingestion page so the documented ClickHouse username env var is
CLICKHOUSE_USER, matching Helm/Docker examples and what the collector actually reads—notCLICKHOUSE_USERNAME.Covers both Managed ClickStack and Open Source ClickStack sections (endpoint/password env var lists and “modifying configuration” text). No code or example blocks are changed.
Reviewed by Cursor Bugbot for commit 38e3f90. Bugbot is set up for automated code reviews on this repo. Configure here.