Class AsyncQueueFullPolicyFactory

java.lang.Object
org.apache.logging.log4j.core.async.AsyncQueueFullPolicyFactory

public class AsyncQueueFullPolicyFactory extends Object
Creates AsyncQueueFullPolicy instances based on user-specified system properties. The AsyncQueueFullPolicy created by this factory is used in AsyncLogger, AsyncLoggerConfig and AsyncAppender to control if events are logged in the current thread, the background thread, or discarded.

Property "log4j2.AsyncQueueFullPolicy" controls the routing behaviour. If this property is not specified or has value "Default", this factory creates DefaultAsyncQueueFullPolicy objects.

If this property has value "Discard", this factory creates DiscardingAsyncQueueFullPolicy objects. By default, this router discards events of level INFO, DEBUG and TRACE if the queue is full. This can be adjusted with property "log4j2.DiscardThreshold" (name of the level at which to start discarding).

For any other value, this factory interprets the value as the fully qualified name of a class implementing the AsyncQueueFullPolicy interface. The class must have a default constructor.

Since:
2.6
  • Field Details

    • PROPERTY_NAME_ASYNC_EVENT_ROUTER

      static final String PROPERTY_NAME_ASYNC_EVENT_ROUTER
      See Also:
    • PROPERTY_VALUE_DEFAULT_ASYNC_EVENT_ROUTER

      static final String PROPERTY_VALUE_DEFAULT_ASYNC_EVENT_ROUTER
      See Also:
    • PROPERTY_VALUE_DISCARDING_ASYNC_EVENT_ROUTER

      static final String PROPERTY_VALUE_DISCARDING_ASYNC_EVENT_ROUTER
      See Also:
    • PROPERTY_NAME_DISCARDING_THRESHOLD_LEVEL

      static final String PROPERTY_NAME_DISCARDING_THRESHOLD_LEVEL
      See Also:
    • LOGGER

      private static final Logger LOGGER
  • Constructor Details

    • AsyncQueueFullPolicyFactory

      public AsyncQueueFullPolicyFactory()
  • Method Details

    • create

      public static AsyncQueueFullPolicy create()
      Creates and returns AsyncQueueFullPolicy instances based on user-specified system properties.

      Property "log4j2.AsyncQueueFullPolicy" controls the routing behaviour. If this property is not specified or has value "Default", this method returns DefaultAsyncQueueFullPolicy objects.

      If this property has value "Discard", this method returns DiscardingAsyncQueueFullPolicy objects.

      For any other value, this method interprets the value as the fully qualified name of a class implementing the AsyncQueueFullPolicy interface. The class must have a default constructor.

      Returns:
      a new AsyncQueueFullPolicy
    • isRouterSelected

      private static boolean isRouterSelected(String propertyValue, Class<? extends AsyncQueueFullPolicy> policy, String shortPropertyValue)
    • createCustomRouter

      private static AsyncQueueFullPolicy createCustomRouter(String router)
    • createDiscardingAsyncQueueFullPolicy

      private static AsyncQueueFullPolicy createDiscardingAsyncQueueFullPolicy()