From 95d1411a4ae1d87a8eab22c128e58b6db0da926d Mon Sep 17 00:00:00 2001
From: skafandri <kooli.ilyes@gmail.com>
Date: Mon, 13 Jan 2025 10:28:34 +0100
Subject: [PATCH] [CPCLOUD-2743] Add documentation

---
 agent360/plugins/diskusage.py | 9 +++++++++
 agent360/plugins/dovecot.py   | 2 +-
 agent360/plugins/postfix.py   | 2 +-
 3 files changed, 11 insertions(+), 2 deletions(-)

diff --git a/agent360/plugins/diskusage.py b/agent360/plugins/diskusage.py
index 1f9fb24..2478a16 100755
--- a/agent360/plugins/diskusage.py
+++ b/agent360/plugins/diskusage.py
@@ -11,6 +11,15 @@ class Plugin(plugins.BasePlugin):
 
 
     def run(self, config):
+        '''
+        Returns disk partitions usage statistics.
+
+        Example config for /etc/agent360.ini:
+        [diskusage]
+        enabled = yes
+        exclude = /dev/loop,/dev/snap,/squashfs,/cagefs-skeleton
+        '''
+
         disk = {}
         disk['df-psutil'] = []
 
diff --git a/agent360/plugins/dovecot.py b/agent360/plugins/dovecot.py
index 7c35c5e..0584959 100644
--- a/agent360/plugins/dovecot.py
+++ b/agent360/plugins/dovecot.py
@@ -13,7 +13,7 @@ def run(self, config):
         Returns active dovecot IMAP and POP3 session and the current version.
         Sudo permission to acces doveadm and dovecot commands are required.
 
-        Exampel config for /etc/agent360.ini:
+        Example config for /etc/agent360.ini:
         [dovecot]
         enabled = yes
         '''
diff --git a/agent360/plugins/postfix.py b/agent360/plugins/postfix.py
index 0bc527d..6b9a880 100644
--- a/agent360/plugins/postfix.py
+++ b/agent360/plugins/postfix.py
@@ -13,7 +13,7 @@ def run(self, config):
         Monitoring of the Postfix MTA log and optionally the Postfix version and the mailqueue
         Dependency: Pflogsumm log analyzer, sudo access
 
-        Exampel config for /etc/agent360.ini:
+        Example config for /etc/agent360.ini:
         [postfix]
         enabled = yes
         log = /var/log/mail.log