Lumberjack Component

Table of Contents

URI format
Options
Result
Lumberjack Usage Samples

Available as of Camel 2.18

The Lumberjack component retrieves logs sent over the network using the Lumberjack protocol, from Filebeat for instance. The network communication can be secured with SSL.

This component only supports consumer endpoints.

Maven users will need to add the following dependency to their pom.xml for this component:

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-lumberjack</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>

URI format

lumberjack:host
lumberjack:host:port

You can append query options to the URI in the following format, ?option=value&option=value&…

Options

The Lumberjack component supports 1 options which are listed below.

{% raw %}

Name	Java Type	Description
sslContextParameters	`SSLContextParameters`	Sets the default SSL configuration to use for all the endpoints. You can also configure it directly at the endpoint level.

{% endraw %}

The Lumberjack component supports 7 endpoint options which are listed below:

{% raw %}

Name	Group	Default	Java Type	Description
host	consumer		`String`	Required Network interface on which to listen for Lumberjack
port	consumer	`5044`	`int`	Network port on which to listen for Lumberjack
bridgeErrorHandler	consumer	`false`	`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.
sslContextParameters	consumer		`SSLContextParameters`	SSL configuration
exceptionHandler	consumer (advanced)		`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.
exchangePattern	consumer (advanced)		`ExchangePattern`	Sets the exchange pattern when the consumer creates an exchange.
synchronous	advanced	`false`	`boolean`	Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).

{% endraw %}

Result

The result body is a Map<String, Object> object.

Lumberjack Usage Samples

Table of Contents

Example 1: Streaming the log messages

Example 1: Streaming the log messages

RouteBuilder builder = new RouteBuilder() {
    public void configure() {
       from("lumberjack:0.0.0.0").                  // Listen on all network interfaces using the default port
           setBody(simple("${body[message]}")).     // Select only the log message
           to("stream:out");                        // Write it into the output stream
    }
};