Open source tool for ClickHouse cluster monitoring and management
Top 56.3% on sourcepulse
HouseWatch is an open-source tool designed to monitor and manage ClickHouse clusters, providing insights into performance, query analysis, and disk usage. It targets database administrators and engineers who need a centralized interface for ClickHouse operations, aiming to consolidate functionalities often spread across multiple tools.
How It Works
HouseWatch leverages ClickHouse's extensive system tables to provide detailed cluster introspection. It queries these tables to surface information on query performance, disk space allocation per node, table, column, and part, and logs. The tool offers a UI for drilling down into query specifics, managing running queries, and executing ad-hoc SQL. An optional AI integration allows for natural language query editing.
Quick Start & Requirements
docker compose -f docker-compose.yml up
SITE_ADDRESS
, CLICKHOUSE_HOST
, CLICKHOUSE_USER
, CLICKHOUSE_PASSWORD
.OPENAI_API_KEY
for AI features.docker compose -f docker-compose.dev.yml up -d
(access at http://localhost:8080
).Highlighted Details
Maintenance & Community
Maintained by PostHog and yakkomajuri. Contributions are welcome, with a request to open an issue before building new features.
Licensing & Compatibility
The repository does not explicitly state a license in the provided README.
Limitations & Caveats
HouseWatch is considered beta software and is in its early stages. The UI is not currently secured, and exposing it to the internet is not recommended without further security measures. Some features, like cluster management operations, require a read-write user for ClickHouse; a read-only user limits functionality to analysis tools. The project is actively seeking contributions and has a public to-do list for future development.
6 months ago
1 week