View Source amoc_dist (amoc v3.3.0)

API module to run tests in a distributed environment

Summary

Functions

Dynamically add more users to a currently running scenario, in all nodes

See also: add/2.

Dynamically add more users to a currently running scenario, in the specified nodes
Start a scenario with the given number of users and configuration
Get the scenario running status in the cluster
Dynamically remove more users from a currently running scenario, optionally forcibly, in all nodes

See also: remove/3.

Dynamically remove more users from a currently running scenario, optionally forcibly, in the specified nodes

Stop a running scenario in the whole cluster
Update the settings of a currently running scenario, in all nodes

See also: update_settings/2.

Update the settings of a currently running scenario, in the specified nodes

Types

-type cluster_state() :: idle | running | stopped.

Functions

-spec add(pos_integer()) -> {ok, any()} | {error, any()}.
Dynamically add more users to a currently running scenario, in all nodes

See also: add/2.

-spec add(pos_integer(), [node()]) -> {ok, any()} | {error, any()}.
Dynamically add more users to a currently running scenario, in the specified nodes
Link to this function

do(Scenario, Count, Settings)

View Source
-spec do(amoc:scenario(), non_neg_integer(), amoc_config:settings()) -> {ok, any()} | {error, any()}.
Start a scenario with the given number of users and configuration
-spec get_state() -> cluster_state().
Get the scenario running status in the cluster
Link to this function

remove(Count, ForceRemove)

View Source
-spec remove(pos_integer(), boolean()) -> {ok, any()} | {error, any()}.
Dynamically remove more users from a currently running scenario, optionally forcibly, in all nodes

See also: remove/3.

Link to this function

remove(Count, ForceRemove, Nodes)

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

Dynamically remove more users from a currently running scenario, optionally forcibly, in the specified nodes

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.
-spec stop() -> {ok, any()} | {error, any()}.
Stop a running scenario in the whole cluster
Link to this function

update_settings(Settings)

View Source
-spec update_settings(amoc_config:settings()) -> {ok, any()} | {error, any()}.
Update the settings of a currently running scenario, in all nodes

See also: update_settings/2.

Link to this function

update_settings(Settings, Nodes)

View Source
-spec update_settings(amoc_config:settings(), [node()]) -> {ok, any()} | {error, any()}.
Update the settings of a currently running scenario, in the specified nodes