com.yammer.metrics.annotation

Annotation Type Gauge

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

An annotation for marking a method of a Guice-provided 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
String	group The gauge's group.
String	name The gauge's name.
String	type The gauge's type.

Element Detail

group

public abstract String group

The gauge's group.

Default:

""

type

public abstract String type

The gauge's type.

Default:

""

name

public abstract String name

The gauge's name.

Default:

""