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"
213 # GraphitePrefix "collectd."
214 # GraphiteEscapeChar "_"
217 # Receive values from an AMQP broker
218 <Subscribe "some_name">
224 Exchange "amq.fanout"
225 # ExchangeType "fanout"
227 # RoutingKey "collectd.#"
231 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
232 blocks, which configure sending and receiving of values respectively. The two
233 blocks are very similar, so unless otherwise noted, an option can be used in
234 either block. The name given in the blocks starting tag is only used for
235 reporting messages, but may be used to support I<flushing> of certain
236 I<Publish> blocks in the future.
240 =item B<Host> I<Host>
242 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
243 the underlying communications library, I<rabbitmq-c>, which is "localhost".
245 =item B<Port> I<Port>
247 Service name or port number on which the AMQP broker accepts connections. This
248 argument must be a string, even if the numeric form is used. Defaults to
251 =item B<VHost> I<VHost>
253 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
255 =item B<User> I<User>
257 =item B<Password> I<Password>
259 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
262 =item B<Exchange> I<Exchange>
264 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
265 By default, "amq.fanout" will be used.
267 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
268 the given exchange and the I<queue> is created, using the I<routing key> if
269 configured. See the B<Queue> and B<RoutingKey> options below.
271 =item B<ExchangeType> I<Type>
273 If given, the plugin will try to create the configured I<exchange> with this
274 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
275 be bound to this exchange.
277 =item B<Queue> I<Queue> (Subscribe only)
279 Configures the I<queue> name to subscribe to. If no queue name was configures
280 explicitly, a unique queue name will be created by the broker.
282 =item B<RoutingKey> I<Key>
284 In I<Publish> blocks, this configures the routing key to set on all outgoing
285 messages. If not given, the routing key will be computed from the I<identifier>
286 of the value. The host, plugin, type and the two instances are concatenated
287 together using dots as the separator and all containing dots replaced with
288 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
289 possible to receive only specific values using a "topic" exchange.
291 In I<Subscribe> blocks, configures the I<routing key> used when creating a
292 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
293 used to filter messages when using a "topic" exchange. If you're only
294 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
297 =item B<Persistent> B<true>|B<false> (Publish only)
299 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
300 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
301 default), the I<transient> delivery mode will be used, i.e. messages may be
302 lost due to high load, overflowing queues or similar issues.
304 =item B<Format> B<Command>|B<JSON> (Publish only)
306 Selects the format in which messages are sent to the broker. If set to
307 B<Command> (the default), values are sent as C<PUTVAL> commands which are
308 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
309 case, the C<Content-Type> header field will be set to C<text/collectd>.
311 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
312 an easy and straight forward exchange format. The C<Content-Type> header field
313 will be set to C<application/json>.
315 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
316 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
319 A subscribing client I<should> use the C<Content-Type> header field to
320 determine how to decode the values. Currently, the I<AMQP plugin> itself can
321 only decode the B<Command> format.
323 =item B<StoreRates> B<true>|B<false> (Publish only)
325 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
326 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
327 default), no conversion is performed. Otherwise the conversion is performed
328 using the internal value cache.
330 Please note that currently this option is only used if the B<Format> option has
333 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
335 A prefix can be added in the metric name when outputting in the I<Graphite> format.
336 It's added before the I<Host> name.
337 Metric name will be "<prefix><host><postfix><plugin><type><name>"
339 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
341 A postfix can be added in the metric name when outputting in the I<Graphite> format.
342 It's added after the I<Host> name.
343 Metric name will be "<prefix><host><postfix><plugin><type><name>"
345 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
347 Specify a character to replace dots (.) in the host part of the metric name.
348 In I<Graphite> metric name, dots are used as separators between different
349 metric parts (host, plugin, type).
350 Default is "_" (I<Underscore>).
354 =head2 Plugin C<apache>
356 To configure the C<apache>-plugin you first need to configure the Apache
357 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
358 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
359 the following snipped to base your Apache config upon:
362 <IfModule mod_status.c>
363 <Location /mod_status>
364 SetHandler server-status
368 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
369 also supported. It introduces a new field, called C<BusyServers>, to count the
370 number of currently connected clients. This field is also supported.
372 The configuration of the I<Apache> plugin consists of one or more
373 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
374 as the instance name. For example:
378 URL "http://www1.example.com/mod_status?auto"
381 URL "http://www2.example.com/mod_status?auto"
385 The instance name will be used as the I<plugin instance>. To emulate the old
386 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
387 plugin to work correctly, each instance name must be unique. This is not
388 enforced by the plugin and it is your responsibility to ensure it.
390 The following options are accepted within each I<Instance> block:
394 =item B<URL> I<http://host/mod_status?auto>
396 Sets the URL of the C<mod_status> output. This needs to be the output generated
397 by C<ExtendedStatus on> and it needs to be the machine readable output
398 generated by appending the C<?auto> argument. This option is I<mandatory>.
400 =item B<User> I<Username>
402 Optional user name needed for authentication.
404 =item B<Password> I<Password>
406 Optional password needed for authentication.
408 =item B<VerifyPeer> B<true|false>
410 Enable or disable peer SSL certificate verification. See
411 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
413 =item B<VerifyHost> B<true|false>
415 Enable or disable peer host name verification. If enabled, the plugin checks
416 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
417 certificate matches the host name provided by the B<URL> option. If this
418 identity check fails, the connection is aborted. Obviously, only works when
419 connecting to a SSL enabled server. Enabled by default.
421 =item B<CACert> I<File>
423 File that holds one or more SSL certificates. If you want to use HTTPS you will
424 possibly need this option. What CA certificates come bundled with C<libcurl>
425 and are checked by default depends on the distribution you use.
429 =head2 Plugin C<apcups>
433 =item B<Host> I<Hostname>
435 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
436 that IPv6 support has been disabled unless someone can confirm or decline that
437 B<apcupsd> can handle it.
439 =item B<Port> I<Port>
441 TCP-Port to connect to. Defaults to B<3551>.
445 =head2 Plugin C<ascent>
447 This plugin collects information about an Ascent server, a free server for the
448 "World of Warcraft" game. This plugin gathers the information by fetching the
449 XML status page using C<libcurl> and parses it using C<libxml2>.
451 The configuration options are the same as for the C<apache> plugin above:
455 =item B<URL> I<http://localhost/ascent/status/>
457 Sets the URL of the XML status output.
459 =item B<User> I<Username>
461 Optional user name needed for authentication.
463 =item B<Password> I<Password>
465 Optional password needed for authentication.
467 =item B<VerifyPeer> B<true|false>
469 Enable or disable peer SSL certificate verification. See
470 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
472 =item B<VerifyHost> B<true|false>
474 Enable or disable peer host name verification. If enabled, the plugin checks
475 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
476 certificate matches the host name provided by the B<URL> option. If this
477 identity check fails, the connection is aborted. Obviously, only works when
478 connecting to a SSL enabled server. Enabled by default.
480 =item B<CACert> I<File>
482 File that holds one or more SSL certificates. If you want to use HTTPS you will
483 possibly need this option. What CA certificates come bundled with C<libcurl>
484 and are checked by default depends on the distribution you use.
488 =head2 Plugin C<bind>
490 Starting with BIND 9.5.0, the most widely used DNS server software provides
491 extensive statistics about queries, responses and lots of other information.
492 The bind plugin retrieves this information that's encoded in XML and provided
493 via HTTP and submits the values to collectd.
495 To use this plugin, you first need to tell BIND to make this information
496 available. This is done with the C<statistics-channels> configuration option:
498 statistics-channels {
499 inet localhost port 8053;
502 The configuration follows the grouping that can be seen when looking at the
503 data with an XSLT compatible viewer, such as a modern web browser. It's
504 probably a good idea to make yourself familiar with the provided values, so you
505 can understand what the collected statistics actually mean.
510 URL "http://localhost:8053/"
525 Zone "127.in-addr.arpa/IN"
529 The bind plugin accepts the following configuration options:
535 URL from which to retrieve the XML data. If not specified,
536 C<http://localhost:8053/> will be used.
538 =item B<ParseTime> B<true>|B<false>
540 When set to B<true>, the time provided by BIND will be parsed and used to
541 dispatch the values. When set to B<false>, the local time source is queried.
543 This setting is set to B<true> by default for backwards compatibility; setting
544 this to B<false> is I<recommended> to avoid problems with timezones and
547 =item B<OpCodes> B<true>|B<false>
549 When enabled, statistics about the I<"OpCodes">, for example the number of
550 C<QUERY> packets, are collected.
554 =item B<QTypes> B<true>|B<false>
556 When enabled, the number of I<incoming> queries by query types (for example
557 C<A>, C<MX>, C<AAAA>) is collected.
561 =item B<ServerStats> B<true>|B<false>
563 Collect global server statistics, such as requests received over IPv4 and IPv6,
564 successful queries, and failed updates.
568 =item B<ZoneMaintStats> B<true>|B<false>
570 Collect zone maintenance statistics, mostly information about notifications
571 (zone updates) and zone transfers.
575 =item B<ResolverStats> B<true>|B<false>
577 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
578 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
579 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
580 default. Use the B<ResolverStats> option within a B<View "_default"> block
581 instead for the same functionality.
587 Collect global memory statistics.
591 =item B<View> I<Name>
593 Collect statistics about a specific I<"view">. BIND can behave different,
594 mostly depending on the source IP-address of the request. These different
595 configurations are called "views". If you don't use this feature, you most
596 likely are only interested in the C<_default> view.
598 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
599 information you want to collect about a view. If no B<View> block is
600 configured, no detailed view statistics will be collected.
604 =item B<QTypes> B<true>|B<false>
606 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
611 =item B<ResolverStats> B<true>|B<false>
613 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
614 (e.E<nbsp>g. queries over IPv4, lame servers).
618 =item B<CacheRRSets> B<true>|B<false>
620 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
621 type is collected. Negative entries (queries which resulted in an error, for
622 example names that do not exist) are reported with a leading exclamation mark,
627 =item B<Zone> I<Name>
629 When given, collect detailed information about the given zone in the view. The
630 information collected if very similar to the global B<ServerStats> information
633 You can repeat this option to collect detailed information about multiple
636 By default no detailed zone information is collected.
642 =head2 Plugin C<cpufreq>
644 This plugin doesn't have any options. It reads
645 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
646 installed) to get the current CPU frequency. If this file does not exist make
647 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
648 installed and an "cpu governor" (that's a kernel module) is loaded.
654 =item B<DataDir> I<Directory>
656 Set the directory to store CSV-files under. Per default CSV-files are generated
657 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
658 The special strings B<stdout> and B<stderr> can be used to write to the standard
659 output and standard error channels, respectively. This, of course, only makes
660 much sense when collectd is running in foreground- or non-daemon-mode.
662 =item B<StoreRates> B<true|false>
664 If set to B<true>, convert counter values to rates. If set to B<false> (the
665 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
670 =head2 Plugin C<curl>
672 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
673 and the match infrastructure (the same code used by the tail plugin) to use
674 regular expressions with the received data.
676 The following example will read the current value of AMD stock from Google's
677 finance page and dispatch the value to collectd.
680 <Page "stock_quotes">
681 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
685 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
686 DSType "GaugeAverage"
687 # Note: `stock_value' is not a standard type.
694 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
695 a web page and one or more "matches" to be performed on the returned data. The
696 string argument to the B<Page> block is used as plugin instance.
698 The following options are valid within B<Page> blocks:
704 URL of the web site to retrieve. Since a regular expression will be used to
705 extract information from this data, non-binary data is a big plus here ;)
707 =item B<User> I<Name>
709 Username to use if authorization is required to read the page.
711 =item B<Password> I<Password>
713 Password to use if authorization is required to read the page.
715 =item B<VerifyPeer> B<true>|B<false>
717 Enable or disable peer SSL certificate verification. See
718 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
720 =item B<VerifyHost> B<true>|B<false>
722 Enable or disable peer host name verification. If enabled, the plugin checks if
723 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
724 matches the host name provided by the B<URL> option. If this identity check
725 fails, the connection is aborted. Obviously, only works when connecting to a
726 SSL enabled server. Enabled by default.
728 =item B<CACert> I<file>
730 File that holds one or more SSL certificates. If you want to use HTTPS you will
731 possibly need this option. What CA certificates come bundled with C<libcurl>
732 and are checked by default depends on the distribution you use.
734 =item B<MeasureResponseTime> B<true>|B<false>
736 Measure response time for the request. If this setting is enabled, B<Match>
737 blocks (see below) are optional. Disabled by default.
739 =item B<E<lt>MatchE<gt>>
741 One or more B<Match> blocks that define how to match information in the data
742 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
743 used by the C<tail> plugin, so please see the documentation of the C<tail>
744 plugin below on how matches are defined. If the B<MeasureResponseTime> option
745 is set to B<true>, B<Match> blocks are optional.
749 =head2 Plugin C<curl_json>
751 The B<curl_json plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and
752 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) to retrieve JSON data
753 via cURL. This can be used to collect values from CouchDB documents (which are
754 stored JSON notation), for example.
756 The following example will collect several values from the built-in `_stats'
757 runtime statistics module of CouchDB
758 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
761 <URL "http://localhost:5984/_stats">
763 <Key "httpd/requests/count">
767 <Key "httpd_request_methods/*/count">
768 Type "http_request_methods"
771 <Key "httpd_status_codes/*/count">
772 Type "http_response_codes"
777 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining
778 a URL to be fetched via HTTP (using libcurl) and one or more B<Key> blocks.
779 The B<Key> string argument must be in a path format, which is used to collect a
780 value from a JSON map object. If a path element of B<Key> is the
781 I<*>E<nbsp>wildcard, the values for all keys will be collectd.
783 The following options are valid within B<URL> blocks:
787 =item B<Instance> I<Instance>
789 Sets the plugin instance to I<Instance>.
791 =item B<User> I<Name>
793 Username to use if authorization is required to read the page.
795 =item B<Password> I<Password>
797 Password to use if authorization is required to read the page.
799 =item B<VerifyPeer> B<true>|B<false>
801 Enable or disable peer SSL certificate verification. See
802 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
804 =item B<VerifyHost> B<true>|B<false>
806 Enable or disable peer host name verification. If enabled, the plugin checks if
807 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
808 matches the host name provided by the B<URL> option. If this identity check
809 fails, the connection is aborted. Obviously, only works when connecting to a
810 SSL enabled server. Enabled by default.
812 =item B<CACert> I<file>
814 File that holds one or more SSL certificates. If you want to use HTTPS you will
815 possibly need this option. What CA certificates come bundled with C<libcurl>
816 and are checked by default depends on the distribution you use.
820 The following options are valid within B<Key> blocks:
824 =item B<Type> I<Type>
826 Sets the type used to dispatch the values to the daemon. Detailed information
827 about types and their configuration can be found in L<types.db(5)>. This
830 =item B<Instance> I<Instance>
832 Type-instance to use. Defaults to the current map key or current string array element value.
836 =head2 Plugin C<curl_xml>
838 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
839 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
842 <URL "http://localhost/stats.xml">
844 Instance "some_instance"
849 CACert "/path/to/ca.crt"
851 <XPath "table[@id=\"magic_level\"]/tr">
853 #InstancePrefix "prefix-"
855 ValuesFrom "td[2]/span[@class=\"level\"]"
860 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
861 URL to be fetched using libcurl. Within each B<URL> block there are
862 options which specify the connection parameters, for example authentication
863 information, and one or more B<XPath> blocks.
865 Each B<XPath> block specifies how to get one type of information. The
866 string argument must be a valid XPath expression which returns a list
867 of "base elements". One value is dispatched for each "base element". The
868 I<type instance> and values are looked up using further I<XPath> expressions
869 that should be relative to the base element.
871 Within the B<URL> block the following options are accepted:
875 =item B<Host> I<Name>
877 Use I<Name> as the host name when submitting values. Defaults to the global
880 =item B<Instance> I<Instance>
882 Use I<Instance> as the plugin instance when submitting values. Defaults to an
883 empty string (no plugin instance).
885 =item B<User> I<User>
886 =item B<Password> I<Password>
887 =item B<VerifyPeer> B<true>|B<false>
888 =item B<VerifyHost> B<true>|B<false>
889 =item B<CACert> I<CA Cert File>
891 These options behave exactly equivalent to the appropriate options of the
892 I<cURL> and I<cURL-JSON> plugins. Please see there for a detailed description.
894 =item E<lt>B<XPath> I<XPath-expression>E<gt>
896 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
897 B<XPath> block specifies how to get one type of information. The string
898 argument must be a valid XPath expression which returns a list of "base
899 elements". One value is dispatched for each "base element".
901 Within the B<XPath> block the following options are accepted:
905 =item B<Type> I<Type>
907 Specifies the I<Type> used for submitting patches. This determines the number
908 of values that are required / expected and whether the strings are parsed as
909 signed or unsigned integer or as double values. See L<types.db(5)> for details.
910 This option is required.
912 =item B<InstancePrefix> I<InstancePrefix>
914 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
915 concatenated together without any separator.
916 This option is optional.
918 =item B<InstanceFrom> I<InstanceFrom>
920 Specifies a XPath expression to use for determining the I<type instance>. The
921 XPath expression must return exactly one element. The element's value is then
922 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
924 This value is required. As a special exception, if the "base XPath expression"
925 (the argument to the B<XPath> block) returns exactly one argument, then this
926 option may be omitted.
928 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
930 Specifies one or more XPath expression to use for reading the values. The
931 number of XPath expressions must match the number of data sources in the
932 I<type> specified with B<Type> (see above). Each XPath expression must return
933 exactly one element. The element's value is then parsed as a number and used as
934 value for the appropriate value in the value list dispatched to the daemon.
942 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
943 connect to various databases, execute I<SQL> statements and read back the
944 results. I<dbi> is an acronym for "database interface" in case you were
945 wondering about the name. You can configure how each column is to be
946 interpreted and the plugin will generate one or more data sets from each row
947 returned according to these rules.
949 Because the plugin is very generic, the configuration is a little more complex
950 than those of other plugins. It usually looks something like this:
953 <Query "out_of_stock">
954 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
955 # Use with MySQL 5.0.0 or later
959 InstancePrefix "out_of_stock"
960 InstancesFrom "category"
964 <Database "product_information">
966 DriverOption "host" "localhost"
967 DriverOption "username" "collectd"
968 DriverOption "password" "aZo6daiw"
969 DriverOption "dbname" "prod_info"
975 The configuration above defines one query with one result and one database. The
976 query is then linked to the database with the B<Query> option I<within> the
977 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
978 and you can also use the B<Include> statement to split up the configuration
979 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
980 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
983 The following is a complete list of options:
985 =head3 B<Query> blocks
987 Query blocks define I<SQL> statements and how the returned data should be
988 interpreted. They are identified by the name that is given in the opening line
989 of the block. Thus the name needs to be unique. Other than that, the name is
990 not used in collectd.
992 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
993 define which column holds which value or instance information. You can use
994 multiple B<Result> blocks to create multiple values from one returned row. This
995 is especially useful, when queries take a long time and sending almost the same
996 query again and again is not desirable.
1000 <Query "environment">
1001 Statement "select station, temperature, humidity from environment"
1004 # InstancePrefix "foo"
1005 InstancesFrom "station"
1006 ValuesFrom "temperature"
1010 InstancesFrom "station"
1011 ValuesFrom "humidity"
1015 The following options are accepted:
1019 =item B<Statement> I<SQL>
1021 Sets the statement that should be executed on the server. This is B<not>
1022 interpreted by collectd, but simply passed to the database server. Therefore,
1023 the SQL dialect that's used depends on the server collectd is connected to.
1025 The query has to return at least two columns, one for the instance and one
1026 value. You cannot omit the instance, even if the statement is guaranteed to
1027 always return exactly one line. In that case, you can usually specify something
1030 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1032 (That works with MySQL but may not be valid SQL according to the spec. If you
1033 use a more strict database server, you may have to select from a dummy table or
1036 Please note that some databases, for example B<Oracle>, will fail if you
1037 include a semicolon at the end of the statement.
1039 =item B<MinVersion> I<Version>
1041 =item B<MaxVersion> I<Value>
1043 Only use this query for the specified database version. You can use these
1044 options to provide multiple queries with the same name but with a slightly
1045 different syntax. The plugin will use only those queries, where the specified
1046 minimum and maximum versions fit the version of the database in use.
1048 The database version is determined by C<dbi_conn_get_engine_version>, see the
1049 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1050 for details. Basically, each part of the version is assumed to be in the range
1051 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1052 "40102", version "5.0.42" becomes "50042".
1054 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1055 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1056 happen. Don't to it! A valid example would be something along these lines:
1067 In the above example, there are three ranges that don't overlap. The last one
1068 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1069 before "4.0.0" are not specified.
1071 =item B<Type> I<Type>
1073 The B<type> that's used for each line returned. See L<types.db(5)> for more
1074 details on how types are defined. In short: A type is a predefined layout of
1075 data and the number of values and type of values has to match the type
1078 If you specify "temperature" here, you need exactly one gauge column. If you
1079 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1082 There must be exactly one B<Type> option inside each B<Result> block.
1084 =item B<InstancePrefix> I<prefix>
1086 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1087 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1088 all strings returned in the appropriate columns are concatenated together,
1089 separated by dashes I<("-")>.
1091 =item B<InstancesFrom> I<column0> [I<column1> ...]
1093 Specifies the columns whose values will be used to create the "type-instance"
1094 for each row. If you specify more than one column, the value of all columns
1095 will be joined together with dashes I<("-")> as separation characters.
1097 The plugin itself does not check whether or not all built instances are
1098 different. It's your responsibility to assure that each is unique. This is
1099 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1100 sure that only one row is returned in this case.
1102 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1105 =item B<ValuesFrom> I<column0> [I<column1> ...]
1107 Names the columns whose content is used as the actual data for the data sets
1108 that are dispatched to the daemon. How many such columns you need is determined
1109 by the B<Type> setting above. If you specify too many or not enough columns,
1110 the plugin will complain about that and no data will be submitted to the
1113 The actual data type in the columns is not that important. The plugin will
1114 automatically cast the values to the right type if it know how to do that. So
1115 it should be able to handle integer an floating point types, as well as strings
1116 (if they include a number at the beginning).
1118 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1122 =head3 B<Database> blocks
1124 Database blocks define a connection to a database and which queries should be
1125 sent to that database. Since the used "dbi" library can handle a wide variety
1126 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1127 documentationE<nbsp>- we stick as close to the terminology used there.
1129 Each database needs a "name" as string argument in the starting tag of the
1130 block. This name will be used as "PluginInstance" in the values submitted to
1131 the daemon. Other than that, that name is not used.
1135 =item B<Driver> I<Driver>
1137 Specifies the driver to use to connect to the database. In many cases those
1138 drivers are named after the database they can connect to, but this is not a
1139 technical necessity. These drivers are sometimes referred to as "DBD",
1140 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1141 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1142 project at L<http://libdbi-drivers.sourceforge.net/>.
1144 You need to give the driver name as expected by the "dbi" library here. You
1145 should be able to find that in the documentation for each driver. If you
1146 mistype the driver name, the plugin will dump a list of all known driver names
1149 =item B<DriverOption> I<Key> I<Value>
1151 Sets driver-specific options. What option a driver supports can be found in the
1152 documentation for each driver, somewhere at
1153 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1154 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1156 Unfortunately, drivers are not too keen to report errors when an unknown option
1157 is passed to them, so invalid settings here may go unnoticed. This is not the
1158 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1159 the driver. If a driver complains about an option, the plugin will dump a
1160 complete list of all options understood by that driver to the log.
1162 =item B<SelectDB> I<Database>
1164 In some cases, the database name you connect with is not the database name you
1165 want to use for querying data. If this option is set, the plugin will "select"
1166 (switch to) that database after the connection is established.
1168 =item B<Query> I<QueryName>
1170 Associates the query named I<QueryName> with this database connection. The
1171 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1172 blocks you want to refer to must be placed above the database block you want to
1181 =item B<Device> I<Device>
1183 Select partitions based on the devicename.
1185 =item B<MountPoint> I<Directory>
1187 Select partitions based on the mountpoint.
1189 =item B<FSType> I<FSType>
1191 Select partitions based on the filesystem type.
1193 =item B<IgnoreSelected> B<true>|B<false>
1195 Invert the selection: If set to true, all partitions B<except> the ones that
1196 match any one of the criteria are collected. By default only selected
1197 partitions are collected if a selection is made. If no selection is configured
1198 at all, B<all> partitions are selected.
1200 =item B<ReportByDevice> B<true>|B<false>
1202 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1203 (the default), it will report a disk as "root", but with it I<true>, it will be
1204 "sda1" (or whichever).
1206 =item B<ReportInodes> B<true>|B<false>
1208 Enables or disables reporting of free, reserved and used inodes. Defaults to
1209 inode collection being disabled.
1211 Enable this option if inodes are a scarce resource for you, usually because
1212 many small files are stored on the disk. This is a usual scenario for mail
1213 transfer agents and web caches.
1217 =head2 Plugin C<disk>
1219 The C<disk> plugin collects information about the usage of physical disks and
1220 logical disks (partitions). Values collected are the number of octets written
1221 to and read from a disk or partition, the number of read/write operations
1222 issued to the disk and a rather complex "time" it took for these commands to be
1225 Using the following two options you can ignore some disks or configure the
1226 collection only of specific disks.
1230 =item B<Disk> I<Name>
1232 Select the disk I<Name>. Whether it is collected or ignored depends on the
1233 B<IgnoreSelected> setting, see below. As with other plugins that use the
1234 daemon's ignorelist functionality, a string that starts and ends with a slash
1235 is interpreted as a regular expression. Examples:
1240 =item B<IgnoreSelected> B<true>|B<false>
1242 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1243 statements, are ignored or if all other disks are ignored. The behavior
1244 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1245 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1246 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1247 is set to B<true>, all disks are collected B<except> the ones matched.
1251 =head2 Plugin C<dns>
1255 =item B<Interface> I<Interface>
1257 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1258 option sets the interface that should be used. If this option is not set, or
1259 set to "any", the plugin will try to get packets from B<all> interfaces. This
1260 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1262 =item B<IgnoreSource> I<IP-address>
1264 Ignore packets that originate from this address.
1266 =item B<SelectNumericQueryTypes> B<true>|B<false>
1268 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1272 =head2 Plugin C<email>
1276 =item B<SocketFile> I<Path>
1278 Sets the socket-file which is to be created.
1280 =item B<SocketGroup> I<Group>
1282 If running as root change the group of the UNIX-socket after it has been
1283 created. Defaults to B<collectd>.
1285 =item B<SocketPerms> I<Permissions>
1287 Change the file permissions of the UNIX-socket after it has been created. The
1288 permissions must be given as a numeric, octal value as you would pass to
1289 L<chmod(1)>. Defaults to B<0770>.
1291 =item B<MaxConns> I<Number>
1293 Sets the maximum number of connections that can be handled in parallel. Since
1294 this many threads will be started immediately setting this to a very high
1295 value will waste valuable resources. Defaults to B<5> and will be forced to be
1296 at most B<16384> to prevent typos and dumb mistakes.
1300 =head2 Plugin C<ethstat>
1302 The I<ethstat plugin> collects information about network interface cards (NICs)
1303 by talking directly with the underlying kernel driver using L<ioctl(2)>.
1309 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
1310 Map "multicast" "if_multicast"
1317 =item B<Interface> I<Name>
1319 Collect statistical information about interface I<Name>.
1321 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
1323 By default, the plugin will submit values as type C<derive> and I<type
1324 instance> set to I<Name>, the name of the metric as reported by the driver. If
1325 an appropriate B<Map> option exists, the given I<Type> and, optionally,
1326 I<TypeInstance> will be used.
1328 =item B<MappedOnly> B<true>|B<false>
1330 When set to B<true>, only metrics that can be mapped to to a I<type> will be
1331 collected, all other metrics will be ignored. Defaults to B<false>.
1335 =head2 Plugin C<exec>
1337 Please make sure to read L<collectd-exec(5)> before using this plugin. It
1338 contains valuable information on when the executable is executed and the
1339 output that is expected from it.
1343 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1345 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1347 Execute the executable I<Executable> as user I<User>. If the user name is
1348 followed by a colon and a group name, the effective group is set to that group.
1349 The real group and saved-set group will be set to the default group of that
1350 user. If no group is given the effective group ID will be the same as the real
1353 Please note that in order to change the user and/or group the daemon needs
1354 superuser privileges. If the daemon is run as an unprivileged user you must
1355 specify the same user/group here. If the daemon is run with superuser
1356 privileges, you must supply a non-root user here.
1358 The executable may be followed by optional arguments that are passed to the
1359 program. Please note that due to the configuration parsing numbers and boolean
1360 values may be changed. If you want to be absolutely sure that something is
1361 passed as-is please enclose it in quotes.
1363 The B<Exec> and B<NotificationExec> statements change the semantics of the
1364 programs executed, i.E<nbsp>e. the data passed to them and the response
1365 expected from them. This is documented in great detail in L<collectd-exec(5)>.
1369 =head2 Plugin C<filecount>
1371 The C<filecount> plugin counts the number of files in a certain directory (and
1372 its subdirectories) and their combined size. The configuration is very straight
1375 <Plugin "filecount">
1376 <Directory "/var/qmail/queue/mess">
1377 Instance "qmail-message"
1379 <Directory "/var/qmail/queue/todo">
1380 Instance "qmail-todo"
1382 <Directory "/var/lib/php5">
1383 Instance "php5-sessions"
1388 The example above counts the number of files in QMail's queue directories and
1389 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
1390 QMail has not yet looked at, the "message" queue holds the messages that were
1391 classified into "local" and "remote".
1393 As you can see, the configuration consists of one or more C<Directory> blocks,
1394 each of which specifies a directory in which to count the files. Within those
1395 blocks, the following options are recognized:
1399 =item B<Instance> I<Instance>
1401 Sets the plugin instance to I<Instance>. That instance name must be unique, but
1402 it's your responsibility, the plugin doesn't check for that. If not given, the
1403 instance is set to the directory name with all slashes replaced by underscores
1404 and all leading underscores removed.
1406 =item B<Name> I<Pattern>
1408 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
1409 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
1410 against the pattern, not the entire path. In case this makes it easier for you:
1411 This option has been named after the B<-name> parameter to L<find(1)>.
1413 =item B<MTime> I<Age>
1415 Count only files of a specific age: If I<Age> is greater than zero, only files
1416 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
1417 a negative number, this is inversed. For example, if B<-60> is specified, only
1418 files that have been modified in the last minute will be counted.
1420 The number can also be followed by a "multiplier" to easily specify a larger
1421 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
1422 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
1423 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
1424 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
1425 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
1428 =item B<Size> I<Size>
1430 Count only files of a specific size. When I<Size> is a positive number, only
1431 files that are at least this big are counted. If I<Size> is a negative number,
1432 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
1433 I<Size> are counted.
1435 As with the B<MTime> option, a "multiplier" may be added. For a detailed
1436 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
1437 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
1438 note that there are 1000 bytes in a kilobyte, not 1024.
1440 =item B<Recursive> I<true>|I<false>
1442 Controls whether or not to recurse into subdirectories. Enabled by default.
1444 =item B<IncludeHidden> I<true>|I<false>
1446 Controls whether or not to include "hidden" files and directories in the count.
1447 "Hidden" files and directories are those, whose name begins with a dot.
1448 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
1452 =head2 Plugin C<GenericJMX>
1454 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
1455 L<collectd-java(5)>.
1457 =head2 Plugin C<gmond>
1459 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
1460 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
1461 are built-in, custom mappings may be added via B<Metric> blocks, see below.
1466 MCReceiveFrom "239.2.11.71" "8649"
1467 <Metric "swap_total">
1469 TypeInstance "total"
1472 <Metric "swap_free">
1479 The following metrics are built-in:
1485 load_one, load_five, load_fifteen
1489 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
1493 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
1505 Available configuration options:
1509 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
1511 Sets sets the multicast group and UDP port to which to subscribe.
1513 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
1515 =item E<lt>B<Metric> I<Name>E<gt>
1517 These blocks add a new metric conversion to the internal table. I<Name>, the
1518 string argument to the B<Metric> block, is the metric name as used by Ganglia.
1522 =item B<Type> I<Type>
1524 Type to map this metric to. Required.
1526 =item B<TypeInstance> I<Instance>
1528 Type-instance to use. Optional.
1530 =item B<DataSource> I<Name>
1532 Data source to map this metric to. If the configured type has exactly one data
1533 source, this is optional. Otherwise the option is required.
1539 =head2 Plugin C<hddtemp>
1541 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
1542 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
1543 default values, see below. C<hddtemp> has to be running to work correctly. If
1544 C<hddtemp> is not running timeouts may appear which may interfere with other
1547 The B<hddtemp> homepage can be found at
1548 L<http://www.guzu.net/linux/hddtemp.php>.
1552 =item B<Host> I<Hostname>
1554 Hostname to connect to. Defaults to B<127.0.0.1>.
1556 =item B<Port> I<Port>
1558 TCP-Port to connect to. Defaults to B<7634>.
1562 =head2 Plugin C<interface>
1566 =item B<Interface> I<Interface>
1568 Select this interface. By default these interfaces will then be collected. For
1569 a more detailed description see B<IgnoreSelected> below.
1571 =item B<IgnoreSelected> I<true>|I<false>
1573 If no configuration if given, the B<traffic>-plugin will collect data from
1574 all interfaces. This may not be practical, especially for loopback- and
1575 similar interfaces. Thus, you can use the B<Interface>-option to pick the
1576 interfaces you're interested in. Sometimes, however, it's easier/preferred
1577 to collect all interfaces I<except> a few ones. This option enables you to
1578 do that: By setting B<IgnoreSelected> to I<true> the effect of
1579 B<Interface> is inverted: All selected interfaces are ignored and all
1580 other interfaces are collected.
1584 =head2 Plugin C<ipmi>
1588 =item B<Sensor> I<Sensor>
1590 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
1592 =item B<IgnoreSelected> I<true>|I<false>
1594 If no configuration if given, the B<ipmi> plugin will collect data from all
1595 sensors found of type "temperature", "voltage", "current" and "fanspeed".
1596 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
1597 the effect of B<Sensor> is inverted: All selected sensors are ignored and
1598 all other sensors are collected.
1600 =item B<NotifySensorAdd> I<true>|I<false>
1602 If a sensor appears after initialization time of a minute a notification
1605 =item B<NotifySensorRemove> I<true>|I<false>
1607 If a sensor disappears a notification is sent.
1609 =item B<NotifySensorNotPresent> I<true>|I<false>
1611 If you have for example dual power supply and one of them is (un)plugged then
1612 a notification is sent.
1616 =head2 Plugin C<iptables>
1620 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
1622 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
1623 will collect the counters of all rules which have a comment-match. The comment
1624 is then used as type-instance.
1626 If I<Comment> or I<Number> is given, only the rule with the matching comment or
1627 the I<n>th rule will be collected. Again, the comment (or the number) will be
1628 used as the type-instance.
1630 If I<Name> is supplied, it will be used as the type-instance instead of the
1631 comment or the number.
1635 =head2 Plugin C<irq>
1641 Select this irq. By default these irqs will then be collected. For a more
1642 detailed description see B<IgnoreSelected> below.
1644 =item B<IgnoreSelected> I<true>|I<false>
1646 If no configuration if given, the B<irq>-plugin will collect data from all
1647 irqs. This may not be practical, especially if no interrupts happen. Thus, you
1648 can use the B<Irq>-option to pick the interrupt you're interested in.
1649 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
1650 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
1651 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
1652 and all other interrupts are collected.
1656 =head2 Plugin C<java>
1658 The I<Java> plugin makes it possible to write extensions for collectd in Java.
1659 This section only discusses the syntax and semantic of the configuration
1660 options. For more in-depth information on the I<Java> plugin, please read
1661 L<collectd-java(5)>.
1666 JVMArg "-verbose:jni"
1667 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
1668 LoadPlugin "org.collectd.java.Foobar"
1669 <Plugin "org.collectd.java.Foobar">
1670 # To be parsed by the plugin
1674 Available configuration options:
1678 =item B<JVMArg> I<Argument>
1680 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
1681 exactly the way the arguments to the I<java> binary on the command line work.
1682 Execute C<javaE<nbsp>--help> for details.
1684 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
1685 any other options! When another option is found, the JVM will be started and
1686 later options will have to be ignored!
1688 =item B<LoadPlugin> I<JavaClass>
1690 Instantiates a new I<JavaClass> object. The constructor of this object very
1691 likely then registers one or more callback methods with the server.
1693 See L<collectd-java(5)> for details.
1695 When the first such option is found, the virtual machine (JVM) is created. This
1696 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
1697 B<LoadPlugin> options!
1699 =item B<Plugin> I<Name>
1701 The entire block is passed to the Java plugin as an
1702 I<org.collectd.api.OConfigItem> object.
1704 For this to work, the plugin has to register a configuration callback first,
1705 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
1706 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
1707 depends on the (Java) plugin registering the callback and is completely
1708 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
1712 =head2 Plugin C<libvirt>
1714 This plugin allows CPU, disk and network load to be collected for virtualized
1715 guests on the machine. This means that these characteristics can be collected
1716 for guest systems without installing any software on them - collectd only runs
1717 on the hosting system. The statistics are collected through libvirt
1718 (L<http://libvirt.org/>).
1720 Only I<Connection> is required.
1724 =item B<Connection> I<uri>
1726 Connect to the hypervisor given by I<uri>. For example if using Xen use:
1728 Connection "xen:///"
1730 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
1732 =item B<RefreshInterval> I<seconds>
1734 Refresh the list of domains and devices every I<seconds>. The default is 60
1735 seconds. Setting this to be the same or smaller than the I<Interval> will cause
1736 the list of domains and devices to be refreshed on every iteration.
1738 Refreshing the devices in particular is quite a costly operation, so if your
1739 virtualization setup is static you might consider increasing this. If this
1740 option is set to 0, refreshing is disabled completely.
1742 =item B<Domain> I<name>
1744 =item B<BlockDevice> I<name:dev>
1746 =item B<InterfaceDevice> I<name:dev>
1748 =item B<IgnoreSelected> I<true>|I<false>
1750 Select which domains and devices are collected.
1752 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
1753 disk/network devices are collected.
1755 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
1756 domains and disk/network devices are ignored, while the rest are collected.
1758 The domain name and device names may use a regular expression, if the name is
1759 surrounded by I</.../> and collectd was compiled with support for regexps.
1761 The default is to collect statistics for all domains and all their devices.
1765 BlockDevice "/:hdb/"
1766 IgnoreSelected "true"
1768 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
1771 =item B<HostnameFormat> B<name|uuid|hostname|...>
1773 When the libvirt plugin logs data, it sets the hostname of the collected data
1774 according to this setting. The default is to use the guest name as provided by
1775 the hypervisor, which is equal to setting B<name>.
1777 B<uuid> means use the guest's UUID. This is useful if you want to track the
1778 same guest across migrations.
1780 B<hostname> means to use the global B<Hostname> setting, which is probably not
1781 useful on its own because all guests will appear to have the same name.
1783 You can also specify combinations of these fields. For example B<name uuid>
1784 means to concatenate the guest name and UUID (with a literal colon character
1785 between, thus I<"foo:1234-1234-1234-1234">).
1787 =item B<InterfaceFormat> B<name>|B<address>
1789 When the libvirt plugin logs interface data, it sets the name of the collected
1790 data according to this setting. The default is to use the path as provided by
1791 the hypervisor (the "dev" property of the target node), which is equal to
1794 B<address> means use the interface's mac address. This is useful since the
1795 interface path might change between reboots of a guest or across migrations.
1799 =head2 Plugin C<logfile>
1803 =item B<LogLevel> B<debug|info|notice|warning|err>
1805 Sets the log-level. If, for example, set to B<notice>, then all events with
1806 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
1808 Please note that B<debug> is only available if collectd has been compiled with
1811 =item B<File> I<File>
1813 Sets the file to write log messages to. The special strings B<stdout> and
1814 B<stderr> can be used to write to the standard output and standard error
1815 channels, respectively. This, of course, only makes much sense when I<collectd>
1816 is running in foreground- or non-daemon-mode.
1818 =item B<Timestamp> B<true>|B<false>
1820 Prefix all lines printed by the current time. Defaults to B<true>.
1822 =item B<PrintSeverity> B<true>|B<false>
1824 When enabled, all lines are prefixed by the severity of the log message, for
1825 example "warning". Defaults to B<false>.
1829 B<Note>: There is no need to notify the daemon after moving or removing the
1830 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
1831 for each line it writes.
1833 =head2 Plugin C<lpar>
1835 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
1836 virtualization technique for IBM POWER processors. It takes into account CPU
1837 time stolen from or donated to a partition, in addition to the usual user,
1838 system, I/O statistics.
1840 The following configuration options are available:
1844 =item B<CpuPoolStats> B<false>|B<true>
1846 When enabled, statistics about the processor pool are read, too. The partition
1847 needs to have pool authority in order to be able to acquire this information.
1850 =item B<ReportBySerial> B<false>|B<true>
1852 If enabled, the serial of the physical machine the partition is currently
1853 running on is reported as I<hostname> and the logical hostname of the machine
1854 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
1855 used (just like other plugins) and the I<plugin instance> will be empty.
1860 =head2 Plugin C<mbmon>
1862 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
1864 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
1865 B<Host> and B<Port> options can be used to change these values, see below.
1866 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
1867 timeouts may appear which may interfere with other statistics..
1869 C<mbmon> must be run with the -r option ("print TAG and Value format");
1870 Debian's F</etc/init.d/mbmon> script already does this, other people
1871 will need to ensure that this is the case.
1875 =item B<Host> I<Hostname>
1877 Hostname to connect to. Defaults to B<127.0.0.1>.
1879 =item B<Port> I<Port>
1881 TCP-Port to connect to. Defaults to B<411>.
1887 The C<md plugin> collects information from Linux Software-RAID devices (md).
1889 All reported values are of the type C<md_disks>. Reported type instances are
1890 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
1891 I<missing> (physically absent) disks.
1895 =item B<Device> I<Device>
1897 Select md devices based on device name. The I<device name> is the basename of
1898 the device, i.e. the name of the block device without the leading C</dev/>.
1899 See B<IgnoreSelected> for more details.
1901 =item B<IgnoreSelected> B<true>|B<false>
1903 Invert device selection: If set to B<true>, all md devices B<except> those
1904 listed using B<Device> are collected. If B<false> (the default), only those
1905 listed are collected. If no configuration is given, the B<md> plugin will
1906 collect data from all md devices.
1910 =head2 Plugin C<memcachec>
1912 The C<memcachec plugin> connects to a memcached server, queries one or more
1913 given I<pages> and parses the returned data according to user specification.
1914 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
1917 In order to talk to the memcached server, this plugin uses the I<libmemcached>
1918 library. Please note that there is another library with a very similar name,
1919 libmemcache (notice the missing `d'), which is not applicable.
1921 Synopsis of the configuration:
1923 <Plugin "memcachec">
1924 <Page "plugin_instance">
1928 Regex "(\\d+) bytes sent"
1931 Instance "type_instance"
1936 The configuration options are:
1940 =item E<lt>B<Page> I<Name>E<gt>
1942 Each B<Page> block defines one I<page> to be queried from the memcached server.
1943 The block requires one string argument which is used as I<plugin instance>.
1945 =item B<Server> I<Address>
1947 Sets the server address to connect to when querying the page. Must be inside a
1952 When connected to the memcached server, asks for the page I<Key>.
1954 =item E<lt>B<Match>E<gt>
1956 Match blocks define which strings to look for and how matches substrings are
1957 interpreted. For a description of match blocks, please see L<"Plugin tail">.
1961 =head2 Plugin C<memcached>
1963 The C<memcached plugin> connects to a memcached server and queries statistics
1964 about cache utilization, memory and bandwidth used.
1965 L<http://www.danga.com/memcached/>
1969 =item B<Host> I<Hostname>
1971 Hostname to connect to. Defaults to B<127.0.0.1>.
1973 =item B<Port> I<Port>
1975 TCP-Port to connect to. Defaults to B<11211>.
1979 =head2 Plugin C<modbus>
1981 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
1982 register values. It supports reading single registers (unsigned 16E<nbsp>bit
1983 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
1984 values (two registers interpreted as IEEE floats in big endian notation).
1988 <Data "voltage-input-1">
1995 <Data "voltage-input-2">
2002 <Host "modbus.example.com">
2003 Address "192.168.0.42"
2008 Instance "power-supply"
2009 Collect "voltage-input-1"
2010 Collect "voltage-input-2"
2016 =item E<lt>B<Data> I<Name>E<gt> blocks
2018 Data blocks define a mapping between register numbers and the "types" used by
2021 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
2025 =item B<RegisterBase> I<Number>
2027 Configures the base register to read from the device. If the option
2028 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
2029 register will be read (the register number is increased by one).
2031 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
2033 Specifies what kind of data is returned by the device. If the type is B<Int32>,
2034 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
2035 combined into one value. Defaults to B<Uint16>.
2037 =item B<Type> I<Type>
2039 Specifies the "type" (data set) to use when dispatching the value to
2040 I<collectd>. Currently, only data sets with exactly one data source are
2043 =item B<Instance> I<Instance>
2045 Sets the type instance to use when dispatching the value to I<collectd>. If
2046 unset, an empty string (no type instance) is used.
2050 =item E<lt>B<Host> I<Name>E<gt> blocks
2052 Host blocks are used to specify to which hosts to connect and what data to read
2053 from their "slaves". The string argument I<Name> is used as hostname when
2054 dispatching the values to I<collectd>.
2056 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
2060 =item B<Address> I<Hostname>
2062 Specifies the node name (the actual network address) used to connect to the
2063 host. This may be an IP address or a hostname. Please note that the used
2064 I<libmodbus> library only supports IPv4 at the moment.
2066 =item B<Port> I<Service>
2068 Specifies the port used to connect to the host. The port can either be given as
2069 a number or as a service name. Please note that the I<Service> argument must be
2070 a string, even if ports are given in their numerical form. Defaults to "502".
2072 =item B<Interval> I<Interval>
2074 Sets the interval (in seconds) in which the values will be collected from this
2075 host. By default the global B<Interval> setting will be used.
2077 =item E<lt>B<Slave> I<ID>E<gt>
2079 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
2080 is used to specify which device should be addressed. For each device you want
2081 to query, one B<Slave> block must be given.
2083 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
2087 =item B<Instance> I<Instance>
2089 Specify the plugin instance to use when dispatching the values to I<collectd>.
2090 By default "slave_I<ID>" is used.
2092 =item B<Collect> I<DataName>
2094 Specifies which data to retrieve from the device. I<DataName> must be the same
2095 string as the I<Name> argument passed to a B<Data> block. You can specify this
2096 option multiple times to collect more than one value from a slave. At least one
2097 B<Collect> option is mandatory.
2105 =head2 Plugin C<mysql>
2107 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
2108 one or more databases when started and keeps the connection up as long as
2109 possible. When the connection is interrupted for whatever reason it will try
2110 to re-connect. The plugin will complain loudly in case anything goes wrong.
2112 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
2113 and collects information about MySQL network traffic, executed statements,
2114 requests, the query cache and threads by evaluating the
2115 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
2116 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
2117 Status Variables> for an explanation of these values.
2119 Optionally, master and slave statistics may be collected in a MySQL
2120 replication setup. In that case, information about the synchronization state
2121 of the nodes are collected by evaluating the C<Position> return value of the
2122 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
2123 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
2124 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
2125 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
2126 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
2141 Socket "/var/run/mysql/mysqld.sock"
2143 SlaveNotifications true
2147 A B<Database> block defines one connection to a MySQL database. It accepts a
2148 single argument which specifies the name of the database. None of the other
2149 options are required. MySQL will use default values as documented in the
2150 section "mysql_real_connect()" in the B<MySQL reference manual>.
2154 =item B<Host> I<Hostname>
2156 Hostname of the database server. Defaults to B<localhost>.
2158 =item B<User> I<Username>
2160 Username to use when connecting to the database. The user does not have to be
2161 granted any privileges (which is synonym to granting the C<USAGE> privilege),
2162 unless you want to collectd replication statistics (see B<MasterStats> and
2163 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
2164 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
2166 =item B<Password> I<Password>
2168 Password needed to log into the database.
2170 =item B<Database> I<Database>
2172 Select this database. Defaults to I<no database> which is a perfectly reasonable
2173 option for what this plugin does.
2175 =item B<Port> I<Port>
2177 TCP-port to connect to. The port must be specified in its numeric form, but it
2178 must be passed as a string nonetheless. For example:
2182 If B<Host> is set to B<localhost> (the default), this setting has no effect.
2183 See the documentation for the C<mysql_real_connect> function for details.
2185 =item B<Socket> I<Socket>
2187 Specifies the path to the UNIX domain socket of the MySQL server. This option
2188 only has any effect, if B<Host> is set to B<localhost> (the default).
2189 Otherwise, use the B<Port> option above. See the documentation for the
2190 C<mysql_real_connect> function for details.
2192 =item B<MasterStats> I<true|false>
2194 =item B<SlaveStats> I<true|false>
2196 Enable the collection of master / slave statistics in a replication setup. In
2197 order to be able to get access to these statistics, the user needs special
2198 privileges. See the B<User> documentation above.
2200 =item B<SlaveNotifications> I<true|false>
2202 If enabled, the plugin sends a notification if the replication slave I/O and /
2203 or SQL threads are not running.
2207 =head2 Plugin C<netapp>
2209 The netapp plugin can collect various performance and capacity information
2210 from a NetApp filer using the NetApp API.
2212 Please note that NetApp has a wide line of products and a lot of different
2213 software versions for each of these products. This plugin was developed for a
2214 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
2215 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
2216 model and software version but it is very hard to test this.
2217 If you have used this plugin with other models and/or software version, feel
2218 free to send us a mail to tell us about the results, even if it's just a short
2221 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
2222 basic authentication.
2224 B<Do not use a regular user for this!> Create a special collectd user with just
2225 the minimum of capabilities needed. The user only needs the "login-http-admin"
2226 capability as well as a few more depending on which data will be collected.
2227 Required capabilities are documented below.
2232 <Host "netapp1.example.com">
2256 IgnoreSelectedIO false
2258 IgnoreSelectedOps false
2259 GetLatency "volume0"
2260 IgnoreSelectedLatency false
2267 IgnoreSelectedCapacity false
2270 IgnoreSelectedSnapshot false
2283 The netapp plugin accepts the following configuration options:
2287 =item B<Host> I<Name>
2289 A host block defines one NetApp filer. It will appear in collectd with the name
2290 you specify here which does not have to be its real name nor its hostname.
2292 =item B<Protocol> B<httpd>|B<http>
2294 The protocol collectd will use to query this host.
2302 Valid options: http, https
2304 =item B<Address> I<Address>
2306 The hostname or IP address of the host.
2312 Default: The "host" block's name.
2314 =item B<Port> I<Port>
2316 The TCP port to connect to on the host.
2322 Default: 80 for protocol "http", 443 for protocol "https"
2324 =item B<User> I<User>
2326 =item B<Password> I<Password>
2328 The username and password to use to login to the NetApp.
2334 =item B<Interval> I<Interval>
2340 The following options decide what kind of data will be collected. You can
2341 either use them as a block and fine tune various parameters inside this block,
2342 use them as a single statement to just accept all default values, or omit it to
2343 not collect any data.
2345 The following options are valid inside all blocks:
2349 =item B<Interval> I<Seconds>
2351 Collect the respective statistics every I<Seconds> seconds. Defaults to the
2352 host specific setting.
2356 =head3 The System block
2358 This will collect various performance data about the whole system.
2360 B<Note:> To get this data the collectd user needs the
2361 "api-perf-object-get-instances" capability.
2365 =item B<Interval> I<Seconds>
2367 Collect disk statistics every I<Seconds> seconds.
2369 =item B<GetCPULoad> B<true>|B<false>
2371 If you set this option to true the current CPU usage will be read. This will be
2372 the average usage between all CPUs in your NetApp without any information about
2375 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2376 returns in the "CPU" field.
2384 Result: Two value lists of type "cpu", and type instances "idle" and "system".
2386 =item B<GetInterfaces> B<true>|B<false>
2388 If you set this option to true the current traffic of the network interfaces
2389 will be read. This will be the total traffic over all interfaces of your NetApp
2390 without any information about individual interfaces.
2392 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2393 in the "Net kB/s" field.
2403 Result: One value list of type "if_octects".
2405 =item B<GetDiskIO> B<true>|B<false>
2407 If you set this option to true the current IO throughput will be read. This
2408 will be the total IO of your NetApp without any information about individual
2409 disks, volumes or aggregates.
2411 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2412 in the "DiskE<nbsp>kB/s" field.
2420 Result: One value list of type "disk_octets".
2422 =item B<GetDiskOps> B<true>|B<false>
2424 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
2425 iSCSI, etc. operations will be read. This will be the total number of
2426 operations on your NetApp without any information about individual volumes or
2429 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2430 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
2438 Result: A variable number of value lists of type "disk_ops_complex". Each type
2439 of operation will result in one value list with the name of the operation as
2444 =head3 The WAFL block
2446 This will collect various performance data about the WAFL file system. At the
2447 moment this just means cache performance.
2449 B<Note:> To get this data the collectd user needs the
2450 "api-perf-object-get-instances" capability.
2452 B<Note:> The interface to get these values is classified as "Diagnostics" by
2453 NetApp. This means that it is not guaranteed to be stable even between minor
2458 =item B<Interval> I<Seconds>
2460 Collect disk statistics every I<Seconds> seconds.
2462 =item B<GetNameCache> B<true>|B<false>
2470 Result: One value list of type "cache_ratio" and type instance
2473 =item B<GetDirCache> B<true>|B<false>
2481 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
2483 =item B<GetInodeCache> B<true>|B<false>
2491 Result: One value list of type "cache_ratio" and type instance
2494 =item B<GetBufferCache> B<true>|B<false>
2496 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
2497 in the "Cache hit" field.
2505 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
2509 =head3 The Disks block
2511 This will collect performance data about the individual disks in the NetApp.
2513 B<Note:> To get this data the collectd user needs the
2514 "api-perf-object-get-instances" capability.
2518 =item B<Interval> I<Seconds>
2520 Collect disk statistics every I<Seconds> seconds.
2522 =item B<GetBusy> B<true>|B<false>
2524 If you set this option to true the busy time of all disks will be calculated
2525 and the value of the busiest disk in the system will be written.
2527 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2528 in the "Disk util" field. Probably.
2536 Result: One value list of type "percent" and type instance "disk_busy".
2540 =head3 The VolumePerf block
2542 This will collect various performance data about the individual volumes.
2544 You can select which data to collect about which volume using the following
2545 options. They follow the standard ignorelist semantic.
2547 B<Note:> To get this data the collectd user needs the
2548 I<api-perf-object-get-instances> capability.
2552 =item B<Interval> I<Seconds>
2554 Collect volume performance data every I<Seconds> seconds.
2556 =item B<GetIO> I<Volume>
2558 =item B<GetOps> I<Volume>
2560 =item B<GetLatency> I<Volume>
2562 Select the given volume for IO, operations or latency statistics collection.
2563 The argument is the name of the volume without the C</vol/> prefix.
2565 Since the standard ignorelist functionality is used here, you can use a string
2566 starting and ending with a slash to specify regular expression matching: To
2567 match the volumes "vol0", "vol2" and "vol7", you can use this regular
2570 GetIO "/^vol[027]$/"
2572 If no regular expression is specified, an exact match is required. Both,
2573 regular and exact matching are case sensitive.
2575 If no volume was specified at all for either of the three options, that data
2576 will be collected for all available volumes.
2578 =item B<IgnoreSelectedIO> B<true>|B<false>
2580 =item B<IgnoreSelectedOps> B<true>|B<false>
2582 =item B<IgnoreSelectedLatency> B<true>|B<false>
2584 When set to B<true>, the volumes selected for IO, operations or latency
2585 statistics collection will be ignored and the data will be collected for all
2588 When set to B<false>, data will only be collected for the specified volumes and
2589 all other volumes will be ignored.
2591 If no volumes have been specified with the above B<Get*> options, all volumes
2592 will be collected regardless of the B<IgnoreSelected*> option.
2594 Defaults to B<false>
2598 =head3 The VolumeUsage block
2600 This will collect capacity data about the individual volumes.
2602 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
2607 =item B<Interval> I<Seconds>
2609 Collect volume usage statistics every I<Seconds> seconds.
2611 =item B<GetCapacity> I<VolumeName>
2613 The current capacity of the volume will be collected. This will result in two
2614 to four value lists, depending on the configuration of the volume. All data
2615 sources are of type "df_complex" with the name of the volume as
2618 There will be type_instances "used" and "free" for the number of used and
2619 available bytes on the volume. If the volume has some space reserved for
2620 snapshots, a type_instance "snap_reserved" will be available. If the volume
2621 has SIS enabled, a type_instance "sis_saved" will be available. This is the
2622 number of bytes saved by the SIS feature.
2624 B<Note:> The current NetApp API has a bug that results in this value being
2625 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
2626 number which works most of the time. If you see strange values here, bug
2627 NetApp support to fix this.
2629 Repeat this option to specify multiple volumes.
2631 =item B<IgnoreSelectedCapacity> B<true>|B<false>
2633 Specify whether to collect only the volumes selected by the B<GetCapacity>
2634 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
2635 B<false>. However, if no B<GetCapacity> option is specified at all, all
2636 capacities will be selected anyway.
2638 =item B<GetSnapshot> I<VolumeName>
2640 Select volumes from which to collect snapshot information.
2642 Usually, the space used for snapshots is included in the space reported as
2643 "used". If snapshot information is collected as well, the space used for
2644 snapshots is subtracted from the used space.
2646 To make things even more interesting, it is possible to reserve space to be
2647 used for snapshots. If the space required for snapshots is less than that
2648 reserved space, there is "reserved free" and "reserved used" space in addition
2649 to "free" and "used". If the space required for snapshots exceeds the reserved
2650 space, that part allocated in the normal space is subtracted from the "used"
2653 Repeat this option to specify multiple volumes.
2655 =item B<IgnoreSelectedSnapshot>
2657 Specify whether to collect only the volumes selected by the B<GetSnapshot>
2658 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
2659 B<false>. However, if no B<GetSnapshot> option is specified at all, all
2660 capacities will be selected anyway.
2664 =head2 Plugin C<netlink>
2666 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
2667 statistics of various interface and routing aspects.
2671 =item B<Interface> I<Interface>
2673 =item B<VerboseInterface> I<Interface>
2675 Instruct the plugin to collect interface statistics. This is basically the same
2676 as the statistics provided by the C<interface> plugin (see above) but
2677 potentially much more detailed.
2679 When configuring with B<Interface> only the basic statistics will be collected,
2680 namely octets, packets, and errors. These statistics are collected by
2681 the C<interface> plugin, too, so using both at the same time is no benefit.
2683 When configured with B<VerboseInterface> all counters B<except> the basic ones,
2684 so that no data needs to be collected twice if you use the C<interface> plugin.
2685 This includes dropped packets, received multicast packets, collisions and a
2686 whole zoo of differentiated RX and TX errors. You can try the following command
2687 to get an idea of what awaits you:
2691 If I<Interface> is B<All>, all interfaces will be selected.
2693 =item B<QDisc> I<Interface> [I<QDisc>]
2695 =item B<Class> I<Interface> [I<Class>]
2697 =item B<Filter> I<Interface> [I<Filter>]
2699 Collect the octets and packets that pass a certain qdisc, class or filter.
2701 QDiscs and classes are identified by their type and handle (or classid).
2702 Filters don't necessarily have a handle, therefore the parent's handle is used.
2703 The notation used in collectd differs from that used in tc(1) in that it
2704 doesn't skip the major or minor number if it's zero and doesn't print special
2705 ids by their name. So, for example, a qdisc may be identified by
2706 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
2707 thus not displayed by tc(1).
2709 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
2710 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
2711 associated with that interface will be collected.
2713 Since a filter itself doesn't necessarily have a handle, the parent's handle is
2714 used. This may lead to problems when more than one filter is attached to a
2715 qdisc or class. This isn't nice, but we don't know how this could be done any
2716 better. If you have a idea, please don't hesitate to tell us.
2718 As with the B<Interface> option you can specify B<All> as the interface,
2719 meaning all interfaces.
2721 Here are some examples to help you understand the above text more easily:
2724 VerboseInterface "All"
2725 QDisc "eth0" "pfifo_fast-1:0"
2727 Class "ppp0" "htb-1:10"
2728 Filter "ppp0" "u32-1:0"
2731 =item B<IgnoreSelected>
2733 The behavior is the same as with all other similar plugins: If nothing is
2734 selected at all, everything is collected. If some things are selected using the
2735 options described above, only these statistics are collected. If you set
2736 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
2737 specified statistics will not be collected.
2741 =head2 Plugin C<network>
2743 The Network plugin sends data to a remote instance of collectd, receives data
2744 from a remote instance, or both at the same time. Data which has been received
2745 from the network is usually not transmitted again, but this can be activated, see
2746 the B<Forward> option below.
2748 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
2749 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
2751 Both, B<Server> and B<Listen> can be used as single option or as block. When
2752 used as block, given options are valid for this socket only. The following
2753 example will export the metrics twice: Once to an "internal" server (without
2754 encryption and signing) and one to an external server (with cryptographic
2758 # Export to an internal server
2759 # (demonstrates usage without additional options)
2760 Server "collectd.internal.tld"
2762 # Export to an external server
2763 # (demonstrates usage with signature options)
2764 <Server "collectd.external.tld">
2765 SecurityLevel "sign"
2766 Username "myhostname"
2773 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
2775 The B<Server> statement/block sets the server to send datagrams to. The
2776 statement may occur multiple times to send each datagram to multiple
2779 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
2780 optional second argument specifies a port number or a service name. If not
2781 given, the default, B<25826>, is used.
2783 The following options are recognized within B<Server> blocks:
2787 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
2789 Set the security you require for network communication. When the security level
2790 has been set to B<Encrypt>, data sent over the network will be encrypted using
2791 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
2792 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
2793 authentication code. When set to B<None>, data is sent without any security.
2795 This feature is only available if the I<network> plugin was linked with
2798 =item B<Username> I<Username>
2800 Sets the username to transmit. This is used by the server to lookup the
2801 password. See B<AuthFile> below. All security levels except B<None> require
2804 This feature is only available if the I<network> plugin was linked with
2807 =item B<Password> I<Password>
2809 Sets a password (shared secret) for this socket. All security levels except
2810 B<None> require this setting.
2812 This feature is only available if the I<network> plugin was linked with
2815 =item B<Interface> I<Interface name>
2817 Set the outgoing interface for IP packets. This applies at least
2818 to IPv6 packets and if possible to IPv4. If this option is not applicable,
2819 undefined or a non-existent interface name is specified, the default
2820 behavior is to let the kernel choose the appropriate interface. Be warned
2821 that the manual selection of an interface for unicast traffic is only
2822 necessary in rare cases.
2826 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
2828 The B<Listen> statement sets the interfaces to bind to. When multiple
2829 statements are found the daemon will bind to multiple interfaces.
2831 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
2832 the argument is a multicast address the daemon will join that multicast group.
2833 The optional second argument specifies a port number or a service name. If not
2834 given, the default, B<25826>, is used.
2836 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
2840 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
2842 Set the security you require for network communication. When the security level
2843 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
2844 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
2845 signed and encrypted data is accepted. When set to B<None>, all data will be
2846 accepted. If an B<AuthFile> option was given (see below), encrypted data is
2847 decrypted if possible.
2849 This feature is only available if the I<network> plugin was linked with
2852 =item B<AuthFile> I<Filename>
2854 Sets a file in which usernames are mapped to passwords. These passwords are
2855 used to verify signatures and to decrypt encrypted network packets. If
2856 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
2857 verified and encrypted packets are decrypted. Otherwise, signed data is
2858 accepted without checking the signature and encrypted data cannot be decrypted.
2859 For the other security levels this option is mandatory.
2861 The file format is very simple: Each line consists of a username followed by a
2862 colon and any number of spaces followed by the password. To demonstrate, an
2863 example file could look like this:
2868 Each time a packet is received, the modification time of the file is checked
2869 using L<stat(2)>. If the file has been changed, the contents is re-read. While
2870 the file is being read, it is locked using L<fcntl(2)>.
2872 =item B<Interface> I<Interface name>
2874 Set the incoming interface for IP packets explicitly. This applies at least
2875 to IPv6 packets and if possible to IPv4. If this option is not applicable,
2876 undefined or a non-existent interface name is specified, the default
2877 behavior is, to let the kernel choose the appropriate interface. Thus incoming
2878 traffic gets only accepted, if it arrives on the given interface.
2882 =item B<TimeToLive> I<1-255>
2884 Set the time-to-live of sent packets. This applies to all, unicast and
2885 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
2886 That means that multicast packets will be sent with a TTL of C<1> (one) on most
2889 =item B<MaxPacketSize> I<1024-65535>
2891 Set the maximum size for datagrams received over the network. Packets larger
2892 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
2893 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
2896 On the server side, this limit should be set to the largest value used on
2897 I<any> client. Likewise, the value on the client must not be larger than the
2898 value on the server, or data will be lost.
2900 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
2901 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
2902 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
2905 =item B<Forward> I<true|false>
2907 If set to I<true>, write packets that were received via the network plugin to
2908 the sending sockets. This should only be activated when the B<Listen>- and
2909 B<Server>-statements differ. Otherwise packets may be send multiple times to
2910 the same multicast group. While this results in more network traffic than
2911 necessary it's not a huge problem since the plugin has a duplicate detection,
2912 so the values will not loop.
2914 =item B<ReportStats> B<true>|B<false>
2916 The network plugin cannot only receive and send statistics, it can also create
2917 statistics about itself. Collected data included the number of received and
2918 sent octets and packets, the length of the receive queue and the number of
2919 values handled. When set to B<true>, the I<Network plugin> will make these
2920 statistics available. Defaults to B<false>.
2924 =head2 Plugin C<nginx>
2926 This plugin collects the number of connections and requests handled by the
2927 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
2928 queries the page provided by the C<ngx_http_stub_status_module> module, which
2929 isn't compiled by default. Please refer to
2930 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
2931 how to compile and configure nginx and this module.
2933 The following options are accepted by the C<nginx plugin>:
2937 =item B<URL> I<http://host/nginx_status>
2939 Sets the URL of the C<ngx_http_stub_status_module> output.
2941 =item B<User> I<Username>
2943 Optional user name needed for authentication.
2945 =item B<Password> I<Password>
2947 Optional password needed for authentication.
2949 =item B<VerifyPeer> B<true|false>
2951 Enable or disable peer SSL certificate verification. See
2952 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
2954 =item B<VerifyHost> B<true|false>
2956 Enable or disable peer host name verification. If enabled, the plugin checks
2957 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
2958 certificate matches the host name provided by the B<URL> option. If this
2959 identity check fails, the connection is aborted. Obviously, only works when
2960 connecting to a SSL enabled server. Enabled by default.
2962 =item B<CACert> I<File>
2964 File that holds one or more SSL certificates. If you want to use HTTPS you will
2965 possibly need this option. What CA certificates come bundled with C<libcurl>
2966 and are checked by default depends on the distribution you use.
2970 =head2 Plugin C<notify_desktop>
2972 This plugin sends a desktop notification to a notification daemon, as defined
2973 in the Desktop Notification Specification. To actually display the
2974 notifications, B<notification-daemon> is required and B<collectd> has to be
2975 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
2976 environment variables have to be set correctly) and the D-Bus message bus.
2978 The Desktop Notification Specification can be found at
2979 L<http://www.galago-project.org/specs/notification/>.
2983 =item B<OkayTimeout> I<timeout>
2985 =item B<WarningTimeout> I<timeout>
2987 =item B<FailureTimeout> I<timeout>
2989 Set the I<timeout>, in milliseconds, after which to expire the notification
2990 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
2991 been specified, the displayed notification will not be closed at all - the
2992 user has to do so herself. These options default to 5000. If a negative number
2993 has been specified, the default is used as well.
2997 =head2 Plugin C<notify_email>
2999 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
3000 configured email address.
3002 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
3004 Available configuration options:
3008 =item B<From> I<Address>
3010 Email address from which the emails should appear to come from.
3012 Default: C<root@localhost>
3014 =item B<Recipient> I<Address>
3016 Configures the email address(es) to which the notifications should be mailed.
3017 May be repeated to send notifications to multiple addresses.
3019 At least one B<Recipient> must be present for the plugin to work correctly.
3021 =item B<SMTPServer> I<Hostname>
3023 Hostname of the SMTP server to connect to.
3025 Default: C<localhost>
3027 =item B<SMTPPort> I<Port>
3029 TCP port to connect to.
3033 =item B<SMTPUser> I<Username>
3035 Username for ASMTP authentication. Optional.
3037 =item B<SMTPPassword> I<Password>
3039 Password for ASMTP authentication. Optional.
3041 =item B<Subject> I<Subject>
3043 Subject-template to use when sending emails. There must be exactly two
3044 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
3045 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
3048 Default: C<Collectd notify: %s@%s>
3052 =head2 Plugin C<ntpd>
3056 =item B<Host> I<Hostname>
3058 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
3060 =item B<Port> I<Port>
3062 UDP-Port to connect to. Defaults to B<123>.
3064 =item B<ReverseLookups> B<true>|B<false>
3066 Sets whether or not to perform reverse lookups on peers. Since the name or
3067 IP-address may be used in a filename it is recommended to disable reverse
3068 lookups. The default is to do reverse lookups to preserve backwards
3069 compatibility, though.
3073 =head2 Plugin C<nut>
3077 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
3079 Add a UPS to collect data from. The format is identical to the one accepted by
3084 =head2 Plugin C<olsrd>
3086 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
3087 the Optimized Link State Routing daemon and reads information about the current
3088 state of the meshed network.
3090 The following configuration options are understood:
3094 =item B<Host> I<Host>
3096 Connect to I<Host>. Defaults to B<"localhost">.
3098 =item B<Port> I<Port>
3100 Specifies the port to connect to. This must be a string, even if you give the
3101 port as a number rather than a service name. Defaults to B<"2006">.
3103 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
3105 Specifies what information to collect about links, i.E<nbsp>e. direct
3106 connections of the daemon queried. If set to B<No>, no information is
3107 collected. If set to B<Summary>, the number of links and the average of all
3108 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
3109 If set to B<Detail> LQ and NLQ are collected per link.
3111 Defaults to B<Detail>.
3113 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
3115 Specifies what information to collect about routes of the daemon queried. If
3116 set to B<No>, no information is collected. If set to B<Summary>, the number of
3117 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
3118 metric and ETX are collected per route.
3120 Defaults to B<Summary>.
3122 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
3124 Specifies what information to collect about the global topology. If set to
3125 B<No>, no information is collected. If set to B<Summary>, the number of links
3126 in the entire topology and the average I<link quality> (LQ) is calculated.
3127 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
3129 Defaults to B<Summary>.
3133 =head2 Plugin C<onewire>
3135 B<EXPERIMENTAL!> See notes below.
3137 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
3138 L<http://owfs.org/> to read sensors connected via the onewire bus.
3140 Currently only temperature sensors (sensors with the family code C<10>,
3141 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
3142 would like to have included, please send a sort request to the mailing list.
3144 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
3145 experimental, below.
3149 =item B<Device> I<Device>
3151 Sets the device to read the values from. This can either be a "real" hardware
3152 device, such as a serial port or an USB port, or the address of the
3153 L<owserver(1)> socket, usually B<localhost:4304>.
3155 Though the documentation claims to automatically recognize the given address
3156 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
3157 with that version, the following configuration worked for us:
3160 Device "-s localhost:4304"
3163 This directive is B<required> and does not have a default value.
3165 =item B<Sensor> I<Sensor>
3167 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
3168 below. Sensors are specified without the family byte at the beginning, to you'd
3169 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
3172 =item B<IgnoreSelected> I<true>|I<false>
3174 If no configuration if given, the B<onewire> plugin will collect data from all
3175 sensors found. This may not be practical, especially if sensors are added and
3176 removed regularly. Sometimes, however, it's easier/preferred to collect only
3177 specific sensors or all sensors I<except> a few specified ones. This option
3178 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
3179 B<Sensor> is inverted: All selected interfaces are ignored and all other
3180 interfaces are collected.
3182 =item B<Interval> I<Seconds>
3184 Sets the interval in which all sensors should be read. If not specified, the
3185 global B<Interval> setting is used.
3189 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
3190 work with big setups. It works with one sensor being attached to one
3191 controller, but as soon as you throw in a couple more senors and maybe a hub
3192 or two, reading all values will take more than ten seconds (the default
3193 interval). We will probably add some separate thread for reading the sensors
3194 and some cache or something like that, but it's not done yet. We will try to
3195 maintain backwards compatibility in the future, but we can't promise. So in
3196 short: If it works for you: Great! But keep in mind that the config I<might>
3197 change, though this is unlikely. Oh, and if you want to help improving this
3198 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
3200 =head2 Plugin C<openvpn>
3202 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
3203 traffic statistics about connected clients.
3205 To set up OpenVPN to write to the status file periodically, use the
3206 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
3207 you need to set the required format, too. This is done by setting
3208 B<--status-version> to B<2>.
3210 So, in a nutshell you need:
3212 openvpn $OTHER_OPTIONS \
3213 --status "/var/run/openvpn-status" 10 \
3220 =item B<StatusFile> I<File>
3222 Specifies the location of the status file.
3224 =item B<ImprovedNamingSchema> B<true>|B<false>
3226 When enabled, the filename of the status file will be used as plugin instance
3227 and the client's "common name" will be used as type instance. This is required
3228 when reading multiple status files. Enabling this option is recommended, but to
3229 maintain backwards compatibility this option is disabled by default.
3231 =item B<CollectCompression> B<true>|B<false>
3233 Sets whether or not statistics about the compression used by OpenVPN should be
3234 collected. This information is only available in I<single> mode. Enabled by
3237 =item B<CollectIndividualUsers> B<true>|B<false>
3239 Sets whether or not traffic information is collected for each connected client
3240 individually. If set to false, currently no traffic data is collected at all
3241 because aggregating this data in a save manner is tricky. Defaults to B<true>.
3243 =item B<CollectUserCount> B<true>|B<false>
3245 When enabled, the number of currently connected clients or users is collected.
3246 This is especially interesting when B<CollectIndividualUsers> is disabled, but
3247 can be configured independently from that option. Defaults to B<false>.
3251 =head2 Plugin C<oracle>
3253 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
3254 Oracle® Database and lets you execute SQL statements there. It is very similar
3255 to the "dbi" plugin, because it was written around the same time. See the "dbi"
3256 plugin's documentation above for details.
3259 <Query "out_of_stock">
3260 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
3263 # InstancePrefix "foo"
3264 InstancesFrom "category"
3268 <Database "product_information">
3272 Query "out_of_stock"
3276 =head3 B<Query> blocks
3278 The Query blocks are handled identically to the Query blocks of the "dbi"
3279 plugin. Please see its documentation above for details on how to specify
3282 =head3 B<Database> blocks
3284 Database blocks define a connection to a database and which queries should be
3285 sent to that database. Each database needs a "name" as string argument in the
3286 starting tag of the block. This name will be used as "PluginInstance" in the
3287 values submitted to the daemon. Other than that, that name is not used.
3291 =item B<ConnectID> I<ID>
3293 Defines the "database alias" or "service name" to connect to. Usually, these
3294 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
3296 =item B<Host> I<Host>
3298 Hostname to use when dispatching values for this database. Defaults to using
3299 the global hostname of the I<collectd> instance.
3301 =item B<Username> I<Username>
3303 Username used for authentication.
3305 =item B<Password> I<Password>
3307 Password used for authentication.
3309 =item B<Query> I<QueryName>
3311 Associates the query named I<QueryName> with this database connection. The
3312 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
3313 blocks you want to refer to must be placed above the database block you want to
3318 =head2 Plugin C<perl>
3320 This plugin embeds a Perl-interpreter into collectd and provides an interface
3321 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
3323 =head2 Plugin C<pinba>
3325 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
3326 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
3327 PHP-based webpage has been delivered, the extension will send a UDP packet
3328 containing timing information, peak memory usage and so on. The plugin will
3329 wait for such packets, parse them and account the provided information, which
3330 is then dispatched to the daemon once per interval.
3337 # Overall statistics for the website.
3339 Server "www.example.com"
3341 # Statistics for www-a only
3343 Host "www-a.example.com"
3344 Server "www.example.com"
3346 # Statistics for www-b only
3348 Host "www-b.example.com"
3349 Server "www.example.com"
3353 The plugin provides the following configuration options:
3357 =item B<Address> I<Node>
3359 Configures the address used to open a listening socket. By default, plugin will
3360 bind to the I<any> address C<::0>.
3362 =item B<Port> I<Service>
3364 Configures the port (service) to bind to. By default the default Pinba port
3365 "30002" will be used. The option accepts service names in addition to port
3366 numbers and thus requires a I<string> argument.
3368 =item E<lt>B<View> I<Name>E<gt> block
3370 The packets sent by the Pinba extension include the hostname of the server, the
3371 server name (the name of the virtual host) and the script that was executed.
3372 Using B<View> blocks it is possible to separate the data into multiple groups
3373 to get more meaningful statistics. Each packet is added to all matching groups,
3374 so that a packet may be accounted for more than once.
3378 =item B<Host> I<Host>
3380 Matches the hostname of the system the webserver / script is running on. This
3381 will contain the result of the L<gethostname(2)> system call. If not
3382 configured, all hostnames will be accepted.
3384 =item B<Server> I<Server>
3386 Matches the name of the I<virtual host>, i.e. the contents of the
3387 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
3388 server names will be accepted.
3390 =item B<Script> I<Script>
3392 Matches the name of the I<script name>, i.e. the contents of the
3393 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
3394 script names will be accepted.
3400 =head2 Plugin C<ping>
3402 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
3403 configured hosts periodically and measures the network latency. Whenever the
3404 C<read> function of the plugin is called, it submits the average latency, the
3405 standard deviation and the drop rate for each host.
3407 Available configuration options:
3411 =item B<Host> I<IP-address>
3413 Host to ping periodically. This option may be repeated several times to ping
3416 =item B<Interval> I<Seconds>
3418 Sets the interval in which to send ICMP echo packets to the configured hosts.
3419 This is B<not> the interval in which statistics are queries from the plugin but
3420 the interval in which the hosts are "pinged". Therefore, the setting here
3421 should be smaller than or equal to the global B<Interval> setting. Fractional
3422 times, such as "1.24" are allowed.
3426 =item B<Timeout> I<Seconds>
3428 Time to wait for a response from the host to which an ICMP packet had been
3429 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
3430 to be down or the packet to be dropped. This setting must be smaller than the
3431 B<Interval> setting above for the plugin to work correctly. Fractional
3432 arguments are accepted.
3436 =item B<TTL> I<0-255>
3438 Sets the Time-To-Live of generated ICMP packets.
3440 =item B<SourceAddress> I<host>
3442 Sets the source address to use. I<host> may either be a numerical network
3443 address or a network hostname.
3445 =item B<Device> I<name>
3447 Sets the outgoing network device to be used. I<name> has to specify an
3448 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
3451 =item B<MaxMissed> I<Packets>
3453 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
3454 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
3456 Default: B<-1> (disabled)
3460 =head2 Plugin C<postgresql>
3462 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
3463 keeps a persistent connection to all configured databases and tries to
3464 reconnect if the connection has been interrupted. A database is configured by
3465 specifying a B<Database> block as described below. The default statistics are
3466 collected from PostgreSQL's B<statistics collector> which thus has to be
3467 enabled for this plugin to work correctly. This should usually be the case by
3468 default. See the section "The Statistics Collector" of the B<PostgreSQL
3469 Documentation> for details.
3471 By specifying custom database queries using a B<Query> block as described
3472 below, you may collect any data that is available from some PostgreSQL
3473 database. This way, you are able to access statistics of external daemons
3474 which are available in a PostgreSQL database or use future or special
3475 statistics provided by PostgreSQL without the need to upgrade your collectd
3478 The B<PostgreSQL Documentation> manual can be found at
3479 L<http://www.postgresql.org/docs/manuals/>.
3483 Statement "SELECT magic FROM wizard WHERE host = $1;"
3487 InstancePrefix "magic"
3492 <Query rt36_tickets>
3493 Statement "SELECT COUNT(type) AS count, type \
3495 WHEN resolved = 'epoch' THEN 'open' \
3496 ELSE 'resolved' END AS type \
3497 FROM tickets) type \
3501 InstancePrefix "rt36_tickets"
3502 InstancesFrom "type"
3513 KRBSrvName "kerberos_service_name"
3519 Service "service_name"
3520 Query backend # predefined
3525 The B<Query> block defines one database query which may later be used by a
3526 database definition. It accepts a single mandatory argument which specifies
3527 the name of the query. The names of all queries have to be unique (see the
3528 B<MinVersion> and B<MaxVersion> options below for an exception to this
3529 rule). The following configuration options are available to define the query:
3531 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
3532 blocks define how to handle the values returned from the query. They define
3533 which column holds which value and how to dispatch that value to the daemon.
3534 Multiple B<Result> blocks may be used to extract multiple values from a single
3539 =item B<Statement> I<sql query statement>
3541 Specify the I<sql query statement> which the plugin should execute. The string
3542 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
3543 first, second, etc. parameter. The value of the parameters is specified by the
3544 B<Param> configuration option - see below for details. To include a literal
3545 B<$> character followed by a number, surround it with single quotes (B<'>).
3547 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
3548 allowed. Note, however, that only a single command may be used. Semicolons are
3549 allowed as long as a single non-empty command has been specified only.
3551 The returned lines will be handled separately one after another.
3553 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
3555 Specify the parameters which should be passed to the SQL query. The parameters
3556 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
3557 they appear in the configuration file. The value of the parameter is
3558 determined depending on the value of the B<Param> option as follows:
3564 The configured hostname of the database connection. If a UNIX domain socket is
3565 used, the parameter expands to "localhost".
3569 The name of the database of the current connection.
3573 The username used to connect to the database.
3577 The interval with which this database is queried (as specified by the database
3578 specific or global B<Interval> options).
3582 Please note that parameters are only supported by PostgreSQL's protocol
3583 version 3 and above which was introduced in version 7.4 of PostgreSQL.
3585 =item B<Type> I<type>
3587 The I<type> name to be used when dispatching the values. The type describes
3588 how to handle the data and where to store it. See L<types.db(5)> for more
3589 details on types and their configuration. The number and type of values (as
3590 selected by the B<ValuesFrom> option) has to match the type of the given name.
3592 This option is required inside a B<Result> block.
3594 =item B<InstancePrefix> I<prefix>
3596 =item B<InstancesFrom> I<column0> [I<column1> ...]
3598 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
3599 B<InstancePrefix> defines a static prefix that will be prepended to all type
3600 instances. B<InstancesFrom> defines the column names whose values will be used
3601 to create the type instance. Multiple values will be joined together using the
3602 hyphen (C<->) as separation character.
3604 The plugin itself does not check whether or not all built instances are
3605 different. It is your responsibility to assure that each is unique.
3607 Both options are optional. If none is specified, the type instance will be
3610 =item B<ValuesFrom> I<column0> [I<column1> ...]
3612 Names the columns whose content is used as the actual data for the data sets
3613 that are dispatched to the daemon. How many such columns you need is
3614 determined by the B<Type> setting as explained above. If you specify too many
3615 or not enough columns, the plugin will complain about that and no data will be
3616 submitted to the daemon.
3618 The actual data type, as seen by PostgreSQL, is not that important as long as
3619 it represents numbers. The plugin will automatically cast the values to the
3620 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
3621 L<strtod(3)> functions, so anything supported by those functions is supported
3622 by the plugin as well.
3624 This option is required inside a B<Result> block and may be specified multiple
3625 times. If multiple B<ValuesFrom> options are specified, the columns are read
3628 =item B<MinVersion> I<version>
3630 =item B<MaxVersion> I<version>
3632 Specify the minimum or maximum version of PostgreSQL that this query should be
3633 used with. Some statistics might only be available with certain versions of
3634 PostgreSQL. This allows you to specify multiple queries with the same name but
3635 which apply to different versions, thus allowing you to use the same
3636 configuration in a heterogeneous environment.
3638 The I<version> has to be specified as the concatenation of the major, minor
3639 and patch-level versions, each represented as two-decimal-digit numbers. For
3640 example, version 8.2.3 will become 80203.
3644 The following predefined queries are available (the definitions can be found
3645 in the F<postgresql_default.conf> file which, by default, is available at
3646 C<I<prefix>/share/collectd/>):
3652 This query collects the number of backends, i.E<nbsp>e. the number of
3655 =item B<transactions>
3657 This query collects the numbers of committed and rolled-back transactions of
3662 This query collects the numbers of various table modifications (i.E<nbsp>e.
3663 insertions, updates, deletions) of the user tables.
3665 =item B<query_plans>
3667 This query collects the numbers of various table scans and returned tuples of
3670 =item B<table_states>
3672 This query collects the numbers of live and dead rows in the user tables.
3676 This query collects disk block access counts for user tables.
3680 This query collects the on-disk size of the database in bytes.
3684 The B<Database> block defines one PostgreSQL database for which to collect
3685 statistics. It accepts a single mandatory argument which specifies the
3686 database name. None of the other options are required. PostgreSQL will use
3687 default values as documented in the section "CONNECTING TO A DATABASE" in the
3688 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
3689 the user collectd is run as and special environment variables. See the manpage
3694 =item B<Interval> I<seconds>
3696 Specify the interval with which the database should be queried. The default is
3697 to use the global B<Interval> setting.
3699 =item B<Host> I<hostname>
3701 Specify the hostname or IP of the PostgreSQL server to connect to. If the
3702 value begins with a slash, it is interpreted as the directory name in which to
3703 look for the UNIX domain socket.
3705 This option is also used to determine the hostname that is associated with a
3706 collected data set. If it has been omitted or either begins with with a slash
3707 or equals B<localhost> it will be replaced with the global hostname definition
3708 of collectd. Any other value will be passed literally to collectd when
3709 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
3711 =item B<Port> I<port>
3713 Specify the TCP port or the local UNIX domain socket file extension of the
3716 =item B<User> I<username>
3718 Specify the username to be used when connecting to the server.
3720 =item B<Password> I<password>
3722 Specify the password to be used when connecting to the server.
3724 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
3726 Specify whether to use an SSL connection when contacting the server. The
3727 following modes are supported:
3733 Do not use SSL at all.
3737 First, try to connect without using SSL. If that fails, try using SSL.
3739 =item I<prefer> (default)
3741 First, try to connect using SSL. If that fails, try without using SSL.
3749 =item B<KRBSrvName> I<kerberos_service_name>
3751 Specify the Kerberos service name to use when authenticating with Kerberos 5
3752 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
3753 B<PostgreSQL Documentation> for details.
3755 =item B<Service> I<service_name>
3757 Specify the PostgreSQL service name to use for additional parameters. That
3758 service has to be defined in F<pg_service.conf> and holds additional
3759 connection parameters. See the section "The Connection Service File" in the
3760 B<PostgreSQL Documentation> for details.
3762 =item B<Query> I<query>
3764 Specify a I<query> which should be executed for the database connection. This
3765 may be any of the predefined or user-defined queries. If no such option is
3766 given, it defaults to "backends", "transactions", "queries", "query_plans",
3767 "table_states", "disk_io" and "disk_usage". Else, the specified queries are
3772 =head2 Plugin C<powerdns>
3774 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
3775 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
3776 values, many of which are probably meaningless to most users, but may be useful
3777 for some. So you may chose which values to collect, but if you don't, some
3778 reasonable defaults will be collected.
3781 <Server "server_name">
3783 Collect "udp-answers" "udp-queries"
3784 Socket "/var/run/pdns.controlsocket"
3786 <Recursor "recursor_name">
3788 Collect "cache-hits" "cache-misses"
3789 Socket "/var/run/pdns_recursor.controlsocket"
3791 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
3796 =item B<Server> and B<Recursor> block
3798 The B<Server> block defines one authoritative server to query, the B<Recursor>
3799 does the same for an recursing server. The possible options in both blocks are
3800 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
3805 =item B<Collect> I<Field>
3807 Using the B<Collect> statement you can select which values to collect. Here,
3808 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
3809 C<dlg-only-drops>, C<answers10-100>.
3811 The method of getting the values differs for B<Server> and B<Recursor> blocks:
3812 When querying the server a C<SHOW *> command is issued in any case, because
3813 that's the only way of getting multiple values out of the server at once.
3814 collectd then picks out the values you have selected. When querying the
3815 recursor, a command is generated to query exactly these values. So if you
3816 specify invalid fields when querying the recursor, a syntax error may be
3817 returned by the daemon and collectd may not collect any values at all.
3819 If no B<Collect> statement is given, the following B<Server> values will be
3826 =item packetcache-hit
3828 =item packetcache-miss
3830 =item packetcache-size
3832 =item query-cache-hit
3834 =item query-cache-miss
3836 =item recursing-answers
3838 =item recursing-questions
3850 The following B<Recursor> values will be collected by default:
3854 =item noerror-answers
3856 =item nxdomain-answers
3858 =item servfail-answers
3876 Please note that up to that point collectd doesn't know what values are
3877 available on the server and values that are added do not need a change of the
3878 mechanism so far. However, the values must be mapped to collectd's naming
3879 scheme, which is done using a lookup table that lists all known values. If
3880 values are added in the future and collectd does not know about them, you will
3881 get an error much like this:
3883 powerdns plugin: submit: Not found in lookup table: foobar = 42
3885 In this case please file a bug report with the collectd team.
3887 =item B<Socket> I<Path>
3889 Configures the path to the UNIX domain socket to be used when connecting to the
3890 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
3891 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
3892 will be used for the recursor.
3896 =item B<LocalSocket> I<Path>
3898 Querying the recursor is done using UDP. When using UDP over UNIX domain
3899 sockets, the client socket needs a name in the file system, too. You can set
3900 this local name to I<Path> using the B<LocalSocket> option. The default is
3901 C<I<prefix>/var/run/collectd-powerdns>.
3905 =head2 Plugin C<processes>
3909 =item B<Process> I<Name>
3911 Select more detailed statistics of processes matching this name. The statistics
3912 collected for these selected processes are size of the resident segment size
3913 (RSS), user- and system-time used, number of processes and number of threads,
3914 io data (where available) and minor and major pagefaults.
3916 =item B<ProcessMatch> I<name> I<regex>
3918 Similar to the B<Process> option this allows to select more detailed
3919 statistics of processes matching the specified I<regex> (see L<regex(7)> for
3920 details). The statistics of all matching processes are summed up and
3921 dispatched to the daemon using the specified I<name> as an identifier. This
3922 allows to "group" several processes together. I<name> must not contain
3927 =head2 Plugin C<protocols>
3929 Collects a lot of information about various network protocols, such as I<IP>,
3930 I<TCP>, I<UDP>, etc.
3932 Available configuration options:
3936 =item B<Value> I<Selector>
3938 Selects whether or not to select a specific value. The string being matched is
3939 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
3940 plugin instance and I<ValueName> will be used as type instance. An example of
3941 the string being used would be C<Tcp:RetransSegs>.
3943 You can use regular expressions to match a large number of values with just one
3944 configuration option. To select all "extended" I<TCP> values, you could use the
3945 following statement:
3949 Whether only matched values are selected or all matched values are ignored
3950 depends on the B<IgnoreSelected>. By default, only matched values are selected.
3951 If no value is configured at all, all values will be selected.
3953 =item B<IgnoreSelected> B<true>|B<false>
3955 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
3956 matching values will be ignored.
3960 =head2 Plugin C<python>
3962 This plugin embeds a Python-interpreter into collectd and provides an interface
3963 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
3965 =head2 Plugin C<routeros>
3967 The C<routeros> plugin connects to a device running I<RouterOS>, the
3968 Linux-based operating system for routers by I<MikroTik>. The plugin uses
3969 I<librouteros> to connect and reads information about the interfaces and
3970 wireless connections of the device. The configuration supports querying
3975 Host "router0.example.com"
3978 CollectInterface true
3983 Host "router1.example.com"
3986 CollectInterface true
3987 CollectRegistrationTable true
3993 As you can see above, the configuration of the I<routeros> plugin consists of
3994 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
3995 options are understood:
3999 =item B<Host> I<Host>
4001 Hostname or IP-address of the router to connect to.
4003 =item B<Port> I<Port>
4005 Port name or port number used when connecting. If left unspecified, the default
4006 will be chosen by I<librouteros>, currently "8728". This option expects a
4007 string argument, even when a numeric port number is given.
4009 =item B<User> I<User>
4011 Use the user name I<User> to authenticate. Defaults to "admin".
4013 =item B<Password> I<Password>
4015 Set the password used to authenticate.
4017 =item B<CollectInterface> B<true>|B<false>
4019 When set to B<true>, interface statistics will be collected for all interfaces
4020 present on the device. Defaults to B<false>.
4022 =item B<CollectRegistrationTable> B<true>|B<false>
4024 When set to B<true>, information about wireless LAN connections will be
4025 collected. Defaults to B<false>.
4027 =item B<CollectCPULoad> B<true>|B<false>
4029 When set to B<true>, information about the CPU usage will be collected. The
4030 number is a dimensionless value where zero indicates no CPU usage at all.
4031 Defaults to B<false>.
4033 =item B<CollectMemory> B<true>|B<false>
4035 When enabled, the amount of used and free memory will be collected. How used
4036 memory is calculated is unknown, for example whether or not caches are counted
4038 Defaults to B<false>.
4040 =item B<CollectDF> B<true>|B<false>
4042 When enabled, the amount of used and free disk space will be collected.
4043 Defaults to B<false>.
4045 =item B<CollectDisk> B<true>|B<false>
4047 When enabled, the number of sectors written and bad blocks will be collected.
4048 Defaults to B<false>.
4052 =head2 Plugin C<redis>
4054 The I<Redis plugin> connects to one or more Redis servers and gathers
4055 information about each server's state. For each server there is a I<Node> block
4056 which configures the connection parameters for this node.
4066 The information shown in the synopsis above is the I<default configuration>
4067 which is used by the plugin if no configuration is present.
4071 =item B<Node> I<Nodename>
4073 The B<Node> block identifies a new Redis node, that is a new Redis instance
4074 running in an specified host and port. The name for node is a canonical
4075 identifier which is used as I<plugin instance>. It is limited to
4076 64E<nbsp>characters in length.
4078 =item B<Host> I<Hostname>
4080 The B<Host> option is the hostname or IP-address where the Redis instance is
4083 =item B<Port> I<Port>
4085 The B<Port> option is the TCP port on which the Redis instance accepts
4086 connections. Either a service name of a port number may be given. Please note
4087 that numerical port numbers must be given as a string, too.
4089 =item B<Password> I<Password>
4091 Use I<Password> to authenticate when connecting to I<Redis>.
4093 =item B<Timeout> I<Timeout in miliseconds>
4095 The B<Timeout> option set the socket timeout for node response. Since the Redis
4096 read function is blocking, you should keep this value as low as possible. Keep
4097 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
4098 than B<Interval> defined globally.
4102 =head2 Plugin C<rrdcached>
4104 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
4105 to store values to RRD files in an efficient manner. The combination of the
4106 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
4107 way the C<rrdtool> plugin works (see below). The added abstraction layer
4108 provides a number of benefits, though: Because the cache is not within
4109 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
4110 restarted. This results in much shorter (if any) gaps in graphs, especially
4111 under heavy load. Also, the C<rrdtool> command line utility is aware of the
4112 daemon so that it can flush values to disk automatically when needed. This
4113 allows to integrate automated flushing of values into graphing solutions much
4116 There are disadvantages, though: The daemon may reside on a different host, so
4117 it may not be possible for C<collectd> to create the appropriate RRD files
4118 anymore. And even if C<rrdcached> runs on the same host, it may run in a
4119 different base directory, so relative paths may do weird stuff if you're not
4122 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
4123 on the same host, communicating via a UNIX domain socket. The B<DataDir>
4124 setting should be set to an absolute path, so that a changed base directory
4125 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
4129 =item B<DaemonAddress> I<Address>
4131 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
4132 library. See L<rrdcached(1)> for details. Example:
4134 <Plugin "rrdcached">
4135 DaemonAddress "unix:/var/run/rrdcached.sock"
4138 =item B<DataDir> I<Directory>
4140 Set the base directory in which the RRD files reside. If this is a relative
4141 path, it is relative to the working base directory of the C<rrdcached> daemon!
4142 Use of an absolute path is recommended.
4144 =item B<CreateFiles> B<true>|B<false>
4146 Enables or disables the creation of RRD files. If the daemon is not running
4147 locally, or B<DataDir> is set to a relative path, this will not work as
4148 expected. Default is B<true>.
4152 =head2 Plugin C<rrdtool>
4154 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
4155 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
4156 using these settings. If you don't want to dive into the depths of RRDtool, you
4157 can safely ignore these settings.
4161 =item B<DataDir> I<Directory>
4163 Set the directory to store RRD-files under. Per default RRD-files are generated
4164 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
4166 =item B<StepSize> I<Seconds>
4168 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
4169 this setting is unset and the stepsize is set to the interval in which the data
4170 is collected. Do not use this option unless you absolutely have to for some
4171 reason. Setting this option may cause problems with the C<snmp plugin>, the
4172 C<exec plugin> or when the daemon is set up to receive data from other hosts.
4174 =item B<HeartBeat> I<Seconds>
4176 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
4177 in which case the heartbeat is set to twice the B<StepSize> which should equal
4178 the interval in which data is collected. Do not set this option unless you have
4179 a very good reason to do so.
4181 =item B<RRARows> I<NumRows>
4183 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
4184 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
4185 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
4186 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
4187 week, one month, and one year.
4189 So for each timespan, it calculates how many PDPs need to be consolidated into
4190 one CDP by calculating:
4191 number of PDPs = timespan / (stepsize * rrarows)
4193 Bottom line is, set this no smaller than the width of you graphs in pixels. The
4196 =item B<RRATimespan> I<Seconds>
4198 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
4199 more then one RRA. If this option is never used, the built-in default of (3600,
4200 86400, 604800, 2678400, 31622400) is used.
4202 For more information on how RRA-sizes are calculated see B<RRARows> above.
4204 =item B<XFF> I<Factor>
4206 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
4208 =item B<CacheFlush> I<Seconds>
4210 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
4211 it writes all values for a certain RRD-file if the oldest value is older than
4212 (or equal to) the number of seconds specified. If some RRD-file is not updated
4213 anymore for some reason (the computer was shut down, the network is broken,
4214 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
4215 entire cache is searched for entries older than B<CacheTimeout> seconds and
4216 written to disk every I<Seconds> seconds. Since this is kind of expensive and
4217 does nothing under normal circumstances, this value should not be too small.
4218 900 seconds might be a good value, though setting this to 7200 seconds doesn't
4219 normally do much harm either.
4221 =item B<CacheTimeout> I<Seconds>
4223 If this option is set to a value greater than zero, the C<rrdtool plugin> will
4224 save values in a cache, as described above. Writing multiple values at once
4225 reduces IO-operations and thus lessens the load produced by updating the files.
4226 The trade off is that the graphs kind of "drag behind" and that more memory is
4229 =item B<WritesPerSecond> I<Updates>
4231 When collecting many statistics with collectd and the C<rrdtool> plugin, you
4232 will run serious performance problems. The B<CacheFlush> setting and the
4233 internal update queue assert that collectd continues to work just fine even
4234 under heavy load, but the system may become very unresponsive and slow. This is
4235 a problem especially if you create graphs from the RRD files on the same
4236 machine, for example using the C<graph.cgi> script included in the
4237 C<contrib/collection3/> directory.
4239 This setting is designed for very large setups. Setting this option to a value
4240 between 25 and 80 updates per second, depending on your hardware, will leave
4241 the server responsive enough to draw graphs even while all the cached values
4242 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
4243 by the B<FLUSH> command, are B<not> effected by this limit. They are still
4244 written as fast as possible, so that web frontends have up to date data when
4247 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
4248 updates per second, writing all values to disk will take approximately
4249 56E<nbsp>minutes. Together with the flushing ability that's integrated into
4250 "collection3" you'll end up with a responsive and fast system, up to date
4251 graphs and basically a "backup" of your values every hour.
4253 =item B<RandomTimeout> I<Seconds>
4255 When set, the actual timeout for each value is chosen randomly between
4256 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
4257 intention is to avoid high load situations that appear when many values timeout
4258 at the same time. This is especially a problem shortly after the daemon starts,
4259 because all values were added to the internal cache at roughly the same time.
4263 =head2 Plugin C<sensors>
4265 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
4266 that all the needed modules have to be loaded and lm_sensors has to be
4267 configured (most likely by editing F</etc/sensors.conf>. Read
4268 L<sensors.conf(5)> for details.
4270 The B<lm_sensors> homepage can be found at
4271 L<http://secure.netroedge.com/~lm78/>.
4275 =item B<SensorConfigFile> I<File>
4277 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
4278 the library's default will be used.
4280 =item B<Sensor> I<chip-bus-address/type-feature>
4282 Selects the name of the sensor which you want to collect or ignore, depending
4283 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
4284 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
4285 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
4287 =item B<IgnoreSelected> I<true>|I<false>
4289 If no configuration if given, the B<sensors>-plugin will collect data from all
4290 sensors. This may not be practical, especially for uninteresting sensors.
4291 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
4292 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
4293 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
4294 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
4295 and all other sensors are collected.
4299 =head2 Plugin C<snmp>
4301 Since the configuration of the C<snmp plugin> is a little more complicated than
4302 other plugins, its documentation has been moved to an own manpage,
4303 L<collectd-snmp(5)>. Please see there for details.
4305 =head2 Plugin C<swap>
4307 The I<Swap plugin> collects information about used and available swap space. On
4308 I<Linux> and I<Solaris>, the following options are available:
4312 =item B<ReportByDevice> B<false>|B<true>
4314 Configures how to report physical swap devices. If set to B<false> (the
4315 default), the summary over all swap devices is reported only, i.e. the globally
4316 used and available space over all devices. If B<true> is configured, the used
4317 and available space of each device will be reported separately.
4319 This option is only available if the I<Swap plugin> can read C</proc/swaps>
4320 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
4324 =head2 Plugin C<syslog>
4328 =item B<LogLevel> B<debug|info|notice|warning|err>
4330 Sets the log-level. If, for example, set to B<notice>, then all events with
4331 severity B<notice>, B<warning>, or B<err> will be submitted to the
4334 Please note that B<debug> is only available if collectd has been compiled with
4337 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
4339 Controls which notifications should be sent to syslog. The default behaviour is
4340 not to send any. Less severe notifications always imply logging more severe
4341 notifications: Setting this to B<OKAY> means all notifications will be sent to
4342 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
4343 notifications but will dismiss B<OKAY> notifications. Setting this option to
4344 B<FAILURE> will only send failures to syslog.
4348 =head2 Plugin C<table>
4350 The C<table plugin> provides generic means to parse tabular data and dispatch
4351 user specified values. Values are selected based on column numbers. For
4352 example, this plugin may be used to get values from the Linux L<proc(5)>
4353 filesystem or CSV (comma separated values) files.
4356 <Table "/proc/slabinfo">
4361 InstancePrefix "active_objs"
4367 InstancePrefix "objperslab"
4374 The configuration consists of one or more B<Table> blocks, each of which
4375 configures one file to parse. Within each B<Table> block, there are one or
4376 more B<Result> blocks, which configure which data to select and how to
4379 The following options are available inside a B<Table> block:
4383 =item B<Instance> I<instance>
4385 If specified, I<instance> is used as the plugin instance. So, in the above
4386 example, the plugin name C<table-slabinfo> would be used. If omitted, the
4387 filename of the table is used instead, with all special characters replaced
4388 with an underscore (C<_>).
4390 =item B<Separator> I<string>
4392 Any character of I<string> is interpreted as a delimiter between the different
4393 columns of the table. A sequence of two or more contiguous delimiters in the
4394 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
4395 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
4396 of a table - see its documentation for more details. This option is mandatory.
4398 A horizontal tab, newline and carriage return may be specified by C<\\t>,
4399 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
4400 required because of collectd's config parsing.
4404 The following options are available inside a B<Result> block:
4408 =item B<Type> I<type>
4410 Sets the type used to dispatch the values to the daemon. Detailed information
4411 about types and their configuration can be found in L<types.db(5)>. This
4412 option is mandatory.
4414 =item B<InstancePrefix> I<prefix>
4416 If specified, prepend I<prefix> to the type instance. If omitted, only the
4417 B<InstancesFrom> option is considered for the type instance.
4419 =item B<InstancesFrom> I<column0> [I<column1> ...]
4421 If specified, the content of the given columns (identified by the column
4422 number starting at zero) will be used to create the type instance for each
4423 row. Multiple values (and the instance prefix) will be joined together with
4424 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
4425 option is considered for the type instance.
4427 The plugin itself does not check whether or not all built instances are
4428 different. It’s your responsibility to assure that each is unique. This is
4429 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
4430 sure that the table only contains one row.
4432 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
4435 =item B<ValuesFrom> I<column0> [I<column1> ...]
4437 Specifies the columns (identified by the column numbers starting at zero)
4438 whose content is used as the actual data for the data sets that are dispatched
4439 to the daemon. How many such columns you need is determined by the B<Type>
4440 setting above. If you specify too many or not enough columns, the plugin will
4441 complain about that and no data will be submitted to the daemon. The plugin
4442 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
4443 respectively, so anything supported by those functions is supported by the
4444 plugin as well. This option is mandatory.
4448 =head2 Plugin C<tail>
4450 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
4451 each line and dispatches found values. What is matched can be configured by the
4452 user using (extended) regular expressions, as described in L<regex(7)>.
4455 <File "/var/log/exim4/mainlog">
4458 Regex "S=([1-9][0-9]*)"
4464 Regex "\\<R=local_user\\>"
4465 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
4468 Instance "local_user"
4473 The config consists of one or more B<File> blocks, each of which configures one
4474 logfile to parse. Within each B<File> block, there are one or more B<Match>
4475 blocks, which configure a regular expression to search for.
4477 The B<Instance> option in the B<File> block may be used to set the plugin
4478 instance. So in the above example the plugin name C<tail-foo> would be used.
4479 This plugin instance is for all B<Match> blocks that B<follow> it, until the
4480 next B<Instance> option. This way you can extract several plugin instances from
4481 one logfile, handy when parsing syslog and the like.
4483 Each B<Match> block has the following options to describe how the match should
4488 =item B<Regex> I<regex>
4490 Sets the regular expression to use for matching against a line. The first
4491 subexpression has to match something that can be turned into a number by
4492 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
4493 below. Because B<extended> regular expressions are used, you do not need to use
4494 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
4495 collectd's config parsing you need to escape backslashes, though. So if you
4496 want to match literal parentheses you need to do the following:
4498 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
4500 =item B<ExcludeRegex> I<regex>
4502 Sets an optional regular expression to use for excluding lines from the match.
4503 An example which excludes all connections from localhost from the match:
4505 ExcludeRegex "127\\.0\\.0\\.1"
4507 =item B<DSType> I<Type>
4509 Sets how the values are cumulated. I<Type> is one of:
4513 =item B<GaugeAverage>
4515 Calculate the average.
4519 Use the smallest number only.
4523 Use the greatest number only.
4527 Use the last number found.
4533 =item B<AbsoluteSet>
4535 The matched number is a counter. Simply I<sets> the internal counter to this
4536 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
4542 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
4543 matched number may be negative, which will effectively subtract from the
4550 Increase the internal counter by one. These B<DSType> are the only ones that do
4551 not use the matched subexpression, but simply count the number of matched
4552 lines. Thus, you may use a regular expression without submatch in this case.
4556 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
4557 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
4558 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
4559 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
4560 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
4563 =item B<Type> I<Type>
4565 Sets the type used to dispatch this value. Detailed information about types and
4566 their configuration can be found in L<types.db(5)>.
4568 =item B<Instance> I<TypeInstance>
4570 This optional setting sets the type instance to use.
4574 =head2 Plugin C<teamspeak2>
4576 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
4577 polls interesting global and virtual server data. The plugin can query only one
4578 physical server but unlimited virtual servers. You can use the following
4579 options to configure it:
4583 =item B<Host> I<hostname/ip>
4585 The hostname or ip which identifies the physical server.
4588 =item B<Port> I<port>
4590 The query port of the physical server. This needs to be a string.
4593 =item B<Server> I<port>
4595 This option has to be added once for every virtual server the plugin should
4596 query. If you want to query the virtual server on port 8767 this is what the
4597 option would look like:
4601 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
4602 use quotes around it! If no such statement is given only global information
4607 =head2 Plugin C<ted>
4609 The I<TED> plugin connects to a device of "The Energy Detective", a device to
4610 measure power consumption. These devices are usually connected to a serial
4611 (RS232) or USB port. The plugin opens a configured device and tries to read the
4612 current energy readings. For more information on TED, visit
4613 L<http://www.theenergydetective.com/>.
4615 Available configuration options:
4619 =item B<Device> I<Path>
4621 Path to the device on which TED is connected. collectd will need read and write
4622 permissions on that file.
4624 Default: B</dev/ttyUSB0>
4626 =item B<Retries> I<Num>
4628 Apparently reading from TED is not that reliable. You can therefore configure a
4629 number of retries here. You only configure the I<retries> here, to if you
4630 specify zero, one reading will be performed (but no retries if that fails); if
4631 you specify three, a maximum of four readings are performed. Negative values
4638 =head2 Plugin C<tcpconns>
4640 The C<tcpconns plugin> counts the number of currently established TCP
4641 connections based on the local port and/or the remote port. Since there may be
4642 a lot of connections the default if to count all connections with a local port,
4643 for which a listening socket is opened. You can use the following options to
4644 fine-tune the ports you are interested in:
4648 =item B<ListeningPorts> I<true>|I<false>
4650 If this option is set to I<true>, statistics for all local ports for which a
4651 listening socket exists are collected. The default depends on B<LocalPort> and
4652 B<RemotePort> (see below): If no port at all is specifically selected, the
4653 default is to collect listening ports. If specific ports (no matter if local or
4654 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
4655 the selected ports will be collected unless this option is set to I<true>
4658 =item B<LocalPort> I<Port>
4660 Count the connections to a specific local port. This can be used to see how
4661 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
4662 You have to specify the port in numeric form, so for the mailserver example
4663 you'd need to set B<25>.
4665 =item B<RemotePort> I<Port>
4667 Count the connections to a specific remote port. This is useful to see how
4668 much a remote service is used. This is most useful if you want to know how many
4669 connections a local service has opened to remote services, e.E<nbsp>g. how many
4670 connections a mail server or news server has to other mail or news servers, or
4671 how many connections a web proxy holds to web servers. You have to give the
4672 port in numeric form.
4676 =head2 Plugin C<thermal>
4680 =item B<ForceUseProcfs> I<true>|I<false>
4682 By default, the I<Thermal plugin> tries to read the statistics from the Linux
4683 C<sysfs> interface. If that is not available, the plugin falls back to the
4684 C<procfs> interface. By setting this option to I<true>, you can force the
4685 plugin to use the latter. This option defaults to I<false>.
4687 =item B<Device> I<Device>
4689 Selects the name of the thermal device that you want to collect or ignore,
4690 depending on the value of the B<IgnoreSelected> option. This option may be
4691 used multiple times to specify a list of devices.
4693 =item B<IgnoreSelected> I<true>|I<false>
4695 Invert the selection: If set to true, all devices B<except> the ones that
4696 match the device names specified by the B<Device> option are collected. By
4697 default only selected devices are collected if a selection is made. If no
4698 selection is configured at all, B<all> devices are selected.
4702 =head2 Plugin C<threshold>
4704 The I<Threshold plugin> checks values collected or received by I<collectd>
4705 against a configurable I<threshold> and issues I<notifications> if values are
4708 Documentation for this plugin is available in the L<collectd-threshold(5)>
4711 =head2 Plugin C<tokyotyrant>
4713 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
4714 couple metrics: number of records, and database size on disk.
4718 =item B<Host> I<Hostname/IP>
4720 The hostname or ip which identifies the server.
4721 Default: B<127.0.0.1>
4723 =item B<Port> I<Service/Port>
4725 The query port of the server. This needs to be a string, even if the port is
4726 given in its numeric form.
4731 =head2 Plugin C<unixsock>
4735 =item B<SocketFile> I<Path>
4737 Sets the socket-file which is to be created.
4739 =item B<SocketGroup> I<Group>
4741 If running as root change the group of the UNIX-socket after it has been
4742 created. Defaults to B<collectd>.
4744 =item B<SocketPerms> I<Permissions>
4746 Change the file permissions of the UNIX-socket after it has been created. The
4747 permissions must be given as a numeric, octal value as you would pass to
4748 L<chmod(1)>. Defaults to B<0770>.
4750 =item B<DeleteSocket> B<false>|B<true>
4752 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
4753 with the given name already exists. If I<collectd> crashes a socket file may be
4754 left over, preventing the daemon from opening a new socket when restarted.
4755 Since this is potentially dangerous, this defaults to B<false>.
4759 =head2 Plugin C<uuid>
4761 This plugin, if loaded, causes the Hostname to be taken from the machine's
4762 UUID. The UUID is a universally unique designation for the machine, usually
4763 taken from the machine's BIOS. This is most useful if the machine is running in
4764 a virtual environment such as Xen, in which case the UUID is preserved across
4765 shutdowns and migration.
4767 The following methods are used to find the machine's UUID, in order:
4773 Check I</etc/uuid> (or I<UUIDFile>).
4777 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
4782 Check for UUID from C<dmidecode> / SMBIOS.
4786 Check for UUID from Xen hypervisor.
4790 If no UUID can be found then the hostname is not modified.
4794 =item B<UUIDFile> I<Path>
4796 Take the UUID from the given file (default I</etc/uuid>).
4800 =head2 Plugin C<varnish>
4802 The Varnish plugin collects information about Varnish, an HTTP accelerator.
4806 =item B<CollectCache> B<true>|B<false>
4808 Cache hits and misses. True by default.
4810 =item B<CollectConnections> B<true>|B<false>
4812 Number of client connections received, accepted and dropped. True by default.
4814 =item B<CollectBackend> B<true>|B<false>
4816 Back-end connection statistics, such as successful, reused,
4817 and closed connections. True by default.
4819 =item B<CollectSHM> B<true>|B<false>
4821 Statistics about the shared memory log, a memory region to store
4822 log messages which is flushed to disk when full. True by default.
4824 =item B<CollectESI> B<true>|B<false>
4826 Edge Side Includes (ESI) parse statistics. False by default.
4828 =item B<CollectFetch> B<true>|B<false>
4830 Statistics about fetches (HTTP requests sent to the backend). False by default.
4832 =item B<CollectHCB> B<true>|B<false>
4834 Inserts and look-ups in the crit bit tree based hash. Look-ups are
4835 divided into locked and unlocked look-ups. False by default.
4837 =item B<CollectSMA> B<true>|B<false>
4839 malloc or umem (umem_alloc(3MALLOC) based) storage statistics.
4840 The umem storage component is Solaris specific. False by default.
4842 =item B<CollectSMS> B<true>|B<false>
4844 synth (synthetic content) storage statistics. This storage
4845 component is used internally only. False by default.
4847 =item B<CollectSM> B<true>|B<false>
4849 file (memory mapped file) storage statistics. False by default.
4851 =item B<CollectTotals> B<true>|B<false>
4853 Collects overview counters, such as the number of sessions created,
4854 the number of requests and bytes transferred. False by default.
4856 =item B<CollectWorkers> B<true>|B<false>
4858 Collect statistics about worker threads. False by default.
4862 =head2 Plugin C<vmem>
4864 The C<vmem> plugin collects information about the usage of virtual memory.
4865 Since the statistics provided by the Linux kernel are very detailed, they are
4866 collected very detailed. However, to get all the details, you have to switch
4867 them on manually. Most people just want an overview over, such as the number of
4868 pages read from swap space.
4872 =item B<Verbose> B<true>|B<false>
4874 Enables verbose collection of information. This will start collecting page
4875 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
4876 Part of these statistics are collected on a "per zone" basis.
4880 =head2 Plugin C<vserver>
4882 This plugin doesn't have any options. B<VServer> support is only available for
4883 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
4884 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
4885 need to apply the patches and compile your own kernel, which will then provide
4886 the F</proc/virtual> filesystem that is required by this plugin.
4888 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
4890 B<Note>: The traffic collected by this plugin accounts for the amount of
4891 traffic passing a socket which might be a lot less than the actual on-wire
4892 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
4893 collect on-wire traffic you could, for example, use the logging facilities of
4894 iptables to feed data for the guest IPs into the iptables plugin.
4896 =head2 Plugin C<write_graphite>
4898 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
4899 storage and graphing project. The plugin connects to I<Carbon>, the data layer
4900 of I<Graphite>, and sends data via the "line based" protocol (per default using
4901 portE<nbsp>2003). The data will be sent in blocks of at most 1428 bytes to
4902 minimize the number of network packets.
4906 <Plugin write_graphite>
4916 =item B<Host> I<Address>
4918 Hostname or address to connect to. Defaults to C<localhost>.
4920 =item B<Port> I<Service>
4922 Service name or port number to connect to. Defaults to C<2003>.
4924 =item B<Prefix> I<String>
4926 When set, I<String> is added in front of the host name. Dots and whitespace are
4927 I<not> escaped in this string (see B<EscapeCharacter> below).
4929 =item B<Postfix> I<String>
4931 When set, I<String> is appended to the host name. Dots and whitespace are
4932 I<not> escaped in this string (see B<EscapeCharacter> below).
4934 =item B<EscapeCharacter> I<Char>
4936 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
4937 in the identifier. The B<EscapeCharacter> option determines which character
4938 dots, whitespace and control characters are replaced with. Defaults to
4941 =item B<StoreRates> B<false>|B<true>
4943 If set to B<true> (the default), convert counter values to rates. If set to
4944 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
4947 =item B<SeparateInstances> B<false>|B<true>
4949 If set to B<true>, the plugin instance and type instance will be in their own
4950 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
4951 default), the plugin and plugin instance (and likewise the type and type
4952 instance) are put into once component, for example C<host.cpu-0.cpu-idle>.
4954 =item B<AlwaysAppendDS> B<false>|B<true>
4956 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
4957 identifier. If set to B<false> (the default), this is only done when there is
4962 =head2 Plugin C<write_mongodb>
4964 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
4969 <Plugin "write_mongodb">
4978 The plugin can send values to multiple instances of I<MongoDB> by specifying
4979 one B<Node> block for each instance. Within the B<Node> blocks, the following
4980 options are available:
4984 =item B<Host> I<Address>
4986 Hostname or address to connect to. Defaults to C<localhost>.
4988 =item B<Port> I<Service>
4990 Service name or port number to connect to. Defaults to C<27017>.
4992 =item B<Timeout> I<Timeout>
4994 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
4995 Setting this option to zero means no timeout, which is the default.
4997 =item B<StoreRates> B<false>|B<true>
4999 If set to B<true> (the default), convert counter values to rates. If set to
5000 B<false> counter values are stored as is, i.e. as an increasing integer
5005 =head2 Plugin C<write_http>
5007 This output plugin submits values to an http server by POST them using the
5008 PUTVAL plain-text protocol. Each destination you want to post data to needs to
5009 have one B<URL> block, within which the destination can be configured further,
5010 for example by specifying authentication data.
5014 <Plugin "write_http">
5015 <URL "http://example.com/post-collectd">
5021 B<URL> blocks need one string argument which is used as the URL to which data
5022 is posted. The following options are understood within B<URL> blocks.
5026 =item B<User> I<Username>
5028 Optional user name needed for authentication.
5030 =item B<Password> I<Password>
5032 Optional password needed for authentication.
5034 =item B<VerifyPeer> B<true>|B<false>
5036 Enable or disable peer SSL certificate verification. See
5037 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5039 =item B<VerifyHost> B<true|false>
5041 Enable or disable peer host name verification. If enabled, the plugin checks if
5042 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
5043 matches the host name provided by the B<URL> option. If this identity check
5044 fails, the connection is aborted. Obviously, only works when connecting to a
5045 SSL enabled server. Enabled by default.
5047 =item B<CACert> I<File>
5049 File that holds one or more SSL certificates. If you want to use HTTPS you will
5050 possibly need this option. What CA certificates come bundled with C<libcurl>
5051 and are checked by default depends on the distribution you use.
5053 =item B<Format> B<Command>|B<JSON>
5055 Format of the output to generate. If set to B<Command>, will create output that
5056 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
5057 create output in the I<JavaScript Object Notation> (JSON).
5059 Defaults to B<Command>.
5061 =item B<StoreRates> B<true|false>
5063 If set to B<true>, convert counter values to rates. If set to B<false> (the
5064 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
5069 =head1 THRESHOLD CONFIGURATION
5071 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
5072 we mean that the values are not only stored or sent somewhere, but that they
5073 are judged and, if a problem is recognized, acted upon. The only action
5074 collectd takes itself is to generate and dispatch a "notification". Plugins can
5075 register to receive notifications and perform appropriate further actions.
5077 Since systems and what you expect them to do differ a lot, you can configure
5078 B<thresholds> for your values freely. This gives you a lot of flexibility but
5079 also a lot of responsibility.
5081 Every time a value is out of range a notification is dispatched. This means
5082 that the idle percentage of your CPU needs to be less then the configured
5083 threshold only once for a notification to be generated. There's no such thing
5084 as a moving average or similar - at least not now.
5086 Also, all values that match a threshold are considered to be relevant or
5087 "interesting". As a consequence collectd will issue a notification if they are
5088 not received for B<Timeout> iterations. The B<Timeout> configuration option is
5089 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
5090 "2" (the default) and some hosts sends it's CPU statistics to the server every
5091 60 seconds, a notification will be dispatched after about 120 seconds. It may
5092 take a little longer because the timeout is checked only once each B<Interval>
5095 When a value comes within range again or is received after it was missing, an
5096 "OKAY-notification" is dispatched.
5098 Here is a configuration example to get you started. Read below for more
5111 <Plugin "interface">
5128 WarningMin 100000000
5134 There are basically two types of configuration statements: The C<Host>,
5135 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
5136 configured. The C<Plugin> and C<Type> blocks may be specified further using the
5137 C<Instance> option. You can combine the block by nesting the blocks, though
5138 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
5139 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
5140 C<Type> may not contain other blocks. If multiple blocks apply to the same
5141 value the most specific block is used.
5143 The other statements specify the threshold to configure. They B<must> be
5144 included in a C<Type> block. Currently the following statements are recognized:
5148 =item B<FailureMax> I<Value>
5150 =item B<WarningMax> I<Value>
5152 Sets the upper bound of acceptable values. If unset defaults to positive
5153 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
5154 will be created. If the value is greater than B<WarningMax> but less than (or
5155 equal to) B<FailureMax> a B<WARNING> notification will be created.
5157 =item B<FailureMin> I<Value>
5159 =item B<WarningMin> I<Value>
5161 Sets the lower bound of acceptable values. If unset defaults to negative
5162 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
5163 be created. If the value is less than B<WarningMin> but greater than (or equal
5164 to) B<FailureMin> a B<WARNING> notification will be created.
5166 =item B<DataSource> I<DSName>
5168 Some data sets have more than one "data source". Interesting examples are the
5169 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
5170 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
5171 system load data set, C<load>, even has three data sources: C<shortterm>,
5172 C<midterm>, and C<longterm>.
5174 Normally, all data sources are checked against a configured threshold. If this
5175 is undesirable, or if you want to specify different limits for each data
5176 source, you can use the B<DataSource> option to have a threshold apply only to
5179 =item B<Invert> B<true>|B<false>
5181 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
5182 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
5183 B<WarningMax>) are not okay. Defaults to B<false>.
5185 =item B<Persist> B<true>|B<false>
5187 Sets how often notifications are generated. If set to B<true> one notification
5188 will be generated for each value that is out of the acceptable range. If set to
5189 B<false> (the default) then a notification is only generated if a value is out
5190 of range but the previous value was okay.
5192 This applies to missing values, too: If set to B<true> a notification about a
5193 missing value is generated once every B<Interval> seconds. If set to B<false>
5194 only one such notification is generated until the value appears again.
5196 =item B<Percentage> B<true>|B<false>
5198 If set to B<true>, the minimum and maximum values given are interpreted as
5199 percentage value, relative to the other data sources. This is helpful for
5200 example for the "df" type, where you may want to issue a warning when less than
5201 5E<nbsp>% of the total space is available. Defaults to B<false>.
5203 =item B<Hits> I<Number>
5205 Delay creating the notification until the threshold has been passed I<Number>
5206 times. When a notification has been generated, or when a subsequent value is
5207 inside the threshold, the counter is reset. If, for example, a value is
5208 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
5209 will be dispatched at most once every 30E<nbsp>seconds.
5211 This is useful when short bursts are not a problem. If, for example, 100% CPU
5212 usage for up to a minute is normal (and data is collected every
5213 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
5215 =item B<Hysteresis> I<Number>
5217 When set to non-zero, a hysteresis value is applied when checking minimum and
5218 maximum bounds. This is useful for values that increase slowly and fluctuate a
5219 bit while doing so. When these values come close to the threshold, they may
5220 "flap", i.e. switch between failure / warning case and okay case repeatedly.
5222 If, for example, the threshold is configures as
5227 then a I<Warning> notification is created when the value exceeds I<101> and the
5228 corresponding I<Okay> notification is only created once the value falls below
5229 I<99>, thus avoiding the "flapping".
5233 =head1 FILTER CONFIGURATION
5235 Starting with collectd 4.6 there is a powerful filtering infrastructure
5236 implemented in the daemon. The concept has mostly been copied from
5237 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
5238 terminology, so that users that are familiar with iptables feel right at home.
5242 The following are the terms used in the remainder of the filter configuration
5243 documentation. For an ASCII-art schema of the mechanism, see
5244 L<"General structure"> below.
5250 A I<match> is a criteria to select specific values. Examples are, of course, the
5251 name of the value or it's current value.
5253 Matches are implemented in plugins which you have to load prior to using the
5254 match. The name of such plugins starts with the "match_" prefix.
5258 A I<target> is some action that is to be performed with data. Such actions
5259 could, for example, be to change part of the value's identifier or to ignore
5260 the value completely.
5262 Some of these targets are built into the daemon, see L<"Built-in targets">
5263 below. Other targets are implemented in plugins which you have to load prior to
5264 using the target. The name of such plugins starts with the "target_" prefix.
5268 The combination of any number of matches and at least one target is called a
5269 I<rule>. The target actions will be performed for all values for which B<all>
5270 matches apply. If the rule does not have any matches associated with it, the
5271 target action will be performed for all values.
5275 A I<chain> is a list of rules and possibly default targets. The rules are tried
5276 in order and if one matches, the associated target will be called. If a value
5277 is handled by a rule, it depends on the target whether or not any subsequent
5278 rules are considered or if traversal of the chain is aborted, see
5279 L<"Flow control"> below. After all rules have been checked, the default targets
5284 =head2 General structure
5286 The following shows the resulting structure:
5293 +---------+ +---------+ +---------+ +---------+
5294 ! Rule !->! Match !->! Match !->! Target !
5295 +---------+ +---------+ +---------+ +---------+
5298 +---------+ +---------+ +---------+
5299 ! Rule !->! Target !->! Target !
5300 +---------+ +---------+ +---------+
5307 +---------+ +---------+ +---------+
5308 ! Rule !->! Match !->! Target !
5309 +---------+ +---------+ +---------+
5319 There are four ways to control which way a value takes through the filter
5326 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
5327 process the value with another chain. When the called chain finishes, usually
5328 the next target or rule after the jump is executed.
5332 The stop condition, signaled for example by the built-in target B<stop>, causes
5333 all processing of the value to be stopped immediately.
5337 Causes processing in the current chain to be aborted, but processing of the
5338 value generally will continue. This means that if the chain was called via
5339 B<Jump>, the next target or rule after the jump will be executed. If the chain
5340 was not called by another chain, control will be returned to the daemon and it
5341 may pass the value to another chain.
5345 Most targets will signal the B<continue> condition, meaning that processing
5346 should continue normally. There is no special built-in target for this
5353 The configuration reflects this structure directly:
5355 PostCacheChain "PostCache"
5357 <Rule "ignore_mysql_show">
5360 Type "^mysql_command$"
5361 TypeInstance "^show_"
5371 The above configuration example will ignore all values where the plugin field
5372 is "mysql", the type is "mysql_command" and the type instance begins with
5373 "show_". All other values will be sent to the C<rrdtool> write plugin via the
5374 default target of the chain. Since this chain is run after the value has been
5375 added to the cache, the MySQL C<show_*> command statistics will be available
5376 via the C<unixsock> plugin.
5378 =head2 List of configuration options
5382 =item B<PreCacheChain> I<ChainName>
5384 =item B<PostCacheChain> I<ChainName>
5386 Configure the name of the "pre-cache chain" and the "post-cache chain". The
5387 argument is the name of a I<chain> that should be executed before and/or after
5388 the values have been added to the cache.
5390 To understand the implications, it's important you know what is going on inside
5391 I<collectd>. The following diagram shows how values are passed from the
5392 read-plugins to the write-plugins:
5398 + - - - - V - - - - +
5399 : +---------------+ :
5402 : +-------+-------+ :
5405 : +-------+-------+ : +---------------+
5406 : ! Cache !--->! Value Cache !
5407 : ! insert ! : +---+---+-------+
5408 : +-------+-------+ : ! !
5409 : ! ,------------' !
5411 : +-------+---+---+ : +-------+-------+
5412 : ! Post-Cache +--->! Write-Plugins !
5413 : ! Chain ! : +---------------+
5414 : +---------------+ :
5417 + - - - - - - - - - +
5419 After the values are passed from the "read" plugins to the dispatch functions,
5420 the pre-cache chain is run first. The values are added to the internal cache
5421 afterwards. The post-cache chain is run after the values have been added to the
5422 cache. So why is it such a huge deal if chains are run before or after the
5423 values have been added to this cache?
5425 Targets that change the identifier of a value list should be executed before
5426 the values are added to the cache, so that the name in the cache matches the
5427 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
5428 this cache to receive a list of all available values. If you change the
5429 identifier after the value list has been added to the cache, this may easily
5430 lead to confusion, but it's not forbidden of course.
5432 The cache is also used to convert counter values to rates. These rates are, for
5433 example, used by the C<value> match (see below). If you use the rate stored in
5434 the cache B<before> the new value is added, you will use the old, B<previous>
5435 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
5436 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
5439 Last but not last, the B<stop> target makes a difference: If the pre-cache
5440 chain returns the stop condition, the value will not be added to the cache and
5441 the post-cache chain will not be run.
5443 =item B<Chain> I<Name>
5445 Adds a new chain with a certain name. This name can be used to refer to a
5446 specific chain, for example to jump to it.
5448 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
5450 =item B<Rule> [I<Name>]
5452 Adds a new rule to the current chain. The name of the rule is optional and
5453 currently has no meaning for the daemon.
5455 Within the B<Rule> block, there may be any number of B<Match> blocks and there
5456 must be at least one B<Target> block.
5458 =item B<Match> I<Name>
5460 Adds a match to a B<Rule> block. The name specifies what kind of match should
5461 be performed. Available matches depend on the plugins that have been loaded.
5463 The arguments inside the B<Match> block are passed to the plugin implementing
5464 the match, so which arguments are valid here depends on the plugin being used.
5465 If you do not need any to pass any arguments to a match, you can use the
5470 Which is equivalent to:
5475 =item B<Target> I<Name>
5477 Add a target to a rule or a default target to a chain. The name specifies what
5478 kind of target is to be added. Which targets are available depends on the
5479 plugins being loaded.
5481 The arguments inside the B<Target> block are passed to the plugin implementing
5482 the target, so which arguments are valid here depends on the plugin being used.
5483 If you do not need any to pass any arguments to a target, you can use the
5488 This is the same as writing:
5495 =head2 Built-in targets
5497 The following targets are built into the core daemon and therefore need no
5498 plugins to be loaded:
5504 Signals the "return" condition, see the L<"Flow control"> section above. This
5505 causes the current chain to stop processing the value and returns control to
5506 the calling chain. The calling chain will continue processing targets and rules
5507 just after the B<jump> target (see below). This is very similar to the
5508 B<RETURN> target of iptables, see L<iptables(8)>.
5510 This target does not have any options.
5518 Signals the "stop" condition, see the L<"Flow control"> section above. This
5519 causes processing of the value to be aborted immediately. This is similar to
5520 the B<DROP> target of iptables, see L<iptables(8)>.
5522 This target does not have any options.
5530 Sends the value to "write" plugins.
5536 =item B<Plugin> I<Name>
5538 Name of the write plugin to which the data should be sent. This option may be
5539 given multiple times to send the data to more than one write plugin.
5543 If no plugin is explicitly specified, the values will be sent to all available
5554 Starts processing the rules of another chain, see L<"Flow control"> above. If
5555 the end of that chain is reached, or a stop condition is encountered,
5556 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
5557 next target or the next rule. This is similar to the B<-j> command line option
5558 of iptables, see L<iptables(8)>.
5564 =item B<Chain> I<Name>
5566 Jumps to the chain I<Name>. This argument is required and may appear only once.
5578 =head2 Available matches
5584 Matches a value using regular expressions.
5590 =item B<Host> I<Regex>
5592 =item B<Plugin> I<Regex>
5594 =item B<PluginInstance> I<Regex>
5596 =item B<Type> I<Regex>
5598 =item B<TypeInstance> I<Regex>
5600 Match values where the given regular expressions match the various fields of
5601 the identifier of a value. If multiple regular expressions are given, B<all>
5602 regexen must match for a value to match.
5604 =item B<Invert> B<false>|B<true>
5606 When set to B<true>, the result of the match is inverted, i.e. all value lists
5607 where all regular expressions apply are not matched, all other value lists are
5608 matched. Defaults to B<false>.
5615 Host "customer[0-9]+"
5621 Matches values that have a time which differs from the time on the server.
5623 This match is mainly intended for servers that receive values over the
5624 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
5625 is very sensitive to the timestamp used when updating the RRD files. In
5626 particular, the time must be ever increasing. If a misbehaving client sends one
5627 packet with a timestamp far in the future, all further packets with a correct
5628 time will be ignored because of that one packet. What's worse, such corrupted
5629 RRD files are hard to fix.
5631 This match lets one match all values B<outside> a specified time range
5632 (relative to the server's time), so you can use the B<stop> target (see below)
5633 to ignore the value, for example.
5639 =item B<Future> I<Seconds>
5641 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
5642 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
5645 =item B<Past> I<Seconds>
5647 Matches all values that are I<behind> of the server's time by I<Seconds> or
5648 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
5660 This example matches all values that are five minutes or more ahead of the
5661 server or one hour (or more) lagging behind.
5665 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
5666 values. If a data-set consists of more than one data-source, all data-sources
5667 must match the specified ranges for a positive match.
5673 =item B<Min> I<Value>
5675 Sets the smallest value which still results in a match. If unset, behaves like
5678 =item B<Max> I<Value>
5680 Sets the largest value which still results in a match. If unset, behaves like
5683 =item B<Invert> B<true>|B<false>
5685 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
5686 no-match is returned and vice versa. Please note that the B<Invert> setting
5687 only effects how B<Min> and B<Max> are applied to a specific value. Especially
5688 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
5690 =item B<DataSource> I<DSName> [I<DSName> ...]
5692 Select one or more of the data sources. If no data source is configured, all
5693 data sources will be checked. If the type handled by the match does not have a
5694 data source of the specified name(s), this will always result in no match
5695 (independent of the B<Invert> setting).
5697 =item B<Satisfy> B<Any>|B<All>
5699 Specifies how checking with several data sources is performed. If set to
5700 B<Any>, the match succeeds if one of the data sources is in the configured
5701 range. If set to B<All> the match only succeeds if all data sources are within
5702 the configured range. Default is B<All>.
5704 Usually B<All> is used for positive matches, B<Any> is used for negative
5705 matches. This means that with B<All> you usually check that all values are in a
5706 "good" range, while with B<Any> you check if any value is within a "bad" range
5707 (or outside the "good" range).
5711 Either B<Min> or B<Max>, but not both, may be unset.
5715 # Match all values smaller than or equal to 100. Matches only if all data
5716 # sources are below 100.
5722 # Match if the value of any data source is outside the range of 0 - 100.
5730 =item B<empty_counter>
5732 Matches all values with one or more data sources of type B<COUNTER> and where
5733 all counter values are zero. These counters usually I<never> increased since
5734 they started existing (and are therefore uninteresting), or got reset recently
5735 or overflowed and you had really, I<really> bad luck.
5737 Please keep in mind that ignoring such counters can result in confusing
5738 behavior: Counters which hardly ever increase will be zero for long periods of
5739 time. If the counter is reset for some reason (machine or service restarted,
5740 usually), the graph will be empty (NAN) for a long time. People may not
5745 Calculates a hash value of the host name and matches values according to that
5746 hash value. This makes it possible to divide all hosts into groups and match
5747 only values that are in a specific group. The intended use is in load
5748 balancing, where you want to handle only part of all data and leave the rest
5751 The hashing function used tries to distribute the hosts evenly. First, it
5752 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
5755 for (i = 0; host[i] != 0; i++)
5756 hash_value = (hash_value * 251) + host[i];
5758 The constant 251 is a prime number which is supposed to make this hash value
5759 more random. The code then checks the group for this host according to the
5760 I<Total> and I<Match> arguments:
5762 if ((hash_value % Total) == Match)
5767 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
5768 groups), then the least significant bit of the hash value will be the XOR of
5769 all least significant bits in the host name. One consequence is that when you
5770 have two hosts, "server0.example.com" and "server1.example.com", where the host
5771 name differs in one digit only and the digits differ by one, those hosts will
5772 never end up in the same group.
5778 =item B<Match> I<Match> I<Total>
5780 Divide the data into I<Total> groups and match all hosts in group I<Match> as
5781 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
5782 be smaller than I<Total>. I<Total> must be at least one, although only values
5783 greater than one really do make any sense.
5785 You can repeat this option to match multiple groups, for example:
5790 The above config will divide the data into seven groups and match groups three
5791 and five. One use would be to keep every value on two hosts so that if one
5792 fails the missing data can later be reconstructed from the second host.
5798 # Operate on the pre-cache chain, so that ignored values are not even in the
5803 # Divide all received hosts in seven groups and accept all hosts in
5807 # If matched: Return and continue.
5810 # If not matched: Return and stop.
5816 =head2 Available targets
5820 =item B<notification>
5822 Creates and dispatches a notification.
5828 =item B<Message> I<String>
5830 This required option sets the message of the notification. The following
5831 placeholders will be replaced by an appropriate value:
5839 =item B<%{plugin_instance}>
5843 =item B<%{type_instance}>
5845 These placeholders are replaced by the identifier field of the same name.
5847 =item B<%{ds:>I<name>B<}>
5849 These placeholders are replaced by a (hopefully) human readable representation
5850 of the current rate of this data source. If you changed the instance name
5851 (using the B<set> or B<replace> targets, see below), it may not be possible to
5852 convert counter values to rates.
5856 Please note that these placeholders are B<case sensitive>!
5858 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
5860 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
5867 <Target "notification">
5868 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
5874 Replaces parts of the identifier using regular expressions.
5880 =item B<Host> I<Regex> I<Replacement>
5882 =item B<Plugin> I<Regex> I<Replacement>
5884 =item B<PluginInstance> I<Regex> I<Replacement>
5886 =item B<TypeInstance> I<Regex> I<Replacement>
5888 Match the appropriate field with the given regular expression I<Regex>. If the
5889 regular expression matches, that part that matches is replaced with
5890 I<Replacement>. If multiple places of the input buffer match a given regular
5891 expression, only the first occurrence will be replaced.
5893 You can specify each option multiple times to use multiple regular expressions
5901 # Replace "example.net" with "example.com"
5902 Host "\\<example.net\\>" "example.com"
5904 # Strip "www." from hostnames
5910 Sets part of the identifier of a value to a given string.
5916 =item B<Host> I<String>
5918 =item B<Plugin> I<String>
5920 =item B<PluginInstance> I<String>
5922 =item B<TypeInstance> I<String>
5924 Set the appropriate field to the given string. The strings for plugin instance
5925 and type instance may be empty, the strings for host and plugin may not be
5926 empty. It's currently not possible to set the type of a value this way.
5933 PluginInstance "coretemp"
5934 TypeInstance "core3"
5939 =head2 Backwards compatibility
5941 If you use collectd with an old configuration, i.E<nbsp>e. one without a
5942 B<Chain> block, it will behave as it used to. This is equivalent to the
5943 following configuration:
5949 If you specify a B<PostCacheChain>, the B<write> target will not be added
5950 anywhere and you will have to make sure that it is called where appropriate. We
5951 suggest to add the above snippet as default target to your "PostCache" chain.
5955 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
5971 L<collectd-exec(5)>,
5972 L<collectd-perl(5)>,
5973 L<collectd-unixsock(5)>,
5986 Florian Forster E<lt>octo@verplant.orgE<gt>