Merge branch 'ff/plugins-ng' of octo@verplant.org:/var/lib/git/collectd into ff/plugi...

[collectd.git] / src / collectd.conf.pod

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 3e544e11b2cc87ee63a34cbdb3b16aba48aa0514..5c8de4fb094a40261660e8657e42c7b5a95ac4f4 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -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,27 @@ Ignore packets that originate from this address.
 
 =back
 
-=head2 Plugin C<df>
+=head2 Plugin C<email>
 
 =over 4
 
-=item B<Device> I<Device>
-
-Select partitions based on the devicename.
-
-=item B<MountPoint> I<Directory>
+=item B<SocketGroup> I<Group>
 
-Select partitions based on the mountpoint.
+If running as root change the group of the UNIX-socket after it has been 
+created. Defaults to B<collectd>.
 
-=item B<FSType> I<FSType>
+=item B<SocketPerms> I<Permissions>
 
-Select partitions based on the filesystem type.
+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<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 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.
 
 =back
 
@@ -216,6 +240,20 @@ TCP-Port to connect to. Defaults to B<7634>.
 
 =back
 
+=head2 Plugin C<mbmon>
+
+=over 4
+
+=item B<Host> I<Hostname>
+
+Hostname to connect to. Defaults to B<127.0.0.1>.
+
+=item B<Port> I<Port>
+
+TCP-Port to connect to. Defaults to B<411>.
+
+=back
+
 =head2 Plugin C<ntpd>
 
 =over 4
@@ -268,6 +306,20 @@ Sets the Time-To-Live of generated ICMP packets.
 
 =back
 
+=head2 Plugin C<rrdtool>
+
+=over 4
+
+=item B<CacheTimeout> I<Seconds>
+
+If this option is set to a value greater than zero, the C<rrdtool>-plugin will
+write values every I<Seconds> seconds to the RRD-files. Writing multiple values
+at once reduces IO-operations and thus lessens the load produced by updating
+the files. The tradeoff is that the graphs kind of "drag behind" and that more
+memory is used.
+
+=back
+
 =head2 Plugin C<sensors>
 
 =over 4