From: Sebastian Harl <sh@tokkee.org>
Date: Wed, 13 Dec 2006 12:37:58 +0000 (+0100)
Subject: collectd{,.conf}.pod: Extended and clarified documentation of the email plugin.
X-Git-Tag: collectd-3.11.0~12
X-Git-Url: https://git.octo.it/?p=collectd.git;a=commitdiff_plain;h=e2ef3574e5ebc05c822c184f4047c0475d079f0b

collectd{,.conf}.pod: Extended and clarified documentation of the email plugin.

* Added a description of the protocol and the DS's to the manpage.
* Make clear that the group of the UNIX socket is always changed when running
  as root.

Signed-off-by: Sebastian Harl <sh@tokkee.org>
---

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index e7ebaf98..aa4799a4 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -208,7 +208,8 @@ Ignore packets that originate from this address.
 
 =item B<SocketGroup> I<Group>
 
-Change the group of the UNIX-socket after it has been created.
+If running as root change the group of the UNIX-socket after it has been 
+created. Defaults to B<collectd>.
 
 =item B<SocketPerms> I<Permissions>
 
@@ -218,7 +219,7 @@ L<chmod(1)>. Defaults to B<0770>.
 
 =item B<MaxConns> I<Number>
 
-Sets the maximum number of connections that can be handeled in parallel. Since
+Sets the maximum number of connections that can be handled in parallel. Since
 this many threads will be started immediately setting this to a very high
 value will waste valuable resources. Defaults to B<5> and will be forced to be
 at most B<16384> to prevent typos and dumb mistakes.
diff --git a/src/collectd.pod b/src/collectd.pod
index 4919f550..f5ed782c 100644
--- a/src/collectd.pod
+++ b/src/collectd.pod
@@ -188,6 +188,27 @@ not exist make sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a
 similar tool is installed and an "cpu governor" (that's kernel module) is
 loaded.
 
+=head2 email
+
+This plugin collects data indirectly by providing a UNIX socket that external
+programs can connect to. A simple line based protocol is used to communicate
+with the plugin:
+
+E-Mail type (e.g. "ham", "spam", "virus", ...) and size (bytes):
+
+  e:<type>:<size>
+
+Spam score:
+
+  s:<value>
+
+Successful spam checks (e.g. "BAYES_99", "SUBJECT_DRUG_GAP_C", ...):
+
+  c:<type1>[,<type2>,...]
+
+Each line is limited to 256 characters (including the newline character). 
+Longer lines will be ignored.
+
 =head2 mysql
 
 Requires B<mysqlclient> to be installed. It connects to the database when
@@ -334,6 +355,14 @@ The DS'es depend on the module creating the RRD files:
   DS:wcount:COUNTER:HEARTBEAT:0:U
   DS:wbytes:COUNTER:HEARTBEAT:0:U
 
+=item E-Mail count (F<email/email-I<E<lt>typeE<gt>>.rrd>)
+
+  DS:count:GAUGE:HEARTBEAT:0:U
+
+=item E-Mail size (F<email/email_size-I<E<lt>typeE<gt>>.rrd>)
+
+  DS:size:GAUGE:HEARTBEAT:0:U
+
 =item HDD Temperature (F<hddtemp-I<E<lt>majorE<gt>>-I<E<lt>minorE<gt>>.rrd>)
 
   DS:value:GAUGE:HEARTBEAT:U:U
@@ -446,6 +475,14 @@ The DS'es depend on the module creating the RRD files:
   DS:incoming:COUNTER:HEARTBEAT:0:U
   DS:outgoing:COUNTER:HEARTBEAT:0:U
 
+=item Spam score (F<email/spam_score.rrd>)
+
+  DS:score:GAUGE:HEARTBEAT:0:U
+
+=item Spam checks (F<email/spam_check-I<E<lt>typeE<gt>>.rrd>)
+
+  DS:hits:GAUGE:HEARTBEAT:0:U
+
 =item Swap usage (F<swap.rrd>)
 
   DS:used:GAUGE:HEARTBEAT:0:1099511627776