@Inherited
@Documented
@Retention(value=RUNTIME)
@Target(value={TYPE,CONSTRUCTOR,METHOD,ANNOTATION_TYPE})
public @interface Metered
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.
This annotation will throw an IllegalStateException if the constructor/method is invoked, but the metric no longer
exists in the MetricRegistry.| Modifier and Type | Optional Element and 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.
|
public abstract java.lang.String name
public abstract java.lang.String[] tags
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.Metadatapublic abstract boolean absolute
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.public abstract java.lang.String displayName
Metadatapublic abstract java.lang.String description
Metadatapublic abstract java.lang.String unit
MetricUnits.PER_SECOND.Metadata,
MetricUnits