API Reference runbox v21.2.0
Modules
Dead-letter message produced when evaluating of raw-topic failed.
Formerly delayed messages/late events, when jitter around incoming topic is out of threshold.
Altworx message runtime representation.
Set of utility functions for use in notification templates.
Struct produced by scenario representing instruction for runtime.
Instruction to register unit timeout.
Sandbox is a helper for executing runs without started Altworx application.
Module that signs user actions for Sandbox.
Sandbox is a helper for executing runs without started Altworx application.
Macro for emulating a StageBased scenario inside a Simple scenario.
Handles run state load or initialization for simple scenario runtime.
StageBased scenario runtime single-process emulator.
Sandbox is helper for executing runs without started Altworx application.
For new unit testing of scenarios it is recommended to use functions in
Runbox.Runtime.Stage.Sandbox directly. This module should only help to
convert old scenarios integration tests (using Solutions.TestRunner) to unit
tests. For examples of such conversion see tests in the scenarios master
branch.
Module handles run state load/initialization for StageBased scenario runtime.
Struct representing a unit.
Module handles run state load/initialization.
Holds information about scenario.
Utilities for working with Asset
Provides configuration to a scenario.
Support for helper processes for scenarios.
Struct representing mapping of logical topics (defined in scenarios) to physical topics (actual kafka topics).
Behaviour and struct for scenario manifest.
Struct representing incident manifest
Struct representing one column in incident forecast UI widget.
Output action represents a side effect produced by a run.
Body of invalid output action.
Parameters for output action Delete All Asset Attributes.
Parameters for output action Delete Asset Attributes.
Parameters for output action Delete Edge.
Parameters for output action Event.
Parameters for output action Execute SQL.
Parameters for output action Incident.
Incident Actor
Incident Future.
Incident history.
Parameters for output action Incident Patch.
Parameters for output action Notification.
Struct for referencing assets in Notifications.
Struct for referencing incidents in Notifications.
Parameters for output action Upsert Asset Attributes.
Parameters for output action Upsert Edge.
Simple scenario behavior.
Simple scenario configuration struct.
Struct containing all neccessary parameters to start scenario.
Module defines behaviour used in scenarios as template.
Defines supported scenario types.
Toolbox for working with scenario user actions.
Holds information about scenario template.
Set of utility functions for working with UI.
A set of utility functions for Enums.
A set of utility functions for Maps.
Utilities for handling configured paths.
Provides topology sorting capabilities.
Mix Tasks
Assembles an Altworx scenario release for the current project. It is done in a docker container based on an image which ensures correct erlang and Elixir versions, so they are compatible with Altworx.