Command line |
Environment |
Config file |
Description |
|
|
|
Python module file to import, e.g. ‘../other.py’. Default: locustfile |
|
|
|
Host to load test in the following format: http://10.21.32.33 |
|
|
|
Number of concurrent Locust users. Primarily used together with –headless. Can be changed during a test by inputs w, W(spawn 1, 10 users) and s, S(stop 1, 10 users) |
|
|
|
The rate per second in which users are spawned. Primarily used together with –headless |
|
|
|
==SUPPRESS== |
|
|
|
Stop after the specified amount of time, e.g. (300s, 20m, 3h, 1h30m, etc.). Only used together with –headless. Defaults to run forever. |
|
|
|
Host to bind the web interface to. Defaults to ‘*’ (all interfaces) |
|
|
|
Port on which to run web host |
|
|
|
Disable the web interface, and instead start the load test immediately. Requires -u and -t to be specified. |
|
|
|
==SUPPRESS== |
|
|
|
Turn on Basic Auth for the web interface. Should be supplied in the following format: username:password |
|
|
|
Optional path to TLS certificate to use to serve over HTTPS |
|
|
|
Optional path to TLS private key to use to serve over HTTPS |
|
|
|
Set locust to run in distributed mode with this process as master |
|
|
|
Interfaces (hostname, ip) that locust master should bind to. Only used when running with –master. Defaults to * (all available interfaces). |
|
|
|
Port that locust master should bind to. Only used when running with –master. Defaults to 5557. |
|
|
|
How many workers master should expect to connect before starting the test (only when –headless used). |
|
|
|
Set locust to run in distributed mode with this process as worker |
|
|
|
Host or IP address of locust master for distributed load testing. Only used when running with –worker. Defaults to 127.0.0.1. |
|
|
|
The port to connect to that is used by the locust master for distributed load testing. Only used when running with –worker. Defaults to 5557. |
|
|
|
List of tags to include in the test, so only tasks with any matching tags will be executed |
|
|
|
List of tags to exclude from the test, so only tasks with no matching tags will be executed |
|
|
|
Store current request stats to files in CSV format. Setting this option will generate three files: [CSV_PREFIX]_stats.csv, [CSV_PREFIX]_stats_history.csv and [CSV_PREFIX]_failures.csv |
|
|
|
Store each stats entry in CSV format to _stats_history.csv file. You must also specify the ‘–csv’ argument to enable this. |
|
|
|
Print stats in the console |
|
|
|
Only print the summary stats |
|
|
|
Reset statistics once spawning has been completed. Should be set on both master and workers when running in distributed mode |
|
|
|
Store HTML report file |
|
|
|
Disable Locust’s logging setup. Instead, the configuration is provided by the Locust test or Python defaults. |
|
|
|
Choose between DEBUG/INFO/WARNING/ERROR/CRITICAL. Default is INFO. |
|
|
|
Path to log file. If not set, log will go to stdout/stderr |
|
|
|
Sets the process exit code to use when a test result contain any failure or error |
|
|
|
Number of seconds to wait for a simulated user to complete any executing task before exiting. Default is to terminate immediately. This parameter only needs to be specified for the master process when running Locust distributed. |