API Reference runbox v21.2.0

Runbox allows working with scenario releases. It can load scenario releases and provide information about the individual scenarios within them.

Decide if a message is a duplicate by comparing it to messages already seen.

Dead-letter message produced when evaluating of raw-topic failed.

Formerly delayed messages/late events, when jitter around incoming topic is out of threshold.

Utilities for communicating with master node from slave node

Altworx message runtime representation.

Set of utility functions for use in notification templates.

Structure holding Runbox context of running slave node.

Module contains common functions called on run slave node.

Structure holding context of starting run.

Component network builds and validates run component dependency network.

Output Action for internal use by Runtime

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.

Component network builds and validates template dependency network for Simple scenario runtime.

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.

Template carrier for Simple scenario.

State that is periodically persisted to savepoints and loaded when run continues.

State of a running template carrier for a Simple scenario.

Timezip component responsible for merging multiple message streams for Simple runtime.

Component network builds and validates template dependency network for StageBased scenario runtime.

StageBased scenario runtime single-process emulator.

StageBased Template emulator.

Sandbox is helper for executing runs without started Altworx application.

Transform valid component network to gen_stage definitions.

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.

Selector function generator which is used to filter messages between GenStage phases.

Module generates state of run components running on slave node.

Module handles run state load/initialization for StageBased scenario runtime.

Module implements producer_consumer GenStage behaviour, scenario template is used to handle events

Module encapsulates scenario template callback calls.

Timezip component responsible for merging multiple message streams using time for Stage runtime.

Struct representing a unit.

Unit register used in stage based runtime to manage state of units.

Module manages alternative registry state.

Builder of msg_parser and unit_register fns used in Runbox.Runtime.Stage.UnitRegistry

Module handles run state load/initialization.

Buffering multi-queue data structure for Timezip.

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.

Module contains functions for working with scenario notifications.

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.

Template inspector for Simple scenario.

Module defines behaviour used in scenarios as template.

Behaviour used to detect scenario template source files.

Defines supported scenario types.

Toolbox for working with scenario user actions.

Module for inspecting a scenario release.

Functions which are called on the scenario slave via RPC from the master node.

Holds information about scenario template.

Utilities for starting a slave node with a scenario release and communicating with the node.

State store is interface for run state persistence.

Module defines struct which acts as state store envelope for any stateful runtime component.

Module defines struct which represents state of all stateful components of the run runtime.

Savepoint represents state of runtime run valid to scheduled timestamp.

Module contains functions to compute savepoint timestamps.

Behaviour for generic state store storage.

Runbox.StateStore.Storage behaviour implementation.

Runbox.StateStore.Storage implementation intended for testing purposes.

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.

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.

Assembles an Altworx scenario release for the current project.