org.avaje.metric.annotation

Annotation Type Timed

@Target(value={TYPE,METHOD})
 @Retention(value=RUNTIME)
public @interface Timed

Put onto a Class or methods that we want timed execution statistics collected.

When put on a Class the default is that all public methods on that Class are timed.

When put on a method we want to override some of metric naming or only collect timed execution on very few methods on the class.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int[]	buckets Define buckets as a list of millisecond times.
String	fullName Set the full name of the metric.
String	name Set the method name part of the full metric name.
String	prefix Set the prefix for short metric names.

Element Detail

prefix

public abstract String prefix

Set the prefix for short metric names. Typically used at class level to define a common short prefix to replace the package name for the metrics on the class.

@Timed(perfix="web.api")
public class AdminResource
  ...

Returns:

Default:

""

name

public abstract String name

Set the method name part of the full metric name.

This is used when the method name is not appropriate or when there is method overloading and the otherwise generated unique name is unclear.

The package and class names are still used and prepended to this name value.

Default:

""

fullName

public abstract String fullName

Set the full name of the metric.

Provides a complete replacement of the metric name. The package and class names are not used at all.

Default:

""

buckets

public abstract int[] buckets

Define buckets as a list of millisecond times.

For example with values of 100, 200, 300 there a with 4 bucket ranges of:

     0 to 100 milliseconds
   100 to 200 milliseconds
   200 to 300 milliseconds
   300+       milliseconds

Defining buckets means a BucketTimedMetric will be used instead of a TimedMetric.

Default:

{}