Munin Plugins for FritzBox

A collection of munin plugins to monitor your AVM FRITZ!Box router. The scripts have been developed using a FRITZ!Box 7590 running FRITZ!OS 7.50 and a FRITZ!WLAN Repeater 1750E running FRITZ!OS 7.27.

If you are using the scripts on a different FRITZ!Box model please let me know by

• opening an issue
• submitting a pull request

These python scripts are Munin plugins for monitoring the FRITZ!Box router by AVM.

Purpose of this Fork

The scripts are build upon the original fritzbox-munin with the goal to make use of the modern APIs that FRITZ!OS 7 provides.
The main differences to the original version are:

• Compatibility with latest FRITZ!OS version using username/password authentication
• No HTML Scraping is used
• All data is fetched either through the TR-064 interface or the JSON API
• Contrary to the original version this fork uses multigraphs: this removes the need to query the same API endpoint multiple times, all multigraph plugins have configuration options to switch individual graphs on and off
• Support for Smart Home devices, e.g. for measuring temperature
• Complete refactoring of the Python code base to make it more robust, use modern language features like type hinting and reuse identical code
• Add possibility to connect to FRITZ!Box via TLS

Requirements

• FRITZ!Box router with FRITZ!OS >= 07.50 (if you are on an older FRITZ!OS version, select an older version of fritzbox-munin-fast by browsing the tags in this repository)
• Munin 1.4.0 or later is required
• Python 3.x

Available Plugins

Connection Uptime

Plugin: fritzbox_connection_uptime.py
Shows the WAN connection uptime.

DSL Errors

Plugin: fritzbox_dsl.py
Multigraph plugin, showing:

• DSL checksum errors
• DSL transmission errors
• line loss
• link capacity
• error correction statistics
• signal-to-noise ratio

CPU & Memory

Plugin: fritzbox_ecostat.py
Multigraph plugin, showing:

• memory usage
• CPU load
• CPU temperature

Smart Home Temperature

Plugin: fritzbox_smart_home_temperature.py

Energy

Plugin: fritzbox_energy.py
Multigraph plugin, showing:

• power consumption for CPU, WiFi, WAN, Fon, USB and total
• devices connected on WiFi and LAN
• system uptime

Link Saturation

Plugin: fritzbox_link_saturation.py
Multigraph plugin, showing saturation of WAN uplink and downlink by QoS priority

Traffic

Plugin: fritzbox_traffic.py
Similar to fritzbox_link_saturation, but single-graph and without QoS monitoring.

Wifi

Plugin: fritzbox_wifi_load.py
Multigraph plugin, showing for 2.4GHz and 5GHz

• WiFi uplink and downlink bandwidth usage
• neighbor APs on same and on different channels

Installation & Configuration

1. Pre-requisites for the fritzbox_traffic and fritzbox_connection_uptime plugins are the fritzconnection and requests package. To install run

   pip install -r requirements.txt

2. Make sure the FRITZ!Box has UPnP status information enabled. (web interface: Home Network > Network > Network Settings > Universal Plug & Play (UPnP))

3. Copy all the scripts from src/ folder to /usr/share/munin/plugins

4. (optional) If you want to connect to FRITZ!Box using SSL, download the Fritz certificate (web interface: Internet > Freigaben > FritzBox Dienste > Zertifikat > Zertifikat herunterladen) and save it to /etc/munin/box.cer.

5. Create entry in /etc/munin/plugin-conf.d/munin-node:

   [fritzbox_*]
   env.fritzbox_password <fritzbox_password>
   env.fritzbox_user <fritzbox_user>
   env.fritzbox_use_tls true
   host_name fritzbox

   See the plugin files for plugin-specific configuration options.

6. For each plugin you want to activate, create a symbolic link to /etc/munin/plugins, e.g.:

   ln -s fritzbox_dsl.py /etc/munin/plugins/fritzbox_dsl.py

7. Restart the munin-node daemon: service munin-node restart.

8. Done. You should now start to see the charts on the Munin pages!

Localization

The fritzbox_energy script depends on the language selected in your FRITZ!Box. Currently, two locales are supported:

1. German: de (default)
2. English: en

You can change the used locale by setting an environment variable in your plugin configuration:

env.locale en

Different hosts for the FRITZ!Box and your system

You can split the graphs of your FRITZ!Box from the localhost graphs by following the next steps:

1. Use the following as your host configuration in /etc/munin/munin.conf

   [home.yourhost.net;server]
       address 127.0.0.1
       use_node_name yes
   
   [home.yourhost.net;fritzbox]
       address 127.0.0.1
       use_node_name no

2. Restart your munin-node: service munin-node restart

Testing

To test a plugin use

munin-run --debug fritzbox_connection_uptime.py