Merge branch 'collectd-4.4' of /var/lib/git/collectd into collectd-4.4
[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<ipmi>
459
460 =over 4
461
462 =item B<Sensor> I<Sensor>
463
464 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
465
466 =item B<IgnoreSelected> I<true>|I<false>
467
468 If no configuration if given, the B<ipmi> plugin will collect data from all
469 sensors found of type "temperature", "voltage", "current" and "fanspeed".
470 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
471 the effect of B<Sensor> is inverted: All selected sensors are ignored and
472 all other sensors are collected.
473
474 =back
475
476 =head2 Plugin C<iptables>
477
478 =over 4
479
480 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
481
482 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
483 will collect the counters of all rules which have a comment-match. The comment
484 is then used as type-instance.
485
486 If I<Comment> or I<Number> is given, only the rule with the matching comment or
487 the I<n>th rule will be collected. Again, the comment (or the number) will be
488 used as the type-instance.
489
490 If I<Name> is supplied, it will be used as the type-instance instead of the
491 comment or the number.
492
493 =back
494
495 =head2 Plugin C<irq>
496
497 =over 4
498
499 =item B<Irq> I<Irq>
500
501 Select this irq. By default these irqs will then be collected. For a more
502 detailed description see B<IgnoreSelected> below.
503
504 =item B<IgnoreSelected> I<true>|I<false>
505
506 If no configuration if given, the B<irq>-plugin will collect data from all
507 irqs. This may not be practical, especially if no interrupts happen. Thus, you
508 can use the B<Irq>-option to pick the interrupt you're interested in.
509 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
510 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
511 I<true> the effect of B<Irq> is inversed: All selected interrupts are ignored
512 and all other interrupts are collected.
513
514 =back
515
516 =head2 Plugin C<libvirt>
517
518 This plugin allows CPU, disk and network load to be collected for virtualized
519 guests on the machine. This means that these characteristics can be collected
520 for guest systems without installing any software on them - collectd only runs
521 on the hosting system. The statistics are collected through libvirt
522 (L<http://libvirt.org/>).
523
524 Only I<Connection> is required.
525
526 =over 4
527
528 =item B<Connection> I<uri>
529
530 Connect to the hypervisor given by I<uri>. For example if using Xen use:
531
532  Connection "xen:///"
533
534 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
535
536 =item B<RefreshInterval> I<seconds>
537
538 Refresh the list of domains and devices every I<seconds>. The default is 60
539 seconds. Setting this to be the same or smaller than the I<Interval> will cause
540 the list of domains and devices to be refreshed on every iteration.
541
542 Refreshing the devices in particular is quite a costly operation, so if your
543 virtualization setup is static you might consider increasing this. If this
544 option is set to 0, refreshing is disabled completely.
545
546 =item B<Domain> I<name>
547
548 =item B<BlockDevice> I<name:dev>
549
550 =item B<InterfaceDevice> I<name:dev>
551
552 =item B<IgnoreSelected> I<true>|I<false>
553
554 Select which domains and devices are collected.
555
556 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
557 disk/network devices are collected.
558
559 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
560 domains and disk/network devices are ignored, while the rest are collected.
561
562 The domain name and device names may use a regular expression, if the name is
563 surrounded by I</.../> and collectd was compiled with support for regexps.
564
565 The default is to collect statistics for all domains and all their devices.
566
567 Example:
568
569  BlockDevice "/:hdb/"
570  IgnoreSelected "true"
571
572 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
573 will be collected.
574
575 =item B<HostnameFormat> B<name|uuid|hostname|...>
576
577 When the libvirt plugin logs data, it sets the hostname of the collected data
578 according to this setting. The default is to use the guest name as provided by
579 the hypervisor, which is equal to setting B<name>.
580
581 B<uuid> means use the guest's UUID. This is useful if you want to track the
582 same guest across migrations.
583
584 B<hostname> means to use the global B<Hostname> setting, which is probably not
585 useful on its own because all guests will appear to have the same name.
586
587 You can also specify combinations of these fields. For example B<name uuid>
588 means to concatenate the guest name and UUID (with a literal colon character
589 between, thus I<"foo:1234-1234-1234-1234">).
590
591 =back
592
593 =head2 Plugin C<logfile>
594
595 =over 4
596
597 =item B<LogLevel> B<debug|info|notice|warning|err>
598
599 Sets the log-level. If, for example, set to B<notice>, then all events with
600 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
601
602 Please note that B<debug> is only available if collectd has been compiled with
603 debugging support.
604
605 =item B<File> I<File>
606
607 Sets the file to write log messages to. The special strings B<stdout> and
608 B<stderr> can be used to write to the standard output and standard error
609 channels, respectively. This, of course, only makes much sense when collectd is
610 running in foreground- or non-daemon-mode.
611
612 =item B<Timestamp> B<true>|B<false>
613
614 Prefix all lines printed by the current time. Defaults to B<true>.
615
616 =back
617
618 =head2 Plugin C<mbmon>
619
620 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
621
622 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
623 B<Host> and B<Port> options can be used to change these values, see below.
624 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
625 timeouts may appear which may interfere with other statistics..
626
627 C<mbmon> must be run with the -r option ("print TAG and Value format");
628 Debian's F</etc/init.d/mbmon> script already does this, other people
629 will need to ensure that this is the case.
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<411>.
640
641 =back
642
643 =head2 Plugin C<memcached>
644
645 The C<memcached plugin> connects to a memcached server and queries statistics
646 about cache utilization, memory and bandwidth used.
647 L<http://www.danga.com/memcached/>
648
649 =over 4
650
651 =item B<Host> I<Hostname>
652
653 Hostname to connect to. Defaults to B<127.0.0.1>.
654
655 =item B<Port> I<Port>
656
657 TCP-Port to connect to. Defaults to B<11211>.
658
659 =back
660
661 =head2 Plugin C<mysql>
662
663 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to the
664 database when started and keeps the connection up as long as possible. When the
665 connection is interrupted for whatever reason it will try to re-connect. The
666 plugin will complaint loudly in case anything goes wrong.
667
668 This plugin issues the MySQL C<SHOW STATUS> command and collects information
669 about MySQL network traffic, executed statements, requests, the query cache
670 and threads by evaluating the C<Bytes_{received,sent}>, C<Com_*>,
671 C<Handler_*>, C<Qcache_*> and C<Threads_*> return values. Please refer to the
672 B<MySQL reference manual>, I<5.1.6. Server Status Variables> for an
673 explanation of these values.
674
675 Use the following options to configure the plugin:
676
677 =over 4
678
679 =item B<Host> I<Hostname>
680
681 Hostname of the database server. Defaults to B<localhost>.
682
683 =item B<User> I<Username>
684
685 Username to use when connecting to the database. The user does not have to be
686 granted any privileges (which is synonym to granting the C<USAGE> privilege).
687 Any existing MySQL user will do.
688
689 =item B<Password> I<Password>
690
691 Password needed to log into the database.
692
693 =item B<Database> I<Database>
694
695 Select this database. Defaults to I<no database> which is a perfectly reasonable
696 option for what this plugin does.
697
698 =back
699
700 =head2 Plugin C<netlink>
701
702 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
703 statistics of various interface and routing aspects.
704
705 =over 4
706
707 =item B<Interface> I<Interface>
708
709 =item B<VerboseInterface> I<Interface>
710
711 Instruct the plugin to collect interface statistics. This is basically the same
712 as the statistics provided by the C<interface> plugin (see above) but
713 potentially much more detailed.
714
715 When configuring with B<Interface> only the basic statistics will be collected,
716 namely octets, packets, and errors. These statistics are collected by
717 the C<interface> plugin, too, so using both at the same time is no benefit.
718
719 When configured with B<VerboseInterface> all counters B<except> the basic ones,
720 so that no data needs to be collected twice if you use the C<interface> plugin.
721 This includes dropped packets, received multicast packets, collisions and a
722 whole zoo of differentiated RX and TX errors. You can try the following command
723 to get an idea of what awaits you:
724
725   ip -s -s link list
726
727 If I<Interface> is B<All>, all interfaces will be selected.
728
729 =item B<QDisc> I<Interface> [I<QDisc>]
730
731 =item B<Class> I<Interface> [I<Class>]
732
733 =item B<Filter> I<Interface> [I<Filter>]
734
735 Collect the octets and packets that pass a certain qdisc, class or filter.
736
737 QDiscs and classes are identified by their type and handle (or classid).
738 Filters don't necessarily have a handle, therefore the parent's handle is used.
739 The notation used in collectd differs from that used in tc(1) in that it
740 doesn't skip the major or minor number if it's zero and doesn't print special
741 ids by their name. So, for example, a qdisc may be identified by
742 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
743 thus not displayed by tc(1).
744
745 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
746 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
747 associated with that interface will be collected.
748
749 Since a filter itself doesn't necessarily have a handle, the parent's handle is
750 used. This may lead to problems when more than one filter is attached to a
751 qdisc or class. This isn't nice, but we don't know how this could be done any
752 better. If you have a idea, please don't hesitate to tell us.
753
754 As with the B<Interface> option you can specify B<All> as the interface,
755 meaning all interfaces.
756
757 Here are some examples to help you understand the above text more easily:
758
759   <Plugin netlink>
760     VerboseInterface "All"
761     QDisc "eth0" "pfifo_fast-1:0"
762     QDisc "ppp0"
763     Class "ppp0" "htb-1:10"
764     Filter "ppp0" "u32-1:0"
765   </Plugin>
766
767 =item B<IgnoreSelected>
768
769 The behaviour is the same as with all other similar plugins: If nothing is
770 selected at all, everything is collected. If some things are selected using the
771 options described above, only these statistics are collected. If you set
772 B<IgnoreSelected> to B<true>, this behavior is inversed, i.E<nbsp>e. the
773 specified statistics will not be collected.
774
775 =back
776
777 =head2 Plugin C<network>
778
779 =over 4
780
781 =item B<Listen> I<Host> [I<Port>]
782
783 =item B<Server> I<Host> [I<Port>]
784
785 The B<Server> statement sets the server to send datagrams B<to>.  The statement
786 may occur multiple times to send each datagram to multiple destinations.
787
788 The B<Listen> statement sets the interfaces to bind to. When multiple
789 statements are found the daemon will bind to multiple interfaces.
790
791 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
792 the argument is a multicast address the daemon will join that multicast group.
793
794 If no B<Listen> statement is found the server tries join both, the default IPv6
795 multicast group and the default IPv4 multicast group. If no B<Server> statement
796 is found the client will try to send data to the IPv6 multicast group first. If
797 that fails the client will try the IPv4 multicast group.
798
799 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
800 multicast group is C<239.192.74.66>.
801
802 The optional I<Port> argument sets the port to use. It can either be given
803 using a numeric port number or a service name. If the argument is omitted the
804 default port B<25826> is assumed.
805
806 =item B<TimeToLive> I<1-255>
807
808 Set the time-to-live of sent packets. This applies to all, unicast and
809 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
810 That means that multicast packets will be sent with a TTL of C<1> (one) on most
811 operating systems.
812
813 =item B<Forward> I<true|false>
814
815 If set to I<true>, write packets that were received via the network plugin to
816 the sending sockets. This should only be activated when the B<Listen>- and
817 B<Server>-statements differ. Otherwise packets may be send multiple times to
818 the same multicast group. While this results in more network traffic than
819 necessary it's not a huge problem since the plugin has a duplicate detection,
820 so the values will not loop.
821
822 =item B<CacheFlush> I<Seconds>
823
824 For each host/plugin/type combination the C<network plugin> caches the time of
825 the last value being sent or received. Every I<Seconds> seconds the plugin
826 searches and removes all entries that are older than I<Seconds> seconds, thus
827 freeing the unused memory again. Since this process is somewhat expensive and
828 normally doesn't do much, this value should not be too small. The default is
829 1800 seconds, but setting this to 86400 seconds (one day) will not do much harm
830 either.
831
832 =back
833
834 =head2 Plugin C<nginx>
835
836 This plugin collects the number of connections and requests handled by the
837 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
838 queries the page provided by the C<ngx_http_stub_status_module> module, which
839 isn't compiled by default. Please refer to
840 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
841 how to compile and configure nginx and this module.
842
843 The following options are accepted by the C<nginx plugin>:
844
845 =over 4
846
847 =item B<URL> I<http://host/nginx_status>
848
849 Sets the URL of the C<ngx_http_stub_status_module> output.
850
851 =item B<User> I<Username>
852
853 Optional user name needed for authentication.
854
855 =item B<Password> I<Password>
856
857 Optional password needed for authentication.
858
859 =item B<VerifyPeer> B<true|false>
860
861 Enable or disable peer SSL certificate verification. See
862 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
863
864 =item B<VerifyHost> B<true|false>
865
866 Enable or disable peer host name verification. If enabled, the plugin checks
867 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
868 certificate matches the host name provided by the B<URL> option. If this
869 identity check fails, the connection is aborted. Obviously, only works when
870 connecting to a SSL enabled server. Enabled by default.
871
872 =item B<CACert> I<File>
873
874 File that holds one or more SSL certificates. If you want to use HTTPS you will
875 possibly need this option. What CA certificates come bundled with C<libcurl>
876 and are checked by default depends on the distribution you use.
877
878 =back
879
880 =head2 Plugin C<ntpd>
881
882 =over 4
883
884 =item B<Host> I<Hostname>
885
886 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
887
888 =item B<Port> I<Port>
889
890 UDP-Port to connect to. Defaults to B<123>.
891
892 =item B<ReverseLookups> B<true>|B<false>
893
894 Sets wether or not to perform reverse lookups on peers. Since the name or
895 IP-address may be used in a filename it is recommended to disable reverse
896 lookups. The default is to do reverse lookups to preserve backwards
897 compatibility, though.
898
899 =back
900
901 =head2 Plugin C<nut>
902
903 =over 4
904
905 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
906
907 Add a UPS to collect data from. The format is identical to the one accepted by
908 L<upsc(8)>.
909
910 =back
911
912 =head2 Plugin C<perl>
913
914 This plugin embeds a Perl-interpreter into collectd and provides an interface
915 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
916
917 =head2 Plugin C<ping>
918
919 =over 4
920
921 =item B<Host> I<IP-address>
922
923 Host to ping periodically. This option may be repeated several times to ping
924 multiple hosts.
925
926 =item B<TTL> I<0-255>
927
928 Sets the Time-To-Live of generated ICMP packets.
929
930 =back
931
932 =head2 Plugin C<powerdns>
933
934 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
935 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
936 values, many of which are probably meaningless to most users, but may be useful
937 for some. So you may chose which values to collect, but if you don't, some
938 reasonable defaults will be collected.
939
940   <Plugin "powerdns">
941     <Server "server_name">
942       Collect "latency"
943       Collect "udp-answers" "udp-queries"
944       Socket "/var/run/pdns.controlsocket"
945     </Server>
946     <Recursor "recursor_name">
947       Collect "questions"
948       Collect "cache-hits" "cache-misses"
949       Socket "/var/run/pdns_recursor.controlsocket"
950     </Recursor>
951     LocalSocket "/opt/collectd/var/run/collectd-powerdns"
952   </Plugin>
953
954 =over 4
955
956 =item B<Server> and B<Recursor> block
957
958 The B<Server> block defines one authoritative server to query, the B<Recursor>
959 does the same for an recursing server. The possible options in both blocks are
960 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
961 and is required.
962
963 =over 4
964
965 =item B<Collect> I<Field>
966
967 Using the B<Collect> statement you can select which values to collect. Here,
968 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
969 C<dlg-only-drops>, C<answers10-100>.
970
971 The method of getting the values differs for B<Server> and B<Recursor> blocks:
972 When querying the server a C<SHOW *> command is issued in any case, because
973 that's the only way of getting multiple values out of the server at once.
974 collectd then picks out the values you have selected. When querying the
975 recursor, a command is generated to query exactly these values. So if you
976 specify invalid fields when querying the recursor, a syntax error may be
977 returned by the daemon and collectd may not collect any values at all.
978
979 If no B<Collect> statement is given, the following B<Server> values will be
980 collected:
981
982 =over 4
983
984 =item latency
985
986 =item packetcache-hit
987
988 =item packetcache-miss
989
990 =item packetcache-size
991
992 =item query-cache-hit
993
994 =item query-cache-miss
995
996 =item recursing-answers
997
998 =item recursing-questions
999
1000 =item tcp-answers
1001
1002 =item tcp-queries
1003
1004 =item udp-answers
1005
1006 =item udp-queries
1007
1008 =back
1009
1010 The following B<Recursor> values will be collected by default:
1011
1012 =over 4
1013
1014 =item noerror-answers
1015
1016 =item nxdomain-answers
1017
1018 =item servfail-answers
1019
1020 =item sys-msec
1021
1022 =item user-msec
1023
1024 =item qa-latency
1025
1026 =item cache-entries
1027
1028 =item cache-hits
1029
1030 =item cache-misses
1031
1032 =item questions
1033
1034 =back
1035
1036 Please note that up to that point collectd doesn't know what values are
1037 available on the server and values that are added do not need a change of the
1038 mechanism so far. However, the values must be mapped to collectd's naming
1039 scheme, which is done using a lookup table that lists all known values. If
1040 values are added in the future and collectd does not know about them, you will
1041 get an error much like this:
1042
1043   powerdns plugin: submit: Not found in lookup table: foobar = 42
1044
1045 In this case please file a bug report with the collectd team.
1046
1047 =item B<Socket> I<Path>
1048
1049 Configures the path to the UNIX domain socket to be used when connecting to the
1050 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
1051 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
1052 will be used for the recursor.
1053
1054 =back
1055
1056 =item B<LocalSocket> I<Path>
1057
1058 Querying the recursor is done using UDP. When using UDP over UNIX domain
1059 sockets, the client socket needs a name in the file system, too. You can set
1060 this local name to I<Path> using the B<LocalSocket> option. The default is
1061 C<I<prefix>/var/run/collectd-powerdns>.
1062
1063 =back
1064
1065 =head2 Plugin C<processes>
1066
1067 =over 4
1068
1069 =item B<Process> I<Name>
1070
1071 Select more detailed statistics of processes matching this name. The statistics
1072 collected for these selected processes are size of the resident segment size
1073 (RSS), user- and system-time used, number of processes and number of threads,
1074 and minor and major pagefaults.
1075
1076 =back
1077
1078 =head2 Plugin C<rrdtool>
1079
1080 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
1081 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
1082 using these settings. If you don't want to dive into the depths of RRDTool, you
1083 can safely ignore these settings.
1084
1085 =over 4
1086
1087 =item B<DataDir> I<Directory>
1088
1089 Set the directory to store RRD-files under. Per default RRD-files are generated
1090 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1091
1092 =item B<StepSize> I<Seconds>
1093
1094 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
1095 this setting is unset and the stepsize is set to the interval in which the data
1096 is collected. Do not use this option unless you absolutely have to for some
1097 reason. Setting this option may cause problems with the C<snmp plugin>, the
1098 C<exec plugin> or when the daemon is set up to receive data from other hosts.
1099
1100 =item B<HeartBeat> I<Seconds>
1101
1102 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
1103 in which case the heartbeat is set to twice the B<StepSize> which should equal
1104 the interval in which data is collected. Do not set this option unless you have
1105 a very good reason to do so.
1106
1107 =item B<RRARows> I<NumRows>
1108
1109 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
1110 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
1111 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
1112 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
1113 week, one month, and one year.
1114
1115 So for each timespan, it calculates how many PDPs need to be consolidated into
1116 one CDP by calculating:
1117   number of PDPs = timespan / (stepsize * rrarows)
1118
1119 Bottom line is, set this no smaller than the width of you graphs in pixels. The
1120 default is 1200.
1121
1122 =item B<RRATimespan> I<Seconds>
1123
1124 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
1125 more then one RRA. If this option is never used, the built-in default of (3600,
1126 86400, 604800, 2678400, 31622400) is used.
1127
1128 For more information on how RRA-sizes are calculated see B<RRARows> above.
1129
1130 =item B<XFF> I<Factor>
1131
1132 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
1133
1134 =item B<CacheFlush> I<Seconds>
1135
1136 When the C<rrdtool plugin> uses a cache (by setting B<CacheTimeout>, see below)
1137 it writes all values for a certain RRD-file if the oldest value is older than
1138 (or equal to) the number of seconds specified. If some RRD-file is not updated
1139 anymore for some reason (the computer was shut down, the network is broken,
1140 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
1141 entire cache is searched for entries older than B<CacheTimeout> seconds and
1142 written to disk every I<Seconds> seconds. Since this is kind of expensive and
1143 does nothing under normal circumstances, this value should not be too small.
1144 900 seconds might be a good value, though setting this to 7200 seconds doesn't
1145 normally do much harm either.
1146
1147 =item B<CacheTimeout> I<Seconds>
1148
1149 If this option is set to a value greater than zero, the C<rrdtool plugin> will
1150 save values in a cache, as described above. Writing multiple values at once
1151 reduces IO-operations and thus lessens the load produced by updating the files.
1152 The trade off is that the graphs kind of "drag behind" and that more memory is
1153 used.
1154
1155 =back
1156
1157 =head2 Plugin C<sensors>
1158
1159 The C<sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
1160 that all the needed modules have to be loaded and lm_sensors has to be
1161 configured (most likely by editing F</etc/sensors.conf>. Read
1162 L<sensors.conf(5)> for details.
1163
1164 The B<lm_sensors> homepage can be found at
1165 L<http://secure.netroedge.com/~lm78/>.
1166
1167 =over 4
1168
1169 =item B<Sensor> I<chip-bus-address/type-feature>
1170
1171 Selects the name of the sensor which you want to collect or ignore, depending
1172 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
1173 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
1174 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
1175
1176 =item B<IgnoreSelected> I<true>|I<false>
1177
1178 If no configuration if given, the B<sensors>-plugin will collect data from all
1179 sensors. This may not be practical, especially for uninteresting sensors.
1180 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
1181 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
1182 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
1183 I<true> the effect of B<Sensor> is inversed: All selected sensors are ignored
1184 and all other sensors are collected.
1185
1186 =back
1187
1188 =head2 Plugin C<snmp>
1189
1190 Since the configuration of the C<snmp plugin> is a little more complicated than
1191 other plugins, its documentation has been moved to an own manpage,
1192 L<collectd-snmp(5)>. Please see there for details.
1193
1194 =head2 Plugin C<syslog>
1195
1196 =over 4
1197
1198 =item B<LogLevel> B<debug|info|notice|warning|err>
1199
1200 Sets the log-level. If, for example, set to B<notice>, then all events with
1201 severity B<notice>, B<warning>, or B<err> will be submitted to the
1202 syslog-daemon.
1203
1204 Please note that B<debug> is only available if collectd has been compiled with
1205 debugging support.
1206
1207 =back
1208
1209 =head2 Plugin C<tail>
1210
1211 The C<tail plugin> plugins follows logfiles, just like L<tail(1)> does, parses
1212 each line and dispatches found values. What is matched can be configured by the
1213 user using (extended) regular expressions, as described in L<regex(7)>.
1214
1215   <Plugin "tail">
1216     <File "/var/log/exim4/mainlog">
1217       Instance "exim"
1218       <Match>
1219         Regex "S=([1-9][0-9]*)"
1220         DSType "CounterAdd"
1221         Type "ipt_bytes"
1222         Instance "total"
1223       </Match>
1224       <Match>
1225         Regex "\\<R=local_user\\>"
1226         DSType "CounterInc"
1227         Type "counter"
1228         Instance "local_user"
1229       </Match>
1230     </File>
1231   </Plugin>
1232
1233 The config consists of one or more B<File> blocks, each of which configures one
1234 logfile to parse. Within each B<File> block, there are one or more B<Match>
1235 blocks, which configure a regular expression to search for.
1236
1237 The B<Instance> option in the B<File> block may be used to set the plugin
1238 instance. So in the above example the plugin name C<tail-foo> would be used.
1239 This plugin instance is for all B<Match> blocks that B<follow> it, until the
1240 next B<Instance> option. This way you can extract several plugin instances from
1241 one logfile, handy when parsing syslog and the like.
1242
1243 Each B<Match> block has the following options to describe how the match should
1244 be performed:
1245
1246 =over 4
1247
1248 =item B<Regex> I<regex>
1249
1250 Sets the regular expression to use for matching against a line. The first
1251 subexpression has to match something that can be turned into a number by
1252 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
1253 below. Because B<extended> regular expressions are used, you do not need to use
1254 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
1255 collectd's config parsing you need to escape backslashes, though. So if you
1256 want to match literal parentheses you need to do the following:
1257
1258   Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
1259
1260 =item B<DSType> I<Type>
1261
1262 Sets how the values are cumulated. I<Type> is one of:
1263
1264 =over 4
1265
1266 =item B<GaugeAverage>
1267
1268 Calculate the average.
1269
1270 =item B<GaugeMin>
1271
1272 Use the smallest number only.
1273
1274 =item B<GaugeMax>
1275
1276 Use the greatest number only.
1277
1278 =item B<GaugeLast>
1279
1280 Use the last number found.
1281
1282 =item B<CounterSet>
1283
1284 The matched number is a counter. Simply sets the internal counter to this
1285 value.
1286
1287 =item B<CounterAdd>
1288
1289 Add the matched value to the internal counter.
1290
1291 =item B<CounterInc>
1292
1293 Increase the internal counter by one. This B<DSType> is the only one that does
1294 not use the matched subexpression, but simply counts the number of matched
1295 lines. Thus, you may use a regular expression without submatch in this case.
1296
1297 =back
1298
1299 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
1300 number, using L<strtod(3)>. The B<CounterSet> and B<CounterAdd> interpret the
1301 submatch as an integer using L<strtoll(3)>. B<CounterInc> does not use the
1302 submatch at all and it may be omitted in this case.
1303
1304 =item B<Type> I<Type>
1305
1306 Sets the type used to dispatch this value. Detailed information about types and
1307 their configuration can be found in L<types.db(5)>.
1308
1309 =item B<Instance> I<TypeInstance>
1310
1311 This optional setting sets the type instance to use.
1312
1313 =back
1314
1315 =head2 Plugin C<teamspeak2>
1316
1317 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
1318 polls interesting global and virtual server data. The plugin can query only one
1319 physical server but unlimited virtual servers. You can use the following
1320 options to configure it:
1321
1322 =over 4
1323
1324 =item B<Host> I<hostname/ip>
1325
1326 The hostname or ip which identifies the physical server.
1327 Default: 127.0.0.1
1328
1329 =item B<Port> I<port>
1330
1331 The query port of the physical server. This needs to be a string.
1332 Default: "51234"
1333
1334 =item B<Server> I<port>
1335
1336 This option has to be added once for every virtual server the plugin should
1337 query. If you want to query the virtual server on port 8767 this is what the
1338 option would look like:
1339
1340   Server "8767"
1341
1342 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
1343 use quotes around it! If no such statement is given only global information
1344 will be collected.
1345
1346 =back
1347
1348 =head2 Plugin C<tcpconns>
1349
1350 The C<tcpconns plugin> counts the number of currently established TCP
1351 connections based on the local port and/or the remote port. Since there may be
1352 a lot of connections the default if to count all connections with a local port,
1353 for which a listening socket is opened. You can use the following options to
1354 fine-tune the ports you are interested in:
1355
1356 =over 4
1357
1358 =item B<ListeningPorts> I<true>|I<false>
1359
1360 If this option is set to I<true>, statistics for all local ports for which a
1361 listening socket exists are collected. The default depends on B<LocalPort> and
1362 B<RemotePort> (see below): If no port at all is specifically selected, the
1363 default is to collect listening ports. If specific ports (no matter if local or
1364 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
1365 the selected ports will be collected unless this option is set to I<true>
1366 specifically.
1367
1368 =item B<LocalPort> I<Port>
1369
1370 Count the connections to a specific local port. This can be used to see how
1371 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
1372 You have to specify the port in numeric form, so for the mailserver example
1373 you'd need to set B<25>.
1374
1375 =item B<RemotePort> I<Port>
1376
1377 Count the connections to a specific remote port. This is useful to see how
1378 much a remote service is used. This is most useful if you want to know how many
1379 connections a local service has opened to remote services, e.E<nbsp>g. how many
1380 connections a mail server or news server has to other mail or news servers, or
1381 how many connections a web proxy holds to web servers. You have to give the
1382 port in numeric form.
1383
1384 =back
1385
1386 =head2 Plugin C<unixsock>
1387
1388 =over 4
1389
1390 =item B<SocketFile> I<Path>
1391
1392 Sets the socket-file which is to be created.
1393
1394 =item B<SocketGroup> I<Group>
1395
1396 If running as root change the group of the UNIX-socket after it has been
1397 created. Defaults to B<collectd>.
1398
1399 =item B<SocketPerms> I<Permissions>
1400
1401 Change the file permissions of the UNIX-socket after it has been created. The
1402 permissions must be given as a numeric, octal value as you would pass to
1403 L<chmod(1)>. Defaults to B<0770>.
1404
1405 =back
1406
1407 =head2 Plugin C<uuid>
1408
1409 This plugin, if loaded, causes the Hostname to be taken from the machine's
1410 UUID. The UUID is a universally unique designation for the machine, usually
1411 taken from the machine's BIOS. This is most useful if the machine is running in
1412 a virtual environment such as Xen, in which case the UUID is preserved across
1413 shutdowns and migration.
1414
1415 The following methods are used to find the machine's UUID, in order:
1416
1417 =over 4
1418
1419 =item
1420
1421 Check I</etc/uuid> (or I<UUIDFile>).
1422
1423 =item
1424
1425 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
1426 present.
1427
1428 =item
1429
1430 Check for UUID from C<dmidecode> / SMBIOS.
1431
1432 =item
1433
1434 Check for UUID from Xen hypervisor.
1435
1436 =back
1437
1438 If no UUID can be found then the hostname is not modified.
1439
1440 =over 4
1441
1442 =item B<UUIDFile> I<Path>
1443
1444 Take the UUID from the given file (default I</etc/uuid>).
1445
1446 =back
1447
1448 =head2 Plugin C<vmem>
1449
1450 The C<vmem> plugin collects information about the usage of virtual memory.
1451 Since the statistics provided by the Linux kernel are very detailed, they are
1452 collected very detailed. However, to get all the details, you have to switch
1453 them on manually. Most people just want an overview over, such as the number of
1454 pages read from swap space.
1455
1456 =over 4
1457
1458 =item B<Verbose> B<true>|B<false>
1459
1460 Enables verbose collection of information. This will start collecting page
1461 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
1462 Part of these statistics are collected on a "per zone" basis.
1463
1464 =back
1465
1466 =head2 Plugin C<vserver>
1467
1468 This plugin doesn't have any options. B<VServer> support is only available for
1469 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
1470 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
1471 need to apply the patches and compile your own kernel, which will then provide
1472 the F</proc/virtual> filesystem that is required by this plugin.
1473
1474 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
1475
1476 =head1 THRESHOLD CONFIGURATION
1477
1478 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
1479 we mean that the values are not only stored or sent somewhere, but that they
1480 are judged and, if a problem is recognized, acted upon. The only action
1481 collectd takes itself is to generate and dispatch a "notification". Plugins can
1482 register to receive notifications and perform appropriate further actions.
1483
1484 Since systems and what you expect them to do differ a lot, you can configure
1485 B<thresholds> for your values freely. This gives you a lot of flexibility but
1486 also a lot of responsibility.
1487
1488 Every time a value is out of range a notification is dispatched. This means
1489 that the idle percentage of your CPU needs to be less then the configured
1490 threshold only once for a notification to be generated. There's no such thing
1491 as a moving average or similar - at least not now.
1492
1493 Also, all values that match a threshold are considered to be relevant or
1494 "interesting". As a consequence collectd will issue a notification if they are
1495 not received for twice the last timeout of the values. If, for example, some
1496 hosts sends it's CPU statistics to the server every 60 seconds, a notification
1497 will be dispatched after about 120 seconds. It may take a little longer because
1498 the timeout is checked only once each B<Interval> on the server.
1499
1500 When a value comes within range again or is received after it was missing, an
1501 "OKAY-notification" is dispatched.
1502
1503 Here is a configuration example to get you started. Read below for more
1504 information.
1505
1506  <Threshold>
1507    <Type "foo">
1508      WarningMin    0.00
1509      WarningMax 1000.00
1510      FailureMin    0.00
1511      FailureMax 1200.00
1512      Invert false
1513      Instance "bar"
1514    </Type>
1515
1516    <Plugin "interface">
1517      Instance "eth0"
1518      <Type "if_octets">
1519        FailureMax 10000000
1520        DataSource "rx"
1521      </Type>
1522    </Plugin>
1523
1524    <Host "hostname">
1525      <Type "cpu">
1526        Instance "idle"
1527        FailureMin 10
1528      </Type>
1529
1530      <Plugin "memory">
1531        <Type "memory">
1532          Instance "cached"
1533          WarningMin 100000000
1534        </Type>
1535      </Plugin>
1536    </Host>
1537  </Threshold>
1538
1539 There are basically two types of configuration statements: The C<Host>,
1540 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
1541 configured. The C<Plugin> and C<Type> blocks may be specified further using the
1542 C<Instance> option. You can combine the block by nesting the blocks, though
1543 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
1544 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
1545 C<Type> may not contain other blocks. If multiple blocks apply to the same
1546 value the most specific block is used.
1547
1548 The other statements specify the threshold to configure. They B<must> be
1549 included in a C<Type> block. Currently the following statements are recognized:
1550
1551 =over 4
1552
1553 =item B<FailureMax> I<Value>
1554
1555 =item B<WarningMax> I<Value>
1556
1557 Sets the upper bound of acceptable values. If unset defaults to positive
1558 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
1559 will be created. If the value is greater than B<WarningMax> but less than (or
1560 equal to) B<FailureMax> a B<WARNING> notification will be created.
1561
1562 =item B<FailureMin> I<Value>
1563
1564 =item B<WarningMin> I<Value>
1565
1566 Sets the lower bound of acceptable values. If unset defaults to negative
1567 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
1568 be created. If the value is less than B<WarningMin> but greater than (or equal
1569 to) B<FailureMin> a B<WARNING> notification will be created.
1570
1571 =item B<DataSource> I<DSName>
1572
1573 Some data sets have more than one "data source". Interesting examples are the
1574 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
1575 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
1576 system load data set, C<load>, even has three data sources: C<shortterm>,
1577 C<midterm>, and C<longterm>.
1578
1579 Normally, all data sources are checked against a configured threshold. If this
1580 is undesirable, or if you want to specify different limits for each data
1581 source, you can use the B<DataSource> option to have a threshold apply only to
1582 one data source.
1583
1584 =item B<Invert> B<true>|B<false>
1585
1586 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
1587 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
1588 B<WarningMax>) are not okay. Defaults to B<false>.
1589
1590 =item B<Persist> B<true>|B<false>
1591
1592 Sets how often notifications are generated. If set to B<true> one notification
1593 will be generated for each value that is out of the acceptable range. If set to
1594 B<false> (the default) then a notification is only generated if a value is out
1595 of range but the previous value was okay.
1596
1597 This applies to missing values, too: If set to B<true> a notification about a
1598 missing value is generated once every B<Interval> seconds. If set to B<false>
1599 only one such notification is generated until the value appears again.
1600
1601 =back
1602
1603 =head1 SEE ALSO
1604
1605 L<collectd(1)>,
1606 L<collectd-exec(5)>,
1607 L<collectd-perl(5)>,
1608 L<collectd-unixsock(5)>,
1609 L<types.db(5)>,
1610 L<hddtemp(8)>,
1611 L<kstat(3KSTAT)>,
1612 L<mbmon(1)>,
1613 L<rrdtool(1)>,
1614 L<sensors(1)>
1615
1616 =head1 AUTHOR
1617
1618 Florian Forster E<lt>octo@verplant.orgE<gt>
1619
1620 =cut