AmqpAppender (Spring AMQP 1.5.0.M1 API)

java.lang.Object
- ch.qos.logback.core.spi.ContextAwareBase
- - ch.qos.logback.core.AppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>
  - - org.springframework.amqp.rabbit.logback.AmqpAppender

All Implemented Interfaces:: ch.qos.logback.core.Appender<ch.qos.logback.classic.spi.ILoggingEvent>, ch.qos.logback.core.spi.ContextAware, ch.qos.logback.core.spi.FilterAttachable<ch.qos.logback.classic.spi.ILoggingEvent>, ch.qos.logback.core.spi.LifeCycle

public class AmqpAppender
extends ch.qos.logback.core.AppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

A Lockback appender that publishes logging events to an AMQP Exchange.

A fully-configured AmqpAppender, with every option set to their defaults, would look like this:

 <appender name="AMQP" class="org.springframework.amqp.rabbit.logback.AmqpAppender">
     <layout>
        <pattern><![CDATA[ %d %p %t [%c] - <%m>%n ]]></pattern>
     </layout>
     <!-- <abbreviation>36</abbreviation --> <!-- no category abbreviation by default -->
     <applicationId>AmqpAppenderTest</applicationId>
     <routingKeyPattern>%property{applicationId}.%c.%p</routingKeyPattern>
     <generateId>true</generateId>
     <charset>UTF-8</charset>
     <durable>false</durable>
     <deliveryMode>NON_PERSISTENT</deliveryMode>
 </appender>

Since:: 1.4
Author:: Artem Bilan, Gary Russell

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`AmqpAppender.Event` Small 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.

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

Fields inherited from class ch.qos.logback.core.AppenderBase
name, started

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase
context

Constructor Summary

Constructors
Constructor and Description

AmqpAppender()

Constructors
Constructor and Description
`AmqpAppender()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`append(ch.qos.logback.classic.spi.ILoggingEvent event)`
`String`	`getApplicationId()`
`String`	`getCharset()`
`String`	`getContentEncoding()`
`String`	`getContentType()`
`String`	`getDeliveryMode()`
`String`	`getExchangeName()`
`String`	`getExchangeType()`
`String`	`getHost()`
`int`	`getMaxSenderRetries()`
`String`	`getPassword()`
`int`	`getPort()`
`String`	`getRoutingKeyPattern()`
`int`	`getSenderPoolSize()`
`String`	`getUsername()`
`String`	`getVirtualHost()`
`boolean`	`isAutoDelete()`
`boolean`	`isDeclareExchange()`
`boolean`	`isDurable()`
`boolean`	`isGenerateId()`
`protected void`	`maybeDeclareExchange()` Maybe declare the exchange.
`Message`	`postProcessMessageBeforeSend(Message message, AmqpAppender.Event event)` Subclasses may modify the final message before sending.
`void`	`setAbbreviation(int len)`
`void`	`setApplicationId(String applicationId)`
`void`	`setAutoDelete(boolean autoDelete)`
`void`	`setCharset(String charset)`
`void`	`setContentEncoding(String contentEncoding)`
`void`	`setContentType(String contentType)`
`void`	`setDeclareExchange(boolean declareExchange)`
`void`	`setDeliveryMode(String deliveryMode)`
`void`	`setDurable(boolean durable)`
`void`	`setExchangeName(String exchangeName)`
`void`	`setExchangeType(String exchangeType)`
`void`	`setGenerateId(boolean generateId)`
`void`	`setHost(String host)`
`void`	`setLayout(ch.qos.logback.core.Layout<ch.qos.logback.classic.spi.ILoggingEvent> layout)`
`void`	`setMaxSenderRetries(int maxSenderRetries)`
`void`	`setPassword(String password)`
`void`	`setPort(int port)`
`void`	`setRoutingKeyPattern(String routingKeyPattern)`
`void`	`setSenderPoolSize(int senderPoolSize)`
`void`	`setUsername(String username)`
`void`	`setVirtualHost(String virtualHost)`
`void`	`start()`
`void`	`stop()`

Methods inherited from class ch.qos.logback.core.AppenderBase
addFilter, clearAllFilters, doAppend, getCopyOfAttachedFiltersList, getFilterChainDecision, getName, isStarted, setName, toString

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase
addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ch.qos.logback.core.spi.ContextAware
addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext

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

Constructor Detail
- AmqpAppender
```
public AmqpAppender()
```

Method Detail

setRoutingKeyPattern

public void setRoutingKeyPattern(String routingKeyPattern)

getHost
```
public String getHost()
```

setHost
```
public void setHost(String host)
```

getPort
```
public int getPort()
```

setPort
```
public void setPort(int port)
```

getVirtualHost
```
public String getVirtualHost()
```

setVirtualHost

public void setVirtualHost(String virtualHost)

getUsername
```
public String getUsername()
```

setUsername

public void setUsername(String username)

getPassword
```
public String getPassword()
```

setPassword

public void setPassword(String password)

getExchangeName
```
public String getExchangeName()
```

setExchangeName

public void setExchangeName(String exchangeName)

getExchangeType
```
public String getExchangeType()
```

setExchangeType

public void setExchangeType(String exchangeType)

getRoutingKeyPattern
```
public String getRoutingKeyPattern()
```

isDeclareExchange
```
public boolean isDeclareExchange()
```

setDeclareExchange

public void setDeclareExchange(boolean declareExchange)

getContentType
```
public String getContentType()
```

setContentType

public void setContentType(String contentType)

getContentEncoding
```
public String getContentEncoding()
```

setContentEncoding

public void setContentEncoding(String contentEncoding)

getApplicationId
```
public String getApplicationId()
```

setApplicationId

public void setApplicationId(String applicationId)

getSenderPoolSize
```
public int getSenderPoolSize()
```

setSenderPoolSize

public void setSenderPoolSize(int senderPoolSize)

getMaxSenderRetries
```
public int getMaxSenderRetries()
```

setMaxSenderRetries

public void setMaxSenderRetries(int maxSenderRetries)

isDurable
```
public boolean isDurable()
```

setDurable

public void setDurable(boolean durable)

getDeliveryMode
```
public String getDeliveryMode()
```

setDeliveryMode

public void setDeliveryMode(String deliveryMode)

isAutoDelete
```
public boolean isAutoDelete()
```

setAutoDelete

public void setAutoDelete(boolean autoDelete)

isGenerateId
```
public boolean isGenerateId()
```

setGenerateId

public void setGenerateId(boolean generateId)

getCharset
```
public String getCharset()
```

setCharset

public void setCharset(String charset)

setLayout

public void setLayout(ch.qos.logback.core.Layout<ch.qos.logback.classic.spi.ILoggingEvent> layout)

setAbbreviation
```
public void setAbbreviation(int len)
```

start
```
public void start()
```
Specified by:

start in interface ch.qos.logback.core.spi.LifeCycle

Overrides:

start in class ch.qos.logback.core.AppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

stop
```
public void stop()
```
Specified by:

stop in interface ch.qos.logback.core.spi.LifeCycle

Overrides:

stop in class ch.qos.logback.core.AppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

append
```
protected void append(ch.qos.logback.classic.spi.ILoggingEvent event)
```
Specified by:

append in class ch.qos.logback.core.AppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

maybeDeclareExchange
```
protected void maybeDeclareExchange()
```
Maybe declare the exchange.

postProcessMessageBeforeSend

public 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.
Since:: 1.4

Class AmqpAppender

Nested Class Summary

Field Summary

Fields inherited from class ch.qos.logback.core.AppenderBase

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase

Constructor Summary

Method Summary

Methods inherited from class ch.qos.logback.core.AppenderBase

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase

Methods inherited from class java.lang.Object

Methods inherited from interface ch.qos.logback.core.spi.ContextAware

Field Detail

APPLICATION_ID

CATEGORY_NAME

CATEGORY_LEVEL

Constructor Detail

AmqpAppender

Method Detail

setRoutingKeyPattern

getHost

setHost

getPort

setPort

getVirtualHost

setVirtualHost

getUsername

setUsername

getPassword

setPassword

getExchangeName

setExchangeName

getExchangeType

setExchangeType

getRoutingKeyPattern

isDeclareExchange

setDeclareExchange

getContentType

setContentType

getContentEncoding

setContentEncoding

getApplicationId

setApplicationId

getSenderPoolSize

setSenderPoolSize

getMaxSenderRetries

setMaxSenderRetries

isDurable

setDurable

getDeliveryMode

setDeliveryMode

isAutoDelete

setAutoDelete

isGenerateId

setGenerateId

getCharset

setCharset

setLayout

setAbbreviation

start

stop

append

maybeDeclareExchange

postProcessMessageBeforeSend