com.jcabi.aspects

Annotation Type Loggable

@Documented
@Retention(value=RUNTIME)
@Target(value={METHOD,CONSTRUCTOR,TYPE})
public @interface Loggable

Makes a method loggable via Logger.

For example, this load() method produces a log line on every call:

 @Loggable
 String load(String resource) throws IOException {
   return "something";
 }

You can configure the level of logging:

 @Loggable(Loggable.DEBUG)
 void save(String resource) throws IOException {
   // do something
 }

Since version 0.7.6, you can specify a maximum execution time limit for a method. If such a limit is reached a logging message will be issued with a WARN priority. It is a very convenient mechanism for profiling applications in production. Default value of a limit is 1 second.

 @Loggable(limit = 2)
 void save(String resource) throws IOException {
   // do something, potentially slow
 }

Since version 0.7.14 you can change the time unit for the "limit" parameter. Default unit of measurement is a second:

 @Loggable(limit = 200, unit = TimeUnit.MILLISECONDS)
 void save(String resource) throws IOException {
   // do something, potentially slow
 }

Since:

0.7.2

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

Logger, http://www.jcabi.com/jcabi-aspects/

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	limit Maximum amount allowed for this method (a warning will be issued if it takes longer).
boolean	prepend Method entry moment should be reported as well (by default only an exit moment is reported).
boolean	trim Shall we trim long texts in order to make log lines more readable?
TimeUnit	unit Time unit for the limit.
int	value Level of logging.

Element Detail

value

public abstract int value

Level of logging.

Default:

1

limit

public abstract int limit

Maximum amount allowed for this method (a warning will be issued if it takes longer).

Since:

0.7.6

Default:

1

unit

public abstract TimeUnit unit

Time unit for the limit.

Since:

0.7.14

Default:

java.util.concurrent.TimeUnit.SECONDS

trim

public abstract boolean trim

Shall we trim long texts in order to make log lines more readable?

Since:

0.7.13

Default:

true

prepend

public abstract boolean prepend

Method entry moment should be reported as well (by default only an exit moment is reported).

Since:

0.7.16

Default:

false