Package org.apache.logging.log4j.core.filter

Class BurstFilter.Builder

java.lang.Object

org.apache.logging.log4j.core.filter.AbstractFilter.AbstractFilterBuilder<BurstFilter.Builder>

org.apache.logging.log4j.core.filter.BurstFilter.Builder

All Implemented Interfaces:

Builder<BurstFilter>

Enclosing class:

BurstFilter

public static class BurstFilter.Builder
extends AbstractFilter.AbstractFilterBuilder<BurstFilter.Builder>
implements Builder<BurstFilter>

Field Summary

Fields

Modifier and Type	Field	Description
private Level	level
private long	maxBurst
private float	rate

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

ATTR_ON_MATCH, ATTR_ON_MISMATCH

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BurstFilter	build()	Builds the object after all configuration has been set.
BurstFilter.Builder	setLevel(Level level)	Sets the logging level to use.
BurstFilter.Builder	setMaxBurst(long maxBurst)	Sets the maximum number of events that can occur before events are filtered for exceeding the average rate.
BurstFilter.Builder	setRate(float rate)	Sets the average number of events per second to allow.

Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilter.AbstractFilterBuilder

asBuilder, getOnMatch, getOnMismatch, setOnMatch, setOnMismatch

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.logging.log4j.core.util.Builder

getErrorPrefix, isValid

Field Detail

level

@PluginBuilderAttribute
private Level level

rate

@PluginBuilderAttribute
private float rate

maxBurst

@PluginBuilderAttribute
private long maxBurst

Constructor Detail

Builder

public Builder()

Method Detail

setLevel

public BurstFilter.Builder setLevel(Level level)

Sets the logging level to use.

Parameters:

level - the logging level to use.

Returns:

this

setRate

public BurstFilter.Builder setRate(float rate)

Sets the average number of events per second to allow.

Parameters:

rate - the average number of events per second to allow. This must be a positive number.

Returns:

this

setMaxBurst

public BurstFilter.Builder setMaxBurst(long maxBurst)

Sets the maximum number of events that can occur before events are filtered for exceeding the average rate.

Parameters:

maxBurst - Sets the maximum number of events that can occur before events are filtered for exceeding the average rate. The default is 10 times the rate.

Returns:

this

build

public BurstFilter build()

Description copied from interface: Builder

Builds the object after all configuration has been set. This will use default values for any unspecified attributes for the object.

Specified by:

build in interface Builder<BurstFilter>

Returns:

the configured instance.