logchef

module
v0.1.0-alpha.2 Latest Latest
Warning

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

Go to latest
Published: Apr 23, 2025 License: AGPL-3.0

README

Logchef

A modern, high-performance log analytics platform that runs as a single binary.

Logchef combines the power of Clickhouse for high-speed log storage with an intuitive frontend, offering powerful querying capabilities and visualization tools for development teams of all sizes.

Key Features

  • Universal Clickhouse UI: Connect to any Clickhouse table, schema-agnostic.
  • Dual Query Modes: Use simple search syntax or full Clickhouse SQL power.
  • High Performance: Leverage Clickhouse for fast queries on large datasets.
  • Team-Centric: Multi-tenant with user roles, teams, and source access control.
  • Low Resource Usage: Minimal footprint on top of Clickhouse.
  • Single Binary Deployment: Easy installation and management.

Demo

Visit demo.logchef.com to see Logchef in action.

Documentation

Comprehensive documentation is available at logchef.app.

Screenshots

Installation

Docker
# Download the compose file
curl -LO https://github.com/mr-karan/logchef/raw/master/docker-compose.yml

# Run the services
docker compose up -d

Visit http://localhost:8125

Binary
  • Download the latest release and extract the binary
  • Run ./logchef and visit http://localhost:8125

Developers

Logchef is open source software. If you're interested in contributing:

  1. Clone the repository.
  2. Set up your development environment with Go and Node.js.
  3. Run necessary development infrastructure (like Clickhouse) using just dev-docker.
  4. Build the project using just build.
  5. Run the backend server in one terminal: just run-backend.
  6. Run the frontend development server in another terminal: just run-frontend.

License

Logchef is licensed under the AGPLv3 License.

Directories

Path Synopsis
cmd
server command
Package docs Code generated by swaggo/swag.
Package docs Code generated by swaggo/swag.
internal
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