How to configure Chproxy for load balancing with Docker?

Chproxy can be deployed via Docker using its official image; you need to mount a configuration file defining clusters and users, then expose ports for HTTP access. Refer to the documentation for example YAML configurations.

Does Chproxy support authentication with ClickHouse clusters?

Yes, Chproxy provides built-in authentication and authorization, allowing you to define users with credentials and permissions in the config file, acting as a secure gateway without modifying ClickHouse settings.

What are the performance overheads of using Chproxy?

Chproxy adds minimal latency due to its lightweight Go implementation, but caching and rate limiting can improve overall performance by reducing database load. However, for very high-throughput scenarios, proxy bottlenecks might occur.

Chproxy vs NGINX for ClickHouse load balancing?

Chproxy is specialized for ClickHouse with features like query caching and native protocol support, while NGINX is a general-purpose proxy requiring more configuration. Choose Chproxy for ClickHouse-specific optimizations, NGINX for multi-service environments.

Can Chproxy cache dynamic query results effectively?

Chproxy caches query results based on configurable TTLs, but for highly dynamic data, caching might lead to staleness. It's best for repeated, stable queries, and you need to tune cache settings carefully.

How to enable TLS and secure connections in Chproxy?

Enable TLS by specifying certificate paths in the configuration file under the 'tls' section; Chproxy terminates TLS, encrypting traffic between clients and the proxy, but ensure ClickHouse backend is also secured if needed.

Open-Awesome

chproxy

MITGov1.30.0

An HTTP proxy and load balancer for ClickHouse databases with caching, rate limiting, and security features.

Visit Website GitHub

1.5k stars276 forks0 contributors

What is chproxy?

Chproxy is an open-source HTTP proxy and load balancer specifically designed for ClickHouse databases. It acts as an intermediary layer between applications and ClickHouse clusters, providing essential production features like load balancing, caching, and security controls. The project solves the challenge of managing and securing ClickHouse deployments at scale.

Target Audience

Database administrators, DevOps engineers, and developers who manage ClickHouse clusters in production environments and need to improve reliability, security, and performance.

Value Proposition

Developers choose Chproxy because it provides a lightweight, specialized solution for ClickHouse that's easier to deploy and manage than general-purpose proxies. Its tight integration with ClickHouse's HTTP protocol and focus on database-specific features make it more efficient than alternatives.

Overview

Open-Source ClickHouse http proxy and load balancer

Use Cases

Best For

Load balancing queries across ClickHouse cluster replicas
Caching frequent query results to reduce database load
Implementing rate limiting for ClickHouse API access
Adding authentication and authorization layers to ClickHouse
Monitoring and logging all ClickHouse queries centrally
Securing ClickHouse deployments with TLS termination

Not Ideal For

Teams managing multi-database environments where ClickHouse is just one component
Projects requiring real-time data streaming or WebSocket support beyond HTTP
Organizations needing a fully managed proxy service with enterprise support SLAs
Environments where extensive plugin ecosystems or dynamic routing are essential

Pros & Cons

Pros

ClickHouse-Specific Optimization

Designed exclusively for ClickHouse's HTTP interface, ensuring full compatibility and efficient query handling, as emphasized in the philosophy of maintaining native compatibility.

Production-Ready Feature Set

Bundles essential features like load balancing, response caching, and rate limiting out of the box, reducing the need for additional tools in ClickHouse deployments.

Enhanced Security Layers

Provides authentication, authorization, and TLS termination, securing ClickHouse access without modifying the database itself, as highlighted in the key features.

Comprehensive Query Monitoring

Logs all queries for auditing and debugging, which is crucial for compliance and performance tuning in production environments.

Cons

Niche Scope Limitation

Only supports ClickHouse, making it ineffective for projects using other databases or requiring a unified proxy for multiple data sources.

Configuration Complexity

Requires manual setup via configuration files, which can be error-prone and time-consuming for large or dynamic clusters, without a built-in UI for management.

Ecosystem Dependency

Tightly coupled to ClickHouse's development; updates or changes in ClickHouse might necessitate timely Chproxy updates, posing maintenance risks.

Frequently Asked Questions

Related Projects

vitess

Vitess is a database clustering system for horizontal scaling of MySQL.

Stars21,006

Forks2,346

Last commit2 days ago

Pgweb

Cross-platform client for PostgreSQL databases

Stars9,372

Forks841

Last commit5 days ago

go-mysql

a powerful mysql toolset with Go

Stars4,950

Forks1,060

Last commit11 days ago

prest

PostgreSQL ➕ REST, low-code, simplify and accelerate development, ⚡ instant, realtime, high-performance on any Postgres application, existing or new

Stars4,550

Forks308

Last commit1 month ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub