This is a prometheus exporter for AVM Fritz! home network devices commonly found in Europe. This exporter uses the devices builtin TR-064 API via the fritzconnection python module.
The exporter still is a bit simplistic in places but it should work with Fritz!Box and Fritz!Repeater Devices (and maybe others). It actively checks for supported metrics and queries the for all devices configured (Yes, it has multi-device support for all you Mesh users out there.)
It has been tested against an AVM Fritz!Box 7590 (DSL), a Fritz!Repeater 2400 and a Fritz!WLAN Repeater 1750E. If you have another box and data is missing, please file an issue or PR on GitHub.
This current version of the exporter has completely reworked how this exports metrics! If you have used this exporter in the past, you will get a completely new set of metrics.
- the metrics prefix has changed from
fritzbox_tofritz_ - all labels have been converted to lower-case (e.g.
Serial->serial) to be in line with the common usage of labels - some metrics have been renamed to better reflect their content
The following groups of metrics are currently available:
- Base Information (Model, Serial, Software Version, Uptime)
- Software Information (Update available)
- LAN statistics (Ethernet only)
- WAN statistics
- DSL statistics
- PPP statistics
- WiFi statistics
- WAN Layer1 (physical link) statistics
Thre is code in fritzexporter/fritzcapabilities.py to extract information about ever single host the device knows about but it is completely disabled as of now as polling the information can take 20-30 seconds depending on your network setup. If you want to test this out simply uncomment that code and rebuild the docker image.
If there is any information missing or not displayed on your specific device, please open an issue.
There is a simple Grafana dashboard avaliable at https://grafana.com/grafana/dashboards/13983
- Python >=3.6
- fritzconnection >= 1.0.0
- prometheus-client >= 0.6.0
A Pipfile for pipenv ist included with the source. So after install pipenv you can just type pipenv install inside the source directory and a virtual environment for running the exporter will be configured for you.
This exporter can directly be run from a shell. Set the environment vars as describe in the configuration section of this README and run "python3 -m fritzbox_exporter" from the code directory. There is a sample systemd unit file included in the docs directory.
Release images are automatically pushed to Docker Hub and are built for linux/amd64, linux/arm/v6, linux/arm/v7 and linux/arm64, the latter three being useful for e.g. Raspberry Pi type systems.
To run simply use
docker run -d -e FRITZ_EXPORTER_CONFIG="192.168.178.1,username,password" -p 9787:9787 --name fritz_exporter pdreker/fritz_exporterThe recommended way to run this exporter is from a docker container. The included Dockerfile will build the exporter using an python:alpine container using python3.
To build execute
docker build -t fritz_exporter:latest .from inside the source directory.
To run the resulting image use
docker run -d --name fritz_exporter -p <PORT>:<FRITZ_EXPORTER_PORT> -e FRITZ_EXPORTER_CONFIG="192.168.178.1,username,password" fritz_exporter:latestVerify correct operation:
curl localhost:<FRITZ_EXPORTER_PORT># HELP python_gc_objects_collected_total Objects collected during gc
# TYPE python_gc_objects_collected_total counter
python_gc_objects_collected_total{generation="0"} 481.0
python_gc_objects_collected_total{generation="1"} 112.0
python_gc_objects_collected_total{generation="2"} 0.0
# HELP python_gc_objects_uncollectable_total Uncollectable object found during GC
# TYPE python_gc_objects_uncollectable_total counter
python_gc_objects_uncollectable_total{generation="0"} 0.0
python_gc_objects_uncollectable_total{generation="1"} 0.0
python_gc_objects_uncollectable_total{generation="2"} 0.0
...
Configuration is done via environment vars.
The main configuration is done inside the environment variable FRITZ_EXPORTER_CONFIG. This variable must contain the comma-separated address, username and password for the device. If you need multiple devices simply repeat the three values for the other devices.
An alternative it to use The three environment variables FRITZ_HOSTNAME, FRITZ_USERNAME and FRITZ_PASSWORD, This way you lose the ability to monitor multiple devices with one exporter but gain the ability To put FRITZ_PASSWORD into a kubernetes secret like shown in Kubernetes deployment.
Example for a single device (at 192.168.178.1 username monitoring and the password "mysupersecretpassword"):
export FRITZ_EXPORTER_CONFIG="192.168.178.1,monitoring,mysupersecretpassword"Example for three devices:
export FRITZ_EXPORTER_CONFIG="fritz.box,user1,password1,fritz.repeater,user2,password2,192.168.178.123,user3,password3"NOTE: If you are using WiFi Mesh all your devices should have the same username password - you will still have to specify them all.
| Env variable | Description | Default |
|---|---|---|
| FRITZ_EXPORTER_CONFIG | Comma separated "hostname","user","password" triplets | none |
| FRITZ_EXPORTER_PORT | Listening port for the exporter | 9787 |
Put the Fritz!Box password into a kubernetes secret
kubectl create secret generic fritzbox-password --from-literal=password='mysupersecretpassword'then deploy the exporter with a deployment
apiVersion: apps/v1
kind: Deployment
metadata:
name: fritzbox-exporter
labels:
app: fritzbox-exporter
spec:
selector:
matchLabels:
app: fritzbox-exporter
template:
metadata:
annotations:
prometheus.io/scrape: "true"
prometheus.io/path: /
prometheus.io/port: "9787"
labels:
app: fritzbox-exporter
spec:
containers:
- name: fritzbox-exporter
image: pdreker/fritz_exporter:latest
imagePullPolicy: Always
env:
- name: FRITZ_HOSTNAME
value: "192.168.178.1"
- name: FRITZ_USERNAME
value: "monitoring"
- name: FRITZ_EXPORTER_PORT
value: "9787"
- name: FRITZ_PASSWORD
valueFrom:
secretKeyRef:
name: fritzbox-password
key: password
ports:
- containerPort: 9787If your device delivers some metrics which are not yet scraped by this exporter you can either create a Pull Request, which will be gladly accepted ;-)
Alternatively you can use the following commands and the litlle helper script in the root of this repository to let me know of metrics:
fritzconnection -i <FRITZ-IP> -s # Lists available services
fritzconnection -i <FRITZ-IP> -S <ServiceName> # Lists available action for a service
python -m fritz_export_helper <FRITZ-IP> <USERNAME> <PASSWORD> <ServiceName> <ActionName> # Will output the data returned from the device in a readable formatIf you have found something you need/want, open an issue provide the following infos:
- Model of Device (e.g. FritzBox DSL 7590)
- ServiceName and ActionName
- Output from fritz_export_helper (make sure, there is not secret data, like password or WiFi passwords in there, before sending!)
- What output you need/want and a little bit of info of the environment (Cable, DSL, Hybrid LTE Mode, ... whatever might be relevant)
Fritz! and AVM are registered trademarks of AVM GmbH. This project is not associated with AVM or Fritz other than using the devices and their names to refer to them.
Copyright 2019-2021 Patrick Dreker patrick@dreker.de
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.