@Plugin(name="BurstFilter", category="Core", elementType="filter", printObject=true) public final class BurstFilter extends AbstractFilter
BurstFilter is a logging filter that regulates logging traffic.
Use this filter when you want to control the maximum burst of log statements that can be sent to an appender. The filter is configured in the log4j configuration file. For example, the following configuration limits the number of INFO level (as well as DEBUG and TRACE) log statements that can be sent to the console to a burst of 100 with an average rate of 16 per second. WARN, ERROR and FATAL messages would continue to be delivered.
<Console name="console">
<PatternLayout pattern="%-5p %d{dd-MMM-yyyy HH:mm:ss} %x %t %m%n"/>
<Filters>
<BurstFilter level="INFO" rate="16" maxBurst="100"/>
</Filters>
</Console>
| Modifier and Type | Class and Description |
|---|---|
static class |
BurstFilter.Builder |
AbstractFilter.AbstractFilterBuilder<B extends AbstractFilter.AbstractFilterBuilder<B>>Filter.ResultLifeCycle.StateonMatch, onMismatchDEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGERELEMENT_TYPE, EMPTY_ARRAY| Modifier and Type | Method and Description |
|---|---|
void |
clear()
Clear the history.
|
Filter.Result |
filter(LogEvent event)
Context Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
Message msg,
Throwable t)
Appender Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
Object msg,
Throwable t)
Appender Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
String msg,
Object... params)
Appender Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
String msg,
Object p0)
Appender Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
String msg,
Object p0,
Object p1)
Appender Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
String msg,
Object p0,
Object p1,
Object p2)
Appender Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
String msg,
Object p0,
Object p1,
Object p2,
Object p3)
Appender Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
String msg,
Object p0,
Object p1,
Object p2,
Object p3,
Object p4)
Appender Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
String msg,
Object p0,
Object p1,
Object p2,
Object p3,
Object p4,
Object p5)
Appender Filter method.
|
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)
Appender Filter method.
|
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)
Appender Filter method.
|
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)
Appender Filter method.
|
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)
Appender Filter method.
|
int |
getAvailable()
Returns the number of available slots.
|
static BurstFilter.Builder |
newBuilder() |
String |
toString() |
equalsImpl, getOnMatch, getOnMismatch, hashCodeImplgetState, getStatusLogger, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, start, stop, stop, stoppublic Filter.Result filter(Logger logger, Level level, Marker marker, String msg, Object... params)
AbstractFilterfilter in interface Filterfilter in class AbstractFilterlogger - the Logger.level - The logging Level.marker - The Marker, if any.msg - The message, if present.params - An array of parameters or null.public Filter.Result filter(Logger logger, Level level, Marker marker, Object msg, Throwable t)
AbstractFilterfilter in interface Filterfilter in class AbstractFilterlogger - the Logger.level - The logging Level.marker - The Marker, if any.msg - The message, if present.t - A throwable or null.public Filter.Result filter(Logger logger, Level level, Marker marker, Message msg, Throwable t)
AbstractFilterfilter in interface Filterfilter in class AbstractFilterlogger - the Logger.level - The logging Level.marker - The Marker, if any.msg - The message, if present.t - A throwable or null.public Filter.Result filter(LogEvent event)
AbstractFilterfilter in interface Filterfilter in class AbstractFilterevent - The LogEvent.public Filter.Result filter(Logger logger, Level level, Marker marker, String msg, Object p0)
AbstractFilterfilter in interface Filterfilter in class AbstractFilterlogger - the Logger.level - The logging Level.marker - The Marker, if any.msg - The message, if present.p0 - the message parameterspublic Filter.Result filter(Logger logger, Level level, Marker marker, String msg, Object p0, Object p1)
AbstractFilterfilter in interface Filterfilter in class AbstractFilterlogger - the Logger.level - The logging Level.marker - The Marker, if any.msg - The message, if present.p0 - the message parametersp1 - the message parameterspublic Filter.Result filter(Logger logger, Level level, Marker marker, String msg, Object p0, Object p1, Object p2)
AbstractFilterfilter in interface Filterfilter in class AbstractFilterlogger - the Logger.level - The logging Level.marker - The Marker, if any.msg - The message, if present.p0 - the message parametersp1 - the message parametersp2 - the message parameterspublic Filter.Result filter(Logger logger, Level level, Marker marker, String msg, Object p0, Object p1, Object p2, Object p3)
AbstractFilterfilter in interface Filterfilter in class AbstractFilterlogger - the Logger.level - The logging Level.marker - The Marker, if any.msg - The message, if present.p0 - the message parametersp1 - the message parametersp2 - the message parametersp3 - the message parameterspublic Filter.Result filter(Logger logger, Level level, Marker marker, String msg, Object p0, Object p1, Object p2, Object p3, Object p4)
AbstractFilterfilter in interface Filterfilter in class AbstractFilterlogger - the Logger.level - The logging Level.marker - The Marker, if any.msg - The message, if present.p0 - the message parametersp1 - the message parametersp2 - the message parametersp3 - the message parametersp4 - the message parameterspublic Filter.Result filter(Logger logger, Level level, Marker marker, String msg, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5)
AbstractFilterfilter in interface Filterfilter in class AbstractFilterlogger - the Logger.level - The logging Level.marker - The Marker, if any.msg - The message, if present.p0 - the message parametersp1 - the message parametersp2 - the message parametersp3 - the message parametersp4 - the message parametersp5 - the message parameterspublic 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)
AbstractFilterfilter in interface Filterfilter in class AbstractFilterlogger - the Logger.level - The logging Level.marker - The Marker, if any.msg - The message, if present.p0 - the message parametersp1 - the message parametersp2 - the message parametersp3 - the message parametersp4 - the message parametersp5 - the message parametersp6 - the message parameterspublic 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)
AbstractFilterfilter in interface Filterfilter in class AbstractFilterlogger - the Logger.level - The logging Level.marker - The Marker, if any.msg - The message, if present.p0 - the message parametersp1 - the message parametersp2 - the message parametersp3 - the message parametersp4 - the message parametersp5 - the message parametersp6 - the message parametersp7 - the message parameterspublic 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)
AbstractFilterfilter in interface Filterfilter in class AbstractFilterlogger - the Logger.level - The logging Level.marker - The Marker, if any.msg - The message, if present.p0 - the message parametersp1 - the message parametersp2 - the message parametersp3 - the message parametersp4 - the message parametersp5 - the message parametersp6 - the message parametersp7 - the message parametersp8 - the message parameterspublic 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)
AbstractFilterfilter in interface Filterfilter in class AbstractFilterlogger - the Logger.level - The logging Level.marker - The Marker, if any.msg - The message, if present.p0 - the message parametersp1 - the message parametersp2 - the message parametersp3 - the message parametersp4 - the message parametersp5 - the message parametersp6 - the message parametersp7 - the message parametersp8 - the message parametersp9 - the message parameterspublic int getAvailable()
public void clear()
public String toString()
toString in class AbstractFilter@PluginBuilderFactory public static BurstFilter.Builder newBuilder()
Copyright © 1999-2023 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.