Code

Merge branch 'collectd-4.0' into collectd-4.1
[collectd.git] / src / collectd.conf.pod
1 =head1 NAME
3 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
5 =head1 SYNOPSIS
7   BaseDir "/path/to/data/"
8   PIDFile "/path/to/pidfile/collectd.pid"
9   Server  "123.123.123.123" 12345
11   LoadPlugin cpu
12   LoadPlugin load
13   LoadPlugin ping
15   <Plugin ping>
16     Host "example.org"
17     Host "provider.net"
18   </Plugin>
20 =head1 DESCRIPTION
22 This config file controls how the system statistics collection daemon
23 B<collectd> behaves. The most significant option is B<LoadPlugin>, which
24 controls which plugins to load. These plugins ultimately define collectd's
25 behavior.
27 The syntax of this config file is similar to the config file of the famos
28 B<Apache Webserver>. Each line contains either a key-value-pair or a
29 section-start or -end. Empty lines and everything after the hash-symbol `#' is
30 ignored. Values are either string, enclosed in double-quotes,
31 (floating-point-)numbers or a boolean expression, i.E<nbsp>e. either B<true> or
32 B<false>. String containing of only alphanumeric characters and underscores do
33 not need to be quoted.
35 =head1 GLOBAL OPTIONS
37 =over 4
39 =item B<BaseDir> I<Directory>
41 Sets the base directory. This is the directory beneath all RRD-files are
42 created. Possibly more subdirectories are created. This is also the working
43 directory for the daemon.
45 =item B<LoadPlugin> I<Plugin>
47 Loads the plugin I<Plugin>. There must be at least one such line or B<collectd>
48 will be mostly useless.
50 =item B<PIDFile> I<File>
52 Sets where to write the PID file to. This file is overwritten when it exists
53 and deleted when the program is stopped. Some init-scripts might override this
54 setting using the B<-P> command-line option.
56 =item B<PluginDir> I<Directory>
58 Path to the plugins (shared objects) of collectd.
60 =item B<TypesDB> I<File>
62 Set the file that contains the data-set descriptions.
64 =item B<Interval> I<Seconds>
66 Configures the interval in which to query the read plugins. Obviously smaller
67 values lead to a higher system load produces by collectd, while higher values
68 lead to more coarse statistics.
70 =item B<ReadThreads> I<Num>
72 Number of threads to start for reading plugins. The default value if B<5>, but
73 you may want to increase this if you have more than five plugins that take a
74 long time to read. Mostly those are plugin that do network-IO. Setting this to
75 a value higher than the number of plugins you've loaded is totally useless.
77 =back
79 =head1 PLUGIN OPTIONS
81 Some plugins may register own options. These options must be enclosed in a
82 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
83 require external configuration, too. The C<apache plugin>, for example,
84 required C<mod_status> to be configured in the webserver you're going to
85 collect data from. These plugins are listed below as well, even if they don't
86 require any configuration within collectd's configfile.
88 A list of all plugins and a short summary for each plugin can be found in the
89 F<README> file shipped with the sourcecode and hopefully binary packets as
90 well.
92 =head2 Plugin C<apache>
94 To configure the C<apache>-plugin you first need to configure the Apache
95 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
96 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
97 the following snipped to base your Apache config upon:
99   ExtendedStatus on
100   <IfModule mod_status.c>
101     <Location /mod_status>
102       SetHandler server-status
103     </Location>
104   </IfModule>
106 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
107 also supported. It introduces a new field, called C<BusyServers>, to count the
108 number of currently connected clients. This field is also supported.
110 The following options are accepted by the C<apache>-plugin:
112 =over 4
114 =item B<URL> I<http://host/mod_status?auto>
116 Sets the URL of the C<mod_status> output. This needs to be the output generated
117 by C<ExtendedStatus on> and it needs to be the machine readable output
118 generated by appending the C<?auto> argument.
120 =item B<User> I<Username>
122 Optional user name needed for authentication.
124 =item B<Password> I<Password>
126 Optional password needed for authentication.
128 =item B<CACert> I<File>
130 File that holds one or more SSL certificates. If you want to use HTTPS you will
131 possibly need this option. What CA certificates come bundled with C<libcurl>
132 and are checked by default depends on the distribution you use.
134 =back
136 =head2 Plugin C<apcups>
138 =over 4
140 =item B<Host> I<Hostname>
142 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
143 that IPv6 support has been disabled unless someone can confirm or decline that
144 B<apcupsd> can handle it.
146 =item B<Port> I<Port>
148 TCP-Port to connect to. Defaults to B<3551>.
150 =back
152 =head2 Plugin C<cpufreq>
154 This plugin doesn't have any options. It reads
155 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
156 installed) to get the current CPU frequency. If this file does not exist make
157 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
158 installed and an "cpu governor" (that's a kernel module) is loaded.
160 =head2 Plugin C<csv>
162 =over 4
164 =item B<DataDir> I<Directory>
166 Set the directory to store RRD-files under. Per default RRD-files are generated
167 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
169 =back
171 =head2 Plugin C<df>
173 =over 4
175 =item B<Device> I<Device>
177 Select partitions based on the devicename.
179 =item B<MountPoint> I<Directory>
181 Select partitions based on the mountpoint.
183 =item B<FSType> I<FSType>
185 Select partitions based on the filesystem type.
187 =item B<IgnoreSelected> I<true>|I<false>
189 Invert the selection: If set to true, all partitions B<except> the ones that
190 match any one of the criteria are collected. By default only selected
191 partitions are collected if a selection is made. If no selection is configured
192 at all, B<all> partitions are selected.
194 =back
196 =head2 Plugin C<dns>
198 =over 4
200 =item B<Interface> I<Interface>
202 The dns plugin uses B<libpcap> to capture dns traffic and analyses it. This
203 option sets the interface that should be used. If this option is not set, or
204 set to "any", the plugin will try to get packets from B<all> interfaces. This
205 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
207 =item B<IgnoreSource> I<IP-address>
209 Ignore packets that originate from this address.
211 =back
213 =head2 Plugin C<email>
215 =over 4
217 =item B<SocketFile> I<Path>
219 Sets the socket-file which is to be created.
221 =item B<SocketGroup> I<Group>
223 If running as root change the group of the UNIX-socket after it has been 
224 created. Defaults to B<collectd>.
226 =item B<SocketPerms> I<Permissions>
228 Change the file permissions of the UNIX-socket after it has been created. The
229 permissions must be given as a numeric, octal value as you would pass to
230 L<chmod(1)>. Defaults to B<0770>.
232 =item B<MaxConns> I<Number>
234 Sets the maximum number of connections that can be handled in parallel. Since
235 this many threads will be started immediately setting this to a very high
236 value will waste valuable resources. Defaults to B<5> and will be forced to be
237 at most B<16384> to prevent typos and dumb mistakes.
239 =back
241 =head2 Plugin C<exec>
243 Please make sure to read L<collectd-exec(5)> before using this plugin. It
244 contains valuable information on when the executable is executed and the
245 output that is expected from it.
247 =over 4
249 =item B<Exec> I<User>[:[I<Group>]] I<Executable>
251 Execute the executable I<Executable> as user I<User>. If the user name is
252 followed by a colon and a group name, the effective group is set to that group.
253 The real group and saved-set group will be set to the default group of that
254 user. If no group is given the effective group ID will be the same as the real
255 group ID.
257 Please note that in order to change the user and/or group the daemon needs
258 superuser privileges. If the daemon is run as an unprivileged user you must
259 specify the same user/group here. If the daemon is run with superuser
260 privileges, you must supply a non-root user here.
262 =back
264 =head2 Plugin C<hddtemp>
266 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
267 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
268 default values, see below. C<hddtemp> has to be running to work correctly. If
269 C<hddtemp> is not running timeouts may appear which may interfere with other
270 statistics..
272 The B<hddtemp> homepage can be found at
273 L<http://www.guzu.net/linux/hddtemp.php>.
275 =over 4
277 =item B<Host> I<Hostname>
279 Hostname to connect to. Defaults to B<127.0.0.1>.
281 =item B<Port> I<Port>
283 TCP-Port to connect to. Defaults to B<7634>.
285 =back
287 =head2 Plugin C<interface>
289 =over 4
291 =item B<Interface> I<Interface>
293 Select this interface. By default these interfaces will then be collected. For
294 a more detailed description see B<IgnoreSelected> below.
296 =item B<IgnoreSelected> I<true>|I<false>
298 If no configuration if given, the B<traffic>-plugin will collect data from
299 all interfaces. This may not be practical, especially for loopback- and
300 similar interfaces. Thus, you can use the B<Interface>-option to pick the
301 interfaces you're interested in. Sometimes, however, it's easier/preferred
302 to collect all interfaces I<except> a few ones. This option enables you to
303 do that: By setting B<IgnoreSelected> to I<true> the effect of
304 B<Interface> is inversed: All selected interfaces are ignored and all
305 other interfaces are collected.
307 =back
309 =head2 Plugin C<iptables>
311 =over 4
313 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
315 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
316 will collect the counters of all rules which have a comment-match. The comment
317 is then used as type-instance.
319 If I<Comment> or I<Number> is given, only the rule with the matching comment or
320 the I<n>th rule will be collected. Again, the comment (or the number) will be
321 used as the type-instance.
323 If I<Name> is supplied, it will be used as the type-instance instead of the
324 comment or the number.
326 =back
328 =head2 Plugin C<irq>
330 =over 4
332 =item B<Irq> I<Irq>
334 Select this irq. By default these irqs will then be collected. For a more
335 detailed description see B<IgnoreSelected> below.
337 =item B<IgnoreSelected> I<true>|I<false>
339 If no configuration if given, the B<irq>-plugin will collect data from all
340 irqs. This may not be practical, especially if no interrupts happen. Thus, you
341 can use the B<Irq>-option to pick the interrupt you're interested in.
342 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
343 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
344 I<true> the effect of B<Irq> is inversed: All selected interrupts are ignored
345 and all other interrupts are collected.
347 =back
349 =head2 Plugin C<logfile>
351 =over 4
353 =item B<LogLevel> B<debug|info|notice|warning|err>
355 Sets the log-level. If, for example, set to B<notice>, then all events with
356 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
358 =item B<File> I<File>
360 Sets the file to write log messages to. The special strings B<stdout> and
361 B<stderr> can be used to write to the standard output and standard error
362 channels, respectively. This, of course, only makes much sense when collectd is
363 running in foreground- or non-daemon-mode.
365 =back
367 =head2 Plugin C<mbmon>
369 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
371 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>.  The
372 B<Host> and B<Port> options can be used to change these values, see below.
373 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
374 timeouts may appear which may interfere with other statistics..
376 C<mbmon> must be run with the -r option ("print TAG and Value format");
377 Debian's F</etc/init.d/mbmon> script already does this, other people
378 will need to ensure that this is the case.
380 =over 4
382 =item B<Host> I<Hostname>
384 Hostname to connect to. Defaults to B<127.0.0.1>.
386 =item B<Port> I<Port>
388 TCP-Port to connect to. Defaults to B<411>.
390 =back
392 =head2 Plugin C<mysql>
394 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to the
395 database when started and keeps the connection up as long as possible. When the
396 connection is interrupted for whatever reason it will try to re-connect. The
397 plugin logs loud complaints in case anything goes wrong.
399 This plugin issues C<SHOW STATUS> and evaluates C<Bytes_{received,sent}>,
400 C<Com_*> and C<Handler_*> which correspond to F<mysql_octets.rrd>,
401 F<mysql_commands-*.rrd> and F<mysql_handler-*.rrd>. Also, the values of
402 C<Qcache_*> are put in F<mysql_qcache.rrd> and values of C<Threads_*> are put
403 in F<mysql_threads.rrd>. Please refer to the B<MySQL reference manual>,
404 I<5.2.4. Server Status Variables> for an explanation of these values.
406 Use the following options to configure the plugin:
408 =over 4
410 =item B<Host> I<Hostname>
412 Hostname of the database server. Defaults to B<localhost>.
414 =item B<User> I<Username>
416 Username to use when connecting to the database.
418 =item B<Password> I<Password>
420 Password needed to log into the database.
422 =item B<Database> I<Database>
424 Select this database. Defaults to I<no database> which is a perfectly reasonable
425 option for what this plugin does.
427 =back
429 =head2 Plugin C<netlink>
431 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
432 statistics of various interface and routing aspects.
434 =over 4
436 =item B<Interface> I<Interface>
438 =item B<VerboseInterface> I<Interface>
440 Instruct the plugin to collect interface statistics. This is basically the same
441 as the statistics provided by the C<interface> plugin (see above) but
442 potentially much more detailed.
444 When configuring with B<Interface> only the basic statistics will be collected,
445 namely octets, packets, and errors. These statistics are collected by
446 the C<interface> plugin, too, so using both at the same time is no benefit.
448 When configured with B<VerboseInterface> all counters B<except> the basic ones,
449 so that no data needs to be collected twice if you use the C<interface> plugin.
450 This includes dropped packets, received multicast packets, collisions and a
451 whole zoo of differentiated RX and TX errors. You can try the following command
452 to get an idea of what awaits you:
454   ip -s -s link list
456 If I<Interface> is B<All>, all interfaces will be selected.
458 =item B<QDisc> I<Interface> [I<QDisc>]
460 =item B<Class> I<Interface> [I<Class>]
462 =item B<Filter> I<Interface> [I<Filter>]
464 Collect the octets and packets that pass a certain qdisc, class or filter.
466 QDiscs and classes are identified by their type and handle (or classid).
467 Filters don't necessarily have a handle, therefore the parent's handle is used.
468 The notation used in collectd differs from that used in tc(1) in that it
469 doesn't skip the major or minor number if it's zero and doesn't print special
470 ids by their name.  So, for example, a qdisc may be identified by
471 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
472 thus not displayed by tc(1).
474 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
475 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
476 associated with that interface will be collected.
478 Since a filter itself doesn't necessarily have a handle, the parent's handle is
479 used. This may lead to problems when more than one filter is attached to a
480 qdisc or class. This isn't nice, but we don't know how this could be done any
481 better. If you have a idea, please don't hesitate to tell us.
483 As with the B<Interface> option you can specify B<All> as the interface,
484 meaning all interfaces.
486 Here are some examples to help you understand the above text more easily:
488   <Plugin netlink>
489     VerboseInterface "All"
490     QDisc "eth0" "pfifo_fast-1:0"
491     QDisc "ppp0"
492     Class "ppp0" "htb-1:10"
493     Filter "ppp0" "u32-1:0"
494   </Plugin>
496 =item B<IgnoreSelected>
498 The behaviour is the same as with all other similar plugins: If nothing is
499 selected at all, everything is collected. If some things are selected using the
500 options described above, only these statistics are collected. If you set
501 B<IgnoreSelected> to B<true>, this behavior is inversed, i.E<nbsp>e. the
502 specified statistics will not be collected.
504 =back
506 =head2 Plugin C<network>
508 =over 4
510 =item B<Listen> I<Host> [I<Port>]
512 =item B<Server> I<Host> [I<Port>]
514 The B<Server> statement sets the server to send datagrams B<to>.  The statement
515 may occur multiple times to send each datagram to multiple destinations.
517 The B<Listen> statement sets the interfaces to bind to. When multiple
518 statements are found the daemon will bind to multiple interfaces.
520 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
521 the argument is a multicast address the daemon will join that multicast group.
523 If no B<Listen> statement is found the server tries join both, the default IPv6
524 multicast group and the default IPv4 multicast group. If no B<Server> statement
525 is found the client will try to send data to the IPv6 multicast group first. If
526 that fails the client will try the IPv4 multicast group.
528 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
529 multicast group is C<239.192.74.66>.
531 The optional I<Port> argument sets the port to use. It can either be given
532 using a numeric port number or a service name. If the argument is omitted the
533 default port B<25826> is assumed.
535 =item B<TimeToLive> I<1-255>
537 Set the time-to-live of sent packets. This applies to all, unicast and
538 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
539 That means that multicast packets will be sent with a TTL of C<1> (one) on most
540 operating systems.
542 =item B<Forward> I<true|false>
544 If set to I<true>, write packets that were received via the network plugin to
545 the sending sockets. This should only be activated when the B<Listen>- and
546 B<Server>-statements differ. Otherwise packets may be send multiple times to
547 the same multicast group. While this results in more network traffic than
548 necessary it's not a huge problem since the plugin has a duplicate detection,
549 so the values will not loop.
551 =item B<CacheFlush> I<Seconds>
553 For each host/plugin/type combination the C<network plugin> caches the time of
554 the last value being sent or received. Every I<Seconds> seconds the plugin
555 searches and removes all entries that are older than I<Seconds> seconds, thus
556 freeing the unused memory again. Since this process is somewhat expensive and
557 normally doesn't do much, this value should not be too small. The default is
558 1800 seconds, but setting this to 86400 seconds (one day) will not do much harm
559 either.
561 =back
563 =head2 Plugin C<ntpd>
565 =over 4
567 =item B<Host> I<Hostname>
569 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
571 =item B<Port> I<Port>
573 UDP-Port to connect to. Defaults to B<123>.
575 =back
577 =head2 Plugin C<nut>
579 =over 4
581 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
583 Add a UPS to collect data from. The format is identical to the one accepted by
584 L<upsc(8)>.
586 =back
588 =head2 Plugin C<perl>
590 =over 4
592 =item B<LoadPlugin> I<Plugin>
594 Loads the Perl plugin I<Plugin>. This does basically the same as B<use> would
595 do in a Perl program.
597 =item B<BaseName> I<Name>
599 Prepends I<Name>B<::> to all plugin names loaded after this option. This is
600 provided for convenience to keep plugin names short.
602 =item B<IncludeDir> I<Dir>
604 Adds I<Dir> to the B<@INC> array. This is the same as using the B<-IDir>
605 command line option or B<use lib Dir> in the source code.
607 =back
609 =head2 Plugin C<ping>
611 =over 4
613 =item B<Host> I<IP-address>
615 Host to ping periodically. This option may be repeated several times to ping
616 multiple hosts.
618 =item B<TTL> I<0-255>
620 Sets the Time-To-Live of generated ICMP packets.
622 =back
624 =head2 Plugin C<processes>
626 =over 4
628 =item B<Process> I<Name>
630 Select more detailed statistics of processes matching this name. The statistics
631 collected for these selected processes are size of the resident segment size
632 (RSS), user- and system-time used, number of processes and number of threads,
633 and minor and major pagefaults.
635 =back
637 =head2 Plugin C<rrdtool>
639 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
640 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
641 using these settings. If you don't want to dive into the depths of RRDTool, you
642 can safely ignore these settings.
644 =over 4
646 =item B<DataDir> I<Directory>
648 Set the directory to store RRD-files under. Per default RRD-files are generated
649 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
651 =item B<StepSize> I<Seconds>
653 Sets the stepsize of newly created RRD-files. Ideally (and per default) this
654 setting is identical to the global B<Interval>-option and should not be
655 smaller. If unsure, don't set this option.
657 =item B<HeartBeat> I<Seconds>
659 Sets the heartbeat of newly created RRD-files. Ideally this setting is bigger
660 than the B<Interval>-setting, by default it's twice the B<Interval>-setting. If
661 unsure, don't set this option.
663 =item B<RRARows> I<NumRows>
665 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
666 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
667 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
668 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
669 week, one month, and one year.
671 So for each timespan, it calculates how many PDPs need to be consolidated into
672 one CDP by calculating:
673   number of PDPs = timespan / (stepsize * rrarows)
675 Bottom line is, set this no smaller than the width of you graphs in pixels. The
676 default is 1200.
678 =item B<RRATimespan> I<Seconds>
680 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
681 more then one RRA. If this option is never used, the built-in default of (3600,
682 86400, 604800, 2678400, 31622400) is used.
684 For more information on how RRA-sizes are calculated see B<RRARows> above.
686 =item B<XFF> I<Factor>
688 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
690 =item B<CacheFlush> I<Seconds>
692 When the C<rrdtool plugin> uses a cache (by setting B<CacheTimeout>, see below)
693 it writes all values for a certain RRD-file if the oldest value is older than
694 (or equal to) the number of seconds specified. If some RRD-file is not updated
695 anymore for some reason (the computer was shut down, the network is broken,
696 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
697 entire cache is searched for entries older than B<CacheTimeout> seconds and
698 written to disk every I<Seconds> seconds. Since this is kind of expensive and
699 does nothing under normal circumstances, this value should not be too small.
700 900 seconds might be a good value, though setting this to 7200 seconds doesn't
701 normally do much harm either.
703 =item B<CacheTimeout> I<Seconds>
705 If this option is set to a value greater than zero, the C<rrdtool plugin> will
706 save values in a cache, as described above. Writing multiple values at once
707 reduces IO-operations and thus lessens the load produced by updating the files.
708 The trade off is that the graphs kind of "drag behind" and that more memory is
709 used.
711 =back
713 =head2 Plugin C<sensors>
715 The C<sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
716 that all the needed modules have to be loaded and lm_sensors has to be
717 configured (most likely by editing F</etc/sensors.conf>. Read
718 L<sensors.conf(5)> for details.
720 The B<lm_sensors> homepage can be found at
721 L<http://secure.netroedge.com/~lm78/>.
723 =over 4
725 =item B<Sensor> I<chip-bus-address/type-feature>
727 Selects the name of the sensor which you want to collect or ignore, depending
728 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
729 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
730 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
732 =item B<IgnoreSelected> I<true>|I<false>
734 If no configuration if given, the B<sensors>-plugin will collect data from all
735 sensors. This may not be practical, especially for uninteresting sensors.
736 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
737 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
738 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
739 I<true> the effect of B<Sensor> is inversed: All selected sensors are ignored
740 and all other sensors are collected.
742 =back
744 =head2 Plugin C<snmp>
746 Since the configuration of the C<snmp plugin> is a little more complicated than
747 other plugins, its documentation has been moved to an own manpage,
748 L<collectd-snmp(5)>. Please see there for details.
750 =head2 Plugin C<syslog>
752 =over 4
754 =item B<LogLevel> B<debug|info|notice|warning|err>
756 Sets the log-level. If, for example, set to B<notice>, then all events with
757 severity B<notice>, B<warning>, or B<err> will be submitted to the
758 syslog-daemon.
760 =back
762 =head2 Plugin C<unixsock>
764 =over 4
766 =item B<SocketFile> I<Path>
768 Sets the socket-file which is to be created.
770 =item B<SocketGroup> I<Group>
772 If running as root change the group of the UNIX-socket after it has been 
773 created. Defaults to B<collectd>.
775 =item B<SocketPerms> I<Permissions>
777 Change the file permissions of the UNIX-socket after it has been created. The
778 permissions must be given as a numeric, octal value as you would pass to
779 L<chmod(1)>. Defaults to B<0770>.
781 =back
783 =head2 Plugin C<vserver>
785 This plugin doesn't have any options. B<VServer> support is only available for
786 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
787 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
788 need to apply the patches and compile your own kernel, which will then provide
789 the F</proc/virtual> filesystem that is required by this plugin.
791 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
793 =head1 SEE ALSO
795 L<collectd(1)>,
796 L<collectd-exec(5)>,
797 L<collectd-unixsock(5)>,
798 L<hddtemp(8)>,
799 L<kstat(3KSTAT)>,
800 L<mbmon(1)>,
801 L<rrdtool(1)>,
802 L<sensors(1)>
804 =head1 AUTHOR
806 Florian Forster E<lt>octo@verplant.orgE<gt>
808 =cut