Annotation Type 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; }
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() {} }
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description boolean
absolute
java.lang.String
description
The description of the meter.java.lang.String
displayName
The display name of the meter.java.lang.String
name
java.lang.String[]
tags
java.lang.String
unit
The unit of the meter.
-
-
-
-
tags
java.lang.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:
Metadata
- Default:
- {}
-
-
-
displayName
java.lang.String displayName
The display name of the meter.- Returns:
- The display name of the meter.
- See Also:
Metadata
- Default:
- ""
-
-
-
description
java.lang.String description
The description of the meter.- Returns:
- The description of the meter.
- See Also:
Metadata
- Default:
- ""
-
-
-
unit
java.lang.String unit
The unit of the meter.- Returns:
- The unit of the meter. By default, the value is
MetricUnits.PER_SECOND
. - See Also:
Metadata
,MetricUnits
- Default:
- "per_second"
-
-