hbase_exporter

KO | EN

gitlite — search

#javascript #typescript #golang #go #machine-learning #linux #docker #macos #nodejs #java #windows #kubernetes #awesome-list #openai

(★ 17)

HBase Exporter,fetch data from jmx for region-level data.

hbase_exporter Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# HBase Exporter

Prometheus exporter for HBase which fetches data from the HBase JMX endpoint, written in Go. Targets **HBase 1.2.x** metrics.

You can see region-level metrics too.

## Installation and Usage

For pre-built binaries see the [releases](../../releases).

### Build from source

```sh
make build
```

### Docker

```sh
docker build -t hbase_exporter .
docker run -d -p 9115:9115 hbase_exporter \
  --hbase.regionserver.uri=http://<rs-host>:60030/jmx
```

Container images for each release are published to `ghcr.io/daiwei233/hbase_exporter`.

## Configuration

Below is the command line options summary:

`hbase_exporter --help`

| Argument               | Description                                           | Default                    |
| ---------------------- | ----------------------------------------------------- | -------------------------- |
| web.listen-address     | Address to listen on for web interface and telemetry. | :9115                      |
| web.telemetry-path     | Path under which to expose metrics.                   | /metrics                   |
| hbase.master.uri       | HTTP jmx address of an HBase master node.             | http://localhost:60010/jmx |
| hbase.regionserver.uri | HTTP jmx address of an HBase regionserver node.       | http://localhost:60030/jmx |
| hbase.master           | Scrape the HBase master (instead of a regionserver).  | false                      |
| log.level              | Log level: debug, info, warn, error.                  | info                       |
| log.format             | Log format: json, logfmt.                             | logfmt                     |
| log.output             | Log output: stdout, stderr.                           | stdout                     |

All flags can also be set via environment variables (`WEB_LISTEN_ADDRESS`, `HBASE_MASTER_URL`, `HBASE_REGIONSERVER_URL`, `HBASE_IS_MASTER`, `LOG_LEVEL`, `LOG_FMT`, `LOG_OUTPUT`).

#### Master

Start in master:

```
./hbase_exporter --web.listen-address=":9003" --hbase.master.uri="http://localhost:60010/jmx" --hbase.master
```

#### Regionserver

Start in regionserver:

```
./hbase_exporter --web.listen-address=":9003" --hbase.regionserver.uri="http://localhost:60030/jmx"
```

### Metrics

#### common

> Common jvm metrics, both hmaster and regionservers.

> From(both hmaster and regionservers):
>
>  http://localhost:60030/jmx?qry=Hadoop:service=HBase,name=JvmMetrics and http://localhost:60010/jmx?qry=Hadoop:service=HBase,name=JvmMetrics
>
> Example:
>
> >  hbase_jvm_mem_non_heap_used_m{host="localhost",role="master"} 1
> >
> > hbase_jvm_mem_non_heap_used_m{host="localhost",role="regionserver"} 1

| Name                          | Type  | Origin in jmx   |
| ----------------------------- | ----- | --------------- |
| hbase_jvm_mem_non_heap_used_m | gauge | MemNonHeapUsedM |
| hbase_jvm_mem_heap_used_m     | gauge | MemHeapUsedM    |
| hbase_jvm_mem_heap_max_m      | gauge | MemHeapMaxM     |
| hbase_jvm_mem_max_m           | gauge | MemMaxM         |
| hbase_jvm_gc_time_millis      | gauge | GcTimeMillis    |
| hbase_jvm_gc_count            | gauge | GcCount         |
| hbase_jvm_thread_blocked      | gauge | ThreadsBlocked  |

#### HMaster

> HMaster server metrics, only for hmaster.
>
> From: http://localhost:60010/jmx?qry=Hadoop:service=HBase,name=Master,sub=Server
>
> Example: hbase_server_num_region_servers{host="localhost",role="master"}

| Name                                 | Type  | Origin in jmx        |
| ------------------------------------ | ----- | -------------------- |
| hbase_server_num_region_servers      | gauge | numRegionServers     |
| hbase_server_num_dead_region_servers | gauge | numDeadRegionServers |
| hbase_server_is_active_master        | gauge | tag.isActiveMaster   |
| hbase_server_average_load            | gauge | averageLoad          |

#### Regionserver

>Regionserver server metrics, only for regionserver.
>
>From: http://localhost:60030/jmx?qry=Hadoop:service=HBase,name=RegionServer,sub=Server
>
>Example: hbase_server_mem_store_size{host="localhost",role="regionserver"} 1

| Name                                 | Type  | Origin in jmx         |
| ------------------------------------ | ----- | --------------------- |
| hbase_server_mem_store_size          | gauge | memStoreSize          |
| hbase_server_region_count            | gauge | regionCount           |
| hbase_server_store_count             | gauge | storeCount            |
| hbase_server_store_file_count        | gauge | storeFileCount        |
| hbase_server_store_file_size         | gauge | storeFileSize         |
| hbase_server_total_request_count     | gauge | totalRequestCount     |
| hbase_server_read_request_count      | gauge | readRequestCount      |
| hbase_server_write_request_count     | gauge | writeRequestCount     |
| hbase_server_split_queue_length      | gauge | splitQueueLength      |
| hbase_server_compaction_queue_length | gauge | compactionQueueLength |
| hbase_server_flush_queue_length      | gauge | flushQueueLength      |
| hbase_server_block_cache_count       | gauge | blockCacheCount       |
| hbase_server_block_cache_size        | gauge | blockCacheSize        |
| hbase_server_block_cache_hit_count   | gauge | blockCacheHitCount    |
| hbase_server_block_cache_miss_count  | gauge | blockCacheMissCount   |
| hbase_server_block_count_hit_percent | gauge | blockCountHitPercent  |
| hbase_server_slow_append_count       | gauge | slowAppendCount       |
| hbase_server_slow_delete_count       | gauge | slowDeleteCount       |
| hbase_server_slow_get_count          | gauge | slowGetCount          |
| hbase_server_slow_put_count          | gauge | slowPutCount          |
| hbase_server_slow_increment_count    | gauge | slowIncrementCount    |

> Regionserver region metrics, only for regionserver.
>
> From: http://localhost:60030/jmx?qry=Hadoop:service=HBase,name=RegionServer,sub=Regions
>
> Example:  hbase_region_store_count{host="localhost",hregion="4fcaf7b9d1fedc1b62c15cbb1c9a10dc",htable="t1",namespace="n1",role="regionserver"} 1

| Name                                     | Type  | Origin in jmx             |
| ---------------------------------------- | ----- | ------------------------- |
| hbase_region_store_count                 | gauge | storeCount                |
| hbase_region_store_file_count            | gauge | storeFileCount            |
| hbase_region_mem_store_size              | gauge | memStoreSize              |
| hbase_region_store_file_size             | gauge | storeFileSize             |
| hbase_region_compactions_completed_count | gauge | compactionsCompletedCount |
| hbase_region_compactions_failed_count    | gauge | compactionsFailedCount    |
| hbase_region_read_request_count          | gauge | readRequestCount          |
| hbase_region_write_request_count         | gauge | writeRequestCount         |
| hbase_region_total_request_count         | gauge | totalRequestCount         |
| hbase_region_num_files_compacted_count   | gauge | numFilesCompactedCount    |
| hbase_region_num_bytes_compacted_count   | gauge | numBytesCompactedCount    |

hbase_exporter

hbase_exporter Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

hbase_exporter

hbase_exporter Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README