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

Constructor Summary

Constructors

Constructor and Description
PerformanceLogger() Constructs a new PerformanceLogger with no threshold.
PerformanceLogger(long threshold) Constructs a new PerformanceLogger.

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

Constructor Detail

PerformanceLogger

public PerformanceLogger()

Constructs a new PerformanceLogger with no threshold.

PerformanceLogger

public PerformanceLogger(long threshold)

Constructs a new PerformanceLogger.

Parameters:

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

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.