Skip to content

Commit

Permalink
userclass-picker: updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mikenester committed Aug 7, 2022
1 parent 89ffc60 commit 6d39a50
Showing 1 changed file with 42 additions and 4 deletions.
46 changes: 42 additions & 4 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,11 +86,49 @@ Using the Locust web UI is entirely optional. You can supply the load parameters
See :ref:`running-without-web-ui` for more details.

Running Locust with UserClass UI Picker

Using multiple Locustfiles at once
==================================

The ``-f/--locustfile`` option accepts a single directory of locustfiles as an option. Locust will recursively
search the directory for ``*.py`` files, ignoring files named ``locust.py`` or those that start with "_".

Example:

With the following file structure:

.. code-block::
β”œβ”€β”€ locustfiles/
β”‚ β”œβ”€β”€ locustfile1.py
β”‚ β”œβ”€β”€ locustfile2.py
β”‚ └── more_files/
β”‚ β”œβ”€β”€ locustfile3.py
β”‚ β”œβ”€β”€ locust.py
β”‚ β”œβ”€β”€ _ignoreme.py
.. code-block:: console
$ locust -f locustfiles
Locust will use ``locustfile1.py``, ``locustfile2.py`` & ``more_files/locustfile3.py``

Additionally, ``-f/--locustfile`` accepts multiple locustfiles.

Example:

.. code-block:: console
$ locust -f locustfiles/locustfile1.py locustfiles/locustfile2.py locustfiles/more_files/locustfile3.py
Locust will use ``locustfile1.py``, ``locustfile2.py`` & ``more_files/locustfile3.py``


Running Locust with User class UI picker
=======================================

The ``-f/--locustfile`` command line parameter accepts multiple Locustfiles, as well as a single directory of Locustfiles. In doing so,
the WebUI will display UserClass and ShapeClass selections, which allow you to pick from any UserClass or ShapeClass from the Locustfiles.
You can select which Shape class and which User classes to run in the WebUI when running locust with the ``--enable-userclass-picker`` flag.
No selection uses all of the available User classes.

Example:

Expand All @@ -114,7 +152,7 @@ With the following file structure:
.. code-block:: console
$ locust -f locustfiles
$ locust -f locustfiles --enable-userclass-picker
The Web UI will display:

Expand Down

0 comments on commit 6d39a50

Please sign in to comment.