Skip to content

Commit 344ba21

Browse files
authored
docs: Update README.md [skip ci]
Signed-off-by: duyet <[email protected]>
1 parent e1f6e65 commit 344ba21

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

README.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,33 +5,36 @@
55

66
The simple Next.js dashboard that relies on `system.*` tables to help monitor and provide an overview of your ClickHouse cluster.
77

8-
Features:
8+
**Features:**
99

1010
- Query monitor: current queries, query history, query resources (memory, parts read, file_open, ...), most expensive queries, most used tables or columns, etc.
1111
- Cluster monitor: total memory/CPU usage, distributed queue, global settings, mergetree settings, metrics, etc.
1212
- Tables and parts information: size, row count, compression, part size, etc., at the column level detail.
1313
- Useful tools: Zookeeper data exploration, query EXPLAIN, kill queries, etc.
1414
- Visualization metric charts: queries and resource usage, number of merges/mutation, merge performance, query performance, etc.
1515

16-
**Demo** (_The ClickHouse server running on my homelab so can be slow sometimes_):
16+
## Demo
17+
18+
_The ClickHouse server running on my homelab so can be slow sometimes_:
1719

1820
- [clickhouse-monitoring.vercel.app](https://clickhouse-monitoring.vercel.app)
1921
- [clickhouse.duyet.net](https://clickhouse.duyet.net)
2022

21-
**Documentation**:
23+
## Documentation
24+
25+
at https://duyet.github.io/clickhouse-monitoring
2226

23-
- https://duyet.github.io/clickhouse-monitoring/
24-
- [Getting Started](https://duyet.github.io/clickhouse-monitoring/getting-started)
25-
- [Local Development](https://duyet.github.io/clickhouse-monitoring/getting-started/local)
26-
- [User Role and Profile](https://duyet.github.io/clickhouse-monitoring/getting-started/clickhouse-requirements)
27-
- [Enable System Tables](https://duyet.github.io/clickhouse-monitoring/getting-started/clickhouse-enable-system-tables)
28-
- [Deployments](https://duyet.github.io/clickhouse-monitoring/deploy)
29-
- [Vercel](https://duyet.github.io/clickhouse-monitoring/deploy/vercel)
30-
- [Docker](https://duyet.github.io/clickhouse-monitoring/deploy/docker)
31-
- [Kubernetes Helm Chart](https://duyet.github.io/clickhouse-monitoring/deploy/k8s)
32-
- [Advanced](https://duyet.github.io/clickhouse-monitoring/advanced)
27+
- [Getting Started](https://duyet.github.io/clickhouse-monitoring/getting-started)
28+
- [Local Development](https://duyet.github.io/clickhouse-monitoring/getting-started/local)
29+
- [User Role and Profile](https://duyet.github.io/clickhouse-monitoring/getting-started/clickhouse-requirements)
30+
- [Enable System Tables](https://duyet.github.io/clickhouse-monitoring/getting-started/clickhouse-enable-system-tables)
31+
- [Deployments](https://duyet.github.io/clickhouse-monitoring/deploy)
32+
- [Vercel](https://duyet.github.io/clickhouse-monitoring/deploy/vercel)
33+
- [Docker](https://duyet.github.io/clickhouse-monitoring/deploy/docker)
34+
- [Kubernetes Helm Chart](https://duyet.github.io/clickhouse-monitoring/deploy/k8s)
35+
- [Advanced](https://duyet.github.io/clickhouse-monitoring/advanced)
3336

34-
**Screenshots**:
37+
## Screenshots
3538

3639
![](.github/screenshots/screenshot_1.png)
3740
![](.github/screenshots/screenshot_2.png)

0 commit comments

Comments
 (0)