org.wikidata.query.rdf.common.log

Class RateLimitFilter

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.RateLimitFilter

All Implemented Interfaces:

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

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

Logback Filter to limit logging events to a maximum rate. This is meant as a last resort to avoid overloading logging backends (mainly logstash). Logging should still be tuned to avoid reaching this limit at all. Once this filter starts dropping log events, it will not differentiate and will silently drop all events that are over the limit. Monitoring of this filter should be done indirectly (logging rate in the backend). This filter can be applied to any logback appender via the usual logback config file. See logback documentation for more details on filters. See bucket4j for more details on the token bucket implementation backing this filter.

Field Summary

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

context

Constructor Summary

Constructors

Constructor and Description
RateLimitFilter()

Method Summary

Modifier and Type	Method and Description
ch.qos.logback.core.spi.FilterReply	decide(ch.qos.logback.classic.spi.ILoggingEvent event) Deny logging if over limit, neutral otherwise.
void	setBucketCapacity(int bucketCapacity)
void	setRefillIntervalInMillis(long refillIntervalInMillis)

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

RateLimitFilter

public RateLimitFilter()

Method Detail

setBucketCapacity

public void setBucketCapacity(int bucketCapacity)

setRefillIntervalInMillis

public void setRefillIntervalInMillis(long refillIntervalInMillis)

decide

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

Deny logging if over limit, neutral otherwise.

Specified by:

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