org.apache.hadoop.metrics.spi
Class MetricsRecordImpl

java.lang.Object
  org.apache.hadoop.metrics.spi.MetricsRecordImpl

All Implemented Interfaces:

org.apache.hadoop.metrics.MetricsRecord

@InterfaceAudience.Public
@InterfaceStability.Evolving
public class MetricsRecordImpl
extends Object
implements org.apache.hadoop.metrics.MetricsRecord

An implementation of MetricsRecord. Keeps a back-pointer to the context from which it was created, and delegates back to it on update and remove().

Constructor Summary

protected

MetricsRecordImpl(String recordName, AbstractMetricsContext context) Creates a new instance of FileRecord

Method Summary

String	getRecordName() Returns the record name.
void	incrMetric(String metricName, byte metricValue) Increments the named metric by the specified value.
void	incrMetric(String metricName, float metricValue) Increments the named metric by the specified value.
void	incrMetric(String metricName, int metricValue) Increments the named metric by the specified value.
void	incrMetric(String metricName, long metricValue) Increments the named metric by the specified value.
void	incrMetric(String metricName, short metricValue) Increments the named metric by the specified value.
void	remove() Removes the row, if it exists, in the buffered data table having tags that equal the tags that have been set on this record.
void	removeTag(String tagName) Removes any tag of the specified name.
void	setMetric(String metricName, byte metricValue) Sets the named metric to the specified value.
void	setMetric(String metricName, float metricValue) Sets the named metric to the specified value.
void	setMetric(String metricName, int metricValue) Sets the named metric to the specified value.
void	setMetric(String metricName, long metricValue) Sets the named metric to the specified value.
void	setMetric(String metricName, short metricValue) Sets the named metric to the specified value.
void	setTag(String tagName, byte tagValue) Sets the named tag to the specified value.
void	setTag(String tagName, int tagValue) Sets the named tag to the specified value.
void	setTag(String tagName, long tagValue) Sets the named tag to the specified value.
void	setTag(String tagName, short tagValue) Sets the named tag to the specified value.
void	setTag(String tagName, String tagValue) Sets the named tag to the specified value.
void	update() Updates the table of buffered data which is to be sent periodically.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricsRecordImpl

protected MetricsRecordImpl(String recordName,
                            AbstractMetricsContext context)

Creates a new instance of FileRecord

Method Detail

getRecordName

public String getRecordName()

Returns the record name.

Specified by:

getRecordName in interface org.apache.hadoop.metrics.MetricsRecord

Returns:

the record name

setTag

public void setTag(String tagName,
                   String tagValue)

Sets the named tag to the specified value.

Specified by:

setTag in interface org.apache.hadoop.metrics.MetricsRecord

Parameters:

tagName - name of the tag

tagValue - new value of the tag

Throws:

org.apache.hadoop.metrics.MetricsException - if the tagName conflicts with the configuration

setTag

public void setTag(String tagName,
                   int tagValue)

Sets the named tag to the specified value.

Specified by:

setTag in interface org.apache.hadoop.metrics.MetricsRecord

Parameters:

tagName - name of the tag

tagValue - new value of the tag

Throws:

org.apache.hadoop.metrics.MetricsException - if the tagName conflicts with the configuration

setTag

public void setTag(String tagName,
                   long tagValue)

Sets the named tag to the specified value.

Specified by:

setTag in interface org.apache.hadoop.metrics.MetricsRecord

Parameters:

tagName - name of the tag

tagValue - new value of the tag

Throws:

org.apache.hadoop.metrics.MetricsException - if the tagName conflicts with the configuration

setTag

public void setTag(String tagName,
                   short tagValue)

Sets the named tag to the specified value.

Specified by:

setTag in interface org.apache.hadoop.metrics.MetricsRecord

Parameters:

tagName - name of the tag

tagValue - new value of the tag

Throws:

org.apache.hadoop.metrics.MetricsException - if the tagName conflicts with the configuration

setTag

public void setTag(String tagName,
                   byte tagValue)

Sets the named tag to the specified value.

Specified by:

setTag in interface org.apache.hadoop.metrics.MetricsRecord

Parameters:

tagName - name of the tag

tagValue - new value of the tag

Throws:

org.apache.hadoop.metrics.MetricsException - if the tagName conflicts with the configuration

removeTag

public void removeTag(String tagName)

Removes any tag of the specified name.

Specified by:

removeTag in interface org.apache.hadoop.metrics.MetricsRecord

Parameters:

tagName - name of a tag

setMetric

public void setMetric(String metricName,
                      int metricValue)

Sets the named metric to the specified value.

Specified by:

setMetric in interface org.apache.hadoop.metrics.MetricsRecord

Parameters:

metricName - name of the metric

metricValue - new value of the metric

Throws:

org.apache.hadoop.metrics.MetricsException - if the metricName or the type of the metricValue conflicts with the configuration

setMetric

public void setMetric(String metricName,
                      long metricValue)

Sets the named metric to the specified value.

Specified by:

setMetric in interface org.apache.hadoop.metrics.MetricsRecord

Parameters:

metricName - name of the metric

metricValue - new value of the metric

Throws:

org.apache.hadoop.metrics.MetricsException - if the metricName or the type of the metricValue conflicts with the configuration

setMetric

public void setMetric(String metricName,
                      short metricValue)

Sets the named metric to the specified value.

Specified by:

setMetric in interface org.apache.hadoop.metrics.MetricsRecord

Parameters:

metricName - name of the metric

metricValue - new value of the metric

Throws:

org.apache.hadoop.metrics.MetricsException - if the metricName or the type of the metricValue conflicts with the configuration

setMetric

public void setMetric(String metricName,
                      byte metricValue)

Sets the named metric to the specified value.

Specified by:

setMetric in interface org.apache.hadoop.metrics.MetricsRecord

Parameters:

metricName - name of the metric

metricValue - new value of the metric

Throws:

org.apache.hadoop.metrics.MetricsException - if the metricName or the type of the metricValue conflicts with the configuration

setMetric

public void setMetric(String metricName,
                      float metricValue)

Sets the named metric to the specified value.

Specified by:

setMetric in interface org.apache.hadoop.metrics.MetricsRecord

Parameters:

metricName - name of the metric

metricValue - new value of the metric

Throws:

org.apache.hadoop.metrics.MetricsException - if the metricName or the type of the metricValue conflicts with the configuration

incrMetric

public void incrMetric(String metricName,
                       int metricValue)

Increments the named metric by the specified value.

Specified by:

incrMetric in interface org.apache.hadoop.metrics.MetricsRecord

Parameters:

metricName - name of the metric

metricValue - incremental value

Throws:

org.apache.hadoop.metrics.MetricsException - if the metricName or the type of the metricValue conflicts with the configuration

incrMetric

public void incrMetric(String metricName,
                       long metricValue)

Increments the named metric by the specified value.

Specified by:

incrMetric in interface org.apache.hadoop.metrics.MetricsRecord

Parameters:

metricName - name of the metric

metricValue - incremental value

Throws:

org.apache.hadoop.metrics.MetricsException - if the metricName or the type of the metricValue conflicts with the configuration

incrMetric

public void incrMetric(String metricName,
                       short metricValue)

Increments the named metric by the specified value.

Specified by:

incrMetric in interface org.apache.hadoop.metrics.MetricsRecord

Parameters:

metricName - name of the metric

metricValue - incremental value

Throws:

org.apache.hadoop.metrics.MetricsException - if the metricName or the type of the metricValue conflicts with the configuration

incrMetric

public void incrMetric(String metricName,
                       byte metricValue)

Increments the named metric by the specified value.

Specified by:

incrMetric in interface org.apache.hadoop.metrics.MetricsRecord

Parameters:

metricName - name of the metric

metricValue - incremental value

Throws:

org.apache.hadoop.metrics.MetricsException - if the metricName or the type of the metricValue conflicts with the configuration

incrMetric

public void incrMetric(String metricName,
                       float metricValue)

Increments the named metric by the specified value.

Specified by:

incrMetric in interface org.apache.hadoop.metrics.MetricsRecord

Parameters:

metricName - name of the metric

metricValue - incremental value

Throws:

org.apache.hadoop.metrics.MetricsException - if the metricName or the type of the metricValue conflicts with the configuration

update

public void update()

Updates the table of buffered data which is to be sent periodically. If the tag values match an existing row, that row is updated; otherwise, a new row is added.

Specified by:

update in interface org.apache.hadoop.metrics.MetricsRecord

remove

public void remove()

Removes the row, if it exists, in the buffered data table having tags that equal the tags that have been set on this record.

Specified by:

remove in interface org.apache.hadoop.metrics.MetricsRecord