NewAsyncAppender (reload4j 1.2.26 API)

java.lang.Object
- org.apache.log4j.AppenderSkeleton
- - org.apache.log4j.NewAsyncAppender

All Implemented Interfaces:: Appender, AppenderAttachable, OptionHandler

public class NewAsyncAppender
extends AppenderSkeleton
implements AppenderAttachable

An asynchronous appender closely reproducing the behaviour of logback's AsyncAppender.

See Logback's AsyncAppender documentation for configuration options.

Here is a sample configuration file for NewAsyncAppender.

 <log4j:configuration debug="true"
                      xmlns:log4j='http://jakarta.apache.org/log4j/'>

    <appender name="FILE" class="org.apache.log4j.FileAppender">
      <param name="File"   value="/tmp/foobar.log" />
      <param name="Append" value="false" />

      <layout class="org.apache.log4j.PatternLayout">
        <param name="ConversionPattern" value="%-5p %c{2} - %m%n"/>
      </layout>
   </appender>

     <appender name="ASYNC" class="org.apache.log4j.NewAsyncAppender">
         <param name="QueueSize" value="512"/>
         <appender-ref ref="FILE"/>
     </appender>

     <root>
         <level value="info"/>
         <appender-ref ref="ASYNC"/>
     </root>

 </log4j:configuration>

Note: NewAyncAppedner requires DOMConfigurator, i.e. XML configuration format.

Since:: 1.2.26

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_MAX_FLUSH_TIME` The default maximum queue flush time allowed during appender stop.
`static int`	`DEFAULT_QUEUE_SIZE` The default buffer size.

Fields inherited from class org.apache.log4j.AppenderSkeleton
closed, errorHandler, headFilter, layout, name, tailFilter, threshold

Constructor Summary

Constructors
Constructor and Description

NewAsyncAppender()

Constructors
Constructor and Description
`NewAsyncAppender()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`activateOptions()` Derived appenders should override this method if option structure requires it.
`void`	`addAppender(Appender newAppender)` Add an appender.
`protected void`	`append(LoggingEvent event)` Subclasses of `AppenderSkeleton` should implement this method to perform actual logging.
`void`	`close()` Release any resources allocated within the appender such as file handles, network connections, etc.
`Enumeration`	`getAllAppenders()` Get all previously added appenders as an Enumeration.
`Appender`	`getAppender(String name)` Get an appender by name.
`int`	`getDiscardingThreshold()`
`int`	`getMaxFlushTime()`
`int`	`getQueueSize()`
`boolean`	`isAttached(Appender appender)` Returns `true` if the specified appender is in list of attached attached, `false` otherwise.
`protected boolean`	`isDiscardable(LoggingEvent event)` Events of level TRACE, DEBUG and INFO are deemed to be discardable.
`boolean`	`isIncludeCallerData()`
`boolean`	`isNeverBlock()`
`boolean`	`isQueueBelowDiscardingThreshold()`
`protected void`	`preprocess(LoggingEvent eventObject)`
`void`	`removeAllAppenders()` Remove all previously added appenders.
`void`	`removeAppender(Appender appender)` Remove the appender passed as parameter from the list of appenders.
`void`	`removeAppender(String name)` Remove the appender with the name passed as parameter from the list of appenders.
`boolean`	`requiresLayout()` Configurators call this method to determine if the appender requires a layout.
`void`	`setDiscardingThreshold(int discardingThreshold)`
`void`	`setIncludeCallerData(boolean includeCallerData)`
`void`	`setMaxFlushTime(int maxFlushTime)`
`void`	`setNeverBlock(boolean neverBlock)`
`void`	`setQueueSize(int queueSize)`

Methods inherited from class org.apache.log4j.AppenderSkeleton
addFilter, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setErrorHandler, setLayout, setName, setThreshold

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

- Field Detail
  - DEFAULT_QUEUE_SIZE
```
public static final int DEFAULT_QUEUE_SIZE
```
    The default buffer size.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_FLUSH_TIME
```
public static final int DEFAULT_MAX_FLUSH_TIME
```
    The default maximum queue flush time allowed during appender stop. If the worker takes longer than this time it will exit, discarding any remaining items in the queue
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - NewAsyncAppender
```
public NewAsyncAppender()
```
- Method Detail
  - activateOptions
```
public void activateOptions()
```
    Description copied from class: AppenderSkeleton
    
    Derived appenders should override this method if option structure requires it.
    
    Specified by:
    
    activateOptions in interface OptionHandler
    
    Overrides:
    
    activateOptions in class AppenderSkeleton
  - append
```
protected void append(LoggingEvent event)
```
    Description copied from class: AppenderSkeleton
    
    Subclasses of AppenderSkeleton should implement this method to perform actual logging. See also AppenderSkeleton.doAppend method.
    
    Specified by:
    
    append in class AppenderSkeleton
  - isQueueBelowDiscardingThreshold
```
public boolean isQueueBelowDiscardingThreshold()
```
  - isDiscardable
```
protected boolean isDiscardable(LoggingEvent event)
```
    Events of level TRACE, DEBUG and INFO are deemed to be discardable.
    
    Parameters:
    
    event -
    
    Returns:
    
    true if the event is of level TRACE, DEBUG or INFO false otherwise.
  - preprocess
```
protected void preprocess(LoggingEvent eventObject)
```
  - close
```
public void close()
```
    Description copied from interface: Appender
    
    Release any resources allocated within the appender such as file handles, network connections, etc.
    It is a programming error to append to a closed appender.
    
    Specified by:
    
    close in interface Appender
  - requiresLayout
```
public boolean requiresLayout()
```
    Description copied from interface: Appender
    
    Configurators call this method to determine if the appender requires a layout. If this method returns true, meaning that layout is required, then the configurator will configure an layout using the configuration information at its disposal. If this method returns false, meaning that a layout is not required, then layout configuration will be skipped even if there is available layout configuration information at the disposal of the configurator..
    In the rather exceptional case, where the appender implementation admits a layout but can also work without it, then the appender should return true.
    
    Specified by:
    
    requiresLayout in interface Appender
  - addAppender
```
public void addAppender(Appender newAppender)
```
    Description copied from interface: AppenderAttachable
    
    Add an appender.
    
    Specified by:
    
    addAppender in interface AppenderAttachable
  - getAllAppenders
```
public Enumeration getAllAppenders()
```
    Description copied from interface: AppenderAttachable
    
    Get all previously added appenders as an Enumeration.
    
    Specified by:
    
    getAllAppenders in interface AppenderAttachable
  - getAppender
```
public Appender getAppender(String name)
```
    Description copied from interface: AppenderAttachable
    
    Get an appender by name.
    
    Specified by:
    
    getAppender in interface AppenderAttachable
  - isAttached
```
public boolean isAttached(Appender appender)
```
    Description copied from interface: AppenderAttachable
    
    Returns true if the specified appender is in list of attached attached, false otherwise.
    
    Specified by:
    
    isAttached in interface AppenderAttachable
  - removeAllAppenders
```
public void removeAllAppenders()
```
    Description copied from interface: AppenderAttachable
    
    Remove all previously added appenders.
    
    Specified by:
    
    removeAllAppenders in interface AppenderAttachable
  - removeAppender
```
public void removeAppender(Appender appender)
```
    Description copied from interface: AppenderAttachable
    
    Remove the appender passed as parameter from the list of appenders.
    
    Specified by:
    
    removeAppender in interface AppenderAttachable
  - removeAppender
```
public void removeAppender(String name)
```
    Description copied from interface: AppenderAttachable
    
    Remove the appender with the name passed as parameter from the list of appenders.
    
    Specified by:
    
    removeAppender in interface AppenderAttachable
  - getQueueSize
```
public int getQueueSize()
```
  - setQueueSize
```
public void setQueueSize(int queueSize)
```
  - getDiscardingThreshold
```
public int getDiscardingThreshold()
```
  - setDiscardingThreshold
```
public void setDiscardingThreshold(int discardingThreshold)
```
  - getMaxFlushTime
```
public int getMaxFlushTime()
```
  - setMaxFlushTime
```
public void setMaxFlushTime(int maxFlushTime)
```
  - setNeverBlock
```
public void setNeverBlock(boolean neverBlock)
```
  - isNeverBlock
```
public boolean isNeverBlock()
```
  - isIncludeCallerData
```
public boolean isIncludeCallerData()
```
  - setIncludeCallerData
```
public void setIncludeCallerData(boolean includeCallerData)
```

Class NewAsyncAppender

Field Summary

Fields inherited from class org.apache.log4j.AppenderSkeleton

Constructor Summary

Method Summary

Methods inherited from class org.apache.log4j.AppenderSkeleton

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_QUEUE_SIZE

DEFAULT_MAX_FLUSH_TIME

Constructor Detail

NewAsyncAppender

Method Detail

activateOptions

append

isQueueBelowDiscardingThreshold

isDiscardable

preprocess

close

requiresLayout

addAppender

getAllAppenders

getAppender

isAttached

removeAllAppenders

removeAppender

removeAppender

getQueueSize

setQueueSize

getDiscardingThreshold

setDiscardingThreshold

getMaxFlushTime

setMaxFlushTime

setNeverBlock

isNeverBlock

isIncludeCallerData

setIncludeCallerData