Locust参数说明

红太狼 2022-01-30 03:36 304阅读 0赞

因为之前jmeter压测，满足不了高并发压测，为了解决，探索使用locust进行压测，一下为locust的使用文档，使用并总结：

打开命令提示符（或Linux终端），输入 `locust --help` 。

> locust --help
    Usage: locust [options] [LocustClass [LocustClass2 ... ]]
    
    Options:
      -h, --help            show this help message and exit
      -H HOST, --host=HOST  Host to load test in the following format:
                            http://10.21.32.33
      --web-host=WEB_HOST   Host to bind the web interface to. Defaults to '' (all
                            interfaces)
      -P PORT, --port=PORT, --web-port=PORT
                            Port on which to run web host
      -f LOCUSTFILE, --locustfile=LOCUSTFILE
                            Python module file to import, e.g. '../other.py'.
                            Default: locustfile
      --csv=CSVFILEBASE, --csv-base-name=CSVFILEBASE
                            Store current request stats to files in CSV format.
      --master              Set locust to run in distributed mode with this
                            process as master
      --slave               Set locust to run in distributed mode with this
                            process as slave
      --master-host=MASTER_HOST
                            Host or IP address of locust master for distributed
                            load testing. Only used when running with --slave.
                            Defaults to 127.0.0.1.
      --master-port=MASTER_PORT
                            The port to connect to that is used by the locust
                            master for distributed load testing. Only used when
                            running with --slave. Defaults to 5557. Note that
                            slaves will also connect to the master node on this
                            port + 1.
      --master-bind-host=MASTER_BIND_HOST
                            Interfaces (hostname, ip) that locust master should
                            bind to. Only used when running with --master.
                            Defaults to * (all available interfaces).
      --master-bind-port=MASTER_BIND_PORT
                            Port that locust master should bind to. Only used when
                            running with --master. Defaults to 5557. Note that
                            Locust will also use this port + 1, so by default the
                            master node will bind to 5557 and 5558.
      --expect-slaves=EXPECT_SLAVES
                            How many slaves master should expect to connect before
                            starting the test (only when --no-web used).
      --no-web              Disable the web interface, and instead start running
                            the test immediately. Requires -c and -r to be
                            specified.
      -c NUM_CLIENTS, --clients=NUM_CLIENTS
                            Number of concurrent Locust users. Only used together
                            with --no-web
      -r HATCH_RATE, --hatch-rate=HATCH_RATE
                            The rate per second in which clients are spawned. Only
                            used together with --no-web
      -t RUN_TIME, --run-time=RUN_TIME
                            Stop after the specified amount of time, e.g. (300s,
                            20m, 3h, 1h30m, etc.). Only used together with --no-
                            web
      -L LOGLEVEL, --loglevel=LOGLEVEL
                            Choose between DEBUG/INFO/WARNING/ERROR/CRITICAL.
                            Default is INFO.
      --logfile=LOGFILE     Path to log file. If not set, log will go to
                            stdout/stderr
      --print-stats         Print stats in the console
      --only-summary        Only print the summary stats
      --no-reset-stats      Do not reset statistics once hatching has been
                            completed
      -l, --list            Show list of possible locust classes and exit
      --show-task-ratio     print table of the locust classes' task execution
                            ratio
      --show-task-ratio-json
                            print json data of the locust classes' task execution
                            ratio
      -V, --version         show program's version number and exit

**参数说明：**

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-h, --help</td> 
   <td>查看帮助</td> 
  </tr> 
  <tr> 
   <td>-H HOST, --host=HOST</td> 
   <td>指定被测试的主机，采用以格式：<a href="http://10.21.32.33/" rel="nofollow">http://10.21.32.33</a></td> 
  </tr> 
  <tr> 
   <td>--web-host=WEB_HOST</td> 
   <td>指定运行 Locust Web 页面的主机，默认为空 ''。</td> 
  </tr> 
  <tr> 
   <td>-P PORT, --port=PORT, --web-port=PORT</td> 
   <td>指定 --web-host 的端口，默认是8089</td> 
  </tr> 
  <tr> 
   <td>-f LOCUSTFILE, --locustfile=LOCUSTFILE</td> 
   <td>指定运行 Locust 性能测试文件，默认为: locustfile.py</td> 
  </tr> 
  <tr> 
   <td>--csv=CSVFILEBASE, --csv-base-name=CSVFILEBASE</td> 
   <td>以CSV格式存储当前请求测试数据。</td> 
  </tr> 
  <tr> 
   <td>--master</td> 
   <td>Locust 分布式模式使用，当前节点为 master 节点。</td> 
  </tr> 
  <tr> 
   <td>--slave</td> 
   <td>Locust 分布式模式使用，当前节点为 slave 节点。</td> 
  </tr> 
  <tr> 
   <td>--master-host=MASTER_HOST</td> 
   <td>分布式模式运行，设置 master 节点的主机或 IP 地址，只在与 --slave 节点一起运行时使用，默认为：127.0.0.1.</td> 
  </tr> 
  <tr> 
   <td>--master-port=MASTER_PORT</td> 
   <td>分布式模式运行， 设置 master 节点的端口号，只在与 --slave 节点一起运行时使用，默认为：5557。注意，slave 节点也将连接到这个端口+1 上的 master 节点。</td> 
  </tr> 
  <tr> 
   <td>--master-bind-host=MASTER_BIND_HOST</td> 
   <td>Interfaces (hostname, ip) that locust master should bind to. Only used when running with --master. Defaults to * (all available interfaces).</td> 
  </tr> 
  <tr> 
   <td>--master-bind-port=MASTER_BIND_PORT</td> 
   <td>Port that locust master should bind to. Only used when running with --master. Defaults to 5557. Note that Locust will also use this port + 1, so by default the master node will bind to 5557 and 5558.</td> 
  </tr> 
  <tr> 
   <td>--expect-slaves=EXPECT_SLAVES</td> 
   <td>How many slaves master should expect to connect before starting the test (only when --no-web used).</td> 
  </tr> 
  <tr> 
   <td>--no-web</td> 
   <td>no-web 模式运行测试，需要 -c 和 -r 配合使用.</td> 
  </tr> 
  <tr> 
   <td>-c NUM_CLIENTS, --clients=NUM_CLIENTS</td> 
   <td>指定并发用户数，作用于&nbsp;<strong>--no-web</strong>&nbsp;模式。</td> 
  </tr> 
  <tr> 
   <td>-r HATCH_RATE, --hatch-rate=HATCH_RATE</td> 
   <td>指定每秒启动的用户数，作用于&nbsp;<strong>--no-web</strong>&nbsp;模式。</td> 
  </tr> 
  <tr> 
   <td>-t RUN_TIME, --run-time=RUN_TIME</td> 
   <td>设置运行时间, 例如： (300s, 20m, 3h, 1h30m). 作用于&nbsp;<strong>--no-web</strong>&nbsp;模式。</td> 
  </tr> 
  <tr> 
   <td>-L LOGLEVEL, --loglevel=LOGLEVEL</td> 
   <td>选择 log 级别（DEBUG/INFO/WARNING/ERROR/CRITICAL）. 默认是 INFO.</td> 
  </tr> 
  <tr> 
   <td>--logfile=LOGFILE</td> 
   <td>日志文件路径。如果没有设置，日志将去 stdout/stderr</td> 
  </tr> 
  <tr> 
   <td>--print-stats</td> 
   <td>在控制台中打印数据</td> 
  </tr> 
  <tr> 
   <td>--only-summary</td> 
   <td>只打印摘要统计</td> 
  </tr> 
  <tr> 
   <td>--no-reset-stats</td> 
   <td>Do not reset statistics once hatching has been completed。</td> 
  </tr> 
  <tr> 
   <td>-l, --list</td> 
   <td>显示测试类, 配置 -f 参数使用</td> 
  </tr> 
  <tr> 
   <td>--show-task-ratio</td> 
   <td>打印 locust 测试类的任务执行比例，配合 -f 参数使用.</td> 
  </tr> 
  <tr> 
   <td>--show-task-ratio-json</td> 
   <td>以 json 格式打印 locust 测试类的任务执行比例，配合 -f 参数使用.</td> 
  </tr> 
  <tr> 
   <td>-V, --version</td> 
   <td>查看当前 Locust 工具的版本.</td> 
  </tr> 
 </tbody> 
</table>