NetPulse

NetPulse is an enterprise-grade, real-time network monitoring dashboard for Network Operations Centers (NOCs). It provides comprehensive infrastructure monitoring for telecommunications providers, ISPs, and enterprise environments.

Quick Links

Overview

NetPulse empowers network operations teams with real-time monitoring capabilities designed for enterprise environments. The platform provides comprehensive visibility into network infrastructure health and performance.

Key Capabilities

Real-time Monitoring: Live server metrics with sub-second refresh rates via WebSocket
Intelligent Alerting: Multi-threshold alerts with anomaly detection and escalation policies
Multi-channel Notifications: SMS, email, webhooks, and Slack integration
Advanced Analytics: Interactive charts, historical trends, and performance benchmarking
Enterprise Security: End-to-end encryption, RBAC, and comprehensive audit trails
Horizontal Scaling: Monitor 1000+ devices with auto-failover capabilities

Why NetPulse?

Production Ready: Built for 99.9% uptime SLA requirements
Microservices Architecture: Independent, scalable services for enterprise deployment
ML-Powered: Anomaly detection and predictive analytics
API-First: REST APIs, webhooks, and plugin architecture for integrations

Features

Core Monitoring Capabilities

Feature	Description
Real-time Monitoring	Live server metrics (CPU, Memory, Network, Disk) with sub-second refresh rates
Device Management	Comprehensive device inventory with status tracking and bulk operations
Alert Management	Multi-threshold alerts with anomaly detection and escalation policies
Notification System	SMS, email, webhooks, and Slack integration with delivery confirmation
Analytics Dashboard	Interactive charts, historical trends, and performance benchmarking
Access Control	Role-based access control (RBAC) with comprehensive audit trails

Technical Highlights

Microservices Architecture: 7 independent services for optimal scalability
High Availability: Auto-failover with horizontal scaling capabilities
Time-series Database: TimescaleDB for efficient metric storage and analysis
Message Queue: RabbitMQ with Celery for reliable background processing
Distributed Tracing: Jaeger integration for microservices observability

Getting Started

Prerequisites

Docker Engine 20.10+
Docker Compose 2.0+
4GB RAM minimum (8GB recommended)
2 CPU cores minimum

Quick Installation

Clone the repository

git clone https://github.com/Code-Savanna/netpulse.git
cd netpulse

Start development environment
```
docker-compose up --build
```
Access the application
- Dashboard: http://localhost:3000
- API Gateway: http://localhost:8000
- Grafana: http://localhost:3001 (admin/admin)

Production Deployment

For production environments, use the production configuration:

# Start production stack
docker-compose -f docker-compose.prod.yml up --build -d

# Initialize databases
./scripts/init-production-db.sh

# Start monitoring stack
./scripts/setup-monitoring.sh

Architecture

NetPulse implements a microservices architecture with the following components:

Service Architecture

┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
│   Load Balancer │    │   API Gateway   │    │  Microservices  │
│      nginx      │───▶│   Port 8000     │───▶│  Ports 8001-6   │
└─────────────────┘    └─────────────────┘    └─────────────────┘
          │                       │                       │
          ▼                       ▼                       ▼
┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
│   Frontend      │    │   Database      │    │ Message Queue   │
│   React App     │    │   PostgreSQL    │    │   RabbitMQ      │
└─────────────────┘    └─────────────────┘    └─────────────────┘

Project Structure

netpulse/
├── services/                 # Microservices
│   ├── gateway/             # API Gateway & routing
│   ├── auth-service/        # Authentication & authorization
│   ├── device-service/      # Device management
│   ├── monitoring-service/  # Real-time monitoring
│   ├── alert-service/       # Alert management
│   ├── notification-service/# Multi-channel notifications
│   └── reporting-service/   # Analytics & insights
├── netpulse_frontend/       # React.js dashboard
├── monitoring/              # Observability stack
├── docs/                    # Documentation
└── scripts/                 # Deployment scripts

Technology Stack

Component	Technology	Purpose
Frontend	React 18, TypeScript, Tailwind CSS	User interface
API Gateway	FastAPI, Python 3.11	Request routing
Microservices	FastAPI, SQLAlchemy	Business logic
Database	PostgreSQL 15, TimescaleDB, Redis	Data storage
Message Queue	RabbitMQ, Celery	Async processing
Monitoring	Prometheus, Grafana, Jaeger	Observability
Deployment	Docker, Docker Compose	Containerization

For detailed architecture information, see ARCHITECTURE.md.

Configuration

Environment Variables

Each microservice requires environment configuration. Create .env files for each service:

Auth Service

# services/auth-service/.env
DATABASE_URL=postgresql://netpulse:password@db:5432/netpulse
SECRET_KEY=your-super-secret-key-here
ALGORITHM=HS256
ACCESS_TOKEN_EXPIRE_MINUTES=30

Notification Service

# services/notification-service/.env
DATABASE_URL=postgresql://netpulse:password@db:5432/netpulse
SENDGRID_API_KEY=your_sendgrid_api_key
SENDGRID_FROM_EMAIL=noreply@yourcompany.com
AFRICAS_TALKING_API_KEY=your_africas_talking_api_key
AFRICAS_TALKING_USERNAME=your_username

Monitoring Service

# services/monitoring-service/.env
DATABASE_URL=postgresql://netpulse:password@db:5432/netpulse
CELERY_BROKER_URL=amqp://netpulse:password@rabbitmq:5672//
CELERY_RESULT_BACKEND=redis://redis:6379/1
DEVICE_SERVICE_URL=http://device-service:8002
AUTH_SERVICE_URL=http://auth-service:8001

Default Parameters

Parameter	Default Value	Description
Metric Interval	30 seconds	Data collection frequency
Alert Thresholds	CPU >85%, Memory >90%, Disk >95%	Default alert triggers
Device Capacity	1000+ devices	Scalable monitoring capacity
Data Retention	90 days	Historical data storage

Testing

Running Tests

Test individual microservices:

cd services/auth-service && python -m pytest tests/ -v
cd services/device-service && python -m pytest tests/ -v
cd services/monitoring-service && python -m pytest tests/ -v

Test frontend components:

cd netpulse_frontend && npm test

Run integration tests:

docker-compose -f docker-compose.test.yml up --build --abort-on-container-exit

Test Coverage

Component	Coverage	Status
Microservices	>85%	Good
API Gateway	>90%	Excellent
Frontend	>85%	Good
Integration	Critical paths	Covered
Performance	10k concurrent users	Load tested

Deployment

Production Deployment

Build and deploy services

docker-compose -f docker-compose.prod.yml build
docker-compose -f docker-compose.prod.yml up -d

Initialize databases

docker-compose exec auth-service python -c "from database import engine; from models import Base; Base.metadata.create_all(bind=engine)"
docker-compose exec device-service python -c "from database import engine; from models import Base; Base.metadata.create_all(bind=engine)"
docker-compose exec alert-service python -c "from database import engine; from models import Base; Base.metadata.create_all(bind=engine)"

Start background workers

docker-compose exec monitoring-service celery -A celery_app worker --loglevel=info --detach

Cloud Platforms

Platform	Status	Use Case
Render	Active	Microservices hosting
Vercel	Active	Frontend deployment
AWS ECS	In Progress	Container orchestration
Kubernetes	Planned	Enterprise scaling
Docker Swarm	Supported	Multi-node deployment

Documentation

Document	Description
Architecture Guide	System design and microservices architecture
API Reference	Complete REST API documentation
Deployment Guide	Production deployment procedures
Monitoring Guide	Observability and alerting setup
Contributing Guidelines	Development workflow and standards
Security Policy	Security practices and vulnerability reporting

Contributing

We welcome contributions! Please follow these steps:

Fork the repository
Create a feature branch: git checkout -b feature/your-feature
Make your changes and add tests
Ensure all tests pass: npm test and python -m pytest
Follow code formatting standards (Black for Python, Prettier for TypeScript)
Commit your changes: git commit -m 'Add new feature'
Push to your branch: git push origin feature/your-feature
Open a Pull Request

Code Standards

Python: Black formatting, Flake8 linting, type hints required
TypeScript: Prettier formatting, ESLint compliance
Testing: Minimum 80% coverage for new features
Documentation: Update relevant docs with changes

See CONTRIBUTING.md for detailed guidelines.

License

This project is licensed under the MIT License. See LICENSE for details.

Support

Documentation: Check our documentation for detailed guides
Bug Reports: Create an issue
Feature Requests: Start a discussion
Community: Join our discussions for help and collaboration

The Network Operations Community by Code Savanna

Name		Name	Last commit message	Last commit date
Latest commit History 34 Commits
docs		docs
monitoring		monitoring
netpulse_frontend		netpulse_frontend
scripts		scripts
services		services
.gitignore		.gitignore
ARCHITECTURE.md		ARCHITECTURE.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
SECURITY.md		SECURITY.md
docker-compose.prod.yml		docker-compose.prod.yml
docker-compose.yml		docker-compose.yml
package-lock.json		package-lock.json
package.json		package.json

License

Code-Savanna/netpulse

Folders and files

Latest commit

History

Repository files navigation

NetPulse

Quick Links

Table of Contents

Overview

Key Capabilities

Why NetPulse?

Features

Core Monitoring Capabilities

Technical Highlights

Getting Started

Prerequisites

Quick Installation

Production Deployment

Architecture

Service Architecture

Project Structure

Technology Stack

Configuration

Environment Variables

Auth Service

Notification Service

Monitoring Service

Default Parameters

Testing

Running Tests

Test Coverage

Deployment

Production Deployment

Cloud Platforms

Documentation

Contributing

Code Standards

License

Support

About

Resources

License

Contributing

Security policy

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages