Chapter 8. Tracing a message through a route

Click the button on the right side of the tool bar, and then select Fuse Integration from the list:

The Fuse Integration perspective opens in the default layout:

Drag the JMX Navigator tab to the far right of the Terminal tab and drop it there:

This arrangement provides more space for Diagram View to display the routing context’s nodes graphically, which makes it easier for you to visually trace the path that messages take in traversing the routing context.

Note

To make it easy to access a routing context .xml file, especially when a project consists of multiple contexts, the tooling lists them under the Camel Contexts folder in Project Explorer.

Additionally, all routes in a routing context are displayed as icons directly under their context file entry. To display a single route in the routing context on the canvas, double-click its icon in Project Explorer. To display all routes in the routing context, double-click the context file entry.

Select Run As Local Camel Context (without tests).

In JMX Navigator, expand Local Processes.

Expand the elements of your route:

Right-click the Routes node and then select Start Tracing:

The tooling displays a graphical representation of your routing context in Diagram View:

To see all message flow paths clearly, you probably need to rearrange the nodes by dragging them to fit neatly in the Diagram View tab. You may also need to adjust the size of the other views and tabs in Red Hat CodeReady Studio to allow the Diagram View tab to expand.

In Project Explorer, expand ZooOrderApp/src/data, so that you can access the message files (message1.xml through message6.xml):

Drag message1.xml and drop it on the _context1>Endpoints>file>src/data?noop=true node in JMX Navigator:

As the message traverses the route, the tooling traces and records its passage at each step.

Click the icon on the panel’s menu bar, and select Configure Columns to open the Configure Columns wizard:

You can include or exclude items from Messages View by selecting or deselecting them. You can rearrange the columnar order in which items appear in Messages View by highlighting individual, selected items and moving them up or down in the list.

In the Configure Columns wizard, select and order the columns this way:

These columns and their order will persist in Messages View until you change them again.

In Messages View, click the (Refresh button) to populate the view with message2.xml message traces.

Each time you drop a message on in JMX Navigator, you need to refresh Messages View to populate it with the message traces.

Click one of the message traces to see more details about it in Properties view:

The tooling displays the details about a message trace (including message headers when they are set) in the top half of the Properties view and the contents of the message instance in the bottom half of the Properties view. So, if your application sets headers at any step within a route, you can check the Message Details to see whether they were set as expected.

You can step through the message instances by highlighting each one to see how a particular message traversed the route and whether it was processed as expected at each step in the route.

Open Diagram View, to see that the associated step in the route is highlighted:

The tooling draws the route in Diagram View, tagging paths exiting a processing step with timing and performance metrics (in milliseconds). Only the metric Total exchanges is displayed in the diagram.

Hover the mouse pointer over the displayed metrics to reveal additional metrics about message flow:

Optionally, you can drag and drop the remaining messages in ZooOrderApp/src/data/ into the _context1>Endpoints>file>src/data?noop=true node in JMX Navigator at any time, as long as tracing remains enabled.

On each subsequent drop, remember to click the (Refresh button) to populate Messages View with the new message traces.

When done: