Locustによる負荷試験

Locust について

Locust は、Python で書かれた負荷テストツールです。機能的には、Apache JMeter などの方が多機能なようですが、以下の特徴があり使い勝手が良いです。

テストシナリオを Python コードで書くことが可能
スケーラブルで、分散実行が可能
Web UI 付き
どのようなシステムでもテストができる（ただし、Locust のコア機能は Web をターゲットにしている）
小さく作られているので、ハックが容易

ただし、ver1.0 で大幅な変更がされているようなので、ドキュメントを参照する際には、バージョンに気を付けた方がよさそうです。

インストール

pip 経由で Locust をインストールします。


$ pip3 install locust

インストールされたバージョンは以下の通りです。


$ locust -V
locust 2.8.5

Locust で簡単な負荷試験を実行する

コード

公式の Tutorial から以下のコードを準備します。


#  locustfile.py

import time
from locust import HttpUser, task, between

class QuickstartUser(HttpUser):
    wait_time = between(1, 2.5) # 1ユーザーのページ滞在秒数の範囲

    @task
    def hello_world(self):
        self.client.get("/hello")
        self.client.get("/world")

    @task(3) # 数字はtaskの重み
    def view_items(self):
        for item_id in range(10):
            self.client.get(f"/item?id={item_id}", name="/item")
            time.sleep(1)

    def on_start(self):
        self.client.post("/login", json={"username":"foo", "password":"bar"})

負荷試験を実行後、各メソッドはランダムにリクエストされます。重み task(3) と入れることで、hello_world メソッドよりもリクエストが単純に 3 倍呼ばれる率が高くなっています。

on_start はユーザーのリクエストの最初に行われるメソッドです。上記は on_start でページログインを行なった後、hello_world, view_items それぞれのメソッドを実行するコードとなっています。

実行

以下のコマンドで実行できます。


$ locust -f locustfile.py
[2022-04-05 09:43:01,894] LAPTOP-F653NDUF/WARNING/locust.main: System open file limit '4096' is below minimum setting '10000'.
It's not high enough for load testing, and the OS didn't allow locust to increase it by itself.
See https://github.com/locustio/locust/wiki/Installation#increasing-maximum-number-of-open-files-limit for more info.
[2022-04-05 09:43:01,894] LAPTOP-F653NDUF/INFO/locust.main: Starting web interface at http://0.0.0.0:8089 (accepting connections from all network interfaces)
[2022-04-05 09:43:01,903] LAPTOP-F653NDUF/INFO/locust.main: Starting Locust 2.8.5

ブラウザから localhost:8089 にアクセスすると以下の画面が表示されます。

ここで、各項目の内容は以下の通りです。

Number of total users to simulate
- 最大の同時接続数
Spawn rate
- 1 秒あたり何ユーザー増やしていくか（最初から最大数にしたい場合は”Number of total users to simulate”と同じ数字にすればよい）
Host
- リクエスト投げるドメイン名 (例: https://www.google.com)

[Start swarming]ボタンを押すと、負荷試験が開始されます。

結果は、表やチャートで分かりやすく表示してくれます。

参考文献

備考

Hakky ではエンジニアを募集中です！まずは話してみたいなどでも構いませんので、ぜひお気軽に採用ページからお問い合わせくださいませ。