7043429150
- Backend: Go API server with Gin framework - Frontend: React setup (placeholder) - ML Service: Python FastAPI skeleton - Docker Compose: Full stack configuration - Database: PostgreSQL schema with migrations - Documentation: Implementation plan and README Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
94 lines
1.9 KiB
Markdown
94 lines
1.9 KiB
Markdown
# VictoriaLogs Manager
|
|
|
|
A comprehensive web application for managing VictoriaLogs with alerting, advanced reporting, and malicious pattern detection.
|
|
|
|
## Features
|
|
|
|
- **Log Exploration**: Query and search logs using LogsQL with visual query builder
|
|
- **Alert Management**: Create and manage vmalert rules with YAML editor
|
|
- **Pattern Detection**: Find malicious patterns using regex and ML-based anomaly detection
|
|
- **Reports & Dashboards**: Fancy visualizations and custom reports
|
|
- **Role-Based Access**: Admin, Editor, Analyst, and Viewer roles
|
|
|
|
## Tech Stack
|
|
|
|
- **Backend**: Go (Gin framework)
|
|
- **Frontend**: React + TypeScript + Vite
|
|
- **Database**: PostgreSQL
|
|
- **ML Service**: Python (FastAPI + scikit-learn)
|
|
- **Deployment**: Docker Compose
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
victorialogs-manager/
|
|
├── backend/ # Go API server
|
|
├── frontend/ # React SPA
|
|
├── ml-service/ # Python ML service
|
|
└── docker-compose.yml
|
|
```
|
|
|
|
## Getting Started
|
|
|
|
### Prerequisites
|
|
|
|
- Go 1.21+
|
|
- Node.js 18+
|
|
- Python 3.11+
|
|
- Docker & Docker Compose
|
|
|
|
### Quick Start with Docker
|
|
|
|
```bash
|
|
# Copy environment file
|
|
cp .env.example .env
|
|
|
|
# Edit .env with your configuration
|
|
nano .env
|
|
|
|
# Start all services
|
|
docker-compose up -d
|
|
```
|
|
|
|
The application will be available at:
|
|
- Frontend: http://localhost:3000
|
|
- Backend API: http://localhost:8080
|
|
- VictoriaLogs: http://localhost:9428
|
|
|
|
### Development Setup
|
|
|
|
#### Backend
|
|
```bash
|
|
cd backend
|
|
go mod download
|
|
go run cmd/server/main.go
|
|
```
|
|
|
|
#### Frontend
|
|
```bash
|
|
cd frontend
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
#### ML Service
|
|
```bash
|
|
cd ml-service
|
|
pip install -r requirements.txt
|
|
uvicorn app.main:app --reload
|
|
```
|
|
|
|
## Configuration
|
|
|
|
See `.env.example` for all available configuration options.
|
|
|
|
## Documentation
|
|
|
|
- [API Documentation](./docs/api.md) (coming soon)
|
|
- [User Guide](./docs/user-guide.md) (coming soon)
|
|
- [Deployment Guide](./docs/deployment.md) (coming soon)
|
|
|
|
## License
|
|
|
|
MIT
|