org.apache.hadoop.metrics2.lib

Class DynamicMetricsRegistry

java.lang.Object

org.apache.hadoop.metrics2.lib.DynamicMetricsRegistry

@InterfaceAudience.Private
public class DynamicMetricsRegistry
extends java.lang.Object

An optional metrics registry class for creating and maintaining a collection of MetricsMutables, making writing metrics source easier. NOTE: this is a copy of org.apache.hadoop.metrics2.lib.MetricsRegistry with added one feature: metrics can be removed. When HADOOP-8313 is fixed, usages of this class should be substituted with org.apache.hadoop.metrics2.lib.MetricsRegistry. This implementation also provides handy methods for creating metrics dynamically. Another difference is that metricsMap implementation is substituted with thread-safe map, as we allow dynamic metrics additions/removals.

Constructor Summary

Constructors

Constructor and Description
DynamicMetricsRegistry(MetricsInfo info) Construct the registry with a metadata object
DynamicMetricsRegistry(java.lang.String name) Construct the registry with a record name

Method Summary

Modifier and Type	Method and Description
void	clearMetrics()
MutableMetric	get(java.lang.String name) Get a metric by name
MutableFastCounter	getCounter(java.lang.String counterName, long potentialStartingValue) Get a MetricMutableCounterLong from the storage.
MutableGaugeLong	getGauge(java.lang.String gaugeName, long potentialStartingValue) Get a MetricMutableGaugeLong from the storage.
MutableHistogram	getHistogram(java.lang.String histoName)
MetricsTag	getTag(java.lang.String name) Get a tag by name
MetricsInfo	info()
MutableFastCounter	newCounter(MetricsInfo info, long iVal) Create a mutable long integer counter
MutableFastCounter	newCounter(java.lang.String name, java.lang.String desc, long iVal) Create a mutable long integer counter
MutableGaugeLong	newGauge(MetricsInfo info, long iVal) Create a mutable long integer gauge
MutableGaugeLong	newGauge(java.lang.String name, java.lang.String desc, long iVal) Create a mutable long integer gauge
MutableHistogram	newHistogram(java.lang.String name) Create a new histogram.
MutableHistogram	newHistogram(java.lang.String name, java.lang.String desc) Create a new histogram.
MutableRate	newRate(java.lang.String name) Create a mutable rate metric
MutableRate	newRate(java.lang.String name, java.lang.String description) Create a mutable rate metric
MutableRate	newRate(java.lang.String name, java.lang.String desc, boolean extended) Create a mutable rate metric (for throughput measurement)
MutableRate	newRate(java.lang.String name, java.lang.String desc, boolean extended, boolean returnExisting)
MutableSizeHistogram	newSizeHistogram(java.lang.String name) Create a new histogram with size range counts.
MutableSizeHistogram	newSizeHistogram(java.lang.String name, java.lang.String desc) Create a new histogram with size range counts.
MutableStat	newStat(java.lang.String name, java.lang.String desc, java.lang.String sampleName, java.lang.String valueName) Create a mutable metric with stats
MutableStat	newStat(java.lang.String name, java.lang.String desc, java.lang.String sampleName, java.lang.String valueName, boolean extended) Create a mutable metric with stats
MutableTimeHistogram	newTimeHistogram(java.lang.String name) Create a new histogram with time range counts.
MutableTimeHistogram	newTimeHistogram(java.lang.String name, java.lang.String desc) Create a new histogram with time range counts.
void	removeHistogramMetrics(java.lang.String baseName)
void	removeMetric(java.lang.String name) Removes metric by name
DynamicMetricsRegistry	setContext(java.lang.String name) Set the metrics context tag
void	snapshot(MetricsRecordBuilder builder, boolean all) Sample all the mutable metrics and put the snapshot in the builder
DynamicMetricsRegistry	tag(MetricsInfo info, java.lang.String value)
DynamicMetricsRegistry	tag(MetricsInfo info, java.lang.String value, boolean override) Add a tag to the metrics
DynamicMetricsRegistry	tag(java.lang.String name, java.lang.String description, java.lang.String value) Add a tag to the metrics
DynamicMetricsRegistry	tag(java.lang.String name, java.lang.String description, java.lang.String value, boolean override) Add a tag to the metrics
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicMetricsRegistry

public DynamicMetricsRegistry(java.lang.String name)

Construct the registry with a record name

Parameters:

name - of the record of the metrics

DynamicMetricsRegistry

public DynamicMetricsRegistry(MetricsInfo info)

Construct the registry with a metadata object

Parameters:

info - the info object for the metrics record/group

Method Detail

info

public MetricsInfo info()

Returns:

the info object of the metrics registry

get

public MutableMetric get(java.lang.String name)

Get a metric by name

Parameters:

name - of the metric

Returns:

the metric object

getTag

public MetricsTag getTag(java.lang.String name)

Get a tag by name

Parameters:

name - of the tag

Returns:

the tag object

newCounter

public MutableFastCounter newCounter(java.lang.String name,
                                     java.lang.String desc,
                                     long iVal)

Create a mutable long integer counter

Parameters:

name - of the metric

desc - metric description

iVal - initial value

Returns:

a new counter object

newCounter

public MutableFastCounter newCounter(MetricsInfo info,
                                     long iVal)

Create a mutable long integer counter

Parameters:

info - metadata of the metric

iVal - initial value

Returns:

a new counter object

newGauge

public MutableGaugeLong newGauge(java.lang.String name,
                                 java.lang.String desc,
                                 long iVal)

Create a mutable long integer gauge

Parameters:

name - of the metric

desc - metric description

iVal - initial value

Returns:

a new gauge object

newGauge

public MutableGaugeLong newGauge(MetricsInfo info,
                                 long iVal)

Create a mutable long integer gauge

Parameters:

info - metadata of the metric

iVal - initial value

Returns:

a new gauge object

newStat

public MutableStat newStat(java.lang.String name,
                           java.lang.String desc,
                           java.lang.String sampleName,
                           java.lang.String valueName,
                           boolean extended)

Create a mutable metric with stats

Parameters:

name - of the metric

desc - metric description

sampleName - of the metric (e.g., "Ops")

valueName - of the metric (e.g., "Time" or "Latency")

extended - produce extended stat (stdev, min/max etc.) if true.

Returns:

a new mutable stat metric object

newStat

public MutableStat newStat(java.lang.String name,
                           java.lang.String desc,
                           java.lang.String sampleName,
                           java.lang.String valueName)

Create a mutable metric with stats

Parameters:

name - of the metric

desc - metric description

sampleName - of the metric (e.g., "Ops")

valueName - of the metric (e.g., "Time" or "Latency")

Returns:

a new mutable metric object

newRate

public MutableRate newRate(java.lang.String name)

Create a mutable rate metric

Parameters:

name - of the metric

Returns:

a new mutable metric object

newRate

public MutableRate newRate(java.lang.String name,
                           java.lang.String description)

Create a mutable rate metric

Parameters:

name - of the metric

description - of the metric

Returns:

a new mutable rate metric object

newRate

public MutableRate newRate(java.lang.String name,
                           java.lang.String desc,
                           boolean extended)

Create a mutable rate metric (for throughput measurement)

Parameters:

name - of the metric

desc - description

extended - produce extended stat (stdev/min/max etc.) if true

Returns:

a new mutable rate metric object

newRate

@InterfaceAudience.Private
public MutableRate newRate(java.lang.String name,
                                                      java.lang.String desc,
                                                      boolean extended,
                                                      boolean returnExisting)

newHistogram

public MutableHistogram newHistogram(java.lang.String name)

Create a new histogram.

Parameters:

name - Name of the histogram.

Returns:

A new MutableHistogram

newHistogram

public MutableHistogram newHistogram(java.lang.String name,
                                     java.lang.String desc)

Create a new histogram.

Parameters:

name - The name of the histogram

desc - The description of the data in the histogram.

Returns:

A new MutableHistogram

newTimeHistogram

public MutableTimeHistogram newTimeHistogram(java.lang.String name)

Create a new histogram with time range counts.

Parameters:

name - Name of the histogram.

Returns:

A new MutableTimeHistogram

newTimeHistogram

public MutableTimeHistogram newTimeHistogram(java.lang.String name,
                                             java.lang.String desc)

Create a new histogram with time range counts.

Parameters:

name - The name of the histogram

desc - The description of the data in the histogram.

Returns:

A new MutableTimeHistogram

newSizeHistogram

public MutableSizeHistogram newSizeHistogram(java.lang.String name)

Create a new histogram with size range counts.

Parameters:

name - Name of the histogram.

Returns:

A new MutableSizeHistogram

newSizeHistogram

public MutableSizeHistogram newSizeHistogram(java.lang.String name,
                                             java.lang.String desc)

Create a new histogram with size range counts.

Parameters:

name - The name of the histogram

desc - The description of the data in the histogram.

Returns:

A new MutableSizeHistogram

setContext

public DynamicMetricsRegistry setContext(java.lang.String name)

Set the metrics context tag

Parameters:

name - of the context

Returns:

the registry itself as a convenience

tag

public DynamicMetricsRegistry tag(java.lang.String name,
                                  java.lang.String description,
                                  java.lang.String value)

Add a tag to the metrics

Parameters:

name - of the tag

description - of the tag

value - of the tag

Returns:

the registry (for keep adding tags)

tag

public DynamicMetricsRegistry tag(java.lang.String name,
                                  java.lang.String description,
                                  java.lang.String value,
                                  boolean override)

Add a tag to the metrics

Parameters:

name - of the tag

description - of the tag

value - of the tag

override - existing tag if true

Returns:

the registry (for keep adding tags)

tag

public DynamicMetricsRegistry tag(MetricsInfo info,
                                  java.lang.String value,
                                  boolean override)

Add a tag to the metrics

Parameters:

info - metadata of the tag

value - of the tag

override - existing tag if true

Returns:

the registry (for keep adding tags etc.)

tag

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

snapshot

public void snapshot(MetricsRecordBuilder builder,
                     boolean all)

Sample all the mutable metrics and put the snapshot in the builder

Parameters:

builder - to contain the metrics snapshot

all - get all the metrics even if the values are not changed.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

removeMetric

public void removeMetric(java.lang.String name)

Removes metric by name

Parameters:

name - name of the metric to remove

removeHistogramMetrics

public void removeHistogramMetrics(java.lang.String baseName)

getGauge

public MutableGaugeLong getGauge(java.lang.String gaugeName,
                                 long potentialStartingValue)

Get a MetricMutableGaugeLong from the storage. If it is not there atomically put it.

Parameters:

gaugeName - name of the gauge to create or get.

potentialStartingValue - value of the new gauge if we have to create it.

getCounter

public MutableFastCounter getCounter(java.lang.String counterName,
                                     long potentialStartingValue)

Get a MetricMutableCounterLong from the storage. If it is not there atomically put it.

Parameters:

counterName - Name of the counter to get

potentialStartingValue - starting value if we have to create a new counter

getHistogram

public MutableHistogram getHistogram(java.lang.String histoName)

clearMetrics

public void clearMetrics()