[CPCLOUD-2743] Add documentation

plesk · Jan 13, 2025 · 95d1411 · 95d1411
1 parent e997045
commit 95d1411
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 2 deletions.
diff --git 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
@@ -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
@@ -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