Package org.apache.hadoop.metrics2

Interface MetricsRecord

All Known Implementing Classes:

MetricsRecordImpl

@Public
@Evolving
public interface MetricsRecord

An immutable snapshot of metrics with a timestamp

Method Summary

Modifier and Type	Method	Description
java.lang.String	context()
java.lang.String	description()
java.lang.Iterable<AbstractMetric>	metrics()	Get the metrics of the record
java.lang.String	name()
java.util.Collection<MetricsTag>	tags()	Get the tags of the record Note: returning a collection instead of iterable as we need to use tags as keys (hence Collection#hashCode etc.) in maps
long	timestamp()	Get the timestamp of the metrics

Method Detail

timestamp

long timestamp()

Get the timestamp of the metrics

Returns:

the timestamp

name

java.lang.String name()

Returns:

the metrics record name

description

java.lang.String description()

Returns:

the description of the metrics record

context

java.lang.String context()

Returns:

the context name of the metrics record

tags

java.util.Collection<MetricsTag> tags()

Get the tags of the record Note: returning a collection instead of iterable as we need to use tags as keys (hence Collection#hashCode etc.) in maps

Returns:

an unmodifiable collection of tags

metrics

java.lang.Iterable<AbstractMetric> metrics()

Get the metrics of the record

Returns:

an immutable iterable interface for metrics