diff options
Diffstat (limited to 'docs/aoa/folders.rst')
-rw-r--r-- | docs/aoa/folders.rst | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/aoa/folders.rst b/docs/aoa/folders.rst new file mode 100644 index 00000000..5f78e496 --- /dev/null +++ b/docs/aoa/folders.rst @@ -0,0 +1,34 @@ +.. _folders: + +Folders +======= + +The folders plugin allows user, through the configuration file, to +monitor size of a predefined folders list. + +.. image:: ../_static/folders.png + +Each item is defined by: + +- ``path``: absolute path to monitor (mandatory) +- ``careful``: optional careful threshold (in MB) +- ``warning``: optional warning threshold (in MB) +- ``critical``: optional critical threshold (in MB) + +Up to ``10`` items can be defined. + +For example, if you want to monitor the ``/tmp`` folder, the following +definition should do the job: + +.. code-block:: ini + + [folders] + folder_1_path=/tmp + folder_1_careful=2500 + folder_1_warning=3000 + folder_1_critical=3500 + +In client/server mode, the list is defined on the ``server`` side. + +.. warning:: + Do **NOT** define folders containing lot of files and subfolders. |