Locust性能测试实践

Locust 是一个开源的负载测试工具，使用Python语言实现，其简洁、轻量、高效的并发机制基于Gevent协程，可以实现单机模拟生成较高的并发压力。具有分布式和可扩展的特点，能够帮助你评估系统的性能并找到潜在的瓶颈。

Locust 的主要特点:

1. 使用 Python 编写测试脚本：你可以用 Python 编写用户行为脚本，定义各种用户操作和请求。
2. 分布式测试：支持分布式测试，允许在多台机器上同时运行，从而模拟大量的并发用户。
3. 实时 Web 界面：提供直观的 Web 界面，用于配置测试参数、启动和监控测试。
4. 可扩展性强：可以通过编写自定义代码来扩展 Locust 的功能，满足不同测试需求。

1. 安装Locust

使用 pip 进行安装：

pip3 install locust -i https://mirrors.aliyun.com/pypi/simple/

查看安装版本：

locust -V

2. web demo应用

使用 Python 的 Flask 框架实现一个简单的web服务器，包含主页 (/) 和关于页 (/about)，用于Locust执行测试。

2.1 安装Flask

使用pip安装：

pip3 install flask -i https://mirrors.aliyun.com/pypi/simple/

2.2 创建Flask应用

新建一个名为 app.py 的文件，编写如下代码：

from flask import Flask, jsonify

app = Flask(__name__)

@app.route('/')
def index():
    return jsonify(message="Welcome to the homepage!")

@app.route('/about')
def about():
    return jsonify(message="This is the about page.")

if __name__ == '__main__':
    app.run(debug=True, host='0.0.0.0', port=5000)

2.3 运行 Flask 应用

在终端中运行以下命令启动 Flask 服务器：

python app.py

默认情况下，Flask 服务器会在 http://localhost:5000 运行。你可以通过浏览器访问这个地址，查看主页和关于页是否正常显示。

3. 运行模式

Locust支持单机模式、分布式模式和无头模式。每种模式适用于不同的测试场景。

3.1 单机模式

适用于小规模测试。简单直接，只需在一台机器上运行 Locust。

一个简单的 Locust 测试脚本如下所示：

# locust-test1.py
from locust import HttpUser, TaskSet, task, between

# 定义一个任务类继承TaskSet类
class UserBehavior(TaskSet):
    # @task(1) 是装饰器，声明此方法是一个任务，权重为1。权重不写的话默认为1
    @task(1)
    def index(self):
        self.client.get("/")
    # @task(2) 是装饰器，声明此方法是一个任务，权重为2
    @task(2)
    def about(self):
        self.client.get("/about")

# 定义一个运行类继承HttpUser类
class WebsiteUser(HttpUser):
    tasks = [UserBehavior]
    wait_time = between(1, 5)
    host = "http://localhost:5000"

在这个脚本中，我们定义了一个 UserBehavior 类，其中包含两个任务：访问主页（index）和访问关于页（about）。然后我们定义了一个 WebsiteUser 类，指定用户行为、请求之间的等待时间以及测试的web服务器。

运行 Locust：

在终端中运行以下命令启动 Locust：

locust -f locust-test1.py

配置和启动测试：

打开浏览器访问 http://localhost:8089，在 Locust 的 Web 界面中设置测试参数，设置并发用户数为50，设置每秒增加的用户数为10，即以多快的速度增加用户。，测试host为本机运行的flask服务器，运行时间为60秒。然后启动测试。

结果结果统计：

图标性能曲线：

测试报告下载：

3.2 分布式模式

适用于大规模测试。支持多台机器协同工作，能够模拟大量并发用户，包括 master 和 worker 节点，worker节点产生负载， master 节点主要负责协调和收集来自多个 worker 节点的数据。

运行方法：

• 启动 master：

  locust -f locust-test1.py --master
  

• 启动 worker：

  # worker机器同样需要安装locust
  locust -f locust-test1.py --worker --master-host=<master_ip>
  

worker运行后，master侧命令行会有worker已连接的打印，可以看到当前master下面连接的worker数量。

在浏览器中打开 http://<master_ip>:8089，配置测试参数并启动测试：

3.3 无头模式（Headless Mode）

适用于持续集成（CI）环境或不需要图形界面的场景。可以自动执行测试，并将结果输出到控制台或文件中。

运行方法：

使用命令行参数配置和启动测试：

locust -f locust-test1.py --headless -u 100 -r 10 -H http://192.168.0.210:5000 --run-time 1m --csv=results

参数说明：

• --headless：无头模式运行。
• -u 或 --users：模拟的用户数。
• -r 或 --spawn-rate：每秒启动的用户数。
• --run-time：测试运行时间，例如 1m 表示 1 分钟。
• --csv：将测试结果输出到 CSV 文件。

3.4 总结

• 单机模式 适用于简单的小规模测试。
• 分布式模式 适用于大规模测试，通过多个 worker 节点协同工作来模拟大量并发用户。
• 无头模式 适用于自动化测试和持续集成环境，可以在没有图形界面的情况下运行测试并输出结果。

4. locust运行参数说明

有关更多详细信息，包括如何使用文件或环境变量设置选项，请参阅文档：https://docs.locust.io/en/stable/configuration.html

5. 参考

1. 官方文档：http://docs.locust.io/en/stable/installation.html

2. Locust性能测试之快速入门: https://www.cnblogs.com/xyztank/articles/16932194.html