locust官方文档-所有可用的配置选项

本文档详细介绍了Locust的所有可用配置选项,包括环境变量和配置文件中的键值,帮助开发者更好地理解和使用 Locust 进行性能测试。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

下面是所有可用配置选项的表,以及它们对应的环境和配置文件键:

命令行环境配置文件描述
-f, --locustfileLOCUST_LOCUSTFILElocustfile要导入的Python模块,例如’ …/other_test.py '。a.py文件或一个包目录。默认为“locustfile”
-H, --hostLOCUST_HOSThost主机加载测试的格式如下:http://10.21.32.33
-u, --usersLOCUST_USERSusersLocust并发用户数的峰值。主要与-headless或-autostart一起使用。可以在测试期间通过键盘输入w, W(生成1,10个用户)和s,S(停止1,10个用户)进行更改
-r, --spawn-rateLOCUST_SPAWN_RATEspawn-rate生成用户的速率(每秒用户)。主要与-headless或-autostart一起使用
–hatch-rateLOCUST_HATCH_RATEhatch-rate阻止(进程或活动)
-t, --run-timeLOCUST_RUN_TIMErun-time在规定的时间后停止,如(300s、20m、3h、1h30m等)。只能与-headless或-autostart一起使用。默认永远运行。
–web-hostLOCUST_WEB_HOSTweb-hostweb界面绑定的主机。默认为’ * '(所有接口)
–web-port, -PLOCUST_WEB_PORTweb-port运行web主机的端口
–headlessLOCUST_HEADLESSheadless关闭web界面,立即开始测试。使用-u和-t控制用户数量和运行时间
–autostartLOCUST_AUTOSTARTautostart立即启动测试(不禁用web界面)。使用-u和-t控制用户数量和运行时间
–autoquitLOCUST_AUTOQUITautoquit在运行结束X秒后完全退出Locust只能与-autostart一起使用。默认值是保持Locust运行,直到使用CTRL+C关闭它
–headfulLOCUST_HEADFULheadfulSUPPRESS
–web-authLOCUST_WEB_AUTHweb-auth打开web界面的基本认证。应以以下格式提供:用户名:密码
–tls-certLOCUST_TLS_CERTtls-cert可选用于HTTPS服务的TLS证书路径
–tls-keyLOCUST_TLS_KEYtls-key可选TLS私钥路径,用于HTTPS服务
–masterLOCUST_MODE_MASTERmaster将locust设置为以分布式模式运行,该进程作为主进程
–master-bind-hostLOCUST_MASTER_BIND_HOSTmaster-bind-hostlocust主机应该绑定到的接口(主机名,ip)。仅在使用-master运行时使用。默认为*(所有可用接口)。
–master-bind-portLOCUST_MASTER_BIND_PORTmaster-bind-portlocust主机应该绑定到的端口。仅在使用-master运行时使用。默认为5557。
–expect-workersLOCUST_EXPECT_WORKERSexpect-workers在开始测试之前,master应该期望连接多少worker(仅在使用-headless /autostart时)。
–expect-workers-max-waitLOCUST_EXPECT_WORKERS_MAX_WAITexpect-workers-max-waitmaster应该等workers连接多久才放弃。默认永远等待
–workerLOCUST_MODE_WORKERworker1将locust设置为以分布式模式运行,并将此进程设置为辅助进程
–master-hostLOCUST_MASTER_NODE_HOSTmaster-host用于分布式负载测试的locust主机或IP地址。仅在与-worker一起运行时使用。默认为127.0.0.1。进入翻译页面
–master-portLOCUST_MASTER_NODE_PORTmaster-port要连接到它的端口被蝗虫主机用于分布式负载测试。仅在与-worker一起运行时使用。默认为5557。
-T, --tagsLOCUST_TAGStags要包含在测试中的标记列表,因此只有具有任何匹配标记的任务才会被执行
-E, --exclude-tagsLOCUST_EXCLUDE_TAGSexclude-tags要从测试中排除的标记列表,因此只执行没有匹配标记的任务
–csvLOCUST_CSVcsv以CSV格式存储当前请求统计信息到文件中。设置此选项将生成三个文件:[CSV_PREFIX]_stats.csv, [CSV_PREFIX]_stats_history.csv和[CSV_PREFIX] _fails .csv
–csv-full-historyLOCUST_CSV_FULL_HISTORYcsv-full-history将每个统计条目以CSV格式存储到_stats_history.csv文件中。你还必须指定’ -csv '参数来启用它。
–print-statsLOCUST_PRINT_STATSprint-stats在控制台中打印数据
–only-summaryLOCUST_ONLY_SUMMARYonly-summary只打印汇总数据
–reset-statsLOCUST_RESET_STATSreset-stats刷出完成后重置统计信息。在分布式模式下运行时,是否应该同时设置在主节点和工作节点上
–htmlLOCUST_HTMLhtml存储HTML报告到指定的文件路径
–skip-log-setupLOCUST_SKIP_LOG_SETUPskip-log-setup禁用Locust的日志记录设置。相反,该配置由Locust测试或Python默认值提供。
–loglevel, -LLOCUST_LOGLEVELloglevel可选择 DEBUG/INFO/WARNING/ERROR/CRITICAL. 默认 INFO.
–logfileLOCUST_LOGFILElogfile日志文件的路径。如果没有设置,log将转到stderr
–exit-code-on-errorLOCUST_EXIT_CODE_ON_ERRORexit-code-on-error设置在测试结果包含任何失败或错误时使用的进程退出代码
-s, --stop-timeoutLOCUST_STOP_TIMEOUTstop-timeout在退出前等待模拟用户完成任何正在执行的任务的秒数。默认是立即终止。该参数只在运行Locust分布式时需要为主进程指定。
### Python Locust 性能测试框架的功能介绍 Locust 是一种用于性能测试的开源工具,支持通过编写 Python 脚本来模拟大量用户的并发行为。它的主要功能包括但不限于以下几个方面: - **分布式架构**:Locust 可以轻松扩展到多个机器上运行,从而实现大规模的负载测试[^1]。 - **灵活的用户行为定义**:开发者可以通过自定义脚本的方式指定每个虚拟用户的具体操作逻辑,这使得测试更加贴近真实场景[^2]。 - **实时监控能力**:内置了一个简单的 Web UI,允许用户查看当前的压力测试状态以及各项指标数据的变化趋势[^3]。 #### 安装方法 为了开始使用 Locust 进行性能测试,首先需要将其安装至本地环境当中。通常情况下,推荐利用 pip 工具完成这一过程: ```bash pip install locust ``` 如果遇到任何依赖项缺失或者版本冲突等问题,则可能还需要额外调整项目配置文件或是升级相关库来解决问题[^4]。 --- ### 基础用法示例 下面提供了一段基础代码片段作为入门指南,展示了如何创建一个基本的任务类并启动服务端口监听请求流量的情况: ```python from locust import HttpUser, task, between class WebsiteTest(HttpUser): wait_time = between(1, 5) @task def index_page(self): self.client.get("/") @task def about_page(self): self.client.get("/about") ``` 上述例子中定义了两个不同的页面访问动作,并设置了随机等待时间范围以便更接近实际用户体验效果。 当准备好相应的测试计划之后,就可以通过命令行界面激活服务器实例了: ```bash locust -f your_script_name.py --host=http://example.com ``` 此时打开浏览器输入地址 `http://localhost:8089` 即可进入图形化管理面板进一步设置参数选项比如总人数、孵化速率等等。 --- ### 高级特性概览 除了以上提到的基础功能之外,Locust 还具备许多高级特性和插件支持,能够满足更为复杂的应用需求: - **多种协议支持**: 不仅限于 HTTP 请求,还兼容 WebSocket 和其他类型的通信方式. - **动态数据注入**: 方便引入外部资源如数据库查询结果或 CSV 文件记录等内容参与仿真流程. - **报告导出功能**: 自动生成详尽的结果分析文档供后续优化参考. ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值