@type browser_connection_adapter_opt() ::
  {:browser_connection_adapter, LiveLoad.Browser.Connection.t()}

Defines the LiveLoad.Browser.Connection implementation to use for this run.

Defaults to LiveLoad.Browser.Connection.Playwright.

@type distributed_run_opt() :: {:distributed?, boolean()}

Configures the run to be distributed.

When set to true, LiveLoad will use FLAME to build an ad-hoc pool of nodes based on the given FLAME.Pool configuration and evenly distribute the users across these nodes during the run.

Defaults to false.

@type option() ::
  scenario_opt()
  | scenarios_opt()
  | otp_app_opt()
  | distributed_run_opt()
  | users_count_opt()
  | browser_connection_adapter_opt()
  | scenario_iteration_timeout_opt()
  | scenario_duration_opt()
  | {atom(), term()}

Initialization options for running a LiveLoad.Scenario.

These are split between options for the overall run configuration (distributed_run_opt/0, users_count_opt/0), options for the runner itself (browser_connection_adapter_opt/0, scenario_iteration_timeout_opt/0, scenario_duration_opt/0) and any other options that should be passed in as configuration to the scenario LiveLoad.Scenario.config/1 callback.

@type otp_app_opt() :: {:otp_app, atom()}

Defines the OTP application to load test.

This option is used in order to automatically discover LiveLoad.Scenario modules implemented in the given application. Similarly to Ecto Migrations, LiveLoad will scan the given OTP application, find all LiveLoad.Scenario modules, and then run these scenarios for a load test.

This option is required unless a scenario_opt/0 or a scenarios_opt/0 is given, in which case only the given scenario modules will be run.

This option takes the lowest priority.

@type scenario_duration_opt() :: {:scenario_duration, timeout()}

Defines the duration of the entire load test for a specific scenario.

When running a load test, the scenario's LiveLoad.Scenario.run/3 callback will be run in a loop multiple times until this value is reached. Once reached, the runner will transition to a terminating state and wait for the latest iteration of the scenario to complete, and then report its completion.

Defaults to 10 minutes.

Note: while the type here is set to timeout/0, the :infinity value is invalid and an error will be returned if it is passed.

@type scenario_iteration_timeout_opt() :: {:iteration_timeout, timeout()}

Defines the timeout for a single iteration of a scenario.

If this timeout is reached and the scenario has not completed, it will be killed and the user's status will reported as a failure. No other iterations will take place for that user.

Defaults to 2 minutes.

Note: while the type here is set to timeout/0, the :infinity value is invalid and an error will be returned if it is passed.

@type scenario_opt() :: {:scenario, LiveLoad.Scenario.t()}

Run a single scenario module.

This option is mutually exclusive with scenarios_opt/0 and otp_app_opt/0, each of which configure which scenarios should be run.

This option takes the highest priority.

@type scenarios_opt() :: {:scenarios, [LiveLoad.Scenario.t()]}

Run a list of scenario modules.

This option is mutually exclusive with scenario_opt/0 and otp_app_opt/0, each of which configure which scenarios should be run.

This option takes the second highest priority.

@type users_count_opt() :: {:users, pos_integer()}

Configures the number of user processes to use for the run.

Defaults to a single user.