iperf3_exporter

README

iPerf3 Exporter

A Prometheus exporter for iPerf3 network performance metrics.

The iPerf3 exporter allows iPerf3 probing of endpoints for Prometheus monitoring, enabling you to measure network performance metrics like bandwidth, jitter, and packet loss.

Features

• Measure network bandwidth between hosts
• Monitor network performance over time
• Support for both TCP and UDP tests
• Configurable test parameters (protocol, duration, bitrate, etc.)
• TLS support for secure communication
• Health and readiness endpoints for monitoring
• Prometheus metrics for exporter itself

---

Diagram Walkthrough

flowchart LR
  User_Prometheus["User/Prometheus"] -- "Scrapes /metrics" --> Server
  Server -- "Loads Config" --> ConfigFile["Configuration File"]
  ConfigFile -- "Defines Targets" --> TargetConfig["Target Configuration"]
  TargetConfig -- "Schedules Probes" --> Collector
  Collector -- "Runs iperf3" --> IperfRunner["iperf.Runner"]
  IperfRunner -- "Returns Results" --> Collector
  Collector -- "Updates Cache" --> MetricsCache["Metrics Cache"]
  MetricsCache -- "Serves Metrics" --> Server

---

Installation

From Binaries

Download the most suitable binary for your platform from the releases tab.

# Download (replace VERSION and PLATFORM with appropriate values)
curl -L -o iperf3_exporter https://github.com/yuvaldekel/iperf3_exporter/releases/download/VERSION/iperf3_exporter-VERSION.PLATFORM

# Make executable
chmod +x iperf3_exporter

# Run
./iperf3_exporter <flags>

Note: iperf3 binary should also be installed and accessible from the path.

Using Docker

docker run --rm -d -p 9579:9579 -v config.yaml:/exporter/config.yaml --name iperf3_exporter ghcr.io/yuvaldekel/iperf3_exporter:latest

The Docker images are available for multiple architectures (amd64, arm64) and are published to GitHub Container Registry.

Building from Source

# Clone repository
git clone https://github.com/yuvaldekel/iperf3_exporter.git
cd iperf3_exporter

# Build
go build -o iperf3_exporter ./cmd/iperf3_exporter

# Run
./iperf3_exporter

Usage

Starting the Exporter

./iperf3_exporter [flags]

Configuration

iPerf3 exporter is configured via command-line flags:

Flag	environment variables	Description	Default
--config	IPERF3_EXPORTER_CONFIG_FILE	Path to configuration file that can enable TLS or authentication	config.yaml
--listen-address	IPERF3_EXPORTER_PORT	Addresses on which to expose metrics and web interface (repeatable)	9579
--mtrics-path	-	Path under which to expose metrics	/metrics
--probe-path	-	Path under which to expose the probe endpoint	/probe
--iperf3-timeout	IPERF3_EXPORTER_TIMEOUT	iperf3 run timeout	30s
--log-level	IPERF3_EXPORTER_LOG_LEVEL	Only log messages with the given severity or above	info
--log-format	IPERF3_EXPORTER_LOG_FORMAT	Output format of log messages	logfmt

Web Configuration File

The exporter supports a configuration file for TLS and authentication settings. This file is specified with the --config flag.

Example configuration file:

listenAddress: 8080
metricsPath: /metrics
probePath: /probe
timeout: 30s

logging:
  level: info
  format: logfmt

tlsCrt: server.crt
tlsKey: server.key

# List of targets that will be scraped constently
targets:
  - target: www.example.com
    port: 5201
    interval: 1h
    protocol: tcp
    period: 10s

For more details on the web configuration file format, see the exporter-toolkit documentation.

To view all available command-line flags, run:

./iperf3_exporter -h

Timeout Behavior

The timeout for each iperf3 probe is determined by the following logic:

1. Prometheus scrape timeout: When Prometheus or compatible systems (e.g., VictoriaMetrics) scrape the exporter, they send the X-Prometheus-Scrape-Timeout-Seconds header containing the configured scrape_timeout value.

2. Configured timeout limit: The --iperf3-timeout flag acts as an upper limit. If set, it restricts the effective timeout to be no larger than this value, regardless of the Prometheus scrape timeout.

3. Default timeout: If neither the Prometheus header nor --iperf3-timeout is provided, the timeout defaults to 30 seconds.

4. Timeout offset: A small offset (0.5 seconds) is subtracted from the Prometheus timeout to ensure the exporter finishes before Prometheus gives up, allowing for network delays and cleaner error handling.

Examples:

• Prometheus scrape_timeout: 60s, --iperf3-timeout=10s → Effective timeout: 10s (configured limit applied)
• Prometheus scrape_timeout: 30s, --iperf3-timeout not set → Effective timeout: 29.5s (header value minus offset)
• No Prometheus header, --iperf3-timeout=15s → Effective timeout: 15s (configured value used)
• No Prometheus header, --iperf3-timeout not set → Effective timeout: 30s (default)

This behavior ensures that the --iperf3.timeout flag can be used to enforce maximum test durations even when Prometheus is configured with longer scrape timeouts.

Probe Parameters

When making requests to the /probe endpoint, the following parameters can be used:

Parameter	Description	Default
target	Target host to probe (required)	-
port	Port that the target iperf3 server is listening on	5201
reverse_mode	Run iperf3 in reverse mode (server sends, client receives)	false
protocol	Run iperf3 in UDP or TCP protocol	TCP
bitrate	Target bitrate in bits/sec (format: #[KMG][/#]). For UDP mode, iperf3 defaults to 1 Mbit/sec if not specified.	-
period	Duration of the iperf3 test	5s
bind	Bind to a specific local IP address or interface	-

Checking the Results

Visit http://localhost:9579 to see the exporter's web interface.

Prometheus Configuration

The iPerf3 exporter needs to be passed the target as a parameter, this can be done with relabelling.

Example config:

scrape_configs:
  - job_name: 'iperf3'
    metrics_path: /probe
    static_configs:
      - targets:
        - foo.server
        - bar.server
    params:
      port: ['5201']
      # Optional: enable reverse mode
      # reverse_mode: ['true']
      # Optional: UDP or TCP
      # protocol: ['tcp']
      # Optional: set bitrate limit
      # bitrate: ['100M']
      # Optional: set test period
      # period: ['10s']
      # Optional: bind to specific interface/IP
      # bind: ['192.168.1.10']
    relabel_configs:
      - source_labels: [__address__]
        target_label: __param_target
      - source_labels: [__param_target]
        target_label: instance
      - target_label: __address__
        replacement: 127.0.0.1:9579  # The iPerf3 exporter's real hostname:port.

Available Metrics

The exporter provides the following metrics:

Metric	Description	Labels
iperf3_up	Was the last iperf3 probe successful (1 for success, 0 for failure)	target, port, protocol, reverse_mode
iperf3_sent_seconds	Total seconds spent sending packets	target, port, protocol, reverse_mode
iperf3_sent_bytes	Total sent bytes for the last test run	target, port, protocol, reverse_mode
iperf3_received_seconds	Total seconds spent receiving packets	target, port, protocol, reverse_mode
iperf3_received_bytes	Total received bytes for the last test run	target, port, protocol, reverse_mode
iperf3_retransmits	Total retransmits for the last test run (TCP mode only, omitted in UDP)	target, port, protocol, reverse_mode
iperf3_sent_packets	Total sent packets for the last UDP test run (UDP mode only)	target, port, protocol, reverse_mode
iperf3_sent_jitter_ms	Jitter in milliseconds for sent packets (UDP mode only)	target, port, protocol, reverse_mode
iperf3_lost_packets	Total lost packets for the last UDP test run (UDP mode only)	target, port, protocol, reverse_mode
iperf3_lost_percent	Percentage of packets lost for the last UDP test run (UDP mode only)	target, port, protocol, reverse_mode

Additionally, the exporter provides metrics about itself:

Metric	Description
iperf3_exporter_duration_seconds	Duration of collections by the iperf3 exporter
iperf3_exporter_errors_total	Errors raised by the iperf3 exporter

Querying the Bandwidth

The byte and second metrics are gauges that represent the results from each individual iperf3 test run. Each time Prometheus scrapes the /probe endpoint, a new iperf3 test runs and the metrics reflect that test's results.

You can use the following Prometheus queries to calculate bandwidth in Mbits/sec:

Receiver Bandwidth (Download Speed)

iperf3_received_bytes / iperf3_received_seconds * 8 / 1000000

Sender Bandwidth (Upload Speed)

iperf3_sent_bytes / iperf3_sent_seconds * 8 / 1000000

These queries calculate the average bandwidth for each test by dividing the total bytes by the time duration to get bytes per second, then converting from bytes to bits (multiply by 8) and from bits to megabits (divide by 1,000,000).

For average bandwidth over multiple test runs:

avg_over_time((iperf3_received_bytes / iperf3_received_seconds * 8 / 1000000)[30m:])
avg_over_time((iperf3_sent_bytes / iperf3_sent_seconds * 8 / 1000000)[30m:])

Note: Since these are gauge metrics (not counters), the rate() function should not be used. Each scrape represents a discrete test, not a cumulative counter.

Contributing

This project is froked from (https://github.com/edgard/iperf3_exporter)

Contributions to the iperf3_exporter are welcome!

This project follows the Conventional Commits specification. When contributing, please format your commit messages according to this standard:

<type>(<scope>): <description>

[optional body]

[optional footer(s)]

Examples:

• feat: add support for UDP tests
• fix: correct metric label in collector
• docs: update installation instructions
• refactor(collector): simplify error handling

Development Prerequisites

• Go 1.25 or higher
• iperf3 installed on your system

Project Structure

.
├── cmd/
│   └── iperf3_exporter/     # Main application entry point
├── internal/
│   ├── collector/           # Prometheus collector implementation
│   ├── config/              # Configuration handling
│   ├── iperf/               # iperf3 command execution and result parsing
│   └── server/              # HTTP server implementation
├── tests/
│   └── e2e/                 # End-to-end tests
├── .github/
│   └── workflows/           # GitHub Actions workflows
├── .goreleaser.yaml         # GoReleaser configuration
├── Dockerfile               # Multi-arch Docker build configuration
├── go.mod                   # Go module definition
└── README.md                # This file

Building and Testing

The project uses a Makefile to streamline development tasks:

# Build the binary
make build

# Run all tests
make test

# Complete development workflow (run mod, generate, lint, vet, tests and build)
make all

# Tidy and download dependencies
make mod

# Run linting
make lint

# Run go vet
make vet

# Generate code (if any generators are configured)
make generate

# Build Docker image for local development
make docker

# See all available commands
make help

You can also use standard Go commands directly:

# Build manually
go build -o iperf3_exporter ./cmd/iperf3_exporter

# Run tests
go test ./...

License

This project is released under Apache License 2.0, see LICENSE.