性能测试之Locust（完整版）

官方文档：Locust说明文档

一、Locust简介

1、定义

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

2、特点

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

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

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

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

3、locust与jmeter的区别

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

二、安装Locust

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

2、安装locust

①、通过 pip install locust 命令安装；

②、通过为pyzmq、gevent和greenlet安装预先构建的二进制包，然后在这里找到非官方的预制包，下载.whl文件后，使用 pip install name-of-file.whl 命令安装；

检测是否安装成功：

pip show locust

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

三、示例

from locust import TaskSet, task, HttpUser, run_single_user
from locust.clients import ResponseContextManager
from locust.runners import logger


class Task(TaskSet):
    @task(1)
    def query_room_all_user_id(self):
        # 传递字典数据
        payload = {"roomId": "101_102_1_3_100001"}

        path = "/room-assignment/query-room-all-user-id"
        logger.info(f"Request URL {path}")
        with self.client.post(path, json=payload, catch_response=True) as res:
            res: ResponseContextManager
            if res.status_code != 200:
                # 输出请求的完整 URL 和状态码
                logger.error(f"Request failed. URL: {res.request.url}, Status Code: {res.status_code}")

                # 输出响应文本
                logger.error(f"Response Text: {res.text}")

                # 标记请求为失败
                res.failure(res.text)

    @task(2)
    def query_room_info(self):
        # 传递字典数据
        payload = {
            "appId": "4",
            "roomType": 2,
            "roomLevel": -1
        }

        path = "/room-assignment/query-room-info"
        logger.info(f"Request URL {path}")
        with self.client.post(path, json=payload, catch_response=True) as res:
            res: ResponseContextManager
            if res.status_code != 200:
                # 输出请求的完整 URL 和状态码
                logger.error(f"Request failed. URL: {res.request.url}, Status Code: {res.status_code}")

                # 输出响应文本
                logger.error(f"Response Text: {res.text}")

                # 标记请求为失败
                res.failure(res.text)

    def on_start(self):
        

    def on_stop(self):
        logger.info('goodbye')


class test(HttpUser):
    host = 'http://10.12.13.129:8008'
    tasks = [Task, ]


if __name__ == '__main__':
    run_single_user(test)

脚本说明：(详细使用请看官方文档)

• @task装饰该方法表示为用户行为，括号里面参数表示该行为的执行权重：数值越大，执行频率越高，不设置默认是1

四、启动

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

 locust -f testscript/locusttest.py --host=http://10.12.13.129:8008

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

五、结果分析、参数说明

1、启动界面

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

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

• Start swarming：执行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；