Locust——基本用法

Posted 2021-08-08 一加一

一、认识Locust

1、定义

Locust是一款易于使用的分布式负载测试工具，完全基于事件，即一个locust节点也可以在一个进程中支持数千并发用户，不使用回调，通过gevent使用轻量级过程（即在自己的进程内运行）。

2、特点

①、不需要编写笨重的UI或者臃肿的XML代码，基于协程而不是回调，脚本编写简单易读；

②、有一个基于we简洁的html+JS的UI用户界面，可以实时显示相关的测试结果；

③、支持分布式测试，用户界面基于网络，因此具有跨平台且易于扩展的特点；

④、所有繁琐的I / O和协同程序都被委托给gevent，替代其他工具的局限性；

3、locust与jmeter的区别

工具	区别
jmeter	需要在UI界面上通过选择组件来“编写”脚本，模拟的负载是线程绑定的，意味着模拟的每个用户，都需要一个单独的线程。单台负载机可模拟的负载数有限
locust	通过编写简单易读的代码完成测试脚本，基于事件，同样配置下，单台负载机可模拟的负载数远超jmeter

PS：但locust的局限性在于，目前其本身对测试过程的监控和测试结果展示，不如jmeter全面和详细，需要进行二次开发才能满足需求越来越复杂的性能测试需要。

 

二、安装Locust

1、支持的python版本：2.7、3.4、3.5、3.6；

2、Windows系统安装locust

直接通过 pip install locustio 命令安装；

安装成功后可以输入 pip show locust 命令查看是否安装成功，以及通过 locust -help 命令查看帮助信息。

PS：运行大规模测试时，建议在Linux机器上执行此操作，因为gevent在Windows下的性能很差。

 

三、一个简单的示例 locustfile.py

1、代码示例

import time
from locust import HttpUser, task, between

class QuickstartUser(HttpUser):
    wait_time = between(1, 2.5)

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

    @task(3)
    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):
        response = self.client.post("/auth/login_by_password", json={"employeeName":"李白","loginType":"PASSWORD","password":"123456"})
        print("Response status code:", response.status_code)
        print("Response text:", response.text)

2、详细分解

2.1 、locust 文件只是一个普通的 Python 模块，它可以从其他文件或包中导入代码。

import time
from locust import HttpUser, task, between

2.2、在这里，我们为将要模拟的用户定义了一个类。它继承自 HttpUserwhich 为每个用户提供一个client属性，该属性是 的一个实例HttpSession，可用于向我们要进行负载测试的目标系统发出 HTTP 请求。当测试开始时，locust 会为它模拟的每个用户创建一个这个类的实例，每个用户都将开始在他们自己的绿色 gevent 线程中运行。

class QuickstartUser(HttpUser):

2.3、我们的类定义了一个wait_time让模拟用户在每个任务执行后等待 1 到 2.5 秒。

wait_time = between(1, 2.5)

2.4、装饰的方法@task是你的 locust 文件的核心。对于每个正在运行的用户，Locust 创建一个 greenlet（微线程），它将调用这些方法。

@task
def hello_world(self):
    ...

2.5、我们通过用 装饰两个方法来声明两个任务@task，其中一个被赋予了更高的权重 (3)。如果我们的QuickstartUser运行，它会挑的申报任务之一-在这种情况下，无论是hello_world或 view_items-并执行它。任务是随机挑选的，但您可以赋予它们不同的权重。上述配置将使 Locustview_items比hello_world. 当任务完成执行时，用户将在等待时间（在这种情况下为 1 到 2.5 秒）期间休眠。在等待时间过后，它会选择一个新任务并不断重复。

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

@task(3)
def view_items(self):
...

2.6、该self.client属性可以进行由 Locust 记录的 HTTP 调用。

self.client.get("/hello")

2.6、在view_items任务中，我们使用可变查询参数加载 10 个不同的 URL。为了不在 Locust 的统计信息中获得 10 个单独的条目——因为统计信息是按 URL 分组的——我们使用name 参数将所有这些请求分组到一个名为的条目下"/item"。

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

2.7、此外，我们还声明了一个on_start方法。每个模拟用户启动时都会调用具有此名称的方法。

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

四、启动Locust

启动的locust文件名为locustfile.py并位于当前工作目录中，可以在编译器中直接运行该文件：locust -f locustfile.py

附上其他启动说明：

1、如果启动的locust文件名为locustfile.py并位于当前工作目录中，可以在编译器中直接运行该文件，或者通过cmd，执行如下命令：

 locust --host=https://www.cnblogs.com 

2、如果Locust文件位于子目录下且名称不是locustfile.py，可以使用-f命令启动上面的示例locust文件：

 locust -f testscript/locusttest.py --host=https://www.cnblogs.com 

3、如果要运行分布在多个进程中的Locust，通过指定-master以下内容来启动主进程 ：

 locust -f testscript/locusttest.py --master --host=https://www.cnblogs.com 

4、如果要启动任意数量的从属进程，可以通过-salve命令来启动locust文件：

 locust -f testscript/locusttest.py --salve --host=https://www.cnblogs.com 

5、如果要运行分布式Locust，必须在启动从机时指定主机（运行分布在单台机器上的Locust时不需要这样做，因为主机默认为127.0.0.1）：

 locust -f testscript/locusttest.py --slave --master-host=192.168.0.100 --host=https://cnblogs.com 

6、启动locust文件成功后，编译器控制台会显示如下信息：

 [2018-10-09 01:01:44,727] IMYalost/INFO/locust.main: Starting web monitor at *:8089

[2018-10-09 01:01:44,729] IMYalost/INFO/locust.main: Starting Locust 0.8 

PS：8089是该服务启动的端口号，如果是本地启动，可以直接在浏览器输入http://localhost:8089打开UI界面，如果是其他机器搭建locust服务，则输入该机器的IP+端口即可；

 五、Locust的网页界面

1、使用上述命令行之一启动 Locust 后，您应该打开浏览器并将其指向http://localhost:8089。那么你应该会收到这样的问候：

Number of users to simulate：设置模拟的用户总数

Hatch rate (users spawned/second)：每秒启动的虚拟用户数

Start swarming：执行locust脚本

Host：填写自己实际需要测试的目标系统host

填写表格并尝试一下！（但请注意，如果您不更改 locust 文件以匹配您的实际目标系统，您通常会收到错误响应）

 

2、测试结果界面

PS：点击STOP可以停止locust脚本运行：

Type：请求类型，即接口的请求方法；

Name：请求路径；

requests：当前已完成的请求数量；

fails：当前失败的数量；

Median：响应时间的中间值，即50%的响应时间在这个数值范围内，单位为毫秒；

Average：平均响应时间，单位为毫秒；

Min：最小响应时间，单位为毫秒；

Max：最大响应时间，单位为毫秒；

Content Size：所有请求的数据量，单位为字节；

reqs/sec：每秒钟处理请求的数量，即QPS；

3、各模块说明

New test：点击该按钮可对模拟的总虚拟用户数和每秒启动的虚拟用户数进行编辑；

Statistics：类似于jmeter中Listen的聚合报告；

Charts：测试结果变化趋势的曲线展示图，分别为每秒完成的请求数（RPS）、响应时间、不同时间的虚拟用户数；

Failures：失败请求的展示界面；

Exceptions：异常请求的展示界面；

Download Data：测试数据下载模块， 提供三种类型的CSV格式的下载，分别是：Statistics、responsetime、exceptions；

 

参考博客：https://www.cnblogs.com/imyalost/p/9758189.html

Locust官方说明文档：https://docs.locust.io/en/stable/