A collectd plugin for monitoring AVM FRITZ!Box routers
Python
Latest commit 94cb255 Oct 22, 2016 @fetzerch project: Release 0.2.1

README.rst

Circle CI Status

fritzcollectd

A collectd plugin for monitoring AVM FRITZ!Box routers.

Data captured includes:

  • Physical link status
  • Connection status
  • Online connection uptime
  • Maximal bit rates
  • Current bit rates
  • Total bytes sent and received

Dependencies

Installation

  1. pip install fritzcollectd
  2. Configure the plugin as shown below
  3. Restart collectd

Prerequisites

In order to be able to read the status information the option "Transmit status information over UPnP" has to be enabled in the "Network Settings" menu on the Fritz!BOX. This is exaplained in AVM's Knowledge Base.

Configuration

Add the following to your collectd config (typically /etc/collectd.conf):

<LoadPlugin python>
    Globals true
</LoadPlugin>
...
<Plugin python>
    Import "fritzcollectd"

    #<Module fritzcollectd>
    #    Address "fritz.box"
    #    Port 49000
    #    User "dslf-config"
    #    Password "pass"
    #    Hostname "FritzBox"
    #    Instance "1"
    #</Module>
</Plugin>

The plugin recognizes several (optional) configuration parameters. In most cases the plugin works without any of these parameters. It might be necessary to specify Address if the router's host name has been changed.

  • Address: The network address of the FRITZ!Box.
  • Port: The TCP port of the FRITZ!Box.
  • User: The login user name on the FRITZ!Box.
  • Password: The password on the FRITZ!Box for authentication.
  • Instance: Plugin instance that collectd associates with the data.
  • Hostname: Hostname that collectd associates with the data (defaults to the host executing this plugin)

Further Information

Please refer to the project announcement blog post for additional information, such as the usage of Grafana for metrics visualization.

License

This projected is licensed under the terms of the MIT license.