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.
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.
The counter value will only monotonically increase.
This annotation will throw an IllegalStateException if the constructor/method is invoked, but the metric no longer
exists in the MetricRegistry.
| Modifier and Type | Method and Description |
|---|---|
| public boolean | Returns: Iftrue, 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.Denotes whether to use the absolute name or use the default given name relative to the annotated class. |
| public String | |
| public String | |
| public String | Returns: The scope this counter belongs to. By default, the value isMetricRegistry#APPLICATION_SCOPE.The scope that this counter belongs to. |
| public String[] | Returns: The tags of the counter. EachString tag must be in the form of 'key=value'. If the input is
empty or does not contain a '=' sign, the entry is ignored.The tags of the counter. |
| public String | Returns: The unit of the counter. By default, the value isMetricUnits#NONE.The unit of the counter. |
| absolute | back to summary |
|---|---|
| public boolean absolute() Denotes whether to use the absolute name or use the default given name relative to the annotated class.
| |
| description | back to summary |
|---|---|
| public String description() The description of the counter.
| |
| name | back to summary |
|---|---|
| public String name() The name of the counter.
| |
| scope | back to summary |
|---|---|
| public String scope() The scope that this counter belongs to.
| |
| tags | back to summary |
|---|---|
| public String[] tags() The tags of the counter.
| |
| unit | back to summary |
|---|---|
| public String unit() The unit of the counter.
| |