PerformanceLogger (IP SQUARE Commons Core 3.0.1 API)

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();
 //...

 //...
 PerformanceLogger.timedExec(() -> {
     doSomeWork();
     return doSomeMoreWork();
 }
 //...

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

All Methods Static Methods Instance Methods Concrete 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.
`static void`	`timedExec(long threshold, Runnable block)` See `timedExec(long, String, Runnable)`
`static void`	`timedExec(long threshold, String msg, Runnable block)` See `timedExec(long, String, Runnable)`
`static <T> T`	`timedExec(long threshold, String msg, java.util.function.Supplier<T> block)` Executes the given block and logs its execution time.
`static <T> T`	`timedExec(long threshold, java.util.function.Supplier<T> block)` See `timedExec(long, String, Runnable)`
`static void`	`timedExec(Runnable block)` See `timedExec(long, String, Runnable)`
`static void`	`timedExec(String msg, Runnable block)` See `timedExec(long, String, Runnable)`
`static <T> T`	`timedExec(String msg, java.util.function.Supplier<T> block)` See `timedExec(long, String, Runnable)`
`static <T> T`	`timedExec(java.util.function.Supplier<T> block)` See `timedExec(long, String, Runnable)`

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.
  - timedExec
```
public static <T> T timedExec(long threshold,
                              String msg,
                              java.util.function.Supplier<T> block)
```
    Executes the given block and logs its execution time.
    
    Parameters:
    
    threshold - the threshold in ms for with the logger should generate any output.
    
    msg - an optional message.
    
    block - the block to execute.
    
    Returns:
    
    the return value of the block.
  - timedExec
```
public static <T> T timedExec(String msg,
                              java.util.function.Supplier<T> block)
```
    See timedExec(long, String, Runnable)
  - timedExec
```
public static <T> T timedExec(long threshold,
                              java.util.function.Supplier<T> block)
```
    See timedExec(long, String, Runnable)
  - timedExec
```
public static <T> T timedExec(java.util.function.Supplier<T> block)
```
    See timedExec(long, String, Runnable)
  - timedExec
```
public static void timedExec(long threshold,
                             String msg,
                             Runnable block)
```
    See timedExec(long, String, Runnable)
  - timedExec
```
public static void timedExec(long threshold,
                             Runnable block)
```
    See timedExec(long, String, Runnable)
  - timedExec
```
public static void timedExec(String msg,
                             Runnable block)
```
    See timedExec(long, String, Runnable)
  - timedExec
```
public static void timedExec(Runnable block)
```
    See timedExec(long, String, Runnable)

Class PerformanceLogger

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SETTINGS_PATH

DEFAULT_PERFORMANCE_LOG_FORMATTER_KEY

DEFAULT_THRESHOLD_KEY

Constructor Detail

PerformanceLogger

PerformanceLogger

PerformanceLogger

PerformanceLogger

Method Detail

logElapsed

logElapsedAndRestart

logElapsed

logElapsedAndRestart

restart

timedExec

timedExec

timedExec

timedExec

timedExec

timedExec

timedExec

timedExec