com.codahale.metrics.annotation

Annotation Type Gauge

@Retention(value=RUNTIME)
@Target(value={METHOD,FIELD})
public @interface Gauge

An annotation for marking a method of an annotated object as a gauge.

Given a method like this:

     @Gauge(name = "queueSize")
     public int getQueueSize() {
         return queue.size;
     }
 

A gauge for the defining class with the name queueSize will be created which uses the annotated method's return value as its value.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	absolute If true, use the given name as an absolute name.
String	name The gauge's name.

Element Detail

name

public abstract String name

The gauge's name.

Default:

""

absolute

public abstract boolean absolute

If true, use the given name as an absolute name. If false, use the given name relative to the annotated class.

Default:

false