Debugging a Pipes project
  • 17 May 2024
  • 2 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Debugging a Pipes project

  • Dark
    Light
  • PDF

Article summary

Active and completed executions for Pipes projects can be debugged using our special Pipes debugging tool.

To open the debugger in a Pipes robot:

  1. Go to Projects.
  2. Open the relevant project folder.
  3. Open the robot.
  4. Double-click on the required Configuration.
  5. Click the Executions tab.
  6. Click View.
  7. Click the Review tab.
  8. Click the bug icon. z project select_configuration execution_information icon debug.png

2021-03-26_13-44-47 (1).gif

Debugging a Pipes project
The debugging tool provides you with information on several aspects of a Pipes robot execution:

  • The order in which the individual nodes were executed
  • The data that was passed to each individual node as it was executed
  • Whether there was an error on executing an individual node
  • Login information published by the node

The main component of the debugger is the timeline which shows you the current step in the playback which is being examined. The total number of steps corresponds to the total number of node executions at the point in which the debugger is being examined. This number dynamically changes for active executions.

Note

Be advised that the timeline manipulation buttons — restart, previous, forward, and play — do not affect the execution in any way. They simply control the playback of the timeline for debugging purposes.

The execution cannot be modified from inside the debugger
The icon on the right side of the timeline shows the current status of the Pipe execution. For example: indicates that the execution is running, a green check sign indicates a successful completion of the execution, and a red cross indicates that the execution finished with an error.

A gear indicates the execution is running:
de1.png

A green check indicates a successful completion of the execution:
de2.png

A red x indicates that the executions finished due to an error:
de3.png

The timeline stores a maximum of 250 steps of a completed execution. If your execution has over 250 steps, the steps at the beginning will be pruned to make space for the latest steps.

If you are debugging a running execution, as long as you do not navigate away from the debugger while the execution is taking place, 2500 steps will remain in your browser memory.

When pressing play or fast-forward, you will advance in the timeline. The next node in the timeline will be highlighted.

de4.png

A node information panel displays, showing input and log information for the node. The information displayed on the top is not linked to the timeline and shows per-execution statistics for the selected node:

  • Hits corresponds to the total number of times this node was executed.
  • Avg. time corresponds to the average time this node took to execute.
  • Active corresponds to the number of active executions for this node.
  • Total time used displays the total time this node spent being executed.

The inputs displayed also correspond to the inputs which were provided for this individual node at this moment in time. The log information is not linked to the timeline and just reflects all logs for this node.

de5.png

Nodes that have failed will be displayed in red and nodes that are currently executing will display a running cog icon on the bottom-right corner.

de6.png

Using breakpoints

Breakpoints can be set on individual nodes to stop timeline playback when the node is reached. Breakpoints on a node can be toggled by pressing the empty red circle on the top-right corner.

de7.png

Changing debugging options

Selecting the bug icon displays options for manipulating the debugger. Changing the options will automatically store them.

de8.png


Was this article helpful?