Code

Merge branch 'dm/t_option'
[collectd.git] / src / collectd.conf.pod
1 =head1 NAME
3 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
5 =head1 SYNOPSIS
7   BaseDir "/path/to/data/"
8   PIDFile "/path/to/pidfile/collectd.pid"
9   Server  "123.123.123.123" 12345
11   LoadPlugin cpu
12   LoadPlugin load
13   LoadPlugin ping
15   <Plugin ping>
16     Host "example.org"
17     Host "provider.net"
18   </Plugin>
20 =head1 DESCRIPTION
22 This config file controls how the system statistics collection daemon
23 B<collectd> behaves. The most significant option is B<LoadPlugin>, which
24 controls which plugins to load. These plugins ultimately define collectd's
25 behavior.
27 The syntax of this config file is similar to the config file of the famous
28 B<Apache Webserver>. Each line contains either a key-value-pair or a
29 section-start or -end. Empty lines and everything after the hash-symbol `#' is
30 ignored. Values are either string, enclosed in double-quotes,
31 (floating-point-)numbers or a boolean expression, i.E<nbsp>e. either B<true> or
32 B<false>. String containing of only alphanumeric characters and underscores do
33 not need to be quoted. Lines may be wrapped by using `\' as the last character
34 before the newline. This allows long lines to be split into multiple lines.
35 Quoted strings may be wrapped as well. However, those are treated special in
36 that whitespace at the beginning of the following lines will be ignored, which
37 allows for nicely indenting the wrapped lines.
39 The configuration is read and processed in order, i.E<nbsp>e. from top to
40 bottom. So the plugins are loaded in the order listed in this config file. It
41 is a good idea to load any logging plugins first in order to catch messages
42 from plugins during configuration. Also, the C<LoadPlugin> option B<must> occur
43 B<before> the C<E<lt>Plugin ...E<gt>> block.
45 =head1 GLOBAL OPTIONS
47 =over 4
49 =item B<BaseDir> I<Directory>
51 Sets the base directory. This is the directory beneath all RRD-files are
52 created. Possibly more subdirectories are created. This is also the working
53 directory for the daemon.
55 =item B<LoadPlugin> I<Plugin>
57 Loads the plugin I<Plugin>. There must be at least one such line or B<collectd>
58 will be mostly useless.
60 =item B<Include> I<Path>
62 If I<Path> points to a file, includes that file. If I<Path> points to a
63 directory, recursively includes all files within that directory and its
64 subdirectories. If the C<wordexp> function is available on your system,
65 shell-like wildcards are expanded before files are included. This means you can
66 use statements like the following:
68   Include "/etc/collectd.d/*.conf"
70 If more than one files are included by a single B<Include> option, the files
71 will be included in lexicographical order (as defined by the C<strcmp>
72 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
73 order in which the files are loaded.
75 To prevent loops and shooting yourself in the foot in interesting ways the
76 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
77 most uses. Since symlinks are followed it is still possible to crash the daemon
78 by looping symlinks. In our opinion significant stupidity should result in an
79 appropriate amount of pain.
81 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
82 file, but you cannot include files from within blocks.
84 =item B<PIDFile> I<File>
86 Sets where to write the PID file to. This file is overwritten when it exists
87 and deleted when the program is stopped. Some init-scripts might override this
88 setting using the B<-P> command-line option.
90 =item B<PluginDir> I<Directory>
92 Path to the plugins (shared objects) of collectd.
94 =item B<TypesDB> I<File> [I<File> ...]
96 Set one or more files that contain the data-set descriptions. See
97 L<types.db(5)> for a description of the format of this file.
99 =item B<Interval> I<Seconds>
101 Configures the interval in which to query the read plugins. Obviously smaller
102 values lead to a higher system load produced by collectd, while higher values
103 lead to more coarse statistics.
105 =item B<ReadThreads> I<Num>
107 Number of threads to start for reading plugins. The default value is B<5>, but
108 you may want to increase this if you have more than five plugins that take a
109 long time to read. Mostly those are plugin that do network-IO. Setting this to
110 a value higher than the number of plugins you've loaded is totally useless.
112 =item B<Hostname> I<Name>
114 Sets the hostname that identifies a host. If you omit this setting, the
115 hostname will be determinded using the L<gethostname(2)> system call.
117 =item B<FQDNLookup> B<true|false>
119 If B<Hostname> is determined automatically this setting controls whether or not
120 the daemon should try to figure out the "fully qualified domain name", FQDN.
121 This is done using a lookup of the name returned by C<gethostname>.
123 Using this feature (i.E<nbsp>e. setting this option to B<true>) is recommended.
124 However, to preserve backwards compatibility the default is set to B<false>.
125 The sample config file that is installed with C<makeE<nbsp>install> includes a
126 line which sets this option, though, so that default installations will have
127 this setting enabled.
129 =back
131 =head1 PLUGIN OPTIONS
133 Some plugins may register own options. These options must be enclosed in a
134 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
135 require external configuration, too. The C<apache plugin>, for example,
136 required C<mod_status> to be configured in the webserver you're going to
137 collect data from. These plugins are listed below as well, even if they don't
138 require any configuration within collectd's configfile.
140 A list of all plugins and a short summary for each plugin can be found in the
141 F<README> file shipped with the sourcecode and hopefully binary packets as
142 well.
144 =head2 Plugin C<apache>
146 To configure the C<apache>-plugin you first need to configure the Apache
147 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
148 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
149 the following snipped to base your Apache config upon:
151   ExtendedStatus on
152   <IfModule mod_status.c>
153     <Location /mod_status>
154       SetHandler server-status
155     </Location>
156   </IfModule>
158 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
159 also supported. It introduces a new field, called C<BusyServers>, to count the
160 number of currently connected clients. This field is also supported.
162 The following options are accepted by the C<apache>-plugin:
164 =over 4
166 =item B<URL> I<http://host/mod_status?auto>
168 Sets the URL of the C<mod_status> output. This needs to be the output generated
169 by C<ExtendedStatus on> and it needs to be the machine readable output
170 generated by appending the C<?auto> argument.
172 =item B<User> I<Username>
174 Optional user name needed for authentication.
176 =item B<Password> I<Password>
178 Optional password needed for authentication.
180 =item B<VerifyPeer> B<true|false>
182 Enable or disable peer SSL certificate verification. See
183 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
185 =item B<VerifyHost> B<true|false>
187 Enable or disable peer host name verification. If enabled, the plugin checks
188 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
189 certificate matches the host name provided by the B<URL> option. If this
190 identity check fails, the connection is aborted. Obviously, only works when
191 connecting to a SSL enabled server. Enabled by default.
193 =item B<CACert> I<File>
195 File that holds one or more SSL certificates. If you want to use HTTPS you will
196 possibly need this option. What CA certificates come bundled with C<libcurl>
197 and are checked by default depends on the distribution you use.
199 =back
201 =head2 Plugin C<apcups>
203 =over 4
205 =item B<Host> I<Hostname>
207 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
208 that IPv6 support has been disabled unless someone can confirm or decline that
209 B<apcupsd> can handle it.
211 =item B<Port> I<Port>
213 TCP-Port to connect to. Defaults to B<3551>.
215 =back
217 =head2 Plugin C<ascent>
219 This plugin collects information about an Ascent server, a free server for the
220 "World of Warcraft" game. This plugin gathers the information by fetching the
221 XML status page using C<libcurl> and parses it using C<libxml2>.
223 The configuration options are the same as for the C<apache> plugin above:
225 =over 4
227 =item B<URL> I<http://localhost/ascent/status/>
229 Sets the URL of the XML status output.
231 =item B<User> I<Username>
233 Optional user name needed for authentication.
235 =item B<Password> I<Password>
237 Optional password needed for authentication.
239 =item B<VerifyPeer> B<true|false>
241 Enable or disable peer SSL certificate verification. See
242 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
244 =item B<VerifyHost> B<true|false>
246 Enable or disable peer host name verification. If enabled, the plugin checks
247 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
248 certificate matches the host name provided by the B<URL> option. If this
249 identity check fails, the connection is aborted. Obviously, only works when
250 connecting to a SSL enabled server. Enabled by default.
252 =item B<CACert> I<File>
254 File that holds one or more SSL certificates. If you want to use HTTPS you will
255 possibly need this option. What CA certificates come bundled with C<libcurl>
256 and are checked by default depends on the distribution you use.
258 =back
260 =head2 Plugin C<cpufreq>
262 This plugin doesn't have any options. It reads
263 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
264 installed) to get the current CPU frequency. If this file does not exist make
265 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
266 installed and an "cpu governor" (that's a kernel module) is loaded.
268 =head2 Plugin C<csv>
270 =over 4
272 =item B<DataDir> I<Directory>
274 Set the directory to store CSV-files under. Per default CSV-files are generated
275 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
276 The special strings B<stdout> and B<stderr> can be used to write to the standard
277 output and standard error channels, respectively. This, of course, only makes
278 much sense when collectd is running in foreground- or non-daemon-mode.
280 =item B<StoreRates> B<true|false>
282 If set to B<true>, convert counter values to rates. If set to B<false> (the
283 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
284 number.
286 =back
288 =head2 Plugin C<dbi>
290 This plugin uses the "B<dbi>" library (L<http://libdbi.sourceforge.net/>) to
291 connect to various databases, execute SQL statements and read back the results.
292 You can configure how each column is to be interpreted and the plugin will
293 generate one data set from each row returned according to these rules.
295 Because the plugin is very generic, the configuration is a little more complex
296 than those of other plugins. It usually looks something like this:
298   <Plugin dbi>
299     <Query "out_of_stock">
300       Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
301       Type "gauge"
302       InstancesFrom "category"
303       ValuesFrom "value"
304     </Query>
305     <Database "product_information">
306       Driver "mysql"
307       DriverOption "host" "localhost"
308       DriverOption "username" "collectd"
309       DriverOption "password" "aZo6daiw"
310       DriverOption "dbname" "prod_info"
311       SelectDB "prod_info"
312       Query "out_of_stock"
313     </Database>
314   </Plugin>
316 The configuration above defines one query and one database. The query is then
317 linked to the database with the B<Query> option I<within> the
318 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
319 and you can also use the B<Include> statement to split up the configuration
320 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
321 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
322 top to bottom!
324 The following is a complete list of options:
326 =head3 B<Query> blocks
328 Query blocks define SQL statements and how the returned data should be
329 interpreted. They are identified by the name that is given in the opening line
330 of the block. Thus the name needs to be unique. Other than that, the name is
331 not used in collectd.
333 =over 4
335 =item B<Statement> I<SQL>
337 Sets the statement that should be executed on the server. This is B<not>
338 interpreted by collectd, but simply passed to the database server. Therefore,
339 the SQL dialect that's used depends on the server collectd is connected to.
341 The query has to return at least two columns, one for the instance and one
342 value. You cannot omit the instance, even if the statement is guaranteed to
343 always return exactly one line. In that case, you can usually specify something
344 like this:
346   Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
348 (That works with MySQL but may not be valid SQL according to the spec. If you
349 use a more strict database server, you may have to select from a dummy table or
350 something.)
352 =item B<Type> I<Type>
354 The B<type> that's used for each line returned. See L<types.db(5)> for more
355 details on how types are defined. In short: A type is a predefined layout of
356 data and the number of values and type of values has to match the type
357 definition.
359 If you specify "temperature" here, you need exactly one gauge column. If you
360 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
361 setting below.
363 =item B<InstancesFrom> I<column0> [I<column1> ...]
365 Specifies the columns whose values will be used to create the "TypeInstance"
366 for each row. You need to specify at least one column for each query. If you
367 specify more than one column, the value of all columns will be join together
368 with the hyphen as separation character.
370 The plugin itself does not check whether or not all built instances are
371 different. It's your responsibility to assure that each is unique.
373 =item B<ValuesFrom> I<column0> [I<column1> ...]
375 Names the columns whose content is used as the actual data for the data sets
376 that are dispatched to the daemon. How many such columns you need is determined
377 by the B<Type> setting above. If you specify too many or not enough columns,
378 the plugin will complain about that and no data will be submitted to the
379 daemon.
381 The actual data type in the columns is not that important. The plugin will
382 automatically cast the values to the right type if it know how to do that. So
383 it should be able to handle integer an floating point types, as well as strings
384 (if they include a number at the beginning).
386 =back
388 =head3 B<Database> blocks
390 Database blocks define a connection to a database and which queries should be
391 sent to that database. Since the used "dbi" library can handle a wide variety
392 of databases, the configuration is very generic. If in doubt, refer to libdbi's
393 documentationE<nbsp>- we stick as close to the terminology used there.
395 Each database needs a "name" as string argument in the starting tag of the
396 block. This name will be used as "PluginInstance" in the values submitted to
397 the daemon. Other than that, that name is not used.
399 =over 4
401 =item B<Driver> I<Driver>
403 Specifies the driver to use to connect to the database. In many cases those
404 drivers are named after the database they can connect to, but this is not a
405 technical necessity. These drivers are sometimes referred to as "DBD",
406 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
407 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
408 project at L<http://libdbi-drivers.sourceforge.net/>.
410 You need to give the driver name as expected by the "dbi" library here. You
411 should be able to find that in the documentation for each driver. If you
412 mistype the driver name, the plugin will dump a list of all known driver names
413 to the log.
415 =item B<DriverOption> I<Key> I<Value>
417 Sets driver-specific options. What option a driver supports can be found in the
418 documentation for each driver, somewhere at
419 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
420 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
422 Unfortunately, drivers are not too keen to report errors when an unknown option
423 is passed to them, so invalid settings here may go unnoticed. This is not the
424 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
425 the driver. If a driver complains about an option, the plugin will dump a
426 complete list of all options understood by that driver to the log.
428 =item B<SelectDB> I<Database>
430 In some cases, the database name you connect with is not the database name you
431 want to use for querying data. If this option is set, the plugin will "select"
432 (switch to) that database after the connection is established.
434 =item B<Query> I<QueryName>
436 Associates the query named I<QueryName> with this database connection. The
437 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
438 blocks you want to refer to must be placed above the database block you want to
439 refer to them from.
441 =back
443 =head2 Plugin C<df>
445 =over 4
447 =item B<Device> I<Device>
449 Select partitions based on the devicename.
451 =item B<MountPoint> I<Directory>
453 Select partitions based on the mountpoint.
455 =item B<FSType> I<FSType>
457 Select partitions based on the filesystem type.
459 =item B<IgnoreSelected> I<true>|I<false>
461 Invert the selection: If set to true, all partitions B<except> the ones that
462 match any one of the criteria are collected. By default only selected
463 partitions are collected if a selection is made. If no selection is configured
464 at all, B<all> partitions are selected.
466 =back
468 =head2 Plugin C<disk>
470 The C<disk> plugin collects information about the usage of physical disks and
471 logical disks (partitions). Values collected are the number of octets written
472 to and read from a disk or partition, the number of read/write operations
473 issued to the disk and a rather complex "time" it took for these commands to be
474 issued.
476 Using the following two options you can ignore some disks or configure the
477 collection only of specific disks.
479 =over 4
481 =item B<Disk> I<Name>
483 Select the disk I<Name>. Whether it is collected or ignored depends on the
484 B<IgnoreSelected> setting, see below. As with other plugins that use the
485 daemon's ignorelist functionality, a string that starts and ends with a slash
486 is interpreted as a regular expression. Examples:
488   Disk "sdd"
489   Disk "/hda[34]/"
491 =item B<IgnoreSelected> B<true>|B<false>
493 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
494 statements, are ignored or if all other disks are ignored. The behavior
495 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
496 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
497 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
498 is set to B<true>, all disks are collected B<except> the ones matched.
500 =back
502 =head2 Plugin C<dns>
504 =over 4
506 =item B<Interface> I<Interface>
508 The dns plugin uses B<libpcap> to capture dns traffic and analyses it. This
509 option sets the interface that should be used. If this option is not set, or
510 set to "any", the plugin will try to get packets from B<all> interfaces. This
511 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
513 =item B<IgnoreSource> I<IP-address>
515 Ignore packets that originate from this address.
517 =back
519 =head2 Plugin C<email>
521 =over 4
523 =item B<SocketFile> I<Path>
525 Sets the socket-file which is to be created.
527 =item B<SocketGroup> I<Group>
529 If running as root change the group of the UNIX-socket after it has been
530 created. Defaults to B<collectd>.
532 =item B<SocketPerms> I<Permissions>
534 Change the file permissions of the UNIX-socket after it has been created. The
535 permissions must be given as a numeric, octal value as you would pass to
536 L<chmod(1)>. Defaults to B<0770>.
538 =item B<MaxConns> I<Number>
540 Sets the maximum number of connections that can be handled in parallel. Since
541 this many threads will be started immediately setting this to a very high
542 value will waste valuable resources. Defaults to B<5> and will be forced to be
543 at most B<16384> to prevent typos and dumb mistakes.
545 =back
547 =head2 Plugin C<exec>
549 Please make sure to read L<collectd-exec(5)> before using this plugin. It
550 contains valuable information on when the executable is executed and the
551 output that is expected from it.
553 =over 4
555 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
557 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
559 Execute the executable I<Executable> as user I<User>. If the user name is
560 followed by a colon and a group name, the effective group is set to that group.
561 The real group and saved-set group will be set to the default group of that
562 user. If no group is given the effective group ID will be the same as the real
563 group ID.
565 Please note that in order to change the user and/or group the daemon needs
566 superuser privileges. If the daemon is run as an unprivileged user you must
567 specify the same user/group here. If the daemon is run with superuser
568 privileges, you must supply a non-root user here.
570 The executable may be followed by optional arguments that are passed to the
571 program. Please note that due to the configuration parsing numbers and boolean
572 values may be changed. If you want to be absolutely sure that something is
573 passed as-is please enclose it in quotes.
575 The B<Exec> and B<NotificationExec> statements change the semantics of the
576 programs executed, i.E<nbsp>e. the data passed to them and the response
577 expected from them. This is documented in great detail in L<collectd-exec(5)>.
579 =back
581 =head2 Plugin C<filecount>
583 The C<filecount> plugin counts the number of files in a certain directory (and
584 its subdirectories) and their combined size. The configuration is very straight
585 forward:
587   <Plugin "filecount">
588     <Directory "/var/qmail/queue/mess">
589       Instance "qmail-message"
590     </Directory>
591     <Directory "/var/qmail/queue/todo">
592       Instance "qmail-todo"
593     </Directory>
594     <Directory "/var/lib/php5">
595       Instance "php5-sessions"
596       Name "sess_*"
597     </Directory>
598   </Plugin>
600 The example above counts the number of files in QMail's queue directories and
601 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
602 QMail has not yet looked at, the "message" queue holds the messages that were
603 classified into "local" and "remote".
605 As you can see, the configuration consists of one or more C<Directory> blocks,
606 each of which specifies a directory in which to count the files. Within those
607 blocks, the following options are recognized:
609 =over 4
611 =item B<Instance> I<Instance>
613 Sets the plugin instance to I<Instance>. That instance name must be unique, but
614 it's your responsibility, the plugin doesn't check for that. If not given, the
615 instance is set to the directory name with all slashes replaced by underscores
616 and all leading underscores removed.
618 =item B<Name> I<Pattern>
620 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
621 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
622 against the pattern, not the entire path. In case this makes it easier for you:
623 This option has been named after the B<-name> parameter to L<find(1)>.
625 =item B<MTime> I<Age>
627 Count only files of a specific age: If I<Age> is greater than zero, only files
628 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
629 a negative number, this is inversed. For example, if B<-60> is specified, only
630 files that have been modified in the last minute will be counted.
632 The number can also be followed by a "multiplier" to easily specify a larger
633 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
634 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
635 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
636 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
637 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
638 B<"12h">.
640 =item B<Size> I<Size>
642 Count only files of a specific size. When I<Size> is a positive number, only
643 files that are at least this big are counted. If I<Size> is a negative number,
644 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
645 I<Size> are counted.
647 As with the B<MTime> option, a "multiplier" may be added. For a detailed
648 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
649 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
650 note that there are 1000 bytes in a kilobyte, not 1024.
652 =item B<Recursive> I<true>|I<false>
654 Controls whether or not to recurse into subdirectories. Enabled by default.
656 =back
658 =head2 Plugin C<filter_pcre>
660 This plugin allows you to filter and rewrite value lists based on
661 Perl-compatible regular expressions whose syntax and semantics are as close as
662 possible to those of the Perl 5 language. See L<pcre(3)> for details.
664   <Plugin filter_pcre>
665     <RegEx>
666       Host "^mail\d+$"
667       Plugin "^tcpconns$"
668       TypeInstance "^SYN_"
670       Action NoWrite
671     </RegEx>
673     <RegEx>
674       Plugin "^sensors$"
675       PluginInstance "^Some Weird Sensor Chip Name Prefix"
677       SubstitutePluginInstance "foo"
678     </RegEx>
679   </Plugin>
681 The configuration consists of one or more C<RegEx> blocks, each of which
682 specifies a regular expression identifying a set of value lists and how to
683 handle successful matches. A value list keeps the values of a single data-set
684 and is identified by the tuple (host, plugin, plugin instance, type, type
685 instance). The plugin and type instances are optional components. If they are
686 missing they are treated as empty strings. Within those blocks, the following
687 options are recognized:
689 =over 4
691 =item B<Host> I<regex>
693 =item B<Plugin> I<regex>
695 =item B<PluginInstance> I<regex>
697 =item B<Type> I<regex>
699 =item B<TypeInstance> I<regex>
701 Specifies the regular expression for each component of the identifier. If any
702 of these options is missing it is interpreted as a pattern which matches any
703 string. All five components of a value list have to match the appropriate
704 regular expression to trigger the specified action.
706 =item B<Action> I<NoWrite>|I<NoThresholdCheck>|I<Ignore>
708 Specify how to handle successful matches:
710 =over 4
712 =item B<NoWrite>
714 Do not send the value list to any output (a.k.a. write) plugins.
716 =item B<NoThresholdCheck>
718 Skip threshold checking for this value list.
720 =item B<Ignore>
722 Completely ignore this value list.
724 =back
726 Two or more actions may be combined by specifying multiple B<Action> options.
728 =item B<SubstituteHost> I<replacement>
730 =item B<SubstitutePlugin> I<replacement>
732 =item B<SubstitutePluginInstance> I<replacement>
734 =item B<SubstituteType> I<replacement>
736 =item B<SubstituteTypeInstance> I<replacement>
738 Upon a successful match, the matching substring will be replaced by the
739 specified I<replacement> text. These options require that an appropriate regex
740 has been specified before, e.E<nbsp>g. B<SubstituteHost> requires that the
741 B<Host> option has been specified before.
743 B<Note>: It is not recommended to modify the type unless you really know what
744 you are doing. The type is used to identify the data-set definition of the
745 dispatched values.
747 =back
749 =head2 Plugin C<hddtemp>
751 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
752 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
753 default values, see below. C<hddtemp> has to be running to work correctly. If
754 C<hddtemp> is not running timeouts may appear which may interfere with other
755 statistics..
757 The B<hddtemp> homepage can be found at
758 L<http://www.guzu.net/linux/hddtemp.php>.
760 =over 4
762 =item B<Host> I<Hostname>
764 Hostname to connect to. Defaults to B<127.0.0.1>.
766 =item B<Port> I<Port>
768 TCP-Port to connect to. Defaults to B<7634>.
770 =item B<TranslateDevicename> I<true>|I<false>
772 If enabled, translate the disk names to major/minor device numbers
773 (e.E<nbsp>g. "8-0" for /dev/sda). For backwards compatibility this defaults to
774 I<true> but it's recommended to disable it as it will probably be removed in
775 the next major version.
777 =back
779 =head2 Plugin C<interface>
781 =over 4
783 =item B<Interface> I<Interface>
785 Select this interface. By default these interfaces will then be collected. For
786 a more detailed description see B<IgnoreSelected> below.
788 =item B<IgnoreSelected> I<true>|I<false>
790 If no configuration if given, the B<traffic>-plugin will collect data from
791 all interfaces. This may not be practical, especially for loopback- and
792 similar interfaces. Thus, you can use the B<Interface>-option to pick the
793 interfaces you're interested in. Sometimes, however, it's easier/preferred
794 to collect all interfaces I<except> a few ones. This option enables you to
795 do that: By setting B<IgnoreSelected> to I<true> the effect of
796 B<Interface> is inverted: All selected interfaces are ignored and all
797 other interfaces are collected.
799 =back
801 =head2 Plugin C<ipmi>
803 =over 4
805 =item B<Sensor> I<Sensor>
807 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
809 =item B<IgnoreSelected> I<true>|I<false>
811 If no configuration if given, the B<ipmi> plugin will collect data from all
812 sensors found of type "temperature", "voltage", "current" and "fanspeed".
813 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
814 the effect of B<Sensor> is inverted: All selected sensors are ignored and
815 all other sensors are collected.
817 =item B<NotifySensorAdd> I<true>|I<false>
819 If a sensor appears after initialization time of a minute a notification
820 is sent.
822 =item B<NotifySensorRemove> I<true>|I<false>
824 If a sensor disappears a notification is sent.
826 =item B<NotifySensorNotPresent> I<true>|I<false>
828 If you have for example dual power supply and one of them is (un)plugged then
829 a notification is sent.
831 =back
833 =head2 Plugin C<iptables>
835 =over 4
837 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
839 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
840 will collect the counters of all rules which have a comment-match. The comment
841 is then used as type-instance.
843 If I<Comment> or I<Number> is given, only the rule with the matching comment or
844 the I<n>th rule will be collected. Again, the comment (or the number) will be
845 used as the type-instance.
847 If I<Name> is supplied, it will be used as the type-instance instead of the
848 comment or the number.
850 =back
852 =head2 Plugin C<irq>
854 =over 4
856 =item B<Irq> I<Irq>
858 Select this irq. By default these irqs will then be collected. For a more
859 detailed description see B<IgnoreSelected> below.
861 =item B<IgnoreSelected> I<true>|I<false>
863 If no configuration if given, the B<irq>-plugin will collect data from all
864 irqs. This may not be practical, especially if no interrupts happen. Thus, you
865 can use the B<Irq>-option to pick the interrupt you're interested in.
866 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
867 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
868 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
869 and all other interrupts are collected.
871 =back
873 =head2 Plugin C<libvirt>
875 This plugin allows CPU, disk and network load to be collected for virtualized
876 guests on the machine. This means that these characteristics can be collected
877 for guest systems without installing any software on them - collectd only runs
878 on the hosting system. The statistics are collected through libvirt
879 (L<http://libvirt.org/>).
881 Only I<Connection> is required.
883 =over 4
885 =item B<Connection> I<uri>
887 Connect to the hypervisor given by I<uri>. For example if using Xen use:
889  Connection "xen:///"
891 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
893 =item B<RefreshInterval> I<seconds>
895 Refresh the list of domains and devices every I<seconds>. The default is 60
896 seconds. Setting this to be the same or smaller than the I<Interval> will cause
897 the list of domains and devices to be refreshed on every iteration.
899 Refreshing the devices in particular is quite a costly operation, so if your
900 virtualization setup is static you might consider increasing this. If this
901 option is set to 0, refreshing is disabled completely.
903 =item B<Domain> I<name>
905 =item B<BlockDevice> I<name:dev>
907 =item B<InterfaceDevice> I<name:dev>
909 =item B<IgnoreSelected> I<true>|I<false>
911 Select which domains and devices are collected.
913 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
914 disk/network devices are collected.
916 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
917 domains and disk/network devices are ignored, while the rest are collected.
919 The domain name and device names may use a regular expression, if the name is
920 surrounded by I</.../> and collectd was compiled with support for regexps.
922 The default is to collect statistics for all domains and all their devices.
924 Example:
926  BlockDevice "/:hdb/"
927  IgnoreSelected "true"
929 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
930 will be collected.
932 =item B<HostnameFormat> B<name|uuid|hostname|...>
934 When the libvirt plugin logs data, it sets the hostname of the collected data
935 according to this setting. The default is to use the guest name as provided by
936 the hypervisor, which is equal to setting B<name>.
938 B<uuid> means use the guest's UUID. This is useful if you want to track the
939 same guest across migrations.
941 B<hostname> means to use the global B<Hostname> setting, which is probably not
942 useful on its own because all guests will appear to have the same name.
944 You can also specify combinations of these fields. For example B<name uuid>
945 means to concatenate the guest name and UUID (with a literal colon character
946 between, thus I<"foo:1234-1234-1234-1234">).
948 =back
950 =head2 Plugin C<logfile>
952 =over 4
954 =item B<LogLevel> B<debug|info|notice|warning|err>
956 Sets the log-level. If, for example, set to B<notice>, then all events with
957 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
959 Please note that B<debug> is only available if collectd has been compiled with
960 debugging support.
962 =item B<File> I<File>
964 Sets the file to write log messages to. The special strings B<stdout> and
965 B<stderr> can be used to write to the standard output and standard error
966 channels, respectively. This, of course, only makes much sense when collectd is
967 running in foreground- or non-daemon-mode.
969 =item B<Timestamp> B<true>|B<false>
971 Prefix all lines printed by the current time. Defaults to B<true>.
973 =back
975 =head2 Plugin C<mbmon>
977 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
979 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
980 B<Host> and B<Port> options can be used to change these values, see below.
981 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
982 timeouts may appear which may interfere with other statistics..
984 C<mbmon> must be run with the -r option ("print TAG and Value format");
985 Debian's F</etc/init.d/mbmon> script already does this, other people
986 will need to ensure that this is the case.
988 =over 4
990 =item B<Host> I<Hostname>
992 Hostname to connect to. Defaults to B<127.0.0.1>.
994 =item B<Port> I<Port>
996 TCP-Port to connect to. Defaults to B<411>.
998 =back
1000 =head2 Plugin C<memcached>
1002 The C<memcached plugin> connects to a memcached server and queries statistics
1003 about cache utilization, memory and bandwidth used.
1004 L<http://www.danga.com/memcached/>
1006 =over 4
1008 =item B<Host> I<Hostname>
1010 Hostname to connect to. Defaults to B<127.0.0.1>.
1012 =item B<Port> I<Port>
1014 TCP-Port to connect to. Defaults to B<11211>.
1016 =back
1018 =head2 Plugin C<mysql>
1020 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to the
1021 database when started and keeps the connection up as long as possible. When the
1022 connection is interrupted for whatever reason it will try to re-connect. The
1023 plugin will complaint loudly in case anything goes wrong.
1025 This plugin issues the MySQL C<SHOW STATUS> command and collects information
1026 about MySQL network traffic, executed statements, requests, the query cache
1027 and threads by evaluating the C<Bytes_{received,sent}>, C<Com_*>,
1028 C<Handler_*>, C<Qcache_*> and C<Threads_*> return values. Please refer to the
1029 B<MySQL reference manual>, I<5.1.6. Server Status Variables> for an
1030 explanation of these values.
1032 Use the following options to configure the plugin:
1034 =over 4
1036 =item B<Host> I<Hostname>
1038 Hostname of the database server. Defaults to B<localhost>.
1040 =item B<User> I<Username>
1042 Username to use when connecting to the database. The user does not have to be
1043 granted any privileges (which is synonym to granting the C<USAGE> privilege).
1044 Any existing MySQL user will do.
1046 =item B<Password> I<Password>
1048 Password needed to log into the database.
1050 =item B<Database> I<Database>
1052 Select this database. Defaults to I<no database> which is a perfectly reasonable
1053 option for what this plugin does.
1055 =item B<Port> I<Port>
1057 TCP-port to connect to. The port must be specified in its numeric form, but it
1058 must be passed as a string nonetheless. For example:
1060   Port "3306"
1062 If B<Host> is set to B<localhost> (the default), this setting has no effect.
1063 See the documentation for the C<mysql_real_connect> function for details.
1065 =item B<Socket> I<Socket>
1067 Specifies the path to the UNIX domain socket of the MySQL server. This option
1068 only has any effect, if B<Host> is set to B<localhost> (the default).
1069 Otherwise, use the B<Port> option above. See the documentation for the
1070 C<mysql_real_connect> function for details.
1072 =back
1074 =head2 Plugin C<netlink>
1076 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
1077 statistics of various interface and routing aspects.
1079 =over 4
1081 =item B<Interface> I<Interface>
1083 =item B<VerboseInterface> I<Interface>
1085 Instruct the plugin to collect interface statistics. This is basically the same
1086 as the statistics provided by the C<interface> plugin (see above) but
1087 potentially much more detailed.
1089 When configuring with B<Interface> only the basic statistics will be collected,
1090 namely octets, packets, and errors. These statistics are collected by
1091 the C<interface> plugin, too, so using both at the same time is no benefit.
1093 When configured with B<VerboseInterface> all counters B<except> the basic ones,
1094 so that no data needs to be collected twice if you use the C<interface> plugin.
1095 This includes dropped packets, received multicast packets, collisions and a
1096 whole zoo of differentiated RX and TX errors. You can try the following command
1097 to get an idea of what awaits you:
1099   ip -s -s link list
1101 If I<Interface> is B<All>, all interfaces will be selected.
1103 =item B<QDisc> I<Interface> [I<QDisc>]
1105 =item B<Class> I<Interface> [I<Class>]
1107 =item B<Filter> I<Interface> [I<Filter>]
1109 Collect the octets and packets that pass a certain qdisc, class or filter.
1111 QDiscs and classes are identified by their type and handle (or classid).
1112 Filters don't necessarily have a handle, therefore the parent's handle is used.
1113 The notation used in collectd differs from that used in tc(1) in that it
1114 doesn't skip the major or minor number if it's zero and doesn't print special
1115 ids by their name. So, for example, a qdisc may be identified by
1116 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
1117 thus not displayed by tc(1).
1119 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
1120 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
1121 associated with that interface will be collected.
1123 Since a filter itself doesn't necessarily have a handle, the parent's handle is
1124 used. This may lead to problems when more than one filter is attached to a
1125 qdisc or class. This isn't nice, but we don't know how this could be done any
1126 better. If you have a idea, please don't hesitate to tell us.
1128 As with the B<Interface> option you can specify B<All> as the interface,
1129 meaning all interfaces.
1131 Here are some examples to help you understand the above text more easily:
1133   <Plugin netlink>
1134     VerboseInterface "All"
1135     QDisc "eth0" "pfifo_fast-1:0"
1136     QDisc "ppp0"
1137     Class "ppp0" "htb-1:10"
1138     Filter "ppp0" "u32-1:0"
1139   </Plugin>
1141 =item B<IgnoreSelected>
1143 The behaviour is the same as with all other similar plugins: If nothing is
1144 selected at all, everything is collected. If some things are selected using the
1145 options described above, only these statistics are collected. If you set
1146 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
1147 specified statistics will not be collected.
1149 =back
1151 =head2 Plugin C<network>
1153 =over 4
1155 =item B<Listen> I<Host> [I<Port>]
1157 =item B<Server> I<Host> [I<Port>]
1159 The B<Server> statement sets the server to send datagrams B<to>.  The statement
1160 may occur multiple times to send each datagram to multiple destinations.
1162 The B<Listen> statement sets the interfaces to bind to. When multiple
1163 statements are found the daemon will bind to multiple interfaces.
1165 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
1166 the argument is a multicast address the daemon will join that multicast group.
1168 If no B<Listen> statement is found the server tries join both, the default IPv6
1169 multicast group and the default IPv4 multicast group. If no B<Server> statement
1170 is found the client will try to send data to the IPv6 multicast group first. If
1171 that fails the client will try the IPv4 multicast group.
1173 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
1174 multicast group is C<239.192.74.66>.
1176 The optional I<Port> argument sets the port to use. It can either be given
1177 using a numeric port number or a service name. If the argument is omitted the
1178 default port B<25826> is assumed.
1180 =item B<TimeToLive> I<1-255>
1182 Set the time-to-live of sent packets. This applies to all, unicast and
1183 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
1184 That means that multicast packets will be sent with a TTL of C<1> (one) on most
1185 operating systems.
1187 =item B<Forward> I<true|false>
1189 If set to I<true>, write packets that were received via the network plugin to
1190 the sending sockets. This should only be activated when the B<Listen>- and
1191 B<Server>-statements differ. Otherwise packets may be send multiple times to
1192 the same multicast group. While this results in more network traffic than
1193 necessary it's not a huge problem since the plugin has a duplicate detection,
1194 so the values will not loop.
1196 =item B<CacheFlush> I<Seconds>
1198 For each host/plugin/type combination the C<network plugin> caches the time of
1199 the last value being sent or received. Every I<Seconds> seconds the plugin
1200 searches and removes all entries that are older than I<Seconds> seconds, thus
1201 freeing the unused memory again. Since this process is somewhat expensive and
1202 normally doesn't do much, this value should not be too small. The default is
1203 1800 seconds, but setting this to 86400 seconds (one day) will not do much harm
1204 either.
1206 =back
1208 =head2 Plugin C<nginx>
1210 This plugin collects the number of connections and requests handled by the
1211 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
1212 queries the page provided by the C<ngx_http_stub_status_module> module, which
1213 isn't compiled by default. Please refer to
1214 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
1215 how to compile and configure nginx and this module.
1217 The following options are accepted by the C<nginx plugin>:
1219 =over 4
1221 =item B<URL> I<http://host/nginx_status>
1223 Sets the URL of the C<ngx_http_stub_status_module> output.
1225 =item B<User> I<Username>
1227 Optional user name needed for authentication.
1229 =item B<Password> I<Password>
1231 Optional password needed for authentication.
1233 =item B<VerifyPeer> B<true|false>
1235 Enable or disable peer SSL certificate verification. See
1236 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1238 =item B<VerifyHost> B<true|false>
1240 Enable or disable peer host name verification. If enabled, the plugin checks
1241 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
1242 certificate matches the host name provided by the B<URL> option. If this
1243 identity check fails, the connection is aborted. Obviously, only works when
1244 connecting to a SSL enabled server. Enabled by default.
1246 =item B<CACert> I<File>
1248 File that holds one or more SSL certificates. If you want to use HTTPS you will
1249 possibly need this option. What CA certificates come bundled with C<libcurl>
1250 and are checked by default depends on the distribution you use.
1252 =back
1254 =head2 Plugin C<notify_desktop>
1256 This plugin sends a desktop notification to a notification daemon, as defined
1257 in the Desktop Notification Specification. To actually display the
1258 notifications, B<notification-daemon> is required and B<collectd> has to be
1259 able to access the X server.
1261 The Desktop Notification Specification can be found at
1262 L<http://www.galago-project.org/specs/notification/>.
1264 =over 4
1266 =item B<OkayTimeout> I<timeout>
1268 =item B<WarningTimeout> I<timeout>
1270 =item B<FailureTimeout> I<timeout>
1272 Set the I<timeout>, in milliseconds, after which to expire the notification
1273 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
1274 been specified, the displayed notification will not be closed at all - the
1275 user has to do so herself. These options default to 5000. If a negative number
1276 has been specified, the default is used as well.
1278 =back
1280 =head2 Plugin C<ntpd>
1282 =over 4
1284 =item B<Host> I<Hostname>
1286 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
1288 =item B<Port> I<Port>
1290 UDP-Port to connect to. Defaults to B<123>.
1292 =item B<ReverseLookups> B<true>|B<false>
1294 Sets wether or not to perform reverse lookups on peers. Since the name or
1295 IP-address may be used in a filename it is recommended to disable reverse
1296 lookups. The default is to do reverse lookups to preserve backwards
1297 compatibility, though.
1299 =back
1301 =head2 Plugin C<nut>
1303 =over 4
1305 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
1307 Add a UPS to collect data from. The format is identical to the one accepted by
1308 L<upsc(8)>.
1310 =back
1312 =head2 Plugin C<onewire>
1314 B<EXPERIMENTAL!> See notes below.
1316 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
1317 L<http://owfs.org/> to read sensors connected via the onewire bus.
1319 Currently only temperature sensors (sensors with the family code C<10>,
1320 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
1321 would like to have included, please send a sort request to the mailing list.
1323 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
1324 experimental, below.
1326 =over 4
1328 =item B<Device> I<Device>
1330 Sets the device to read the values from. This can either be a "real" hardware
1331 device, such as a serial port or an USB port, or the address of the
1332 L<owserver(1)> socket, usually B<localhost:4304>.
1334 Though the documentation claims to automatically recognize the given address
1335 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
1336 with that version, the following configuration worked for us:
1338   <Plugin onewire>
1339     Device "-s localhost:4304"
1340   </Plugin>
1342 This directive is B<required> and does not have a default value.
1344 =item B<Sensor> I<Sensor>
1346 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
1347 below. Sensors are specified without the family byte at the beginning, to you'd
1348 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
1349 point.
1351 =item B<IgnoreSelected> I<true>|I<false>
1353 If no configuration if given, the B<onewire> plugin will collect data from all
1354 sensors found. This may not be practical, especially if sensors are added and
1355 removed regularly. Sometimes, however, it's easier/preferred to collect only
1356 specific sensors or all sensors I<except> a few specified ones. This option
1357 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
1358 B<Sensor> is inverted: All selected interfaces are ignored and all other
1359 interfaces are collected.
1361 =back
1363 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
1364 work with big setups. It works with one sensor being attached to one
1365 controller, but as soon as you throw in a couple more senors and maybe a hub
1366 or two, reading all values will take more than ten seconds (the default
1367 interval). We will probably add some separate thread for reading the sensors
1368 and some cache or something like that, but it's not done yet. We will try to
1369 maintain backwards compatibility in the future, but we can't promise. So in
1370 short: If it works for you: Great! But keep in mind that the config I<might>
1371 change, though this is unlikely. Oh, and if you want to help improving this
1372 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
1374 =head2 Plugin C<openvpn>
1376 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
1377 traffic statistics about connected clients.
1379 To set up OpenVPN to write to the status file periodically, use the
1380 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
1381 you need to set the required format, too. This is done by setting
1382 B<--status-version> to B<2>.
1384 So, in a nutshell you need:
1386   openvpn $OTHER_OPTIONS \
1387     --status "/var/run/openvpn-status" 10 \
1388     --status-version 2
1390 Available options:
1392 =over 4
1394 =item B<StatusFile> I<File>
1396 Specifies the location of the status file.
1398 =back
1400 =head2 Plugin C<oracle>
1402 The "oracle" plugin uses the Oracle® Call Interface (OCI) to connect to an
1403 Oracle® Database and lets you execute SQL statements there. It is very similar
1404 to the "dbi" plugin, because it was written around the same time. See the "dbi"
1405 plugin's documentation above for details.
1407   <Plugin oracle>
1408     <Query "out_of_stock">
1409       Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1410       Type "gauge"
1411       InstancesFrom "category"
1412       ValuesFrom "value"
1413     </Query>
1414     <Database "product_information">
1415       ConnectID "db01"
1416       Username "oracle"
1417       Password "secret"
1418       Query "out_of_stock"
1419     </Database>
1420   </Plugin>
1422 =head3 B<Query> blocks
1424 The Query blocks are handled identically to the Query blocks of the "dbi"
1425 plugin. Please see its documentation above for details on how to specify
1426 queries.
1428 =head3 B<Database> blocks
1430 Database blocks define a connection to a database and which queries should be
1431 sent to that database. Each database needs a "name" as string argument in the
1432 starting tag of the block. This name will be used as "PluginInstance" in the
1433 values submitted to the daemon. Other than that, that name is not used.
1435 =over 4
1437 =item B<ConnectID> I<ID>
1439 Defines the "database alias" or "service name" to connect to. Usually, these
1440 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
1442 =item B<Username> I<Username>
1444 Username used for authentication.
1446 =item B<Password> I<Password>
1448 Password used for authentication.
1450 =item B<Query> I<QueryName>
1452 Associates the query named I<QueryName> with this database connection. The
1453 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1454 blocks you want to refer to must be placed above the database block you want to
1455 refer to them from.
1457 =back
1459 =head2 Plugin C<perl>
1461 This plugin embeds a Perl-interpreter into collectd and provides an interface
1462 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
1464 =head2 Plugin C<ping>
1466 =over 4
1468 =item B<Host> I<IP-address>
1470 Host to ping periodically. This option may be repeated several times to ping
1471 multiple hosts.
1473 =item B<TTL> I<0-255>
1475 Sets the Time-To-Live of generated ICMP packets.
1477 =back
1479 =head2 Plugin C<postgresql>
1481 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
1482 keeps a persistent connection to all configured databases and tries to
1483 reconnect if the connection has been interrupted. A database is configured by
1484 specifying a B<Database> block as described below. The default statistics are
1485 collected from PostgreSQL's B<statistics collector> which thus has to be
1486 enabled for this plugin to work correctly. This should usually be the case by
1487 default. See the section "The Statistics Collector" of the B<PostgreSQL
1488 Documentation> for details.
1490 By specifying custom database queries using a B<Query> block as described
1491 below, you may collect any data that is available from some PostgreSQL
1492 database. This way, you are able to access statistics of external daemons
1493 which are available in a PostgreSQL database or use future or special
1494 statistics provided by PostgreSQL without the need to upgrade your collectd
1495 installation.
1497 The B<PostgreSQL Documentation> manual can be found at
1498 L<http://www.postgresql.org/docs/manuals/>.
1500   <Plugin postgresql>
1501     <Query magic>
1502       Query "SELECT magic, spells FROM wizard WHERE host = $1;"
1503       Param hostname
1504       Column gauge magic
1505       Column counter spells
1506     </Query>
1508     <Database foo>
1509       Host "hostname"
1510       Port "5432"
1511       User "username"
1512       Password "secret"
1513       SSLMode "prefer"
1514       KRBSrvName "kerberos_service_name"
1515       Query magic
1516     </Database>
1517     <Database bar>
1518       Service "service_name"
1519     </Database>
1520   </Plugin>
1522 The B<Query> block defines one database query which may later be used by a
1523 database definition. It accepts a single mandatory argument which specifies
1524 the name of the query. The names of all queries have to be unique. The
1525 following configuration options are available to define the query:
1527 =over 4
1529 =item B<Query> I<sql query>
1531 Specify the I<sql query> which the plugin should execute. The string may
1532 contain the tokens B<$1>, B<$2>, etc. which are used to reference the first,
1533 second, etc. parameter. The value of the parameters is specified by the
1534 B<Param> configuration option - see below for details. To include a literal
1535 B<$> character followed by a number, surround it with single quotes (B<'>).
1537 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
1538 allowed. Note, however, that only a single command may be used. Semicolons are
1539 allowed as long as a single non-empty command has been specified only.
1541 =item B<Param> I<hostname>|I<database>|I<username>
1543 Specify the parameters which should be passed to the SQL query. The parameters
1544 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
1545 they appear in the configuration file. The value of the parameter is
1546 determined depending on the value of the B<Param> option as follows:
1548 =over 4
1550 =item I<hostname>
1552 The configured hostname of the database connection. If a UNIX domain socket is
1553 used, the parameter expands to "localhost".
1555 =item I<database>
1557 The name of the database of the current connection.
1559 =item I<username>
1561 The username used to connect to the database.
1563 =back
1565 Please note that parameters are only supported by PostgreSQL's protocol
1566 version 3 and above which was introduced in version 7.4 of PostgreSQL.
1568 =item B<Column> I<type> [I<type instance>]
1570 Specify the I<type> and optional I<type instance> used to dispatch the value
1571 of each result column. Detailed information about types and their
1572 configuration can be found in L<types.db(5)>. The number and order of the
1573 B<Column> options has to match the columns of the query result.
1575 =item B<MinPGVersion> I<version>
1577 =item B<MaxPGVersion> I<version>
1579 Specify the minimum or maximum version of PostgreSQL that this query should be
1580 used with. Some statistics might only be available with certain versions of
1581 PostgreSQL. This allows you to specify multiple queries with the same name but
1582 which apply to different versions, thus allowing you to use the same
1583 configuration in a heterogeneous environment.
1585 The I<version> has to be specified as the concatenation of the major, minor
1586 and patch-level versions, each represented as two-decimal-digit numbers. For
1587 example, version 8.2.3 will become 80203.
1589 =back
1591 The following predefined queries are available (the definitions can be found
1592 in the F<postgresql_default.conf> file which, by default, is available at
1593 C<I<prefix>/share/collectd/>):
1595 =over 4
1597 =item B<backends>
1599 This query collects the number of backends, i.E<nbsp>e. the number of
1600 connected clients.
1602 =item B<transactions>
1604 This query collects the numbers of committed and rolled-back transactions of
1605 the user tables.
1607 =item B<queries>
1609 This query collects the numbers of various table modifications (i.E<nbsp>e.
1610 insertions, updates, deletions) of the user tables.
1612 =item B<query_plans>
1614 This query collects the numbers of various table scans and returned tuples of
1615 the user tables.
1617 =item B<table_states>
1619 This query collects the numbers of live and dead rows in the user tables.
1621 =item B<disk_io>
1623 This query collects disk block access counts for user tables.
1625 =item B<disk_usage>
1627 This query collects the on-disk size of the database in bytes.
1629 =back
1631 The B<Database> block defines one PostgreSQL database for which to collect
1632 statistics. It accepts a single mandatory argument which specifies the
1633 database name. None of the other options are required. PostgreSQL will use
1634 default values as documented in the section "CONNECTING TO A DATABASE" in the
1635 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
1636 the user collectd is run as and special environment variables. See the manpage
1637 for details.
1639 =over 4
1641 =item B<Host> I<hostname>
1643 Specify the hostname or IP of the PostgreSQL server to connect to. If the
1644 value begins with a slash, it is interpreted as the directory name in which to
1645 look for the UNIX domain socket.
1647 This option is also used to determine the hostname that is associated with a
1648 collected data set. If it has been omitted or either begins with with a slash
1649 or equals B<localhost> it will be replaced with the global hostname definition
1650 of collectd. Any other value will be passed literally to collectd when
1651 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
1653 =item B<Port> I<port>
1655 Specify the TCP port or the local UNIX domain socket file extension of the
1656 server.
1658 =item B<User> I<username>
1660 Specify the username to be used when connecting to the server.
1662 =item B<Password> I<password>
1664 Specify the password to be used when connecting to the server.
1666 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
1668 Specify whether to use an SSL connection when contacting the server. The
1669 following modes are supported:
1671 =over 4
1673 =item I<disable>
1675 Do not use SSL at all.
1677 =item I<allow>
1679 First, try to connect without using SSL. If that fails, try using SSL.
1681 =item I<prefer> (default)
1683 First, try to connect using SSL. If that fails, try without using SSL.
1685 =item I<require>
1687 Use SSL only.
1689 =back
1691 =item B<KRBSrvName> I<kerberos_service_name>
1693 Specify the Kerberos service name to use when authenticating with Kerberos 5
1694 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
1695 B<PostgreSQL Documentation> for details.
1697 =item B<Service> I<service_name>
1699 Specify the PostgreSQL service name to use for additional parameters. That
1700 service has to be defined in F<pg_service.conf> and holds additional
1701 connection parameters. See the section "The Connection Service File" in the
1702 B<PostgreSQL Documentation> for details.
1704 =item B<Query> I<query>
1706 Specify a I<query> which should be executed for the database connection. This
1707 may be any of the predefined or user-defined queries. If no such option is
1708 given, it defaults to "backends", "transactions", "queries", "query_plans",
1709 "table_states", "disk_io" and "disk_usage". Else, the specified queries are
1710 used only.
1712 =back
1714 =head2 Plugin C<powerdns>
1716 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
1717 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
1718 values, many of which are probably meaningless to most users, but may be useful
1719 for some. So you may chose which values to collect, but if you don't, some
1720 reasonable defaults will be collected.
1722   <Plugin "powerdns">
1723     <Server "server_name">
1724       Collect "latency"
1725       Collect "udp-answers" "udp-queries"
1726       Socket "/var/run/pdns.controlsocket"
1727     </Server>
1728     <Recursor "recursor_name">
1729       Collect "questions"
1730       Collect "cache-hits" "cache-misses"
1731       Socket "/var/run/pdns_recursor.controlsocket"
1732     </Recursor>
1733     LocalSocket "/opt/collectd/var/run/collectd-powerdns"
1734   </Plugin>
1736 =over 4
1738 =item B<Server> and B<Recursor> block
1740 The B<Server> block defines one authoritative server to query, the B<Recursor>
1741 does the same for an recursing server. The possible options in both blocks are
1742 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
1743 and is required.
1745 =over 4
1747 =item B<Collect> I<Field>
1749 Using the B<Collect> statement you can select which values to collect. Here,
1750 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
1751 C<dlg-only-drops>, C<answers10-100>.
1753 The method of getting the values differs for B<Server> and B<Recursor> blocks:
1754 When querying the server a C<SHOW *> command is issued in any case, because
1755 that's the only way of getting multiple values out of the server at once.
1756 collectd then picks out the values you have selected. When querying the
1757 recursor, a command is generated to query exactly these values. So if you
1758 specify invalid fields when querying the recursor, a syntax error may be
1759 returned by the daemon and collectd may not collect any values at all.
1761 If no B<Collect> statement is given, the following B<Server> values will be
1762 collected:
1764 =over 4
1766 =item latency
1768 =item packetcache-hit
1770 =item packetcache-miss
1772 =item packetcache-size
1774 =item query-cache-hit
1776 =item query-cache-miss
1778 =item recursing-answers
1780 =item recursing-questions
1782 =item tcp-answers
1784 =item tcp-queries
1786 =item udp-answers
1788 =item udp-queries
1790 =back
1792 The following B<Recursor> values will be collected by default:
1794 =over 4
1796 =item noerror-answers
1798 =item nxdomain-answers
1800 =item servfail-answers
1802 =item sys-msec
1804 =item user-msec
1806 =item qa-latency
1808 =item cache-entries
1810 =item cache-hits
1812 =item cache-misses
1814 =item questions
1816 =back
1818 Please note that up to that point collectd doesn't know what values are
1819 available on the server and values that are added do not need a change of the
1820 mechanism so far. However, the values must be mapped to collectd's naming
1821 scheme, which is done using a lookup table that lists all known values. If
1822 values are added in the future and collectd does not know about them, you will
1823 get an error much like this:
1825   powerdns plugin: submit: Not found in lookup table: foobar = 42
1827 In this case please file a bug report with the collectd team.
1829 =item B<Socket> I<Path>
1831 Configures the path to the UNIX domain socket to be used when connecting to the
1832 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
1833 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
1834 will be used for the recursor.
1836 =back
1838 =item B<LocalSocket> I<Path>
1840 Querying the recursor is done using UDP. When using UDP over UNIX domain
1841 sockets, the client socket needs a name in the file system, too. You can set
1842 this local name to I<Path> using the B<LocalSocket> option. The default is
1843 C<I<prefix>/var/run/collectd-powerdns>.
1845 =back
1847 =head2 Plugin C<processes>
1849 =over 4
1851 =item B<Process> I<Name>
1853 Select more detailed statistics of processes matching this name. The statistics
1854 collected for these selected processes are size of the resident segment size
1855 (RSS), user- and system-time used, number of processes and number of threads,
1856 and minor and major pagefaults.
1858 =item B<ProcessMatch> I<name> I<regex>
1860 Similar to the B<Process> option this allows to select more detailed
1861 statistics of processes matching the specified I<regex> (see L<regex(7)> for
1862 details). The statistics of all matching processes are summed up and
1863 dispatched to the daemon using the specified I<name> as an identifier. This
1864 allows to "group" several processes together. I<name> must not contain
1865 slashes.
1867 =back
1869 =head2 Plugin C<rrdcached>
1871 The C<rrdcached> plugin uses the RRDTool accelerator daemon, L<rrdcached(1)>,
1872 to store values to RRD files in an efficient manner. The combination of the
1873 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
1874 way the C<rrdtool> plugin works (see below). The added abstraction layer
1875 provides a number of benefits, though: Because the cache is not within
1876 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
1877 restarted. This results in much shorter (if any) gaps in graphs, especially
1878 under heavy load. Also, the C<rrdtool> command line utility is aware of the
1879 daemon so that it can flush values to disk automatically when needed. This
1880 allows to integrate automated flushing of values into graphing solutions much
1881 more easily.
1883 There are disadvantages, though: The daemon may reside on a different host, so
1884 it may not be possible for C<collectd> to create the appropriate RRD files
1885 anymore. And even if C<rrdcached> runs on the same host, it may run in a
1886 different base directory, so relative paths may do weird stuff if you're not
1887 careful.
1889 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
1890 on the same host, communicating via a UNIX domain socket. The B<DataDir>
1891 setting should be set to an absolute path, so that a changed base directory
1892 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
1894 =over 4
1896 =item B<DaemonAddress> I<Address>
1898 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
1899 library. See L<rrdcached(1)> for details. Example:
1901   <Plugin "rrdcached">
1902     DaemonAddress "unix:/var/run/rrdcached.sock"
1903   </Plugin>
1905 =item B<DataDir> I<Directory>
1907 Set the base directory in which the RRD files reside. If this is a relative
1908 path, it is relative to the working base directory of the C<rrdcached> daemon!
1909 Use of an absolute path is recommended.
1911 =item B<CreateFiles> B<true>|B<false>
1913 Enables or disables the creation of RRD files. If the daemon is not running
1914 locally, or B<DataDir> is set to a relative path, this will not work as
1915 expected. Default is B<true>.
1917 =back
1919 =head2 Plugin C<rrdtool>
1921 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
1922 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
1923 using these settings. If you don't want to dive into the depths of RRDTool, you
1924 can safely ignore these settings.
1926 =over 4
1928 =item B<DataDir> I<Directory>
1930 Set the directory to store RRD-files under. Per default RRD-files are generated
1931 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1933 =item B<StepSize> I<Seconds>
1935 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
1936 this setting is unset and the stepsize is set to the interval in which the data
1937 is collected. Do not use this option unless you absolutely have to for some
1938 reason. Setting this option may cause problems with the C<snmp plugin>, the
1939 C<exec plugin> or when the daemon is set up to receive data from other hosts.
1941 =item B<HeartBeat> I<Seconds>
1943 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
1944 in which case the heartbeat is set to twice the B<StepSize> which should equal
1945 the interval in which data is collected. Do not set this option unless you have
1946 a very good reason to do so.
1948 =item B<RRARows> I<NumRows>
1950 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
1951 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
1952 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
1953 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
1954 week, one month, and one year.
1956 So for each timespan, it calculates how many PDPs need to be consolidated into
1957 one CDP by calculating:
1958   number of PDPs = timespan / (stepsize * rrarows)
1960 Bottom line is, set this no smaller than the width of you graphs in pixels. The
1961 default is 1200.
1963 =item B<RRATimespan> I<Seconds>
1965 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
1966 more then one RRA. If this option is never used, the built-in default of (3600,
1967 86400, 604800, 2678400, 31622400) is used.
1969 For more information on how RRA-sizes are calculated see B<RRARows> above.
1971 =item B<XFF> I<Factor>
1973 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
1975 =item B<CacheFlush> I<Seconds>
1977 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
1978 it writes all values for a certain RRD-file if the oldest value is older than
1979 (or equal to) the number of seconds specified. If some RRD-file is not updated
1980 anymore for some reason (the computer was shut down, the network is broken,
1981 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
1982 entire cache is searched for entries older than B<CacheTimeout> seconds and
1983 written to disk every I<Seconds> seconds. Since this is kind of expensive and
1984 does nothing under normal circumstances, this value should not be too small.
1985 900 seconds might be a good value, though setting this to 7200 seconds doesn't
1986 normally do much harm either.
1988 =item B<CacheTimeout> I<Seconds>
1990 If this option is set to a value greater than zero, the C<rrdtool plugin> will
1991 save values in a cache, as described above. Writing multiple values at once
1992 reduces IO-operations and thus lessens the load produced by updating the files.
1993 The trade off is that the graphs kind of "drag behind" and that more memory is
1994 used.
1996 =item B<WritesPerSecond> B<Updates>
1998 When collecting many statistics with collectd and the C<rrdtool> plugin, you
1999 will run serious performance problems. The B<CacheFlush> setting and the
2000 internal update queue assert that collectd continues to work just fine even
2001 under heavy load, but the system may become very unresponsive and slow. This is
2002 a problem especially if you create graphs from the RRD files on the same
2003 machine, for example using the C<graph.cgi> script included in the
2004 C<contrib/collection3/> directory.
2006 This setting is designed for very large setups. Setting this option to a value
2007 between 25 and 80 updates per second, depending on your hardware, will leave
2008 the server responsive enough to draw graphs even while all the cached values
2009 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
2010 by the B<FLUSH> command, are B<not> effected by this limit. They are still
2011 written as fast as possible, so that web frontends have up to date data when
2012 generating graphs.
2014 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
2015 updates per second, writing all values to disk will take approximately
2016 56E<nbsp>minutes. Together with the flushing ability that's integrated into
2017 "collection3" you'll end up with a responsive and fast system, up to date
2018 graphs and basically a "backup" of your values every hour.
2020 =back
2022 =head2 Plugin C<sensors>
2024 The C<sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
2025 that all the needed modules have to be loaded and lm_sensors has to be
2026 configured (most likely by editing F</etc/sensors.conf>. Read
2027 L<sensors.conf(5)> for details.
2029 The B<lm_sensors> homepage can be found at
2030 L<http://secure.netroedge.com/~lm78/>.
2032 =over 4
2034 =item B<Sensor> I<chip-bus-address/type-feature>
2036 Selects the name of the sensor which you want to collect or ignore, depending
2037 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
2038 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
2039 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
2041 =item B<IgnoreSelected> I<true>|I<false>
2043 If no configuration if given, the B<sensors>-plugin will collect data from all
2044 sensors. This may not be practical, especially for uninteresting sensors.
2045 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
2046 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
2047 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2048 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
2049 and all other sensors are collected.
2051 =back
2053 =head2 Plugin C<snmp>
2055 Since the configuration of the C<snmp plugin> is a little more complicated than
2056 other plugins, its documentation has been moved to an own manpage,
2057 L<collectd-snmp(5)>. Please see there for details.
2059 =head2 Plugin C<syslog>
2061 =over 4
2063 =item B<LogLevel> B<debug|info|notice|warning|err>
2065 Sets the log-level. If, for example, set to B<notice>, then all events with
2066 severity B<notice>, B<warning>, or B<err> will be submitted to the
2067 syslog-daemon.
2069 Please note that B<debug> is only available if collectd has been compiled with
2070 debugging support.
2072 =back
2074 =head2 Plugin C<tail>
2076 The C<tail plugin> plugins follows logfiles, just like L<tail(1)> does, parses
2077 each line and dispatches found values. What is matched can be configured by the
2078 user using (extended) regular expressions, as described in L<regex(7)>.
2080   <Plugin "tail">
2081     <File "/var/log/exim4/mainlog">
2082       Instance "exim"
2083       <Match>
2084         Regex "S=([1-9][0-9]*)"
2085         DSType "CounterAdd"
2086         Type "ipt_bytes"
2087         Instance "total"
2088       </Match>
2089       <Match>
2090         Regex "\\<R=local_user\\>"
2091         DSType "CounterInc"
2092         Type "counter"
2093         Instance "local_user"
2094       </Match>
2095     </File>
2096   </Plugin>
2098 The config consists of one or more B<File> blocks, each of which configures one
2099 logfile to parse. Within each B<File> block, there are one or more B<Match>
2100 blocks, which configure a regular expression to search for.
2102 The B<Instance> option in the B<File> block may be used to set the plugin
2103 instance. So in the above example the plugin name C<tail-foo> would be used.
2104 This plugin instance is for all B<Match> blocks that B<follow> it, until the
2105 next B<Instance> option. This way you can extract several plugin instances from
2106 one logfile, handy when parsing syslog and the like.
2108 Each B<Match> block has the following options to describe how the match should
2109 be performed:
2111 =over 4
2113 =item B<Regex> I<regex>
2115 Sets the regular expression to use for matching against a line. The first
2116 subexpression has to match something that can be turned into a number by
2117 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
2118 below. Because B<extended> regular expressions are used, you do not need to use
2119 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
2120 collectd's config parsing you need to escape backslashes, though. So if you
2121 want to match literal parentheses you need to do the following:
2123   Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
2125 =item B<DSType> I<Type>
2127 Sets how the values are cumulated. I<Type> is one of:
2129 =over 4
2131 =item B<GaugeAverage>
2133 Calculate the average.
2135 =item B<GaugeMin>
2137 Use the smallest number only.
2139 =item B<GaugeMax>
2141 Use the greatest number only.
2143 =item B<GaugeLast>
2145 Use the last number found.
2147 =item B<CounterSet>
2149 The matched number is a counter. Simply sets the internal counter to this
2150 value.
2152 =item B<CounterAdd>
2154 Add the matched value to the internal counter.
2156 =item B<CounterInc>
2158 Increase the internal counter by one. This B<DSType> is the only one that does
2159 not use the matched subexpression, but simply counts the number of matched
2160 lines. Thus, you may use a regular expression without submatch in this case.
2162 =back
2164 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
2165 number, using L<strtod(3)>. The B<CounterSet> and B<CounterAdd> interpret the
2166 submatch as an integer using L<strtoll(3)>. B<CounterInc> does not use the
2167 submatch at all and it may be omitted in this case.
2169 =item B<Type> I<Type>
2171 Sets the type used to dispatch this value. Detailed information about types and
2172 their configuration can be found in L<types.db(5)>.
2174 =item B<Instance> I<TypeInstance>
2176 This optional setting sets the type instance to use.
2178 =back
2180 =head2 Plugin C<teamspeak2>
2182 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
2183 polls interesting global and virtual server data. The plugin can query only one
2184 physical server but unlimited virtual servers. You can use the following
2185 options to configure it:
2187 =over 4
2189 =item B<Host> I<hostname/ip>
2191 The hostname or ip which identifies the physical server.
2192 Default: 127.0.0.1
2194 =item B<Port> I<port>
2196 The query port of the physical server. This needs to be a string.
2197 Default: "51234"
2199 =item B<Server> I<port>
2201 This option has to be added once for every virtual server the plugin should
2202 query. If you want to query the virtual server on port 8767 this is what the
2203 option would look like:
2205   Server "8767"
2207 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
2208 use quotes around it! If no such statement is given only global information
2209 will be collected.
2211 =back
2213 =head2 Plugin C<tcpconns>
2215 The C<tcpconns plugin> counts the number of currently established TCP
2216 connections based on the local port and/or the remote port. Since there may be
2217 a lot of connections the default if to count all connections with a local port,
2218 for which a listening socket is opened. You can use the following options to
2219 fine-tune the ports you are interested in:
2221 =over 4
2223 =item B<ListeningPorts> I<true>|I<false>
2225 If this option is set to I<true>, statistics for all local ports for which a
2226 listening socket exists are collected. The default depends on B<LocalPort> and
2227 B<RemotePort> (see below): If no port at all is specifically selected, the
2228 default is to collect listening ports. If specific ports (no matter if local or
2229 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
2230 the selected ports will be collected unless this option is set to I<true>
2231 specifically.
2233 =item B<LocalPort> I<Port>
2235 Count the connections to a specific local port. This can be used to see how
2236 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
2237 You have to specify the port in numeric form, so for the mailserver example
2238 you'd need to set B<25>.
2240 =item B<RemotePort> I<Port>
2242 Count the connections to a specific remote port. This is useful to see how
2243 much a remote service is used. This is most useful if you want to know how many
2244 connections a local service has opened to remote services, e.E<nbsp>g. how many
2245 connections a mail server or news server has to other mail or news servers, or
2246 how many connections a web proxy holds to web servers. You have to give the
2247 port in numeric form.
2249 =back
2251 =head2 Plugin C<thermal>
2253 =over 4
2255 =item B<ForceUseProcfs> I<true>|I<false>
2257 By default, the C<thermal> plugin tries to read the statistics from the Linux
2258 C<sysfs> interface. If that is not available, the plugin falls back to the
2259 C<procfs> interface. By setting this option to I<true>, you can force the
2260 plugin to use the latter. This option defaults to I<false>.
2262 =item B<Device> I<Device>
2264 Selects the name of the thermal device that you want to collect or ignore,
2265 depending on the value of the B<IgnoreSelected> option. This option may be
2266 used multiple times to specify a list of devices.
2268 =item B<IgnoreSelected> I<true>|I<false>
2270 Invert the selection: If set to true, all devices B<except> the ones that
2271 match the device names specified by the B<Device> option are collected. By
2272 default only selected devices are collected if a selection is made. If no
2273 selection is configured at all, B<all> devices are selected.
2275 =back
2277 =head2 Plugin C<unixsock>
2279 =over 4
2281 =item B<SocketFile> I<Path>
2283 Sets the socket-file which is to be created.
2285 =item B<SocketGroup> I<Group>
2287 If running as root change the group of the UNIX-socket after it has been
2288 created. Defaults to B<collectd>.
2290 =item B<SocketPerms> I<Permissions>
2292 Change the file permissions of the UNIX-socket after it has been created. The
2293 permissions must be given as a numeric, octal value as you would pass to
2294 L<chmod(1)>. Defaults to B<0770>.
2296 =back
2298 =head2 Plugin C<uuid>
2300 This plugin, if loaded, causes the Hostname to be taken from the machine's
2301 UUID. The UUID is a universally unique designation for the machine, usually
2302 taken from the machine's BIOS. This is most useful if the machine is running in
2303 a virtual environment such as Xen, in which case the UUID is preserved across
2304 shutdowns and migration.
2306 The following methods are used to find the machine's UUID, in order:
2308 =over 4
2310 =item
2312 Check I</etc/uuid> (or I<UUIDFile>).
2314 =item
2316 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
2317 present.
2319 =item
2321 Check for UUID from C<dmidecode> / SMBIOS.
2323 =item
2325 Check for UUID from Xen hypervisor.
2327 =back
2329 If no UUID can be found then the hostname is not modified.
2331 =over 4
2333 =item B<UUIDFile> I<Path>
2335 Take the UUID from the given file (default I</etc/uuid>).
2337 =back
2339 =head2 Plugin C<vmem>
2341 The C<vmem> plugin collects information about the usage of virtual memory.
2342 Since the statistics provided by the Linux kernel are very detailed, they are
2343 collected very detailed. However, to get all the details, you have to switch
2344 them on manually. Most people just want an overview over, such as the number of
2345 pages read from swap space.
2347 =over 4
2349 =item B<Verbose> B<true>|B<false>
2351 Enables verbose collection of information. This will start collecting page
2352 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
2353 Part of these statistics are collected on a "per zone" basis.
2355 =back
2357 =head2 Plugin C<vserver>
2359 This plugin doesn't have any options. B<VServer> support is only available for
2360 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
2361 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
2362 need to apply the patches and compile your own kernel, which will then provide
2363 the F</proc/virtual> filesystem that is required by this plugin.
2365 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
2367 =head1 THRESHOLD CONFIGURATION
2369 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
2370 we mean that the values are not only stored or sent somewhere, but that they
2371 are judged and, if a problem is recognized, acted upon. The only action
2372 collectd takes itself is to generate and dispatch a "notification". Plugins can
2373 register to receive notifications and perform appropriate further actions.
2375 Since systems and what you expect them to do differ a lot, you can configure
2376 B<thresholds> for your values freely. This gives you a lot of flexibility but
2377 also a lot of responsibility.
2379 Every time a value is out of range a notification is dispatched. This means
2380 that the idle percentage of your CPU needs to be less then the configured
2381 threshold only once for a notification to be generated. There's no such thing
2382 as a moving average or similar - at least not now.
2384 Also, all values that match a threshold are considered to be relevant or
2385 "interesting". As a consequence collectd will issue a notification if they are
2386 not received for twice the last timeout of the values. If, for example, some
2387 hosts sends it's CPU statistics to the server every 60 seconds, a notification
2388 will be dispatched after about 120 seconds. It may take a little longer because
2389 the timeout is checked only once each B<Interval> on the server.
2391 When a value comes within range again or is received after it was missing, an
2392 "OKAY-notification" is dispatched.
2394 Here is a configuration example to get you started. Read below for more
2395 information.
2397  <Threshold>
2398    <Type "foo">
2399      WarningMin    0.00
2400      WarningMax 1000.00
2401      FailureMin    0.00
2402      FailureMax 1200.00
2403      Invert false
2404      Instance "bar"
2405    </Type>
2407    <Plugin "interface">
2408      Instance "eth0"
2409      <Type "if_octets">
2410        FailureMax 10000000
2411        DataSource "rx"
2412      </Type>
2413    </Plugin>
2415    <Host "hostname">
2416      <Type "cpu">
2417        Instance "idle"
2418        FailureMin 10
2419      </Type>
2421      <Plugin "memory">
2422        <Type "memory">
2423          Instance "cached"
2424          WarningMin 100000000
2425        </Type>
2426      </Plugin>
2427    </Host>
2428  </Threshold>
2430 There are basically two types of configuration statements: The C<Host>,
2431 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
2432 configured. The C<Plugin> and C<Type> blocks may be specified further using the
2433 C<Instance> option. You can combine the block by nesting the blocks, though
2434 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
2435 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
2436 C<Type> may not contain other blocks. If multiple blocks apply to the same
2437 value the most specific block is used.
2439 The other statements specify the threshold to configure. They B<must> be
2440 included in a C<Type> block. Currently the following statements are recognized:
2442 =over 4
2444 =item B<FailureMax> I<Value>
2446 =item B<WarningMax> I<Value>
2448 Sets the upper bound of acceptable values. If unset defaults to positive
2449 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
2450 will be created. If the value is greater than B<WarningMax> but less than (or
2451 equal to) B<FailureMax> a B<WARNING> notification will be created.
2453 =item B<FailureMin> I<Value>
2455 =item B<WarningMin> I<Value>
2457 Sets the lower bound of acceptable values. If unset defaults to negative
2458 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
2459 be created. If the value is less than B<WarningMin> but greater than (or equal
2460 to) B<FailureMin> a B<WARNING> notification will be created.
2462 =item B<DataSource> I<DSName>
2464 Some data sets have more than one "data source". Interesting examples are the
2465 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
2466 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
2467 system load data set, C<load>, even has three data sources: C<shortterm>,
2468 C<midterm>, and C<longterm>.
2470 Normally, all data sources are checked against a configured threshold. If this
2471 is undesirable, or if you want to specify different limits for each data
2472 source, you can use the B<DataSource> option to have a threshold apply only to
2473 one data source.
2475 =item B<Invert> B<true>|B<false>
2477 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
2478 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
2479 B<WarningMax>) are not okay. Defaults to B<false>.
2481 =item B<Persist> B<true>|B<false>
2483 Sets how often notifications are generated. If set to B<true> one notification
2484 will be generated for each value that is out of the acceptable range. If set to
2485 B<false> (the default) then a notification is only generated if a value is out
2486 of range but the previous value was okay.
2488 This applies to missing values, too: If set to B<true> a notification about a
2489 missing value is generated once every B<Interval> seconds. If set to B<false>
2490 only one such notification is generated until the value appears again.
2492 =back
2494 =head1 FILTER CONFIGURATION
2496 TODO: Update this entire section once development is done.
2498 Starting with collectd 4.6 there is a powerful filtering infrastructure
2499 implemented in the daemon. The concept has mostly been copied from I<iptables>,
2500 the packet filter infrastructure for Linux. We'll use a similar terminology, so
2501 that users that are familiar with iptables feel right at home.
2503 =head2 Terminology
2505 The most important terms are:
2507 =over 4
2509 =item B<Match>
2511 A I<match> is a criteria to select specific values. Examples are, of course, the
2512 name of the value or it's current value.
2514 =item B<Target>
2516 A I<target> is some action that is to be performed with data. Such actions
2517 could, for example, be to change part of the value's identifier or to ignore
2518 the value completely. Built-in functions are B<write> and B<stop>, see below.
2520 Some targets, for example the built-in B<stop> target, signal that processing
2521 of a value should be stopped. In that case processing of the current chain will
2522 be aborted.
2524 =item B<Rule>
2526 The combination of any number of matches and at least one target is called a
2527 I<rule>. The target actions will be performed for all values for which B<all>
2528 matches apply. If the rule does not have any matches associated with it, the
2529 target action will be performed for all values.
2531 If any target returns the stop condition, the processing will stop right away.
2532 This means that any targets following the current one will not be called after
2533 the stop condition has been returned.
2535 =item B<Chain>
2537 A I<chain> is a list of rules and possibly default targets. The rules are tried
2538 in order and if one matches, the associated target will be called. If a value
2539 is handled by a rule, it depends on the target whether or not any subsequent
2540 rules are considered or if traversal of the chain is aborted. After all rules
2541 have been checked and no target returned the stop condition, the default
2542 targets will be executed.
2544 =back
2546 =head2 General structure
2548 The following shows the resulting structure:
2550  +---------+
2551  ! Chain   !
2552  +---------+
2553       !
2554       V
2555  +---------+  +---------+  +---------+  +---------+
2556  ! Rule    !->! Match   !->! Match   !->! Target  !
2557  +---------+  +---------+  +---------+  +---------+
2558       !
2559       V
2560  +---------+  +---------+  +---------+
2561  ! Rule    !->! Target  !->! Target  !
2562  +---------+  +---------+  +---------+
2563       !
2564       V
2565       :
2566       :
2567       !
2568       V
2569  +---------+  +---------+  +---------+
2570  ! Rule    !->! Match   !->! Target  !
2571  +---------+  +---------+  +---------+
2572       !
2573       V
2574  +---------+
2575  ! Default !
2576  ! Target  !
2577  +---------+
2579 =head2 Synopsis
2581 The configuration reflects this structure directly:
2583  <Chain "main">
2584    <Rule "ignore_mysql_show">
2585      <Match "regex">
2586        Plugin "^mysql$"
2587        Type "^mysql_command$"
2588        TypeInstance "^show_"
2589      </Match>
2590      <Target "stop">
2591      </Target>
2592    </Rule>
2593    <Target "write">
2594      Plugin "rrdtool"
2595    </Target>
2596  </Chain>
2598 The above configuration example will ignore all values where the plugin field
2599 is "mysql", the type is "mysql_command" and the type instance begins with
2600 "show_". All other values will be sent to the "rrdtool" write plugin via the
2601 default target of the chain.
2603 =head2 List of configuration options
2605 =over 4
2607 =item B<Chain> I<Name>
2609 Adds a new chain with a certain name. This name can be used to refer to a
2610 specific chain, for example to jump to it.
2612 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
2614 =item B<Rule> [I<Name>]
2616 Adds a new rule to the current chain. The name of the rule is optional and
2617 currently has no meaning for the daemon.
2619 Within the B<Rule> block, there may be any number of B<Match> blocks and there
2620 must be at least one B<Target> block.
2622 =item B<Match> I<Name>
2624 Adds a match to a B<Rule> block. The name specifies what kind of match should
2625 be performed. Available matches depend on the plugins that have been loaded.
2627 The arguments inside the B<Match> block are passed to the plugin implementing
2628 the match, so which arguments are valid here depends on the plugin being used.
2629 If you do not need any to pass any arguments to a match, you can use the
2630 shorter syntax:
2632  Match "foobar"
2634 Which is equivalent to:
2636  <Match "foobar">
2637  </Match>
2639 =item B<Target> I<Name>
2641 Add a target to a rule or a default target to a chain. The name specifies what
2642 kind of target is to be added. Which targets are available depends on the
2643 plugins being loaded.
2645 The arguments inside the B<Target> block are passed to the plugin implementing
2646 the target, so which arguments are valid here depends on the plugin being used.
2647 If you do not need any to pass any arguments to a target, you can use the
2648 shorter syntax:
2650  Target "stop"
2652 This is the same as writing:
2654  <Target "stop">
2655  </Target>
2657 =back
2659 =head2 Built-in targets 
2661 The following targets are built into the core daemon and therefore need no
2662 plugins to be loaded:
2664 =over 4
2666 =item B<return>
2668 Signals the "return" condition. This causes the current chain to stop
2669 processing the value and returns control to the calling chain. The calling
2670 chain will continue processing targets and rules just after the B<jump> target
2671 (see below). This is very similar to the B<RETURN> target of iptables, see
2672 L<iptables(8)>.
2674 This target does not have any options.
2676 Example:
2678  Target "return"
2680 =item B<stop>
2682 Signals the "stop" condition, causing processing of the value to be aborted
2683 immediately. This is similar to the B<DROP> target of iptables, see
2684 L<iptables(8)>.
2686 This target does not have any options.
2688 Example:
2690  Target "stop"
2692 =item B<write>
2694 Sends the value to write plugins.
2696 Available options:
2698 =over 4
2700 =item B<Plugin> I<Name>
2702 Name of the write plugin to which the data should be sent. This option may be
2703 given multiple times to send the data to more than one write plugin.
2705 =back
2707 If no plugin is explicitly specified, the values will be sent to all available
2708 write plugins.
2710 Example:
2712  <Target "write">
2713    Plugin "rrdtool"
2714  </Target>
2716 =item B<jump>
2718 Starts processing the rules of another chain. If the end of that chain is
2719 reached, or a stop condition is encountered, processing will continue right
2720 after the B<jump> target, i.E<nbsp>e. with the next target or the next rule.
2721 This is similar to the B<-j> command line option of iptables, see
2722 L<iptables(8)>.
2724 Available options:
2726 =over 4
2728 =item B<Chain> I<Name>
2730 Jumps to the chain I<Name>. This argument is required and may appear only once.
2732 =back
2734 Example:
2736  <Target "jump">
2737    Chain "foobar"
2738  </Target>
2740 =back
2742 =head2 Available matches
2744 =over 4
2746 =item B<regex>
2748 Matches a value using regular expressions.
2750 Available options:
2752 =over 4
2754 =item B<Host> I<Regex>
2756 =item B<Plugin> I<Regex>
2758 =item B<PluginInstance> I<Regex>
2760 =item B<Type> I<Regex>
2762 =item B<TypeInstance> I<Regex>
2764 Match values where the given regular expressions match the various fields of
2765 the identifier of a value. If multiple regular expressions are given, B<all>
2766 regexen must match for a value to match.
2768 =back
2770 Example:
2772  <Match "regex">
2773    Host "customer[0-9]+"
2774    Plugin "^foobar$"
2775  </Match>
2777 =item B<value>
2779 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
2780 values. If a data-set consists of more than one data-source, all data-sources
2781 must match the specified ranges for a positive match.
2783 Available options:
2785 =over 4
2787 =item B<Min> I<Value>
2789 Sets the smallest value which still results in a match. If unset, behaves like
2790 negative infinity.
2792 =item B<Max> I<Value>
2794 Sets the largest value which still results in a match. If unset, behaves like
2795 positive infinity.
2797 =item B<Invert> B<true>|B<false>
2799 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
2800 no-match is returned and vice versa. Please note that the B<Invert> setting
2801 only effects how B<Min> and B<Max> are applied to a specific value. Especially
2802 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
2804 =item B<DataSource> I<DSName> [I<DSName> ...]
2806 Select one or more of the data sources. If no data source is configured, all
2807 data sources will be checked. If the type handled by the match does not have a
2808 data source of the specified name(s), this will always result in no match
2809 (independent of the B<Invert> setting).
2811 =item B<Satisfy> B<Any>|B<All>
2813 Specifies how checking with several data sources is performed. If set to
2814 B<Any>, the match succeeds if one of the data sources is in the configured
2815 range. If set to B<All> the match only succeeds if all data sources are within
2816 the configured range. Default is B<All>.
2818 Usually B<All> is used for positive matches, B<Any> is used for negative
2819 matches. This means that with B<All> you usually check that all values are in a
2820 "good" range, while with B<Any> you check if any value is within a "bad" range
2821 (or outside the "good" range).
2823 =back
2825 Either B<Min> or B<Max>, but not both, may be unset.
2827 Example:
2829  # Match all values smaller than or equal to 100. Matches only if all data
2830  # sources are below 100.
2831  <Match "value">
2832    Max 100
2833    Satisfy "All"
2834  </Match>
2835  
2836  # Match if the value of any data source is outside the range of 0 - 100.
2837  <Match "value">
2838    Min   0
2839    Max 100
2840    Invert true
2841    Satisfy "Any"
2842  </Match>
2844 =back
2846 =head2 Available targets
2848 =over 4
2850 =item B<notification>
2852 Creates and dispatches a notification.
2854 Available options:
2856 =over 4
2858 =item B<Message> I<String>
2860 This required option sets the message of the notification. The following
2861 placeholders will be replaced by an appropriate value:
2863 =over 4
2865 =item B<%{host}>
2867 =item B<%{plugin}>
2869 =item B<%{plugin_instance}>
2871 =item B<%{type}>
2873 =item B<%{type_instance}>
2875 These placeholders are replaced by the identifier field of the same name.
2877 =item B<%{ds:>I<name>B<}>
2879 These placeholders are replaced by a (hopefully) human readable representation
2880 of the current rate of this data source. If you changed the instance name
2881 (using the B<set> or B<replace> targets, see below), it may not be possible to
2882 convert counter values to rates.
2884 =back
2886 Please note that these placeholders are B<case sensitive>!
2888 =item B<Severity> B<"FATAL">|B<"WARNING">|B<"OKAY">
2890 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
2891 used.
2893 =back
2895 Example:
2897   <Target "notification">
2898     Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
2899     Severity "WARNING"
2900   </Target>
2902 =item B<replace>
2904 Replaces parts of the identifier using regular expressions.
2906 Available options:
2908 =over 4
2910 =item B<Host> I<Regex> I<Replacement>
2912 =item B<Plugin> I<Regex> I<Replacement>
2914 =item B<PluginInstance> I<Regex> I<Replacement>
2916 =item B<TypeInstance> I<Regex> I<Replacement>
2918 Match the appropriate field with the given regular expression I<Regex>. If the
2919 regular expression matches, that part that matches is replaced with
2920 I<Replacement>. If multiple places of the input buffer match a given regular
2921 expression, only the first occurrence will be replaced.
2923 You can specify each option multiple times to use multiple regular expressions
2924 one after another.
2926 =back
2928 Example:
2930  <Target "replace">
2931    # Replace "example.net" with "example.com"
2932    Host "\\<example.net\\>" "example.com"
2933  
2934    # Strip "www." from hostnames
2935    Host "\\<www\\." ""
2936  </Target>
2938 =item B<set>
2940 Sets part of the identifier of a value to a given string.
2942 Available options:
2944 =over 4
2946 =item B<Host> I<String>
2948 =item B<Plugin> I<String>
2950 =item B<PluginInstance> I<String>
2952 =item B<TypeInstance> I<String>
2954 Set the appropriate field to the given string. The strings for plugin instance
2955 and type instance may be empty, the strings for host and plugin may not be
2956 empty. It's currently not possible to set the type of a value this way.
2958 =back
2960 Example:
2962  <Target "set">
2963    PluginInstance "coretemp"
2964    TypeInstance "core3"
2965  </Target>
2967 =back
2969 =head2 Backwards compatibility
2971 If you use collectd with an old configuration, i.E<nbsp>e. one without a
2972 B<Chain> block, it will behave as it used to. This is equivalent to the
2973 following configuration:
2975  <Chain "main">
2976    Target "write"
2977  </Chain>
2979 If you specify a B<Chain> block anywhere, the B<write> target will not be added
2980 anywhere and you will have to make sure that it is called where appropriate. We
2981 suggest to add the above snippet as default target to your main chain.
2983 TODO: Notifications will be implemented using chains, too. Describe that here!
2985 =head2 Examples
2987 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
2988 be an FQDN.
2990  <Chain "main">
2991    <Rule "no_fqdn">
2992      <Match "regex">
2993        Host "^[^\.]*$"
2994      </Match>
2995      Target "stop"
2996    </Rule>
2997    Target "write"
2998  </Chain>
3000 =head1 SEE ALSO
3002 L<collectd(1)>,
3003 L<collectd-exec(5)>,
3004 L<collectd-perl(5)>,
3005 L<collectd-unixsock(5)>,
3006 L<types.db(5)>,
3007 L<hddtemp(8)>,
3008 L<iptables(8)>,
3009 L<kstat(3KSTAT)>,
3010 L<mbmon(1)>,
3011 L<pcre(3)>,
3012 L<psql(1)>,
3013 L<regex(7)>,
3014 L<rrdtool(1)>,
3015 L<sensors(1)>
3017 =head1 AUTHOR
3019 Florian Forster E<lt>octo@verplant.orgE<gt>
3021 =cut