Runbooks page

The Runbooks page enables you to manage the runbooks for your configuration; these are the automated investigations that execute in response to triggers. It lists all the runbooks that exist in your configuration (built-in and custom), enabling you to modify the existing ones, create new ones, import and export definitions via file, and delete any that you no longer need.

Access the Runbooks page at any time by clicking Runbooks in the Navigation pane at the left of the Alluvio IQ window.

For any listed runbook, click on its row or click the > at its left to show its definition as a sequence of nodes. Doing this also provides access to several controls:

  • Edit – Open the runbook definition in the Runbook editor to change it.

  • ExportWrite the runbook definition to JSON file.

  • Duplicate – Copy the runbook.

  • Delete – Use with caution. This will prompt you for confirmation, then will permanently remove the runbook from the system. There is no undo, once the runbook is deleted.

Controls For Adding a New Runbook

Two controls reside at the top of the page:

Runbook List Filters

Control how many runbooks are listed by choosing a filter; each filter shows how many runbooks it comprises, currently.

  • All Runbooks – Show all existing runbooks. This is the default.

  • Active – Show only those runbooks that have been set to Active, meaning that they are in use currently.

  • Created By Me – Show only those runbooks created and saved using the current user account.

  • In Error – Show only those runbooks marked with an error state. These runbooks cannot be be set to Active, and cannot be executed until all errors are corrected.

  • Built-In – Show only those runbooks provided as part of the Alluvio IQ application.

Runbook List Columns

These fields are shown for each runbook listed. Note that you can sort by each column, and search withing each column, also.

  • Runbook – The runbook's name. This may be user-defined, or auto-generated if no user has renamed it.

  • Description – A brief, user-defined explanation of what the runbook is used for.

  • Trigger – The type of trigger that launches the runbook.

  • Built-In – A checkmark is shown if the runbook is provided by Alluvio IQ.

  • Last Updated – The timestamp from when the runbook was most recently saved.

  • Last Updated By – The username of the account that saved the most recent change to the runbook.

  • Active – Toggle a runbook On to enable it for related incidents, or toggle it Off to disable it. Custom runbooks are Off by default.

  • ... pop-up menu – Additional controls for managing runbooks. Most are also available from other places when working with runbooks.

    • ExportOutput the runbook definition to a JSON file that can be imported subsequently to create a new runbook.

    • Edit – Open the runbook in the Runbook Editor to change it.

    • DuplicateCopy the runbook.

    • Delete – Use with caution. This will prompt you for confirmation, then will permanently remove the runbook from the system. There is no undo, once the runbook is deleted.

    • Test Run – Execute the runbook's logic immediately, without having to wait for a corresponding trigger.

    • Preview Output – Show what data the runbook will generate after it executes in response to a trigger.