ingwer / chdig Goto Github PK

Dig into ClickHouse with TUI interface.

The idea is came from everyday digging into various ClickHouse issues.

ClickHouse has a approximately universe of introspection tools, and it is easy to forget some of them. At first I came with some slides and a picture (to attract your attention) by analogy to what Brendan Gregg did for Linux:

Note, the picture and the presentation had been made in the beginning of 2022, so it may not include some new introspection tools.

But this requires you to dig into lots of places, and even though during this process you will learn a lot, it does not solves the problem of forgetfulness. So I came up with this simple TUI interface that tries to make this process simpler.

chdig can be used not only to debug some problems, but also just as a regular introspection, like top for Linux.

• top like interface (or csysdig to be more precise)
• Flamegraphs (CPU/Real/Memory)
• Query logs
• Cluster support (--cluster)

• Query view (system.processes)
• Slow query log (system.query_log)
• Last queries (system.query_log)
• Processors (system.processors_profile_log)
• Views (system.query_views_log)
• Merges view (system.merges)
• Mutations view (system.mutations)
• Replicas (system.replicas)
• Replication queue view (system.replication_queue)
• Fetches (system.replicated_fetches)
• Backups (system.backups)
• Errors (system.errors)

And there is a huge bunch of TODOs (right now it is too huge to include it here).

Note, this it is in a pre-alpha stage, so everything can be changed (keyboard shortcuts, views, color schema and of course features)

If something does not work, like you have too old version of ClickHouse, consider upgrading.

Later some backward compatiblity will be added as well.

Prerequisites:

• cargo
• nfpm
• pyinstaller

make packages

For now, only deb packages are available.

But we are using nfpm, so any supported package, archlinux, deb, rpm, tar, you name it, can be supported):

• tfg

Since Rust is a new language to me, the code can be far from ideal.