Locust分布式负载测试工具入门
Locust简介
Locust是一个简单易用的分布式负载测试工具,主要用来对网站进行负载压力测试。
以下是github上的仓库地址
https://github.com/yileye/locust
官网地址:
Locust特性
- 使用Python编写模拟用户行为的代码,无需繁琐的配置
- 分布式可扩展,能够支持上百万用户
- 自带Web界面
- 不仅能测试web系统,也可以测试其它系统
Locust思想
在测试过程中,一群用户将访问你的网站。每个用户的行为由你编写的Python代码定义,同时可以从Web界面中实时观察到用户的行为。
Locust完全是事件驱动的,因此在单台机器上能够支持几千并发用户访问。与其它许多基于事件的应用相比,Locust并不使用回调,而是使用gevent,而gevent是基于协程的,可以用同步的方式来编写异步执行的代码。每个用户实际上运行在自己的greenlet中。
Locust安装
Locust可以通过pip或者easy_install安装:
pip install locustio 或者 easy_install locustio
安装完Locust后,shell命令locust就可以使用了,可以查看locust命令有哪些选项:
locust --help
如果打算以分布式模式运行Locust,建议同时安装pyzmq:
pip install pyzmq 或者 easy_install pyzmq
Locust初步使用
概念理解(翻译):
1. 超级类是 locust 类,它的每一个实例代表了一个用户, 守护程序会为每一个模拟用户生成一个实例
2. httplocust 继承了locust 类, 添加了可以发送http请求的功能
3. locust 有一个属性(成员变量)是 task_set , 它可以定义用户的行为, 就是访问哪些URL, post还是get, 每个连接占总访问量比是多少
这个task_set 是类TaskSet(或其子类)的一个实例, 上边说的各种行为就是在这个类里边定义的
4. locsut类:
属性: min_wait/max_wait 模拟用户有在上边说的类中定义了好多任务/行为, 每个任务/行为间隔多久执行一次, 单位是毫秒, 默认1000, 也即隔一秒种后执行下一个任务
属性: weight 权重: 模拟时, 同一段时间, 手机用户的访问量要比PC的访问量大, 那么对应的locust(或其子类)的weight值就大小不一
属性: host 就是需要被压测的网站的域名(或域名前缀), 如果启动服务时没有通过参数-host来指定域名, 那么就用使用该host属性指定的值
TaskSet类:
1. 推荐的是, 在taskset类(或子类)中通过在行为(回调函数)前加@task(weight)描述符来指定某一个行为被执行的频率
2. 或者先定义行为(回调函数), 然后通过属性tasks来指定每一个行为被执行的频率 tasks=[fun1, fun2....] 或者 tasks={fun1:weight1, fun2:weight2......}
3. 不管怎样定义, 里边的行为或函数是被随机调用/执行的, 只是根据weight的不通, 随机到的频率不通而已
4. 而且, 行为/任务可以嵌套执行, 先执行task1(也就是 fun1 下同), 然后执行task2 ..... 这样会更真实的模拟,
其写法就是, 将这些有关联任务定义/封装到一个taskset子类中, 然后通过上边介绍的 tasks属性tasks={classname:weight}, 在另一个TaskSet子类中去关联该类以达到嵌套的目的
5. 在执行子任务时, 通过 self.interrupt() 来终止子任务的执行, 来回到父任务类中执行, 否则子任务会一直执行
6. 成员函数, on_start(), 如果定义的话, 就会在开始的时候执行
HttpLocust类
1. 他可以发送http请求, 他有一个属性叫client(实例化的时候自动生成), 存储HttpSession类的实例(HttpSession类在实例化Locust的时候自动创建), 用来保存请求session
2. TaskSet类里也有属性client: self.client.get()或者self.client.post(), 这个client内部就是httplocust里的client
3. 请求返回一个对象, 他有两个成员, response.status_code 和 response.content
4. 如果因连接失败, 超时等等原因造成请求失败, 不会发出异常, 而是将上边的content置为空, status_code 置为0
5. 可以对返回content内容自定义处理, 因为有的时候返回404是你希望得到的
1 with client.get("/does_not_exist/", catch_response=True) as response: 2 if response.status_code == 404: 3 response.success()
6.对网站来说, 一个URL的参数是固定的, 但是参数值是不定的, 也可以处理
1 # Statistics for these requests will be grouped under: /blog/?id=[id] 2 for i in range(10): 3 client.get("/blog?id=%i" % i, name="/blog?id=[id]")
其他, locust还有很多事件hook可以扩展开发, 有需要的可以去看官方文档, 内容没多少
locustfile.py例子
下面是一个简单的locustfile.py文件。
from locust import HttpLocust, TaskSet def login(l): l.client.post("/login", {"username":"ellen_key", "password":"education"}) def index(l): l.client.get("/") def profile(l): l.client.get("/profile") class UserBehavior(TaskSet): tasks = {index:2, profile:1} def on_start(self): login(self) class WebsiteUser(HttpLocust): task_set = UserBehavior min_wait=5000 max_wait=9000
在上面的代码中,定义了一些locust任务,这些任务是用Python函数定义的。这些函数传入一个参数,也就是Locust类的实例。这些任务然后被聚集在TaskSet类的tasks属性中,用来表示一个用户访问网站的行为。接着,HttpLocust类表示一个用户,这个用户具有哪些行为,以及该用户在执行下一个任务之前应该等待多长时间。
HttpLocust类继承于Locust类,它增加了一个client属性,这个client实际上是HttpSession实例,可以用来发起HTTP请求。
上面的代码示例了一种定义任务的方式,下面是一种更方便的方式,该方式使用了task装饰器。
from locust import HttpLocust, TaskSet, task class UserBehavior(TaskSet): def on_start(self): """ on_start is called when a Locust start before any task is scheduled """ self.login() def login(self): self.client.post("/login", {"username":"ellen_key", "password":"education"}) @task(2) def index(self): self.client.get("/") @task(1) def profile(self): self.client.get("/profile") class WebsiteUser(HttpLocust): task_set = UserBehavior min_wait=5000 max_wait=9000
启动Locust
在shell中执行locust命令即可启动Locust。如果locustfile.py文件在当前目录,那么直接执行locust命令即可。如果locustfile.py文件在别的地方,可以执行
locust -f /path/to/locustfile.py
至于如何在分布式模式下运行Locust,请参考Running Locust distributed
打开Web界面
在shell中执行locust命令,如果没有问题的话,命令输出会提示可以在浏览器中打开Locust的Web界面,访问地址默认是http://127.0.0.1:8089。在浏览器中打开该地址,就可以看到像下面这样的Web界面:对于喜欢使用轻量级性能工具的同学,可以考虑学习一下。而且也可以导出类似Jmeter一样的聚合报告