sebclem/huawei_lte_exporter
Archived
1
0
Fork 0
Code Issues 1 Pull Requests 1 Actions Packages Projects Releases 4 Wiki Activity
Prometheus exporter for Huawei LTE routers
This repository has been archived on 2024-10-15. You can view files and clone it, but cannot push or open issues or pull requests.
14 Commits 2 Branches 4 Tags 161 KiB
Python 95.3%
Dockerfile 4.7%
62ac4170f2
Go to file
Rob Lee 62ac4170f2 Added note on signal data availability
2020-04-09 21:11:22 +01:00
examples Added more usage information 2020-04-07 15:52:27 +01:00
.gitignore Initial commit 2020-04-06 21:27:29 +01:00
Dockerfile Initial commit 2020-04-06 21:27:29 +01:00
huwawei_lte_exporter Refactored to provide more resilience against null values and added additional signal information to the exporter 2020-04-09 21:08:30 +01:00
README.md Added note on signal data availability 2020-04-09 21:11:22 +01:00
requirements.txt Initial commit 2020-04-06 21:27:29 +01:00

README.md

huawei_lte_exporter

A promethus exporter for the Huawei series of 4G LTE routers, exporting various LTE signal strength measures e.g. rssi, snr etc ... It should be compatible with a range of Huawei routers including B310, B315, B525 and B535. A full range is listed at huawei-lte-api.

Example

Grafana Dashboard Screenshot

Data Availability

Different operators appear to provide different signal information, so not all values will be available across all operators. A handy way to identify the available information is to login to your router and then view device api.

A good way to observe the available information

Install

Follow the usual docker build and run flow.

Required environment variables:

  • ROUTER_ADDRESS - IP address of the Huawei router on your network (typically '192.168.8.1')
  • ROUTER_USER - Username to login to the router (typically 'admin')
  • ROUTER_PASS - Password to login to the router (typically 'admin')
  • PROM_PORT - Port to start the exporter on in the container
docker build -t huawei_lte_exporter .

export ROUTER_ADDRESS=192.168.8.1
export ROUTER_USER=admin
export ROUTER_PASS=admin
export PROM_PORT=8080

docker run -d -it -p $PROM_PORT:$PROM_PORT -e ROUTER_ADDRESS=$ROUTER_ADDRESS -e ROUTER_USER=$ROUTER_USER -e ROUTER_PASS=$ROUTER_PASS -e PROM_PORT=$PROM_PORT --name=hle huawei_lte_exporter
sleep 5
curl http://localhost:$PROM_PORT

HELP band The signal band the LTE connection is using
TYPE band gauge
band{deviceName="B535-232",iccid="111"} 1
HELP rsrp The average power received from a single Reference signal, and Its typical range is around -44dbm (good) to -140dbm(bad)
TYPE rsrp gauge
rsrp{deviceName="B535-232",iccid="111",band="3"} -98
HELP rsrq Indicates quality of the received signal, and its range is typically -19.5dB(bad) to -3dB (good)
TYPE rsrq gauge
rsrq{deviceName="B535-232",iccid="111",band="3"} -10.0
HELP rssi Represents the entire received power including the wanted power from the serving cell as well as all co-channel power and other sources of noise in dBm
TYPE rssi gauge
rssi{deviceName="B535-232",iccid="111",band="3"} -71
HELP sinr The signal-to-noise ratio of the given signal in dB
TYPE sinr gauge
rsrq{deviceName="B535-232",iccid="111",band="3"} 11

Configure

Prometheus

  - job_name: '4g'
    scrape_interval: 1m
    static_configs:
    - targets:
      - server.home:8080

Grafana

Example dashboard for Three (UK) config

Guage values taken from: https://wiki.teltonika-networks.com/view/Mobile_Signal_Strength_Recommendations

Todo