logchef

module
v0.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 4, 2025 License: AGPL-3.0

README

Logchef Logo

A modern, single binary, high-performance log analytics platform

Try Demo · Read Documentation · Announcement Blog Post

Logchef Light Explore View

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

  • Schema-Agnostic Log Exploration: Query any ClickHouse table without predefined schema constraints.
  • Flexible Query Options: Supports both simple search syntax and full ClickHouse SQL for advanced analysis.
  • AI-Powered SQL Generation: Transform natural language questions into ClickHouse SQL queries using OpenAI-compatible models.
  • MCP Integration: Model Context Protocol server for seamless AI assistant integration (logchef-mcp).
  • High Performance: Engineered for fast query execution on large datasets with minimal resource consumption.
  • Team-Based Access Control: Provides secure, multi-tenant log access with configurable, fine-grained permissions.
  • Comprehensive Metrics: Built-in Prometheus metrics for monitoring instance usage, performance, and health.
  • Single Binary Deployment: Simplifies installation, deployment, and management.

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.

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

Logchef Light Explore View Logchef Dark Explore View Logchef Collections View Logchef Teams View Logchef Users View Logchef Source Settings View

License

Logchef is distributed under the terms of the AGPLv3 License.

Credits

The Logchef logo was designed by Namisha Katira.

Directories

Path Synopsis
cmd
server command
Package docs Code generated by swaggo/swag.
Package docs Code generated by swaggo/swag.
internal
ai
app
pkg
logger
Package logger provides a simple wrapper around slog for structured logging
Package logger provides a simple wrapper around slog for structured logging
models
Package models defines the core data structures used throughout LogChef.
Package models defines the core data structures used throughout LogChef.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL