Skip to content

Traffic Monitoring

Monitor network bandwidth usage with circular progress visualizations, real-time speeds, and cumulative data transfer tracking.

Overview

Komandorr's traffic monitoring feature tracks network bandwidth consumption with beautiful circular progress indicators showing percentage utilization, current upload/download speeds, and total data transferred.

Visualization

Circular Progress Cards

  • Top 5 Services: Displays the 5 services with highest bandwidth usage
  • 200px Diameter Circles: Large, easy-to-read circular progress rings
  • Percentage Display: Shows bandwidth usage as percentage of configured MAX_BANDWIDTH
  • Color-Coded: Each service gets unique colors (pink, violet, cyan, emerald, amber)
  • Active Indicator: Green pulsing dot when service has active traffic

Bandwidth Metrics Display

Each card shows a two-row metrics box:

Row 1 - Current Speeds:

  • Upload (blue): Real-time upload speed in MB/s
  • Download (green): Real-time download speed in MB/s
  • Total (purple): Combined current bandwidth

Row 2 - Cumulative Data:

  • Uploaded (orange): Total data uploaded (GB/TB)
  • Downloaded (cyan): Total data downloaded (GB/TB)
  • Combined (amber): Total data transferred (GB/TB)

Data Formatting

  • Speeds: Automatically switches between KB/s and MB/s
  • Totals: Displays in GB, automatically converts to TB when ≥ 1000 GB
  • Monospace Font: Consistent number alignment for easy reading

Architecture

Traffic monitoring consists of two components:

  1. Traffic Agent - Runs on monitored servers
  2. Komandorr Dashboard - Displays and stores metrics

Installation

Install Traffic Agent

On the server you want to monitor:

# Clone repository or download traffic agent
git clone https://github.com/cyb3rgh05t/komandorr.git
cd komandorr/traffic

# Install dependencies
pip install -r requirements.txt

# Run the agent
python traffic_agent.py

Configure Agent

Edit traffic_agent.py or set environment variables:

export KOMANDORR_URL=http://your-komandorr:3000
export INTERFACE=eth0
export INTERVAL=5

Or modify the script:

KOMANDORR_URL = "http://your-komandorr:3000"
INTERFACE = "eth0"  # Network interface to monitor
INTERVAL = 5        # Update interval in seconds

Network Interfaces

Identify your network interface:

ip link show
# or
ifconfig

ipconfig
# or
Get-NetAdapter

ifconfig
# or
networksetup -listallhardwareports

Common interfaces:

  • eth0 - Primary ethernet (Linux)
  • eno1 - Ethernet (Linux, systemd naming)
  • wlan0 - WiFi (Linux)
  • en0 - Primary network (macOS)

Metrics Collected

Bandwidth Usage

  • Upload Rate - Current bytes/sec uploaded
  • Download Rate - Current bytes/sec downloaded
  • Total Upload - Cumulative bytes uploaded
  • Total Download - Cumulative bytes downloaded

Visualizations

  • Real-time line charts
  • Historical data (last 24 hours)
  • Peak usage indicators
  • Average bandwidth calculations

Dashboard Features

Real-time Monitoring

View current traffic in real-time:

  • Live upload/download rates
  • Color-coded graphs
  • Auto-refreshing display

Historical Data

Analyze traffic patterns:

  • Last hour, day, week, or month
  • Identify peak usage times
  • Compare trends over time

Data Retention

  • In-memory: Last 100 data points
  • Database: Last 1000 data points per service
  • Automatic cleanup of old data

Configuration

Update Interval

Configure how often traffic data is collected:

INTERVAL = 5  # Update every 5 seconds

Recommended values:

  • Real-time monitoring: 5-10 seconds
  • General monitoring: 30-60 seconds
  • Light monitoring: 300+ seconds

API Endpoint

Point the agent to your Komandorr instance:

KOMANDORR_URL = "http://localhost:3000"

Running as Service

Linux (systemd)

Create /etc/systemd/system/komandorr-traffic.service:

[Unit]
Description=Komandorr Traffic Agent
After=network.target

[Service]
Type=simple
User=komandorr
WorkingDirectory=/opt/komandorr/traffic
ExecStart=/usr/bin/python3 traffic_agent.py
Restart=always
Environment="KOMANDORR_URL=http://your-komandorr:3000"
Environment="INTERFACE=eth0"

[Install]
WantedBy=multi-user.target

Enable and start:

sudo systemctl enable komandorr-traffic
sudo systemctl start komandorr-traffic
sudo systemctl status komandorr-traffic

Docker

Run the traffic agent in a container:

docker run -d \
  --name traffic-agent \
  --network host \
  -e KOMANDORR_URL=http://your-komandorr:3000 \
  -e INTERFACE=eth0 \
  cyb3rgh05t/komandorr-traffic:latest

Network Mode

The --network host flag is required for the agent to access network interfaces.

Troubleshooting

Agent Not Connecting

Connection refused

Check:

- Komandorr URL is correct
- Komandorr is running and accessible
- No firewall blocking connection
- Network connectivity

No Data Appearing

No traffic data

Verify:

- Correct network interface name
- Interface is active: `ip link show <interface>`
- Agent has permissions to read interface stats
- Agent is actually sending data (check logs)

Permission Errors

Permission denied reading interface

Linux Solution:

Run with sudo or give capabilities:
```bash
sudo setcap cap_net_raw,cap_net_admin=eip /usr/bin/python3
```

API Access

Get traffic data via API:

# Get current traffic
curl http://localhost:3000/api/traffic/current

# Get historical data
curl http://localhost:3000/api/traffic/history?hours=24

See Traffic API Reference for full documentation.

Best Practices

  1. Choose Correct Interface: Monitor the interface with internet traffic
  2. Appropriate Interval: Balance data granularity with performance
  3. Run as Service: Ensure agent starts on boot
  4. Monitor Resources: Traffic agent uses minimal CPU/memory
  5. Secure Connection: Use HTTPS for agent-to-Komandorr communication