org.eclipse.microprofile.metrics.annotation

Annotation Type Timed

@Inherited
 @Documented
 @InterceptorBinding
 @Retention(value=RUNTIME)
 @Target(value={TYPE,CONSTRUCTOR,METHOD,ANNOTATION_TYPE})
public @interface Timed

An annotation for marking a method, constructor, or class as timed. The metric will be registered in the application MetricRegistry.

Given a method annotated with @Timed like this:

      @Timed(name = "fancyName")
     public String fancyName(String name) {
         return "Sir Captain " + name;
     }
 

A timer with the fully qualified class name + fancyName will be created and each time the #fancyName(String) method is invoked, the method's execution will be timed.

Given a class annotated with @Timed like this:

      @Timed
     public class TimedBean {
         public void timedMethod1() {}
         public void timedMethod2() {}
     }
 

A timer for the defining class will be created for each of the constructors/methods. Each time a constructor/method is invoked, the execution will be timed with the respective timer.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	absolute
String	description
String	displayName
String	name
String[]	tags
String	unit

Element Detail

name

public abstract String name

Returns:

The name of the timer.

Default:

""

tags

public abstract String[] tags

Returns:

The tags of the timer. Each String tag must be in the form of 'key=value'. If the input is empty or does not contain a '=' sign, the entry is ignored.

See Also:

Metadata

Default:

{}

absolute

public abstract boolean absolute

Returns:

If true, use the given name as an absolute name. If false (default), use the given name relative to the annotated class. When annotating a class, this must be false.

Default:

false

displayName

public abstract String displayName

Returns:

The display name of the timer.

See Also:

Metadata

Default:

""

description

public abstract String description

Returns:

The description of the timer.

See Also:

Metadata

Default:

""

unit

public abstract String unit

Returns:

The unit of the timer. By default, the value is MetricUnits.NANOSECONDS.

See Also:

Metadata, MetricUnits

Default:

"nanoseconds"