org.springframework.amqp.rabbit.log4j2

Class AmqpAppender

java.lang.Object

org.apache.logging.log4j.core.AbstractLifeCycle

org.apache.logging.log4j.core.filter.AbstractFilterable

org.apache.logging.log4j.core.appender.AbstractAppender

org.springframework.amqp.rabbit.log4j2.AmqpAppender

All Implemented Interfaces:

org.apache.logging.log4j.core.Appender, org.apache.logging.log4j.core.filter.Filterable, org.apache.logging.log4j.core.impl.LocationAware, org.apache.logging.log4j.core.LifeCycle, org.apache.logging.log4j.core.LifeCycle2

@Plugin(name="RabbitMQ",
        category="Core",
        elementType="appender",
        printObject=true)
public class AmqpAppender
extends org.apache.logging.log4j.core.appender.AbstractAppender

A Log4j 2 appender that publishes logging events to an AMQP Exchange.

Since:

1.6

Author:

Gary Russell, Stephen Oakey, Artem Bilan, Dominique Villard, Nicolas Ristock, Eugene Gusev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AmqpAppender.AmqpManager Manager class for the appender.
protected static class	AmqpAppender.Event Helper class to encapsulate a LoggingEvent, its MDC properties, and the number of retries.
protected class	AmqpAppender.EventSender Helper class to actually send LoggingEvents asynchronously.

Nested classes/interfaces inherited from class org.apache.logging.log4j.core.appender.AbstractAppender

org.apache.logging.log4j.core.appender.AbstractAppender.Builder<B extends org.apache.logging.log4j.core.appender.AbstractAppender.Builder<B>>

Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle

org.apache.logging.log4j.core.LifeCycle.State

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLICATION_ID Key name for the application id (if there is one set via the appender config) in the message properties.
static String	CATEGORY_LEVEL Key name for the logger level name in the message properties.
static String	CATEGORY_NAME Key name for the logger category name in the message properties.
static String	THREAD_NAME Key name for the thread name in the message properties.

Fields inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER

Fields inherited from interface org.apache.logging.log4j.core.Appender

ELEMENT_TYPE

Constructor Summary

Constructors

Constructor and Description
AmqpAppender(String name, org.apache.logging.log4j.core.Filter filter, org.apache.logging.log4j.core.Layout<? extends Serializable> layout, boolean ignoreExceptions, AmqpAppender.AmqpManager manager, BlockingQueue<AmqpAppender.Event> eventQueue)

Method Summary

Modifier and Type	Method and Description
void	append(org.apache.logging.log4j.core.LogEvent event)
static AmqpAppender	createAppender(org.apache.logging.log4j.core.config.Configuration configuration, String name, org.apache.logging.log4j.core.Layout<? extends Serializable> layout, org.apache.logging.log4j.core.Filter filter, boolean ignoreExceptions, URI uri, String host, String port, String addresses, String user, String password, String virtualHost, boolean useSsl, boolean verifyHostname, String sslAlgorithm, String sslPropertiesLocation, String keyStore, String keyStorePassphrase, String keyStoreType, String trustStore, String trustStorePassphrase, String trustStoreType, String saslConfig, int senderPoolSize, int maxSenderRetries, String applicationId, String routingKeyPattern, boolean generateId, String deliveryMode, String exchange, String exchangeType, boolean declareExchange, boolean durable, boolean autoDelete, String contentType, String contentEncoding, String connectionName, String clientConnectionProperties, boolean async, String charset, int bufferSize, org.apache.logging.log4j.core.async.BlockingQueueFactory<AmqpAppender.Event> blockingQueueFactory, boolean addMdcAsHeaders)
protected void	doSend(AmqpAppender.Event event, org.apache.logging.log4j.core.LogEvent logEvent, MessageProperties amqpProps)
int	getQueuedEventCount() Return the number of events waiting to be sent.
protected Message	postProcessMessageBeforeSend(Message message, AmqpAppender.Event event) Subclasses may modify the final message before sending.
protected void	sendEvent(AmqpAppender.Event event, Map<?,?> properties)
protected boolean	stop(long timeout, TimeUnit timeUnit, boolean changeLifeCycleState)

Methods inherited from class org.apache.logging.log4j.core.appender.AbstractAppender

error, error, error, getHandler, getLayout, getName, ignoreExceptions, parseInt, requiresLocation, setHandler, toSerializable, toString

Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilterable

addFilter, getFilter, getPropertyArray, hasFilter, isFiltered, removeFilter, start, stop

Methods inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

equalsImpl, getState, getStatusLogger, hashCodeImpl, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, stop, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.logging.log4j.core.LifeCycle

getState, initialize, isStarted, isStopped, start, stop

Field Detail

APPLICATION_ID

public static final String APPLICATION_ID

Key name for the application id (if there is one set via the appender config) in the message properties.

See Also:

Constant Field Values

CATEGORY_NAME

public static final String CATEGORY_NAME

Key name for the logger category name in the message properties.

See Also:

Constant Field Values

CATEGORY_LEVEL

public static final String CATEGORY_LEVEL

Key name for the logger level name in the message properties.

See Also:

Constant Field Values

THREAD_NAME

public static final String THREAD_NAME

Key name for the thread name in the message properties.

See Also:

Constant Field Values

Constructor Detail

AmqpAppender

public AmqpAppender(String name,
                    org.apache.logging.log4j.core.Filter filter,
                    org.apache.logging.log4j.core.Layout<? extends Serializable> layout,
                    boolean ignoreExceptions,
                    AmqpAppender.AmqpManager manager,
                    BlockingQueue<AmqpAppender.Event> eventQueue)

Method Detail

createAppender

@PluginFactory
public static AmqpAppender createAppender(@PluginConfiguration
                                                         org.apache.logging.log4j.core.config.Configuration configuration,
                                                         @PluginAttribute(value="name")
                                                         String name,
                                                         @PluginElement(value="Layout")
                                                         org.apache.logging.log4j.core.Layout<? extends Serializable> layout,
                                                         @PluginElement(value="Filter")
                                                         org.apache.logging.log4j.core.Filter filter,
                                                         @PluginAttribute(value="ignoreExceptions")
                                                         boolean ignoreExceptions,
                                                         @PluginAttribute(value="uri")
                                                         URI uri,
                                                         @PluginAttribute(value="host")
                                                         String host,
                                                         @PluginAttribute(value="port")
                                                         String port,
                                                         @PluginAttribute(value="addresses")
                                                         String addresses,
                                                         @PluginAttribute(value="user")
                                                         String user,
                                                         @PluginAttribute(value="password")
                                                         String password,
                                                         @PluginAttribute(value="virtualHost")
                                                         String virtualHost,
                                                         @PluginAttribute(value="useSsl")
                                                         boolean useSsl,
                                                         @PluginAttribute(value="verifyHostname")
                                                         boolean verifyHostname,
                                                         @PluginAttribute(value="sslAlgorithm")
                                                         String sslAlgorithm,
                                                         @PluginAttribute(value="sslPropertiesLocation")
                                                         String sslPropertiesLocation,
                                                         @PluginAttribute(value="keyStore")
                                                         String keyStore,
                                                         @PluginAttribute(value="keyStorePassphrase")
                                                         String keyStorePassphrase,
                                                         @PluginAttribute(value="keyStoreType")
                                                         String keyStoreType,
                                                         @PluginAttribute(value="trustStore")
                                                         String trustStore,
                                                         @PluginAttribute(value="trustStorePassphrase")
                                                         String trustStorePassphrase,
                                                         @PluginAttribute(value="trustStoreType")
                                                         String trustStoreType,
                                                         @PluginAttribute(value="saslConfig")
                                                         String saslConfig,
                                                         @PluginAttribute(value="senderPoolSize")
                                                         int senderPoolSize,
                                                         @PluginAttribute(value="maxSenderRetries")
                                                         int maxSenderRetries,
                                                         @PluginAttribute(value="applicationId")
                                                         String applicationId,
                                                         @PluginAttribute(value="routingKeyPattern")
                                                         String routingKeyPattern,
                                                         @PluginAttribute(value="generateId")
                                                         boolean generateId,
                                                         @PluginAttribute(value="deliveryMode")
                                                         String deliveryMode,
                                                         @PluginAttribute(value="exchange")
                                                         String exchange,
                                                         @PluginAttribute(value="exchangeType")
                                                         String exchangeType,
                                                         @PluginAttribute(value="declareExchange")
                                                         boolean declareExchange,
                                                         @PluginAttribute(value="durable")
                                                         boolean durable,
                                                         @PluginAttribute(value="autoDelete")
                                                         boolean autoDelete,
                                                         @PluginAttribute(value="contentType")
                                                         String contentType,
                                                         @PluginAttribute(value="contentEncoding")
                                                         String contentEncoding,
                                                         @PluginAttribute(value="connectionName")
                                                         String connectionName,
                                                         @PluginAttribute(value="clientConnectionProperties")
                                                         String clientConnectionProperties,
                                                         @PluginAttribute(value="async")
                                                         boolean async,
                                                         @PluginAttribute(value="charset")
                                                         String charset,
                                                         @PluginAttribute(value="bufferSize",defaultInt=2147483647)
                                                         int bufferSize,
                                                         @PluginElement(value="BlockingQueueFactory")
                                                         org.apache.logging.log4j.core.async.BlockingQueueFactory<AmqpAppender.Event> blockingQueueFactory,
                                                         @PluginAttribute(value="addMdcAsHeaders",defaultBoolean=true)
                                                         boolean addMdcAsHeaders)

append

public void append(org.apache.logging.log4j.core.LogEvent event)

postProcessMessageBeforeSend

protected Message postProcessMessageBeforeSend(Message message,
                                               AmqpAppender.Event event)

Subclasses may modify the final message before sending.

Parameters:

message - The message.

event - The event.

Returns:

The modified message.

sendEvent

protected void sendEvent(AmqpAppender.Event event,
                         Map<?,?> properties)

doSend

protected void doSend(AmqpAppender.Event event,
                      org.apache.logging.log4j.core.LogEvent logEvent,
                      MessageProperties amqpProps)

stop

protected boolean stop(long timeout,
                       TimeUnit timeUnit,
                       boolean changeLifeCycleState)

Overrides:

stop in class org.apache.logging.log4j.core.filter.AbstractFilterable

getQueuedEventCount

public int getQueuedEventCount()

Return the number of events waiting to be sent.

Returns:

the number of events waiting to be sent.