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