@InterfaceAudience.Private public class DynamicMetricsRegistry extends java.lang.Object
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
|
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() |
public DynamicMetricsRegistry(java.lang.String name)
name
- of the record of the metricspublic DynamicMetricsRegistry(MetricsInfo info)
info
- the info object for the metrics record/grouppublic MetricsInfo info()
public MutableMetric get(java.lang.String name)
name
- of the metricpublic MetricsTag getTag(java.lang.String name)
name
- of the tagpublic MutableFastCounter newCounter(java.lang.String name, java.lang.String desc, long iVal)
name
- of the metricdesc
- metric descriptioniVal
- initial valuepublic MutableFastCounter newCounter(MetricsInfo info, long iVal)
info
- metadata of the metriciVal
- initial valuepublic MutableGaugeLong newGauge(java.lang.String name, java.lang.String desc, long iVal)
name
- of the metricdesc
- metric descriptioniVal
- initial valuepublic MutableGaugeLong newGauge(MetricsInfo info, long iVal)
info
- metadata of the metriciVal
- initial valuepublic MutableStat newStat(java.lang.String name, java.lang.String desc, java.lang.String sampleName, java.lang.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 MutableStat newStat(java.lang.String name, java.lang.String desc, java.lang.String sampleName, java.lang.String valueName)
name
- of the metricdesc
- metric descriptionsampleName
- of the metric (e.g., "Ops")valueName
- of the metric (e.g., "Time" or "Latency")public MutableRate newRate(java.lang.String name)
name
- of the metricpublic MutableRate newRate(java.lang.String name, java.lang.String description)
name
- of the metricdescription
- of the metricpublic MutableRate newRate(java.lang.String name, java.lang.String desc, boolean extended)
name
- of the metricdesc
- descriptionextended
- produce extended stat (stdev/min/max etc.) if true@InterfaceAudience.Private public MutableRate newRate(java.lang.String name, java.lang.String desc, boolean extended, boolean returnExisting)
public MutableHistogram newHistogram(java.lang.String name)
name
- Name of the histogram.public MutableHistogram newHistogram(java.lang.String name, java.lang.String desc)
name
- The name of the histogramdesc
- The description of the data in the histogram.public MutableTimeHistogram newTimeHistogram(java.lang.String name)
name
- Name of the histogram.public MutableTimeHistogram newTimeHistogram(java.lang.String name, java.lang.String desc)
name
- The name of the histogramdesc
- The description of the data in the histogram.public MutableSizeHistogram newSizeHistogram(java.lang.String name)
name
- Name of the histogram.public MutableSizeHistogram newSizeHistogram(java.lang.String name, java.lang.String desc)
name
- The name of the histogramdesc
- The description of the data in the histogram.public DynamicMetricsRegistry setContext(java.lang.String name)
name
- of the contextpublic DynamicMetricsRegistry tag(java.lang.String name, java.lang.String description, java.lang.String value)
name
- of the tagdescription
- of the tagvalue
- of the tagpublic DynamicMetricsRegistry tag(java.lang.String name, java.lang.String description, java.lang.String value, boolean override)
name
- of the tagdescription
- of the tagvalue
- of the tagoverride
- existing tag if truepublic DynamicMetricsRegistry tag(MetricsInfo info, java.lang.String value, boolean override)
info
- metadata of the tagvalue
- of the tagoverride
- existing tag if truepublic DynamicMetricsRegistry tag(MetricsInfo info, java.lang.String value)
public void snapshot(MetricsRecordBuilder builder, boolean all)
builder
- to contain the metrics snapshotall
- get all the metrics even if the values are not changed.public java.lang.String toString()
toString
in class java.lang.Object
public void removeMetric(java.lang.String name)
name
- name of the metric to removepublic void removeHistogramMetrics(java.lang.String baseName)
public MutableGaugeLong getGauge(java.lang.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 MutableFastCounter getCounter(java.lang.String counterName, long potentialStartingValue)
counterName
- Name of the counter to getpotentialStartingValue
- starting value if we have to create a new counterpublic MutableHistogram getHistogram(java.lang.String histoName)
public void clearMetrics()