com.swrve.ratelimitedlogger

Class RateLimitedLogWithPattern

java.lang.Object

com.swrve.ratelimitedlogger.RateLimitedLogWithPattern

@ThreadSafe
public class RateLimitedLogWithPattern
extends java.lang.Object

An individual log pattern. Each object is rate-limited individually but with separation on the log level. These objects are thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RateLimitedLogWithPattern.RateAndPeriod

Method Summary

Modifier and Type	Method and Description
void	debug(org.slf4j.Marker marker, java.lang.Object... args)
void	debug(org.slf4j.Marker marker, java.lang.Throwable t)
void	debug(java.lang.Object... args)
void	debug(java.lang.Throwable t)
boolean	equals(java.lang.Object o) Two RateLimitedLogWithPattern objects are considered equal if their messages match; the RateAndPeriods are not significant.
void	error(org.slf4j.Marker marker, java.lang.Object... args)
void	error(org.slf4j.Marker marker, java.lang.Throwable t)
void	error(java.lang.Object... args)
void	error(java.lang.Throwable t)
LogWithPatternAndLevel	get(Level level)
int	hashCode()
void	info(org.slf4j.Marker marker, java.lang.Object... args)
void	info(org.slf4j.Marker marker, java.lang.Throwable t)
void	info(java.lang.Object... args)
void	info(java.lang.Throwable t)
void	trace(org.slf4j.Marker marker, java.lang.Object... args)
void	trace(org.slf4j.Marker marker, java.lang.Throwable t)
void	trace(java.lang.Object... args) logging APIs.
void	trace(java.lang.Throwable t)
void	warn(org.slf4j.Marker marker, java.lang.Object... args)
void	warn(org.slf4j.Marker marker, java.lang.Throwable t)
void	warn(java.lang.Object... args)
void	warn(java.lang.Throwable t)

Methods inherited from class java.lang.Object

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

Method Detail

trace

public void trace(java.lang.Object... args)

logging APIs. These can use the SLF4J style of templating to parameterize the Logs. See http://www.slf4j.org/api/org/slf4j/helpers/MessageFormatter.html .

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

Parameters:

args - the varargs list of arguments matching the message template

trace

public void trace(java.lang.Throwable t)

trace

public void trace(org.slf4j.Marker marker,
                  java.lang.Object... args)

trace

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

debug

public void debug(java.lang.Object... args)

debug

public void debug(java.lang.Throwable t)

debug

public void debug(org.slf4j.Marker marker,
                  java.lang.Object... args)

debug

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

info

public void info(java.lang.Object... args)

info

public void info(java.lang.Throwable t)

info

public void info(org.slf4j.Marker marker,
                 java.lang.Object... args)

info

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

warn

public void warn(java.lang.Object... args)

warn

public void warn(java.lang.Throwable t)

warn

public void warn(org.slf4j.Marker marker,
                 java.lang.Object... args)

warn

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

error

public void error(java.lang.Object... args)

error

public void error(java.lang.Throwable t)

error

public void error(org.slf4j.Marker marker,
                  java.lang.Object... args)

error

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

equals

public boolean equals(@Nullable
                      java.lang.Object o)

Two RateLimitedLogWithPattern objects are considered equal if their messages match; the RateAndPeriods are not significant.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

get

public LogWithPatternAndLevel get(Level level)

Returns:

a LogWithPatternAndLevel object for the supplied @param 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.

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.