GitHub - chmonitor/chmonitor: Open-source operational advisor for ClickHouse — real-time monitoring plus AI-driven index/partition/materialized-view recommendations. · GitHub
Skip to content

Latest commit

 

History

3,860 Commits

Folders and files

Repository files navigation

chmonitor

chmonitor

The operational advisor for ClickHouse

Build and Test GitHub stars Latest release Docker image License

Live demo · Website · Docs · Getting started · Quick start

Watch the chmonitor v0.3 launch film

Watch the v0.3 launch film · 36 seconds · MP4

chmonitor is a dashboard and advisor for ClickHouse. It reads system.* tables and shows what the cluster is doing — queries, merges, replication, storage, health — then recommends what to change next.

It does not apply DDL for you. Recommendations stay recommendations.

Runs the same way on Docker, Kubernetes, bare metal, or ClickHouse Cloud. Self-host it free (GPL-3.0), or use the hosted demo.

Current release: v0.3.0. Upgrading from v0.2? See Migrate to v0.3.


What it does

You need chmonitor
See the cluster Overview, topology, health checks, 30+ charts
Catch expensive work Running, slow, failed, and historical queries
Understand data Explorer, table size, parts, compression, TTLs
Keep replicas healthy Merges, mutations, replication queue, Keeper
Get a second opinion AI advisor: projections, skip indexes, PREWHERE, MVs
Ask in English Built-in AI agent + MCP for Claude / Cursor
Work from a terminal chm CLI — live TUI and chm doctor

Works with multiple ClickHouse hosts from one dashboard (?host=0).

More detail: docs · AI agent · editions


Quick start

One container, pointed at any reachable ClickHouse (OSS, Altinity, or ClickHouse Cloud):

docker run -d --name chmonitor -p 3000:3000 \
  -e CLICKHOUSE_HOST=https://clickhouse.example.com:8443 \
  -e CLICKHOUSE_USER=default \
  -e CLICKHOUSE_PASSWORD=change-me \
  ghcr.io/chmonitor/chmonitor:v0.3.0

Open http://localhost:3000. Pin a version tag in production; use :latest only if you want the rolling tip.

Want a look first? dash.chmonitor.dev — no setup.

Install the CLI:

curl -sSf https://chmonitor.dev/install.sh | bash
chm doctor

Deploy

Same CLICKHOUSE_HOST / CLICKHOUSE_USER / CLICKHOUSE_PASSWORD everywhere.

Target Guide
Docker docs/operate/deploy/docker
Kubernetes (Helm) docs/operate/deploy/k8s
Cloudflare Workers docs/operate/deploy
Railway / Render / Fly One-click
Local development Getting started

Release artifacts (Docker image, Node standalone, Workers archive) are on the GitHub Releases page.


Editions

One codebase. Community is free forever (GPL-3.0). An optional license unlocks enterprise gates — same binary.

Community Enterprise
Cost Free, GPL-3.0 Priced by host count
Where it runs Your infra Same
ClickHouse hosts Unlimited Personal · Team 3 · Unlimited
AI advisor, agent, MCP Included Same, plus enterprise gates

Details: Editions.


Screenshots

Overview charts: query count, duration, and data written over time Cluster topology: nodes, shards, replicas, and Keeper quorum Cluster insights: findings, record-breaking queries, storage stats AI agent: ask about schema, storage, queries, and health SQL console: read-only SQL with history and EXPLAIN

Docs


Contribute

Issues and pull requests are welcome. Agent instructions live in AGENTS.md (CLAUDE.md includes that file).

License

GPL-3.0


Repo activity

About

Open-source operational advisor for ClickHouse — real-time monitoring plus AI-driven index/partition/materialized-view recommendations.

Topics

Resources

Contributing

Stars

287 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages