goben

goben is a golang tool to measure TCP/UDP transport layer throughput between hosts.

• Features
• History
• Requirements
• Install
• Usage
• Example

Created by gh-md-toc

Features

• Support for TCP and UDP.
• Can limit maximum bandwidth.
• Written in Go. Single executable file. No runtime dependency.
• Simple usage: start the server then launch the client pointing to server's address.
• Spawns multiple concurrent lightweight goroutines to handle multiple parallel traffic streams.
• Can save test results as PNG chart.
• Can export test results in YAML format.

History

• Years ago out of frustration with iperf2 limitations, I wrote the nepim tool. One can find some known iperf problems here: iperf caveats. Nepim was more customizable, easier to use, reported simpler to understand results, was lighter on CPU.
• Later I found another amazing tool called nuttcp. One can read about nepim and nuttcp here: nepim and nuttcp.
• goben is intended to fix shortcomings of nepim: (1) Take advantage of multiple CPUs while not wasting processing power. Nepim was single-threaded. (2) Be easily portable to multiple platforms. Nepim was heavily tied to UNIX-like world. (3) Use a simpler synchronous code flow. Nepim used hard-to-follow asynchronous architecture.

Requirements

• You need a system with the Go language in order to build the application. There is no special requirement for running it.
• You can also download a binary release from https://github.com/udhos/goben/releases

Install

go get github.com/wcharczuk/go-chart
go get gopkg.in/yaml.v2
go get github.com/udhos/goben
go install github.com/udhos/goben/goben

Usage

Make sure ~/go/bin is in your shell PATH.

Start server:

server$ goben

Start client:

client$ goben -hosts 1.1.1.1 ;# 1.1.1.1 is server's address

Example

Server side:

$ goben
2018/02/08 18:37:28 goben version 0.1 runtime go1.10rc2 GOMAXPROCS=1
2018/02/08 18:37:28 connections=1 defaultPort=:8080 listeners=[":8080"] hosts=[]
2018/02/08 18:37:28 reportInterval=2s totalDuration=10s
2018/02/08 18:37:28 server mode (use -hosts to switch to client mode)
2018/02/08 18:37:28 serve: spawning TCP listener: :8080
2018/02/08 18:37:28 serve: spawning UDP listener: :8080

Client side:

$ goben -hosts localhost
2018/02/08 18:38:48 goben version 0.1 runtime go1.10rc2 GOMAXPROCS=1
2018/02/08 18:38:48 connections=1 defaultPort=:8080 listeners=[":8080"] hosts=["localhost"]
2018/02/08 18:38:48 reportInterval=2s totalDuration=10s
2018/02/08 18:38:48 client mode, tcp protocol
2018/02/08 18:38:48 open: opening tcp 0/1: localhost:8080
2018/02/08 18:38:48 handleConnectionClient: starting 0/1 [::1]:8080
2018/02/08 18:38:48 handleConnectionClient: options sent: {2s 10s 50000 50000 false 0}
2018/02/08 18:38:48 clientReader: starting: 0/1 [::1]:8080
2018/02/08 18:38:48 clientWriter: starting: 0/1 [::1]:8080
2018/02/08 18:38:50 report   clientReader rate:  11565 Mbps  28913 rcv/s
2018/02/08 18:38:50 report   clientWriter rate:  11189 Mbps  27973 snd/s
2018/02/08 18:38:52 report   clientReader rate:  11340 Mbps  28352 rcv/s
2018/02/08 18:38:52 report   clientWriter rate:  10975 Mbps  27438 snd/s
2018/02/08 18:38:54 report   clientReader rate:  11647 Mbps  29117 rcv/s
2018/02/08 18:38:54 report   clientWriter rate:  11272 Mbps  28180 snd/s
2018/02/08 18:38:56 report   clientReader rate:  10957 Mbps  27394 rcv/s
2018/02/08 18:38:56 report   clientWriter rate:  10603 Mbps  26508 snd/s
2018/02/08 18:38:58 workLoop: clientWriter: write tcp [::1]:55186->[::1]:8080: write: connection reset by peer
2018/02/08 18:38:58 average clientWriter rate: 10995 Mbps 27489 snd/s
2018/02/08 18:38:58 clientWriter: exiting: 0/1 [::1]:8080
2018/02/08 18:38:58 report   clientReader rate:  11297 Mbps  28244 rcv/s
2018/02/08 18:38:58 handleConnectionClient: 10s timer
2018/02/08 18:38:58 workLoop: clientReader: read tcp [::1]:55186->[::1]:8080: use of closed network connection
2018/02/08 18:38:58 average clientReader rate: 11361 Mbps 28402 rcv/s
2018/02/08 18:38:58 clientReader: exiting: 0/1 [::1]:8080
2018/02/08 18:38:58 handleConnectionClient: closing: 0/1 [::1]:8080