gonzo  by control-theory

Log analysis tool with TUI

Created 1 month ago
1,564 stars

Top 26.7% on SourcePulse

GitHubView on GitHub
Project Summary

Gonzo is a powerful, real-time log analysis tool designed for terminal users, offering a k9s-inspired interface with advanced filtering, AI-powered insights, and native OpenTelemetry log format (OTLP) support. It benefits developers and operations teams by enabling efficient log stream analysis directly within the terminal, reducing the need for external UIs or complex log aggregation platforms.

How It Works

Gonzo utilizes the Bubble Tea framework for its terminal UI, with Lipgloss for styling and Bubbles for components. It processes logs from various sources like files, stdin, and network OTLP receivers. Key features include real-time analysis with interactive charts (word frequency, attributes, severity), a familiar 2x2 dashboard layout, Vim-style navigation, and smart log viewing with pause/resume capabilities. AI analysis is integrated, supporting models like GPT-4 and GPT-3.5, and providers such as OpenAI, LM Studio, and Ollama, allowing for pattern detection, anomaly analysis, and root cause suggestions.

Quick Start & Requirements

  • Installation:
    • Go: go install github.com/control-theory/gonzo/cmd/gonzo@latest
    • Homebrew (macOS/Linux): brew tap control-theory/gonzo && brew install gonzo
    • Binary: Download from releases page.
    • Build from Source: git clone https://github.com/control-theory/gonzo.git && cd gonzo && make build
  • Prerequisites: Go 1.21+ for building from source. AI features require an OpenAI API key or a locally running AI model server (LM Studio, Ollama).
  • Setup Time: Minimal for basic usage; AI setup depends on local model availability or API key configuration.
  • Docs: Usage Guide, Contributing Guide, Changelog available.

Highlighted Details

  • Native OpenTelemetry Log (OTLP) receiver support via gRPC and HTTP.
  • AI-powered insights for log pattern detection, anomaly analysis, and debugging assistance.
  • K9s integration for seamless Kubernetes log analysis via a simple plugin.
  • Comprehensive log analysis modal with real-time heatmap, pattern analysis by severity, and service distribution.

Maintenance & Community

The project is maintained by ControlTheory and the Gonzo community. Contributions are welcomed via pull requests. Links to documentation and issue reporting are provided.

Licensing & Compatibility

Licensed under the MIT License, permitting commercial use and integration with closed-source projects.

Limitations & Caveats

AI analysis requires external API keys or local model setup, which may incur costs or require significant local resources. The effectiveness of AI insights depends on the chosen model and log data quality.

Health Check
Last Commit

2 days ago

Responsiveness

Inactive

Pull Requests (30d)
25
Issues (30d)
27
Star History
1,572 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.