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.
77 This is useful (or possibly even required), e.g., when loading a plugin that
78 embeds some scripting language into the daemon (e.g. the I<Perl> and
79 I<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 plugin.
82 See the documentation of those plugins (e.g., L<collectd-perl(5)> or
83 L<collectd-python(5)>) for details.
85 By default, this is disabled. As a special exception, if the plugin name is
86 either C<perl> or C<python>, the default is changed to enabled in order to keep
87 the average user from ever having to deal with this low level linking stuff.
91 =item B<Include> I<Path>
93 If I<Path> points to a file, includes that file. If I<Path> points to a
94 directory, recursively includes all files within that directory and its
95 subdirectories. If the C<wordexp> function is available on your system,
96 shell-like wildcards are expanded before files are included. This means you can
97 use statements like the following:
99 Include "/etc/collectd.d/*.conf"
101 If more than one files are included by a single B<Include> option, the files
102 will be included in lexicographical order (as defined by the C<strcmp>
103 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
104 order in which the files are loaded.
106 To prevent loops and shooting yourself in the foot in interesting ways the
107 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
108 most uses. Since symlinks are followed it is still possible to crash the daemon
109 by looping symlinks. In our opinion significant stupidity should result in an
110 appropriate amount of pain.
112 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
113 file, but you cannot include files from within blocks.
115 =item B<PIDFile> I<File>
117 Sets where to write the PID file to. This file is overwritten when it exists
118 and deleted when the program is stopped. Some init-scripts might override this
119 setting using the B<-P> command-line option.
121 =item B<PluginDir> I<Directory>
123 Path to the plugins (shared objects) of collectd.
125 =item B<TypesDB> I<File> [I<File> ...]
127 Set one or more files that contain the data-set descriptions. See
128 L<types.db(5)> for a description of the format of this file.
130 =item B<Interval> I<Seconds>
132 Configures the interval in which to query the read plugins. Obviously smaller
133 values lead to a higher system load produced by collectd, while higher values
134 lead to more coarse statistics.
136 B<Warning:> You should set this once and then never touch it again. If you do,
137 I<you will have to delete all your RRD files> or know some serious RRDtool
138 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
140 =item B<Timeout> I<Iterations>
142 Consider a value list "missing" when no update has been read or received for
143 I<Iterations> iterations. By default, I<collectd> considers a value list
144 missing when no update has been received for twice the update interval. Since
145 this setting uses iterations, the maximum allowed time without update depends
146 on the I<Interval> information contained in each value list. This is used in
147 the I<Threshold> configuration to dispatch notifications about missing values,
148 see L<collectd-threshold(5)> for details.
150 =item B<ReadThreads> I<Num>
152 Number of threads to start for reading plugins. The default value is B<5>, but
153 you may want to increase this if you have more than five plugins that take a
154 long time to read. Mostly those are plugin that do network-IO. Setting this to
155 a value higher than the number of plugins you've loaded is totally useless.
157 =item B<Hostname> I<Name>
159 Sets the hostname that identifies a host. If you omit this setting, the
160 hostname will be determined using the L<gethostname(2)> system call.
162 =item B<FQDNLookup> B<true|false>
164 If B<Hostname> is determined automatically this setting controls whether or not
165 the daemon should try to figure out the "fully qualified domain name", FQDN.
166 This is done using a lookup of the name returned by C<gethostname>. This option
167 is enabled by default.
169 =item B<PreCacheChain> I<ChainName>
171 =item B<PostCacheChain> I<ChainName>
173 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
174 see L<FILTER CONFIGURATION> below on information on chains and how these
175 setting change the daemon's behavior.
179 =head1 PLUGIN OPTIONS
181 Some plugins may register own options. These options must be enclosed in a
182 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
183 require external configuration, too. The C<apache plugin>, for example,
184 required C<mod_status> to be configured in the webserver you're going to
185 collect data from. These plugins are listed below as well, even if they don't
186 require any configuration within collectd's configfile.
188 A list of all plugins and a short summary for each plugin can be found in the
189 F<README> file shipped with the sourcecode and hopefully binary packets as
192 =head2 Plugin C<amqp>
194 The I<AMQMP plugin> can be used to communicate with other instances of
195 I<collectd> or third party applications using an AMQP message broker. Values
196 are sent to or received from the broker, which handles routing, queueing and
197 possibly filtering or messages.
200 # Send values to an AMQP broker
201 <Publish "some_name">
207 Exchange "amq.fanout"
208 # ExchangeType "fanout"
209 # RoutingKey "collectd"
215 # Receive values from an AMQP broker
216 <Subscribe "some_name">
222 Exchange "amq.fanout"
223 # ExchangeType "fanout"
225 # RoutingKey "collectd.#"
229 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
230 blocks, which configure sending and receiving of values respectively. The two
231 blocks are very similar, so unless otherwise noted, an option can be used in
232 either block. The name given in the blocks starting tag is only used for
233 reporting messages, but may be used to support I<flushing> of certain
234 I<Publish> blocks in the future.
238 =item B<Host> I<Host>
240 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
241 the underlying communications library, I<rabbitmq-c>, which is "localhost".
243 =item B<Port> I<Port>
245 Service name or port number on which the AMQP broker accepts connections. This
246 argument must be a string, even if the numeric form is used. Defaults to
249 =item B<VHost> I<VHost>
251 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
253 =item B<User> I<User>
255 =item B<Password> I<Password>
257 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
260 =item B<Exchange> I<Exchange>
262 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
263 By default, "amq.fanout" will be used.
265 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
266 the given exchange and the I<queue> is created, using the I<routing key> if
267 configured. See the B<Queue> and B<RoutingKey> options below.
269 =item B<ExchangeType> I<Type>
271 If given, the plugin will try to create the configured I<exchange> with this
272 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
273 be bound to this exchange.
275 =item B<Queue> I<Queue> (Subscribe only)
277 Configures the I<queue> name to subscribe to. If no queue name was configures
278 explicitly, a unique queue name will be created by the broker.
280 =item B<RoutingKey> I<Key>
282 In I<Publish> blocks, this configures the routing key to set on all outgoing
283 messages. If not given, the routing key will be computed from the I<identifier>
284 of the value. The host, plugin, type and the two instances are concatenated
285 together using dots as the separator and all containing dots replaced with
286 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
287 possible to receive only specific values using a "topic" exchange.
289 In I<Subscribe> blocks, configures the I<routing key> used when creating a
290 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
291 used to filter messages when using a "topic" exchange. If you're only
292 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
295 =item B<Persistent> B<true>|B<false> (Publish only)
297 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
298 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
299 default), the I<transient> delivery mode will be used, i.e. messages may be
300 lost due to high load, overflowing queues or similar issues.
302 =item B<Format> B<Command>|B<JSON> (Publish only)
304 Selects the format in which messages are sent to the broker. If set to
305 B<Command> (the default), values are sent as C<PUTVAL> commands which are
306 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
307 case, the C<Content-Type> header field will be set to C<text/collectd>.
309 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
310 an easy and straight forward exchange format. The C<Content-Type> header field
311 will be set to C<application/json>.
313 A subscribing client I<should> use the C<Content-Type> header field to
314 determine how to decode the values. Currently, the I<AMQP plugin> itself can
315 only decode the B<Command> format.
317 =item B<StoreRates> B<true>|B<false> (Publish only)
319 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
320 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
321 default), no conversion is performed. Otherwise the conversion is performed
322 using the internal value cache.
324 Please note that currently this option is only used if the B<Format> option has
329 =head2 Plugin C<apache>
331 To configure the C<apache>-plugin you first need to configure the Apache
332 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
333 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
334 the following snipped to base your Apache config upon:
337 <IfModule mod_status.c>
338 <Location /mod_status>
339 SetHandler server-status
343 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
344 also supported. It introduces a new field, called C<BusyServers>, to count the
345 number of currently connected clients. This field is also supported.
347 The configuration of the I<Apache> plugin consists of one or more
348 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
349 as the instance name. For example:
353 URL "http://www1.example.com/mod_status?auto"
356 URL "http://www2.example.com/mod_status?auto"
360 The instance name will be used as the I<plugin instance>. To emulate the old
361 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
362 plugin to work correctly, each instance name must be unique. This is not
363 enforced by the plugin and it is your responsibility to ensure it.
365 The following options are accepted within each I<Instance> block:
369 =item B<URL> I<http://host/mod_status?auto>
371 Sets the URL of the C<mod_status> output. This needs to be the output generated
372 by C<ExtendedStatus on> and it needs to be the machine readable output
373 generated by appending the C<?auto> argument. This option is I<mandatory>.
375 =item B<User> I<Username>
377 Optional user name needed for authentication.
379 =item B<Password> I<Password>
381 Optional password needed for authentication.
383 =item B<VerifyPeer> B<true|false>
385 Enable or disable peer SSL certificate verification. See
386 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
388 =item B<VerifyHost> B<true|false>
390 Enable or disable peer host name verification. If enabled, the plugin checks
391 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
392 certificate matches the host name provided by the B<URL> option. If this
393 identity check fails, the connection is aborted. Obviously, only works when
394 connecting to a SSL enabled server. Enabled by default.
396 =item B<CACert> I<File>
398 File that holds one or more SSL certificates. If you want to use HTTPS you will
399 possibly need this option. What CA certificates come bundled with C<libcurl>
400 and are checked by default depends on the distribution you use.
404 =head2 Plugin C<apcups>
408 =item B<Host> I<Hostname>
410 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
411 that IPv6 support has been disabled unless someone can confirm or decline that
412 B<apcupsd> can handle it.
414 =item B<Port> I<Port>
416 TCP-Port to connect to. Defaults to B<3551>.
420 =head2 Plugin C<ascent>
422 This plugin collects information about an Ascent server, a free server for the
423 "World of Warcraft" game. This plugin gathers the information by fetching the
424 XML status page using C<libcurl> and parses it using C<libxml2>.
426 The configuration options are the same as for the C<apache> plugin above:
430 =item B<URL> I<http://localhost/ascent/status/>
432 Sets the URL of the XML status output.
434 =item B<User> I<Username>
436 Optional user name needed for authentication.
438 =item B<Password> I<Password>
440 Optional password needed for authentication.
442 =item B<VerifyPeer> B<true|false>
444 Enable or disable peer SSL certificate verification. See
445 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
447 =item B<VerifyHost> B<true|false>
449 Enable or disable peer host name verification. If enabled, the plugin checks
450 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
451 certificate matches the host name provided by the B<URL> option. If this
452 identity check fails, the connection is aborted. Obviously, only works when
453 connecting to a SSL enabled server. Enabled by default.
455 =item B<CACert> I<File>
457 File that holds one or more SSL certificates. If you want to use HTTPS you will
458 possibly need this option. What CA certificates come bundled with C<libcurl>
459 and are checked by default depends on the distribution you use.
463 =head2 Plugin C<bind>
465 Starting with BIND 9.5.0, the most widely used DNS server software provides
466 extensive statistics about queries, responses and lots of other information.
467 The bind plugin retrieves this information that's encoded in XML and provided
468 via HTTP and submits the values to collectd.
470 To use this plugin, you first need to tell BIND to make this information
471 available. This is done with the C<statistics-channels> configuration option:
473 statistics-channels {
474 inet localhost port 8053;
477 The configuration follows the grouping that can be seen when looking at the
478 data with an XSLT compatible viewer, such as a modern web browser. It's
479 probably a good idea to make yourself familiar with the provided values, so you
480 can understand what the collected statistics actually mean.
485 URL "http://localhost:8053/"
500 Zone "127.in-addr.arpa/IN"
504 The bind plugin accepts the following configuration options:
510 URL from which to retrieve the XML data. If not specified,
511 C<http://localhost:8053/> will be used.
513 =item B<ParseTime> B<true>|B<false>
515 When set to B<true>, the time provided by BIND will be parsed and used to
516 dispatch the values. When set to B<false>, the local time source is queried.
518 This setting is set to B<true> by default for backwards compatibility; setting
519 this to B<false> is I<recommended> to avoid problems with timezones and
522 =item B<OpCodes> B<true>|B<false>
524 When enabled, statistics about the I<"OpCodes">, for example the number of
525 C<QUERY> packets, are collected.
529 =item B<QTypes> B<true>|B<false>
531 When enabled, the number of I<incoming> queries by query types (for example
532 C<A>, C<MX>, C<AAAA>) is collected.
536 =item B<ServerStats> B<true>|B<false>
538 Collect global server statistics, such as requests received over IPv4 and IPv6,
539 successful queries, and failed updates.
543 =item B<ZoneMaintStats> B<true>|B<false>
545 Collect zone maintenance statistics, mostly information about notifications
546 (zone updates) and zone transfers.
550 =item B<ResolverStats> B<true>|B<false>
552 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
553 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
554 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
555 default. Use the B<ResolverStats> option within a B<View "_default"> block
556 instead for the same functionality.
562 Collect global memory statistics.
566 =item B<View> I<Name>
568 Collect statistics about a specific I<"view">. BIND can behave different,
569 mostly depending on the source IP-address of the request. These different
570 configurations are called "views". If you don't use this feature, you most
571 likely are only interested in the C<_default> view.
573 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
574 information you want to collect about a view. If no B<View> block is
575 configured, no detailed view statistics will be collected.
579 =item B<QTypes> B<true>|B<false>
581 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
586 =item B<ResolverStats> B<true>|B<false>
588 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
589 (e.E<nbsp>g. queries over IPv4, lame servers).
593 =item B<CacheRRSets> B<true>|B<false>
595 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
596 type is collected. Negative entries (queries which resulted in an error, for
597 example names that do not exist) are reported with a leading exclamation mark,
602 =item B<Zone> I<Name>
604 When given, collect detailed information about the given zone in the view. The
605 information collected if very similar to the global B<ServerStats> information
608 You can repeat this option to collect detailed information about multiple
611 By default no detailed zone information is collected.
617 =head2 Plugin C<cpufreq>
619 This plugin doesn't have any options. It reads
620 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
621 installed) to get the current CPU frequency. If this file does not exist make
622 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
623 installed and an "cpu governor" (that's a kernel module) is loaded.
629 =item B<DataDir> I<Directory>
631 Set the directory to store CSV-files under. Per default CSV-files are generated
632 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
633 The special strings B<stdout> and B<stderr> can be used to write to the standard
634 output and standard error channels, respectively. This, of course, only makes
635 much sense when collectd is running in foreground- or non-daemon-mode.
637 =item B<StoreRates> B<true|false>
639 If set to B<true>, convert counter values to rates. If set to B<false> (the
640 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
645 =head2 Plugin C<curl>
647 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
648 and the match infrastructure (the same code used by the tail plugin) to use
649 regular expressions with the received data.
651 The following example will read the current value of AMD stock from Google's
652 finance page and dispatch the value to collectd.
655 <Page "stock_quotes">
656 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
660 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
661 DSType "GaugeAverage"
662 # Note: `stock_value' is not a standard type.
669 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
670 a web page and one or more "matches" to be performed on the returned data. The
671 string argument to the B<Page> block is used as plugin instance.
673 The following options are valid within B<Page> blocks:
679 URL of the web site to retrieve. Since a regular expression will be used to
680 extract information from this data, non-binary data is a big plus here ;)
682 =item B<User> I<Name>
684 Username to use if authorization is required to read the page.
686 =item B<Password> I<Password>
688 Password to use if authorization is required to read the page.
690 =item B<VerifyPeer> B<true>|B<false>
692 Enable or disable peer SSL certificate verification. See
693 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
695 =item B<VerifyHost> B<true>|B<false>
697 Enable or disable peer host name verification. If enabled, the plugin checks if
698 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
699 matches the host name provided by the B<URL> option. If this identity check
700 fails, the connection is aborted. Obviously, only works when connecting to a
701 SSL enabled server. Enabled by default.
703 =item B<CACert> I<file>
705 File that holds one or more SSL certificates. If you want to use HTTPS you will
706 possibly need this option. What CA certificates come bundled with C<libcurl>
707 and are checked by default depends on the distribution you use.
709 =item B<MeasureResponseTime> B<true>|B<false>
711 Measure response time for the request. If this setting is enabled, B<Match>
712 blocks (see below) are optional. Disabled by default.
714 =item B<E<lt>MatchE<gt>>
716 One or more B<Match> blocks that define how to match information in the data
717 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
718 used by the C<tail> plugin, so please see the documentation of the C<tail>
719 plugin below on how matches are defined. If the B<MeasureResponseTime> option
720 is set to B<true>, B<Match> blocks are optional.
724 =head2 Plugin C<curl_json>
726 The B<curl_json plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and
727 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) to retrieve JSON data
728 via cURL. This can be used to collect values from CouchDB documents (which are
729 stored JSON notation), for example.
731 The following example will collect several values from the built-in `_stats'
732 runtime statistics module of CouchDB
733 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
736 <URL "http://localhost:5984/_stats">
738 <Key "httpd/requests/count">
742 <Key "httpd_request_methods/*/count">
743 Type "http_request_methods"
746 <Key "httpd_status_codes/*/count">
747 Type "http_response_codes"
752 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining
753 a URL to be fetched via HTTP (using libcurl) and one or more B<Key> blocks.
754 The B<Key> string argument must be in a path format, which is used to collect a
755 value from a JSON map object. If a path element of B<Key> is the
756 I<*>E<nbsp>wildcard, the values for all keys will be collectd.
758 The following options are valid within B<URL> blocks:
762 =item B<Instance> I<Instance>
764 Sets the plugin instance to I<Instance>.
766 =item B<User> I<Name>
768 Username to use if authorization is required to read the page.
770 =item B<Password> I<Password>
772 Password to use if authorization is required to read the page.
774 =item B<VerifyPeer> B<true>|B<false>
776 Enable or disable peer SSL certificate verification. See
777 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
779 =item B<VerifyHost> B<true>|B<false>
781 Enable or disable peer host name verification. If enabled, the plugin checks if
782 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
783 matches the host name provided by the B<URL> option. If this identity check
784 fails, the connection is aborted. Obviously, only works when connecting to a
785 SSL enabled server. Enabled by default.
787 =item B<CACert> I<file>
789 File that holds one or more SSL certificates. If you want to use HTTPS you will
790 possibly need this option. What CA certificates come bundled with C<libcurl>
791 and are checked by default depends on the distribution you use.
795 The following options are valid within B<Key> blocks:
799 =item B<Type> I<Type>
801 Sets the type used to dispatch the values to the daemon. Detailed information
802 about types and their configuration can be found in L<types.db(5)>. This
805 =item B<Instance> I<Instance>
807 Type-instance to use. Defaults to the current map key or current string array element value.
811 =head2 Plugin C<curl_xml>
813 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
814 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
817 <URL "http://localhost/stats.xml">
819 Instance "some_instance"
824 CACert "/path/to/ca.crt"
826 <XPath "table[@id=\"magic_level\"]/tr">
828 #InstancePrefix "prefix-"
830 ValuesFrom "td[2]/span[@class=\"level\"]"
835 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
836 URL to be fetched using libcurl. Within each B<URL> block there are
837 options which specify the connection parameters, for example authentication
838 information, and one or more B<XPath> blocks.
840 Each B<XPath> block specifies how to get one type of information. The
841 string argument must be a valid XPath expression which returns a list
842 of "base elements". One value is dispatched for each "base element". The
843 I<type instance> and values are looked up using further I<XPath> expressions
844 that should be relative to the base element.
846 Within the B<URL> block the following options are accepted:
850 =item B<Host> I<Name>
852 Use I<Name> as the host name when submitting values. Defaults to the global
855 =item B<Instance> I<Instance>
857 Use I<Instance> as the plugin instance when submitting values. Defaults to an
858 empty string (no plugin instance).
860 =item B<User> I<User>
861 =item B<Password> I<Password>
862 =item B<VerifyPeer> B<true>|B<false>
863 =item B<VerifyHost> B<true>|B<false>
864 =item B<CACert> I<CA Cert File>
866 These options behave exactly equivalent to the appropriate options of the
867 I<cURL> and I<cURL-JSON> plugins. Please see there for a detailed description.
869 =item E<lt>B<XPath> I<XPath-expression>E<gt>
871 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
872 B<XPath> block specifies how to get one type of information. The string
873 argument must be a valid XPath expression which returns a list of "base
874 elements". One value is dispatched for each "base element".
876 Within the B<XPath> block the following options are accepted:
880 =item B<Type> I<Type>
882 Specifies the I<Type> used for submitting patches. This determines the number
883 of values that are required / expected and whether the strings are parsed as
884 signed or unsigned integer or as double values. See L<types.db(5)> for details.
885 This option is required.
887 =item B<InstancePrefix> I<InstancePrefix>
889 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
890 concatenated together without any separator.
891 This option is optional.
893 =item B<InstanceFrom> I<InstanceFrom>
895 Specifies a XPath expression to use for determining the I<type instance>. The
896 XPath expression must return exactly one element. The element's value is then
897 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
899 This value is required. As a special exception, if the "base XPath expression"
900 (the argument to the B<XPath> block) returns exactly one argument, then this
901 option may be omitted.
903 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
905 Specifies one or more XPath expression to use for reading the values. The
906 number of XPath expressions must match the number of data sources in the
907 I<type> specified with B<Type> (see above). Each XPath expression must return
908 exactly one element. The element's value is then parsed as a number and used as
909 value for the appropriate value in the value list dispatched to the daemon.
917 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
918 connect to various databases, execute I<SQL> statements and read back the
919 results. I<dbi> is an acronym for "database interface" in case you were
920 wondering about the name. You can configure how each column is to be
921 interpreted and the plugin will generate one or more data sets from each row
922 returned according to these rules.
924 Because the plugin is very generic, the configuration is a little more complex
925 than those of other plugins. It usually looks something like this:
928 <Query "out_of_stock">
929 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
930 # Use with MySQL 5.0.0 or later
934 InstancePrefix "out_of_stock"
935 InstancesFrom "category"
939 <Database "product_information">
941 DriverOption "host" "localhost"
942 DriverOption "username" "collectd"
943 DriverOption "password" "aZo6daiw"
944 DriverOption "dbname" "prod_info"
950 The configuration above defines one query with one result and one database. The
951 query is then linked to the database with the B<Query> option I<within> the
952 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
953 and you can also use the B<Include> statement to split up the configuration
954 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
955 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
958 The following is a complete list of options:
960 =head3 B<Query> blocks
962 Query blocks define I<SQL> statements and how the returned data should be
963 interpreted. They are identified by the name that is given in the opening line
964 of the block. Thus the name needs to be unique. Other than that, the name is
965 not used in collectd.
967 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
968 define which column holds which value or instance information. You can use
969 multiple B<Result> blocks to create multiple values from one returned row. This
970 is especially useful, when queries take a long time and sending almost the same
971 query again and again is not desirable.
975 <Query "environment">
976 Statement "select station, temperature, humidity from environment"
979 # InstancePrefix "foo"
980 InstancesFrom "station"
981 ValuesFrom "temperature"
985 InstancesFrom "station"
986 ValuesFrom "humidity"
990 The following options are accepted:
994 =item B<Statement> I<SQL>
996 Sets the statement that should be executed on the server. This is B<not>
997 interpreted by collectd, but simply passed to the database server. Therefore,
998 the SQL dialect that's used depends on the server collectd is connected to.
1000 The query has to return at least two columns, one for the instance and one
1001 value. You cannot omit the instance, even if the statement is guaranteed to
1002 always return exactly one line. In that case, you can usually specify something
1005 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1007 (That works with MySQL but may not be valid SQL according to the spec. If you
1008 use a more strict database server, you may have to select from a dummy table or
1011 Please note that some databases, for example B<Oracle>, will fail if you
1012 include a semicolon at the end of the statement.
1014 =item B<MinVersion> I<Version>
1016 =item B<MaxVersion> I<Value>
1018 Only use this query for the specified database version. You can use these
1019 options to provide multiple queries with the same name but with a slightly
1020 different syntax. The plugin will use only those queries, where the specified
1021 minimum and maximum versions fit the version of the database in use.
1023 The database version is determined by C<dbi_conn_get_engine_version>, see the
1024 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1025 for details. Basically, each part of the version is assumed to be in the range
1026 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1027 "40102", version "5.0.42" becomes "50042".
1029 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1030 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1031 happen. Don't to it! A valid example would be something along these lines:
1042 In the above example, there are three ranges that don't overlap. The last one
1043 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1044 before "4.0.0" are not specified.
1046 =item B<Type> I<Type>
1048 The B<type> that's used for each line returned. See L<types.db(5)> for more
1049 details on how types are defined. In short: A type is a predefined layout of
1050 data and the number of values and type of values has to match the type
1053 If you specify "temperature" here, you need exactly one gauge column. If you
1054 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1057 There must be exactly one B<Type> option inside each B<Result> block.
1059 =item B<InstancePrefix> I<prefix>
1061 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1062 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1063 all strings returned in the appropriate columns are concatenated together,
1064 separated by dashes I<("-")>.
1066 =item B<InstancesFrom> I<column0> [I<column1> ...]
1068 Specifies the columns whose values will be used to create the "type-instance"
1069 for each row. If you specify more than one column, the value of all columns
1070 will be joined together with dashes I<("-")> as separation characters.
1072 The plugin itself does not check whether or not all built instances are
1073 different. It's your responsibility to assure that each is unique. This is
1074 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1075 sure that only one row is returned in this case.
1077 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1080 =item B<ValuesFrom> I<column0> [I<column1> ...]
1082 Names the columns whose content is used as the actual data for the data sets
1083 that are dispatched to the daemon. How many such columns you need is determined
1084 by the B<Type> setting above. If you specify too many or not enough columns,
1085 the plugin will complain about that and no data will be submitted to the
1088 The actual data type in the columns is not that important. The plugin will
1089 automatically cast the values to the right type if it know how to do that. So
1090 it should be able to handle integer an floating point types, as well as strings
1091 (if they include a number at the beginning).
1093 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1097 =head3 B<Database> blocks
1099 Database blocks define a connection to a database and which queries should be
1100 sent to that database. Since the used "dbi" library can handle a wide variety
1101 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1102 documentationE<nbsp>- we stick as close to the terminology used there.
1104 Each database needs a "name" as string argument in the starting tag of the
1105 block. This name will be used as "PluginInstance" in the values submitted to
1106 the daemon. Other than that, that name is not used.
1110 =item B<Driver> I<Driver>
1112 Specifies the driver to use to connect to the database. In many cases those
1113 drivers are named after the database they can connect to, but this is not a
1114 technical necessity. These drivers are sometimes referred to as "DBD",
1115 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1116 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1117 project at L<http://libdbi-drivers.sourceforge.net/>.
1119 You need to give the driver name as expected by the "dbi" library here. You
1120 should be able to find that in the documentation for each driver. If you
1121 mistype the driver name, the plugin will dump a list of all known driver names
1124 =item B<DriverOption> I<Key> I<Value>
1126 Sets driver-specific options. What option a driver supports can be found in the
1127 documentation for each driver, somewhere at
1128 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1129 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1131 Unfortunately, drivers are not too keen to report errors when an unknown option
1132 is passed to them, so invalid settings here may go unnoticed. This is not the
1133 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1134 the driver. If a driver complains about an option, the plugin will dump a
1135 complete list of all options understood by that driver to the log.
1137 =item B<SelectDB> I<Database>
1139 In some cases, the database name you connect with is not the database name you
1140 want to use for querying data. If this option is set, the plugin will "select"
1141 (switch to) that database after the connection is established.
1143 =item B<Query> I<QueryName>
1145 Associates the query named I<QueryName> with this database connection. The
1146 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1147 blocks you want to refer to must be placed above the database block you want to
1156 =item B<Device> I<Device>
1158 Select partitions based on the devicename.
1160 =item B<MountPoint> I<Directory>
1162 Select partitions based on the mountpoint.
1164 =item B<FSType> I<FSType>
1166 Select partitions based on the filesystem type.
1168 =item B<IgnoreSelected> B<true>|B<false>
1170 Invert the selection: If set to true, all partitions B<except> the ones that
1171 match any one of the criteria are collected. By default only selected
1172 partitions are collected if a selection is made. If no selection is configured
1173 at all, B<all> partitions are selected.
1175 =item B<ReportByDevice> B<true>|B<false>
1177 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1178 (the default), it will report a disk as "root", but with it I<true>, it will be
1179 "sda1" (or whichever).
1181 =item B<ReportInodes> B<true>|B<false>
1183 Enables or disables reporting of free, reserved and used inodes. Defaults to
1184 inode collection being disabled.
1186 Enable this option if inodes are a scarce resource for you, usually because
1187 many small files are stored on the disk. This is a usual scenario for mail
1188 transfer agents and web caches.
1192 =head2 Plugin C<disk>
1194 The C<disk> plugin collects information about the usage of physical disks and
1195 logical disks (partitions). Values collected are the number of octets written
1196 to and read from a disk or partition, the number of read/write operations
1197 issued to the disk and a rather complex "time" it took for these commands to be
1200 Using the following two options you can ignore some disks or configure the
1201 collection only of specific disks.
1205 =item B<Disk> I<Name>
1207 Select the disk I<Name>. Whether it is collected or ignored depends on the
1208 B<IgnoreSelected> setting, see below. As with other plugins that use the
1209 daemon's ignorelist functionality, a string that starts and ends with a slash
1210 is interpreted as a regular expression. Examples:
1215 =item B<IgnoreSelected> B<true>|B<false>
1217 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1218 statements, are ignored or if all other disks are ignored. The behavior
1219 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1220 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1221 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1222 is set to B<true>, all disks are collected B<except> the ones matched.
1226 =head2 Plugin C<dns>
1230 =item B<Interface> I<Interface>
1232 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1233 option sets the interface that should be used. If this option is not set, or
1234 set to "any", the plugin will try to get packets from B<all> interfaces. This
1235 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1237 =item B<IgnoreSource> I<IP-address>
1239 Ignore packets that originate from this address.
1241 =item B<SelectNumericQueryTypes> B<true>|B<false>
1243 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1247 =head2 Plugin C<email>
1251 =item B<SocketFile> I<Path>
1253 Sets the socket-file which is to be created.
1255 =item B<SocketGroup> I<Group>
1257 If running as root change the group of the UNIX-socket after it has been
1258 created. Defaults to B<collectd>.
1260 =item B<SocketPerms> I<Permissions>
1262 Change the file permissions of the UNIX-socket after it has been created. The
1263 permissions must be given as a numeric, octal value as you would pass to
1264 L<chmod(1)>. Defaults to B<0770>.
1266 =item B<MaxConns> I<Number>
1268 Sets the maximum number of connections that can be handled in parallel. Since
1269 this many threads will be started immediately setting this to a very high
1270 value will waste valuable resources. Defaults to B<5> and will be forced to be
1271 at most B<16384> to prevent typos and dumb mistakes.
1275 =head2 Plugin C<ethstat>
1277 The I<ethstat plugin> collects information about network interface cards (NICs)
1278 by talking directly with the underlying kernel driver using L<ioctl(2)>.
1284 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
1285 Map "multicast" "if_multicast"
1292 =item B<Interface> I<Name>
1294 Collect statistical information about interface I<Name>.
1296 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
1298 By default, the plugin will submit values as type C<derive> and I<type
1299 instance> set to I<Name>, the name of the metric as reported by the driver. If
1300 an appropriate B<Map> option exists, the given I<Type> and, optionally,
1301 I<TypeInstance> will be used.
1303 =item B<MappedOnly> B<true>|B<false>
1305 When set to B<true>, only metrics that can be mapped to to a I<type> will be
1306 collected, all other metrics will be ignored. Defaults to B<false>.
1310 =head2 Plugin C<exec>
1312 Please make sure to read L<collectd-exec(5)> before using this plugin. It
1313 contains valuable information on when the executable is executed and the
1314 output that is expected from it.
1318 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1320 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1322 Execute the executable I<Executable> as user I<User>. If the user name is
1323 followed by a colon and a group name, the effective group is set to that group.
1324 The real group and saved-set group will be set to the default group of that
1325 user. If no group is given the effective group ID will be the same as the real
1328 Please note that in order to change the user and/or group the daemon needs
1329 superuser privileges. If the daemon is run as an unprivileged user you must
1330 specify the same user/group here. If the daemon is run with superuser
1331 privileges, you must supply a non-root user here.
1333 The executable may be followed by optional arguments that are passed to the
1334 program. Please note that due to the configuration parsing numbers and boolean
1335 values may be changed. If you want to be absolutely sure that something is
1336 passed as-is please enclose it in quotes.
1338 The B<Exec> and B<NotificationExec> statements change the semantics of the
1339 programs executed, i.E<nbsp>e. the data passed to them and the response
1340 expected from them. This is documented in great detail in L<collectd-exec(5)>.
1344 =head2 Plugin C<filecount>
1346 The C<filecount> plugin counts the number of files in a certain directory (and
1347 its subdirectories) and their combined size. The configuration is very straight
1350 <Plugin "filecount">
1351 <Directory "/var/qmail/queue/mess">
1352 Instance "qmail-message"
1354 <Directory "/var/qmail/queue/todo">
1355 Instance "qmail-todo"
1357 <Directory "/var/lib/php5">
1358 Instance "php5-sessions"
1363 The example above counts the number of files in QMail's queue directories and
1364 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
1365 QMail has not yet looked at, the "message" queue holds the messages that were
1366 classified into "local" and "remote".
1368 As you can see, the configuration consists of one or more C<Directory> blocks,
1369 each of which specifies a directory in which to count the files. Within those
1370 blocks, the following options are recognized:
1374 =item B<Instance> I<Instance>
1376 Sets the plugin instance to I<Instance>. That instance name must be unique, but
1377 it's your responsibility, the plugin doesn't check for that. If not given, the
1378 instance is set to the directory name with all slashes replaced by underscores
1379 and all leading underscores removed.
1381 =item B<Name> I<Pattern>
1383 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
1384 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
1385 against the pattern, not the entire path. In case this makes it easier for you:
1386 This option has been named after the B<-name> parameter to L<find(1)>.
1388 =item B<MTime> I<Age>
1390 Count only files of a specific age: If I<Age> is greater than zero, only files
1391 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
1392 a negative number, this is inversed. For example, if B<-60> is specified, only
1393 files that have been modified in the last minute will be counted.
1395 The number can also be followed by a "multiplier" to easily specify a larger
1396 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
1397 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
1398 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
1399 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
1400 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
1403 =item B<Size> I<Size>
1405 Count only files of a specific size. When I<Size> is a positive number, only
1406 files that are at least this big are counted. If I<Size> is a negative number,
1407 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
1408 I<Size> are counted.
1410 As with the B<MTime> option, a "multiplier" may be added. For a detailed
1411 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
1412 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
1413 note that there are 1000 bytes in a kilobyte, not 1024.
1415 =item B<Recursive> I<true>|I<false>
1417 Controls whether or not to recurse into subdirectories. Enabled by default.
1419 =item B<IncludeHidden> I<true>|I<false>
1421 Controls whether or not to include "hidden" files and directories in the count.
1422 "Hidden" files and directories are those, whose name begins with a dot.
1423 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
1427 =head2 Plugin C<GenericJMX>
1429 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
1430 L<collectd-java(5)>.
1432 =head2 Plugin C<gmond>
1434 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
1435 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
1436 are built-in, custom mappings may be added via B<Metric> blocks, see below.
1441 MCReceiveFrom "239.2.11.71" "8649"
1442 <Metric "swap_total">
1444 TypeInstance "total"
1447 <Metric "swap_free">
1454 The following metrics are built-in:
1460 load_one, load_five, load_fifteen
1464 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
1468 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
1480 Available configuration options:
1484 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
1486 Sets sets the multicast group and UDP port to which to subscribe.
1488 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
1490 =item E<lt>B<Metric> I<Name>E<gt>
1492 These blocks add a new metric conversion to the internal table. I<Name>, the
1493 string argument to the B<Metric> block, is the metric name as used by Ganglia.
1497 =item B<Type> I<Type>
1499 Type to map this metric to. Required.
1501 =item B<TypeInstance> I<Instance>
1503 Type-instance to use. Optional.
1505 =item B<DataSource> I<Name>
1507 Data source to map this metric to. If the configured type has exactly one data
1508 source, this is optional. Otherwise the option is required.
1514 =head2 Plugin C<hddtemp>
1516 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
1517 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
1518 default values, see below. C<hddtemp> has to be running to work correctly. If
1519 C<hddtemp> is not running timeouts may appear which may interfere with other
1522 The B<hddtemp> homepage can be found at
1523 L<http://www.guzu.net/linux/hddtemp.php>.
1527 =item B<Host> I<Hostname>
1529 Hostname to connect to. Defaults to B<127.0.0.1>.
1531 =item B<Port> I<Port>
1533 TCP-Port to connect to. Defaults to B<7634>.
1537 =head2 Plugin C<interface>
1541 =item B<Interface> I<Interface>
1543 Select this interface. By default these interfaces will then be collected. For
1544 a more detailed description see B<IgnoreSelected> below.
1546 =item B<IgnoreSelected> I<true>|I<false>
1548 If no configuration if given, the B<traffic>-plugin will collect data from
1549 all interfaces. This may not be practical, especially for loopback- and
1550 similar interfaces. Thus, you can use the B<Interface>-option to pick the
1551 interfaces you're interested in. Sometimes, however, it's easier/preferred
1552 to collect all interfaces I<except> a few ones. This option enables you to
1553 do that: By setting B<IgnoreSelected> to I<true> the effect of
1554 B<Interface> is inverted: All selected interfaces are ignored and all
1555 other interfaces are collected.
1559 =head2 Plugin C<ipmi>
1563 =item B<Sensor> I<Sensor>
1565 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
1567 =item B<IgnoreSelected> I<true>|I<false>
1569 If no configuration if given, the B<ipmi> plugin will collect data from all
1570 sensors found of type "temperature", "voltage", "current" and "fanspeed".
1571 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
1572 the effect of B<Sensor> is inverted: All selected sensors are ignored and
1573 all other sensors are collected.
1575 =item B<NotifySensorAdd> I<true>|I<false>
1577 If a sensor appears after initialization time of a minute a notification
1580 =item B<NotifySensorRemove> I<true>|I<false>
1582 If a sensor disappears a notification is sent.
1584 =item B<NotifySensorNotPresent> I<true>|I<false>
1586 If you have for example dual power supply and one of them is (un)plugged then
1587 a notification is sent.
1591 =head2 Plugin C<iptables>
1595 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
1597 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
1598 will collect the counters of all rules which have a comment-match. The comment
1599 is then used as type-instance.
1601 If I<Comment> or I<Number> is given, only the rule with the matching comment or
1602 the I<n>th rule will be collected. Again, the comment (or the number) will be
1603 used as the type-instance.
1605 If I<Name> is supplied, it will be used as the type-instance instead of the
1606 comment or the number.
1610 =head2 Plugin C<irq>
1616 Select this irq. By default these irqs will then be collected. For a more
1617 detailed description see B<IgnoreSelected> below.
1619 =item B<IgnoreSelected> I<true>|I<false>
1621 If no configuration if given, the B<irq>-plugin will collect data from all
1622 irqs. This may not be practical, especially if no interrupts happen. Thus, you
1623 can use the B<Irq>-option to pick the interrupt you're interested in.
1624 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
1625 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
1626 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
1627 and all other interrupts are collected.
1631 =head2 Plugin C<java>
1633 The I<Java> plugin makes it possible to write extensions for collectd in Java.
1634 This section only discusses the syntax and semantic of the configuration
1635 options. For more in-depth information on the I<Java> plugin, please read
1636 L<collectd-java(5)>.
1641 JVMArg "-verbose:jni"
1642 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
1643 LoadPlugin "org.collectd.java.Foobar"
1644 <Plugin "org.collectd.java.Foobar">
1645 # To be parsed by the plugin
1649 Available configuration options:
1653 =item B<JVMArg> I<Argument>
1655 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
1656 exactly the way the arguments to the I<java> binary on the command line work.
1657 Execute C<javaE<nbsp>--help> for details.
1659 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
1660 any other options! When another option is found, the JVM will be started and
1661 later options will have to be ignored!
1663 =item B<LoadPlugin> I<JavaClass>
1665 Instantiates a new I<JavaClass> object. The constructor of this object very
1666 likely then registers one or more callback methods with the server.
1668 See L<collectd-java(5)> for details.
1670 When the first such option is found, the virtual machine (JVM) is created. This
1671 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
1672 B<LoadPlugin> options!
1674 =item B<Plugin> I<Name>
1676 The entire block is passed to the Java plugin as an
1677 I<org.collectd.api.OConfigItem> object.
1679 For this to work, the plugin has to register a configuration callback first,
1680 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
1681 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
1682 depends on the (Java) plugin registering the callback and is completely
1683 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
1687 =head2 Plugin C<libvirt>
1689 This plugin allows CPU, disk and network load to be collected for virtualized
1690 guests on the machine. This means that these characteristics can be collected
1691 for guest systems without installing any software on them - collectd only runs
1692 on the hosting system. The statistics are collected through libvirt
1693 (L<http://libvirt.org/>).
1695 Only I<Connection> is required.
1699 =item B<Connection> I<uri>
1701 Connect to the hypervisor given by I<uri>. For example if using Xen use:
1703 Connection "xen:///"
1705 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
1707 =item B<RefreshInterval> I<seconds>
1709 Refresh the list of domains and devices every I<seconds>. The default is 60
1710 seconds. Setting this to be the same or smaller than the I<Interval> will cause
1711 the list of domains and devices to be refreshed on every iteration.
1713 Refreshing the devices in particular is quite a costly operation, so if your
1714 virtualization setup is static you might consider increasing this. If this
1715 option is set to 0, refreshing is disabled completely.
1717 =item B<Domain> I<name>
1719 =item B<BlockDevice> I<name:dev>
1721 =item B<InterfaceDevice> I<name:dev>
1723 =item B<IgnoreSelected> I<true>|I<false>
1725 Select which domains and devices are collected.
1727 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
1728 disk/network devices are collected.
1730 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
1731 domains and disk/network devices are ignored, while the rest are collected.
1733 The domain name and device names may use a regular expression, if the name is
1734 surrounded by I</.../> and collectd was compiled with support for regexps.
1736 The default is to collect statistics for all domains and all their devices.
1740 BlockDevice "/:hdb/"
1741 IgnoreSelected "true"
1743 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
1746 =item B<HostnameFormat> B<name|uuid|hostname|...>
1748 When the libvirt plugin logs data, it sets the hostname of the collected data
1749 according to this setting. The default is to use the guest name as provided by
1750 the hypervisor, which is equal to setting B<name>.
1752 B<uuid> means use the guest's UUID. This is useful if you want to track the
1753 same guest across migrations.
1755 B<hostname> means to use the global B<Hostname> setting, which is probably not
1756 useful on its own because all guests will appear to have the same name.
1758 You can also specify combinations of these fields. For example B<name uuid>
1759 means to concatenate the guest name and UUID (with a literal colon character
1760 between, thus I<"foo:1234-1234-1234-1234">).
1762 =item B<InterfaceFormat> B<name>|B<address>
1764 When the libvirt plugin logs interface data, it sets the name of the collected
1765 data according to this setting. The default is to use the path as provided by
1766 the hypervisor (the "dev" property of the target node), which is equal to
1769 B<address> means use the interface's mac address. This is useful since the
1770 interface path might change between reboots of a guest or across migrations.
1774 =head2 Plugin C<logfile>
1778 =item B<LogLevel> B<debug|info|notice|warning|err>
1780 Sets the log-level. If, for example, set to B<notice>, then all events with
1781 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
1783 Please note that B<debug> is only available if collectd has been compiled with
1786 =item B<File> I<File>
1788 Sets the file to write log messages to. The special strings B<stdout> and
1789 B<stderr> can be used to write to the standard output and standard error
1790 channels, respectively. This, of course, only makes much sense when I<collectd>
1791 is running in foreground- or non-daemon-mode.
1793 =item B<Timestamp> B<true>|B<false>
1795 Prefix all lines printed by the current time. Defaults to B<true>.
1797 =item B<PrintSeverity> B<true>|B<false>
1799 When enabled, all lines are prefixed by the severity of the log message, for
1800 example "warning". Defaults to B<false>.
1804 B<Note>: There is no need to notify the daemon after moving or removing the
1805 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
1806 for each line it writes.
1808 =head2 Plugin C<lpar>
1810 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
1811 virtualization technique for IBM POWER processors. It takes into account CPU
1812 time stolen from or donated to a partition, in addition to the usual user,
1813 system, I/O statistics.
1815 The following configuration options are available:
1819 =item B<CpuPoolStats> B<false>|B<true>
1821 When enabled, statistics about the processor pool are read, too. The partition
1822 needs to have pool authority in order to be able to acquire this information.
1825 =item B<ReportBySerial> B<false>|B<true>
1827 If enabled, the serial of the physical machine the partition is currently
1828 running on is reported as I<hostname> and the logical hostname of the machine
1829 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
1830 used (just like other plugins) and the I<plugin instance> will be empty.
1835 =head2 Plugin C<mbmon>
1837 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
1839 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
1840 B<Host> and B<Port> options can be used to change these values, see below.
1841 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
1842 timeouts may appear which may interfere with other statistics..
1844 C<mbmon> must be run with the -r option ("print TAG and Value format");
1845 Debian's F</etc/init.d/mbmon> script already does this, other people
1846 will need to ensure that this is the case.
1850 =item B<Host> I<Hostname>
1852 Hostname to connect to. Defaults to B<127.0.0.1>.
1854 =item B<Port> I<Port>
1856 TCP-Port to connect to. Defaults to B<411>.
1862 The C<md plugin> collects information from Linux Software-RAID devices (md).
1864 All reported values are of the type C<md_disks>. Reported type instances are
1865 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
1866 I<missing> (physically absent) disks.
1870 =item B<Device> I<Device>
1872 Select md devices based on device name. The I<device name> is the basename of
1873 the device, i.e. the name of the block device without the leading C</dev/>.
1874 See B<IgnoreSelected> for more details.
1876 =item B<IgnoreSelected> B<true>|B<false>
1878 Invert device selection: If set to B<true>, all md devices B<except> those
1879 listed using B<Device> are collected. If B<false> (the default), only those
1880 listed are collected. If no configuration is given, the B<md> plugin will
1881 collect data from all md devices.
1885 =head2 Plugin C<memcachec>
1887 The C<memcachec plugin> connects to a memcached server, queries one or more
1888 given I<pages> and parses the returned data according to user specification.
1889 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
1892 In order to talk to the memcached server, this plugin uses the I<libmemcached>
1893 library. Please note that there is another library with a very similar name,
1894 libmemcache (notice the missing `d'), which is not applicable.
1896 Synopsis of the configuration:
1898 <Plugin "memcachec">
1899 <Page "plugin_instance">
1903 Regex "(\\d+) bytes sent"
1906 Instance "type_instance"
1911 The configuration options are:
1915 =item E<lt>B<Page> I<Name>E<gt>
1917 Each B<Page> block defines one I<page> to be queried from the memcached server.
1918 The block requires one string argument which is used as I<plugin instance>.
1920 =item B<Server> I<Address>
1922 Sets the server address to connect to when querying the page. Must be inside a
1927 When connected to the memcached server, asks for the page I<Key>.
1929 =item E<lt>B<Match>E<gt>
1931 Match blocks define which strings to look for and how matches substrings are
1932 interpreted. For a description of match blocks, please see L<"Plugin tail">.
1936 =head2 Plugin C<memcached>
1938 The C<memcached plugin> connects to a memcached server and queries statistics
1939 about cache utilization, memory and bandwidth used.
1940 L<http://www.danga.com/memcached/>
1944 =item B<Host> I<Hostname>
1946 Hostname to connect to. Defaults to B<127.0.0.1>.
1948 =item B<Port> I<Port>
1950 TCP-Port to connect to. Defaults to B<11211>.
1954 =head2 Plugin C<modbus>
1956 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
1957 register values. It supports reading single registers (unsigned 16E<nbsp>bit
1958 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
1959 values (two registers interpreted as IEEE floats in big endian notation).
1963 <Data "voltage-input-1">
1970 <Data "voltage-input-2">
1977 <Host "modbus.example.com">
1978 Address "192.168.0.42"
1983 Instance "power-supply"
1984 Collect "voltage-input-1"
1985 Collect "voltage-input-2"
1991 =item E<lt>B<Data> I<Name>E<gt> blocks
1993 Data blocks define a mapping between register numbers and the "types" used by
1996 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
2000 =item B<RegisterBase> I<Number>
2002 Configures the base register to read from the device. If the option
2003 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
2004 register will be read (the register number is increased by one).
2006 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
2008 Specifies what kind of data is returned by the device. If the type is B<Int32>,
2009 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
2010 combined into one value. Defaults to B<Uint16>.
2012 =item B<Type> I<Type>
2014 Specifies the "type" (data set) to use when dispatching the value to
2015 I<collectd>. Currently, only data sets with exactly one data source are
2018 =item B<Instance> I<Instance>
2020 Sets the type instance to use when dispatching the value to I<collectd>. If
2021 unset, an empty string (no type instance) is used.
2025 =item E<lt>B<Host> I<Name>E<gt> blocks
2027 Host blocks are used to specify to which hosts to connect and what data to read
2028 from their "slaves". The string argument I<Name> is used as hostname when
2029 dispatching the values to I<collectd>.
2031 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
2035 =item B<Address> I<Hostname>
2037 Specifies the node name (the actual network address) used to connect to the
2038 host. This may be an IP address or a hostname. Please note that the used
2039 I<libmodbus> library only supports IPv4 at the moment.
2041 =item B<Port> I<Service>
2043 Specifies the port used to connect to the host. The port can either be given as
2044 a number or as a service name. Please note that the I<Service> argument must be
2045 a string, even if ports are given in their numerical form. Defaults to "502".
2047 =item B<Interval> I<Interval>
2049 Sets the interval (in seconds) in which the values will be collected from this
2050 host. By default the global B<Interval> setting will be used.
2052 =item E<lt>B<Slave> I<ID>E<gt>
2054 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
2055 is used to specify which device should be addressed. For each device you want
2056 to query, one B<Slave> block must be given.
2058 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
2062 =item B<Instance> I<Instance>
2064 Specify the plugin instance to use when dispatching the values to I<collectd>.
2065 By default "slave_I<ID>" is used.
2067 =item B<Collect> I<DataName>
2069 Specifies which data to retrieve from the device. I<DataName> must be the same
2070 string as the I<Name> argument passed to a B<Data> block. You can specify this
2071 option multiple times to collect more than one value from a slave. At least one
2072 B<Collect> option is mandatory.
2080 =head2 Plugin C<mysql>
2082 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
2083 one or more databases when started and keeps the connection up as long as
2084 possible. When the connection is interrupted for whatever reason it will try
2085 to re-connect. The plugin will complain loudly in case anything goes wrong.
2087 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
2088 and collects information about MySQL network traffic, executed statements,
2089 requests, the query cache and threads by evaluating the
2090 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
2091 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
2092 Status Variables> for an explanation of these values.
2094 Optionally, master and slave statistics may be collected in a MySQL
2095 replication setup. In that case, information about the synchronization state
2096 of the nodes are collected by evaluating the C<Position> return value of the
2097 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
2098 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
2099 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
2100 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
2101 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
2116 Socket "/var/run/mysql/mysqld.sock"
2118 SlaveNotifications true
2122 A B<Database> block defines one connection to a MySQL database. It accepts a
2123 single argument which specifies the name of the database. None of the other
2124 options are required. MySQL will use default values as documented in the
2125 section "mysql_real_connect()" in the B<MySQL reference manual>.
2129 =item B<Host> I<Hostname>
2131 Hostname of the database server. Defaults to B<localhost>.
2133 =item B<User> I<Username>
2135 Username to use when connecting to the database. The user does not have to be
2136 granted any privileges (which is synonym to granting the C<USAGE> privilege),
2137 unless you want to collectd replication statistics (see B<MasterStats> and
2138 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
2139 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
2141 =item B<Password> I<Password>
2143 Password needed to log into the database.
2145 =item B<Database> I<Database>
2147 Select this database. Defaults to I<no database> which is a perfectly reasonable
2148 option for what this plugin does.
2150 =item B<Port> I<Port>
2152 TCP-port to connect to. The port must be specified in its numeric form, but it
2153 must be passed as a string nonetheless. For example:
2157 If B<Host> is set to B<localhost> (the default), this setting has no effect.
2158 See the documentation for the C<mysql_real_connect> function for details.
2160 =item B<Socket> I<Socket>
2162 Specifies the path to the UNIX domain socket of the MySQL server. This option
2163 only has any effect, if B<Host> is set to B<localhost> (the default).
2164 Otherwise, use the B<Port> option above. See the documentation for the
2165 C<mysql_real_connect> function for details.
2167 =item B<MasterStats> I<true|false>
2169 =item B<SlaveStats> I<true|false>
2171 Enable the collection of master / slave statistics in a replication setup. In
2172 order to be able to get access to these statistics, the user needs special
2173 privileges. See the B<User> documentation above.
2175 =item B<SlaveNotifications> I<true|false>
2177 If enabled, the plugin sends a notification if the replication slave I/O and /
2178 or SQL threads are not running.
2182 =head2 Plugin C<netapp>
2184 The netapp plugin can collect various performance and capacity information
2185 from a NetApp filer using the NetApp API.
2187 Please note that NetApp has a wide line of products and a lot of different
2188 software versions for each of these products. This plugin was developed for a
2189 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
2190 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
2191 model and software version but it is very hard to test this.
2192 If you have used this plugin with other models and/or software version, feel
2193 free to send us a mail to tell us about the results, even if it's just a short
2196 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
2197 basic authentication.
2199 B<Do not use a regular user for this!> Create a special collectd user with just
2200 the minimum of capabilities needed. The user only needs the "login-http-admin"
2201 capability as well as a few more depending on which data will be collected.
2202 Required capabilities are documented below.
2207 <Host "netapp1.example.com">
2231 IgnoreSelectedIO false
2233 IgnoreSelectedOps false
2234 GetLatency "volume0"
2235 IgnoreSelectedLatency false
2242 IgnoreSelectedCapacity false
2245 IgnoreSelectedSnapshot false
2258 The netapp plugin accepts the following configuration options:
2262 =item B<Host> I<Name>
2264 A host block defines one NetApp filer. It will appear in collectd with the name
2265 you specify here which does not have to be its real name nor its hostname.
2267 =item B<Protocol> B<httpd>|B<http>
2269 The protocol collectd will use to query this host.
2277 Valid options: http, https
2279 =item B<Address> I<Address>
2281 The hostname or IP address of the host.
2287 Default: The "host" block's name.
2289 =item B<Port> I<Port>
2291 The TCP port to connect to on the host.
2297 Default: 80 for protocol "http", 443 for protocol "https"
2299 =item B<User> I<User>
2301 =item B<Password> I<Password>
2303 The username and password to use to login to the NetApp.
2309 =item B<Interval> I<Interval>
2315 The following options decide what kind of data will be collected. You can
2316 either use them as a block and fine tune various parameters inside this block,
2317 use them as a single statement to just accept all default values, or omit it to
2318 not collect any data.
2320 The following options are valid inside all blocks:
2324 =item B<Interval> I<Seconds>
2326 Collect the respective statistics every I<Seconds> seconds. Defaults to the
2327 host specific setting.
2331 =head3 The System block
2333 This will collect various performance data about the whole system.
2335 B<Note:> To get this data the collectd user needs the
2336 "api-perf-object-get-instances" capability.
2340 =item B<Interval> I<Seconds>
2342 Collect disk statistics every I<Seconds> seconds.
2344 =item B<GetCPULoad> B<true>|B<false>
2346 If you set this option to true the current CPU usage will be read. This will be
2347 the average usage between all CPUs in your NetApp without any information about
2350 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2351 returns in the "CPU" field.
2359 Result: Two value lists of type "cpu", and type instances "idle" and "system".
2361 =item B<GetInterfaces> B<true>|B<false>
2363 If you set this option to true the current traffic of the network interfaces
2364 will be read. This will be the total traffic over all interfaces of your NetApp
2365 without any information about individual interfaces.
2367 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2368 in the "Net kB/s" field.
2378 Result: One value list of type "if_octects".
2380 =item B<GetDiskIO> B<true>|B<false>
2382 If you set this option to true the current IO throughput will be read. This
2383 will be the total IO of your NetApp without any information about individual
2384 disks, volumes or aggregates.
2386 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2387 in the "DiskE<nbsp>kB/s" field.
2395 Result: One value list of type "disk_octets".
2397 =item B<GetDiskOps> B<true>|B<false>
2399 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
2400 iSCSI, etc. operations will be read. This will be the total number of
2401 operations on your NetApp without any information about individual volumes or
2404 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2405 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
2413 Result: A variable number of value lists of type "disk_ops_complex". Each type
2414 of operation will result in one value list with the name of the operation as
2419 =head3 The WAFL block
2421 This will collect various performance data about the WAFL file system. At the
2422 moment this just means cache performance.
2424 B<Note:> To get this data the collectd user needs the
2425 "api-perf-object-get-instances" capability.
2427 B<Note:> The interface to get these values is classified as "Diagnostics" by
2428 NetApp. This means that it is not guaranteed to be stable even between minor
2433 =item B<Interval> I<Seconds>
2435 Collect disk statistics every I<Seconds> seconds.
2437 =item B<GetNameCache> B<true>|B<false>
2445 Result: One value list of type "cache_ratio" and type instance
2448 =item B<GetDirCache> B<true>|B<false>
2456 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
2458 =item B<GetInodeCache> B<true>|B<false>
2466 Result: One value list of type "cache_ratio" and type instance
2469 =item B<GetBufferCache> B<true>|B<false>
2471 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
2472 in the "Cache hit" field.
2480 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
2484 =head3 The Disks block
2486 This will collect performance data about the individual disks in the NetApp.
2488 B<Note:> To get this data the collectd user needs the
2489 "api-perf-object-get-instances" capability.
2493 =item B<Interval> I<Seconds>
2495 Collect disk statistics every I<Seconds> seconds.
2497 =item B<GetBusy> B<true>|B<false>
2499 If you set this option to true the busy time of all disks will be calculated
2500 and the value of the busiest disk in the system will be written.
2502 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2503 in the "Disk util" field. Probably.
2511 Result: One value list of type "percent" and type instance "disk_busy".
2515 =head3 The VolumePerf block
2517 This will collect various performance data about the individual volumes.
2519 You can select which data to collect about which volume using the following
2520 options. They follow the standard ignorelist semantic.
2522 B<Note:> To get this data the collectd user needs the
2523 I<api-perf-object-get-instances> capability.
2527 =item B<Interval> I<Seconds>
2529 Collect volume performance data every I<Seconds> seconds.
2531 =item B<GetIO> I<Volume>
2533 =item B<GetOps> I<Volume>
2535 =item B<GetLatency> I<Volume>
2537 Select the given volume for IO, operations or latency statistics collection.
2538 The argument is the name of the volume without the C</vol/> prefix.
2540 Since the standard ignorelist functionality is used here, you can use a string
2541 starting and ending with a slash to specify regular expression matching: To
2542 match the volumes "vol0", "vol2" and "vol7", you can use this regular
2545 GetIO "/^vol[027]$/"
2547 If no regular expression is specified, an exact match is required. Both,
2548 regular and exact matching are case sensitive.
2550 If no volume was specified at all for either of the three options, that data
2551 will be collected for all available volumes.
2553 =item B<IgnoreSelectedIO> B<true>|B<false>
2555 =item B<IgnoreSelectedOps> B<true>|B<false>
2557 =item B<IgnoreSelectedLatency> B<true>|B<false>
2559 When set to B<true>, the volumes selected for IO, operations or latency
2560 statistics collection will be ignored and the data will be collected for all
2563 When set to B<false>, data will only be collected for the specified volumes and
2564 all other volumes will be ignored.
2566 If no volumes have been specified with the above B<Get*> options, all volumes
2567 will be collected regardless of the B<IgnoreSelected*> option.
2569 Defaults to B<false>
2573 =head3 The VolumeUsage block
2575 This will collect capacity data about the individual volumes.
2577 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
2582 =item B<Interval> I<Seconds>
2584 Collect volume usage statistics every I<Seconds> seconds.
2586 =item B<GetCapacity> I<VolumeName>
2588 The current capacity of the volume will be collected. This will result in two
2589 to four value lists, depending on the configuration of the volume. All data
2590 sources are of type "df_complex" with the name of the volume as
2593 There will be type_instances "used" and "free" for the number of used and
2594 available bytes on the volume. If the volume has some space reserved for
2595 snapshots, a type_instance "snap_reserved" will be available. If the volume
2596 has SIS enabled, a type_instance "sis_saved" will be available. This is the
2597 number of bytes saved by the SIS feature.
2599 B<Note:> The current NetApp API has a bug that results in this value being
2600 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
2601 number which works most of the time. If you see strange values here, bug
2602 NetApp support to fix this.
2604 Repeat this option to specify multiple volumes.
2606 =item B<IgnoreSelectedCapacity> B<true>|B<false>
2608 Specify whether to collect only the volumes selected by the B<GetCapacity>
2609 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
2610 B<false>. However, if no B<GetCapacity> option is specified at all, all
2611 capacities will be selected anyway.
2613 =item B<GetSnapshot> I<VolumeName>
2615 Select volumes from which to collect snapshot information.
2617 Usually, the space used for snapshots is included in the space reported as
2618 "used". If snapshot information is collected as well, the space used for
2619 snapshots is subtracted from the used space.
2621 To make things even more interesting, it is possible to reserve space to be
2622 used for snapshots. If the space required for snapshots is less than that
2623 reserved space, there is "reserved free" and "reserved used" space in addition
2624 to "free" and "used". If the space required for snapshots exceeds the reserved
2625 space, that part allocated in the normal space is subtracted from the "used"
2628 Repeat this option to specify multiple volumes.
2630 =item B<IgnoreSelectedSnapshot>
2632 Specify whether to collect only the volumes selected by the B<GetSnapshot>
2633 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
2634 B<false>. However, if no B<GetSnapshot> option is specified at all, all
2635 capacities will be selected anyway.
2639 =head2 Plugin C<netlink>
2641 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
2642 statistics of various interface and routing aspects.
2646 =item B<Interface> I<Interface>
2648 =item B<VerboseInterface> I<Interface>
2650 Instruct the plugin to collect interface statistics. This is basically the same
2651 as the statistics provided by the C<interface> plugin (see above) but
2652 potentially much more detailed.
2654 When configuring with B<Interface> only the basic statistics will be collected,
2655 namely octets, packets, and errors. These statistics are collected by
2656 the C<interface> plugin, too, so using both at the same time is no benefit.
2658 When configured with B<VerboseInterface> all counters B<except> the basic ones,
2659 so that no data needs to be collected twice if you use the C<interface> plugin.
2660 This includes dropped packets, received multicast packets, collisions and a
2661 whole zoo of differentiated RX and TX errors. You can try the following command
2662 to get an idea of what awaits you:
2666 If I<Interface> is B<All>, all interfaces will be selected.
2668 =item B<QDisc> I<Interface> [I<QDisc>]
2670 =item B<Class> I<Interface> [I<Class>]
2672 =item B<Filter> I<Interface> [I<Filter>]
2674 Collect the octets and packets that pass a certain qdisc, class or filter.
2676 QDiscs and classes are identified by their type and handle (or classid).
2677 Filters don't necessarily have a handle, therefore the parent's handle is used.
2678 The notation used in collectd differs from that used in tc(1) in that it
2679 doesn't skip the major or minor number if it's zero and doesn't print special
2680 ids by their name. So, for example, a qdisc may be identified by
2681 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
2682 thus not displayed by tc(1).
2684 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
2685 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
2686 associated with that interface will be collected.
2688 Since a filter itself doesn't necessarily have a handle, the parent's handle is
2689 used. This may lead to problems when more than one filter is attached to a
2690 qdisc or class. This isn't nice, but we don't know how this could be done any
2691 better. If you have a idea, please don't hesitate to tell us.
2693 As with the B<Interface> option you can specify B<All> as the interface,
2694 meaning all interfaces.
2696 Here are some examples to help you understand the above text more easily:
2699 VerboseInterface "All"
2700 QDisc "eth0" "pfifo_fast-1:0"
2702 Class "ppp0" "htb-1:10"
2703 Filter "ppp0" "u32-1:0"
2706 =item B<IgnoreSelected>
2708 The behavior is the same as with all other similar plugins: If nothing is
2709 selected at all, everything is collected. If some things are selected using the
2710 options described above, only these statistics are collected. If you set
2711 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
2712 specified statistics will not be collected.
2716 =head2 Plugin C<network>
2718 The Network plugin sends data to a remote instance of collectd, receives data
2719 from a remote instance, or both at the same time. Data which has been received
2720 from the network is usually not transmitted again, but this can be activated, see
2721 the B<Forward> option below.
2723 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
2724 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
2726 Both, B<Server> and B<Listen> can be used as single option or as block. When
2727 used as block, given options are valid for this socket only. For example:
2730 Server "collectd.internal.tld"
2731 <Server "collectd.external.tld">
2732 SecurityLevel "sign"
2733 Username "myhostname"
2740 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
2742 The B<Server> statement/block sets the server to send datagrams to. The
2743 statement may occur multiple times to send each datagram to multiple
2746 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
2747 optional second argument specifies a port number or a service name. If not
2748 given, the default, B<25826>, is used.
2750 The following options are recognized within B<Server> blocks:
2754 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
2756 Set the security you require for network communication. When the security level
2757 has been set to B<Encrypt>, data sent over the network will be encrypted using
2758 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
2759 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
2760 authentication code. When set to B<None>, data is sent without any security.
2762 This feature is only available if the I<network> plugin was linked with
2765 =item B<Username> I<Username>
2767 Sets the username to transmit. This is used by the server to lookup the
2768 password. See B<AuthFile> below. All security levels except B<None> require
2771 This feature is only available if the I<network> plugin was linked with
2774 =item B<Password> I<Password>
2776 Sets a password (shared secret) for this socket. All security levels except
2777 B<None> require this setting.
2779 This feature is only available if the I<network> plugin was linked with
2782 =item B<Interface> I<Interface name>
2784 Set the outgoing interface for IP packets. This applies at least
2785 to IPv6 packets and if possible to IPv4. If this option is not applicable,
2786 undefined or a non-existent interface name is specified, the default
2787 behavior is to let the kernel choose the appropriate interface. Be warned
2788 that the manual selection of an interface for unicast traffic is only
2789 necessary in rare cases.
2793 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
2795 The B<Listen> statement sets the interfaces to bind to. When multiple
2796 statements are found the daemon will bind to multiple interfaces.
2798 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
2799 the argument is a multicast address the daemon will join that multicast group.
2800 The optional second argument specifies a port number or a service name. If not
2801 given, the default, B<25826>, is used.
2803 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
2807 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
2809 Set the security you require for network communication. When the security level
2810 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
2811 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
2812 signed and encrypted data is accepted. When set to B<None>, all data will be
2813 accepted. If an B<AuthFile> option was given (see below), encrypted data is
2814 decrypted if possible.
2816 This feature is only available if the I<network> plugin was linked with
2819 =item B<AuthFile> I<Filename>
2821 Sets a file in which usernames are mapped to passwords. These passwords are
2822 used to verify signatures and to decrypt encrypted network packets. If
2823 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
2824 verified and encrypted packets are decrypted. Otherwise, signed data is
2825 accepted without checking the signature and encrypted data cannot be decrypted.
2826 For the other security levels this option is mandatory.
2828 The file format is very simple: Each line consists of a username followed by a
2829 colon and any number of spaces followed by the password. To demonstrate, an
2830 example file could look like this:
2835 Each time a packet is received, the modification time of the file is checked
2836 using L<stat(2)>. If the file has been changed, the contents is re-read. While
2837 the file is being read, it is locked using L<fcntl(2)>.
2839 =item B<Interface> I<Interface name>
2841 Set the incoming interface for IP packets explicitly. This applies at least
2842 to IPv6 packets and if possible to IPv4. If this option is not applicable,
2843 undefined or a non-existent interface name is specified, the default
2844 behavior is, to let the kernel choose the appropriate interface. Thus incoming
2845 traffic gets only accepted, if it arrives on the given interface.
2849 =item B<TimeToLive> I<1-255>
2851 Set the time-to-live of sent packets. This applies to all, unicast and
2852 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
2853 That means that multicast packets will be sent with a TTL of C<1> (one) on most
2856 =item B<MaxPacketSize> I<1024-65535>
2858 Set the maximum size for datagrams received over the network. Packets larger
2859 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
2860 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
2863 On the server side, this limit should be set to the largest value used on
2864 I<any> client. Likewise, the value on the client must not be larger than the
2865 value on the server, or data will be lost.
2867 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
2868 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
2869 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
2872 =item B<Forward> I<true|false>
2874 If set to I<true>, write packets that were received via the network plugin to
2875 the sending sockets. This should only be activated when the B<Listen>- and
2876 B<Server>-statements differ. Otherwise packets may be send multiple times to
2877 the same multicast group. While this results in more network traffic than
2878 necessary it's not a huge problem since the plugin has a duplicate detection,
2879 so the values will not loop.
2881 =item B<ReportStats> B<true>|B<false>
2883 The network plugin cannot only receive and send statistics, it can also create
2884 statistics about itself. Collected data included the number of received and
2885 sent octets and packets, the length of the receive queue and the number of
2886 values handled. When set to B<true>, the I<Network plugin> will make these
2887 statistics available. Defaults to B<false>.
2891 =head2 Plugin C<nginx>
2893 This plugin collects the number of connections and requests handled by the
2894 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
2895 queries the page provided by the C<ngx_http_stub_status_module> module, which
2896 isn't compiled by default. Please refer to
2897 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
2898 how to compile and configure nginx and this module.
2900 The following options are accepted by the C<nginx plugin>:
2904 =item B<URL> I<http://host/nginx_status>
2906 Sets the URL of the C<ngx_http_stub_status_module> output.
2908 =item B<User> I<Username>
2910 Optional user name needed for authentication.
2912 =item B<Password> I<Password>
2914 Optional password needed for authentication.
2916 =item B<VerifyPeer> B<true|false>
2918 Enable or disable peer SSL certificate verification. See
2919 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
2921 =item B<VerifyHost> B<true|false>
2923 Enable or disable peer host name verification. If enabled, the plugin checks
2924 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
2925 certificate matches the host name provided by the B<URL> option. If this
2926 identity check fails, the connection is aborted. Obviously, only works when
2927 connecting to a SSL enabled server. Enabled by default.
2929 =item B<CACert> I<File>
2931 File that holds one or more SSL certificates. If you want to use HTTPS you will
2932 possibly need this option. What CA certificates come bundled with C<libcurl>
2933 and are checked by default depends on the distribution you use.
2937 =head2 Plugin C<notify_desktop>
2939 This plugin sends a desktop notification to a notification daemon, as defined
2940 in the Desktop Notification Specification. To actually display the
2941 notifications, B<notification-daemon> is required and B<collectd> has to be
2942 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
2943 environment variables have to be set correctly) and the D-Bus message bus.
2945 The Desktop Notification Specification can be found at
2946 L<http://www.galago-project.org/specs/notification/>.
2950 =item B<OkayTimeout> I<timeout>
2952 =item B<WarningTimeout> I<timeout>
2954 =item B<FailureTimeout> I<timeout>
2956 Set the I<timeout>, in milliseconds, after which to expire the notification
2957 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
2958 been specified, the displayed notification will not be closed at all - the
2959 user has to do so herself. These options default to 5000. If a negative number
2960 has been specified, the default is used as well.
2964 =head2 Plugin C<notify_email>
2966 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
2967 configured email address.
2969 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
2971 Available configuration options:
2975 =item B<From> I<Address>
2977 Email address from which the emails should appear to come from.
2979 Default: C<root@localhost>
2981 =item B<Recipient> I<Address>
2983 Configures the email address(es) to which the notifications should be mailed.
2984 May be repeated to send notifications to multiple addresses.
2986 At least one B<Recipient> must be present for the plugin to work correctly.
2988 =item B<SMTPServer> I<Hostname>
2990 Hostname of the SMTP server to connect to.
2992 Default: C<localhost>
2994 =item B<SMTPPort> I<Port>
2996 TCP port to connect to.
3000 =item B<SMTPUser> I<Username>
3002 Username for ASMTP authentication. Optional.
3004 =item B<SMTPPassword> I<Password>
3006 Password for ASMTP authentication. Optional.
3008 =item B<Subject> I<Subject>
3010 Subject-template to use when sending emails. There must be exactly two
3011 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
3012 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
3015 Default: C<Collectd notify: %s@%s>
3019 =head2 Plugin C<ntpd>
3023 =item B<Host> I<Hostname>
3025 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
3027 =item B<Port> I<Port>
3029 UDP-Port to connect to. Defaults to B<123>.
3031 =item B<ReverseLookups> B<true>|B<false>
3033 Sets whether or not to perform reverse lookups on peers. Since the name or
3034 IP-address may be used in a filename it is recommended to disable reverse
3035 lookups. The default is to do reverse lookups to preserve backwards
3036 compatibility, though.
3040 =head2 Plugin C<nut>
3044 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
3046 Add a UPS to collect data from. The format is identical to the one accepted by
3051 =head2 Plugin C<olsrd>
3053 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
3054 the Optimized Link State Routing daemon and reads information about the current
3055 state of the meshed network.
3057 The following configuration options are understood:
3061 =item B<Host> I<Host>
3063 Connect to I<Host>. Defaults to B<"localhost">.
3065 =item B<Port> I<Port>
3067 Specifies the port to connect to. This must be a string, even if you give the
3068 port as a number rather than a service name. Defaults to B<"2006">.
3070 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
3072 Specifies what information to collect about links, i.E<nbsp>e. direct
3073 connections of the daemon queried. If set to B<No>, no information is
3074 collected. If set to B<Summary>, the number of links and the average of all
3075 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
3076 If set to B<Detail> LQ and NLQ are collected per link.
3078 Defaults to B<Detail>.
3080 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
3082 Specifies what information to collect about routes of the daemon queried. If
3083 set to B<No>, no information is collected. If set to B<Summary>, the number of
3084 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
3085 metric and ETX are collected per route.
3087 Defaults to B<Summary>.
3089 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
3091 Specifies what information to collect about the global topology. If set to
3092 B<No>, no information is collected. If set to B<Summary>, the number of links
3093 in the entire topology and the average I<link quality> (LQ) is calculated.
3094 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
3096 Defaults to B<Summary>.
3100 =head2 Plugin C<onewire>
3102 B<EXPERIMENTAL!> See notes below.
3104 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
3105 L<http://owfs.org/> to read sensors connected via the onewire bus.
3107 Currently only temperature sensors (sensors with the family code C<10>,
3108 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
3109 would like to have included, please send a sort request to the mailing list.
3111 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
3112 experimental, below.
3116 =item B<Device> I<Device>
3118 Sets the device to read the values from. This can either be a "real" hardware
3119 device, such as a serial port or an USB port, or the address of the
3120 L<owserver(1)> socket, usually B<localhost:4304>.
3122 Though the documentation claims to automatically recognize the given address
3123 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
3124 with that version, the following configuration worked for us:
3127 Device "-s localhost:4304"
3130 This directive is B<required> and does not have a default value.
3132 =item B<Sensor> I<Sensor>
3134 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
3135 below. Sensors are specified without the family byte at the beginning, to you'd
3136 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
3139 =item B<IgnoreSelected> I<true>|I<false>
3141 If no configuration if given, the B<onewire> plugin will collect data from all
3142 sensors found. This may not be practical, especially if sensors are added and
3143 removed regularly. Sometimes, however, it's easier/preferred to collect only
3144 specific sensors or all sensors I<except> a few specified ones. This option
3145 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
3146 B<Sensor> is inverted: All selected interfaces are ignored and all other
3147 interfaces are collected.
3149 =item B<Interval> I<Seconds>
3151 Sets the interval in which all sensors should be read. If not specified, the
3152 global B<Interval> setting is used.
3156 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
3157 work with big setups. It works with one sensor being attached to one
3158 controller, but as soon as you throw in a couple more senors and maybe a hub
3159 or two, reading all values will take more than ten seconds (the default
3160 interval). We will probably add some separate thread for reading the sensors
3161 and some cache or something like that, but it's not done yet. We will try to
3162 maintain backwards compatibility in the future, but we can't promise. So in
3163 short: If it works for you: Great! But keep in mind that the config I<might>
3164 change, though this is unlikely. Oh, and if you want to help improving this
3165 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
3167 =head2 Plugin C<openvpn>
3169 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
3170 traffic statistics about connected clients.
3172 To set up OpenVPN to write to the status file periodically, use the
3173 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
3174 you need to set the required format, too. This is done by setting
3175 B<--status-version> to B<2>.
3177 So, in a nutshell you need:
3179 openvpn $OTHER_OPTIONS \
3180 --status "/var/run/openvpn-status" 10 \
3187 =item B<StatusFile> I<File>
3189 Specifies the location of the status file.
3191 =item B<ImprovedNamingSchema> B<true>|B<false>
3193 When enabled, the filename of the status file will be used as plugin instance
3194 and the client's "common name" will be used as type instance. This is required
3195 when reading multiple status files. Enabling this option is recommended, but to
3196 maintain backwards compatibility this option is disabled by default.
3198 =item B<CollectCompression> B<true>|B<false>
3200 Sets whether or not statistics about the compression used by OpenVPN should be
3201 collected. This information is only available in I<single> mode. Enabled by
3204 =item B<CollectIndividualUsers> B<true>|B<false>
3206 Sets whether or not traffic information is collected for each connected client
3207 individually. If set to false, currently no traffic data is collected at all
3208 because aggregating this data in a save manner is tricky. Defaults to B<true>.
3210 =item B<CollectUserCount> B<true>|B<false>
3212 When enabled, the number of currently connected clients or users is collected.
3213 This is especially interesting when B<CollectIndividualUsers> is disabled, but
3214 can be configured independently from that option. Defaults to B<false>.
3218 =head2 Plugin C<oracle>
3220 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
3221 Oracle® Database and lets you execute SQL statements there. It is very similar
3222 to the "dbi" plugin, because it was written around the same time. See the "dbi"
3223 plugin's documentation above for details.
3226 <Query "out_of_stock">
3227 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
3230 # InstancePrefix "foo"
3231 InstancesFrom "category"
3235 <Database "product_information">
3239 Query "out_of_stock"
3243 =head3 B<Query> blocks
3245 The Query blocks are handled identically to the Query blocks of the "dbi"
3246 plugin. Please see its documentation above for details on how to specify
3249 =head3 B<Database> blocks
3251 Database blocks define a connection to a database and which queries should be
3252 sent to that database. Each database needs a "name" as string argument in the
3253 starting tag of the block. This name will be used as "PluginInstance" in the
3254 values submitted to the daemon. Other than that, that name is not used.
3258 =item B<ConnectID> I<ID>
3260 Defines the "database alias" or "service name" to connect to. Usually, these
3261 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
3263 =item B<Username> I<Username>
3265 Username used for authentication.
3267 =item B<Password> I<Password>
3269 Password used for authentication.
3271 =item B<Query> I<QueryName>
3273 Associates the query named I<QueryName> with this database connection. The
3274 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
3275 blocks you want to refer to must be placed above the database block you want to
3280 =head2 Plugin C<perl>
3282 This plugin embeds a Perl-interpreter into collectd and provides an interface
3283 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
3285 =head2 Plugin C<pinba>
3287 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
3288 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
3289 PHP-based webpage has been delivered, the extension will send a UDP packet
3290 containing timing information, peak memory usage and so on. The plugin will
3291 wait for such packets, parse them and account the provided information, which
3292 is then dispatched to the daemon once per interval.
3299 # Overall statistics for the website.
3301 Server "www.example.com"
3303 # Statistics for www-a only
3305 Host "www-a.example.com"
3306 Server "www.example.com"
3308 # Statistics for www-b only
3310 Host "www-b.example.com"
3311 Server "www.example.com"
3315 The plugin provides the following configuration options:
3319 =item B<Address> I<Node>
3321 Configures the address used to open a listening socket. By default, plugin will
3322 bind to the I<any> address C<::0>.
3324 =item B<Port> I<Service>
3326 Configures the port (service) to bind to. By default the default Pinba port
3327 "30002" will be used. The option accepts service names in addition to port
3328 numbers and thus requires a I<string> argument.
3330 =item E<lt>B<View> I<Name>E<gt> block
3332 The packets sent by the Pinba extension include the hostname of the server, the
3333 server name (the name of the virtual host) and the script that was executed.
3334 Using B<View> blocks it is possible to separate the data into multiple groups
3335 to get more meaningful statistics. Each packet is added to all matching groups,
3336 so that a packet may be accounted for more than once.
3340 =item B<Host> I<Host>
3342 Matches the hostname of the system the webserver / script is running on. This
3343 will contain the result of the L<gethostname(2)> system call. If not
3344 configured, all hostnames will be accepted.
3346 =item B<Server> I<Server>
3348 Matches the name of the I<virtual host>, i.e. the contents of the
3349 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
3350 server names will be accepted.
3352 =item B<Script> I<Script>
3354 Matches the name of the I<script name>, i.e. the contents of the
3355 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
3356 script names will be accepted.
3362 =head2 Plugin C<ping>
3364 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
3365 configured hosts periodically and measures the network latency. Whenever the
3366 C<read> function of the plugin is called, it submits the average latency, the
3367 standard deviation and the drop rate for each host.
3369 Available configuration options:
3373 =item B<Host> I<IP-address>
3375 Host to ping periodically. This option may be repeated several times to ping
3378 =item B<Interval> I<Seconds>
3380 Sets the interval in which to send ICMP echo packets to the configured hosts.
3381 This is B<not> the interval in which statistics are queries from the plugin but
3382 the interval in which the hosts are "pinged". Therefore, the setting here
3383 should be smaller than or equal to the global B<Interval> setting. Fractional
3384 times, such as "1.24" are allowed.
3388 =item B<Timeout> I<Seconds>
3390 Time to wait for a response from the host to which an ICMP packet had been
3391 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
3392 to be down or the packet to be dropped. This setting must be smaller than the
3393 B<Interval> setting above for the plugin to work correctly. Fractional
3394 arguments are accepted.
3398 =item B<TTL> I<0-255>
3400 Sets the Time-To-Live of generated ICMP packets.
3402 =item B<SourceAddress> I<host>
3404 Sets the source address to use. I<host> may either be a numerical network
3405 address or a network hostname.
3407 =item B<Device> I<name>
3409 Sets the outgoing network device to be used. I<name> has to specify an
3410 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
3413 =item B<MaxMissed> I<Packets>
3415 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
3416 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
3418 Default: B<-1> (disabled)
3422 =head2 Plugin C<postgresql>
3424 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
3425 keeps a persistent connection to all configured databases and tries to
3426 reconnect if the connection has been interrupted. A database is configured by
3427 specifying a B<Database> block as described below. The default statistics are
3428 collected from PostgreSQL's B<statistics collector> which thus has to be
3429 enabled for this plugin to work correctly. This should usually be the case by
3430 default. See the section "The Statistics Collector" of the B<PostgreSQL
3431 Documentation> for details.
3433 By specifying custom database queries using a B<Query> block as described
3434 below, you may collect any data that is available from some PostgreSQL
3435 database. This way, you are able to access statistics of external daemons
3436 which are available in a PostgreSQL database or use future or special
3437 statistics provided by PostgreSQL without the need to upgrade your collectd
3440 The B<PostgreSQL Documentation> manual can be found at
3441 L<http://www.postgresql.org/docs/manuals/>.
3445 Statement "SELECT magic FROM wizard WHERE host = $1;"
3449 InstancePrefix "magic"
3454 <Query rt36_tickets>
3455 Statement "SELECT COUNT(type) AS count, type \
3457 WHEN resolved = 'epoch' THEN 'open' \
3458 ELSE 'resolved' END AS type \
3459 FROM tickets) type \
3463 InstancePrefix "rt36_tickets"
3464 InstancesFrom "type"
3475 KRBSrvName "kerberos_service_name"
3481 Service "service_name"
3482 Query backend # predefined
3487 The B<Query> block defines one database query which may later be used by a
3488 database definition. It accepts a single mandatory argument which specifies
3489 the name of the query. The names of all queries have to be unique (see the
3490 B<MinVersion> and B<MaxVersion> options below for an exception to this
3491 rule). The following configuration options are available to define the query:
3493 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
3494 blocks define how to handle the values returned from the query. They define
3495 which column holds which value and how to dispatch that value to the daemon.
3496 Multiple B<Result> blocks may be used to extract multiple values from a single
3501 =item B<Statement> I<sql query statement>
3503 Specify the I<sql query statement> which the plugin should execute. The string
3504 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
3505 first, second, etc. parameter. The value of the parameters is specified by the
3506 B<Param> configuration option - see below for details. To include a literal
3507 B<$> character followed by a number, surround it with single quotes (B<'>).
3509 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
3510 allowed. Note, however, that only a single command may be used. Semicolons are
3511 allowed as long as a single non-empty command has been specified only.
3513 The returned lines will be handled separately one after another.
3515 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
3517 Specify the parameters which should be passed to the SQL query. The parameters
3518 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
3519 they appear in the configuration file. The value of the parameter is
3520 determined depending on the value of the B<Param> option as follows:
3526 The configured hostname of the database connection. If a UNIX domain socket is
3527 used, the parameter expands to "localhost".
3531 The name of the database of the current connection.
3535 The username used to connect to the database.
3539 The interval with which this database is queried (as specified by the database
3540 specific or global B<Interval> options).
3544 Please note that parameters are only supported by PostgreSQL's protocol
3545 version 3 and above which was introduced in version 7.4 of PostgreSQL.
3547 =item B<Type> I<type>
3549 The I<type> name to be used when dispatching the values. The type describes
3550 how to handle the data and where to store it. See L<types.db(5)> for more
3551 details on types and their configuration. The number and type of values (as
3552 selected by the B<ValuesFrom> option) has to match the type of the given name.
3554 This option is required inside a B<Result> block.
3556 =item B<InstancePrefix> I<prefix>
3558 =item B<InstancesFrom> I<column0> [I<column1> ...]
3560 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
3561 B<InstancePrefix> defines a static prefix that will be prepended to all type
3562 instances. B<InstancesFrom> defines the column names whose values will be used
3563 to create the type instance. Multiple values will be joined together using the
3564 hyphen (C<->) as separation character.
3566 The plugin itself does not check whether or not all built instances are
3567 different. It is your responsibility to assure that each is unique.
3569 Both options are optional. If none is specified, the type instance will be
3572 =item B<ValuesFrom> I<column0> [I<column1> ...]
3574 Names the columns whose content is used as the actual data for the data sets
3575 that are dispatched to the daemon. How many such columns you need is
3576 determined by the B<Type> setting as explained above. If you specify too many
3577 or not enough columns, the plugin will complain about that and no data will be
3578 submitted to the daemon.
3580 The actual data type, as seen by PostgreSQL, is not that important as long as
3581 it represents numbers. The plugin will automatically cast the values to the
3582 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
3583 L<strtod(3)> functions, so anything supported by those functions is supported
3584 by the plugin as well.
3586 This option is required inside a B<Result> block and may be specified multiple
3587 times. If multiple B<ValuesFrom> options are specified, the columns are read
3590 =item B<MinVersion> I<version>
3592 =item B<MaxVersion> I<version>
3594 Specify the minimum or maximum version of PostgreSQL that this query should be
3595 used with. Some statistics might only be available with certain versions of
3596 PostgreSQL. This allows you to specify multiple queries with the same name but
3597 which apply to different versions, thus allowing you to use the same
3598 configuration in a heterogeneous environment.
3600 The I<version> has to be specified as the concatenation of the major, minor
3601 and patch-level versions, each represented as two-decimal-digit numbers. For
3602 example, version 8.2.3 will become 80203.
3606 The following predefined queries are available (the definitions can be found
3607 in the F<postgresql_default.conf> file which, by default, is available at
3608 C<I<prefix>/share/collectd/>):
3614 This query collects the number of backends, i.E<nbsp>e. the number of
3617 =item B<transactions>
3619 This query collects the numbers of committed and rolled-back transactions of
3624 This query collects the numbers of various table modifications (i.E<nbsp>e.
3625 insertions, updates, deletions) of the user tables.
3627 =item B<query_plans>
3629 This query collects the numbers of various table scans and returned tuples of
3632 =item B<table_states>
3634 This query collects the numbers of live and dead rows in the user tables.
3638 This query collects disk block access counts for user tables.
3642 This query collects the on-disk size of the database in bytes.
3646 The B<Database> block defines one PostgreSQL database for which to collect
3647 statistics. It accepts a single mandatory argument which specifies the
3648 database name. None of the other options are required. PostgreSQL will use
3649 default values as documented in the section "CONNECTING TO A DATABASE" in the
3650 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
3651 the user collectd is run as and special environment variables. See the manpage
3656 =item B<Interval> I<seconds>
3658 Specify the interval with which the database should be queried. The default is
3659 to use the global B<Interval> setting.
3661 =item B<Host> I<hostname>
3663 Specify the hostname or IP of the PostgreSQL server to connect to. If the
3664 value begins with a slash, it is interpreted as the directory name in which to
3665 look for the UNIX domain socket.
3667 This option is also used to determine the hostname that is associated with a
3668 collected data set. If it has been omitted or either begins with with a slash
3669 or equals B<localhost> it will be replaced with the global hostname definition
3670 of collectd. Any other value will be passed literally to collectd when
3671 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
3673 =item B<Port> I<port>
3675 Specify the TCP port or the local UNIX domain socket file extension of the
3678 =item B<User> I<username>
3680 Specify the username to be used when connecting to the server.
3682 =item B<Password> I<password>
3684 Specify the password to be used when connecting to the server.
3686 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
3688 Specify whether to use an SSL connection when contacting the server. The
3689 following modes are supported:
3695 Do not use SSL at all.
3699 First, try to connect without using SSL. If that fails, try using SSL.
3701 =item I<prefer> (default)
3703 First, try to connect using SSL. If that fails, try without using SSL.
3711 =item B<KRBSrvName> I<kerberos_service_name>
3713 Specify the Kerberos service name to use when authenticating with Kerberos 5
3714 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
3715 B<PostgreSQL Documentation> for details.
3717 =item B<Service> I<service_name>
3719 Specify the PostgreSQL service name to use for additional parameters. That
3720 service has to be defined in F<pg_service.conf> and holds additional
3721 connection parameters. See the section "The Connection Service File" in the
3722 B<PostgreSQL Documentation> for details.
3724 =item B<Query> I<query>
3726 Specify a I<query> which should be executed for the database connection. This
3727 may be any of the predefined or user-defined queries. If no such option is
3728 given, it defaults to "backends", "transactions", "queries", "query_plans",
3729 "table_states", "disk_io" and "disk_usage". Else, the specified queries are
3734 =head2 Plugin C<powerdns>
3736 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
3737 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
3738 values, many of which are probably meaningless to most users, but may be useful
3739 for some. So you may chose which values to collect, but if you don't, some
3740 reasonable defaults will be collected.
3743 <Server "server_name">
3745 Collect "udp-answers" "udp-queries"
3746 Socket "/var/run/pdns.controlsocket"
3748 <Recursor "recursor_name">
3750 Collect "cache-hits" "cache-misses"
3751 Socket "/var/run/pdns_recursor.controlsocket"
3753 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
3758 =item B<Server> and B<Recursor> block
3760 The B<Server> block defines one authoritative server to query, the B<Recursor>
3761 does the same for an recursing server. The possible options in both blocks are
3762 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
3767 =item B<Collect> I<Field>
3769 Using the B<Collect> statement you can select which values to collect. Here,
3770 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
3771 C<dlg-only-drops>, C<answers10-100>.
3773 The method of getting the values differs for B<Server> and B<Recursor> blocks:
3774 When querying the server a C<SHOW *> command is issued in any case, because
3775 that's the only way of getting multiple values out of the server at once.
3776 collectd then picks out the values you have selected. When querying the
3777 recursor, a command is generated to query exactly these values. So if you
3778 specify invalid fields when querying the recursor, a syntax error may be
3779 returned by the daemon and collectd may not collect any values at all.
3781 If no B<Collect> statement is given, the following B<Server> values will be
3788 =item packetcache-hit
3790 =item packetcache-miss
3792 =item packetcache-size
3794 =item query-cache-hit
3796 =item query-cache-miss
3798 =item recursing-answers
3800 =item recursing-questions
3812 The following B<Recursor> values will be collected by default:
3816 =item noerror-answers
3818 =item nxdomain-answers
3820 =item servfail-answers
3838 Please note that up to that point collectd doesn't know what values are
3839 available on the server and values that are added do not need a change of the
3840 mechanism so far. However, the values must be mapped to collectd's naming
3841 scheme, which is done using a lookup table that lists all known values. If
3842 values are added in the future and collectd does not know about them, you will
3843 get an error much like this:
3845 powerdns plugin: submit: Not found in lookup table: foobar = 42
3847 In this case please file a bug report with the collectd team.
3849 =item B<Socket> I<Path>
3851 Configures the path to the UNIX domain socket to be used when connecting to the
3852 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
3853 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
3854 will be used for the recursor.
3858 =item B<LocalSocket> I<Path>
3860 Querying the recursor is done using UDP. When using UDP over UNIX domain
3861 sockets, the client socket needs a name in the file system, too. You can set
3862 this local name to I<Path> using the B<LocalSocket> option. The default is
3863 C<I<prefix>/var/run/collectd-powerdns>.
3867 =head2 Plugin C<processes>
3871 =item B<Process> I<Name>
3873 Select more detailed statistics of processes matching this name. The statistics
3874 collected for these selected processes are size of the resident segment size
3875 (RSS), user- and system-time used, number of processes and number of threads,
3876 io data (where available) and minor and major pagefaults.
3878 =item B<ProcessMatch> I<name> I<regex>
3880 Similar to the B<Process> option this allows to select more detailed
3881 statistics of processes matching the specified I<regex> (see L<regex(7)> for
3882 details). The statistics of all matching processes are summed up and
3883 dispatched to the daemon using the specified I<name> as an identifier. This
3884 allows to "group" several processes together. I<name> must not contain
3889 =head2 Plugin C<protocols>
3891 Collects a lot of information about various network protocols, such as I<IP>,
3892 I<TCP>, I<UDP>, etc.
3894 Available configuration options:
3898 =item B<Value> I<Selector>
3900 Selects whether or not to select a specific value. The string being matched is
3901 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
3902 plugin instance and I<ValueName> will be used as type instance. An example of
3903 the string being used would be C<Tcp:RetransSegs>.
3905 You can use regular expressions to match a large number of values with just one
3906 configuration option. To select all "extended" I<TCP> values, you could use the
3907 following statement:
3911 Whether only matched values are selected or all matched values are ignored
3912 depends on the B<IgnoreSelected>. By default, only matched values are selected.
3913 If no value is configured at all, all values will be selected.
3915 =item B<IgnoreSelected> B<true>|B<false>
3917 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
3918 matching values will be ignored.
3922 =head2 Plugin C<python>
3924 This plugin embeds a Python-interpreter into collectd and provides an interface
3925 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
3927 =head2 Plugin C<routeros>
3929 The C<routeros> plugin connects to a device running I<RouterOS>, the
3930 Linux-based operating system for routers by I<MikroTik>. The plugin uses
3931 I<librouteros> to connect and reads information about the interfaces and
3932 wireless connections of the device. The configuration supports querying
3937 Host "router0.example.com"
3940 CollectInterface true
3945 Host "router1.example.com"
3948 CollectInterface true
3949 CollectRegistrationTable true
3955 As you can see above, the configuration of the I<routeros> plugin consists of
3956 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
3957 options are understood:
3961 =item B<Host> I<Host>
3963 Hostname or IP-address of the router to connect to.
3965 =item B<Port> I<Port>
3967 Port name or port number used when connecting. If left unspecified, the default
3968 will be chosen by I<librouteros>, currently "8728". This option expects a
3969 string argument, even when a numeric port number is given.
3971 =item B<User> I<User>
3973 Use the user name I<User> to authenticate. Defaults to "admin".
3975 =item B<Password> I<Password>
3977 Set the password used to authenticate.
3979 =item B<CollectInterface> B<true>|B<false>
3981 When set to B<true>, interface statistics will be collected for all interfaces
3982 present on the device. Defaults to B<false>.
3984 =item B<CollectRegistrationTable> B<true>|B<false>
3986 When set to B<true>, information about wireless LAN connections will be
3987 collected. Defaults to B<false>.
3989 =item B<CollectCPULoad> B<true>|B<false>
3991 When set to B<true>, information about the CPU usage will be collected. The
3992 number is a dimensionless value where zero indicates no CPU usage at all.
3993 Defaults to B<false>.
3995 =item B<CollectMemory> B<true>|B<false>
3997 When enabled, the amount of used and free memory will be collected. How used
3998 memory is calculated is unknown, for example whether or not caches are counted
4000 Defaults to B<false>.
4002 =item B<CollectDF> B<true>|B<false>
4004 When enabled, the amount of used and free disk space will be collected.
4005 Defaults to B<false>.
4007 =item B<CollectDisk> B<true>|B<false>
4009 When enabled, the number of sectors written and bad blocks will be collected.
4010 Defaults to B<false>.
4014 =head2 Plugin C<redis>
4016 The I<Redis plugin> connects to one or more Redis servers and gathers
4017 information about each server's state. For each server there is a I<Node> block
4018 which configures the connection parameters for this node.
4028 The information shown in the synopsis above is the I<default configuration>
4029 which is used by the plugin if no configuration is present.
4033 =item B<Node> I<Nodename>
4035 The B<Node> block identifies a new Redis node, that is a new Redis instance
4036 running in an specified host and port. The name for node is a canonical
4037 identifier which is used as I<plugin instance>. It is limited to
4038 64E<nbsp>characters in length.
4040 =item B<Host> I<Hostname>
4042 The B<Host> option is the hostname or IP-address where the Redis instance is
4045 =item B<Port> I<Port>
4047 The B<Port> option is the TCP port on which the Redis instance accepts
4048 connections. Either a service name of a port number may be given. Please note
4049 that numerical port numbers must be given as a string, too.
4051 =item B<Timeout> I<Timeout in miliseconds>
4053 The B<Timeout> option set the socket timeout for node response. Since the Redis
4054 read function is blocking, you should keep this value as low as possible. Keep
4055 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
4056 than B<Interval> defined globally.
4060 =head2 Plugin C<rrdcached>
4062 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
4063 to store values to RRD files in an efficient manner. The combination of the
4064 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
4065 way the C<rrdtool> plugin works (see below). The added abstraction layer
4066 provides a number of benefits, though: Because the cache is not within
4067 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
4068 restarted. This results in much shorter (if any) gaps in graphs, especially
4069 under heavy load. Also, the C<rrdtool> command line utility is aware of the
4070 daemon so that it can flush values to disk automatically when needed. This
4071 allows to integrate automated flushing of values into graphing solutions much
4074 There are disadvantages, though: The daemon may reside on a different host, so
4075 it may not be possible for C<collectd> to create the appropriate RRD files
4076 anymore. And even if C<rrdcached> runs on the same host, it may run in a
4077 different base directory, so relative paths may do weird stuff if you're not
4080 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
4081 on the same host, communicating via a UNIX domain socket. The B<DataDir>
4082 setting should be set to an absolute path, so that a changed base directory
4083 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
4087 =item B<DaemonAddress> I<Address>
4089 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
4090 library. See L<rrdcached(1)> for details. Example:
4092 <Plugin "rrdcached">
4093 DaemonAddress "unix:/var/run/rrdcached.sock"
4096 =item B<DataDir> I<Directory>
4098 Set the base directory in which the RRD files reside. If this is a relative
4099 path, it is relative to the working base directory of the C<rrdcached> daemon!
4100 Use of an absolute path is recommended.
4102 =item B<CreateFiles> B<true>|B<false>
4104 Enables or disables the creation of RRD files. If the daemon is not running
4105 locally, or B<DataDir> is set to a relative path, this will not work as
4106 expected. Default is B<true>.
4110 =head2 Plugin C<rrdtool>
4112 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
4113 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
4114 using these settings. If you don't want to dive into the depths of RRDtool, you
4115 can safely ignore these settings.
4119 =item B<DataDir> I<Directory>
4121 Set the directory to store RRD-files under. Per default RRD-files are generated
4122 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
4124 =item B<StepSize> I<Seconds>
4126 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
4127 this setting is unset and the stepsize is set to the interval in which the data
4128 is collected. Do not use this option unless you absolutely have to for some
4129 reason. Setting this option may cause problems with the C<snmp plugin>, the
4130 C<exec plugin> or when the daemon is set up to receive data from other hosts.
4132 =item B<HeartBeat> I<Seconds>
4134 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
4135 in which case the heartbeat is set to twice the B<StepSize> which should equal
4136 the interval in which data is collected. Do not set this option unless you have
4137 a very good reason to do so.
4139 =item B<RRARows> I<NumRows>
4141 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
4142 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
4143 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
4144 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
4145 week, one month, and one year.
4147 So for each timespan, it calculates how many PDPs need to be consolidated into
4148 one CDP by calculating:
4149 number of PDPs = timespan / (stepsize * rrarows)
4151 Bottom line is, set this no smaller than the width of you graphs in pixels. The
4154 =item B<RRATimespan> I<Seconds>
4156 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
4157 more then one RRA. If this option is never used, the built-in default of (3600,
4158 86400, 604800, 2678400, 31622400) is used.
4160 For more information on how RRA-sizes are calculated see B<RRARows> above.
4162 =item B<XFF> I<Factor>
4164 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
4166 =item B<CacheFlush> I<Seconds>
4168 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
4169 it writes all values for a certain RRD-file if the oldest value is older than
4170 (or equal to) the number of seconds specified. If some RRD-file is not updated
4171 anymore for some reason (the computer was shut down, the network is broken,
4172 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
4173 entire cache is searched for entries older than B<CacheTimeout> seconds and
4174 written to disk every I<Seconds> seconds. Since this is kind of expensive and
4175 does nothing under normal circumstances, this value should not be too small.
4176 900 seconds might be a good value, though setting this to 7200 seconds doesn't
4177 normally do much harm either.
4179 =item B<CacheTimeout> I<Seconds>
4181 If this option is set to a value greater than zero, the C<rrdtool plugin> will
4182 save values in a cache, as described above. Writing multiple values at once
4183 reduces IO-operations and thus lessens the load produced by updating the files.
4184 The trade off is that the graphs kind of "drag behind" and that more memory is
4187 =item B<WritesPerSecond> I<Updates>
4189 When collecting many statistics with collectd and the C<rrdtool> plugin, you
4190 will run serious performance problems. The B<CacheFlush> setting and the
4191 internal update queue assert that collectd continues to work just fine even
4192 under heavy load, but the system may become very unresponsive and slow. This is
4193 a problem especially if you create graphs from the RRD files on the same
4194 machine, for example using the C<graph.cgi> script included in the
4195 C<contrib/collection3/> directory.
4197 This setting is designed for very large setups. Setting this option to a value
4198 between 25 and 80 updates per second, depending on your hardware, will leave
4199 the server responsive enough to draw graphs even while all the cached values
4200 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
4201 by the B<FLUSH> command, are B<not> effected by this limit. They are still
4202 written as fast as possible, so that web frontends have up to date data when
4205 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
4206 updates per second, writing all values to disk will take approximately
4207 56E<nbsp>minutes. Together with the flushing ability that's integrated into
4208 "collection3" you'll end up with a responsive and fast system, up to date
4209 graphs and basically a "backup" of your values every hour.
4211 =item B<RandomTimeout> I<Seconds>
4213 When set, the actual timeout for each value is chosen randomly between
4214 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
4215 intention is to avoid high load situations that appear when many values timeout
4216 at the same time. This is especially a problem shortly after the daemon starts,
4217 because all values were added to the internal cache at roughly the same time.
4221 =head2 Plugin C<sensors>
4223 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
4224 that all the needed modules have to be loaded and lm_sensors has to be
4225 configured (most likely by editing F</etc/sensors.conf>. Read
4226 L<sensors.conf(5)> for details.
4228 The B<lm_sensors> homepage can be found at
4229 L<http://secure.netroedge.com/~lm78/>.
4233 =item B<SensorConfigFile> I<File>
4235 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
4236 the library's default will be used.
4238 =item B<Sensor> I<chip-bus-address/type-feature>
4240 Selects the name of the sensor which you want to collect or ignore, depending
4241 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
4242 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
4243 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
4245 =item B<IgnoreSelected> I<true>|I<false>
4247 If no configuration if given, the B<sensors>-plugin will collect data from all
4248 sensors. This may not be practical, especially for uninteresting sensors.
4249 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
4250 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
4251 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
4252 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
4253 and all other sensors are collected.
4257 =head2 Plugin C<snmp>
4259 Since the configuration of the C<snmp plugin> is a little more complicated than
4260 other plugins, its documentation has been moved to an own manpage,
4261 L<collectd-snmp(5)>. Please see there for details.
4263 =head2 Plugin C<swap>
4265 The I<Swap plugin> collects information about used and available swap space. On
4266 I<Linux> and I<Solaris>, the following options are available:
4270 =item B<ReportByDevice> B<false>|B<true>
4272 Configures how to report physical swap devices. If set to B<false> (the
4273 default), the summary over all swap devices is reported only, i.e. the globally
4274 used and available space over all devices. If B<true> is configured, the used
4275 and available space of each device will be reported separately.
4277 This option is only available if the I<Swap plugin> can read C</proc/swaps>
4278 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
4282 =head2 Plugin C<syslog>
4286 =item B<LogLevel> B<debug|info|notice|warning|err>
4288 Sets the log-level. If, for example, set to B<notice>, then all events with
4289 severity B<notice>, B<warning>, or B<err> will be submitted to the
4292 Please note that B<debug> is only available if collectd has been compiled with
4295 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
4297 Controls which notifications should be sent to syslog. The default behaviour is
4298 not to send any. Less severe notifications always imply logging more severe
4299 notifications: Setting this to B<OKAY> means all notifications will be sent to
4300 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
4301 notifications but will dismiss B<OKAY> notifications. Setting this option to
4302 B<FAILURE> will only send failures to syslog.
4306 =head2 Plugin C<table>
4308 The C<table plugin> provides generic means to parse tabular data and dispatch
4309 user specified values. Values are selected based on column numbers. For
4310 example, this plugin may be used to get values from the Linux L<proc(5)>
4311 filesystem or CSV (comma separated values) files.
4314 <Table "/proc/slabinfo">
4319 InstancePrefix "active_objs"
4325 InstancePrefix "objperslab"
4332 The configuration consists of one or more B<Table> blocks, each of which
4333 configures one file to parse. Within each B<Table> block, there are one or
4334 more B<Result> blocks, which configure which data to select and how to
4337 The following options are available inside a B<Table> block:
4341 =item B<Instance> I<instance>
4343 If specified, I<instance> is used as the plugin instance. So, in the above
4344 example, the plugin name C<table-slabinfo> would be used. If omitted, the
4345 filename of the table is used instead, with all special characters replaced
4346 with an underscore (C<_>).
4348 =item B<Separator> I<string>
4350 Any character of I<string> is interpreted as a delimiter between the different
4351 columns of the table. A sequence of two or more contiguous delimiters in the
4352 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
4353 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
4354 of a table - see its documentation for more details. This option is mandatory.
4356 A horizontal tab, newline and carriage return may be specified by C<\\t>,
4357 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
4358 required because of collectd's config parsing.
4362 The following options are available inside a B<Result> block:
4366 =item B<Type> I<type>
4368 Sets the type used to dispatch the values to the daemon. Detailed information
4369 about types and their configuration can be found in L<types.db(5)>. This
4370 option is mandatory.
4372 =item B<InstancePrefix> I<prefix>
4374 If specified, prepend I<prefix> to the type instance. If omitted, only the
4375 B<InstancesFrom> option is considered for the type instance.
4377 =item B<InstancesFrom> I<column0> [I<column1> ...]
4379 If specified, the content of the given columns (identified by the column
4380 number starting at zero) will be used to create the type instance for each
4381 row. Multiple values (and the instance prefix) will be joined together with
4382 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
4383 option is considered for the type instance.
4385 The plugin itself does not check whether or not all built instances are
4386 different. It’s your responsibility to assure that each is unique. This is
4387 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
4388 sure that the table only contains one row.
4390 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
4393 =item B<ValuesFrom> I<column0> [I<column1> ...]
4395 Specifies the columns (identified by the column numbers starting at zero)
4396 whose content is used as the actual data for the data sets that are dispatched
4397 to the daemon. How many such columns you need is determined by the B<Type>
4398 setting above. If you specify too many or not enough columns, the plugin will
4399 complain about that and no data will be submitted to the daemon. The plugin
4400 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
4401 respectively, so anything supported by those functions is supported by the
4402 plugin as well. This option is mandatory.
4406 =head2 Plugin C<tail>
4408 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
4409 each line and dispatches found values. What is matched can be configured by the
4410 user using (extended) regular expressions, as described in L<regex(7)>.
4413 <File "/var/log/exim4/mainlog">
4416 Regex "S=([1-9][0-9]*)"
4422 Regex "\\<R=local_user\\>"
4423 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
4426 Instance "local_user"
4431 The config consists of one or more B<File> blocks, each of which configures one
4432 logfile to parse. Within each B<File> block, there are one or more B<Match>
4433 blocks, which configure a regular expression to search for.
4435 The B<Instance> option in the B<File> block may be used to set the plugin
4436 instance. So in the above example the plugin name C<tail-foo> would be used.
4437 This plugin instance is for all B<Match> blocks that B<follow> it, until the
4438 next B<Instance> option. This way you can extract several plugin instances from
4439 one logfile, handy when parsing syslog and the like.
4441 Each B<Match> block has the following options to describe how the match should
4446 =item B<Regex> I<regex>
4448 Sets the regular expression to use for matching against a line. The first
4449 subexpression has to match something that can be turned into a number by
4450 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
4451 below. Because B<extended> regular expressions are used, you do not need to use
4452 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
4453 collectd's config parsing you need to escape backslashes, though. So if you
4454 want to match literal parentheses you need to do the following:
4456 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
4458 =item B<ExcludeRegex> I<regex>
4460 Sets an optional regular expression to use for excluding lines from the match.
4461 An example which excludes all connections from localhost from the match:
4463 ExcludeRegex "127\\.0\\.0\\.1"
4465 =item B<DSType> I<Type>
4467 Sets how the values are cumulated. I<Type> is one of:
4471 =item B<GaugeAverage>
4473 Calculate the average.
4477 Use the smallest number only.
4481 Use the greatest number only.
4485 Use the last number found.
4491 =item B<AbsoluteSet>
4493 The matched number is a counter. Simply I<sets> the internal counter to this
4494 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
4500 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
4501 matched number may be negative, which will effectively subtract from the
4508 Increase the internal counter by one. These B<DSType> are the only ones that do
4509 not use the matched subexpression, but simply count the number of matched
4510 lines. Thus, you may use a regular expression without submatch in this case.
4514 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
4515 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
4516 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
4517 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
4518 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
4521 =item B<Type> I<Type>
4523 Sets the type used to dispatch this value. Detailed information about types and
4524 their configuration can be found in L<types.db(5)>.
4526 =item B<Instance> I<TypeInstance>
4528 This optional setting sets the type instance to use.
4532 =head2 Plugin C<teamspeak2>
4534 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
4535 polls interesting global and virtual server data. The plugin can query only one
4536 physical server but unlimited virtual servers. You can use the following
4537 options to configure it:
4541 =item B<Host> I<hostname/ip>
4543 The hostname or ip which identifies the physical server.
4546 =item B<Port> I<port>
4548 The query port of the physical server. This needs to be a string.
4551 =item B<Server> I<port>
4553 This option has to be added once for every virtual server the plugin should
4554 query. If you want to query the virtual server on port 8767 this is what the
4555 option would look like:
4559 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
4560 use quotes around it! If no such statement is given only global information
4565 =head2 Plugin C<ted>
4567 The I<TED> plugin connects to a device of "The Energy Detective", a device to
4568 measure power consumption. These devices are usually connected to a serial
4569 (RS232) or USB port. The plugin opens a configured device and tries to read the
4570 current energy readings. For more information on TED, visit
4571 L<http://www.theenergydetective.com/>.
4573 Available configuration options:
4577 =item B<Device> I<Path>
4579 Path to the device on which TED is connected. collectd will need read and write
4580 permissions on that file.
4582 Default: B</dev/ttyUSB0>
4584 =item B<Retries> I<Num>
4586 Apparently reading from TED is not that reliable. You can therefore configure a
4587 number of retries here. You only configure the I<retries> here, to if you
4588 specify zero, one reading will be performed (but no retries if that fails); if
4589 you specify three, a maximum of four readings are performed. Negative values
4596 =head2 Plugin C<tcpconns>
4598 The C<tcpconns plugin> counts the number of currently established TCP
4599 connections based on the local port and/or the remote port. Since there may be
4600 a lot of connections the default if to count all connections with a local port,
4601 for which a listening socket is opened. You can use the following options to
4602 fine-tune the ports you are interested in:
4606 =item B<ListeningPorts> I<true>|I<false>
4608 If this option is set to I<true>, statistics for all local ports for which a
4609 listening socket exists are collected. The default depends on B<LocalPort> and
4610 B<RemotePort> (see below): If no port at all is specifically selected, the
4611 default is to collect listening ports. If specific ports (no matter if local or
4612 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
4613 the selected ports will be collected unless this option is set to I<true>
4616 =item B<LocalPort> I<Port>
4618 Count the connections to a specific local port. This can be used to see how
4619 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
4620 You have to specify the port in numeric form, so for the mailserver example
4621 you'd need to set B<25>.
4623 =item B<RemotePort> I<Port>
4625 Count the connections to a specific remote port. This is useful to see how
4626 much a remote service is used. This is most useful if you want to know how many
4627 connections a local service has opened to remote services, e.E<nbsp>g. how many
4628 connections a mail server or news server has to other mail or news servers, or
4629 how many connections a web proxy holds to web servers. You have to give the
4630 port in numeric form.
4634 =head2 Plugin C<thermal>
4638 =item B<ForceUseProcfs> I<true>|I<false>
4640 By default, the I<Thermal plugin> tries to read the statistics from the Linux
4641 C<sysfs> interface. If that is not available, the plugin falls back to the
4642 C<procfs> interface. By setting this option to I<true>, you can force the
4643 plugin to use the latter. This option defaults to I<false>.
4645 =item B<Device> I<Device>
4647 Selects the name of the thermal device that you want to collect or ignore,
4648 depending on the value of the B<IgnoreSelected> option. This option may be
4649 used multiple times to specify a list of devices.
4651 =item B<IgnoreSelected> I<true>|I<false>
4653 Invert the selection: If set to true, all devices B<except> the ones that
4654 match the device names specified by the B<Device> option are collected. By
4655 default only selected devices are collected if a selection is made. If no
4656 selection is configured at all, B<all> devices are selected.
4660 =head2 Plugin C<threshold>
4662 The I<Threshold plugin> checks values collected or received by I<collectd>
4663 against a configurable I<threshold> and issues I<notifications> if values are
4666 Documentation for this plugin is available in the L<collectd-threshold(5)>
4669 =head2 Plugin C<tokyotyrant>
4671 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
4672 couple metrics: number of records, and database size on disk.
4676 =item B<Host> I<Hostname/IP>
4678 The hostname or ip which identifies the server.
4679 Default: B<127.0.0.1>
4681 =item B<Port> I<Service/Port>
4683 The query port of the server. This needs to be a string, even if the port is
4684 given in its numeric form.
4689 =head2 Plugin C<unixsock>
4693 =item B<SocketFile> I<Path>
4695 Sets the socket-file which is to be created.
4697 =item B<SocketGroup> I<Group>
4699 If running as root change the group of the UNIX-socket after it has been
4700 created. Defaults to B<collectd>.
4702 =item B<SocketPerms> I<Permissions>
4704 Change the file permissions of the UNIX-socket after it has been created. The
4705 permissions must be given as a numeric, octal value as you would pass to
4706 L<chmod(1)>. Defaults to B<0770>.
4708 =item B<DeleteSocket> B<false>|B<true>
4710 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
4711 with the given name already exists. If I<collectd> crashes a socket file may be
4712 left over, preventing the daemon from opening a new socket when restarted.
4713 Since this is potentially dangerous, this defaults to B<false>.
4717 =head2 Plugin C<uuid>
4719 This plugin, if loaded, causes the Hostname to be taken from the machine's
4720 UUID. The UUID is a universally unique designation for the machine, usually
4721 taken from the machine's BIOS. This is most useful if the machine is running in
4722 a virtual environment such as Xen, in which case the UUID is preserved across
4723 shutdowns and migration.
4725 The following methods are used to find the machine's UUID, in order:
4731 Check I</etc/uuid> (or I<UUIDFile>).
4735 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
4740 Check for UUID from C<dmidecode> / SMBIOS.
4744 Check for UUID from Xen hypervisor.
4748 If no UUID can be found then the hostname is not modified.
4752 =item B<UUIDFile> I<Path>
4754 Take the UUID from the given file (default I</etc/uuid>).
4758 =head2 Plugin C<varnish>
4760 The Varnish plugin collects information about Varnish, an HTTP accelerator.
4764 =item B<CollectCache> B<true>|B<false>
4766 Cache hits and misses. True by default.
4768 =item B<CollectConnections> B<true>|B<false>
4770 Number of client connections received, accepted and dropped. True by default.
4772 =item B<CollectBackend> B<true>|B<false>
4774 Back-end connection statistics, such as successful, reused,
4775 and closed connections. True by default.
4777 =item B<CollectSHM> B<true>|B<false>
4779 Statistics about the shared memory log, a memory region to store
4780 log messages which is flushed to disk when full. True by default.
4782 =item B<CollectESI> B<true>|B<false>
4784 Edge Side Includes (ESI) parse statistics. False by default.
4786 =item B<CollectFetch> B<true>|B<false>
4788 Statistics about fetches (HTTP requests sent to the backend). False by default.
4790 =item B<CollectHCB> B<true>|B<false>
4792 Inserts and look-ups in the crit bit tree based hash. Look-ups are
4793 divided into locked and unlocked look-ups. False by default.
4795 =item B<CollectSMA> B<true>|B<false>
4797 malloc or umem (umem_alloc(3MALLOC) based) storage statistics.
4798 The umem storage component is Solaris specific. False by default.
4800 =item B<CollectSMS> B<true>|B<false>
4802 synth (synthetic content) storage statistics. This storage
4803 component is used internally only. False by default.
4805 =item B<CollectSM> B<true>|B<false>
4807 file (memory mapped file) storage statistics. False by default.
4809 =item B<CollectTotals> B<true>|B<false>
4811 Collects overview counters, such as the number of sessions created,
4812 the number of requests and bytes transferred. False by default.
4814 =item B<CollectWorkers> B<true>|B<false>
4816 Collect statistics about worker threads. False by default.
4820 =head2 Plugin C<vmem>
4822 The C<vmem> plugin collects information about the usage of virtual memory.
4823 Since the statistics provided by the Linux kernel are very detailed, they are
4824 collected very detailed. However, to get all the details, you have to switch
4825 them on manually. Most people just want an overview over, such as the number of
4826 pages read from swap space.
4830 =item B<Verbose> B<true>|B<false>
4832 Enables verbose collection of information. This will start collecting page
4833 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
4834 Part of these statistics are collected on a "per zone" basis.
4838 =head2 Plugin C<vserver>
4840 This plugin doesn't have any options. B<VServer> support is only available for
4841 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
4842 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
4843 need to apply the patches and compile your own kernel, which will then provide
4844 the F</proc/virtual> filesystem that is required by this plugin.
4846 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
4848 B<Note>: The traffic collected by this plugin accounts for the amount of
4849 traffic passing a socket which might be a lot less than the actual on-wire
4850 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
4851 collect on-wire traffic you could, for example, use the logging facilities of
4852 iptables to feed data for the guest IPs into the iptables plugin.
4854 =head2 Plugin C<write_graphite>
4856 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
4857 storage and graphing project. The plugin connects to I<Carbon>, the data layer
4858 of I<Graphite>, and sends data via the "line based" protocol (per default using
4859 portE<nbsp>2003). The data will be sent in blocks of at most 1428 bytes to
4860 minimize the number of network packets.
4864 <Plugin write_graphite>
4874 =item B<Host> I<Address>
4876 Hostname or address to connect to. Defaults to C<localhost>.
4878 =item B<Port> I<Service>
4880 Service name or port number to connect to. Defaults to C<2003>.
4882 =item B<Prefix> I<String>
4884 When set, I<String> is added in front of the host name. Dots and whitespace are
4885 I<not> escaped in this string (see B<EscapeCharacter> below).
4887 =item B<Postfix> I<String>
4889 When set, I<String> is appended to the host name. Dots and whitespace are
4890 I<not> escaped in this string (see B<EscapeCharacter> below).
4892 =item B<EscapeCharacter> I<Char>
4894 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
4895 in the identifier. The B<EscapeCharacter> option determines which character
4896 dots, whitespace and control characters are replaced with. Defaults to
4899 =item B<StoreRates> B<false>|B<true>
4901 If set to B<true> (the default), convert counter values to rates. If set to
4902 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
4905 =item B<SeparateInstances> B<false>|B<true>
4907 If set to B<true>, the plugin instance and type instance will be in their own
4908 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
4909 default), the plugin and plugin instance (and likewise the type and type
4910 instance) are put into once component, for example C<host.cpu-0.cpu-idle>.
4912 =item B<AlwaysAppendDS> B<false>|B<true>
4914 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
4915 identifier. If set to B<false> (the default), this is only done when there is
4920 =head2 Plugin C<write_mongodb>
4922 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
4927 <Plugin "write_mongodb">
4936 The plugin can send values to multiple instances of I<MongoDB> by specifying
4937 one B<Node> block for each instance. Within the B<Node> blocks, the following
4938 options are available:
4942 =item B<Host> I<Address>
4944 Hostname or address to connect to. Defaults to C<localhost>.
4946 =item B<Port> I<Service>
4948 Service name or port number to connect to. Defaults to C<27017>.
4950 =item B<Timeout> I<Timeout>
4952 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
4953 Setting this option to zero means no timeout, which is the default.
4955 =item B<StoreRates> B<false>|B<true>
4957 If set to B<true> (the default), convert counter values to rates. If set to
4958 B<false> counter values are stored as is, i.e. as an increasing integer
4963 =head2 Plugin C<write_http>
4965 This output plugin submits values to an http server by POST them using the
4966 PUTVAL plain-text protocol. Each destination you want to post data to needs to
4967 have one B<URL> block, within which the destination can be configured further,
4968 for example by specifying authentication data.
4972 <Plugin "write_http">
4973 <URL "http://example.com/post-collectd">
4979 B<URL> blocks need one string argument which is used as the URL to which data
4980 is posted. The following options are understood within B<URL> blocks.
4984 =item B<User> I<Username>
4986 Optional user name needed for authentication.
4988 =item B<Password> I<Password>
4990 Optional password needed for authentication.
4992 =item B<VerifyPeer> B<true>|B<false>
4994 Enable or disable peer SSL certificate verification. See
4995 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
4997 =item B<VerifyHost> B<true|false>
4999 Enable or disable peer host name verification. If enabled, the plugin checks if
5000 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
5001 matches the host name provided by the B<URL> option. If this identity check
5002 fails, the connection is aborted. Obviously, only works when connecting to a
5003 SSL enabled server. Enabled by default.
5005 =item B<CACert> I<File>
5007 File that holds one or more SSL certificates. If you want to use HTTPS you will
5008 possibly need this option. What CA certificates come bundled with C<libcurl>
5009 and are checked by default depends on the distribution you use.
5011 =item B<Format> B<Command>|B<JSON>
5013 Format of the output to generate. If set to B<Command>, will create output that
5014 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
5015 create output in the I<JavaScript Object Notation> (JSON).
5017 Defaults to B<Command>.
5019 =item B<StoreRates> B<true|false>
5021 If set to B<true>, convert counter values to rates. If set to B<false> (the
5022 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
5027 =head1 FILTER CONFIGURATION
5029 Starting with collectd 4.6 there is a powerful filtering infrastructure
5030 implemented in the daemon. The concept has mostly been copied from
5031 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
5032 terminology, so that users that are familiar with iptables feel right at home.
5036 The following are the terms used in the remainder of the filter configuration
5037 documentation. For an ASCII-art schema of the mechanism, see
5038 L<"General structure"> below.
5044 A I<match> is a criteria to select specific values. Examples are, of course, the
5045 name of the value or it's current value.
5047 Matches are implemented in plugins which you have to load prior to using the
5048 match. The name of such plugins starts with the "match_" prefix.
5052 A I<target> is some action that is to be performed with data. Such actions
5053 could, for example, be to change part of the value's identifier or to ignore
5054 the value completely.
5056 Some of these targets are built into the daemon, see L<"Built-in targets">
5057 below. Other targets are implemented in plugins which you have to load prior to
5058 using the target. The name of such plugins starts with the "target_" prefix.
5062 The combination of any number of matches and at least one target is called a
5063 I<rule>. The target actions will be performed for all values for which B<all>
5064 matches apply. If the rule does not have any matches associated with it, the
5065 target action will be performed for all values.
5069 A I<chain> is a list of rules and possibly default targets. The rules are tried
5070 in order and if one matches, the associated target will be called. If a value
5071 is handled by a rule, it depends on the target whether or not any subsequent
5072 rules are considered or if traversal of the chain is aborted, see
5073 L<"Flow control"> below. After all rules have been checked, the default targets
5078 =head2 General structure
5080 The following shows the resulting structure:
5087 +---------+ +---------+ +---------+ +---------+
5088 ! Rule !->! Match !->! Match !->! Target !
5089 +---------+ +---------+ +---------+ +---------+
5092 +---------+ +---------+ +---------+
5093 ! Rule !->! Target !->! Target !
5094 +---------+ +---------+ +---------+
5101 +---------+ +---------+ +---------+
5102 ! Rule !->! Match !->! Target !
5103 +---------+ +---------+ +---------+
5113 There are four ways to control which way a value takes through the filter
5120 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
5121 process the value with another chain. When the called chain finishes, usually
5122 the next target or rule after the jump is executed.
5126 The stop condition, signaled for example by the built-in target B<stop>, causes
5127 all processing of the value to be stopped immediately.
5131 Causes processing in the current chain to be aborted, but processing of the
5132 value generally will continue. This means that if the chain was called via
5133 B<Jump>, the next target or rule after the jump will be executed. If the chain
5134 was not called by another chain, control will be returned to the daemon and it
5135 may pass the value to another chain.
5139 Most targets will signal the B<continue> condition, meaning that processing
5140 should continue normally. There is no special built-in target for this
5147 The configuration reflects this structure directly:
5149 PostCacheChain "PostCache"
5151 <Rule "ignore_mysql_show">
5154 Type "^mysql_command$"
5155 TypeInstance "^show_"
5165 The above configuration example will ignore all values where the plugin field
5166 is "mysql", the type is "mysql_command" and the type instance begins with
5167 "show_". All other values will be sent to the C<rrdtool> write plugin via the
5168 default target of the chain. Since this chain is run after the value has been
5169 added to the cache, the MySQL C<show_*> command statistics will be available
5170 via the C<unixsock> plugin.
5172 =head2 List of configuration options
5176 =item B<PreCacheChain> I<ChainName>
5178 =item B<PostCacheChain> I<ChainName>
5180 Configure the name of the "pre-cache chain" and the "post-cache chain". The
5181 argument is the name of a I<chain> that should be executed before and/or after
5182 the values have been added to the cache.
5184 To understand the implications, it's important you know what is going on inside
5185 I<collectd>. The following diagram shows how values are passed from the
5186 read-plugins to the write-plugins:
5192 + - - - - V - - - - +
5193 : +---------------+ :
5196 : +-------+-------+ :
5199 : +-------+-------+ : +---------------+
5200 : ! Cache !--->! Value Cache !
5201 : ! insert ! : +---+---+-------+
5202 : +-------+-------+ : ! !
5203 : ! ,------------' !
5205 : +-------+---+---+ : +-------+-------+
5206 : ! Post-Cache +--->! Write-Plugins !
5207 : ! Chain ! : +---------------+
5208 : +---------------+ :
5211 + - - - - - - - - - +
5213 After the values are passed from the "read" plugins to the dispatch functions,
5214 the pre-cache chain is run first. The values are added to the internal cache
5215 afterwards. The post-cache chain is run after the values have been added to the
5216 cache. So why is it such a huge deal if chains are run before or after the
5217 values have been added to this cache?
5219 Targets that change the identifier of a value list should be executed before
5220 the values are added to the cache, so that the name in the cache matches the
5221 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
5222 this cache to receive a list of all available values. If you change the
5223 identifier after the value list has been added to the cache, this may easily
5224 lead to confusion, but it's not forbidden of course.
5226 The cache is also used to convert counter values to rates. These rates are, for
5227 example, used by the C<value> match (see below). If you use the rate stored in
5228 the cache B<before> the new value is added, you will use the old, B<previous>
5229 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
5230 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
5233 Last but not last, the B<stop> target makes a difference: If the pre-cache
5234 chain returns the stop condition, the value will not be added to the cache and
5235 the post-cache chain will not be run.
5237 =item B<Chain> I<Name>
5239 Adds a new chain with a certain name. This name can be used to refer to a
5240 specific chain, for example to jump to it.
5242 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
5244 =item B<Rule> [I<Name>]
5246 Adds a new rule to the current chain. The name of the rule is optional and
5247 currently has no meaning for the daemon.
5249 Within the B<Rule> block, there may be any number of B<Match> blocks and there
5250 must be at least one B<Target> block.
5252 =item B<Match> I<Name>
5254 Adds a match to a B<Rule> block. The name specifies what kind of match should
5255 be performed. Available matches depend on the plugins that have been loaded.
5257 The arguments inside the B<Match> block are passed to the plugin implementing
5258 the match, so which arguments are valid here depends on the plugin being used.
5259 If you do not need any to pass any arguments to a match, you can use the
5264 Which is equivalent to:
5269 =item B<Target> I<Name>
5271 Add a target to a rule or a default target to a chain. The name specifies what
5272 kind of target is to be added. Which targets are available depends on the
5273 plugins being loaded.
5275 The arguments inside the B<Target> block are passed to the plugin implementing
5276 the target, so which arguments are valid here depends on the plugin being used.
5277 If you do not need any to pass any arguments to a target, you can use the
5282 This is the same as writing:
5289 =head2 Built-in targets
5291 The following targets are built into the core daemon and therefore need no
5292 plugins to be loaded:
5298 Signals the "return" condition, see the L<"Flow control"> section above. This
5299 causes the current chain to stop processing the value and returns control to
5300 the calling chain. The calling chain will continue processing targets and rules
5301 just after the B<jump> target (see below). This is very similar to the
5302 B<RETURN> target of iptables, see L<iptables(8)>.
5304 This target does not have any options.
5312 Signals the "stop" condition, see the L<"Flow control"> section above. This
5313 causes processing of the value to be aborted immediately. This is similar to
5314 the B<DROP> target of iptables, see L<iptables(8)>.
5316 This target does not have any options.
5324 Sends the value to "write" plugins.
5330 =item B<Plugin> I<Name>
5332 Name of the write plugin to which the data should be sent. This option may be
5333 given multiple times to send the data to more than one write plugin.
5337 If no plugin is explicitly specified, the values will be sent to all available
5348 Starts processing the rules of another chain, see L<"Flow control"> above. If
5349 the end of that chain is reached, or a stop condition is encountered,
5350 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
5351 next target or the next rule. This is similar to the B<-j> command line option
5352 of iptables, see L<iptables(8)>.
5358 =item B<Chain> I<Name>
5360 Jumps to the chain I<Name>. This argument is required and may appear only once.
5372 =head2 Available matches
5378 Matches a value using regular expressions.
5384 =item B<Host> I<Regex>
5386 =item B<Plugin> I<Regex>
5388 =item B<PluginInstance> I<Regex>
5390 =item B<Type> I<Regex>
5392 =item B<TypeInstance> I<Regex>
5394 Match values where the given regular expressions match the various fields of
5395 the identifier of a value. If multiple regular expressions are given, B<all>
5396 regexen must match for a value to match.
5398 =item B<Invert> B<false>|B<true>
5400 When set to B<true>, the result of the match is inverted, i.e. all value lists
5401 where all regular expressions apply are not matched, all other value lists are
5402 matched. Defaults to B<false>.
5409 Host "customer[0-9]+"
5415 Matches values that have a time which differs from the time on the server.
5417 This match is mainly intended for servers that receive values over the
5418 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
5419 is very sensitive to the timestamp used when updating the RRD files. In
5420 particular, the time must be ever increasing. If a misbehaving client sends one
5421 packet with a timestamp far in the future, all further packets with a correct
5422 time will be ignored because of that one packet. What's worse, such corrupted
5423 RRD files are hard to fix.
5425 This match lets one match all values B<outside> a specified time range
5426 (relative to the server's time), so you can use the B<stop> target (see below)
5427 to ignore the value, for example.
5433 =item B<Future> I<Seconds>
5435 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
5436 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
5439 =item B<Past> I<Seconds>
5441 Matches all values that are I<behind> of the server's time by I<Seconds> or
5442 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
5454 This example matches all values that are five minutes or more ahead of the
5455 server or one hour (or more) lagging behind.
5459 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
5460 values. If a data-set consists of more than one data-source, all data-sources
5461 must match the specified ranges for a positive match.
5467 =item B<Min> I<Value>
5469 Sets the smallest value which still results in a match. If unset, behaves like
5472 =item B<Max> I<Value>
5474 Sets the largest value which still results in a match. If unset, behaves like
5477 =item B<Invert> B<true>|B<false>
5479 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
5480 no-match is returned and vice versa. Please note that the B<Invert> setting
5481 only effects how B<Min> and B<Max> are applied to a specific value. Especially
5482 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
5484 =item B<DataSource> I<DSName> [I<DSName> ...]
5486 Select one or more of the data sources. If no data source is configured, all
5487 data sources will be checked. If the type handled by the match does not have a
5488 data source of the specified name(s), this will always result in no match
5489 (independent of the B<Invert> setting).
5491 =item B<Satisfy> B<Any>|B<All>
5493 Specifies how checking with several data sources is performed. If set to
5494 B<Any>, the match succeeds if one of the data sources is in the configured
5495 range. If set to B<All> the match only succeeds if all data sources are within
5496 the configured range. Default is B<All>.
5498 Usually B<All> is used for positive matches, B<Any> is used for negative
5499 matches. This means that with B<All> you usually check that all values are in a
5500 "good" range, while with B<Any> you check if any value is within a "bad" range
5501 (or outside the "good" range).
5505 Either B<Min> or B<Max>, but not both, may be unset.
5509 # Match all values smaller than or equal to 100. Matches only if all data
5510 # sources are below 100.
5516 # Match if the value of any data source is outside the range of 0 - 100.
5524 =item B<empty_counter>
5526 Matches all values with one or more data sources of type B<COUNTER> and where
5527 all counter values are zero. These counters usually I<never> increased since
5528 they started existing (and are therefore uninteresting), or got reset recently
5529 or overflowed and you had really, I<really> bad luck.
5531 Please keep in mind that ignoring such counters can result in confusing
5532 behavior: Counters which hardly ever increase will be zero for long periods of
5533 time. If the counter is reset for some reason (machine or service restarted,
5534 usually), the graph will be empty (NAN) for a long time. People may not
5539 Calculates a hash value of the host name and matches values according to that
5540 hash value. This makes it possible to divide all hosts into groups and match
5541 only values that are in a specific group. The intended use is in load
5542 balancing, where you want to handle only part of all data and leave the rest
5545 The hashing function used tries to distribute the hosts evenly. First, it
5546 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
5549 for (i = 0; host[i] != 0; i++)
5550 hash_value = (hash_value * 251) + host[i];
5552 The constant 251 is a prime number which is supposed to make this hash value
5553 more random. The code then checks the group for this host according to the
5554 I<Total> and I<Match> arguments:
5556 if ((hash_value % Total) == Match)
5561 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
5562 groups), then the least significant bit of the hash value will be the XOR of
5563 all least significant bits in the host name. One consequence is that when you
5564 have two hosts, "server0.example.com" and "server1.example.com", where the host
5565 name differs in one digit only and the digits differ by one, those hosts will
5566 never end up in the same group.
5572 =item B<Match> I<Match> I<Total>
5574 Divide the data into I<Total> groups and match all hosts in group I<Match> as
5575 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
5576 be smaller than I<Total>. I<Total> must be at least one, although only values
5577 greater than one really do make any sense.
5579 You can repeat this option to match multiple groups, for example:
5584 The above config will divide the data into seven groups and match groups three
5585 and five. One use would be to keep every value on two hosts so that if one
5586 fails the missing data can later be reconstructed from the second host.
5592 # Operate on the pre-cache chain, so that ignored values are not even in the
5597 # Divide all received hosts in seven groups and accept all hosts in
5601 # If matched: Return and continue.
5604 # If not matched: Return and stop.
5610 =head2 Available targets
5614 =item B<notification>
5616 Creates and dispatches a notification.
5622 =item B<Message> I<String>
5624 This required option sets the message of the notification. The following
5625 placeholders will be replaced by an appropriate value:
5633 =item B<%{plugin_instance}>
5637 =item B<%{type_instance}>
5639 These placeholders are replaced by the identifier field of the same name.
5641 =item B<%{ds:>I<name>B<}>
5643 These placeholders are replaced by a (hopefully) human readable representation
5644 of the current rate of this data source. If you changed the instance name
5645 (using the B<set> or B<replace> targets, see below), it may not be possible to
5646 convert counter values to rates.
5650 Please note that these placeholders are B<case sensitive>!
5652 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
5654 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
5661 <Target "notification">
5662 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
5668 Replaces parts of the identifier using regular expressions.
5674 =item B<Host> I<Regex> I<Replacement>
5676 =item B<Plugin> I<Regex> I<Replacement>
5678 =item B<PluginInstance> I<Regex> I<Replacement>
5680 =item B<TypeInstance> I<Regex> I<Replacement>
5682 Match the appropriate field with the given regular expression I<Regex>. If the
5683 regular expression matches, that part that matches is replaced with
5684 I<Replacement>. If multiple places of the input buffer match a given regular
5685 expression, only the first occurrence will be replaced.
5687 You can specify each option multiple times to use multiple regular expressions
5695 # Replace "example.net" with "example.com"
5696 Host "\\<example.net\\>" "example.com"
5698 # Strip "www." from hostnames
5704 Sets part of the identifier of a value to a given string.
5710 =item B<Host> I<String>
5712 =item B<Plugin> I<String>
5714 =item B<PluginInstance> I<String>
5716 =item B<TypeInstance> I<String>
5718 Set the appropriate field to the given string. The strings for plugin instance
5719 and type instance may be empty, the strings for host and plugin may not be
5720 empty. It's currently not possible to set the type of a value this way.
5727 PluginInstance "coretemp"
5728 TypeInstance "core3"
5733 =head2 Backwards compatibility
5735 If you use collectd with an old configuration, i.E<nbsp>e. one without a
5736 B<Chain> block, it will behave as it used to. This is equivalent to the
5737 following configuration:
5743 If you specify a B<PostCacheChain>, the B<write> target will not be added
5744 anywhere and you will have to make sure that it is called where appropriate. We
5745 suggest to add the above snippet as default target to your "PostCache" chain.
5749 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
5765 L<collectd-exec(5)>,
5766 L<collectd-perl(5)>,
5767 L<collectd-unixsock(5)>,
5780 Florian Forster E<lt>octo@verplant.orgE<gt>