eMQTT-Benchによるパフォーマンステスト
EMQXをシングルモードまたはクラスターでデプロイした後、システムの性能を把握するためにパフォーマンステストを実施できます。本節では、eMQTT-Benchのインストール方法と使用方法を紹介します。eMQTT-BenchはErlangで書かれたシンプルかつ強力なMQTTプロトコルのベンチマークツールです。大規模シナリオや高度なカスタマイズが必要な場合は、テストサービスのXMeterを推奨します。
eMQTT-Benchのインストール
eMQTT-Benchのインストール方法は以下の3つがあります。
- Dockerイメージを実行する
- バイナリパッケージをダウンロードしてインストールする
- ソースコードからビルドする
Dockerイメージ
hub.docker.comに公開されているemqtt-benchのDockerイメージを実行してインストールできます。:latestタグは新しいバージョンごとに更新されます。
docker run -it emqx/emqtt-bench:latest
Usage: emqtt_bench pub | sub | conn [--help]Dockerイメージ名はハイフン - を使用していますが、バイナリスクリプト名はアンダースコア _ を使用している点にご注意ください。
バイナリパッケージ
以下のプラットフォーム向けにリリースされたバイナリパッケージをダウンロードしてemqtt-benchをインストールできます。
- Amazon Linux 2
- Amazon Linux 2023
- CentOS 7
- Rocky Linux 8
- Rocky Linux 9
- Debian 9
- Debian 10
- Debian 11
- Debian 12
- Ubuntu 16.04
- Ubuntu 18.04
- Ubuntu 20.04
- Ubuntu 22.04
- MacOS 11 (Intel)
- MacOS 12 (Intel)
- MacOS 12 (Apple Silicon)
各リリースの詳細はReleasesをご参照ください。
例として、Ubuntu 20.04にemqtt-benchをインストールする手順は以下の通りです。
mkdir emqtt-bench && cd emqtt-bench
wget https://github.com/emqx/emqtt-bench/releases/download/0.4.12/emqtt-bench-0.4.12-ubuntu20.04-amd64.tar.gz
tar xfz emqtt-bench-0.4.12-ubuntu20.04-amd64.tar.gz
rm emqtt-bench-0.4.12-ubuntu20.04-amd64.tar.gz
./emqtt_bench
Usage: emqtt_bench pub | sub | conn [--help]ソースからビルド
eMQTT-BenchはErlangで書かれており、ビルドにはErlang/OTP 22.3以上が必要です。Erlang/OTPのインストール手順はここでは省略します。詳細はオンラインのインストールチュートリアルをご参照ください。
Erlang環境が整ったら、最新のemqtt-benchコードをダウンロードしてコンパイルします。
git clone https://github.com/emqx/emqtt-bench
cd emqtt-bench
makeコンパイル後、カレントディレクトリにemqtt_benchという実行可能スクリプトが生成されます。以下のコマンドを実行して正常に動作するか確認してください。
./emqtt_bench
Usage: emqtt_bench pub | sub | conn [--help]上記の出力が表示されれば、emqtt-benchがホストに正しくインストールされたことを示します。
eMQTT-Benchの使い方
emqtt_benchには以下の3つのサブコマンドがあります。
pub：大量のクライアントを作成し、メッセージのパブリッシュ操作を行うsub：大量のクライアントを作成し、トピックをサブスクライブしてメッセージを受信するconn：大量の接続を作成する
パブリッシュ
./emqtt_bench pub --helpを実行すると利用可能なパラメータが表示されます。
| パラメータ | 省略形 | オプション値 | デフォルト値 | 説明 |
|---|---|---|---|---|
| --host | -h | - | localhost | 接続するMQTTサーバーのアドレス |
| --port | -p | - | 1883 | MQTTサービスのポート番号 |
| --version | -V | 3 4 5 | 5 | 使用するMQTTプロトコルのバージョン |
| --count | -c | - | 200 | クライアントの総数 |
| --startnumber | -n | - | 0 | クライアントの開始番号 |
| --interval | -i | - | 10 | クライアント作成の間隔（単位：ms） |
| --interval_of_msg | -I | - | 1000 | メッセージのパブリッシュ間隔 |
| --username | -u | - | なし（任意） | クライアントのユーザー名 |
| --password | -P | - | なし（任意） | クライアントのパスワード |
| --topic | -t | - | なし（必須） | パブリッシュするトピック。プレースホルダー対応：%c: ClientId%u: Username%i: クライアントの連番 |
| --size | -s | - | 256 | メッセージペイロードのサイズ（バイト単位） |
| --qos | -q | - | 0 | QoSレベル |
| --retain | -r | true false | false | メッセージのRetainフラグを設定するかどうか |
| --keepalive | -k | - | 300 | クライアントのキープアライブ時間 |
| --clean | -C | true false | true | セッションをクリアして接続を確立するかどうか |
| --ssl | -S | true false | false | SSLを有効にするかどうか |
| --certfile | - | - | なし | クライアントのSSL証明書 |
| --keyfile | - | - | なし | クライアントのSSLキー |
| --ws | - | true false | false | WebSocket経由で接続を確立するかどうか |
| --ifaddr | - | - | なし | クライアント接続に使用するローカルネットワークインターフェース |
例として、10接続を開始し、1秒ごとにトピックtへQos0のメッセージを100件、ペイロードサイズ16バイトでパブリッシュするコマンドは以下の通りです。
./emqtt_bench pub -t t -h emqx-server -s 16 -q 0 -c 10 -I 10サブスクライブ
./emqtt_bench sub --helpを実行すると、このサブコマンドの利用可能なパラメータが表示されます。説明は上記の表と重複するため省略します。
例として、500接続を開始し、それぞれがQos0でトピックtをサブスクライブするコマンドは以下の通りです。
./emqtt_bench sub -t t -h emqx-server -c 500コネクト
./emqtt_bench conn --helpを実行すると、このサブコマンドの利用可能なパラメータが表示されます。説明は上記の表と重複するため省略します。
例として、1000接続を開始するコマンドは以下の通りです。
./emqtt_bench conn -h emqx-server -c 1000SSL接続
emqtt-benchはSSLによるセキュアな接続を確立し、テストを行うことができます。
片方向証明書の場合：
./emqtt_bench sub -c 100 -i 10 -t bench/%i -p 8883 -S
./emqtt_bench pub -c 100 -I 10 -t bench/%i -p 8883 -s 256 -S双方向証明書の場合：
./emqtt_bench sub -c 100 -i 10 -t bench/%i -p 8883 --certfile path/to/client-cert.pem --keyfile path/to/client-key.pem
./emqtt_bench pub -c 100 -i 10 -t bench/%i -s 256 -p 8883 --certfile path/to/client-cert.pem --keyfile path/to/client-key.pemストレステストの実施
本節では、典型的な2つのシナリオ（接続数とスループット）におけるストレステストの実施方法を説明します。
典型的なストレステストシナリオ
以下の2つの典型的なシナリオでツールの利用を検証します。
- 接続数：
emqtt-benchを使ってEMQXに数百万の接続を作成する - スループット：
emqtt-benchを使ってEMQXにおいて100k/s Qos 0のメッセージスループットを生成する
デバイスとデプロイメントトポロジー
合計3台の8コア16GBメモリのサーバーを準備し、1台はEMQX用、2台はクライアント負荷用に使用します。
- システム：
CentOS Linux release 7.7.1908 (Core) - CPU：
Intel Xeon Processor (Skylake)メインクロック：2693.670 MHZ - サーバー：
emqx-centos7-v4.0.2.zip - 負荷用クライアント：
emqtt-bench v0.3.1、各負荷用クライアントは10個のネットワークカードを設定し、接続テストで大量のMQTTクライアント接続を確立するために使用
トポロジー構成は以下の通りです。
チューニング
クライアント負荷用とサーバーの両方でシステムパラメータのチューニングが必要です。詳細はTuning guideを参照してください。
接続テスト
システムチューニング後にEMQXを起動し、bench1の各ネットワークカードごとに5万接続を開始します。合計で50万接続となります。
./emqtt_bench -h 192.168.0.99 -c 50000 --ifaddr 192.168.0.100
./emqtt_bench -h 192.168.0.99 -c 50000 --ifaddr 192.168.0.101
./emqtt_bench -h 192.168.0.99 -c 50000 --ifaddr 192.168.0.102
./emqtt_bench -h 192.168.0.99 -c 50000 --ifaddr 192.168.0.103
./emqtt_bench -h 192.168.0.99 -c 50000 --ifaddr 192.168.0.104
./emqtt_bench -h 192.168.0.99 -c 50000 --ifaddr 192.168.0.105
./emqtt_bench -h 192.168.0.99 -c 50000 --ifaddr 192.168.0.106
./emqtt_bench -h 192.168.0.99 -c 50000 --ifaddr 192.168.0.107
./emqtt_bench -h 192.168.0.99 -c 50000 --ifaddr 192.168.0.108
./emqtt_bench -h 192.168.0.99 -c 50000 --ifaddr 192.168.0.109同様の操作をbench2でも実施します。
すべての接続が確立した後、./bin/emqx ctl listenersを実行すると、EMQXの接続数に関する以下の情報が確認できます。
listener on mqtt:tcp:0.0.0.0:1883
acceptors : 8
max_conns : 1024000
current_conn : 1000000
shutdown_count : []スループットテスト
同様に、まずEMQXを起動し、bench1で500のサブスクライブクライアントを起動します。
./emqtt_bench sub -t t -h 192.168.0.99 -c 500次にbench2で20のパブリッシャーを起動し、1秒あたり10メッセージをパブリッシュします。
./emqtt_bench pub -t t -h 192.168.0.99 -c 20 -I 100bench1のサブスクライブクライアントに戻ると、現在の受信メッセージレートが確認できます。
recv(28006): total=2102563, rate=99725(msg/sec)