org.wikidata.query.rdf.common.log

Class PerLoggerThrottler

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.filter.Filter<ch.qos.logback.classic.spi.ILoggingEvent>

org.wikidata.query.rdf.common.log.PerLoggerThrottler

All Implemented Interfaces:

ch.qos.logback.core.spi.ContextAware, ch.qos.logback.core.spi.LifeCycle

public class PerLoggerThrottler
extends ch.qos.logback.core.filter.Filter<ch.qos.logback.classic.spi.ILoggingEvent>

Throttle log messages per logger. In some cases, a single logger will start generating huge amount of messages. Throttling per logger can ensure that the logging backend (for example logstash) is not overloaded, while keeping low frequency messages flowing. This filter can be applied to any logback appender via the usual logback config file. See logback documentation for more details on filters. Note that instance variables of this class are not synchronized or final. They are set only at filter initialization (via Joran) and are assumed to be safely published.

Field Summary

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

context

Constructor Summary

Constructors

Constructor and Description
PerLoggerThrottler()

Method Summary

Modifier and Type	Method and Description
ch.qos.logback.core.spi.FilterReply	decide(ch.qos.logback.classic.spi.ILoggingEvent event)
void	setCacheSize(long cacheSize) Number of log entries to keep track of.
void	setPeriodInMillis(long periodInMillis) Period over which to count messages.
void	setThreshold(long threshold) Threshold over which logs are discarded.

Methods inherited from class ch.qos.logback.core.filter.Filter

getName, isStarted, setName, start, 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

PerLoggerThrottler

public PerLoggerThrottler()

Method Detail

decide

public ch.qos.logback.core.spi.FilterReply decide(ch.qos.logback.classic.spi.ILoggingEvent event)

Specified by:

decide in class ch.qos.logback.core.filter.Filter<ch.qos.logback.classic.spi.ILoggingEvent>

setCacheSize

public void setCacheSize(long cacheSize)

Number of log entries to keep track of. Used by Joran to configure this filter.

setPeriodInMillis

public void setPeriodInMillis(long periodInMillis)

Period over which to count messages. Used by Joran to configure this filter.

setThreshold

public void setThreshold(long threshold)

Threshold over which logs are discarded. Used by Joran to configure this filter.