at.ipsquare.commons.core.util

Class PerformanceLogger

java.lang.Object

at.ipsquare.commons.core.util.PerformanceLogger

@NotThreadSafe
public class PerformanceLogger
extends Object

A simple performance logger.

This class is meant to be used like this:

 //...
 PerformanceLogger plog = new PerformanceLogger();
 doWork();
 plog.logElapsedAndRestart();
 doSomeMoreWork();
 plog.logElapsed();
 //...
 

For logging SLF4J with log level DEBUG is used; you can therefore disable performance logging by simply setting the log level for this class accordingly.

Since:

2.0.0

Author:

Matthias Langer

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_PERFORMANCE_LOG_FORMATTER_KEY The property key that specifies the default PerformanceLogFormatter implementation to use.
static String	DEFAULT_SETTINGS_PATH Path to an XML properties file that can be used to override the default settings of this class.
static String	DEFAULT_THRESHOLD_KEY The property key that specifies the default threshold to use.

Constructor Summary

Constructors

Constructor and Description
PerformanceLogger() Constructs a new PerformanceLogger with default settings.
PerformanceLogger(long threshold) Constructs a new PerformanceLogger a default PerformanceLogFormatter implementation.
PerformanceLogger(long threshold, PerformanceLogFormatter logFormatter) Constructs a new PerformanceLogger.
PerformanceLogger(PerformanceLogFormatter logFormatter) Constructs a new PerformanceLogger with a default threshold.

Method Summary

Methods

Modifier and Type	Method and Description
void	logElapsed() See logElapsed(String).
void	logElapsed(String msg) Logs the elapsed time if it is above the threshold.
void	logElapsedAndRestart() See logElapsedAndRestart(String).
void	logElapsedAndRestart(String msg) Logs the elapsed time if it is above the threshold and restarts the internal timer.
void	restart() Restarts the internal timer.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SETTINGS_PATH

public static final String DEFAULT_SETTINGS_PATH

Path to an XML properties file that can be used to override the default settings of this class.

This file loaded using LocalResources. Consult the users manual for details.

Since:

2.1.0

See Also:

Constant Field Values

DEFAULT_PERFORMANCE_LOG_FORMATTER_KEY

public static final String DEFAULT_PERFORMANCE_LOG_FORMATTER_KEY

The property key that specifies the default PerformanceLogFormatter implementation to use.

Since:

2.1.0

See Also:

DEFAULT_SETTINGS_PATH, Constant Field Values

DEFAULT_THRESHOLD_KEY

public static final String DEFAULT_THRESHOLD_KEY

The property key that specifies the default threshold to use.

Since:

2.1.0

See Also:

DEFAULT_SETTINGS_PATH, Constant Field Values

Constructor Detail

PerformanceLogger

public PerformanceLogger()

Constructs a new PerformanceLogger with default settings.

PerformanceLogger

public PerformanceLogger(long threshold)

Constructs a new PerformanceLogger a default PerformanceLogFormatter implementation.

Parameters:

threshold - the threshold in ms for which the logger should generate any output.

PerformanceLogger

public PerformanceLogger(PerformanceLogFormatter logFormatter)

Constructs a new PerformanceLogger with a default threshold.

Parameters:

logFormatter - optional PerformanceLogFormatter

Since:

2.1.0

PerformanceLogger

public PerformanceLogger(long threshold,
                 PerformanceLogFormatter logFormatter)

Constructs a new PerformanceLogger.

Parameters:

threshold - the threshold in ms for which the logger should generate any output.

logFormatter - optional PerformanceLogFormatter.

Since:

2.1.0

Method Detail

logElapsed

public void logElapsed()

See logElapsed(String).

logElapsedAndRestart

public void logElapsedAndRestart()

See logElapsedAndRestart(String).

logElapsed

public void logElapsed(String msg)

Logs the elapsed time if it is above the threshold.

Parameters:

msg - an optional message.

logElapsedAndRestart

public void logElapsedAndRestart(String msg)

Logs the elapsed time if it is above the threshold and restarts the internal timer.

Parameters:

msg - an optional message.

restart

public void restart()

Restarts the internal timer.