View Source Altworx Toolbox
Toolbox is a convenience library designed to streamline the creation of Altworx scenarios. It provides a variety of utilities to simplify tasks like managing incidents, using randomness, producing reports, and more. While scenarios can benefit from the functionality Toolbox offers, its use is entirely optional and not a requirement for running scenarios within Altworx.
Installation
Add Toolbox as a dependency in your mix.exs
:
def deps do
[
{:toolbox, "~> 5.4", hex: :altworx_toolbox}
]
end
Modules overview
Toolbox.Workflow
: general-purpose state machine abstractionToolbox.Incident
: state machine abstraction for managing incidentsToolbox.Incident.IdGenerator
: helper for generating stable incident IDsToolbox.Random
: helpers for using reproducible randomness inside scenariosToolbox.Report
: behaviour for sending periodic reports via notificationsToolbox.Utils.Enum
andToolbox.Utils.Map
: utility functions for working with enumerables and maps