Openwrt-Monitoring
Openwrt Monitoring via Grafana.
This project consists of a few applications to help monitor your home router. You will need a decent router (anything from 2-3yrs ago will work) with dual core CPU, with 256mb-512mb of RAM and 128mb nand. Note: This will only work with Openwrt 21.x (IPTables) NFTables will not be supported,
On the router, the following software will be installed
Prometheus - main router monitoring (CPU,MEM,etc)
Collectd - to monitor ping and export iptmon data
vnstat2 - to monitor wan bandwidth usage
iptmon - to monitor per device usage
You will also need a Home Server running Docker to run the following applications
Prometheus - Container to scrape and store data.
Grafana - Container to display the graphs. (you will need to add your Prometheus location as the data source)
AdGuardHome - Container to block Ads/Porn/etc.
Prom-Exporters - Container(s) used to export data so prometheus can scrape the data.
Router Steps:
*This section will cover the openwrt Router config
I've created a shell script that can be ran on the router, it will install all the needed software, scripts and custom lua files.
Before running the shell script, please edit the routersetup.sh file and replace the home server ip variable. My home server is at 10.0.5.5, if you dont replace this ip, it will cause your DNS to stop working and your collectd export settings wont work.
Note: The New_Device section does not work at the moment.
The routersetup.sh script will do the following:
Install Nano, netperf (needed for speedtest.sh), openssh-sftp-server,vnstat
Install Prometheus and CollectD
Install iptmon, wrtbwmon and luci-wrtbwmon
Copy custom scripts from this git to /usr/bin/ on the router
Copy custom LUA files from this git to /usr/lib/lua/prometheus-collectors on the router.
Adding new_device.sh script to dhcp dnsmasq
Adding scripts to Crontab
Update prometheus config to 'lan'
Update Collectd Export IP to home server ip address
Add iptmon to your dhcp file under dnsmasq section
Set your lan interface to assign out DNS IP of your home server
restarts services
SSH to your router and run
wget https://raw.githubusercontent.com/benisai/Openwrt-Monitoring/main/routersetup.sh nano routersetup.sh -> find 10.0.5.5 and replace that ip with your home-server ip. sh routersetup.sh reboot router
Home Server Steps:
You will need a Raspberry Pi or other linux server with Docker and Docker Compose. Clone this repo to your server. :~# gh repo clone benisai/Openwrt-Monitoring :~# cd Docker ------->NOTE: Make sure to update the prometheus.yml file with your server IP and router IP. :~# Sudo Docker-Compose.yml up -d This will install Grafana/Prometheus/Collectd-Exporter/AdguardHome/AdguardHome-Exporter. Login to grafana, add the prometheus datasource and Import the dashboard from this GIT Repo. (OpenWRT-Dashboard.json) Note about the Grafana Dashboard:: You'll find two variables at the top. One for iptimon (hostname) and (srcip) for prometheus metrics. Unfortunately Prometheus exporter does not export via hostname only IP address. And iptimon exports as hostname. You can use the DHCP panel to find the corresponding IP address to hostname.
Credit: I have to give credit to Matthew Helmke, I used his blog and grafana dashboard and I added some stuff. I cant say I'm an expert in Grafana or Prometheus (first time using Prom) https://grafana.com/blog/2021/02/09/how-i-monitor-my-openwrt-router-with-grafana-cloud-and-prometheus/