org.apache.hadoop.hbase.metrics

Class MetricRegistryInfo

java.lang.Object

org.apache.hadoop.hbase.metrics.MetricRegistryInfo

@InterfaceAudience.Private
public class MetricRegistryInfo
extends Object

HBase Metrics are grouped in different MetricRegistry'ies. All metrics that correspond to a subcomponent (like RPC, GC, WAL) are managed in a single MetricRegistry. This class holds the name and description and JMX related context names for such group of metrics.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	existingSource
protected String	metricsContext
protected String	metricsDescription
protected String	metricsJmxContext
protected String	metricsName

Constructor Summary

Constructors

Constructor and Description
MetricRegistryInfo(String metricsName, String metricsDescription, String metricsJmxContext, String metricsContext, boolean existingSource)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getMetricsContext() Get the metrics context.
String	getMetricsDescription() Get the description of what this source exposes.
String	getMetricsJmxContext() Get the name of the context in JMX that this source will be exposed through.
String	getMetricsName() Get the name of the metrics that are being exported by this source.
int	hashCode()
boolean	isExistingSource() Returns whether or not this MetricRegistry is for an existing BaseSource

Methods inherited from class java.lang.Object

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

Field Detail

metricsName

protected final String metricsName

metricsDescription

protected final String metricsDescription

metricsContext

protected final String metricsContext

metricsJmxContext

protected final String metricsJmxContext

existingSource

protected final boolean existingSource

Constructor Detail

MetricRegistryInfo

public MetricRegistryInfo(String metricsName,
                          String metricsDescription,
                          String metricsJmxContext,
                          String metricsContext,
                          boolean existingSource)

Method Detail

getMetricsContext

public String getMetricsContext()

Get the metrics context. For hadoop metrics2 system this is usually an all lowercased string. eg. regionserver, master, thriftserver

Returns:

The string context used to register this source to hadoop's metrics2 system.

getMetricsDescription

public String getMetricsDescription()

Get the description of what this source exposes.

getMetricsJmxContext

public String getMetricsJmxContext()

Get the name of the context in JMX that this source will be exposed through. This is in ObjectName format. With the default context being Hadoop -> HBase

getMetricsName

public String getMetricsName()

Get the name of the metrics that are being exported by this source. Eg. IPC, GC, WAL

isExistingSource

public boolean isExistingSource()

Returns whether or not this MetricRegistry is for an existing BaseSource

Returns:

true if this MetricRegistry is for an existing BaseSource.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object