Initial commit: LogMaster with Viewer Collector Monitor modes
This commit is contained in:
44
README.md
Normal file
44
README.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# Log Viewer
|
||||
|
||||
A powerful log management tool with four operating modes: Viewer, Collector, Monitor, and combined. Features web UIs, S3 integration, UDP ingestion, log rotation, pattern-based alerting, and multi-channel notifications.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npm run build
|
||||
node dist-server/server.js
|
||||
```
|
||||
|
||||
Open http://localhost:8080 in your browser.
|
||||
|
||||
## Modes
|
||||
|
||||
| Mode | Command | Port | Description |
|
||||
|------|---------|------|-------------|
|
||||
| Both (default) | `node dist-server/server.js` | 8080 | Viewer + Collector |
|
||||
| Viewer | `cp .env.viewer .env && node dist-server/server.js` | 9090 | Read & display logs |
|
||||
| Collector | `cp .env.collector .env && node dist-server/server.js` | 8081 | Receive & store logs |
|
||||
| Monitor | `cp .env.monitor .env && node dist-server/server.js` | 8082 | Scan & alert on patterns |
|
||||
|
||||
## Documentation
|
||||
|
||||
- **[Full Documentation](DOCS.md)** — Complete reference
|
||||
- **[Viewer Guide](docs/VIEWER.md)** — How to use the log viewer
|
||||
- **[Collector Guide](docs/COLLECTOR.md)** — How to set up log collection
|
||||
- **[Monitor Guide](docs/MONITOR.md)** — How to configure pattern alerts
|
||||
|
||||
## Features
|
||||
|
||||
- Multi-source: local files, gzip/bz2/xz/zst, S3, UDP, HTTP
|
||||
- Real-time log streaming with live highlighting
|
||||
- Regex search with level filtering
|
||||
- Log rotation (size + time based, with compression)
|
||||
- Forward to HTTP, file, UDP, or console
|
||||
- Pattern monitoring with Telegram, Webhook, Teams, Email alerts
|
||||
- Scheduled scans (continuous, daily, hourly)
|
||||
- Dark/Light theme, keyboard shortcuts, export
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
Reference in New Issue
Block a user