nikdoof/hg612-exporter
1
0
Fork 0
mirror of https://github.com/nikdoof/hg612-exporter.git synced 2025-12-13 18:22:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

add desc, build and run instructions

Browse Source
This commit is contained in:
Jake Keeys
2020-01-26 15:44:18 +00:00
parent e719b0a702
commit dc00b99d9a
1 changed files with 72 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

100
README.md
View File

@@ -1,5 +1,18 @@
# HG612 Prometheus Exporter
[![Docker Repository on Quay](https://quay.io/repository/jakekeeys/hg612-exporter/status "Docker Repository on Quay")](https://quay.io/repository/jakekeeys/hg612-exporter)
A prometheus exporter for the HG612 modem
![](https://i0.wp.com/codeblog.dotsandbrackets.com/wp-content/uploads/2017/01/prometheus-logo.jpg?resize=231%2C231) ![](https://kitz.co.uk/routers/images/huawei_echolife_hg612.jpg)
*Requires unlocked firmware with exposed metrics*
see https://kitz.co.uk/routers/hg612unlock.htm for flashing instructions and firmware
see also https://support.aa.net.uk/Router_-_EchoLife_HG612
## Usage
```
@@ -20,35 +33,66 @@ GLOBAL OPTIONS:
--help, -h show help (default: false)
```
## Dashbaord
## Build
go
```
go build .
```
![](https://raw.githubusercontent.com/jakekeeys/hg612-exporter/master/resources/dashboard.png)
docker
```
docker build .
```
## Run
go
```
go run main.go --host <host> --identifier <identifier>
```
docker
```
docker run docker run quay.io/jakekeeys/hg612-exporter --host <host> --identifier <identifier>
```
## Metrics
| Metric | Type | Lables |
| Domain | Implemented | Status
| --- | --- | --- |
| dsl_down_attenuation | gauge | `host` `identifier` |
| dsl_down_crc | gauge | `host` `identifier` |
| dsl_down_crc_2 | gauge | `host` `identifier` |
| dsl_down_current_rate | gauge | `host` `identifier` |
| dsl_down_current_rate_2 | gauge | `host` `identifier` |
| dsl_down_fec | gauge | `host` `identifier` |
| dsl_down_fec_2 | gauge | `host` `identifier` |
| dsl_down_hec | gauge | `host` `identifier` |
| dsl_down_hec_2 | gauge | `host` `identifier` |
| dsl_down_max_rate | gauge | `host` `identifier` |
| dsl_down_power | gauge | `host` `identifier` |
| dsl_down_snr | gauge | `host` `identifier` |
| dsl_status | gauge | `host` `identifier` `status` `modulation` `dataPath` |
| dsl_up_attenuation | gauge | `host` `identifier` |
| dsl_up_crc | gauge | `host` `identifier` |
| dsl_up_crc_2 | gauge | `host` `identifier` |
| dsl_up_current_rate | gauge | `host` `identifier` |
| dsl_up_current_rate_2 | gauge | `host` `identifier` |
| dsl_up_fec | gauge | `host` `identifier` |
| dsl_up_fec_2 | gauge | `host` `identifier` |
| dsl_up_hec | gauge | `host` `identifier` |
| dsl_up_hec_2 | gauge | `host` `identifier` |
| dsl_up_max_rate | gauge | `host` `identifier` |
| dsl_up_power | gauge | `host` `identifier` |
| dsl_up_snr | gauge | `host` `identifier` |
| dsl | ✓ | alpha |
| device | - | - |
| wan | - | - |
| lan | - | - |
| atm | - | - |
| Domain | Metric Name | Type | Labels |
| --- | --- | --- | --- |
| dsl | dsl_down_attenuation | gauge | `host` `identifier` |
| dsl | dsl_down_crc | gauge | `host` `identifier` |
| dsl | dsl_down_crc_2 | gauge | `host` `identifier` |
| dsl | dsl_down_current_rate | gauge | `host` `identifier` |
| dsl | dsl_down_current_rate_2 | gauge | `host` `identifier` |
| dsl | dsl_down_fec | gauge | `host` `identifier` |
| dsl | dsl_down_fec_2 | gauge | `host` `identifier` |
| dsl | dsl_down_hec | gauge | `host` `identifier` |
| dsl | dsl_down_hec_2 | gauge | `host` `identifier` |
| dsl | dsl_down_max_rate | gauge | `host` `identifier` |
| dsl | dsl_down_power | gauge | `host` `identifier` |
| dsl | dsl_down_snr | gauge | `host` `identifier` |
| dsl | dsl_status | gauge | `host` `identifier` `status` `modulation` `dataPath` |
| dsl | dsl_up_attenuation | gauge | `host` `identifier` |
| dsl | dsl_up_crc | gauge | `host` `identifier` |
| dsl | dsl_up_crc_2 | gauge | `host` `identifier` |
| dsl | dsl_up_current_rate | gauge | `host` `identifier` |
| dsl | dsl_up_current_rate_2 | gauge | `host` `identifier` |
| dsl | dsl_up_fec | gauge | `host` `identifier` |
| dsl | dsl_up_fec_2 | gauge | `host` `identifier` |
| dsl | dsl_up_hec | gauge | `host` `identifier` |
| dsl | dsl_up_hec_2 | gauge | `host` `identifier` |
| dsl | dsl_up_max_rate | gauge | `host` `identifier` |
| dsl | dsl_up_power | gauge | `host` `identifier` |
| dsl | dsl_up_snr | gauge | `host` `identifier` |
### Grafana Dashboard Preview
![](https://raw.githubusercontent.com/jakekeeys/hg612-exporter/master/resources/dashboard.png)