3ff24bbb08f8bb95c0afe13c958fa2265197d8c3
[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 Please note that B<debug> is only available if collectd has been compiled with
365 debugging support.
366
367 =item B<File> I<File>
368
369 Sets the file to write log messages to. The special strings B<stdout> and
370 B<stderr> can be used to write to the standard output and standard error
371 channels, respectively. This, of course, only makes much sense when collectd is
372 running in foreground- or non-daemon-mode.
373
374 =back
375
376 =head2 Plugin C<mbmon>
377
378 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
379
380 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>.  The
381 B<Host> and B<Port> options can be used to change these values, see below.
382 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
383 timeouts may appear which may interfere with other statistics..
384
385 C<mbmon> must be run with the -r option ("print TAG and Value format");
386 Debian's F</etc/init.d/mbmon> script already does this, other people
387 will need to ensure that this is the case.
388
389 =over 4
390
391 =item B<Host> I<Hostname>
392
393 Hostname to connect to. Defaults to B<127.0.0.1>.
394
395 =item B<Port> I<Port>
396
397 TCP-Port to connect to. Defaults to B<411>.
398
399 =back
400
401 =head2 Plugin C<mysql>
402
403 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to the
404 database when started and keeps the connection up as long as possible. When the
405 connection is interrupted for whatever reason it will try to re-connect. The
406 plugin will complaint loudly in case anything goes wrong.
407
408 This plugin issues C<SHOW STATUS> and evaluates C<Bytes_{received,sent}>,
409 C<Com_*> and C<Handler_*> which correspond to F<mysql_octets.rrd>,
410 F<mysql_commands-*.rrd> and F<mysql_handler-*.rrd>. Also, the values of
411 C<Qcache_*> are put in F<mysql_qcache.rrd> and values of C<Threads_*> are put
412 in F<mysql_threads.rrd>. Please refer to the B<MySQL reference manual>,
413 I<5.2.4. Server Status Variables> for an explanation of these values.
414
415 Use the following options to configure the plugin:
416
417 =over 4
418
419 =item B<Host> I<Hostname>
420
421 Hostname of the database server. Defaults to B<localhost>.
422
423 =item B<User> I<Username>
424
425 Username to use when connecting to the database.
426
427 =item B<Password> I<Password>
428
429 Password needed to log into the database.
430
431 =item B<Database> I<Database>
432
433 Select this database. Defaults to I<no database> which is a perfectly reasonable
434 option for what this plugin does.
435
436 =back
437
438 =head2 Plugin C<netlink>
439
440 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
441 statistics of various interface and routing aspects.
442
443 =over 4
444
445 =item B<Interface> I<Interface>
446
447 =item B<VerboseInterface> I<Interface>
448
449 Instruct the plugin to collect interface statistics. This is basically the same
450 as the statistics provided by the C<interface> plugin (see above) but
451 potentially much more detailed.
452
453 When configuring with B<Interface> only the basic statistics will be collected,
454 namely octets, packets, and errors. These statistics are collected by
455 the C<interface> plugin, too, so using both at the same time is no benefit.
456
457 When configured with B<VerboseInterface> all counters B<except> the basic ones,
458 so that no data needs to be collected twice if you use the C<interface> plugin.
459 This includes dropped packets, received multicast packets, collisions and a
460 whole zoo of differentiated RX and TX errors. You can try the following command
461 to get an idea of what awaits you:
462
463   ip -s -s link list
464
465 If I<Interface> is B<All>, all interfaces will be selected.
466
467 =item B<QDisc> I<Interface> [I<QDisc>]
468
469 =item B<Class> I<Interface> [I<Class>]
470
471 =item B<Filter> I<Interface> [I<Filter>]
472
473 Collect the octets and packets that pass a certain qdisc, class or filter.
474
475 QDiscs and classes are identified by their type and handle (or classid).
476 Filters don't necessarily have a handle, therefore the parent's handle is used.
477 The notation used in collectd differs from that used in tc(1) in that it
478 doesn't skip the major or minor number if it's zero and doesn't print special
479 ids by their name.  So, for example, a qdisc may be identified by
480 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
481 thus not displayed by tc(1).
482
483 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
484 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
485 associated with that interface will be collected.
486
487 Since a filter itself doesn't necessarily have a handle, the parent's handle is
488 used. This may lead to problems when more than one filter is attached to a
489 qdisc or class. This isn't nice, but we don't know how this could be done any
490 better. If you have a idea, please don't hesitate to tell us.
491
492 As with the B<Interface> option you can specify B<All> as the interface,
493 meaning all interfaces.
494
495 Here are some examples to help you understand the above text more easily:
496
497   <Plugin netlink>
498     VerboseInterface "All"
499     QDisc "eth0" "pfifo_fast-1:0"
500     QDisc "ppp0"
501     Class "ppp0" "htb-1:10"
502     Filter "ppp0" "u32-1:0"
503   </Plugin>
504
505 =item B<IgnoreSelected>
506
507 The behaviour is the same as with all other similar plugins: If nothing is
508 selected at all, everything is collected. If some things are selected using the
509 options described above, only these statistics are collected. If you set
510 B<IgnoreSelected> to B<true>, this behavior is inversed, i.E<nbsp>e. the
511 specified statistics will not be collected.
512
513 =back
514
515 =head2 Plugin C<network>
516
517 =over 4
518
519 =item B<Listen> I<Host> [I<Port>]
520
521 =item B<Server> I<Host> [I<Port>]
522
523 The B<Server> statement sets the server to send datagrams B<to>.  The statement
524 may occur multiple times to send each datagram to multiple destinations.
525
526 The B<Listen> statement sets the interfaces to bind to. When multiple
527 statements are found the daemon will bind to multiple interfaces.
528
529 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
530 the argument is a multicast address the daemon will join that multicast group.
531
532 If no B<Listen> statement is found the server tries join both, the default IPv6
533 multicast group and the default IPv4 multicast group. If no B<Server> statement
534 is found the client will try to send data to the IPv6 multicast group first. If
535 that fails the client will try the IPv4 multicast group.
536
537 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
538 multicast group is C<239.192.74.66>.
539
540 The optional I<Port> argument sets the port to use. It can either be given
541 using a numeric port number or a service name. If the argument is omitted the
542 default port B<25826> is assumed.
543
544 =item B<TimeToLive> I<1-255>
545
546 Set the time-to-live of sent packets. This applies to all, unicast and
547 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
548 That means that multicast packets will be sent with a TTL of C<1> (one) on most
549 operating systems.
550
551 =item B<Forward> I<true|false>
552
553 If set to I<true>, write packets that were received via the network plugin to
554 the sending sockets. This should only be activated when the B<Listen>- and
555 B<Server>-statements differ. Otherwise packets may be send multiple times to
556 the same multicast group. While this results in more network traffic than
557 necessary it's not a huge problem since the plugin has a duplicate detection,
558 so the values will not loop.
559
560 =item B<CacheFlush> I<Seconds>
561
562 For each host/plugin/type combination the C<network plugin> caches the time of
563 the last value being sent or received. Every I<Seconds> seconds the plugin
564 searches and removes all entries that are older than I<Seconds> seconds, thus
565 freeing the unused memory again. Since this process is somewhat expensive and
566 normally doesn't do much, this value should not be too small. The default is
567 1800 seconds, but setting this to 86400 seconds (one day) will not do much harm
568 either.
569
570 =back
571
572 =head2 Plugin C<ntpd>
573
574 =over 4
575
576 =item B<Host> I<Hostname>
577
578 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
579
580 =item B<Port> I<Port>
581
582 UDP-Port to connect to. Defaults to B<123>.
583
584 =back
585
586 =head2 Plugin C<nut>
587
588 =over 4
589
590 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
591
592 Add a UPS to collect data from. The format is identical to the one accepted by
593 L<upsc(8)>.
594
595 =back
596
597 =head2 Plugin C<perl>
598
599 =over 4
600
601 =item B<LoadPlugin> I<Plugin>
602
603 Loads the Perl plugin I<Plugin>. This does basically the same as B<use> would
604 do in a Perl program.
605
606 =item B<BaseName> I<Name>
607
608 Prepends I<Name>B<::> to all plugin names loaded after this option. This is
609 provided for convenience to keep plugin names short.
610
611 =item B<IncludeDir> I<Dir>
612
613 Adds I<Dir> to the B<@INC> array. This is the same as using the B<-IDir>
614 command line option or B<use lib Dir> in the source code.
615
616 =back
617
618 =head2 Plugin C<ping>
619
620 =over 4
621
622 =item B<Host> I<IP-address>
623
624 Host to ping periodically. This option may be repeated several times to ping
625 multiple hosts.
626
627 =item B<TTL> I<0-255>
628
629 Sets the Time-To-Live of generated ICMP packets.
630
631 =back
632
633 =head2 Plugin C<processes>
634
635 =over 4
636
637 =item B<Process> I<Name>
638
639 Select more detailed statistics of processes matching this name. The statistics
640 collected for these selected processes are size of the resident segment size
641 (RSS), user- and system-time used, number of processes and number of threads,
642 and minor and major pagefaults.
643
644 =back
645
646 =head2 Plugin C<rrdtool>
647
648 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
649 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
650 using these settings. If you don't want to dive into the depths of RRDTool, you
651 can safely ignore these settings.
652
653 =over 4
654
655 =item B<DataDir> I<Directory>
656
657 Set the directory to store RRD-files under. Per default RRD-files are generated
658 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
659
660 =item B<StepSize> I<Seconds>
661
662 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
663 this setting is unset and the stepsize is set to the interval in which the data
664 is collected. Do not use this option unless you absolutely have to for some
665 reason. Setting this option may cause problems with the C<snmp plugin>, the
666 C<exec plugin> or when the daemon is set up to receive data from other hosts.
667
668 =item B<HeartBeat> I<Seconds>
669
670 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
671 in which case the heartbeat is set to twice the B<StepSize> which should equal
672 the interval in which data is collected. Do not set this option unless you have
673 a very good reason to do so.
674
675 =item B<RRARows> I<NumRows>
676
677 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
678 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
679 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
680 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
681 week, one month, and one year.
682
683 So for each timespan, it calculates how many PDPs need to be consolidated into
684 one CDP by calculating:
685   number of PDPs = timespan / (stepsize * rrarows)
686
687 Bottom line is, set this no smaller than the width of you graphs in pixels. The
688 default is 1200.
689
690 =item B<RRATimespan> I<Seconds>
691
692 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
693 more then one RRA. If this option is never used, the built-in default of (3600,
694 86400, 604800, 2678400, 31622400) is used.
695
696 For more information on how RRA-sizes are calculated see B<RRARows> above.
697
698 =item B<XFF> I<Factor>
699
700 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
701
702 =item B<CacheFlush> I<Seconds>
703
704 When the C<rrdtool plugin> uses a cache (by setting B<CacheTimeout>, see below)
705 it writes all values for a certain RRD-file if the oldest value is older than
706 (or equal to) the number of seconds specified. If some RRD-file is not updated
707 anymore for some reason (the computer was shut down, the network is broken,
708 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
709 entire cache is searched for entries older than B<CacheTimeout> seconds and
710 written to disk every I<Seconds> seconds. Since this is kind of expensive and
711 does nothing under normal circumstances, this value should not be too small.
712 900 seconds might be a good value, though setting this to 7200 seconds doesn't
713 normally do much harm either.
714
715 =item B<CacheTimeout> I<Seconds>
716
717 If this option is set to a value greater than zero, the C<rrdtool plugin> will
718 save values in a cache, as described above. Writing multiple values at once
719 reduces IO-operations and thus lessens the load produced by updating the files.
720 The trade off is that the graphs kind of "drag behind" and that more memory is
721 used.
722
723 =back
724
725 =head2 Plugin C<sensors>
726
727 The C<sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
728 that all the needed modules have to be loaded and lm_sensors has to be
729 configured (most likely by editing F</etc/sensors.conf>. Read
730 L<sensors.conf(5)> for details.
731
732 The B<lm_sensors> homepage can be found at
733 L<http://secure.netroedge.com/~lm78/>.
734
735 =over 4
736
737 =item B<Sensor> I<chip-bus-address/type-feature>
738
739 Selects the name of the sensor which you want to collect or ignore, depending
740 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
741 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
742 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
743
744 =item B<IgnoreSelected> I<true>|I<false>
745
746 If no configuration if given, the B<sensors>-plugin will collect data from all
747 sensors. This may not be practical, especially for uninteresting sensors.
748 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
749 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
750 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
751 I<true> the effect of B<Sensor> is inversed: All selected sensors are ignored
752 and all other sensors are collected.
753
754 =back
755
756 =head2 Plugin C<snmp>
757
758 Since the configuration of the C<snmp plugin> is a little more complicated than
759 other plugins, its documentation has been moved to an own manpage,
760 L<collectd-snmp(5)>. Please see there for details.
761
762 =head2 Plugin C<syslog>
763
764 =over 4
765
766 =item B<LogLevel> B<debug|info|notice|warning|err>
767
768 Sets the log-level. If, for example, set to B<notice>, then all events with
769 severity B<notice>, B<warning>, or B<err> will be submitted to the
770 syslog-daemon.
771
772 Please note that B<debug> is only available if collectd has been compiled with
773 debugging support.
774
775 =back
776
777 =head2 Plugin C<unixsock>
778
779 =over 4
780
781 =item B<SocketFile> I<Path>
782
783 Sets the socket-file which is to be created.
784
785 =item B<SocketGroup> I<Group>
786
787 If running as root change the group of the UNIX-socket after it has been
788 created. Defaults to B<collectd>.
789
790 =item B<SocketPerms> I<Permissions>
791
792 Change the file permissions of the UNIX-socket after it has been created. The
793 permissions must be given as a numeric, octal value as you would pass to
794 L<chmod(1)>. Defaults to B<0770>.
795
796 =back
797
798 =head2 Plugin C<vserver>
799
800 This plugin doesn't have any options. B<VServer> support is only available for
801 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
802 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
803 need to apply the patches and compile your own kernel, which will then provide
804 the F</proc/virtual> filesystem that is required by this plugin.
805
806 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
807
808 =head1 SEE ALSO
809
810 L<collectd(1)>,
811 L<collectd-exec(5)>,
812 L<collectd-unixsock(5)>,
813 L<hddtemp(8)>,
814 L<kstat(3KSTAT)>,
815 L<mbmon(1)>,
816 L<rrdtool(1)>,
817 L<sensors(1)>
818
819 =head1 AUTHOR
820
821 Florian Forster E<lt>octo@verplant.orgE<gt>
822
823 =cut