View Source amoc (amoc v3.3.0)

API module for running locally, in a non-distributed environment

Use amoc_dist module to run scenarios in a distributed environment

Summary

Types

scenario/0

Functions

add(Count)
Dynamically add more users to a currently running scenario
do(Scenario, Count, Settings)
Start a scenario with the given number of users and configuration
remove(Count, ForceRemove)

Dynamically remove more users from a currently running scenario, optionally forcibly

reset()
Restart the whole amoc supervision tree
stop()
Stop a running scenario

Types

Link to this type

scenario/0

View Source 
-type scenario() :: module().

Functions

Link to this function

add(Count)

View Source 
-spec add(pos_integer()) -> ok | {error, any()}.
Dynamically add more users to a currently running scenario
Link to this function

do(Scenario, Count, Settings)

View Source 
-spec do(scenario(), non_neg_integer(), amoc_config:settings()) -> ok | {error, term()}.
Start a scenario with the given number of users and configuration
Link to this function

remove(Count, ForceRemove)

View Source 
-spec remove(pos_integer(), boolean()) -> {ok, non_neg_integer()} | {error, any()}.

Dynamically remove more users from a currently running scenario, optionally forcibly

Forcing user removal means that all users will be signal to exit in parallel, and will forcibly be killed after a short timeout (2 seconds), whether they have exited already or not.
Link to this function

reset()

View Source 
-spec reset() -> ok | {error, term()}.
Restart the whole amoc supervision tree
Link to this function

stop()

View Source 
-spec stop() -> ok | {error, any()}.
Stop a running scenario