Merge branch 'collectd-4.3'
[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 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.
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<Include> I<Path>
57
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:
63
64   Include "/etc/collectd.d/*.conf"
65
66 If more than one files are included by a single B<Include> option, the files
67 will be included in lexicographical order (as defined by the C<strcmp>
68 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
69 order in which the files are loaded.
70
71 To prevent loops and shooting yourself in the foot in interesting ways the
72 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
73 most uses. Since symlinks are followed it is still possible to crash the daemon
74 by looping symlinks. In our opinion significant stupidity should result in an
75 appropriate amount of pain.
76
77 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
78 file, but you cannot include files from within blocks.
79
80 =item B<PIDFile> I<File>
81
82 Sets where to write the PID file to. This file is overwritten when it exists
83 and deleted when the program is stopped. Some init-scripts might override this
84 setting using the B<-P> command-line option.
85
86 =item B<PluginDir> I<Directory>
87
88 Path to the plugins (shared objects) of collectd.
89
90 =item B<TypesDB> I<File> [I<File> ...]
91
92 Set one or more files that contain the data-set descriptions. See
93 L<types.db(5)> for a description of the format of this file.
94
95 =item B<Interval> I<Seconds>
96
97 Configures the interval in which to query the read plugins. Obviously smaller
98 values lead to a higher system load produced by collectd, while higher values
99 lead to more coarse statistics.
100
101 =item B<ReadThreads> I<Num>
102
103 Number of threads to start for reading plugins. The default value is B<5>, but
104 you may want to increase this if you have more than five plugins that take a
105 long time to read. Mostly those are plugin that do network-IO. Setting this to
106 a value higher than the number of plugins you've loaded is totally useless.
107
108 =item B<Hostname> I<Name>
109
110 Sets the hostname that identifies a host. If you omit this setting, the
111 hostname will be determinded using the L<gethostname(2)> system call.
112
113 =item B<FQDNLookup> B<true|false>
114
115 If B<Hostname> is determined automatically this setting controls whether or not
116 the daemon should try to figure out the "fully qualified domain name", FQDN.
117 This is done using a lookup of the name returned by C<gethostname>.
118
119 Using this feature (i.E<nbsp>e. setting this option to B<true>) is recommended.
120 However, to preserve backwards compatibility the default is set to B<false>.
121 The sample config file that is installed with C<makeE<nbsp>install> includes a
122 line which sets this option, though, so that default installations will have
123 this setting enabled.
124
125 =back
126
127 =head1 PLUGIN OPTIONS
128
129 Some plugins may register own options. These options must be enclosed in a
130 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
131 require external configuration, too. The C<apache plugin>, for example,
132 required C<mod_status> to be configured in the webserver you're going to
133 collect data from. These plugins are listed below as well, even if they don't
134 require any configuration within collectd's configfile.
135
136 A list of all plugins and a short summary for each plugin can be found in the
137 F<README> file shipped with the sourcecode and hopefully binary packets as
138 well.
139
140 =head2 Plugin C<apache>
141
142 To configure the C<apache>-plugin you first need to configure the Apache
143 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
144 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
145 the following snipped to base your Apache config upon:
146
147   ExtendedStatus on
148   <IfModule mod_status.c>
149     <Location /mod_status>
150       SetHandler server-status
151     </Location>
152   </IfModule>
153
154 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
155 also supported. It introduces a new field, called C<BusyServers>, to count the
156 number of currently connected clients. This field is also supported.
157
158 The following options are accepted by the C<apache>-plugin:
159
160 =over 4
161
162 =item B<URL> I<http://host/mod_status?auto>
163
164 Sets the URL of the C<mod_status> output. This needs to be the output generated
165 by C<ExtendedStatus on> and it needs to be the machine readable output
166 generated by appending the C<?auto> argument.
167
168 =item B<User> I<Username>
169
170 Optional user name needed for authentication.
171
172 =item B<Password> I<Password>
173
174 Optional password needed for authentication.
175
176 =item B<VerifyPeer> B<true|false>
177
178 Enable or disable peer SSL certificate verification. See
179 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
180
181 =item B<VerifyHost> B<true|false>
182
183 Enable or disable peer host name verification. If enabled, the plugin checks
184 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
185 certificate matches the host name provided by the B<URL> option. If this
186 identity check fails, the connection is aborted. Obviously, only works when
187 connecting to a SSL enabled server. Enabled by default.
188
189 =item B<CACert> I<File>
190
191 File that holds one or more SSL certificates. If you want to use HTTPS you will
192 possibly need this option. What CA certificates come bundled with C<libcurl>
193 and are checked by default depends on the distribution you use.
194
195 =back
196
197 =head2 Plugin C<apcups>
198
199 =over 4
200
201 =item B<Host> I<Hostname>
202
203 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
204 that IPv6 support has been disabled unless someone can confirm or decline that
205 B<apcupsd> can handle it.
206
207 =item B<Port> I<Port>
208
209 TCP-Port to connect to. Defaults to B<3551>.
210
211 =back
212
213 =head2 Plugin C<ascent>
214
215 This plugin collects information about an Ascent server, a free server for the
216 "World of Warcraft" game. This plugin gathers the information by fetching the
217 XML status page using C<libcurl> and parses it using C<libxml2>.
218
219 The configuration options are the same as for the C<apache> plugin above:
220
221 =over 4
222
223 =item B<URL> I<http://localhost/ascent/status/>
224
225 Sets the URL of the XML status output.
226
227 =item B<User> I<Username>
228
229 Optional user name needed for authentication.
230
231 =item B<Password> I<Password>
232
233 Optional password needed for authentication.
234
235 =item B<CACert> I<File>
236
237 File that holds one or more SSL certificates. If you want to use HTTPS you will
238 possibly need this option. What CA certificates come bundled with C<libcurl>
239 and are checked by default depends on the distribution you use.
240
241 =back
242
243 =head2 Plugin C<cpufreq>
244
245 This plugin doesn't have any options. It reads
246 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
247 installed) to get the current CPU frequency. If this file does not exist make
248 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
249 installed and an "cpu governor" (that's a kernel module) is loaded.
250
251 =head2 Plugin C<csv>
252
253 =over 4
254
255 =item B<DataDir> I<Directory>
256
257 Set the directory to store CSV-files under. Per default CSV-files are generated
258 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
259
260 =item B<StoreRates> B<true|false>
261
262 If set to B<true>, convert counter values to rates. If set to B<false> (the
263 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
264 number.
265
266 =back
267
268 =head2 Plugin C<df>
269
270 =over 4
271
272 =item B<Device> I<Device>
273
274 Select partitions based on the devicename.
275
276 =item B<MountPoint> I<Directory>
277
278 Select partitions based on the mountpoint.
279
280 =item B<FSType> I<FSType>
281
282 Select partitions based on the filesystem type.
283
284 =item B<IgnoreSelected> I<true>|I<false>
285
286 Invert the selection: If set to true, all partitions B<except> the ones that
287 match any one of the criteria are collected. By default only selected
288 partitions are collected if a selection is made. If no selection is configured
289 at all, B<all> partitions are selected.
290
291 =back
292
293 =head2 Plugin C<disk>
294
295 The C<disk> plugin collects information about the usage of physical disks and
296 logical disks (partitions). Values collected are the number of octets written
297 to and read from a disk or partition, the number of read/write operations
298 issued to the disk and a rather complex "time" it took for these commands to be
299 issued.
300
301 Using the following two options you can ignore some disks or configure the
302 collection only of specific disks.
303
304 =over 4
305
306 =item B<Disk> I<Name>
307
308 Select the disk I<Name>. Whether it is collected or ignored depends on the
309 B<IgnoreSelected> setting, see below. As with other plugins that use the
310 daemon's ignorelist functionality, a string that starts and ends with a slash
311 is interpreted as a regular expression. Examples:
312
313   Disk "sdd"
314   Disk "/hda[34]/"
315
316 =item B<IgnoreSelected> B<true>|B<false>
317
318 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
319 statements, are ignored or if all other disks are ignored. The behavior
320 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
321 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
322 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
323 is set to B<true>, all disks are collected B<except> the ones matched.
324
325 =back
326
327 =head2 Plugin C<dns>
328
329 =over 4
330
331 =item B<Interface> I<Interface>
332
333 The dns plugin uses B<libpcap> to capture dns traffic and analyses it. This
334 option sets the interface that should be used. If this option is not set, or
335 set to "any", the plugin will try to get packets from B<all> interfaces. This
336 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
337
338 =item B<IgnoreSource> I<IP-address>
339
340 Ignore packets that originate from this address.
341
342 =back
343
344 =head2 Plugin C<email>
345
346 =over 4
347
348 =item B<SocketFile> I<Path>
349
350 Sets the socket-file which is to be created.
351
352 =item B<SocketGroup> I<Group>
353
354 If running as root change the group of the UNIX-socket after it has been
355 created. Defaults to B<collectd>.
356
357 =item B<SocketPerms> I<Permissions>
358
359 Change the file permissions of the UNIX-socket after it has been created. The
360 permissions must be given as a numeric, octal value as you would pass to
361 L<chmod(1)>. Defaults to B<0770>.
362
363 =item B<MaxConns> I<Number>
364
365 Sets the maximum number of connections that can be handled in parallel. Since
366 this many threads will be started immediately setting this to a very high
367 value will waste valuable resources. Defaults to B<5> and will be forced to be
368 at most B<16384> to prevent typos and dumb mistakes.
369
370 =back
371
372 =head2 Plugin C<exec>
373
374 Please make sure to read L<collectd-exec(5)> before using this plugin. It
375 contains valuable information on when the executable is executed and the
376 output that is expected from it.
377
378 =over 4
379
380 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
381
382 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
383
384 Execute the executable I<Executable> as user I<User>. If the user name is
385 followed by a colon and a group name, the effective group is set to that group.
386 The real group and saved-set group will be set to the default group of that
387 user. If no group is given the effective group ID will be the same as the real
388 group ID.
389
390 Please note that in order to change the user and/or group the daemon needs
391 superuser privileges. If the daemon is run as an unprivileged user you must
392 specify the same user/group here. If the daemon is run with superuser
393 privileges, you must supply a non-root user here.
394
395 The executable may be followed by optional arguments that are passed to the
396 program. Please note that due to the configuration parsing numbers and boolean
397 values may be changed. If you want to be absolutely sure that something is
398 passed as-is please enclose it in quotes.
399
400 The B<Exec> and B<NotificationExec> statements change the semantics of the
401 programs executed, i.E<nbsp>e. the data passed to them and the response
402 expected from them. This is documented in great detail in L<collectd-exec(5)>.
403
404 =back
405
406 =head2 Plugin C<hddtemp>
407
408 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
409 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
410 default values, see below. C<hddtemp> has to be running to work correctly. If
411 C<hddtemp> is not running timeouts may appear which may interfere with other
412 statistics..
413
414 The B<hddtemp> homepage can be found at
415 L<http://www.guzu.net/linux/hddtemp.php>.
416
417 =over 4
418
419 =item B<Host> I<Hostname>
420
421 Hostname to connect to. Defaults to B<127.0.0.1>.
422
423 =item B<Port> I<Port>
424
425 TCP-Port to connect to. Defaults to B<7634>.
426
427 =item B<TranslateDevicename> I<true>|I<false>
428
429 If enabled, translate the disk names to major/minor device numbers
430 (e.E<nbsp>g. "8-0" for /dev/sda). For backwards compatibility this defaults to
431 I<true> but it's recommended to disable it as it will probably be removed in
432 the next major version.
433
434 =back
435
436 =head2 Plugin C<interface>
437
438 =over 4
439
440 =item B<Interface> I<Interface>
441
442 Select this interface. By default these interfaces will then be collected. For
443 a more detailed description see B<IgnoreSelected> below.
444
445 =item B<IgnoreSelected> I<true>|I<false>
446
447 If no configuration if given, the B<traffic>-plugin will collect data from
448 all interfaces. This may not be practical, especially for loopback- and
449 similar interfaces. Thus, you can use the B<Interface>-option to pick the
450 interfaces you're interested in. Sometimes, however, it's easier/preferred
451 to collect all interfaces I<except> a few ones. This option enables you to
452 do that: By setting B<IgnoreSelected> to I<true> the effect of
453 B<Interface> is inversed: All selected interfaces are ignored and all
454 other interfaces are collected.
455
456 =back
457
458 =head2 Plugin C<iptables>
459
460 =over 4
461
462 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
463
464 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
465 will collect the counters of all rules which have a comment-match. The comment
466 is then used as type-instance.
467
468 If I<Comment> or I<Number> is given, only the rule with the matching comment or
469 the I<n>th rule will be collected. Again, the comment (or the number) will be
470 used as the type-instance.
471
472 If I<Name> is supplied, it will be used as the type-instance instead of the
473 comment or the number.
474
475 =back
476
477 =head2 Plugin C<irq>
478
479 =over 4
480
481 =item B<Irq> I<Irq>
482
483 Select this irq. By default these irqs will then be collected. For a more
484 detailed description see B<IgnoreSelected> below.
485
486 =item B<IgnoreSelected> I<true>|I<false>
487
488 If no configuration if given, the B<irq>-plugin will collect data from all
489 irqs. This may not be practical, especially if no interrupts happen. Thus, you
490 can use the B<Irq>-option to pick the interrupt you're interested in.
491 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
492 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
493 I<true> the effect of B<Irq> is inversed: All selected interrupts are ignored
494 and all other interrupts are collected.
495
496 =back
497
498 =head2 Plugin C<libvirt>
499
500 This plugin allows CPU, disk and network load to be collected for virtualized
501 guests on the machine. This means that these characteristics can be collected
502 for guest systems without installing any software on them - collectd only runs
503 on the hosting system. The statistics are collected through libvirt
504 (L<http://libvirt.org/>).
505
506 Only I<Connection> is required.
507
508 =over 4
509
510 =item B<Connection> I<uri>
511
512 Connect to the hypervisor given by I<uri>. For example if using Xen use:
513
514  Connection "xen:///"
515
516 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
517
518 =item B<RefreshInterval> I<seconds>
519
520 Refresh the list of domains and devices every I<seconds>. The default is 60
521 seconds. Setting this to be the same or smaller than the I<Interval> will cause
522 the list of domains and devices to be refreshed on every iteration.
523
524 Refreshing the devices in particular is quite a costly operation, so if your
525 virtualization setup is static you might consider increasing this. If this
526 option is set to 0, refreshing is disabled completely.
527
528 =item B<Domain> I<name>
529
530 =item B<BlockDevice> I<name:dev>
531
532 =item B<InterfaceDevice> I<name:dev>
533
534 =item B<IgnoreSelected> I<true>|I<false>
535
536 Select which domains and devices are collected.
537
538 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
539 disk/network devices are collected.
540
541 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
542 domains and disk/network devices are ignored, while the rest are collected.
543
544 The domain name and device names may use a regular expression, if the name is
545 surrounded by I</.../> and collectd was compiled with support for regexps.
546
547 The default is to collect statistics for all domains and all their devices.
548
549 Example:
550
551  BlockDevice "/:hdb/"
552  IgnoreSelected "true"
553
554 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
555 will be collected.
556
557 =item B<HostnameFormat> B<name|uuid|hostname|...>
558
559 When the libvirt plugin logs data, it sets the hostname of the collected data
560 according to this setting. The default is to use the guest name as provided by
561 the hypervisor, which is equal to setting B<name>.
562
563 B<uuid> means use the guest's UUID. This is useful if you want to track the
564 same guest across migrations.
565
566 B<hostname> means to use the global B<Hostname> setting, which is probably not
567 useful on its own because all guests will appear to have the same name.
568
569 You can also specify combinations of these fields. For example B<name uuid>
570 means to concatenate the guest name and UUID (with a literal colon character
571 between, thus I<"foo:1234-1234-1234-1234">).
572
573 =back
574
575 =head2 Plugin C<logfile>
576
577 =over 4
578
579 =item B<LogLevel> B<debug|info|notice|warning|err>
580
581 Sets the log-level. If, for example, set to B<notice>, then all events with
582 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
583
584 Please note that B<debug> is only available if collectd has been compiled with
585 debugging support.
586
587 =item B<File> I<File>
588
589 Sets the file to write log messages to. The special strings B<stdout> and
590 B<stderr> can be used to write to the standard output and standard error
591 channels, respectively. This, of course, only makes much sense when collectd is
592 running in foreground- or non-daemon-mode.
593
594 =item B<Timestamp> B<true>|B<false>
595
596 Prefix all lines printed by the current time. Defaults to B<true>.
597
598 =back
599
600 =head2 Plugin C<mbmon>
601
602 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
603
604 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
605 B<Host> and B<Port> options can be used to change these values, see below.
606 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
607 timeouts may appear which may interfere with other statistics..
608
609 C<mbmon> must be run with the -r option ("print TAG and Value format");
610 Debian's F</etc/init.d/mbmon> script already does this, other people
611 will need to ensure that this is the case.
612
613 =over 4
614
615 =item B<Host> I<Hostname>
616
617 Hostname to connect to. Defaults to B<127.0.0.1>.
618
619 =item B<Port> I<Port>
620
621 TCP-Port to connect to. Defaults to B<411>.
622
623 =back
624
625 =head2 Plugin C<memcached>
626
627 The C<memcached plugin> connects to a memcached server and queries statistics
628 about cache utilization, memory and bandwidth used.
629 L<http://www.danga.com/memcached/>
630
631 =over 4
632
633 =item B<Host> I<Hostname>
634
635 Hostname to connect to. Defaults to B<127.0.0.1>.
636
637 =item B<Port> I<Port>
638
639 TCP-Port to connect to. Defaults to B<11211>.
640
641 =back
642
643 =head2 Plugin C<mysql>
644
645 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to the
646 database when started and keeps the connection up as long as possible. When the
647 connection is interrupted for whatever reason it will try to re-connect. The
648 plugin will complaint loudly in case anything goes wrong.
649
650 This plugin issues C<SHOW STATUS> and evaluates C<Bytes_{received,sent}>,
651 C<Com_*> and C<Handler_*> which correspond to F<mysql_octets.rrd>,
652 F<mysql_commands-*.rrd> and F<mysql_handler-*.rrd>. Also, the values of
653 C<Qcache_*> are put in F<mysql_qcache.rrd> and values of C<Threads_*> are put
654 in F<mysql_threads.rrd>. Please refer to the B<MySQL reference manual>,
655 I<5.2.4. Server Status Variables> for an explanation of these values.
656
657 Use the following options to configure the plugin:
658
659 =over 4
660
661 =item B<Host> I<Hostname>
662
663 Hostname of the database server. Defaults to B<localhost>.
664
665 =item B<User> I<Username>
666
667 Username to use when connecting to the database.
668
669 =item B<Password> I<Password>
670
671 Password needed to log into the database.
672
673 =item B<Database> I<Database>
674
675 Select this database. Defaults to I<no database> which is a perfectly reasonable
676 option for what this plugin does.
677
678 =back
679
680 =head2 Plugin C<netlink>
681
682 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
683 statistics of various interface and routing aspects.
684
685 =over 4
686
687 =item B<Interface> I<Interface>
688
689 =item B<VerboseInterface> I<Interface>
690
691 Instruct the plugin to collect interface statistics. This is basically the same
692 as the statistics provided by the C<interface> plugin (see above) but
693 potentially much more detailed.
694
695 When configuring with B<Interface> only the basic statistics will be collected,
696 namely octets, packets, and errors. These statistics are collected by
697 the C<interface> plugin, too, so using both at the same time is no benefit.
698
699 When configured with B<VerboseInterface> all counters B<except> the basic ones,
700 so that no data needs to be collected twice if you use the C<interface> plugin.
701 This includes dropped packets, received multicast packets, collisions and a
702 whole zoo of differentiated RX and TX errors. You can try the following command
703 to get an idea of what awaits you:
704
705   ip -s -s link list
706
707 If I<Interface> is B<All>, all interfaces will be selected.
708
709 =item B<QDisc> I<Interface> [I<QDisc>]
710
711 =item B<Class> I<Interface> [I<Class>]
712
713 =item B<Filter> I<Interface> [I<Filter>]
714
715 Collect the octets and packets that pass a certain qdisc, class or filter.
716
717 QDiscs and classes are identified by their type and handle (or classid).
718 Filters don't necessarily have a handle, therefore the parent's handle is used.
719 The notation used in collectd differs from that used in tc(1) in that it
720 doesn't skip the major or minor number if it's zero and doesn't print special
721 ids by their name. So, for example, a qdisc may be identified by
722 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
723 thus not displayed by tc(1).
724
725 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
726 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
727 associated with that interface will be collected.
728
729 Since a filter itself doesn't necessarily have a handle, the parent's handle is
730 used. This may lead to problems when more than one filter is attached to a
731 qdisc or class. This isn't nice, but we don't know how this could be done any
732 better. If you have a idea, please don't hesitate to tell us.
733
734 As with the B<Interface> option you can specify B<All> as the interface,
735 meaning all interfaces.
736
737 Here are some examples to help you understand the above text more easily:
738
739   <Plugin netlink>
740     VerboseInterface "All"
741     QDisc "eth0" "pfifo_fast-1:0"
742     QDisc "ppp0"
743     Class "ppp0" "htb-1:10"
744     Filter "ppp0" "u32-1:0"
745   </Plugin>
746
747 =item B<IgnoreSelected>
748
749 The behaviour is the same as with all other similar plugins: If nothing is
750 selected at all, everything is collected. If some things are selected using the
751 options described above, only these statistics are collected. If you set
752 B<IgnoreSelected> to B<true>, this behavior is inversed, i.E<nbsp>e. the
753 specified statistics will not be collected.
754
755 =back
756
757 =head2 Plugin C<network>
758
759 =over 4
760
761 =item B<Listen> I<Host> [I<Port>]
762
763 =item B<Server> I<Host> [I<Port>]
764
765 The B<Server> statement sets the server to send datagrams B<to>.  The statement
766 may occur multiple times to send each datagram to multiple destinations.
767
768 The B<Listen> statement sets the interfaces to bind to. When multiple
769 statements are found the daemon will bind to multiple interfaces.
770
771 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
772 the argument is a multicast address the daemon will join that multicast group.
773
774 If no B<Listen> statement is found the server tries join both, the default IPv6
775 multicast group and the default IPv4 multicast group. If no B<Server> statement
776 is found the client will try to send data to the IPv6 multicast group first. If
777 that fails the client will try the IPv4 multicast group.
778
779 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
780 multicast group is C<239.192.74.66>.
781
782 The optional I<Port> argument sets the port to use. It can either be given
783 using a numeric port number or a service name. If the argument is omitted the
784 default port B<25826> is assumed.
785
786 =item B<TimeToLive> I<1-255>
787
788 Set the time-to-live of sent packets. This applies to all, unicast and
789 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
790 That means that multicast packets will be sent with a TTL of C<1> (one) on most
791 operating systems.
792
793 =item B<Forward> I<true|false>
794
795 If set to I<true>, write packets that were received via the network plugin to
796 the sending sockets. This should only be activated when the B<Listen>- and
797 B<Server>-statements differ. Otherwise packets may be send multiple times to
798 the same multicast group. While this results in more network traffic than
799 necessary it's not a huge problem since the plugin has a duplicate detection,
800 so the values will not loop.
801
802 =item B<CacheFlush> I<Seconds>
803
804 For each host/plugin/type combination the C<network plugin> caches the time of
805 the last value being sent or received. Every I<Seconds> seconds the plugin
806 searches and removes all entries that are older than I<Seconds> seconds, thus
807 freeing the unused memory again. Since this process is somewhat expensive and
808 normally doesn't do much, this value should not be too small. The default is
809 1800 seconds, but setting this to 86400 seconds (one day) will not do much harm
810 either.
811
812 =back
813
814 =head2 Plugin C<nginx>
815
816 This plugin collects the number of connections and requests handled by the
817 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
818 queries the page provided by the C<ngx_http_stub_status_module> module, which
819 isn't compiled by default. Please refer to
820 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
821 how to compile and configure nginx and this module.
822
823 The following options are accepted by the C<nginx plugin>:
824
825 =over 4
826
827 =item B<URL> I<http://host/nginx_status>
828
829 Sets the URL of the C<ngx_http_stub_status_module> output.
830
831 =item B<User> I<Username>
832
833 Optional user name needed for authentication.
834
835 =item B<Password> I<Password>
836
837 Optional password needed for authentication.
838
839 =item B<VerifyPeer> B<true|false>
840
841 Enable or disable peer SSL certificate verification. See
842 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
843
844 =item B<VerifyHost> B<true|false>
845
846 Enable or disable peer host name verification. If enabled, the plugin checks
847 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
848 certificate matches the host name provided by the B<URL> option. If this
849 identity check fails, the connection is aborted. Obviously, only works when
850 connecting to a SSL enabled server. Enabled by default.
851
852 =item B<CACert> I<File>
853
854 File that holds one or more SSL certificates. If you want to use HTTPS you will
855 possibly need this option. What CA certificates come bundled with C<libcurl>
856 and are checked by default depends on the distribution you use.
857
858 =back
859
860 =head2 Plugin C<ntpd>
861
862 =over 4
863
864 =item B<Host> I<Hostname>
865
866 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
867
868 =item B<Port> I<Port>
869
870 UDP-Port to connect to. Defaults to B<123>.
871
872 =item B<ReverseLookups> B<true>|B<false>
873
874 Sets wether or not to perform reverse lookups on peers. Since the name or
875 IP-address may be used in a filename it is recommended to disable reverse
876 lookups. The default is to do reverse lookups to preserve backwards
877 compatibility, though.
878
879 =back
880
881 =head2 Plugin C<nut>
882
883 =over 4
884
885 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
886
887 Add a UPS to collect data from. The format is identical to the one accepted by
888 L<upsc(8)>.
889
890 =back
891
892 =head2 Plugin C<perl>
893
894 This plugin embeds a Perl-interpreter into collectd and provides an interface
895 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
896
897 =head2 Plugin C<ping>
898
899 =over 4
900
901 =item B<Host> I<IP-address>
902
903 Host to ping periodically. This option may be repeated several times to ping
904 multiple hosts.
905
906 =item B<TTL> I<0-255>
907
908 Sets the Time-To-Live of generated ICMP packets.
909
910 =back
911
912 =head2 Plugin C<processes>
913
914 =over 4
915
916 =item B<Process> I<Name>
917
918 Select more detailed statistics of processes matching this name. The statistics
919 collected for these selected processes are size of the resident segment size
920 (RSS), user- and system-time used, number of processes and number of threads,
921 and minor and major pagefaults.
922
923 =back
924
925 =head2 Plugin C<rrdtool>
926
927 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
928 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
929 using these settings. If you don't want to dive into the depths of RRDTool, you
930 can safely ignore these settings.
931
932 =over 4
933
934 =item B<DataDir> I<Directory>
935
936 Set the directory to store RRD-files under. Per default RRD-files are generated
937 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
938
939 =item B<StepSize> I<Seconds>
940
941 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
942 this setting is unset and the stepsize is set to the interval in which the data
943 is collected. Do not use this option unless you absolutely have to for some
944 reason. Setting this option may cause problems with the C<snmp plugin>, the
945 C<exec plugin> or when the daemon is set up to receive data from other hosts.
946
947 =item B<HeartBeat> I<Seconds>
948
949 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
950 in which case the heartbeat is set to twice the B<StepSize> which should equal
951 the interval in which data is collected. Do not set this option unless you have
952 a very good reason to do so.
953
954 =item B<RRARows> I<NumRows>
955
956 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
957 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
958 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
959 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
960 week, one month, and one year.
961
962 So for each timespan, it calculates how many PDPs need to be consolidated into
963 one CDP by calculating:
964   number of PDPs = timespan / (stepsize * rrarows)
965
966 Bottom line is, set this no smaller than the width of you graphs in pixels. The
967 default is 1200.
968
969 =item B<RRATimespan> I<Seconds>
970
971 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
972 more then one RRA. If this option is never used, the built-in default of (3600,
973 86400, 604800, 2678400, 31622400) is used.
974
975 For more information on how RRA-sizes are calculated see B<RRARows> above.
976
977 =item B<XFF> I<Factor>
978
979 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
980
981 =item B<CacheFlush> I<Seconds>
982
983 When the C<rrdtool plugin> uses a cache (by setting B<CacheTimeout>, see below)
984 it writes all values for a certain RRD-file if the oldest value is older than
985 (or equal to) the number of seconds specified. If some RRD-file is not updated
986 anymore for some reason (the computer was shut down, the network is broken,
987 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
988 entire cache is searched for entries older than B<CacheTimeout> seconds and
989 written to disk every I<Seconds> seconds. Since this is kind of expensive and
990 does nothing under normal circumstances, this value should not be too small.
991 900 seconds might be a good value, though setting this to 7200 seconds doesn't
992 normally do much harm either.
993
994 =item B<CacheTimeout> I<Seconds>
995
996 If this option is set to a value greater than zero, the C<rrdtool plugin> will
997 save values in a cache, as described above. Writing multiple values at once
998 reduces IO-operations and thus lessens the load produced by updating the files.
999 The trade off is that the graphs kind of "drag behind" and that more memory is
1000 used.
1001
1002 =back
1003
1004 =head2 Plugin C<sensors>
1005
1006 The C<sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
1007 that all the needed modules have to be loaded and lm_sensors has to be
1008 configured (most likely by editing F</etc/sensors.conf>. Read
1009 L<sensors.conf(5)> for details.
1010
1011 The B<lm_sensors> homepage can be found at
1012 L<http://secure.netroedge.com/~lm78/>.
1013
1014 =over 4
1015
1016 =item B<Sensor> I<chip-bus-address/type-feature>
1017
1018 Selects the name of the sensor which you want to collect or ignore, depending
1019 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
1020 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
1021 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
1022
1023 =item B<IgnoreSelected> I<true>|I<false>
1024
1025 If no configuration if given, the B<sensors>-plugin will collect data from all
1026 sensors. This may not be practical, especially for uninteresting sensors.
1027 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
1028 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
1029 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
1030 I<true> the effect of B<Sensor> is inversed: All selected sensors are ignored
1031 and all other sensors are collected.
1032
1033 =back
1034
1035 =head2 Plugin C<snmp>
1036
1037 Since the configuration of the C<snmp plugin> is a little more complicated than
1038 other plugins, its documentation has been moved to an own manpage,
1039 L<collectd-snmp(5)>. Please see there for details.
1040
1041 =head2 Plugin C<syslog>
1042
1043 =over 4
1044
1045 =item B<LogLevel> B<debug|info|notice|warning|err>
1046
1047 Sets the log-level. If, for example, set to B<notice>, then all events with
1048 severity B<notice>, B<warning>, or B<err> will be submitted to the
1049 syslog-daemon.
1050
1051 Please note that B<debug> is only available if collectd has been compiled with
1052 debugging support.
1053
1054 =back
1055
1056 =head2 Plugin C<tail>
1057
1058 The C<tail plugin> plugins follows logfiles, just like L<tail(1)> does, parses
1059 each line and dispatches found values. What is matched can be configured by the
1060 user using (extended) regular expressions, as described in L<regex(7)>.
1061
1062   <Plugin "tail">
1063     <File "/var/log/exim4/mainlog">
1064       Instance "exim"
1065       <Match>
1066         Regex "S=([1-9][0-9]*)"
1067         DSType "CounterAdd"
1068         Type "ipt_bytes"
1069         Instance "total"
1070       </Match>
1071       <Match>
1072         Regex "\\<R=local_user\\>"
1073         DSType "CounterInc"
1074         Type "email_count"
1075         Instance "local_user"
1076       </Match>
1077     </File>
1078   </Plugin>
1079
1080 The config consists of one or more B<File> blocks, each of which configures one
1081 logfile to parse. Within each B<File> block, there are one or more B<Match>
1082 blocks, which configure a regular expression to search for.
1083
1084 The B<Instance> option in the B<File> block may be used to set the plugin
1085 instance. So in the above example the plugin name C<tail-foo> would be used.
1086 This plugin instance is for all B<Match> blocks that B<follow> it, until the
1087 next B<Instance> option. This way you can extract several plugin instances from
1088 one logfile, handy when parsing syslog and the like.
1089
1090 Each B<Match> block has the following options to describe how the match should
1091 be performed:
1092
1093 =over 4
1094
1095 =item B<Regex> I<regex>
1096
1097 Sets the regular expression to use for matching against a line. The first
1098 subexpression has to match something that can be turned into a number by
1099 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
1100 below. Because B<extended> regular expressions are used, you do not need to use
1101 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
1102 collectd's config parsing you need to escape backslashes, though. So if you
1103 want to match literal parentheses you need to do the following:
1104
1105   Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
1106
1107 =item B<DSType> I<Type>
1108
1109 Sets how the values are cumulated. I<Type> is one of:
1110
1111 =over 4
1112
1113 =item B<GaugeAverage>
1114
1115 Calculate the average.
1116
1117 =item B<GaugeMin>
1118
1119 Use the smallest number only.
1120
1121 =item B<GaugeMax>
1122
1123 Use the greatest number only.
1124
1125 =item B<GaugeLast>
1126
1127 Use the last number found.
1128
1129 =item B<CounterSet>
1130
1131 The matched number is a counter. Simply sets the internal counter to this
1132 value.
1133
1134 =item B<CounterAdd>
1135
1136 Add the matched value to the internal counter.
1137
1138 =item B<CounterInc>
1139
1140 Increase the internal counter by one. This B<DSType> is the only one that does
1141 not use the matched subexpression, but simply counts the number of matched
1142 lines. Thus, you may use a regular expression without submatch in this case.
1143
1144 =back
1145
1146 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
1147 number, using L<strtod(3)>. The B<CounterSet> and B<CounterAdd> interpret the
1148 submatch as an integer using L<strtoll(3)>. B<CounterInc> does not use the
1149 submatch at all and it may be omitted in this case.
1150
1151 =item B<Type> I<Type>
1152
1153 Sets the type used to dispatch this value. Detailed information about types and
1154 their configuration can be found in L<types.db(5)>.
1155
1156 =item B<Instance> I<TypeInstance>
1157
1158 This optional setting sets the type instance to use.
1159
1160 =back
1161
1162 =head2 Plugin C<teamspeak2>
1163
1164 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
1165 polls interesting global and virtual server data. The plugin can query only one
1166 physical server but unlimited virtual servers. You can use the following
1167 options to configure it:
1168
1169 =over 4
1170
1171 =item B<Host> I<hostname/ip>
1172
1173 The hostname or ip which identifies the physical server.
1174 Default: 127.0.0.1
1175
1176 =item B<Port> I<port>
1177
1178 The query port of the physical server. This needs to be a string.
1179 Default: "51234"
1180
1181 =item B<Server> I<port>
1182
1183 This option has to be added once for every virtual server the plugin should
1184 query. If you want to query the virtual server on port 8767 this is what the
1185 option would look like:
1186
1187   Server "8767"
1188
1189 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
1190 use quotes around it! If no such statement is given only global information
1191 will be collected.
1192
1193 =head2 Plugin C<tcpconns>
1194
1195 The C<tcpconns plugin> counts the number of currently established TCP
1196 connections based on the local port and/or the remote port. Since there may be
1197 a lot of connections the default if to count all connections with a local port,
1198 for which a listening socket is opened. You can use the following options to
1199 fine-tune the ports you are interested in:
1200
1201 =over 4
1202
1203 =back
1204
1205 =item B<ListeningPorts> I<true>|I<false>
1206
1207 If this option is set to I<true>, statistics for all local ports for which a
1208 listening socket exists are collected. The default depends on B<LocalPort> and
1209 B<RemotePort> (see below): If no port at all is specifically selected, the
1210 default is to collect listening ports. If specific ports (no matter if local or
1211 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
1212 the selected ports will be collected unless this option is set to I<true>
1213 specifically.
1214
1215 =item B<LocalPort> I<Port>
1216
1217 Count the connections to a specific local port. This can be used to see how
1218 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
1219 You have to specify the port in numeric form, so for the mailserver example
1220 you'd need to set B<25>.
1221
1222 =item B<RemotePort> I<Port>
1223
1224 Count the connections to a specific remote port. This is useful to see how
1225 much a remote service is used. This is most useful if you want to know how many
1226 connections a local service has opened to remote services, e.E<nbsp>g. how many
1227 connections a mail server or news server has to other mail or news servers, or
1228 how many connections a web proxy holds to web servers. You have to give the
1229 port in numeric form.
1230
1231 =back
1232
1233 =head2 Plugin C<unixsock>
1234
1235 =over 4
1236
1237 =item B<SocketFile> I<Path>
1238
1239 Sets the socket-file which is to be created.
1240
1241 =item B<SocketGroup> I<Group>
1242
1243 If running as root change the group of the UNIX-socket after it has been
1244 created. Defaults to B<collectd>.
1245
1246 =item B<SocketPerms> I<Permissions>
1247
1248 Change the file permissions of the UNIX-socket after it has been created. The
1249 permissions must be given as a numeric, octal value as you would pass to
1250 L<chmod(1)>. Defaults to B<0770>.
1251
1252 =back
1253
1254 =head2 Plugin C<uuid>
1255
1256 This plugin, if loaded, causes the Hostname to be taken from the machine's
1257 UUID. The UUID is a universally unique designation for the machine, usually
1258 taken from the machine's BIOS. This is most useful if the machine is running in
1259 a virtual environment such as Xen, in which case the UUID is preserved across
1260 shutdowns and migration.
1261
1262 The following methods are used to find the machine's UUID, in order:
1263
1264 =over 4
1265
1266 =item
1267
1268 Check I</etc/uuid> (or I<UUIDFile>).
1269
1270 =item
1271
1272 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
1273 present.
1274
1275 =item
1276
1277 Check for UUID from C<dmidecode> / SMBIOS.
1278
1279 =item
1280
1281 Check for UUID from Xen hypervisor.
1282
1283 =back
1284
1285 If no UUID can be found then the hostname is not modified.
1286
1287 =over 4
1288
1289 =item B<UUIDFile> I<Path>
1290
1291 Take the UUID from the given file (default I</etc/uuid>).
1292
1293 =back
1294
1295 =head2 Plugin C<vmem>
1296
1297 The C<vmem> plugin collects information about the usage of virtual memory.
1298 Since the statistics provided by the Linux kernel are very detailed, they are
1299 collected very detailed. However, to get all the details, you have to switch
1300 them on manually. Most people just want an overview over, such as the number of
1301 pages read from swap space.
1302
1303 =over 4
1304
1305 =item B<Verbose> B<true>|B<false>
1306
1307 Enables verbose collection of information. This will start collecting page
1308 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
1309 Part of these statistics are collected on a "per zone" basis.
1310
1311 =back
1312
1313 =head2 Plugin C<vserver>
1314
1315 This plugin doesn't have any options. B<VServer> support is only available for
1316 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
1317 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
1318 need to apply the patches and compile your own kernel, which will then provide
1319 the F</proc/virtual> filesystem that is required by this plugin.
1320
1321 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
1322
1323 =head1 THRESHOLD CONFIGURATION
1324
1325 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
1326 we mean that the values are not only stored or sent somewhere, but that they
1327 are judged and, if a problem is recognized, acted upon. The only action
1328 collectd takes itself is to generate and dispatch a "notification". Plugins can
1329 register to receive notifications and perform appropriate further actions.
1330
1331 Since systems and what you expect them to do differ a lot, you can configure
1332 B<thresholds> for your values freely. This gives you a lot of flexibility but
1333 also a lot of responsibility.
1334
1335 Every time a value is out of range a notification is dispatched. This means
1336 that the idle percentage of your CPU needs to be less then the configured
1337 threshold only once for a notification to be generated. There's no such thing
1338 as a moving average or similar - at least not now.
1339
1340 Also, all values that match a threshold are considered to be relevant or
1341 "interesting". As a consequence collectd will issue a notification if they are
1342 not received for twice the last timeout of the values. If, for example, some
1343 hosts sends it's CPU statistics to the server every 60 seconds, a notification
1344 will be dispatched after about 120 seconds. It may take a little longer because
1345 the timeout is checked only once each B<Interval> on the server.
1346
1347 Here is a configuration example to get you started. Read below for more
1348 information.
1349
1350  <Threshold>
1351    <Type "foo">
1352      WarningMin    0.00
1353      WarningMax 1000.00
1354      FailureMin    0.00
1355      FailureMax 1200.00
1356      Invert false
1357      Instance "bar"
1358    </Type>
1359
1360    <Plugin "interface">
1361      Instance "eth0"
1362      <Type "if_octets">
1363        FailureMax 10000000
1364      </Type>
1365    </Plugin>
1366
1367    <Host "hostname">
1368      <Type "cpu">
1369        Instance "idle"
1370        FailureMin 10
1371      </Type>
1372
1373      <Plugin "memory">
1374        <Type "memory">
1375          Instance "cached"
1376          WarningMin 100000000
1377        </Type>
1378      </Plugin>
1379    </Host>
1380  </Threshold>
1381
1382 There are basically two types of configuration statements: The C<Host>,
1383 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
1384 configured. The C<Plugin> and C<Type> blocks may be specified further using the
1385 C<Instance> option. You can combine the block by nesting the blocks, though
1386 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
1387 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
1388 C<Type> may not contain other blocks. If multiple blocks apply to the same
1389 value the most specific block is used.
1390
1391 The other statements specify the threshold to configure. They B<must> be
1392 included in a C<Type> block. Currently the following statements are recognized:
1393
1394 =over 4
1395
1396 =item B<FailureMax> I<Value>
1397
1398 =item B<WarningMax> I<Value>
1399
1400 Sets the upper bound of acceptable values. If unset defaults to positive
1401 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
1402 will be created. If the value is greater than B<WarningMax> but less than (or
1403 equal to) B<FailureMax> a B<WARNING> notification will be created.
1404
1405 =item B<FailureMin> I<Value>
1406
1407 =item B<WarningMin> I<Value>
1408
1409 Sets the lower bound of acceptable values. If unset defaults to negative
1410 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
1411 be created. If the value is less than B<WarningMin> but greater than (or equal
1412 to) B<FailureMin> a B<WARNING> notification will be created.
1413
1414 =item B<Invert> B<true>|B<false>
1415
1416 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
1417 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
1418 B<WarningMax>) are not okay. Defaults to B<false>.
1419
1420 =item B<Persist> B<true>|B<false>
1421
1422 Sets how often notifications are generated. If set to B<true> one notification
1423 will be generated for each value that is out of the acceptable range. If set to
1424 B<false> (the default) then a notification is only generated if a value is out
1425 of range but the previous value was okay.
1426
1427 This applies to missing values, too: If set to B<true> a notification about a
1428 missing value is generated once every B<Interval> seconds. If set to B<false>
1429 only one such notification is generated until the value appears again.
1430
1431 =back
1432
1433 =head1 SEE ALSO
1434
1435 L<collectd(1)>,
1436 L<collectd-exec(5)>,
1437 L<collectd-perl(5)>,
1438 L<collectd-unixsock(5)>,
1439 L<types.db(5)>,
1440 L<hddtemp(8)>,
1441 L<kstat(3KSTAT)>,
1442 L<mbmon(1)>,
1443 L<rrdtool(1)>,
1444 L<sensors(1)>
1445
1446 =head1 AUTHOR
1447
1448 Florian Forster E<lt>octo@verplant.orgE<gt>
1449
1450 =cut