Skip to content

Commit

Permalink
[docs] Added docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pandafy committed Dec 13, 2024
1 parent 958bd6d commit 2762e68
Show file tree
Hide file tree
Showing 2 changed files with 99 additions and 0 deletions.
47 changes: 47 additions & 0 deletions docs/user/checks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,50 @@ parameters used for iperf3 checks (e.g. timing, port, username, password,
may need to update the :doc:`metric configuration
<device-checks-and-alert-settings>` to enable alerts for the iperf3
check.

.. _wifi_client_check:

WiFi Client
-----------

This check sends alerts based on the total number of WiFi Clients
connected to a device. It sends two types of alerts:

- **Maximum WiFi Users**: 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 users.
- **Minimum WiFi Users**: 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 :ref:`openwisp_monitoring_auto_wifi_client_check` to ``True``
and configure the task scheduling in your Django project:

.. code-block:: python
from datetime import timedelta
OPENWISP_MONITORING_AUTO_WIFI_CLIENT_CHECK = True
CELERY_BEAT_SCHEDULE.update(
{
"run_wifi_client_checks": {
"task": "openwisp_monitoring.check.tasks.run_wifi_client_checks",
# Run check every 5 minutes
"schedule": timedelta(minutes=5),
"relative": True,
},
}
)
You can also :doc:`add the WiFi Client check
<device-checks-and-alert-settings>` directly from the device page.

You can use the
:ref:`openwisp_monitoring_wifi_client_check_snooze_schedule` setting to
disable this check on specific dates, such as during scheduled
maintenance, to avoid generating unnecessary alerts.
52 changes: 52 additions & 0 deletions docs/user/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,58 @@ check when running on multiple servers. Make sure it is always greater
than the total iperf3 check time, i.e. greater than the TCP + UDP test
time. By default, it is set to **600 seconds (10 mins)**.

.. _openwisp_monitoring_auto_wifi_client_check:

``OPENWISP_MONITORING_AUTO_WIFI_CLIENT_CHECK``
----------------------------------------------

============ =========
**type**: ``bool``
**default**: ``False``
============ =========

This setting allows you to choose whether :ref:`WiFi Client
<wifi_client_check>` checks should be created automatically for newly
registered devices. It's disabled by default.

``OPENWISP_MONITORING_WIFI_CLIENT_CHECK_SNOOZE_SCHEDULE``
---------------------------------------------------------

============ ========
**type**: ``list``
**default**: ``[]``
============ ========

This setting allows you to configure date ranges when the WiFi Client
check should not be executed. The date ranges should be in the format
``(start_date, end_date)`` where both dates are in the format ``MM-DD``.
Both start date and end date are inclusive.

E.g.:

.. code-block:: python
OPENWISP_MONITORING_WIFI_CLIENT_CHECK_SNOOZE_SCHEDULE = [
# Date ranges can expand over months
("12-24", "01-05"),
# Date ranges can be single day
("01-26", "01-26"),
]
.. _openwisp_monitoring_wifi_client_check_interval:

``OPENWISP_MONITORING_WIFI_CLIENT_CHECK_INTERVAL``
--------------------------------------------------

============ =======
**type**: ``int``
**default**: ``5``
============ =======

This setting allows you to configure the WiFi Client check interval used
by :ref:`WiFi Client checks <wifi_client_check>`. By default it is set to
5 minutes.

.. _openwisp_monitoring_auto_charts:

``OPENWISP_MONITORING_AUTO_CHARTS``
Expand Down

0 comments on commit 2762e68

Please sign in to comment.