Class ThresholdFilter

  • All Implemented Interfaces:
    Filter, LifeCycle, LifeCycle2

    @Plugin(name="ThresholdFilter",
            category="Core",
            elementType="filter",
            printObject=true)
    public final class ThresholdFilter
    extends AbstractFilter
    This filter returns the onMatch result if the level in the LogEvent is the same or more specific than the configured level and the onMismatch value otherwise. For example, if the ThresholdFilter is configured with Level ERROR and the LogEvent contains Level DEBUG then the onMismatch value will be returned since ERROR events are more specific than DEBUG. The default Level is ERROR.
    • Method Detail

      • filter

        public Filter.Result filter​(Logger logger,
                                    Level testLevel,
                                    Marker marker,
                                    String msg,
                                    Object... params)
        Description copied from class: AbstractFilter
        Appender Filter method. The default returns NEUTRAL.
        Specified by:
        filter in interface Filter
        Overrides:
        filter in class AbstractFilter
        Parameters:
        logger - the Logger.
        testLevel - The logging Level.
        marker - The Marker, if any.
        msg - The message, if present.
        params - An array of parameters or null.
        Returns:
        The Result of filtering.
      • filter

        public Filter.Result filter​(Logger logger,
                                    Level testLevel,
                                    Marker marker,
                                    Object msg,
                                    Throwable t)
        Description copied from class: AbstractFilter
        Appender Filter method. The default returns NEUTRAL.
        Specified by:
        filter in interface Filter
        Overrides:
        filter in class AbstractFilter
        Parameters:
        logger - the Logger.
        testLevel - The logging Level.
        marker - The Marker, if any.
        msg - The message, if present.
        t - A throwable or null.
        Returns:
        The Result of filtering.
      • filter

        public Filter.Result filter​(Logger logger,
                                    Level testLevel,
                                    Marker marker,
                                    Message msg,
                                    Throwable t)
        Description copied from class: AbstractFilter
        Appender Filter method. The default returns NEUTRAL.
        Specified by:
        filter in interface Filter
        Overrides:
        filter in class AbstractFilter
        Parameters:
        logger - the Logger.
        testLevel - The logging Level.
        marker - The Marker, if any.
        msg - The message, if present.
        t - A throwable or null.
        Returns:
        The Result of filtering.
      • filter

        public Filter.Result filter​(Logger logger,
                                    Level level,
                                    Marker marker,
                                    String msg,
                                    Object p0)
        Description copied from class: AbstractFilter
        Appender Filter method. The default returns NEUTRAL.
        Specified by:
        filter in interface Filter
        Overrides:
        filter in class AbstractFilter
        Parameters:
        logger - the Logger.
        level - The logging Level.
        marker - The Marker, if any.
        msg - The message, if present.
        p0 - the message parameters
        Returns:
        The Result of filtering.
      • filter

        public Filter.Result filter​(Logger logger,
                                    Level level,
                                    Marker marker,
                                    String msg,
                                    Object p0,
                                    Object p1)
        Description copied from class: AbstractFilter
        Appender Filter method. The default returns NEUTRAL.
        Specified by:
        filter in interface Filter
        Overrides:
        filter in class AbstractFilter
        Parameters:
        logger - the Logger.
        level - The logging Level.
        marker - The Marker, if any.
        msg - The message, if present.
        p0 - the message parameters
        p1 - the message parameters
        Returns:
        The Result of filtering.
      • filter

        public Filter.Result filter​(Logger logger,
                                    Level level,
                                    Marker marker,
                                    String msg,
                                    Object p0,
                                    Object p1,
                                    Object p2)
        Description copied from class: AbstractFilter
        Appender Filter method. The default returns NEUTRAL.
        Specified by:
        filter in interface Filter
        Overrides:
        filter in class AbstractFilter
        Parameters:
        logger - the Logger.
        level - The logging Level.
        marker - The Marker, if any.
        msg - The message, if present.
        p0 - the message parameters
        p1 - the message parameters
        p2 - the message parameters
        Returns:
        The Result of filtering.
      • filter

        public Filter.Result filter​(Logger logger,
                                    Level level,
                                    Marker marker,
                                    String msg,
                                    Object p0,
                                    Object p1,
                                    Object p2,
                                    Object p3)
        Description copied from class: AbstractFilter
        Appender Filter method. The default returns NEUTRAL.
        Specified by:
        filter in interface Filter
        Overrides:
        filter in class AbstractFilter
        Parameters:
        logger - the Logger.
        level - The logging Level.
        marker - The Marker, if any.
        msg - The message, if present.
        p0 - the message parameters
        p1 - the message parameters
        p2 - the message parameters
        p3 - the message parameters
        Returns:
        The Result of filtering.
      • filter

        public Filter.Result filter​(Logger logger,
                                    Level level,
                                    Marker marker,
                                    String msg,
                                    Object p0,
                                    Object p1,
                                    Object p2,
                                    Object p3,
                                    Object p4)
        Description copied from class: AbstractFilter
        Appender Filter method. The default returns NEUTRAL.
        Specified by:
        filter in interface Filter
        Overrides:
        filter in class AbstractFilter
        Parameters:
        logger - the Logger.
        level - The logging Level.
        marker - The Marker, if any.
        msg - The message, if present.
        p0 - the message parameters
        p1 - the message parameters
        p2 - the message parameters
        p3 - the message parameters
        p4 - the message parameters
        Returns:
        The Result of filtering.
      • filter

        public Filter.Result filter​(Logger logger,
                                    Level level,
                                    Marker marker,
                                    String msg,
                                    Object p0,
                                    Object p1,
                                    Object p2,
                                    Object p3,
                                    Object p4,
                                    Object p5)
        Description copied from class: AbstractFilter
        Appender Filter method. The default returns NEUTRAL.
        Specified by:
        filter in interface Filter
        Overrides:
        filter in class AbstractFilter
        Parameters:
        logger - the Logger.
        level - The logging Level.
        marker - The Marker, if any.
        msg - The message, if present.
        p0 - the message parameters
        p1 - the message parameters
        p2 - the message parameters
        p3 - the message parameters
        p4 - the message parameters
        p5 - the message parameters
        Returns:
        The Result of filtering.
      • filter

        public Filter.Result filter​(Logger logger,
                                    Level level,
                                    Marker marker,
                                    String msg,
                                    Object p0,
                                    Object p1,
                                    Object p2,
                                    Object p3,
                                    Object p4,
                                    Object p5,
                                    Object p6)
        Description copied from class: AbstractFilter
        Appender Filter method. The default returns NEUTRAL.
        Specified by:
        filter in interface Filter
        Overrides:
        filter in class AbstractFilter
        Parameters:
        logger - the Logger.
        level - The logging Level.
        marker - The Marker, if any.
        msg - The message, if present.
        p0 - the message parameters
        p1 - the message parameters
        p2 - the message parameters
        p3 - the message parameters
        p4 - the message parameters
        p5 - the message parameters
        p6 - the message parameters
        Returns:
        The Result of filtering.
      • filter

        public Filter.Result filter​(Logger logger,
                                    Level level,
                                    Marker marker,
                                    String msg,
                                    Object p0,
                                    Object p1,
                                    Object p2,
                                    Object p3,
                                    Object p4,
                                    Object p5,
                                    Object p6,
                                    Object p7)
        Description copied from class: AbstractFilter
        Appender Filter method. The default returns NEUTRAL.
        Specified by:
        filter in interface Filter
        Overrides:
        filter in class AbstractFilter
        Parameters:
        logger - the Logger.
        level - The logging Level.
        marker - The Marker, if any.
        msg - The message, if present.
        p0 - the message parameters
        p1 - the message parameters
        p2 - the message parameters
        p3 - the message parameters
        p4 - the message parameters
        p5 - the message parameters
        p6 - the message parameters
        p7 - the message parameters
        Returns:
        The Result of filtering.
      • filter

        public Filter.Result filter​(Logger logger,
                                    Level level,
                                    Marker marker,
                                    String msg,
                                    Object p0,
                                    Object p1,
                                    Object p2,
                                    Object p3,
                                    Object p4,
                                    Object p5,
                                    Object p6,
                                    Object p7,
                                    Object p8)
        Description copied from class: AbstractFilter
        Appender Filter method. The default returns NEUTRAL.
        Specified by:
        filter in interface Filter
        Overrides:
        filter in class AbstractFilter
        Parameters:
        logger - the Logger.
        level - The logging Level.
        marker - The Marker, if any.
        msg - The message, if present.
        p0 - the message parameters
        p1 - the message parameters
        p2 - the message parameters
        p3 - the message parameters
        p4 - the message parameters
        p5 - the message parameters
        p6 - the message parameters
        p7 - the message parameters
        p8 - the message parameters
        Returns:
        The Result of filtering.
      • filter

        public Filter.Result filter​(Logger logger,
                                    Level level,
                                    Marker marker,
                                    String msg,
                                    Object p0,
                                    Object p1,
                                    Object p2,
                                    Object p3,
                                    Object p4,
                                    Object p5,
                                    Object p6,
                                    Object p7,
                                    Object p8,
                                    Object p9)
        Description copied from class: AbstractFilter
        Appender Filter method. The default returns NEUTRAL.
        Specified by:
        filter in interface Filter
        Overrides:
        filter in class AbstractFilter
        Parameters:
        logger - the Logger.
        level - The logging Level.
        marker - The Marker, if any.
        msg - The message, if present.
        p0 - the message parameters
        p1 - the message parameters
        p2 - the message parameters
        p3 - the message parameters
        p4 - the message parameters
        p5 - the message parameters
        p6 - the message parameters
        p7 - the message parameters
        p8 - the message parameters
        p9 - the message parameters
        Returns:
        The Result of filtering.
      • getLevel

        public Level getLevel()