🌐 Network Monitoring Dashboard 📊

Welcome to Network Monitoring Dashboard — a powerful and user-friendly tool to monitor and manage the devices connected to your network. Built with Rust, this dashboard connects seamlessly with the NATS message queue and provides real-time insights into system health metrics, such as CPU usage, temperature, disk usage, and network bandwidth.

• Device Discovery: Automatically detect and monitor devices connected to your network.
• Real-time Metrics: View live statistics for:
  • CPU Usage
  • Temperature
  • Disk Usage
  • Network Bandwidth
• NATS Queue Integration: The dashboard subscribes to the NATS queue for seamless communication with your devices, ensuring up-to-date system information.
• Settings Customization: Tweak the settings of:
  • Device Discovery: Fine-tune how devices are identified and tracked on the network.
  • Metrics System: Control how often and what kind of metrics are gathered.

• Docker support: Provide Docker support to launch the whole system including Rust services.
• Log Component: Connect to the queue and retrieve the logs from the different services into a single screen.
• Notifications System: Get alerts when important events happen, via:
  • Telegram
  • Slack
  • HTTP Webhooks
• Device History: View a detailed log of previously connected devices to track changes over time.

1. Clone the repository:

   git clone https://github.com/albertjimenez/NetworkMonitor.git

2. Create an .env (already created as .env in this repo) file with this content or expose the following environment variables

Example:

# .env file with default values for environment variables
# PostgreSQL environment variables
POSTGRES_USER=network
POSTGRES_PASSWORD=123456
POSTGRES_DB=network_monitor
# NATS environment variables
NATS_PORT=4222
NATS_HOSTNAME=nats
NATS_URL=nats:4222
# Dashboard environment variables
NATS_WS_PORT=8080
VITE_NATS_HOSTNAME=ws://localhost
DASHBOARD_PORT=3005

3. Run docker-compose, compile the network-handler and run it as sudo

   docker-compose up -d
   cd network-handler
   cargo build --release
   cd target/release
   # the hostname and port you used on the .env file 
   sudo NATS_URL=localhost:4222 ./network-handler

Once the dashboard is running, open your browser and navigate to http://localhost:5173 to view the real-time metrics and device list.

You can adjust the discovery settings and the frequency of metrics collection from the dashboard's settings panel.

The dashboard provides key system metrics in real-time:

• CPU Usage: Displays current CPU usage across all cores.
• Temperature: Tracks the device's temperature if supported.
• Disk Usage: Shows total and used disk space.
• RAM Usage: Shows total and used memory.
• Network Bandwidth: Provides live stats on bandwidth usage.
• Devices: Lists all the currently connected devices.

To view the current offline/online devices with a search functionality to filter them by name.

Displays the metrics from the host system.

Tweak settings of the time to obtain data for the host discovery and the metrics.

1. Device Discovery
2. Real-time System Monitoring
3. Docker Integration (missing network-handler due to permissions)
4. Notification System (Telegram, Slack, Webhooks)
5. Device History View

Stay tuned for more exciting features!

Feel free to contribute to this project! Fork the repository and submit a pull request with your feature or bug fix.

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

If you find this project helpful, please consider giving it a ⭐ on GitHub! You can also open an issue if you encounter any problems or have suggestions for improvement.

Made with ❤️ by Albert Sendrós