|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.hadoop.metrics2.lib.DynamicMetricsRegistry
@InterfaceAudience.Private public class DynamicMetricsRegistry
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 | |
---|---|
DynamicMetricsRegistry(org.apache.hadoop.metrics2.MetricsInfo info)
Construct the registry with a metadata object |
|
DynamicMetricsRegistry(String name)
Construct the registry with a record name |
Method Summary | |
---|---|
void |
add(String name,
long value)
Add sample to a stat metric by name. |
void |
clearMetrics()
|
org.apache.hadoop.metrics2.lib.MutableMetric |
get(String name)
Get a metric by name |
MutableHistogram |
getHistogram(String histoName)
|
org.apache.hadoop.metrics2.lib.MutableCounterLong |
getLongCounter(String counterName,
long potentialStartingValue)
Get a MetricMutableCounterLong from the storage. |
org.apache.hadoop.metrics2.lib.MutableGaugeLong |
getLongGauge(String gaugeName,
long potentialStartingValue)
Get a MetricMutableGaugeLong from the storage. |
MetricMutableQuantiles |
getQuantile(String histoName)
|
org.apache.hadoop.metrics2.MetricsTag |
getTag(String name)
Get a tag by name |
org.apache.hadoop.metrics2.MetricsInfo |
info()
|
org.apache.hadoop.metrics2.lib.MutableCounterInt |
newCounter(org.apache.hadoop.metrics2.MetricsInfo info,
int iVal)
Create a mutable integer counter |
org.apache.hadoop.metrics2.lib.MutableCounterLong |
newCounter(org.apache.hadoop.metrics2.MetricsInfo info,
long iVal)
Create a mutable long integer counter |
org.apache.hadoop.metrics2.lib.MutableCounterInt |
newCounter(String name,
String desc,
int iVal)
Create a mutable integer counter |
org.apache.hadoop.metrics2.lib.MutableCounterLong |
newCounter(String name,
String desc,
long iVal)
Create a mutable long integer counter |
org.apache.hadoop.metrics2.lib.MutableGaugeInt |
newGauge(org.apache.hadoop.metrics2.MetricsInfo info,
int iVal)
Create a mutable integer gauge |
org.apache.hadoop.metrics2.lib.MutableGaugeLong |
newGauge(org.apache.hadoop.metrics2.MetricsInfo info,
long iVal)
Create a mutable long integer gauge |
org.apache.hadoop.metrics2.lib.MutableGaugeInt |
newGauge(String name,
String desc,
int iVal)
Create a mutable integer gauge |
org.apache.hadoop.metrics2.lib.MutableGaugeLong |
newGauge(String name,
String desc,
long iVal)
Create a mutable long integer gauge |
MutableHistogram |
newHistogram(String name)
Create a new histogram. |
MutableHistogram |
newHistogram(String name,
String desc)
Create a new histogram. |
MetricMutableQuantiles |
newQuantile(String name)
Create a new MutableQuantile(A more accurate histogram). |
MetricMutableQuantiles |
newQuantile(String name,
String desc)
|
org.apache.hadoop.metrics2.lib.MutableRate |
newRate(String name)
Create a mutable rate metric |
org.apache.hadoop.metrics2.lib.MutableRate |
newRate(String name,
String description)
Create a mutable rate metric |
org.apache.hadoop.metrics2.lib.MutableRate |
newRate(String name,
String desc,
boolean extended)
Create a mutable rate metric (for throughput measurement) |
org.apache.hadoop.metrics2.lib.MutableRate |
newRate(String name,
String desc,
boolean extended,
boolean returnExisting)
|
org.apache.hadoop.metrics2.lib.MutableStat |
newStat(String name,
String desc,
String sampleName,
String valueName)
Create a mutable metric with stats |
org.apache.hadoop.metrics2.lib.MutableStat |
newStat(String name,
String desc,
String sampleName,
String valueName,
boolean extended)
Create a mutable metric with stats |
void |
removeMetric(String name)
Removes metric by name |
DynamicMetricsRegistry |
setContext(String name)
Set the metrics context tag |
void |
snapshot(org.apache.hadoop.metrics2.MetricsRecordBuilder builder,
boolean all)
Sample all the mutable metrics and put the snapshot in the builder |
DynamicMetricsRegistry |
tag(org.apache.hadoop.metrics2.MetricsInfo info,
String value)
|
DynamicMetricsRegistry |
tag(org.apache.hadoop.metrics2.MetricsInfo info,
String value,
boolean override)
Add a tag to the metrics |
DynamicMetricsRegistry |
tag(String name,
String description,
String value)
Add a tag to the metrics |
DynamicMetricsRegistry |
tag(String name,
String description,
String value,
boolean override)
Add a tag to the metrics |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DynamicMetricsRegistry(String name)
name
- of the record of the metricspublic DynamicMetricsRegistry(org.apache.hadoop.metrics2.MetricsInfo info)
info
- the info object for the metrics record/groupMethod Detail |
---|
public org.apache.hadoop.metrics2.MetricsInfo info()
public org.apache.hadoop.metrics2.lib.MutableMetric get(String name)
name
- of the metric
public org.apache.hadoop.metrics2.MetricsTag getTag(String name)
name
- of the tag
public org.apache.hadoop.metrics2.lib.MutableCounterInt newCounter(String name, String desc, int iVal)
name
- of the metricdesc
- metric descriptioniVal
- initial value
public org.apache.hadoop.metrics2.lib.MutableCounterInt newCounter(org.apache.hadoop.metrics2.MetricsInfo info, int iVal)
info
- metadata of the metriciVal
- initial value
public org.apache.hadoop.metrics2.lib.MutableCounterLong newCounter(String name, String desc, long iVal)
name
- of the metricdesc
- metric descriptioniVal
- initial value
public org.apache.hadoop.metrics2.lib.MutableCounterLong newCounter(org.apache.hadoop.metrics2.MetricsInfo info, long iVal)
info
- metadata of the metriciVal
- initial value
public org.apache.hadoop.metrics2.lib.MutableGaugeInt newGauge(String name, String desc, int iVal)
name
- of the metricdesc
- metric descriptioniVal
- initial value
public org.apache.hadoop.metrics2.lib.MutableGaugeInt newGauge(org.apache.hadoop.metrics2.MetricsInfo info, int iVal)
info
- metadata of the metriciVal
- initial value
public org.apache.hadoop.metrics2.lib.MutableGaugeLong newGauge(String name, String desc, long iVal)
name
- of the metricdesc
- metric descriptioniVal
- initial value
public org.apache.hadoop.metrics2.lib.MutableGaugeLong newGauge(org.apache.hadoop.metrics2.MetricsInfo info, long iVal)
info
- metadata of the metriciVal
- initial value
public org.apache.hadoop.metrics2.lib.MutableStat newStat(String name, String desc, String sampleName, String valueName, boolean extended)
name
- of the metricdesc
- metric descriptionsampleName
- 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.
public org.apache.hadoop.metrics2.lib.MutableStat newStat(String name, String desc, String sampleName, String valueName)
name
- of the metricdesc
- metric descriptionsampleName
- of the metric (e.g., "Ops")valueName
- of the metric (e.g., "Time" or "Latency")
public org.apache.hadoop.metrics2.lib.MutableRate newRate(String name)
name
- of the metric
public org.apache.hadoop.metrics2.lib.MutableRate newRate(String name, String description)
name
- of the metricdescription
- of the metric
public org.apache.hadoop.metrics2.lib.MutableRate newRate(String name, String desc, boolean extended)
name
- of the metricdesc
- descriptionextended
- produce extended stat (stdev/min/max etc.) if true
@InterfaceAudience.Private public org.apache.hadoop.metrics2.lib.MutableRate newRate(String name, String desc, boolean extended, boolean returnExisting)
public MutableHistogram newHistogram(String name)
name
- Name of the histogram.
public MutableHistogram newHistogram(String name, String desc)
name
- The name of the histogramdesc
- The description of the data in the histogram.
public MetricMutableQuantiles newQuantile(String name)
name
- The name of the histogram
public MetricMutableQuantiles newQuantile(String name, String desc)
public void add(String name, long value)
name
- of the metricvalue
- of the snapshot to addpublic DynamicMetricsRegistry setContext(String name)
name
- of the context
public DynamicMetricsRegistry tag(String name, String description, String value)
name
- of the tagdescription
- of the tagvalue
- of the tag
public DynamicMetricsRegistry tag(String name, String description, String value, boolean override)
name
- of the tagdescription
- of the tagvalue
- of the tagoverride
- existing tag if true
public DynamicMetricsRegistry tag(org.apache.hadoop.metrics2.MetricsInfo info, String value, boolean override)
info
- metadata of the tagvalue
- of the tagoverride
- existing tag if true
public DynamicMetricsRegistry tag(org.apache.hadoop.metrics2.MetricsInfo info, String value)
public void snapshot(org.apache.hadoop.metrics2.MetricsRecordBuilder builder, boolean all)
builder
- to contain the metrics snapshotall
- get all the metrics even if the values are not changed.public String toString()
toString
in class Object
public void removeMetric(String name)
name
- name of the metric to removepublic org.apache.hadoop.metrics2.lib.MutableGaugeLong getLongGauge(String gaugeName, long potentialStartingValue)
gaugeName
- name of the gauge to create or get.potentialStartingValue
- value of the new gauge if we have to create it.public org.apache.hadoop.metrics2.lib.MutableCounterLong getLongCounter(String counterName, long potentialStartingValue)
counterName
- Name of the counter to getpotentialStartingValue
- starting value if we have to create a new counterpublic MutableHistogram getHistogram(String histoName)
public MetricMutableQuantiles getQuantile(String histoName)
public void clearMetrics()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |