iperf3 でネットワークパフォーマンスを測定する
iperf3 はネットワークパフォーマンスを測定するツールです。
Wikipedia には下記と書かれています。
Iperfはttcp（英語版）と互換性のある最新の代替手段としてイリノイ大学の米国立スーパーコンピュータ応用研究所でNational Laboratory for Applied Network Research (NLANR)のDistributed Applications Support Team (DAST)によって開発され、アメリカ国立科学財団による資金提供の終了により2006年12月31日に閉鎖された。(snip) Iperf3はiperfを最初から書き直し、より小さく単純なコードベースとして作成された。また、他のプログラムが提供された機能を使用できるようにするライブラリバージョンも含まれている。
基本的な使い方をメモしておきます。
インストール
以降の作業は root 権限で実施しますので、予め root 権限へ昇格しておきます。
apt でインストールします。 標準リポジトリからインストール出来ます。
| apt update && apt -y install iperf3
|
今回はバージョン 3.7 がインストールされました。
| # iperf3 --version
iperf 3.7 (cJSON 1.5.2)
Linux ubuntu2 5.4.0-88-generic #99-Ubuntu SMP Thu Sep 23 17:29:00 UTC 2021 x86_64
Optional features available: CPU affinity setting, IPv6 flow label, SCTP, TCP congestion algorithm setting, sendfile / zerocopy, socket pacing, authentication
|
iperf3 はクライアント/サーバが同じバイナリ
iperf3 はクライント/サーバに分けて動作させます。 バイナリ自体は共通ですが、オプションによってクライアント/サーバの役割を切り替えることが出来ます。 サーバとして動作させる為には -s オプションを指定して Listen します。
| root@ubuntu1:~# iperf3 -s
-----------------------------------------------------------
Server listening on 5201
-----------------------------------------------------------
|
iperf3 が利用するポート
iperf3 をサーバとして起動した場合、デフォルトでは 5201/TCP を Listen します。
| root@ubuntu1:~# lsof -i:5201
COMMAND PID USER FD TYPE DEVICE SIZE/OFF NODE NAME
iperf3 2282 root 3u IPv6 35018 0t0 TCP *:5201 (LISTEN)
|
クライアント側から TCP でのテストを開始した場合、サーバは下記のようにそのまま 5201/TCP を利用します。
| root@ubuntu1:~# lsof -i:5201
COMMAND PID USER FD TYPE DEVICE SIZE/OFF NODE NAME
iperf3 2282 root 3u IPv6 36082 0t0 TCP *:5201 (LISTEN)
iperf3 2282 root 4u IPv6 36099 0t0 TCP ubuntu1:5201->10.0.0.2:35768 (ESTABLISHED)
iperf3 2282 root 5u IPv6 36100 0t0 TCP ubuntu1:5201->10.0.0.2:35770 (ESTABLISHED)
|
クライアント側から UDP でのテストを開始した場合、サーバは 5201/TCP に加え 5201/UDP を Listen します。
| root@ubuntu1:~# lsof -i:5201
COMMAND PID USER FD TYPE DEVICE SIZE/OFF NODE NAME
iperf3 2282 root 3u IPv6 35018 0t0 TCP *:5201 (LISTEN)
iperf3 2282 root 4u IPv6 36049 0t0 TCP ubuntu1:5201->10.0.0.2:35766 (ESTABLISHED)
iperf3 2282 root 5u IPv6 36050 0t0 UDP ubuntu1:5201->10.0.0.2:50908
|
TCP による計測
TCP による計測方法をメモしておきます。 予めサーバ側は iperf3 -s によってサーバが起動されているものとします。
クライアント側
クライアントとして動作させるには -c オプションに続けてサーバのアドレスを指定します。 下記の例では 10.0.0.1 がサーバのアドレスです。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20 | root@ubuntu2:~# iperf3 -c 10.0.0.1
Connecting to host 10.0.0.1, port 5201
[ 5] local 10.0.0.2 port 35760 connected to 10.0.0.1 port 5201
[ ID] Interval Transfer Bitrate Retr Cwnd
[ 5] 0.00-1.00 sec 112 MBytes 940 Mbits/sec 936 91.9 KBytes
[ 5] 1.00-2.00 sec 116 MBytes 973 Mbits/sec 1076 97.6 KBytes
[ 5] 2.00-3.00 sec 116 MBytes 976 Mbits/sec 1015 106 KBytes
[ 5] 3.00-4.00 sec 117 MBytes 982 Mbits/sec 834 96.2 KBytes
[ 5] 4.00-5.00 sec 119 MBytes 995 Mbits/sec 1094 102 KBytes
[ 5] 5.00-6.00 sec 119 MBytes 998 Mbits/sec 983 106 KBytes
[ 5] 6.00-7.00 sec 116 MBytes 975 Mbits/sec 1019 70.7 KBytes
[ 5] 7.00-8.00 sec 119 MBytes 997 Mbits/sec 859 143 KBytes
[ 5] 8.00-9.00 sec 95.6 MBytes 802 Mbits/sec 854 124 KBytes
[ 5] 9.00-10.00 sec 117 MBytes 981 Mbits/sec 1189 94.7 KBytes
- - - - - - - - - - - - - - - - - - - - - - - - -
[ ID] Interval Transfer Bitrate Retr
[ 5] 0.00-10.00 sec 1.12 GBytes 962 Mbits/sec 9859 sender
[ 5] 0.00-10.00 sec 1.12 GBytes 960 Mbits/sec receiver
iperf Done.
|
サーバ側
計測が完了するとサーバ側は以下のように表示されます。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23 | root@ubuntu1:~# iperf3 -s
-----------------------------------------------------------
Server listening on 5201
-----------------------------------------------------------
Accepted connection from 10.0.0.2, port 35758
[ 5] local 10.0.0.1 port 5201 connected to 10.0.0.2 port 35760
[ ID] Interval Transfer Bitrate
[ 5] 0.00-1.00 sec 111 MBytes 928 Mbits/sec
[ 5] 1.00-2.00 sec 116 MBytes 973 Mbits/sec
[ 5] 2.00-3.00 sec 116 MBytes 977 Mbits/sec
[ 5] 3.00-4.00 sec 117 MBytes 980 Mbits/sec
[ 5] 4.00-5.00 sec 118 MBytes 994 Mbits/sec
[ 5] 5.00-6.00 sec 119 MBytes 998 Mbits/sec
[ 5] 6.00-7.00 sec 116 MBytes 977 Mbits/sec
[ 5] 7.00-8.00 sec 119 MBytes 998 Mbits/sec
[ 5] 8.00-9.00 sec 95.1 MBytes 798 Mbits/sec
[ 5] 9.00-10.00 sec 117 MBytes 982 Mbits/sec
- - - - - - - - - - - - - - - - - - - - - - - - -
[ ID] Interval Transfer Bitrate
[ 5] 0.00-10.00 sec 1.12 GBytes 960 Mbits/sec receiver
-----------------------------------------------------------
Server listening on 5201
-----------------------------------------------------------
|
UDP による計測
UDP による計測方法をメモしておきます。 TCP 同様に、予めサーバ側は iperf3 -s によってサーバが起動されているものとします。 TCP/UDP いずれで計測する場合もサーバ側のオプションは変わりません。
クライアント側
UDP で計測する場合は -c オプションに加え、明示的に -u オプションで「UDP の計測である」ことを指定する必要があります。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20 | root@ubuntu2:~# iperf3 -c 10.0.0.1 -u
Connecting to host 10.0.0.1, port 5201
[ 5] local 10.0.0.2 port 39603 connected to 10.0.0.1 port 5201
[ ID] Interval Transfer Bitrate Total Datagrams
[ 5] 0.00-1.00 sec 129 KBytes 1.05 Mbits/sec 91
[ 5] 1.00-2.00 sec 127 KBytes 1.04 Mbits/sec 90
[ 5] 2.00-3.00 sec 129 KBytes 1.05 Mbits/sec 91
[ 5] 3.00-4.00 sec 127 KBytes 1.04 Mbits/sec 90
[ 5] 4.00-5.00 sec 129 KBytes 1.05 Mbits/sec 91
[ 5] 5.00-6.00 sec 129 KBytes 1.05 Mbits/sec 91
[ 5] 6.00-7.00 sec 127 KBytes 1.04 Mbits/sec 90
[ 5] 7.00-8.00 sec 129 KBytes 1.05 Mbits/sec 91
[ 5] 8.00-9.00 sec 127 KBytes 1.04 Mbits/sec 90
[ 5] 9.00-10.00 sec 129 KBytes 1.05 Mbits/sec 91
- - - - - - - - - - - - - - - - - - - - - - - - -
[ ID] Interval Transfer Bitrate Jitter Lost/Total Datagrams
[ 5] 0.00-10.00 sec 1.25 MBytes 1.05 Mbits/sec 0.000 ms 0/906 (0%) sender
[ 5] 0.00-10.00 sec 1.25 MBytes 1.05 Mbits/sec 0.048 ms 0/906 (0%) receiver
iperf Done.
|
サーバ側
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23 | root@ubuntu1:~# iperf3 -s
-----------------------------------------------------------
Server listening on 5201
-----------------------------------------------------------
Accepted connection from 10.0.0.2, port 35764
[ 5] local 10.0.0.1 port 5201 connected to 10.0.0.2 port 39603
[ ID] Interval Transfer Bitrate Jitter Lost/Total Datagrams
[ 5] 0.00-1.00 sec 129 KBytes 1.05 Mbits/sec 1.438 ms 0/91 (0%)
[ 5] 1.00-2.00 sec 127 KBytes 1.04 Mbits/sec 0.073 ms 0/90 (0%)
[ 5] 2.00-3.00 sec 129 KBytes 1.05 Mbits/sec 0.056 ms 0/91 (0%)
[ 5] 3.00-4.00 sec 127 KBytes 1.04 Mbits/sec 0.151 ms 0/90 (0%)
[ 5] 4.00-5.00 sec 129 KBytes 1.05 Mbits/sec 0.039 ms 0/91 (0%)
[ 5] 5.00-6.00 sec 129 KBytes 1.05 Mbits/sec 0.036 ms 0/91 (0%)
[ 5] 6.00-7.00 sec 127 KBytes 1.04 Mbits/sec 0.043 ms 0/90 (0%)
[ 5] 7.00-8.00 sec 129 KBytes 1.05 Mbits/sec 0.068 ms 0/91 (0%)
[ 5] 8.00-9.00 sec 127 KBytes 1.04 Mbits/sec 0.036 ms 0/90 (0%)
[ 5] 9.00-10.00 sec 129 KBytes 1.05 Mbits/sec 0.048 ms 0/91 (0%)
- - - - - - - - - - - - - - - - - - - - - - - - -
[ ID] Interval Transfer Bitrate Jitter Lost/Total Datagrams
[ 5] 0.00-10.00 sec 1.25 MBytes 1.05 Mbits/sec 0.048 ms 0/906 (0%) receiver
-----------------------------------------------------------
Server listening on 5201
-----------------------------------------------------------
|
テスト
サーバ側のテスト結果表示の項目を TCP/UDP で比較すると以下の差があります。
| Protocol |
Interval |
Transfer |
Bitrate |
Jitter |
Lost/Total Datagrams |
| TCP |
○ |
○ |
○ |
|
|
| UDP |
○ |
○ |
○ |
○ |
○ |
テストを自動化/結果を加工したい場合は
iperf3 には結果を JSON で表示する -J (または --json) オプションがあります。 例えば「結果をグラフ化したい」「プログラムから扱いたい」といった場合は iperf3 の実行結果を JSON で受け取る選択肢もあります。
より複雑な要件がある場合は Python 用の iperf3 ライブラリである iperf3 (GitHub は こちら) の利用も検討します。
参考
iperf3 のヘルプ
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79 | # iperf3 --help
Usage: iperf3 [-s|-c host] [options]
iperf3 [-h|--help] [-v|--version]
Server or Client:
-p, --port # server port to listen on/connect to
-f, --format [kmgtKMGT] format to report: Kbits, Mbits, Gbits, Tbits
-i, --interval # seconds between periodic throughput reports
-F, --file name xmit/recv the specified file
-A, --affinity n/n,m set CPU affinity
-B, --bind <host> bind to the interface associated with the address <host>
-V, --verbose more detailed output
-J, --json output in JSON format
--logfile f send output to a log file
--forceflush force flushing output at every interval
-d, --debug emit debugging output
-v, --version show version information and quit
-h, --help show this message and quit
Server specific:
-s, --server run in server mode
-D, --daemon run the server as a daemon
-I, --pidfile file write PID file
-1, --one-off handle one client connection then exit
--rsa-private-key-path path to the RSA private key used to decrypt
authentication credentials
--authorized-users-path path to the configuration file containing user
credentials
Client specific:
-c, --client <host> run in client mode, connecting to <host>
--sctp use SCTP rather than TCP
-X, --xbind <name> bind SCTP association to links
--nstreams # number of SCTP streams
-u, --udp use UDP rather than TCP
--connect-timeout # timeout for control connection setup (ms)
-b, --bitrate #[KMG][/#] target bitrate in bits/sec (0 for unlimited)
(default 1 Mbit/sec for UDP, unlimited for TCP)
(optional slash and packet count for burst mode)
--pacing-timer #[KMG] set the timing for pacing, in microseconds (default 1000)
--fq-rate #[KMG] enable fair-queuing based socket pacing in
bits/sec (Linux only)
-t, --time # time in seconds to transmit for (default 10 secs)
-n, --bytes #[KMG] number of bytes to transmit (instead of -t)
-k, --blockcount #[KMG] number of blocks (packets) to transmit (instead of -t or -n)
-l, --length #[KMG] length of buffer to read or write
(default 128 KB for TCP, dynamic or 1460 for UDP)
--cport <port> bind to a specific client port (TCP and UDP, default: ephemeral port)
-P, --parallel # number of parallel client streams to run
-R, --reverse run in reverse mode (server sends, client receives)
--bidir run in bidirectional mode.
Client and server send and receive data.
-w, --window #[KMG] set window size / socket buffer size
-C, --congestion <algo> set TCP congestion control algorithm (Linux and FreeBSD only)
-M, --set-mss # set TCP/SCTP maximum segment size (MTU - 40 bytes)
-N, --no-delay set TCP/SCTP no delay, disabling Nagle's Algorithm
-4, --version4 only use IPv4
-6, --version6 only use IPv6
-S, --tos N set the IP type of service, 0-255.
The usual prefixes for octal and hex can be used,
i.e. 52, 064 and 0x34 all specify the same value.
--dscp N or --dscp val set the IP dscp value, either 0-63 or symbolic.
Numeric values can be specified in decimal,
octal and hex (see --tos above).
-L, --flowlabel N set the IPv6 flow label (only supported on Linux)
-Z, --zerocopy use a 'zero copy' method of sending data
-O, --omit N omit the first n seconds
-T, --title str prefix every output line with this string
--extra-data str data string to include in client and server JSON
--get-server-output get results from server
--udp-counters-64bit use 64-bit counters in UDP test packets
--repeating-payload use repeating pattern in payload, instead of
randomized payload (like in iperf2)
--username username for authentication
--rsa-public-key-path path to the RSA public key used to encrypt
authentication credentials
[KMG] indicates options that support a K/M/G suffix for kilo-, mega-, or giga-
iperf3 homepage at: https://software.es.net/iperf/
Report bugs to: https://github.com/esnet/iperf
|