Code

383dda6397c5e4e6c1b90d9c683e32137b179e4a
[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<Path>
58 If I<Path> points to a file, includes that file. If I<Path> points to a
59 directory, recursively includes all files within that directory and its
60 subdirectories. If the C<wordexp> function is available on your system,
61 shell-like wildcards are expanded before files are included. This means you can
62 use statements like the following:
64   Include "/etc/collectd.d/*.conf"
66 To prevent loops and shooting yourself in the foot in interesting ways the
67 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
68 most uses. Since symlinks are followed it is still possible to crash the daemon
69 by looping symlinks. In our opinion significant stupidity should result in an
70 appropriate amount of pain.
72 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
73 file, but you cannot include files from within blocks.
75 =item B<PIDFile> I<File>
77 Sets where to write the PID file to. This file is overwritten when it exists
78 and deleted when the program is stopped. Some init-scripts might override this
79 setting using the B<-P> command-line option.
81 =item B<PluginDir> I<Directory>
83 Path to the plugins (shared objects) of collectd.
85 =item B<TypesDB> I<File> [I<File> ...]
87 Set one or more files that contain the data-set descriptions. See
88 L<types.db(5)> for a description of the format of this file.
90 =item B<Interval> I<Seconds>
92 Configures the interval in which to query the read plugins. Obviously smaller
93 values lead to a higher system load produced by collectd, while higher values
94 lead to more coarse statistics.
96 =item B<ReadThreads> I<Num>
98 Number of threads to start for reading plugins. The default value is B<5>, but
99 you may want to increase this if you have more than five plugins that take a
100 long time to read. Mostly those are plugin that do network-IO. Setting this to
101 a value higher than the number of plugins you've loaded is totally useless.
103 =item B<Hostname> I<Name>
105 Sets the hostname that identifies a host. If you omit this setting, the
106 hostname will be determinded using the L<gethostname(2)> system call.
108 =item B<FQDNLookup> B<true|false>
110 If B<Hostname> is determined automatically this setting controls whether or not
111 the daemon should try to figure out the "fully qualified domain name", FQDN.
112 This is done using a lookup of the name returned by C<gethostname>.
114 Using this feature (i.E<nbsp>e. setting this option to B<true>) is recommended.
115 However, to preserve backwards compatibility the default is set to B<false>.
116 The sample config file that is installed with C<makeE<nbsp>install> includes a
117 line which sets this option, though, so that default installations will have
118 this setting enabled.
120 =back
122 =head1 PLUGIN OPTIONS
124 Some plugins may register own options. These options must be enclosed in a
125 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
126 require external configuration, too. The C<apache plugin>, for example,
127 required C<mod_status> to be configured in the webserver you're going to
128 collect data from. These plugins are listed below as well, even if they don't
129 require any configuration within collectd's configfile.
131 A list of all plugins and a short summary for each plugin can be found in the
132 F<README> file shipped with the sourcecode and hopefully binary packets as
133 well.
135 =head2 Plugin C<apache>
137 To configure the C<apache>-plugin you first need to configure the Apache
138 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
139 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
140 the following snipped to base your Apache config upon:
142   ExtendedStatus on
143   <IfModule mod_status.c>
144     <Location /mod_status>
145       SetHandler server-status
146     </Location>
147   </IfModule>
149 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
150 also supported. It introduces a new field, called C<BusyServers>, to count the
151 number of currently connected clients. This field is also supported.
153 The following options are accepted by the C<apache>-plugin:
155 =over 4
157 =item B<URL> I<http://host/mod_status?auto>
159 Sets the URL of the C<mod_status> output. This needs to be the output generated
160 by C<ExtendedStatus on> and it needs to be the machine readable output
161 generated by appending the C<?auto> argument.
163 =item B<User> I<Username>
165 Optional user name needed for authentication.
167 =item B<Password> I<Password>
169 Optional password needed for authentication.
171 =item B<CACert> I<File>
173 File that holds one or more SSL certificates. If you want to use HTTPS you will
174 possibly need this option. What CA certificates come bundled with C<libcurl>
175 and are checked by default depends on the distribution you use.
177 =back
179 =head2 Plugin C<apcups>
181 =over 4
183 =item B<Host> I<Hostname>
185 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
186 that IPv6 support has been disabled unless someone can confirm or decline that
187 B<apcupsd> can handle it.
189 =item B<Port> I<Port>
191 TCP-Port to connect to. Defaults to B<3551>.
193 =back
195 =head2 Plugin C<cpufreq>
197 This plugin doesn't have any options. It reads
198 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
199 installed) to get the current CPU frequency. If this file does not exist make
200 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
201 installed and an "cpu governor" (that's a kernel module) is loaded.
203 =head2 Plugin C<csv>
205 =over 4
207 =item B<DataDir> I<Directory>
209 Set the directory to store CSV-files under. Per default CSV-files are generated
210 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
212 =item B<StoreRates> B<true|false>
214 If set to B<true>, convert counter values to rates. If set to B<false> (the
215 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
216 number.
218 =back
220 =head2 Plugin C<df>
222 =over 4
224 =item B<Device> I<Device>
226 Select partitions based on the devicename.
228 =item B<MountPoint> I<Directory>
230 Select partitions based on the mountpoint.
232 =item B<FSType> I<FSType>
234 Select partitions based on the filesystem type.
236 =item B<IgnoreSelected> I<true>|I<false>
238 Invert the selection: If set to true, all partitions B<except> the ones that
239 match any one of the criteria are collected. By default only selected
240 partitions are collected if a selection is made. If no selection is configured
241 at all, B<all> partitions are selected.
243 =back
245 =head2 Plugin C<dns>
247 =over 4
249 =item B<Interface> I<Interface>
251 The dns plugin uses B<libpcap> to capture dns traffic and analyses it. This
252 option sets the interface that should be used. If this option is not set, or
253 set to "any", the plugin will try to get packets from B<all> interfaces. This
254 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
256 =item B<IgnoreSource> I<IP-address>
258 Ignore packets that originate from this address.
260 =back
262 =head2 Plugin C<email>
264 =over 4
266 =item B<SocketFile> I<Path>
268 Sets the socket-file which is to be created.
270 =item B<SocketGroup> I<Group>
272 If running as root change the group of the UNIX-socket after it has been
273 created. Defaults to B<collectd>.
275 =item B<SocketPerms> I<Permissions>
277 Change the file permissions of the UNIX-socket after it has been created. The
278 permissions must be given as a numeric, octal value as you would pass to
279 L<chmod(1)>. Defaults to B<0770>.
281 =item B<MaxConns> I<Number>
283 Sets the maximum number of connections that can be handled in parallel. Since
284 this many threads will be started immediately setting this to a very high
285 value will waste valuable resources. Defaults to B<5> and will be forced to be
286 at most B<16384> to prevent typos and dumb mistakes.
288 =back
290 =head2 Plugin C<exec>
292 Please make sure to read L<collectd-exec(5)> before using this plugin. It
293 contains valuable information on when the executable is executed and the
294 output that is expected from it.
296 =over 4
298 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
300 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
302 Execute the executable I<Executable> as user I<User>. If the user name is
303 followed by a colon and a group name, the effective group is set to that group.
304 The real group and saved-set group will be set to the default group of that
305 user. If no group is given the effective group ID will be the same as the real
306 group ID.
308 Please note that in order to change the user and/or group the daemon needs
309 superuser privileges. If the daemon is run as an unprivileged user you must
310 specify the same user/group here. If the daemon is run with superuser
311 privileges, you must supply a non-root user here.
313 The executable may be followed by optional arguments that are passed to the
314 program. Please note that due to the configuration parsing numbers and boolean
315 values may be changed. If you want to be absolutely sure that something is
316 passed as-is please enclose it in quotes.
318 The B<Exec> and B<NotificationExec> statements change the semantics of the
319 programs executed, i.E<nbsp>e. the data passed to them and the response
320 expected from them. This is documented in great detail in L<collectd-exec(5)>.
322 =back
324 =head2 Plugin C<hddtemp>
326 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
327 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
328 default values, see below. C<hddtemp> has to be running to work correctly. If
329 C<hddtemp> is not running timeouts may appear which may interfere with other
330 statistics..
332 The B<hddtemp> homepage can be found at
333 L<http://www.guzu.net/linux/hddtemp.php>.
335 =over 4
337 =item B<Host> I<Hostname>
339 Hostname to connect to. Defaults to B<127.0.0.1>.
341 =item B<Port> I<Port>
343 TCP-Port to connect to. Defaults to B<7634>.
345 =item B<TranslateDevicename> I<true>|I<false>
347 If enabled, translate the disk names to major/minor device numbers
348 (e.E<nbsp>g. "8-0" for /dev/sda). For backwards compatibility this defaults to
349 I<true> but it's recommended to disable it as it will probably be removed in
350 the next major version.
352 =back
354 =head2 Plugin C<interface>
356 =over 4
358 =item B<Interface> I<Interface>
360 Select this interface. By default these interfaces will then be collected. For
361 a more detailed description see B<IgnoreSelected> below.
363 =item B<IgnoreSelected> I<true>|I<false>
365 If no configuration if given, the B<traffic>-plugin will collect data from
366 all interfaces. This may not be practical, especially for loopback- and
367 similar interfaces. Thus, you can use the B<Interface>-option to pick the
368 interfaces you're interested in. Sometimes, however, it's easier/preferred
369 to collect all interfaces I<except> a few ones. This option enables you to
370 do that: By setting B<IgnoreSelected> to I<true> the effect of
371 B<Interface> is inversed: All selected interfaces are ignored and all
372 other interfaces are collected.
374 =back
376 =head2 Plugin C<iptables>
378 =over 4
380 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
382 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
383 will collect the counters of all rules which have a comment-match. The comment
384 is then used as type-instance.
386 If I<Comment> or I<Number> is given, only the rule with the matching comment or
387 the I<n>th rule will be collected. Again, the comment (or the number) will be
388 used as the type-instance.
390 If I<Name> is supplied, it will be used as the type-instance instead of the
391 comment or the number.
393 =back
395 =head2 Plugin C<irq>
397 =over 4
399 =item B<Irq> I<Irq>
401 Select this irq. By default these irqs will then be collected. For a more
402 detailed description see B<IgnoreSelected> below.
404 =item B<IgnoreSelected> I<true>|I<false>
406 If no configuration if given, the B<irq>-plugin will collect data from all
407 irqs. This may not be practical, especially if no interrupts happen. Thus, you
408 can use the B<Irq>-option to pick the interrupt you're interested in.
409 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
410 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
411 I<true> the effect of B<Irq> is inversed: All selected interrupts are ignored
412 and all other interrupts are collected.
414 =back
416 =head2 Plugin C<libvirt>
418 This plugin allows CPU, disk and network load to be collected for virtualized
419 guests on the machine. This means that these characteristics can be collected
420 for guest systems without installing any software on them - collectd only runs
421 on the hosting system. The statistics are collected through libvirt
422 (L<http://libvirt.org/>).
424 Only I<Connection> is required.
426 =over 4
428 =item B<Connection> I<uri>
430 Connect to the hypervisor given by I<uri>. For example if using Xen use:
432  Connection "xen:///"
434 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
436 =item B<RefreshInterval> I<seconds>
438 Refresh the list of domains and devices every I<seconds>. The default is 60
439 seconds. Setting this to be the same or smaller than the I<Interval> will cause
440 the list of domains and devices to be refreshed on every iteration.
442 Refreshing the devices in particular is quite a costly operation, so if your
443 virtualization setup is static you might consider increasing this. If this
444 option is set to 0, refreshing is disabled completely.
446 =item B<Domain> I<name>
448 =item B<BlockDevice> I<name:dev>
450 =item B<InterfaceDevice> I<name:dev>
452 =item B<IgnoreSelected> I<true>|I<false>
454 Select which domains and devices are collected.
456 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
457 disk/network devices are collected.
459 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
460 domains and disk/network devices are ignored, while the rest are collected.
462 The domain name and device names may use a regular expression, if the name is
463 surrounded by I</.../> and collectd was compiled with support for regexps.
465 The default is to collect statistics for all domains and all their devices.
467 Example:
469  BlockDevice "/:hdb/"
470  IgnoreSelected "true"
472 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
473 will be collected.
475 =item B<HostnameFormat> B<name|uuid|hostname|...>
477 When the libvirt plugin logs data, it sets the hostname of the collected data
478 according to this setting. The default is to use the guest name as provided by
479 the hypervisor, which is equal to setting B<name>.
481 B<uuid> means use the guest's UUID. This is useful if you want to track the
482 same guest across migrations.
484 B<hostname> means to use the global B<Hostname> setting, which is probably not
485 useful on its own because all guests will appear to have the same name.
487 You can also specify combinations of these fields. For example B<name uuid>
488 means to concatenate the guest name and UUID (with a literal colon character
489 between, thus I<"foo:1234-1234-1234-1234">).
491 =back
493 =head2 Plugin C<logfile>
495 =over 4
497 =item B<LogLevel> B<debug|info|notice|warning|err>
499 Sets the log-level. If, for example, set to B<notice>, then all events with
500 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
502 Please note that B<debug> is only available if collectd has been compiled with
503 debugging support.
505 =item B<File> I<File>
507 Sets the file to write log messages to. The special strings B<stdout> and
508 B<stderr> can be used to write to the standard output and standard error
509 channels, respectively. This, of course, only makes much sense when collectd is
510 running in foreground- or non-daemon-mode.
512 =item B<Timestamp> B<true>|B<false>
514 Prefix all lines printed by the current time. Defaults to B<true>.
516 =back
518 =head2 Plugin C<mbmon>
520 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
522 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
523 B<Host> and B<Port> options can be used to change these values, see below.
524 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
525 timeouts may appear which may interfere with other statistics..
527 C<mbmon> must be run with the -r option ("print TAG and Value format");
528 Debian's F</etc/init.d/mbmon> script already does this, other people
529 will need to ensure that this is the case.
531 =over 4
533 =item B<Host> I<Hostname>
535 Hostname to connect to. Defaults to B<127.0.0.1>.
537 =item B<Port> I<Port>
539 TCP-Port to connect to. Defaults to B<411>.
541 =back
543 =head2 Plugin C<memcached>
545 The C<memcached plugin> connects to a memcached server and queries statistics
546 about cache utilization, memory and bandwidth used.
547 L<http://www.danga.com/memcached/>
549 =over 4
551 =item B<Host> I<Hostname>
553 Hostname to connect to. Defaults to B<127.0.0.1>.
555 =item B<Port> I<Port>
557 TCP-Port to connect to. Defaults to B<11211>.
559 =back
561 =head2 Plugin C<mysql>
563 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to the
564 database when started and keeps the connection up as long as possible. When the
565 connection is interrupted for whatever reason it will try to re-connect. The
566 plugin will complaint loudly in case anything goes wrong.
568 This plugin issues C<SHOW STATUS> and evaluates C<Bytes_{received,sent}>,
569 C<Com_*> and C<Handler_*> which correspond to F<mysql_octets.rrd>,
570 F<mysql_commands-*.rrd> and F<mysql_handler-*.rrd>. Also, the values of
571 C<Qcache_*> are put in F<mysql_qcache.rrd> and values of C<Threads_*> are put
572 in F<mysql_threads.rrd>. Please refer to the B<MySQL reference manual>,
573 I<5.2.4. Server Status Variables> for an explanation of these values.
575 Use the following options to configure the plugin:
577 =over 4
579 =item B<Host> I<Hostname>
581 Hostname of the database server. Defaults to B<localhost>.
583 =item B<User> I<Username>
585 Username to use when connecting to the database.
587 =item B<Password> I<Password>
589 Password needed to log into the database.
591 =item B<Database> I<Database>
593 Select this database. Defaults to I<no database> which is a perfectly reasonable
594 option for what this plugin does.
596 =back
598 =head2 Plugin C<netlink>
600 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
601 statistics of various interface and routing aspects.
603 =over 4
605 =item B<Interface> I<Interface>
607 =item B<VerboseInterface> I<Interface>
609 Instruct the plugin to collect interface statistics. This is basically the same
610 as the statistics provided by the C<interface> plugin (see above) but
611 potentially much more detailed.
613 When configuring with B<Interface> only the basic statistics will be collected,
614 namely octets, packets, and errors. These statistics are collected by
615 the C<interface> plugin, too, so using both at the same time is no benefit.
617 When configured with B<VerboseInterface> all counters B<except> the basic ones,
618 so that no data needs to be collected twice if you use the C<interface> plugin.
619 This includes dropped packets, received multicast packets, collisions and a
620 whole zoo of differentiated RX and TX errors. You can try the following command
621 to get an idea of what awaits you:
623   ip -s -s link list
625 If I<Interface> is B<All>, all interfaces will be selected.
627 =item B<QDisc> I<Interface> [I<QDisc>]
629 =item B<Class> I<Interface> [I<Class>]
631 =item B<Filter> I<Interface> [I<Filter>]
633 Collect the octets and packets that pass a certain qdisc, class or filter.
635 QDiscs and classes are identified by their type and handle (or classid).
636 Filters don't necessarily have a handle, therefore the parent's handle is used.
637 The notation used in collectd differs from that used in tc(1) in that it
638 doesn't skip the major or minor number if it's zero and doesn't print special
639 ids by their name. So, for example, a qdisc may be identified by
640 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
641 thus not displayed by tc(1).
643 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
644 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
645 associated with that interface will be collected.
647 Since a filter itself doesn't necessarily have a handle, the parent's handle is
648 used. This may lead to problems when more than one filter is attached to a
649 qdisc or class. This isn't nice, but we don't know how this could be done any
650 better. If you have a idea, please don't hesitate to tell us.
652 As with the B<Interface> option you can specify B<All> as the interface,
653 meaning all interfaces.
655 Here are some examples to help you understand the above text more easily:
657   <Plugin netlink>
658     VerboseInterface "All"
659     QDisc "eth0" "pfifo_fast-1:0"
660     QDisc "ppp0"
661     Class "ppp0" "htb-1:10"
662     Filter "ppp0" "u32-1:0"
663   </Plugin>
665 =item B<IgnoreSelected>
667 The behaviour is the same as with all other similar plugins: If nothing is
668 selected at all, everything is collected. If some things are selected using the
669 options described above, only these statistics are collected. If you set
670 B<IgnoreSelected> to B<true>, this behavior is inversed, i.E<nbsp>e. the
671 specified statistics will not be collected.
673 =back
675 =head2 Plugin C<network>
677 =over 4
679 =item B<Listen> I<Host> [I<Port>]
681 =item B<Server> I<Host> [I<Port>]
683 The B<Server> statement sets the server to send datagrams B<to>.  The statement
684 may occur multiple times to send each datagram to multiple destinations.
686 The B<Listen> statement sets the interfaces to bind to. When multiple
687 statements are found the daemon will bind to multiple interfaces.
689 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
690 the argument is a multicast address the daemon will join that multicast group.
692 If no B<Listen> statement is found the server tries join both, the default IPv6
693 multicast group and the default IPv4 multicast group. If no B<Server> statement
694 is found the client will try to send data to the IPv6 multicast group first. If
695 that fails the client will try the IPv4 multicast group.
697 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
698 multicast group is C<239.192.74.66>.
700 The optional I<Port> argument sets the port to use. It can either be given
701 using a numeric port number or a service name. If the argument is omitted the
702 default port B<25826> is assumed.
704 =item B<TimeToLive> I<1-255>
706 Set the time-to-live of sent packets. This applies to all, unicast and
707 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
708 That means that multicast packets will be sent with a TTL of C<1> (one) on most
709 operating systems.
711 =item B<Forward> I<true|false>
713 If set to I<true>, write packets that were received via the network plugin to
714 the sending sockets. This should only be activated when the B<Listen>- and
715 B<Server>-statements differ. Otherwise packets may be send multiple times to
716 the same multicast group. While this results in more network traffic than
717 necessary it's not a huge problem since the plugin has a duplicate detection,
718 so the values will not loop.
720 =item B<CacheFlush> I<Seconds>
722 For each host/plugin/type combination the C<network plugin> caches the time of
723 the last value being sent or received. Every I<Seconds> seconds the plugin
724 searches and removes all entries that are older than I<Seconds> seconds, thus
725 freeing the unused memory again. Since this process is somewhat expensive and
726 normally doesn't do much, this value should not be too small. The default is
727 1800 seconds, but setting this to 86400 seconds (one day) will not do much harm
728 either.
730 =back
732 =head2 Plugin C<nginx>
734 This plugin collects the number of connections and requests handled by the
735 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
736 queries the page provided by the C<ngx_http_stub_status_module> module, which
737 isn't compiled by default. Please refer to
738 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
739 how to compile and configure nginx and this module.
741 The following options are accepted by the C<nginx plugin>:
743 =over 4
745 =item B<URL> I<http://host/nginx_status>
747 Sets the URL of the C<ngx_http_stub_status_module> output.
749 =item B<User> I<Username>
751 Optional user name needed for authentication.
753 =item B<Password> I<Password>
755 Optional password needed for authentication.
757 =item B<CACert> I<File>
759 File that holds one or more SSL certificates. If you want to use HTTPS you will
760 possibly need this option. What CA certificates come bundled with C<libcurl>
761 and are checked by default depends on the distribution you use.
763 =back
765 =head2 Plugin C<ntpd>
767 =over 4
769 =item B<Host> I<Hostname>
771 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
773 =item B<Port> I<Port>
775 UDP-Port to connect to. Defaults to B<123>.
777 =item B<ReverseLookups> B<true>|B<false>
779 Sets wether or not to perform reverse lookups on peers. Since the name or
780 IP-address may be used in a filename it is recommended to disable reverse
781 lookups. The default is to do reverse lookups to preserve backwards
782 compatibility, though.
784 =back
786 =head2 Plugin C<nut>
788 =over 4
790 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
792 Add a UPS to collect data from. The format is identical to the one accepted by
793 L<upsc(8)>.
795 =back
797 =head2 Plugin C<perl>
799 This plugin embeds a Perl-interpreter into collectd and provides an interface
800 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
802 =head2 Plugin C<ping>
804 =over 4
806 =item B<Host> I<IP-address>
808 Host to ping periodically. This option may be repeated several times to ping
809 multiple hosts.
811 =item B<TTL> I<0-255>
813 Sets the Time-To-Live of generated ICMP packets.
815 =back
817 =head2 Plugin C<processes>
819 =over 4
821 =item B<Process> I<Name>
823 Select more detailed statistics of processes matching this name. The statistics
824 collected for these selected processes are size of the resident segment size
825 (RSS), user- and system-time used, number of processes and number of threads,
826 and minor and major pagefaults.
828 =back
830 =head2 Plugin C<rrdtool>
832 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
833 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
834 using these settings. If you don't want to dive into the depths of RRDTool, you
835 can safely ignore these settings.
837 =over 4
839 =item B<DataDir> I<Directory>
841 Set the directory to store RRD-files under. Per default RRD-files are generated
842 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
844 =item B<StepSize> I<Seconds>
846 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
847 this setting is unset and the stepsize is set to the interval in which the data
848 is collected. Do not use this option unless you absolutely have to for some
849 reason. Setting this option may cause problems with the C<snmp plugin>, the
850 C<exec plugin> or when the daemon is set up to receive data from other hosts.
852 =item B<HeartBeat> I<Seconds>
854 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
855 in which case the heartbeat is set to twice the B<StepSize> which should equal
856 the interval in which data is collected. Do not set this option unless you have
857 a very good reason to do so.
859 =item B<RRARows> I<NumRows>
861 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
862 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
863 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
864 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
865 week, one month, and one year.
867 So for each timespan, it calculates how many PDPs need to be consolidated into
868 one CDP by calculating:
869   number of PDPs = timespan / (stepsize * rrarows)
871 Bottom line is, set this no smaller than the width of you graphs in pixels. The
872 default is 1200.
874 =item B<RRATimespan> I<Seconds>
876 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
877 more then one RRA. If this option is never used, the built-in default of (3600,
878 86400, 604800, 2678400, 31622400) is used.
880 For more information on how RRA-sizes are calculated see B<RRARows> above.
882 =item B<XFF> I<Factor>
884 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
886 =item B<CacheFlush> I<Seconds>
888 When the C<rrdtool plugin> uses a cache (by setting B<CacheTimeout>, see below)
889 it writes all values for a certain RRD-file if the oldest value is older than
890 (or equal to) the number of seconds specified. If some RRD-file is not updated
891 anymore for some reason (the computer was shut down, the network is broken,
892 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
893 entire cache is searched for entries older than B<CacheTimeout> seconds and
894 written to disk every I<Seconds> seconds. Since this is kind of expensive and
895 does nothing under normal circumstances, this value should not be too small.
896 900 seconds might be a good value, though setting this to 7200 seconds doesn't
897 normally do much harm either.
899 =item B<CacheTimeout> I<Seconds>
901 If this option is set to a value greater than zero, the C<rrdtool plugin> will
902 save values in a cache, as described above. Writing multiple values at once
903 reduces IO-operations and thus lessens the load produced by updating the files.
904 The trade off is that the graphs kind of "drag behind" and that more memory is
905 used.
907 =back
909 =head2 Plugin C<sensors>
911 The C<sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
912 that all the needed modules have to be loaded and lm_sensors has to be
913 configured (most likely by editing F</etc/sensors.conf>. Read
914 L<sensors.conf(5)> for details.
916 The B<lm_sensors> homepage can be found at
917 L<http://secure.netroedge.com/~lm78/>.
919 =over 4
921 =item B<Sensor> I<chip-bus-address/type-feature>
923 Selects the name of the sensor which you want to collect or ignore, depending
924 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
925 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
926 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
928 =item B<IgnoreSelected> I<true>|I<false>
930 If no configuration if given, the B<sensors>-plugin will collect data from all
931 sensors. This may not be practical, especially for uninteresting sensors.
932 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
933 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
934 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
935 I<true> the effect of B<Sensor> is inversed: All selected sensors are ignored
936 and all other sensors are collected.
938 =back
940 =head2 Plugin C<snmp>
942 Since the configuration of the C<snmp plugin> is a little more complicated than
943 other plugins, its documentation has been moved to an own manpage,
944 L<collectd-snmp(5)>. Please see there for details.
946 =head2 Plugin C<syslog>
948 =over 4
950 =item B<LogLevel> B<debug|info|notice|warning|err>
952 Sets the log-level. If, for example, set to B<notice>, then all events with
953 severity B<notice>, B<warning>, or B<err> will be submitted to the
954 syslog-daemon.
956 Please note that B<debug> is only available if collectd has been compiled with
957 debugging support.
959 =back
961 =head2 Plugin C<tcpconns>
963 The C<tcpconns plugin> counts the number of currently established TCP
964 connections based on the local port and/or the remote port. Since there may be
965 a lot of connections the default if to count all connections with a local port,
966 for which a listening socket is opened. You can use the following options to
967 fine-tune the ports you are interested in:
969 =over 4
971 =item B<ListeningPorts> I<true>|I<false>
973 If this option is set to I<true>, statistics for all local ports for which a
974 listening socket exists are collected. The default depends on B<LocalPort> and
975 B<RemotePort> (see below): If no port at all is specifically selected, the
976 default is to collect listening ports. If specific ports (no matter if local or
977 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
978 the selected ports will be collected unless this option is set to I<true>
979 specifically.
981 =item B<LocalPort> I<Port>
983 Count the connections to a specific local port. This can be used to see how
984 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
985 You have to specify the port in numeric form, so for the mailserver example
986 you'd need to set B<25>.
988 =item B<RemotePort> I<Port>
990 Count the connections to a specific remote port. This is useful to see how
991 much a remote service is used. This is most useful if you want to know how many
992 connections a local service has opened to remote services, e.E<nbsp>g. how many
993 connections a mail server or news server has to other mail or news servers, or
994 how many connections a web proxy holds to web servers. You have to give the
995 port in numeric form.
997 =back
999 =head2 Plugin C<unixsock>
1001 =over 4
1003 =item B<SocketFile> I<Path>
1005 Sets the socket-file which is to be created.
1007 =item B<SocketGroup> I<Group>
1009 If running as root change the group of the UNIX-socket after it has been
1010 created. Defaults to B<collectd>.
1012 =item B<SocketPerms> I<Permissions>
1014 Change the file permissions of the UNIX-socket after it has been created. The
1015 permissions must be given as a numeric, octal value as you would pass to
1016 L<chmod(1)>. Defaults to B<0770>.
1018 =back
1020 =head2 Plugin C<uuid>
1022 This plugin, if loaded, causes the Hostname to be taken from the machine's
1023 UUID. The UUID is a universally unique designation for the machine, usually
1024 taken from the machine's BIOS. This is most useful if the machine is running in
1025 a virtual environment such as Xen, in which case the UUID is preserved across
1026 shutdowns and migration.
1028 The following methods are used to find the machine's UUID, in order:
1030 =over 4
1032 =item
1034 Check I</etc/uuid> (or I<UUIDFile>).
1036 =item
1038 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
1039 present.
1041 =item
1043 Check for UUID from C<dmidecode> / SMBIOS.
1045 =item
1047 Check for UUID from Xen hypervisor.
1049 =back
1051 If no UUID can be found then the hostname is not modified.
1053 =over 4
1055 =item B<UUIDFile> I<Path>
1057 Take the UUID from the given file (default I</etc/uuid>).
1059 =back
1061 =head2 Plugin C<vserver>
1063 This plugin doesn't have any options. B<VServer> support is only available for
1064 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
1065 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
1066 need to apply the patches and compile your own kernel, which will then provide
1067 the F</proc/virtual> filesystem that is required by this plugin.
1069 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
1071 =head1 THRESHOLD CONFIGURATION
1073 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
1074 we mean that the values are not only stored or sent somewhere, but that they
1075 are judged and, if a problem is recognized, acted upon. The only action
1076 collectd takes itself is to generate and dispatch a "notification". Plugins can
1077 register to receive notifications and perform appropriate further actions.
1079 Since systems and what you expect them to do differ a lot, you can configure
1080 B<thresholds> for your values freely. This gives you a lot of flexibility but
1081 also a lot of responsibility.
1083 Every time a value is out of range a notification is dispatched. This means
1084 that the idle percentage of your CPU needs to be less then the configured
1085 threshold only once for a notification to be generated. There's no such thing
1086 as a moving average or similar - at least not now.
1088 Also, all values that match a threshold are considered to be relevant or
1089 "interesting". As a consequence collectd will issue a notification if they are
1090 not received for twice the last timeout of the values. If, for example, some
1091 hosts sends it's CPU statistics to the server every 60 seconds, a notification
1092 will be dispatched after about 120 seconds. It may take a little longer because
1093 the timeout is checked only once each B<Interval> on the server.
1095 Here is a configuration example to get you started. Read below for more
1096 information.
1098  <Threshold>
1099    <Type "foo">
1100      WarningMin    0.00
1101      WarningMax 1000.00
1102      FailureMin    0.00
1103      FailureMax 1200.00
1104      Invert false
1105      Instance "bar"
1106    </Type>
1108    <Plugin "interface">
1109      Instance "eth0"
1110      <Type "if_octets">
1111        FailureMax 10000000
1112      </Type>
1113    </Plugin>
1115    <Host "hostname">
1116      <Type "cpu">
1117        Instance "idle"
1118        FailureMin 10
1119      </Type>
1121      <Plugin "memory">
1122        <Type "memory">
1123          Instance "cached"
1124          WarningMin 100000000
1125        </Type>
1126      </Plugin>
1127    </Host>
1128  </Threshold>
1130 There are basically two types of configuration statements: The C<Host>,
1131 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
1132 configured. The C<Plugin> and C<Type> blocks may be specified further using the
1133 C<Instance> option. You can combine the block by nesting the blocks, though
1134 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
1135 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
1136 C<Type> may not contain other blocks. If multiple blocks apply to the same
1137 value the most specific block is used.
1139 The other statements specify the threshold to configure. They B<must> be
1140 included in a C<Type> block. Currently the following statements are recognized:
1142 =over 4
1144 =item B<FailureMax> I<Value>
1146 =item B<WarningMax> I<Value>
1148 Sets the upper bound of acceptable values. If unset defaults to positive
1149 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
1150 will be created. If the value is greater than B<WarningMax> but less than (or
1151 equal to) B<FailureMax> a B<WARNING> notification will be created.
1153 =item B<FailureMin> I<Value>
1155 =item B<WarningMin> I<Value>
1157 Sets the lower bound of acceptable values. If unset defaults to negative
1158 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
1159 be created. If the value is less than B<WarningMin> but greater than (or equal
1160 to) B<FailureMin> a B<WARNING> notification will be created.
1162 =item B<Invert> B<true>|B<false>
1164 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
1165 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
1166 B<WarningMax>) are not okay. Defaults to B<false>.
1168 =item B<Persist> B<true>|B<false>
1170 Sets how often notifications are generated. If set to B<true> one notification
1171 will be generated for each value that is out of the acceptable range. If set to
1172 B<false> (the default) then a notification is only generated if a value is out
1173 of range but the previous value was okay.
1175 This applies to missing values, too: If set to B<true> a notification about a
1176 missing value is generated once every B<Interval> seconds. If set to B<false>
1177 only one such notification is generated until the value appears again.
1179 =back
1181 =head1 SEE ALSO
1183 L<collectd(1)>,
1184 L<collectd-exec(5)>,
1185 L<collectd-perl(5)>,
1186 L<collectd-unixsock(5)>,
1187 L<types.db(5)>,
1188 L<hddtemp(8)>,
1189 L<kstat(3KSTAT)>,
1190 L<mbmon(1)>,
1191 L<rrdtool(1)>,
1192 L<sensors(1)>
1194 =head1 AUTHOR
1196 Florian Forster E<lt>octo@verplant.orgE<gt>
1198 =cut