Checks
Introduction
Active checks are periodic background tasks executed by Celery workers on the OpenWISP server.
These workers perform the enabled checks and store their results in the time series database.
The built-in checks and the related django settings available in OpenWISP Monitoring are described below.
Note
If you're unsure about what "Django settings" are, you can refer to How to Edit Django Settings in OpenWISP for guidance.
Ping
Check enabled by default? Yes.
Alert: Ping Alert.
Charts: Ping Charts.
This check returns information on Ping Success Rate and RTT (Round trip
time). It creates charts like Ping Success Rate, Packet Loss and RTT.
These metrics are collected using the fping Linux program. You may
choose to disable auto creation of this check by setting
OPENWISP_MONITORING_AUTO_PING to False.
You can change the default values used for ping checks using OPENWISP_MONITORING_PING_CHECK_CONFIG setting.
This check also sends an alert when the device becomes unreachable.
Configuration Applied
Check enabled by default? Yes.
Alert: Config Applied Alert.
This check ensures that the openwisp-config agent is running and applying configuration changes in a timely manner. You may choose to disable auto creation of this check by using the setting OPENWISP_MONITORING_AUTO_DEVICE_CONFIG_CHECK.
This check runs periodically, but it is also triggered whenever the configuration status of a device changes, this ensures the check reacts quickly to events happening in the network and informs the user promptly if there's anything that is not working as intended.
This check also sends an alert if configuration is not being applied.
Monitoring Data Collected
Check enabled by default? Yes.
Alert: Data Collected Alert.
This check ensures that the server is receiving metrics from network devices in a timely manner. You may choose to disable auto creation of this check by using the setting OPENWISP_MONITORING_AUTO_DATA_COLLECTED_CHECK.
This check also sends an alert when no data is received from a device.
Iperf3
Check enabled by default? No.
Charts: Iperf3 Charts.
This check provides network performance measurements such as maximum achievable bandwidth, jitter, datagram loss etc of the device using iperf3 utility.
This check is disabled by default. You can enable auto creation of
this check by setting OPENWISP_MONITORING_AUTO_IPERF3 to True.
You can also add the iperf3 check directly from the device page.
It also supports tuning of various parameters. You can change the
parameters used for iperf3 checks (e.g. timing, port, username, password,
rsa_publc_key, etc.) using the
OPENWISP_MONITORING_IPERF3_CHECK_CONFIG setting.
Note
When setting OPENWISP_MONITORING_AUTO_IPERF3 to True, you
may need to update the metric configuration to enable alerts for the iperf3
check.
WiFi Clients
Check enabled by default? No.
Alerts: WiFi Clients Alerts (Max/Min).
This check sends alerts based on the total number of WiFi Clients connected to a device. It sends two types of alerts:
Maximum WiFi Clients: When the total number of WiFi clients connected to an access point exceeds a predetermined threshold. This functionality provides valuable insights into the network's performance, signaling when a specific access point is overwhelmed by an excessive number of WiFi clients.
Minimum WiFi Clients: When the total number of WiFi clients connected to an access point remains at zero for a duration exceeding the specified tolerance period. It serves as an indicator of whether the access point is malfunctioning or if its placement is hindering user connectivity.
This check is disabled by default. To enable auto creation of this
check, set OPENWISP_MONITORING_AUTO_WIFI_CLIENTS_CHECK to True.
You can also add the WiFi Clients check directly from the device page.
You can use the OPENWISP_MONITORING_WIFI_CLIENTS_CHECK_SNOOZE_SCHEDULE setting to disable this check on specific dates, such as during scheduled maintenance, to avoid generating unnecessary alerts.
Other related settings: