Package org.apache.logging.log4j.core.async

Interface AsyncQueueFullPolicy

All Known Implementing Classes:
DefaultAsyncQueueFullPolicy, DiscardingAsyncQueueFullPolicy
public interface AsyncQueueFullPolicy
Policy for deciding whether to discard the event, enqueue it or log the event on the current thread when the queue is full.

The asynchronous logging queue may become full when the application is logging faster than the underlying appender can keep up with for a long enough time to fill up the bounded queue. When this happens, the logging subsystem has to choose what to do with the event:

  • Enqueue the event. This will block until the background thread removes a log event from the queue and space for new events becomes available in the queue. There is a risk of causing deadlock here when the new logging call was made while processing another logging call, for example when Log4j calls toString() on a message parameter, and the parameter object makes a logging call from its toString() method.
  • Bypass the queue and send the event directly to the underlying appenders. This is the default policy used by Log4j since 2.7: see DefaultAsyncQueueFullPolicy. The benefit of this approach is that events will not get lost, but the disadvantage is that the resulting log file will be confusing for users, since log events will appear in the log file in random order: new events that are directly logged are followed by older log events taken from the queue.
  • Discard the event. Log4j offers a variation of this policy where log events that are more verbose than a certain threshold are discarded, and other events are sent to the underlying appenders. See DiscardingAsyncQueueFullPolicy for details.

See AsyncQueueFullPolicyFactory for how to install a custom policy.

Since:
2.6
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    EventRoute
    getRoute(long backgroundThreadId, Level level)
    Returns the appropriate route for the current log event, given the specified parameters.

  • Method Details

    • getRoute

      EventRoute getRoute(long backgroundThreadId, Level level)
      Returns the appropriate route for the current log event, given the specified parameters.
      Parameters:
      backgroundThreadId - the thread ID of the background thread. Can be compared with the current thread's ID.
      level - the level of the log event
      Returns:
      the appropriate route for the current event