io.opencensus.metrics

Class MetricOptions

java.lang.Object

io.opencensus.metrics.MetricOptions

@Immutable
public abstract class MetricOptions
extends Object

Options for every metric added to the MetricRegistry.

Since:

0.20

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetricOptions.Builder Builder for MetricOptions.

Method Summary

Modifier and Type	Method and Description
static MetricOptions.Builder	builder() Returns a new MetricOptions.Builder with default options.
abstract Map<LabelKey,LabelValue>	getConstantLabels() Returns the map of constant labels (they will be added to all the TimeSeries) for the Metric.
abstract String	getDescription() Returns the description of the Metric.
abstract List<LabelKey>	getLabelKeys() Returns the list of label keys for the Metric.
abstract String	getUnit() Returns the unit of the Metric.

Methods inherited from class java.lang.Object

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

Method Detail

getDescription

public abstract String getDescription()

Returns the description of the Metric.

Default value is "".

Returns:

the description of the Metric.

Since:

0.20

getUnit

public abstract String getUnit()

Returns the unit of the Metric.

Default value is "1".

Returns:

the unit of the Metric.

Since:

0.20

getLabelKeys

public abstract List<LabelKey> getLabelKeys()

Returns the list of label keys for the Metric.

Default value is Collections.emptyList().

Returns:

the list of label keys for the Metric.

Since:

0.20

getConstantLabels

public abstract Map<LabelKey,LabelValue> getConstantLabels()

Returns the map of constant labels (they will be added to all the TimeSeries) for the Metric.

Default value is Collections.emptyMap().

Returns:

the map of constant labels for the Metric.

Since:

0.21

builder

public static MetricOptions.Builder builder()

Returns a new MetricOptions.Builder with default options.

Returns:

a new Builder with default options.

Since:

0.20.0