The Apache HBase integration collects cluster metrics from master and region
servers. Region server metrics are related to storage as well as request and
latency. The integration also collects master and region server logs and
parses them into a JSON payload. The result includes fields for source, level,
and message.
For more information about HBase, see hbase.apache.org/.
Prerequisites
To collect and ingest HBase logs and metrics, you must install Ops Agent version 2.11.0 or higher.
This receiver supports Apache HBase versions 1.7.x, 2.3.x, and 2.4.x.
Configure your HBase instance
To expose a JMX endpoint, you must set the com.sun.management.jmxremote.port
system property when starting the JVM. We also recommend setting the
com.sun.management.jmxremote.rmi.port system property to the same port. To
expose a JMX endpoint remotely, you must also set the java.rmi.server.hostname
system property.
By default, these properties are set in a HBase deployment's hbase-env.sh
file.
To set system properties by using command-line arguments, prepend the property
name with -D when starting the JVM. For example, to set
com.sun.management.jmxremote.port to port 10101, specify the following when
starting the JVM:
-Dcom.sun.management.jmxremote.port=10101
Configure the Ops Agent for HBase
Following the guide for Configuring the Ops Agent, add the required elements to collect logs and metrics from your HBase instances, and restart the agent.
Example configuration
The following command creates the configuration file to collect and ingest logs and metrics for HBase and restarts the Ops Agent on Linux.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
logging:
receivers:
hbase_system:
type: hbase_system
service:
pipelines:
hbase:
receivers:
- hbase_system
metrics:
receivers:
hbase:
type: hbase
service:
pipelines:
hbase:
receivers:
- hbase
EOF
sudo service google-cloud-ops-agent restart
Configure logs collection
To ingest logs from HBase, you must create receivers for the logs HBase produces and then create a pipeline for the new receivers.
To configure a receiver for your hbase_system logs, specify the following fields:
| Field | Default | Description |
|---|---|---|
type |
This value must be hbase_system. |
|
include_paths |
[/opt/hbase/logs/hbase-*-regionserver-*.log, /opt/hbase/logs/hbase-*-master-*.log] |
A list of filesystem paths to read by tailing each file. A wild card (*) can be used in the paths; for example, /var/log/hbase*/*.log. |
collect_jvm_metrics |
true |
Configures the receiver to also collect the supported JVM metrics. |
exclude_paths |
[] |
A list of filesystem path patterns to exclude from the set matched by include_paths. |
wildcard_refresh_interval |
60s |
The interval at which wildcard file paths in include_paths are refreshed. Specified as a time interval parsable by time.ParseDuration. Must be a multiple of 1s. |
What is logged
The logName of the hbase_system logs are derived from the receiver IDs
specified in the configuration. Detailed fields inside the
LogEntry
are as follows.
| Field | Type | Description |
|---|---|---|
timestamp |
string (Timestamp) |
Time the request was received. |
jsonPayload.module |
string | Module of hbase where the log originated. |
jsonPayload.source |
string | Source of where the log originated. |
jsonPayload.message |
string | Log message, including detailed stack trace where provided. |
severity |
string (LogSeverity) |
Log entry level (translated). |
Configure metrics collection
To collect metrics from HBase, you must create a receiver for HBase metrics and then create a pipeline for the new receiver. To configure a receiver for your HBase metrics, specify the following fields:
| Field | Default | Description |
|---|---|---|
type |
This value must be hbase. |
|
endpoint |
localhost:10101 |
The JMX Service URL or host and port used to construct the Service URL. Must be in the form of service:jmx:<protocol>:<sap> or host:port. Values in host:port form will be used to create a Service URL of service:jmx:rmi:///jndi/rmi://<host>:<port>/jmxrmi. |
collect_jvm_metrics |
true | Configures the receiver to also collect the supported JVM metrics. |
username |
The configured username if JMX is configured to require authentication. | |
password |
The configured password if JMX is configured to require authentication. | |
collection_interval |
60s |
A time.Duration value, such as 30s or 5m. |
What is monitored
The following table provides the list of metrics that the Ops Agent collects from the HBase instance.
| Metric type | |
|---|---|
| Kind, Type Monitored resources |
Labels |
workload.googleapis.com/hbase.master.region_server.count
|
|
GAUGE, INT64gce_instance |
state
|
workload.googleapis.com/hbase.master.regions_in_transition.count
|
|
GAUGE, INT64gce_instance |
|
workload.googleapis.com/hbase.master.regions_in_transition.oldest_age
|
|
GAUGE, INT64gce_instance |
|
workload.googleapis.com/hbase.master.regions_in_transition.over_threshold
|
|
GAUGE, INT64gce_instance |
|
workload.googleapis.com/hbase.region_server.active_handler.count
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.authentication.count
|
|
GAUGE, INT64gce_instance |
state
region_server
|
workload.googleapis.com/hbase.region_server.block_cache.operation.count
|
|
GAUGE, INT64gce_instance |
state
region_server
|
workload.googleapis.com/hbase.region_server.blocked_update.time
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.disk.store_file.count
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.disk.store_file.size
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.files.local
|
|
GAUGE, DOUBLEgce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.gc.old_gen.time
|
|
CUMULATIVE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.gc.time
|
|
CUMULATIVE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.gc.young_gen.time
|
|
CUMULATIVE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.open_connection.count
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.append.latency.max
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.append.latency.mean
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.append.latency.median
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.append.latency.min
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.append.latency.p99
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.delete.latency.max
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.delete.latency.mean
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.delete.latency.median
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.delete.latency.min
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.delete.latency.p99
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.get.latency.max
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.get.latency.mean
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.get.latency.median
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.get.latency.min
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.get.latency.p99
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.increment.latency.max
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.increment.latency.mean
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.increment.latency.median
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.increment.latency.min
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.increment.latency.p99
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.put.latency.max
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.put.latency.mean
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.put.latency.median
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.put.latency.min
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.put.latency.p99
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.replay.latency.max
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.replay.latency.mean
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.replay.latency.median
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.replay.latency.min
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operation.replay.latency.p99
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.operations.slow
|
|
GAUGE, INT64gce_instance |
operation
region_server
|
workload.googleapis.com/hbase.region_server.queue.length
|
|
GAUGE, INT64gce_instance |
state
region_server
|
workload.googleapis.com/hbase.region_server.queue.request.count
|
|
GAUGE, INT64gce_instance |
state
region_server
|
workload.googleapis.com/hbase.region_server.region.count
|
|
GAUGE, INT64gce_instance |
region_server
|
workload.googleapis.com/hbase.region_server.request.count
|
|
GAUGE, INT64gce_instance |
state
region_server
|
workload.googleapis.com/hbase.region_server.write_ahead_log.count
|
|
GAUGE, INT64gce_instance |
region_server
|
Verify the configuration
You can use the Logs Explorer and Metrics Explorer to verify that you correctly configured the HBase receiver. It might take one or two minutes for the Ops Agent to begin collecting logs and metrics.
To verify the logs are ingested, go to the Logs Explorer and run the following query to view the HBase logs:
resource.type="gce_instance"
logName=("projects/PROJECT_ID/logs/hbase_system")
To verify the metrics are ingested, go to
Metrics Explorer
and run the following query in the MQL tab.
fetch gce_instance
| metric 'workload.googleapis.com/hbase.region_server.request.count'
| align rate(1m)
| every 1m