org.apache.logging.log4j.core.async

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

    • Constructor Detail

      • AsyncQueueFullPolicyFactory

        public AsyncQueueFullPolicyFactory()

    • Method Detail

      • 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

Copyright © 1999-2018 The Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.