Skip to content

Latest commit

 

History

History
50 lines (34 loc) · 1.48 KB

README.md

File metadata and controls

50 lines (34 loc) · 1.48 KB
Raw

huawei-4g-exporter

A Prometheus exporter for Huawei 4G routers (B315).

This is a work-in-progress and not complete. Code interface and reported metric naming and structure can change at any time. Pull requests with helpful contributions are very welcome.

Configuration

The following environment variables can be set.

  • HUAWEI_GW_IP - required (192.168.1.2)
  • HUAWEI_GW_USERNAME - required (admin)
  • HUAWEI_GW_PASSWORD - required (admin)
  • SERVER_PORT - (default 8080)
  • SERVER_HOST - (default 0.0.0.0)

Running

Docker

# With Docker Compose
HUAWEI_GW_PASSWORD='admin' HUAWEI_GW_USERNAME='admin' HUAWEI_GW_IP='192.168.1.2' docker-compose up

# With Docker
docker run -p 8080:8080 -e HUAWEI_GW_IP=192.168.1.1 -e HUAWEI_GW_USERNAME=admin -e HUAWEI_GW_PASSWORD=admin --name=huawei-4g-exporter --rm -d anroots/huawei-4g-exporter

Natively

wget https://github.com/anroots/huawei-4g-exporter/archive/master.zip && \
	unzip master.zip && \
	rm -f master.zip && \
	cd huawei-4g-exporter-master && \
	npm install && \
	HUAWEI_GW_PASSWORD='admin' HUAWEI_GW_USERNAME='admin' HUAWEI_GW_IP='192.168.1.2' node src/export.js

Metrics can be read from http://SERVER_HOST:SERVER_PORT/metrics endpoint.

Reported Metrics

Metrics are retrieved from the router using dialog-router-api package. Not all available metrics are implemented.

License

MIT license