Awesome ClickHouseOps

PostHog/HouseWatch

⭐ 631 TypeScript repository created 2023-03-29

HouseWatch is an open-source tool designed specifically for monitoring and managing ClickHouse clusters. It provides a comprehensive overview of cluster load and performance, allowing users to drill down into queries to understand their impact on the cluster. The tool offers features such as searching through logs and errors, monitoring and terminating running queries with ease, and detailed statistics on disk usage per node, including the space taken up by tables, columns, and parts. Users can also run their own queries directly from the interface to further investigate performance and cluster issues. Additionally, HouseWatch supports setting up operations to run in the background with automatic rollbacks in case of failures. Deployment is straightforward using Docker Compose, with environment variables to configure connection details to ClickHouse instances or clusters. The UI runs on a specified address and port, though it is advised to be cautious about exposing it to the internet due to lack of built-in security. HouseWatch can also be run locally alongside a local ClickHouse instance for development and testing purposes. The motivation behind HouseWatch stems from PostHog's experience managing large ClickHouse clusters and the need for a unified tool that consolidates monitoring, management, and debugging capabilities. ClickHouse's system tables provide rich metadata, but querying and interpreting this data can be complex. HouseWatch encapsulates PostHog's accumulated knowledge and best practices into a single interface, aiming to serve as a comprehensive solution akin to pganalyze but for ClickHouse. Currently in beta, HouseWatch is actively developed with plans for many additional features such as system issue tabs, EXPLAIN visualizers, multi-instance support, and enhanced operation controls. It supports read-only user connections for safer monitoring, though some management features require elevated permissions. The project welcomes contributions and aims to improve developer experience and code quality over time. Key features include query performance analysis, schema statistics, query benchmarking, log viewing, query editing, disk usage monitoring, error tracking, and operational management. HouseWatch is maintained by PostHog and contributors, reflecting a strong community-driven approach to evolving ClickHouse cluster management.

https://github.com/PostHog/HouseWatch

benchmarkingbeta-softwareclickhousecluster-loadcluster-managementdatabasedatabase-managementdisk-usagedjangodockererror-trackinglogsmit-licensemonitoringopen-sourceoperationsperformance-analysisposthogquery-editorquery-performancereactschema-stats

Also in Ops

Altinity/clickhouse-backup

Altinity/clickhouse-backup is a tool for easy backup and restore of ClickHouse databases using various cloud and local object storage systems.

ContentSquare/chproxy

Chproxy is an open-source HTTP proxy and load balancer designed to optimize and manage HTTP traffic for the ClickHouse database, enhancing scalability and fault tolerance.

duyet/clickhouse-monitoring

ClickHouse Monitoring Dashboard is a Next.js-based UI tool that leverages system tables to provide comprehensive monitoring and visualization of ClickHouse clusters, including query, cluster, and table metrics.