負荷テストツールLocust学習3：Locustのパラメータ
はじめに
こんにちは、SHIFT DevOps推進2グループの李です。
前回はLocustの書き方について紹介しました。いかがでしたか？
Pythonができれば、Locustもあっという間に習得できるでしょう。
続けて、今回はLocustのパラメータを紹介しようと思います。
下記が今回使用するソフトウェアです。
Visual Studio Code：最新版 https://code.visualstudio.com/
Python：3.11.1 https://www.python.org/
Locust：2.14.2 https://locust.io/
内容を5つのシリーズに分けて紹介したいと思います。
連載目次：
（今回）負荷テストツールLocust学習3：Locustのパラメータ
Locustのパラメータ
ターミナルでlocust -hを入力すると、パラメータ一覧が表示されます。
ここからはLocustのコマンドを紹介します。
共通パラメータ
共通パラメータはよく使うパラメータです。
ファイルの指定、ユーザ数の設定など必須な設定項目です。
詳しくは下記の一覧を参考にしてください。
-h, --help：パラメータ一覧を表示する
-f , --locustfile ：実行するファイルパス
--config ：コンフィグファイルパス
-H , --host ：テストするホストアドレス
-u , --users ユーザ数：実行するユーザ数
-r , --spawn-rate ：毎秒起動するユーザ数
-t , --run-time ：指定された時間後に停止する
-l, --list：可能なユーザークラスのリストを表示して終了
UIパラメータ
UIパラメータはGUIに使用するパラメータです。
GUIのホストやポートなどを設定することができます。
詳しくは下記の一覧を参考にしてください。
--web-host ：UIインターフェースのホストアドレス
--web-port , -P ：UIインターフェースのホストポート（デフォルトは8089）
--headless：UIインターフェースを表示しないようにテストする（-uと-tなどの実行パラメータを指定する）
--autostart：すぐにテストを開始する
--autoquit：実行が終了してからLocust を完全に終了する
--web-auth :：ユーザとパスワードでログインする
--tls-cert ：TLS認証を使用する証明書のパス
--tls-key ：TLS認証を使用するTLS秘密鍵のパス
マスター パラメータ
マスターパラメータは分散モードのマスターロールに対して設定するパラメータです。
詳しくは下記の一覧を参考にしてください。
--master：locustを分散モードで実行するように設定して、このプロセスをマスターとして指定する
--master-bind-host ：マスターのホストを指定する
--master-bind-port ：マスターのポートを指定する（デフォルトは5557）
--expect-workers ：マスターに接続するワーカーの数
--expect-workers-max-wait ：ワーカーが接続するまでマスターの待機時間（でフォルダは無制限）
ワーカー パラメータ
ワーカーパラメータは分散モードのワーカーロールに対して設定するパラメータです。
詳しくは下記の一覧を参考にしてください。
--worker：locustを分散モードで実行するように設定して、このプロセスをワーカーとして指定する
--master-host：：マスターのホストを指定する
--master-port ：マスターのポートを指定する（デフォルトは5557）
タグ パラメータ
タブパラメータは実行のタブを分けて、一部のスクリプトを実行するパラメータです。
詳しくは下記の一覧を参考にしてください。
-T , --tags ：指定のタグを含めるタスクのみ実行する
-E , --exclude-tags ：指定のタグを含まないタスクを実行する
レポート パラメータ
レポートパラメータは出力するレポートについての詳細な設定です。
詳しくは下記の一覧を参考にしてください。
--csv ：リクエスト統計を CSV 形式で保存する
--csv-full-history：統計エントリを CSV 形式で保存する
--print-stats：リクエスト統計の定期的な出力する
--only-summary：概要のみ出力する
--reset-stats：生成が完了したら、統計をリセットする
--html ：HTML レポートを生成する
–json：JSON 形式で出力する
ログ パラメータ
ログパラメータは出力するログのレベルを設定するパラメータです。
詳しくは下記の一覧を参考にしてください。
--skip-log-setup：ログを無効にする
--loglevel ：DEBUG/INFO/WARNING/ERROR/CRITICAL からログレベルを指定する
--logfile ：ログ ファイルへパス
その他 パラメータ
--version, -V：バージョンを表示する
-s , --stop-timeout：タイムアウト時間を指定する
次回のお知らせ
今回はLocust（ロウカスト）のパラメータ全てを紹介しました。
次回はパラメータを使用したLocustのGUIとCLIの操作方法について紹介したいと思います。
最後までお読みいただきありがとうございました。
また次回の記事でお会いしましょう！
参考資料
執筆者プロフィール：李 嘉興
社会人になって以来、数年間システムエンジニアとして多数のプロジェクトの開発（要件定義～リリース）を経験したのち、2021年7月にSHIFTに入社。
システムエンジニアの仕事と全く違う分野の自動化とCICDを経験しつつ、未来のキャリアのため日々奮闘中。
お問合せはお気軽に
https://service.shiftinc.jp/contact/
SHIFTについて（コーポレートサイト）
https://www.shiftinc.jp/
SHIFTのサービスについて（サービスサイト）
https://service.shiftinc.jp/
SHIFTの導入事例
https://service.shiftinc.jp/case/
お役立ち資料はこちら
https://service.shiftinc.jp/resources/
SHIFTの採用情報はこちら
https://recruit.shiftinc.jp/career/