Page History

{include:Uses Commons Logging}

h3. URI format

{code}
log:loggingCategory[?options]
{code}

Where *loggingCategory* is the name of the logging category to use. You can append query options to the URI in the following format, {{

].
{tip}

h3. Options
{div:class=confluenceTableSmall}
|| Option || Default || Type || Description ||
| {{level}} | {{INFO}} | {{String}} | Logging level to use. Possible values: {{ERROR}}, {{WARN}}, {{INFO}}, {{DEBUG}}, {{TRACE}}, {{OFF}} |
| {{marker}} | {{null}} | {{String}} | *Camel 2.9:* An optional [Marker|http://www.slf4j.org/api/org/slf4j/Marker.html] name to use. |
| {{groupSize}} | {{null}} | {{Integer}} | An integer that specifies a group size for throughput logging.|
| {{groupInterval}} | {{null}} | {{Integer}} | If specified will group message stats by this time interval (in millis) |
| {{groupDelay}} | {{0}} | {{Integer}} | Set the initial delay for stats (in millis) |
| {{groupActiveOnly}} | {{true}} | {{boolean}} | If true, will hide stats when no new messages have been received for a time interval, if false, show stats regardless of message traffic | 
{div}
*

{div groupInterval



h3. Formatting
The log formats the execution of exchanges to log lines. 
By default, the log uses {{LogFormatter}} to format the log output, where {{LogFormatter}} has the following options:
{div:class=confluenceTableSmall}
|| Option || Default || Description ||
| {{showAll}} | {{false}} | Quick option for turning all options on. (multiline, maxChars has to be manually set if to be used) |
| {{showExchangeId}} | {{false}} | Show the unique exchange ID. |
| {{showExchangePattern}} | {{true}} | Shows the Message Exchange Pattern (or MEP for short). |
| {{showProperties}} | {{false}} | Show the exchange properties. |
| {{showHeaders}} | {{false}} | Show the In message headers. |
| {{skipBodyLineSeparator}} | {{true}} | *Camel 2.12.2:* Whether to skip line separators when logging the message body. This allows to log the message body in one line, setting this option to {{false}} will preserve any line separators from the body, which then will log the body _as is_. |
| {{showBodyType}} | {{true}} | Show the In body Java type. |
| {{showBody}} | {{true}} | Show the In body. |
| {{showOut}} | {{false}} | If the exchange has an Out message, show the Out message. |
| {{showException}} | {{false}} | If the exchange has an exception, show the exception message (no stack trace). |
| {{showCaughtException}} | {{false}} | If the exchange has a caught exception, show the exception message (no stack trace). A caught exception is stored as a property on the exchange (using the key {{Exchange.EXCEPTION_CAUGHT}}) and for instance a {{doCatch}} can catch exceptions. See [Try Catch Finally]. |
| {{showStackTrace}} | {{false}} | Show the stack trace, if an exchange has an exception. Only effective if one of {{showAll}}, {{showException}} or {{showCaughtException}} are enabled. | 
| {{showFiles}} | {{false}} | *Camel 2.9:* Whether Camel should show file bodies or not (eg such as java.io.File). | 
| {{showFuture}} | {{false}} | Whether Camel should show {{java.util.concurrent.Future}} bodies or not. If enabled Camel could potentially wait until the {{Future}} task is done. Will by default not wait. |
| {{showStreams}} | {{false}} | *Camel 2.8:* Whether Camel should show stream bodies or not (eg such as java.io.InputStream). Beware if you enable this option then you may not be able later to access the message body as the stream have already been read by this logger. To remedy this you will have to use [Stream Caching]. | 
| {{multiline}} | {{false}} | If {{true}}, each piece of information is logged on a new line. |
| {{maxChars}} | | Limits the number of characters logged per line. The default value is {{10000}} from *Camel 2.9* onwards. |
{div}

{

{code}
{tip}


h3. Regular logger sample
In the route below we log the incoming orders at {{DEBUG}} level before the order is processed:
{code:java}
from("activemq:orders").to("log:com.mycompany.order?level=DEBUG").to("bean:processOrder");
{code}

{code:xml}
  <route>
    <from uri="activemq:orders"/>
    <to uri="log:com.mycompany.order?level=DEBUG"/>
    <to uri="bean:processOrder"/>
  </route> 
{code}

h3. Regular logger with formatter sample
In the route below we log the incoming orders at {{INFO}} level before the order is processed.
{code:java}

from("activemq:orders").
    to("log:com.mycompany.order?showAll=true&multiline=true").to("bean:processOrder");
{code}

h3. Throughput logger with groupSize sample
In the route below we log the throughput of the incoming orders at {{DEBUG}} level grouped by 

10 messages.
{code:java}
from("activemq:orders").
    to("log:com.mycompany.order?level=DEBUG&groupSize=10").to("bean:processOrder");
{code}

h3. Throughput logger with groupInterval sample

This route will result in message stats logged every 10s, with an initial 60s delay and stats should be displayed even if there isn't any message traffic.

{code:java}

from("activemq:orders").
to("log:com.mycompany.order?level=DEBUG&groupInterval=10000&groupDelay=60000&groupActiveOnly=false").to("bean:processOrder");
{code}

Exchange[Id:ID-machine-local-50656-1234567901234-1-2, ExchangePattern:InOut, 
Properties:{CamelToEndpoint=log://org.apache.camel.component.log.TEST?showAll=true, 
CamelCreatedTimestamp=Thu Mar 28 00:00:00 WET 2013}, 
Headers:{breadcrumbId=ID-machine-local-50656-1234567901234-1-1}, BodyType:String, Body:Hello World, Out: null]
{code}

 [{{ExchangeFormatter}}|http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/spi/ExchangeFormatter.html] interface. Within the {{format(Exchange)}} method you have access to the full Exchange, so you can select and extract the precise information you need, format it in a custom manner and return it. The return value will become the final log message.

You can have the Log component pick up your custom {{ExchangeFormatter}} in either of two ways:

*Explicitly instantiating the LogComponent in your Registry:*

{code}
<bean name="log" class="org.apache.camel.component.log.LogComponent">
   <property name="exchangeFormatter" ref="myCustomFormatter" />
</bean>
{code}

*Convention over configuration:*

Simply by registering a bean with the name {{logFormatter}}; the Log Component is intelligent enough to pick it up automatically.

{code}

<bean name="logFormatter" class="com.xyz.MyCustomExchangeFormatter" />
{code}