Skip to content

Latest commit

 

History

527 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ClickLens

A modern, powerful web interface for managing and monitoring ClickHouse databases.

License GitHub stars

Kooha-2026-01-27-17-05-35.webm

1. Introduction

ClickLens provides a comprehensive suite of tools for developers, analysts, and administrators to interact with their ClickHouse clusters efficiently.

1.1. Why ClickLens?

ClickHouse is an incredible analytical database, but managing it via CLI or basic tools can be challenging. ClickLens bridges the gap by offering:

  • Discover - Flexible, Kibana-like data exploration for any table
  • SQL Console - Write, execute, and analyze queries with syntax highlighting and streaming results
  • Real-time Monitoring - Keep an eye on your cluster's health, query performance, and resource usage
  • Schema Explorer - Navigate databases, tables, columns, parts, and more
  • Access Control - Manage users and roles directly from the UI
  • Native RBAC - Your UI permissions are derived directly from your ClickHouse grants
  • Multi-Cluster - Manage multiple ClickHouse clusters from a single UI

2. Features

Feature Description
Discover Kibana-style exploration with time filtering, field selection, and histograms
SQL Console Multi-tab editor with autocomplete, EXPLAIN, saved queries, and streaming
Table Explorer Browse schemas with parts, merges, mutations, and DDL views
Monitoring 8 dashboards for metrics, cluster, disks, Keeper, and replication
Query Analytics Running queries, history, performance analysis, and cache stats
Logging Server logs, session logs, and crash logs
Access Control User and role management with feature roles
Settings View server and session settings
Multi-Cluster Manage multiple ClickHouse clusters from a single login screen

3. Multi-Cluster Support

ClickLens supports connecting to multiple independent ClickHouse clusters from a single instance. Each cluster is registered in the CLICKHOUSE_CLUSTERS environment variable, and users select which cluster to log into from the login page.

Quick Start (Docker Compose)

cp env.sample .env.local
# Edit .env.local with your cluster definitions
docker compose -f docker-compose.multi-cluster.yml up --build -d

Each cluster entry in CLICKHOUSE_CLUSTERS requires:

Field Description
id Unique identifier for the cluster
label Display name shown in the UI
host ClickHouse HTTP host
port HTTP port (default 8123)
lensUser Service account for metadata ops
lensPassword Service account password

Once logged in, every authenticated request is pinned to the selected cluster — queries, monitoring, schema browsing, and access control all operate against that cluster.

4. Documentation

Full documentation is available at https://ntk148v.github.io/clicklens.

Section Description
Getting Started Installation and first login
Features All features with usage instructions
Architecture Tech stack, data flow, internals
Deployment Configuration, Docker, RBAC setup
Contributing Development setup, code guidelines

AI generated documentation:

4. Screenshots

Discovery

Overview Filter Expandable Row
discovery-overview discovery-filter discovery-expandable-row

SQL Console

Overview Run Query Results
sql-overview sql-run sql-run-result
History Time Range Table Preview
sql-history sql-time-range-selector sql-table-preview-data

Monitoring

Overview Metrics Async Metrics
monitoring-overview monitoring-metrics monitoring-async-metrics
Disks ZooKeeper
monitoring-disk monitoring-zookeeper

Queries

History History Filter Running Analytics
queries-history queries-history-filter queries-running queries-analytics

Access Control

Users Create User Edit User
access-user-overview access-user-create access-user-edit
Roles Create Role Feature Role
access-role-overview access-role-create access-role-feature-role

Settings

Server Settings Server Expandable Session Settings Session Expandable
settings-server settings-server-expandable-row settings-session settings-session-expandable-row

Tables

Columns Parts
tables-columns tables-parts

Logging

Server Logs Crash Logs
logging-server logging-crash

Profile

User Profile
profile

6. License

MIT

About

ClickLens provides a comprehensive suite of tools for developers, analysts, and administrators to interact with their ClickHouse clusters efficiently.

Topics

Resources

Stars

46 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages