Debug Runbook Flow

The Debug Runbook Flow dialog provides a visual representation of your runbook's execution, showing which nodes executed, which branches were taken, and any errors encountered. This feature is essential for understanding runbook behavior during development and troubleshooting.

Accessing Debug Runbook Flow

You can access the Debug Runbook Flow dialog on all pages where a runbook appears, including during test runs. To open it:

  1. Open the ... menu on the page where the runbook appears.

  2. Select Debug Runbook Flow.

The Debug Runbook Flow dialog displays all nodes in the runbook. Nodes that executed are highlighted, while nodes that did not execute are grayed out, making it easy to see the execution path at a glance.

Understanding the Execution Flow

The Debug Runbook Flow dialog helps you:

  • Identify which branches executed or skipped: See which decision branch paths were taken and which were not executed.

  • See which nodes succeeded or failed: Visually identify nodes that executed successfully versus those that failed or were skipped.

  • View execution order: Understand the sequence in which nodes executed during the runbook's execution.

Viewing Node Details

Click on any node in the Debug Runbook Flow dialog to open a details dialog that provides comprehensive information about that node's execution:

  • Config tab: Shows the exact configuration that was used for the node during execution, including any variable substitutions. This helps you verify that the node received the expected inputs and was configured correctly.

  • Error tab: Displays any errors encountered when running the node. This tab is only visible if errors occurred during node execution. Review error information to understand why a node failed and what needs to be fixed.

  • Inspect tab: Shows formatted, structured debug output that presents information in an organized, easy-to-read format. This tab is only visible when debug is enabled for the node. The Inspect tab is the default view and provides the most user-friendly presentation of debug data. Transform and HTTP nodes provide specialized Inspect views with organized sections for input/output data, errors, and validation information. For details about these specialized views, see Runbook Debugging Features.

  • Debug tab: Shows raw debug output in text format. This tab is only visible when debug is enabled for the node. Use this tab when you need to see the unformatted debug data.

How Debug Information is Stored

When a runbook activates, IQ Ops automatically stores information about:

  • Which nodes executed

  • The execution path taken through the runbook

  • Any errors encountered during execution

  • Debug information from nodes that have debug enabled

This information is available immediately after execution and remains accessible until the runbook execution data is cleared.

Using Debug Runbook Flow for Troubleshooting

The Debug Runbook Flow dialog is particularly useful for:

  • Verifying logic flow: Confirm that decision branches are evaluating conditions correctly and routing execution along the expected paths.

  • Identifying skipped nodes: Understand why certain nodes did not execute, which helps identify configuration issues or logic problems.

  • Debugging failures: Quickly locate failed nodes and review error information to understand what went wrong.

  • Validating node configuration: Verify that nodes received the correct inputs and were configured as expected during execution.

For more information about debugging runbooks, see How to Debug with IQ.