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 Starting with collectd 4.9, this may also be a block in which further options
61 affecting the behavior of B<LoadPlugin> may be specified. The following
62 options are allowed inside a B<LoadPlugin> block:
70 =item B<Globals> B<true|false>
72 If enabled, collectd will export all global symbols of the plugin (and of all
73 libraries loaded as dependencies of the plugin) and, thus, makes those symbols
74 available for resolving unresolved symbols in subsequently loaded plugins if
75 that is supported by your system. By default, this is disabled.
77 This is useful (or possibly even required), e.E<nbsp>g., when loading a plugin
78 that embeds some scripting language into the daemon (e.E<nbsp>g. the C<perl>
79 or C<python> plugins). Scripting languages usually provide means to load
80 extensions written in C. Those extensions require symbols provided by the
81 interpreter, which is loaded as a dependency of the respective collectd
82 plugin. See the documentation of those plugins (e.E<nbsp>g.,
83 L<collectd-perl(5)> or L<collectd-python(5)>) for details.
87 =item B<Include> I<Path>
89 If I<Path> points to a file, includes that file. If I<Path> points to a
90 directory, recursively includes all files within that directory and its
91 subdirectories. If the C<wordexp> function is available on your system,
92 shell-like wildcards are expanded before files are included. This means you can
93 use statements like the following:
95 Include "/etc/collectd.d/*.conf"
97 If more than one files are included by a single B<Include> option, the files
98 will be included in lexicographical order (as defined by the C<strcmp>
99 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
100 order in which the files are loaded.
102 To prevent loops and shooting yourself in the foot in interesting ways the
103 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
104 most uses. Since symlinks are followed it is still possible to crash the daemon
105 by looping symlinks. In our opinion significant stupidity should result in an
106 appropriate amount of pain.
108 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
109 file, but you cannot include files from within blocks.
111 =item B<PIDFile> I<File>
113 Sets where to write the PID file to. This file is overwritten when it exists
114 and deleted when the program is stopped. Some init-scripts might override this
115 setting using the B<-P> command-line option.
117 =item B<PluginDir> I<Directory>
119 Path to the plugins (shared objects) of collectd.
121 =item B<TypesDB> I<File> [I<File> ...]
123 Set one or more files that contain the data-set descriptions. See
124 L<types.db(5)> for a description of the format of this file.
126 =item B<Interval> I<Seconds>
128 Configures the interval in which to query the read plugins. Obviously smaller
129 values lead to a higher system load produced by collectd, while higher values
130 lead to more coarse statistics.
132 B<Warning:> You should set this once and then never touch it again. If you do,
133 I<you will have to delete all your RRD files> or know some serious RRDtool
134 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
136 =item B<Timeout> I<Iterations>
138 Consider a value list "missing" when no update has been read or received for
139 I<Iterations> iterations. By default, I<collectd> considers a value list
140 missing when no update has been received for twice the update interval. Since
141 this setting uses iterations, the maximum allowed time without update depends
142 on the I<Interval> information contained in each value list. This is used in
143 the I<Threshold> configuration to dispatch notifications about missing values,
144 see L<collectd-threshold(5)> for details.
146 =item B<ReadThreads> I<Num>
148 Number of threads to start for reading plugins. The default value is B<5>, but
149 you may want to increase this if you have more than five plugins that take a
150 long time to read. Mostly those are plugin that do network-IO. Setting this to
151 a value higher than the number of plugins you've loaded is totally useless.
153 =item B<Hostname> I<Name>
155 Sets the hostname that identifies a host. If you omit this setting, the
156 hostname will be determined using the L<gethostname(2)> system call.
158 =item B<FQDNLookup> B<true|false>
160 If B<Hostname> is determined automatically this setting controls whether or not
161 the daemon should try to figure out the "fully qualified domain name", FQDN.
162 This is done using a lookup of the name returned by C<gethostname>. This option
163 is enabled by default.
165 =item B<PreCacheChain> I<ChainName>
167 =item B<PostCacheChain> I<ChainName>
169 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
170 see L<FILTER CONFIGURATION> below on information on chains and how these
171 setting change the daemon's behavior.
175 =head1 PLUGIN OPTIONS
177 Some plugins may register own options. These options must be enclosed in a
178 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
179 require external configuration, too. The C<apache plugin>, for example,
180 required C<mod_status> to be configured in the webserver you're going to
181 collect data from. These plugins are listed below as well, even if they don't
182 require any configuration within collectd's configfile.
184 A list of all plugins and a short summary for each plugin can be found in the
185 F<README> file shipped with the sourcecode and hopefully binary packets as
188 =head2 Plugin C<amqp>
190 The I<AMQMP plugin> can be used to communicate with other instances of
191 I<collectd> or third party applications using an AMQP message broker. Values
192 are sent to or received from the broker, which handles routing, queueing and
193 possibly filtering or messages.
196 # Send values to an AMQP broker
197 <Publish "some_name">
203 Exchange "amq.fanout"
204 # ExchangeType "fanout"
205 # RoutingKey "collectd"
211 # Receive values from an AMQP broker
212 <Subscribe "some_name">
218 Exchange "amq.fanout"
219 # ExchangeType "fanout"
221 # RoutingKey "collectd.#"
225 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
226 blocks, which configure sending and receiving of values respectively. The two
227 blocks are very similar, so unless otherwise noted, an option can be used in
228 either block. The name given in the blocks starting tag is only used for
229 reporting messages, but may be used to support I<flushing> of certain
230 I<Publish> blocks in the future.
234 =item B<Host> I<Host>
236 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
237 the underlying communications library, I<rabbitmq-c>, which is "localhost".
239 =item B<Port> I<Port>
241 Service name or port number on which the AMQP broker accepts connections. This
242 argument must be a string, even if the numeric form is used. Defaults to
245 =item B<VHost> I<VHost>
247 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
249 =item B<User> I<User>
251 =item B<Password> I<Password>
253 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
256 =item B<Exchange> I<Exchange>
258 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
259 By default, "amq.fanout" will be used.
261 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
262 the given exchange and the I<queue> is created, using the I<routing key> if
263 configured. See the B<Queue> and B<RoutingKey> options below.
265 =item B<ExchangeType> I<Type>
267 If given, the plugin will try to create the configured I<exchange> with this
268 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
269 be bound to this exchange.
271 =item B<Queue> I<Queue> (Subscribe only)
273 Configures the I<queue> name to subscribe to. If no queue name was configures
274 explicitly, a unique queue name will be created by the broker.
276 =item B<RoutingKey> I<Key>
278 In I<Publish> blocks, this configures the routing key to set on all outgoing
279 messages. If not given, the routing key will be computed from the I<identifier>
280 of the value. The host, plugin, type and the two instances are concatenated
281 together using dots as the separator and all containing dots replaced with
282 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
283 possible to receive only specific values using a "topic" exchange.
285 In I<Subscribe> blocks, configures the I<routing key> used when creating a
286 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
287 used to filter messages when using a "topic" exchange. If you're only
288 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
291 =item B<Persistent> B<true>|B<false> (Publish only)
293 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
294 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
295 default), the I<transient> delivery mode will be used, i.e. messages may be
296 lost due to high load, overflowing queues or similar issues.
298 =item B<Format> B<Command>|B<JSON> (Publish only)
300 Selects the format in which messages are sent to the broker. If set to
301 B<Command> (the default), values are sent as C<PUTVAL> commands which are
302 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
303 case, the C<Content-Type> header field will be set to C<text/collectd>.
305 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
306 an easy and straight forward exchange format. The C<Content-Type> header field
307 will be set to C<application/json>.
309 A subscribing client I<should> use the C<Content-Type> header field to
310 determine how to decode the values. Currently, the I<AMQP plugin> itself can
311 only decode the B<Command> format.
313 =item B<StoreRates> B<true>|B<false> (Publish only)
315 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
316 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
317 default), no conversion is performed. Otherwise the conversion is performed
318 using the internal value cache.
320 Please note that currently this option is only used if the B<Format> option has
325 =head2 Plugin C<apache>
327 To configure the C<apache>-plugin you first need to configure the Apache
328 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
329 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
330 the following snipped to base your Apache config upon:
333 <IfModule mod_status.c>
334 <Location /mod_status>
335 SetHandler server-status
339 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
340 also supported. It introduces a new field, called C<BusyServers>, to count the
341 number of currently connected clients. This field is also supported.
343 The configuration of the I<Apache> plugin consists of one or more
344 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
345 as the instance name. For example:
349 URL "http://www1.example.com/mod_status?auto"
352 URL "http://www2.example.com/mod_status?auto"
356 The instance name will be used as the I<plugin instance>. To emulate the old
357 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
358 plugin to work correctly, each instance name must be unique. This is not
359 enforced by the plugin and it is your responsibility to ensure it.
361 The following options are accepted within each I<Instance> block:
365 =item B<URL> I<http://host/mod_status?auto>
367 Sets the URL of the C<mod_status> output. This needs to be the output generated
368 by C<ExtendedStatus on> and it needs to be the machine readable output
369 generated by appending the C<?auto> argument. This option is I<mandatory>.
371 =item B<User> I<Username>
373 Optional user name needed for authentication.
375 =item B<Password> I<Password>
377 Optional password needed for authentication.
379 =item B<VerifyPeer> B<true|false>
381 Enable or disable peer SSL certificate verification. See
382 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
384 =item B<VerifyHost> B<true|false>
386 Enable or disable peer host name verification. If enabled, the plugin checks
387 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
388 certificate matches the host name provided by the B<URL> option. If this
389 identity check fails, the connection is aborted. Obviously, only works when
390 connecting to a SSL enabled server. Enabled by default.
392 =item B<CACert> I<File>
394 File that holds one or more SSL certificates. If you want to use HTTPS you will
395 possibly need this option. What CA certificates come bundled with C<libcurl>
396 and are checked by default depends on the distribution you use.
400 =head2 Plugin C<apcups>
404 =item B<Host> I<Hostname>
406 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
407 that IPv6 support has been disabled unless someone can confirm or decline that
408 B<apcupsd> can handle it.
410 =item B<Port> I<Port>
412 TCP-Port to connect to. Defaults to B<3551>.
416 =head2 Plugin C<ascent>
418 This plugin collects information about an Ascent server, a free server for the
419 "World of Warcraft" game. This plugin gathers the information by fetching the
420 XML status page using C<libcurl> and parses it using C<libxml2>.
422 The configuration options are the same as for the C<apache> plugin above:
426 =item B<URL> I<http://localhost/ascent/status/>
428 Sets the URL of the XML status output.
430 =item B<User> I<Username>
432 Optional user name needed for authentication.
434 =item B<Password> I<Password>
436 Optional password needed for authentication.
438 =item B<VerifyPeer> B<true|false>
440 Enable or disable peer SSL certificate verification. See
441 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
443 =item B<VerifyHost> B<true|false>
445 Enable or disable peer host name verification. If enabled, the plugin checks
446 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
447 certificate matches the host name provided by the B<URL> option. If this
448 identity check fails, the connection is aborted. Obviously, only works when
449 connecting to a SSL enabled server. Enabled by default.
451 =item B<CACert> I<File>
453 File that holds one or more SSL certificates. If you want to use HTTPS you will
454 possibly need this option. What CA certificates come bundled with C<libcurl>
455 and are checked by default depends on the distribution you use.
459 =head2 Plugin C<bind>
461 Starting with BIND 9.5.0, the most widely used DNS server software provides
462 extensive statistics about queries, responses and lots of other information.
463 The bind plugin retrieves this information that's encoded in XML and provided
464 via HTTP and submits the values to collectd.
466 To use this plugin, you first need to tell BIND to make this information
467 available. This is done with the C<statistics-channels> configuration option:
469 statistics-channels {
470 inet localhost port 8053;
473 The configuration follows the grouping that can be seen when looking at the
474 data with an XSLT compatible viewer, such as a modern web browser. It's
475 probably a good idea to make yourself familiar with the provided values, so you
476 can understand what the collected statistics actually mean.
481 URL "http://localhost:8053/"
495 Zone "127.in-addr.arpa/IN"
499 The bind plugin accepts the following configuration options:
505 URL from which to retrieve the XML data. If not specified,
506 C<http://localhost:8053/> will be used.
508 =item B<OpCodes> I<true>|I<false>
510 When enabled, statistics about the I<"OpCodes">, for example the number of
511 C<QUERY> packets, are collected.
515 =item B<QTypes> I<true>|I<false>
517 When enabled, the number of I<incoming> queries by query types (for example
518 C<A>, C<MX>, C<AAAA>) is collected.
522 =item B<ServerStats> I<true>|I<false>
524 Collect global server statistics, such as requests received over IPv4 and IPv6,
525 successful queries, and failed updates.
529 =item B<ZoneMaintStats> I<true>|I<false>
531 Collect zone maintenance statistics, mostly information about notifications
532 (zone updates) and zone transfers.
536 =item B<ResolverStats> I<true>|I<false>
538 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
539 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
540 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
541 default. Use the B<ResolverStats> option within a B<View "_default"> block
542 instead for the same functionality.
548 Collect global memory statistics.
552 =item B<View> I<Name>
554 Collect statistics about a specific I<"view">. BIND can behave different,
555 mostly depending on the source IP-address of the request. These different
556 configurations are called "views". If you don't use this feature, you most
557 likely are only interested in the C<_default> view.
559 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
560 information you want to collect about a view. If no B<View> block is
561 configured, no detailed view statistics will be collected.
565 =item B<QTypes> I<true>|I<false>
567 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
572 =item B<ResolverStats> I<true>|I<false>
574 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
575 (e.E<nbsp>g. queries over IPv4, lame servers).
579 =item B<CacheRRSets> I<true>|I<false>
581 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
582 type is collected. Negative entries (queries which resulted in an error, for
583 example names that do not exist) are reported with a leading exclamation mark,
588 =item B<Zone> I<Name>
590 When given, collect detailed information about the given zone in the view. The
591 information collected if very similar to the global B<ServerStats> information
594 You can repeat this option to collect detailed information about multiple
597 By default no detailed zone information is collected.
603 =head2 Plugin C<cpufreq>
605 This plugin doesn't have any options. It reads
606 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
607 installed) to get the current CPU frequency. If this file does not exist make
608 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
609 installed and an "cpu governor" (that's a kernel module) is loaded.
615 =item B<DataDir> I<Directory>
617 Set the directory to store CSV-files under. Per default CSV-files are generated
618 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
619 The special strings B<stdout> and B<stderr> can be used to write to the standard
620 output and standard error channels, respectively. This, of course, only makes
621 much sense when collectd is running in foreground- or non-daemon-mode.
623 =item B<StoreRates> B<true|false>
625 If set to B<true>, convert counter values to rates. If set to B<false> (the
626 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
631 =head2 Plugin C<curl>
633 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
634 and the match infrastructure (the same code used by the tail plugin) to use
635 regular expressions with the received data.
637 The following example will read the current value of AMD stock from Google's
638 finance page and dispatch the value to collectd.
641 <Page "stock_quotes">
642 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
646 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
647 DSType "GaugeAverage"
648 # Note: `stock_value' is not a standard type.
655 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
656 a web page and one or more "matches" to be performed on the returned data. The
657 string argument to the B<Page> block is used as plugin instance.
659 The following options are valid within B<Page> blocks:
665 URL of the web site to retrieve. Since a regular expression will be used to
666 extract information from this data, non-binary data is a big plus here ;)
668 =item B<User> I<Name>
670 Username to use if authorization is required to read the page.
672 =item B<Password> I<Password>
674 Password to use if authorization is required to read the page.
676 =item B<VerifyPeer> B<true>|B<false>
678 Enable or disable peer SSL certificate verification. See
679 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
681 =item B<VerifyHost> B<true>|B<false>
683 Enable or disable peer host name verification. If enabled, the plugin checks if
684 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
685 matches the host name provided by the B<URL> option. If this identity check
686 fails, the connection is aborted. Obviously, only works when connecting to a
687 SSL enabled server. Enabled by default.
689 =item B<CACert> I<file>
691 File that holds one or more SSL certificates. If you want to use HTTPS you will
692 possibly need this option. What CA certificates come bundled with C<libcurl>
693 and are checked by default depends on the distribution you use.
695 =item B<MeasureResponseTime> B<true>|B<false>
697 Measure response time for the request. If this setting is enabled, B<Match>
698 blocks (see below) are optional. Disabled by default.
700 =item B<E<lt>MatchE<gt>>
702 One or more B<Match> blocks that define how to match information in the data
703 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
704 used by the C<tail> plugin, so please see the documentation of the C<tail>
705 plugin below on how matches are defined. If the B<MeasureResponseTime> option
706 is set to B<true>, B<Match> blocks are optional.
710 =head2 Plugin C<curl_json>
712 The B<curl_json plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and
713 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) to retrieve JSON data
714 via cURL. This can be used to collect values from CouchDB documents (which are
715 stored JSON notation), for example.
717 The following example will collect several values from the built-in `_stats'
718 runtime statistics module of CouchDB
719 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
722 <URL "http://localhost:5984/_stats">
724 <Key "httpd/requests/count">
728 <Key "httpd_request_methods/*/count">
729 Type "http_request_methods"
732 <Key "httpd_status_codes/*/count">
733 Type "http_response_codes"
738 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining
739 a URL to be fetched via HTTP (using libcurl) and one or more B<Key> blocks.
740 The B<Key> string argument must be in a path format, which is used to collect a
741 value from a JSON map object. If a path element of B<Key> is the
742 I<*>E<nbsp>wildcard, the values for all keys will be collectd.
744 The following options are valid within B<URL> blocks:
748 =item B<Instance> I<Instance>
750 Sets the plugin instance to I<Instance>.
752 =item B<User> I<Name>
754 Username to use if authorization is required to read the page.
756 =item B<Password> I<Password>
758 Password to use if authorization is required to read the page.
760 =item B<VerifyPeer> B<true>|B<false>
762 Enable or disable peer SSL certificate verification. See
763 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
765 =item B<VerifyHost> B<true>|B<false>
767 Enable or disable peer host name verification. If enabled, the plugin checks if
768 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
769 matches the host name provided by the B<URL> option. If this identity check
770 fails, the connection is aborted. Obviously, only works when connecting to a
771 SSL enabled server. Enabled by default.
773 =item B<CACert> I<file>
775 File that holds one or more SSL certificates. If you want to use HTTPS you will
776 possibly need this option. What CA certificates come bundled with C<libcurl>
777 and are checked by default depends on the distribution you use.
781 The following options are valid within B<Key> blocks:
785 =item B<Type> I<Type>
787 Sets the type used to dispatch the values to the daemon. Detailed information
788 about types and their configuration can be found in L<types.db(5)>. This
791 =item B<Instance> I<Instance>
793 Type-instance to use. Defaults to the current map key or current string array element value.
797 =head2 Plugin C<curl_xml>
799 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
800 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
803 <URL "http://localhost/stats.xml">
805 Instance "some_instance"
810 CACert "/path/to/ca.crt"
812 <XPath "table[@id=\"magic_level\"]/tr">
814 #InstancePrefix "prefix-"
816 ValuesFrom "td[2]/span[@class=\"level\"]"
821 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
822 URL to be fetched via HTTP (using libcurl). Within each B<URL> block there are
823 options which specify the connection parameters, for example authentication
824 information, and one or more B<XPath> blocks.
826 Each B<XPath> block specifies how to get one type of information. The
827 string argument must be a valid XPath expression which returns a list
828 of "base elements". One value is dispatched for each "base element". The
829 I<type instance> and values are looked up using further I<XPath> expressions
830 that should be relative to the base element.
832 Within the B<URL> block the following options are accepted:
836 =item B<Host> I<Name>
838 Use I<Name> as the host name when submitting values. Defaults to the global
841 =item B<Instance> I<Instance>
843 Use I<Instance> as the plugin instance when submitting values. Defaults to an
844 empty string (no plugin instance).
846 =item B<User> I<User>
847 =item B<Password> I<Password>
848 =item B<VerifyPeer> B<true>|B<false>
849 =item B<VerifyHost> B<true>|B<false>
850 =item B<CACert> I<CA Cert File>
852 These options behave exactly equivalent to the appropriate options of the
853 I<cURL> and I<cURL-JSON> plugins. Please see there for a detailed description.
855 =item E<lt>B<XPath> I<XPath-expression>E<gt>
857 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
858 B<XPath> block specifies how to get one type of information. The string
859 argument must be a valid XPath expression which returns a list of "base
860 elements". One value is dispatched for each "base element".
862 Within the B<XPath> block the following options are accepted:
866 =item B<Type> I<Type>
868 Specifies the I<Type> used for submitting patches. This determines the number
869 of values that are required / expected and whether the strings are parsed as
870 signed or unsigned integer or as double values. See L<types.db(5)> for details.
871 This option is required.
873 =item B<InstancePrefix> I<InstancePrefix>
875 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
876 concatenated together without any separator.
877 This option is optional.
879 =item B<InstanceFrom> I<InstanceFrom>
881 Specifies a XPath expression to use for determining the I<type instance>. The
882 XPath expression must return exactly one element. The element's value is then
883 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
885 This value is required. As a special exception, if the "base XPath expression"
886 (the argument to the B<XPath> block) returns exactly one argument, then this
887 option may be omitted.
889 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
891 Specifies one or more XPath expression to use for reading the values. The
892 number of XPath expressions must match the number of data sources in the
893 I<type> specified with B<Type> (see above). Each XPath expression must return
894 exactly one element. The element's value is then parsed as a number and used as
895 value for the appropriate value in the value list dispatched to the daemon.
903 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
904 connect to various databases, execute I<SQL> statements and read back the
905 results. I<dbi> is an acronym for "database interface" in case you were
906 wondering about the name. You can configure how each column is to be
907 interpreted and the plugin will generate one or more data sets from each row
908 returned according to these rules.
910 Because the plugin is very generic, the configuration is a little more complex
911 than those of other plugins. It usually looks something like this:
914 <Query "out_of_stock">
915 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
916 # Use with MySQL 5.0.0 or later
920 InstancePrefix "out_of_stock"
921 InstancesFrom "category"
925 <Database "product_information">
927 DriverOption "host" "localhost"
928 DriverOption "username" "collectd"
929 DriverOption "password" "aZo6daiw"
930 DriverOption "dbname" "prod_info"
936 The configuration above defines one query with one result and one database. The
937 query is then linked to the database with the B<Query> option I<within> the
938 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
939 and you can also use the B<Include> statement to split up the configuration
940 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
941 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
944 The following is a complete list of options:
946 =head3 B<Query> blocks
948 Query blocks define I<SQL> statements and how the returned data should be
949 interpreted. They are identified by the name that is given in the opening line
950 of the block. Thus the name needs to be unique. Other than that, the name is
951 not used in collectd.
953 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
954 define which column holds which value or instance information. You can use
955 multiple B<Result> blocks to create multiple values from one returned row. This
956 is especially useful, when queries take a long time and sending almost the same
957 query again and again is not desirable.
961 <Query "environment">
962 Statement "select station, temperature, humidity from environment"
965 # InstancePrefix "foo"
966 InstancesFrom "station"
967 ValuesFrom "temperature"
971 InstancesFrom "station"
972 ValuesFrom "humidity"
976 The following options are accepted:
980 =item B<Statement> I<SQL>
982 Sets the statement that should be executed on the server. This is B<not>
983 interpreted by collectd, but simply passed to the database server. Therefore,
984 the SQL dialect that's used depends on the server collectd is connected to.
986 The query has to return at least two columns, one for the instance and one
987 value. You cannot omit the instance, even if the statement is guaranteed to
988 always return exactly one line. In that case, you can usually specify something
991 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
993 (That works with MySQL but may not be valid SQL according to the spec. If you
994 use a more strict database server, you may have to select from a dummy table or
997 Please note that some databases, for example B<Oracle>, will fail if you
998 include a semicolon at the end of the statement.
1000 =item B<MinVersion> I<Version>
1002 =item B<MaxVersion> I<Value>
1004 Only use this query for the specified database version. You can use these
1005 options to provide multiple queries with the same name but with a slightly
1006 different syntax. The plugin will use only those queries, where the specified
1007 minimum and maximum versions fit the version of the database in use.
1009 The database version is determined by C<dbi_conn_get_engine_version>, see the
1010 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1011 for details. Basically, each part of the version is assumed to be in the range
1012 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1013 "40102", version "5.0.42" becomes "50042".
1015 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1016 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1017 happen. Don't to it! A valid example would be something along these lines:
1028 In the above example, there are three ranges that don't overlap. The last one
1029 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1030 before "4.0.0" are not specified.
1032 =item B<Type> I<Type>
1034 The B<type> that's used for each line returned. See L<types.db(5)> for more
1035 details on how types are defined. In short: A type is a predefined layout of
1036 data and the number of values and type of values has to match the type
1039 If you specify "temperature" here, you need exactly one gauge column. If you
1040 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1043 There must be exactly one B<Type> option inside each B<Result> block.
1045 =item B<InstancePrefix> I<prefix>
1047 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1048 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1049 all strings returned in the appropriate columns are concatenated together,
1050 separated by dashes I<("-")>.
1052 =item B<InstancesFrom> I<column0> [I<column1> ...]
1054 Specifies the columns whose values will be used to create the "type-instance"
1055 for each row. If you specify more than one column, the value of all columns
1056 will be joined together with dashes I<("-")> as separation characters.
1058 The plugin itself does not check whether or not all built instances are
1059 different. It's your responsibility to assure that each is unique. This is
1060 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1061 sure that only one row is returned in this case.
1063 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1066 =item B<ValuesFrom> I<column0> [I<column1> ...]
1068 Names the columns whose content is used as the actual data for the data sets
1069 that are dispatched to the daemon. How many such columns you need is determined
1070 by the B<Type> setting above. If you specify too many or not enough columns,
1071 the plugin will complain about that and no data will be submitted to the
1074 The actual data type in the columns is not that important. The plugin will
1075 automatically cast the values to the right type if it know how to do that. So
1076 it should be able to handle integer an floating point types, as well as strings
1077 (if they include a number at the beginning).
1079 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1083 =head3 B<Database> blocks
1085 Database blocks define a connection to a database and which queries should be
1086 sent to that database. Since the used "dbi" library can handle a wide variety
1087 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1088 documentationE<nbsp>- we stick as close to the terminology used there.
1090 Each database needs a "name" as string argument in the starting tag of the
1091 block. This name will be used as "PluginInstance" in the values submitted to
1092 the daemon. Other than that, that name is not used.
1096 =item B<Driver> I<Driver>
1098 Specifies the driver to use to connect to the database. In many cases those
1099 drivers are named after the database they can connect to, but this is not a
1100 technical necessity. These drivers are sometimes referred to as "DBD",
1101 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1102 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1103 project at L<http://libdbi-drivers.sourceforge.net/>.
1105 You need to give the driver name as expected by the "dbi" library here. You
1106 should be able to find that in the documentation for each driver. If you
1107 mistype the driver name, the plugin will dump a list of all known driver names
1110 =item B<DriverOption> I<Key> I<Value>
1112 Sets driver-specific options. What option a driver supports can be found in the
1113 documentation for each driver, somewhere at
1114 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1115 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1117 Unfortunately, drivers are not too keen to report errors when an unknown option
1118 is passed to them, so invalid settings here may go unnoticed. This is not the
1119 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1120 the driver. If a driver complains about an option, the plugin will dump a
1121 complete list of all options understood by that driver to the log.
1123 =item B<SelectDB> I<Database>
1125 In some cases, the database name you connect with is not the database name you
1126 want to use for querying data. If this option is set, the plugin will "select"
1127 (switch to) that database after the connection is established.
1129 =item B<Query> I<QueryName>
1131 Associates the query named I<QueryName> with this database connection. The
1132 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1133 blocks you want to refer to must be placed above the database block you want to
1142 =item B<Device> I<Device>
1144 Select partitions based on the devicename.
1146 =item B<MountPoint> I<Directory>
1148 Select partitions based on the mountpoint.
1150 =item B<FSType> I<FSType>
1152 Select partitions based on the filesystem type.
1154 =item B<IgnoreSelected> B<true>|B<false>
1156 Invert the selection: If set to true, all partitions B<except> the ones that
1157 match any one of the criteria are collected. By default only selected
1158 partitions are collected if a selection is made. If no selection is configured
1159 at all, B<all> partitions are selected.
1161 =item B<ReportByDevice> B<true>|B<false>
1163 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1164 (the default), it will report a disk as "root", but with it I<true>, it will be
1165 "sda1" (or whichever).
1167 =item B<ReportInodes> B<true>|B<false>
1169 Enables or disables reporting of free, reserved and used inodes. Defaults to
1170 inode collection being disabled.
1172 Enable this option if inodes are a scarce resource for you, usually because
1173 many small files are stored on the disk. This is a usual scenario for mail
1174 transfer agents and web caches.
1178 =head2 Plugin C<disk>
1180 The C<disk> plugin collects information about the usage of physical disks and
1181 logical disks (partitions). Values collected are the number of octets written
1182 to and read from a disk or partition, the number of read/write operations
1183 issued to the disk and a rather complex "time" it took for these commands to be
1186 Using the following two options you can ignore some disks or configure the
1187 collection only of specific disks.
1191 =item B<Disk> I<Name>
1193 Select the disk I<Name>. Whether it is collected or ignored depends on the
1194 B<IgnoreSelected> setting, see below. As with other plugins that use the
1195 daemon's ignorelist functionality, a string that starts and ends with a slash
1196 is interpreted as a regular expression. Examples:
1201 =item B<IgnoreSelected> B<true>|B<false>
1203 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1204 statements, are ignored or if all other disks are ignored. The behavior
1205 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1206 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1207 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1208 is set to B<true>, all disks are collected B<except> the ones matched.
1212 =head2 Plugin C<dns>
1216 =item B<Interface> I<Interface>
1218 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1219 option sets the interface that should be used. If this option is not set, or
1220 set to "any", the plugin will try to get packets from B<all> interfaces. This
1221 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1223 =item B<IgnoreSource> I<IP-address>
1225 Ignore packets that originate from this address.
1227 =item B<SelectNumericQueryTypes> B<true>|B<false>
1229 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1233 =head2 Plugin C<email>
1237 =item B<SocketFile> I<Path>
1239 Sets the socket-file which is to be created.
1241 =item B<SocketGroup> I<Group>
1243 If running as root change the group of the UNIX-socket after it has been
1244 created. Defaults to B<collectd>.
1246 =item B<SocketPerms> I<Permissions>
1248 Change the file permissions of the UNIX-socket after it has been created. The
1249 permissions must be given as a numeric, octal value as you would pass to
1250 L<chmod(1)>. Defaults to B<0770>.
1252 =item B<MaxConns> I<Number>
1254 Sets the maximum number of connections that can be handled in parallel. Since
1255 this many threads will be started immediately setting this to a very high
1256 value will waste valuable resources. Defaults to B<5> and will be forced to be
1257 at most B<16384> to prevent typos and dumb mistakes.
1261 =head2 Plugin C<exec>
1263 Please make sure to read L<collectd-exec(5)> before using this plugin. It
1264 contains valuable information on when the executable is executed and the
1265 output that is expected from it.
1269 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1271 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1273 Execute the executable I<Executable> as user I<User>. If the user name is
1274 followed by a colon and a group name, the effective group is set to that group.
1275 The real group and saved-set group will be set to the default group of that
1276 user. If no group is given the effective group ID will be the same as the real
1279 Please note that in order to change the user and/or group the daemon needs
1280 superuser privileges. If the daemon is run as an unprivileged user you must
1281 specify the same user/group here. If the daemon is run with superuser
1282 privileges, you must supply a non-root user here.
1284 The executable may be followed by optional arguments that are passed to the
1285 program. Please note that due to the configuration parsing numbers and boolean
1286 values may be changed. If you want to be absolutely sure that something is
1287 passed as-is please enclose it in quotes.
1289 The B<Exec> and B<NotificationExec> statements change the semantics of the
1290 programs executed, i.E<nbsp>e. the data passed to them and the response
1291 expected from them. This is documented in great detail in L<collectd-exec(5)>.
1295 =head2 Plugin C<filecount>
1297 The C<filecount> plugin counts the number of files in a certain directory (and
1298 its subdirectories) and their combined size. The configuration is very straight
1301 <Plugin "filecount">
1302 <Directory "/var/qmail/queue/mess">
1303 Instance "qmail-message"
1305 <Directory "/var/qmail/queue/todo">
1306 Instance "qmail-todo"
1308 <Directory "/var/lib/php5">
1309 Instance "php5-sessions"
1314 The example above counts the number of files in QMail's queue directories and
1315 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
1316 QMail has not yet looked at, the "message" queue holds the messages that were
1317 classified into "local" and "remote".
1319 As you can see, the configuration consists of one or more C<Directory> blocks,
1320 each of which specifies a directory in which to count the files. Within those
1321 blocks, the following options are recognized:
1325 =item B<Instance> I<Instance>
1327 Sets the plugin instance to I<Instance>. That instance name must be unique, but
1328 it's your responsibility, the plugin doesn't check for that. If not given, the
1329 instance is set to the directory name with all slashes replaced by underscores
1330 and all leading underscores removed.
1332 =item B<Name> I<Pattern>
1334 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
1335 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
1336 against the pattern, not the entire path. In case this makes it easier for you:
1337 This option has been named after the B<-name> parameter to L<find(1)>.
1339 =item B<MTime> I<Age>
1341 Count only files of a specific age: If I<Age> is greater than zero, only files
1342 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
1343 a negative number, this is inversed. For example, if B<-60> is specified, only
1344 files that have been modified in the last minute will be counted.
1346 The number can also be followed by a "multiplier" to easily specify a larger
1347 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
1348 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
1349 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
1350 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
1351 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
1354 =item B<Size> I<Size>
1356 Count only files of a specific size. When I<Size> is a positive number, only
1357 files that are at least this big are counted. If I<Size> is a negative number,
1358 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
1359 I<Size> are counted.
1361 As with the B<MTime> option, a "multiplier" may be added. For a detailed
1362 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
1363 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
1364 note that there are 1000 bytes in a kilobyte, not 1024.
1366 =item B<Recursive> I<true>|I<false>
1368 Controls whether or not to recurse into subdirectories. Enabled by default.
1370 =item B<IncludeHidden> I<true>|I<false>
1372 Controls whether or not to include "hidden" files and directories in the count.
1373 "Hidden" files and directories are those, whose name begins with a dot.
1374 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
1378 =head2 Plugin C<GenericJMX>
1380 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
1381 L<collectd-java(5)>.
1383 =head2 Plugin C<gmond>
1385 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
1386 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
1387 are built-in, custom mappings may be added via B<Metric> blocks, see below.
1392 MCReceiveFrom "239.2.11.71" "8649"
1393 <Metric "swap_total">
1395 TypeInstance "total"
1398 <Metric "swap_free">
1405 The following metrics are built-in:
1411 load_one, load_five, load_fifteen
1415 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
1419 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
1431 Available configuration options:
1435 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
1437 Sets sets the multicast group and UDP port to which to subscribe.
1439 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
1441 =item E<lt>B<Metric> I<Name>E<gt>
1443 These blocks add a new metric conversion to the internal table. I<Name>, the
1444 string argument to the B<Metric> block, is the metric name as used by Ganglia.
1448 =item B<Type> I<Type>
1450 Type to map this metric to. Required.
1452 =item B<TypeInstance> I<Instance>
1454 Type-instance to use. Optional.
1456 =item B<DataSource> I<Name>
1458 Data source to map this metric to. If the configured type has exactly one data
1459 source, this is optional. Otherwise the option is required.
1465 =head2 Plugin C<hddtemp>
1467 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
1468 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
1469 default values, see below. C<hddtemp> has to be running to work correctly. If
1470 C<hddtemp> is not running timeouts may appear which may interfere with other
1473 The B<hddtemp> homepage can be found at
1474 L<http://www.guzu.net/linux/hddtemp.php>.
1478 =item B<Host> I<Hostname>
1480 Hostname to connect to. Defaults to B<127.0.0.1>.
1482 =item B<Port> I<Port>
1484 TCP-Port to connect to. Defaults to B<7634>.
1488 =head2 Plugin C<interface>
1492 =item B<Interface> I<Interface>
1494 Select this interface. By default these interfaces will then be collected. For
1495 a more detailed description see B<IgnoreSelected> below.
1497 =item B<IgnoreSelected> I<true>|I<false>
1499 If no configuration if given, the B<traffic>-plugin will collect data from
1500 all interfaces. This may not be practical, especially for loopback- and
1501 similar interfaces. Thus, you can use the B<Interface>-option to pick the
1502 interfaces you're interested in. Sometimes, however, it's easier/preferred
1503 to collect all interfaces I<except> a few ones. This option enables you to
1504 do that: By setting B<IgnoreSelected> to I<true> the effect of
1505 B<Interface> is inverted: All selected interfaces are ignored and all
1506 other interfaces are collected.
1510 =head2 Plugin C<ipmi>
1514 =item B<Sensor> I<Sensor>
1516 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
1518 =item B<IgnoreSelected> I<true>|I<false>
1520 If no configuration if given, the B<ipmi> plugin will collect data from all
1521 sensors found of type "temperature", "voltage", "current" and "fanspeed".
1522 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
1523 the effect of B<Sensor> is inverted: All selected sensors are ignored and
1524 all other sensors are collected.
1526 =item B<NotifySensorAdd> I<true>|I<false>
1528 If a sensor appears after initialization time of a minute a notification
1531 =item B<NotifySensorRemove> I<true>|I<false>
1533 If a sensor disappears a notification is sent.
1535 =item B<NotifySensorNotPresent> I<true>|I<false>
1537 If you have for example dual power supply and one of them is (un)plugged then
1538 a notification is sent.
1542 =head2 Plugin C<iptables>
1546 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
1548 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
1549 will collect the counters of all rules which have a comment-match. The comment
1550 is then used as type-instance.
1552 If I<Comment> or I<Number> is given, only the rule with the matching comment or
1553 the I<n>th rule will be collected. Again, the comment (or the number) will be
1554 used as the type-instance.
1556 If I<Name> is supplied, it will be used as the type-instance instead of the
1557 comment or the number.
1561 =head2 Plugin C<irq>
1567 Select this irq. By default these irqs will then be collected. For a more
1568 detailed description see B<IgnoreSelected> below.
1570 =item B<IgnoreSelected> I<true>|I<false>
1572 If no configuration if given, the B<irq>-plugin will collect data from all
1573 irqs. This may not be practical, especially if no interrupts happen. Thus, you
1574 can use the B<Irq>-option to pick the interrupt you're interested in.
1575 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
1576 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
1577 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
1578 and all other interrupts are collected.
1582 =head2 Plugin C<java>
1584 The I<Java> plugin makes it possible to write extensions for collectd in Java.
1585 This section only discusses the syntax and semantic of the configuration
1586 options. For more in-depth information on the I<Java> plugin, please read
1587 L<collectd-java(5)>.
1592 JVMArg "-verbose:jni"
1593 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
1594 LoadPlugin "org.collectd.java.Foobar"
1595 <Plugin "org.collectd.java.Foobar">
1596 # To be parsed by the plugin
1600 Available configuration options:
1604 =item B<JVMArg> I<Argument>
1606 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
1607 exactly the way the arguments to the I<java> binary on the command line work.
1608 Execute C<javaE<nbsp>--help> for details.
1610 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
1611 any other options! When another option is found, the JVM will be started and
1612 later options will have to be ignored!
1614 =item B<LoadPlugin> I<JavaClass>
1616 Instantiates a new I<JavaClass> object. The constructor of this object very
1617 likely then registers one or more callback methods with the server.
1619 See L<collectd-java(5)> for details.
1621 When the first such option is found, the virtual machine (JVM) is created. This
1622 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
1623 B<LoadPlugin> options!
1625 =item B<Plugin> I<Name>
1627 The entire block is passed to the Java plugin as an
1628 I<org.collectd.api.OConfigItem> object.
1630 For this to work, the plugin has to register a configuration callback first,
1631 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
1632 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
1633 depends on the (Java) plugin registering the callback and is completely
1634 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
1638 =head2 Plugin C<libvirt>
1640 This plugin allows CPU, disk and network load to be collected for virtualized
1641 guests on the machine. This means that these characteristics can be collected
1642 for guest systems without installing any software on them - collectd only runs
1643 on the hosting system. The statistics are collected through libvirt
1644 (L<http://libvirt.org/>).
1646 Only I<Connection> is required.
1650 =item B<Connection> I<uri>
1652 Connect to the hypervisor given by I<uri>. For example if using Xen use:
1654 Connection "xen:///"
1656 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
1658 =item B<RefreshInterval> I<seconds>
1660 Refresh the list of domains and devices every I<seconds>. The default is 60
1661 seconds. Setting this to be the same or smaller than the I<Interval> will cause
1662 the list of domains and devices to be refreshed on every iteration.
1664 Refreshing the devices in particular is quite a costly operation, so if your
1665 virtualization setup is static you might consider increasing this. If this
1666 option is set to 0, refreshing is disabled completely.
1668 =item B<Domain> I<name>
1670 =item B<BlockDevice> I<name:dev>
1672 =item B<InterfaceDevice> I<name:dev>
1674 =item B<IgnoreSelected> I<true>|I<false>
1676 Select which domains and devices are collected.
1678 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
1679 disk/network devices are collected.
1681 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
1682 domains and disk/network devices are ignored, while the rest are collected.
1684 The domain name and device names may use a regular expression, if the name is
1685 surrounded by I</.../> and collectd was compiled with support for regexps.
1687 The default is to collect statistics for all domains and all their devices.
1691 BlockDevice "/:hdb/"
1692 IgnoreSelected "true"
1694 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
1697 =item B<HostnameFormat> B<name|uuid|hostname|...>
1699 When the libvirt plugin logs data, it sets the hostname of the collected data
1700 according to this setting. The default is to use the guest name as provided by
1701 the hypervisor, which is equal to setting B<name>.
1703 B<uuid> means use the guest's UUID. This is useful if you want to track the
1704 same guest across migrations.
1706 B<hostname> means to use the global B<Hostname> setting, which is probably not
1707 useful on its own because all guests will appear to have the same name.
1709 You can also specify combinations of these fields. For example B<name uuid>
1710 means to concatenate the guest name and UUID (with a literal colon character
1711 between, thus I<"foo:1234-1234-1234-1234">).
1713 =item B<InterfaceFormat> B<name>|B<address>
1715 When the libvirt plugin logs interface data, it sets the name of the collected
1716 data according to this setting. The default is to use the path as provided by
1717 the hypervisor (the "dev" property of the target node), which is equal to
1720 B<address> means use the interface's mac address. This is useful since the
1721 interface path might change between reboots of a guest or across migrations.
1725 =head2 Plugin C<logfile>
1729 =item B<LogLevel> B<debug|info|notice|warning|err>
1731 Sets the log-level. If, for example, set to B<notice>, then all events with
1732 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
1734 Please note that B<debug> is only available if collectd has been compiled with
1737 =item B<File> I<File>
1739 Sets the file to write log messages to. The special strings B<stdout> and
1740 B<stderr> can be used to write to the standard output and standard error
1741 channels, respectively. This, of course, only makes much sense when I<collectd>
1742 is running in foreground- or non-daemon-mode.
1744 =item B<Timestamp> B<true>|B<false>
1746 Prefix all lines printed by the current time. Defaults to B<true>.
1748 =item B<PrintSeverity> B<true>|B<false>
1750 When enabled, all lines are prefixed by the severity of the log message, for
1751 example "warning". Defaults to B<false>.
1755 B<Note>: There is no need to notify the daemon after moving or removing the
1756 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
1757 for each line it writes.
1759 =head2 Plugin C<lpar>
1761 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
1762 virtualization technique for IBM POWER processors. It takes into account CPU
1763 time stolen from or donated to a partition, in addition to the usual user,
1764 system, I/O statistics.
1766 The following configuration options are available:
1770 =item B<CpuPoolStats> B<false>|B<true>
1772 When enabled, statistics about the processor pool are read, too. The partition
1773 needs to have pool authority in order to be able to acquire this information.
1776 =item B<ReportBySerial> B<false>|B<true>
1778 If enabled, the serial of the physical machine the partition is currently
1779 running on is reported as I<hostname> and the logical hostname of the machine
1780 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
1781 used (just like other plugins) and the I<plugin instance> will be empty.
1786 =head2 Plugin C<mbmon>
1788 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
1790 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
1791 B<Host> and B<Port> options can be used to change these values, see below.
1792 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
1793 timeouts may appear which may interfere with other statistics..
1795 C<mbmon> must be run with the -r option ("print TAG and Value format");
1796 Debian's F</etc/init.d/mbmon> script already does this, other people
1797 will need to ensure that this is the case.
1801 =item B<Host> I<Hostname>
1803 Hostname to connect to. Defaults to B<127.0.0.1>.
1805 =item B<Port> I<Port>
1807 TCP-Port to connect to. Defaults to B<411>.
1811 =head2 Plugin C<memcachec>
1813 The C<memcachec plugin> connects to a memcached server, queries one or more
1814 given I<pages> and parses the returned data according to user specification.
1815 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
1818 In order to talk to the memcached server, this plugin uses the I<libmemcached>
1819 library. Please note that there is another library with a very similar name,
1820 libmemcache (notice the missing `d'), which is not applicable.
1822 Synopsis of the configuration:
1824 <Plugin "memcachec">
1825 <Page "plugin_instance">
1829 Regex "(\\d+) bytes sent"
1832 Instance "type_instance"
1837 The configuration options are:
1841 =item E<lt>B<Page> I<Name>E<gt>
1843 Each B<Page> block defines one I<page> to be queried from the memcached server.
1844 The block requires one string argument which is used as I<plugin instance>.
1846 =item B<Server> I<Address>
1848 Sets the server address to connect to when querying the page. Must be inside a
1853 When connected to the memcached server, asks for the page I<Key>.
1855 =item E<lt>B<Match>E<gt>
1857 Match blocks define which strings to look for and how matches substrings are
1858 interpreted. For a description of match blocks, please see L<"Plugin tail">.
1862 =head2 Plugin C<memcached>
1864 The C<memcached plugin> connects to a memcached server and queries statistics
1865 about cache utilization, memory and bandwidth used.
1866 L<http://www.danga.com/memcached/>
1870 =item B<Host> I<Hostname>
1872 Hostname to connect to. Defaults to B<127.0.0.1>.
1874 =item B<Port> I<Port>
1876 TCP-Port to connect to. Defaults to B<11211>.
1880 =head2 Plugin C<modbus>
1882 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
1883 register values. It supports reading single registers (unsigned 16E<nbsp>bit
1884 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
1885 values (two registers interpreted as IEEE floats in big endian notation).
1889 <Data "voltage-input-1">
1896 <Data "voltage-input-2">
1903 <Host "modbus.example.com">
1904 Address "192.168.0.42"
1909 Instance "power-supply"
1910 Collect "voltage-input-1"
1911 Collect "voltage-input-2"
1917 =item E<lt>B<Data> I<Name>E<gt> blocks
1919 Data blocks define a mapping between register numbers and the "types" used by
1922 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
1926 =item B<RegisterBase> I<Number>
1928 Configures the base register to read from the device. If the option
1929 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
1930 register will be read (the register number is increased by one).
1932 =item B<RegisterType> B<Uint16>|B<Uint32>|B<Float>
1934 Specifies what kind of data is returned by the device. If the type is B<Uint32>
1935 or B<Float>, two 16E<nbsp>bit registers will be read and the data is combined
1936 into one value. Defaults to B<Uint16>.
1938 =item B<Type> I<Type>
1940 Specifies the "type" (data set) to use when dispatching the value to
1941 I<collectd>. Currently, only data sets with exactly one data source are
1944 =item B<Instance> I<Instance>
1946 Sets the type instance to use when dispatching the value to I<collectd>. If
1947 unset, an empty string (no type instance) is used.
1951 =item E<lt>B<Host> I<Name>E<gt> blocks
1953 Host blocks are used to specify to which hosts to connect and what data to read
1954 from their "slaves". The string argument I<Name> is used as hostname when
1955 dispatching the values to I<collectd>.
1957 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
1961 =item B<Address> I<Hostname>
1963 Specifies the node name (the actual network address) used to connect to the
1964 host. This may be an IP address or a hostname. Please note that the used
1965 I<libmodbus> library only supports IPv4 at the moment.
1967 =item B<Port> I<Service>
1969 Specifies the port used to connect to the host. The port can either be given as
1970 a number or as a service name. Please note that the I<Service> argument must be
1971 a string, even if ports are given in their numerical form. Defaults to "502".
1973 =item B<Interval> I<Interval>
1975 Sets the interval (in seconds) in which the values will be collected from this
1976 host. By default the global B<Interval> setting will be used.
1978 =item E<lt>B<Slave> I<ID>E<gt>
1980 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
1981 is used to specify which device should be addressed. For each device you want
1982 to query, one B<Slave> block must be given.
1984 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
1988 =item B<Instance> I<Instance>
1990 Specify the plugin instance to use when dispatching the values to I<collectd>.
1991 By default "slave_I<ID>" is used.
1993 =item B<Collect> I<DataName>
1995 Specifies which data to retrieve from the device. I<DataName> must be the same
1996 string as the I<Name> argument passed to a B<Data> block. You can specify this
1997 option multiple times to collect more than one value from a slave. At least one
1998 B<Collect> option is mandatory.
2006 =head2 Plugin C<mysql>
2008 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
2009 one or more databases when started and keeps the connection up as long as
2010 possible. When the connection is interrupted for whatever reason it will try
2011 to re-connect. The plugin will complain loudly in case anything goes wrong.
2013 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
2014 and collects information about MySQL network traffic, executed statements,
2015 requests, the query cache and threads by evaluating the
2016 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
2017 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
2018 Status Variables> for an explanation of these values.
2020 Optionally, master and slave statistics may be collected in a MySQL
2021 replication setup. In that case, information about the synchronization state
2022 of the nodes are collected by evaluating the C<Position> return value of the
2023 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
2024 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
2025 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
2026 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
2027 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
2042 Socket "/var/run/mysql/mysqld.sock"
2044 SlaveNotifications true
2048 A B<Database> block defines one connection to a MySQL database. It accepts a
2049 single argument which specifies the name of the database. None of the other
2050 options are required. MySQL will use default values as documented in the
2051 section "mysql_real_connect()" in the B<MySQL reference manual>.
2055 =item B<Host> I<Hostname>
2057 Hostname of the database server. Defaults to B<localhost>.
2059 =item B<User> I<Username>
2061 Username to use when connecting to the database. The user does not have to be
2062 granted any privileges (which is synonym to granting the C<USAGE> privilege).
2063 Any existing MySQL user will do.
2065 =item B<Password> I<Password>
2067 Password needed to log into the database.
2069 =item B<Database> I<Database>
2071 Select this database. Defaults to I<no database> which is a perfectly reasonable
2072 option for what this plugin does.
2074 =item B<Port> I<Port>
2076 TCP-port to connect to. The port must be specified in its numeric form, but it
2077 must be passed as a string nonetheless. For example:
2081 If B<Host> is set to B<localhost> (the default), this setting has no effect.
2082 See the documentation for the C<mysql_real_connect> function for details.
2084 =item B<Socket> I<Socket>
2086 Specifies the path to the UNIX domain socket of the MySQL server. This option
2087 only has any effect, if B<Host> is set to B<localhost> (the default).
2088 Otherwise, use the B<Port> option above. See the documentation for the
2089 C<mysql_real_connect> function for details.
2091 =item B<MasterStats> I<true|false>
2093 =item B<SlaveStats> I<true|false>
2095 Enable the collection of master / slave statistics in a replication setup.
2097 =item B<SlaveNotifications> I<true|false>
2099 If enabled, the plugin sends a notification if the replication slave I/O and /
2100 or SQL threads are not running.
2104 =head2 Plugin C<netapp>
2106 The netapp plugin can collect various performance and capacity information
2107 from a NetApp filer using the NetApp API.
2109 Please note that NetApp has a wide line of products and a lot of different
2110 software versions for each of these products. This plugin was developed for a
2111 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
2112 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
2113 model and software version but it is very hard to test this.
2114 If you have used this plugin with other models and/or software version, feel
2115 free to send us a mail to tell us about the results, even if it's just a short
2118 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
2119 basic authentication.
2121 B<Do not use a regular user for this!> Create a special collectd user with just
2122 the minimum of capabilities needed. The user only needs the "login-http-admin"
2123 capability as well as a few more depending on which data will be collected.
2124 Required capabilities are documented below.
2129 <Host "netapp1.example.com">
2153 IgnoreSelectedIO false
2155 IgnoreSelectedOps false
2156 GetLatency "volume0"
2157 IgnoreSelectedLatency false
2164 IgnoreSelectedCapacity false
2167 IgnoreSelectedSnapshot false
2180 The netapp plugin accepts the following configuration options:
2184 =item B<Host> I<Name>
2186 A host block defines one NetApp filer. It will appear in collectd with the name
2187 you specify here which does not have to be its real name nor its hostname.
2189 =item B<Protocol> B<httpd>|B<http>
2191 The protocol collectd will use to query this host.
2199 Valid options: http, https
2201 =item B<Address> I<Address>
2203 The hostname or IP address of the host.
2209 Default: The "host" block's name.
2211 =item B<Port> I<Port>
2213 The TCP port to connect to on the host.
2219 Default: 80 for protocol "http", 443 for protocol "https"
2221 =item B<User> I<User>
2223 =item B<Password> I<Password>
2225 The username and password to use to login to the NetApp.
2231 =item B<Interval> I<Interval>
2237 The following options decide what kind of data will be collected. You can
2238 either use them as a block and fine tune various parameters inside this block,
2239 use them as a single statement to just accept all default values, or omit it to
2240 not collect any data.
2242 The following options are valid inside all blocks:
2246 =item B<Interval> I<Seconds>
2248 Collect the respective statistics every I<Seconds> seconds. Defaults to the
2249 host specific setting.
2253 =head3 The System block
2255 This will collect various performance data about the whole system.
2257 B<Note:> To get this data the collectd user needs the
2258 "api-perf-object-get-instances" capability.
2262 =item B<Interval> I<Seconds>
2264 Collect disk statistics every I<Seconds> seconds.
2266 =item B<GetCPULoad> B<true>|B<false>
2268 If you set this option to true the current CPU usage will be read. This will be
2269 the average usage between all CPUs in your NetApp without any information about
2272 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2273 returns in the "CPU" field.
2281 Result: Two value lists of type "cpu", and type instances "idle" and "system".
2283 =item B<GetInterfaces> B<true>|B<false>
2285 If you set this option to true the current traffic of the network interfaces
2286 will be read. This will be the total traffic over all interfaces of your NetApp
2287 without any information about individual interfaces.
2289 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2290 in the "Net kB/s" field.
2300 Result: One value list of type "if_octects".
2302 =item B<GetDiskIO> B<true>|B<false>
2304 If you set this option to true the current IO throughput will be read. This
2305 will be the total IO of your NetApp without any information about individual
2306 disks, volumes or aggregates.
2308 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2309 in the "DiskE<nbsp>kB/s" field.
2317 Result: One value list of type "disk_octets".
2319 =item B<GetDiskOps> B<true>|B<false>
2321 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
2322 iSCSI, etc. operations will be read. This will be the total number of
2323 operations on your NetApp without any information about individual volumes or
2326 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2327 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
2335 Result: A variable number of value lists of type "disk_ops_complex". Each type
2336 of operation will result in one value list with the name of the operation as
2341 =head3 The WAFL block
2343 This will collect various performance data about the WAFL file system. At the
2344 moment this just means cache performance.
2346 B<Note:> To get this data the collectd user needs the
2347 "api-perf-object-get-instances" capability.
2349 B<Note:> The interface to get these values is classified as "Diagnostics" by
2350 NetApp. This means that it is not guaranteed to be stable even between minor
2355 =item B<Interval> I<Seconds>
2357 Collect disk statistics every I<Seconds> seconds.
2359 =item B<GetNameCache> B<true>|B<false>
2367 Result: One value list of type "cache_ratio" and type instance
2370 =item B<GetDirCache> B<true>|B<false>
2378 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
2380 =item B<GetInodeCache> B<true>|B<false>
2388 Result: One value list of type "cache_ratio" and type instance
2391 =item B<GetBufferCache> B<true>|B<false>
2393 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
2394 in the "Cache hit" field.
2402 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
2406 =head3 The Disks block
2408 This will collect performance data about the individual disks in the NetApp.
2410 B<Note:> To get this data the collectd user needs the
2411 "api-perf-object-get-instances" capability.
2415 =item B<Interval> I<Seconds>
2417 Collect disk statistics every I<Seconds> seconds.
2419 =item B<GetBusy> B<true>|B<false>
2421 If you set this option to true the busy time of all disks will be calculated
2422 and the value of the busiest disk in the system will be written.
2424 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2425 in the "Disk util" field. Probably.
2433 Result: One value list of type "percent" and type instance "disk_busy".
2437 =head3 The VolumePerf block
2439 This will collect various performance data about the individual volumes.
2441 You can select which data to collect about which volume using the following
2442 options. They follow the standard ignorelist semantic.
2444 B<Note:> To get this data the collectd user needs the
2445 I<api-perf-object-get-instances> capability.
2449 =item B<Interval> I<Seconds>
2451 Collect volume performance data every I<Seconds> seconds.
2453 =item B<GetIO> I<Volume>
2455 =item B<GetOps> I<Volume>
2457 =item B<GetLatency> I<Volume>
2459 Select the given volume for IO, operations or latency statistics collection.
2460 The argument is the name of the volume without the C</vol/> prefix.
2462 Since the standard ignorelist functionality is used here, you can use a string
2463 starting and ending with a slash to specify regular expression matching: To
2464 match the volumes "vol0", "vol2" and "vol7", you can use this regular
2467 GetIO "/^vol[027]$/"
2469 If no regular expression is specified, an exact match is required. Both,
2470 regular and exact matching are case sensitive.
2472 If no volume was specified at all for either of the three options, that data
2473 will be collected for all available volumes.
2475 =item B<IgnoreSelectedIO> B<true>|B<false>
2477 =item B<IgnoreSelectedOps> B<true>|B<false>
2479 =item B<IgnoreSelectedLatency> B<true>|B<false>
2481 When set to B<true>, the volumes selected for IO, operations or latency
2482 statistics collection will be ignored and the data will be collected for all
2485 When set to B<false>, data will only be collected for the specified volumes and
2486 all other volumes will be ignored.
2488 If no volumes have been specified with the above B<Get*> options, all volumes
2489 will be collected regardless of the B<IgnoreSelected*> option.
2491 Defaults to B<false>
2495 =head3 The VolumeUsage block
2497 This will collect capacity data about the individual volumes.
2499 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
2504 =item B<Interval> I<Seconds>
2506 Collect volume usage statistics every I<Seconds> seconds.
2508 =item B<GetCapacity> I<VolumeName>
2510 The current capacity of the volume will be collected. This will result in two
2511 to four value lists, depending on the configuration of the volume. All data
2512 sources are of type "df_complex" with the name of the volume as
2515 There will be type_instances "used" and "free" for the number of used and
2516 available bytes on the volume. If the volume has some space reserved for
2517 snapshots, a type_instance "snap_reserved" will be available. If the volume
2518 has SIS enabled, a type_instance "sis_saved" will be available. This is the
2519 number of bytes saved by the SIS feature.
2521 B<Note:> The current NetApp API has a bug that results in this value being
2522 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
2523 number which works most of the time. If you see strange values here, bug
2524 NetApp support to fix this.
2526 Repeat this option to specify multiple volumes.
2528 =item B<IgnoreSelectedCapacity> B<true>|B<false>
2530 Specify whether to collect only the volumes selected by the B<GetCapacity>
2531 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
2532 B<false>. However, if no B<GetCapacity> option is specified at all, all
2533 capacities will be selected anyway.
2535 =item B<GetSnapshot> I<VolumeName>
2537 Select volumes from which to collect snapshot information.
2539 Usually, the space used for snapshots is included in the space reported as
2540 "used". If snapshot information is collected as well, the space used for
2541 snapshots is subtracted from the used space.
2543 To make things even more interesting, it is possible to reserve space to be
2544 used for snapshots. If the space required for snapshots is less than that
2545 reserved space, there is "reserved free" and "reserved used" space in addition
2546 to "free" and "used". If the space required for snapshots exceeds the reserved
2547 space, that part allocated in the normal space is subtracted from the "used"
2550 Repeat this option to specify multiple volumes.
2552 =item B<IgnoreSelectedSnapshot>
2554 Specify whether to collect only the volumes selected by the B<GetSnapshot>
2555 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
2556 B<false>. However, if no B<GetSnapshot> option is specified at all, all
2557 capacities will be selected anyway.
2561 =head2 Plugin C<netlink>
2563 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
2564 statistics of various interface and routing aspects.
2568 =item B<Interface> I<Interface>
2570 =item B<VerboseInterface> I<Interface>
2572 Instruct the plugin to collect interface statistics. This is basically the same
2573 as the statistics provided by the C<interface> plugin (see above) but
2574 potentially much more detailed.
2576 When configuring with B<Interface> only the basic statistics will be collected,
2577 namely octets, packets, and errors. These statistics are collected by
2578 the C<interface> plugin, too, so using both at the same time is no benefit.
2580 When configured with B<VerboseInterface> all counters B<except> the basic ones,
2581 so that no data needs to be collected twice if you use the C<interface> plugin.
2582 This includes dropped packets, received multicast packets, collisions and a
2583 whole zoo of differentiated RX and TX errors. You can try the following command
2584 to get an idea of what awaits you:
2588 If I<Interface> is B<All>, all interfaces will be selected.
2590 =item B<QDisc> I<Interface> [I<QDisc>]
2592 =item B<Class> I<Interface> [I<Class>]
2594 =item B<Filter> I<Interface> [I<Filter>]
2596 Collect the octets and packets that pass a certain qdisc, class or filter.
2598 QDiscs and classes are identified by their type and handle (or classid).
2599 Filters don't necessarily have a handle, therefore the parent's handle is used.
2600 The notation used in collectd differs from that used in tc(1) in that it
2601 doesn't skip the major or minor number if it's zero and doesn't print special
2602 ids by their name. So, for example, a qdisc may be identified by
2603 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
2604 thus not displayed by tc(1).
2606 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
2607 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
2608 associated with that interface will be collected.
2610 Since a filter itself doesn't necessarily have a handle, the parent's handle is
2611 used. This may lead to problems when more than one filter is attached to a
2612 qdisc or class. This isn't nice, but we don't know how this could be done any
2613 better. If you have a idea, please don't hesitate to tell us.
2615 As with the B<Interface> option you can specify B<All> as the interface,
2616 meaning all interfaces.
2618 Here are some examples to help you understand the above text more easily:
2621 VerboseInterface "All"
2622 QDisc "eth0" "pfifo_fast-1:0"
2624 Class "ppp0" "htb-1:10"
2625 Filter "ppp0" "u32-1:0"
2628 =item B<IgnoreSelected>
2630 The behavior is the same as with all other similar plugins: If nothing is
2631 selected at all, everything is collected. If some things are selected using the
2632 options described above, only these statistics are collected. If you set
2633 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
2634 specified statistics will not be collected.
2638 =head2 Plugin C<network>
2640 The Network plugin sends data to a remote instance of collectd, receives data
2641 from a remote instance, or both at the same time. Data which has been received
2642 from the network is usually not transmitted again, but this can be activated, see
2643 the B<Forward> option below.
2645 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
2646 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
2648 Both, B<Server> and B<Listen> can be used as single option or as block. When
2649 used as block, given options are valid for this socket only. For example:
2652 Server "collectd.internal.tld"
2653 <Server "collectd.external.tld">
2654 SecurityLevel "sign"
2655 Username "myhostname"
2662 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
2664 The B<Server> statement/block sets the server to send datagrams to. The
2665 statement may occur multiple times to send each datagram to multiple
2668 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
2669 optional second argument specifies a port number or a service name. If not
2670 given, the default, B<25826>, is used.
2672 The following options are recognized within B<Server> blocks:
2676 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
2678 Set the security you require for network communication. When the security level
2679 has been set to B<Encrypt>, data sent over the network will be encrypted using
2680 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
2681 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
2682 authentication code. When set to B<None>, data is sent without any security.
2684 This feature is only available if the I<network> plugin was linked with
2687 =item B<Username> I<Username>
2689 Sets the username to transmit. This is used by the server to lookup the
2690 password. See B<AuthFile> below. All security levels except B<None> require
2693 This feature is only available if the I<network> plugin was linked with
2696 =item B<Password> I<Password>
2698 Sets a password (shared secret) for this socket. All security levels except
2699 B<None> require this setting.
2701 This feature is only available if the I<network> plugin was linked with
2704 =item B<Interface> I<Interface name>
2706 Set the outgoing interface for IP packets. This applies at least
2707 to IPv6 packets and if possible to IPv4. If this option is not applicable,
2708 undefined or a non-existent interface name is specified, the default
2709 behavior is to let the kernel choose the appropriate interface. Be warned
2710 that the manual selection of an interface for unicast traffic is only
2711 necessary in rare cases.
2715 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
2717 The B<Listen> statement sets the interfaces to bind to. When multiple
2718 statements are found the daemon will bind to multiple interfaces.
2720 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
2721 the argument is a multicast address the daemon will join that multicast group.
2722 The optional second argument specifies a port number or a service name. If not
2723 given, the default, B<25826>, is used.
2725 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
2729 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
2731 Set the security you require for network communication. When the security level
2732 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
2733 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
2734 signed and encrypted data is accepted. When set to B<None>, all data will be
2735 accepted. If an B<AuthFile> option was given (see below), encrypted data is
2736 decrypted if possible.
2738 This feature is only available if the I<network> plugin was linked with
2741 =item B<AuthFile> I<Filename>
2743 Sets a file in which usernames are mapped to passwords. These passwords are
2744 used to verify signatures and to decrypt encrypted network packets. If
2745 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
2746 verified and encrypted packets are decrypted. Otherwise, signed data is
2747 accepted without checking the signature and encrypted data cannot be decrypted.
2748 For the other security levels this option is mandatory.
2750 The file format is very simple: Each line consists of a username followed by a
2751 colon and any number of spaces followed by the password. To demonstrate, an
2752 example file could look like this:
2757 Each time a packet is received, the modification time of the file is checked
2758 using L<stat(2)>. If the file has been changed, the contents is re-read. While
2759 the file is being read, it is locked using L<fcntl(2)>.
2761 =item B<Interface> I<Interface name>
2763 Set the incoming interface for IP packets explicitly. This applies at least
2764 to IPv6 packets and if possible to IPv4. If this option is not applicable,
2765 undefined or a non-existent interface name is specified, the default
2766 behavior is, to let the kernel choose the appropriate interface. Thus incoming
2767 traffic gets only accepted, if it arrives on the given interface.
2771 =item B<TimeToLive> I<1-255>
2773 Set the time-to-live of sent packets. This applies to all, unicast and
2774 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
2775 That means that multicast packets will be sent with a TTL of C<1> (one) on most
2778 =item B<MaxPacketSize> I<1024-65535>
2780 Set the maximum size for datagrams received over the network. Packets larger
2781 than this will be truncated. Defaults to 1452E<nbsp>bytes.
2783 =item B<Forward> I<true|false>
2785 If set to I<true>, write packets that were received via the network plugin to
2786 the sending sockets. This should only be activated when the B<Listen>- and
2787 B<Server>-statements differ. Otherwise packets may be send multiple times to
2788 the same multicast group. While this results in more network traffic than
2789 necessary it's not a huge problem since the plugin has a duplicate detection,
2790 so the values will not loop.
2792 =item B<ReportStats> B<true>|B<false>
2794 The network plugin cannot only receive and send statistics, it can also create
2795 statistics about itself. Collected data included the number of received and
2796 sent octets and packets, the length of the receive queue and the number of
2797 values handled. When set to B<true>, the I<Network plugin> will make these
2798 statistics available. Defaults to B<false>.
2802 =head2 Plugin C<nginx>
2804 This plugin collects the number of connections and requests handled by the
2805 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
2806 queries the page provided by the C<ngx_http_stub_status_module> module, which
2807 isn't compiled by default. Please refer to
2808 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
2809 how to compile and configure nginx and this module.
2811 The following options are accepted by the C<nginx plugin>:
2815 =item B<URL> I<http://host/nginx_status>
2817 Sets the URL of the C<ngx_http_stub_status_module> output.
2819 =item B<User> I<Username>
2821 Optional user name needed for authentication.
2823 =item B<Password> I<Password>
2825 Optional password needed for authentication.
2827 =item B<VerifyPeer> B<true|false>
2829 Enable or disable peer SSL certificate verification. See
2830 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
2832 =item B<VerifyHost> B<true|false>
2834 Enable or disable peer host name verification. If enabled, the plugin checks
2835 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
2836 certificate matches the host name provided by the B<URL> option. If this
2837 identity check fails, the connection is aborted. Obviously, only works when
2838 connecting to a SSL enabled server. Enabled by default.
2840 =item B<CACert> I<File>
2842 File that holds one or more SSL certificates. If you want to use HTTPS you will
2843 possibly need this option. What CA certificates come bundled with C<libcurl>
2844 and are checked by default depends on the distribution you use.
2848 =head2 Plugin C<notify_desktop>
2850 This plugin sends a desktop notification to a notification daemon, as defined
2851 in the Desktop Notification Specification. To actually display the
2852 notifications, B<notification-daemon> is required and B<collectd> has to be
2853 able to access the X server.
2855 The Desktop Notification Specification can be found at
2856 L<http://www.galago-project.org/specs/notification/>.
2860 =item B<OkayTimeout> I<timeout>
2862 =item B<WarningTimeout> I<timeout>
2864 =item B<FailureTimeout> I<timeout>
2866 Set the I<timeout>, in milliseconds, after which to expire the notification
2867 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
2868 been specified, the displayed notification will not be closed at all - the
2869 user has to do so herself. These options default to 5000. If a negative number
2870 has been specified, the default is used as well.
2874 =head2 Plugin C<notify_email>
2876 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
2877 configured email address.
2879 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
2881 Available configuration options:
2885 =item B<From> I<Address>
2887 Email address from which the emails should appear to come from.
2889 Default: C<root@localhost>
2891 =item B<Recipient> I<Address>
2893 Configures the email address(es) to which the notifications should be mailed.
2894 May be repeated to send notifications to multiple addresses.
2896 At least one B<Recipient> must be present for the plugin to work correctly.
2898 =item B<SMTPServer> I<Hostname>
2900 Hostname of the SMTP server to connect to.
2902 Default: C<localhost>
2904 =item B<SMTPPort> I<Port>
2906 TCP port to connect to.
2910 =item B<SMTPUser> I<Username>
2912 Username for ASMTP authentication. Optional.
2914 =item B<SMTPPassword> I<Password>
2916 Password for ASMTP authentication. Optional.
2918 =item B<Subject> I<Subject>
2920 Subject-template to use when sending emails. There must be exactly two
2921 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
2922 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
2925 Default: C<Collectd notify: %s@%s>
2929 =head2 Plugin C<ntpd>
2933 =item B<Host> I<Hostname>
2935 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
2937 =item B<Port> I<Port>
2939 UDP-Port to connect to. Defaults to B<123>.
2941 =item B<ReverseLookups> B<true>|B<false>
2943 Sets whether or not to perform reverse lookups on peers. Since the name or
2944 IP-address may be used in a filename it is recommended to disable reverse
2945 lookups. The default is to do reverse lookups to preserve backwards
2946 compatibility, though.
2950 =head2 Plugin C<nut>
2954 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
2956 Add a UPS to collect data from. The format is identical to the one accepted by
2961 =head2 Plugin C<olsrd>
2963 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
2964 the Optimized Link State Routing daemon and reads information about the current
2965 state of the meshed network.
2967 The following configuration options are understood:
2971 =item B<Host> I<Host>
2973 Connect to I<Host>. Defaults to B<"localhost">.
2975 =item B<Port> I<Port>
2977 Specifies the port to connect to. This must be a string, even if you give the
2978 port as a number rather than a service name. Defaults to B<"2006">.
2980 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
2982 Specifies what information to collect about links, i.E<nbsp>e. direct
2983 connections of the daemon queried. If set to B<No>, no information is
2984 collected. If set to B<Summary>, the number of links and the average of all
2985 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
2986 If set to B<Detail> LQ and NLQ are collected per link.
2988 Defaults to B<Detail>.
2990 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
2992 Specifies what information to collect about routes of the daemon queried. If
2993 set to B<No>, no information is collected. If set to B<Summary>, the number of
2994 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
2995 metric and ETX are collected per route.
2997 Defaults to B<Summary>.
2999 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
3001 Specifies what information to collect about the global topology. If set to
3002 B<No>, no information is collected. If set to B<Summary>, the number of links
3003 in the entire topology and the average I<link quality> (LQ) is calculated.
3004 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
3006 Defaults to B<Summary>.
3010 =head2 Plugin C<onewire>
3012 B<EXPERIMENTAL!> See notes below.
3014 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
3015 L<http://owfs.org/> to read sensors connected via the onewire bus.
3017 Currently only temperature sensors (sensors with the family code C<10>,
3018 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
3019 would like to have included, please send a sort request to the mailing list.
3021 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
3022 experimental, below.
3026 =item B<Device> I<Device>
3028 Sets the device to read the values from. This can either be a "real" hardware
3029 device, such as a serial port or an USB port, or the address of the
3030 L<owserver(1)> socket, usually B<localhost:4304>.
3032 Though the documentation claims to automatically recognize the given address
3033 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
3034 with that version, the following configuration worked for us:
3037 Device "-s localhost:4304"
3040 This directive is B<required> and does not have a default value.
3042 =item B<Sensor> I<Sensor>
3044 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
3045 below. Sensors are specified without the family byte at the beginning, to you'd
3046 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
3049 =item B<IgnoreSelected> I<true>|I<false>
3051 If no configuration if given, the B<onewire> plugin will collect data from all
3052 sensors found. This may not be practical, especially if sensors are added and
3053 removed regularly. Sometimes, however, it's easier/preferred to collect only
3054 specific sensors or all sensors I<except> a few specified ones. This option
3055 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
3056 B<Sensor> is inverted: All selected interfaces are ignored and all other
3057 interfaces are collected.
3059 =item B<Interval> I<Seconds>
3061 Sets the interval in which all sensors should be read. If not specified, the
3062 global B<Interval> setting is used.
3066 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
3067 work with big setups. It works with one sensor being attached to one
3068 controller, but as soon as you throw in a couple more senors and maybe a hub
3069 or two, reading all values will take more than ten seconds (the default
3070 interval). We will probably add some separate thread for reading the sensors
3071 and some cache or something like that, but it's not done yet. We will try to
3072 maintain backwards compatibility in the future, but we can't promise. So in
3073 short: If it works for you: Great! But keep in mind that the config I<might>
3074 change, though this is unlikely. Oh, and if you want to help improving this
3075 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
3077 =head2 Plugin C<openvpn>
3079 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
3080 traffic statistics about connected clients.
3082 To set up OpenVPN to write to the status file periodically, use the
3083 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
3084 you need to set the required format, too. This is done by setting
3085 B<--status-version> to B<2>.
3087 So, in a nutshell you need:
3089 openvpn $OTHER_OPTIONS \
3090 --status "/var/run/openvpn-status" 10 \
3097 =item B<StatusFile> I<File>
3099 Specifies the location of the status file.
3101 =item B<ImprovedNamingSchema> B<true>|B<false>
3103 When enabled, the filename of the status file will be used as plugin instance
3104 and the client's "common name" will be used as type instance. This is required
3105 when reading multiple status files. Enabling this option is recommended, but to
3106 maintain backwards compatibility this option is disabled by default.
3108 =item B<CollectCompression> B<true>|B<false>
3110 Sets whether or not statistics about the compression used by OpenVPN should be
3111 collected. This information is only available in I<single> mode. Enabled by
3114 =item B<CollectIndividualUsers> B<true>|B<false>
3116 Sets whether or not traffic information is collected for each connected client
3117 individually. If set to false, currently no traffic data is collected at all
3118 because aggregating this data in a save manner is tricky. Defaults to B<true>.
3120 =item B<CollectUserCount> B<true>|B<false>
3122 When enabled, the number of currently connected clients or users is collected.
3123 This is especially interesting when B<CollectIndividualUsers> is disabled, but
3124 can be configured independently from that option. Defaults to B<false>.
3128 =head2 Plugin C<oracle>
3130 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
3131 Oracle® Database and lets you execute SQL statements there. It is very similar
3132 to the "dbi" plugin, because it was written around the same time. See the "dbi"
3133 plugin's documentation above for details.
3136 <Query "out_of_stock">
3137 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
3140 # InstancePrefix "foo"
3141 InstancesFrom "category"
3145 <Database "product_information">
3149 Query "out_of_stock"
3153 =head3 B<Query> blocks
3155 The Query blocks are handled identically to the Query blocks of the "dbi"
3156 plugin. Please see its documentation above for details on how to specify
3159 =head3 B<Database> blocks
3161 Database blocks define a connection to a database and which queries should be
3162 sent to that database. Each database needs a "name" as string argument in the
3163 starting tag of the block. This name will be used as "PluginInstance" in the
3164 values submitted to the daemon. Other than that, that name is not used.
3168 =item B<ConnectID> I<ID>
3170 Defines the "database alias" or "service name" to connect to. Usually, these
3171 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
3173 =item B<Username> I<Username>
3175 Username used for authentication.
3177 =item B<Password> I<Password>
3179 Password used for authentication.
3181 =item B<Query> I<QueryName>
3183 Associates the query named I<QueryName> with this database connection. The
3184 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
3185 blocks you want to refer to must be placed above the database block you want to
3190 =head2 Plugin C<perl>
3192 This plugin embeds a Perl-interpreter into collectd and provides an interface
3193 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
3195 =head2 Plugin C<pinba>
3197 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
3198 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
3199 PHP-based webpage has been delivered, the extension will send a UDP packet
3200 containing timing information, peak memory usage and so on. The plugin will
3201 wait for such packets, parse them and account the provided information, which
3202 is then dispatched to the daemon once per interval.
3209 # Overall statistics for the website.
3211 Server "www.example.com"
3213 # Statistics for www-a only
3215 Host "www-a.example.com"
3216 Server "www.example.com"
3218 # Statistics for www-b only
3220 Host "www-b.example.com"
3221 Server "www.example.com"
3225 The plugin provides the following configuration options:
3229 =item B<Address> I<Node>
3231 Configures the address used to open a listening socket. By default, plugin will
3232 bind to the I<any> address C<::0>.
3234 =item B<Port> I<Service>
3236 Configures the port (service) to bind to. By default the default Pinba port
3237 "30002" will be used. The option accepts service names in addition to port
3238 numbers and thus requires a I<string> argument.
3240 =item E<lt>B<View> I<Name>E<gt> block
3242 The packets sent by the Pinba extension include the hostname of the server, the
3243 server name (the name of the virtual host) and the script that was executed.
3244 Using B<View> blocks it is possible to separate the data into multiple groups
3245 to get more meaningful statistics. Each packet is added to all matching groups,
3246 so that a packet may be accounted for more than once.
3250 =item B<Host> I<Host>
3252 Matches the hostname of the system the webserver / script is running on. This
3253 will contain the result of the L<gethostname(2)> system call. If not
3254 configured, all hostnames will be accepted.
3256 =item B<Server> I<Server>
3258 Matches the name of the I<virtual host>, i.e. the contents of the
3259 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
3260 server names will be accepted.
3262 =item B<Script> I<Script>
3264 Matches the name of the I<script name>, i.e. the contents of the
3265 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
3266 script names will be accepted.
3272 =head2 Plugin C<ping>
3274 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
3275 configured hosts periodically and measures the network latency. Whenever the
3276 C<read> function of the plugin is called, it submits the average latency, the
3277 standard deviation and the drop rate for each host.
3279 Available configuration options:
3283 =item B<Host> I<IP-address>
3285 Host to ping periodically. This option may be repeated several times to ping
3288 =item B<Interval> I<Seconds>
3290 Sets the interval in which to send ICMP echo packets to the configured hosts.
3291 This is B<not> the interval in which statistics are queries from the plugin but
3292 the interval in which the hosts are "pinged". Therefore, the setting here
3293 should be smaller than or equal to the global B<Interval> setting. Fractional
3294 times, such as "1.24" are allowed.
3298 =item B<Timeout> I<Seconds>
3300 Time to wait for a response from the host to which an ICMP packet had been
3301 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
3302 to be down or the packet to be dropped. This setting must be smaller than the
3303 B<Interval> setting above for the plugin to work correctly. Fractional
3304 arguments are accepted.
3308 =item B<TTL> I<0-255>
3310 Sets the Time-To-Live of generated ICMP packets.
3312 =item B<SourceAddress> I<host>
3314 Sets the source address to use. I<host> may either be a numerical network
3315 address or a network hostname.
3317 =item B<Device> I<name>
3319 Sets the outgoing network device to be used. I<name> has to specify an
3320 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
3323 =item B<MaxMissed> I<Packets>
3325 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
3326 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
3328 Default: B<-1> (disabled)
3332 =head2 Plugin C<postgresql>
3334 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
3335 keeps a persistent connection to all configured databases and tries to
3336 reconnect if the connection has been interrupted. A database is configured by
3337 specifying a B<Database> block as described below. The default statistics are
3338 collected from PostgreSQL's B<statistics collector> which thus has to be
3339 enabled for this plugin to work correctly. This should usually be the case by
3340 default. See the section "The Statistics Collector" of the B<PostgreSQL
3341 Documentation> for details.
3343 By specifying custom database queries using a B<Query> block as described
3344 below, you may collect any data that is available from some PostgreSQL
3345 database. This way, you are able to access statistics of external daemons
3346 which are available in a PostgreSQL database or use future or special
3347 statistics provided by PostgreSQL without the need to upgrade your collectd
3350 The B<PostgreSQL Documentation> manual can be found at
3351 L<http://www.postgresql.org/docs/manuals/>.
3355 Statement "SELECT magic FROM wizard WHERE host = $1;"
3359 InstancePrefix "magic"
3364 <Query rt36_tickets>
3365 Statement "SELECT COUNT(type) AS count, type \
3367 WHEN resolved = 'epoch' THEN 'open' \
3368 ELSE 'resolved' END AS type \
3369 FROM tickets) type \
3373 InstancePrefix "rt36_tickets"
3374 InstancesFrom "type"
3385 KRBSrvName "kerberos_service_name"
3391 Service "service_name"
3392 Query backend # predefined
3397 The B<Query> block defines one database query which may later be used by a
3398 database definition. It accepts a single mandatory argument which specifies
3399 the name of the query. The names of all queries have to be unique (see the
3400 B<MinVersion> and B<MaxVersion> options below for an exception to this
3401 rule). The following configuration options are available to define the query:
3403 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
3404 blocks define how to handle the values returned from the query. They define
3405 which column holds which value and how to dispatch that value to the daemon.
3406 Multiple B<Result> blocks may be used to extract multiple values from a single
3411 =item B<Statement> I<sql query statement>
3413 Specify the I<sql query statement> which the plugin should execute. The string
3414 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
3415 first, second, etc. parameter. The value of the parameters is specified by the
3416 B<Param> configuration option - see below for details. To include a literal
3417 B<$> character followed by a number, surround it with single quotes (B<'>).
3419 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
3420 allowed. Note, however, that only a single command may be used. Semicolons are
3421 allowed as long as a single non-empty command has been specified only.
3423 The returned lines will be handled separately one after another.
3425 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
3427 Specify the parameters which should be passed to the SQL query. The parameters
3428 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
3429 they appear in the configuration file. The value of the parameter is
3430 determined depending on the value of the B<Param> option as follows:
3436 The configured hostname of the database connection. If a UNIX domain socket is
3437 used, the parameter expands to "localhost".
3441 The name of the database of the current connection.
3445 The username used to connect to the database.
3449 The interval with which this database is queried (as specified by the database
3450 specific or global B<Interval> options).
3454 Please note that parameters are only supported by PostgreSQL's protocol
3455 version 3 and above which was introduced in version 7.4 of PostgreSQL.
3457 =item B<Type> I<type>
3459 The I<type> name to be used when dispatching the values. The type describes
3460 how to handle the data and where to store it. See L<types.db(5)> for more
3461 details on types and their configuration. The number and type of values (as
3462 selected by the B<ValuesFrom> option) has to match the type of the given name.
3464 This option is required inside a B<Result> block.
3466 =item B<InstancePrefix> I<prefix>
3468 =item B<InstancesFrom> I<column0> [I<column1> ...]
3470 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
3471 B<InstancePrefix> defines a static prefix that will be prepended to all type
3472 instances. B<InstancesFrom> defines the column names whose values will be used
3473 to create the type instance. Multiple values will be joined together using the
3474 hyphen (C<->) as separation character.
3476 The plugin itself does not check whether or not all built instances are
3477 different. It is your responsibility to assure that each is unique.
3479 Both options are optional. If none is specified, the type instance will be
3482 =item B<ValuesFrom> I<column0> [I<column1> ...]
3484 Names the columns whose content is used as the actual data for the data sets
3485 that are dispatched to the daemon. How many such columns you need is
3486 determined by the B<Type> setting as explained above. If you specify too many
3487 or not enough columns, the plugin will complain about that and no data will be
3488 submitted to the daemon.
3490 The actual data type, as seen by PostgreSQL, is not that important as long as
3491 it represents numbers. The plugin will automatically cast the values to the
3492 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
3493 L<strtod(3)> functions, so anything supported by those functions is supported
3494 by the plugin as well.
3496 This option is required inside a B<Result> block and may be specified multiple
3497 times. If multiple B<ValuesFrom> options are specified, the columns are read
3500 =item B<MinVersion> I<version>
3502 =item B<MaxVersion> I<version>
3504 Specify the minimum or maximum version of PostgreSQL that this query should be
3505 used with. Some statistics might only be available with certain versions of
3506 PostgreSQL. This allows you to specify multiple queries with the same name but
3507 which apply to different versions, thus allowing you to use the same
3508 configuration in a heterogeneous environment.
3510 The I<version> has to be specified as the concatenation of the major, minor
3511 and patch-level versions, each represented as two-decimal-digit numbers. For
3512 example, version 8.2.3 will become 80203.
3516 The following predefined queries are available (the definitions can be found
3517 in the F<postgresql_default.conf> file which, by default, is available at
3518 C<I<prefix>/share/collectd/>):
3524 This query collects the number of backends, i.E<nbsp>e. the number of
3527 =item B<transactions>
3529 This query collects the numbers of committed and rolled-back transactions of
3534 This query collects the numbers of various table modifications (i.E<nbsp>e.
3535 insertions, updates, deletions) of the user tables.
3537 =item B<query_plans>
3539 This query collects the numbers of various table scans and returned tuples of
3542 =item B<table_states>
3544 This query collects the numbers of live and dead rows in the user tables.
3548 This query collects disk block access counts for user tables.
3552 This query collects the on-disk size of the database in bytes.
3556 The B<Database> block defines one PostgreSQL database for which to collect
3557 statistics. It accepts a single mandatory argument which specifies the
3558 database name. None of the other options are required. PostgreSQL will use
3559 default values as documented in the section "CONNECTING TO A DATABASE" in the
3560 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
3561 the user collectd is run as and special environment variables. See the manpage
3566 =item B<Interval> I<seconds>
3568 Specify the interval with which the database should be queried. The default is
3569 to use the global B<Interval> setting.
3571 =item B<Host> I<hostname>
3573 Specify the hostname or IP of the PostgreSQL server to connect to. If the
3574 value begins with a slash, it is interpreted as the directory name in which to
3575 look for the UNIX domain socket.
3577 This option is also used to determine the hostname that is associated with a
3578 collected data set. If it has been omitted or either begins with with a slash
3579 or equals B<localhost> it will be replaced with the global hostname definition
3580 of collectd. Any other value will be passed literally to collectd when
3581 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
3583 =item B<Port> I<port>
3585 Specify the TCP port or the local UNIX domain socket file extension of the
3588 =item B<User> I<username>
3590 Specify the username to be used when connecting to the server.
3592 =item B<Password> I<password>
3594 Specify the password to be used when connecting to the server.
3596 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
3598 Specify whether to use an SSL connection when contacting the server. The
3599 following modes are supported:
3605 Do not use SSL at all.
3609 First, try to connect without using SSL. If that fails, try using SSL.
3611 =item I<prefer> (default)
3613 First, try to connect using SSL. If that fails, try without using SSL.
3621 =item B<KRBSrvName> I<kerberos_service_name>
3623 Specify the Kerberos service name to use when authenticating with Kerberos 5
3624 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
3625 B<PostgreSQL Documentation> for details.
3627 =item B<Service> I<service_name>
3629 Specify the PostgreSQL service name to use for additional parameters. That
3630 service has to be defined in F<pg_service.conf> and holds additional
3631 connection parameters. See the section "The Connection Service File" in the
3632 B<PostgreSQL Documentation> for details.
3634 =item B<Query> I<query>
3636 Specify a I<query> which should be executed for the database connection. This
3637 may be any of the predefined or user-defined queries. If no such option is
3638 given, it defaults to "backends", "transactions", "queries", "query_plans",
3639 "table_states", "disk_io" and "disk_usage". Else, the specified queries are
3644 =head2 Plugin C<powerdns>
3646 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
3647 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
3648 values, many of which are probably meaningless to most users, but may be useful
3649 for some. So you may chose which values to collect, but if you don't, some
3650 reasonable defaults will be collected.
3653 <Server "server_name">
3655 Collect "udp-answers" "udp-queries"
3656 Socket "/var/run/pdns.controlsocket"
3658 <Recursor "recursor_name">
3660 Collect "cache-hits" "cache-misses"
3661 Socket "/var/run/pdns_recursor.controlsocket"
3663 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
3668 =item B<Server> and B<Recursor> block
3670 The B<Server> block defines one authoritative server to query, the B<Recursor>
3671 does the same for an recursing server. The possible options in both blocks are
3672 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
3677 =item B<Collect> I<Field>
3679 Using the B<Collect> statement you can select which values to collect. Here,
3680 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
3681 C<dlg-only-drops>, C<answers10-100>.
3683 The method of getting the values differs for B<Server> and B<Recursor> blocks:
3684 When querying the server a C<SHOW *> command is issued in any case, because
3685 that's the only way of getting multiple values out of the server at once.
3686 collectd then picks out the values you have selected. When querying the
3687 recursor, a command is generated to query exactly these values. So if you
3688 specify invalid fields when querying the recursor, a syntax error may be
3689 returned by the daemon and collectd may not collect any values at all.
3691 If no B<Collect> statement is given, the following B<Server> values will be
3698 =item packetcache-hit
3700 =item packetcache-miss
3702 =item packetcache-size
3704 =item query-cache-hit
3706 =item query-cache-miss
3708 =item recursing-answers
3710 =item recursing-questions
3722 The following B<Recursor> values will be collected by default:
3726 =item noerror-answers
3728 =item nxdomain-answers
3730 =item servfail-answers
3748 Please note that up to that point collectd doesn't know what values are
3749 available on the server and values that are added do not need a change of the
3750 mechanism so far. However, the values must be mapped to collectd's naming
3751 scheme, which is done using a lookup table that lists all known values. If
3752 values are added in the future and collectd does not know about them, you will
3753 get an error much like this:
3755 powerdns plugin: submit: Not found in lookup table: foobar = 42
3757 In this case please file a bug report with the collectd team.
3759 =item B<Socket> I<Path>
3761 Configures the path to the UNIX domain socket to be used when connecting to the
3762 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
3763 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
3764 will be used for the recursor.
3768 =item B<LocalSocket> I<Path>
3770 Querying the recursor is done using UDP. When using UDP over UNIX domain
3771 sockets, the client socket needs a name in the file system, too. You can set
3772 this local name to I<Path> using the B<LocalSocket> option. The default is
3773 C<I<prefix>/var/run/collectd-powerdns>.
3777 =head2 Plugin C<processes>
3781 =item B<Process> I<Name>
3783 Select more detailed statistics of processes matching this name. The statistics
3784 collected for these selected processes are size of the resident segment size
3785 (RSS), user- and system-time used, number of processes and number of threads,
3786 io data (where available) and minor and major pagefaults.
3788 =item B<ProcessMatch> I<name> I<regex>
3790 Similar to the B<Process> option this allows to select more detailed
3791 statistics of processes matching the specified I<regex> (see L<regex(7)> for
3792 details). The statistics of all matching processes are summed up and
3793 dispatched to the daemon using the specified I<name> as an identifier. This
3794 allows to "group" several processes together. I<name> must not contain
3799 =head2 Plugin C<protocols>
3801 Collects a lot of information about various network protocols, such as I<IP>,
3802 I<TCP>, I<UDP>, etc.
3804 Available configuration options:
3808 =item B<Value> I<Selector>
3810 Selects whether or not to select a specific value. The string being matched is
3811 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
3812 plugin instance and I<ValueName> will be used as type instance. An example of
3813 the string being used would be C<Tcp:RetransSegs>.
3815 You can use regular expressions to match a large number of values with just one
3816 configuration option. To select all "extended" I<TCP> values, you could use the
3817 following statement:
3821 Whether only matched values are selected or all matched values are ignored
3822 depends on the B<IgnoreSelected>. By default, only matched values are selected.
3823 If no value is configured at all, all values will be selected.
3825 =item B<IgnoreSelected> B<true>|B<false>
3827 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
3828 matching values will be ignored.
3832 =head2 Plugin C<python>
3834 This plugin embeds a Python-interpreter into collectd and provides an interface
3835 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
3837 =head2 Plugin C<routeros>
3839 The C<routeros> plugin connects to a device running I<RouterOS>, the
3840 Linux-based operating system for routers by I<MikroTik>. The plugin uses
3841 I<librouteros> to connect and reads information about the interfaces and
3842 wireless connections of the device. The configuration supports querying
3847 Host "router0.example.com"
3850 CollectInterface true
3855 Host "router1.example.com"
3858 CollectInterface true
3859 CollectRegistrationTable true
3865 As you can see above, the configuration of the I<routeros> plugin consists of
3866 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
3867 options are understood:
3871 =item B<Host> I<Host>
3873 Hostname or IP-address of the router to connect to.
3875 =item B<Port> I<Port>
3877 Port name or port number used when connecting. If left unspecified, the default
3878 will be chosen by I<librouteros>, currently "8728". This option expects a
3879 string argument, even when a numeric port number is given.
3881 =item B<User> I<User>
3883 Use the user name I<User> to authenticate. Defaults to "admin".
3885 =item B<Password> I<Password>
3887 Set the password used to authenticate.
3889 =item B<CollectInterface> B<true>|B<false>
3891 When set to B<true>, interface statistics will be collected for all interfaces
3892 present on the device. Defaults to B<false>.
3894 =item B<CollectRegistrationTable> B<true>|B<false>
3896 When set to B<true>, information about wireless LAN connections will be
3897 collected. Defaults to B<false>.
3899 =item B<CollectCPULoad> B<true>|B<false>
3901 When set to B<true>, information about the CPU usage will be collected. The
3902 number is a dimensionless value where zero indicates no CPU usage at all.
3903 Defaults to B<false>.
3905 =item B<CollectMemory> B<true>|B<false>
3907 When enabled, the amount of used and free memory will be collected. How used
3908 memory is calculated is unknown, for example whether or not caches are counted
3910 Defaults to B<false>.
3912 =item B<CollectDF> B<true>|B<false>
3914 When enabled, the amount of used and free disk space will be collected.
3915 Defaults to B<false>.
3917 =item B<CollectDisk> B<true>|B<false>
3919 When enabled, the number of sectors written and bad blocks will be collected.
3920 Defaults to B<false>.
3924 =head2 Plugin C<redis>
3926 The I<Redis plugin> connects to one or more Redis servers and gathers
3927 information about each server's state. For each server there is a I<Node> block
3928 which configures the connection parameters for this node.
3938 The information shown in the synopsis above is the I<default configuration>
3939 which is used by the plugin if no configuration is present.
3943 =item B<Node> I<Nodename>
3945 The B<Node> block identifies a new Redis node, that is a new Redis instance
3946 running in an specified host and port. The name for node is a canonical
3947 identifier which is used as I<plugin instance>. It is limited to
3948 64E<nbsp>characters in length.
3950 =item B<Host> I<Hostname>
3952 The B<Host> option is the hostname or IP-address where the Redis instance is
3955 =item B<Port> I<Port>
3957 The B<Port> option is the TCP port on which the Redis instance accepts
3958 connections. Either a service name of a port number may be given. Please note
3959 that numerical port numbers must be given as a string, too.
3961 =item B<Timeout> I<Timeout in miliseconds>
3963 The B<Timeout> option set the socket timeout for node response. Since the Redis
3964 read function is blocking, you should keep this value as low as possible. Keep
3965 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
3966 than B<Interval> defined globally.
3970 =head2 Plugin C<rrdcached>
3972 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
3973 to store values to RRD files in an efficient manner. The combination of the
3974 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
3975 way the C<rrdtool> plugin works (see below). The added abstraction layer
3976 provides a number of benefits, though: Because the cache is not within
3977 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
3978 restarted. This results in much shorter (if any) gaps in graphs, especially
3979 under heavy load. Also, the C<rrdtool> command line utility is aware of the
3980 daemon so that it can flush values to disk automatically when needed. This
3981 allows to integrate automated flushing of values into graphing solutions much
3984 There are disadvantages, though: The daemon may reside on a different host, so
3985 it may not be possible for C<collectd> to create the appropriate RRD files
3986 anymore. And even if C<rrdcached> runs on the same host, it may run in a
3987 different base directory, so relative paths may do weird stuff if you're not
3990 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
3991 on the same host, communicating via a UNIX domain socket. The B<DataDir>
3992 setting should be set to an absolute path, so that a changed base directory
3993 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
3997 =item B<DaemonAddress> I<Address>
3999 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
4000 library. See L<rrdcached(1)> for details. Example:
4002 <Plugin "rrdcached">
4003 DaemonAddress "unix:/var/run/rrdcached.sock"
4006 =item B<DataDir> I<Directory>
4008 Set the base directory in which the RRD files reside. If this is a relative
4009 path, it is relative to the working base directory of the C<rrdcached> daemon!
4010 Use of an absolute path is recommended.
4012 =item B<CreateFiles> B<true>|B<false>
4014 Enables or disables the creation of RRD files. If the daemon is not running
4015 locally, or B<DataDir> is set to a relative path, this will not work as
4016 expected. Default is B<true>.
4020 =head2 Plugin C<rrdtool>
4022 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
4023 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
4024 using these settings. If you don't want to dive into the depths of RRDtool, you
4025 can safely ignore these settings.
4029 =item B<DataDir> I<Directory>
4031 Set the directory to store RRD-files under. Per default RRD-files are generated
4032 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
4034 =item B<StepSize> I<Seconds>
4036 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
4037 this setting is unset and the stepsize is set to the interval in which the data
4038 is collected. Do not use this option unless you absolutely have to for some
4039 reason. Setting this option may cause problems with the C<snmp plugin>, the
4040 C<exec plugin> or when the daemon is set up to receive data from other hosts.
4042 =item B<HeartBeat> I<Seconds>
4044 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
4045 in which case the heartbeat is set to twice the B<StepSize> which should equal
4046 the interval in which data is collected. Do not set this option unless you have
4047 a very good reason to do so.
4049 =item B<RRARows> I<NumRows>
4051 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
4052 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
4053 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
4054 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
4055 week, one month, and one year.
4057 So for each timespan, it calculates how many PDPs need to be consolidated into
4058 one CDP by calculating:
4059 number of PDPs = timespan / (stepsize * rrarows)
4061 Bottom line is, set this no smaller than the width of you graphs in pixels. The
4064 =item B<RRATimespan> I<Seconds>
4066 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
4067 more then one RRA. If this option is never used, the built-in default of (3600,
4068 86400, 604800, 2678400, 31622400) is used.
4070 For more information on how RRA-sizes are calculated see B<RRARows> above.
4072 =item B<XFF> I<Factor>
4074 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
4076 =item B<CacheFlush> I<Seconds>
4078 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
4079 it writes all values for a certain RRD-file if the oldest value is older than
4080 (or equal to) the number of seconds specified. If some RRD-file is not updated
4081 anymore for some reason (the computer was shut down, the network is broken,
4082 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
4083 entire cache is searched for entries older than B<CacheTimeout> seconds and
4084 written to disk every I<Seconds> seconds. Since this is kind of expensive and
4085 does nothing under normal circumstances, this value should not be too small.
4086 900 seconds might be a good value, though setting this to 7200 seconds doesn't
4087 normally do much harm either.
4089 =item B<CacheTimeout> I<Seconds>
4091 If this option is set to a value greater than zero, the C<rrdtool plugin> will
4092 save values in a cache, as described above. Writing multiple values at once
4093 reduces IO-operations and thus lessens the load produced by updating the files.
4094 The trade off is that the graphs kind of "drag behind" and that more memory is
4097 =item B<WritesPerSecond> I<Updates>
4099 When collecting many statistics with collectd and the C<rrdtool> plugin, you
4100 will run serious performance problems. The B<CacheFlush> setting and the
4101 internal update queue assert that collectd continues to work just fine even
4102 under heavy load, but the system may become very unresponsive and slow. This is
4103 a problem especially if you create graphs from the RRD files on the same
4104 machine, for example using the C<graph.cgi> script included in the
4105 C<contrib/collection3/> directory.
4107 This setting is designed for very large setups. Setting this option to a value
4108 between 25 and 80 updates per second, depending on your hardware, will leave
4109 the server responsive enough to draw graphs even while all the cached values
4110 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
4111 by the B<FLUSH> command, are B<not> effected by this limit. They are still
4112 written as fast as possible, so that web frontends have up to date data when
4115 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
4116 updates per second, writing all values to disk will take approximately
4117 56E<nbsp>minutes. Together with the flushing ability that's integrated into
4118 "collection3" you'll end up with a responsive and fast system, up to date
4119 graphs and basically a "backup" of your values every hour.
4121 =item B<RandomTimeout> I<Seconds>
4123 When set, the actual timeout for each value is chosen randomly between
4124 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
4125 intention is to avoid high load situations that appear when many values timeout
4126 at the same time. This is especially a problem shortly after the daemon starts,
4127 because all values were added to the internal cache at roughly the same time.
4131 =head2 Plugin C<sensors>
4133 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
4134 that all the needed modules have to be loaded and lm_sensors has to be
4135 configured (most likely by editing F</etc/sensors.conf>. Read
4136 L<sensors.conf(5)> for details.
4138 The B<lm_sensors> homepage can be found at
4139 L<http://secure.netroedge.com/~lm78/>.
4143 =item B<Sensor> I<chip-bus-address/type-feature>
4145 Selects the name of the sensor which you want to collect or ignore, depending
4146 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
4147 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
4148 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
4150 =item B<IgnoreSelected> I<true>|I<false>
4152 If no configuration if given, the B<sensors>-plugin will collect data from all
4153 sensors. This may not be practical, especially for uninteresting sensors.
4154 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
4155 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
4156 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
4157 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
4158 and all other sensors are collected.
4162 =head2 Plugin C<snmp>
4164 Since the configuration of the C<snmp plugin> is a little more complicated than
4165 other plugins, its documentation has been moved to an own manpage,
4166 L<collectd-snmp(5)>. Please see there for details.
4168 =head2 Plugin C<swap>
4170 The I<Swap plugin> collects information about used and available swap space. On
4171 Solaris, it is possible to collect information on physical swap devices and the
4172 view of the virtual memory subsystem on the matter. On I<Solaris>, the
4173 following options are available:
4177 =item B<ReportPhysical> B<combined>|B<separate>|B<false>
4179 Configures how to report physical swap devices. If B<combined> is used (the
4180 default), the summary over all swap devices is reported only, i.e. the globally
4181 used and available space over all devices. If B<separate> is configured, the
4182 used and available space of each device will be reported separately. B<false>
4183 deactivates collection of physical swap information (only valid if collection
4184 via L<kstat(3KSTAT)> is available).
4186 This option is only available if the I<Swap plugin> can use the L<swapctl(2)>
4187 mechanism under I<Solaris>.
4189 =item B<ReportVirtual> B<false>|B<true>
4191 Configures whether or not to report the view of the virtual memory subsystem on
4192 swap space. This information is used under Solaris if L<swapctl(2)> is not
4193 available and was the default behavior under I<Solaris> in I<collectdE<nbsp>4>.
4195 This option is only available if the I<Swap plugin> can use L<swapctl(2)> and
4196 L<kstat(3KSTAT)> to collect swap statistics under I<Solaris>. It defaults to
4201 =head2 Plugin C<syslog>
4205 =item B<LogLevel> B<debug|info|notice|warning|err>
4207 Sets the log-level. If, for example, set to B<notice>, then all events with
4208 severity B<notice>, B<warning>, or B<err> will be submitted to the
4211 Please note that B<debug> is only available if collectd has been compiled with
4216 =head2 Plugin C<table>
4218 The C<table plugin> provides generic means to parse tabular data and dispatch
4219 user specified values. Values are selected based on column numbers. For
4220 example, this plugin may be used to get values from the Linux L<proc(5)>
4221 filesystem or CSV (comma separated values) files.
4224 <Table "/proc/slabinfo">
4229 InstancePrefix "active_objs"
4235 InstancePrefix "objperslab"
4242 The configuration consists of one or more B<Table> blocks, each of which
4243 configures one file to parse. Within each B<Table> block, there are one or
4244 more B<Result> blocks, which configure which data to select and how to
4247 The following options are available inside a B<Table> block:
4251 =item B<Instance> I<instance>
4253 If specified, I<instance> is used as the plugin instance. So, in the above
4254 example, the plugin name C<table-slabinfo> would be used. If omitted, the
4255 filename of the table is used instead, with all special characters replaced
4256 with an underscore (C<_>).
4258 =item B<Separator> I<string>
4260 Any character of I<string> is interpreted as a delimiter between the different
4261 columns of the table. A sequence of two or more contiguous delimiters in the
4262 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
4263 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
4264 of a table - see its documentation for more details. This option is mandatory.
4266 A horizontal tab, newline and carriage return may be specified by C<\\t>,
4267 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
4268 required because of collectd's config parsing.
4272 The following options are available inside a B<Result> block:
4276 =item B<Type> I<type>
4278 Sets the type used to dispatch the values to the daemon. Detailed information
4279 about types and their configuration can be found in L<types.db(5)>. This
4280 option is mandatory.
4282 =item B<InstancePrefix> I<prefix>
4284 If specified, prepend I<prefix> to the type instance. If omitted, only the
4285 B<InstancesFrom> option is considered for the type instance.
4287 =item B<InstancesFrom> I<column0> [I<column1> ...]
4289 If specified, the content of the given columns (identified by the column
4290 number starting at zero) will be used to create the type instance for each
4291 row. Multiple values (and the instance prefix) will be joined together with
4292 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
4293 option is considered for the type instance.
4295 The plugin itself does not check whether or not all built instances are
4296 different. It’s your responsibility to assure that each is unique. This is
4297 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
4298 sure that the table only contains one row.
4300 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
4303 =item B<ValuesFrom> I<column0> [I<column1> ...]
4305 Specifies the columns (identified by the column numbers starting at zero)
4306 whose content is used as the actual data for the data sets that are dispatched
4307 to the daemon. How many such columns you need is determined by the B<Type>
4308 setting above. If you specify too many or not enough columns, the plugin will
4309 complain about that and no data will be submitted to the daemon. The plugin
4310 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
4311 respectively, so anything supported by those functions is supported by the
4312 plugin as well. This option is mandatory.
4316 =head2 Plugin C<tail>
4318 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
4319 each line and dispatches found values. What is matched can be configured by the
4320 user using (extended) regular expressions, as described in L<regex(7)>.
4323 <File "/var/log/exim4/mainlog">
4326 Regex "S=([1-9][0-9]*)"
4332 Regex "\\<R=local_user\\>"
4333 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
4336 Instance "local_user"
4341 The config consists of one or more B<File> blocks, each of which configures one
4342 logfile to parse. Within each B<File> block, there are one or more B<Match>
4343 blocks, which configure a regular expression to search for.
4345 The B<Instance> option in the B<File> block may be used to set the plugin
4346 instance. So in the above example the plugin name C<tail-foo> would be used.
4347 This plugin instance is for all B<Match> blocks that B<follow> it, until the
4348 next B<Instance> option. This way you can extract several plugin instances from
4349 one logfile, handy when parsing syslog and the like.
4351 Each B<Match> block has the following options to describe how the match should
4356 =item B<Regex> I<regex>
4358 Sets the regular expression to use for matching against a line. The first
4359 subexpression has to match something that can be turned into a number by
4360 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
4361 below. Because B<extended> regular expressions are used, you do not need to use
4362 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
4363 collectd's config parsing you need to escape backslashes, though. So if you
4364 want to match literal parentheses you need to do the following:
4366 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
4368 =item B<ExcludeRegex> I<regex>
4370 Sets an optional regular expression to use for excluding lines from the match.
4371 An example which excludes all connections from localhost from the match:
4373 ExcludeRegex "127\\.0\\.0\\.1"
4375 =item B<DSType> I<Type>
4377 Sets how the values are cumulated. I<Type> is one of:
4381 =item B<GaugeAverage>
4383 Calculate the average.
4387 Use the smallest number only.
4391 Use the greatest number only.
4395 Use the last number found.
4401 =item B<AbsoluteSet>
4403 The matched number is a counter. Simply I<sets> the internal counter to this
4404 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
4410 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
4411 matched number may be negative, which will effectively subtract from the
4418 Increase the internal counter by one. These B<DSType> are the only ones that do
4419 not use the matched subexpression, but simply count the number of matched
4420 lines. Thus, you may use a regular expression without submatch in this case.
4424 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
4425 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
4426 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
4427 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
4428 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
4431 =item B<Type> I<Type>
4433 Sets the type used to dispatch this value. Detailed information about types and
4434 their configuration can be found in L<types.db(5)>.
4436 =item B<Instance> I<TypeInstance>
4438 This optional setting sets the type instance to use.
4442 =head2 Plugin C<teamspeak2>
4444 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
4445 polls interesting global and virtual server data. The plugin can query only one
4446 physical server but unlimited virtual servers. You can use the following
4447 options to configure it:
4451 =item B<Host> I<hostname/ip>
4453 The hostname or ip which identifies the physical server.
4456 =item B<Port> I<port>
4458 The query port of the physical server. This needs to be a string.
4461 =item B<Server> I<port>
4463 This option has to be added once for every virtual server the plugin should
4464 query. If you want to query the virtual server on port 8767 this is what the
4465 option would look like:
4469 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
4470 use quotes around it! If no such statement is given only global information
4475 =head2 Plugin C<ted>
4477 The I<TED> plugin connects to a device of "The Energy Detective", a device to
4478 measure power consumption. These devices are usually connected to a serial
4479 (RS232) or USB port. The plugin opens a configured device and tries to read the
4480 current energy readings. For more information on TED, visit
4481 L<http://www.theenergydetective.com/>.
4483 Available configuration options:
4487 =item B<Device> I<Path>
4489 Path to the device on which TED is connected. collectd will need read and write
4490 permissions on that file.
4492 Default: B</dev/ttyUSB0>
4494 =item B<Retries> I<Num>
4496 Apparently reading from TED is not that reliable. You can therefore configure a
4497 number of retries here. You only configure the I<retries> here, to if you
4498 specify zero, one reading will be performed (but no retries if that fails); if
4499 you specify three, a maximum of four readings are performed. Negative values
4506 =head2 Plugin C<tcpconns>
4508 The C<tcpconns plugin> counts the number of currently established TCP
4509 connections based on the local port and/or the remote port. Since there may be
4510 a lot of connections the default if to count all connections with a local port,
4511 for which a listening socket is opened. You can use the following options to
4512 fine-tune the ports you are interested in:
4516 =item B<ListeningPorts> I<true>|I<false>
4518 If this option is set to I<true>, statistics for all local ports for which a
4519 listening socket exists are collected. The default depends on B<LocalPort> and
4520 B<RemotePort> (see below): If no port at all is specifically selected, the
4521 default is to collect listening ports. If specific ports (no matter if local or
4522 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
4523 the selected ports will be collected unless this option is set to I<true>
4526 =item B<LocalPort> I<Port>
4528 Count the connections to a specific local port. This can be used to see how
4529 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
4530 You have to specify the port in numeric form, so for the mailserver example
4531 you'd need to set B<25>.
4533 =item B<RemotePort> I<Port>
4535 Count the connections to a specific remote port. This is useful to see how
4536 much a remote service is used. This is most useful if you want to know how many
4537 connections a local service has opened to remote services, e.E<nbsp>g. how many
4538 connections a mail server or news server has to other mail or news servers, or
4539 how many connections a web proxy holds to web servers. You have to give the
4540 port in numeric form.
4544 =head2 Plugin C<thermal>
4548 =item B<ForceUseProcfs> I<true>|I<false>
4550 By default, the I<Thermal plugin> tries to read the statistics from the Linux
4551 C<sysfs> interface. If that is not available, the plugin falls back to the
4552 C<procfs> interface. By setting this option to I<true>, you can force the
4553 plugin to use the latter. This option defaults to I<false>.
4555 =item B<Device> I<Device>
4557 Selects the name of the thermal device that you want to collect or ignore,
4558 depending on the value of the B<IgnoreSelected> option. This option may be
4559 used multiple times to specify a list of devices.
4561 =item B<IgnoreSelected> I<true>|I<false>
4563 Invert the selection: If set to true, all devices B<except> the ones that
4564 match the device names specified by the B<Device> option are collected. By
4565 default only selected devices are collected if a selection is made. If no
4566 selection is configured at all, B<all> devices are selected.
4570 =head2 Plugin C<threshold>
4572 The I<Threshold plugin> checks values collected or received by I<collectd>
4573 against a configurable I<threshold> and issues I<notifications> if values are
4576 Documentation for this plugin is available in the L<collectd-threshold(5)>
4579 =head2 Plugin C<tokyotyrant>
4581 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
4582 couple metrics: number of records, and database size on disk.
4586 =item B<Host> I<Hostname/IP>
4588 The hostname or ip which identifies the server.
4589 Default: B<127.0.0.1>
4591 =item B<Port> I<Service/Port>
4593 The query port of the server. This needs to be a string, even if the port is
4594 given in its numeric form.
4599 =head2 Plugin C<unixsock>
4603 =item B<SocketFile> I<Path>
4605 Sets the socket-file which is to be created.
4607 =item B<SocketGroup> I<Group>
4609 If running as root change the group of the UNIX-socket after it has been
4610 created. Defaults to B<collectd>.
4612 =item B<SocketPerms> I<Permissions>
4614 Change the file permissions of the UNIX-socket after it has been created. The
4615 permissions must be given as a numeric, octal value as you would pass to
4616 L<chmod(1)>. Defaults to B<0770>.
4618 =item B<DeleteSocket> B<false>|B<true>
4620 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
4621 with the given name already exists. If I<collectd> crashes a socket file may be
4622 left over, preventing the daemon from opening a new socket when restarted.
4623 Since this is potentially dangerous, this defaults to B<false>.
4627 =head2 Plugin C<uuid>
4629 This plugin, if loaded, causes the Hostname to be taken from the machine's
4630 UUID. The UUID is a universally unique designation for the machine, usually
4631 taken from the machine's BIOS. This is most useful if the machine is running in
4632 a virtual environment such as Xen, in which case the UUID is preserved across
4633 shutdowns and migration.
4635 The following methods are used to find the machine's UUID, in order:
4641 Check I</etc/uuid> (or I<UUIDFile>).
4645 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
4650 Check for UUID from C<dmidecode> / SMBIOS.
4654 Check for UUID from Xen hypervisor.
4658 If no UUID can be found then the hostname is not modified.
4662 =item B<UUIDFile> I<Path>
4664 Take the UUID from the given file (default I</etc/uuid>).
4668 =head2 Plugin C<varnish>
4670 The Varnish plugin collects information about Varnish, an HTTP accelerator.
4674 =item B<CollectCache> B<true>|B<false>
4676 Cache hits and misses. True by default.
4678 =item B<CollectConnections> B<true>|B<false>
4680 Number of client connections received, accepted and dropped. True by default.
4682 =item B<CollectBackend> B<true>|B<false>
4684 Back-end connection statistics, such as successful, reused,
4685 and closed connections. True by default.
4687 =item B<CollectSHM> B<true>|B<false>
4689 Statistics about the shared memory log, a memory region to store
4690 log messages which is flushed to disk when full. True by default.
4692 =item B<CollectESI> B<true>|B<false>
4694 Edge Side Includes (ESI) parse statistics. False by default.
4696 =item B<CollectFetch> B<true>|B<false>
4698 Statistics about fetches (HTTP requests sent to the backend). False by default.
4700 =item B<CollectHCB> B<true>|B<false>
4702 Inserts and look-ups in the crit bit tree based hash. Look-ups are
4703 divided into locked and unlocked look-ups. False by default.
4705 =item B<CollectSMA> B<true>|B<false>
4707 malloc or umem (umem_alloc(3MALLOC) based) storage statistics.
4708 The umem storage component is Solaris specific. False by default.
4710 =item B<CollectSMS> B<true>|B<false>
4712 synth (synthetic content) storage statistics. This storage
4713 component is used internally only. False by default.
4715 =item B<CollectSM> B<true>|B<false>
4717 file (memory mapped file) storage statistics. False by default.
4719 =item B<CollectTotals> B<true>|B<false>
4721 Collects overview counters, such as the number of sessions created,
4722 the number of requests and bytes transferred. False by default.
4724 =item B<CollectWorkers> B<true>|B<false>
4726 Collect statistics about worker threads. False by default.
4730 =head2 Plugin C<vmem>
4732 The C<vmem> plugin collects information about the usage of virtual memory.
4733 Since the statistics provided by the Linux kernel are very detailed, they are
4734 collected very detailed. However, to get all the details, you have to switch
4735 them on manually. Most people just want an overview over, such as the number of
4736 pages read from swap space.
4740 =item B<Verbose> B<true>|B<false>
4742 Enables verbose collection of information. This will start collecting page
4743 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
4744 Part of these statistics are collected on a "per zone" basis.
4748 =head2 Plugin C<vserver>
4750 This plugin doesn't have any options. B<VServer> support is only available for
4751 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
4752 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
4753 need to apply the patches and compile your own kernel, which will then provide
4754 the F</proc/virtual> filesystem that is required by this plugin.
4756 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
4758 B<Note>: The traffic collected by this plugin accounts for the amount of
4759 traffic passing a socket which might be a lot less than the actual on-wire
4760 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
4761 collect on-wire traffic you could, for example, use the logging facilities of
4762 iptables to feed data for the guest IPs into the iptables plugin.
4764 =head2 Plugin C<write_http>
4766 This output plugin submits values to an http server by POST them using the
4767 PUTVAL plain-text protocol. Each destination you want to post data to needs to
4768 have one B<URL> block, within which the destination can be configured further,
4769 for example by specifying authentication data.
4773 <Plugin "write_http">
4774 <URL "http://example.com/post-collectd">
4780 B<URL> blocks need one string argument which is used as the URL to which data
4781 is posted. The following options are understood within B<URL> blocks.
4785 =item B<User> I<Username>
4787 Optional user name needed for authentication.
4789 =item B<Password> I<Password>
4791 Optional password needed for authentication.
4793 =item B<VerifyPeer> B<true>|B<false>
4795 Enable or disable peer SSL certificate verification. See
4796 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
4798 =item B<VerifyHost> B<true|false>
4800 Enable or disable peer host name verification. If enabled, the plugin checks if
4801 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
4802 matches the host name provided by the B<URL> option. If this identity check
4803 fails, the connection is aborted. Obviously, only works when connecting to a
4804 SSL enabled server. Enabled by default.
4806 =item B<CACert> I<File>
4808 File that holds one or more SSL certificates. If you want to use HTTPS you will
4809 possibly need this option. What CA certificates come bundled with C<libcurl>
4810 and are checked by default depends on the distribution you use.
4812 =item B<Format> B<Command>|B<JSON>
4814 Format of the output to generate. If set to B<Command>, will create output that
4815 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
4816 create output in the I<JavaScript Object Notation> (JSON).
4818 Defaults to B<Command>.
4820 =item B<StoreRates> B<true|false>
4822 If set to B<true>, convert counter values to rates. If set to B<false> (the
4823 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
4828 =head1 FILTER CONFIGURATION
4830 Starting with collectd 4.6 there is a powerful filtering infrastructure
4831 implemented in the daemon. The concept has mostly been copied from
4832 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
4833 terminology, so that users that are familiar with iptables feel right at home.
4837 The following are the terms used in the remainder of the filter configuration
4838 documentation. For an ASCII-art schema of the mechanism, see
4839 L<"General structure"> below.
4845 A I<match> is a criteria to select specific values. Examples are, of course, the
4846 name of the value or it's current value.
4848 Matches are implemented in plugins which you have to load prior to using the
4849 match. The name of such plugins starts with the "match_" prefix.
4853 A I<target> is some action that is to be performed with data. Such actions
4854 could, for example, be to change part of the value's identifier or to ignore
4855 the value completely.
4857 Some of these targets are built into the daemon, see L<"Built-in targets">
4858 below. Other targets are implemented in plugins which you have to load prior to
4859 using the target. The name of such plugins starts with the "target_" prefix.
4863 The combination of any number of matches and at least one target is called a
4864 I<rule>. The target actions will be performed for all values for which B<all>
4865 matches apply. If the rule does not have any matches associated with it, the
4866 target action will be performed for all values.
4870 A I<chain> is a list of rules and possibly default targets. The rules are tried
4871 in order and if one matches, the associated target will be called. If a value
4872 is handled by a rule, it depends on the target whether or not any subsequent
4873 rules are considered or if traversal of the chain is aborted, see
4874 L<"Flow control"> below. After all rules have been checked, the default targets
4879 =head2 General structure
4881 The following shows the resulting structure:
4888 +---------+ +---------+ +---------+ +---------+
4889 ! Rule !->! Match !->! Match !->! Target !
4890 +---------+ +---------+ +---------+ +---------+
4893 +---------+ +---------+ +---------+
4894 ! Rule !->! Target !->! Target !
4895 +---------+ +---------+ +---------+
4902 +---------+ +---------+ +---------+
4903 ! Rule !->! Match !->! Target !
4904 +---------+ +---------+ +---------+
4914 There are four ways to control which way a value takes through the filter
4921 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
4922 process the value with another chain. When the called chain finishes, usually
4923 the next target or rule after the jump is executed.
4927 The stop condition, signaled for example by the built-in target B<stop>, causes
4928 all processing of the value to be stopped immediately.
4932 Causes processing in the current chain to be aborted, but processing of the
4933 value generally will continue. This means that if the chain was called via
4934 B<Jump>, the next target or rule after the jump will be executed. If the chain
4935 was not called by another chain, control will be returned to the daemon and it
4936 may pass the value to another chain.
4940 Most targets will signal the B<continue> condition, meaning that processing
4941 should continue normally. There is no special built-in target for this
4948 The configuration reflects this structure directly:
4950 PostCacheChain "PostCache"
4952 <Rule "ignore_mysql_show">
4955 Type "^mysql_command$"
4956 TypeInstance "^show_"
4966 The above configuration example will ignore all values where the plugin field
4967 is "mysql", the type is "mysql_command" and the type instance begins with
4968 "show_". All other values will be sent to the C<rrdtool> write plugin via the
4969 default target of the chain. Since this chain is run after the value has been
4970 added to the cache, the MySQL C<show_*> command statistics will be available
4971 via the C<unixsock> plugin.
4973 =head2 List of configuration options
4977 =item B<PreCacheChain> I<ChainName>
4979 =item B<PostCacheChain> I<ChainName>
4981 Configure the name of the "pre-cache chain" and the "post-cache chain". The
4982 argument is the name of a I<chain> that should be executed before and/or after
4983 the values have been added to the cache.
4985 To understand the implications, it's important you know what is going on inside
4986 I<collectd>. The following diagram shows how values are passed from the
4987 read-plugins to the write-plugins:
4993 + - - - - V - - - - +
4994 : +---------------+ :
4997 : +-------+-------+ :
5000 : +-------+-------+ : +---------------+
5001 : ! Cache !--->! Value Cache !
5002 : ! insert ! : +---+---+-------+
5003 : +-------+-------+ : ! !
5004 : ! ,------------' !
5006 : +-------+---+---+ : +-------+-------+
5007 : ! Post-Cache +--->! Write-Plugins !
5008 : ! Chain ! : +---------------+
5009 : +---------------+ :
5012 + - - - - - - - - - +
5014 After the values are passed from the "read" plugins to the dispatch functions,
5015 the pre-cache chain is run first. The values are added to the internal cache
5016 afterwards. The post-cache chain is run after the values have been added to the
5017 cache. So why is it such a huge deal if chains are run before or after the
5018 values have been added to this cache?
5020 Targets that change the identifier of a value list should be executed before
5021 the values are added to the cache, so that the name in the cache matches the
5022 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
5023 this cache to receive a list of all available values. If you change the
5024 identifier after the value list has been added to the cache, this may easily
5025 lead to confusion, but it's not forbidden of course.
5027 The cache is also used to convert counter values to rates. These rates are, for
5028 example, used by the C<value> match (see below). If you use the rate stored in
5029 the cache B<before> the new value is added, you will use the old, B<previous>
5030 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
5031 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
5034 Last but not last, the B<stop> target makes a difference: If the pre-cache
5035 chain returns the stop condition, the value will not be added to the cache and
5036 the post-cache chain will not be run.
5038 =item B<Chain> I<Name>
5040 Adds a new chain with a certain name. This name can be used to refer to a
5041 specific chain, for example to jump to it.
5043 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
5045 =item B<Rule> [I<Name>]
5047 Adds a new rule to the current chain. The name of the rule is optional and
5048 currently has no meaning for the daemon.
5050 Within the B<Rule> block, there may be any number of B<Match> blocks and there
5051 must be at least one B<Target> block.
5053 =item B<Match> I<Name>
5055 Adds a match to a B<Rule> block. The name specifies what kind of match should
5056 be performed. Available matches depend on the plugins that have been loaded.
5058 The arguments inside the B<Match> block are passed to the plugin implementing
5059 the match, so which arguments are valid here depends on the plugin being used.
5060 If you do not need any to pass any arguments to a match, you can use the
5065 Which is equivalent to:
5070 =item B<Target> I<Name>
5072 Add a target to a rule or a default target to a chain. The name specifies what
5073 kind of target is to be added. Which targets are available depends on the
5074 plugins being loaded.
5076 The arguments inside the B<Target> block are passed to the plugin implementing
5077 the target, so which arguments are valid here depends on the plugin being used.
5078 If you do not need any to pass any arguments to a target, you can use the
5083 This is the same as writing:
5090 =head2 Built-in targets
5092 The following targets are built into the core daemon and therefore need no
5093 plugins to be loaded:
5099 Signals the "return" condition, see the L<"Flow control"> section above. This
5100 causes the current chain to stop processing the value and returns control to
5101 the calling chain. The calling chain will continue processing targets and rules
5102 just after the B<jump> target (see below). This is very similar to the
5103 B<RETURN> target of iptables, see L<iptables(8)>.
5105 This target does not have any options.
5113 Signals the "stop" condition, see the L<"Flow control"> section above. This
5114 causes processing of the value to be aborted immediately. This is similar to
5115 the B<DROP> target of iptables, see L<iptables(8)>.
5117 This target does not have any options.
5125 Sends the value to "write" plugins.
5131 =item B<Plugin> I<Name>
5133 Name of the write plugin to which the data should be sent. This option may be
5134 given multiple times to send the data to more than one write plugin.
5138 If no plugin is explicitly specified, the values will be sent to all available
5149 Starts processing the rules of another chain, see L<"Flow control"> above. If
5150 the end of that chain is reached, or a stop condition is encountered,
5151 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
5152 next target or the next rule. This is similar to the B<-j> command line option
5153 of iptables, see L<iptables(8)>.
5159 =item B<Chain> I<Name>
5161 Jumps to the chain I<Name>. This argument is required and may appear only once.
5173 =head2 Available matches
5179 Matches a value using regular expressions.
5185 =item B<Host> I<Regex>
5187 =item B<Plugin> I<Regex>
5189 =item B<PluginInstance> I<Regex>
5191 =item B<Type> I<Regex>
5193 =item B<TypeInstance> I<Regex>
5195 Match values where the given regular expressions match the various fields of
5196 the identifier of a value. If multiple regular expressions are given, B<all>
5197 regexen must match for a value to match.
5199 =item B<Invert> B<false>|B<true>
5201 When set to B<true>, the result of the match is inverted, i.e. all value lists
5202 where all regular expressions apply are not matched, all other value lists are
5203 matched. Defaults to B<false>.
5210 Host "customer[0-9]+"
5216 Matches values that have a time which differs from the time on the server.
5218 This match is mainly intended for servers that receive values over the
5219 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
5220 is very sensitive to the timestamp used when updating the RRD files. In
5221 particular, the time must be ever increasing. If a misbehaving client sends one
5222 packet with a timestamp far in the future, all further packets with a correct
5223 time will be ignored because of that one packet. What's worse, such corrupted
5224 RRD files are hard to fix.
5226 This match lets one match all values B<outside> a specified time range
5227 (relative to the server's time), so you can use the B<stop> target (see below)
5228 to ignore the value, for example.
5234 =item B<Future> I<Seconds>
5236 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
5237 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
5240 =item B<Past> I<Seconds>
5242 Matches all values that are I<behind> of the server's time by I<Seconds> or
5243 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
5255 This example matches all values that are five minutes or more ahead of the
5256 server or one hour (or more) lagging behind.
5260 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
5261 values. If a data-set consists of more than one data-source, all data-sources
5262 must match the specified ranges for a positive match.
5268 =item B<Min> I<Value>
5270 Sets the smallest value which still results in a match. If unset, behaves like
5273 =item B<Max> I<Value>
5275 Sets the largest value which still results in a match. If unset, behaves like
5278 =item B<Invert> B<true>|B<false>
5280 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
5281 no-match is returned and vice versa. Please note that the B<Invert> setting
5282 only effects how B<Min> and B<Max> are applied to a specific value. Especially
5283 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
5285 =item B<DataSource> I<DSName> [I<DSName> ...]
5287 Select one or more of the data sources. If no data source is configured, all
5288 data sources will be checked. If the type handled by the match does not have a
5289 data source of the specified name(s), this will always result in no match
5290 (independent of the B<Invert> setting).
5292 =item B<Satisfy> B<Any>|B<All>
5294 Specifies how checking with several data sources is performed. If set to
5295 B<Any>, the match succeeds if one of the data sources is in the configured
5296 range. If set to B<All> the match only succeeds if all data sources are within
5297 the configured range. Default is B<All>.
5299 Usually B<All> is used for positive matches, B<Any> is used for negative
5300 matches. This means that with B<All> you usually check that all values are in a
5301 "good" range, while with B<Any> you check if any value is within a "bad" range
5302 (or outside the "good" range).
5306 Either B<Min> or B<Max>, but not both, may be unset.
5310 # Match all values smaller than or equal to 100. Matches only if all data
5311 # sources are below 100.
5317 # Match if the value of any data source is outside the range of 0 - 100.
5325 =item B<empty_counter>
5327 Matches all values with one or more data sources of type B<COUNTER> and where
5328 all counter values are zero. These counters usually I<never> increased since
5329 they started existing (and are therefore uninteresting), or got reset recently
5330 or overflowed and you had really, I<really> bad luck.
5332 Please keep in mind that ignoring such counters can result in confusing
5333 behavior: Counters which hardly ever increase will be zero for long periods of
5334 time. If the counter is reset for some reason (machine or service restarted,
5335 usually), the graph will be empty (NAN) for a long time. People may not
5340 Calculates a hash value of the host name and matches values according to that
5341 hash value. This makes it possible to divide all hosts into groups and match
5342 only values that are in a specific group. The intended use is in load
5343 balancing, where you want to handle only part of all data and leave the rest
5346 The hashing function used tries to distribute the hosts evenly. First, it
5347 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
5350 for (i = 0; host[i] != 0; i++)
5351 hash_value = (hash_value * 251) + host[i];
5353 The constant 251 is a prime number which is supposed to make this hash value
5354 more random. The code then checks the group for this host according to the
5355 I<Total> and I<Match> arguments:
5357 if ((hash_value % Total) == Match)
5362 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
5363 groups), then the least significant bit of the hash value will be the XOR of
5364 all least significant bits in the host name. One consequence is that when you
5365 have two hosts, "server0.example.com" and "server1.example.com", where the host
5366 name differs in one digit only and the digits differ by one, those hosts will
5367 never end up in the same group.
5373 =item B<Match> I<Match> I<Total>
5375 Divide the data into I<Total> groups and match all hosts in group I<Match> as
5376 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
5377 be smaller than I<Total>. I<Total> must be at least one, although only values
5378 greater than one really do make any sense.
5380 You can repeat this option to match multiple groups, for example:
5385 The above config will divide the data into seven groups and match groups three
5386 and five. One use would be to keep every value on two hosts so that if one
5387 fails the missing data can later be reconstructed from the second host.
5393 # Operate on the pre-cache chain, so that ignored values are not even in the
5398 # Divide all received hosts in seven groups and accept all hosts in
5402 # If matched: Return and continue.
5405 # If not matched: Return and stop.
5411 =head2 Available targets
5415 =item B<notification>
5417 Creates and dispatches a notification.
5423 =item B<Message> I<String>
5425 This required option sets the message of the notification. The following
5426 placeholders will be replaced by an appropriate value:
5434 =item B<%{plugin_instance}>
5438 =item B<%{type_instance}>
5440 These placeholders are replaced by the identifier field of the same name.
5442 =item B<%{ds:>I<name>B<}>
5444 These placeholders are replaced by a (hopefully) human readable representation
5445 of the current rate of this data source. If you changed the instance name
5446 (using the B<set> or B<replace> targets, see below), it may not be possible to
5447 convert counter values to rates.
5451 Please note that these placeholders are B<case sensitive>!
5453 =item B<Severity> B<"FATAL">|B<"WARNING">|B<"OKAY">
5455 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
5462 <Target "notification">
5463 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
5469 Replaces parts of the identifier using regular expressions.
5475 =item B<Host> I<Regex> I<Replacement>
5477 =item B<Plugin> I<Regex> I<Replacement>
5479 =item B<PluginInstance> I<Regex> I<Replacement>
5481 =item B<TypeInstance> I<Regex> I<Replacement>
5483 Match the appropriate field with the given regular expression I<Regex>. If the
5484 regular expression matches, that part that matches is replaced with
5485 I<Replacement>. If multiple places of the input buffer match a given regular
5486 expression, only the first occurrence will be replaced.
5488 You can specify each option multiple times to use multiple regular expressions
5496 # Replace "example.net" with "example.com"
5497 Host "\\<example.net\\>" "example.com"
5499 # Strip "www." from hostnames
5505 Sets part of the identifier of a value to a given string.
5511 =item B<Host> I<String>
5513 =item B<Plugin> I<String>
5515 =item B<PluginInstance> I<String>
5517 =item B<TypeInstance> I<String>
5519 Set the appropriate field to the given string. The strings for plugin instance
5520 and type instance may be empty, the strings for host and plugin may not be
5521 empty. It's currently not possible to set the type of a value this way.
5528 PluginInstance "coretemp"
5529 TypeInstance "core3"
5534 =head2 Backwards compatibility
5536 If you use collectd with an old configuration, i.E<nbsp>e. one without a
5537 B<Chain> block, it will behave as it used to. This is equivalent to the
5538 following configuration:
5544 If you specify a B<PostCacheChain>, the B<write> target will not be added
5545 anywhere and you will have to make sure that it is called where appropriate. We
5546 suggest to add the above snippet as default target to your "PostCache" chain.
5550 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
5566 L<collectd-exec(5)>,
5567 L<collectd-perl(5)>,
5568 L<collectd-unixsock(5)>,
5581 Florian Forster E<lt>octo@verplant.orgE<gt>