Add diagnostics runbook section#185
Open
TheraniAA wants to merge 1 commit into
Open
Conversation
New top-level KB section at content/en/altinity-kb-diagnostics-runbook/
with 25 pages of cluster-wide diagnostic queries and scenario-based
playbooks. Aimed at on-call engineers triaging running ClickHouse
clusters.
Structure:
- _index.md, quick-reference.md, investigation-methods.md (top level)
- query-library/ — 54 queries grouped into 9 subsystem pages
(replication, parts/merges, disk, pools, queries/mutations,
async inserts, keeper, insert load + host skew, dictionaries/kafka)
- scenarios/ — 11 scenario playbooks (general triage, merge/fetch,
too many parts, replica readonly, memory/disk pressure, stuck
mutations, async insert issues, slow queries, kafka, frozen
historical tables, host-skewed failures)
All queries use clusterAllReplicas('{cluster}', ...) placeholders.
Queries are referenced by stable numeric IDs (Q1-Q54) for cross-linking.
Heavy use of internal cross-links between scenarios and the query
library to support both top-down (start from a symptom) and bottom-up
(grab a known query) workflows.
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
1 participant
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.
New top-level KB section at content/en/altinity-kb-diagnostics-runbook/ with 25 pages of cluster-wide diagnostic queries and scenario-based playbooks. Aimed at on-call engineers triaging running ClickHouse clusters.
Structure:
All queries use clusterAllReplicas('{cluster}', ...) placeholders. Queries are referenced by stable numeric IDs (Q1-Q54) for cross-linking. Heavy use of internal cross-links between scenarios and the query library to support both top-down (start from a symptom) and bottom-up (grab a known query) workflows.
I have read the CLA Document and I hereby sign the CLA