fergbrain / igd-exporter

Prometheus exporter for UPnP Internet Gateway Device metrics

igd-exporter

Allows probing of UPnP Internet Gateway Devices (i.e., consumer Internet routers) by Prometheus. Modelled after the Blackbox exporter.

Running

$ python3 -m pip install git+https://github.com/yrro/igd-exporter.git
$ igd-exporter

You can then visit http://localhost:9196/ to search for devices on your network, and probe each discovered device to see its available metrics; for instance:

# HELP igd_common_sent_packets_total Packets sent by all connections
# TYPE igd_common_sent_packets_total counter
igd_common_sent_packets_total{udn="uuid:upnp-WANDevice-1_0-944452e7ebdc"} 164336.0
# HELP igd_common_received_packets_total Packets received by all connections
# TYPE igd_common_received_packets_total counter
igd_common_received_packets_total{udn="uuid:upnp-WANDevice-1_0-944452e7ebdc"} 485942.0
# HELP igd_common_sent_bytes Bytes sent by all connections
# TYPE igd_common_sent_bytes counter
igd_common_sent_bytes{udn="uuid:upnp-WANDevice-1_0-944452e7ebdc"} 37393863.0
# HELP igd_common_received_bytes Bytes received by all connections
# TYPE igd_common_received_bytes counter
igd_common_received_bytes{udn="uuid:upnp-WANDevice-1_0-944452e7ebdc"} 448588847.0

According to the UPnP specification, the udn label should be unique to a given device.

Packaging

To produce a Debian package:

$ debian/rules clean
$ dpkg-buildpackage -b

The prometheus-igd-exporter package will be created in the parent directory.

Prometheus configuration

Each device is identified by a "root device URL", for example http://192.0.2.1:80/scpd.xml. You can use relabelling to pass this URL to the exporter as follows:

scrape_configs:
 - job_name: igd
   metrics_path: /probe
   static_configs:
    - targets:
        - http://192.0.2.1:80/scpd.xml
   relabel_configs:
    - source_labels: [__address__]
      target_label: __param_target
    - source_labels: [__param_target]
      target_label: instance
    - target_label: __address__
      replacement: exporter-host:9196

Exporter Configuration

Some useful options can be given to exporter.py on the command line.

$ igd-exporter
usage: igd-exporter [-h] [--bind-address BIND_ADDRESS] [--bind-port BIND_PORT]
                    [--bind-v6only {0,1}] [--thread-count THREAD_COUNT]

optional arguments:
  -h, --help            show this help message and exit
  --bind-address BIND_ADDRESS
                        IPv6 or IPv4 address to listen on
  --bind-port BIND_PORT
                        Port to listen on
  --bind-v6only {0,1}   If 1, prevent IPv6 sockets from accepting IPv4
                        connections; if 0, allow; if unspecified, use OS
                        default
  --thread-count THREAD_COUNT
                        Number of request-handling threads to spawn

Development

I'm trying to keep things simple and rely only on the Python standard library and the prometheus_client module.

To run exporter from source:

$ python3 -m pip install -e .
$ igd-exporter

or, without installing:

$ python3 -m igd_exporter