Chapter 258. OSGi PAX Logging Component

Available as of Camel version 2.6

The paxlogging component can be used in an OSGi environment to receive PaxLogging events and process them.

258.1. Dependencies

Maven users need to add the following dependency to their pom.xml

<dependency>
  <groupId>org.apache.camel</groupId>
  <artifactId>camel-paxlogging</artifactId>
  <version>${camel-version}</version>
</dependency>

where ${camel-version} must be replaced by the actual version of Camel (2.6.0 or higher).

258.2. URI format

paxlogging:appender[?options]

where appender is the name of the pax appender that need to be configured in the PaxLogging service configuration.

258.3. URI options

The OSGi PAX Logging component supports 2 options which are listed below.

NameDescriptionDefaultType

bundleContext (consumer)

The OSGi BundleContext is automatic injected by Camel

 

BundleContext

resolveProperty Placeholders (advanced)

Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.

true

boolean

The OSGi PAX Logging endpoint is configured using URI syntax:

paxlogging:appender

with the following path and query parameters:

258.3.1. Path Parameters (1 parameters):

NameDescriptionDefaultType

appender

Required Appender is the name of the pax appender that need to be configured in the PaxLogging service configuration.

 

String

258.3.2. Query Parameters (4 parameters):

NameDescriptionDefaultType

bridgeErrorHandler (consumer)

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 or ERROR level and ignored.

false

boolean

exceptionHandler (consumer)

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 or ERROR level and ignored.

 

ExceptionHandler

exchangePattern (consumer)

Sets the exchange pattern when the consumer creates an exchange.

 

ExchangePattern

synchronous (advanced)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

boolean

258.4. Message body

The in message body will be set to the received PaxLoggingEvent.

258.5. Example usage

<route>
    <from uri="paxlogging:camel"/>
    <to uri="stream:out"/>
</route>

Configuration:

log4j.rootLogger=INFO, out, osgi:VmLogAppender, osgi:camel