com.swrve.ratelimitedlogger

Class RateLimitedLog

java.lang.Object

com.swrve.ratelimitedlogger.RateLimitedLog

All Implemented Interfaces:

org.slf4j.Logger

@ThreadSafe
public class RateLimitedLog
extends java.lang.Object
implements org.slf4j.Logger

An SLF4J-compatible API for rate-limited logging. Example usage:

    private static final Logger logger = LoggerFactory.getLogger(getClass());
    private static final RateLimitedLog rateLimitedLog = RateLimitedLog.withRateLimit(logger)
             .maxRate(5).every(Duration.ofSeconds(10))
             .build();
 

This will wrap an existing SLF4J Logger object, allowing a max of 5 messages to be output every 10 seconds, suppressing any more than that. When a log is suppressed, at the end of the 10-second period, another log message is output indicating how many logs were hidden. This style of rate limiting is the same as the one used by UNIX syslog, so should be comprehensible, easy to predict, and familiar to many users, unlike more complex adaptive rate limits. Each log message has its own internal rate limiting counter. In other words, if you have 2 log messages, you can safely reuse the same RateLimitedLog object to log both, and the rate of one will not caused the other to be suppressed as a side effect. However, this means that if you wish to include dynamic, variable data in the log output, you will need to use SLF4J-style templates, instead of ("foo " + bar + " baz") string interpolation. For example:

    rateLimitedLog.info("Just saw an event of type {}: {}", event.getType(), event);
 

"{}" will implicitly invoke an object's toString() method, so toString() does not need to be called explicitly when logging. (This has obvious performance benefits, in that those toString() methods will not be called at all once the rate limits have been exceeded.) Where performance is critical, note that you can obtain a reference to the RateLimitedLogWithPattern object for an individual log template, which will avoid a ConcurrentHashMap lookup. The RateLimitedLog objects are thread-safe.

Field Summary

Fields inherited from interface org.slf4j.Logger

ROOT_LOGGER_NAME

Method Summary

Modifier and Type	Method and Description
void	debug(org.slf4j.Marker marker, java.lang.String msg)
void	debug(org.slf4j.Marker marker, java.lang.String format, java.lang.Object... argArray)
void	debug(org.slf4j.Marker marker, java.lang.String format, java.lang.Object arg)
void	debug(org.slf4j.Marker marker, java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)
void	debug(org.slf4j.Marker marker, java.lang.String msg, java.lang.Throwable t)
void	debug(java.lang.String msg)
void	debug(java.lang.String format, java.lang.Object... arguments)
void	debug(java.lang.String format, java.lang.Object arg)
void	debug(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)
void	debug(java.lang.String msg, java.lang.Throwable t)
void	error(org.slf4j.Marker marker, java.lang.String msg)
void	error(org.slf4j.Marker marker, java.lang.String format, java.lang.Object... argArray)
void	error(org.slf4j.Marker marker, java.lang.String format, java.lang.Object arg)
void	error(org.slf4j.Marker marker, java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)
void	error(org.slf4j.Marker marker, java.lang.String msg, java.lang.Throwable t)
void	error(java.lang.String msg)
void	error(java.lang.String format, java.lang.Object... arguments)
void	error(java.lang.String format, java.lang.Object arg)
void	error(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)
void	error(java.lang.String msg, java.lang.Throwable t)
RateLimitedLogWithPattern	get(java.lang.String message)
LogWithPatternAndLevel	get(java.lang.String pattern, Level level)
java.lang.String	getName()
void	info(org.slf4j.Marker marker, java.lang.String msg)
void	info(org.slf4j.Marker marker, java.lang.String format, java.lang.Object... argArray)
void	info(org.slf4j.Marker marker, java.lang.String format, java.lang.Object arg)
void	info(org.slf4j.Marker marker, java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)
void	info(org.slf4j.Marker marker, java.lang.String msg, java.lang.Throwable t)
void	info(java.lang.String msg)
void	info(java.lang.String format, java.lang.Object... arguments)
void	info(java.lang.String format, java.lang.Object arg)
void	info(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)
void	info(java.lang.String msg, java.lang.Throwable t)
boolean	isDebugEnabled()
boolean	isDebugEnabled(org.slf4j.Marker marker)
boolean	isErrorEnabled()
boolean	isErrorEnabled(org.slf4j.Marker marker)
boolean	isInfoEnabled()
boolean	isInfoEnabled(org.slf4j.Marker marker)
boolean	isTraceEnabled()
boolean	isTraceEnabled(org.slf4j.Marker marker)
boolean	isWarnEnabled()
boolean	isWarnEnabled(org.slf4j.Marker marker)
void	trace(org.slf4j.Marker marker, java.lang.String msg)
void	trace(org.slf4j.Marker marker, java.lang.String format, java.lang.Object... argArray)
void	trace(org.slf4j.Marker marker, java.lang.String format, java.lang.Object arg)
void	trace(org.slf4j.Marker marker, java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)
void	trace(org.slf4j.Marker marker, java.lang.String msg, java.lang.Throwable t)
void	trace(java.lang.String msg)
void	trace(java.lang.String format, java.lang.Object... arguments)
void	trace(java.lang.String format, java.lang.Object arg)
void	trace(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)
void	trace(java.lang.String msg, java.lang.Throwable t)
void	warn(org.slf4j.Marker marker, java.lang.String msg)
void	warn(org.slf4j.Marker marker, java.lang.String format, java.lang.Object... argArray)
void	warn(org.slf4j.Marker marker, java.lang.String format, java.lang.Object arg)
void	warn(org.slf4j.Marker marker, java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)
void	warn(org.slf4j.Marker marker, java.lang.String msg, java.lang.Throwable t)
void	warn(java.lang.String msg)
void	warn(java.lang.String format, java.lang.Object... arguments)
void	warn(java.lang.String format, java.lang.Object arg)
void	warn(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)
void	warn(java.lang.String msg, java.lang.Throwable t)
static RateLimitedLogBuilder.MissingRateAndPeriod	withRateLimit(org.slf4j.Logger logger) Start building a new RateLimitedLog, wrapping the SLF4J logger @param logger.

Methods inherited from class java.lang.Object

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

Method Detail

withRateLimit

public static RateLimitedLogBuilder.MissingRateAndPeriod withRateLimit(org.slf4j.Logger logger)

Start building a new RateLimitedLog, wrapping the SLF4J logger @param logger.

getName

public java.lang.String getName()

Specified by:

getName in interface org.slf4j.Logger

isTraceEnabled

public boolean isTraceEnabled()

Specified by:

isTraceEnabled in interface org.slf4j.Logger

trace

public void trace(java.lang.String msg)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(java.lang.String format,
                  java.lang.Object arg)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(java.lang.String format,
                  java.lang.Object arg1,
                  java.lang.Object arg2)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(java.lang.String format,
                  java.lang.Object... arguments)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(java.lang.String msg,
                  java.lang.Throwable t)

Specified by:

trace in interface org.slf4j.Logger

isTraceEnabled

public boolean isTraceEnabled(org.slf4j.Marker marker)

Specified by:

isTraceEnabled in interface org.slf4j.Logger

trace

public void trace(org.slf4j.Marker marker,
                  java.lang.String msg)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(org.slf4j.Marker marker,
                  java.lang.String format,
                  java.lang.Object arg)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(org.slf4j.Marker marker,
                  java.lang.String format,
                  java.lang.Object arg1,
                  java.lang.Object arg2)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(org.slf4j.Marker marker,
                  java.lang.String format,
                  java.lang.Object... argArray)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(org.slf4j.Marker marker,
                  java.lang.String msg,
                  java.lang.Throwable t)

Specified by:

trace in interface org.slf4j.Logger

isDebugEnabled

public boolean isDebugEnabled()

Specified by:

isDebugEnabled in interface org.slf4j.Logger

debug

public void debug(java.lang.String msg)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(java.lang.String format,
                  java.lang.Object arg)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(java.lang.String format,
                  java.lang.Object arg1,
                  java.lang.Object arg2)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(java.lang.String format,
                  java.lang.Object... arguments)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(java.lang.String msg,
                  java.lang.Throwable t)

Specified by:

debug in interface org.slf4j.Logger

isDebugEnabled

public boolean isDebugEnabled(org.slf4j.Marker marker)

Specified by:

isDebugEnabled in interface org.slf4j.Logger

debug

public void debug(org.slf4j.Marker marker,
                  java.lang.String msg)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(org.slf4j.Marker marker,
                  java.lang.String format,
                  java.lang.Object arg)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(org.slf4j.Marker marker,
                  java.lang.String format,
                  java.lang.Object arg1,
                  java.lang.Object arg2)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(org.slf4j.Marker marker,
                  java.lang.String format,
                  java.lang.Object... argArray)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(org.slf4j.Marker marker,
                  java.lang.String msg,
                  java.lang.Throwable t)

Specified by:

debug in interface org.slf4j.Logger

isInfoEnabled

public boolean isInfoEnabled()

Specified by:

isInfoEnabled in interface org.slf4j.Logger

info

public void info(java.lang.String msg)

Specified by:

info in interface org.slf4j.Logger

info

public void info(java.lang.String format,
                 java.lang.Object arg)

Specified by:

info in interface org.slf4j.Logger

info

public void info(java.lang.String format,
                 java.lang.Object arg1,
                 java.lang.Object arg2)

Specified by:

info in interface org.slf4j.Logger

info

public void info(java.lang.String format,
                 java.lang.Object... arguments)

Specified by:

info in interface org.slf4j.Logger

info

public void info(java.lang.String msg,
                 java.lang.Throwable t)

Specified by:

info in interface org.slf4j.Logger

isInfoEnabled

public boolean isInfoEnabled(org.slf4j.Marker marker)

Specified by:

isInfoEnabled in interface org.slf4j.Logger

info

public void info(org.slf4j.Marker marker,
                 java.lang.String msg)

Specified by:

info in interface org.slf4j.Logger

info

public void info(org.slf4j.Marker marker,
                 java.lang.String format,
                 java.lang.Object arg)

Specified by:

info in interface org.slf4j.Logger

info

public void info(org.slf4j.Marker marker,
                 java.lang.String format,
                 java.lang.Object arg1,
                 java.lang.Object arg2)

Specified by:

info in interface org.slf4j.Logger

info

public void info(org.slf4j.Marker marker,
                 java.lang.String format,
                 java.lang.Object... argArray)

Specified by:

info in interface org.slf4j.Logger

info

public void info(org.slf4j.Marker marker,
                 java.lang.String msg,
                 java.lang.Throwable t)

Specified by:

info in interface org.slf4j.Logger

isWarnEnabled

public boolean isWarnEnabled()

Specified by:

isWarnEnabled in interface org.slf4j.Logger

warn

public void warn(java.lang.String msg)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(java.lang.String format,
                 java.lang.Object arg)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(java.lang.String format,
                 java.lang.Object arg1,
                 java.lang.Object arg2)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(java.lang.String format,
                 java.lang.Object... arguments)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(java.lang.String msg,
                 java.lang.Throwable t)

Specified by:

warn in interface org.slf4j.Logger

isWarnEnabled

public boolean isWarnEnabled(org.slf4j.Marker marker)

Specified by:

isWarnEnabled in interface org.slf4j.Logger

warn

public void warn(org.slf4j.Marker marker,
                 java.lang.String msg)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(org.slf4j.Marker marker,
                 java.lang.String format,
                 java.lang.Object arg)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(org.slf4j.Marker marker,
                 java.lang.String format,
                 java.lang.Object arg1,
                 java.lang.Object arg2)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(org.slf4j.Marker marker,
                 java.lang.String format,
                 java.lang.Object... argArray)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(org.slf4j.Marker marker,
                 java.lang.String msg,
                 java.lang.Throwable t)

Specified by:

warn in interface org.slf4j.Logger

isErrorEnabled

public boolean isErrorEnabled()

Specified by:

isErrorEnabled in interface org.slf4j.Logger

error

public void error(java.lang.String msg)

Specified by:

error in interface org.slf4j.Logger

error

public void error(java.lang.String format,
                  java.lang.Object arg)

Specified by:

error in interface org.slf4j.Logger

error

public void error(java.lang.String format,
                  java.lang.Object arg1,
                  java.lang.Object arg2)

Specified by:

error in interface org.slf4j.Logger

error

public void error(java.lang.String format,
                  java.lang.Object... arguments)

Specified by:

error in interface org.slf4j.Logger

error

public void error(java.lang.String msg,
                  java.lang.Throwable t)

Specified by:

error in interface org.slf4j.Logger

isErrorEnabled

public boolean isErrorEnabled(org.slf4j.Marker marker)

Specified by:

isErrorEnabled in interface org.slf4j.Logger

error

public void error(org.slf4j.Marker marker,
                  java.lang.String msg)

Specified by:

error in interface org.slf4j.Logger

error

public void error(org.slf4j.Marker marker,
                  java.lang.String format,
                  java.lang.Object arg)

Specified by:

error in interface org.slf4j.Logger

error

public void error(org.slf4j.Marker marker,
                  java.lang.String format,
                  java.lang.Object arg1,
                  java.lang.Object arg2)

Specified by:

error in interface org.slf4j.Logger

error

public void error(org.slf4j.Marker marker,
                  java.lang.String format,
                  java.lang.Object... argArray)

Specified by:

error in interface org.slf4j.Logger

error

public void error(org.slf4j.Marker marker,
                  java.lang.String msg,
                  java.lang.Throwable t)

Specified by:

error in interface org.slf4j.Logger

get

public RateLimitedLogWithPattern get(java.lang.String message)

Returns:

a RateLimitedLogWithPattern object for the supplied @param message. This can be cached and reused by callers in performance-sensitive cases to avoid performing a ConcurrentHashMap lookup. Note that the string is the sole key used, so the same string cannot be reused with differing period settings; any periods which differ from the first one used are ignored. The first 8192 characters of the message are used as the key, so if an extremely long log pattern is used, with differences only after that threshold, they will share the same rate limiter.

Throws:

java.lang.IllegalStateException - if we exceed the limit on number of RateLimitedLogWithPattern objects in any one period; if this happens, it's probable that an already-interpolated string is accidentally being used as a log pattern.

get

public LogWithPatternAndLevel get(java.lang.String pattern,
                                  Level level)

Parameters:

level - . This can be cached and reused by callers in performance-sensitive cases to avoid performing two ConcurrentHashMap lookups. Note that the string is the sole key used, so the same string cannot be reused with differing period settings; any periods which differ from the first one used are ignored.

Returns:

a LogWithPatternAndLevel object for the supplied @param message and

Throws:

java.lang.IllegalStateException - if we exceed the limit on number of RateLimitedLogWithPattern objects in any one period; if this happens, it's probable that an already-interpolated string is accidentally being used as a log pattern.