2.6 KiB
2.6 KiB
LogWisp Documentation
Welcome to the LogWisp documentation. This guide covers all aspects of installing, configuring, and using LogWisp for multi-stream log monitoring.
📚 Documentation Index
Getting Started
- Installation Guide - How to install LogWisp on various platforms
- Quick Start - Get up and running in 5 minutes
- Architecture Overview - System design and components
Configuration
- Configuration Guide - Complete configuration reference
- Environment Variables - Environment variable reference
- Command Line Options - CLI flags and parameters
Features
- Filters Guide - Pattern-based log filtering
- Rate Limiting - Request and connection limiting
- Router Mode - Path-based multi-stream routing
- Authentication - Securing your log streams (planned)
Operations
- Monitoring & Status - Health checks and statistics
- Performance Tuning - Optimization guidelines
- Troubleshooting - Common issues and solutions
Advanced Topics
- Security Best Practices - Hardening your deployment
- Integration Examples - Working with other tools
- Development Guide - Contributing to LogWisp
🚀 Quick Links
- Example Configurations - Ready-to-use config templates
- API Reference - SSE/TCP protocol documentation
- Changelog - Version history and updates
💡 Common Use Cases
Single Application Monitoring
Monitor logs from one application with basic filtering:
[[streams]]
name = "myapp"
[streams.monitor]
targets = [{ path = "/var/log/myapp", pattern = "*.log" }]
[[streams.filters]]
type = "include"
patterns = ["ERROR", "WARN"]
Multi-Service Architecture
Monitor multiple services with different configurations:
logwisp --router --config /etc/logwisp/services.toml
High-Security Environments
Enable authentication and rate limiting:
[streams.httpserver.rate_limit]
enabled = true
requests_per_second = 10.0
max_connections_per_ip = 3
🔍 Finding Help
- GitHub Issues: Report bugs or request features
- Discussions: Ask questions and share ideas
- Examples: Check the examples directory for common scenarios
📝 License
BSD-3-Clause