org.javasimon.callback.logging
Class LoggingCallback

java.lang.Object
  org.javasimon.callback.CallbackSkeleton
      org.javasimon.callback.logging.LoggingCallback

All Implemented Interfaces:

Callback

public class LoggingCallback
extends CallbackSkeleton

Callback which log stopwatch splits and manager warnings. By default every split is logged, but one can configure this callback to log only:

• Splits too long (longer that threshold)
• One split out of N
• One split every N milliseconds

Nested Class Summary

Nested classes/interfaces inherited from interface org.javasimon.callback.Callback

Callback.Event

Field Summary

private LogMessageSource<String>	managerLogMessageSource String to string (no-op) converter.
private LogTemplate<String>	managerLogTemplate Log template used for manager.
private LogMessageSource<Split>	stopwatchLogMessageSource Split to string converter.
private LogTemplate<Split>	stopwatchLogTemplate Log template used for Stopwatch splits.

Constructor Summary

LoggingCallback()
Default constructor logging everything to SLF4J.

LoggingCallback(LogTemplate<Split> stopwatchLogTemplate, LogTemplate<String> managerLogTemplate)
Constructor wich can be used to customize log templates.

Method Summary

LogTemplate<String>	getManagerLogTemplate() Get log template used for manage warnings.
LogTemplate<Split>	getStopwatchLogTemplate() Get log template used for stopwatch splits.
protected LogTemplate<Split>	getStopwatchLogTemplate(Stopwatch stopwatch) Get log template for stopwatch, defaults to stopwatchLogTemplate.
void	onManagerWarning(String warning, Exception cause) Warning event containing warning and/or cause.
void	onStopwatchStop(Split split, StopwatchSample sample) Stopwatch stop event.

Methods inherited from class org.javasimon.callback.CallbackSkeleton

cleanup, initialize, onCounterDecrease, onCounterIncrease, onCounterSet, onManagerClear, onManagerMessage, onSimonCreated, onSimonDestroyed, onSimonReset, onStopwatchAdd, onStopwatchAdd, onStopwatchStart

Methods inherited from class java.lang.Object

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

Field Detail

stopwatchLogTemplate

private final LogTemplate<Split> stopwatchLogTemplate

Log template used for Stopwatch splits.

stopwatchLogMessageSource

private final LogMessageSource<Split> stopwatchLogMessageSource

Split to string converter.

managerLogTemplate

private final LogTemplate<String> managerLogTemplate

Log template used for manager.

managerLogMessageSource

private final LogMessageSource<String> managerLogMessageSource

String to string (no-op) converter.

Constructor Detail

LoggingCallback

public LoggingCallback(LogTemplate<Split> stopwatchLogTemplate,
                       LogTemplate<String> managerLogTemplate)

Constructor wich can be used to customize log templates.

Parameters:

stopwatchLogTemplate - Logger used for Stopwatch splits

managerLogTemplate - Logger used for manager

LoggingCallback

public LoggingCallback()

Default constructor logging everything to SLF4J.

Method Detail

getManagerLogTemplate

public LogTemplate<String> getManagerLogTemplate()

Get log template used for manage warnings.

Returns:

Logger

getStopwatchLogTemplate

public LogTemplate<Split> getStopwatchLogTemplate()

Get log template used for stopwatch splits.

Returns:

Logger

getStopwatchLogTemplate

protected LogTemplate<Split> getStopwatchLogTemplate(Stopwatch stopwatch)

Get log template for stopwatch, defaults to stopwatchLogTemplate. This method can be overridden to get a specific log template per stopwatch.

Parameters:

stopwatch - Stopwatch

Returns:

Logger

onStopwatchStop

public void onStopwatchStop(Split split,
                            StopwatchSample sample)

Stopwatch stop event. This action is executed after the split time is calculated and does not affect the measuring. StopwatchSample valid for the moment after the stop is provided because the callback is executed out of synchronized block. Split and stopwatch are logger to log template is enabled.

Specified by:

onStopwatchStop in interface Callback

Overrides:

onStopwatchStop in class CallbackSkeleton

Parameters:

split - Split

sample -

onManagerWarning

public void onManagerWarning(String warning,
                             Exception cause)

Warning event containing warning and/or cause.

Specified by:

onManagerWarning in interface Callback

Overrides:

onManagerWarning in class CallbackSkeleton

Parameters:

warning - arbitrary warning message - can be null, unless concrete implementation states otherwise

cause - exception causing this warning - can be null, unless concrete implementation states otherwise