Configuring the Runbook Widget

The Runbook widget displays output from an on-demand runbook An automated workflow that executes a series of steps or tasks in response to a triggered event, such as the detection of anomalous behavior generating an incident, a lifecycle event, or a manually executed runbook.. When you configure the widget, you choose which runbook to run, set any runtime variables, and control how the results are shown. Configuration is done in a multistep dialog.

Opening the Runbook widget configuration

Enter edit mode on the workspace, open the widget menu (ellipsis on the widget header), and click Configure. The Runbook configuration dialog opens with steps for query, visualization, and interactions.

Query step

In the Query step you define which runbook runs and what inputs it receives.

• Runbook: Select the on-demand runbook to run. The list shows runbooks available in your environment. Only runbooks that support on-demand execution appear.

• Runtime variables: If the runbook has input parameters (variables), you can set default values here. Users can change these when they run the widget, or you can leave them blank so users must supply values. The exact variables depend on the runbook definition.

Visualization step

In the Visualization step you set how the runbook output is displayed in the widget. Options may include the widget name and how output (e.g. tables or logs) is shown. The available options depend on the runbook output type.

Interactions step

In the Interactions step you configure how this widget responds to selections in other widgets (for example, group, metric, or time). You can choose which interaction types the Runbook widget accepts so that runbook inputs can be driven by another widget. For more on interactions, see Library Widget Interactivity.