Skip to content

Simplify export-system-logs article - #190

Merged
BorisTyshkevich merged 1 commit into
mainfrom
kb/export-system-logs-simplify
Aug 25, 2026
Merged

Simplify export-system-logs article#190
BorisTyshkevich merged 1 commit into
mainfrom
kb/export-system-logs-simplify

Conversation

@BorisTyshkevich

Copy link
Copy Markdown
Contributor

Follow-up to #189. The article read like an investigation writeup rather than a KB page.

3313 words → 1278. For context, the median article in altinity-kb-setup-and-maintenance is 498 words and the previous longest was 1049 — #189 landed at 3× the section's longest.

What was cut

The removed material was ClickHouse internals that don't help someone configuring an export:

  • The flush-mechanism walkthrough — SystemLogQueue::pop(), result.logs.swap(queue), queue->confirm() — replaced by the only part an operator acts on: a failed flush is not retried, so those rows are gone.
  • Both C++ stack traces.
  • The push-time vs sink-construction analysis. The usable rule is "an S3 target failure loses local rows, a URL target failure doesn't" — the reader doesn't need to know why.
  • A 4-row measurement table justifying the data-loss finding, collapsed to one sentence carrying the same numbers (20/20, 1/20, 0/10).
  • The reconciliation / Distributed-sender section — design prose that made no tested claim.
  • The separate References list, merged into Related resources.

What was kept

Every tested recipe, unchanged in substance: the S3 export (with the settings-placement warning, which is the article's most practically valuable part), session log, URL, File, the direct external engine, the monitoring query, the post-upgrade dependency check, and the version table.

Verification

The DDL was reflowed onto fewer lines, so it was re-tested rather than assumed. All four SQL blocks were extracted from the article and executed verbatim on 26.7.5.10 against MinIO, followed by the glob read-back, monitoring and upgrade-check queries. Object sequence (query-log.ndjson, .1, .2, ...), all three session event types including LoginFailure, the appending file target, and the dependency output all match what the article claims. SystemLogErrorOnFlush stayed empty throughout.

Hugo build (0.128.2, CI-pinned): 328 pages, no shortcode leakage, anchor and both internal links resolve.

🤖 Generated with Claude Code

https://claude.ai/code/session_01AsB1E5eSBXpaZT4jGzY57L

The article was 3313 words against a section median of 498 - the longest
in Setup & maintenance by 3x, and much of the length was ClickHouse
internals that an operator does not need: SystemLogQueue::pop() and
queue->confirm() semantics, C++ stack traces, and a measurement table
justifying the findings rather than stating them.

Cut to 1278 words. Every tested recipe is kept; the reasoning behind
them is replaced by the operational rule.

- Replace the flush-mechanism explanation with the consequence: a failed
  flush is not retried, so the rows are gone.
- Drop both stack traces and the push-time vs sink-construction analysis.
  The rule that matters is "S3 target failures lose local rows, URL
  target failures do not".
- Collapse the 4-row measurement table into one sentence with the same
  numbers.
- Drop the reconciliation / Distributed-sender section - design prose
  that made no tested claim.
- Merge the References list into Related resources.
- Reflow the DDL onto fewer lines.

All four DDL blocks were re-executed verbatim on 26.7.5.10 after the
reflow, plus the glob read-back, monitoring and upgrade-check queries:
object sequence, session event types, file append and dependency output
all match what the article states.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01AsB1E5eSBXpaZT4jGzY57L
@github-actions

Copy link
Copy Markdown
Contributor


Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.


I have read the CLA Document and I hereby sign the CLA


You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot.

@BorisTyshkevich
BorisTyshkevich merged commit 678db6c into main Aug 25, 2026
1 of 2 checks passed
@github-actions github-actions Bot locked and limited conversation to collaborators Aug 25, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant