Class AsyncLoggerConfig

  • All Implemented Interfaces:
    Filterable, LocationAware, LifeCycle, LifeCycle2

    @Plugin(name="asyncLogger",
            category="Core",
            printObject=true)
    public class AsyncLoggerConfig
    extends LoggerConfig
    Asynchronous Logger object that is created via configuration and can be combined with synchronous loggers.

    AsyncLoggerConfig is a logger designed for high throughput and low latency logging. It does not perform any I/O in the calling (application) thread, but instead hands off the work to another thread as soon as possible. The actual logging is performed in the background thread. It uses LMAX Disruptor for inter-thread communication.

    To use AsyncLoggerConfig, specify <asyncLogger> or <asyncRoot> in configuration.

    Note that for performance reasons, this logger does not include source location by default. You need to specify includeLocation="true" in the configuration or any %class, %location or %line conversion patterns in your log4j.xml configuration will produce either a "?" character or no output at all.

    For best performance, use AsyncLoggerConfig with the RandomAccessFileAppender or RollingRandomAccessFileAppender, with immediateFlush=false. These appenders have built-in support for the batching mechanism used by the Disruptor library, and they will flush to disk at the end of each batch. This means that even with immediateFlush=false, there will never be any items left in the buffer; all log events will all be written to disk in a very efficient manner.

    • Field Detail

      • ASYNC_LOGGER_ENTERED

        private static final java.lang.ThreadLocal<java.lang.Boolean> ASYNC_LOGGER_ENTERED
    • Constructor Detail

      • AsyncLoggerConfig

        protected AsyncLoggerConfig​(java.lang.String name,
                                    java.util.List<AppenderRef> appenders,
                                    Filter filter,
                                    Level level,
                                    boolean additive,
                                    Property[] properties,
                                    Configuration config,
                                    boolean includeLocation)
    • Method Detail

      • logToAsyncDelegate

        private void logToAsyncDelegate​(LogEvent event)
      • handleQueueFull

        private void handleQueueFull​(LogEvent event)
      • populateLazilyInitializedFields

        private void populateLazilyInitializedFields​(LogEvent event)
      • logInBackgroundThread

        void logInBackgroundThread​(LogEvent event)
      • logToAsyncLoggerConfigsOnCurrentThread

        void logToAsyncLoggerConfigsOnCurrentThread​(LogEvent event)
        Called by AsyncLoggerConfigHelper.RingBufferLog4jEventHandler. This method will log the provided event to only configs of type AsyncLoggerConfig (not default LoggerConfig definitions), which will be invoked on the calling thread.
      • displayName

        private java.lang.String displayName()
      • stop

        public boolean stop​(long timeout,
                            java.util.concurrent.TimeUnit timeUnit)
        Description copied from class: AbstractFilterable
        Cleanup the Filter.
        Specified by:
        stop in interface LifeCycle2
        Overrides:
        stop in class AbstractFilterable
        Parameters:
        timeout - the maximum time to wait
        timeUnit - the time unit of the timeout argument
        Returns:
        true if the receiver was stopped cleanly and normally, false otherwise.
      • createRingBufferAdmin

        public RingBufferAdmin createRingBufferAdmin​(java.lang.String contextName)
        Creates and returns a new RingBufferAdmin that instruments the ringbuffer of this AsyncLoggerConfig.
        Parameters:
        contextName - name of the LoggerContext
        Returns:
        a new RingBufferAdmin that instruments the ringbuffer
      • createLogger

        @Deprecated
        public static LoggerConfig createLogger​(java.lang.String additivity,
                                                java.lang.String levelName,
                                                java.lang.String loggerName,
                                                java.lang.String includeLocation,
                                                AppenderRef[] refs,
                                                Property[] properties,
                                                Configuration config,
                                                Filter filter)
        Factory method to create a LoggerConfig.
        Parameters:
        additivity - True if additive, false otherwise.
        levelName - The Level to be associated with the Logger.
        loggerName - The name of the Logger.
        includeLocation - "true" if location should be passed downstream
        refs - An array of Appender names.
        properties - Properties to pass to the Logger.
        config - The Configuration.
        filter - A Filter.
        Returns:
        A new LoggerConfig.
      • includeLocation

        protected static boolean includeLocation​(java.lang.String includeLocationConfigValue)