To Trace a Message Through a Route

Select Window > Open Perspective > Other... > Fuse Integration to open the Fuse Integration perspective, as shown in Figure 19.

	Note
	You can use the Open Perspective icon () in the perspectives tab to access the list of available perspectives.

Figure 19. Fuse Integration perspective

	Note
	To make it easy to access a Camel Context .xml file, especially when a project consists of multiple contexts, the tooling lists them in the Camel Contexts folder, beneath the project's root folder in Project Explorer; for example:

Drag the Diagram View tab and the Shell tab, located to the left of the JMX Navigator tab, and drop them to the right of the JMX Navigator tab, as shown in Figure 20.

Figure 20. Fuse Integration perspective rearranged

This layout will provide more space for Diagram View to display the route's nodes in a graphical representation, enabling you to visually trace the path that messages take in traversing the routing context.

In Project Explorer, expand the CBRroute project to expose the src/main/resources/OSGI-INF/blueprint/camelContext.xml file.

Select Run As > Local Camel Context (without tests) from the camelContext.xml file's context menu.

In JMX Navigator, expand Local Processes.

Double click Local Camel Context[Id][Disconnected] to connect to it and expand the elements of your route, as shown in Figure 21, “Route elements in JMX Navigator”.

Figure 21. Route elements in JMX Navigator

Right-click the blueprintContext node to open the context menu, and select Start Tracing.

The tooling displays a graphical representation of your route in Diagram View, as shown in Figure 22.

Figure 22. Routes' graphical representation

In Project Explorer, expand CBRroute/src/data, so you can access the message files (message1.xml through message6.xml), as shown in Figure 23, “Message files in CBRroute project”.

Figure 23. Message files in CBRroute project

Drag message1.xml and drop it on the blueprintContext>Endpoints>file>src/data?noop=true node in JMX Navigator, as shown in Figure 24.

Figure 24. Local Camel Context tree expanded to input source node

As the message traverses the route, the tooling traces and records its passage at each step. To update Diagram View with the new message count, you need to click the blueprintContext node in JMX Navigator.

Note

The Local Camel Context[xxx] tree collapses to the blueprintContext node after you drop the next message on the input src node. You need not re-expand it. When dragging the other messages, hover over each node in the tree to expose the next node, until you reach the src/data?noop=true node. Then drop the message on it. This method prevents the tooling from redrawing the graphical representation in Diagram View.

Switch from Console to Messages View.

Click the blueprintContext node in JMX Navigator to initialize Messages View with message1.xml's details.

Note

You can control columnar layout in all of the tooling's tables. Use the drag method to temporarily rearrange tabular format. For example, drag a column's border rule to expand or contract its width. To hide a column, totally contract its borders. Drag the column header to relocate a column within the table. For your arrangement to persist, you must use the View Menu > Configure Columns... method instead.

In Messages View, click the icon on the panel's menu bar, and select Configure Columns... to open the Configure Columns wizard, as shown in Figure 25.

Figure 25. Configure Columns defaults

	Note
	Notice that the message header, Destination, which you set for the messages in your routing context, appears in the list.

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 items as shown in Figure 26.

Figure 26. Configure Columns set

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

In Messages View, click the (Refresh button) on top, right of the panel's menu bar to populate the view with message1.xml's message traces.

Each time you drop a message on the input src node 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, as shown in Figure 27.

Figure 27. Message trace selected

The tooling displays the details about a message trace (including message headers when they are set) in the top half of the Properties panel and the contents of the message instance in the bottom half of the Properties panel. 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.

In Diagram View, the associated step in the route is highlighted, as shown in Figure 28.

Figure 28. Diagram View: message trace node

Drag message2.xml and drop it on theblueprintContext>Endpoints>file>src/data?noop=true node in JMX Navigator.

Hover over each node in the tree until you expose the src/data?noop=true node, then drop message2.xml on it.

Switch from Console to Messages View.

In Messages View, click the (Refresh button) on top, right of the panel's menu bar to populate the view with message2.xml's message traces.

	Note
	You can repeat Step 2 through Step 2 for the remaining messages in CBRroute/src/data/ at any time, as long as tracing remains enabled. On each subsequent drop, remember to click the (Refresh button) on the panel's menu bar to populate Messages View with the new message traces.

As shown in Figure 29, 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.

Figure 29. Fuse Integration perspective's message tracing components

Hovering over the displayed metrics reveals additional metrics about message flow, as shown in Figure 30.

Figure 30. Additional message metrics

When done: