org.apache.hadoop.hbase.metrics.impl

Class MetricRegistryImpl

java.lang.Object

org.apache.hadoop.hbase.metrics.impl.MetricRegistryImpl

All Implemented Interfaces:

Metric, MetricRegistry, MetricSet

@InterfaceAudience.Private
public class MetricRegistryImpl
extends Object
implements MetricRegistry

Custom implementation of MetricRegistry.

Constructor Summary

Constructors

Constructor and Description
MetricRegistryImpl(MetricRegistryInfo info)

Method Summary

Modifier and Type	Method and Description
Counter	counter(String name) Get or construct a Counter used to track a mutable number.
protected Counter	createCounter()
protected Histogram	createHistogram()
protected Meter	createMeter()
protected Timer	createTimer()
Optional<Metric>	get(String name) Returns previously registered metric with the name if any.
MetricRegistryInfo	getMetricRegistryInfo() Return the MetricRegistryInfo object for this registry.
Map<String,Metric>	getMetrics() A map of metric names to metrics.
Histogram	histogram(String name) Get or construct a Histogram used to measure a distribution of values.
Meter	meter(String name) Get or construct a Meter used to measure durations and report distributions (a combination of a Timer and a Histogram.
<T> Gauge<T>	register(String name, Gauge<T> gauge) Register a Gauge.
Metric	register(String name, Metric metric) Registers the Metric with the given name if there does not exist one with the same name.
void	registerAll(MetricSet metricSet) Registers the Metrics in the given MetricSet.
boolean	remove(String name) Removes the metric with the given name.
Timer	timer(String name) Get or construct a Timer used to measure durations and report rates.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricRegistryImpl

public MetricRegistryImpl(MetricRegistryInfo info)

Method Detail

timer

public Timer timer(String name)

Description copied from interface: MetricRegistry

Get or construct a Timer used to measure durations and report rates.

Specified by:

timer in interface MetricRegistry

Parameters:

name - the name of the timer.

Returns:

An instance of Timer.

createTimer

protected Timer createTimer()

histogram

public Histogram histogram(String name)

Description copied from interface: MetricRegistry

Get or construct a Histogram used to measure a distribution of values.

Specified by:

histogram in interface MetricRegistry

Parameters:

name - The name of the Histogram.

Returns:

An instance of Histogram.

createHistogram

protected Histogram createHistogram()

meter

public Meter meter(String name)

Description copied from interface: MetricRegistry

Get or construct a Meter used to measure durations and report distributions (a combination of a Timer and a Histogram.

Specified by:

meter in interface MetricRegistry

Parameters:

name - The name of the Meter.

Returns:

An instance of Meter.

createMeter

protected Meter createMeter()

counter

public Counter counter(String name)

Description copied from interface: MetricRegistry

Get or construct a Counter used to track a mutable number.

Specified by:

counter in interface MetricRegistry

Parameters:

name - The name of the Counter

Returns:

An instance of Counter.

createCounter

protected Counter createCounter()

get

public Optional<Metric> get(String name)

Description copied from interface: MetricRegistry

Returns previously registered metric with the name if any.

Specified by:

get in interface MetricRegistry

Parameters:

name - the name of the metric

Returns:

previously registered metric

register

public Metric register(String name,
                       Metric metric)

Description copied from interface: MetricRegistry

Registers the Metric with the given name if there does not exist one with the same name. Returns the newly registered or existing Metric.

Specified by:

register in interface MetricRegistry

Parameters:

name - The name of the Metric.

metric - the metric to register

Returns:

the registered metric, or the existing metrid

register

public <T> Gauge<T> register(String name,
                             Gauge<T> gauge)

Description copied from interface: MetricRegistry

Register a Gauge. The Gauge will be invoked at a period defined by the implementation of MetricRegistry.

Specified by:

register in interface MetricRegistry

Parameters:

name - The name of the Gauge.

gauge - A callback to compute the current value.

Returns:

the registered gauge, or the existing gauge

registerAll

public void registerAll(MetricSet metricSet)

Description copied from interface: MetricRegistry

Registers the Metrics in the given MetricSet.

Specified by:

registerAll in interface MetricRegistry

Parameters:

metricSet - set of metrics to register.

getMetrics

public Map<String,Metric> getMetrics()

Description copied from interface: MetricSet

A map of metric names to metrics.

Specified by:

getMetrics in interface MetricSet

Returns:

the metrics

remove

public boolean remove(String name)

Description copied from interface: MetricRegistry

Removes the metric with the given name.

Specified by:

remove in interface MetricRegistry

Parameters:

name - the name of the metric

Returns:

true if the metric is removed.

getMetricRegistryInfo

public MetricRegistryInfo getMetricRegistryInfo()

Description copied from interface: MetricRegistry

Return the MetricRegistryInfo object for this registry.

Specified by:

getMetricRegistryInfo in interface MetricRegistry

Returns:

MetricRegistryInfo describing the registry.