Annotation Interface Counted
@Inherited
@Documented
@InterceptorBinding
@Retention(RUNTIME)
@Target({TYPE,CONSTRUCTOR,METHOD,ANNOTATION_TYPE})
public @interface Counted
An annotation for marking a method, constructor, or class as counted.
The metric will be registered in the application MetricRegistry.
Given a method annotated with @Counted like this:
@Counted(name = "fancyName")
public String fancyName(String name) {
return "Sir Captain " + name;
}
A counter with the fully qualified class name + fancyName
will be created and each time the
#fancyName(String)
method is invoked, the counter will be marked.
Similarly, the same applies for a constructor annotated with counted.
(See monotonic()
for how the counter will be incremented).
Given a class annotated with @Counted like this:
@Counted
public class CounterBean {
public void countMethod1() {}
public void countMethod2() {}
}
A counter for the defining class will be created for each of the constructors/methods.
Each time the constructor/method is invoked, the respective counter will be marked.
(See monotonic()
for how the counter will be incremented)-
Optional Element Summary
-
Element Details
-
name
String name- Returns:
- The name of the counter.
- Default:
- ""
-
tags
String[] tags- Returns:
- The tags of the counter. 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
-
monotonic
boolean monotonic- Returns:
- If
false
(default), the counter is decremented when the annotated method returns, counting current invocations of the annotated method. Iftrue
, the counter increases monotonically, counting total invocations of the annotated method.
- Default:
- false
-
displayName
String displayName- Returns:
- The display name of the counter.
- See Also:
- Default:
- ""
-
description
String description- Returns:
- The description of the counter.
- See Also:
- Default:
- ""
-
unit
String unit- Returns:
- The unit of the counter. By default, the value is
MetricUnits.NONE
. - See Also:
- Default:
- "none"
-