Module ch.qos.logback.classic

Package ch.qos.logback.classic.turbo

Class TurboFilter

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.classic.turbo.TurboFilter

All Implemented Interfaces:

ContextAware, LifeCycle

Direct Known Subclasses:

DuplicateMessageFilter, DynamicThresholdFilter, MatchingFilter, ReconfigureOnChangeFilter

public abstract class TurboFilter
extends ContextAwareBase
implements LifeCycle

TurboFilter is a specialized filter with a decide method that takes a bunch of parameters instead of a single event object. The latter is cleaner but the first is much more performant.

For more information about turbo filters, please refer to the online manual at https://logback.qos.ch/manual/filters.html#TurboFilter

Author:

Ceki Gulcu

Field Summary

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase

context

Constructor Summary

Constructors

Constructor	Description
TurboFilter()

Method Summary

Modifier and Type	Method	Description
FilterReply	decide(Logger logger, org.slf4j.event.LoggingEvent slf4jEvent)	This method is intended to be called via SLF4J's fluent API and more specifically by Logger.log(org.slf4j.event.LoggingEvent slf4jEvent).
abstract FilterReply	decide(org.slf4j.Marker marker, Logger logger, Level level, String format, Object[] params, Throwable t)	Make a decision based on the multiple parameters passed as arguments.
String	getName()
boolean	isStarted()
void	setName(String name)
void	start()
void	stop()

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContext

Methods inherited from class java.lang.Object

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

Constructor Detail

TurboFilter

public TurboFilter()

Method Detail

decide

public abstract FilterReply decide(org.slf4j.Marker marker,
                                   Logger logger,
                                   Level level,
                                   String format,
                                   Object[] params,
                                   Throwable t)

Make a decision based on the multiple parameters passed as arguments. The returned value should be one of FilterReply.DENY, FilterReply.NEUTRAL, or FilterReply.ACCEPT.

Parameters:

marker -

logger -

level -

format -

params -

t -

Returns:

decide

public FilterReply decide(Logger logger,
                          org.slf4j.event.LoggingEvent slf4jEvent)

This method is intended to be called via SLF4J's fluent API and more specifically by Logger.log(org.slf4j.event.LoggingEvent slf4jEvent). Derived classes are strongly encouraged to override this method with a better suited and more specialized implementation.

The present default implementation translates the given SLF4J LoggingEvent into the set of parameters required by decide(Marker, Logger, Level, String, Object[], Throwable) and delegate the decision to that method.

Concretely, this method:

• extracts the first marker (if any) from the event's marker list,
• maps the SLF4J level to Logback's Level,
• and forwards the event message, arguments and throwable.

Returns the FilterReply produced by decide(...), which should be one of DENY, NEUTRAL or ACCEPT.

Derived classes are strongly encouraged to override this method with a better suited and more specialized implementation.

Parameters:

logger - the Logger that is logging the event; non-null

slf4jEvent - the SLF4J logging event to translate and evaluate; may be non-null

Returns:

the filter decision (DENY, NEUTRAL or ACCEPT)

Since:

1.5.21

start

public void start()

Specified by:

start in interface LifeCycle

isStarted

public boolean isStarted()

Specified by:

isStarted in interface LifeCycle

stop

public void stop()

Specified by:

stop in interface LifeCycle

getName

public String getName()

setName

public void setName(String name)