3 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
7 BaseDir "/path/to/data/"
8 PIDFile "/path/to/pidfile/collectd.pid"
9 Server "123.123.123.123" 12345
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
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.
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.
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
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:
152 <IfModule mod_status.c>
153 <Location /mod_status>
154 SetHandler server-status
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:
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.
201 =head2 Plugin C<apcups>
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>.
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:
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.
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.
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>.
277 =item B<StoreRates> B<true|false>
279 If set to B<true>, convert counter values to rates. If set to B<false> (the
280 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
287 This plugin uses the "B<dbi>" library (L<http://libdbi.sourceforge.net/>) to
288 connect to various databases, execute SQL statements and read back the results.
289 You can configure how each column is to be interpreted and the plugin will
290 generate one data set from each row returned according to these rules.
292 Because the plugin is very generic, the configuration is a little more complex
293 than those of other plugins. It usually looks something like this:
296 <Query "out_of_stock">
297 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
299 InstancesFrom "category"
302 <Database "product_information">
304 DriverOption "host" "localhost"
305 DriverOption "username" "collectd"
306 DriverOption "password" "aZo6daiw"
307 DriverOption "dbname" "prod_info"
313 The configuration above defines one query and one database. The query is then
314 linked to the database with the B<Query> option I<within> the
315 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
316 and you can also use the B<Include> statement to split up the configuration
317 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
318 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
321 The following is a complete list of options:
323 =head3 B<Query> blocks
325 Query blocks define SQL statements and how the returned data should be
326 interpreted. They are identified by the name that is given in the opening line
327 of the block. Thus the name needs to be unique. Other than that, the name is
328 not used in collectd.
332 =item B<Statement> I<SQL>
334 Sets the statement that should be executed on the server. This is B<not>
335 interpreted by collectd, but simply passed to the database server. Therefore,
336 the SQL dialect that's used depends on the server collectd is connected to.
338 The query has to return at least two columns, one for the instance and one
339 value. You cannot omit the instance, even if the statement is guaranteed to
340 always return exactly one line. In that case, you can usually specify something
343 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
345 (That works with MySQL but may not be valid SQL according to the spec. If you
346 use a more strict database server, you may have to select from a dummy table or
349 =item B<Type> I<Type>
351 The B<type> that's used for each line returned. See L<types.db(5)> for more
352 details on how types are defined. In short: A type is a predefined layout of
353 data and the number of values and type of values has to match the type
356 If you specify "temperature" here, you need exactly one gauge column. If you
357 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
360 =item B<InstancesFrom> I<column0> [I<column1> ...]
362 Specifies the columns whose values will be used to create the "TypeInstance"
363 for each row. You need to specify at least one column for each query. If you
364 specify more than one column, the value of all columns will be join together
365 with the hyphen as separation character.
367 The plugin itself does not check whether or not all built instances are
368 different. It's your responsibility to assure that each is unique.
370 =item B<ValuesFrom> I<column0> [I<column1> ...]
372 Names the columns whose content is used as the actual data for the data sets
373 that are dispatched to the daemon. How many such columns you need is determined
374 by the B<Type> setting above. If you specify too many or not enough columns,
375 the plugin will complain about that and no data will be submitted to the
378 The actual data type in the columns is not that important. The plugin will
379 automatically cast the values to the right type if it know how to do that. So
380 it should be able to handle integer an floating point types, as well as strings
381 (if they include a number at the beginning).
385 =head3 B<Database> blocks
387 Database blocks define a connection to a database and which queries should be
388 sent to that database. Since the used "dbi" library can handle a wide variety
389 of databases, the configuration is very generic. If in doubt, refer to libdbi's
390 documentationE<nbsp>- we stick as close to the terminology used there.
392 Each database needs a "name" as string argument in the starting tag of the
393 block. This name will be used as "PluginInstance" in the values submitted to
394 the daemon. Other than that, that name is not used.
398 =item B<Driver> I<Driver>
400 Specifies the driver to use to connect to the database. In many cases those
401 drivers are named after the database they can connect to, but this is not a
402 technical necessity. These drivers are sometimes referred to as "DBD",
403 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
404 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
405 project at L<http://libdbi-drivers.sourceforge.net/>.
407 You need to give the driver name as expected by the "dbi" library here. You
408 should be able to find that in the documentation for each driver. If you
409 mistype the driver name, the plugin will dump a list of all known driver names
412 =item B<DriverOption> I<Key> I<Value>
414 Sets driver-specific options. What option a driver supports can be found in the
415 documentation for each driver, somewhere at
416 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
417 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
419 Unfortunately, drivers are not too keen to report errors when an unknown option
420 is passed to them, so invalid settings here may go unnoticed. This is not the
421 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
422 the driver. If a driver complains about an option, the plugin will dump a
423 complete list of all options understood by that driver to the log.
425 =item B<SelectDB> I<Database>
427 In some cases, the database name you connect with is not the database name you
428 want to use for querying data. If this option is set, the plugin will "select"
429 (switch to) that database after the connection is established.
431 =item B<Query> I<QueryName>
433 Associates the query named I<QueryName> with this database connection. The
434 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
435 blocks you want to refer to must be placed above the database block you want to
444 =item B<Device> I<Device>
446 Select partitions based on the devicename.
448 =item B<MountPoint> I<Directory>
450 Select partitions based on the mountpoint.
452 =item B<FSType> I<FSType>
454 Select partitions based on the filesystem type.
456 =item B<IgnoreSelected> I<true>|I<false>
458 Invert the selection: If set to true, all partitions B<except> the ones that
459 match any one of the criteria are collected. By default only selected
460 partitions are collected if a selection is made. If no selection is configured
461 at all, B<all> partitions are selected.
465 =head2 Plugin C<disk>
467 The C<disk> plugin collects information about the usage of physical disks and
468 logical disks (partitions). Values collected are the number of octets written
469 to and read from a disk or partition, the number of read/write operations
470 issued to the disk and a rather complex "time" it took for these commands to be
473 Using the following two options you can ignore some disks or configure the
474 collection only of specific disks.
478 =item B<Disk> I<Name>
480 Select the disk I<Name>. Whether it is collected or ignored depends on the
481 B<IgnoreSelected> setting, see below. As with other plugins that use the
482 daemon's ignorelist functionality, a string that starts and ends with a slash
483 is interpreted as a regular expression. Examples:
488 =item B<IgnoreSelected> B<true>|B<false>
490 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
491 statements, are ignored or if all other disks are ignored. The behavior
492 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
493 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
494 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
495 is set to B<true>, all disks are collected B<except> the ones matched.
503 =item B<Interface> I<Interface>
505 The dns plugin uses B<libpcap> to capture dns traffic and analyses it. This
506 option sets the interface that should be used. If this option is not set, or
507 set to "any", the plugin will try to get packets from B<all> interfaces. This
508 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
510 =item B<IgnoreSource> I<IP-address>
512 Ignore packets that originate from this address.
516 =head2 Plugin C<email>
520 =item B<SocketFile> I<Path>
522 Sets the socket-file which is to be created.
524 =item B<SocketGroup> I<Group>
526 If running as root change the group of the UNIX-socket after it has been
527 created. Defaults to B<collectd>.
529 =item B<SocketPerms> I<Permissions>
531 Change the file permissions of the UNIX-socket after it has been created. The
532 permissions must be given as a numeric, octal value as you would pass to
533 L<chmod(1)>. Defaults to B<0770>.
535 =item B<MaxConns> I<Number>
537 Sets the maximum number of connections that can be handled in parallel. Since
538 this many threads will be started immediately setting this to a very high
539 value will waste valuable resources. Defaults to B<5> and will be forced to be
540 at most B<16384> to prevent typos and dumb mistakes.
544 =head2 Plugin C<exec>
546 Please make sure to read L<collectd-exec(5)> before using this plugin. It
547 contains valuable information on when the executable is executed and the
548 output that is expected from it.
552 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
554 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
556 Execute the executable I<Executable> as user I<User>. If the user name is
557 followed by a colon and a group name, the effective group is set to that group.
558 The real group and saved-set group will be set to the default group of that
559 user. If no group is given the effective group ID will be the same as the real
562 Please note that in order to change the user and/or group the daemon needs
563 superuser privileges. If the daemon is run as an unprivileged user you must
564 specify the same user/group here. If the daemon is run with superuser
565 privileges, you must supply a non-root user here.
567 The executable may be followed by optional arguments that are passed to the
568 program. Please note that due to the configuration parsing numbers and boolean
569 values may be changed. If you want to be absolutely sure that something is
570 passed as-is please enclose it in quotes.
572 The B<Exec> and B<NotificationExec> statements change the semantics of the
573 programs executed, i.E<nbsp>e. the data passed to them and the response
574 expected from them. This is documented in great detail in L<collectd-exec(5)>.
578 =head2 Plugin C<filecount>
580 The C<filecount> plugin counts the number of files in a certain directory (and
581 its subdirectories) and their combined size. The configuration is very straight
585 <Directory "/var/qmail/queue/mess">
586 Instance "qmail-message"
588 <Directory "/var/qmail/queue/todo">
589 Instance "qmail-todo"
591 <Directory "/var/lib/php5">
592 Instance "php5-sessions"
597 The example above counts the number of files in QMail's queue directories and
598 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
599 QMail has not yet looked at, the "message" queue holds the messages that were
600 classified into "local" and "remote".
602 As you can see, the configuration consists of one or more C<Directory> blocks,
603 each of which specifies a directory in which to count the files. Within those
604 blocks, the following options are recognized:
608 =item B<Instance> I<Instance>
610 Sets the plugin instance to I<Instance>. That instance name must be unique, but
611 it's your responsibility, the plugin doesn't check for that. If not given, the
612 instance is set to the directory name with all slashes replaced by underscores
613 and all leading underscores removed.
615 =item B<Name> I<Pattern>
617 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
618 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
619 against the pattern, not the entire path. In case this makes it easier for you:
620 This option has been named after the B<-name> parameter to L<find(1)>.
622 =item B<MTime> I<Age>
624 Count only files of a specific age: If I<Age> is greater than zero, only files
625 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
626 a negative number, this is inversed. For example, if B<-60> is specified, only
627 files that have been modified in the last minute will be counted.
629 The number can also be followed by a "multiplier" to easily specify a larger
630 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
631 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
632 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
633 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
634 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
637 =item B<Size> I<Size>
639 Count only files of a specific size. When I<Size> is a positive number, only
640 files that are at least this big are counted. If I<Size> is a negative number,
641 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
644 As with the B<MTime> option, a "multiplier" may be added. For a detailed
645 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
646 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
647 note that there are 1000 bytes in a kilobyte, not 1024.
649 =item B<Recursive> I<true>|I<false>
651 Controls whether or not to recurse into subdirectories. Enabled by default.
655 =head2 Plugin C<filter_pcre>
657 This plugin allows you to filter value lists based on Perl-compatible regular
658 expressions whose syntax and semantics are as close as possible to those of
659 the Perl 5 language. See L<pcre(3)> for details.
671 The configuration consists of one or more C<RegEx> blocks, each of which
672 specifies a regular expression identifying a set of value lists and how to
673 handle successful matches. A value list keeps the values of a single data-set
674 and is identified by the tuple (host, plugin, plugin instance, type, type
675 instance). The plugin and type instances are optional components. If they are
676 missing they are treated as empty strings. Within those blocks, the following
677 options are recognized:
681 =item B<Host> I<regex>
683 =item B<Plugin> I<regex>
685 =item B<PluginInstance> I<regex>
687 =item B<Type> I<regex>
689 =item B<TypeInstance> I<regex>
691 Specifies the regular expression for each component of the identifier. If any
692 of these options is missing it is interpreted as a pattern which matches any
693 string. All five components of a value list have to match the appropriate
694 regular expression to trigger the specified action.
696 =item B<Action> I<NoWrite>|I<NoThresholdCheck>|I<Ignore>
698 Specify how to handle successful matches:
704 Do not send the value list to any output (a.k.a. write) plugins.
706 =item B<NoThresholdCheck>
708 Skip threshold checking for this value list.
712 Completely ignore this value list.
716 Two or more actions may be combined by specifying multiple B<Action> options.
720 =head2 Plugin C<hddtemp>
722 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
723 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
724 default values, see below. C<hddtemp> has to be running to work correctly. If
725 C<hddtemp> is not running timeouts may appear which may interfere with other
728 The B<hddtemp> homepage can be found at
729 L<http://www.guzu.net/linux/hddtemp.php>.
733 =item B<Host> I<Hostname>
735 Hostname to connect to. Defaults to B<127.0.0.1>.
737 =item B<Port> I<Port>
739 TCP-Port to connect to. Defaults to B<7634>.
741 =item B<TranslateDevicename> I<true>|I<false>
743 If enabled, translate the disk names to major/minor device numbers
744 (e.E<nbsp>g. "8-0" for /dev/sda). For backwards compatibility this defaults to
745 I<true> but it's recommended to disable it as it will probably be removed in
746 the next major version.
750 =head2 Plugin C<interface>
754 =item B<Interface> I<Interface>
756 Select this interface. By default these interfaces will then be collected. For
757 a more detailed description see B<IgnoreSelected> below.
759 =item B<IgnoreSelected> I<true>|I<false>
761 If no configuration if given, the B<traffic>-plugin will collect data from
762 all interfaces. This may not be practical, especially for loopback- and
763 similar interfaces. Thus, you can use the B<Interface>-option to pick the
764 interfaces you're interested in. Sometimes, however, it's easier/preferred
765 to collect all interfaces I<except> a few ones. This option enables you to
766 do that: By setting B<IgnoreSelected> to I<true> the effect of
767 B<Interface> is inverted: All selected interfaces are ignored and all
768 other interfaces are collected.
772 =head2 Plugin C<ipmi>
776 =item B<Sensor> I<Sensor>
778 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
780 =item B<IgnoreSelected> I<true>|I<false>
782 If no configuration if given, the B<ipmi> plugin will collect data from all
783 sensors found of type "temperature", "voltage", "current" and "fanspeed".
784 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
785 the effect of B<Sensor> is inverted: All selected sensors are ignored and
786 all other sensors are collected.
788 =item B<NotifySensorAdd> I<true>|I<false>
790 If a sensor appears after initialization time of a minute a notification
793 =item B<NotifySensorRemove> I<true>|I<false>
795 If a sensor disappears a notification is sent.
797 =item B<NotifySensorNotPresent> I<true>|I<false>
799 If you have for example dual power supply and one of them is (un)plugged then
800 a notification is sent.
804 =head2 Plugin C<iptables>
808 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
810 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
811 will collect the counters of all rules which have a comment-match. The comment
812 is then used as type-instance.
814 If I<Comment> or I<Number> is given, only the rule with the matching comment or
815 the I<n>th rule will be collected. Again, the comment (or the number) will be
816 used as the type-instance.
818 If I<Name> is supplied, it will be used as the type-instance instead of the
819 comment or the number.
829 Select this irq. By default these irqs will then be collected. For a more
830 detailed description see B<IgnoreSelected> below.
832 =item B<IgnoreSelected> I<true>|I<false>
834 If no configuration if given, the B<irq>-plugin will collect data from all
835 irqs. This may not be practical, especially if no interrupts happen. Thus, you
836 can use the B<Irq>-option to pick the interrupt you're interested in.
837 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
838 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
839 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
840 and all other interrupts are collected.
844 =head2 Plugin C<libvirt>
846 This plugin allows CPU, disk and network load to be collected for virtualized
847 guests on the machine. This means that these characteristics can be collected
848 for guest systems without installing any software on them - collectd only runs
849 on the hosting system. The statistics are collected through libvirt
850 (L<http://libvirt.org/>).
852 Only I<Connection> is required.
856 =item B<Connection> I<uri>
858 Connect to the hypervisor given by I<uri>. For example if using Xen use:
862 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
864 =item B<RefreshInterval> I<seconds>
866 Refresh the list of domains and devices every I<seconds>. The default is 60
867 seconds. Setting this to be the same or smaller than the I<Interval> will cause
868 the list of domains and devices to be refreshed on every iteration.
870 Refreshing the devices in particular is quite a costly operation, so if your
871 virtualization setup is static you might consider increasing this. If this
872 option is set to 0, refreshing is disabled completely.
874 =item B<Domain> I<name>
876 =item B<BlockDevice> I<name:dev>
878 =item B<InterfaceDevice> I<name:dev>
880 =item B<IgnoreSelected> I<true>|I<false>
882 Select which domains and devices are collected.
884 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
885 disk/network devices are collected.
887 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
888 domains and disk/network devices are ignored, while the rest are collected.
890 The domain name and device names may use a regular expression, if the name is
891 surrounded by I</.../> and collectd was compiled with support for regexps.
893 The default is to collect statistics for all domains and all their devices.
898 IgnoreSelected "true"
900 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
903 =item B<HostnameFormat> B<name|uuid|hostname|...>
905 When the libvirt plugin logs data, it sets the hostname of the collected data
906 according to this setting. The default is to use the guest name as provided by
907 the hypervisor, which is equal to setting B<name>.
909 B<uuid> means use the guest's UUID. This is useful if you want to track the
910 same guest across migrations.
912 B<hostname> means to use the global B<Hostname> setting, which is probably not
913 useful on its own because all guests will appear to have the same name.
915 You can also specify combinations of these fields. For example B<name uuid>
916 means to concatenate the guest name and UUID (with a literal colon character
917 between, thus I<"foo:1234-1234-1234-1234">).
921 =head2 Plugin C<logfile>
925 =item B<LogLevel> B<debug|info|notice|warning|err>
927 Sets the log-level. If, for example, set to B<notice>, then all events with
928 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
930 Please note that B<debug> is only available if collectd has been compiled with
933 =item B<File> I<File>
935 Sets the file to write log messages to. The special strings B<stdout> and
936 B<stderr> can be used to write to the standard output and standard error
937 channels, respectively. This, of course, only makes much sense when collectd is
938 running in foreground- or non-daemon-mode.
940 =item B<Timestamp> B<true>|B<false>
942 Prefix all lines printed by the current time. Defaults to B<true>.
946 =head2 Plugin C<mbmon>
948 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
950 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
951 B<Host> and B<Port> options can be used to change these values, see below.
952 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
953 timeouts may appear which may interfere with other statistics..
955 C<mbmon> must be run with the -r option ("print TAG and Value format");
956 Debian's F</etc/init.d/mbmon> script already does this, other people
957 will need to ensure that this is the case.
961 =item B<Host> I<Hostname>
963 Hostname to connect to. Defaults to B<127.0.0.1>.
965 =item B<Port> I<Port>
967 TCP-Port to connect to. Defaults to B<411>.
971 =head2 Plugin C<memcached>
973 The C<memcached plugin> connects to a memcached server and queries statistics
974 about cache utilization, memory and bandwidth used.
975 L<http://www.danga.com/memcached/>
979 =item B<Host> I<Hostname>
981 Hostname to connect to. Defaults to B<127.0.0.1>.
983 =item B<Port> I<Port>
985 TCP-Port to connect to. Defaults to B<11211>.
989 =head2 Plugin C<mysql>
991 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to the
992 database when started and keeps the connection up as long as possible. When the
993 connection is interrupted for whatever reason it will try to re-connect. The
994 plugin will complaint loudly in case anything goes wrong.
996 This plugin issues C<SHOW STATUS> and evaluates C<Bytes_{received,sent}>,
997 C<Com_*> and C<Handler_*> which correspond to F<mysql_octets.rrd>,
998 F<mysql_commands-*.rrd> and F<mysql_handler-*.rrd>. Also, the values of
999 C<Qcache_*> are put in F<mysql_qcache.rrd> and values of C<Threads_*> are put
1000 in F<mysql_threads.rrd>. Please refer to the B<MySQL reference manual>,
1001 I<5.2.4. Server Status Variables> for an explanation of these values.
1003 Use the following options to configure the plugin:
1007 =item B<Host> I<Hostname>
1009 Hostname of the database server. Defaults to B<localhost>.
1011 =item B<User> I<Username>
1013 Username to use when connecting to the database.
1015 =item B<Password> I<Password>
1017 Password needed to log into the database.
1019 =item B<Database> I<Database>
1021 Select this database. Defaults to I<no database> which is a perfectly reasonable
1022 option for what this plugin does.
1026 =head2 Plugin C<netlink>
1028 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
1029 statistics of various interface and routing aspects.
1033 =item B<Interface> I<Interface>
1035 =item B<VerboseInterface> I<Interface>
1037 Instruct the plugin to collect interface statistics. This is basically the same
1038 as the statistics provided by the C<interface> plugin (see above) but
1039 potentially much more detailed.
1041 When configuring with B<Interface> only the basic statistics will be collected,
1042 namely octets, packets, and errors. These statistics are collected by
1043 the C<interface> plugin, too, so using both at the same time is no benefit.
1045 When configured with B<VerboseInterface> all counters B<except> the basic ones,
1046 so that no data needs to be collected twice if you use the C<interface> plugin.
1047 This includes dropped packets, received multicast packets, collisions and a
1048 whole zoo of differentiated RX and TX errors. You can try the following command
1049 to get an idea of what awaits you:
1053 If I<Interface> is B<All>, all interfaces will be selected.
1055 =item B<QDisc> I<Interface> [I<QDisc>]
1057 =item B<Class> I<Interface> [I<Class>]
1059 =item B<Filter> I<Interface> [I<Filter>]
1061 Collect the octets and packets that pass a certain qdisc, class or filter.
1063 QDiscs and classes are identified by their type and handle (or classid).
1064 Filters don't necessarily have a handle, therefore the parent's handle is used.
1065 The notation used in collectd differs from that used in tc(1) in that it
1066 doesn't skip the major or minor number if it's zero and doesn't print special
1067 ids by their name. So, for example, a qdisc may be identified by
1068 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
1069 thus not displayed by tc(1).
1071 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
1072 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
1073 associated with that interface will be collected.
1075 Since a filter itself doesn't necessarily have a handle, the parent's handle is
1076 used. This may lead to problems when more than one filter is attached to a
1077 qdisc or class. This isn't nice, but we don't know how this could be done any
1078 better. If you have a idea, please don't hesitate to tell us.
1080 As with the B<Interface> option you can specify B<All> as the interface,
1081 meaning all interfaces.
1083 Here are some examples to help you understand the above text more easily:
1086 VerboseInterface "All"
1087 QDisc "eth0" "pfifo_fast-1:0"
1089 Class "ppp0" "htb-1:10"
1090 Filter "ppp0" "u32-1:0"
1093 =item B<IgnoreSelected>
1095 The behaviour is the same as with all other similar plugins: If nothing is
1096 selected at all, everything is collected. If some things are selected using the
1097 options described above, only these statistics are collected. If you set
1098 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
1099 specified statistics will not be collected.
1103 =head2 Plugin C<network>
1107 =item B<Listen> I<Host> [I<Port>]
1109 =item B<Server> I<Host> [I<Port>]
1111 The B<Server> statement sets the server to send datagrams B<to>. The statement
1112 may occur multiple times to send each datagram to multiple destinations.
1114 The B<Listen> statement sets the interfaces to bind to. When multiple
1115 statements are found the daemon will bind to multiple interfaces.
1117 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
1118 the argument is a multicast address the daemon will join that multicast group.
1120 If no B<Listen> statement is found the server tries join both, the default IPv6
1121 multicast group and the default IPv4 multicast group. If no B<Server> statement
1122 is found the client will try to send data to the IPv6 multicast group first. If
1123 that fails the client will try the IPv4 multicast group.
1125 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
1126 multicast group is C<239.192.74.66>.
1128 The optional I<Port> argument sets the port to use. It can either be given
1129 using a numeric port number or a service name. If the argument is omitted the
1130 default port B<25826> is assumed.
1132 =item B<TimeToLive> I<1-255>
1134 Set the time-to-live of sent packets. This applies to all, unicast and
1135 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
1136 That means that multicast packets will be sent with a TTL of C<1> (one) on most
1139 =item B<Forward> I<true|false>
1141 If set to I<true>, write packets that were received via the network plugin to
1142 the sending sockets. This should only be activated when the B<Listen>- and
1143 B<Server>-statements differ. Otherwise packets may be send multiple times to
1144 the same multicast group. While this results in more network traffic than
1145 necessary it's not a huge problem since the plugin has a duplicate detection,
1146 so the values will not loop.
1148 =item B<CacheFlush> I<Seconds>
1150 For each host/plugin/type combination the C<network plugin> caches the time of
1151 the last value being sent or received. Every I<Seconds> seconds the plugin
1152 searches and removes all entries that are older than I<Seconds> seconds, thus
1153 freeing the unused memory again. Since this process is somewhat expensive and
1154 normally doesn't do much, this value should not be too small. The default is
1155 1800 seconds, but setting this to 86400 seconds (one day) will not do much harm
1160 =head2 Plugin C<nginx>
1162 This plugin collects the number of connections and requests handled by the
1163 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
1164 queries the page provided by the C<ngx_http_stub_status_module> module, which
1165 isn't compiled by default. Please refer to
1166 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
1167 how to compile and configure nginx and this module.
1169 The following options are accepted by the C<nginx plugin>:
1173 =item B<URL> I<http://host/nginx_status>
1175 Sets the URL of the C<ngx_http_stub_status_module> output.
1177 =item B<User> I<Username>
1179 Optional user name needed for authentication.
1181 =item B<Password> I<Password>
1183 Optional password needed for authentication.
1185 =item B<VerifyPeer> B<true|false>
1187 Enable or disable peer SSL certificate verification. See
1188 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1190 =item B<VerifyHost> B<true|false>
1192 Enable or disable peer host name verification. If enabled, the plugin checks
1193 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
1194 certificate matches the host name provided by the B<URL> option. If this
1195 identity check fails, the connection is aborted. Obviously, only works when
1196 connecting to a SSL enabled server. Enabled by default.
1198 =item B<CACert> I<File>
1200 File that holds one or more SSL certificates. If you want to use HTTPS you will
1201 possibly need this option. What CA certificates come bundled with C<libcurl>
1202 and are checked by default depends on the distribution you use.
1206 =head2 Plugin C<notify_desktop>
1208 This plugin sends a desktop notification to a notification daemon, as defined
1209 in the Desktop Notification Specification. To actually display the
1210 notifications, B<notification-daemon> is required and B<collectd> has to be
1211 able to access the X server.
1213 The Desktop Notification Specification can be found at
1214 L<http://www.galago-project.org/specs/notification/>.
1218 =item B<OkayTimeout> I<timeout>
1220 =item B<WarningTimeout> I<timeout>
1222 =item B<FailureTimeout> I<timeout>
1224 Set the I<timeout>, in milliseconds, after which to expire the notification
1225 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
1226 been specified, the displayed notification will not be closed at all - the
1227 user has to do so herself. These options default to 5000. If a negative number
1228 has been specified, the default is used as well.
1232 =head2 Plugin C<ntpd>
1236 =item B<Host> I<Hostname>
1238 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
1240 =item B<Port> I<Port>
1242 UDP-Port to connect to. Defaults to B<123>.
1244 =item B<ReverseLookups> B<true>|B<false>
1246 Sets wether or not to perform reverse lookups on peers. Since the name or
1247 IP-address may be used in a filename it is recommended to disable reverse
1248 lookups. The default is to do reverse lookups to preserve backwards
1249 compatibility, though.
1253 =head2 Plugin C<nut>
1257 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
1259 Add a UPS to collect data from. The format is identical to the one accepted by
1264 =head2 Plugin C<onewire>
1266 B<EXPERIMENTAL!> See notes below.
1268 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
1269 L<http://owfs.org/> to read sensors connected via the onewire bus.
1271 Currently only temperature sensors (sensors with the family code C<10>,
1272 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
1273 would like to have included, please send a sort request to the mailing list.
1275 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
1276 experimental, below.
1280 =item B<Device> I<Device>
1282 Sets the device to read the values from. This can either be a "real" hardware
1283 device, such as a serial port or an USB port, or the address of the
1284 L<owserver(1)> socket, usually B<localhost:4304>.
1286 Though the documentation claims to automatically recognize the given address
1287 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
1288 with that version, the following configuration worked for us:
1291 Device "-s localhost:4304"
1294 This directive is B<required> and does not have a default value.
1296 =item B<Sensor> I<Sensor>
1298 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
1299 below. Sensors are specified without the family byte at the beginning, to you'd
1300 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
1303 =item B<IgnoreSelected> I<true>|I<false>
1305 If no configuration if given, the B<onewire> plugin will collect data from all
1306 sensors found. This may not be practical, especially if sensors are added and
1307 removed regularly. Sometimes, however, it's easier/preferred to collect only
1308 specific sensors or all sensors I<except> a few specified ones. This option
1309 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
1310 B<Sensor> is inverted: All selected interfaces are ignored and all other
1311 interfaces are collected.
1315 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
1316 work with big setups. It works with one sensor being attached to one
1317 controller, but as soon as you throw in a couple more senors and maybe a hub
1318 or two, reading all values will take more than ten seconds (the default
1319 interval). We will probably add some separate thread for reading the sensors
1320 and some cache or something like that, but it's not done yet. We will try to
1321 maintain backwards compatibility in the future, but we can't probmise. So in
1322 short: If it works for you: Great! But kaap in mind that the config I<might>
1323 change, though this is unlikely. Oh, and if you want to help improving this
1324 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
1326 =head2 Plugin C<oracle>
1328 The "oracle" plugin uses the Oracle® Call Interface (OCI) to connect to an
1329 Oracle® Database and lets you execute SQL statements there. It is very similar
1330 to the "dbi" plugin, because it was written around the same time. See the "dbi"
1331 plugin's documentation above for details.
1334 <Query "out_of_stock">
1335 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1337 InstancesFrom "category"
1340 <Database "product_information">
1344 Query "out_of_stock"
1348 =head3 B<Query> blocks
1350 The Query blocks are handled identically to the Query blocks of the "dbi"
1351 plugin. Please see its documentation above for details on how to specify
1354 =head3 B<Database> blocks
1356 Database blocks define a connection to a database and which queries should be
1357 sent to that database. Each database needs a "name" as string argument in the
1358 starting tag of the block. This name will be used as "PluginInstance" in the
1359 values submitted to the daemon. Other than that, that name is not used.
1363 =item B<ConnectID> I<ID>
1365 Defines the "database alias" or "service name" to connect to. Usually, these
1366 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
1368 =item B<Username> I<Username>
1370 Username used for authentication.
1372 =item B<Password> I<Password>
1374 Password used for authentication.
1376 =item B<Query> I<QueryName>
1378 Associates the query named I<QueryName> with this database connection. The
1379 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1380 blocks you want to refer to must be placed above the database block you want to
1385 =head2 Plugin C<perl>
1387 This plugin embeds a Perl-interpreter into collectd and provides an interface
1388 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
1390 =head2 Plugin C<ping>
1394 =item B<Host> I<IP-address>
1396 Host to ping periodically. This option may be repeated several times to ping
1399 =item B<TTL> I<0-255>
1401 Sets the Time-To-Live of generated ICMP packets.
1405 =head2 Plugin C<postgresql>
1407 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
1408 keeps a persistent connection to all configured databases and tries to
1409 reconnect if the connection has been interrupted. A database is configured by
1410 specifying a B<Database> block as described below. The default statistics are
1411 collected from PostgreSQL's B<statistics collector> which thus has to be
1412 enabled for this plugin to work correctly. This should usually be the case by
1413 default. See the section "The Statistics Collector" of the B<PostgreSQL
1414 Documentation> for details.
1416 By specifying custom database queries using a B<Query> block as described
1417 below, you may collect any data that is available from some PostgreSQL
1418 database. This way, you are able to access statistics of external daemons
1419 which are available in a PostgreSQL database or use future or special
1420 statistics provided by PostgreSQL without the need to upgrade your collectd
1423 The B<PostgreSQL Documentation> manual can be found at
1424 L<http://www.postgresql.org/docs/manuals/>.
1428 Query "SELECT magic, spells FROM wizard WHERE host = $1;"
1431 Column counter spells
1440 KRBSrvName "kerberos_service_name"
1444 Service "service_name"
1448 The B<Query> block defines one database query which may later be used by a
1449 database definition. It accepts a single mandatory argument which specifies
1450 the name of the query. The names of all queries have to be unique. The
1451 following configuration options are available to define the query:
1455 =item B<Query> I<sql query>
1457 Specify the I<sql query> which the plugin should execute. The string may
1458 contain the tokens B<$1>, B<$2>, etc. which are used to reference the first,
1459 second, etc. parameter. The value of the parameters is specified by the
1460 B<Param> configuration option - see below for details. To include a literal
1461 B<$> character followed by a number, surround it with single quotes (B<'>).
1463 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
1464 allowed. Note, however, that only a single command may be used. Semicolons are
1465 allowed as long as a single non-empty command has been specified only.
1467 =item B<Param> I<hostname>|I<database>|I<username>
1469 Specify the parameters which should be passed to the SQL query. The parameters
1470 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
1471 they appear in the configuration file. The value of the parameter is
1472 determined depending on the value of the B<Param> option as follows:
1478 The configured hostname of the database connection. If a UNIX domain socket is
1479 used, the parameter expands to "localhost".
1483 The name of the database of the current connection.
1487 The username used to connect to the database.
1491 Please note that parameters are only supported by PostgreSQL's protocol
1492 version 3 and above which was introduced in version 7.4 of PostgreSQL.
1494 =item B<Column> I<type> [I<type instance>]
1496 Specify the I<type> and optional I<type instance> used to dispatch the value
1497 of each result column. Detailed information about types and their
1498 configuration can be found in L<types.db(5)>. The number and order of the
1499 B<Column> options has to match the columns of the query result.
1501 =item B<MinPGVersion> I<version>
1503 =item B<MaxPGVersion> I<version>
1505 Specify the minimum or maximum version of PostgreSQL that this query should be
1506 used with. Some statistics might only be available with certain versions of
1507 PostgreSQL. This allows you to specify multiple queries with the same name but
1508 which apply to different versions, thus allowing you to use the same
1509 configuration in a heterogeneous environment.
1511 The I<version> has to be specified as the concatenation of the major, minor
1512 and patch-level versions, each represented as two-decimal-digit numbers. For
1513 example, version 8.2.3 will become 80203.
1517 The following predefined queries are available (the definitions can be found
1518 in the F<postgresql_default.conf> file which, by default, is available at
1519 C<I<prefix>/share/collectd/>):
1525 This query collects the number of backends, i.E<nbsp>e. the number of
1528 =item B<transactions>
1530 This query collects the numbers of committed and rolled-back transactions of
1535 This query collects the numbers of various table modifications (i.E<nbsp>e.
1536 insertions, updates, deletions) of the user tables.
1538 =item B<query_plans>
1540 This query collects the numbers of various table scans and returned tuples of
1543 =item B<table_states>
1545 This query collects the numbers of live and dead rows in the user tables.
1549 This query collects disk block access counts for user tables.
1553 This query collects the on-disk size of the database in bytes.
1557 The B<Database> block defines one PostgreSQL database for which to collect
1558 statistics. It accepts a single mandatory argument which specifies the
1559 database name. None of the other options are required. PostgreSQL will use
1560 default values as documented in the section "CONNECTING TO A DATABASE" in the
1561 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
1562 the user collectd is run as and special environment variables. See the manpage
1567 =item B<Host> I<hostname>
1569 Specify the hostname or IP of the PostgreSQL server to connect to. If the
1570 value begins with a slash, it is interpreted as the directory name in which to
1571 look for the UNIX domain socket.
1573 This option is also used to determine the hostname that is associated with a
1574 collected data set. If it has been omitted or either begins with with a slash
1575 or equals B<localhost> it will be replaced with the global hostname definition
1576 of collectd. Any other value will be passed literally to collectd when
1577 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
1579 =item B<Port> I<port>
1581 Specify the TCP port or the local UNIX domain socket file extension of the
1584 =item B<User> I<username>
1586 Specify the username to be used when connecting to the server.
1588 =item B<Password> I<password>
1590 Specify the password to be used when connecting to the server.
1592 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
1594 Specify whether to use an SSL connection when contacting the server. The
1595 following modes are supported:
1601 Do not use SSL at all.
1605 First, try to connect without using SSL. If that fails, try using SSL.
1607 =item I<prefer> (default)
1609 First, try to connect using SSL. If that fails, try without using SSL.
1617 =item B<KRBSrvName> I<kerberos_service_name>
1619 Specify the Kerberos service name to use when authenticating with Kerberos 5
1620 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
1621 B<PostgreSQL Documentation> for details.
1623 =item B<Service> I<service_name>
1625 Specify the PostgreSQL service name to use for additional parameters. That
1626 service has to be defined in F<pg_service.conf> and holds additional
1627 connection parameters. See the section "The Connection Service File" in the
1628 B<PostgreSQL Documentation> for details.
1630 =item B<Query> I<query>
1632 Specify a I<query> which should be executed for the database connection. This
1633 may be any of the predefined or user-defined queries. If no such option is
1634 given, it defaults to "backends", "transactions", "queries", "query_plans",
1635 "table_states", "disk_io" and "disk_usage". Else, the specified queries are
1640 =head2 Plugin C<powerdns>
1642 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
1643 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
1644 values, many of which are probably meaningless to most users, but may be useful
1645 for some. So you may chose which values to collect, but if you don't, some
1646 reasonable defaults will be collected.
1649 <Server "server_name">
1651 Collect "udp-answers" "udp-queries"
1652 Socket "/var/run/pdns.controlsocket"
1654 <Recursor "recursor_name">
1656 Collect "cache-hits" "cache-misses"
1657 Socket "/var/run/pdns_recursor.controlsocket"
1659 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
1664 =item B<Server> and B<Recursor> block
1666 The B<Server> block defines one authoritative server to query, the B<Recursor>
1667 does the same for an recursing server. The possible options in both blocks are
1668 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
1673 =item B<Collect> I<Field>
1675 Using the B<Collect> statement you can select which values to collect. Here,
1676 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
1677 C<dlg-only-drops>, C<answers10-100>.
1679 The method of getting the values differs for B<Server> and B<Recursor> blocks:
1680 When querying the server a C<SHOW *> command is issued in any case, because
1681 that's the only way of getting multiple values out of the server at once.
1682 collectd then picks out the values you have selected. When querying the
1683 recursor, a command is generated to query exactly these values. So if you
1684 specify invalid fields when querying the recursor, a syntax error may be
1685 returned by the daemon and collectd may not collect any values at all.
1687 If no B<Collect> statement is given, the following B<Server> values will be
1694 =item packetcache-hit
1696 =item packetcache-miss
1698 =item packetcache-size
1700 =item query-cache-hit
1702 =item query-cache-miss
1704 =item recursing-answers
1706 =item recursing-questions
1718 The following B<Recursor> values will be collected by default:
1722 =item noerror-answers
1724 =item nxdomain-answers
1726 =item servfail-answers
1744 Please note that up to that point collectd doesn't know what values are
1745 available on the server and values that are added do not need a change of the
1746 mechanism so far. However, the values must be mapped to collectd's naming
1747 scheme, which is done using a lookup table that lists all known values. If
1748 values are added in the future and collectd does not know about them, you will
1749 get an error much like this:
1751 powerdns plugin: submit: Not found in lookup table: foobar = 42
1753 In this case please file a bug report with the collectd team.
1755 =item B<Socket> I<Path>
1757 Configures the path to the UNIX domain socket to be used when connecting to the
1758 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
1759 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
1760 will be used for the recursor.
1764 =item B<LocalSocket> I<Path>
1766 Querying the recursor is done using UDP. When using UDP over UNIX domain
1767 sockets, the client socket needs a name in the file system, too. You can set
1768 this local name to I<Path> using the B<LocalSocket> option. The default is
1769 C<I<prefix>/var/run/collectd-powerdns>.
1773 =head2 Plugin C<processes>
1777 =item B<Process> I<Name>
1779 Select more detailed statistics of processes matching this name. The statistics
1780 collected for these selected processes are size of the resident segment size
1781 (RSS), user- and system-time used, number of processes and number of threads,
1782 and minor and major pagefaults.
1786 =head2 Plugin C<rrdcached>
1788 The C<rrdcached> plugin uses the RRDTool accelerator daemon, L<rrdcached(1)>,
1789 to store values to RRD files in an efficient manner. The combination of the
1790 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
1791 way the C<rrdtool> plugin works (see below). The added abstraction layer
1792 provides a number of benefits, though: Because the cache is not within
1793 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
1794 restarted. This results in much shorter (if any) gaps in graphs, especially
1795 under heavy load. Also, the C<rrdtool> command line utility is aware of the
1796 daemon so that it can flush values to disk automatically when needed. This
1797 allows to integrate automated flushing of values into graphing solutions much
1800 There are disadvantages, though: The daemon may reside on a different host, so
1801 it may not be possible for C<collectd> to create the appropriate RRD files
1802 anymore. And even if C<rrdcached> runs on the same host, it may run in a
1803 different base directory, so relative paths may do weird stuff if you're not
1806 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
1807 on the same host, communicating via a UNIX domain socket. The B<DataDir>
1808 setting should be set to an absolute path, so that a changed base directory
1809 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
1813 =item B<DaemonAddress> I<Address>
1815 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
1816 library. See L<rrdcached(1)> for details. Example:
1818 <Plugin "rrdcached">
1819 DaemonAddress "unix:/var/run/rrdcached.sock"
1822 =item B<DataDir> I<Directory>
1824 Set the base directory in which the RRD files reside. If this is a relative
1825 path, it is relative to the working base directory of the C<rrdcached> daemon!
1826 Use of an absolute path is recommended.
1828 =item B<CreateFiles> B<true>|B<false>
1830 Enables or disables the creation of RRD files. If the daemon is not running
1831 locally, or B<DataDir> is set to a relative path, this will not work as
1832 expected. Default is B<true>.
1836 =head2 Plugin C<rrdtool>
1838 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
1839 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
1840 using these settings. If you don't want to dive into the depths of RRDTool, you
1841 can safely ignore these settings.
1845 =item B<DataDir> I<Directory>
1847 Set the directory to store RRD-files under. Per default RRD-files are generated
1848 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1850 =item B<StepSize> I<Seconds>
1852 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
1853 this setting is unset and the stepsize is set to the interval in which the data
1854 is collected. Do not use this option unless you absolutely have to for some
1855 reason. Setting this option may cause problems with the C<snmp plugin>, the
1856 C<exec plugin> or when the daemon is set up to receive data from other hosts.
1858 =item B<HeartBeat> I<Seconds>
1860 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
1861 in which case the heartbeat is set to twice the B<StepSize> which should equal
1862 the interval in which data is collected. Do not set this option unless you have
1863 a very good reason to do so.
1865 =item B<RRARows> I<NumRows>
1867 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
1868 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
1869 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
1870 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
1871 week, one month, and one year.
1873 So for each timespan, it calculates how many PDPs need to be consolidated into
1874 one CDP by calculating:
1875 number of PDPs = timespan / (stepsize * rrarows)
1877 Bottom line is, set this no smaller than the width of you graphs in pixels. The
1880 =item B<RRATimespan> I<Seconds>
1882 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
1883 more then one RRA. If this option is never used, the built-in default of (3600,
1884 86400, 604800, 2678400, 31622400) is used.
1886 For more information on how RRA-sizes are calculated see B<RRARows> above.
1888 =item B<XFF> I<Factor>
1890 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
1892 =item B<CacheFlush> I<Seconds>
1894 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
1895 it writes all values for a certain RRD-file if the oldest value is older than
1896 (or equal to) the number of seconds specified. If some RRD-file is not updated
1897 anymore for some reason (the computer was shut down, the network is broken,
1898 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
1899 entire cache is searched for entries older than B<CacheTimeout> seconds and
1900 written to disk every I<Seconds> seconds. Since this is kind of expensive and
1901 does nothing under normal circumstances, this value should not be too small.
1902 900 seconds might be a good value, though setting this to 7200 seconds doesn't
1903 normally do much harm either.
1905 =item B<CacheTimeout> I<Seconds>
1907 If this option is set to a value greater than zero, the C<rrdtool plugin> will
1908 save values in a cache, as described above. Writing multiple values at once
1909 reduces IO-operations and thus lessens the load produced by updating the files.
1910 The trade off is that the graphs kind of "drag behind" and that more memory is
1913 =item B<WritesPerSecond> B<Updates>
1915 When collecting many statistics with collectd and the C<rrdtool> plugin, you
1916 will run serious performance problems. The B<CacheFlush> setting and the
1917 internal update queue assert that collectd continues to work just fine even
1918 under heavy load, but the system may become very unresponsive and slow. This is
1919 a problem especially if you create graphs from the RRD files on the same
1920 machine, for example using the C<graph.cgi> script included in the
1921 C<contrib/collection3/> directory.
1923 This setting is designed for very large setups. Setting this option to a value
1924 between 25 and 80 updates per second, depending on your hardware, will leave
1925 the server responsive enough to draw graphs even while all the cached values
1926 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
1927 by the B<FLUSH> command, are B<not> effected by this limit. They are still
1928 written as fast as possible, so that web frontends have up to date data when
1931 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
1932 updates per second, writing all values to disk will take approximately
1933 56E<nbsp>minutes. Together with the flushing ability that's integrated into
1934 "collection3" you'll end up with a responsive and fast system, up to date
1935 graphs and basically a "backup" of your values every hour.
1939 =head2 Plugin C<sensors>
1941 The C<sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
1942 that all the needed modules have to be loaded and lm_sensors has to be
1943 configured (most likely by editing F</etc/sensors.conf>. Read
1944 L<sensors.conf(5)> for details.
1946 The B<lm_sensors> homepage can be found at
1947 L<http://secure.netroedge.com/~lm78/>.
1951 =item B<Sensor> I<chip-bus-address/type-feature>
1953 Selects the name of the sensor which you want to collect or ignore, depending
1954 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
1955 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
1956 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
1958 =item B<IgnoreSelected> I<true>|I<false>
1960 If no configuration if given, the B<sensors>-plugin will collect data from all
1961 sensors. This may not be practical, especially for uninteresting sensors.
1962 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
1963 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
1964 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
1965 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
1966 and all other sensors are collected.
1970 =head2 Plugin C<snmp>
1972 Since the configuration of the C<snmp plugin> is a little more complicated than
1973 other plugins, its documentation has been moved to an own manpage,
1974 L<collectd-snmp(5)>. Please see there for details.
1976 =head2 Plugin C<syslog>
1980 =item B<LogLevel> B<debug|info|notice|warning|err>
1982 Sets the log-level. If, for example, set to B<notice>, then all events with
1983 severity B<notice>, B<warning>, or B<err> will be submitted to the
1986 Please note that B<debug> is only available if collectd has been compiled with
1991 =head2 Plugin C<tail>
1993 The C<tail plugin> plugins follows logfiles, just like L<tail(1)> does, parses
1994 each line and dispatches found values. What is matched can be configured by the
1995 user using (extended) regular expressions, as described in L<regex(7)>.
1998 <File "/var/log/exim4/mainlog">
2001 Regex "S=([1-9][0-9]*)"
2007 Regex "\\<R=local_user\\>"
2010 Instance "local_user"
2015 The config consists of one or more B<File> blocks, each of which configures one
2016 logfile to parse. Within each B<File> block, there are one or more B<Match>
2017 blocks, which configure a regular expression to search for.
2019 The B<Instance> option in the B<File> block may be used to set the plugin
2020 instance. So in the above example the plugin name C<tail-foo> would be used.
2021 This plugin instance is for all B<Match> blocks that B<follow> it, until the
2022 next B<Instance> option. This way you can extract several plugin instances from
2023 one logfile, handy when parsing syslog and the like.
2025 Each B<Match> block has the following options to describe how the match should
2030 =item B<Regex> I<regex>
2032 Sets the regular expression to use for matching against a line. The first
2033 subexpression has to match something that can be turned into a number by
2034 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
2035 below. Because B<extended> regular expressions are used, you do not need to use
2036 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
2037 collectd's config parsing you need to escape backslashes, though. So if you
2038 want to match literal parentheses you need to do the following:
2040 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
2042 =item B<DSType> I<Type>
2044 Sets how the values are cumulated. I<Type> is one of:
2048 =item B<GaugeAverage>
2050 Calculate the average.
2054 Use the smallest number only.
2058 Use the greatest number only.
2062 Use the last number found.
2066 The matched number is a counter. Simply sets the internal counter to this
2071 Add the matched value to the internal counter.
2075 Increase the internal counter by one. This B<DSType> is the only one that does
2076 not use the matched subexpression, but simply counts the number of matched
2077 lines. Thus, you may use a regular expression without submatch in this case.
2081 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
2082 number, using L<strtod(3)>. The B<CounterSet> and B<CounterAdd> interpret the
2083 submatch as an integer using L<strtoll(3)>. B<CounterInc> does not use the
2084 submatch at all and it may be omitted in this case.
2086 =item B<Type> I<Type>
2088 Sets the type used to dispatch this value. Detailed information about types and
2089 their configuration can be found in L<types.db(5)>.
2091 =item B<Instance> I<TypeInstance>
2093 This optional setting sets the type instance to use.
2097 =head2 Plugin C<teamspeak2>
2099 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
2100 polls interesting global and virtual server data. The plugin can query only one
2101 physical server but unlimited virtual servers. You can use the following
2102 options to configure it:
2106 =item B<Host> I<hostname/ip>
2108 The hostname or ip which identifies the physical server.
2111 =item B<Port> I<port>
2113 The query port of the physical server. This needs to be a string.
2116 =item B<Server> I<port>
2118 This option has to be added once for every virtual server the plugin should
2119 query. If you want to query the virtual server on port 8767 this is what the
2120 option would look like:
2124 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
2125 use quotes around it! If no such statement is given only global information
2130 =head2 Plugin C<tcpconns>
2132 The C<tcpconns plugin> counts the number of currently established TCP
2133 connections based on the local port and/or the remote port. Since there may be
2134 a lot of connections the default if to count all connections with a local port,
2135 for which a listening socket is opened. You can use the following options to
2136 fine-tune the ports you are interested in:
2140 =item B<ListeningPorts> I<true>|I<false>
2142 If this option is set to I<true>, statistics for all local ports for which a
2143 listening socket exists are collected. The default depends on B<LocalPort> and
2144 B<RemotePort> (see below): If no port at all is specifically selected, the
2145 default is to collect listening ports. If specific ports (no matter if local or
2146 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
2147 the selected ports will be collected unless this option is set to I<true>
2150 =item B<LocalPort> I<Port>
2152 Count the connections to a specific local port. This can be used to see how
2153 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
2154 You have to specify the port in numeric form, so for the mailserver example
2155 you'd need to set B<25>.
2157 =item B<RemotePort> I<Port>
2159 Count the connections to a specific remote port. This is useful to see how
2160 much a remote service is used. This is most useful if you want to know how many
2161 connections a local service has opened to remote services, e.E<nbsp>g. how many
2162 connections a mail server or news server has to other mail or news servers, or
2163 how many connections a web proxy holds to web servers. You have to give the
2164 port in numeric form.
2168 =head2 Plugin C<thermal>
2172 =item B<ForceUseProcfs> I<true>|I<false>
2174 By default, the C<thermal> plugin tries to read the statistics from the Linux
2175 C<sysfs> interface. If that is not available, the plugin falls back to the
2176 C<procfs> interface. By setting this option to I<true>, you can force the
2177 plugin to use the latter. This option defaults to I<false>.
2179 =item B<Device> I<Device>
2181 Selects the name of the thermal device that you want to collect or ignore,
2182 depending on the value of the B<IgnoreSelected> option. This option may be
2183 used multiple times to specify a list of devices.
2185 =item B<IgnoreSelected> I<true>|I<false>
2187 Invert the selection: If set to true, all devices B<except> the ones that
2188 match the device names specified by the B<Device> option are collected. By
2189 default only selected devices are collected if a selection is made. If no
2190 selection is configured at all, B<all> devices are selected.
2194 =head2 Plugin C<unixsock>
2198 =item B<SocketFile> I<Path>
2200 Sets the socket-file which is to be created.
2202 =item B<SocketGroup> I<Group>
2204 If running as root change the group of the UNIX-socket after it has been
2205 created. Defaults to B<collectd>.
2207 =item B<SocketPerms> I<Permissions>
2209 Change the file permissions of the UNIX-socket after it has been created. The
2210 permissions must be given as a numeric, octal value as you would pass to
2211 L<chmod(1)>. Defaults to B<0770>.
2215 =head2 Plugin C<uuid>
2217 This plugin, if loaded, causes the Hostname to be taken from the machine's
2218 UUID. The UUID is a universally unique designation for the machine, usually
2219 taken from the machine's BIOS. This is most useful if the machine is running in
2220 a virtual environment such as Xen, in which case the UUID is preserved across
2221 shutdowns and migration.
2223 The following methods are used to find the machine's UUID, in order:
2229 Check I</etc/uuid> (or I<UUIDFile>).
2233 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
2238 Check for UUID from C<dmidecode> / SMBIOS.
2242 Check for UUID from Xen hypervisor.
2246 If no UUID can be found then the hostname is not modified.
2250 =item B<UUIDFile> I<Path>
2252 Take the UUID from the given file (default I</etc/uuid>).
2256 =head2 Plugin C<vmem>
2258 The C<vmem> plugin collects information about the usage of virtual memory.
2259 Since the statistics provided by the Linux kernel are very detailed, they are
2260 collected very detailed. However, to get all the details, you have to switch
2261 them on manually. Most people just want an overview over, such as the number of
2262 pages read from swap space.
2266 =item B<Verbose> B<true>|B<false>
2268 Enables verbose collection of information. This will start collecting page
2269 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
2270 Part of these statistics are collected on a "per zone" basis.
2274 =head2 Plugin C<vserver>
2276 This plugin doesn't have any options. B<VServer> support is only available for
2277 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
2278 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
2279 need to apply the patches and compile your own kernel, which will then provide
2280 the F</proc/virtual> filesystem that is required by this plugin.
2282 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
2284 =head1 THRESHOLD CONFIGURATION
2286 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
2287 we mean that the values are not only stored or sent somewhere, but that they
2288 are judged and, if a problem is recognized, acted upon. The only action
2289 collectd takes itself is to generate and dispatch a "notification". Plugins can
2290 register to receive notifications and perform appropriate further actions.
2292 Since systems and what you expect them to do differ a lot, you can configure
2293 B<thresholds> for your values freely. This gives you a lot of flexibility but
2294 also a lot of responsibility.
2296 Every time a value is out of range a notification is dispatched. This means
2297 that the idle percentage of your CPU needs to be less then the configured
2298 threshold only once for a notification to be generated. There's no such thing
2299 as a moving average or similar - at least not now.
2301 Also, all values that match a threshold are considered to be relevant or
2302 "interesting". As a consequence collectd will issue a notification if they are
2303 not received for twice the last timeout of the values. If, for example, some
2304 hosts sends it's CPU statistics to the server every 60 seconds, a notification
2305 will be dispatched after about 120 seconds. It may take a little longer because
2306 the timeout is checked only once each B<Interval> on the server.
2308 When a value comes within range again or is received after it was missing, an
2309 "OKAY-notification" is dispatched.
2311 Here is a configuration example to get you started. Read below for more
2324 <Plugin "interface">
2341 WarningMin 100000000
2347 There are basically two types of configuration statements: The C<Host>,
2348 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
2349 configured. The C<Plugin> and C<Type> blocks may be specified further using the
2350 C<Instance> option. You can combine the block by nesting the blocks, though
2351 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
2352 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
2353 C<Type> may not contain other blocks. If multiple blocks apply to the same
2354 value the most specific block is used.
2356 The other statements specify the threshold to configure. They B<must> be
2357 included in a C<Type> block. Currently the following statements are recognized:
2361 =item B<FailureMax> I<Value>
2363 =item B<WarningMax> I<Value>
2365 Sets the upper bound of acceptable values. If unset defaults to positive
2366 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
2367 will be created. If the value is greater than B<WarningMax> but less than (or
2368 equal to) B<FailureMax> a B<WARNING> notification will be created.
2370 =item B<FailureMin> I<Value>
2372 =item B<WarningMin> I<Value>
2374 Sets the lower bound of acceptable values. If unset defaults to negative
2375 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
2376 be created. If the value is less than B<WarningMin> but greater than (or equal
2377 to) B<FailureMin> a B<WARNING> notification will be created.
2379 =item B<DataSource> I<DSName>
2381 Some data sets have more than one "data source". Interesting examples are the
2382 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
2383 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
2384 system load data set, C<load>, even has three data sources: C<shortterm>,
2385 C<midterm>, and C<longterm>.
2387 Normally, all data sources are checked against a configured threshold. If this
2388 is undesirable, or if you want to specify different limits for each data
2389 source, you can use the B<DataSource> option to have a threshold apply only to
2392 =item B<Invert> B<true>|B<false>
2394 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
2395 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
2396 B<WarningMax>) are not okay. Defaults to B<false>.
2398 =item B<Persist> B<true>|B<false>
2400 Sets how often notifications are generated. If set to B<true> one notification
2401 will be generated for each value that is out of the acceptable range. If set to
2402 B<false> (the default) then a notification is only generated if a value is out
2403 of range but the previous value was okay.
2405 This applies to missing values, too: If set to B<true> a notification about a
2406 missing value is generated once every B<Interval> seconds. If set to B<false>
2407 only one such notification is generated until the value appears again.
2414 L<collectd-exec(5)>,
2415 L<collectd-perl(5)>,
2416 L<collectd-unixsock(5)>,
2428 Florian Forster E<lt>octo@verplant.orgE<gt>