com.google.gerrit.metrics

Class Description

java.lang.Object

com.google.gerrit.metrics.Description

public class Description
extends Object

Describes a metric created by MetricMaker.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Description.FieldOrdering
static class	Description.Units

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONSTANT
static String	CUMULATIVE
static String	DESCRIPTION
static String	FIELD_ORDERING
static String	GAUGE
static String	RATE
static String	TRUE_VALUE
static String	UNIT

Constructor Summary

Constructors

Constructor and Description
Description(String helpText) Describe a metric.

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableMap<String,String>	getAnnotations()
Description.FieldOrdering	getFieldOrdering()
TimeUnit	getTimeUnit() Decode the unit as a unit of time.
static TimeUnit	getTimeUnit(String unit)
boolean	isConstant()
boolean	isCumulative()
boolean	isGauge()
boolean	isRate()
Description	setConstant() Mark the value as constant for the life of this process.
Description	setCumulative() Indicates the metric accumulates over the lifespan of the process.
Description	setFieldOrdering(Description.FieldOrdering ordering) Configure how fields are ordered into submetric names.
Description	setGauge() Instantaneously sampled value that may increase or decrease at a later time.
Description	setRate() Indicates the metric may be usefully interpreted as a count over short periods of time, such as request arrival rate.
Description	setUnit(String unitName) Set unit used to describe the value.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DESCRIPTION

public static final String DESCRIPTION

See Also:

Constant Field Values

UNIT

public static final String UNIT

See Also:

Constant Field Values

CUMULATIVE

public static final String CUMULATIVE

See Also:

Constant Field Values

RATE

public static final String RATE

See Also:

Constant Field Values

GAUGE

public static final String GAUGE

See Also:

Constant Field Values

CONSTANT

public static final String CONSTANT

See Also:

Constant Field Values

FIELD_ORDERING

public static final String FIELD_ORDERING

See Also:

Constant Field Values

TRUE_VALUE

public static final String TRUE_VALUE

See Also:

Constant Field Values

Constructor Detail

Description

public Description(String helpText)

Describe a metric.

Parameters:

helpText - a short one-sentence string explaining the values captured by the metric. This may be made available to administrators as documentation in the reporting tools.

Method Detail

setUnit

public Description setUnit(String unitName)

Set unit used to describe the value.

Parameters:

unitName - name of the unit, e.g. "requests", "seconds", etc.

Returns:

this

setConstant

public Description setConstant()

Mark the value as constant for the life of this process. Typically used for software versions, command line arguments, etc. that cannot change without a process restart.

Returns:

this

setRate

public Description setRate()

Indicates the metric may be usefully interpreted as a count over short periods of time, such as request arrival rate. May only be applied to a Counter0.

Returns:

this

setGauge

public Description setGauge()

Instantaneously sampled value that may increase or decrease at a later time. Memory allocated or open network connections are examples of gauges.

Returns:

this

setCumulative

public Description setCumulative()

Indicates the metric accumulates over the lifespan of the process. A Counter0 like total requests handled accumulates over the process and should be setCumulative().

Returns:

this

setFieldOrdering

public Description setFieldOrdering(Description.FieldOrdering ordering)

Configure how fields are ordered into submetric names.

Parameters:

ordering - field ordering

Returns:

this

isConstant

public boolean isConstant()

Returns:

true if the metric value never changes after startup.

isRate

public boolean isRate()

Returns:

true if the metric may be interpreted as a rate over time.

isGauge

public boolean isGauge()

Returns:

true if the metric is an instantaneous sample.

isCumulative

public boolean isCumulative()

Returns:

true if the metric accumulates over the lifespan of the process.

getFieldOrdering

public Description.FieldOrdering getFieldOrdering()

Returns:

the suggested field ordering.

getTimeUnit

public TimeUnit getTimeUnit()

Decode the unit as a unit of time.

Returns:

valid time unit.

Throws:

IllegalArgumentException - if the unit is not a valid unit of time.

getTimeUnit

public static TimeUnit getTimeUnit(String unit)

getAnnotations

public com.google.common.collect.ImmutableMap<String,String> getAnnotations()

Returns:

immutable copy of all annotations (configurable properties).

toString

public String toString()

Overrides:

toString in class Object