com.foreach.common.spring.logging

Class MethodExecutionTimeLogger

java.lang.Object

com.foreach.common.spring.logging.MethodExecutionTimeLogger

public class MethodExecutionTimeLogger
extends Object

The MethodExecutionTimeLogger class contains utility method which can be used to log the method execution time. To use, inherit this class in your actual AspectJ class where you define advice method and point-cut methods. The advice method of your AspectJ class should use/call method proceedAndLogExecutionTime(org.aspectj.lang.ProceedingJoinPoint) for logging the method execution time in log files.

To use this class, perform following steps

• Inherit this class in your actual AspectJ class where you define advice and point-cut methods
• Define point-cut methods for which you wants method execution time to be logged
• In your advice method call the method proceedAndLogExecutionTime(org.aspectj.lang.ProceedingJoinPoint). This will log the method execution time
• All methods with duration of > 75 milliseconds will be logged by default. You can change this minimum duration time by method MethodExecutionTimeLogger.setMinimumDuration

Version:

1.0

Constructor Summary

Constructors

Constructor and Description
MethodExecutionTimeLogger()

Method Summary

Modifier and Type	Method and Description
protected org.slf4j.Logger	getLogger() Get the logger
protected Object	proceedAndLogExecutionTime(org.aspectj.lang.ProceedingJoinPoint point) This method will log the method duration time if the execution time exceeds specified minimum duration time.
protected void	setLogger(org.slf4j.Logger log) Specify your own logger where you want the method duration time to be logged
void	setMinimumDuration(int time) Specify the minimum duration time of methods in milliseconds.

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodExecutionTimeLogger

public MethodExecutionTimeLogger()

Method Detail

setLogger

protected final void setLogger(org.slf4j.Logger log)

Specify your own logger where you want the method duration time to be logged

Parameters:

log -

getLogger

protected final org.slf4j.Logger getLogger()

Get the logger

Returns:

Logger

setMinimumDuration

public final void setMinimumDuration(int time)

Specify the minimum duration time of methods in milliseconds. Default is 75 milliseconds. Methods whose processing time is greater then specified minimum duration time will be logged.

Parameters:

time - minimum duration time of methods in milliseconds (exclusive)

proceedAndLogExecutionTime

protected final Object proceedAndLogExecutionTime(org.aspectj.lang.ProceedingJoinPoint point)
                                           throws Throwable

This method will log the method duration time if the execution time exceeds specified minimum duration time. Log format - class-name.method-name duration-time(in milliseconds)

Following is the example of logged entries of MethodExecutionTimeLogger. You can see below all the methods executed for a unique request id with their execution time(in milliseconds).

• 2011-04-21 12:37:06,319 [1303382196403] be.restobookings.services.restaurant.RestaurantService.getRestaurantCountForPartner 594
• 2011-04-21 12:37:09,351 [1303382196403] be.restobookings.data.model.LocalizationDao.getLocalizedObjects 328
• 2011-04-21 12:37:09,351 [1303382196403] be.restobookings.services.localization.LocalizationService.getText 328

Parameters:

point - ProceedingJoinPoint reference from your advice method

Returns:

Throws:

Throwable