X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=cffb7ad3ad31a1d1820b50bd9b6e2233ca3a03a1;hb=863dfcdf274509e4e1836c2c8f1f10f09e1d13be;hp=f3e2585659504f26af3d335bf37e0bacf659726d;hpb=533dba5626961fae399a4523837bdf7523692e78;p=collectd.git

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index f3e25856..cffb7ad3 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -49,7 +49,8 @@ will be mostly useless. The names of the plugins are listed in L<collectd(1)>.
 =item B<PIDFile> I<File>
 
 Sets where to write the PID file to. This file is overwritten when it exists
-and deleted when the program ist stopped. Available in B<all modes>.
+and deleted when the program ist stopped. Some init-scripts might override this
+setting using the B<-P> commandline option. Available in B<all modes>.
 
 =item B<DataDir> I<Directory>
 
@@ -159,6 +160,72 @@ 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
+
+=item B<Interface> I<Interface>
+
+The dns plugin uses B<libpcap> to capture dns traffic and analyses it. This
+option sets the interface that should be used. If this option is not set, or
+set to "any", the plugin will try to get packets from B<all> interfaces. This
+may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
+
+=item B<IgnoreSource> I<IP-address>
+
+Ignore packets that originate from this address.
+
+=back
+
+=head2 Plugin C<email>
+
+=over 4
+
+=item B<SocketGroup> I<Group>
+
+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>
+
+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<MaxConns> I<Number>
+
+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
+
 =head2 Plugin C<hddtemp>
 
 =over 4
@@ -173,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
@@ -225,6 +306,68 @@ Sets the Time-To-Live of generated ICMP packets.
 
 =back
 
+=head2 Plugin C<sensors>
+
+=over 4
+
+=item B<ExtendedSensorNaming> I<true>|I<false>
+
+If set to I<true> this option switches on the extended sensors and RRD-files
+naming. This option exists to preserve backwards compatibility. It is
+recommended that you set this option to I<true>. The default is I<false> to
+maintain compatibility only.
+
+Sensors get names like I<chip-bus-address/type-feature> (e.g.
+I<it8712-isa-0290/voltage-in1>) and RRD files are therefore stored in a
+standalone directory inside the B<DataDir> directory and get names like
+I<lm_sensors-chip-bus-address/type-feature.rrd> (e.g.
+I<lm_sensors-it8712-isa-0290/voltage-in1.rrd>).
+
+The B<ExtendedSensorNaming> option breaks the compatibility with previous
+sensors and RRD files naming and the place where RRDs are stored. If you turn
+it on, the plugin will create new RRD files in a standalone directory inside
+the B<DataDir> directory and without previous history. You can rename ``old''
+RRD-files to preserve already collected statistics, because the file layout
+hasn't changed. If you have two chips of the same type, you need to use
+B<ExtendedSensorNaming> in order to collect information from both chips.
+
+If not set or set to I<false>, the extended naming is not active. Sensors get
+names like I<chip-feature> (e.g. I<it8712-in1>) and RRD files are stored in the
+main B<DataDir> directory and get names like I<sensors-chip-feature.rrd> (e.g.
+I<sensors-it8712-in1.rrd>).  You simply continue using the plugin the old way
+and additionally also getting data for newly added sensors in this mode.
+
+=item B<Sensor> I<chip-feature> or B<Sensor> I<chip-bus-address/type-feature>
+
+Both option modes select the name of the sensor which you want to collect.
+The naming scheme is dependent on the state of the B<ExtendedSensorNaming>
+option (see previous option). Both option modes can also deselect the
+sensor according to the B<IgnoreSelected> option (see below).
+
+For example the option "B<Sensor> I<it8712-in1>" will cause the collectd
+to gather data for the voltage sensor I<in1> of the I<it8712> chip in case
+of the B<ExtendedSensorNaming> option is set to I<false>.
+
+And likewise the option "B<Sensor> I<it8712-isa-0290/voltage-in1>" will
+cause the collectd to gather data for the voltage sensor I<in1> of the I<it8712>
+on the isa bus at the address 0290 in case of the B<ExtendedSensorNaming>
+option set to I<true>.
+
+=item B<IgnoreSelected> I<true>|I<false>
+
+If no configuration if given, the B<sensors>-plugin will collect data from
+all sensors. This may not be practical, especially for uninteresting sensors.
+Thus, you can use the B<Sensor>-option to pick the sensors you're
+interested in. Sometimes, however, it's easier/prefered to collect all
+sensors I<except> a few ones. This option enables you to
+do that: By setting B<IgnoreSelected> to I<true> the effect of
+B<Sensor> is inversed: All selected sensors are ignored and all
+other sensors are collected.
+
+back
+
+=back
+
 =head2 Plugin C<traffic>
 
 =over 4