Class Instrument

java.lang.Object

com.codename1.backend.metrics.Instrument

Direct Known Subclasses:

Counter, Gauge, Histogram

public abstract class Instrument
extends Object

One named measurement: a counter, a gauge or a histogram.

Created once through Metrics and kept -- the build's generated code holds each in a static field -- so recording a value never looks anything up.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	COUNTER
static final int	GAUGE
static final int	HISTOGRAM
static final int	UP_DOWN_COUNTER

Method Summary

Modifier and Type	Method	Description
String	getDescription()
int	getKind()	COUNTER, UP_DOWN_COUNTER, GAUGE or HISTOGRAM.
String	getName()
String	getUnit()
abstract List	points()	The current points, each a map with attributes (a map, possibly empty) and either value or, for a histogram, count, sum, min, max, bounds and buckets.

Methods inherited from class Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

COUNTER

public static final int COUNTER

See Also:

• Constant Field Values

UP_DOWN_COUNTER

public static final int UP_DOWN_COUNTER

See Also:

• Constant Field Values

GAUGE

public static final int GAUGE

See Also:

• Constant Field Values

HISTOGRAM

public static final int HISTOGRAM

See Also:

• Constant Field Values

Method Details

getName

public String getName()

getDescription

public String getDescription()

getUnit

public String getUnit()

getKind

public int getKind()

COUNTER, UP_DOWN_COUNTER, GAUGE or HISTOGRAM.

points

public abstract List points()

The current points, each a map with attributes (a map, possibly empty) and either value or, for a histogram, count, sum, min, max, bounds and buckets.