HouseWatch  by PostHog

Open source tool for ClickHouse cluster monitoring and management

created 2 years ago
584 stars

Top 56.3% on sourcepulse

GitHubView on GitHub
1 Expert Loves This Project
Project Summary

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

  • Install/run via Docker Compose: docker compose -f docker-compose.yml up
  • Required environment variables: SITE_ADDRESS, CLICKHOUSE_HOST, CLICKHOUSE_USER, CLICKHOUSE_PASSWORD.
  • Optional: OPENAI_API_KEY for AI features.
  • Local development setup: docker compose -f docker-compose.dev.yml up -d (access at http://localhost:8080).

Highlighted Details

  • Centralized monitoring and management for ClickHouse clusters.
  • Drill-down capabilities for query performance and disk usage.
  • Ability to search logs and kill running queries.
  • Experimental AI-powered natural language query editor.

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.

Health Check
Last commit

6 months ago

Responsiveness

1 week

Pull Requests (30d)
0
Issues (30d)
0
Star History
25 stars in the last 90 days

Explore Similar Projects

Feedback? Help us improve.