Locust以库模式运行时无法触发事件的问题求助

问题原因 #

Locust的test_start、init这类生命周期事件，是由官方工具模式（locust命令）的核心运行逻辑自动触发的。当你用库模式手动编写代码启动Locust时，默认不会走完整的测试启动流程——既不会自动初始化事件触发的钩子，也不会在测试开始时主动调用test_start事件的触发方法，所以你的监听器代码不会执行。

而工具模式下，locust命令会帮你完成从环境初始化、Runner创建到测试生命周期事件触发的全流程，所以监听器能正常打印信息。

解决办法 #

在库模式代码中，手动触发对应的生命周期事件即可，以下是完整的示例代码：

from locust import events, HttpUser, task
from locust.env import Environment
import time

# 定义事件监听器
@events.test_start.add_listener
def on_test_start(environment, **kwargs):
    print("Test started! (from test_start listener)")

@events.init.add_listener
def on_init(environment, **kwargs):
    print("Environment initialized! (from init listener)")

class MyTestUser(HttpUser):
    @task
    def visit_homepage(self):
        self.client.get("/")

if __name__ == "__main__":
    # 1. 创建Locust环境实例
    env = Environment(user_classes=[MyTestUser])
    
    # 2. 手动触发init事件
    events.init.fire(environment=env)
    
    # 3. 创建本地Runner并启动用户
    runner = env.create_local_runner()
    runner.start(user_count=1, spawn_rate=1)
    
    # 4. 手动触发test_start事件
    events.test_start.fire(environment=env)
    
    # 让测试运行10秒（模拟工具模式的-t参数）
    time.sleep(10)
    
    # 停止测试并触发test_stop事件（可选）
    runner.stop()
    events.test_stop.fire(environment=env)

关键步骤说明 #

• 手动调用events.xxx.fire(environment=env)方法，其中xxx对应你监听的事件名（init/test_start/test_stop等）
• 必须传入environment参数，因为监听器函数需要接收该参数
• 如果需要模拟工具模式的完整流程，记得在测试结束时触发test_stop事件

内容的提问来源于stack exchange，提问作者mCY