collectd(1), README: Document notifications and related plugins.

Signed-off-by: Sebastian Harl <sh@tokkee.org>
Signed-off-by: Florian Forster <octo@huhu.verplant.org>

diff --git a/README b/README
index 06650e81214aa634e187ec7198ddafd5af10073f..a16e9ec56cac30200563ad2756f24234a09fd0b1 100644 (file)
--- a/README
+++ b/README
@@ -210,9 +210,29 @@ Features
     - logfile
       Writes logmessages to a file or STDOUT/STDERR.
 
+    - perl
+      Log messages are propagated to plugins written in Perl as well.
+      See collectd-perl(5).
+
     - syslog
       Logs to the standard UNIX logging mechanism, syslog.
 
+  * Notifications can be handled by the following plugins:
+
+    - exec
+      Execute a program or script to handle the notification.
+      See collectd-exec(5).
+
+    - logfile
+      Writes the notification message to a file or STDOUT/STDERR.
+
+    - network
+      Send the notification to a remote host to handle it somehow.
+
+    - perl
+      Notifications are propagated to plugins written in Perl as well.
+      See collectd-perl(5).
+
   * Miscellaneous plugins:
 
     - uuid

diff --git a/src/collectd.pod b/src/collectd.pod
index 2a326bb6fa544d2de91ac5bb3abfc5274d76e721..b55362a3d12296161a5347ce0826fdef8a5341fd 100644 (file)
--- a/src/collectd.pod
+++ b/src/collectd.pod
@@ -89,6 +89,11 @@ C<logfile plugin> and the C<syslog plugin>. With these plugins collectd can
 provide information about issues and significant situations to the user.
 Several loglevels let you suppress uninteresting messages.
 
+Starting with version C<4.3.0> collectd has support for B<monitoring>. This is
+done by checking thresholds defined by the user. If a value is out of range, a
+notification will be dispatched to "notification plugins". See
+L<collectd.conf(5)> for more detailed information about threshold checking.
+
 Please note that some plugins, that provide other means of communicating with
 the daemon, have manpages of their own to describe their functionality in more
 detail. In particular those are L<collectd-email(5)>, L<collectd-exec(5)>,