Timer metric aggregates timing durations and provides duration
statistics.
Given a method annotated with @Timed like this:
@Timed(name = "fancyName")
public String fancyName(String name) {
return "Sir Captain " + name;
}
A timer with the fully qualified class name + fancyName will be created and each time the
#fancyName(String) method is invoked, the method's execution will be timed.
Given a class annotated with @Timed like this:
@Timed
public class TimedBean {
public void timedMethod1() {}
public void timedMethod2() {}
}
A timer for the defining class will be created for each of the constructors/methods. Each time a constructor/method
is invoked, the execution will be timed with the respective timer.
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 Timer belongs to. By default, the value isMetricRegistry#APPLICATION_SCOPE.The scope that this Timer belongs to. |
| public String[] | Returns: The tags of the timer. 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.
|
| public String | Returns: The unit of the timer. By default, the value isMetricUnits#NANOSECONDS.The unit of the timer. |
| 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 timer.
| |
| name | back to summary |
|---|---|
| public String name() The name of the timer.
| |
| scope | back to summary |
|---|---|
| public String scope() The scope that this Timer belongs to.
| |
| tags | back to summary |
|---|---|
public String[] tags()
| |
| unit | back to summary |
|---|---|
| public String unit() The unit of the timer.
| |