org.perf4j.commonslog
Class CommonsLogStopWatch

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

public class CommonsLogStopWatch
extends LoggingStopWatch

This LoggingStopWatch uses an Apache Commons Logging Log 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 FATAL_LEVEL
          Specifying this level will cause the fatal() 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
CommonsLogStopWatch()
          Creates a CommonsLogStopWatch with a blank tag, no message and started at the instant of creation.
CommonsLogStopWatch(Log logger)
          Creates a CommonsLogStopWatch with a blank tag, no message and started at the instant of creation, using the specified Log 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.
CommonsLogStopWatch(Log logger, int normalPriority)
          Creates a CommonsLogStopWatch with a blank tag, no message and started at the instant of creation, using the specified Log 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.
CommonsLogStopWatch(Log logger, int normalPriority, int exceptionPriority)
          Creates a CommonsLogStopWatch with a blank tag, no message and started at the instant of creation, using the specified Log 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.
CommonsLogStopWatch(long startTime, long elapsedTime, String tag, String message, Log logger, int normalPriority, int exceptionPriority)
          This constructor is mainly used for creation of StopWatch instances from logs and for testing.
CommonsLogStopWatch(String tag)
          Creates a CommonsLogStopWatch with the tag specified, no message and started at the instant of creation.
CommonsLogStopWatch(String tag, Log logger)
          Creates a CommonsLogStopWatch with the tag specified, no message and started at the instant of creation, using the specified Log 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.
CommonsLogStopWatch(String tag, Log logger, int normalPriority)
          Creates a CommonsLogStopWatch with the tag specified, no message and started at the instant of creation, using the specified Log 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.
CommonsLogStopWatch(String tag, Log logger, int normalPriority, int exceptionPriority)
          Creates a CommonsLogStopWatch with the tag specified, no message and started at the instant of creation, using the specified Log 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.
CommonsLogStopWatch(String tag, String message)
          Creates a CommonsLogStopWatch with the tag and message specified and started at the instant of creation.
CommonsLogStopWatch(String tag, String message, Log logger)
          Creates a CommonsLogStopWatch with the tag and message specified and started at the instant of creation, using the specified Log 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.
CommonsLogStopWatch(String tag, String message, Log logger, int normalPriority)
          Creates a CommonsLogStopWatch with the tag and message specified and started at the instant of creation, using the specified Log 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.
CommonsLogStopWatch(String tag, String message, Log logger, int normalPriority, int exceptionPriority)
          Creates a CommonsLogStopWatch with the tag and message specified and started at the instant of creation, using the specified Log 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
 CommonsLogStopWatch 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.
 Log getLogger()
          Gets the Apache Commons Logging Log 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 Log 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 Log 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.
 CommonsLogStopWatch 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.
 CommonsLogStopWatch setLogger(Log logger)
          Sets the Apache Commons Logging Logused to persist StopWatch instances.
 CommonsLogStopWatch setMessage(String message)
          Sends a message on this StopWatch instance to be printed when this instance is logged.
 CommonsLogStopWatch setNormalAndSlowSuffixesEnabled(boolean normalAndSlowSuffixesEnabled)
          Sets whether to append normalSuffix and slowSuffix when timeThreshold > 0 AND elapsedTime >= timeThreshold
 CommonsLogStopWatch 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.
 CommonsLogStopWatch setNormalSuffix(String normalSuffix)
          Sets the suffix to use when normalAndSlowSuffixesEnabled=true and timeThreshold > 0 and elapsedTime < timeThreshold.
 CommonsLogStopWatch setSlowSuffix(String slowSuffix)
          Sets the suffix to use when normalAndSlowSuffixesEnabled=true and timeThreshold > 0 and elapsedTime >= timeThreshold.
 CommonsLogStopWatch setTag(String tag)
          Sets the grouping tag for this StopWatch instance.
 CommonsLogStopWatch 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

FATAL_LEVEL

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

See Also:
Constant Field Values
Constructor Detail

CommonsLogStopWatch

public CommonsLogStopWatch()
Creates a CommonsLogStopWatch with a blank tag, no message and started at the instant of creation. The Log 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.


CommonsLogStopWatch

public CommonsLogStopWatch(Log logger)
Creates a CommonsLogStopWatch with a blank tag, no message and started at the instant of creation, using the specified Log 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 Log to use when persisting StopWatches in one of the stop or lap methods.

CommonsLogStopWatch

public CommonsLogStopWatch(Log logger,
                           int normalPriority)
Creates a CommonsLogStopWatch with a blank tag, no message and started at the instant of creation, using the specified Log 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 Log 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.

CommonsLogStopWatch

public CommonsLogStopWatch(Log logger,
                           int normalPriority,
                           int exceptionPriority)
Creates a CommonsLogStopWatch with a blank tag, no message and started at the instant of creation, using the specified Log 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 Log 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.

CommonsLogStopWatch

public CommonsLogStopWatch(String tag)
Creates a CommonsLogStopWatch with the tag specified, no message and started at the instant of creation. The Log 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.

CommonsLogStopWatch

public CommonsLogStopWatch(String tag,
                           Log logger)
Creates a CommonsLogStopWatch with the tag specified, no message and started at the instant of creation, using the specified Log 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 Log to use when persisting StopWatches in one of the stop or lap methods.

CommonsLogStopWatch

public CommonsLogStopWatch(String tag,
                           Log logger,
                           int normalPriority)
Creates a CommonsLogStopWatch with the tag specified, no message and started at the instant of creation, using the specified Log 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 Log 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.

CommonsLogStopWatch

public CommonsLogStopWatch(String tag,
                           Log logger,
                           int normalPriority,
                           int exceptionPriority)
Creates a CommonsLogStopWatch with the tag specified, no message and started at the instant of creation, using the specified Log 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 Log 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.

CommonsLogStopWatch

public CommonsLogStopWatch(String tag,
                           String message)
Creates a CommonsLogStopWatch with the tag and message specified and started at the instant of creation. The Log 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.

CommonsLogStopWatch

public CommonsLogStopWatch(String tag,
                           String message,
                           Log logger)
Creates a CommonsLogStopWatch with the tag and message specified and started at the instant of creation, using the specified Log 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 Log to use when persisting StopWatches in one of the stop or lap methods.

CommonsLogStopWatch

public CommonsLogStopWatch(String tag,
                           String message,
                           Log logger,
                           int normalPriority)
Creates a CommonsLogStopWatch with the tag and message specified and started at the instant of creation, using the specified Log 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 Log 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.

CommonsLogStopWatch

public CommonsLogStopWatch(String tag,
                           String message,
                           Log logger,
                           int normalPriority,
                           int exceptionPriority)
Creates a CommonsLogStopWatch with the tag and message specified and started at the instant of creation, using the specified Log 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 Log 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.

CommonsLogStopWatch

public CommonsLogStopWatch(long startTime,
                           long elapsedTime,
                           String tag,
                           String message,
                           Log 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 Log 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 Log getLogger()
Gets the Apache Commons Logging Log that is used to persist logging statements when one of the stop or lap methods is called.

Returns:
The Log used for StopWatch persistence.

setLogger

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

Parameters:
logger - The Log 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 CommonsLogStopWatch 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 CommonsLogStopWatch 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 CommonsLogStopWatch 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 CommonsLogStopWatch 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 CommonsLogStopWatch 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 CommonsLogStopWatch 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 CommonsLogStopWatch 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 CommonsLogStopWatch 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 Log 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 Log 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 Log 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 CommonsLogStopWatch clone()
Overrides:
clone in class LoggingStopWatch


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