Logchef

<a href="https://zerodha.tech"><img src="https://zerodha.tech/static/images/github-badge.svg" /></a>

<p align="center"><img src="LOGCHEF.svg" alt="Logchef Logo" /></p> <p align="center">A modern, single binary, high-performance log analytics platform</p> <p align="center"> <a href="https://demo.logchef.app"><strong>Try Demo</strong></a> · <a href="https://logchef.app"><strong>Read Documentation</strong></a> · <a href="https://mrkaran.dev/posts/announcing-logchef/"><strong>Announcement Blog Post</strong></a> </p> <p align="center"> <img alt="Logchef Log Explorer" src="docs/public/screenshots/hero-light.png"> </p>

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).
• CLI: Query logs from your terminal with syntax highlighting and multi-context support.

Quick Start

Docker

# 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:

# 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

# 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.

Documentation

For comprehensive documentation, including setup guides, configuration options, and API references, please visit logchef.app.

Contributing

We welcome contributions! To get started:

1. Development Setup: See our Development Setup Guide or use the Nix flake:

   nix develop
   just sqlc-generate
   just dev-docker
   just build
   

2. Read the Guidelines: Check 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.