org.apache.logging.log4j.core.filter
Class DynamicThresholdFilter

java.lang.Object
  org.apache.logging.log4j.core.filter.FilterBase
      org.apache.logging.log4j.core.filter.DynamicThresholdFilter

All Implemented Interfaces:

Filter, Lifecycle

public final class DynamicThresholdFilter
extends FilterBase

Compare against a log level that is associated with an MDC value.

Nested Class Summary

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

Filter.Result

Field Summary

Fields inherited from class org.apache.logging.log4j.core.filter.FilterBase

LOGGER, onMatch, onMismatch

Method Summary

static DynamicThresholdFilter	createFilter(String key, ValueLevelPair[] pairs, String level, String match, String mismatch) Create the DynamicThresholdFilter.
Filter.Result	filter(LogEvent event) Context Filter method.
Filter.Result	filter(Logger logger, org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, org.apache.logging.log4j.message.Message msg, Throwable t) Appender Filter method.
Filter.Result	filter(Logger logger, org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, Object msg, Throwable t) Appender Filter method.
Filter.Result	filter(Logger logger, org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String msg, Object[] params) Appender Filter method.
String	getKey()
String	toString()

Methods inherited from class org.apache.logging.log4j.core.filter.FilterBase

getOnMatch, getOnMismatch, isStarted, start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getKey

public String getKey()

filter

public Filter.Result filter(Logger logger,
                            org.apache.logging.log4j.Level level,
                            org.apache.logging.log4j.Marker marker,
                            String msg,
                            Object[] params)

Description copied from class: FilterBase

Appender Filter method. The default returns NEUTRAL.

Specified by:

filter in interface Filter

Overrides:

filter in class FilterBase

Parameters:

logger - the Logger.

level - 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,
                            org.apache.logging.log4j.Level level,
                            org.apache.logging.log4j.Marker marker,
                            Object msg,
                            Throwable t)

Description copied from class: FilterBase

Appender Filter method. The default returns NEUTRAL.

Specified by:

filter in interface Filter

Overrides:

filter in class FilterBase

Parameters:

logger - the Logger.

level - 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,
                            org.apache.logging.log4j.Level level,
                            org.apache.logging.log4j.Marker marker,
                            org.apache.logging.log4j.message.Message msg,
                            Throwable t)

Description copied from class: FilterBase

Appender Filter method. The default returns NEUTRAL.

Specified by:

filter in interface Filter

Overrides:

filter in class FilterBase

Parameters:

logger - the Logger.

level - 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(LogEvent event)

Description copied from class: FilterBase

Context Filter method. The default returns NEUTRAL.

Specified by:

filter in interface Filter

Overrides:

filter in class FilterBase

Parameters:

event - The LogEvent.

Returns:

The Result of filtering.

toString

public String toString()

Overrides:

toString in class FilterBase

createFilter

public static DynamicThresholdFilter createFilter(String key,
                                                  ValueLevelPair[] pairs,
                                                  String level,
                                                  String match,
                                                  String mismatch)

Create the DynamicThresholdFilter.

Parameters:

key - The name of the key to compare.

pairs - An array of value and Level pairs.

level - The default Level.

match - The action to perform if a match occurs.

mismatch - The action to perform if no match occurs.

Returns:

The DynamicThresholdFilter.