com.jcabi.aspects

Annotation Type Loggable

@Documented
@Retention(value=RUNTIME)
@Target(value={METHOD,CONSTRUCTOR})
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 50 milliseconds:

 @Loggable(limit = 200)
 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

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	limit Maximum amount of milliseconds allowed for this method (a warning will be issued if it takes longer).
int	value Level of logging.

Element Detail

value

public abstract int value

Level of logging.

Default:

1

limit

public abstract int limit

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

Since:

0.7.6

Suppressed Checkstyle violations:

MagicNumber (2 lines)

Default:

50