Skip to content

LogWhisperer is a self-hosted, AI-powered log summarization tool for Linux servers.

License

Notifications You must be signed in to change notification settings

binary-knight/logwhisperer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LogWhisperer 🔍

License: MIT Python 3.8+ Docker Discord

AI-powered log analysis and monitoring tool that uses local LLMs to provide intelligent insights from your system logs.

LogWhisperer Demo

✨ Features

  • 🤖 AI-Powered Analysis - Uses Ollama for local LLM processing
  • 📊 Multiple Log Sources - Supports journalctl, files, and Docker containers
  • 🚨 Real-time Alerts - Discord notifications with @mentions
  • 🔍 Smart Summarization - Intelligent pattern detection
  • 🐳 Docker Ready - Full containerization support
  • 🛡️ Production Ready - Rate limiting, deduplication, caching

🚀 Quick Start

Option 1: Download Binary (Easiest)

# Download latest release
wget https://github.com/yourusername/logwhisperer/releases/latest/download/logwhisperer_linux_x86_64.zip
unzip logwhisperer_linux_x86_64.zip
sudo ./install.sh

# Test it
logwhisperer test

Option 2: Docker (Recommended)

# Clone and run with docker-compose
git clone https://github.com/yourusername/logwhisperer.git
cd logwhisperer
docker-compose up -d

Option 3: From Source

# Clone and install
git clone https://github.com/yourusername/logwhisperer.git
cd logwhisperer
pip install -r requirements.txt
python logwhisperer.py --help

📖 Basic Usage

Summarize Logs

# Recent system errors
logwhisperer summarize --source journalctl --priority err

# Specific log file
logwhisperer summarize --source file --logfile /var/log/nginx/error.log

# Docker container
logwhisperer summarize --source docker --container myapp

Real-time Monitoring (PRO)

# Start monitoring with Discord alerts
logwhisperer monitor

# Monitor specific file
logwhisperer monitor --source file --file /var/log/app.log

⚙️ Configuration

Create /etc/logwhisperer/config.yaml:

# LLM Settings
model: mistral
ollama_host: http://localhost:11434

# Monitoring
monitor:
  webhook_url: https://discord.com/api/webhooks/YOUR_WEBHOOK
  escalation_level: ERROR
  
  # Discord @mentions (optional)
  discord_mentions:
    ERROR:
      - "123456789012345678"  # User ID
    CRITICAL:
      - "123456789012345678"  # User ID  
      - "&456789012345678901" # Role ID

🔨 Building from Source

Development

# Install dev dependencies
pip install -r requirements-dev.txt

# Run tests
pytest

# Build binary
./build.sh

CI/CD

# Tag a release
git tag v1.0.0
git push origin v1.0.0
# GitHub Actions handles the rest!

🐳 Docker

# Quick start
docker-compose up -d

# With external Ollama
docker-compose --profile external-ollama up -d

# Development mode
docker-compose --profile development up

📚 Documentation

🤝 Contributing

Contributions are welcome! Please read our Contributing Guide.

# Setup dev environment
git clone https://github.com/yourusername/logwhisperer.git
cd logwhisperer
pip install -r requirements-dev.txt
pre-commit install

📄 License

MIT License - see LICENSE for details.

🙏 Acknowledgments

🔗 Links


Made with ❤️ by the LogWhisperer Team

About

LogWhisperer is a self-hosted, AI-powered log summarization tool for Linux servers.

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published