org.nuiton.util

Class TimeLog

java.lang.Object

org.nuiton.util.TimeLog

public class TimeLog
extends Object

Cette classe permet de facilement trace le temps d'execution entre deux points usage

 final private static final Log log = LogFactory.getLog(MyClass.class);
 final static private TimeLog timeLog = new TimeLog(MyClass.class, 5000, 1000);


 long start = timeLog.getTime();
 ...
 // do some work
 ...
 start = timeLog.log(start, "MyMethod step 1", "do some work");
 ...
 // do some work
 ...
 timeLog.log(start, "MyMethod step 2", "do other work");


 System.out.println ("time: " + timeLog.getCallCount());
 

You can configure log level in configuration file with: log4j.logger.org.codelutin.MyClass=DEBUG log4j.logger.org.codelutin.MyClass.TimeLog=INFO

Since:

2.1

Author:

Benjamin Poussin - poussin@codelutin.com

See Also:

CallAnalyse

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimeLog.CallStat

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,TimeLog.CallStat>	callCount for each method of all proxies, keep number of call
protected org.apache.commons.logging.Log	timeLog loggueur used to log time
protected long	timeToLogInfo time to trigger log time in info level (ns) (default: 1s)
protected long	timeToLogWarn time to trigger log time in warn level (ns) (default: 3s)

Constructor Summary

Constructors

Modifier	Constructor and Description
	TimeLog(Class<?> logName)
	TimeLog(Class<?> logName, long timeToLogInfo, long timeToLogWarn)
protected	TimeLog(org.apache.commons.logging.Log logTime)
	TimeLog(String logName)
	TimeLog(String logName, long timeToLogInfo, long timeToLogWarn)

Method Summary

Modifier and Type	Method and Description
Map<String,TimeLog.CallStat>	getCallCount()
static long	getTime() return time in format acceptable for log(long, long, String, String) method.
long	log(long startNs, long stopNs, String methodName, String msg) add new trace
long	log(long startNs, String methodName) add new trace, stop time is automaticaly computed.
long	log(long startNs, String methodName, String msg) add new trace, stop time is automaticaly computed
void	setTimeToLogInfo(long timeToLogInfoMs)
void	setTimeToLogWarn(long timeToLogWarnMs)

Methods inherited from class java.lang.Object

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

Field Detail

timeLog

protected org.apache.commons.logging.Log timeLog

loggueur used to log time

timeToLogInfo

protected long timeToLogInfo

time to trigger log time in info level (ns) (default: 1s)

timeToLogWarn

protected long timeToLogWarn

time to trigger log time in warn level (ns) (default: 3s)

callCount

protected Map<String,TimeLog.CallStat> callCount

for each method of all proxies, keep number of call

Constructor Detail

TimeLog

protected TimeLog(org.apache.commons.logging.Log logTime)

Parameters:

logTime - log used to log time message.

TimeLog

public TimeLog(String logName)

Parameters:

logName - log category used to log time message. This category must be category used to log message in classe that use this TimeLog (normaly class name). TimeLog is added at the end.

TimeLog

public TimeLog(Class<?> logName)

Parameters:

logName - log category used to log time message. This category must be category used to log message in classe that use this TimeLog (normaly class name)

Since:

2.1

TimeLog

public TimeLog(String logName,
               long timeToLogInfo,
               long timeToLogWarn)

Parameters:

logName - log category used to log time message. This category must be category used to log message in classe that use this TimeLog (normaly class name)

timeToLogInfo - time in milliseconde after that we log info

timeToLogWarn - time in milliseconde after that we log warn

TimeLog

public TimeLog(Class<?> logName,
               long timeToLogInfo,
               long timeToLogWarn)

Parameters:

logName - log category used to log time message. This category must be category used to log message in classe that use this TimeLog (normaly class name)

timeToLogInfo - time in milliseconde after that we log info

timeToLogWarn - time in milliseconde after that we log warn

Method Detail

setTimeToLogInfo

public void setTimeToLogInfo(long timeToLogInfoMs)

Parameters:

timeToLogInfoMs - time in milliseconde after that we log info

setTimeToLogWarn

public void setTimeToLogWarn(long timeToLogWarnMs)

Parameters:

timeToLogWarnMs - time in milliseconde after that we log warn

getCallCount

public Map<String,TimeLog.CallStat> getCallCount()

getTime

public static long getTime()

return time in format acceptable for log(long, long, String, String) method.

Returns:

the current time in nanoseconds

log

public long log(long startNs,
                String methodName)

add new trace, stop time is automaticaly computed.

Parameters:

startNs - time returned by getTime() method

methodName - key name to store this time

Returns:

time used as stop time, this permit to chain many add in same method to trace time.

log

public long log(long startNs,
                String methodName,
                String msg)

add new trace, stop time is automaticaly computed

Parameters:

startNs - time returned by getTime() method

methodName - key name to store this time

msg - message to add to log

Returns:

time used as stop time, this permit to chain many add in same method to trace time.

log

public long log(long startNs,
                long stopNs,
                String methodName,
                String msg)

add new trace

Parameters:

startNs - time returned by getTime() method

stopNs - time returned by getTime() method

methodName - key name to store this time

msg - message to add to log

Returns:

time used as stop time (stopNs)