clickhouse-tools is a set of tools for administration and diagnostics of ClickHouse DBMS.
clickhouse-tools consist of following components:
- chadmin - ClickHouse administration tool
- ch-monitoring - ClickHouse monitoring tool
- keeper-monitoring - ClickHouse Keeper / ZooKeeper monitoring tool
All of these tools must be run on the same host as ClickHouse server is running.
Requirements:
- GNU Make version > 3.81
- uv
- Docker
# lint
make lint
# unit tests
make test-unit
make test-unit PYTEST_ARGS="-k test_name"
# integration tests (rebuild docker images using a .whl file)
make test-integration
make test-integration BEHAVE_ARGS="-i feature_name"
# integration tests (supply a custom ClickHouse version to test against)
CLICKHOUSE_VERSION="1.2.3.4" make test-integration
# If you want to have containers running on failure, supply a flag:
# BEHAVE_ARGS="-D no_stop_on_fail"
# For building deb packages
make build-deb-package