org.perf4j.slf4j
Class Slf4JStopWatch

java.lang.Object
  extended by org.perf4j.StopWatch
      extended by org.perf4j.LoggingStopWatch
          extended by org.perf4j.slf4j.Slf4JStopWatch
All Implemented Interfaces:
Serializable, Cloneable

public class Slf4JStopWatch
extends LoggingStopWatch

This LoggingStopWatch uses an SLF4J Logger instance to persist the StopWatch messages.

Author:
Alex Devine
See Also:
Serialized Form

Field Summary
static int DEBUG_LEVEL
          Specifying this level will cause the debug() method to be used for logging.
static int ERROR_LEVEL
          Specifying this level will cause the error() method to be used for logging.
static int INFO_LEVEL
          Specifying this level will cause the info() method to be used for logging.
static int TRACE_LEVEL
          Specifying this level will cause the trace() method to be used for logging.
static int WARN_LEVEL
          Specifying this level will cause the warn() method to be used for logging.
 
Fields inherited from class org.perf4j.StopWatch
DEFAULT_LOGGER_NAME
 
Constructor Summary
Slf4JStopWatch()
          Creates a Slf4JStopWatch with a blank tag, no message and started at the instant of creation.
Slf4JStopWatch(Logger logger)
          Creates a Slf4JStopWatch with a blank tag, no message and started at the instant of creation, using the specified Logger to log stop watch messages using the info() method, or using the warn() method if an exception is passed to one of the stop or lap methods.
Slf4JStopWatch(Logger logger, int normalPriority)
          Creates a Slf4JStopWatch with a blank tag, no message and started at the instant of creation, using the specified Logger to log stop watch messages at the normalPriority level specified, or using the warn() method if an exception is passed to one of the stop or lap methods.
Slf4JStopWatch(Logger logger, int normalPriority, int exceptionPriority)
          Creates a Slf4JStopWatch with a blank tag, no message and started at the instant of creation, using the specified Logger to log stop watch messages at the normalPriority level specified, or at the exceptionPriority level if an exception is passed to one of the stop or lap methods.
Slf4JStopWatch(long startTime, long elapsedTime, String tag, String message, Logger logger, int normalPriority, int exceptionPriority)
          This constructor is mainly used for creation of StopWatch instances from logs and for testing.
Slf4JStopWatch(String tag)
          Creates a Slf4JStopWatch with the tag specified, no message and started at the instant of creation.
Slf4JStopWatch(String tag, Logger logger)
          Creates a Slf4JStopWatch with the tag specified, no message and started at the instant of creation, using the specified Logger to log stop watch using the info() method, or using the warn() method if an exception is passed to one of the stop or lap methods.
Slf4JStopWatch(String tag, Logger logger, int normalPriority)
          Creates a Slf4JStopWatch with the tag specified, no message and started at the instant of creation, using the specified Logger to log stop watch messages at the normalPriority level specified, or using the warn() level if an exception is passed to one of the stop or lap methods.
Slf4JStopWatch(String tag, Logger logger, int normalPriority, int exceptionPriority)
          Creates a Slf4JStopWatch with the tag specified, no message and started at the instant of creation, using the specified Logger to log stop watch messages at the normalPriority level specified, or at the exceptionPriority level if an exception is passed to one of the stop or lap methods.
Slf4JStopWatch(String tag, String message)
          Creates a Slf4JStopWatch with the tag and message specified and started at the instant of creation.
Slf4JStopWatch(String tag, String message, Logger logger)
          Creates a Slf4JStopWatch with the tag and message specified and started at the instant of creation, using the specified Logger to log stop watch messages using the info() method, or using the warn() method if an exception is passed to one of the stop or lap methods.
Slf4JStopWatch(String tag, String message, Logger logger, int normalPriority)
          Creates a Slf4JStopWatch with the tag and message specified and started at the instant of creation, using the specified Logger to log stop watch messages at the normalPriority level specified, or using the warn() method if an exception is passed to one of the stop or lap methods.
Slf4JStopWatch(String tag, String message, Logger logger, int normalPriority, int exceptionPriority)
          Creates a Slf4JStopWatch with the tag and message specified and started at the instant of creation, using the specified Logger to log stop watch messages at the normalPriority level specified, or at the exceptionPriority level if an exception is passed to one of the stop or lap methods.
 
Method Summary
 Slf4JStopWatch clone()
           
 int getExceptionPriority()
          Gets the level at which log statements will be made when one of the stop or lap methods that DOES take an exception is called.
 Logger getLogger()
          Gets the Apache Commons Logging Logger that is used to persist logging statements when one of the stop or lap methods is called.
 int getNormalPriority()
          Gets the level at which log statements will be made when one of the stop or lap methods that does NOT take an exception is called.
 boolean isLogging()
          This method returns true if the Logger it uses is enabled at the normalPriority level of this StopWatch.
protected  boolean isLogging(int atLevel)
          Since Commons Logging doesn't have a first class notion of Level objects or integer values, this method converts the level value to one of the isXYZEnabled() methods on the Log.
protected  void log(String stopWatchAsString, Throwable exception)
          The log message is overridden to use the Apache Commons Logging Logger to persist the stop watch.
protected  void log(String stopWatchAsString, Throwable exception, int atLevel)
          Since Commons Logging doesn't have a first class notion of Level objects or integer values, this method maps the atLevel parameter to one of the trace(), debug(), info(), warn(), error(), or fatal() methods on the Log.
static int mapLevelName(String levelName)
          This utility method provides the standard mapping between log4j level names (which Perf4J uses as the standard set of possible levels) to the corresponding ..._LEVEL constant from this class.
 Slf4JStopWatch setExceptionPriority(int exceptionPriority)
          Sets the level at which log statements will be made when one of the stop or lap methods that DOES take an exception is called.
 Slf4JStopWatch setLogger(Logger logger)
          Sets the Apache Commons Logging Logused to persist StopWatch instances.
 Slf4JStopWatch setMessage(String message)
          Sends a message on this StopWatch instance to be printed when this instance is logged.
 Slf4JStopWatch setNormalAndSlowSuffixesEnabled(boolean normalAndSlowSuffixesEnabled)
          Sets whether to append normalSuffix and slowSuffix when timeThreshold > 0 AND elapsedTime >= timeThreshold
 Slf4JStopWatch setNormalPriority(int normalPriority)
          Sets the level at which log statements will be made when one of the stop or lap methods that does NOT take an exception is called.
 Slf4JStopWatch setNormalSuffix(String normalSuffix)
          Sets the suffix to use when normalAndSlowSuffixesEnabled=true and timeThreshold > 0 and elapsedTime < timeThreshold.
 Slf4JStopWatch setSlowSuffix(String slowSuffix)
          Sets the suffix to use when normalAndSlowSuffixesEnabled=true and timeThreshold > 0 and elapsedTime >= timeThreshold.
 Slf4JStopWatch setTag(String tag)
          Sets the grouping tag for this StopWatch instance.
 Slf4JStopWatch setTimeThreshold(long timeThreshold)
          Sets a threshold level, in milliseconds, below which logging calls will not be made.
 
Methods inherited from class org.perf4j.LoggingStopWatch
getNormalSuffix, getSlowSuffix, getTag, getTimeThreshold, isNormalAndSlowSuffixesEnabled, lap, lap, stop, stop, stop, stop
 
Methods inherited from class org.perf4j.StopWatch
equals, getElapsedTime, getMessage, getStartTime, hashCode, lap, lap, start, start, start, stop, stop, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

TRACE_LEVEL

public static final int TRACE_LEVEL
Specifying this level will cause the trace() method to be used for logging.

See Also:
Constant Field Values

DEBUG_LEVEL

public static final int DEBUG_LEVEL
Specifying this level will cause the debug() method to be used for logging.

See Also:
Constant Field Values

INFO_LEVEL

public static final int INFO_LEVEL
Specifying this level will cause the info() method to be used for logging.

See Also:
Constant Field Values

WARN_LEVEL

public static final int WARN_LEVEL
Specifying this level will cause the warn() method to be used for logging.

See Also:
Constant Field Values

ERROR_LEVEL

public static final int ERROR_LEVEL
Specifying this level will cause the error() method to be used for logging.

See Also:
Constant Field Values
Constructor Detail

Slf4JStopWatch

public Slf4JStopWatch()
Creates a Slf4JStopWatch with a blank tag, no message and started at the instant of creation. The Logger with the name "org.perf4j.TimingLogger" is used to log stop watch messages using the info() method, or using the warn() method if an exception is passed to one of the stop or lap methods.


Slf4JStopWatch

public Slf4JStopWatch(Logger logger)
Creates a Slf4JStopWatch with a blank tag, no message and started at the instant of creation, using the specified Logger to log stop watch messages using the info() method, or using the warn() method if an exception is passed to one of the stop or lap methods.

Parameters:
logger - The Logger to use when persisting StopWatches in one of the stop or lap methods.

Slf4JStopWatch

public Slf4JStopWatch(Logger logger,
                      int normalPriority)
Creates a Slf4JStopWatch with a blank tag, no message and started at the instant of creation, using the specified Logger to log stop watch messages at the normalPriority level specified, or using the warn() method if an exception is passed to one of the stop or lap methods.

Parameters:
logger - The Logger to use when persisting StopWatches in one of the stop or lap methods.
normalPriority - The level at which this StopWatch is logged if one of the stop or lap methods that does NOT take an exception is called. Should be one of the ..._LEVEL constants from this class.

Slf4JStopWatch

public Slf4JStopWatch(Logger logger,
                      int normalPriority,
                      int exceptionPriority)
Creates a Slf4JStopWatch with a blank tag, no message and started at the instant of creation, using the specified Logger to log stop watch messages at the normalPriority level specified, or at the exceptionPriority level if an exception is passed to one of the stop or lap methods.

Parameters:
logger - The Logger to use when persisting StopWatches in one of the stop or lap methods.
normalPriority - The level at which this StopWatch is logged if one of the stop or lap methods that does NOT take an exception is called. Should be one of the ..._LEVEL constants from this class.
exceptionPriority - The level at which this StopWatch is logged if one of the stop or lap methods that DOES take an exception is called. Should be one of the ..._LEVEL constants from this class.

Slf4JStopWatch

public Slf4JStopWatch(String tag)
Creates a Slf4JStopWatch with the tag specified, no message and started at the instant of creation. The Logger with the name "org.perf4j.TimingLogger" is used to log stop watch messages using the info() method, or using the warn() method if an exception is passed to one of the stop or lap methods.

Parameters:
tag - The tag name for this timing call. Tags are used to group timing logs, thus each block of code being timed should have a unique tag. Note that tags can take a hierarchical format using dot notation.

Slf4JStopWatch

public Slf4JStopWatch(String tag,
                      Logger logger)
Creates a Slf4JStopWatch with the tag specified, no message and started at the instant of creation, using the specified Logger to log stop watch using the info() method, or using the warn() method if an exception is passed to one of the stop or lap methods.

Parameters:
tag - The tag name for this timing call. Tags are used to group timing logs, thus each block of code being timed should have a unique tag. Note that tags can take a hierarchical format using dot notation.
logger - The Logger to use when persisting StopWatches in one of the stop or lap methods.

Slf4JStopWatch

public Slf4JStopWatch(String tag,
                      Logger logger,
                      int normalPriority)
Creates a Slf4JStopWatch with the tag specified, no message and started at the instant of creation, using the specified Logger to log stop watch messages at the normalPriority level specified, or using the warn() level if an exception is passed to one of the stop or lap methods.

Parameters:
tag - The tag name for this timing call. Tags are used to group timing logs, thus each block of code being timed should have a unique tag. Note that tags can take a hierarchical format using dot notation.
logger - The Logger to use when persisting StopWatches in one of the stop or lap methods.
normalPriority - The level at which this StopWatch is logged if one of the stop or lap methods that does NOT take an exception is called. Should be one of the ..._LEVEL constants from this class.

Slf4JStopWatch

public Slf4JStopWatch(String tag,
                      Logger logger,
                      int normalPriority,
                      int exceptionPriority)
Creates a Slf4JStopWatch with the tag specified, no message and started at the instant of creation, using the specified Logger to log stop watch messages at the normalPriority level specified, or at the exceptionPriority level if an exception is passed to one of the stop or lap methods.

Parameters:
tag - The tag name for this timing call. Tags are used to group timing logs, thus each block of code being timed should have a unique tag. Note that tags can take a hierarchical format using dot notation.
logger - The Logger to use when persisting StopWatches in one of the stop or lap methods.
normalPriority - The level at which this StopWatch is logged if one of the stop or lap methods that does NOT take an exception is called. Should be one of the ..._LEVEL constants from this class.
exceptionPriority - The level at which this StopWatch is logged if one of the stop or lap methods that DOES take an exception is called. Should be one of the ..._LEVEL constants from this class.

Slf4JStopWatch

public Slf4JStopWatch(String tag,
                      String message)
Creates a Slf4JStopWatch with the tag and message specified and started at the instant of creation. The Logger with the name "org.perf4j.TimingLogger" is used to log stop watch messages using the info() method, or using the warn() method if an exception is passed to one of the stop or lap methods.

Parameters:
tag - The tag name for this timing call. Tags are used to group timing logs, thus each block of code being timed should have a unique tag. Note that tags can take a hierarchical format using dot notation.
message - Additional text to be printed with the logging statement of this StopWatch.

Slf4JStopWatch

public Slf4JStopWatch(String tag,
                      String message,
                      Logger logger)
Creates a Slf4JStopWatch with the tag and message specified and started at the instant of creation, using the specified Logger to log stop watch messages using the info() method, or using the warn() method if an exception is passed to one of the stop or lap methods.

Parameters:
tag - The tag name for this timing call. Tags are used to group timing logs, thus each block of code being timed should have a unique tag. Note that tags can take a hierarchical format using dot notation.
message - Additional text to be printed with the logging statement of this StopWatch.
logger - The Logger to use when persisting StopWatches in one of the stop or lap methods.

Slf4JStopWatch

public Slf4JStopWatch(String tag,
                      String message,
                      Logger logger,
                      int normalPriority)
Creates a Slf4JStopWatch with the tag and message specified and started at the instant of creation, using the specified Logger to log stop watch messages at the normalPriority level specified, or using the warn() method if an exception is passed to one of the stop or lap methods.

Parameters:
tag - The tag name for this timing call. Tags are used to group timing logs, thus each block of code being timed should have a unique tag. Note that tags can take a hierarchical format using dot notation.
message - Additional text to be printed with the logging statement of this StopWatch.
logger - The Logger to use when persisting StopWatches in one of the stop or lap methods.
normalPriority - The level at which this StopWatch is logged if one of the stop or lap methods that does NOT take an exception is called. Should be one of the ..._LEVEL constants from this class.

Slf4JStopWatch

public Slf4JStopWatch(String tag,
                      String message,
                      Logger logger,
                      int normalPriority,
                      int exceptionPriority)
Creates a Slf4JStopWatch with the tag and message specified and started at the instant of creation, using the specified Logger to log stop watch messages at the normalPriority level specified, or at the exceptionPriority level if an exception is passed to one of the stop or lap methods.

Parameters:
tag - The tag name for this timing call. Tags are used to group timing logs, thus each block of code being timed should have a unique tag. Note that tags can take a hierarchical format using dot notation.
message - Additional text to be printed with the logging statement of this StopWatch.
logger - The Logger to use when persisting StopWatches in one of the stop or lap methods.
normalPriority - The level at which this StopWatch is logged if one of the stop or lap methods that does NOT take an exception is called. Should be one of the ..._LEVEL constants from this class.
exceptionPriority - The level at which this StopWatch is logged if one of the stop or lap methods that DOES take an exception is called. Should be one of the ..._LEVEL constants from this class.

Slf4JStopWatch

public Slf4JStopWatch(long startTime,
                      long elapsedTime,
                      String tag,
                      String message,
                      Logger logger,
                      int normalPriority,
                      int exceptionPriority)
This constructor is mainly used for creation of StopWatch instances from logs and for testing. Users should normally not call this constructor in client code.

Parameters:
startTime - The start time in milliseconds
elapsedTime - The elapsed time in milliseconds
tag - The tag used to group timing logs of the same code block
message - Additional message text
logger - The Logger to use when persisting StopWatches in one of the stop or lap methods.
normalPriority - The level at which this StopWatch is logged if one of the stop or lap methods that does NOT take an exception is called.
exceptionPriority - The level at which this StopWatch is logged if one of the stop or lap methods that DOES take an exception is called.
Method Detail

getLogger

public Logger getLogger()
Gets the Apache Commons Logging Logger that is used to persist logging statements when one of the stop or lap methods is called.

Returns:
The Logger used for StopWatch persistence.

setLogger

public Slf4JStopWatch setLogger(Logger logger)
Sets the Apache Commons Logging Logused to persist StopWatch instances.

Parameters:
logger - The Logger this instance should use for persistence. May not be null.
Returns:
this instance, for use with method chaining if desired

getNormalPriority

public int getNormalPriority()
Gets the level at which log statements will be made when one of the stop or lap methods that does NOT take an exception is called. The value returned corresponds to one of the ..._LEVEL constants of this class.

Returns:
The level used when logging "normal" stop or lap calls.

setNormalPriority

public Slf4JStopWatch setNormalPriority(int normalPriority)
Sets the level at which log statements will be made when one of the stop or lap methods that does NOT take an exception is called.

Parameters:
normalPriority - The level used when logging "normal" stop or lap calls. This value should be one of the ..._LEVEL constants of this class.
Returns:
this instance, for use with method chaining if desired

getExceptionPriority

public int getExceptionPriority()
Gets the level at which log statements will be made when one of the stop or lap methods that DOES take an exception is called. The value returned corresponds to one of the ..._LEVEL constants of this class.

Returns:
The level used when logging "exceptional" stop or lap calls.

setExceptionPriority

public Slf4JStopWatch setExceptionPriority(int exceptionPriority)
Sets the level at which log statements will be made when one of the stop or lap methods that DOES take an exception is called.

Parameters:
exceptionPriority - The level used when logging "exceptional" stop or lap calls. This value should be one of the ..._LEVEL constants of this class.
Returns:
this instance, for use with method chaining if desired

setTimeThreshold

public Slf4JStopWatch setTimeThreshold(long timeThreshold)
Description copied from class: LoggingStopWatch
Sets a threshold level, in milliseconds, below which logging calls will not be made. You can set this to a high positive value if you only want logging to occur for abnormally slow execution times. Note, though, that you may wish to leave the threshold at 0 and attach a JmxAttributeStatisticsAppender in the logging configuration to be notified when times are outside acceptable thresholds.

Overrides:
setTimeThreshold in class LoggingStopWatch
Parameters:
timeThreshold - The minimum elapsed time, in milliseconds, below which log calls will not be made.
Returns:
this instance, for use with method chaining if desired
See Also:
JmxAttributeStatisticsAppender.getNotificationThresholds()

setTag

public Slf4JStopWatch setTag(String tag)
Description copied from class: StopWatch
Sets the grouping tag for this StopWatch instance.

Overrides:
setTag in class LoggingStopWatch
Parameters:
tag - The grouping tag.
Returns:
this instance, for method chaining if desired

setMessage

public Slf4JStopWatch setMessage(String message)
Description copied from class: StopWatch
Sends a message on this StopWatch instance to be printed when this instance is logged.

Overrides:
setMessage in class LoggingStopWatch
Parameters:
message - The message associated with this StopWatch, which may be null.
Returns:
this instance, for method chaining if desired.

setNormalAndSlowSuffixesEnabled

public Slf4JStopWatch setNormalAndSlowSuffixesEnabled(boolean normalAndSlowSuffixesEnabled)
Description copied from class: LoggingStopWatch
Sets whether to append normalSuffix and slowSuffix when timeThreshold > 0 AND elapsedTime >= timeThreshold

Overrides:
setNormalAndSlowSuffixesEnabled in class LoggingStopWatch
Parameters:
normalAndSlowSuffixesEnabled - true enables logging extra suffixes to normal and slow events; false (default) suppresses the suffixes

setNormalSuffix

public Slf4JStopWatch setNormalSuffix(String normalSuffix)
Description copied from class: LoggingStopWatch
Sets the suffix to use when normalAndSlowSuffixesEnabled=true and timeThreshold > 0 and elapsedTime < timeThreshold. Setting this to "" is equivalent to setting to null.

Overrides:
setNormalSuffix in class LoggingStopWatch
Parameters:
normalSuffix - the suffix to append if normalAndSlowSuffixesEnabled and the elapsedtime is under the threshold

setSlowSuffix

public Slf4JStopWatch setSlowSuffix(String slowSuffix)
Description copied from class: LoggingStopWatch
Sets the suffix to use when normalAndSlowSuffixesEnabled=true and timeThreshold > 0 and elapsedTime >= timeThreshold. Setting this to "" is equivalent to setting to null.

Overrides:
setSlowSuffix in class LoggingStopWatch
Parameters:
slowSuffix - the suffix to append if normalAndSlowSuffixesEnabled and the elapsedtime is under the threshold

isLogging

public boolean isLogging()
This method returns true if the Logger it uses is enabled at the normalPriority level of this StopWatch.

Overrides:
isLogging in class LoggingStopWatch
Returns:
true if this StopWatch will output log messages when one of the stop or lap messages that does NOT take an exception is called.

log

protected void log(String stopWatchAsString,
                   Throwable exception)
The log message is overridden to use the Apache Commons Logging Logger to persist the stop watch.

Overrides:
log in class LoggingStopWatch
Parameters:
stopWatchAsString - The stringified view of the stop watch for logging.
exception - An exception, if any, that was passed to the stop or lap method. If this is null then logging will occur at normalPriority, if non-null it will occur at exceptionPriority.

isLogging

protected boolean isLogging(int atLevel)
Since Commons Logging doesn't have a first class notion of Level objects or integer values, this method converts the level value to one of the isXYZEnabled() methods on the Log.

Parameters:
atLevel - The level at which a log message is logged.
Returns:
true if the Logger used by this StopWatch will output messages at the level specified.

log

protected void log(String stopWatchAsString,
                   Throwable exception,
                   int atLevel)
Since Commons Logging doesn't have a first class notion of Level objects or integer values, this method maps the atLevel parameter to one of the trace(), debug(), info(), warn(), error(), or fatal() methods on the Log.

Parameters:
stopWatchAsString - The stringified view of the stop watch for logging.
exception - An exception, if any, that was passed to the stop or lap method. If this is null then logging will occur at normalPriority, if non-null it will occur at exceptionPriority.
atLevel - The level at which logging should occur.

mapLevelName

public static int mapLevelName(String levelName)
This utility method provides the standard mapping between log4j level names (which Perf4J uses as the standard set of possible levels) to the corresponding ..._LEVEL constant from this class.

Parameters:
levelName - The name of the logging level, should be one of TRACE, DEBUG, INFO, WARN, ERROR or FATAL.
Returns:
The corresponding ..._LEVEL constant from this class.

clone

public Slf4JStopWatch clone()
Overrides:
clone in class LoggingStopWatch


Copyright © 2008-2011 perf4j.org. All Rights Reserved.