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(String s, Throwable t) and error(String 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(String message)
void	debug(String message, Object object)
void	debug(String message, Object arg1, Object arg2)
void	debug(String message, Throwable t)
void	error(String message)
void	error(String message, Throwable t)
void	errorWithTrace(String message)
void	info(String message)
void	info(String message, Throwable t)
boolean	isDebugEnabled()
boolean	isInfoEnabled()
protected boolean	wantFullStackTrace()
void	warn(String message)
void	warn(String message, Throwable t)
void	warnWithTrace(String 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

debug

public void debug(String message)

debug

public void debug(String message,
                  Object object)

debug

public void debug(String message,
                  Object arg1,
                  Object arg2)

debug

public void debug(String message,
                  Throwable t)

error

public void error(String message)

error

public void error(String message,
                  Throwable t)

isDebugEnabled

public boolean isDebugEnabled()

isInfoEnabled

public boolean isInfoEnabled()

info

public void info(String message)

info

public void info(String message,
                 Throwable t)

warn

public void warn(String message)

warnWithTrace

public void warnWithTrace(String message)

errorWithTrace

public void errorWithTrace(String message)

warn

public void warn(String message,
                 Throwable t)

wantFullStackTrace

protected boolean wantFullStackTrace()