📦 DevOps Monitoring in a Box

🚀 Overview

This project provides a ready-to-use monitoring stack for DevOps engineers and beginners. With just one command, you get:

🎯 Demo Preview Available: Check out the live demo at devops-monitoring-in-a-box.vercel.app
Login: demo@example.com / demo123 (Demo credentials only - configure your own for production)

Prometheus → Metrics collection
Grafana → Beautiful dashboards
Loki → Centralized log aggregation
Alertmanager → Alerts via Slack/Email/Webhooks
Node Exporter → System metrics (CPU, RAM, Disk, etc.)
🔔 Notification Service → Multi-channel notifications (Slack, Teams, Discord, Email, Webhooks)
🎨 Modern React UI → Unified dashboard experience (What makes us unique!)

👉 Perfect for learning, testing, or quick local monitoring setup.

🚀 What Sets Us Apart: While most monitoring projects stop at Prometheus + Grafana, we provide a modern, responsive web interface that unifies all your monitoring tools into one beautiful dashboard experience!

🖼️ Visual Showcase

See what you'll get with our modern monitoring dashboard:

Main Dashboard _{Unified monitoring dashboard with system overview}	Metrics & Analytics _{Real-time metrics visualization and analysis}
Log Management _{Centralized log viewing and search}	Alert Management _{Comprehensive alert monitoring and management}
Service Monitoring _{Service health and status overview}	Settings & Configuration _{Comprehensive settings and configuration options}

Comprehensive settings and configuration options for all monitoring aspects

🚀 Usage & Deployment

Choose your preferred deployment method based on your needs:

🐳 Docker Deployment (Recommended)

Option 1: Use Pre-built Image (Fastest)

# Pull and run the pre-built image
docker pull harshhaareddy/devops-monitoring-box:latest
docker run -d -p 4000:4000 --name devops-monitor harshhaareddy/devops-monitoring-box:latest

# Access the application
open http://localhost:4000

Option 2: Build Your Own Image

# Clone the repository
git clone https://github.com/NotHarshhaa/devops-monitoring-in-a-box.git
cd devops-monitoring-in-a-box

# Build your custom image
docker build -t your-username/devops-monitoring-box:latest .

# Run your custom image
docker run -d -p 4000:4000 --name devops-monitor your-username/devops-monitoring-box:latest

# Push to your registry (optional)
docker push your-username/devops-monitoring-box:latest

Option 3: Full Stack with Docker Compose

# Clone and start the complete monitoring stack
git clone https://github.com/NotHarshhaa/devops-monitoring-in-a-box.git
cd devops-monitoring-in-a-box

# Start all services (Prometheus, Grafana, Loki, etc.)
./devops-monitor.sh start

# Or manually with Docker Compose
docker compose up -d

🌐 Cloud Deployment

Vercel (Frontend Only)

# Deploy the UI to Vercel
cd ui-next
npm install
vercel --prod

# Or use the one-click deploy button above

Features:

✅ Automatic deployments from GitHub
✅ Custom domain support
✅ Environment variables management
✅ Serverless functions support

Netlify (Frontend Only)

# Build and deploy to Netlify
cd ui-next
npm install
npm run build

# Upload the 'out' folder to Netlify
# Or connect your GitHub repository for auto-deployments

Features:

✅ Continuous deployment from Git
✅ Form handling and serverless functions
✅ CDN and edge functions
✅ Branch previews

Railway (Full Stack)

# Deploy full stack to Railway
railway login
railway init
railway up

🏗️ Self-Hosted Options

Kubernetes

# Apply Kubernetes manifests
kubectl apply -f k8s/
kubectl get pods -n monitoring

Traditional VPS/Server

# On your server
git clone https://github.com/NotHarshhaa/devops-monitoring-in-a-box.git
cd devops-monitoring-in-a-box

# Install dependencies
sudo apt update && sudo apt install docker.io docker-compose

# Start services
./devops-monitor.sh start

🎯 Access Points

Once deployed, access your monitoring tools:

Service	URL	Credentials	Description
🎨 Modern UI	http://localhost:4000	-	Unified dashboard experience
📊 Grafana	http://localhost:3000	admin/admin	Visualization dashboards
📈 Prometheus	http://localhost:9090	-	Metrics collection & querying
📜 Loki	http://localhost:3100	-	Log aggregation
🚨 Alertmanager	http://localhost:9093	-	Alert management

🔧 Quick Management Commands

# Check status
./devops-monitor.sh status

# View logs
./devops-monitor.sh logs

# Stop services
./devops-monitor.sh stop

# Restart services
./devops-monitor.sh restart

# Clean up (removes all containers and volumes)
./devops-monitor.sh clean

📂 Project Structure

The Monitoring in a Box project is organized into several key directories, each serving a specific purpose in the monitoring ecosystem.

🏗️ Core Components

prometheus/ - Metrics collection and alerting configuration
grafana/ - Dashboard and visualization setup
loki/ - Log aggregation and collection
alertmanager/ - Alert routing and notifications
ui-next/ - Modern Next.js web interface
docs/ - Comprehensive documentation
exporters/ - System metrics exporters

🎯 Key Files

devops-monitor.sh - Main management script (wrapper)
env.example - Environment variables template
site-config.json - Site configuration (SEO, branding)
config.json - Monitoring configuration
docker-compose.yml - Production stack configuration
scripts/ - All management and setup scripts

📖 Detailed Structure

For a complete breakdown of all directories, files, and their purposes, see our comprehensive Project Structure Guide.

📊 Features

🔧 Core Monitoring Stack

📈 Metrics Collection: Prometheus with Node Exporter for system metrics
🖼️ Dashboards: Pre-configured Grafana dashboards with beautiful visualizations
📜 Log Aggregation: Loki + Promtail for centralized log management
🚨 Alert Management: Alertmanager with multi-channel notifications
📊 Service Health: Real-time service status monitoring

🎨 Modern Web Interface

🖥️ Unified Dashboard: Single-page application for all monitoring needs
📱 Responsive Design: Works perfectly on desktop, tablet, and mobile
🌙 Dark/Light Theme: Automatic theme switching with user preference
⚡ Real-time Updates: Live data refresh without page reloads
🎯 Intuitive Navigation: Easy-to-use sidebar navigation

🔐 Authentication & Security

👤 User Authentication: Secure login system with session management
🏢 Multi-tenant Support: Role-based access control (Admin, Editor, Viewer)
🔒 Secure API: Protected endpoints with authentication middleware
🛡️ Input Validation: Comprehensive data validation and sanitization

📊 Advanced Monitoring Features

📈 Custom Metrics: Define and monitor custom application metrics
📊 Dynamic Dashboards: Create and customize monitoring dashboards
🔍 Log Search: Advanced log filtering and search capabilities
📊 Metrics Visualization: Interactive charts and graphs
⏰ Historical Data: Time-series data analysis and trending

🔔 Notification System

📧 Email Alerts: SMTP-based email notifications
💬 Slack Integration: Direct Slack channel notifications
🎯 Microsoft Teams: Teams webhook integration
🎮 Discord Support: Discord webhook notifications
🔗 Custom Webhooks: Generic webhook support for any service

⚙️ Configuration Management

🎛️ Dynamic Configuration: JSON-based configuration system
🔄 Hot Reloading: Configuration changes without restart
📁 Import/Export: Share configurations between environments
✅ Validation: Built-in configuration validation
🎨 Site Customization: SEO, branding, and company information

🔌 Plugin System

🧩 Extensible Architecture: Plugin-based system for custom integrations
📦 Plugin Marketplace: Browse and install community plugins
⚙️ Plugin Configuration: Easy plugin setup and management
🔧 Custom Plugins: Create your own monitoring plugins

📚 Documentation & Support

📖 Comprehensive Docs: Detailed documentation for all features
🎯 Quick Start Guide: Get up and running in minutes
🔧 Configuration Examples: Ready-to-use configuration templates
💡 Best Practices: Industry-standard monitoring practices

⚙️ Configuration

Configure your Monitoring in a Box platform with comprehensive environment variables and configuration files.

🔧 Quick Setup

Copy example configuration:
```
cp env.example .env
```
Edit your settings:
```
nano .env
```
Start the platform:
```
docker-compose up -d
```

📖 Complete Configuration Guide

For detailed configuration options, environment variables, and deployment settings, see our comprehensive Configuration Guide.

Key Configuration Areas:

🌐 Site Configuration: SEO, branding, company information
🔐 Authentication & Security: Database, sessions, JWT tokens
📊 Monitoring Services: Prometheus, Grafana, Loki, Alertmanager
🔔 Notifications: Email, Slack, Teams, Discord, webhooks
🎨 UI Settings: Themes, dashboards, logs configuration
🔌 Plugin System: Plugin management and marketplace
🏢 Multi-tenancy: Tenant isolation and management
🚀 Deployment: Docker, Kubernetes, production settings

🔧 Next Steps (for contributors)

Add more exporters (MySQL, Redis, Nginx, etc.)
Add Kubernetes manifests for K8s-based deployment
Add Terraform/Ansible automation for cloud deployment

🚀 Getting Started

📖 For detailed setup instructions, see SETUP.md

🎯 Quick Setup

Clone and setup environment:

git clone https://github.com/NotHarshhaa/devops-monitoring-in-a-box.git
cd devops-monitoring-in-a-box

# Setup environment (creates .env files, installs dependencies)
./scripts/setup-env.sh

Start the monitoring stack:

# Start everything (monitoring stack + UI)
./scripts/devops-monitor.sh start

# Check health of all services
./scripts/devops-monitor.sh health

🎯 Management Commands

We've created convenient scripts to manage your entire monitoring stack:

# Start everything (monitoring stack + UI)
./scripts/devops-monitor.sh start

# Start just the UI development server
./scripts/devops-monitor.sh ui

# Check project status
./scripts/devops-monitor.sh status

# Run comprehensive health check
./scripts/devops-monitor.sh health

# View service logs
./scripts/devops-monitor.sh logs

# Stop everything
./scripts/devops-monitor.sh stop

# Clean up (removes containers and volumes)
./scripts/devops-monitor.sh clean

# Get help
./scripts/devops-monitor.sh help

Prerequisites

Docker and Docker Compose installed
At least 2GB of available RAM
Ports 3000, 4000, 9090, 3100, 9093 available

Installation

Clone the repository:

git clone https://github.com/NotHarshhaa/devops-monitoring-in-a-box.git
cd devops-monitoring-in-a-box

Setup environment:

# Setup environment (creates .env files, installs dependencies)
./scripts/setup-env.sh

Start the monitoring stack:

# Option 1: Using the management script (Recommended)
./scripts/devops-monitor.sh start

# Option 2: Using Docker Compose directly
docker compose up -d

Verify all services are running:

# Check status
./scripts/devops-monitor.sh status

# Run health check
./scripts/devops-monitor.sh health

Access the services:
- 🎨 DevOps Monitor UI: http://localhost:4000
- 📊 Grafana: http://localhost:3000 (admin/admin)
- 📈 Prometheus: http://localhost:9090
- 📜 Loki: http://localhost:3100
- 🚨 Alertmanager: http://localhost:9093

Stopping the Stack

# Using management script
./scripts/devops-monitor.sh stop

# Or using Docker Compose directly
docker compose down

Viewing Logs

# All services
./scripts/devops-monitor.sh logs

# Or using Docker Compose directly
docker compose logs

# Specific service
docker compose logs prometheus
docker compose logs grafana

📈 What You'll Get

Prometheus

Scrapes metrics from Node Exporter every 15 seconds
Stores time-series data for historical analysis
Built-in query language (PromQL) for data exploration

Grafana

Pre-configured Prometheus data source
Node Exporter dashboard showing system metrics
Easy to create custom dashboards and alerts

Loki

Collects logs from various sources
Efficient log storage and querying
Integration with Grafana for log visualization

Alertmanager

Sample alert rules for system monitoring
Ready for Slack/Email/Webhook integration
Manages alert routing and silencing

Node Exporter

Exports system metrics (CPU, memory, disk, network)
Low resource footprint
Industry standard for system monitoring

📚 Documentation

📖 Complete Documentation - Comprehensive guides and setup instructions

Key Documentation Links:

Setup Guide - Detailed setup instructions
Configuration Guide - Complete configuration reference
Project Structure - Complete project structure overview
Prometheus Integration - Metrics collection and configuration
Grafana Dashboards - Dashboard setup and customization
Loki Logs - Log aggregation and search
AlertManager - Alert management and notifications
Authentication & Multi-Tenancy - User management and role-based access
UI Application - Next.js web interface documentation
Configuration System - Dynamic configuration management
Service Health - Health monitoring and status checks
UX Improvements - User interface enhancements
Plugin System - Plugin development and management
Dashboard Templates - Template creation and marketplace
Notifications Integration - Multi-channel notification setup
Production Setup - Production deployment guide

🎯 Quick Access

Main Documentation Hub: docs/README.md
All Documentation Files: docs/ folder

🔒 Security Notes

Default credentials are for development only
Change default passwords in production
Consider using secrets management for sensitive configs
Restrict network access in production environments

🤝 Contributing

Fork the repository
Create a feature branch
Make your changes
Add tests if applicable
Submit a pull request

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

Prometheus - Metrics collection
Grafana - Visualization platform
Loki - Log aggregation
Node Exporter - System metrics

🛠️ Author & Community

Built with passion and purpose by Harshhaa.
Your ideas, feedback, and contributions are what make this project better.

Let’s shape the future of DevOps monitoring together! 🚀

Connect & Collaborate:

GitHub: @NotHarshhaa
Blog: ProDevOpsGuy
Telegram Community: Join Here
LinkedIn: Harshhaa Vardhan Reddy

⭐ How You Can Support

If you found this project useful:

⭐ Star the repository to show your support
📢 Share it with your friends and colleagues
📝 Open issues or submit pull requests to help improve it

📢 Stay Connected

Join the community, share your experience, and help us grow!

Name		Name	Last commit message	Last commit date
Latest commit History 68 Commits
.github/workflows		.github/workflows
alertmanager		alertmanager
docs		docs
grafana		grafana
loki		loki
prometheus		prometheus
scripts		scripts
ui-next		ui-next
.dockerignore		.dockerignore
.gitignore		.gitignore
DOCKER_README.md		DOCKER_README.md
Dockerfile		Dockerfile
Dockerfile.buildx		Dockerfile.buildx
LICENSE		LICENSE
README.md		README.md
config.json		config.json
config.yaml		config.yaml
devops-monitor.sh		devops-monitor.sh
docker-compose.dev.yml		docker-compose.dev.yml
docker-compose.env.example		docker-compose.env.example
docker-compose.yml		docker-compose.yml
env.example		env.example
site-config.json		site-config.json

License

NotHarshhaa/devops-monitoring-in-a-box

Folders and files

Latest commit

History

Repository files navigation