com.atlassian.jira.util.log

Class RateLimitingLogger

java.lang.Object

com.atlassian.jira.util.log.RateLimitingLogger

public class RateLimitingLogger
extends Object

A logger for use where there is the chance for large numbers of repetitive errors. This Logger will output only a limited number of stacktraces and then will only output error messages for warn(Object s, Throwable t) and error(Object s, Throwable t)

Since:

v6.3

Constructor Summary

Constructors

Constructor and Description
RateLimitingLogger(Class clazz) Create a new logger with defaults for number of stacktraces (25) and time to reset (5 minutes).
RateLimitingLogger(Class clazz, int maxStackTraces, int resetAfterMinutes) Create a new logger

Method Summary

Modifier and Type	Method and Description
void	debug(Object message)
void	debug(Object message, Throwable t)
void	error(Object message)
void	error(Object message, Throwable t)
void	errorWithTrace(Object message)
void	fatal(Object message)
void	fatal(Object message, Throwable t)
void	info(Object message)
void	info(Object message, Throwable t)
boolean	isDebugEnabled()
boolean	isEnabledFor(org.apache.log4j.Priority level)
boolean	isInfoEnabled()
boolean	isTraceEnabled()
void	trace(Object message)
void	trace(Object message, Throwable t)
protected boolean	wantFullStackTrace()
void	warn(Object message)
void	warn(Object message, Throwable t)
void	warnWithTrace(Object message)

Methods inherited from class java.lang.Object

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

Constructor Detail

RateLimitingLogger

public RateLimitingLogger(Class clazz)

Create a new logger with defaults for number of stacktraces (25) and time to reset (5 minutes).

Parameters:

clazz - Class for logger name

RateLimitingLogger

public RateLimitingLogger(Class clazz,
                          int maxStackTraces,
                          int resetAfterMinutes)

Create a new logger

Parameters:

clazz - Class for logger name

maxStackTraces - Maximum number of stacktraces to print before starting suppression.

resetAfterMinutes - Number of minutes where the logger is idle to cause a reset to recommence printing stacktraces.

Method Detail

trace

public void trace(Object message)

trace

public void trace(Object message,
                  Throwable t)

isTraceEnabled

public boolean isTraceEnabled()

debug

public void debug(Object message)

debug

public void debug(Object message,
                  Throwable t)

error

public void error(Object message)

error

public void error(Object message,
                  Throwable t)

fatal

public void fatal(Object message)

fatal

public void fatal(Object message,
                  Throwable t)

isDebugEnabled

public boolean isDebugEnabled()

isEnabledFor

public boolean isEnabledFor(org.apache.log4j.Priority level)

isInfoEnabled

public boolean isInfoEnabled()

info

public void info(Object message)

info

public void info(Object message,
                 Throwable t)

warn

public void warn(Object message)

warnWithTrace

public void warnWithTrace(Object message)

errorWithTrace

public void errorWithTrace(Object message)

warn

public void warn(Object message,
                 Throwable t)

wantFullStackTrace

protected boolean wantFullStackTrace()