A Prometheus exporter for BT Home Hub routers.
Download the exporter from the releases page and then run:
./homehub-metrics-exporter --listen-address=0.0.0.0:19092 --hub-address=192.168.1.254 --hub-username=admin --hub-password=secret
Some of the arguments can be ommitted if the default values are acceptable.
| Name | Default Value |
|---|---|
| listen-address | 0.0.0.0:19092 |
| hub-address | 192.168.1.254 |
| hub-username | admin |
Configuration options can also be set by environment variables:
HUB_EXPORTER_LISTEN_ADDRESS
HUB_ADDRESS
HUB_USERNAME
HUB_PASSWORD
The password can either be provided as plain text or MD5 hashed.
With the exporter running, hit the /metrics endpoint to collect metrics from the Home Hub. Here's a breakdown of available metrics.
| Metrics Name | Description |
|---|---|
| bt_homehub_build_info | Home Hub build information. Currently only a label for the firmware version. |
| bt_homehub_device_downloaded_megabytes | Total megabytes downloaded by each active device. |
| bt_homehub_device_uploaded_megabytes | Total megabytes uploaded by each active device. |
| bt_homehub_download_rate_mbps | The download rate of the Home Hub router. |
| bt_homehub_upload_rate_mbps | The upload rate of the Home Hub router |
| bt_homehub_up | Whether the Home Hub is 'Up'. Will be 0 if the exporter failed to collect metrics. |
| bt_homehub_uptime_seconds | The amount of time in seconds that the Home Hub has been running. |
| bt_homehub_download_bytes_total | Total number of bytes downloaded from the internet. |
| bt_homehub_upload_bytes_total | Total number of bytes uploaded to the internet. |
You can run the exporter within a Docker container:
docker run -ti --rm jamesnetherton/homehub-metrics-exporter \
--listen-address=0.0.0.0:19092 \
--hub-address=192.168.1.254 \
--hub-username=admin \
--hub-password=secret
Getting started is simple with Docker Compose.
You'll need to edit the docker-compose.yml file to add your Home Hub password to the --hub-password argument. Then Simply run docker-compose up.
The Home Hub Grafana dashboard can be accessed at http://localhost:3000. Prometheus is available at http://localhost:9090.
This project uses go modules. Ensure that you're using a compatible go version in order to build the project.
git clone git@github.com:jamesnetherton/homehub-metrics-exporter.git
make build
Generated binaries are output to the build directory.