-
Notifications
You must be signed in to change notification settings - Fork 359
4146 add troubleshooting section #4181
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
dhtclk
wants to merge
36
commits into
main
Choose a base branch
from
4146-add-troubleshooting-section
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+1,246
−39
Open
Changes from 4 commits
Commits
Show all changes
36 commits
Select commit
Hold shift + click to select a range
32feb0b
Troubleshooting page, temporary placement
dhtclk 60f3fbe
Merge branch 'main' of https://github.com/ClickHouse/clickhouse-docs …
dhtclk c619204
Merge branch 'main' of https://github.com/ClickHouse/clickhouse-docs …
dhtclk aa15a8a
Merge branch 'main' of https://github.com/ClickHouse/clickhouse-docs …
dhtclk 0c7d189
Merge branch 'main' of https://github.com/ClickHouse/clickhouse-docs …
dhtclk 7c94a46
Adding Lessons Learned Guide with Interactable Queries
dhtclk 9166323
Split into multiple guides under a new section
dhtclk 2bbe1bc
Merge branch 'main' of https://github.com/ClickHouse/clickhouse-docs …
dhtclk bf67a27
Keywords, cross-linking, clean-up
dhtclk e10f908
adding ask ai link to troubleshooting, simple kapa link component.
dhtclk dc751b2
commenting out C++ link
dhtclk 0ba3eb4
spelling and dictionary update
dhtclk e9a6adf
Update docs/tips-and-tricks/too-many-parts.md
dhtclk 0f7d07e
Update docs/tips-and-tricks/too-many-parts.md
dhtclk 7159177
Update docs/tips-and-tricks/too-many-parts.md
dhtclk 03abb7d
Update docs/tips-and-tricks/too-many-parts.md
dhtclk 8e8fd7b
Update docs/tips-and-tricks/debugging-toolkit.md
dhtclk 4867bbe
Update docs/tips-and-tricks/cost-optimization.md
dhtclk ec2036f
Merge branch 'main' of https://github.com/ClickHouse/clickhouse-docs …
dhtclk de5e966
Rewriting Creative Use Cases
dhtclk 21e518c
fix formatting
dhtclk 33935f4
Rewrite cost-optimization doc
dhtclk f3806da
Performance Optimization Guide
dhtclk d8e3ca2
Too Many Parts
dhtclk 395d484
MVs and Debugging Toolkit
dhtclk aa308be
Fixing nav link
dhtclk bc0e0eb
adding to dictionary
dhtclk 1dd1100
fixing dictionary
dhtclk f37c70a
adding header ids
dhtclk c0cf0fa
removing garbage AI quotes
dhtclk d546215
removing another garbage quote and fixing capitalization
dhtclk 6e98868
fixing another quote
dhtclk 12fb3ef
rewriting debugging insights
dhtclk 500d515
slight header change
dhtclk fc5d1a1
adding header ids
dhtclk 267527c
Further pruning innaccuracies and renaming debugging toolkit
dhtclk File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
145 changes: 145 additions & 0 deletions
145
docs/getting-started/troubleshooting/troubleshooting.md
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,145 @@ | ||
--- | ||
sidebar_position: 1 | ||
slug: /getting-started/troubleshooting | ||
sidebar_label: 'Troubleshooting' | ||
keywords: [ | ||
'clickhouse troubleshooting', | ||
'clickhouse errors', | ||
'slow queries', | ||
'memory problems', | ||
'connection issues', | ||
'performance optimization', | ||
'database errors', | ||
'configuration problems', | ||
'debug', | ||
'solutions' | ||
] | ||
title: 'Troubleshooting Common Issues' | ||
description: 'Find solutions to the most common ClickHouse problems including slow queries, memory errors, connection issues, and configuration problems.' | ||
--- | ||
|
||
# Troubleshooting Common Issues {#troubleshooting-common-issues} | ||
|
||
Having problems with ClickHouse? Find the solutions to common issues here. | ||
|
||
## Performance and Errors {#performance-and-errors} | ||
|
||
Queries running slowly, timeouts, or getting specific error messages like "Memory limit exceeded" or "Connection refused." | ||
|
||
<details> | ||
<summary><strong>Show performance and error solutions</strong></summary> | ||
|
||
### Query Performance {#query-performance} | ||
- [Find which queries are using the most resources](/knowledgebase/find-expensive-queries) | ||
- [Complete query optimization guide](/docs/optimize/query-optimization) | ||
- [Optimize JOIN operations](/docs/best-practices/minimize-optimize-joins) | ||
- [Run diagnostic queries to find bottlenecks](/docs/knowledgebase/useful-queries-for-troubleshooting) | ||
<br/> | ||
### Data Insertion Performance {#data-insertion-performance} | ||
- [Speed up data insertion](/docs/optimize/bulk-inserts) | ||
- [Set up asynchronous inserts](/docs/optimize/asynchronous-inserts) | ||
<br/> | ||
### Advanced Analysis Tools {#advanced-analysis-tools} | ||
- [Profile with LLVM XRay](/docs/knowledgebase/profiling-clickhouse-with-llvm-xray) | ||
- [Check what processes are running](/docs/knowledgebase/which-processes-are-currently-running) | ||
- [Monitor system performance](/docs/operations/system-tables/processes) | ||
<br/> | ||
### Error Messages {#error-messages} | ||
- **"Memory limit exceeded"** → [Debug memory limit errors](/docs/guides/developer/debugging-memory-issues) | ||
- **"Connection refused"** → [Fix connection problems](#connections-and-authentication) | ||
- **"Login failures"** → [Set up users, roles, and permissions](/docs/operations/access-rights) | ||
- **"SSL certificate errors"** → [Fix certificate problems](/docs/knowledgebase/certificate_verify_failed_error) | ||
- **"Table/database errors"** → [Database creation guide](/docs/sql-reference/statements/create/database) | [Table UUID problems](/docs/engines/database-engines/atomic) | ||
- **"Network timeouts"** → [Network troubleshooting](/docs/interfaces/http) | ||
- **Other issues** → [Track errors across your cluster](/docs/operations/system-tables/errors) | ||
</details> | ||
|
||
## Memory and Resources {#memory-and-resources} | ||
|
||
High memory usage, out-of-memory crashes, or need help sizing your ClickHouse deployment. | ||
|
||
<details> | ||
<summary><strong>Show memory solutions</strong></summary> | ||
|
||
### Memory debugging and monitoring: {#memory-debugging-and-monitoring} | ||
- [Identify what's using memory](/docs/guides/developer/debugging-memory-issues) | ||
- [Check current memory usage](/docs/operations/system-tables/processes) | ||
- [Memory allocation profiling](/docs/operations/allocation-profiling) | ||
- [Analyze memory usage patterns](/docs/operations/system-tables/query_log) | ||
<br/> | ||
### Memory configuration: {#memory-configuration} | ||
- [Configure memory limits](/docs/operations/settings/memory-overcommit) | ||
- [Server memory settings](/docs/operations/server-configuration-parameters/settings) | ||
- [Session memory settings](/docs/operations/settings/settings) | ||
<br/> | ||
### Scaling and sizing: {#scaling-and-sizing} | ||
- [Right-size your service](/docs/operations/tips) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Just an idea, but some of these like this one are only really applicable to OSS ClickHouse. Maybe we should mark them with a ⛁ vs ☁️ if they are specific |
||
- [Configure automatic scaling](/docs/manage/scaling) | ||
|
||
</details> | ||
|
||
## Connections and Authentication {#connections-and-authentication} | ||
|
||
Can't connect to ClickHouse, authentication failures, SSL certificate errors, or client setup issues. | ||
|
||
<details> | ||
<summary><strong>Show connection solutions</strong></summary> | ||
|
||
### Basic Connection Issues {#basic-connection-issues} | ||
- [Fix HTTP interface issues](/docs/interfaces/http) | ||
- [Handle SSL certificate problems](/docs/knowledgebase/certificate_verify_failed_error) | ||
- [User authentication setup](/docs/operations/access-rights) | ||
<br/> | ||
### Client Interfaces {#client-interfaces} | ||
- [Native ClickHouse clients](/docs/interfaces/natives-clients-and-interfaces) | ||
- [MySQL interface problems](/docs/interfaces/mysql) | ||
- [PostgreSQL interface issues](/docs/interfaces/postgresql) | ||
- [gRPC interface configuration](/docs/interfaces/grpc) | ||
- [SSH interface setup](/docs/interfaces/ssh) | ||
<br/> | ||
### Network and Data {#network-and-data} | ||
- [Network security settings](/docs/operations/server-configuration-parameters/settings) | ||
- [Data format parsing issues](/docs/interfaces/formats) | ||
|
||
</details> | ||
|
||
## Setup and Configuration {#setup-and-configuration} | ||
|
||
Initial installation, server configuration, database creation, data ingestion issues, or replication setup. | ||
|
||
<details> | ||
<summary><strong>Show setup and configuration solutions</strong></summary> | ||
|
||
### Initial Setup {#initial-setup} | ||
- [Configure server settings](/docs/operations/server-configuration-parameters/settings) | ||
- [Set up security and access control](/docs/operations/access-rights) | ||
- [Configure hardware properly](/docs/operations/tips) | ||
<br/> | ||
### Database Management {#database-management} | ||
- [Create and manage databases](/docs/sql-reference/statements/create/database) | ||
- [Choose the right table engine](/docs/engines/table-engines) | ||
<!-- - [Modify schemas safely](/docs/sql-reference/statements/alter/index) --> | ||
<br/> | ||
### Data Operations {#data-operations} | ||
- [Optimize bulk data insertion](/docs/optimize/bulk-inserts) | ||
- [Handle data format problems](/docs/interfaces/formats) | ||
- [Set up streaming data pipelines](/docs/optimize/asynchronous-inserts) | ||
- [Improve S3 integration performance](/docs/integrations/s3/performance) | ||
<br/> | ||
### Advanced Configuration {#advanced-configuration} | ||
- [Set up data replication](/docs/engines/table-engines/mergetree-family/replication) | ||
- [Configure distributed tables](/docs/engines/table-engines/special/distributed) | ||
<!-- - [ClickHouse Keeper setup](/docs/guides/sre/keeper/index.md) --> | ||
- [Set up backup and recovery](/docs/operations/backup) | ||
- [Configure monitoring](/docs/operations/system-tables/overview) | ||
|
||
</details> | ||
|
||
## Still Need Help? {#still-need-help} | ||
|
||
If you can't find a solution: | ||
|
||
1. **Check system tables** - Run `SELECT * FROM system.processes` and `SELECT * FROM system.query_log ORDER BY event_time DESC LIMIT 10` | ||
2. **Review server logs** - Look for error messages in your ClickHouse logs | ||
3. **Ask the community** - [GitHub Discussions](https://github.com/ClickHouse/ClickHouse/discussions) | ||
4. **Get professional support** - [ClickHouse Cloud support](https://clickhouse.com/support) | ||
dhtclk marked this conversation as resolved.
Show resolved
Hide resolved
|
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
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
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
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.
Uh oh!
There was an error while loading. Please reload this page.