locustio/locust

Locust

Locust是一个易于使用、可编写脚本且可扩展的性能测试工具。用户通过常规Python代码定义用户行为，而非使用笨重的UI或特定领域语言，这使得Locust具有无限扩展性且对开发人员非常友好。

核心功能

用Python编写用户测试场景

如需让用户执行循环、条件行为或计算，只需使用Python提供的常规编程结构。Locust在独立的greenlet（轻量级进程/协程）中运行每个用户，允许以普通（阻塞）Python代码编写测试，无需使用回调或其他机制。由于测试场景是“纯Python代码”，可使用常规IDE，并通过版本控制管理（不同于使用XML或二进制格式的工具）。

python
from locust import HttpUser, task, between

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

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

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

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

分布式与可扩展性 - 支持数十万用户

Locust便于在多台机器上分布式运行负载测试。它基于事件驱动（使用gevent），单个进程可处理数千并发用户。虽然可能有其他工具在特定硬件上能处理更多请求/秒，但Locust用户的低开销使其非常适合测试高并发工作负载。

基于Web的UI

Locust提供友好的Web界面，实时显示测试进度，甚至可在测试运行时调整负载。也可无UI运行，便于CI/CD测试。

可测试任何系统

尽管Locust主要用于网站/服务测试，但可用于测试几乎任何系统或协议。只需编写自定义客户端，或使用https://github.com/SvenskaSpel/locust-plugins#users%E3%80%82

高度可定制

Locust体积小且非常灵活。如需将报告数据发送到指定数据库和图形系统、包装REST API调用以处理系统特定需求，或运行完全自定义的负载模式，均可轻松实现。

使用场景与适用范围

• 开发人员性能测试：适合熟悉Python的团队，通过代码定义测试逻辑，便于版本控制和集成到开发流程
• 高并发场景测试：支持数十万并发用户，适合验证系统在峰值负载下的稳定性
• CI/CD集成：支持无UI运行，可集成到持续集成/部署流程中实现自动化性能测试
• 多协议测试：通过自定义客户端，可测试HTTP、TCP、数据库等多种系统和协议

使用方法与配置说明

Docker快速部署

基本运行命令

bash
docker run -p 8089:8089 -v $PWD:/locust locustio/locust -f /locust/locustfile.py

• -p 8089:8089：映射Web UI端口
• -v $PWD:/locust：挂载本地目录到容器内，便于加载测试文件
• -f /locust/locustfile.py：指定测试脚本路径

分布式模式（主从架构）

主节点（负责协调和Web UI）：

bash
docker run -p 8089:8089 -v $PWD:/locust locustio/locust -f /locust/locustfile.py --master

从节点（负责生成负载，可多节点部署）：

bash
docker run -v $PWD:/locust locustio/locust -f /locust/locustfile.py --worker --master-host=<主节点IP>

Docker Compose配置示例

yaml
version: '3'

services:
  master:
    image: locustio/locust
    ports:
      - "8089:8089"
    volumes:
      - ./:/locust
    command: -f /locust/locustfile.py --master

  worker:
    image: locustio/locust
    volumes:
      - ./:/locust
    command: -f /locust/locustfile.py --worker --master-host=master
    depends_on:
      - master
    deploy:
      replicas: 3  # 启动3个从节点

测试脚本编写要点

1. 创建locustfile.py，定义继承HttpUser的测试类
2. 使用@task装饰器标记用户行为，可通过参数设置任务权重（如@task(3)表示权重为3）
3. wait_time定义任务间等待时间，支持固定值或随机范围（如between(1, 2)表示1-2秒）
4. on_start方法在用户开始时执行（如登录操作）

相关链接

• 官方网站：locust.io
• 文档：docs.locust.io
• 代码/问题：https://github.com/locustio/locust
• 支持/问答：StackOverflow
• 社区讨论：Slack注册

作者

• Carl Bystr（***：@cgbystrom）
• Jonatan Heyman（***：@jonatanheyman）
• https://github.com/Jahaja%EF%BC%88***%EF%BC%9A@Jahaaja%EF%BC%89
• https://github.com/HeyHugo%EF%BC%88***%EF%BC%9A@hugoheyman%EF%BC%89
• https://github.com/cyberw

许可证

开源，基于MIT许可证（详见LICENSE文件）。