Skip to content

Welcome

aiolocust

Usage:

aiolocust [OPTIONS] [filename]

Options:

  filename                The test to run  [env var: LOCUST_FILENAME; default:
                          locustfile.py]
  -u, --users <int>       Number of concurrent VUs (peak)  [env var:
                          LOCUST_USERS; default: 1]
  -d, --duration <int>    Time to run the test (seconds)  [env var:
                          LOCUST_DURATION]
  -r, --rate <float>      Number of users to spawn (per second)  [env var:
                          LOCUST_RATE]
  -i, --iterations <int>  Max total number of iterations to run  [env var:
                          LOCUST_ITERATIONS]
  -H, --host <str>        Base URL to target  [env var: LOCUST_HOST]
  --instrument            Capture aiohttp traces and metrics using
                          AioHttpClientInstrumentor().instrument()  [env var:
                          LOCUST_INSTRUMENT]
  -l, --log-level TEXT    Set the logging level (debug, info, warning, error)
                          [env var: LOCUST_LOG_LEVEL]
  --config JSON           JSON string or path to JSON file, e.g.

                          {"stages":[{"duration":10,"target":10},{"duration":5
                          ,"target":0}]}  [env var: LOCUST_CONFIG]
  --event-loops <int>     Set the number of aio event loops  [env var:
                          LOCUST_EVENT_LOOPS]
  --html-report <path>    Write the final summary as a static HTML report
                          [env var: LOCUST_HTML_REPORT]
  --json-report <path>    Write the final summary as a JSON file  [env var:
                          LOCUST_JSON_REPORT]
  --profile <str>         A description of the test run to include in otel
                          resource attributes,

                          to differentiate between runs with the same file
                          name  [env var: LOCUST_PROFILE]
  --version               Show the version and exit.
  --help                  Show this message and exit.

For a proper intro, see the README