Contact Us 1-800-596-4880

Breakpoints

You can add breakpoints to your message processors so that the Studio debugger stops the execution of your flow at that particular processor. You can later inspect the content of the message as it exists at that point in the flow.

A breakpoint stops the execution of the flow when the message reaches it. You can also configure a breakpoint to execute when a specific condition in the message is met, or whenever an error occurs. See the following types of breakpoints for more details.

Default Breakpoints

When you add a breakpoint, Studio enables the breakpoint by default.

To add a default breakpoint, right-click a message processor and select Add Breakpoint:

The Add breakpoint option highlighted in the context menu of a flow

To disable the breakpoint, right-click the message processor and select Disable Breakpoint:

The Disable breakpoint option highlighted in the context menu of a flow

Although you disable the breakpoint, Studio does not delete it. In the canvas, the breakpoint’s corresponding event processor displays a gray circle instead of a red circle:

A gray circle shows a disabled breakpoint

When you have many breakpoints, you can use the Mule Breakpoints view in the Mule Debug perspective. The Mule Breakpoints view lists all the message processors that have breakpoints and indicates with a check mark all the enabled breakpoints. You can select and unselect the check marks to enable or disable the breakpoints you need:

The elements of the Mule Breakpoints view in the Mule Debug perspective

When you run your application in debug mode, Studio stops the flow execution at the breakpoint you added, enabling you to inspect the message’s content in the Mule Debugger view.

Conditional Breakpoints

A conditional breakpoint activates when a predefined condition evaluates to true when Studio executes the event processor with the breakpoint. You define the condition using a DataWeave expression.

To add a conditional breakpoint:

  1. Right-click the message processor and select Add Breakpoint:

    The Add breakpoint option highlighted in the context menu of a flow
  2. In the Mule Breakpoints view, select the breakpoint to which you want to add a condition, and select Conditional:

    Set Payload and Conditional elements highlighted In the Mule Breakpoints view
  3. Enter the condition that must be met to activate the breakpoint.
    For example, the following expression activates the breakpoint if the method used in the request is GET:

    attributes.method == "GET"

You can change the condition without stopping the application’s execution.

Error Breakpoints

Enabling error breakpoints causes any event processor in the application to become a breakpoint if it throws an error. Studio stops the flow execution whenever an error occurs. The Mule Debugger view displays the content of the message as it exists at that point in the flow that the error occurred.

Studio enables error breakpoints by default.

You can’t add specific error breakpoints to stop the flow execution when a specific error occurs.

To disable error breakpoints, select the Disable error breakpoints (Disable error breakpoints icon") button in the Mule Breakpoints view:

Disable error breakpoints button highlighted in the Mule Breakpoints view

Temporarily Mute Breakpoints

You can activate the Mute Breakpoints option in the Mule Breakpoints view to temporarily disable the debugger from stopping at your enabled breakpoints:

The Mute breakpoints icon highlighted in the Mule Breakpoints view

By default, muting your breakpoints also disables the error breakpoints. You can configure this behavior in Preferences > Anypoint Studio > Debugger by unselecting the Mute Breakpoints disables Error Breakpoints check mark:

The Mute breakpoints disables Error Breakpoints checkbox highlighted in the Anypoint Studio Preferences menu