HBase plugin

HBase is an open source, non-relational, distributed database. For more information visit http://hbase.apache.org/.


Even if the HBase plugin is not configured, Monitoring discovers HBase services running in your Google Cloud project by:

  • Searching instance names for hbase
  • Checking for ports opened to 60201 via firewall rules

The services discovered are displayed on the HBase Services page in the Resources menu. After you install the monitoring agent and configure the HBase plugin on your instances, Monitoring populates the HBase Services page with inventory and metrics.

Configuring Monitoring to monitor HBase

After you install the monitoring agent, use the following instructions to configure the HBase plugin on your instances.


The HBase plugin requires version 5.5.0-257 or later of the monitoring agent. To update the agent, see Upgrading the agent.

Enabling the HBase monitoring plugin

HBase is monitored via JMX. Monitoring has separate configurations for monitoring HBase versions 0.98 and above, and versions 0.95 and below. It also supports monitoring HBase 0.98 and above running in a standalone configuration (all services on the same port).

On your VM instance, download the appropriate configuration file from the GitHub configuration repository based on your HBase version and place it in the directory /etc/stackdriver/collectd.d/:


Download hbase-098.conf into /etc/stackdriver/collectd.d/:

(cd /etc/stackdriver/collectd.d/ && sudo curl -O https://raw.githubusercontent.com/Stackdriver/stackdriver-agent-service-configs/master/etc/collectd.d/hbase-098.conf)

0.98+ standalone

Download hbase-098-standalone.conf into /etc/stackdriver/collectd.d/:

(cd /etc/stackdriver/collectd.d/ && sudo curl -O https://raw.githubusercontent.com/Stackdriver/stackdriver-agent-service-configs/master/etc/collectd.d/hbase-098-standalone.conf)

<= 0.95

Download hbase-095.conf into /etc/stackdriver/collectd.d/:

(cd /etc/stackdriver/collectd.d/ && sudo curl -O https://raw.githubusercontent.com/Stackdriver/stackdriver-agent-service-configs/master/etc/collectd.d/hbase-095.conf)

If you use Thrift, see Enabling Thrift monitoring below.

The downloaded plugin configuration file assumes that your HBase master is configured to accept JMX connections on port 10101 and your HBase regionserver in non-standalone mode is configured to accept JMX connections on port 10102. If you have configured HBase with different JMX ports, as root, edit the file and follow the instructions to change the JMX port settings.

After adding the configuration files, restart the monitoring agent by running the following command:

sudo service stackdriver-agent restart

For more information on the collectd GenericJMX plugin used to monitor HBase, see Plugin:GenericJMX.

Enabling Thrift monitoring

Thrift is a cross-language services framework commonly used with HBase.

If you wish to monitor Thrift metrics, download hbase-thrift.conf into /etc/stackdriver/collectd.d/ in addition to the HBase plugin configuration:

(cd /etc/stackdriver/collectd.d/ && sudo curl -O https://raw.githubusercontent.com/Stackdriver/stackdriver-agent-service-configs/master/etc/collectd.d/hbase-thrift.conf)

What is monitored

The full lists of metrics the HBase plugin monitors are at Agent metrics: hbase and Agent metrics: jvm.