Log

Log

Scheme: log
Syntax: log:loggerName
Description: The log component logs message exchanges to the underlying logging mechanism.
Deprecated:false
Maven: org.apache.camel/camel-core/2.17.0.redhat-630377

The log component logs message exchanges to the underlying logging mechanism. Camel uses sfl4j which allows you to configure logging to the actual logging system.

Name Kind Group Required Default Type Enum Description
loggerName path producer true java.lang.String The logger name to use
bridgeErrorHandler parameter consumer boolean Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.

By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN/ERROR level and ignored.

sendEmptyMessageWhenIdle parameter consumer boolean If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.
exceptionHandler parameter consumer (advanced) org.apache.camel.spi.ExceptionHandler To let the consumer use a custom ExceptionHandler. + Notice if the option bridgeErrorHandler is enabled then this options is not in use. + By default the consumer will deal with exceptions, that will be logged at WARN/ERROR level and ignored.
pollStrategy parameter consumer (advanced) org.apache.camel.spi.PollingConsumerPollStrategy A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. In other words the error occurred while the polling was gathering information, for instance access to a file network failed so Camel cannot access it to scan for files. The default implementation will log the caused exception at WARN level and ignore it.
groupActiveOnly parameter producer true java.lang.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.
groupDelay parameter producer java.lang.Long Set the initial delay for stats (in millis)
groupInterval parameter producer java.lang.Long If specified will group message stats by this time interval (in millis)
groupSize parameter producer java.lang.Integer An integer that specifies a group size for throughput logging.
level parameter producer INFO java.lang.String ERROR
WARN
INFO
DEBUG
TRACE
OFF
Logging level to use.

The default value is INFO.

marker parameter producer java.lang.String An optional Marker name to use.
exchangePattern parameter advanced InOnly org.apache.camel.ExchangePattern InOnly
RobustInOnly
InOut
InOptionalOut
OutOnly
RobustOutOnly
OutIn
OutOptionalIn
Sets the default exchange pattern when creating an exchange.
synchronous parameter advanced false boolean Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). @param synchronous true to enforce synchronous processing
backoffErrorThreshold parameter scheduler int The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
backoffIdleThreshold parameter scheduler int The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
backoffMultiplier parameter scheduler int To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
delay parameter scheduler 500 long Milliseconds before the next poll.
greedy parameter scheduler boolean If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
initialDelay parameter scheduler 1000 long Milliseconds before the first poll starts.
runLoggingLevel parameter scheduler TRACE org.apache.camel.LoggingLevel TRACE
DEBUG
INFO
WARN
ERROR
OFF
The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
scheduledExecutorService parameter scheduler java.util.concurrent.ScheduledExecutorService Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. This option allows you to share a thread pool among multiple consumers.
scheduler parameter scheduler none org.apache.camel.spi.ScheduledPollConsumerScheduler none
spring
quartz2
Allow to plugin a custom org.apache.camel.spi.ScheduledPollConsumerScheduler to use as the scheduler for firing when the polling consumer runs. The default implementation uses the ScheduledExecutorService and there is a Quartz2, and Spring based which supports CRON expressions. Notice: If using a custom scheduler then the options for initialDelay, useFixedDelay, timeUnit, and scheduledExecutorService may not be in use. Use the text quartz2 to refer to use the Quartz2 scheduler; and use the text spring to use the Spring based; and use the text #myScheduler to refer to a custom scheduler by its id in the Registry. See Quartz2 page for an example.
schedulerProperties parameter scheduler java.util.Map To configure additional properties when using a custom scheduler or any of the Quartz2, Spring based scheduler.
startScheduler parameter scheduler true boolean Whether the scheduler should be auto started.
timeUnit parameter scheduler MILLISECONDS java.util.concurrent.TimeUnit NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS
Time unit for initialDelay and delay options.
useFixedDelay parameter scheduler true boolean Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
maxChars parameter formatting 10000 int Limits the number of characters logged per line.
multiline parameter formatting boolean If enabled then each information is outputted on a newline.
showAll parameter formatting boolean Quick option for turning all options on. (multiline, maxChars has to be manually set if to be used)
showBody parameter formatting true boolean Show the message body.
showBodyType parameter formatting true boolean Show the body Java type.
showCaughtException parameter formatting boolean f 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 {@link org.apache.camel.Exchange#EXCEPTION_CAUGHT} and for instance a doCatch can catch exceptions.
showException parameter formatting boolean If the exchange has an exception, show the exception message (no stacktrace)
showExchangeId parameter formatting boolean Show the unique exchange ID.
showExchangePattern parameter formatting true boolean Shows the Message Exchange Pattern (or MEP for short).
showFiles parameter formatting boolean If enabled Camel will output files
showFuture parameter formatting boolean If enabled Camel will on Future objects wait for it to complete to obtain the payload to be logged.
showHeaders parameter formatting boolean Show the message headers.
showOut parameter formatting boolean If the exchange has an out message, show the out message.
showProperties parameter formatting boolean Show the exchange properties.
showStackTrace parameter formatting boolean Show the stack trace, if an exchange has an exception. Only effective if one of showAll, showException or showCaughtException are enabled.
showStreams parameter formatting boolean 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.
skipBodyLineSeparator parameter formatting true boolean 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.
style parameter formatting Default org.apache.camel.processor.DefaultExchangeFormatter.OutputStyle Default
Tab
Fixed
Sets the outputs style to use.