Repository navigation
docs(logging): add ClickHouse as a logs provider - #920
Draft
reckless-sherixx wants to merge 1 commit into
Draft
reckless-sherixx wants to merge 1 commit into
reckless-sherixx wants to merge 1 commit into
Conversation
Add a page for collecting container logs into the agent's bundled ClickHouse: turning on collection, choosing the provider, supported LogQL, differences from Loki, limits, troubleshooting and turning it off. Link it from the Logging overview and its troubleshooting checklist. Signed-off-by: Vidyansh <ezboi2312@gmail.com>
Contributor
There was a problem hiding this comment.
Code Review
This pull request introduces comprehensive documentation for the new ClickHouse Logs feature, which allows the NudgeBee Agent to collect container logs into its bundled ClickHouse instance. A new detailed guide (clickhouse.md) has been added to cover setup, operation, LogQL support, and troubleshooting, and the main logging index page (index.md) has been updated to reference this new feature. There are no review comments, and I have no feedback to provide.
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
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.
Summary
Adds a page for ClickHouse logs: how to turn on collection, choose ClickHouse as the logs provider, which LogQL works, how it differs from Loki, the limits, troubleshooting, and how to turn it off. The Logging overview now points to it.
Stays a draft until chart 0.1.31 is released. Every command pins that version, and today no chart with that exact version exists.
Decision: the page documents the awkward first upgrade on clusters without ClickHouse (
--no-hooksplus a password), because that's the only route that worked. If a chart fix lands first, that section shrinks to one command. Please look hardest at "Existing install without ClickHouse" and "JSON logs".Type of change
Checklist
npm run buildlocally and the site builds without errorsnpm run lintlocally and lint passesgit commit -s)Additional notes
What has to happen before this leaves draft
0.1.31-rc-1on a one-node kind cluster with no NudgeBee backend. The exacthelm repo addand--version 0.1.31commands have not been run.ttlaffects an existing table. The page gives the default retention and doesn't say how to change it, because a change may only apply to new tables.Not in this PR
helm_values.mdandagent-health.md: open draft docs: update pages for the latest release (agent 0.1.30) #892 already changes them, sologs.collectionand the health text belong there.upgrade.mdsays the collector and ClickHouse "come back" wheninstallation.sh -ais re-run. On a cluster with no ClickHouse Secret, that likely fails withPASSWORDS ERROR.loki.md,clickhouse-tracing.mdandupgrade.mduse--reuse-values, which keeps the old collector settings across chart versions.storage-and-pvcs.mdtells readers to changettl, which may not affect an existing table.