Annotation Interface Metered
@Inherited
@Documented
@InterceptorBinding
@Retention(RUNTIME)
@Target({TYPE,CONSTRUCTOR,METHOD,ANNOTATION_TYPE})
public @interface Metered
An annotation for marking a method, constructor, or class as metered.
The metric will be registered in the application MetricRegistry.
Given a method annotated with @Metered like this:
@Metered(name = "fancyName")
public String fancyName(String name) {
return "Sir Captain " + name;
}
A meter with the fully qualified class name + fancyName
will be created and each time the
#fancyName(String)
method is invoked, the meter will be marked.
Similarly, the same applies for a constructor annotated with metered.
Given a class annotated with @Metered like this:
@Metered
public class MeteredBean {
public void meteredMethod1() {}
public void meteredMethod2() {}
}
A meter for the defining class will be created for each of the constructors/methods.
Each time a constructor/method is invoked, the respective meter will be marked.-
Optional Element Summary
-
Element Details
-
name
String name- Returns:
- The name of the meter.
- Default:
- ""
-
tags
String[] tags- Returns:
- The tags of the meter. 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:
- Default:
- {}
-
absolute
boolean absolute- Returns:
- If
true
, use the given name as an absolute name. Iffalse
(default), use the given name relative to the annotated class. When annotating a class, this must befalse
.
- Default:
- false
-
displayName
String displayName- Returns:
- The display name of the meter.
- See Also:
- Default:
- ""
-
description
String description- Returns:
- The description of the meter.
- See Also:
- Default:
- ""
-
unit
String unit- Returns:
- The unit of the meter. By default, the value is
MetricUnits.PER_SECOND
. - See Also:
- Default:
- "per_second"
-