FlowGauge

Overview

FlowGauge is a modular bandwidth testing tool with Multi-WAN support, DSCP flag configuration, and Grafana-compatible API. Perfect for testing multiple internet connections with quality of service settings!

Main Features

🌐 Multi-WAN Support

Test multiple internet connections with different source IPs

🏷️ DSCP Tagging

Set QoS flags for more realistic tests in prioritized networks

⏰ Scheduled Tests

Automatic tests via cron syntax

🎨 Web Dashboard

Modern dashboard with real-time updates and charts

🔌 REST API

JSON API for Grafana and other tools

📊 Prometheus Metrics

Native Prometheus support for monitoring

💾 Flexible Storage

SQLite (default) or PostgreSQL

Quick Start

Installation

# Via Go Install (recommended)
go install github.com/lan-dot-party/flowgauge/cmd/flowgauge@latest

# Or: Download binary
# See Releases page for .deb, .rpm and binaries

Getting Started

# Create example configuration
flowgauge config init > /etc/flowgauge/config.yaml

# Edit configuration
nano /etc/flowgauge/config.yaml

# Run a single test
flowgauge test --once

# Start server with API and scheduler
flowgauge server

Configuration

FlowGauge is configured via a YAML file. Default path: /etc/flowgauge/config.yaml

general:
  log_level: info
  data_dir: /var/lib/flowgauge

storage:
  type: sqlite
  sqlite:
    path: /var/lib/flowgauge/results.db

api:
  enabled: true
  listen: 127.0.0.1:8080

connections:
  - name: WAN1-Telekom
    source_ip: 192.168.1.100
    dscp: 0
    enabled: true
  
  - name: WAN2-Vodafone
    source_ip: 192.168.2.100
    dscp: 46  # Expedited Forwarding
    enabled: true

scheduler:
  enabled: true
  schedule: "*/30 * * * *"  # Every 30 minutes

Web Dashboard

The integrated web dashboard offers:

Real-time overview of all connections with current measurements
History charts for download, upload, and latency (24h)
Auto-refresh every 30 seconds

Accessible at http://localhost:8080/ when the server is running.

API Endpoints

Endpoint	Description
`GET /`	Web Dashboard
`GET /health`	Health Check
`GET /api/`	Interactive API Documentation
`GET /api/v1/results`	All test results
`GET /api/v1/results/latest`	Latest results per connection
`GET /api/v1/connections`	Configured connections
`GET /api/v1/connections/{name}/stats`	Statistics for a connection
`GET /api/v1/metrics`	Prometheus Metrics

Docker Support

Run FlowGauge easily with Docker:

docker run -d \
  --name flowgauge \
  --cap-add NET_ADMIN \
  -v ./config.yaml:/etc/flowgauge/config.yaml:ro \
  -v flowgauge-data:/var/lib/flowgauge \
  -p 8080:8080 \
  ghcr.io/lan-dot-party/flowgauge:latest

System Requirements

Go 1.22+ (for development/build)
Linux (recommended) - Full DSCP/Source-IP support
CAP_NET_ADMIN - Permission for DSCP marking

Grafana Integration

FlowGauge provides native Prometheus metrics and a JSON API that works perfectly with Grafana:

Prometheus Datasource: Use the /api/v1/metrics endpoint
JSON API Plugin: Query results via /api/v1/results
Pre-built Dashboards: Available in the Grafana directory

See the Grafana Integration Guide for detailed setup instructions.

Downloads & Releases

Download the latest version of FlowGauge:

📦 Releases on GitHub

Here you'll find all available versions with detailed changelogs and download links:

Binaries: Pre-compiled for Linux, macOS, and Windows
Debian/Ubuntu (.deb): Available for Debian-based systems
RHEL/Fedora/openSUSE (.rpm): Available for RPM-based systems
Docker Images: Available on GitHub Container Registry

Documentation

For more detailed information, check out the official documentation:

API Documentation - REST API details & examples
Grafana Integration - Dashboard setup guide
GitHub Repository - Source code and issue tracker

License

This project is licensed under the MIT License.

Developed with ❤️ for network enthusiasts