email plugin: Added some information about this plugin and it's config options to...
authorFlorian Forster <octo@crystal.wlan.home.verplant.org>
Wed, 6 Dec 2006 12:33:35 +0000 (13:33 +0100)
committerFlorian Forster <octo@crystal.wlan.home.verplant.org>
Wed, 6 Dec 2006 12:33:35 +0000 (13:33 +0100)
Also updated the README file, fixed a little indentation in `src/collectd.h'
and force the base of the `SocketPerms' to be eight (i. e. assume octal numbers
when setting the permission).

README
src/collectd.conf.pod
src/collectd.h
src/collectd.pod
src/email.c

diff --git a/README b/README
index 3665099..0fd3726 100644 (file)
--- a/README
+++ b/README
@@ -42,6 +42,9 @@ Features
     - DNS traffic
       (query types, response codes, opcodes and traffic)
 
+    - Email statistics
+      (count, traffic, spam scores and checks)
+
     - Harddisk temperatures
       (Uhm, yeah, temperature of harddisks that is ;)
 
index 3e544e1..e7ebaf9 100644 (file)
@@ -160,6 +160,31 @@ TCP-Port to connect to. Defaults to B<3551>.
 
 =back
 
+=head2 Plugin C<df>
+
+=over 4
+
+=item B<Device> I<Device>
+
+Select partitions based on the devicename.
+
+=item B<MountPoint> I<Directory>
+
+Select partitions based on the mountpoint.
+
+=item B<FSType> I<FSType>
+
+Select partitions based on the filesystem type.
+
+=item B<IgnoreSelected> I<true>|I<false>
+
+Invert the selection: If set to true, all partitions B<except> the ones that
+match any one of the criteria are collected. By default only selected
+partitions are collected if a selection is made. If no selection is conifured
+at all, B<all> partitions are selected.
+
+=back
+
 =head2 Plugin C<dns>
 
 =over 4
@@ -177,28 +202,26 @@ Ignore packets that originate from this address.
 
 =back
 
-=head2 Plugin C<df>
+=head2 Plugin C<email>
 
 =over 4
 
-=item B<Device> I<Device>
+=item B<SocketGroup> I<Group>
 
-Select partitions based on the devicename.
+Change the group of the UNIX-socket after it has been created.
 
-=item B<MountPoint> I<Directory>
+=item B<SocketPerms> I<Permissions>
 
-Select partitions based on the mountpoint.
+Change the file permissions of the UNIX-socket after it has been created. The
+permissions must be given as a numeric, octal value as you would pass to
+L<chmod(1)>. Defaults to B<0770>.
 
-=item B<FSType> I<FSType>
-
-Select partitions based on the filesystem type.
-
-=item B<IgnoreSelected> I<true>|I<false>
+=item B<MaxConns> I<Number>
 
-Invert the selection: If set to true, all partitions B<except> the ones that
-match any one of the criteria are collected. By default only selected
-partitions are collected if a selection is made. If no selection is conifured
-at all, B<all> partitions are selected.
+Sets the maximum number of connections that can be handeled 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.
 
 =back
 
index d8f74f9..2ce0a15 100644 (file)
 #define MODE_LOG    0x08
 
 #ifndef COLLECTD_GRP_NAME
-#      define COLLECTD_GRP_NAME "collectd"
+# define COLLECTD_GRP_NAME "collectd"
 #endif
 
 #ifndef COLLECTD_STEP
index b0af26d..4919f55 100644 (file)
@@ -44,6 +44,10 @@ DNS traffic (I<dns>)
 
 =item
 
+Email usage (I<email>)
+
+=item
+
 Harddisk temperatures (I<hddtemp>)
 
 =item
index 9fd05ba..58d94d1 100644 (file)
@@ -211,7 +211,7 @@ static int email_config (char *key, char *value)
        }
        else if (0 == strcasecmp (key, "SocketPerms")) {
                /* the user is responsible for providing reasonable values */
-               sock_perms = (int)strtol (value, NULL, 0);
+               sock_perms = (int)strtol (value, NULL, 8);
        }
        else if (0 == strcasecmp (key, "MaxConns")) {
                long int tmp = strtol (value, NULL, 0);