Use the route debugger

The route debugger is a tool that helps you test and debug existing routes in your application. In this page, learn how to use the route debugger tool. 

Access the route debugger

From the context of an existing route in your deployment, click the Debugger button.

Note: If you start a debugging session for a route while another user is already running a debugging session on that route, a message is displayed. Click OK to cancel the first user's debugging session and proceed with yours, or click Cancel. If you proceed with your own session, the other user will see a pop-up informing them that their session has been canceled.

Route debugger interface

The route debugger screen has four areas.


Area Description
Menu buttons (1)

Click the buttons to manage your route. You can startresume, and stop your route. You can also inject data.

Variables (2) Displays details about a breakpoint in the route once the route is started. Click the resume button to move from one breakpoint to the next.
Console (3) Lists log messages about your route for the current debugging session. The contents of the console are updated anytime you edit your route from the route contents area and click Save.
Route contents (4)

Displays the route you are debugging.

Enables you to add breakpoints to the route to debug it step by step.


Analyze your route using breakpoints

In the route contents area, add breakpoints to segment your route as needed so you can get a finer analysis of your route. Once you have added breakpoints and you launch the debugging analysis, the tool can pause at each breakpoint and give you information about each segment in order to help you find bugs more easily.

To add a breakpoint, click the grey bar right of the line number where you want to have the breakpoint. Once you start your route, click the resume button to move from one breakpoint to the next.

Not all the lines in a route can be used as breakpoints. You can see whether a breakpoint can be analyzed or not based on the breakpoint symbol:

  • A v check symbol means that the breakpoint is at a valid place and the route debugger can analyze this specific part of the route.  
  • An x symbol indicates that your breakpoint cannot be used for the debugging.

The following screenshot shows a route with three valid breakpoints and one invalid breakpoint. The debugger tool is analyzing in the context of the highlighted breakpoint and displays information about this breakpoint in the Variables area. 



Related Links