Prometheus exporter for cheap TP-Link routers, like the TL-WR841N.
Inspired by this repository.
The tplink package created for this exporter can be used for another projects besides this one.
tplink exporter has a few CLI arguments that you can configure like the following ones.
- -a: Router's IP address, you can also configure it by using the
TPLINK_ROUTER_ADDRenvironment variable. - -w: Router's password, you can also configure it by using the
TPLINK_ROUTER_PASSWDenvironment variable. - -u: Router's username, you can also configure it by using the
TPLINK_ROUTER_USERenvironment variable. - -p: Prometheus port.
- -v: Verbose output.
- -f: MAC Database, you can also configure it by using the
TPLINK_ROUTER_MACSenvironment variable. By default should be located on/etc/known_macs.
- tplink_wan_rx_bytes: Total bytes received
- tplink_wan_tx_bytes: Total bytes transmitted
- tplink_lan_traffic_bytes: bytes sent/received per device
- tplink_lan_traffic_packets: Packets sent/received per device
- tplink_lan_leases_seconds: Lease time left per device
LAN metrics include IP and MAC addresses and device name as labels.
You can run this agent as a service. First you need to compile it and then you just need create a systemd service like this one:
[Unit]
Description=TP-Link Exporter
Wants=network-online.target
After=network-online.target
[Service]
User=tplink_exporter
Group=tplink_exporter
Type=simple
ExecStart=/usr/local/bin/tplink_exporter
[Install]
WantedBy=multi-user.target
Configure it and launch it:
sudo systemctl enable tplink_exporter
sudo systemctl start tplink_exporter
tplink_exporter:
container_name: tplink_exporter
restart: unless-stopped
cpu_count: 1
mem_limit: 16m
build:
context: ./containers/tplink_exporter
dockerfile: Dockerfile
ports:
- "9300:9300"
volumes:
- "./config/tplink_exporter/known_macs:/etc/known_macs"