Runbook Debug Nodes

Many runbookClosed 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. nodesClosed Individual components that make up a runbook automation, each performing a specific function such as data queries, transformations, logic, integrations, or visualizations. support a debug capability that provides detailed logging and diagnostic information during node execution. When you enable debug for a node, that node emits additional debug information that you can view in the Debug Runbook Flow dialog after the runbook executes.

Enabling Debug on Nodes

To enable debug for a node:

  1. In the Runbook Editor, select the node on the canvas.

  2. In the Properties pane, locate the Debug checkbox.

  3. Check the Debug checkbox to enable debug capabilities for that node.

When debug is enabled for a node, a visual indicator appears on the node in the Runbook Editor canvas, making it easy to see which nodes have debug enabled at a glance.

Enabling Debug on Multiple Nodes

You can enable debug for multiple nodes at once using the debug configuration dialog. For more information about using the debug configuration dialog, see Runbook Debugging Features.

Disabling Debug

To disable debug for a node, uncheck the Debug checkbox in the node's Properties pane. You can also disable debug for multiple nodes using the debug configuration dialog. For more information, see Runbook Debugging Features.

When you save a runbook that has debug enabled on any nodes, the Save Runbook dialog displays a visual indicator showing that debug is enabled. The dialog also provides an option to disable debug before saving, allowing you to ensure that debug is not left enabled in production runbooks.

Viewing Debug Information

After a runbook executes, you can view the debug information emitted by nodes that have debug enabled. Open the Debug Runbook Flow dialog and click a node, or click the stethoscope (debug) icon next to runbook output when debug data is present. The node details dialog includes the CONFIG tab, the INSPECT tab (formatted, structured view), and the DEBUG tab (Tree view and Text (JSON) view, with Tree view as the default) when debug is enabled for the selected node. The INSPECT tab is the default view for debug output and provides the most user-friendly presentation of debug data. For a full description of the dialog, tabs, and Node dropdown, see Viewing Node Details in Debug Runbook Flow.

For more information about using debug information to troubleshoot runbooks, see How to Debug with IQ.