Skip to content

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
wants to merge 36 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
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 Jul 26, 2025
60f3fbe
Merge branch 'main' of https://github.com/ClickHouse/clickhouse-docs …
dhtclk Jul 26, 2025
c619204
Merge branch 'main' of https://github.com/ClickHouse/clickhouse-docs …
dhtclk Jul 28, 2025
aa15a8a
Merge branch 'main' of https://github.com/ClickHouse/clickhouse-docs …
dhtclk Aug 1, 2025
0c7d189
Merge branch 'main' of https://github.com/ClickHouse/clickhouse-docs …
dhtclk Aug 4, 2025
7c94a46
Adding Lessons Learned Guide with Interactable Queries
dhtclk Aug 6, 2025
9166323
Split into multiple guides under a new section
dhtclk Aug 6, 2025
2bbe1bc
Merge branch 'main' of https://github.com/ClickHouse/clickhouse-docs …
dhtclk Aug 7, 2025
bf67a27
Keywords, cross-linking, clean-up
dhtclk Aug 7, 2025
e10f908
adding ask ai link to troubleshooting, simple kapa link component.
dhtclk Aug 7, 2025
dc751b2
commenting out C++ link
dhtclk Aug 7, 2025
0ba3eb4
spelling and dictionary update
dhtclk Aug 7, 2025
e9a6adf
Update docs/tips-and-tricks/too-many-parts.md
dhtclk Aug 8, 2025
0f7d07e
Update docs/tips-and-tricks/too-many-parts.md
dhtclk Aug 8, 2025
7159177
Update docs/tips-and-tricks/too-many-parts.md
dhtclk Aug 8, 2025
03abb7d
Update docs/tips-and-tricks/too-many-parts.md
dhtclk Aug 8, 2025
8e8fd7b
Update docs/tips-and-tricks/debugging-toolkit.md
dhtclk Aug 8, 2025
4867bbe
Update docs/tips-and-tricks/cost-optimization.md
dhtclk Aug 8, 2025
ec2036f
Merge branch 'main' of https://github.com/ClickHouse/clickhouse-docs …
dhtclk Aug 11, 2025
de5e966
Rewriting Creative Use Cases
dhtclk Aug 11, 2025
21e518c
fix formatting
dhtclk Aug 11, 2025
33935f4
Rewrite cost-optimization doc
dhtclk Aug 11, 2025
f3806da
Performance Optimization Guide
dhtclk Aug 11, 2025
d8e3ca2
Too Many Parts
dhtclk Aug 11, 2025
395d484
MVs and Debugging Toolkit
dhtclk Aug 11, 2025
aa308be
Fixing nav link
dhtclk Aug 11, 2025
bc0e0eb
adding to dictionary
dhtclk Aug 11, 2025
1dd1100
fixing dictionary
dhtclk Aug 11, 2025
f37c70a
adding header ids
dhtclk Aug 11, 2025
c0cf0fa
removing garbage AI quotes
dhtclk Aug 12, 2025
d546215
removing another garbage quote and fixing capitalization
dhtclk Aug 12, 2025
6e98868
fixing another quote
dhtclk Aug 12, 2025
12fb3ef
rewriting debugging insights
dhtclk Aug 12, 2025
500d515
slight header change
dhtclk Aug 12, 2025
fc5d1a1
adding header ids
dhtclk Aug 12, 2025
267527c
Further pruning innaccuracies and renaming debugging toolkit
dhtclk Aug 12, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
145 changes: 145 additions & 0 deletions docs/getting-started/troubleshooting/troubleshooting.md
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)
Copy link
Member

Choose a reason for hiding this comment

The 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)
1 change: 1 addition & 0 deletions knowledgebase/find-expensive-queries.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: How to Identify the Most Expensive Queries in ClickHouse
description: Learn how to use the `query_log` table in ClickHouse to identify the most memory and CPU-intensive queries across distributed nodes.
date: 2023-03-26
slug: find-expensive-queries
tags: ['Performance and Optimizations']
keywords: ['Expensive Queries']
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Identifying Expensive Queries by Memory Usage in ClickHouse
description: Learn how to use the `system.query_log` table to find the most memory-intensive queries in ClickHouse, with examples for clustered and standalone setups.
date: 2023-06-07
slug: find-expensive-queries-by-memory-usage
tags: ['Performance and Optimizations']
keywords: ['Expensive Queries', 'Memory Usage']
---
Expand Down
14 changes: 14 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,20 @@ const sidebars = {
dirName: "getting-started/example-datasets",
}
]
},
{
type: "category",
label: "Troubleshooting",
className: "top-nav-item",
collapsed: true,
collapsible: true,
link: { type: "doc", id: "getting-started/index" },
items: [
{
type: "autogenerated",
dirName: "getting-started/troubleshooting",
}
]
}
],

Expand Down