https://github.com/mr-karan/logchef
Lightweight, single-binary log analytics interface for ClickHouse, focused on high-performance querying and visualization
https://github.com/mr-karan/logchef
clickhouse log-analytics logging
Last synced: 5 months ago
JSON representation
Lightweight, single-binary log analytics interface for ClickHouse, focused on high-performance querying and visualization
- Host: GitHub
- URL: https://github.com/mr-karan/logchef
- Owner: mr-karan
- License: agpl-3.0
- Created: 2024-09-25T04:57:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-01-20T14:47:29.000Z (5 months ago)
- Last Synced: 2026-01-20T16:09:51.392Z (5 months ago)
- Topics: clickhouse, log-analytics, logging
- Language: Vue
- Homepage: https://logchef.app/
- Size: 21.4 MB
- Stars: 650
- Watchers: 4
- Forks: 41
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-clickhouse - mr-karan/logchef - Logchef is a lightweight, high-performance log analytics platform built on ClickHouse, offering schema-agnostic querying, team-based access control, and easy deployment as a single binary. (Integrations / Data Visualization and Analysis)
README
A modern, single binary, high-performance log analytics platform
Try Demo ·
Read Documentation ·
Announcement Blog Post
LogChef is a lightweight, powerful log analytics platform designed for efficient log management and analysis. It operates as a single binary, utilizing ClickHouse for high-performance log storage and querying. LogChef provides an intuitive interface for exploring log data, making it suitable for development teams seeking a robust and scalable solution.
## Features
- **Query-first log exploration**: Fast filtering with both LogChefQL and ClickHouse SQL.
- **AI Query Assistant**: Turn natural language into SQL instantly.
- **Real-time alerting**: Schedule rules and send email or webhook notifications.
- **OIDC + RBAC included**: SSO and team-based access out of the box.
- **Schema-agnostic**: Point at any ClickHouse table without migrations.
- **Single binary**: One executable, no runtime dependencies.
- **Comprehensive metrics**: Prometheus metrics for usage and performance.
- **MCP integration**: Model Context Protocol server for AI assistants ([logchef-mcp](https://github.com/mr-karan/logchef-mcp)).
- **CLI**: Query logs from your terminal with syntax highlighting and multi-context support.
## Quick Start
### Docker
```shell
# Download the Docker Compose file
curl -LO https://raw.githubusercontent.com/mr-karan/logchef/refs/heads/main/deployment/docker/docker-compose.yml
# Start the services
docker compose up -d
```
Access the Logchef interface at `http://localhost:8125`.
## CLI
LogChef includes a powerful CLI for querying logs directly from your terminal.
### Install
Download the latest release for your platform from [GitHub Releases](https://github.com/mr-karan/logchef/releases?q=cli&expanded=true):
```bash
# macOS (Apple Silicon)
curl -LO https://github.com/mr-karan/logchef/releases/download/cli-v0.1.1/logchef-darwin-arm64.tar.gz
# macOS (Intel)
curl -LO https://github.com/mr-karan/logchef/releases/download/cli-v0.1.1/logchef-darwin-amd64.tar.gz
# Linux (x86_64)
curl -LO https://github.com/mr-karan/logchef/releases/download/cli-v0.1.1/logchef-linux-amd64.tar.gz
# Linux (ARM64)
curl -LO https://github.com/mr-karan/logchef/releases/download/cli-v0.1.1/logchef-linux-arm64.tar.gz
# Extract and install
tar -xzf logchef-*.tar.gz
sudo mv logchef /usr/local/bin/
```
### Usage
```bash
# Authenticate with your LogChef server
logchef auth --server https://logs.example.com
# Query logs with LogChefQL
logchef query "level:error" --since 1h
# Execute raw SQL
logchef sql "SELECT * FROM logs.app WHERE level='error' LIMIT 10"
```
For full documentation, see the [CLI Guide](https://logchef.app/integration/cli/).
## Documentation
For comprehensive documentation, including setup guides, configuration options, and API references, please visit [logchef.app](https://logchef.app).
## Contributing
We welcome contributions! To get started:
1. **Development Setup**: See our [Development Setup Guide](https://logchef.app/contributing/setup) or use the Nix flake:
```bash
nix develop
just sqlc-generate
just dev-docker
just build
```
2. **Read the Guidelines**: Check [CONTRIBUTING.md](./CONTRIBUTING.md) for detailed contribution guidelines
3. **Find an Issue**: Look for issues labeled `good first issue` or `help wanted`
4. **Make Your Changes**: Follow our coding standards and run `just check` before submitting
For questions or help, open an issue or start a discussion on GitHub.
## Screenshots
## License
LogChef is distributed under the terms of the AGPLv3 License.
### Credits
The Logchef logo was designed by [Namisha Katira](https://www.behance.net/katiranimi015d).