Package org.apache.hadoop.metrics2

Class MetricStringBuilder

java.lang.Object

org.apache.hadoop.metrics2.MetricsRecordBuilder

org.apache.hadoop.metrics2.MetricStringBuilder

@Public
@Evolving
public class MetricStringBuilder
extends MetricsRecordBuilder

Build a string dump of the metrics. The toString() operator dumps out all values collected. Every entry is formatted as prefix + name + separator + value + suffix

Constructor Summary

Constructors

Constructor	Description
MetricStringBuilder(MetricsCollector parent, java.lang.String prefix, java.lang.String separator, java.lang.String suffix)	Build an instance.

Method Summary

Modifier and Type	Method	Description
MetricsRecordBuilder	add(AbstractMetric metric)	Add a pre-made immutable metric object
MetricStringBuilder	add(MetricsInfo info, java.lang.Object value)
MetricsRecordBuilder	add(MetricsTag tag)	Add an immutable metrics tag object
MetricsRecordBuilder	addCounter(MetricsInfo info, int value)	Add an integer metric
MetricsRecordBuilder	addCounter(MetricsInfo info, long value)	Add an long metric
MetricsRecordBuilder	addGauge(MetricsInfo info, double value)	Add a double gauge metric
MetricsRecordBuilder	addGauge(MetricsInfo info, float value)	Add a float gauge metric
MetricsRecordBuilder	addGauge(MetricsInfo info, int value)	Add a integer gauge metric
MetricsRecordBuilder	addGauge(MetricsInfo info, long value)	Add a long gauge metric
MetricsCollector	parent()
MetricsRecordBuilder	setContext(java.lang.String value)	Set the context tag
MetricsRecordBuilder	tag(MetricsInfo info, java.lang.String value)	Add a metrics value with metrics information
java.lang.String	toString()
MetricStringBuilder	tuple(java.lang.String key, java.lang.String value)	Add any key,val pair to the string, between the prefix and suffix, separated by the separator.

Methods inherited from class org.apache.hadoop.metrics2.MetricsRecordBuilder

endRecord

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricStringBuilder

public MetricStringBuilder(MetricsCollector parent,
                           java.lang.String prefix,
                           java.lang.String separator,
                           java.lang.String suffix)

Build an instance.

Parameters:

parent - parent collector. Unused in this instance; only used for the parent() method

prefix - string before each entry

separator - separator between name and value

suffix - suffix after each entry

Method Detail

add

public MetricStringBuilder add(MetricsInfo info,
                               java.lang.Object value)

tuple

public MetricStringBuilder tuple(java.lang.String key,
                                 java.lang.String value)

Add any key,val pair to the string, between the prefix and suffix, separated by the separator.

Parameters:

key - key

value - value

Returns:

this instance

tag

public MetricsRecordBuilder tag(MetricsInfo info,
                                java.lang.String value)

Description copied from class: MetricsRecordBuilder

Add a metrics value with metrics information

Specified by:

tag in class MetricsRecordBuilder

Parameters:

info - metadata of the tag

value - of the tag

Returns:

self

add

public MetricsRecordBuilder add(MetricsTag tag)

Description copied from class: MetricsRecordBuilder

Add an immutable metrics tag object

Specified by:

add in class MetricsRecordBuilder

Parameters:

tag - a pre-made tag object (potentially save an object construction)

Returns:

self

add

public MetricsRecordBuilder add(AbstractMetric metric)

Description copied from class: MetricsRecordBuilder

Add a pre-made immutable metric object

Specified by:

add in class MetricsRecordBuilder

Parameters:

metric - the pre-made metric to save an object construction

Returns:

self

setContext

public MetricsRecordBuilder setContext(java.lang.String value)

Description copied from class: MetricsRecordBuilder

Set the context tag

Specified by:

setContext in class MetricsRecordBuilder

Parameters:

value - of the context

Returns:

self

addCounter

public MetricsRecordBuilder addCounter(MetricsInfo info,
                                       int value)

Description copied from class: MetricsRecordBuilder

Add an integer metric

Specified by:

addCounter in class MetricsRecordBuilder

Parameters:

info - metadata of the metric

value - of the metric

Returns:

self

addCounter

public MetricsRecordBuilder addCounter(MetricsInfo info,
                                       long value)

Description copied from class: MetricsRecordBuilder

Add an long metric

Specified by:

addCounter in class MetricsRecordBuilder

Parameters:

info - metadata of the metric

value - of the metric

Returns:

self

addGauge

public MetricsRecordBuilder addGauge(MetricsInfo info,
                                     int value)

Description copied from class: MetricsRecordBuilder

Add a integer gauge metric

Specified by:

addGauge in class MetricsRecordBuilder

Parameters:

info - metadata of the metric

value - of the metric

Returns:

self

addGauge

public MetricsRecordBuilder addGauge(MetricsInfo info,
                                     long value)

Description copied from class: MetricsRecordBuilder

Add a long gauge metric

Specified by:

addGauge in class MetricsRecordBuilder

Parameters:

info - metadata of the metric

value - of the metric

Returns:

self

addGauge

public MetricsRecordBuilder addGauge(MetricsInfo info,
                                     float value)

Description copied from class: MetricsRecordBuilder

Add a float gauge metric

Specified by:

addGauge in class MetricsRecordBuilder

Parameters:

info - metadata of the metric

value - of the metric

Returns:

self

addGauge

public MetricsRecordBuilder addGauge(MetricsInfo info,
                                     double value)

Description copied from class: MetricsRecordBuilder

Add a double gauge metric

Specified by:

addGauge in class MetricsRecordBuilder

Parameters:

info - metadata of the metric

value - of the metric

Returns:

self

parent

public MetricsCollector parent()

Specified by:

parent in class MetricsRecordBuilder

Returns:

the parent metrics collector object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object