org.apache.hadoop.metrics2

Interface MetricsInfo

All Known Implementing Classes:

AbstractMetric, MetricsTag

@InterfaceAudience.Public
@InterfaceStability.Evolving
public interface MetricsInfo

Interface to provide immutable metainfo for metrics.

Method Summary

Methods

Modifier and Type	Method and Description
String	description() Typically the description corresponds to annotation Metric.about() or the name of the class.
String	name() Typically name corresponds to annotation Metric.value() or the name of the class.

Method Detail

name

String name()

Typically name corresponds to annotation Metric.value() or the name of the class.

Returns:

the name of the metric/tag

description

String description()

Typically the description corresponds to annotation Metric.about() or the name of the class.

Returns:

the description of the metric/tag