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<Timeout> I<Iterations>
107 Consider a value list "missing" when no update has been read or received for
108 I<Iterations> iterations. By default, I<collectd> considers a value list
109 missing when no update has been received for twice the update interval. Since
110 this setting uses iterations, the maximum allowed time without update depends
111 on the I<Interval> information contained in each value list. This is used in
112 the I<Threshold> configuration to dispatch notifications about missing values,
113 see L<"THRESHOLD CONFIGURATION"> below.
115 =item B<ReadThreads> I<Num>
117 Number of threads to start for reading plugins. The default value is B<5>, but
118 you may want to increase this if you have more than five plugins that take a
119 long time to read. Mostly those are plugin that do network-IO. Setting this to
120 a value higher than the number of plugins you've loaded is totally useless.
122 =item B<Hostname> I<Name>
124 Sets the hostname that identifies a host. If you omit this setting, the
125 hostname will be determined using the L<gethostname(2)> system call.
127 =item B<FQDNLookup> B<true|false>
129 If B<Hostname> is determined automatically this setting controls whether or not
130 the daemon should try to figure out the "fully qualified domain name", FQDN.
131 This is done using a lookup of the name returned by C<gethostname>. This option
132 is enabled by default.
134 =item B<PreCacheChain> I<ChainName>
136 =item B<PostCacheChain> I<ChainName>
138 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
139 see L<FILTER CONFIGURATION> below on information on chains and how these
140 setting change the daemon's behavior.
144 =head1 PLUGIN OPTIONS
146 Some plugins may register own options. These options must be enclosed in a
147 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
148 require external configuration, too. The C<apache plugin>, for example,
149 required C<mod_status> to be configured in the webserver you're going to
150 collect data from. These plugins are listed below as well, even if they don't
151 require any configuration within collectd's configfile.
153 A list of all plugins and a short summary for each plugin can be found in the
154 F<README> file shipped with the sourcecode and hopefully binary packets as
157 =head2 Plugin C<amqp>
159 The I<AMQMP plugin> can be used to communicate with other instances of
160 I<collectd> or third party applications using an AMQP message broker. Values
161 are sent to or received from the broker, which handles routing, queueing and
162 possibly filtering or messages.
165 # Send values to an AMQP broker
166 <Publish "some_name">
172 Exchange "amq.fanout"
173 # ExchangeType "fanout"
174 # RoutingKey "collectd"
180 # Receive values from an AMQP broker
181 <Subscribe "some_name">
187 Exchange "amq.fanout"
188 # ExchangeType "fanout"
190 # RoutingKey "collectd.#"
194 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
195 blocks, which configure sending and receiving of values respectively. The two
196 blocks are very similar, so unless otherwise noted, an option can be used in
197 either block. The name given in the blocks starting tag is only used for
198 reporting messages, but may be used to support I<flushing> of certain
199 I<Publish> blocks in the future.
203 =item B<Host> I<Host>
205 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
206 the underlying communications library, I<rabbitmq-c>, which is "localhost".
208 =item B<Port> I<Port>
210 Service name or port number on which the AMQP broker accepts connections. This
211 argument must be a string, even if the numeric form is used. Defaults to
214 =item B<VHost> I<VHost>
216 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
218 =item B<User> I<User>
220 =item B<Password> I<Password>
222 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
225 =item B<Exchange> I<Exchange>
227 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
228 By default, "amq.fanout" will be used.
230 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
231 the given exchange and the I<queue> is created, using the I<routing key> if
232 configured. See the B<Queue> and B<RoutingKey> options below.
234 =item B<ExchangeType> I<Type>
236 If given, the plugin will try to create the configured I<exchange> with this
237 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
238 be bound to this exchange.
240 =item B<Queue> I<Queue> (Subscribe only)
242 Configures the I<queue> name to subscribe to. If no queue name was configures
243 explicitly, a unique queue name will be created by the broker.
245 =item B<RoutingKey> I<Key>
247 In I<Publish> blocks, this configures the routing key to set on all outgoing
248 messages. If not given, the routing key will be computed from the I<identifier>
249 of the value. The host, plugin, type and the two instances are concatenated
250 together using dots as the separator and all containing dots replaced with
251 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
252 possible to receive only specific values using a "topic" exchange.
254 In I<Subscribe> blocks, configures the I<routing key> used when creating a
255 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
256 used to filter messages when using a "topic" exchange. If you're only
257 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
260 =item B<Persistent> B<true>|B<false> (Publish only)
262 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
263 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
264 default), the I<transient> delivery mode will be used, i.e. messages may be
265 lost due to high load, overflowing queues or similar issues.
267 =item B<Format> B<Command>|B<JSON> (Publish only)
269 Selects the format in which messages are sent to the broker. If set to
270 B<Command> (the default), values are sent as C<PUTVAL> commands which are
271 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
272 case, the C<Content-Type> header field will be set to C<text/collectd>.
274 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
275 an easy and straight forward exchange format. The C<Content-Type> header field
276 will be set to C<application/json>.
278 A subscribing client I<should> use the C<Content-Type> header field to
279 determine how to decode the values. Currently, the I<AMQP plugin> itself can
280 only decode the B<Command> format.
282 =item B<StoreRates> B<true>|B<false> (Publish only)
284 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
285 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
286 default), no conversion is performed. Otherwise the conversion is performed
287 using the internal value cache.
289 Please note that currently this option is only used if the B<Format> option has
294 =head2 Plugin C<apache>
296 To configure the C<apache>-plugin you first need to configure the Apache
297 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
298 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
299 the following snipped to base your Apache config upon:
302 <IfModule mod_status.c>
303 <Location /mod_status>
304 SetHandler server-status
308 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
309 also supported. It introduces a new field, called C<BusyServers>, to count the
310 number of currently connected clients. This field is also supported.
312 The following options are accepted by the C<apache>-plugin:
316 =item B<URL> I<http://host/mod_status?auto>
318 Sets the URL of the C<mod_status> output. This needs to be the output generated
319 by C<ExtendedStatus on> and it needs to be the machine readable output
320 generated by appending the C<?auto> argument.
322 =item B<User> I<Username>
324 Optional user name needed for authentication.
326 =item B<Password> I<Password>
328 Optional password needed for authentication.
330 =item B<VerifyPeer> B<true|false>
332 Enable or disable peer SSL certificate verification. See
333 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
335 =item B<VerifyHost> B<true|false>
337 Enable or disable peer host name verification. If enabled, the plugin checks
338 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
339 certificate matches the host name provided by the B<URL> option. If this
340 identity check fails, the connection is aborted. Obviously, only works when
341 connecting to a SSL enabled server. Enabled by default.
343 =item B<CACert> I<File>
345 File that holds one or more SSL certificates. If you want to use HTTPS you will
346 possibly need this option. What CA certificates come bundled with C<libcurl>
347 and are checked by default depends on the distribution you use.
351 =head2 Plugin C<apcups>
355 =item B<Host> I<Hostname>
357 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
358 that IPv6 support has been disabled unless someone can confirm or decline that
359 B<apcupsd> can handle it.
361 =item B<Port> I<Port>
363 TCP-Port to connect to. Defaults to B<3551>.
367 =head2 Plugin C<ascent>
369 This plugin collects information about an Ascent server, a free server for the
370 "World of Warcraft" game. This plugin gathers the information by fetching the
371 XML status page using C<libcurl> and parses it using C<libxml2>.
373 The configuration options are the same as for the C<apache> plugin above:
377 =item B<URL> I<http://localhost/ascent/status/>
379 Sets the URL of the XML status output.
381 =item B<User> I<Username>
383 Optional user name needed for authentication.
385 =item B<Password> I<Password>
387 Optional password needed for authentication.
389 =item B<VerifyPeer> B<true|false>
391 Enable or disable peer SSL certificate verification. See
392 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
394 =item B<VerifyHost> B<true|false>
396 Enable or disable peer host name verification. If enabled, the plugin checks
397 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
398 certificate matches the host name provided by the B<URL> option. If this
399 identity check fails, the connection is aborted. Obviously, only works when
400 connecting to a SSL enabled server. Enabled by default.
402 =item B<CACert> I<File>
404 File that holds one or more SSL certificates. If you want to use HTTPS you will
405 possibly need this option. What CA certificates come bundled with C<libcurl>
406 and are checked by default depends on the distribution you use.
410 =head2 Plugin C<bind>
412 Starting with BIND 9.5.0, the most widely used DNS server software provides
413 extensive statistics about queries, responses and lots of other information.
414 The bind plugin retrieves this information that's encoded in XML and provided
415 via HTTP and submits the values to collectd.
417 To use this plugin, you first need to tell BIND to make this information
418 available. This is done with the C<statistics-channels> configuration option:
420 statistics-channels {
421 inet localhost port 8053;
424 The configuration follows the grouping that can be seen when looking at the
425 data with an XSLT compatible viewer, such as a modern web browser. It's
426 probably a good idea to make yourself familiar with the provided values, so you
427 can understand what the collected statistics actually mean.
432 URL "http://localhost:8053/"
446 Zone "127.in-addr.arpa/IN"
450 The bind plugin accepts the following configuration options:
456 URL from which to retrieve the XML data. If not specified,
457 C<http://localhost:8053/> will be used.
459 =item B<OpCodes> I<true>|I<false>
461 When enabled, statistics about the I<"OpCodes">, for example the number of
462 C<QUERY> packets, are collected.
466 =item B<QTypes> I<true>|I<false>
468 When enabled, the number of I<incoming> queries by query types (for example
469 C<A>, C<MX>, C<AAAA>) is collected.
473 =item B<ServerStats> I<true>|I<false>
475 Collect global server statistics, such as requests received over IPv4 and IPv6,
476 successful queries, and failed updates.
480 =item B<ZoneMaintStats> I<true>|I<false>
482 Collect zone maintenance statistics, mostly information about notifications
483 (zone updates) and zone transfers.
487 =item B<ResolverStats> I<true>|I<false>
489 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
490 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
491 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
492 default. Use the B<ResolverStats> option within a B<View "_default"> block
493 instead for the same functionality.
499 Collect global memory statistics.
503 =item B<View> I<Name>
505 Collect statistics about a specific I<"view">. BIND can behave different,
506 mostly depending on the source IP-address of the request. These different
507 configurations are called "views". If you don't use this feature, you most
508 likely are only interested in the C<_default> view.
510 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
511 information you want to collect about a view. If no B<View> block is
512 configured, no detailed view statistics will be collected.
516 =item B<QTypes> I<true>|I<false>
518 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
523 =item B<ResolverStats> I<true>|I<false>
525 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
526 (e.E<nbsp>g. queries over IPv4, lame servers).
530 =item B<CacheRRSets> I<true>|I<false>
532 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
533 type is collected. Negative entries (queries which resulted in an error, for
534 example names that do not exist) are reported with a leading exclamation mark,
539 =item B<Zone> I<Name>
541 When given, collect detailed information about the given zone in the view. The
542 information collected if very similar to the global B<ServerStats> information
545 You can repeat this option to collect detailed information about multiple
548 By default no detailed zone information is collected.
554 =head2 Plugin C<cpufreq>
556 This plugin doesn't have any options. It reads
557 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
558 installed) to get the current CPU frequency. If this file does not exist make
559 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
560 installed and an "cpu governor" (that's a kernel module) is loaded.
566 =item B<DataDir> I<Directory>
568 Set the directory to store CSV-files under. Per default CSV-files are generated
569 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
570 The special strings B<stdout> and B<stderr> can be used to write to the standard
571 output and standard error channels, respectively. This, of course, only makes
572 much sense when collectd is running in foreground- or non-daemon-mode.
574 =item B<StoreRates> B<true|false>
576 If set to B<true>, convert counter values to rates. If set to B<false> (the
577 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
582 =head2 Plugin C<curl>
584 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
585 and the match infrastructure (the same code used by the tail plugin) to use
586 regular expressions with the received data.
588 The following example will read the current value of AMD stock from Google's
589 finance page and dispatch the value to collectd.
592 <Page "stock_quotes">
593 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
597 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
598 DSType "GaugeAverage"
599 # Note: `stock_value' is not a standard type.
606 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
607 a web page and one or more "matches" to be performed on the returned data. The
608 string argument to the B<Page> block is used as plugin instance.
610 The following options are valid within B<Page> blocks:
616 URL of the web site to retrieve. Since a regular expression will be used to
617 extract information from this data, non-binary data is a big plus here ;)
619 =item B<User> I<Name>
621 Username to use if authorization is required to read the page.
623 =item B<Password> I<Password>
625 Password to use if authorization is required to read the page.
627 =item B<VerifyPeer> B<true>|B<false>
629 Enable or disable peer SSL certificate verification. See
630 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
632 =item B<VerifyHost> B<true>|B<false>
634 Enable or disable peer host name verification. If enabled, the plugin checks if
635 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
636 matches the host name provided by the B<URL> option. If this identity check
637 fails, the connection is aborted. Obviously, only works when connecting to a
638 SSL enabled server. Enabled by default.
640 =item B<CACert> I<file>
642 File that holds one or more SSL certificates. If you want to use HTTPS you will
643 possibly need this option. What CA certificates come bundled with C<libcurl>
644 and are checked by default depends on the distribution you use.
646 =item B<MeasureResponseTime> B<true>|B<false>
648 Measure response time for the request. If this setting is enabled, B<Match>
649 blocks (see below) are optional. Disabled by default.
651 =item B<E<lt>MatchE<gt>>
653 One or more B<Match> blocks that define how to match information in the data
654 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
655 used by the C<tail> plugin, so please see the documentation of the C<tail>
656 plugin below on how matches are defined. If the B<MeasureResponseTime> option
657 is set to B<true>, B<Match> blocks are optional.
661 =head2 Plugin C<curl_json>
663 The B<curl_json plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and
664 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) to retrieve JSON data
665 via cURL. This can be used to collect values from CouchDB documents (which are
666 stored JSON notation), for example.
668 The following example will collect several values from the built-in `_stats'
669 runtime statistics module of CouchDB
670 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
673 <URL "http://localhost:5984/_stats">
675 <Key "httpd/requests/count">
679 <Key "httpd_request_methods/*/count">
680 Type "http_request_methods"
683 <Key "httpd_status_codes/*/count">
684 Type "http_response_codes"
689 Another CouchDB example:
690 The following example will collect the status values from each database:
692 <URL "http://localhost:5984/_all_dbs">
697 <Key "*/doc_del_count">
705 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining
706 a URL to be fetched via HTTP (using libcurl) and one or more B<Key> blocks.
707 The B<Key> string argument must be in a path format, which is used to collect a
708 value from a JSON map object. If a path element of B<Key> is the
709 I<*>E<nbsp>wildcard, the values for all keys will be collectd.
711 The following options are valid within B<URL> blocks:
715 =item B<Instance> I<Instance>
717 Sets the plugin instance to I<Instance>.
719 =item B<User> I<Name>
721 Username to use if authorization is required to read the page.
723 =item B<Password> I<Password>
725 Password to use if authorization is required to read the page.
727 =item B<VerifyPeer> B<true>|B<false>
729 Enable or disable peer SSL certificate verification. See
730 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
732 =item B<VerifyHost> B<true>|B<false>
734 Enable or disable peer host name verification. If enabled, the plugin checks if
735 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
736 matches the host name provided by the B<URL> option. If this identity check
737 fails, the connection is aborted. Obviously, only works when connecting to a
738 SSL enabled server. Enabled by default.
740 =item B<CACert> I<file>
742 File that holds one or more SSL certificates. If you want to use HTTPS you will
743 possibly need this option. What CA certificates come bundled with C<libcurl>
744 and are checked by default depends on the distribution you use.
748 The following options are valid within B<Key> blocks:
752 =item B<Type> I<Type>
754 Sets the type used to dispatch the values to the daemon. Detailed information
755 about types and their configuration can be found in L<types.db(5)>. This
758 =item B<Instance> I<Instance>
760 Type-instance to use. Defaults to the current map key or current string array element value.
764 =head2 Plugin C<curl_xml>
766 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
767 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
770 <URL "http://localhost/stats.xml">
772 Instance "some_instance"
777 CACert "/path/to/ca.crt"
779 <XPath "table[@id=\"magic_level\"]/tr">
781 #InstancePrefix "prefix-"
783 ValuesFrom "td[2]/span[@class=\"level\"]"
788 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
789 URL to be fetched via HTTP (using libcurl). Within each B<URL> block there are
790 options which specify the connection parameters, for example authentication
791 information, and one or more B<XPath> blocks.
793 Each B<XPath> block specifies how to get one type of information. The
794 string argument must be a valid XPath expression which returns a list
795 of "base elements". One value is dispatched for each "base element". The
796 I<type instance> and values are looked up using further I<XPath> expressions
797 that should be relative to the base element.
799 Within the B<URL> block the following options are accepted:
803 =item B<Host> I<Name>
805 Use I<Name> as the host name when submitting values. Defaults to the global
808 =item B<Instance> I<Instance>
810 Use I<Instance> as the plugin instance when submitting values. Defaults to an
811 empty string (no plugin instance).
813 =item B<User> I<User>
814 =item B<Password> I<Password>
815 =item B<VerifyPeer> B<true>|B<false>
816 =item B<VerifyHost> B<true>|B<false>
817 =item B<CACert> I<CA Cert File>
819 These options behave exactly equivalent to the appropriate options of the
820 I<cURL> and I<cURL-JSON> plugins. Please see there for a detailed description.
822 =item E<lt>B<XPath> I<XPath-expression>E<gt>
824 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
825 B<XPath> block specifies how to get one type of information. The string
826 argument must be a valid XPath expression which returns a list of "base
827 elements". One value is dispatched for each "base element".
829 Within the B<XPath> block the following options are accepted:
833 =item B<Type> I<Type>
835 Specifies the I<Type> used for submitting patches. This determines the number
836 of values that are required / expected and whether the strings are parsed as
837 signed or unsigned integer or as double values. See L<types.db(5)> for details.
838 This option is required.
840 =item B<InstancePrefix> I<InstancePrefix>
842 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
843 concatenated together without any separator.
844 This option is optional.
846 =item B<InstanceFrom> I<InstanceFrom>
848 Specifies a XPath expression to use for determining the I<type instance>. The
849 XPath expression must return exactly one element. The element's value is then
850 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
852 This value is required. As a special exception, if the "base XPath expression"
853 (the argument to the B<XPath> block) returns exactly one argument, then this
854 option may be omitted.
856 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
858 Specifies one or more XPath expression to use for reading the values. The
859 number of XPath expressions must match the number of data sources in the
860 I<type> specified with B<Type> (see above). Each XPath expression must return
861 exactly one element. The element's value is then parsed as a number and used as
862 value for the appropriate value in the value list dispatched to the daemon.
870 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
871 connect to various databases, execute I<SQL> statements and read back the
872 results. I<dbi> is an acronym for "database interface" in case you were
873 wondering about the name. You can configure how each column is to be
874 interpreted and the plugin will generate one or more data sets from each row
875 returned according to these rules.
877 Because the plugin is very generic, the configuration is a little more complex
878 than those of other plugins. It usually looks something like this:
881 <Query "out_of_stock">
882 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
883 # Use with MySQL 5.0.0 or later
887 InstancePrefix "out_of_stock"
888 InstancesFrom "category"
892 <Database "product_information">
894 DriverOption "host" "localhost"
895 DriverOption "username" "collectd"
896 DriverOption "password" "aZo6daiw"
897 DriverOption "dbname" "prod_info"
903 The configuration above defines one query with one result and one database. The
904 query is then linked to the database with the B<Query> option I<within> the
905 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
906 and you can also use the B<Include> statement to split up the configuration
907 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
908 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
911 The following is a complete list of options:
913 =head3 B<Query> blocks
915 Query blocks define I<SQL> statements and how the returned data should be
916 interpreted. They are identified by the name that is given in the opening line
917 of the block. Thus the name needs to be unique. Other than that, the name is
918 not used in collectd.
920 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
921 define which column holds which value or instance information. You can use
922 multiple B<Result> blocks to create multiple values from one returned row. This
923 is especially useful, when queries take a long time and sending almost the same
924 query again and again is not desirable.
928 <Query "environment">
929 Statement "select station, temperature, humidity from environment"
932 # InstancePrefix "foo"
933 InstancesFrom "station"
934 ValuesFrom "temperature"
938 InstancesFrom "station"
939 ValuesFrom "humidity"
943 The following options are accepted:
947 =item B<Statement> I<SQL>
949 Sets the statement that should be executed on the server. This is B<not>
950 interpreted by collectd, but simply passed to the database server. Therefore,
951 the SQL dialect that's used depends on the server collectd is connected to.
953 The query has to return at least two columns, one for the instance and one
954 value. You cannot omit the instance, even if the statement is guaranteed to
955 always return exactly one line. In that case, you can usually specify something
958 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
960 (That works with MySQL but may not be valid SQL according to the spec. If you
961 use a more strict database server, you may have to select from a dummy table or
964 Please note that some databases, for example B<Oracle>, will fail if you
965 include a semicolon at the end of the statement.
967 =item B<MinVersion> I<Version>
969 =item B<MaxVersion> I<Value>
971 Only use this query for the specified database version. You can use these
972 options to provide multiple queries with the same name but with a slightly
973 different syntax. The plugin will use only those queries, where the specified
974 minimum and maximum versions fit the version of the database in use.
976 The database version is determined by C<dbi_conn_get_engine_version>, see the
977 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
978 for details. Basically, each part of the version is assumed to be in the range
979 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
980 "40102", version "5.0.42" becomes "50042".
982 B<Warning:> The plugin will use B<all> matching queries, so if you specify
983 multiple queries with the same name and B<overlapping> ranges, weird stuff will
984 happen. Don't to it! A valid example would be something along these lines:
995 In the above example, there are three ranges that don't overlap. The last one
996 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
997 before "4.0.0" are not specified.
999 =item B<Type> I<Type>
1001 The B<type> that's used for each line returned. See L<types.db(5)> for more
1002 details on how types are defined. In short: A type is a predefined layout of
1003 data and the number of values and type of values has to match the type
1006 If you specify "temperature" here, you need exactly one gauge column. If you
1007 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1010 There must be exactly one B<Type> option inside each B<Result> block.
1012 =item B<InstancePrefix> I<prefix>
1014 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1015 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1016 all strings returned in the appropriate columns are concatenated together,
1017 separated by dashes I<("-")>.
1019 =item B<InstancesFrom> I<column0> [I<column1> ...]
1021 Specifies the columns whose values will be used to create the "type-instance"
1022 for each row. If you specify more than one column, the value of all columns
1023 will be joined together with dashes I<("-")> as separation characters.
1025 The plugin itself does not check whether or not all built instances are
1026 different. It's your responsibility to assure that each is unique. This is
1027 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1028 sure that only one row is returned in this case.
1030 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1033 =item B<ValuesFrom> I<column0> [I<column1> ...]
1035 Names the columns whose content is used as the actual data for the data sets
1036 that are dispatched to the daemon. How many such columns you need is determined
1037 by the B<Type> setting above. If you specify too many or not enough columns,
1038 the plugin will complain about that and no data will be submitted to the
1041 The actual data type in the columns is not that important. The plugin will
1042 automatically cast the values to the right type if it know how to do that. So
1043 it should be able to handle integer an floating point types, as well as strings
1044 (if they include a number at the beginning).
1046 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1050 =head3 B<Database> blocks
1052 Database blocks define a connection to a database and which queries should be
1053 sent to that database. Since the used "dbi" library can handle a wide variety
1054 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1055 documentationE<nbsp>- we stick as close to the terminology used there.
1057 Each database needs a "name" as string argument in the starting tag of the
1058 block. This name will be used as "PluginInstance" in the values submitted to
1059 the daemon. Other than that, that name is not used.
1063 =item B<Driver> I<Driver>
1065 Specifies the driver to use to connect to the database. In many cases those
1066 drivers are named after the database they can connect to, but this is not a
1067 technical necessity. These drivers are sometimes referred to as "DBD",
1068 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1069 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1070 project at L<http://libdbi-drivers.sourceforge.net/>.
1072 You need to give the driver name as expected by the "dbi" library here. You
1073 should be able to find that in the documentation for each driver. If you
1074 mistype the driver name, the plugin will dump a list of all known driver names
1077 =item B<DriverOption> I<Key> I<Value>
1079 Sets driver-specific options. What option a driver supports can be found in the
1080 documentation for each driver, somewhere at
1081 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1082 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1084 Unfortunately, drivers are not too keen to report errors when an unknown option
1085 is passed to them, so invalid settings here may go unnoticed. This is not the
1086 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1087 the driver. If a driver complains about an option, the plugin will dump a
1088 complete list of all options understood by that driver to the log.
1090 =item B<SelectDB> I<Database>
1092 In some cases, the database name you connect with is not the database name you
1093 want to use for querying data. If this option is set, the plugin will "select"
1094 (switch to) that database after the connection is established.
1096 =item B<Query> I<QueryName>
1098 Associates the query named I<QueryName> with this database connection. The
1099 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1100 blocks you want to refer to must be placed above the database block you want to
1109 =item B<Device> I<Device>
1111 Select partitions based on the devicename.
1113 =item B<MountPoint> I<Directory>
1115 Select partitions based on the mountpoint.
1117 =item B<FSType> I<FSType>
1119 Select partitions based on the filesystem type.
1121 =item B<IgnoreSelected> B<true>|B<false>
1123 Invert the selection: If set to true, all partitions B<except> the ones that
1124 match any one of the criteria are collected. By default only selected
1125 partitions are collected if a selection is made. If no selection is configured
1126 at all, B<all> partitions are selected.
1128 =item B<ReportByDevice> B<true>|B<false>
1130 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1131 (the default), it will report a disk as "root", but with it I<true>, it will be
1132 "sda1" (or whichever).
1134 =item B<ReportInodes> B<true>|B<false>
1136 Enables or disables reporting of free, reserved and used inodes. Defaults to
1137 inode collection being disabled.
1139 Enable this option if inodes are a scarce resource for you, usually because
1140 many small files are stored on the disk. This is a usual scenario for mail
1141 transfer agents and web caches.
1145 =head2 Plugin C<disk>
1147 The C<disk> plugin collects information about the usage of physical disks and
1148 logical disks (partitions). Values collected are the number of octets written
1149 to and read from a disk or partition, the number of read/write operations
1150 issued to the disk and a rather complex "time" it took for these commands to be
1153 Using the following two options you can ignore some disks or configure the
1154 collection only of specific disks.
1158 =item B<Disk> I<Name>
1160 Select the disk I<Name>. Whether it is collected or ignored depends on the
1161 B<IgnoreSelected> setting, see below. As with other plugins that use the
1162 daemon's ignorelist functionality, a string that starts and ends with a slash
1163 is interpreted as a regular expression. Examples:
1168 =item B<IgnoreSelected> B<true>|B<false>
1170 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1171 statements, are ignored or if all other disks are ignored. The behavior
1172 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1173 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1174 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1175 is set to B<true>, all disks are collected B<except> the ones matched.
1179 =head2 Plugin C<dns>
1183 =item B<Interface> I<Interface>
1185 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1186 option sets the interface that should be used. If this option is not set, or
1187 set to "any", the plugin will try to get packets from B<all> interfaces. This
1188 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1190 =item B<IgnoreSource> I<IP-address>
1192 Ignore packets that originate from this address.
1194 =item B<SelectNumericQueryTypes> B<true>|B<false>
1196 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1200 =head2 Plugin C<email>
1204 =item B<SocketFile> I<Path>
1206 Sets the socket-file which is to be created.
1208 =item B<SocketGroup> I<Group>
1210 If running as root change the group of the UNIX-socket after it has been
1211 created. Defaults to B<collectd>.
1213 =item B<SocketPerms> I<Permissions>
1215 Change the file permissions of the UNIX-socket after it has been created. The
1216 permissions must be given as a numeric, octal value as you would pass to
1217 L<chmod(1)>. Defaults to B<0770>.
1219 =item B<MaxConns> I<Number>
1221 Sets the maximum number of connections that can be handled in parallel. Since
1222 this many threads will be started immediately setting this to a very high
1223 value will waste valuable resources. Defaults to B<5> and will be forced to be
1224 at most B<16384> to prevent typos and dumb mistakes.
1228 =head2 Plugin C<exec>
1230 Please make sure to read L<collectd-exec(5)> before using this plugin. It
1231 contains valuable information on when the executable is executed and the
1232 output that is expected from it.
1236 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1238 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1240 Execute the executable I<Executable> as user I<User>. If the user name is
1241 followed by a colon and a group name, the effective group is set to that group.
1242 The real group and saved-set group will be set to the default group of that
1243 user. If no group is given the effective group ID will be the same as the real
1246 Please note that in order to change the user and/or group the daemon needs
1247 superuser privileges. If the daemon is run as an unprivileged user you must
1248 specify the same user/group here. If the daemon is run with superuser
1249 privileges, you must supply a non-root user here.
1251 The executable may be followed by optional arguments that are passed to the
1252 program. Please note that due to the configuration parsing numbers and boolean
1253 values may be changed. If you want to be absolutely sure that something is
1254 passed as-is please enclose it in quotes.
1256 The B<Exec> and B<NotificationExec> statements change the semantics of the
1257 programs executed, i.E<nbsp>e. the data passed to them and the response
1258 expected from them. This is documented in great detail in L<collectd-exec(5)>.
1262 =head2 Plugin C<filecount>
1264 The C<filecount> plugin counts the number of files in a certain directory (and
1265 its subdirectories) and their combined size. The configuration is very straight
1268 <Plugin "filecount">
1269 <Directory "/var/qmail/queue/mess">
1270 Instance "qmail-message"
1272 <Directory "/var/qmail/queue/todo">
1273 Instance "qmail-todo"
1275 <Directory "/var/lib/php5">
1276 Instance "php5-sessions"
1281 The example above counts the number of files in QMail's queue directories and
1282 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
1283 QMail has not yet looked at, the "message" queue holds the messages that were
1284 classified into "local" and "remote".
1286 As you can see, the configuration consists of one or more C<Directory> blocks,
1287 each of which specifies a directory in which to count the files. Within those
1288 blocks, the following options are recognized:
1292 =item B<Instance> I<Instance>
1294 Sets the plugin instance to I<Instance>. That instance name must be unique, but
1295 it's your responsibility, the plugin doesn't check for that. If not given, the
1296 instance is set to the directory name with all slashes replaced by underscores
1297 and all leading underscores removed.
1299 =item B<Name> I<Pattern>
1301 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
1302 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
1303 against the pattern, not the entire path. In case this makes it easier for you:
1304 This option has been named after the B<-name> parameter to L<find(1)>.
1306 =item B<MTime> I<Age>
1308 Count only files of a specific age: If I<Age> is greater than zero, only files
1309 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
1310 a negative number, this is inversed. For example, if B<-60> is specified, only
1311 files that have been modified in the last minute will be counted.
1313 The number can also be followed by a "multiplier" to easily specify a larger
1314 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
1315 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
1316 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
1317 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
1318 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
1321 =item B<Size> I<Size>
1323 Count only files of a specific size. When I<Size> is a positive number, only
1324 files that are at least this big are counted. If I<Size> is a negative number,
1325 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
1326 I<Size> are counted.
1328 As with the B<MTime> option, a "multiplier" may be added. For a detailed
1329 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
1330 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
1331 note that there are 1000 bytes in a kilobyte, not 1024.
1333 =item B<Recursive> I<true>|I<false>
1335 Controls whether or not to recurse into subdirectories. Enabled by default.
1337 =item B<IncludeHidden> I<true>|I<false>
1339 Controls whether or not to include "hidden" files and directories in the count.
1340 "Hidden" files and directories are those, whose name begins with a dot.
1341 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
1345 =head2 Plugin C<GenericJMX>
1347 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
1348 L<collectd-java(5)>.
1350 =head2 Plugin C<gmond>
1352 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
1353 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
1354 are built-in, custom mappings may be added via B<Metric> blocks, see below.
1359 MCReceiveFrom "239.2.11.71" "8649"
1360 <Metric "swap_total">
1362 TypeInstance "total"
1365 <Metric "swap_free">
1372 The following metrics are built-in:
1378 load_one, load_five, load_fifteen
1382 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
1386 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
1398 Available configuration options:
1402 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
1404 Sets sets the multicast group and UDP port to which to subscribe.
1406 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
1408 =item E<lt>B<Metric> I<Name>E<gt>
1410 These blocks add a new metric conversion to the internal table. I<Name>, the
1411 string argument to the B<Metric> block, is the metric name as used by Ganglia.
1415 =item B<Type> I<Type>
1417 Type to map this metric to. Required.
1419 =item B<TypeInstance> I<Instance>
1421 Type-instance to use. Optional.
1423 =item B<DataSource> I<Name>
1425 Data source to map this metric to. If the configured type has exactly one data
1426 source, this is optional. Otherwise the option is required.
1432 =head2 Plugin C<hddtemp>
1434 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
1435 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
1436 default values, see below. C<hddtemp> has to be running to work correctly. If
1437 C<hddtemp> is not running timeouts may appear which may interfere with other
1440 The B<hddtemp> homepage can be found at
1441 L<http://www.guzu.net/linux/hddtemp.php>.
1445 =item B<Host> I<Hostname>
1447 Hostname to connect to. Defaults to B<127.0.0.1>.
1449 =item B<Port> I<Port>
1451 TCP-Port to connect to. Defaults to B<7634>.
1455 =head2 Plugin C<interface>
1459 =item B<Interface> I<Interface>
1461 Select this interface. By default these interfaces will then be collected. For
1462 a more detailed description see B<IgnoreSelected> below.
1464 =item B<IgnoreSelected> I<true>|I<false>
1466 If no configuration if given, the B<traffic>-plugin will collect data from
1467 all interfaces. This may not be practical, especially for loopback- and
1468 similar interfaces. Thus, you can use the B<Interface>-option to pick the
1469 interfaces you're interested in. Sometimes, however, it's easier/preferred
1470 to collect all interfaces I<except> a few ones. This option enables you to
1471 do that: By setting B<IgnoreSelected> to I<true> the effect of
1472 B<Interface> is inverted: All selected interfaces are ignored and all
1473 other interfaces are collected.
1477 =head2 Plugin C<ipmi>
1481 =item B<Sensor> I<Sensor>
1483 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
1485 =item B<IgnoreSelected> I<true>|I<false>
1487 If no configuration if given, the B<ipmi> plugin will collect data from all
1488 sensors found of type "temperature", "voltage", "current" and "fanspeed".
1489 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
1490 the effect of B<Sensor> is inverted: All selected sensors are ignored and
1491 all other sensors are collected.
1493 =item B<NotifySensorAdd> I<true>|I<false>
1495 If a sensor appears after initialization time of a minute a notification
1498 =item B<NotifySensorRemove> I<true>|I<false>
1500 If a sensor disappears a notification is sent.
1502 =item B<NotifySensorNotPresent> I<true>|I<false>
1504 If you have for example dual power supply and one of them is (un)plugged then
1505 a notification is sent.
1509 =head2 Plugin C<iptables>
1513 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
1515 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
1516 will collect the counters of all rules which have a comment-match. The comment
1517 is then used as type-instance.
1519 If I<Comment> or I<Number> is given, only the rule with the matching comment or
1520 the I<n>th rule will be collected. Again, the comment (or the number) will be
1521 used as the type-instance.
1523 If I<Name> is supplied, it will be used as the type-instance instead of the
1524 comment or the number.
1528 =head2 Plugin C<irq>
1534 Select this irq. By default these irqs will then be collected. For a more
1535 detailed description see B<IgnoreSelected> below.
1537 =item B<IgnoreSelected> I<true>|I<false>
1539 If no configuration if given, the B<irq>-plugin will collect data from all
1540 irqs. This may not be practical, especially if no interrupts happen. Thus, you
1541 can use the B<Irq>-option to pick the interrupt you're interested in.
1542 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
1543 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
1544 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
1545 and all other interrupts are collected.
1549 =head2 Plugin C<java>
1551 The I<Java> plugin makes it possible to write extensions for collectd in Java.
1552 This section only discusses the syntax and semantic of the configuration
1553 options. For more in-depth information on the I<Java> plugin, please read
1554 L<collectd-java(5)>.
1559 JVMArg "-verbose:jni"
1560 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
1561 LoadPlugin "org.collectd.java.Foobar"
1562 <Plugin "org.collectd.java.Foobar">
1563 # To be parsed by the plugin
1567 Available configuration options:
1571 =item B<JVMArg> I<Argument>
1573 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
1574 exactly the way the arguments to the I<java> binary on the command line work.
1575 Execute C<javaE<nbsp>--help> for details.
1577 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
1578 any other options! When another option is found, the JVM will be started and
1579 later options will have to be ignored!
1581 =item B<LoadPlugin> I<JavaClass>
1583 Instantiates a new I<JavaClass> object. The constructor of this object very
1584 likely then registers one or more callback methods with the server.
1586 See L<collectd-java(5)> for details.
1588 When the first such option is found, the virtual machine (JVM) is created. This
1589 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
1590 B<LoadPlugin> options!
1592 =item B<Plugin> I<Name>
1594 The entire block is passed to the Java plugin as an
1595 I<org.collectd.api.OConfigItem> object.
1597 For this to work, the plugin has to register a configuration callback first,
1598 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
1599 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
1600 depends on the (Java) plugin registering the callback and is completely
1601 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
1605 =head2 Plugin C<libvirt>
1607 This plugin allows CPU, disk and network load to be collected for virtualized
1608 guests on the machine. This means that these characteristics can be collected
1609 for guest systems without installing any software on them - collectd only runs
1610 on the hosting system. The statistics are collected through libvirt
1611 (L<http://libvirt.org/>).
1613 Only I<Connection> is required.
1617 =item B<Connection> I<uri>
1619 Connect to the hypervisor given by I<uri>. For example if using Xen use:
1621 Connection "xen:///"
1623 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
1625 =item B<RefreshInterval> I<seconds>
1627 Refresh the list of domains and devices every I<seconds>. The default is 60
1628 seconds. Setting this to be the same or smaller than the I<Interval> will cause
1629 the list of domains and devices to be refreshed on every iteration.
1631 Refreshing the devices in particular is quite a costly operation, so if your
1632 virtualization setup is static you might consider increasing this. If this
1633 option is set to 0, refreshing is disabled completely.
1635 =item B<Domain> I<name>
1637 =item B<BlockDevice> I<name:dev>
1639 =item B<InterfaceDevice> I<name:dev>
1641 =item B<IgnoreSelected> I<true>|I<false>
1643 Select which domains and devices are collected.
1645 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
1646 disk/network devices are collected.
1648 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
1649 domains and disk/network devices are ignored, while the rest are collected.
1651 The domain name and device names may use a regular expression, if the name is
1652 surrounded by I</.../> and collectd was compiled with support for regexps.
1654 The default is to collect statistics for all domains and all their devices.
1658 BlockDevice "/:hdb/"
1659 IgnoreSelected "true"
1661 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
1664 =item B<HostnameFormat> B<name|uuid|hostname|...>
1666 When the libvirt plugin logs data, it sets the hostname of the collected data
1667 according to this setting. The default is to use the guest name as provided by
1668 the hypervisor, which is equal to setting B<name>.
1670 B<uuid> means use the guest's UUID. This is useful if you want to track the
1671 same guest across migrations.
1673 B<hostname> means to use the global B<Hostname> setting, which is probably not
1674 useful on its own because all guests will appear to have the same name.
1676 You can also specify combinations of these fields. For example B<name uuid>
1677 means to concatenate the guest name and UUID (with a literal colon character
1678 between, thus I<"foo:1234-1234-1234-1234">).
1680 =item B<InterfaceFormat> B<name>|B<address>
1682 When the libvirt plugin logs interface data, it sets the name of the collected
1683 data according to this setting. The default is to use the path as provided by
1684 the hypervisor (the "dev" property of the target node), which is equal to
1687 B<address> means use the interface's mac address. This is useful since the
1688 interface path might change between reboots of a guest or across migrations.
1692 =head2 Plugin C<logfile>
1696 =item B<LogLevel> B<debug|info|notice|warning|err>
1698 Sets the log-level. If, for example, set to B<notice>, then all events with
1699 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
1701 Please note that B<debug> is only available if collectd has been compiled with
1704 =item B<File> I<File>
1706 Sets the file to write log messages to. The special strings B<stdout> and
1707 B<stderr> can be used to write to the standard output and standard error
1708 channels, respectively. This, of course, only makes much sense when collectd is
1709 running in foreground- or non-daemon-mode.
1711 =item B<Timestamp> B<true>|B<false>
1713 Prefix all lines printed by the current time. Defaults to B<true>.
1715 =item B<PrintSeverity> B<true>|B<false>
1717 When enabled, all lines are prefixed by the severity of the log message, for
1718 example "warning". Defaults to B<false>.
1722 B<Note>: There is no need to notify the daemon after moving or removing the
1723 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
1724 for each line it writes.
1726 =head2 Plugin C<mbmon>
1728 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
1730 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
1731 B<Host> and B<Port> options can be used to change these values, see below.
1732 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
1733 timeouts may appear which may interfere with other statistics..
1735 C<mbmon> must be run with the -r option ("print TAG and Value format");
1736 Debian's F</etc/init.d/mbmon> script already does this, other people
1737 will need to ensure that this is the case.
1741 =item B<Host> I<Hostname>
1743 Hostname to connect to. Defaults to B<127.0.0.1>.
1745 =item B<Port> I<Port>
1747 TCP-Port to connect to. Defaults to B<411>.
1751 =head2 Plugin C<memcachec>
1753 The C<memcachec plugin> connects to a memcached server, queries one or more
1754 given I<pages> and parses the returned data according to user specification.
1755 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
1758 In order to talk to the memcached server, this plugin uses the I<libmemcached>
1759 library. Please note that there is another library with a very similar name,
1760 libmemcache (notice the missing `d'), which is not applicable.
1762 Synopsis of the configuration:
1764 <Plugin "memcachec">
1765 <Page "plugin_instance">
1769 Regex "(\\d+) bytes sent"
1772 Instance "type_instance"
1777 The configuration options are:
1781 =item E<lt>B<Page> I<Name>E<gt>
1783 Each B<Page> block defines one I<page> to be queried from the memcached server.
1784 The block requires one string argument which is used as I<plugin instance>.
1786 =item B<Server> I<Address>
1788 Sets the server address to connect to when querying the page. Must be inside a
1793 When connected to the memcached server, asks for the page I<Key>.
1795 =item E<lt>B<Match>E<gt>
1797 Match blocks define which strings to look for and how matches substrings are
1798 interpreted. For a description of match blocks, please see L<"Plugin tail">.
1802 =head2 Plugin C<memcached>
1804 The C<memcached plugin> connects to a memcached server and queries statistics
1805 about cache utilization, memory and bandwidth used.
1806 L<http://www.danga.com/memcached/>
1810 =item B<Host> I<Hostname>
1812 Hostname to connect to. Defaults to B<127.0.0.1>.
1814 =item B<Port> I<Port>
1816 TCP-Port to connect to. Defaults to B<11211>.
1820 =head2 Plugin C<modbus>
1822 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
1823 register values. It supports reading single registers (unsigned 16E<nbsp>bit
1824 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
1825 values (two registers interpreted as IEEE floats in big endian notation).
1829 <Data "voltage-input-1">
1836 <Data "voltage-input-2">
1843 <Host "modbus.example.com">
1844 Address "192.168.0.42"
1849 Instance "power-supply"
1850 Collect "voltage-input-1"
1851 Collect "voltage-input-2"
1857 =item E<lt>B<Data> I<Name>E<gt> blocks
1859 Data blocks define a mapping between register numbers and the "types" used by
1862 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
1866 =item B<RegisterBase> I<Number>
1868 Configures the base register to read from the device. If the option
1869 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
1870 register will be read (the register number is increased by one).
1872 =item B<RegisterType> B<Uint16>|B<Uint32>|B<Float>
1874 Specifies what kind of data is returned by the device. If the type is B<Uint32>
1875 or B<Float>, two 16E<nbsp>bit registers will be read and the data is combined
1876 into one value. Defaults to B<Uint16>.
1878 =item B<Type> I<Type>
1880 Specifies the "type" (data set) to use when dispatching the value to
1881 I<collectd>. Currently, only data sets with exactly one data source are
1884 =item B<Instance> I<Instance>
1886 Sets the type instance to use when dispatching the value to I<collectd>. If
1887 unset, an empty string (no type instance) is used.
1891 =item E<lt>B<Host> I<Name>E<gt> blocks
1893 Host blocks are used to specify to which hosts to connect and what data to read
1894 from their "slaves". The string argument I<Name> is used as hostname when
1895 dispatching the values to I<collectd>.
1897 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
1901 =item B<Address> I<Hostname>
1903 Specifies the node name (the actual network address) used to connect to the
1904 host. This may be an IP address or a hostname. Please note that the used
1905 I<libmodbus> library only supports IPv4 at the moment.
1907 =item B<Port> I<Service>
1909 Specifies the port used to connect to the host. The port can either be given as
1910 a number or as a service name. Please note that the I<Service> argument must be
1911 a string, even if ports are given in their numerical form. Defaults to "502".
1913 =item B<Interval> I<Interval>
1915 Sets the interval (in seconds) in which the values will be collected from this
1916 host. By default the global B<Interval> setting will be used.
1918 =item E<lt>B<Slave> I<ID>E<gt>
1920 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
1921 is used to specify which device should be addressed. For each device you want
1922 to query, one B<Slave> block must be given.
1924 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
1928 =item B<Instance> I<Instance>
1930 Specify the plugin instance to use when dispatching the values to I<collectd>.
1931 By default "slave_I<ID>" is used.
1933 =item B<Collect> I<DataName>
1935 Specifies which data to retrieve from the device. I<DataName> must be the same
1936 string as the I<Name> argument passed to a B<Data> block. You can specify this
1937 option multiple times to collect more than one value from a slave. At least one
1938 B<Collect> option is mandatory.
1946 =head2 Plugin C<mysql>
1948 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
1949 one or more databases when started and keeps the connection up as long as
1950 possible. When the connection is interrupted for whatever reason it will try
1951 to re-connect. The plugin will complain loudly in case anything goes wrong.
1953 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
1954 and collects information about MySQL network traffic, executed statements,
1955 requests, the query cache and threads by evaluating the
1956 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
1957 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
1958 Status Variables> for an explanation of these values.
1960 Optionally, master and slave statistics may be collected in a MySQL
1961 replication setup. In that case, information about the synchronization state
1962 of the nodes are collected by evaluating the C<Position> return value of the
1963 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
1964 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
1965 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
1966 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
1967 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
1982 Socket "/var/run/mysql/mysqld.sock"
1984 SlaveNotifications true
1988 A B<Database> block defines one connection to a MySQL database. It accepts a
1989 single argument which specifies the name of the database. None of the other
1990 options are required. MySQL will use default values as documented in the
1991 section "mysql_real_connect()" in the B<MySQL reference manual>.
1995 =item B<Host> I<Hostname>
1997 Hostname of the database server. Defaults to B<localhost>.
1999 =item B<User> I<Username>
2001 Username to use when connecting to the database. The user does not have to be
2002 granted any privileges (which is synonym to granting the C<USAGE> privilege).
2003 Any existing MySQL user will do.
2005 =item B<Password> I<Password>
2007 Password needed to log into the database.
2009 =item B<Database> I<Database>
2011 Select this database. Defaults to I<no database> which is a perfectly reasonable
2012 option for what this plugin does.
2014 =item B<Port> I<Port>
2016 TCP-port to connect to. The port must be specified in its numeric form, but it
2017 must be passed as a string nonetheless. For example:
2021 If B<Host> is set to B<localhost> (the default), this setting has no effect.
2022 See the documentation for the C<mysql_real_connect> function for details.
2024 =item B<Socket> I<Socket>
2026 Specifies the path to the UNIX domain socket of the MySQL server. This option
2027 only has any effect, if B<Host> is set to B<localhost> (the default).
2028 Otherwise, use the B<Port> option above. See the documentation for the
2029 C<mysql_real_connect> function for details.
2031 =item B<MasterStats> I<true|false>
2033 =item B<SlaveStats> I<true|false>
2035 Enable the collection of master / slave statistics in a replication setup.
2037 =item B<SlaveNotifications> I<true|false>
2039 If enabled, the plugin sends a notification if the replication slave I/O and /
2040 or SQL threads are not running.
2044 =head2 Plugin C<netapp>
2046 The netapp plugin can collect various performance and capacity information
2047 from a NetApp filer using the NetApp API.
2049 Please note that NetApp has a wide line of products and a lot of different
2050 software versions for each of these products. This plugin was developed for a
2051 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
2052 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
2053 model and software version but it is very hard to test this.
2054 If you have used this plugin with other models and/or software version, feel
2055 free to send us a mail to tell us about the results, even if it's just a short
2058 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
2059 basic authentication.
2061 B<Do not use a regular user for this!> Create a special collectd user with just
2062 the minimum of capabilities needed. The user only needs the "login-http-admin"
2063 capability as well as a few more depending on which data will be collected.
2064 Required capabilities are documented below.
2069 <Host "netapp1.example.com">
2093 IgnoreSelectedIO false
2095 IgnoreSelectedOps false
2096 GetLatency "volume0"
2097 IgnoreSelectedLatency false
2104 IgnoreSelectedCapacity false
2107 IgnoreSelectedSnapshot false
2120 The netapp plugin accepts the following configuration options:
2124 =item B<Host> I<Name>
2126 A host block defines one NetApp filer. It will appear in collectd with the name
2127 you specify here which does not have to be its real name nor its hostname.
2129 =item B<Protocol> B<httpd>|B<http>
2131 The protocol collectd will use to query this host.
2139 Valid options: http, https
2141 =item B<Address> I<Address>
2143 The hostname or IP address of the host.
2149 Default: The "host" block's name.
2151 =item B<Port> I<Port>
2153 The TCP port to connect to on the host.
2159 Default: 80 for protocol "http", 443 for protocol "https"
2161 =item B<User> I<User>
2163 =item B<Password> I<Password>
2165 The username and password to use to login to the NetApp.
2171 =item B<Interval> I<Interval>
2177 The following options decide what kind of data will be collected. You can
2178 either use them as a block and fine tune various parameters inside this block,
2179 use them as a single statement to just accept all default values, or omit it to
2180 not collect any data.
2182 The following options are valid inside all blocks:
2186 =item B<Interval> I<Seconds>
2188 Collect the respective statistics every I<Seconds> seconds. Defaults to the
2189 host specific setting.
2193 =head3 The System block
2195 This will collect various performance data about the whole system.
2197 B<Note:> To get this data the collectd user needs the
2198 "api-perf-object-get-instances" capability.
2202 =item B<Interval> I<Seconds>
2204 Collect disk statistics every I<Seconds> seconds.
2206 =item B<GetCPULoad> B<true>|B<false>
2208 If you set this option to true the current CPU usage will be read. This will be
2209 the average usage between all CPUs in your NetApp without any information about
2212 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2213 returns in the "CPU" field.
2221 Result: Two value lists of type "cpu", and type instances "idle" and "system".
2223 =item B<GetInterfaces> B<true>|B<false>
2225 If you set this option to true the current traffic of the network interfaces
2226 will be read. This will be the total traffic over all interfaces of your NetApp
2227 without any information about individual interfaces.
2229 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2230 in the "Net kB/s" field.
2240 Result: One value list of type "if_octects".
2242 =item B<GetDiskIO> B<true>|B<false>
2244 If you set this option to true the current IO throughput will be read. This
2245 will be the total IO of your NetApp without any information about individual
2246 disks, volumes or aggregates.
2248 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2249 in the "DiskE<nbsp>kB/s" field.
2257 Result: One value list of type "disk_octets".
2259 =item B<GetDiskOps> B<true>|B<false>
2261 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
2262 iSCSI, etc. operations will be read. This will be the total number of
2263 operations on your NetApp without any information about individual volumes or
2266 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2267 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
2275 Result: A variable number of value lists of type "disk_ops_complex". Each type
2276 of operation will result in one value list with the name of the operation as
2281 =head3 The WAFL block
2283 This will collect various performance data about the WAFL file system. At the
2284 moment this just means cache performance.
2286 B<Note:> To get this data the collectd user needs the
2287 "api-perf-object-get-instances" capability.
2289 B<Note:> The interface to get these values is classified as "Diagnostics" by
2290 NetApp. This means that it is not guaranteed to be stable even between minor
2295 =item B<Interval> I<Seconds>
2297 Collect disk statistics every I<Seconds> seconds.
2299 =item B<GetNameCache> B<true>|B<false>
2307 Result: One value list of type "cache_ratio" and type instance
2310 =item B<GetDirCache> B<true>|B<false>
2318 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
2320 =item B<GetInodeCache> B<true>|B<false>
2328 Result: One value list of type "cache_ratio" and type instance
2331 =item B<GetBufferCache> B<true>|B<false>
2333 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
2334 in the "Cache hit" field.
2342 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
2346 =head3 The Disks block
2348 This will collect performance data about the individual disks in the NetApp.
2350 B<Note:> To get this data the collectd user needs the
2351 "api-perf-object-get-instances" capability.
2355 =item B<Interval> I<Seconds>
2357 Collect disk statistics every I<Seconds> seconds.
2359 =item B<GetBusy> B<true>|B<false>
2361 If you set this option to true the busy time of all disks will be calculated
2362 and the value of the busiest disk in the system will be written.
2364 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2365 in the "Disk util" field. Probably.
2373 Result: One value list of type "percent" and type instance "disk_busy".
2377 =head3 The VolumePerf block
2379 This will collect various performance data about the individual volumes.
2381 You can select which data to collect about which volume using the following
2382 options. They follow the standard ignorelist semantic.
2384 B<Note:> To get this data the collectd user needs the
2385 I<api-perf-object-get-instances> capability.
2389 =item B<Interval> I<Seconds>
2391 Collect volume performance data every I<Seconds> seconds.
2393 =item B<GetIO> I<Volume>
2395 =item B<GetOps> I<Volume>
2397 =item B<GetLatency> I<Volume>
2399 Select the given volume for IO, operations or latency statistics collection.
2400 The argument is the name of the volume without the C</vol/> prefix.
2402 Since the standard ignorelist functionality is used here, you can use a string
2403 starting and ending with a slash to specify regular expression matching: To
2404 match the volumes "vol0", "vol2" and "vol7", you can use this regular
2407 GetIO "/^vol[027]$/"
2409 If no regular expression is specified, an exact match is required. Both,
2410 regular and exact matching are case sensitive.
2412 If no volume was specified at all for either of the three options, that data
2413 will be collected for all available volumes.
2415 =item B<IgnoreSelectedIO> B<true>|B<false>
2417 =item B<IgnoreSelectedOps> B<true>|B<false>
2419 =item B<IgnoreSelectedLatency> B<true>|B<false>
2421 When set to B<true>, the volumes selected for IO, operations or latency
2422 statistics collection will be ignored and the data will be collected for all
2425 When set to B<false>, data will only be collected for the specified volumes and
2426 all other volumes will be ignored.
2428 If no volumes have been specified with the above B<Get*> options, all volumes
2429 will be collected regardless of the B<IgnoreSelected*> option.
2431 Defaults to B<false>
2435 =head3 The VolumeUsage block
2437 This will collect capacity data about the individual volumes.
2439 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
2444 =item B<Interval> I<Seconds>
2446 Collect volume usage statistics every I<Seconds> seconds.
2448 =item B<GetCapacity> I<VolumeName>
2450 The current capacity of the volume will be collected. This will result in two
2451 to four value lists, depending on the configuration of the volume. All data
2452 sources are of type "df_complex" with the name of the volume as
2455 There will be type_instances "used" and "free" for the number of used and
2456 available bytes on the volume. If the volume has some space reserved for
2457 snapshots, a type_instance "snap_reserved" will be available. If the volume
2458 has SIS enabled, a type_instance "sis_saved" will be available. This is the
2459 number of bytes saved by the SIS feature.
2461 B<Note:> The current NetApp API has a bug that results in this value being
2462 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
2463 number which works most of the time. If you see strange values here, bug
2464 NetApp support to fix this.
2466 Repeat this option to specify multiple volumes.
2468 =item B<IgnoreSelectedCapacity> B<true>|B<false>
2470 Specify whether to collect only the volumes selected by the B<GetCapacity>
2471 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
2472 B<false>. However, if no B<GetCapacity> option is specified at all, all
2473 capacities will be selected anyway.
2475 =item B<GetSnapshot> I<VolumeName>
2477 Select volumes from which to collect snapshot information.
2479 Usually, the space used for snapshots is included in the space reported as
2480 "used". If snapshot information is collected as well, the space used for
2481 snapshots is subtracted from the used space.
2483 To make things even more interesting, it is possible to reserve space to be
2484 used for snapshots. If the space required for snapshots is less than that
2485 reserved space, there is "reserved free" and "reserved used" space in addition
2486 to "free" and "used". If the space required for snapshots exceeds the reserved
2487 space, that part allocated in the normal space is subtracted from the "used"
2490 Repeat this option to specify multiple volumes.
2492 =item B<IgnoreSelectedSnapshot>
2494 Specify whether to collect only the volumes selected by the B<GetSnapshot>
2495 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
2496 B<false>. However, if no B<GetSnapshot> option is specified at all, all
2497 capacities will be selected anyway.
2501 =head2 Plugin C<netlink>
2503 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
2504 statistics of various interface and routing aspects.
2508 =item B<Interface> I<Interface>
2510 =item B<VerboseInterface> I<Interface>
2512 Instruct the plugin to collect interface statistics. This is basically the same
2513 as the statistics provided by the C<interface> plugin (see above) but
2514 potentially much more detailed.
2516 When configuring with B<Interface> only the basic statistics will be collected,
2517 namely octets, packets, and errors. These statistics are collected by
2518 the C<interface> plugin, too, so using both at the same time is no benefit.
2520 When configured with B<VerboseInterface> all counters B<except> the basic ones,
2521 so that no data needs to be collected twice if you use the C<interface> plugin.
2522 This includes dropped packets, received multicast packets, collisions and a
2523 whole zoo of differentiated RX and TX errors. You can try the following command
2524 to get an idea of what awaits you:
2528 If I<Interface> is B<All>, all interfaces will be selected.
2530 =item B<QDisc> I<Interface> [I<QDisc>]
2532 =item B<Class> I<Interface> [I<Class>]
2534 =item B<Filter> I<Interface> [I<Filter>]
2536 Collect the octets and packets that pass a certain qdisc, class or filter.
2538 QDiscs and classes are identified by their type and handle (or classid).
2539 Filters don't necessarily have a handle, therefore the parent's handle is used.
2540 The notation used in collectd differs from that used in tc(1) in that it
2541 doesn't skip the major or minor number if it's zero and doesn't print special
2542 ids by their name. So, for example, a qdisc may be identified by
2543 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
2544 thus not displayed by tc(1).
2546 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
2547 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
2548 associated with that interface will be collected.
2550 Since a filter itself doesn't necessarily have a handle, the parent's handle is
2551 used. This may lead to problems when more than one filter is attached to a
2552 qdisc or class. This isn't nice, but we don't know how this could be done any
2553 better. If you have a idea, please don't hesitate to tell us.
2555 As with the B<Interface> option you can specify B<All> as the interface,
2556 meaning all interfaces.
2558 Here are some examples to help you understand the above text more easily:
2561 VerboseInterface "All"
2562 QDisc "eth0" "pfifo_fast-1:0"
2564 Class "ppp0" "htb-1:10"
2565 Filter "ppp0" "u32-1:0"
2568 =item B<IgnoreSelected>
2570 The behavior is the same as with all other similar plugins: If nothing is
2571 selected at all, everything is collected. If some things are selected using the
2572 options described above, only these statistics are collected. If you set
2573 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
2574 specified statistics will not be collected.
2578 =head2 Plugin C<network>
2580 The Network plugin sends data to a remote instance of collectd, receives data
2581 from a remote instance, or both at the same time. Data which has been received
2582 from the network is usually not transmitted again, but this can be activated, see
2583 the B<Forward> option below.
2585 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
2586 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
2588 Both, B<Server> and B<Listen> can be used as single option or as block. When
2589 used as block, given options are valid for this socket only. For example:
2592 Server "collectd.internal.tld"
2593 <Server "collectd.external.tld">
2594 SecurityLevel "sign"
2595 Username "myhostname"
2602 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
2604 The B<Server> statement/block sets the server to send datagrams to. The
2605 statement may occur multiple times to send each datagram to multiple
2608 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
2609 optional second argument specifies a port number or a service name. If not
2610 given, the default, B<25826>, is used.
2612 The following options are recognized within B<Server> blocks:
2616 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
2618 Set the security you require for network communication. When the security level
2619 has been set to B<Encrypt>, data sent over the network will be encrypted using
2620 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
2621 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
2622 authentication code. When set to B<None>, data is sent without any security.
2624 This feature is only available if the I<network> plugin was linked with
2627 =item B<Username> I<Username>
2629 Sets the username to transmit. This is used by the server to lookup the
2630 password. See B<AuthFile> below. All security levels except B<None> require
2633 This feature is only available if the I<network> plugin was linked with
2636 =item B<Password> I<Password>
2638 Sets a password (shared secret) for this socket. All security levels except
2639 B<None> require this setting.
2641 This feature is only available if the I<network> plugin was linked with
2644 =item B<Interface> I<Interface name>
2646 Set the outgoing interface for IP packets. This applies at least
2647 to IPv6 packets and if possible to IPv4. If this option is not applicable,
2648 undefined or a non-existent interface name is specified, the default
2649 behavior is to let the kernel choose the appropriate interface. Be warned
2650 that the manual selection of an interface for unicast traffic is only
2651 necessary in rare cases.
2655 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
2657 The B<Listen> statement sets the interfaces to bind to. When multiple
2658 statements are found the daemon will bind to multiple interfaces.
2660 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
2661 the argument is a multicast address the daemon will join that multicast group.
2662 The optional second argument specifies a port number or a service name. If not
2663 given, the default, B<25826>, is used.
2665 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
2669 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
2671 Set the security you require for network communication. When the security level
2672 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
2673 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
2674 signed and encrypted data is accepted. When set to B<None>, all data will be
2675 accepted. If an B<AuthFile> option was given (see below), encrypted data is
2676 decrypted if possible.
2678 This feature is only available if the I<network> plugin was linked with
2681 =item B<AuthFile> I<Filename>
2683 Sets a file in which usernames are mapped to passwords. These passwords are
2684 used to verify signatures and to decrypt encrypted network packets. If
2685 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
2686 verified and encrypted packets are decrypted. Otherwise, signed data is
2687 accepted without checking the signature and encrypted data cannot be decrypted.
2688 For the other security levels this option is mandatory.
2690 The file format is very simple: Each line consists of a username followed by a
2691 colon and any number of spaces followed by the password. To demonstrate, an
2692 example file could look like this:
2697 Each time a packet is received, the modification time of the file is checked
2698 using L<stat(2)>. If the file has been changed, the contents is re-read. While
2699 the file is being read, it is locked using L<fcntl(2)>.
2701 =item B<Interface> I<Interface name>
2703 Set the incoming interface for IP packets explicitly. This applies at least
2704 to IPv6 packets and if possible to IPv4. If this option is not applicable,
2705 undefined or a non-existent interface name is specified, the default
2706 behavior is, to let the kernel choose the appropriate interface. Thus incoming
2707 traffic gets only accepted, if it arrives on the given interface.
2711 =item B<TimeToLive> I<1-255>
2713 Set the time-to-live of sent packets. This applies to all, unicast and
2714 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
2715 That means that multicast packets will be sent with a TTL of C<1> (one) on most
2718 =item B<MaxPacketSize> I<1024-65535>
2720 Set the maximum size for datagrams received over the network. Packets larger
2721 than this will be truncated.
2723 =item B<Forward> I<true|false>
2725 If set to I<true>, write packets that were received via the network plugin to
2726 the sending sockets. This should only be activated when the B<Listen>- and
2727 B<Server>-statements differ. Otherwise packets may be send multiple times to
2728 the same multicast group. While this results in more network traffic than
2729 necessary it's not a huge problem since the plugin has a duplicate detection,
2730 so the values will not loop.
2732 =item B<ReportStats> B<true>|B<false>
2734 The network plugin cannot only receive and send statistics, it can also create
2735 statistics about itself. Collected data included the number of received and
2736 sent octets and packets, the length of the receive queue and the number of
2737 values handled. When set to B<true>, the I<Network plugin> will make these
2738 statistics available. Defaults to B<false>.
2742 =head2 Plugin C<nginx>
2744 This plugin collects the number of connections and requests handled by the
2745 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
2746 queries the page provided by the C<ngx_http_stub_status_module> module, which
2747 isn't compiled by default. Please refer to
2748 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
2749 how to compile and configure nginx and this module.
2751 The following options are accepted by the C<nginx plugin>:
2755 =item B<URL> I<http://host/nginx_status>
2757 Sets the URL of the C<ngx_http_stub_status_module> output.
2759 =item B<User> I<Username>
2761 Optional user name needed for authentication.
2763 =item B<Password> I<Password>
2765 Optional password needed for authentication.
2767 =item B<VerifyPeer> B<true|false>
2769 Enable or disable peer SSL certificate verification. See
2770 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
2772 =item B<VerifyHost> B<true|false>
2774 Enable or disable peer host name verification. If enabled, the plugin checks
2775 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
2776 certificate matches the host name provided by the B<URL> option. If this
2777 identity check fails, the connection is aborted. Obviously, only works when
2778 connecting to a SSL enabled server. Enabled by default.
2780 =item B<CACert> I<File>
2782 File that holds one or more SSL certificates. If you want to use HTTPS you will
2783 possibly need this option. What CA certificates come bundled with C<libcurl>
2784 and are checked by default depends on the distribution you use.
2788 =head2 Plugin C<notify_desktop>
2790 This plugin sends a desktop notification to a notification daemon, as defined
2791 in the Desktop Notification Specification. To actually display the
2792 notifications, B<notification-daemon> is required and B<collectd> has to be
2793 able to access the X server.
2795 The Desktop Notification Specification can be found at
2796 L<http://www.galago-project.org/specs/notification/>.
2800 =item B<OkayTimeout> I<timeout>
2802 =item B<WarningTimeout> I<timeout>
2804 =item B<FailureTimeout> I<timeout>
2806 Set the I<timeout>, in milliseconds, after which to expire the notification
2807 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
2808 been specified, the displayed notification will not be closed at all - the
2809 user has to do so herself. These options default to 5000. If a negative number
2810 has been specified, the default is used as well.
2814 =head2 Plugin C<notify_email>
2816 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
2817 configured email address.
2819 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
2821 Available configuration options:
2825 =item B<From> I<Address>
2827 Email address from which the emails should appear to come from.
2829 Default: C<root@localhost>
2831 =item B<Recipient> I<Address>
2833 Configures the email address(es) to which the notifications should be mailed.
2834 May be repeated to send notifications to multiple addresses.
2836 At least one B<Recipient> must be present for the plugin to work correctly.
2838 =item B<SMTPServer> I<Hostname>
2840 Hostname of the SMTP server to connect to.
2842 Default: C<localhost>
2844 =item B<SMTPPort> I<Port>
2846 TCP port to connect to.
2850 =item B<SMTPUser> I<Username>
2852 Username for ASMTP authentication. Optional.
2854 =item B<SMTPPassword> I<Password>
2856 Password for ASMTP authentication. Optional.
2858 =item B<Subject> I<Subject>
2860 Subject-template to use when sending emails. There must be exactly two
2861 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
2862 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
2865 Default: C<Collectd notify: %s@%s>
2869 =head2 Plugin C<ntpd>
2873 =item B<Host> I<Hostname>
2875 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
2877 =item B<Port> I<Port>
2879 UDP-Port to connect to. Defaults to B<123>.
2881 =item B<ReverseLookups> B<true>|B<false>
2883 Sets whether or not to perform reverse lookups on peers. Since the name or
2884 IP-address may be used in a filename it is recommended to disable reverse
2885 lookups. The default is to do reverse lookups to preserve backwards
2886 compatibility, though.
2890 =head2 Plugin C<nut>
2894 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
2896 Add a UPS to collect data from. The format is identical to the one accepted by
2901 =head2 Plugin C<olsrd>
2903 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
2904 the Optimized Link State Routing daemon and reads information about the current
2905 state of the meshed network.
2907 The following configuration options are understood:
2911 =item B<Host> I<Host>
2913 Connect to I<Host>. Defaults to B<"localhost">.
2915 =item B<Port> I<Port>
2917 Specifies the port to connect to. This must be a string, even if you give the
2918 port as a number rather than a service name. Defaults to B<"2006">.
2920 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
2922 Specifies what information to collect about links, i.E<nbsp>e. direct
2923 connections of the daemon queried. If set to B<No>, no information is
2924 collected. If set to B<Summary>, the number of links and the average of all
2925 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
2926 If set to B<Detail> LQ and NLQ are collected per link.
2928 Defaults to B<Detail>.
2930 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
2932 Specifies what information to collect about routes of the daemon queried. If
2933 set to B<No>, no information is collected. If set to B<Summary>, the number of
2934 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
2935 metric and ETX are collected per route.
2937 Defaults to B<Summary>.
2939 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
2941 Specifies what information to collect about the global topology. If set to
2942 B<No>, no information is collected. If set to B<Summary>, the number of links
2943 in the entire topology and the average I<link quality> (LQ) is calculated.
2944 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
2946 Defaults to B<Summary>.
2950 =head2 Plugin C<onewire>
2952 B<EXPERIMENTAL!> See notes below.
2954 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
2955 L<http://owfs.org/> to read sensors connected via the onewire bus.
2957 Currently only temperature sensors (sensors with the family code C<10>,
2958 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
2959 would like to have included, please send a sort request to the mailing list.
2961 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
2962 experimental, below.
2966 =item B<Device> I<Device>
2968 Sets the device to read the values from. This can either be a "real" hardware
2969 device, such as a serial port or an USB port, or the address of the
2970 L<owserver(1)> socket, usually B<localhost:4304>.
2972 Though the documentation claims to automatically recognize the given address
2973 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
2974 with that version, the following configuration worked for us:
2977 Device "-s localhost:4304"
2980 This directive is B<required> and does not have a default value.
2982 =item B<Sensor> I<Sensor>
2984 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
2985 below. Sensors are specified without the family byte at the beginning, to you'd
2986 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
2989 =item B<IgnoreSelected> I<true>|I<false>
2991 If no configuration if given, the B<onewire> plugin will collect data from all
2992 sensors found. This may not be practical, especially if sensors are added and
2993 removed regularly. Sometimes, however, it's easier/preferred to collect only
2994 specific sensors or all sensors I<except> a few specified ones. This option
2995 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
2996 B<Sensor> is inverted: All selected interfaces are ignored and all other
2997 interfaces are collected.
2999 =item B<Interval> I<Seconds>
3001 Sets the interval in which all sensors should be read. If not specified, the
3002 global B<Interval> setting is used.
3006 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
3007 work with big setups. It works with one sensor being attached to one
3008 controller, but as soon as you throw in a couple more senors and maybe a hub
3009 or two, reading all values will take more than ten seconds (the default
3010 interval). We will probably add some separate thread for reading the sensors
3011 and some cache or something like that, but it's not done yet. We will try to
3012 maintain backwards compatibility in the future, but we can't promise. So in
3013 short: If it works for you: Great! But keep in mind that the config I<might>
3014 change, though this is unlikely. Oh, and if you want to help improving this
3015 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
3017 =head2 Plugin C<openvpn>
3019 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
3020 traffic statistics about connected clients.
3022 To set up OpenVPN to write to the status file periodically, use the
3023 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
3024 you need to set the required format, too. This is done by setting
3025 B<--status-version> to B<2>.
3027 So, in a nutshell you need:
3029 openvpn $OTHER_OPTIONS \
3030 --status "/var/run/openvpn-status" 10 \
3037 =item B<StatusFile> I<File>
3039 Specifies the location of the status file.
3041 =item B<ImprovedNamingSchema> B<true>|B<false>
3043 When enabled, the filename of the status file will be used as plugin instance
3044 and the client's "common name" will be used as type instance. This is required
3045 when reading multiple status files. Enabling this option is recommended, but to
3046 maintain backwards compatibility this option is disabled by default.
3048 =item B<CollectCompression> B<true>|B<false>
3050 Sets whether or not statistics about the compression used by OpenVPN should be
3051 collected. This information is only available in I<single> mode. Enabled by
3054 =item B<CollectIndividualUsers> B<true>|B<false>
3056 Sets whether or not traffic information is collected for each connected client
3057 individually. If set to false, currently no traffic data is collected at all
3058 because aggregating this data in a save manner is tricky. Defaults to B<true>.
3060 =item B<CollectUserCount> B<true>|B<false>
3062 When enabled, the number of currently connected clients or users is collected.
3063 This is especially interesting when B<CollectIndividualUsers> is disabled, but
3064 can be configured independently from that option. Defaults to B<false>.
3068 =head2 Plugin C<oracle>
3070 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
3071 Oracle® Database and lets you execute SQL statements there. It is very similar
3072 to the "dbi" plugin, because it was written around the same time. See the "dbi"
3073 plugin's documentation above for details.
3076 <Query "out_of_stock">
3077 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
3080 # InstancePrefix "foo"
3081 InstancesFrom "category"
3085 <Database "product_information">
3089 Query "out_of_stock"
3093 =head3 B<Query> blocks
3095 The Query blocks are handled identically to the Query blocks of the "dbi"
3096 plugin. Please see its documentation above for details on how to specify
3099 =head3 B<Database> blocks
3101 Database blocks define a connection to a database and which queries should be
3102 sent to that database. Each database needs a "name" as string argument in the
3103 starting tag of the block. This name will be used as "PluginInstance" in the
3104 values submitted to the daemon. Other than that, that name is not used.
3108 =item B<ConnectID> I<ID>
3110 Defines the "database alias" or "service name" to connect to. Usually, these
3111 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
3113 =item B<Username> I<Username>
3115 Username used for authentication.
3117 =item B<Password> I<Password>
3119 Password used for authentication.
3121 =item B<Query> I<QueryName>
3123 Associates the query named I<QueryName> with this database connection. The
3124 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
3125 blocks you want to refer to must be placed above the database block you want to
3130 =head2 Plugin C<perl>
3132 This plugin embeds a Perl-interpreter into collectd and provides an interface
3133 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
3135 =head2 Plugin C<pinba>
3137 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
3138 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
3139 PHP-based webpage has been delivered, the extension will send a UDP packet
3140 containing timing information, peak memory usage and so on. The plugin will
3141 wait for such packets, parse them and account the provided information, which
3142 is then dispatched to the daemon once per interval.
3149 # Overall statistics for the website.
3151 Server "www.example.com"
3153 # Statistics for www-a only
3155 Host "www-a.example.com"
3156 Server "www.example.com"
3158 # Statistics for www-b only
3160 Host "www-b.example.com"
3161 Server "www.example.com"
3165 The plugin provides the following configuration options:
3169 =item B<Address> I<Node>
3171 Configures the address used to open a listening socket. By default, plugin will
3172 bind to the I<any> address C<::0>.
3174 =item B<Port> I<Service>
3176 Configures the port (service) to bind to. By default the default Pinba port
3177 "30002" will be used. The option accepts service names in addition to port
3178 numbers and thus requires a I<string> argument.
3180 =item E<lt>B<View> I<Name>E<gt> block
3182 The packets sent by the Pinba extension include the hostname of the server, the
3183 server name (the name of the virtual host) and the script that was executed.
3184 Using B<View> blocks it is possible to separate the data into multiple groups
3185 to get more meaningful statistics. Each packet is added to all matching groups,
3186 so that a packet may be accounted for more than once.
3190 =item B<Host> I<Host>
3192 Matches the hostname of the system the webserver / script is running on. This
3193 will contain the result of the L<gethostname(2)> system call. If not
3194 configured, all hostnames will be accepted.
3196 =item B<Server> I<Server>
3198 Matches the name of the I<virtual host>, i.e. the contents of the
3199 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
3200 server names will be accepted.
3202 =item B<Script> I<Script>
3204 Matches the name of the I<script name>, i.e. the contents of the
3205 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
3206 script names will be accepted.
3212 =head2 Plugin C<ping>
3214 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
3215 configured hosts periodically and measures the network latency. Whenever the
3216 C<read> function of the plugin is called, it submits the average latency, the
3217 standard deviation and the drop rate for each host.
3219 Available configuration options:
3223 =item B<Host> I<IP-address>
3225 Host to ping periodically. This option may be repeated several times to ping
3228 =item B<Interval> I<Seconds>
3230 Sets the interval in which to send ICMP echo packets to the configured hosts.
3231 This is B<not> the interval in which statistics are queries from the plugin but
3232 the interval in which the hosts are "pinged". Therefore, the setting here
3233 should be smaller than or equal to the global B<Interval> setting. Fractional
3234 times, such as "1.24" are allowed.
3238 =item B<Timeout> I<Seconds>
3240 Time to wait for a response from the host to which an ICMP packet had been
3241 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
3242 to be down or the packet to be dropped. This setting must be smaller than the
3243 B<Interval> setting above for the plugin to work correctly. Fractional
3244 arguments are accepted.
3248 =item B<TTL> I<0-255>
3250 Sets the Time-To-Live of generated ICMP packets.
3252 =item B<SourceAddress> I<host>
3254 Sets the source address to use. I<host> may either be a numerical network
3255 address or a network hostname.
3257 =item B<Device> I<name>
3259 Sets the outgoing network device to be used. I<name> has to specify an
3260 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
3263 =item B<MaxMissed> I<Packets>
3265 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
3266 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
3268 Default: B<-1> (disabled)
3272 =head2 Plugin C<postgresql>
3274 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
3275 keeps a persistent connection to all configured databases and tries to
3276 reconnect if the connection has been interrupted. A database is configured by
3277 specifying a B<Database> block as described below. The default statistics are
3278 collected from PostgreSQL's B<statistics collector> which thus has to be
3279 enabled for this plugin to work correctly. This should usually be the case by
3280 default. See the section "The Statistics Collector" of the B<PostgreSQL
3281 Documentation> for details.
3283 By specifying custom database queries using a B<Query> block as described
3284 below, you may collect any data that is available from some PostgreSQL
3285 database. This way, you are able to access statistics of external daemons
3286 which are available in a PostgreSQL database or use future or special
3287 statistics provided by PostgreSQL without the need to upgrade your collectd
3290 The B<PostgreSQL Documentation> manual can be found at
3291 L<http://www.postgresql.org/docs/manuals/>.
3295 Statement "SELECT magic FROM wizard WHERE host = $1;"
3299 InstancePrefix "magic"
3304 <Query rt36_tickets>
3305 Statement "SELECT COUNT(type) AS count, type \
3307 WHEN resolved = 'epoch' THEN 'open' \
3308 ELSE 'resolved' END AS type \
3309 FROM tickets) type \
3313 InstancePrefix "rt36_tickets"
3314 InstancesFrom "type"
3325 KRBSrvName "kerberos_service_name"
3331 Service "service_name"
3332 Query backend # predefined
3337 The B<Query> block defines one database query which may later be used by a
3338 database definition. It accepts a single mandatory argument which specifies
3339 the name of the query. The names of all queries have to be unique (see the
3340 B<MinVersion> and B<MaxVersion> options below for an exception to this
3341 rule). The following configuration options are available to define the query:
3343 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
3344 blocks define how to handle the values returned from the query. They define
3345 which column holds which value and how to dispatch that value to the daemon.
3346 Multiple B<Result> blocks may be used to extract multiple values from a single
3351 =item B<Statement> I<sql query statement>
3353 Specify the I<sql query statement> which the plugin should execute. The string
3354 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
3355 first, second, etc. parameter. The value of the parameters is specified by the
3356 B<Param> configuration option - see below for details. To include a literal
3357 B<$> character followed by a number, surround it with single quotes (B<'>).
3359 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
3360 allowed. Note, however, that only a single command may be used. Semicolons are
3361 allowed as long as a single non-empty command has been specified only.
3363 The returned lines will be handled separately one after another.
3365 =item B<Query> I<sql query statement>
3367 This is a deprecated synonym for B<Statement>. It will be removed in version 5
3370 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
3372 Specify the parameters which should be passed to the SQL query. The parameters
3373 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
3374 they appear in the configuration file. The value of the parameter is
3375 determined depending on the value of the B<Param> option as follows:
3381 The configured hostname of the database connection. If a UNIX domain socket is
3382 used, the parameter expands to "localhost".
3386 The name of the database of the current connection.
3390 The username used to connect to the database.
3394 The interval with which this database is queried (as specified by the database
3395 specific or global B<Interval> options).
3399 Please note that parameters are only supported by PostgreSQL's protocol
3400 version 3 and above which was introduced in version 7.4 of PostgreSQL.
3402 =item B<Type> I<type>
3404 The I<type> name to be used when dispatching the values. The type describes
3405 how to handle the data and where to store it. See L<types.db(5)> for more
3406 details on types and their configuration. The number and type of values (as
3407 selected by the B<ValuesFrom> option) has to match the type of the given name.
3409 This option is required inside a B<Result> block.
3411 =item B<InstancePrefix> I<prefix>
3413 =item B<InstancesFrom> I<column0> [I<column1> ...]
3415 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
3416 B<InstancePrefix> defines a static prefix that will be prepended to all type
3417 instances. B<InstancesFrom> defines the column names whose values will be used
3418 to create the type instance. Multiple values will be joined together using the
3419 hyphen (C<->) as separation character.
3421 The plugin itself does not check whether or not all built instances are
3422 different. It is your responsibility to assure that each is unique.
3424 Both options are optional. If none is specified, the type instance will be
3427 =item B<ValuesFrom> I<column0> [I<column1> ...]
3429 Names the columns whose content is used as the actual data for the data sets
3430 that are dispatched to the daemon. How many such columns you need is
3431 determined by the B<Type> setting as explained above. If you specify too many
3432 or not enough columns, the plugin will complain about that and no data will be
3433 submitted to the daemon.
3435 The actual data type, as seen by PostgreSQL, is not that important as long as
3436 it represents numbers. The plugin will automatically cast the values to the
3437 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
3438 L<strtod(3)> functions, so anything supported by those functions is supported
3439 by the plugin as well.
3441 This option is required inside a B<Result> block and may be specified multiple
3442 times. If multiple B<ValuesFrom> options are specified, the columns are read
3445 =item B<Column> I<type> [I<type instance>]
3447 This is a deprecated alternative to a B<Result> block. It will be removed in
3448 version 5 of collectd. It is equivalent to the following B<Result> block:
3452 InstancePrefix I<type instance>
3453 ValuesFrom I<name of the x. column>
3456 The order of the B<Column> options defines which columns of the query result
3457 should be used. The first option specifies the data found in the first column,
3458 the second option that of the second column, and so on.
3460 =item B<MinVersion> I<version>
3462 =item B<MaxVersion> I<version>
3464 Specify the minimum or maximum version of PostgreSQL that this query should be
3465 used with. Some statistics might only be available with certain versions of
3466 PostgreSQL. This allows you to specify multiple queries with the same name but
3467 which apply to different versions, thus allowing you to use the same
3468 configuration in a heterogeneous environment.
3470 The I<version> has to be specified as the concatenation of the major, minor
3471 and patch-level versions, each represented as two-decimal-digit numbers. For
3472 example, version 8.2.3 will become 80203.
3474 =item B<MinPGVersion> I<version>
3476 =item B<MaxPGVersion> I<version>
3478 These are deprecated synonyms for B<MinVersion> and B<MaxVersion>
3479 respectively. They will be removed in version 5 of collectd.
3483 The following predefined queries are available (the definitions can be found
3484 in the F<postgresql_default.conf> file which, by default, is available at
3485 C<I<prefix>/share/collectd/>):
3491 This query collects the number of backends, i.E<nbsp>e. the number of
3494 =item B<transactions>
3496 This query collects the numbers of committed and rolled-back transactions of
3501 This query collects the numbers of various table modifications (i.E<nbsp>e.
3502 insertions, updates, deletions) of the user tables.
3504 =item B<query_plans>
3506 This query collects the numbers of various table scans and returned tuples of
3509 =item B<table_states>
3511 This query collects the numbers of live and dead rows in the user tables.
3515 This query collects disk block access counts for user tables.
3519 This query collects the on-disk size of the database in bytes.
3523 The B<Database> block defines one PostgreSQL database for which to collect
3524 statistics. It accepts a single mandatory argument which specifies the
3525 database name. None of the other options are required. PostgreSQL will use
3526 default values as documented in the section "CONNECTING TO A DATABASE" in the
3527 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
3528 the user collectd is run as and special environment variables. See the manpage
3533 =item B<Interval> I<seconds>
3535 Specify the interval with which the database should be queried. The default is
3536 to use the global B<Interval> setting.
3538 =item B<Host> I<hostname>
3540 Specify the hostname or IP of the PostgreSQL server to connect to. If the
3541 value begins with a slash, it is interpreted as the directory name in which to
3542 look for the UNIX domain socket.
3544 This option is also used to determine the hostname that is associated with a
3545 collected data set. If it has been omitted or either begins with with a slash
3546 or equals B<localhost> it will be replaced with the global hostname definition
3547 of collectd. Any other value will be passed literally to collectd when
3548 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
3550 =item B<Port> I<port>
3552 Specify the TCP port or the local UNIX domain socket file extension of the
3555 =item B<User> I<username>
3557 Specify the username to be used when connecting to the server.
3559 =item B<Password> I<password>
3561 Specify the password to be used when connecting to the server.
3563 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
3565 Specify whether to use an SSL connection when contacting the server. The
3566 following modes are supported:
3572 Do not use SSL at all.
3576 First, try to connect without using SSL. If that fails, try using SSL.
3578 =item I<prefer> (default)
3580 First, try to connect using SSL. If that fails, try without using SSL.
3588 =item B<KRBSrvName> I<kerberos_service_name>
3590 Specify the Kerberos service name to use when authenticating with Kerberos 5
3591 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
3592 B<PostgreSQL Documentation> for details.
3594 =item B<Service> I<service_name>
3596 Specify the PostgreSQL service name to use for additional parameters. That
3597 service has to be defined in F<pg_service.conf> and holds additional
3598 connection parameters. See the section "The Connection Service File" in the
3599 B<PostgreSQL Documentation> for details.
3601 =item B<Query> I<query>
3603 Specify a I<query> which should be executed for the database connection. This
3604 may be any of the predefined or user-defined queries. If no such option is
3605 given, it defaults to "backends", "transactions", "queries", "query_plans",
3606 "table_states", "disk_io" and "disk_usage". Else, the specified queries are
3611 =head2 Plugin C<powerdns>
3613 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
3614 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
3615 values, many of which are probably meaningless to most users, but may be useful
3616 for some. So you may chose which values to collect, but if you don't, some
3617 reasonable defaults will be collected.
3620 <Server "server_name">
3622 Collect "udp-answers" "udp-queries"
3623 Socket "/var/run/pdns.controlsocket"
3625 <Recursor "recursor_name">
3627 Collect "cache-hits" "cache-misses"
3628 Socket "/var/run/pdns_recursor.controlsocket"
3630 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
3635 =item B<Server> and B<Recursor> block
3637 The B<Server> block defines one authoritative server to query, the B<Recursor>
3638 does the same for an recursing server. The possible options in both blocks are
3639 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
3644 =item B<Collect> I<Field>
3646 Using the B<Collect> statement you can select which values to collect. Here,
3647 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
3648 C<dlg-only-drops>, C<answers10-100>.
3650 The method of getting the values differs for B<Server> and B<Recursor> blocks:
3651 When querying the server a C<SHOW *> command is issued in any case, because
3652 that's the only way of getting multiple values out of the server at once.
3653 collectd then picks out the values you have selected. When querying the
3654 recursor, a command is generated to query exactly these values. So if you
3655 specify invalid fields when querying the recursor, a syntax error may be
3656 returned by the daemon and collectd may not collect any values at all.
3658 If no B<Collect> statement is given, the following B<Server> values will be
3665 =item packetcache-hit
3667 =item packetcache-miss
3669 =item packetcache-size
3671 =item query-cache-hit
3673 =item query-cache-miss
3675 =item recursing-answers
3677 =item recursing-questions
3689 The following B<Recursor> values will be collected by default:
3693 =item noerror-answers
3695 =item nxdomain-answers
3697 =item servfail-answers
3715 Please note that up to that point collectd doesn't know what values are
3716 available on the server and values that are added do not need a change of the
3717 mechanism so far. However, the values must be mapped to collectd's naming
3718 scheme, which is done using a lookup table that lists all known values. If
3719 values are added in the future and collectd does not know about them, you will
3720 get an error much like this:
3722 powerdns plugin: submit: Not found in lookup table: foobar = 42
3724 In this case please file a bug report with the collectd team.
3726 =item B<Socket> I<Path>
3728 Configures the path to the UNIX domain socket to be used when connecting to the
3729 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
3730 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
3731 will be used for the recursor.
3735 =item B<LocalSocket> I<Path>
3737 Querying the recursor is done using UDP. When using UDP over UNIX domain
3738 sockets, the client socket needs a name in the file system, too. You can set
3739 this local name to I<Path> using the B<LocalSocket> option. The default is
3740 C<I<prefix>/var/run/collectd-powerdns>.
3744 =head2 Plugin C<processes>
3748 =item B<Process> I<Name>
3750 Select more detailed statistics of processes matching this name. The statistics
3751 collected for these selected processes are size of the resident segment size
3752 (RSS), user- and system-time used, number of processes and number of threads,
3753 io data (where available) and minor and major pagefaults.
3755 =item B<ProcessMatch> I<name> I<regex>
3757 Similar to the B<Process> option this allows to select more detailed
3758 statistics of processes matching the specified I<regex> (see L<regex(7)> for
3759 details). The statistics of all matching processes are summed up and
3760 dispatched to the daemon using the specified I<name> as an identifier. This
3761 allows to "group" several processes together. I<name> must not contain
3766 =head2 Plugin C<protocols>
3768 Collects a lot of information about various network protocols, such as I<IP>,
3769 I<TCP>, I<UDP>, etc.
3771 Available configuration options:
3775 =item B<Value> I<Selector>
3777 Selects whether or not to select a specific value. The string being matched is
3778 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
3779 plugin instance and I<ValueName> will be used as type instance. An example of
3780 the string being used would be C<Tcp:RetransSegs>.
3782 You can use regular expressions to match a large number of values with just one
3783 configuration option. To select all "extended" I<TCP> values, you could use the
3784 following statement:
3788 Whether only matched values are selected or all matched values are ignored
3789 depends on the B<IgnoreSelected>. By default, only matched values are selected.
3790 If no value is configured at all, all values will be selected.
3792 =item B<IgnoreSelected> B<true>|B<false>
3794 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
3795 matching values will be ignored.
3799 =head2 Plugin C<python>
3801 This plugin embeds a Python-interpreter into collectd and provides an interface
3802 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
3804 =head2 Plugin C<routeros>
3806 The C<routeros> plugin connects to a device running I<RouterOS>, the
3807 Linux-based operating system for routers by I<MikroTik>. The plugin uses
3808 I<librouteros> to connect and reads information about the interfaces and
3809 wireless connections of the device. The configuration supports querying
3814 Host "router0.example.com"
3817 CollectInterface true
3822 Host "router1.example.com"
3825 CollectInterface true
3826 CollectRegistrationTable true
3832 As you can see above, the configuration of the I<routeros> plugin consists of
3833 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
3834 options are understood:
3838 =item B<Host> I<Host>
3840 Hostname or IP-address of the router to connect to.
3842 =item B<Port> I<Port>
3844 Port name or port number used when connecting. If left unspecified, the default
3845 will be chosen by I<librouteros>, currently "8728". This option expects a
3846 string argument, even when a numeric port number is given.
3848 =item B<User> I<User>
3850 Use the user name I<User> to authenticate. Defaults to "admin".
3852 =item B<Password> I<Password>
3854 Set the password used to authenticate.
3856 =item B<CollectInterface> B<true>|B<false>
3858 When set to B<true>, interface statistics will be collected for all interfaces
3859 present on the device. Defaults to B<false>.
3861 =item B<CollectRegistrationTable> B<true>|B<false>
3863 When set to B<true>, information about wireless LAN connections will be
3864 collected. Defaults to B<false>.
3866 =item B<CollectCPULoad> B<true>|B<false>
3868 When set to B<true>, information about the CPU usage will be collected. The
3869 number is a dimensionless value where zero indicates no CPU usage at all.
3870 Defaults to B<false>.
3872 =item B<CollectMemory> B<true>|B<false>
3874 When enabled, the amount of used and free memory will be collected. How used
3875 memory is calculated is unknown, for example whether or not caches are counted
3877 Defaults to B<false>.
3879 =item B<CollectDF> B<true>|B<false>
3881 When enabled, the amount of used and free disk space will be collected.
3882 Defaults to B<false>.
3884 =item B<CollectDisk> B<true>|B<false>
3886 When enabled, the number of sectors written and bad blocks will be collected.
3887 Defaults to B<false>.
3891 =head2 Plugin C<rrdcached>
3893 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
3894 to store values to RRD files in an efficient manner. The combination of the
3895 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
3896 way the C<rrdtool> plugin works (see below). The added abstraction layer
3897 provides a number of benefits, though: Because the cache is not within
3898 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
3899 restarted. This results in much shorter (if any) gaps in graphs, especially
3900 under heavy load. Also, the C<rrdtool> command line utility is aware of the
3901 daemon so that it can flush values to disk automatically when needed. This
3902 allows to integrate automated flushing of values into graphing solutions much
3905 There are disadvantages, though: The daemon may reside on a different host, so
3906 it may not be possible for C<collectd> to create the appropriate RRD files
3907 anymore. And even if C<rrdcached> runs on the same host, it may run in a
3908 different base directory, so relative paths may do weird stuff if you're not
3911 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
3912 on the same host, communicating via a UNIX domain socket. The B<DataDir>
3913 setting should be set to an absolute path, so that a changed base directory
3914 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
3918 =item B<DaemonAddress> I<Address>
3920 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
3921 library. See L<rrdcached(1)> for details. Example:
3923 <Plugin "rrdcached">
3924 DaemonAddress "unix:/var/run/rrdcached.sock"
3927 =item B<DataDir> I<Directory>
3929 Set the base directory in which the RRD files reside. If this is a relative
3930 path, it is relative to the working base directory of the C<rrdcached> daemon!
3931 Use of an absolute path is recommended.
3933 =item B<CreateFiles> B<true>|B<false>
3935 Enables or disables the creation of RRD files. If the daemon is not running
3936 locally, or B<DataDir> is set to a relative path, this will not work as
3937 expected. Default is B<true>.
3941 =head2 Plugin C<rrdtool>
3943 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
3944 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
3945 using these settings. If you don't want to dive into the depths of RRDtool, you
3946 can safely ignore these settings.
3950 =item B<DataDir> I<Directory>
3952 Set the directory to store RRD-files under. Per default RRD-files are generated
3953 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
3955 =item B<StepSize> I<Seconds>
3957 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
3958 this setting is unset and the stepsize is set to the interval in which the data
3959 is collected. Do not use this option unless you absolutely have to for some
3960 reason. Setting this option may cause problems with the C<snmp plugin>, the
3961 C<exec plugin> or when the daemon is set up to receive data from other hosts.
3963 =item B<HeartBeat> I<Seconds>
3965 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
3966 in which case the heartbeat is set to twice the B<StepSize> which should equal
3967 the interval in which data is collected. Do not set this option unless you have
3968 a very good reason to do so.
3970 =item B<RRARows> I<NumRows>
3972 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
3973 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
3974 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
3975 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
3976 week, one month, and one year.
3978 So for each timespan, it calculates how many PDPs need to be consolidated into
3979 one CDP by calculating:
3980 number of PDPs = timespan / (stepsize * rrarows)
3982 Bottom line is, set this no smaller than the width of you graphs in pixels. The
3985 =item B<RRATimespan> I<Seconds>
3987 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
3988 more then one RRA. If this option is never used, the built-in default of (3600,
3989 86400, 604800, 2678400, 31622400) is used.
3991 For more information on how RRA-sizes are calculated see B<RRARows> above.
3993 =item B<XFF> I<Factor>
3995 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
3997 =item B<CacheFlush> I<Seconds>
3999 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
4000 it writes all values for a certain RRD-file if the oldest value is older than
4001 (or equal to) the number of seconds specified. If some RRD-file is not updated
4002 anymore for some reason (the computer was shut down, the network is broken,
4003 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
4004 entire cache is searched for entries older than B<CacheTimeout> seconds and
4005 written to disk every I<Seconds> seconds. Since this is kind of expensive and
4006 does nothing under normal circumstances, this value should not be too small.
4007 900 seconds might be a good value, though setting this to 7200 seconds doesn't
4008 normally do much harm either.
4010 =item B<CacheTimeout> I<Seconds>
4012 If this option is set to a value greater than zero, the C<rrdtool plugin> will
4013 save values in a cache, as described above. Writing multiple values at once
4014 reduces IO-operations and thus lessens the load produced by updating the files.
4015 The trade off is that the graphs kind of "drag behind" and that more memory is
4018 =item B<WritesPerSecond> I<Updates>
4020 When collecting many statistics with collectd and the C<rrdtool> plugin, you
4021 will run serious performance problems. The B<CacheFlush> setting and the
4022 internal update queue assert that collectd continues to work just fine even
4023 under heavy load, but the system may become very unresponsive and slow. This is
4024 a problem especially if you create graphs from the RRD files on the same
4025 machine, for example using the C<graph.cgi> script included in the
4026 C<contrib/collection3/> directory.
4028 This setting is designed for very large setups. Setting this option to a value
4029 between 25 and 80 updates per second, depending on your hardware, will leave
4030 the server responsive enough to draw graphs even while all the cached values
4031 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
4032 by the B<FLUSH> command, are B<not> effected by this limit. They are still
4033 written as fast as possible, so that web frontends have up to date data when
4036 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
4037 updates per second, writing all values to disk will take approximately
4038 56E<nbsp>minutes. Together with the flushing ability that's integrated into
4039 "collection3" you'll end up with a responsive and fast system, up to date
4040 graphs and basically a "backup" of your values every hour.
4042 =item B<RandomTimeout> I<Seconds>
4044 When set, the actual timeout for each value is chosen randomly between
4045 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
4046 intention is to avoid high load situations that appear when many values timeout
4047 at the same time. This is especially a problem shortly after the daemon starts,
4048 because all values were added to the internal cache at roughly the same time.
4052 =head2 Plugin C<sensors>
4054 The C<sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
4055 that all the needed modules have to be loaded and lm_sensors has to be
4056 configured (most likely by editing F</etc/sensors.conf>. Read
4057 L<sensors.conf(5)> for details.
4059 The B<lm_sensors> homepage can be found at
4060 L<http://secure.netroedge.com/~lm78/>.
4064 =item B<Sensor> I<chip-bus-address/type-feature>
4066 Selects the name of the sensor which you want to collect or ignore, depending
4067 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
4068 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
4069 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
4071 =item B<IgnoreSelected> I<true>|I<false>
4073 If no configuration if given, the B<sensors>-plugin will collect data from all
4074 sensors. This may not be practical, especially for uninteresting sensors.
4075 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
4076 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
4077 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
4078 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
4079 and all other sensors are collected.
4083 =head2 Plugin C<snmp>
4085 Since the configuration of the C<snmp plugin> is a little more complicated than
4086 other plugins, its documentation has been moved to an own manpage,
4087 L<collectd-snmp(5)>. Please see there for details.
4089 =head2 Plugin C<syslog>
4093 =item B<LogLevel> B<debug|info|notice|warning|err>
4095 Sets the log-level. If, for example, set to B<notice>, then all events with
4096 severity B<notice>, B<warning>, or B<err> will be submitted to the
4099 Please note that B<debug> is only available if collectd has been compiled with
4104 =head2 Plugin C<table>
4106 The C<table plugin> provides generic means to parse tabular data and dispatch
4107 user specified values. Values are selected based on column numbers. For
4108 example, this plugin may be used to get values from the Linux L<proc(5)>
4109 filesystem or CSV (comma separated values) files.
4112 <Table "/proc/slabinfo">
4117 InstancePrefix "active_objs"
4123 InstancePrefix "objperslab"
4130 The configuration consists of one or more B<Table> blocks, each of which
4131 configures one file to parse. Within each B<Table> block, there are one or
4132 more B<Result> blocks, which configure which data to select and how to
4135 The following options are available inside a B<Table> block:
4139 =item B<Instance> I<instance>
4141 If specified, I<instance> is used as the plugin instance. So, in the above
4142 example, the plugin name C<table-slabinfo> would be used. If omitted, the
4143 filename of the table is used instead, with all special characters replaced
4144 with an underscore (C<_>).
4146 =item B<Separator> I<string>
4148 Any character of I<string> is interpreted as a delimiter between the different
4149 columns of the table. A sequence of two or more contiguous delimiters in the
4150 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
4151 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
4152 of a table - see its documentation for more details. This option is mandatory.
4154 A horizontal tab, newline and carriage return may be specified by C<\\t>,
4155 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
4156 required because of collectd's config parsing.
4160 The following options are available inside a B<Result> block:
4164 =item B<Type> I<type>
4166 Sets the type used to dispatch the values to the daemon. Detailed information
4167 about types and their configuration can be found in L<types.db(5)>. This
4168 option is mandatory.
4170 =item B<InstancePrefix> I<prefix>
4172 If specified, prepend I<prefix> to the type instance. If omitted, only the
4173 B<InstancesFrom> option is considered for the type instance.
4175 =item B<InstancesFrom> I<column0> [I<column1> ...]
4177 If specified, the content of the given columns (identified by the column
4178 number starting at zero) will be used to create the type instance for each
4179 row. Multiple values (and the instance prefix) will be joined together with
4180 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
4181 option is considered for the type instance.
4183 The plugin itself does not check whether or not all built instances are
4184 different. It’s your responsibility to assure that each is unique. This is
4185 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
4186 sure that the table only contains one row.
4188 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
4191 =item B<ValuesFrom> I<column0> [I<column1> ...]
4193 Specifies the columns (identified by the column numbers starting at zero)
4194 whose content is used as the actual data for the data sets that are dispatched
4195 to the daemon. How many such columns you need is determined by the B<Type>
4196 setting above. If you specify too many or not enough columns, the plugin will
4197 complain about that and no data will be submitted to the daemon. The plugin
4198 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
4199 respectively, so anything supported by those functions is supported by the
4200 plugin as well. This option is mandatory.
4204 =head2 Plugin C<tail>
4206 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
4207 each line and dispatches found values. What is matched can be configured by the
4208 user using (extended) regular expressions, as described in L<regex(7)>.
4211 <File "/var/log/exim4/mainlog">
4214 Regex "S=([1-9][0-9]*)"
4220 Regex "\\<R=local_user\\>"
4221 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
4224 Instance "local_user"
4229 The config consists of one or more B<File> blocks, each of which configures one
4230 logfile to parse. Within each B<File> block, there are one or more B<Match>
4231 blocks, which configure a regular expression to search for.
4233 The B<Instance> option in the B<File> block may be used to set the plugin
4234 instance. So in the above example the plugin name C<tail-foo> would be used.
4235 This plugin instance is for all B<Match> blocks that B<follow> it, until the
4236 next B<Instance> option. This way you can extract several plugin instances from
4237 one logfile, handy when parsing syslog and the like.
4239 Each B<Match> block has the following options to describe how the match should
4244 =item B<Regex> I<regex>
4246 Sets the regular expression to use for matching against a line. The first
4247 subexpression has to match something that can be turned into a number by
4248 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
4249 below. Because B<extended> regular expressions are used, you do not need to use
4250 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
4251 collectd's config parsing you need to escape backslashes, though. So if you
4252 want to match literal parentheses you need to do the following:
4254 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
4256 =item B<ExcludeRegex> I<regex>
4258 Sets an optional regular expression to use for excluding lines from the match.
4259 An example which excludes all connections from localhost from the match:
4261 ExcludeRegex "127\\.0\\.0\\.1"
4263 =item B<DSType> I<Type>
4265 Sets how the values are cumulated. I<Type> is one of:
4269 =item B<GaugeAverage>
4271 Calculate the average.
4275 Use the smallest number only.
4279 Use the greatest number only.
4283 Use the last number found.
4287 The matched number is a counter. Simply sets the internal counter to this
4292 Add the matched value to the internal counter.
4296 Increase the internal counter by one. This B<DSType> is the only one that does
4297 not use the matched subexpression, but simply counts the number of matched
4298 lines. Thus, you may use a regular expression without submatch in this case.
4302 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
4303 number, using L<strtod(3)>. The B<CounterSet> and B<CounterAdd> interpret the
4304 submatch as an integer using L<strtoll(3)>. B<CounterInc> does not use the
4305 submatch at all and it may be omitted in this case.
4307 =item B<Type> I<Type>
4309 Sets the type used to dispatch this value. Detailed information about types and
4310 their configuration can be found in L<types.db(5)>.
4312 =item B<Instance> I<TypeInstance>
4314 This optional setting sets the type instance to use.
4318 =head2 Plugin C<teamspeak2>
4320 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
4321 polls interesting global and virtual server data. The plugin can query only one
4322 physical server but unlimited virtual servers. You can use the following
4323 options to configure it:
4327 =item B<Host> I<hostname/ip>
4329 The hostname or ip which identifies the physical server.
4332 =item B<Port> I<port>
4334 The query port of the physical server. This needs to be a string.
4337 =item B<Server> I<port>
4339 This option has to be added once for every virtual server the plugin should
4340 query. If you want to query the virtual server on port 8767 this is what the
4341 option would look like:
4345 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
4346 use quotes around it! If no such statement is given only global information
4351 =head2 Plugin C<ted>
4353 The I<TED> plugin connects to a device of "The Energy Detective", a device to
4354 measure power consumption. These devices are usually connected to a serial
4355 (RS232) or USB port. The plugin opens a configured device and tries to read the
4356 current energy readings. For more information on TED, visit
4357 L<http://www.theenergydetective.com/>.
4359 Available configuration options:
4363 =item B<Device> I<Path>
4365 Path to the device on which TED is connected. collectd will need read and write
4366 permissions on that file.
4368 Default: B</dev/ttyUSB0>
4370 =item B<Retries> I<Num>
4372 Apparently reading from TED is not that reliable. You can therefore configure a
4373 number of retries here. You only configure the I<retries> here, to if you
4374 specify zero, one reading will be performed (but no retries if that fails); if
4375 you specify three, a maximum of four readings are performed. Negative values
4382 =head2 Plugin C<tcpconns>
4384 The C<tcpconns plugin> counts the number of currently established TCP
4385 connections based on the local port and/or the remote port. Since there may be
4386 a lot of connections the default if to count all connections with a local port,
4387 for which a listening socket is opened. You can use the following options to
4388 fine-tune the ports you are interested in:
4392 =item B<ListeningPorts> I<true>|I<false>
4394 If this option is set to I<true>, statistics for all local ports for which a
4395 listening socket exists are collected. The default depends on B<LocalPort> and
4396 B<RemotePort> (see below): If no port at all is specifically selected, the
4397 default is to collect listening ports. If specific ports (no matter if local or
4398 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
4399 the selected ports will be collected unless this option is set to I<true>
4402 =item B<LocalPort> I<Port>
4404 Count the connections to a specific local port. This can be used to see how
4405 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
4406 You have to specify the port in numeric form, so for the mailserver example
4407 you'd need to set B<25>.
4409 =item B<RemotePort> I<Port>
4411 Count the connections to a specific remote port. This is useful to see how
4412 much a remote service is used. This is most useful if you want to know how many
4413 connections a local service has opened to remote services, e.E<nbsp>g. how many
4414 connections a mail server or news server has to other mail or news servers, or
4415 how many connections a web proxy holds to web servers. You have to give the
4416 port in numeric form.
4420 =head2 Plugin C<thermal>
4424 =item B<ForceUseProcfs> I<true>|I<false>
4426 By default, the C<thermal> plugin tries to read the statistics from the Linux
4427 C<sysfs> interface. If that is not available, the plugin falls back to the
4428 C<procfs> interface. By setting this option to I<true>, you can force the
4429 plugin to use the latter. This option defaults to I<false>.
4431 =item B<Device> I<Device>
4433 Selects the name of the thermal device that you want to collect or ignore,
4434 depending on the value of the B<IgnoreSelected> option. This option may be
4435 used multiple times to specify a list of devices.
4437 =item B<IgnoreSelected> I<true>|I<false>
4439 Invert the selection: If set to true, all devices B<except> the ones that
4440 match the device names specified by the B<Device> option are collected. By
4441 default only selected devices are collected if a selection is made. If no
4442 selection is configured at all, B<all> devices are selected.
4446 =head2 Plugin C<tokyotyrant>
4448 The C<tokyotyrant plugin> connects to a TokyoTyrant server and collects a
4449 couple metrics: number of records, and database size on disk.
4453 =item B<Host> I<Hostname/IP>
4455 The hostname or ip which identifies the server.
4456 Default: B<127.0.0.1>
4458 =item B<Port> I<Service/Port>
4460 The query port of the server. This needs to be a string, even if the port is
4461 given in its numeric form.
4466 =head2 Plugin C<unixsock>
4470 =item B<SocketFile> I<Path>
4472 Sets the socket-file which is to be created.
4474 =item B<SocketGroup> I<Group>
4476 If running as root change the group of the UNIX-socket after it has been
4477 created. Defaults to B<collectd>.
4479 =item B<SocketPerms> I<Permissions>
4481 Change the file permissions of the UNIX-socket after it has been created. The
4482 permissions must be given as a numeric, octal value as you would pass to
4483 L<chmod(1)>. Defaults to B<0770>.
4487 =head2 Plugin C<uuid>
4489 This plugin, if loaded, causes the Hostname to be taken from the machine's
4490 UUID. The UUID is a universally unique designation for the machine, usually
4491 taken from the machine's BIOS. This is most useful if the machine is running in
4492 a virtual environment such as Xen, in which case the UUID is preserved across
4493 shutdowns and migration.
4495 The following methods are used to find the machine's UUID, in order:
4501 Check I</etc/uuid> (or I<UUIDFile>).
4505 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
4510 Check for UUID from C<dmidecode> / SMBIOS.
4514 Check for UUID from Xen hypervisor.
4518 If no UUID can be found then the hostname is not modified.
4522 =item B<UUIDFile> I<Path>
4524 Take the UUID from the given file (default I</etc/uuid>).
4528 =head2 Plugin C<varnish>
4530 The Varnish plugin collects information about Varnish, an HTTP accelerator.
4534 =item B<CollectCache> B<true>|B<false>
4536 Cache hits and misses. True by default.
4538 =item B<CollectConnections> B<true>|B<false>
4540 Number of client connections received, accepted and dropped. True by default.
4542 =item B<CollectBackend> B<true>|B<false>
4544 Back-end connection statistics, such as successful, reused,
4545 and closed connections. True by default.
4547 =item B<CollectSHM> B<true>|B<false>
4549 Statistics about the shared memory log, a memory region to store
4550 log messages which is flushed to disk when full. True by default.
4552 =item B<CollectESI> B<true>|B<false>
4554 Edge Side Includes (ESI) parse statistics. False by default.
4556 =item B<CollectFetch> B<true>|B<false>
4558 Statistics about fetches (HTTP requests sent to the backend). False by default.
4560 =item B<CollectHCB> B<true>|B<false>
4562 Inserts and look-ups in the crit bit tree based hash. Look-ups are
4563 divided into locked and unlocked look-ups. False by default.
4565 =item B<CollectSMA> B<true>|B<false>
4567 malloc or umem (umem_alloc(3MALLOC) based) storage statistics.
4568 The umem storage component is Solaris specific. False by default.
4570 =item B<CollectSMS> B<true>|B<false>
4572 synth (synthetic content) storage statistics. This storage
4573 component is used internally only. False by default.
4575 =item B<CollectSM> B<true>|B<false>
4577 file (memory mapped file) storage statistics. False by default.
4579 =item B<CollectTotals> B<true>|B<false>
4581 Collects overview counters, such as the number of sessions created,
4582 the number of requests and bytes transferred. False by default.
4584 =item B<CollectWorkers> B<true>|B<false>
4586 Collect statistics about worker threads. False by default.
4590 =head2 Plugin C<vmem>
4592 The C<vmem> plugin collects information about the usage of virtual memory.
4593 Since the statistics provided by the Linux kernel are very detailed, they are
4594 collected very detailed. However, to get all the details, you have to switch
4595 them on manually. Most people just want an overview over, such as the number of
4596 pages read from swap space.
4600 =item B<Verbose> B<true>|B<false>
4602 Enables verbose collection of information. This will start collecting page
4603 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
4604 Part of these statistics are collected on a "per zone" basis.
4608 =head2 Plugin C<vserver>
4610 This plugin doesn't have any options. B<VServer> support is only available for
4611 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
4612 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
4613 need to apply the patches and compile your own kernel, which will then provide
4614 the F</proc/virtual> filesystem that is required by this plugin.
4616 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
4618 B<Note>: The traffic collected by this plugin accounts for the amount of
4619 traffic passing a socket which might be a lot less than the actual on-wire
4620 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
4621 collect on-wire traffic you could, for example, use the logging facilities of
4622 iptables to feed data for the guest IPs into the iptables plugin.
4624 =head2 Plugin C<write_http>
4626 This output plugin submits values to an http server by POST them using the
4627 PUTVAL plain-text protocol. Each destination you want to post data to needs to
4628 have one B<URL> block, within which the destination can be configured further,
4629 for example by specifying authentication data.
4633 <Plugin "write_http">
4634 <URL "http://example.com/post-collectd">
4640 B<URL> blocks need one string argument which is used as the URL to which data
4641 is posted. The following options are understood within B<URL> blocks.
4645 =item B<User> I<Username>
4647 Optional user name needed for authentication.
4649 =item B<Password> I<Password>
4651 Optional password needed for authentication.
4653 =item B<VerifyPeer> B<true>|B<false>
4655 Enable or disable peer SSL certificate verification. See
4656 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
4658 =item B<VerifyHost> B<true|false>
4660 Enable or disable peer host name verification. If enabled, the plugin checks if
4661 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
4662 matches the host name provided by the B<URL> option. If this identity check
4663 fails, the connection is aborted. Obviously, only works when connecting to a
4664 SSL enabled server. Enabled by default.
4666 =item B<CACert> I<File>
4668 File that holds one or more SSL certificates. If you want to use HTTPS you will
4669 possibly need this option. What CA certificates come bundled with C<libcurl>
4670 and are checked by default depends on the distribution you use.
4672 =item B<Format> B<Command>|B<JSON>
4674 Format of the output to generate. If set to B<Command>, will create output that
4675 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
4676 create output in the I<JavaScript Object Notation> (JSON).
4678 Defaults to B<Command>.
4680 =item B<StoreRates> B<true|false>
4682 If set to B<true>, convert counter values to rates. If set to B<false> (the
4683 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
4688 =head1 THRESHOLD CONFIGURATION
4690 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
4691 we mean that the values are not only stored or sent somewhere, but that they
4692 are judged and, if a problem is recognized, acted upon. The only action
4693 collectd takes itself is to generate and dispatch a "notification". Plugins can
4694 register to receive notifications and perform appropriate further actions.
4696 Since systems and what you expect them to do differ a lot, you can configure
4697 B<thresholds> for your values freely. This gives you a lot of flexibility but
4698 also a lot of responsibility.
4700 Every time a value is out of range a notification is dispatched. This means
4701 that the idle percentage of your CPU needs to be less then the configured
4702 threshold only once for a notification to be generated. There's no such thing
4703 as a moving average or similar - at least not now.
4705 Also, all values that match a threshold are considered to be relevant or
4706 "interesting". As a consequence collectd will issue a notification if they are
4707 not received for B<Timeout> iterations. The B<Timeout> configuration option is
4708 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
4709 "2" (the default) and some hosts sends it's CPU statistics to the server every
4710 60 seconds, a notification will be dispatched after about 120 seconds. It may
4711 take a little longer because the timeout is checked only once each B<Interval>
4714 When a value comes within range again or is received after it was missing, an
4715 "OKAY-notification" is dispatched.
4717 Here is a configuration example to get you started. Read below for more
4730 <Plugin "interface">
4747 WarningMin 100000000
4752 DataSource "midterm"
4760 There are basically two types of configuration statements: The C<Host>,
4761 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
4762 configured. The C<Plugin> and C<Type> blocks may be specified further using the
4763 C<Instance> option. You can combine the block by nesting the blocks, though
4764 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
4765 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
4766 C<Type> may not contain other blocks. If multiple blocks apply to the same
4767 value the most specific block is used.
4769 The other statements specify the threshold to configure. They B<must> be
4770 included in a C<Type> block. Currently the following statements are recognized:
4774 =item B<FailureMax> I<Value>
4776 =item B<WarningMax> I<Value>
4778 Sets the upper bound of acceptable values. If unset defaults to positive
4779 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
4780 will be created. If the value is greater than B<WarningMax> but less than (or
4781 equal to) B<FailureMax> a B<WARNING> notification will be created.
4783 =item B<FailureMin> I<Value>
4785 =item B<WarningMin> I<Value>
4787 Sets the lower bound of acceptable values. If unset defaults to negative
4788 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
4789 be created. If the value is less than B<WarningMin> but greater than (or equal
4790 to) B<FailureMin> a B<WARNING> notification will be created.
4792 =item B<DataSource> I<DSName>
4794 Some data sets have more than one "data source". Interesting examples are the
4795 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
4796 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
4797 system load data set, C<load>, even has three data sources: C<shortterm>,
4798 C<midterm>, and C<longterm>.
4800 Normally, all data sources are checked against a configured threshold. If this
4801 is undesirable, or if you want to specify different limits for each data
4802 source, you can use the B<DataSource> option to have a threshold apply only to
4805 =item B<Invert> B<true>|B<false>
4807 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
4808 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
4809 B<WarningMax>) are not okay. Defaults to B<false>.
4811 =item B<Persist> B<true>|B<false>
4813 Sets how often notifications are generated. If set to B<true> one notification
4814 will be generated for each value that is out of the acceptable range. If set to
4815 B<false> (the default) then a notification is only generated if a value is out
4816 of range but the previous value was okay.
4818 This applies to missing values, too: If set to B<true> a notification about a
4819 missing value is generated once every B<Interval> seconds. If set to B<false>
4820 only one such notification is generated until the value appears again.
4822 =item B<Percentage> B<true>|B<false>
4824 If set to B<true>, the minimum and maximum values given are interpreted as
4825 percentage value, relative to the other data sources. This is helpful for
4826 example for the "df" type, where you may want to issue a warning when less than
4827 5E<nbsp>% of the total space is available. Defaults to B<false>.
4829 =item B<Hits> I<Value>
4831 Sets the number of occurrences which the threshold must be arised before to
4832 dispatch any notification or, in other words, the number of B<Interval>s
4833 than the threshold must be match before dispatch any notification.
4835 =item B<Hysteresis> I<Value>
4837 Sets the hysteresis value for threshold. The hysteresis is a method to
4838 prevent flapping between states, until a new received value for
4839 a previously matched threshold down below the threshold condition
4840 (B<WarningMax>, B<FailureMin> or everthing else) minus the hysteresis value,
4841 the failure (respectively warning) state will be keep.
4843 =item B<Interesting> B<true>|B<false>
4845 If set to B<true> (the default), the threshold must be treated as
4846 interesting and, when a number of B<Timeout> values will lost, then
4847 a missing notification will be dispatched. On the other hand, if set to
4848 B<false>, the missing notification will never dispatched for this threshold.
4852 =head1 FILTER CONFIGURATION
4854 Starting with collectd 4.6 there is a powerful filtering infrastructure
4855 implemented in the daemon. The concept has mostly been copied from
4856 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
4857 terminology, so that users that are familiar with iptables feel right at home.
4861 The following are the terms used in the remainder of the filter configuration
4862 documentation. For an ASCII-art schema of the mechanism, see
4863 L<"General structure"> below.
4869 A I<match> is a criteria to select specific values. Examples are, of course, the
4870 name of the value or it's current value.
4872 Matches are implemented in plugins which you have to load prior to using the
4873 match. The name of such plugins starts with the "match_" prefix.
4877 A I<target> is some action that is to be performed with data. Such actions
4878 could, for example, be to change part of the value's identifier or to ignore
4879 the value completely.
4881 Some of these targets are built into the daemon, see L<"Built-in targets">
4882 below. Other targets are implemented in plugins which you have to load prior to
4883 using the target. The name of such plugins starts with the "target_" prefix.
4887 The combination of any number of matches and at least one target is called a
4888 I<rule>. The target actions will be performed for all values for which B<all>
4889 matches apply. If the rule does not have any matches associated with it, the
4890 target action will be performed for all values.
4894 A I<chain> is a list of rules and possibly default targets. The rules are tried
4895 in order and if one matches, the associated target will be called. If a value
4896 is handled by a rule, it depends on the target whether or not any subsequent
4897 rules are considered or if traversal of the chain is aborted, see
4898 L<"Flow control"> below. After all rules have been checked, the default targets
4903 =head2 General structure
4905 The following shows the resulting structure:
4912 +---------+ +---------+ +---------+ +---------+
4913 ! Rule !->! Match !->! Match !->! Target !
4914 +---------+ +---------+ +---------+ +---------+
4917 +---------+ +---------+ +---------+
4918 ! Rule !->! Target !->! Target !
4919 +---------+ +---------+ +---------+
4926 +---------+ +---------+ +---------+
4927 ! Rule !->! Match !->! Target !
4928 +---------+ +---------+ +---------+
4938 There are four ways to control which way a value takes through the filter
4945 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
4946 process the value with another chain. When the called chain finishes, usually
4947 the next target or rule after the jump is executed.
4951 The stop condition, signaled for example by the built-in target B<stop>, causes
4952 all processing of the value to be stopped immediately.
4956 Causes processing in the current chain to be aborted, but processing of the
4957 value generally will continue. This means that if the chain was called via
4958 B<Jump>, the next target or rule after the jump will be executed. If the chain
4959 was not called by another chain, control will be returned to the daemon and it
4960 may pass the value to another chain.
4964 Most targets will signal the B<continue> condition, meaning that processing
4965 should continue normally. There is no special built-in target for this
4972 The configuration reflects this structure directly:
4974 PostCacheChain "PostCache"
4976 <Rule "ignore_mysql_show">
4979 Type "^mysql_command$"
4980 TypeInstance "^show_"
4990 The above configuration example will ignore all values where the plugin field
4991 is "mysql", the type is "mysql_command" and the type instance begins with
4992 "show_". All other values will be sent to the C<rrdtool> write plugin via the
4993 default target of the chain. Since this chain is run after the value has been
4994 added to the cache, the MySQL C<show_*> command statistics will be available
4995 via the C<unixsock> plugin.
4997 =head2 List of configuration options
5001 =item B<PreCacheChain> I<ChainName>
5003 =item B<PostCacheChain> I<ChainName>
5005 Configure the name of the "pre-cache chain" and the "post-cache chain". The
5006 argument is the name of a I<chain> that should be executed before and/or after
5007 the values have been added to the cache.
5009 To understand the implications, it's important you know what is going on inside
5010 I<collectd>. The following diagram shows how values are passed from the
5011 read-plugins to the write-plugins:
5017 + - - - - V - - - - +
5018 : +---------------+ :
5021 : +-------+-------+ :
5024 : +-------+-------+ : +---------------+
5025 : ! Cache !--->! Value Cache !
5026 : ! insert ! : +---+---+-------+
5027 : +-------+-------+ : ! !
5028 : ! ,------------' !
5030 : +-------+---+---+ : +-------+-------+
5031 : ! Post-Cache +--->! Write-Plugins !
5032 : ! Chain ! : +---------------+
5033 : +---------------+ :
5036 + - - - - - - - - - +
5038 After the values are passed from the "read" plugins to the dispatch functions,
5039 the pre-cache chain is run first. The values are added to the internal cache
5040 afterwards. The post-cache chain is run after the values have been added to the
5041 cache. So why is it such a huge deal if chains are run before or after the
5042 values have been added to this cache?
5044 Targets that change the identifier of a value list should be executed before
5045 the values are added to the cache, so that the name in the cache matches the
5046 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
5047 this cache to receive a list of all available values. If you change the
5048 identifier after the value list has been added to the cache, this may easily
5049 lead to confusion, but it's not forbidden of course.
5051 The cache is also used to convert counter values to rates. These rates are, for
5052 example, used by the C<value> match (see below). If you use the rate stored in
5053 the cache B<before> the new value is added, you will use the old, B<previous>
5054 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
5055 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
5058 Last but not last, the B<stop> target makes a difference: If the pre-cache
5059 chain returns the stop condition, the value will not be added to the cache and
5060 the post-cache chain will not be run.
5062 =item B<Chain> I<Name>
5064 Adds a new chain with a certain name. This name can be used to refer to a
5065 specific chain, for example to jump to it.
5067 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
5069 =item B<Rule> [I<Name>]
5071 Adds a new rule to the current chain. The name of the rule is optional and
5072 currently has no meaning for the daemon.
5074 Within the B<Rule> block, there may be any number of B<Match> blocks and there
5075 must be at least one B<Target> block.
5077 =item B<Match> I<Name>
5079 Adds a match to a B<Rule> block. The name specifies what kind of match should
5080 be performed. Available matches depend on the plugins that have been loaded.
5082 The arguments inside the B<Match> block are passed to the plugin implementing
5083 the match, so which arguments are valid here depends on the plugin being used.
5084 If you do not need any to pass any arguments to a match, you can use the
5089 Which is equivalent to:
5094 =item B<Target> I<Name>
5096 Add a target to a rule or a default target to a chain. The name specifies what
5097 kind of target is to be added. Which targets are available depends on the
5098 plugins being loaded.
5100 The arguments inside the B<Target> block are passed to the plugin implementing
5101 the target, so which arguments are valid here depends on the plugin being used.
5102 If you do not need any to pass any arguments to a target, you can use the
5107 This is the same as writing:
5114 =head2 Built-in targets
5116 The following targets are built into the core daemon and therefore need no
5117 plugins to be loaded:
5123 Signals the "return" condition, see the L<"Flow control"> section above. This
5124 causes the current chain to stop processing the value and returns control to
5125 the calling chain. The calling chain will continue processing targets and rules
5126 just after the B<jump> target (see below). This is very similar to the
5127 B<RETURN> target of iptables, see L<iptables(8)>.
5129 This target does not have any options.
5137 Signals the "stop" condition, see the L<"Flow control"> section above. This
5138 causes processing of the value to be aborted immediately. This is similar to
5139 the B<DROP> target of iptables, see L<iptables(8)>.
5141 This target does not have any options.
5149 Sends the value to "write" plugins.
5155 =item B<Plugin> I<Name>
5157 Name of the write plugin to which the data should be sent. This option may be
5158 given multiple times to send the data to more than one write plugin.
5162 If no plugin is explicitly specified, the values will be sent to all available
5173 Starts processing the rules of another chain, see L<"Flow control"> above. If
5174 the end of that chain is reached, or a stop condition is encountered,
5175 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
5176 next target or the next rule. This is similar to the B<-j> command line option
5177 of iptables, see L<iptables(8)>.
5183 =item B<Chain> I<Name>
5185 Jumps to the chain I<Name>. This argument is required and may appear only once.
5197 =head2 Available matches
5203 Matches a value using regular expressions.
5209 =item B<Host> I<Regex>
5211 =item B<Plugin> I<Regex>
5213 =item B<PluginInstance> I<Regex>
5215 =item B<Type> I<Regex>
5217 =item B<TypeInstance> I<Regex>
5219 Match values where the given regular expressions match the various fields of
5220 the identifier of a value. If multiple regular expressions are given, B<all>
5221 regexen must match for a value to match.
5223 =item B<Invert> B<false>|B<true>
5225 When set to B<true>, the result of the match is inverted, i.e. all value lists
5226 where all regular expressions apply are not matched, all other value lists are
5227 matched. Defaults to B<false>.
5234 Host "customer[0-9]+"
5240 Matches values that have a time which differs from the time on the server.
5242 This match is mainly intended for servers that receive values over the
5243 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
5244 is very sensitive to the timestamp used when updating the RRD files. In
5245 particular, the time must be ever increasing. If a misbehaving client sends one
5246 packet with a timestamp far in the future, all further packets with a correct
5247 time will be ignored because of that one packet. What's worse, such corrupted
5248 RRD files are hard to fix.
5250 This match lets one match all values B<outside> a specified time range
5251 (relative to the server's time), so you can use the B<stop> target (see below)
5252 to ignore the value, for example.
5258 =item B<Future> I<Seconds>
5260 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
5261 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
5264 =item B<Past> I<Seconds>
5266 Matches all values that are I<behind> of the server's time by I<Seconds> or
5267 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
5279 This example matches all values that are five minutes or more ahead of the
5280 server or one hour (or more) lagging behind.
5284 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
5285 values. If a data-set consists of more than one data-source, all data-sources
5286 must match the specified ranges for a positive match.
5292 =item B<Min> I<Value>
5294 Sets the smallest value which still results in a match. If unset, behaves like
5297 =item B<Max> I<Value>
5299 Sets the largest value which still results in a match. If unset, behaves like
5302 =item B<Invert> B<true>|B<false>
5304 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
5305 no-match is returned and vice versa. Please note that the B<Invert> setting
5306 only effects how B<Min> and B<Max> are applied to a specific value. Especially
5307 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
5309 =item B<DataSource> I<DSName> [I<DSName> ...]
5311 Select one or more of the data sources. If no data source is configured, all
5312 data sources will be checked. If the type handled by the match does not have a
5313 data source of the specified name(s), this will always result in no match
5314 (independent of the B<Invert> setting).
5316 =item B<Satisfy> B<Any>|B<All>
5318 Specifies how checking with several data sources is performed. If set to
5319 B<Any>, the match succeeds if one of the data sources is in the configured
5320 range. If set to B<All> the match only succeeds if all data sources are within
5321 the configured range. Default is B<All>.
5323 Usually B<All> is used for positive matches, B<Any> is used for negative
5324 matches. This means that with B<All> you usually check that all values are in a
5325 "good" range, while with B<Any> you check if any value is within a "bad" range
5326 (or outside the "good" range).
5330 Either B<Min> or B<Max>, but not both, may be unset.
5334 # Match all values smaller than or equal to 100. Matches only if all data
5335 # sources are below 100.
5341 # Match if the value of any data source is outside the range of 0 - 100.
5349 =item B<empty_counter>
5351 Matches all values with one or more data sources of type B<COUNTER> and where
5352 all counter values are zero. These counters usually I<never> increased since
5353 they started existing (and are therefore uninteresting), or got reset recently
5354 or overflowed and you had really, I<really> bad luck.
5356 Please keep in mind that ignoring such counters can result in confusing
5357 behavior: Counters which hardly ever increase will be zero for long periods of
5358 time. If the counter is reset for some reason (machine or service restarted,
5359 usually), the graph will be empty (NAN) for a long time. People may not
5364 Calculates a hash value of the host name and matches values according to that
5365 hash value. This makes it possible to divide all hosts into groups and match
5366 only values that are in a specific group. The intended use is in load
5367 balancing, where you want to handle only part of all data and leave the rest
5370 The hashing function used tries to distribute the hosts evenly. First, it
5371 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
5374 for (i = 0; host[i] != 0; i++)
5375 hash_value = (hash_value * 251) + host[i];
5377 The constant 251 is a prime number which is supposed to make this hash value
5378 more random. The code then checks the group for this host according to the
5379 I<Total> and I<Match> arguments:
5381 if ((hash_value % Total) == Match)
5386 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
5387 groups), then the least significant bit of the hash value will be the XOR of
5388 all least significant bits in the host name. One consequence is that when you
5389 have two hosts, "server0.example.com" and "server1.example.com", where the host
5390 name differs in one digit only and the digits differ by one, those hosts will
5391 never end up in the same group.
5397 =item B<Match> I<Match> I<Total>
5399 Divide the data into I<Total> groups and match all hosts in group I<Match> as
5400 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
5401 be smaller than I<Total>. I<Total> must be at least one, although only values
5402 greater than one really do make any sense.
5404 You can repeat this option to match multiple groups, for example:
5409 The above config will divide the data into seven groups and match groups three
5410 and five. One use would be to keep every value on two hosts so that if one
5411 fails the missing data can later be reconstructed from the second host.
5417 # Operate on the pre-cache chain, so that ignored values are not even in the
5422 # Divide all received hosts in seven groups and accept all hosts in
5426 # If matched: Return and continue.
5429 # If not matched: Return and stop.
5435 =head2 Available targets
5439 =item B<notification>
5441 Creates and dispatches a notification.
5447 =item B<Message> I<String>
5449 This required option sets the message of the notification. The following
5450 placeholders will be replaced by an appropriate value:
5458 =item B<%{plugin_instance}>
5462 =item B<%{type_instance}>
5464 These placeholders are replaced by the identifier field of the same name.
5466 =item B<%{ds:>I<name>B<}>
5468 These placeholders are replaced by a (hopefully) human readable representation
5469 of the current rate of this data source. If you changed the instance name
5470 (using the B<set> or B<replace> targets, see below), it may not be possible to
5471 convert counter values to rates.
5475 Please note that these placeholders are B<case sensitive>!
5477 =item B<Severity> B<"FATAL">|B<"WARNING">|B<"OKAY">
5479 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
5486 <Target "notification">
5487 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
5493 Replaces parts of the identifier using regular expressions.
5499 =item B<Host> I<Regex> I<Replacement>
5501 =item B<Plugin> I<Regex> I<Replacement>
5503 =item B<PluginInstance> I<Regex> I<Replacement>
5505 =item B<TypeInstance> I<Regex> I<Replacement>
5507 Match the appropriate field with the given regular expression I<Regex>. If the
5508 regular expression matches, that part that matches is replaced with
5509 I<Replacement>. If multiple places of the input buffer match a given regular
5510 expression, only the first occurrence will be replaced.
5512 You can specify each option multiple times to use multiple regular expressions
5520 # Replace "example.net" with "example.com"
5521 Host "\\<example.net\\>" "example.com"
5523 # Strip "www." from hostnames
5529 Sets part of the identifier of a value to a given string.
5535 =item B<Host> I<String>
5537 =item B<Plugin> I<String>
5539 =item B<PluginInstance> I<String>
5541 =item B<TypeInstance> I<String>
5543 Set the appropriate field to the given string. The strings for plugin instance
5544 and type instance may be empty, the strings for host and plugin may not be
5545 empty. It's currently not possible to set the type of a value this way.
5552 PluginInstance "coretemp"
5553 TypeInstance "core3"
5558 =head2 Backwards compatibility
5560 If you use collectd with an old configuration, i.E<nbsp>e. one without a
5561 B<Chain> block, it will behave as it used to. This is equivalent to the
5562 following configuration:
5568 If you specify a B<PostCacheChain>, the B<write> target will not be added
5569 anywhere and you will have to make sure that it is called where appropriate. We
5570 suggest to add the above snippet as default target to your "PostCache" chain.
5574 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
5590 L<collectd-exec(5)>,
5591 L<collectd-perl(5)>,
5592 L<collectd-unixsock(5)>,
5605 Florian Forster E<lt>octo@verplant.orgE<gt>