--- title: "Apache HBase integration | Grafana Cloud documentation" description: "Learn about Apache HBase Grafana Cloud integration." --- > For a curated documentation index, see [llms.txt](/llms.txt). For the complete documentation index, see [llms-full.txt](/llms-full.txt). # Apache HBase integration for Grafana Cloud Apache HBase is an open-source non-relational distributed database modeled after Google’s Bigtable and written in Java. It is developed as part of Apache Software Foundation’s Apache Hadoop project and runs on top of HDFS or Alluxio, providing Bigtable-like capabilities for Hadoop. This integration supports Apache HBase versions 3.0.0+ This integration includes 5 useful alerts and 3 pre-built dashboards to help monitor and visualize Apache HBase metrics and logs. ## Before you begin Apache HBase requires a JDK, Apache Zookeeper, and one of Hadoop or Alluxio. Ensure that each of these is installed and configured. Refer to [this documentation](https://hbase.apache.org/book.html#basic.prerequisites) for prerequisites and compatible versions for Apache HBase. Apache HBase exposes a [Prometheus metrics endpoint](https://hbase.apache.org/book.html#enabling.metrics.servlets) that is enabled by default. ## Install Apache HBase integration for Grafana Cloud 1. In your Grafana Cloud stack, click **Connections** in the left-hand menu. 2. Find **Apache HBase** and click its tile to open the integration. 3. Review the prerequisites in the **Configuration Details** tab and set up Grafana Alloy to send Apache HBase metrics and logs to your Grafana Cloud instance. 4. Click **Install** to add this integration’s pre-built dashboards and alerts to your Grafana Cloud instance, and you can start monitoring your Apache HBase setup. ## Configuration snippets for Grafana Alloy ### Advanced mode The following snippets provide examples to guide you through the configuration process. To instruct Grafana Alloy to scrape your Apache HBase instances, **manually** copy and append the snippets to your alloy configuration file, then follow subsequent instructions. ### Advanced metrics snippets Alloy ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy ```alloy prometheus.scrape "metrics_integrations_integrations_apache_hbase" { targets = [{ __address__ = "localhost:", hbase_cluster = "", instance = constants.hostname, }] forward_to = [prometheus.remote_write.metrics_service.receiver] job_name = "integrations/apache-hbase" metrics_path = "/prometheus" } ``` To monitor your Apache HBase instance, you must use a [discovery.relabel](/docs/alloy/latest/reference/components/discovery.relabel/) component to discover your Apache HBase Prometheus endpoint and apply appropriate labels, followed by a [prometheus.scrape](/docs/alloy/latest/reference/components/prometheus.scrape) component to scrape it. Configure the following properties within each `discovery.relabel` component: - `__address__`: The address to your Apache HBase Prometheus metrics endpoint. - `instance` label: `constants.hostname` sets the `instance` label to your Grafana Alloy server hostname. If that is not suitable, change it to a value uniquely identifies this Apache HBase instance. Make sure this label value is the same for all telemetry data collected for this instance. - `hbase_cluster` label must be set to a value that identifies your Apache HBase cluster. If you have multiple Apache HBase servers to scrape, configure one `discovery.relabel` for each and scrape them by including each under `targets` within the `prometheus.scrape` component. ### Advanced logs snippets #### linux Alloy ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy ```alloy local.file_match "logs_integrations_integrations_apache_hbase" { path_targets = [{ __address__ = "localhost", __path__ = "/logs/*.log", hbase_cluster = "", instance = constants.hostname, job = "integrations/apache-hbase", }] } loki.process "logs_integrations_integrations_apache_hbase" { forward_to = [loki.write.grafana_cloud_loki.receiver] stage.multiline { firstline = "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2},\\d{3}" max_lines = 0 max_wait_time = "3s" } stage.regex { expression = "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2},\\d{3} (?P\\w+) \\[(.*)\\] (?P\\w+.\\w+): (?P(?s:.*))$" } stage.labels { values = { level = null, logger = null, } } } loki.source.file "logs_integrations_integrations_apache_hbase" { targets = local.file_match.logs_integrations_integrations_apache_hbase.targets forward_to = [loki.process.logs_integrations_integrations_apache_hbase.receiver] } ``` To monitor your Apache HBase instance logs, you will use a combination of the following components: - [local.file\_match](/docs/alloy/latest/reference/components/local.file_match) defines where to find the log file to be scraped. Change the following properties according to your environment: - `__address__`: The Apache HBase instance address - `__path__`: The path to the log file. - `instance` label: `constants.hostname` sets the `instance` label to your Grafana Alloy server hostname. If that is not suitable, change it to a value uniquely identifies this Apache HBase instance. Make sure this label value is the same for all telemetry data collected for this instance. - `hbase_cluster` label must be set to a value that identifies your Apache HBase cluster. - [loki.process](/docs/alloy/latest/reference/components/loki.process) defines how to process logs before sending it to Loki. - [loki.source.file](/docs/alloy/latest/reference/components/loki.source.file) sends logs to Loki. ## Dashboards The Apache HBase integration installs the following dashboards in your Grafana Cloud instance to help monitor your system. - Apache HBase RegionServer overview - Apache HBase cluster overview - Apache HBase logs overview **Apache HBase cluster overview (status)** **Apache HBase RegionServer overview (performance)** **Apache HBase logs overview** ## Alerts The Apache HBase integration includes the following useful alerts: Expand table | Alert | Description | |-----------------------------|--------------------------------------------------------------------------------------| | HBaseHighHeapMemUsage | Warning: There is a limited amount of heap memory available to the JVM. | | HBaseDeadRegionServer | Warning: One or more RegionServer(s) has become unresponsive. | | HBaseOldRegionsInTransition | Warning: RegionServers are in transition for longer than expected. | | HBaseHighMasterAuthFailRate | Warning: A high percentage of authentication attempts to the master are failing. | | HBaseHighRSAuthFailRate | Warning: A high percentage of authentication attempts to a RegionServer are failing. | ## Metrics The most important metrics provided by the Apache HBase integration, which are used on the pre-built dashboards and Prometheus alerts, are as follows: - assignment\_manager\_rit\_count - assignment\_manager\_rit\_count\_over\_threshold - assignment\_manager\_rit\_oldest\_age - jvm\_metrics\_mem\_heap\_committed\_m - jvm\_metrics\_mem\_heap\_used\_m - master\_authentication\_failures - master\_authentication\_successes - master\_num\_calls\_in\_general\_queue - master\_num\_calls\_in\_priority\_queue - master\_num\_calls\_in\_read\_queue - master\_num\_calls\_in\_replication\_queue - master\_num\_calls\_in\_scan\_queue - master\_num\_calls\_in\_write\_queue - master\_num\_open\_connections - master\_queue\_size - region\_server\_authentication\_failures - region\_server\_authentication\_successes - region\_server\_num\_calls\_in\_general\_queue - region\_server\_num\_calls\_in\_priority\_queue - region\_server\_num\_calls\_in\_read\_queue - region\_server\_num\_calls\_in\_replication\_queue - region\_server\_num\_calls\_in\_scan\_queue - region\_server\_num\_calls\_in\_write\_queue - region\_server\_num\_open\_connections - server\_block\_cache\_express\_hit\_percent - server\_cp\_request\_count - server\_filtered\_read\_request\_count - server\_num\_dead\_region\_servers - server\_num\_reference\_files - server\_num\_region\_servers - server\_read\_request\_count - server\_region\_count - server\_rpc\_full\_scan\_request\_count - server\_rpc\_get\_request\_count - server\_rpc\_multi\_request\_count - server\_rpc\_mutate\_request\_count - server\_rpc\_scan\_request\_count - server\_slow\_append\_count - server\_slow\_delete\_count - server\_slow\_get\_count - server\_slow\_increment\_count - server\_slow\_put\_count - server\_store\_file\_count - server\_store\_file\_size - server\_total\_request\_count - server\_write\_request\_count - up ## Changelog md ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy ```md # 1.0.1 - November 2024 - Update status panel check queries # 1.0.0 - November 2023 - Initial release ``` ## Cost By connecting your Apache HBase instance to Grafana Cloud, you might incur charges. To view information on the number of active series that your Grafana Cloud account uses for metrics included in each Cloud tier, see [Active series and dpm usage](/docs/grafana-cloud/fundamentals/active-series-and-dpm/) and [Cloud tier pricing](/products/cloud/pricing/).