Code

Merge branch 'collectd-4.1' into collectd-4.2
[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 famous
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 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.
41 =head1 GLOBAL OPTIONS
43 =over 4
45 =item B<BaseDir> I<Directory>
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.
51 =item B<LoadPlugin> I<Plugin>
53 Loads the plugin I<Plugin>. There must be at least one such line or B<collectd>
54 will be mostly useless.
56 =item B<Include> I<File>
58 Includes the file I<File> as if it was copy and pasted here. To prevent loops
59 and shooting yourself in the foot in interesting ways the nesting is limited to
60 a depth of 8E<nbsp>levels, which should be sufficient for most uses.
62 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
63 file, but you cannot include files from within blocks.
65 =item B<PIDFile> I<File>
67 Sets where to write the PID file to. This file is overwritten when it exists
68 and deleted when the program is stopped. Some init-scripts might override this
69 setting using the B<-P> command-line option.
71 =item B<PluginDir> I<Directory>
73 Path to the plugins (shared objects) of collectd.
75 =item B<TypesDB> I<File>
77 Set the file that contains the data-set descriptions.
79 =item B<Interval> I<Seconds>
81 Configures the interval in which to query the read plugins. Obviously smaller
82 values lead to a higher system load produces by collectd, while higher values
83 lead to more coarse statistics.
85 =item B<ReadThreads> I<Num>
87 Number of threads to start for reading plugins. The default value if B<5>, but
88 you may want to increase this if you have more than five plugins that take a
89 long time to read. Mostly those are plugin that do network-IO. Setting this to
90 a value higher than the number of plugins you've loaded is totally useless.
92 =back
94 =head1 PLUGIN OPTIONS
96 Some plugins may register own options. These options must be enclosed in a
97 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
98 require external configuration, too. The C<apache plugin>, for example,
99 required C<mod_status> to be configured in the webserver you're going to
100 collect data from. These plugins are listed below as well, even if they don't
101 require any configuration within collectd's configfile.
103 A list of all plugins and a short summary for each plugin can be found in the
104 F<README> file shipped with the sourcecode and hopefully binary packets as
105 well.
107 =head2 Plugin C<apache>
109 To configure the C<apache>-plugin you first need to configure the Apache
110 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
111 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
112 the following snipped to base your Apache config upon:
114   ExtendedStatus on
115   <IfModule mod_status.c>
116     <Location /mod_status>
117       SetHandler server-status
118     </Location>
119   </IfModule>
121 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
122 also supported. It introduces a new field, called C<BusyServers>, to count the
123 number of currently connected clients. This field is also supported.
125 The following options are accepted by the C<apache>-plugin:
127 =over 4
129 =item B<URL> I<http://host/mod_status?auto>
131 Sets the URL of the C<mod_status> output. This needs to be the output generated
132 by C<ExtendedStatus on> and it needs to be the machine readable output
133 generated by appending the C<?auto> argument.
135 =item B<User> I<Username>
137 Optional user name needed for authentication.
139 =item B<Password> I<Password>
141 Optional password needed for authentication.
143 =item B<CACert> I<File>
145 File that holds one or more SSL certificates. If you want to use HTTPS you will
146 possibly need this option. What CA certificates come bundled with C<libcurl>
147 and are checked by default depends on the distribution you use.
149 =back
151 =head2 Plugin C<apcups>
153 =over 4
155 =item B<Host> I<Hostname>
157 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
158 that IPv6 support has been disabled unless someone can confirm or decline that
159 B<apcupsd> can handle it.
161 =item B<Port> I<Port>
163 TCP-Port to connect to. Defaults to B<3551>.
165 =back
167 =head2 Plugin C<cpufreq>
169 This plugin doesn't have any options. It reads
170 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
171 installed) to get the current CPU frequency. If this file does not exist make
172 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
173 installed and an "cpu governor" (that's a kernel module) is loaded.
175 =head2 Plugin C<csv>
177 =over 4
179 =item B<DataDir> I<Directory>
181 Set the directory to store CSV-files under. Per default CSV-files are generated
182 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
184 =back
186 =head2 Plugin C<df>
188 =over 4
190 =item B<Device> I<Device>
192 Select partitions based on the devicename.
194 =item B<MountPoint> I<Directory>
196 Select partitions based on the mountpoint.
198 =item B<FSType> I<FSType>
200 Select partitions based on the filesystem type.
202 =item B<IgnoreSelected> I<true>|I<false>
204 Invert the selection: If set to true, all partitions B<except> the ones that
205 match any one of the criteria are collected. By default only selected
206 partitions are collected if a selection is made. If no selection is configured
207 at all, B<all> partitions are selected.
209 =back
211 =head2 Plugin C<dns>
213 =over 4
215 =item B<Interface> I<Interface>
217 The dns plugin uses B<libpcap> to capture dns traffic and analyses it. This
218 option sets the interface that should be used. If this option is not set, or
219 set to "any", the plugin will try to get packets from B<all> interfaces. This
220 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
222 =item B<IgnoreSource> I<IP-address>
224 Ignore packets that originate from this address.
226 =back
228 =head2 Plugin C<email>
230 =over 4
232 =item B<SocketFile> I<Path>
234 Sets the socket-file which is to be created.
236 =item B<SocketGroup> I<Group>
238 If running as root change the group of the UNIX-socket after it has been
239 created. Defaults to B<collectd>.
241 =item B<SocketPerms> I<Permissions>
243 Change the file permissions of the UNIX-socket after it has been created. The
244 permissions must be given as a numeric, octal value as you would pass to
245 L<chmod(1)>. Defaults to B<0770>.
247 =item B<MaxConns> I<Number>
249 Sets the maximum number of connections that can be handled in parallel. Since
250 this many threads will be started immediately setting this to a very high
251 value will waste valuable resources. Defaults to B<5> and will be forced to be
252 at most B<16384> to prevent typos and dumb mistakes.
254 =back
256 =head2 Plugin C<exec>
258 Please make sure to read L<collectd-exec(5)> before using this plugin. It
259 contains valuable information on when the executable is executed and the
260 output that is expected from it.
262 =over 4
264 =item B<Exec> I<User>[:[I<Group>]] I<Executable>
266 Execute the executable I<Executable> as user I<User>. If the user name is
267 followed by a colon and a group name, the effective group is set to that group.
268 The real group and saved-set group will be set to the default group of that
269 user. If no group is given the effective group ID will be the same as the real
270 group ID.
272 Please note that in order to change the user and/or group the daemon needs
273 superuser privileges. If the daemon is run as an unprivileged user you must
274 specify the same user/group here. If the daemon is run with superuser
275 privileges, you must supply a non-root user here.
277 =back
279 =head2 Plugin C<hddtemp>
281 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
282 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
283 default values, see below. C<hddtemp> has to be running to work correctly. If
284 C<hddtemp> is not running timeouts may appear which may interfere with other
285 statistics..
287 The B<hddtemp> homepage can be found at
288 L<http://www.guzu.net/linux/hddtemp.php>.
290 =over 4
292 =item B<Host> I<Hostname>
294 Hostname to connect to. Defaults to B<127.0.0.1>.
296 =item B<Port> I<Port>
298 TCP-Port to connect to. Defaults to B<7634>.
300 =back
302 =head2 Plugin C<interface>
304 =over 4
306 =item B<Interface> I<Interface>
308 Select this interface. By default these interfaces will then be collected. For
309 a more detailed description see B<IgnoreSelected> below.
311 =item B<IgnoreSelected> I<true>|I<false>
313 If no configuration if given, the B<traffic>-plugin will collect data from
314 all interfaces. This may not be practical, especially for loopback- and
315 similar interfaces. Thus, you can use the B<Interface>-option to pick the
316 interfaces you're interested in. Sometimes, however, it's easier/preferred
317 to collect all interfaces I<except> a few ones. This option enables you to
318 do that: By setting B<IgnoreSelected> to I<true> the effect of
319 B<Interface> is inversed: All selected interfaces are ignored and all
320 other interfaces are collected.
322 =back
324 =head2 Plugin C<iptables>
326 =over 4
328 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
330 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
331 will collect the counters of all rules which have a comment-match. The comment
332 is then used as type-instance.
334 If I<Comment> or I<Number> is given, only the rule with the matching comment or
335 the I<n>th rule will be collected. Again, the comment (or the number) will be
336 used as the type-instance.
338 If I<Name> is supplied, it will be used as the type-instance instead of the
339 comment or the number.
341 =back
343 =head2 Plugin C<irq>
345 =over 4
347 =item B<Irq> I<Irq>
349 Select this irq. By default these irqs will then be collected. For a more
350 detailed description see B<IgnoreSelected> below.
352 =item B<IgnoreSelected> I<true>|I<false>
354 If no configuration if given, the B<irq>-plugin will collect data from all
355 irqs. This may not be practical, especially if no interrupts happen. Thus, you
356 can use the B<Irq>-option to pick the interrupt you're interested in.
357 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
358 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
359 I<true> the effect of B<Irq> is inversed: All selected interrupts are ignored
360 and all other interrupts are collected.
362 =back
364 =head2 Plugin C<logfile>
366 =over 4
368 =item B<LogLevel> B<debug|info|notice|warning|err>
370 Sets the log-level. If, for example, set to B<notice>, then all events with
371 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
373 Please note that B<debug> is only available if collectd has been compiled with
374 debugging support.
376 =item B<File> I<File>
378 Sets the file to write log messages to. The special strings B<stdout> and
379 B<stderr> can be used to write to the standard output and standard error
380 channels, respectively. This, of course, only makes much sense when collectd is
381 running in foreground- or non-daemon-mode.
383 =item B<Timestamp> B<true>|B<false>
385 Prefix all lines printed by the current time. Defaults to B<true>.
387 =back
389 =head2 Plugin C<mbmon>
391 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
393 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>.  The
394 B<Host> and B<Port> options can be used to change these values, see below.
395 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
396 timeouts may appear which may interfere with other statistics..
398 C<mbmon> must be run with the -r option ("print TAG and Value format");
399 Debian's F</etc/init.d/mbmon> script already does this, other people
400 will need to ensure that this is the case.
402 =over 4
404 =item B<Host> I<Hostname>
406 Hostname to connect to. Defaults to B<127.0.0.1>.
408 =item B<Port> I<Port>
410 TCP-Port to connect to. Defaults to B<411>.
412 =back
414 =head2 Plugin C<memcached>
416 The C<memcached plugin> connects to a memcached server and queries statistics
417 about cache utilization, memory and bandwidth used.
418 L<http://www.danga.com/memcached/>
420 =over 4
422 =item B<Host> I<Hostname>
424 Hostname to connect to. Defaults to B<127.0.0.1>.
426 =item B<Port> I<Port>
428 TCP-Port to connect to. Defaults to B<11211>.
430 =back
432 =head2 Plugin C<mysql>
434 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to the
435 database when started and keeps the connection up as long as possible. When the
436 connection is interrupted for whatever reason it will try to re-connect. The
437 plugin will complaint loudly in case anything goes wrong.
439 This plugin issues C<SHOW STATUS> and evaluates C<Bytes_{received,sent}>,
440 C<Com_*> and C<Handler_*> which correspond to F<mysql_octets.rrd>,
441 F<mysql_commands-*.rrd> and F<mysql_handler-*.rrd>. Also, the values of
442 C<Qcache_*> are put in F<mysql_qcache.rrd> and values of C<Threads_*> are put
443 in F<mysql_threads.rrd>. Please refer to the B<MySQL reference manual>,
444 I<5.2.4. Server Status Variables> for an explanation of these values.
446 Use the following options to configure the plugin:
448 =over 4
450 =item B<Host> I<Hostname>
452 Hostname of the database server. Defaults to B<localhost>.
454 =item B<User> I<Username>
456 Username to use when connecting to the database.
458 =item B<Password> I<Password>
460 Password needed to log into the database.
462 =item B<Database> I<Database>
464 Select this database. Defaults to I<no database> which is a perfectly reasonable
465 option for what this plugin does.
467 =back
469 =head2 Plugin C<netlink>
471 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
472 statistics of various interface and routing aspects.
474 =over 4
476 =item B<Interface> I<Interface>
478 =item B<VerboseInterface> I<Interface>
480 Instruct the plugin to collect interface statistics. This is basically the same
481 as the statistics provided by the C<interface> plugin (see above) but
482 potentially much more detailed.
484 When configuring with B<Interface> only the basic statistics will be collected,
485 namely octets, packets, and errors. These statistics are collected by
486 the C<interface> plugin, too, so using both at the same time is no benefit.
488 When configured with B<VerboseInterface> all counters B<except> the basic ones,
489 so that no data needs to be collected twice if you use the C<interface> plugin.
490 This includes dropped packets, received multicast packets, collisions and a
491 whole zoo of differentiated RX and TX errors. You can try the following command
492 to get an idea of what awaits you:
494   ip -s -s link list
496 If I<Interface> is B<All>, all interfaces will be selected.
498 =item B<QDisc> I<Interface> [I<QDisc>]
500 =item B<Class> I<Interface> [I<Class>]
502 =item B<Filter> I<Interface> [I<Filter>]
504 Collect the octets and packets that pass a certain qdisc, class or filter.
506 QDiscs and classes are identified by their type and handle (or classid).
507 Filters don't necessarily have a handle, therefore the parent's handle is used.
508 The notation used in collectd differs from that used in tc(1) in that it
509 doesn't skip the major or minor number if it's zero and doesn't print special
510 ids by their name.  So, for example, a qdisc may be identified by
511 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
512 thus not displayed by tc(1).
514 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
515 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
516 associated with that interface will be collected.
518 Since a filter itself doesn't necessarily have a handle, the parent's handle is
519 used. This may lead to problems when more than one filter is attached to a
520 qdisc or class. This isn't nice, but we don't know how this could be done any
521 better. If you have a idea, please don't hesitate to tell us.
523 As with the B<Interface> option you can specify B<All> as the interface,
524 meaning all interfaces.
526 Here are some examples to help you understand the above text more easily:
528   <Plugin netlink>
529     VerboseInterface "All"
530     QDisc "eth0" "pfifo_fast-1:0"
531     QDisc "ppp0"
532     Class "ppp0" "htb-1:10"
533     Filter "ppp0" "u32-1:0"
534   </Plugin>
536 =item B<IgnoreSelected>
538 The behaviour is the same as with all other similar plugins: If nothing is
539 selected at all, everything is collected. If some things are selected using the
540 options described above, only these statistics are collected. If you set
541 B<IgnoreSelected> to B<true>, this behavior is inversed, i.E<nbsp>e. the
542 specified statistics will not be collected.
544 =back
546 =head2 Plugin C<network>
548 =over 4
550 =item B<Listen> I<Host> [I<Port>]
552 =item B<Server> I<Host> [I<Port>]
554 The B<Server> statement sets the server to send datagrams B<to>.  The statement
555 may occur multiple times to send each datagram to multiple destinations.
557 The B<Listen> statement sets the interfaces to bind to. When multiple
558 statements are found the daemon will bind to multiple interfaces.
560 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
561 the argument is a multicast address the daemon will join that multicast group.
563 If no B<Listen> statement is found the server tries join both, the default IPv6
564 multicast group and the default IPv4 multicast group. If no B<Server> statement
565 is found the client will try to send data to the IPv6 multicast group first. If
566 that fails the client will try the IPv4 multicast group.
568 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
569 multicast group is C<239.192.74.66>.
571 The optional I<Port> argument sets the port to use. It can either be given
572 using a numeric port number or a service name. If the argument is omitted the
573 default port B<25826> is assumed.
575 =item B<TimeToLive> I<1-255>
577 Set the time-to-live of sent packets. This applies to all, unicast and
578 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
579 That means that multicast packets will be sent with a TTL of C<1> (one) on most
580 operating systems.
582 =item B<Forward> I<true|false>
584 If set to I<true>, write packets that were received via the network plugin to
585 the sending sockets. This should only be activated when the B<Listen>- and
586 B<Server>-statements differ. Otherwise packets may be send multiple times to
587 the same multicast group. While this results in more network traffic than
588 necessary it's not a huge problem since the plugin has a duplicate detection,
589 so the values will not loop.
591 =item B<CacheFlush> I<Seconds>
593 For each host/plugin/type combination the C<network plugin> caches the time of
594 the last value being sent or received. Every I<Seconds> seconds the plugin
595 searches and removes all entries that are older than I<Seconds> seconds, thus
596 freeing the unused memory again. Since this process is somewhat expensive and
597 normally doesn't do much, this value should not be too small. The default is
598 1800 seconds, but setting this to 86400 seconds (one day) will not do much harm
599 either.
601 =back
603 =head2 Plugin C<nginx>
605 This plugin collects the number of connections and requests handled by the
606 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
607 queries the page provided by the C<ngx_http_stub_status_module> module, which
608 isn't compiled by default. Please refer to
609 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
610 how to compile and configure nginx and this module.
612 The following options are accepted by the C<nginx plugin>:
614 =over 4
616 =item B<URL> I<http://host/nginx_status>
618 Sets the URL of the C<ngx_http_stub_status_module> output.
620 =item B<User> I<Username>
622 Optional user name needed for authentication.
624 =item B<Password> I<Password>
626 Optional password needed for authentication.
628 =item B<CACert> I<File>
630 File that holds one or more SSL certificates. If you want to use HTTPS you will
631 possibly need this option. What CA certificates come bundled with C<libcurl>
632 and are checked by default depends on the distribution you use.
634 =back
636 =head2 Plugin C<ntpd>
638 =over 4
640 =item B<Host> I<Hostname>
642 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
644 =item B<Port> I<Port>
646 UDP-Port to connect to. Defaults to B<123>.
648 =back
650 =head2 Plugin C<nut>
652 =over 4
654 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
656 Add a UPS to collect data from. The format is identical to the one accepted by
657 L<upsc(8)>.
659 =back
661 =head2 Plugin C<perl>
663 This plugin embeds a Perl-interpreter into collectd and provides an interface
664 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
666 =head2 Plugin C<ping>
668 =over 4
670 =item B<Host> I<IP-address>
672 Host to ping periodically. This option may be repeated several times to ping
673 multiple hosts.
675 =item B<TTL> I<0-255>
677 Sets the Time-To-Live of generated ICMP packets.
679 =back
681 =head2 Plugin C<processes>
683 =over 4
685 =item B<Process> I<Name>
687 Select more detailed statistics of processes matching this name. The statistics
688 collected for these selected processes are size of the resident segment size
689 (RSS), user- and system-time used, number of processes and number of threads,
690 and minor and major pagefaults.
692 =back
694 =head2 Plugin C<rrdtool>
696 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
697 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
698 using these settings. If you don't want to dive into the depths of RRDTool, you
699 can safely ignore these settings.
701 =over 4
703 =item B<DataDir> I<Directory>
705 Set the directory to store RRD-files under. Per default RRD-files are generated
706 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
708 =item B<StepSize> I<Seconds>
710 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
711 this setting is unset and the stepsize is set to the interval in which the data
712 is collected. Do not use this option unless you absolutely have to for some
713 reason. Setting this option may cause problems with the C<snmp plugin>, the
714 C<exec plugin> or when the daemon is set up to receive data from other hosts.
716 =item B<HeartBeat> I<Seconds>
718 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
719 in which case the heartbeat is set to twice the B<StepSize> which should equal
720 the interval in which data is collected. Do not set this option unless you have
721 a very good reason to do so.
723 =item B<RRARows> I<NumRows>
725 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
726 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
727 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
728 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
729 week, one month, and one year.
731 So for each timespan, it calculates how many PDPs need to be consolidated into
732 one CDP by calculating:
733   number of PDPs = timespan / (stepsize * rrarows)
735 Bottom line is, set this no smaller than the width of you graphs in pixels. The
736 default is 1200.
738 =item B<RRATimespan> I<Seconds>
740 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
741 more then one RRA. If this option is never used, the built-in default of (3600,
742 86400, 604800, 2678400, 31622400) is used.
744 For more information on how RRA-sizes are calculated see B<RRARows> above.
746 =item B<XFF> I<Factor>
748 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
750 =item B<CacheFlush> I<Seconds>
752 When the C<rrdtool plugin> uses a cache (by setting B<CacheTimeout>, see below)
753 it writes all values for a certain RRD-file if the oldest value is older than
754 (or equal to) the number of seconds specified. If some RRD-file is not updated
755 anymore for some reason (the computer was shut down, the network is broken,
756 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
757 entire cache is searched for entries older than B<CacheTimeout> seconds and
758 written to disk every I<Seconds> seconds. Since this is kind of expensive and
759 does nothing under normal circumstances, this value should not be too small.
760 900 seconds might be a good value, though setting this to 7200 seconds doesn't
761 normally do much harm either.
763 =item B<CacheTimeout> I<Seconds>
765 If this option is set to a value greater than zero, the C<rrdtool plugin> will
766 save values in a cache, as described above. Writing multiple values at once
767 reduces IO-operations and thus lessens the load produced by updating the files.
768 The trade off is that the graphs kind of "drag behind" and that more memory is
769 used.
771 =back
773 =head2 Plugin C<sensors>
775 The C<sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
776 that all the needed modules have to be loaded and lm_sensors has to be
777 configured (most likely by editing F</etc/sensors.conf>. Read
778 L<sensors.conf(5)> for details.
780 The B<lm_sensors> homepage can be found at
781 L<http://secure.netroedge.com/~lm78/>.
783 =over 4
785 =item B<Sensor> I<chip-bus-address/type-feature>
787 Selects the name of the sensor which you want to collect or ignore, depending
788 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
789 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
790 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
792 =item B<IgnoreSelected> I<true>|I<false>
794 If no configuration if given, the B<sensors>-plugin will collect data from all
795 sensors. This may not be practical, especially for uninteresting sensors.
796 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
797 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
798 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
799 I<true> the effect of B<Sensor> is inversed: All selected sensors are ignored
800 and all other sensors are collected.
802 =back
804 =head2 Plugin C<snmp>
806 Since the configuration of the C<snmp plugin> is a little more complicated than
807 other plugins, its documentation has been moved to an own manpage,
808 L<collectd-snmp(5)>. Please see there for details.
810 =head2 Plugin C<syslog>
812 =over 4
814 =item B<LogLevel> B<debug|info|notice|warning|err>
816 Sets the log-level. If, for example, set to B<notice>, then all events with
817 severity B<notice>, B<warning>, or B<err> will be submitted to the
818 syslog-daemon.
820 Please note that B<debug> is only available if collectd has been compiled with
821 debugging support.
823 =back
825 =head2 Plugin C<tcpconns>
827 The C<tcpconns plugin> counts the number of currently established TCP
828 connections based on the local port and/or the remote port. Since there may be
829 a lot of connections the default if to count all connections with a local port,
830 for which a listening socket is opened. You can use the following options to
831 fine-tune the ports you are interested in:
833 =over 4
835 =item B<ListeningPorts> I<true>|I<false>
837 If this option is set to I<true>, statistics for all local ports for which a
838 listening socket exists are collected. The default depends on B<LocalPort> and
839 B<RemotePort> (see below): If no port at all is specifically selected, the
840 default is to collect listening ports. If specific ports (no matter if local or
841 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
842 the selected ports will be collected unless this option is set to I<true>
843 specifically.
845 =item B<LocalPort> I<Port>
847 Count the connections to a specific local port. This can be used to see how
848 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
849 You have to specify the port in numeric form, so for the mailserver example
850 you'd need to set B<25>.
852 =item B<RemotePort> I<Port>
854 Count the connections to a specific remote port. This is useful to see how
855 much a remote service is used. This is most useful if you want to know how many
856 connections a local service has opened to remote services, e.E<nbsp>g. how many
857 connections a mail server or news server has to other mail or news servers, or
858 how many connections a web proxy holds to web servers. You have to give the
859 port in numeric form.
861 =back
863 =head2 Plugin C<unixsock>
865 =over 4
867 =item B<SocketFile> I<Path>
869 Sets the socket-file which is to be created.
871 =item B<SocketGroup> I<Group>
873 If running as root change the group of the UNIX-socket after it has been
874 created. Defaults to B<collectd>.
876 =item B<SocketPerms> I<Permissions>
878 Change the file permissions of the UNIX-socket after it has been created. The
879 permissions must be given as a numeric, octal value as you would pass to
880 L<chmod(1)>. Defaults to B<0770>.
882 =back
884 =head2 Plugin C<vserver>
886 This plugin doesn't have any options. B<VServer> support is only available for
887 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
888 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
889 need to apply the patches and compile your own kernel, which will then provide
890 the F</proc/virtual> filesystem that is required by this plugin.
892 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
894 =head1 SEE ALSO
896 L<collectd(1)>,
897 L<collectd-exec(5)>,
898 L<collectd-perl(5)>,
899 L<collectd-unixsock(5)>,
900 L<hddtemp(8)>,
901 L<kstat(3KSTAT)>,
902 L<mbmon(1)>,
903 L<rrdtool(1)>,
904 L<sensors(1)>
906 =head1 AUTHOR
908 Florian Forster E<lt>octo@verplant.orgE<gt>
910 =cut