官方文档
https://docs.locust.io/en/latest/writing-a-locustfile.html
2018-07-24

An open source load testing tool

screenshot.png

使用Python代码定义用户行为，并使用数百万个并发用户来支持您的系统!

Locust是一款易于使用的分布式用户负载测试工具。
它用于对网站（或其他系统）进行负载测试，并确定系统可以处理多少并发用户.
在测试期间，一群Locust会攻击你的网站。

您定义了每个Locust（或测试用户，如果您愿意）的行为，并且实时地从Web UI监视群集过程。
这将有助于您在让真正的用户进入之前进行测试并识别代码中的瓶颈.

Locust完全基于事件，因此可以在一台计算机上支持数千个并发用户。
与许多其他基于事件的应用程序相比，它不使用回调。
相反，它通过[gevent]使用轻量级过程。

每个Locust蜂拥到你的网站实际上是在自己的进程内运行（或者是greenlet，这是正确的）。
这允许您在Python中编写非常富有表现力的场景，而不会使代码复杂化。

用普通的Python编写用户测试场景
分布式和可扩展 - 支持数十万用户
基于Web的UI

Locust有一个简洁的HTML + JS用户界面，可以实时显示相关的测试细节。
由于用户界面是基于网络的，因此它具有跨平台且易于扩展的特点
可以测试任何系统
容易被破解

安装

Locust在PyPI上可用，可以通过pip或easy_install安装

pip install locustio

安装Locust时，你的shell中应该有一个locust命令
要查看可用选项，请运行：

$ locust --help

支持的Python版本

Locust支持Python 2.7,3.4,3.5和3.6

在Windows上安装

在Windows上，运行应该工作。pip install locustio
但是，如果没有，可以通过首先为pyzmq，gevent和greenlet安装预先构建的二进制包来修复它。

你可以在这里找到一个非官方的预制python包集合：http： //www.lfd.uci.edu/~gohlke/pythonlibs/
下载预建.whl文件后，可以使用以下命令安装：

$ pip install name-of-file.whl
一旦你完成了，你应该能够做到。pip install locustio

在Windows上运行Locust应该可以很好地开发和测试负载测试脚本。
但是，在运行大规模测试时，建议您在Linux机器上执行此操作，因为gevent在Windows下的性能很差

增加最大打开文件数限制

计算机上的每个HTTP连接都会打开一个新文件（从技术上讲是一个文件描述符）。操作系统可以为可以打开的最大文件数设置下限。如果限制小于测试中的模拟用户数，则会发生故障。

将操作系统的默认最大文件数限制增加到高于您要运行的模拟用户数的数量。如何执行此操作取决于使用的操作系统

快速启动

实施例locustfile.py

下面是一个简单的locustfile.py的简单示例：

from locust import HttpLocust, TaskSet

def login(l):
    l.client.post("/login", {"username":"ellen_key", "password":"education"})

def logout(l):
    l.client.post("/logout", {"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)

    def on_stop(self):
        logout(self)

class WebsiteUser(HttpLocust):
    task_set = UserBehavior
    min_wait = 5000
    max_wait = 9000

这里我们定义了许多Locust任务，它们是带有一个参数（Locust类实例）的普通Python callables 。
这些任务收集在tasks属性的TaskSet类下。
然后我们有一个代表用户的类，
我们在其中定义模拟用户在执行任务之间应该等待多长时间，以及哪个类应该定义用户的“行为”。
类可以嵌套。HttpLocust TaskSet TaskSet.

HttpLocust类从继承 Locust的类，并给它添加一个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 on_stop(self):
        """ on_stop is called when the TaskSet is stopping """
        self.logout()

    def login(self):
        self.client.post("/login", {"username":"ellen_key", "password":"education"})

    def logout(self):
        self.client.post("/logout", {"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

The Locust class (as well as HttpLocust since it’s a subclass) also allows one to specify minimum and maximum wait time in milliseconds—per simulated user—between the execution of tasks (min_wait and max_wait) as well as other user behaviours.
By default the time is randomly chosen uniformly between min_wait and max_wait, but any user-defined time distributions can be used by setting wait_function to any arbitrary function.
For example, for an exponentially distributed wait time with average of 1 second:

在Locust类（以及HttpLocust 因为它是一个子类），也可以让一个在指定最小和最大等待时间毫秒，每个模拟用户之间的任务执行（min_wait和MAX_WAIT）以及其他用户的行为。
默认情况下，时间是在min_wait和max_wait之间统一随机选择的，但是可以通过将wait_function设置为任意函数来使用任何用户定义的时间分布。
例如，对于指数分布的等待时间平均为1秒：

import random
class WebsiteUser(HttpLocust):
    task_set = UserBehaviour
    wait_function = lambda self: random.expovariate(1)*1000

启动Locust

要使用上面的Locust文件运行Locust，如果它名为locustfile.py并位于当前工作目录中，我们可以运行：

locust --host=http://example.com

如果Locust文件位于子目录下和/或名称不同于locustfile.py，请使用-f以下命令指定：

locust -f locust_files/my_locust_file.py --host=http://example.com

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

locust -f locust_files/my_locust_file.py --master --host=http://example.com

然后我们将启动任意数量的从属进程：

locust -f locust_files/my_locust_file.py --slave --host=http://example.com

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

locust -f locust_files/my_locust_file.py --slave --master-host=192.168.0.100 --host=http://example.com

要查看所有可用选项类型： locust --help

打开Locust的Web界面

使用上述命令行之一启动Locust后，应打开浏览器并将其指向http://127.0.0.1:8089（如果您在本地运行Locust）。那么你应该受到这样的欢迎：

Test png

locust开源负载测试工具001