HBase plugin

This plugin collects metrics from a HBase Region Server.


Meter 4.2 or later must be installed.

The HBase plugin supports the following Operating Systems.

Smart OS(tick)
OS X(tick)

Plugin Setup

Enable JMX Metrics

Click here to view the procedure to enable JMX metrics in HBase.

Set JAVA_HOME Environment Variable

Ensure that the JAVA_HOME environment variable is by running the following on a Linux/UNIX platform:

    $ echo $JAVA_HOME 

Or on Windows from a cmd shell: bash % set JAVA_HOME 2. If JAVA_HOME is not set then configure appropriately for the target operating system and re-verify.

To install the plugin

  1. From the top right of the screen, perform one of the following actions:
    • Click Settings > Data Collection, select the TrueSight meter, and select the Sources tab.

    • Click Settings > Configure Sources.
  2. Use the search box or scroll through the page to find the source system which has the TrueSight meter on which you want to install the plugin.
  3. Click the name of the source to view source details.
  4. Select the Plugins tab.
  5. Use the search box or scroll through the page to find the plugin you want to install.
  6. Click + Install to start the installation.

    Refer to the following sections for the configuration details required to collect data and view the list of plugin metrics.

Configuration details

Field NameDescription
HostnameThe hostname or IP address of the JMX Region server
PortThe port of the JMX Region server
UsernameIf the JMX endpoint is password protected, what username should graphdat use when calling it.
PasswordIf the JMX endpoint is password protected, what password should graphdat use when calling it.
Poll SecondsHow often should the plugin poll the JMX endpoint
SourceThe Source to display in the legend for the HBase data. It will default to the hostname of the server

Advanced configuration

To customize this plugin, see HBase plugin on GitHub.

Plugin metrics

Metric NameDescription
HBase Cache Read RatioThe cache-hit ratio for reads configured to look in the cache
HBase Compaction TargetsThe number of Stores in the Region Server that have been targeted for compaction
HBase Flush QueueThe number of enqueued regions in the MemStore awaiting flush
HBase Local Block RatioThe percentage of HDFS blocks that are local to this Region Server
HBase Memstore SizeThe sum of all the memstore sizes in this Region Server
HBase Regions in a Region ServerThe number of regions served by the Region Server.
HBase ReadsThe number of read requests for this Region Server.
HBase Slow WritesThe number of slow HLog append writes for this Region Server, where slow is > 1 second.
HBase MemoryThe amount of memory used by the RegionServer.
HBase WritesThe number of write requests for this Region Server.
Was this page helpful? Yes No Submitting... Thank you