Page History

...

Div

class	confluenceTableSmall

Option	Default	Description
breadCrumbLength	0	Fixed length of the bread crumb. 0 = no fixed length. Setting a value to e.g. 80 allows the tracer logs to be aligned for easier reading.
nodeLength	0	Fixed length of the node. 0 = no fixed length. Setting a value to e.g. 40 allows the tracer logs to be aligned for easier reading.
showBreadCrumb	true	Outputs the unique unit of work for the exchange. To be used for correlation so you can identify the same exchange.
showNode	true	Previous and destination node, so you can see from -> to.
showExchangeId	false	To output the unique exchange id. Currently the breadcrumb is sufficient.
showShortExchangeId	false	To output the unique exchange id in short form, without the hostname.
showProperties	false	Output the exchange properties
showHeaders	true	Output the in message headers
showBodyType	true	Output the in body Java type
showBody	true	Output the in body
showOutHeaders	false	Output the out (if any) message headers
showOutBodyType	false	Output the out (if any) body Java type
showOutBody	false	Output the out (if any) body
showExchangePattern	true	Output the exchange pattern
showException	true	Output the exception if the exchange has failed
showRouteId	true	Camel 2.8: Output the id of the route
maxChars		Is used to limit the number of chars logged per line. The default value is `10000` from Camel 2.9 onwards.
multiline	false	Camel 2.18: If true, each piece of information is logged on a new line.

Tip

title	Logging stream bodies

Camel Tracer will by default not log stream or files bodies from Camel 2.8 onwards. You can force Camel to log those by setting the property on the CamelContext properties

Code Block
camelContext.getProperties().put(Exchange.LOG_DEBUG_BODY_STREAMS, true);

Example:

Code Block
ID-claus-acer/4412-1222625653890/2-0 -> to(mock:a) , Pattern:InOnly , Headers:{to=James} , BodyType:String , Body:Hello London

...

The trace log will output both the from and to so you can see where the Exchange came from, such as:

Code Block
>>> direct:start --> process(MyProcessor) >>> process(MyProcessor) --> to(mock:a) >>> to(mock:a) --> to(mock:b)

...

To enable tracer from the main run

Code Block
java org.apache.camel.spring.Main -t

or

Code Block
java org.apache.camel.spring.Main -trace

...

Enabling from Java DSL

Code Block
context.setTracing(true);

You can configure tracing at a higher granularity as you can configure it on camel context and then override and set it per route as well. For instance you could just enable tracer for one particular route.

Code Block


INFO  TraceInterceptor     - ID-davsclaus-local-54403-1246038742624-0-0 >>> from(direct:start) --> MyProcessor     , Pattern:InOnly, Headers:{to=James}, BodyType:String, Body:Hello London
INFO  TraceInterceptor     - ID-davsclaus-local-54403-1246038742624-0-0 >>> MyProcessor --> mock:a                 , Pattern:InOnly, Headers:{to=James}, BodyType:String, Body:Hello London
INFO  TraceInterceptor     - ID-davsclaus-local-54403-1246038742624-0-0 >>> mock:a --> mock:b                      , Pattern:InOnly, Headers:{to=James}, BodyType:String, Body:Hello London
...
INFO  TraceInterceptor     - ID-davsclaus-local-54403-1246038742624-0-1 >>> from(direct:start) --> MyProcessor     , Pattern:InOnly, Headers:{from=Claus}, BodyType:String, Body:This is Copenhagen calling
INFO  TraceInterceptor     - ID-davsclaus-local-54403-1246038742624-0-1 >>> MyProcessor --> mock:a                 , Pattern:InOnly, Headers:{from=Claus}, BodyType:String, Body:This is Copenhagen calling
INFO  TraceInterceptor     - ID-davsclaus-local-54403-1246038742624-0-1 >>> mock:a --> mock:b                      , Pattern:InOnly, Headers:{from=Claus}, BodyType:String, Body:This is Copenhagen calling

...

The tracer options can be configured from the Java DSL like this:

Code Block


    public void configure() throws Exception {
        // add tracer as an interceptor so it will log the exchange executions at runtime
        // this can aid us to understand/see how the exchanges is routed etc.
        Tracer tracer = new Tracer();
        formatter.getDefaultTraceFormatter().setShowBreadCrumb(false);
        formatter.getDefaultTraceFormatter().setShowNode(false);
        ...
        getContext().addInterceptStrategy(tracer);

...

In the code below we want the tracer only to trace if the body contains the text London. As this is just an example can of course set any Predicate that matches your criteria:

Code Block

	java
	java


    Tracer tracer = new Tracer();
    // set the level to FATAL so we can easily spot it
    tracer.setLogLevel(LoggingLevel.FATAL);
    // and only trace if the body contains London as text
    tracer.setTraceFilter(body().contains(constant("London")));

...

There is now a trace attribute you can specify on the *<camelContext/> for example

Code Block
<camelContext trace="true" xmlns="http://activemq.apache.org/camel/schema/spring"> ... </camelContext>

...

You can configure the tracer as a Spring bean. Just add a bean with the bean class org.apache.camel.processor.interceptor.Tracer and Camel will use it as the Tracer.

Wiki Markup
{snippet:id=e1\|lang=xml\|url=camel/trunk/components/camel-spring/src/test/resources/org/apache/camel/spring/interceptor/tracerConfigurationTest.xml}

You can configure the formatting of tracer as a Spring bean. Just add a bean with the id traceFormatter and Camel will lookup this id and use the formatter, as the example below illustrates:

Wiki Markup
{snippet:id=e1\|lang=xml\|url=camel/trunk/components/camel-spring/src/test/resources/org/apache/camel/spring/interceptor/traceFormatterTest.xml}

Enable tracing of out messages

You can trace messages coming out of processing steps. To enable this, configure the tracer as follows

Wiki Markup
{snippet:id=tracingOutExchanges\|title=Java DSL\|lang=java\|url=camel/trunk/camel-core/src/test/java/org/apache/camel/processor/TraceInterceptorWithOutBodyTraceTest.java}

or

Wiki Markup
{snippet:id=tracingOutExchanges\|title=Spring DSL\|lang=xml\|url=camel/trunk/components/camel-spring/src/test/resources/org/apache/camel/spring/processor/traceInterceptorWithOutBodyTrace.xml}

Running with these options, you'll get output similar to:

Code Block


INFO  TraceInterceptor - ID-mojo/59899-1225474989226/2-0 -> transform(body) , Pattern:InOnly , Headers:{to=James} , BodyType:String , Body:Hello London
INFO  TraceInterceptor - transform(body) -> ID-mojo/59899-1225474989226/2-0 , Pattern:InOnly , Headers:{to=James} , BodyType:String , Body:Hello London , OutBodyType:String , OutBody:Hello London

...

The sample below shows how to configure a Tracer from Java DSL using custom formatter:

Wiki Markup
{snippet:id=e1\|lang=java\|url=camel/trunk/camel-core/src/test/java/org/apache/camel/processor/interceptor/TraceFormatterTest.java}

And here we have our custom logger that implements the TraceFormatter interface where we can construct the log message how we like:

Wiki Markup
{snippet:id=e2\|lang=java\|url=camel/trunk/camel-core/src/test/java/org/apache/camel/processor/interceptor/TraceFormatterTest.java}

Using Destination for custom processing and routing

...

The sample below demonstrates this feature, where we route traced Exchanges to the direct:traced route:

Wiki Markup
{snippet:id=e1\|lang=java\|url=camel/trunk/camel-core/src/test/java/org/apache/camel/processor/interceptor/TraceInterceptorDestinationTest.java}

Then we can configure a route for the traced messages:

Code Block
from("direct:traced").process(new MyTraceMessageProcessor()).to("file://myapp/logs/trace);

And our processor where we can process the TraceEventMessage. Here we want to create a CSV format of the trace event to be stored as a file. We do this by constructing the CSV String and the replace the IN body with our String instead of the TraceEventMessage.

Wiki Markup
{snippet:id=e2\|lang=java\|url=camel/trunk/camel-core/src/test/java/org/apache/camel/processor/interceptor/TraceInterceptorDestinationTest.java}

Using JPA as datastore for trace messages

...

The example below demonstrates how we can use that for error handling where we can determine at which node in the route graph the error triggered.
First we define our route:

Wiki Markup
{snippet:id=e1\|lang=java\|url=camel/trunk/camel-core/src/test/java/org/apache/camel/processor/TraceableUnitOfWorkTest.java}

And then our custom error processor where we can handle the exception and figure out at which node the exception occurred.

Wiki Markup
{snippet:id=e2\|lang=java\|url=camel/trunk/camel-core/src/test/java/org/apache/camel/processor/TraceableUnitOfWorkTest.java}

Child pages

Versions Compared

Old Version 60

New Version 61

Key

Enabling from Java DSL

Enable tracing of out messages

Using Destination for custom processing and routing

Using JPA as datastore for trace messages

See Also