Feature Highlights

OpenWISP Monitoring is available since OpenWISP 22.05 and focuses on allowing users to know the status of their devices at any given time.

Deploy instructions

The monitoring module is enabled by default in the OpenWISP 22.05 ansible role.

It’s also available in docker-openwisp although its usage is not recommended for production usage yet, unless the reader is willing to invest effort in adapting the docker images and configurations to overcome any problems encountered.

Quickstart Guide

This guide assumes you have the OpenWISP Monitoring module enabled on your OpenWISP server application and you have already followed the steps to install openwisp-config on your OpenWRT devices.

Install monitoring packages on the device

Install the openwrt-openwisp-monitoring packages on your device.

These packages collect and send the monitoring data from the device to OpenWISP Monitoring and are required to collect metrics like interface traffic, WiFi clients, CPU load, memory usage, etc.

Make sure OpenWISP can reach your devices

In order to perform active checks and other actions like triggering the push of configuration changes, executing shell commands or performing firmware upgrades, the OpenWISP server needs to be able to reach the network devices.

There are mainly two deployment scenarios for OpenWISP:

  1. the OpenWISP server is deployed on the public internet and the devices are geographically distributed across different locations: in this case a management tunnel is needed

  2. the OpenWISP server is deployed on a computer/server which is located in the same Layer 2 network (that is, in the same LAN) where the devices are located. In this case a management tunnel is NOT needed

1. Public internet deployment

This is the most common scenario:

  • the OpenWISP server is deployed to the public internet, hence the server has a public IPv4 (and IPv6) address and usually a valid SSL certificate provided by Mozilla Letsencrypt or another SSL provider

  • the network devices are geographically distributed across different locations (different cities, different regions, different countries)

In this scenario, the OpenWISP application will not be able to reach the devices unless a management tunnel is used, for that reason having a management VPN like OpenVPN, Wireguard, ZeroTier or any other tunneling solution is paramount, not only to allow OpenWISP to work properly, but also to be able to perform debugging and troubleshooting when needed.

In this scenario, the following requirements are needed:

  • a VPN server must be installed in a way that the OpenWISP server can reach the VPN peers. For more information on how to do this via OpenWISP please refer to the following sections:

  • If you prefer to use other tunneling solutions (L2TP, Softether, etc.) and know how to configure those solutions on your own, please do so. If the OpenWISP server is connected to a network infrastructure which allows it to reach the devices via pre-existing tunneling or Intranet solutions (eg: MPLS, SD-WAN), then setting up a VPN server is not needed, as long as there’s a dedicated interface on OpenWrt which has an IP address assigned to it and which is reachable from the OpenWISP server.

  • The devices must be configured to join the management tunnel automatically, either via a pre-existing configuration in the firmware or via an OpenWISP Template.

  • The openwisp-config agent on the devices must be configured to specify the management_interface option, the agent will communicate the IP of the management interface to the OpenWISP Server and OpenWISP will use the management IP for reaching the device.

    For example, if the management interface is named tun0, the openwisp-config configuration should look like the following example:

# In /etc/config/openwisp on the device

config controller 'http'
    # ... other configuration directives ...
    option management_interface 'tun0'

2. LAN deployment

When the OpenWISP server and the network devices are deployed in the same L2 network (eg: an office LAN) and the OpenWISP server is reachable on the LAN address, OpenWISP can then use the Last IP field of the devices to reach them.

In this scenario it’s necessary to set the “OPENWISP_MONITORING_MANAGEMENT_IP_ONLY” setting to False.

Find out more about OpenWISP Monitoring

For more information about the features offered by OpenWISP Monitoring and the related OpenWrt packages we refer to the following sections of their respective READMEs.

OpenWISP Monitoring Python/Django module

OpenWISP Monitoring OpenWrt packages