Class ThreadNameFilter

  • All Implemented Interfaces:
    org.apache.logging.log4j.core.Filter, org.apache.logging.log4j.core.LifeCycle, org.apache.logging.log4j.core.LifeCycle2

    @Plugin(name="ThreadNameFilter",
            category="Core",
            elementType="filter",
            printObject=true)
    public final class ThreadNameFilter
    extends org.apache.logging.log4j.core.filter.AbstractFilter
    Log4j Filter that only allow events from threads matching a regular expression. Events with a level greater than threshold are always logged.
    Since:
    5.2
    Author:
    Dan Berindei
    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.apache.logging.log4j.core.filter.AbstractFilter

        org.apache.logging.log4j.core.filter.AbstractFilter.AbstractFilterBuilder<B extends org.apache.logging.log4j.core.filter.AbstractFilter.AbstractFilterBuilder<B>>
      • Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.Filter

        org.apache.logging.log4j.core.Filter.Result
      • Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle

        org.apache.logging.log4j.core.LifeCycle.State
    • Field Summary

      • Fields inherited from class org.apache.logging.log4j.core.filter.AbstractFilter

        onMatch, onMismatch
      • Fields inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

        DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER
      • Fields inherited from interface org.apache.logging.log4j.core.Filter

        ELEMENT_TYPE, EMPTY_ARRAY
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static ThreadNameFilter createFilter​(org.apache.logging.log4j.Level level, String include)
      Create a ThreadNameFilter.
      org.apache.logging.log4j.core.Filter.Result filter​(org.apache.logging.log4j.core.LogEvent event)  
      org.apache.logging.log4j.core.Filter.Result filter​(org.apache.logging.log4j.core.Logger logger, org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, Object msg, Throwable t)  
      org.apache.logging.log4j.core.Filter.Result filter​(org.apache.logging.log4j.core.Logger logger, org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String msg, Object... params)  
      org.apache.logging.log4j.core.Filter.Result filter​(org.apache.logging.log4j.core.Logger logger, org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, org.apache.logging.log4j.message.Message msg, Throwable t)  
      String toString()  
      • Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilter

        equalsImpl, filter, filter, filter, filter, filter, filter, filter, filter, filter, filter, getOnMatch, getOnMismatch, hashCodeImpl
      • Methods inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

        getState, getStatusLogger, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, start, stop, stop, stop
      • Methods inherited from interface org.apache.logging.log4j.core.LifeCycle

        getState, initialize, isStarted, isStopped, start, stop
    • Method Detail

      • filter

        public org.apache.logging.log4j.core.Filter.Result filter​(org.apache.logging.log4j.core.Logger logger,
                                                                  org.apache.logging.log4j.Level level,
                                                                  org.apache.logging.log4j.Marker marker,
                                                                  String msg,
                                                                  Object... params)
        Specified by:
        filter in interface org.apache.logging.log4j.core.Filter
        Overrides:
        filter in class org.apache.logging.log4j.core.filter.AbstractFilter
      • filter

        public org.apache.logging.log4j.core.Filter.Result filter​(org.apache.logging.log4j.core.Logger logger,
                                                                  org.apache.logging.log4j.Level level,
                                                                  org.apache.logging.log4j.Marker marker,
                                                                  Object msg,
                                                                  Throwable t)
        Specified by:
        filter in interface org.apache.logging.log4j.core.Filter
        Overrides:
        filter in class org.apache.logging.log4j.core.filter.AbstractFilter
      • filter

        public org.apache.logging.log4j.core.Filter.Result filter​(org.apache.logging.log4j.core.Logger logger,
                                                                  org.apache.logging.log4j.Level level,
                                                                  org.apache.logging.log4j.Marker marker,
                                                                  org.apache.logging.log4j.message.Message msg,
                                                                  Throwable t)
        Specified by:
        filter in interface org.apache.logging.log4j.core.Filter
        Overrides:
        filter in class org.apache.logging.log4j.core.filter.AbstractFilter
      • filter

        public org.apache.logging.log4j.core.Filter.Result filter​(org.apache.logging.log4j.core.LogEvent event)
        Specified by:
        filter in interface org.apache.logging.log4j.core.Filter
        Overrides:
        filter in class org.apache.logging.log4j.core.filter.AbstractFilter
      • toString

        public String toString()
        Overrides:
        toString in class org.apache.logging.log4j.core.filter.AbstractFilter
      • createFilter

        @PluginFactory
        public static ThreadNameFilter createFilter​(@PluginAttribute("level")
                                                    org.apache.logging.log4j.Level level,
                                                    @PluginAttribute("include")
                                                    String include)
        Create a ThreadNameFilter.
        Parameters:
        level - The log Level.
        include - The regex
        Returns:
        The created filter.