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 I<Apache> webserver. Each line contains either an option (a key and a list of
29 one or more values) or a section-start or -end. Empty lines and everything
30 after a non-quoted hash-symbol (C<#>) is ignored. I<Keys> are unquoted
31 strings, consisting only of alphanumeric characters and the underscore (C<_>)
32 character. Keys are handled case insensitive by I<collectd> itself and all
33 plugins included with it. I<Values> can either be an I<unquoted string>, a
34 I<quoted string> (enclosed in double-quotes) a I<number> or a I<boolean>
35 expression. I<Unquoted strings> consist of only alphanumeric characters and
36 underscores (C<_>) and do not need to be quoted. I<Quoted strings> are
37 enclosed in double quotes (C<">). You can use the backslash character (C<\>)
38 to include double quotes as part of the string. I<Numbers> can be specified in
39 decimal and floating point format (using a dot C<.> as decimal separator),
40 hexadecimal when using the C<0x> prefix and octal with a leading zero (C<0>).
41 I<Boolean> values are either B<true> or B<false>.
43 Lines may be wrapped by using C<\> as the last character before the newline.
44 This allows long lines to be split into multiple lines. Quoted strings may be
45 wrapped as well. However, those are treated special in that whitespace at the
46 beginning of the following lines will be ignored, which allows for nicely
47 indenting the wrapped lines.
49 The configuration is read and processed in order, i.e. from top to bottom. So
50 the plugins are loaded in the order listed in this config file. It is a good
51 idea to load any logging plugins first in order to catch messages from plugins
52 during configuration. Also, the C<LoadPlugin> option B<must> occur B<before>
53 the appropriate C<E<lt>Plugin ...E<gt>> block.
59 =item B<BaseDir> I<Directory>
61 Sets the base directory. This is the directory beneath all RRD-files are
62 created. Possibly more subdirectories are created. This is also the working
63 directory for the daemon.
65 =item B<LoadPlugin> I<Plugin>
67 Loads the plugin I<Plugin>. There must be at least one such line or B<collectd>
68 will be mostly useless.
70 Starting with collectd 4.9, this may also be a block in which further options
71 affecting the behavior of B<LoadPlugin> may be specified. The following
72 options are allowed inside a B<LoadPlugin> block:
80 =item B<Globals> B<true|false>
82 If enabled, collectd will export all global symbols of the plugin (and of all
83 libraries loaded as dependencies of the plugin) and, thus, makes those symbols
84 available for resolving unresolved symbols in subsequently loaded plugins if
85 that is supported by your system.
87 This is useful (or possibly even required), e.g., when loading a plugin that
88 embeds some scripting language into the daemon (e.g. the I<Perl> and
89 I<Python plugins>). Scripting languages usually provide means to load
90 extensions written in C. Those extensions require symbols provided by the
91 interpreter, which is loaded as a dependency of the respective collectd plugin.
92 See the documentation of those plugins (e.g., L<collectd-perl(5)> or
93 L<collectd-python(5)>) for details.
95 By default, this is disabled. As a special exception, if the plugin name is
96 either C<perl> or C<python>, the default is changed to enabled in order to keep
97 the average user from ever having to deal with this low level linking stuff.
99 =item B<Interval> I<Seconds>
101 Sets a plugin-specific interval for collecting metrics. This overrides the
102 global B<Interval> setting. If a plugin provides own support for specifying an
103 interval, that setting will take precedence.
107 =item B<Include> I<Path>
109 If I<Path> points to a file, includes that file. If I<Path> points to a
110 directory, recursively includes all files within that directory and its
111 subdirectories. If the C<wordexp> function is available on your system,
112 shell-like wildcards are expanded before files are included. This means you can
113 use statements like the following:
115 Include "/etc/collectd.d/*.conf"
117 If more than one files are included by a single B<Include> option, the files
118 will be included in lexicographical order (as defined by the C<strcmp>
119 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
120 order in which the files are loaded.
122 To prevent loops and shooting yourself in the foot in interesting ways the
123 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
124 most uses. Since symlinks are followed it is still possible to crash the daemon
125 by looping symlinks. In our opinion significant stupidity should result in an
126 appropriate amount of pain.
128 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
129 file, but you cannot include files from within blocks.
131 =item B<PIDFile> I<File>
133 Sets where to write the PID file to. This file is overwritten when it exists
134 and deleted when the program is stopped. Some init-scripts might override this
135 setting using the B<-P> command-line option.
137 =item B<PluginDir> I<Directory>
139 Path to the plugins (shared objects) of collectd.
141 =item B<TypesDB> I<File> [I<File> ...]
143 Set one or more files that contain the data-set descriptions. See
144 L<types.db(5)> for a description of the format of this file.
146 =item B<Interval> I<Seconds>
148 Configures the interval in which to query the read plugins. Obviously smaller
149 values lead to a higher system load produced by collectd, while higher values
150 lead to more coarse statistics.
152 B<Warning:> You should set this once and then never touch it again. If you do,
153 I<you will have to delete all your RRD files> or know some serious RRDtool
154 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
156 =item B<Timeout> I<Iterations>
158 Consider a value list "missing" when no update has been read or received for
159 I<Iterations> iterations. By default, I<collectd> considers a value list
160 missing when no update has been received for twice the update interval. Since
161 this setting uses iterations, the maximum allowed time without update depends
162 on the I<Interval> information contained in each value list. This is used in
163 the I<Threshold> configuration to dispatch notifications about missing values,
164 see L<collectd-threshold(5)> for details.
166 =item B<ReadThreads> I<Num>
168 Number of threads to start for reading plugins. The default value is B<5>, but
169 you may want to increase this if you have more than five plugins that take a
170 long time to read. Mostly those are plugin that do network-IO. Setting this to
171 a value higher than the number of plugins you've loaded is totally useless.
173 =item B<Hostname> I<Name>
175 Sets the hostname that identifies a host. If you omit this setting, the
176 hostname will be determined using the L<gethostname(2)> system call.
178 =item B<FQDNLookup> B<true|false>
180 If B<Hostname> is determined automatically this setting controls whether or not
181 the daemon should try to figure out the "fully qualified domain name", FQDN.
182 This is done using a lookup of the name returned by C<gethostname>. This option
183 is enabled by default.
185 =item B<PreCacheChain> I<ChainName>
187 =item B<PostCacheChain> I<ChainName>
189 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
190 see L<FILTER CONFIGURATION> below on information on chains and how these
191 setting change the daemon's behavior.
195 =head1 PLUGIN OPTIONS
197 Some plugins may register own options. These options must be enclosed in a
198 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
199 require external configuration, too. The C<apache plugin>, for example,
200 required C<mod_status> to be configured in the webserver you're going to
201 collect data from. These plugins are listed below as well, even if they don't
202 require any configuration within collectd's configuration file.
204 A list of all plugins and a short summary for each plugin can be found in the
205 F<README> file shipped with the sourcecode and hopefully binary packets as
208 =head2 Plugin C<aggregation>
210 The I<Aggregation plugin> makes it possible to aggregate several values into
211 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
212 This can be put to a wide variety of uses, e.g. average and total CPU
213 statistics for your entire fleet.
215 The grouping is powerful but, as with many powerful tools, may be a bit
216 difficult to wrap your head around. The grouping will therefore be
217 demonstrated using an example: The average and sum of the CPU usage across
218 all CPUs of each host is to be calculated.
220 To select all the affected values for our example, set C<Plugin cpu> and
221 C<Type cpu>. The other values are left unspecified, meaning "all values". The
222 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
223 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
229 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...) and
230 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
231 example, the intention is to have a new value for each host / type instance
232 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
233 It can be specified multiple times to group by more than one field.
236 GroupBy "TypeInstance"
238 We do neither specify nor group by I<plugin instance> (the CPU number), so all
239 metrics that differ in the CPU number only will be aggregated. Each
240 aggregation needs I<at least one> such field, otherwise no aggregation would
243 The full example configuration looks like this:
245 <Plugin "aggregation">
251 GroupBy "TypeInstance"
254 CalculateAverage true
258 There are a couple of limitations you should be aware of:
264 The I<Type> cannot be left unspecified, because it is not reasonable to add
265 apples to oranges. Also, the internal lookup structure won't work if you try
270 There must be at least one unspecified, ungrouped field. Otherwise nothing
275 As you can see in the example above, each aggregation has its own
276 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
277 blocks may match the same values, i.e. one value list can update multiple
278 aggregations. The following options are valid inside B<Aggregation> blocks:
282 =item B<Host> I<Host>
284 =item B<Plugin> I<Plugin>
286 =item B<PluginInstance> I<PluginInstance>
288 =item B<Type> I<Type>
290 =item B<TypeInstance> I<TypeInstance>
292 Selects the value lists to be added to this aggregation. B<Type> must be a
293 valid data set name, see L<types.db(5)> for details.
295 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
297 Group valued by the specified field. The B<GroupBy> option may be repeated to
298 group by multiple fields.
300 =item B<CalculateNum> B<true>|B<false>
302 =item B<CalculateSum> B<true>|B<false>
304 =item B<CalculateAverage> B<true>|B<false>
306 =item B<CalculateMinimum> B<true>|B<false>
308 =item B<CalculateMaximum> B<true>|B<false>
310 =item B<CalculateStddev> B<true>|B<false>
312 Boolean options for enabling calculation of the number of value lists, their
313 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
314 are disabled by default.
318 =head2 Plugin C<amqp>
320 The I<AMQMP plugin> can be used to communicate with other instances of
321 I<collectd> or third party applications using an AMQP message broker. Values
322 are sent to or received from the broker, which handles routing, queueing and
323 possibly filtering or messages.
326 # Send values to an AMQP broker
327 <Publish "some_name">
333 Exchange "amq.fanout"
334 # ExchangeType "fanout"
335 # RoutingKey "collectd"
339 # GraphitePrefix "collectd."
340 # GraphiteEscapeChar "_"
343 # Receive values from an AMQP broker
344 <Subscribe "some_name">
350 Exchange "amq.fanout"
351 # ExchangeType "fanout"
353 # RoutingKey "collectd.#"
357 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
358 blocks, which configure sending and receiving of values respectively. The two
359 blocks are very similar, so unless otherwise noted, an option can be used in
360 either block. The name given in the blocks starting tag is only used for
361 reporting messages, but may be used to support I<flushing> of certain
362 I<Publish> blocks in the future.
366 =item B<Host> I<Host>
368 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
369 the underlying communications library, I<rabbitmq-c>, which is "localhost".
371 =item B<Port> I<Port>
373 Service name or port number on which the AMQP broker accepts connections. This
374 argument must be a string, even if the numeric form is used. Defaults to
377 =item B<VHost> I<VHost>
379 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
381 =item B<User> I<User>
383 =item B<Password> I<Password>
385 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
388 =item B<Exchange> I<Exchange>
390 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
391 By default, "amq.fanout" will be used.
393 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
394 the given exchange and the I<queue> is created, using the I<routing key> if
395 configured. See the B<Queue> and B<RoutingKey> options below.
397 =item B<ExchangeType> I<Type>
399 If given, the plugin will try to create the configured I<exchange> with this
400 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
401 be bound to this exchange.
403 =item B<Queue> I<Queue> (Subscribe only)
405 Configures the I<queue> name to subscribe to. If no queue name was configures
406 explicitly, a unique queue name will be created by the broker.
408 =item B<RoutingKey> I<Key>
410 In I<Publish> blocks, this configures the routing key to set on all outgoing
411 messages. If not given, the routing key will be computed from the I<identifier>
412 of the value. The host, plugin, type and the two instances are concatenated
413 together using dots as the separator and all containing dots replaced with
414 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
415 possible to receive only specific values using a "topic" exchange.
417 In I<Subscribe> blocks, configures the I<routing key> used when creating a
418 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
419 used to filter messages when using a "topic" exchange. If you're only
420 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
423 =item B<Persistent> B<true>|B<false> (Publish only)
425 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
426 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
427 default), the I<transient> delivery mode will be used, i.e. messages may be
428 lost due to high load, overflowing queues or similar issues.
430 =item B<Format> B<Command>|B<JSON> (Publish only)
432 Selects the format in which messages are sent to the broker. If set to
433 B<Command> (the default), values are sent as C<PUTVAL> commands which are
434 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
435 case, the C<Content-Type> header field will be set to C<text/collectd>.
437 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
438 an easy and straight forward exchange format. The C<Content-Type> header field
439 will be set to C<application/json>.
441 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
442 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
445 A subscribing client I<should> use the C<Content-Type> header field to
446 determine how to decode the values. Currently, the I<AMQP plugin> itself can
447 only decode the B<Command> format.
449 =item B<StoreRates> B<true>|B<false> (Publish only)
451 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
452 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
453 default), no conversion is performed. Otherwise the conversion is performed
454 using the internal value cache.
456 Please note that currently this option is only used if the B<Format> option has
459 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
461 A prefix can be added in the metric name when outputting in the I<Graphite> format.
462 It's added before the I<Host> name.
463 Metric name will be "<prefix><host><postfix><plugin><type><name>"
465 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
467 A postfix can be added in the metric name when outputting in the I<Graphite> format.
468 It's added after the I<Host> name.
469 Metric name will be "<prefix><host><postfix><plugin><type><name>"
471 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
473 Specify a character to replace dots (.) in the host part of the metric name.
474 In I<Graphite> metric name, dots are used as separators between different
475 metric parts (host, plugin, type).
476 Default is "_" (I<Underscore>).
480 =head2 Plugin C<apache>
482 To configure the C<apache>-plugin you first need to configure the Apache
483 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
484 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
485 the following snipped to base your Apache config upon:
488 <IfModule mod_status.c>
489 <Location /mod_status>
490 SetHandler server-status
494 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
495 also supported. It introduces a new field, called C<BusyServers>, to count the
496 number of currently connected clients. This field is also supported.
498 The configuration of the I<Apache> plugin consists of one or more
499 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
500 as the instance name. For example:
504 URL "http://www1.example.com/mod_status?auto"
507 URL "http://www2.example.com/mod_status?auto"
511 The instance name will be used as the I<plugin instance>. To emulate the old
512 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
513 plugin to work correctly, each instance name must be unique. This is not
514 enforced by the plugin and it is your responsibility to ensure it.
516 The following options are accepted within each I<Instance> block:
520 =item B<URL> I<http://host/mod_status?auto>
522 Sets the URL of the C<mod_status> output. This needs to be the output generated
523 by C<ExtendedStatus on> and it needs to be the machine readable output
524 generated by appending the C<?auto> argument. This option is I<mandatory>.
526 =item B<User> I<Username>
528 Optional user name needed for authentication.
530 =item B<Password> I<Password>
532 Optional password needed for authentication.
534 =item B<VerifyPeer> B<true|false>
536 Enable or disable peer SSL certificate verification. See
537 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
539 =item B<VerifyHost> B<true|false>
541 Enable or disable peer host name verification. If enabled, the plugin checks
542 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
543 certificate matches the host name provided by the B<URL> option. If this
544 identity check fails, the connection is aborted. Obviously, only works when
545 connecting to a SSL enabled server. Enabled by default.
547 =item B<CACert> I<File>
549 File that holds one or more SSL certificates. If you want to use HTTPS you will
550 possibly need this option. What CA certificates come bundled with C<libcurl>
551 and are checked by default depends on the distribution you use.
555 =head2 Plugin C<apcups>
559 =item B<Host> I<Hostname>
561 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
562 that IPv6 support has been disabled unless someone can confirm or decline that
563 B<apcupsd> can handle it.
565 =item B<Port> I<Port>
567 TCP-Port to connect to. Defaults to B<3551>.
571 =head2 Plugin C<ascent>
573 This plugin collects information about an Ascent server, a free server for the
574 "World of Warcraft" game. This plugin gathers the information by fetching the
575 XML status page using C<libcurl> and parses it using C<libxml2>.
577 The configuration options are the same as for the C<apache> plugin above:
581 =item B<URL> I<http://localhost/ascent/status/>
583 Sets the URL of the XML status output.
585 =item B<User> I<Username>
587 Optional user name needed for authentication.
589 =item B<Password> I<Password>
591 Optional password needed for authentication.
593 =item B<VerifyPeer> B<true|false>
595 Enable or disable peer SSL certificate verification. See
596 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
598 =item B<VerifyHost> B<true|false>
600 Enable or disable peer host name verification. If enabled, the plugin checks
601 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
602 certificate matches the host name provided by the B<URL> option. If this
603 identity check fails, the connection is aborted. Obviously, only works when
604 connecting to a SSL enabled server. Enabled by default.
606 =item B<CACert> I<File>
608 File that holds one or more SSL certificates. If you want to use HTTPS you will
609 possibly need this option. What CA certificates come bundled with C<libcurl>
610 and are checked by default depends on the distribution you use.
614 =head2 Plugin C<bind>
616 Starting with BIND 9.5.0, the most widely used DNS server software provides
617 extensive statistics about queries, responses and lots of other information.
618 The bind plugin retrieves this information that's encoded in XML and provided
619 via HTTP and submits the values to collectd.
621 To use this plugin, you first need to tell BIND to make this information
622 available. This is done with the C<statistics-channels> configuration option:
624 statistics-channels {
625 inet localhost port 8053;
628 The configuration follows the grouping that can be seen when looking at the
629 data with an XSLT compatible viewer, such as a modern web browser. It's
630 probably a good idea to make yourself familiar with the provided values, so you
631 can understand what the collected statistics actually mean.
636 URL "http://localhost:8053/"
651 Zone "127.in-addr.arpa/IN"
655 The bind plugin accepts the following configuration options:
661 URL from which to retrieve the XML data. If not specified,
662 C<http://localhost:8053/> will be used.
664 =item B<ParseTime> B<true>|B<false>
666 When set to B<true>, the time provided by BIND will be parsed and used to
667 dispatch the values. When set to B<false>, the local time source is queried.
669 This setting is set to B<true> by default for backwards compatibility; setting
670 this to B<false> is I<recommended> to avoid problems with timezones and
673 =item B<OpCodes> B<true>|B<false>
675 When enabled, statistics about the I<"OpCodes">, for example the number of
676 C<QUERY> packets, are collected.
680 =item B<QTypes> B<true>|B<false>
682 When enabled, the number of I<incoming> queries by query types (for example
683 C<A>, C<MX>, C<AAAA>) is collected.
687 =item B<ServerStats> B<true>|B<false>
689 Collect global server statistics, such as requests received over IPv4 and IPv6,
690 successful queries, and failed updates.
694 =item B<ZoneMaintStats> B<true>|B<false>
696 Collect zone maintenance statistics, mostly information about notifications
697 (zone updates) and zone transfers.
701 =item B<ResolverStats> B<true>|B<false>
703 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
704 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
705 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
706 default. Use the B<ResolverStats> option within a B<View "_default"> block
707 instead for the same functionality.
713 Collect global memory statistics.
717 =item B<View> I<Name>
719 Collect statistics about a specific I<"view">. BIND can behave different,
720 mostly depending on the source IP-address of the request. These different
721 configurations are called "views". If you don't use this feature, you most
722 likely are only interested in the C<_default> view.
724 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
725 information you want to collect about a view. If no B<View> block is
726 configured, no detailed view statistics will be collected.
730 =item B<QTypes> B<true>|B<false>
732 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
737 =item B<ResolverStats> B<true>|B<false>
739 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
740 (e.E<nbsp>g. queries over IPv4, lame servers).
744 =item B<CacheRRSets> B<true>|B<false>
746 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
747 type is collected. Negative entries (queries which resulted in an error, for
748 example names that do not exist) are reported with a leading exclamation mark,
753 =item B<Zone> I<Name>
755 When given, collect detailed information about the given zone in the view. The
756 information collected if very similar to the global B<ServerStats> information
759 You can repeat this option to collect detailed information about multiple
762 By default no detailed zone information is collected.
768 =head2 Plugin C<cpufreq>
770 This plugin doesn't have any options. It reads
771 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
772 installed) to get the current CPU frequency. If this file does not exist make
773 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
774 installed and an "cpu governor" (that's a kernel module) is loaded.
780 =item B<DataDir> I<Directory>
782 Set the directory to store CSV-files under. Per default CSV-files are generated
783 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
784 The special strings B<stdout> and B<stderr> can be used to write to the standard
785 output and standard error channels, respectively. This, of course, only makes
786 much sense when collectd is running in foreground- or non-daemon-mode.
788 =item B<StoreRates> B<true|false>
790 If set to B<true>, convert counter values to rates. If set to B<false> (the
791 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
796 =head2 Plugin C<curl>
798 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
799 and the match infrastructure (the same code used by the tail plugin) to use
800 regular expressions with the received data.
802 The following example will read the current value of AMD stock from Google's
803 finance page and dispatch the value to collectd.
806 <Page "stock_quotes">
807 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
811 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
812 DSType "GaugeAverage"
813 # Note: `stock_value' is not a standard type.
820 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
821 a web page and one or more "matches" to be performed on the returned data. The
822 string argument to the B<Page> block is used as plugin instance.
824 The following options are valid within B<Page> blocks:
830 URL of the web site to retrieve. Since a regular expression will be used to
831 extract information from this data, non-binary data is a big plus here ;)
833 =item B<User> I<Name>
835 Username to use if authorization is required to read the page.
837 =item B<Password> I<Password>
839 Password to use if authorization is required to read the page.
841 =item B<VerifyPeer> B<true>|B<false>
843 Enable or disable peer SSL certificate verification. See
844 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
846 =item B<VerifyHost> B<true>|B<false>
848 Enable or disable peer host name verification. If enabled, the plugin checks if
849 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
850 matches the host name provided by the B<URL> option. If this identity check
851 fails, the connection is aborted. Obviously, only works when connecting to a
852 SSL enabled server. Enabled by default.
854 =item B<CACert> I<file>
856 File that holds one or more SSL certificates. If you want to use HTTPS you will
857 possibly need this option. What CA certificates come bundled with C<libcurl>
858 and are checked by default depends on the distribution you use.
860 =item B<MeasureResponseTime> B<true>|B<false>
862 Measure response time for the request. If this setting is enabled, B<Match>
863 blocks (see below) are optional. Disabled by default.
865 =item B<E<lt>MatchE<gt>>
867 One or more B<Match> blocks that define how to match information in the data
868 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
869 used by the C<tail> plugin, so please see the documentation of the C<tail>
870 plugin below on how matches are defined. If the B<MeasureResponseTime> option
871 is set to B<true>, B<Match> blocks are optional.
875 =head2 Plugin C<curl_json>
877 The B<curl_json plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and
878 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) to retrieve JSON data
879 via cURL. This can be used to collect values from CouchDB documents (which are
880 stored JSON notation), for example.
882 The following example will collect several values from the built-in `_stats'
883 runtime statistics module of CouchDB
884 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
887 <URL "http://localhost:5984/_stats">
889 <Key "httpd/requests/count">
893 <Key "httpd_request_methods/*/count">
894 Type "http_request_methods"
897 <Key "httpd_status_codes/*/count">
898 Type "http_response_codes"
903 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining
904 a URL to be fetched via HTTP (using libcurl) and one or more B<Key> blocks.
905 The B<Key> string argument must be in a path format, which is used to collect a
906 value from a JSON map object. If a path element of B<Key> is the
907 I<*>E<nbsp>wildcard, the values for all keys will be collectd.
909 The following options are valid within B<URL> blocks:
913 =item B<Instance> I<Instance>
915 Sets the plugin instance to I<Instance>.
917 =item B<User> I<Name>
919 Username to use if authorization is required to read the page.
921 =item B<Password> I<Password>
923 Password to use if authorization is required to read the page.
925 =item B<VerifyPeer> B<true>|B<false>
927 Enable or disable peer SSL certificate verification. See
928 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
930 =item B<VerifyHost> B<true>|B<false>
932 Enable or disable peer host name verification. If enabled, the plugin checks if
933 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
934 matches the host name provided by the B<URL> option. If this identity check
935 fails, the connection is aborted. Obviously, only works when connecting to a
936 SSL enabled server. Enabled by default.
938 =item B<CACert> I<file>
940 File that holds one or more SSL certificates. If you want to use HTTPS you will
941 possibly need this option. What CA certificates come bundled with C<libcurl>
942 and are checked by default depends on the distribution you use.
946 The following options are valid within B<Key> blocks:
950 =item B<Type> I<Type>
952 Sets the type used to dispatch the values to the daemon. Detailed information
953 about types and their configuration can be found in L<types.db(5)>. This
956 =item B<Instance> I<Instance>
958 Type-instance to use. Defaults to the current map key or current string array element value.
962 =head2 Plugin C<curl_xml>
964 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
965 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
968 <URL "http://localhost/stats.xml">
970 Instance "some_instance"
975 CACert "/path/to/ca.crt"
977 <XPath "table[@id=\"magic_level\"]/tr">
979 #InstancePrefix "prefix-"
981 ValuesFrom "td[2]/span[@class=\"level\"]"
986 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
987 URL to be fetched using libcurl. Within each B<URL> block there are
988 options which specify the connection parameters, for example authentication
989 information, and one or more B<XPath> blocks.
991 Each B<XPath> block specifies how to get one type of information. The
992 string argument must be a valid XPath expression which returns a list
993 of "base elements". One value is dispatched for each "base element". The
994 I<type instance> and values are looked up using further I<XPath> expressions
995 that should be relative to the base element.
997 Within the B<URL> block the following options are accepted:
1001 =item B<Host> I<Name>
1003 Use I<Name> as the host name when submitting values. Defaults to the global
1006 =item B<Instance> I<Instance>
1008 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1009 empty string (no plugin instance).
1011 =item B<User> I<User>
1012 =item B<Password> I<Password>
1013 =item B<VerifyPeer> B<true>|B<false>
1014 =item B<VerifyHost> B<true>|B<false>
1015 =item B<CACert> I<CA Cert File>
1017 These options behave exactly equivalent to the appropriate options of the
1018 I<cURL> and I<cURL-JSON> plugins. Please see there for a detailed description.
1020 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1022 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1023 B<XPath> block specifies how to get one type of information. The string
1024 argument must be a valid XPath expression which returns a list of "base
1025 elements". One value is dispatched for each "base element".
1027 Within the B<XPath> block the following options are accepted:
1031 =item B<Type> I<Type>
1033 Specifies the I<Type> used for submitting patches. This determines the number
1034 of values that are required / expected and whether the strings are parsed as
1035 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1036 This option is required.
1038 =item B<InstancePrefix> I<InstancePrefix>
1040 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1041 concatenated together without any separator.
1042 This option is optional.
1044 =item B<InstanceFrom> I<InstanceFrom>
1046 Specifies a XPath expression to use for determining the I<type instance>. The
1047 XPath expression must return exactly one element. The element's value is then
1048 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1050 This value is required. As a special exception, if the "base XPath expression"
1051 (the argument to the B<XPath> block) returns exactly one argument, then this
1052 option may be omitted.
1054 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1056 Specifies one or more XPath expression to use for reading the values. The
1057 number of XPath expressions must match the number of data sources in the
1058 I<type> specified with B<Type> (see above). Each XPath expression must return
1059 exactly one element. The element's value is then parsed as a number and used as
1060 value for the appropriate value in the value list dispatched to the daemon.
1066 =head2 Plugin C<dbi>
1068 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1069 connect to various databases, execute I<SQL> statements and read back the
1070 results. I<dbi> is an acronym for "database interface" in case you were
1071 wondering about the name. You can configure how each column is to be
1072 interpreted and the plugin will generate one or more data sets from each row
1073 returned according to these rules.
1075 Because the plugin is very generic, the configuration is a little more complex
1076 than those of other plugins. It usually looks something like this:
1079 <Query "out_of_stock">
1080 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1081 # Use with MySQL 5.0.0 or later
1085 InstancePrefix "out_of_stock"
1086 InstancesFrom "category"
1090 <Database "product_information">
1092 DriverOption "host" "localhost"
1093 DriverOption "username" "collectd"
1094 DriverOption "password" "aZo6daiw"
1095 DriverOption "dbname" "prod_info"
1096 SelectDB "prod_info"
1097 Query "out_of_stock"
1101 The configuration above defines one query with one result and one database. The
1102 query is then linked to the database with the B<Query> option I<within> the
1103 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1104 and you can also use the B<Include> statement to split up the configuration
1105 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1106 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1109 The following is a complete list of options:
1111 =head3 B<Query> blocks
1113 Query blocks define I<SQL> statements and how the returned data should be
1114 interpreted. They are identified by the name that is given in the opening line
1115 of the block. Thus the name needs to be unique. Other than that, the name is
1116 not used in collectd.
1118 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1119 define which column holds which value or instance information. You can use
1120 multiple B<Result> blocks to create multiple values from one returned row. This
1121 is especially useful, when queries take a long time and sending almost the same
1122 query again and again is not desirable.
1126 <Query "environment">
1127 Statement "select station, temperature, humidity from environment"
1130 # InstancePrefix "foo"
1131 InstancesFrom "station"
1132 ValuesFrom "temperature"
1136 InstancesFrom "station"
1137 ValuesFrom "humidity"
1141 The following options are accepted:
1145 =item B<Statement> I<SQL>
1147 Sets the statement that should be executed on the server. This is B<not>
1148 interpreted by collectd, but simply passed to the database server. Therefore,
1149 the SQL dialect that's used depends on the server collectd is connected to.
1151 The query has to return at least two columns, one for the instance and one
1152 value. You cannot omit the instance, even if the statement is guaranteed to
1153 always return exactly one line. In that case, you can usually specify something
1156 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1158 (That works with MySQL but may not be valid SQL according to the spec. If you
1159 use a more strict database server, you may have to select from a dummy table or
1162 Please note that some databases, for example B<Oracle>, will fail if you
1163 include a semicolon at the end of the statement.
1165 =item B<MinVersion> I<Version>
1167 =item B<MaxVersion> I<Value>
1169 Only use this query for the specified database version. You can use these
1170 options to provide multiple queries with the same name but with a slightly
1171 different syntax. The plugin will use only those queries, where the specified
1172 minimum and maximum versions fit the version of the database in use.
1174 The database version is determined by C<dbi_conn_get_engine_version>, see the
1175 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1176 for details. Basically, each part of the version is assumed to be in the range
1177 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1178 "40102", version "5.0.42" becomes "50042".
1180 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1181 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1182 happen. Don't to it! A valid example would be something along these lines:
1193 In the above example, there are three ranges that don't overlap. The last one
1194 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1195 before "4.0.0" are not specified.
1197 =item B<Type> I<Type>
1199 The B<type> that's used for each line returned. See L<types.db(5)> for more
1200 details on how types are defined. In short: A type is a predefined layout of
1201 data and the number of values and type of values has to match the type
1204 If you specify "temperature" here, you need exactly one gauge column. If you
1205 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1208 There must be exactly one B<Type> option inside each B<Result> block.
1210 =item B<InstancePrefix> I<prefix>
1212 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1213 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1214 all strings returned in the appropriate columns are concatenated together,
1215 separated by dashes I<("-")>.
1217 =item B<InstancesFrom> I<column0> [I<column1> ...]
1219 Specifies the columns whose values will be used to create the "type-instance"
1220 for each row. If you specify more than one column, the value of all columns
1221 will be joined together with dashes I<("-")> as separation characters.
1223 The plugin itself does not check whether or not all built instances are
1224 different. It's your responsibility to assure that each is unique. This is
1225 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1226 sure that only one row is returned in this case.
1228 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1231 =item B<ValuesFrom> I<column0> [I<column1> ...]
1233 Names the columns whose content is used as the actual data for the data sets
1234 that are dispatched to the daemon. How many such columns you need is determined
1235 by the B<Type> setting above. If you specify too many or not enough columns,
1236 the plugin will complain about that and no data will be submitted to the
1239 The actual data type in the columns is not that important. The plugin will
1240 automatically cast the values to the right type if it know how to do that. So
1241 it should be able to handle integer an floating point types, as well as strings
1242 (if they include a number at the beginning).
1244 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1246 =item B<MetadataFrom> [I<column0> I<column1> ...]
1248 Names the columns whose content is used as metadata for the data sets
1249 that are dispatched to the daemon.
1251 The actual data type in the columns is not that important. The plugin will
1252 automatically cast the values to the right type if it know how to do that. So
1253 it should be able to handle integer an floating point types, as well as strings
1254 (if they include a number at the beginning).
1258 =head3 B<Database> blocks
1260 Database blocks define a connection to a database and which queries should be
1261 sent to that database. Since the used "dbi" library can handle a wide variety
1262 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1263 documentationE<nbsp>- we stick as close to the terminology used there.
1265 Each database needs a "name" as string argument in the starting tag of the
1266 block. This name will be used as "PluginInstance" in the values submitted to
1267 the daemon. Other than that, that name is not used.
1271 =item B<Driver> I<Driver>
1273 Specifies the driver to use to connect to the database. In many cases those
1274 drivers are named after the database they can connect to, but this is not a
1275 technical necessity. These drivers are sometimes referred to as "DBD",
1276 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1277 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1278 project at L<http://libdbi-drivers.sourceforge.net/>.
1280 You need to give the driver name as expected by the "dbi" library here. You
1281 should be able to find that in the documentation for each driver. If you
1282 mistype the driver name, the plugin will dump a list of all known driver names
1285 =item B<DriverOption> I<Key> I<Value>
1287 Sets driver-specific options. What option a driver supports can be found in the
1288 documentation for each driver, somewhere at
1289 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1290 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1292 Unfortunately, drivers are not too keen to report errors when an unknown option
1293 is passed to them, so invalid settings here may go unnoticed. This is not the
1294 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1295 the driver. If a driver complains about an option, the plugin will dump a
1296 complete list of all options understood by that driver to the log.
1298 =item B<SelectDB> I<Database>
1300 In some cases, the database name you connect with is not the database name you
1301 want to use for querying data. If this option is set, the plugin will "select"
1302 (switch to) that database after the connection is established.
1304 =item B<Query> I<QueryName>
1306 Associates the query named I<QueryName> with this database connection. The
1307 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1308 blocks you want to refer to must be placed above the database block you want to
1317 =item B<Device> I<Device>
1319 Select partitions based on the devicename.
1321 =item B<MountPoint> I<Directory>
1323 Select partitions based on the mountpoint.
1325 =item B<FSType> I<FSType>
1327 Select partitions based on the filesystem type.
1329 =item B<IgnoreSelected> B<true>|B<false>
1331 Invert the selection: If set to true, all partitions B<except> the ones that
1332 match any one of the criteria are collected. By default only selected
1333 partitions are collected if a selection is made. If no selection is configured
1334 at all, B<all> partitions are selected.
1336 =item B<ReportByDevice> B<true>|B<false>
1338 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1339 (the default), it will report a disk as "root", but with it I<true>, it will be
1340 "sda1" (or whichever).
1342 =item B<ReportInodes> B<true>|B<false>
1344 Enables or disables reporting of free, reserved and used inodes. Defaults to
1345 inode collection being disabled.
1347 Enable this option if inodes are a scarce resource for you, usually because
1348 many small files are stored on the disk. This is a usual scenario for mail
1349 transfer agents and web caches.
1353 =head2 Plugin C<disk>
1355 The C<disk> plugin collects information about the usage of physical disks and
1356 logical disks (partitions). Values collected are the number of octets written
1357 to and read from a disk or partition, the number of read/write operations
1358 issued to the disk and a rather complex "time" it took for these commands to be
1361 Using the following two options you can ignore some disks or configure the
1362 collection only of specific disks.
1366 =item B<Disk> I<Name>
1368 Select the disk I<Name>. Whether it is collected or ignored depends on the
1369 B<IgnoreSelected> setting, see below. As with other plugins that use the
1370 daemon's ignorelist functionality, a string that starts and ends with a slash
1371 is interpreted as a regular expression. Examples:
1376 =item B<IgnoreSelected> B<true>|B<false>
1378 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1379 statements, are ignored or if all other disks are ignored. The behavior
1380 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1381 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1382 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1383 is set to B<true>, all disks are collected B<except> the ones matched.
1387 =head2 Plugin C<dns>
1391 =item B<Interface> I<Interface>
1393 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1394 option sets the interface that should be used. If this option is not set, or
1395 set to "any", the plugin will try to get packets from B<all> interfaces. This
1396 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1398 =item B<IgnoreSource> I<IP-address>
1400 Ignore packets that originate from this address.
1402 =item B<SelectNumericQueryTypes> B<true>|B<false>
1404 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1408 =head2 Plugin C<email>
1412 =item B<SocketFile> I<Path>
1414 Sets the socket-file which is to be created.
1416 =item B<SocketGroup> I<Group>
1418 If running as root change the group of the UNIX-socket after it has been
1419 created. Defaults to B<collectd>.
1421 =item B<SocketPerms> I<Permissions>
1423 Change the file permissions of the UNIX-socket after it has been created. The
1424 permissions must be given as a numeric, octal value as you would pass to
1425 L<chmod(1)>. Defaults to B<0770>.
1427 =item B<MaxConns> I<Number>
1429 Sets the maximum number of connections that can be handled in parallel. Since
1430 this many threads will be started immediately setting this to a very high
1431 value will waste valuable resources. Defaults to B<5> and will be forced to be
1432 at most B<16384> to prevent typos and dumb mistakes.
1436 =head2 Plugin C<ethstat>
1438 The I<ethstat plugin> collects information about network interface cards (NICs)
1439 by talking directly with the underlying kernel driver using L<ioctl(2)>.
1445 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
1446 Map "multicast" "if_multicast"
1453 =item B<Interface> I<Name>
1455 Collect statistical information about interface I<Name>.
1457 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
1459 By default, the plugin will submit values as type C<derive> and I<type
1460 instance> set to I<Name>, the name of the metric as reported by the driver. If
1461 an appropriate B<Map> option exists, the given I<Type> and, optionally,
1462 I<TypeInstance> will be used.
1464 =item B<MappedOnly> B<true>|B<false>
1466 When set to B<true>, only metrics that can be mapped to to a I<type> will be
1467 collected, all other metrics will be ignored. Defaults to B<false>.
1471 =head2 Plugin C<exec>
1473 Please make sure to read L<collectd-exec(5)> before using this plugin. It
1474 contains valuable information on when the executable is executed and the
1475 output that is expected from it.
1479 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1481 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1483 Execute the executable I<Executable> as user I<User>. If the user name is
1484 followed by a colon and a group name, the effective group is set to that group.
1485 The real group and saved-set group will be set to the default group of that
1486 user. If no group is given the effective group ID will be the same as the real
1489 Please note that in order to change the user and/or group the daemon needs
1490 superuser privileges. If the daemon is run as an unprivileged user you must
1491 specify the same user/group here. If the daemon is run with superuser
1492 privileges, you must supply a non-root user here.
1494 The executable may be followed by optional arguments that are passed to the
1495 program. Please note that due to the configuration parsing numbers and boolean
1496 values may be changed. If you want to be absolutely sure that something is
1497 passed as-is please enclose it in quotes.
1499 The B<Exec> and B<NotificationExec> statements change the semantics of the
1500 programs executed, i.E<nbsp>e. the data passed to them and the response
1501 expected from them. This is documented in great detail in L<collectd-exec(5)>.
1505 =head2 Plugin C<filecount>
1507 The C<filecount> plugin counts the number of files in a certain directory (and
1508 its subdirectories) and their combined size. The configuration is very straight
1511 <Plugin "filecount">
1512 <Directory "/var/qmail/queue/mess">
1513 Instance "qmail-message"
1515 <Directory "/var/qmail/queue/todo">
1516 Instance "qmail-todo"
1518 <Directory "/var/lib/php5">
1519 Instance "php5-sessions"
1524 The example above counts the number of files in QMail's queue directories and
1525 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
1526 QMail has not yet looked at, the "message" queue holds the messages that were
1527 classified into "local" and "remote".
1529 As you can see, the configuration consists of one or more C<Directory> blocks,
1530 each of which specifies a directory in which to count the files. Within those
1531 blocks, the following options are recognized:
1535 =item B<Instance> I<Instance>
1537 Sets the plugin instance to I<Instance>. That instance name must be unique, but
1538 it's your responsibility, the plugin doesn't check for that. If not given, the
1539 instance is set to the directory name with all slashes replaced by underscores
1540 and all leading underscores removed.
1542 =item B<Name> I<Pattern>
1544 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
1545 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
1546 against the pattern, not the entire path. In case this makes it easier for you:
1547 This option has been named after the B<-name> parameter to L<find(1)>.
1549 =item B<MTime> I<Age>
1551 Count only files of a specific age: If I<Age> is greater than zero, only files
1552 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
1553 a negative number, this is inversed. For example, if B<-60> is specified, only
1554 files that have been modified in the last minute will be counted.
1556 The number can also be followed by a "multiplier" to easily specify a larger
1557 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
1558 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
1559 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
1560 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
1561 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
1564 =item B<Size> I<Size>
1566 Count only files of a specific size. When I<Size> is a positive number, only
1567 files that are at least this big are counted. If I<Size> is a negative number,
1568 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
1569 I<Size> are counted.
1571 As with the B<MTime> option, a "multiplier" may be added. For a detailed
1572 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
1573 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
1574 note that there are 1000 bytes in a kilobyte, not 1024.
1576 =item B<Recursive> I<true>|I<false>
1578 Controls whether or not to recurse into subdirectories. Enabled by default.
1580 =item B<IncludeHidden> I<true>|I<false>
1582 Controls whether or not to include "hidden" files and directories in the count.
1583 "Hidden" files and directories are those, whose name begins with a dot.
1584 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
1588 =head2 Plugin C<GenericJMX>
1590 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
1591 L<collectd-java(5)>.
1593 =head2 Plugin C<gmond>
1595 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
1596 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
1597 are built-in, custom mappings may be added via B<Metric> blocks, see below.
1602 MCReceiveFrom "239.2.11.71" "8649"
1603 <Metric "swap_total">
1605 TypeInstance "total"
1608 <Metric "swap_free">
1615 The following metrics are built-in:
1621 load_one, load_five, load_fifteen
1625 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
1629 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
1641 Available configuration options:
1645 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
1647 Sets sets the multicast group and UDP port to which to subscribe.
1649 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
1651 =item E<lt>B<Metric> I<Name>E<gt>
1653 These blocks add a new metric conversion to the internal table. I<Name>, the
1654 string argument to the B<Metric> block, is the metric name as used by Ganglia.
1658 =item B<Type> I<Type>
1660 Type to map this metric to. Required.
1662 =item B<TypeInstance> I<Instance>
1664 Type-instance to use. Optional.
1666 =item B<DataSource> I<Name>
1668 Data source to map this metric to. If the configured type has exactly one data
1669 source, this is optional. Otherwise the option is required.
1675 =head2 Plugin C<hddtemp>
1677 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
1678 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
1679 default values, see below. C<hddtemp> has to be running to work correctly. If
1680 C<hddtemp> is not running timeouts may appear which may interfere with other
1683 The B<hddtemp> homepage can be found at
1684 L<http://www.guzu.net/linux/hddtemp.php>.
1688 =item B<Host> I<Hostname>
1690 Hostname to connect to. Defaults to B<127.0.0.1>.
1692 =item B<Port> I<Port>
1694 TCP-Port to connect to. Defaults to B<7634>.
1698 =head2 Plugin C<interface>
1702 =item B<Interface> I<Interface>
1704 Select this interface. By default these interfaces will then be collected. For
1705 a more detailed description see B<IgnoreSelected> below.
1707 =item B<IgnoreSelected> I<true>|I<false>
1709 If no configuration if given, the B<traffic>-plugin will collect data from
1710 all interfaces. This may not be practical, especially for loopback- and
1711 similar interfaces. Thus, you can use the B<Interface>-option to pick the
1712 interfaces you're interested in. Sometimes, however, it's easier/preferred
1713 to collect all interfaces I<except> a few ones. This option enables you to
1714 do that: By setting B<IgnoreSelected> to I<true> the effect of
1715 B<Interface> is inverted: All selected interfaces are ignored and all
1716 other interfaces are collected.
1720 =head2 Plugin C<ipmi>
1724 =item B<Sensor> I<Sensor>
1726 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
1728 =item B<IgnoreSelected> I<true>|I<false>
1730 If no configuration if given, the B<ipmi> plugin will collect data from all
1731 sensors found of type "temperature", "voltage", "current" and "fanspeed".
1732 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
1733 the effect of B<Sensor> is inverted: All selected sensors are ignored and
1734 all other sensors are collected.
1736 =item B<NotifySensorAdd> I<true>|I<false>
1738 If a sensor appears after initialization time of a minute a notification
1741 =item B<NotifySensorRemove> I<true>|I<false>
1743 If a sensor disappears a notification is sent.
1745 =item B<NotifySensorNotPresent> I<true>|I<false>
1747 If you have for example dual power supply and one of them is (un)plugged then
1748 a notification is sent.
1752 =head2 Plugin C<iptables>
1756 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
1758 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
1759 will collect the counters of all rules which have a comment-match. The comment
1760 is then used as type-instance.
1762 If I<Comment> or I<Number> is given, only the rule with the matching comment or
1763 the I<n>th rule will be collected. Again, the comment (or the number) will be
1764 used as the type-instance.
1766 If I<Name> is supplied, it will be used as the type-instance instead of the
1767 comment or the number.
1771 =head2 Plugin C<irq>
1777 Select this irq. By default these irqs will then be collected. For a more
1778 detailed description see B<IgnoreSelected> below.
1780 =item B<IgnoreSelected> I<true>|I<false>
1782 If no configuration if given, the B<irq>-plugin will collect data from all
1783 irqs. This may not be practical, especially if no interrupts happen. Thus, you
1784 can use the B<Irq>-option to pick the interrupt you're interested in.
1785 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
1786 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
1787 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
1788 and all other interrupts are collected.
1792 =head2 Plugin C<java>
1794 The I<Java> plugin makes it possible to write extensions for collectd in Java.
1795 This section only discusses the syntax and semantic of the configuration
1796 options. For more in-depth information on the I<Java> plugin, please read
1797 L<collectd-java(5)>.
1802 JVMArg "-verbose:jni"
1803 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
1804 LoadPlugin "org.collectd.java.Foobar"
1805 <Plugin "org.collectd.java.Foobar">
1806 # To be parsed by the plugin
1810 Available configuration options:
1814 =item B<JVMArg> I<Argument>
1816 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
1817 exactly the way the arguments to the I<java> binary on the command line work.
1818 Execute C<javaE<nbsp>--help> for details.
1820 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
1821 any other options! When another option is found, the JVM will be started and
1822 later options will have to be ignored!
1824 =item B<LoadPlugin> I<JavaClass>
1826 Instantiates a new I<JavaClass> object. The constructor of this object very
1827 likely then registers one or more callback methods with the server.
1829 See L<collectd-java(5)> for details.
1831 When the first such option is found, the virtual machine (JVM) is created. This
1832 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
1833 B<LoadPlugin> options!
1835 =item B<Plugin> I<Name>
1837 The entire block is passed to the Java plugin as an
1838 I<org.collectd.api.OConfigItem> object.
1840 For this to work, the plugin has to register a configuration callback first,
1841 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
1842 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
1843 depends on the (Java) plugin registering the callback and is completely
1844 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
1848 =head2 Plugin C<libvirt>
1850 This plugin allows CPU, disk and network load to be collected for virtualized
1851 guests on the machine. This means that these characteristics can be collected
1852 for guest systems without installing any software on them - collectd only runs
1853 on the hosting system. The statistics are collected through libvirt
1854 (L<http://libvirt.org/>).
1856 Only I<Connection> is required.
1860 =item B<Connection> I<uri>
1862 Connect to the hypervisor given by I<uri>. For example if using Xen use:
1864 Connection "xen:///"
1866 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
1868 =item B<RefreshInterval> I<seconds>
1870 Refresh the list of domains and devices every I<seconds>. The default is 60
1871 seconds. Setting this to be the same or smaller than the I<Interval> will cause
1872 the list of domains and devices to be refreshed on every iteration.
1874 Refreshing the devices in particular is quite a costly operation, so if your
1875 virtualization setup is static you might consider increasing this. If this
1876 option is set to 0, refreshing is disabled completely.
1878 =item B<Domain> I<name>
1880 =item B<BlockDevice> I<name:dev>
1882 =item B<InterfaceDevice> I<name:dev>
1884 =item B<IgnoreSelected> I<true>|I<false>
1886 Select which domains and devices are collected.
1888 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
1889 disk/network devices are collected.
1891 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
1892 domains and disk/network devices are ignored, while the rest are collected.
1894 The domain name and device names may use a regular expression, if the name is
1895 surrounded by I</.../> and collectd was compiled with support for regexps.
1897 The default is to collect statistics for all domains and all their devices.
1901 BlockDevice "/:hdb/"
1902 IgnoreSelected "true"
1904 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
1907 =item B<HostnameFormat> B<name|uuid|hostname|...>
1909 When the libvirt plugin logs data, it sets the hostname of the collected data
1910 according to this setting. The default is to use the guest name as provided by
1911 the hypervisor, which is equal to setting B<name>.
1913 B<uuid> means use the guest's UUID. This is useful if you want to track the
1914 same guest across migrations.
1916 B<hostname> means to use the global B<Hostname> setting, which is probably not
1917 useful on its own because all guests will appear to have the same name.
1919 You can also specify combinations of these fields. For example B<name uuid>
1920 means to concatenate the guest name and UUID (with a literal colon character
1921 between, thus I<"foo:1234-1234-1234-1234">).
1923 =item B<InterfaceFormat> B<name>|B<address>
1925 When the libvirt plugin logs interface data, it sets the name of the collected
1926 data according to this setting. The default is to use the path as provided by
1927 the hypervisor (the "dev" property of the target node), which is equal to
1930 B<address> means use the interface's mac address. This is useful since the
1931 interface path might change between reboots of a guest or across migrations.
1935 =head2 Plugin C<logfile>
1939 =item B<LogLevel> B<debug|info|notice|warning|err>
1941 Sets the log-level. If, for example, set to B<notice>, then all events with
1942 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
1944 Please note that B<debug> is only available if collectd has been compiled with
1947 =item B<File> I<File>
1949 Sets the file to write log messages to. The special strings B<stdout> and
1950 B<stderr> can be used to write to the standard output and standard error
1951 channels, respectively. This, of course, only makes much sense when I<collectd>
1952 is running in foreground- or non-daemon-mode.
1954 =item B<Timestamp> B<true>|B<false>
1956 Prefix all lines printed by the current time. Defaults to B<true>.
1958 =item B<PrintSeverity> B<true>|B<false>
1960 When enabled, all lines are prefixed by the severity of the log message, for
1961 example "warning". Defaults to B<false>.
1965 B<Note>: There is no need to notify the daemon after moving or removing the
1966 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
1967 for each line it writes.
1969 =head2 Plugin C<lpar>
1971 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
1972 virtualization technique for IBM POWER processors. It takes into account CPU
1973 time stolen from or donated to a partition, in addition to the usual user,
1974 system, I/O statistics.
1976 The following configuration options are available:
1980 =item B<CpuPoolStats> B<false>|B<true>
1982 When enabled, statistics about the processor pool are read, too. The partition
1983 needs to have pool authority in order to be able to acquire this information.
1986 =item B<ReportBySerial> B<false>|B<true>
1988 If enabled, the serial of the physical machine the partition is currently
1989 running on is reported as I<hostname> and the logical hostname of the machine
1990 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
1991 used (just like other plugins) and the I<plugin instance> will be empty.
1996 =head2 Plugin C<mbmon>
1998 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2000 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2001 B<Host> and B<Port> options can be used to change these values, see below.
2002 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2003 timeouts may appear which may interfere with other statistics..
2005 C<mbmon> must be run with the -r option ("print TAG and Value format");
2006 Debian's F</etc/init.d/mbmon> script already does this, other people
2007 will need to ensure that this is the case.
2011 =item B<Host> I<Hostname>
2013 Hostname to connect to. Defaults to B<127.0.0.1>.
2015 =item B<Port> I<Port>
2017 TCP-Port to connect to. Defaults to B<411>.
2023 The C<md plugin> collects information from Linux Software-RAID devices (md).
2025 All reported values are of the type C<md_disks>. Reported type instances are
2026 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2027 I<missing> (physically absent) disks.
2031 =item B<Device> I<Device>
2033 Select md devices based on device name. The I<device name> is the basename of
2034 the device, i.e. the name of the block device without the leading C</dev/>.
2035 See B<IgnoreSelected> for more details.
2037 =item B<IgnoreSelected> B<true>|B<false>
2039 Invert device selection: If set to B<true>, all md devices B<except> those
2040 listed using B<Device> are collected. If B<false> (the default), only those
2041 listed are collected. If no configuration is given, the B<md> plugin will
2042 collect data from all md devices.
2046 =head2 Plugin C<memcachec>
2048 The C<memcachec plugin> connects to a memcached server, queries one or more
2049 given I<pages> and parses the returned data according to user specification.
2050 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2053 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2054 library. Please note that there is another library with a very similar name,
2055 libmemcache (notice the missing `d'), which is not applicable.
2057 Synopsis of the configuration:
2059 <Plugin "memcachec">
2060 <Page "plugin_instance">
2064 Regex "(\\d+) bytes sent"
2067 Instance "type_instance"
2072 The configuration options are:
2076 =item E<lt>B<Page> I<Name>E<gt>
2078 Each B<Page> block defines one I<page> to be queried from the memcached server.
2079 The block requires one string argument which is used as I<plugin instance>.
2081 =item B<Server> I<Address>
2083 Sets the server address to connect to when querying the page. Must be inside a
2088 When connected to the memcached server, asks for the page I<Key>.
2090 =item E<lt>B<Match>E<gt>
2092 Match blocks define which strings to look for and how matches substrings are
2093 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2097 =head2 Plugin C<memcached>
2099 The C<memcached plugin> connects to a memcached server and queries statistics
2100 about cache utilization, memory and bandwidth used.
2101 L<http://www.danga.com/memcached/>
2103 <Plugin "memcached">
2105 Host "memcache.example.com"
2110 The plugin configuration consists of one or more B<Instance> blocks which
2111 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2112 following options are allowed:
2116 =item B<Host> I<Hostname>
2118 Hostname to connect to. Defaults to B<127.0.0.1>.
2120 =item B<Port> I<Port>
2122 TCP-Port to connect to. Defaults to B<11211>.
2124 =item B<Socket> I<Path>
2126 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2127 setting is given, the B<Host> and B<Port> settings are ignored.
2131 =head2 Plugin C<modbus>
2133 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
2134 register values. It supports reading single registers (unsigned 16E<nbsp>bit
2135 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2136 values (two registers interpreted as IEEE floats in big endian notation).
2140 <Data "voltage-input-1">
2147 <Data "voltage-input-2">
2154 <Host "modbus.example.com">
2155 Address "192.168.0.42"
2160 Instance "power-supply"
2161 Collect "voltage-input-1"
2162 Collect "voltage-input-2"
2168 =item E<lt>B<Data> I<Name>E<gt> blocks
2170 Data blocks define a mapping between register numbers and the "types" used by
2173 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
2177 =item B<RegisterBase> I<Number>
2179 Configures the base register to read from the device. If the option
2180 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
2181 register will be read (the register number is increased by one).
2183 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
2185 Specifies what kind of data is returned by the device. If the type is B<Int32>,
2186 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
2187 combined into one value. Defaults to B<Uint16>.
2189 =item B<Type> I<Type>
2191 Specifies the "type" (data set) to use when dispatching the value to
2192 I<collectd>. Currently, only data sets with exactly one data source are
2195 =item B<Instance> I<Instance>
2197 Sets the type instance to use when dispatching the value to I<collectd>. If
2198 unset, an empty string (no type instance) is used.
2202 =item E<lt>B<Host> I<Name>E<gt> blocks
2204 Host blocks are used to specify to which hosts to connect and what data to read
2205 from their "slaves". The string argument I<Name> is used as hostname when
2206 dispatching the values to I<collectd>.
2208 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
2212 =item B<Address> I<Hostname>
2214 Specifies the node name (the actual network address) used to connect to the
2215 host. This may be an IP address or a hostname. Please note that the used
2216 I<libmodbus> library only supports IPv4 at the moment.
2218 =item B<Port> I<Service>
2220 Specifies the port used to connect to the host. The port can either be given as
2221 a number or as a service name. Please note that the I<Service> argument must be
2222 a string, even if ports are given in their numerical form. Defaults to "502".
2224 =item B<Interval> I<Interval>
2226 Sets the interval (in seconds) in which the values will be collected from this
2227 host. By default the global B<Interval> setting will be used.
2229 =item E<lt>B<Slave> I<ID>E<gt>
2231 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
2232 is used to specify which device should be addressed. For each device you want
2233 to query, one B<Slave> block must be given.
2235 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
2239 =item B<Instance> I<Instance>
2241 Specify the plugin instance to use when dispatching the values to I<collectd>.
2242 By default "slave_I<ID>" is used.
2244 =item B<Collect> I<DataName>
2246 Specifies which data to retrieve from the device. I<DataName> must be the same
2247 string as the I<Name> argument passed to a B<Data> block. You can specify this
2248 option multiple times to collect more than one value from a slave. At least one
2249 B<Collect> option is mandatory.
2257 =head2 Plugin C<mysql>
2259 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
2260 one or more databases when started and keeps the connection up as long as
2261 possible. When the connection is interrupted for whatever reason it will try
2262 to re-connect. The plugin will complain loudly in case anything goes wrong.
2264 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
2265 and collects information about MySQL network traffic, executed statements,
2266 requests, the query cache and threads by evaluating the
2267 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
2268 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
2269 Status Variables> for an explanation of these values.
2271 Optionally, master and slave statistics may be collected in a MySQL
2272 replication setup. In that case, information about the synchronization state
2273 of the nodes are collected by evaluating the C<Position> return value of the
2274 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
2275 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
2276 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
2277 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
2278 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
2293 Socket "/var/run/mysql/mysqld.sock"
2295 SlaveNotifications true
2299 A B<Database> block defines one connection to a MySQL database. It accepts a
2300 single argument which specifies the name of the database. None of the other
2301 options are required. MySQL will use default values as documented in the
2302 section "mysql_real_connect()" in the B<MySQL reference manual>.
2306 =item B<Host> I<Hostname>
2308 Hostname of the database server. Defaults to B<localhost>.
2310 =item B<User> I<Username>
2312 Username to use when connecting to the database. The user does not have to be
2313 granted any privileges (which is synonym to granting the C<USAGE> privilege),
2314 unless you want to collectd replication statistics (see B<MasterStats> and
2315 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
2316 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
2318 =item B<Password> I<Password>
2320 Password needed to log into the database.
2322 =item B<Database> I<Database>
2324 Select this database. Defaults to I<no database> which is a perfectly reasonable
2325 option for what this plugin does.
2327 =item B<Port> I<Port>
2329 TCP-port to connect to. The port must be specified in its numeric form, but it
2330 must be passed as a string nonetheless. For example:
2334 If B<Host> is set to B<localhost> (the default), this setting has no effect.
2335 See the documentation for the C<mysql_real_connect> function for details.
2337 =item B<Socket> I<Socket>
2339 Specifies the path to the UNIX domain socket of the MySQL server. This option
2340 only has any effect, if B<Host> is set to B<localhost> (the default).
2341 Otherwise, use the B<Port> option above. See the documentation for the
2342 C<mysql_real_connect> function for details.
2344 =item B<MasterStats> I<true|false>
2346 =item B<SlaveStats> I<true|false>
2348 Enable the collection of master / slave statistics in a replication setup. In
2349 order to be able to get access to these statistics, the user needs special
2350 privileges. See the B<User> documentation above.
2352 =item B<SlaveNotifications> I<true|false>
2354 If enabled, the plugin sends a notification if the replication slave I/O and /
2355 or SQL threads are not running.
2359 =head2 Plugin C<netapp>
2361 The netapp plugin can collect various performance and capacity information
2362 from a NetApp filer using the NetApp API.
2364 Please note that NetApp has a wide line of products and a lot of different
2365 software versions for each of these products. This plugin was developed for a
2366 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
2367 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
2368 model and software version but it is very hard to test this.
2369 If you have used this plugin with other models and/or software version, feel
2370 free to send us a mail to tell us about the results, even if it's just a short
2373 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
2374 basic authentication.
2376 B<Do not use a regular user for this!> Create a special collectd user with just
2377 the minimum of capabilities needed. The user only needs the "login-http-admin"
2378 capability as well as a few more depending on which data will be collected.
2379 Required capabilities are documented below.
2384 <Host "netapp1.example.com">
2408 IgnoreSelectedIO false
2410 IgnoreSelectedOps false
2411 GetLatency "volume0"
2412 IgnoreSelectedLatency false
2419 IgnoreSelectedCapacity false
2422 IgnoreSelectedSnapshot false
2435 The netapp plugin accepts the following configuration options:
2439 =item B<Host> I<Name>
2441 A host block defines one NetApp filer. It will appear in collectd with the name
2442 you specify here which does not have to be its real name nor its hostname.
2444 =item B<Protocol> B<httpd>|B<http>
2446 The protocol collectd will use to query this host.
2454 Valid options: http, https
2456 =item B<Address> I<Address>
2458 The hostname or IP address of the host.
2464 Default: The "host" block's name.
2466 =item B<Port> I<Port>
2468 The TCP port to connect to on the host.
2474 Default: 80 for protocol "http", 443 for protocol "https"
2476 =item B<User> I<User>
2478 =item B<Password> I<Password>
2480 The username and password to use to login to the NetApp.
2486 =item B<Interval> I<Interval>
2492 The following options decide what kind of data will be collected. You can
2493 either use them as a block and fine tune various parameters inside this block,
2494 use them as a single statement to just accept all default values, or omit it to
2495 not collect any data.
2497 The following options are valid inside all blocks:
2501 =item B<Interval> I<Seconds>
2503 Collect the respective statistics every I<Seconds> seconds. Defaults to the
2504 host specific setting.
2508 =head3 The System block
2510 This will collect various performance data about the whole system.
2512 B<Note:> To get this data the collectd user needs the
2513 "api-perf-object-get-instances" capability.
2517 =item B<Interval> I<Seconds>
2519 Collect disk statistics every I<Seconds> seconds.
2521 =item B<GetCPULoad> B<true>|B<false>
2523 If you set this option to true the current CPU usage will be read. This will be
2524 the average usage between all CPUs in your NetApp without any information about
2527 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2528 returns in the "CPU" field.
2536 Result: Two value lists of type "cpu", and type instances "idle" and "system".
2538 =item B<GetInterfaces> B<true>|B<false>
2540 If you set this option to true the current traffic of the network interfaces
2541 will be read. This will be the total traffic over all interfaces of your NetApp
2542 without any information about individual interfaces.
2544 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2545 in the "Net kB/s" field.
2555 Result: One value list of type "if_octects".
2557 =item B<GetDiskIO> B<true>|B<false>
2559 If you set this option to true the current IO throughput will be read. This
2560 will be the total IO of your NetApp without any information about individual
2561 disks, volumes or aggregates.
2563 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2564 in the "DiskE<nbsp>kB/s" field.
2572 Result: One value list of type "disk_octets".
2574 =item B<GetDiskOps> B<true>|B<false>
2576 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
2577 iSCSI, etc. operations will be read. This will be the total number of
2578 operations on your NetApp without any information about individual volumes or
2581 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2582 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
2590 Result: A variable number of value lists of type "disk_ops_complex". Each type
2591 of operation will result in one value list with the name of the operation as
2596 =head3 The WAFL block
2598 This will collect various performance data about the WAFL file system. At the
2599 moment this just means cache performance.
2601 B<Note:> To get this data the collectd user needs the
2602 "api-perf-object-get-instances" capability.
2604 B<Note:> The interface to get these values is classified as "Diagnostics" by
2605 NetApp. This means that it is not guaranteed to be stable even between minor
2610 =item B<Interval> I<Seconds>
2612 Collect disk statistics every I<Seconds> seconds.
2614 =item B<GetNameCache> B<true>|B<false>
2622 Result: One value list of type "cache_ratio" and type instance
2625 =item B<GetDirCache> B<true>|B<false>
2633 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
2635 =item B<GetInodeCache> B<true>|B<false>
2643 Result: One value list of type "cache_ratio" and type instance
2646 =item B<GetBufferCache> B<true>|B<false>
2648 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
2649 in the "Cache hit" field.
2657 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
2661 =head3 The Disks block
2663 This will collect performance data about the individual disks in the NetApp.
2665 B<Note:> To get this data the collectd user needs the
2666 "api-perf-object-get-instances" capability.
2670 =item B<Interval> I<Seconds>
2672 Collect disk statistics every I<Seconds> seconds.
2674 =item B<GetBusy> B<true>|B<false>
2676 If you set this option to true the busy time of all disks will be calculated
2677 and the value of the busiest disk in the system will be written.
2679 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2680 in the "Disk util" field. Probably.
2688 Result: One value list of type "percent" and type instance "disk_busy".
2692 =head3 The VolumePerf block
2694 This will collect various performance data about the individual volumes.
2696 You can select which data to collect about which volume using the following
2697 options. They follow the standard ignorelist semantic.
2699 B<Note:> To get this data the collectd user needs the
2700 I<api-perf-object-get-instances> capability.
2704 =item B<Interval> I<Seconds>
2706 Collect volume performance data every I<Seconds> seconds.
2708 =item B<GetIO> I<Volume>
2710 =item B<GetOps> I<Volume>
2712 =item B<GetLatency> I<Volume>
2714 Select the given volume for IO, operations or latency statistics collection.
2715 The argument is the name of the volume without the C</vol/> prefix.
2717 Since the standard ignorelist functionality is used here, you can use a string
2718 starting and ending with a slash to specify regular expression matching: To
2719 match the volumes "vol0", "vol2" and "vol7", you can use this regular
2722 GetIO "/^vol[027]$/"
2724 If no regular expression is specified, an exact match is required. Both,
2725 regular and exact matching are case sensitive.
2727 If no volume was specified at all for either of the three options, that data
2728 will be collected for all available volumes.
2730 =item B<IgnoreSelectedIO> B<true>|B<false>
2732 =item B<IgnoreSelectedOps> B<true>|B<false>
2734 =item B<IgnoreSelectedLatency> B<true>|B<false>
2736 When set to B<true>, the volumes selected for IO, operations or latency
2737 statistics collection will be ignored and the data will be collected for all
2740 When set to B<false>, data will only be collected for the specified volumes and
2741 all other volumes will be ignored.
2743 If no volumes have been specified with the above B<Get*> options, all volumes
2744 will be collected regardless of the B<IgnoreSelected*> option.
2746 Defaults to B<false>
2750 =head3 The VolumeUsage block
2752 This will collect capacity data about the individual volumes.
2754 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
2759 =item B<Interval> I<Seconds>
2761 Collect volume usage statistics every I<Seconds> seconds.
2763 =item B<GetCapacity> I<VolumeName>
2765 The current capacity of the volume will be collected. This will result in two
2766 to four value lists, depending on the configuration of the volume. All data
2767 sources are of type "df_complex" with the name of the volume as
2770 There will be type_instances "used" and "free" for the number of used and
2771 available bytes on the volume. If the volume has some space reserved for
2772 snapshots, a type_instance "snap_reserved" will be available. If the volume
2773 has SIS enabled, a type_instance "sis_saved" will be available. This is the
2774 number of bytes saved by the SIS feature.
2776 B<Note:> The current NetApp API has a bug that results in this value being
2777 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
2778 number which works most of the time. If you see strange values here, bug
2779 NetApp support to fix this.
2781 Repeat this option to specify multiple volumes.
2783 =item B<IgnoreSelectedCapacity> B<true>|B<false>
2785 Specify whether to collect only the volumes selected by the B<GetCapacity>
2786 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
2787 B<false>. However, if no B<GetCapacity> option is specified at all, all
2788 capacities will be selected anyway.
2790 =item B<GetSnapshot> I<VolumeName>
2792 Select volumes from which to collect snapshot information.
2794 Usually, the space used for snapshots is included in the space reported as
2795 "used". If snapshot information is collected as well, the space used for
2796 snapshots is subtracted from the used space.
2798 To make things even more interesting, it is possible to reserve space to be
2799 used for snapshots. If the space required for snapshots is less than that
2800 reserved space, there is "reserved free" and "reserved used" space in addition
2801 to "free" and "used". If the space required for snapshots exceeds the reserved
2802 space, that part allocated in the normal space is subtracted from the "used"
2805 Repeat this option to specify multiple volumes.
2807 =item B<IgnoreSelectedSnapshot>
2809 Specify whether to collect only the volumes selected by the B<GetSnapshot>
2810 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
2811 B<false>. However, if no B<GetSnapshot> option is specified at all, all
2812 capacities will be selected anyway.
2816 =head2 Plugin C<netlink>
2818 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
2819 statistics of various interface and routing aspects.
2823 =item B<Interface> I<Interface>
2825 =item B<VerboseInterface> I<Interface>
2827 Instruct the plugin to collect interface statistics. This is basically the same
2828 as the statistics provided by the C<interface> plugin (see above) but
2829 potentially much more detailed.
2831 When configuring with B<Interface> only the basic statistics will be collected,
2832 namely octets, packets, and errors. These statistics are collected by
2833 the C<interface> plugin, too, so using both at the same time is no benefit.
2835 When configured with B<VerboseInterface> all counters B<except> the basic ones,
2836 so that no data needs to be collected twice if you use the C<interface> plugin.
2837 This includes dropped packets, received multicast packets, collisions and a
2838 whole zoo of differentiated RX and TX errors. You can try the following command
2839 to get an idea of what awaits you:
2843 If I<Interface> is B<All>, all interfaces will be selected.
2845 =item B<QDisc> I<Interface> [I<QDisc>]
2847 =item B<Class> I<Interface> [I<Class>]
2849 =item B<Filter> I<Interface> [I<Filter>]
2851 Collect the octets and packets that pass a certain qdisc, class or filter.
2853 QDiscs and classes are identified by their type and handle (or classid).
2854 Filters don't necessarily have a handle, therefore the parent's handle is used.
2855 The notation used in collectd differs from that used in tc(1) in that it
2856 doesn't skip the major or minor number if it's zero and doesn't print special
2857 ids by their name. So, for example, a qdisc may be identified by
2858 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
2859 thus not displayed by tc(1).
2861 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
2862 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
2863 associated with that interface will be collected.
2865 Since a filter itself doesn't necessarily have a handle, the parent's handle is
2866 used. This may lead to problems when more than one filter is attached to a
2867 qdisc or class. This isn't nice, but we don't know how this could be done any
2868 better. If you have a idea, please don't hesitate to tell us.
2870 As with the B<Interface> option you can specify B<All> as the interface,
2871 meaning all interfaces.
2873 Here are some examples to help you understand the above text more easily:
2876 VerboseInterface "All"
2877 QDisc "eth0" "pfifo_fast-1:0"
2879 Class "ppp0" "htb-1:10"
2880 Filter "ppp0" "u32-1:0"
2883 =item B<IgnoreSelected>
2885 The behavior is the same as with all other similar plugins: If nothing is
2886 selected at all, everything is collected. If some things are selected using the
2887 options described above, only these statistics are collected. If you set
2888 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
2889 specified statistics will not be collected.
2893 =head2 Plugin C<network>
2895 The Network plugin sends data to a remote instance of collectd, receives data
2896 from a remote instance, or both at the same time. Data which has been received
2897 from the network is usually not transmitted again, but this can be activated, see
2898 the B<Forward> option below.
2900 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
2901 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
2903 Both, B<Server> and B<Listen> can be used as single option or as block. When
2904 used as block, given options are valid for this socket only. The following
2905 example will export the metrics twice: Once to an "internal" server (without
2906 encryption and signing) and one to an external server (with cryptographic
2910 # Export to an internal server
2911 # (demonstrates usage without additional options)
2912 Server "collectd.internal.tld"
2914 # Export to an external server
2915 # (demonstrates usage with signature options)
2916 <Server "collectd.external.tld">
2917 SecurityLevel "sign"
2918 Username "myhostname"
2925 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
2927 The B<Server> statement/block sets the server to send datagrams to. The
2928 statement may occur multiple times to send each datagram to multiple
2931 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
2932 optional second argument specifies a port number or a service name. If not
2933 given, the default, B<25826>, is used.
2935 The following options are recognized within B<Server> blocks:
2939 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
2941 Set the security you require for network communication. When the security level
2942 has been set to B<Encrypt>, data sent over the network will be encrypted using
2943 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
2944 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
2945 authentication code. When set to B<None>, data is sent without any security.
2947 This feature is only available if the I<network> plugin was linked with
2950 =item B<Username> I<Username>
2952 Sets the username to transmit. This is used by the server to lookup the
2953 password. See B<AuthFile> below. All security levels except B<None> require
2956 This feature is only available if the I<network> plugin was linked with
2959 =item B<Password> I<Password>
2961 Sets a password (shared secret) for this socket. All security levels except
2962 B<None> require this setting.
2964 This feature is only available if the I<network> plugin was linked with
2967 =item B<Interface> I<Interface name>
2969 Set the outgoing interface for IP packets. This applies at least
2970 to IPv6 packets and if possible to IPv4. If this option is not applicable,
2971 undefined or a non-existent interface name is specified, the default
2972 behavior is to let the kernel choose the appropriate interface. Be warned
2973 that the manual selection of an interface for unicast traffic is only
2974 necessary in rare cases.
2978 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
2980 The B<Listen> statement sets the interfaces to bind to. When multiple
2981 statements are found the daemon will bind to multiple interfaces.
2983 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
2984 the argument is a multicast address the daemon will join that multicast group.
2985 The optional second argument specifies a port number or a service name. If not
2986 given, the default, B<25826>, is used.
2988 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
2992 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
2994 Set the security you require for network communication. When the security level
2995 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
2996 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
2997 signed and encrypted data is accepted. When set to B<None>, all data will be
2998 accepted. If an B<AuthFile> option was given (see below), encrypted data is
2999 decrypted if possible.
3001 This feature is only available if the I<network> plugin was linked with
3004 =item B<AuthFile> I<Filename>
3006 Sets a file in which usernames are mapped to passwords. These passwords are
3007 used to verify signatures and to decrypt encrypted network packets. If
3008 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
3009 verified and encrypted packets are decrypted. Otherwise, signed data is
3010 accepted without checking the signature and encrypted data cannot be decrypted.
3011 For the other security levels this option is mandatory.
3013 The file format is very simple: Each line consists of a username followed by a
3014 colon and any number of spaces followed by the password. To demonstrate, an
3015 example file could look like this:
3020 Each time a packet is received, the modification time of the file is checked
3021 using L<stat(2)>. If the file has been changed, the contents is re-read. While
3022 the file is being read, it is locked using L<fcntl(2)>.
3024 =item B<Interface> I<Interface name>
3026 Set the incoming interface for IP packets explicitly. This applies at least
3027 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3028 undefined or a non-existent interface name is specified, the default
3029 behavior is, to let the kernel choose the appropriate interface. Thus incoming
3030 traffic gets only accepted, if it arrives on the given interface.
3034 =item B<TimeToLive> I<1-255>
3036 Set the time-to-live of sent packets. This applies to all, unicast and
3037 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
3038 That means that multicast packets will be sent with a TTL of C<1> (one) on most
3041 =item B<MaxPacketSize> I<1024-65535>
3043 Set the maximum size for datagrams received over the network. Packets larger
3044 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
3045 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
3048 On the server side, this limit should be set to the largest value used on
3049 I<any> client. Likewise, the value on the client must not be larger than the
3050 value on the server, or data will be lost.
3052 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
3053 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
3054 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
3057 =item B<Forward> I<true|false>
3059 If set to I<true>, write packets that were received via the network plugin to
3060 the sending sockets. This should only be activated when the B<Listen>- and
3061 B<Server>-statements differ. Otherwise packets may be send multiple times to
3062 the same multicast group. While this results in more network traffic than
3063 necessary it's not a huge problem since the plugin has a duplicate detection,
3064 so the values will not loop.
3066 =item B<ReportStats> B<true>|B<false>
3068 The network plugin cannot only receive and send statistics, it can also create
3069 statistics about itself. Collected data included the number of received and
3070 sent octets and packets, the length of the receive queue and the number of
3071 values handled. When set to B<true>, the I<Network plugin> will make these
3072 statistics available. Defaults to B<false>.
3076 =head2 Plugin C<nginx>
3078 This plugin collects the number of connections and requests handled by the
3079 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
3080 queries the page provided by the C<ngx_http_stub_status_module> module, which
3081 isn't compiled by default. Please refer to
3082 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
3083 how to compile and configure nginx and this module.
3085 The following options are accepted by the C<nginx plugin>:
3089 =item B<URL> I<http://host/nginx_status>
3091 Sets the URL of the C<ngx_http_stub_status_module> output.
3093 =item B<User> I<Username>
3095 Optional user name needed for authentication.
3097 =item B<Password> I<Password>
3099 Optional password needed for authentication.
3101 =item B<VerifyPeer> B<true|false>
3103 Enable or disable peer SSL certificate verification. See
3104 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
3106 =item B<VerifyHost> B<true|false>
3108 Enable or disable peer host name verification. If enabled, the plugin checks
3109 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
3110 certificate matches the host name provided by the B<URL> option. If this
3111 identity check fails, the connection is aborted. Obviously, only works when
3112 connecting to a SSL enabled server. Enabled by default.
3114 =item B<CACert> I<File>
3116 File that holds one or more SSL certificates. If you want to use HTTPS you will
3117 possibly need this option. What CA certificates come bundled with C<libcurl>
3118 and are checked by default depends on the distribution you use.
3122 =head2 Plugin C<notify_desktop>
3124 This plugin sends a desktop notification to a notification daemon, as defined
3125 in the Desktop Notification Specification. To actually display the
3126 notifications, B<notification-daemon> is required and B<collectd> has to be
3127 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
3128 environment variables have to be set correctly) and the D-Bus message bus.
3130 The Desktop Notification Specification can be found at
3131 L<http://www.galago-project.org/specs/notification/>.
3135 =item B<OkayTimeout> I<timeout>
3137 =item B<WarningTimeout> I<timeout>
3139 =item B<FailureTimeout> I<timeout>
3141 Set the I<timeout>, in milliseconds, after which to expire the notification
3142 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
3143 been specified, the displayed notification will not be closed at all - the
3144 user has to do so herself. These options default to 5000. If a negative number
3145 has been specified, the default is used as well.
3149 =head2 Plugin C<notify_email>
3151 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
3152 configured email address.
3154 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
3156 Available configuration options:
3160 =item B<From> I<Address>
3162 Email address from which the emails should appear to come from.
3164 Default: C<root@localhost>
3166 =item B<Recipient> I<Address>
3168 Configures the email address(es) to which the notifications should be mailed.
3169 May be repeated to send notifications to multiple addresses.
3171 At least one B<Recipient> must be present for the plugin to work correctly.
3173 =item B<SMTPServer> I<Hostname>
3175 Hostname of the SMTP server to connect to.
3177 Default: C<localhost>
3179 =item B<SMTPPort> I<Port>
3181 TCP port to connect to.
3185 =item B<SMTPUser> I<Username>
3187 Username for ASMTP authentication. Optional.
3189 =item B<SMTPPassword> I<Password>
3191 Password for ASMTP authentication. Optional.
3193 =item B<Subject> I<Subject>
3195 Subject-template to use when sending emails. There must be exactly two
3196 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
3197 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
3200 Default: C<Collectd notify: %s@%s>
3204 =head2 Plugin C<ntpd>
3208 =item B<Host> I<Hostname>
3210 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
3212 =item B<Port> I<Port>
3214 UDP-Port to connect to. Defaults to B<123>.
3216 =item B<ReverseLookups> B<true>|B<false>
3218 Sets whether or not to perform reverse lookups on peers. Since the name or
3219 IP-address may be used in a filename it is recommended to disable reverse
3220 lookups. The default is to do reverse lookups to preserve backwards
3221 compatibility, though.
3223 =item B<IncludeUnitID> B<true>|B<false>
3225 When a peer is a refclock, include the unit ID in the I<type instance>.
3226 Defaults to B<false> for backward compatibility.
3228 If two refclock peers use the same driver and this is B<false>, the plugin will
3229 try to write simultaneous measurements from both to the same type instance.
3230 This will result in error messages in the log and only one set of measurements
3235 =head2 Plugin C<nut>
3239 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
3241 Add a UPS to collect data from. The format is identical to the one accepted by
3246 =head2 Plugin C<olsrd>
3248 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
3249 the Optimized Link State Routing daemon and reads information about the current
3250 state of the meshed network.
3252 The following configuration options are understood:
3256 =item B<Host> I<Host>
3258 Connect to I<Host>. Defaults to B<"localhost">.
3260 =item B<Port> I<Port>
3262 Specifies the port to connect to. This must be a string, even if you give the
3263 port as a number rather than a service name. Defaults to B<"2006">.
3265 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
3267 Specifies what information to collect about links, i.E<nbsp>e. direct
3268 connections of the daemon queried. If set to B<No>, no information is
3269 collected. If set to B<Summary>, the number of links and the average of all
3270 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
3271 If set to B<Detail> LQ and NLQ are collected per link.
3273 Defaults to B<Detail>.
3275 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
3277 Specifies what information to collect about routes of the daemon queried. If
3278 set to B<No>, no information is collected. If set to B<Summary>, the number of
3279 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
3280 metric and ETX are collected per route.
3282 Defaults to B<Summary>.
3284 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
3286 Specifies what information to collect about the global topology. If set to
3287 B<No>, no information is collected. If set to B<Summary>, the number of links
3288 in the entire topology and the average I<link quality> (LQ) is calculated.
3289 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
3291 Defaults to B<Summary>.
3295 =head2 Plugin C<onewire>
3297 B<EXPERIMENTAL!> See notes below.
3299 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
3300 L<http://owfs.org/> to read sensors connected via the onewire bus.
3302 Currently only temperature sensors (sensors with the family code C<10>,
3303 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
3304 would like to have included, please send a sort request to the mailing list.
3306 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
3307 experimental, below.
3311 =item B<Device> I<Device>
3313 Sets the device to read the values from. This can either be a "real" hardware
3314 device, such as a serial port or an USB port, or the address of the
3315 L<owserver(1)> socket, usually B<localhost:4304>.
3317 Though the documentation claims to automatically recognize the given address
3318 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
3319 with that version, the following configuration worked for us:
3322 Device "-s localhost:4304"
3325 This directive is B<required> and does not have a default value.
3327 =item B<Sensor> I<Sensor>
3329 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
3330 below. Sensors are specified without the family byte at the beginning, to you'd
3331 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
3334 =item B<IgnoreSelected> I<true>|I<false>
3336 If no configuration if given, the B<onewire> plugin will collect data from all
3337 sensors found. This may not be practical, especially if sensors are added and
3338 removed regularly. Sometimes, however, it's easier/preferred to collect only
3339 specific sensors or all sensors I<except> a few specified ones. This option
3340 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
3341 B<Sensor> is inverted: All selected interfaces are ignored and all other
3342 interfaces are collected.
3344 =item B<Interval> I<Seconds>
3346 Sets the interval in which all sensors should be read. If not specified, the
3347 global B<Interval> setting is used.
3351 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
3352 work with big setups. It works with one sensor being attached to one
3353 controller, but as soon as you throw in a couple more senors and maybe a hub
3354 or two, reading all values will take more than ten seconds (the default
3355 interval). We will probably add some separate thread for reading the sensors
3356 and some cache or something like that, but it's not done yet. We will try to
3357 maintain backwards compatibility in the future, but we can't promise. So in
3358 short: If it works for you: Great! But keep in mind that the config I<might>
3359 change, though this is unlikely. Oh, and if you want to help improving this
3360 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
3362 =head2 Plugin C<openvpn>
3364 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
3365 traffic statistics about connected clients.
3367 To set up OpenVPN to write to the status file periodically, use the
3368 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
3369 you need to set the required format, too. This is done by setting
3370 B<--status-version> to B<2>.
3372 So, in a nutshell you need:
3374 openvpn $OTHER_OPTIONS \
3375 --status "/var/run/openvpn-status" 10 \
3382 =item B<StatusFile> I<File>
3384 Specifies the location of the status file.
3386 =item B<ImprovedNamingSchema> B<true>|B<false>
3388 When enabled, the filename of the status file will be used as plugin instance
3389 and the client's "common name" will be used as type instance. This is required
3390 when reading multiple status files. Enabling this option is recommended, but to
3391 maintain backwards compatibility this option is disabled by default.
3393 =item B<CollectCompression> B<true>|B<false>
3395 Sets whether or not statistics about the compression used by OpenVPN should be
3396 collected. This information is only available in I<single> mode. Enabled by
3399 =item B<CollectIndividualUsers> B<true>|B<false>
3401 Sets whether or not traffic information is collected for each connected client
3402 individually. If set to false, currently no traffic data is collected at all
3403 because aggregating this data in a save manner is tricky. Defaults to B<true>.
3405 =item B<CollectUserCount> B<true>|B<false>
3407 When enabled, the number of currently connected clients or users is collected.
3408 This is especially interesting when B<CollectIndividualUsers> is disabled, but
3409 can be configured independently from that option. Defaults to B<false>.
3413 =head2 Plugin C<oracle>
3415 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
3416 Oracle® Database and lets you execute SQL statements there. It is very similar
3417 to the "dbi" plugin, because it was written around the same time. See the "dbi"
3418 plugin's documentation above for details.
3421 <Query "out_of_stock">
3422 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
3425 # InstancePrefix "foo"
3426 InstancesFrom "category"
3430 <Database "product_information">
3434 Query "out_of_stock"
3438 =head3 B<Query> blocks
3440 The Query blocks are handled identically to the Query blocks of the "dbi"
3441 plugin. Please see its documentation above for details on how to specify
3444 =head3 B<Database> blocks
3446 Database blocks define a connection to a database and which queries should be
3447 sent to that database. Each database needs a "name" as string argument in the
3448 starting tag of the block. This name will be used as "PluginInstance" in the
3449 values submitted to the daemon. Other than that, that name is not used.
3453 =item B<ConnectID> I<ID>
3455 Defines the "database alias" or "service name" to connect to. Usually, these
3456 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
3458 =item B<Host> I<Host>
3460 Hostname to use when dispatching values for this database. Defaults to using
3461 the global hostname of the I<collectd> instance.
3463 =item B<Username> I<Username>
3465 Username used for authentication.
3467 =item B<Password> I<Password>
3469 Password used for authentication.
3471 =item B<Query> I<QueryName>
3473 Associates the query named I<QueryName> with this database connection. The
3474 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
3475 blocks you want to refer to must be placed above the database block you want to
3480 =head2 Plugin C<perl>
3482 This plugin embeds a Perl-interpreter into collectd and provides an interface
3483 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
3485 =head2 Plugin C<pinba>
3487 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
3488 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
3489 PHP-based webpage has been delivered, the extension will send a UDP packet
3490 containing timing information, peak memory usage and so on. The plugin will
3491 wait for such packets, parse them and account the provided information, which
3492 is then dispatched to the daemon once per interval.
3499 # Overall statistics for the website.
3501 Server "www.example.com"
3503 # Statistics for www-a only
3505 Host "www-a.example.com"
3506 Server "www.example.com"
3508 # Statistics for www-b only
3510 Host "www-b.example.com"
3511 Server "www.example.com"
3515 The plugin provides the following configuration options:
3519 =item B<Address> I<Node>
3521 Configures the address used to open a listening socket. By default, plugin will
3522 bind to the I<any> address C<::0>.
3524 =item B<Port> I<Service>
3526 Configures the port (service) to bind to. By default the default Pinba port
3527 "30002" will be used. The option accepts service names in addition to port
3528 numbers and thus requires a I<string> argument.
3530 =item E<lt>B<View> I<Name>E<gt> block
3532 The packets sent by the Pinba extension include the hostname of the server, the
3533 server name (the name of the virtual host) and the script that was executed.
3534 Using B<View> blocks it is possible to separate the data into multiple groups
3535 to get more meaningful statistics. Each packet is added to all matching groups,
3536 so that a packet may be accounted for more than once.
3540 =item B<Host> I<Host>
3542 Matches the hostname of the system the webserver / script is running on. This
3543 will contain the result of the L<gethostname(2)> system call. If not
3544 configured, all hostnames will be accepted.
3546 =item B<Server> I<Server>
3548 Matches the name of the I<virtual host>, i.e. the contents of the
3549 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
3550 server names will be accepted.
3552 =item B<Script> I<Script>
3554 Matches the name of the I<script name>, i.e. the contents of the
3555 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
3556 script names will be accepted.
3562 =head2 Plugin C<ping>
3564 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
3565 configured hosts periodically and measures the network latency. Whenever the
3566 C<read> function of the plugin is called, it submits the average latency, the
3567 standard deviation and the drop rate for each host.
3569 Available configuration options:
3573 =item B<Host> I<IP-address>
3575 Host to ping periodically. This option may be repeated several times to ping
3578 =item B<Interval> I<Seconds>
3580 Sets the interval in which to send ICMP echo packets to the configured hosts.
3581 This is B<not> the interval in which statistics are queries from the plugin but
3582 the interval in which the hosts are "pinged". Therefore, the setting here
3583 should be smaller than or equal to the global B<Interval> setting. Fractional
3584 times, such as "1.24" are allowed.
3588 =item B<Timeout> I<Seconds>
3590 Time to wait for a response from the host to which an ICMP packet had been
3591 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
3592 to be down or the packet to be dropped. This setting must be smaller than the
3593 B<Interval> setting above for the plugin to work correctly. Fractional
3594 arguments are accepted.
3598 =item B<TTL> I<0-255>
3600 Sets the Time-To-Live of generated ICMP packets.
3602 =item B<SourceAddress> I<host>
3604 Sets the source address to use. I<host> may either be a numerical network
3605 address or a network hostname.
3607 =item B<Device> I<name>
3609 Sets the outgoing network device to be used. I<name> has to specify an
3610 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
3613 =item B<MaxMissed> I<Packets>
3615 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
3616 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
3618 Default: B<-1> (disabled)
3622 =head2 Plugin C<postgresql>
3624 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
3625 keeps a persistent connection to all configured databases and tries to
3626 reconnect if the connection has been interrupted. A database is configured by
3627 specifying a B<Database> block as described below. The default statistics are
3628 collected from PostgreSQL's B<statistics collector> which thus has to be
3629 enabled for this plugin to work correctly. This should usually be the case by
3630 default. See the section "The Statistics Collector" of the B<PostgreSQL
3631 Documentation> for details.
3633 By specifying custom database queries using a B<Query> block as described
3634 below, you may collect any data that is available from some PostgreSQL
3635 database. This way, you are able to access statistics of external daemons
3636 which are available in a PostgreSQL database or use future or special
3637 statistics provided by PostgreSQL without the need to upgrade your collectd
3640 Starting with version 5.2, the C<postgresql> plugin supports writing data to
3641 PostgreSQL databases as well. This has been implemented in a generic way. You
3642 need to specify an SQL statement which will then be executed by collectd in
3643 order to write the data (see below for details). The benefit of that approach
3644 is that there is no fixed database layout. Rather, the layout may be optimized
3645 for the current setup.
3647 The B<PostgreSQL Documentation> manual can be found at
3648 L<http://www.postgresql.org/docs/manuals/>.
3652 Statement "SELECT magic FROM wizard WHERE host = $1;"
3656 InstancePrefix "magic"
3661 <Query rt36_tickets>
3662 Statement "SELECT COUNT(type) AS count, type \
3664 WHEN resolved = 'epoch' THEN 'open' \
3665 ELSE 'resolved' END AS type \
3666 FROM tickets) type \
3670 InstancePrefix "rt36_tickets"
3671 InstancesFrom "type"
3677 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
3687 KRBSrvName "kerberos_service_name"
3693 Service "service_name"
3694 Query backend # predefined
3705 The B<Query> block defines one database query which may later be used by a
3706 database definition. It accepts a single mandatory argument which specifies
3707 the name of the query. The names of all queries have to be unique (see the
3708 B<MinVersion> and B<MaxVersion> options below for an exception to this
3709 rule). The following configuration options are available to define the query:
3711 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
3712 blocks define how to handle the values returned from the query. They define
3713 which column holds which value and how to dispatch that value to the daemon.
3714 Multiple B<Result> blocks may be used to extract multiple values from a single
3719 =item B<Statement> I<sql query statement>
3721 Specify the I<sql query statement> which the plugin should execute. The string
3722 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
3723 first, second, etc. parameter. The value of the parameters is specified by the
3724 B<Param> configuration option - see below for details. To include a literal
3725 B<$> character followed by a number, surround it with single quotes (B<'>).
3727 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
3728 allowed. Note, however, that only a single command may be used. Semicolons are
3729 allowed as long as a single non-empty command has been specified only.
3731 The returned lines will be handled separately one after another.
3733 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
3735 Specify the parameters which should be passed to the SQL query. The parameters
3736 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
3737 they appear in the configuration file. The value of the parameter is
3738 determined depending on the value of the B<Param> option as follows:
3744 The configured hostname of the database connection. If a UNIX domain socket is
3745 used, the parameter expands to "localhost".
3749 The name of the database of the current connection.
3753 The name of the database plugin instance. See the B<Instance> option of the
3754 database specification below for details.
3758 The username used to connect to the database.
3762 The interval with which this database is queried (as specified by the database
3763 specific or global B<Interval> options).
3767 Please note that parameters are only supported by PostgreSQL's protocol
3768 version 3 and above which was introduced in version 7.4 of PostgreSQL.
3770 =item B<Type> I<type>
3772 The I<type> name to be used when dispatching the values. The type describes
3773 how to handle the data and where to store it. See L<types.db(5)> for more
3774 details on types and their configuration. The number and type of values (as
3775 selected by the B<ValuesFrom> option) has to match the type of the given name.
3777 This option is required inside a B<Result> block.
3779 =item B<InstancePrefix> I<prefix>
3781 =item B<InstancesFrom> I<column0> [I<column1> ...]
3783 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
3784 B<InstancePrefix> defines a static prefix that will be prepended to all type
3785 instances. B<InstancesFrom> defines the column names whose values will be used
3786 to create the type instance. Multiple values will be joined together using the
3787 hyphen (C<->) as separation character.
3789 The plugin itself does not check whether or not all built instances are
3790 different. It is your responsibility to assure that each is unique.
3792 Both options are optional. If none is specified, the type instance will be
3795 =item B<ValuesFrom> I<column0> [I<column1> ...]
3797 Names the columns whose content is used as the actual data for the data sets
3798 that are dispatched to the daemon. How many such columns you need is
3799 determined by the B<Type> setting as explained above. If you specify too many
3800 or not enough columns, the plugin will complain about that and no data will be
3801 submitted to the daemon.
3803 The actual data type, as seen by PostgreSQL, is not that important as long as
3804 it represents numbers. The plugin will automatically cast the values to the
3805 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
3806 L<strtod(3)> functions, so anything supported by those functions is supported
3807 by the plugin as well.
3809 This option is required inside a B<Result> block and may be specified multiple
3810 times. If multiple B<ValuesFrom> options are specified, the columns are read
3813 =item B<MinVersion> I<version>
3815 =item B<MaxVersion> I<version>
3817 Specify the minimum or maximum version of PostgreSQL that this query should be
3818 used with. Some statistics might only be available with certain versions of
3819 PostgreSQL. This allows you to specify multiple queries with the same name but
3820 which apply to different versions, thus allowing you to use the same
3821 configuration in a heterogeneous environment.
3823 The I<version> has to be specified as the concatenation of the major, minor
3824 and patch-level versions, each represented as two-decimal-digit numbers. For
3825 example, version 8.2.3 will become 80203.
3829 The following predefined queries are available (the definitions can be found
3830 in the F<postgresql_default.conf> file which, by default, is available at
3831 C<I<prefix>/share/collectd/>):
3837 This query collects the number of backends, i.E<nbsp>e. the number of
3840 =item B<transactions>
3842 This query collects the numbers of committed and rolled-back transactions of
3847 This query collects the numbers of various table modifications (i.E<nbsp>e.
3848 insertions, updates, deletions) of the user tables.
3850 =item B<query_plans>
3852 This query collects the numbers of various table scans and returned tuples of
3855 =item B<table_states>
3857 This query collects the numbers of live and dead rows in the user tables.
3861 This query collects disk block access counts for user tables.
3865 This query collects the on-disk size of the database in bytes.
3869 In addition, the following detailed queries are available by default. Please
3870 note that each of those queries collects information B<by table>, thus,
3871 potentially producing B<a lot> of data. For details see the description of the
3872 non-by_table queries above.
3876 =item B<queries_by_table>
3878 =item B<query_plans_by_table>
3880 =item B<table_states_by_table>
3882 =item B<disk_io_by_table>
3886 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
3887 mandatory argument specifying the name of the writer. This will then be used
3888 in the B<Database> specification in order to activate the writer instance. The
3889 names of all writers have to be unique. The following options may be
3894 =item B<Statement> I<sql statement>
3896 This mandatory option specifies the SQL statement that will be executed for
3897 each submitted value. A single SQL statement is allowed only. Anything after
3898 the first semicolon will be ignored.
3900 Nine parameters will be passed to the statement and should be specified as
3901 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
3902 values are made available through those parameters:
3908 The timestamp of the queried value as a floating point number.
3912 The hostname of the queried value.
3916 The plugin name of the queried value.
3920 The plugin instance of the queried value. This value may be B<NULL> if there
3921 is no plugin instance.
3925 The type of the queried value (cf. L<types.db(5)>).
3929 The type instance of the queried value. This value may be B<NULL> if there is
3934 An array of names for the submitted values (i.E<nbsp>e., the name of the data
3935 sources of the submitted value-list).
3939 An array of types for the submitted values (i.E<nbsp>e., the type of the data
3940 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
3941 B<StoreRates> is enabled (which is the default, see below), all types will be
3946 An array of the submitted values. The dimensions of the value name and value
3951 In general, it is advisable to create and call a custom function in the
3952 PostgreSQL database for this purpose. Any procedural language supported by
3953 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
3956 =item B<StoreRates> B<false>|B<true>
3958 If set to B<true> (the default), convert counter values to rates. If set to
3959 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
3964 The B<Database> block defines one PostgreSQL database for which to collect
3965 statistics. It accepts a single mandatory argument which specifies the
3966 database name. None of the other options are required. PostgreSQL will use
3967 default values as documented in the section "CONNECTING TO A DATABASE" in the
3968 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
3969 the user collectd is run as and special environment variables. See the manpage
3974 =item B<Interval> I<seconds>
3976 Specify the interval with which the database should be queried. The default is
3977 to use the global B<Interval> setting.
3979 =item B<CommitInterval> I<seconds>
3981 This option may be used for database connections which have "writers" assigned
3982 (see above). If specified, it causes a writer to put several updates into a
3983 single transaction. This transaction will last for the specified amount of
3984 time. By default, each update will be executed in a separate transaction. Each
3985 transaction generates a fair amount of overhead which can, thus, be reduced by
3986 activating this option. The draw-back is, that data covering the specified
3987 amount of time will be lost, for example, if a single statement within the
3988 transaction fails or if the database server crashes.
3990 =item B<Host> I<hostname>
3992 Specify the hostname or IP of the PostgreSQL server to connect to. If the
3993 value begins with a slash, it is interpreted as the directory name in which to
3994 look for the UNIX domain socket.
3996 This option is also used to determine the hostname that is associated with a
3997 collected data set. If it has been omitted or either begins with with a slash
3998 or equals B<localhost> it will be replaced with the global hostname definition
3999 of collectd. Any other value will be passed literally to collectd when
4000 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
4002 =item B<Port> I<port>
4004 Specify the TCP port or the local UNIX domain socket file extension of the
4007 =item B<User> I<username>
4009 Specify the username to be used when connecting to the server.
4011 =item B<Password> I<password>
4013 Specify the password to be used when connecting to the server.
4015 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
4017 Specify whether to use an SSL connection when contacting the server. The
4018 following modes are supported:
4020 =item B<Instance> I<name>
4022 Specify the plugin instance name that should be used instead of the database
4023 name (which is the default, if this option has not been specified). This
4024 allows to query multiple databases of the same name on the same host (e.g.
4025 when running multiple database server versions in parallel).
4031 Do not use SSL at all.
4035 First, try to connect without using SSL. If that fails, try using SSL.
4037 =item I<prefer> (default)
4039 First, try to connect using SSL. If that fails, try without using SSL.
4047 =item B<KRBSrvName> I<kerberos_service_name>
4049 Specify the Kerberos service name to use when authenticating with Kerberos 5
4050 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
4051 B<PostgreSQL Documentation> for details.
4053 =item B<Service> I<service_name>
4055 Specify the PostgreSQL service name to use for additional parameters. That
4056 service has to be defined in F<pg_service.conf> and holds additional
4057 connection parameters. See the section "The Connection Service File" in the
4058 B<PostgreSQL Documentation> for details.
4060 =item B<Query> I<query>
4062 Specifies a I<query> which should be executed in the context of the database
4063 connection. This may be any of the predefined or user-defined queries. If no
4064 such option is given, it defaults to "backends", "transactions", "queries",
4065 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
4066 has been specified). Else, the specified queries are used only.
4068 =item B<Writer> I<writer>
4070 Assigns the specified I<writer> backend to the database connection. This
4071 causes all collected data to be send to the database using the settings
4072 defined in the writer configuration (see the section "FILTER CONFIGURATION"
4073 below for details on how to selectively send data to certain plugins).
4075 Each writer will register a flush callback which may be used when having long
4076 transactions enabled (see the B<CommitInterval> option above). When issuing
4077 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
4078 transaction will be committed right away. Two different kinds of flush
4079 callbacks are available with the C<postgresql> plugin:
4085 Flush all writer backends.
4087 =item B<postgresql->I<database>
4089 Flush all writers of the specified I<database> only.
4095 =head2 Plugin C<powerdns>
4097 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
4098 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
4099 values, many of which are probably meaningless to most users, but may be useful
4100 for some. So you may chose which values to collect, but if you don't, some
4101 reasonable defaults will be collected.
4104 <Server "server_name">
4106 Collect "udp-answers" "udp-queries"
4107 Socket "/var/run/pdns.controlsocket"
4109 <Recursor "recursor_name">
4111 Collect "cache-hits" "cache-misses"
4112 Socket "/var/run/pdns_recursor.controlsocket"
4114 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
4119 =item B<Server> and B<Recursor> block
4121 The B<Server> block defines one authoritative server to query, the B<Recursor>
4122 does the same for an recursing server. The possible options in both blocks are
4123 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
4128 =item B<Collect> I<Field>
4130 Using the B<Collect> statement you can select which values to collect. Here,
4131 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
4132 C<dlg-only-drops>, C<answers10-100>.
4134 The method of getting the values differs for B<Server> and B<Recursor> blocks:
4135 When querying the server a C<SHOW *> command is issued in any case, because
4136 that's the only way of getting multiple values out of the server at once.
4137 collectd then picks out the values you have selected. When querying the
4138 recursor, a command is generated to query exactly these values. So if you
4139 specify invalid fields when querying the recursor, a syntax error may be
4140 returned by the daemon and collectd may not collect any values at all.
4142 If no B<Collect> statement is given, the following B<Server> values will be
4149 =item packetcache-hit
4151 =item packetcache-miss
4153 =item packetcache-size
4155 =item query-cache-hit
4157 =item query-cache-miss
4159 =item recursing-answers
4161 =item recursing-questions
4173 The following B<Recursor> values will be collected by default:
4177 =item noerror-answers
4179 =item nxdomain-answers
4181 =item servfail-answers
4199 Please note that up to that point collectd doesn't know what values are
4200 available on the server and values that are added do not need a change of the
4201 mechanism so far. However, the values must be mapped to collectd's naming
4202 scheme, which is done using a lookup table that lists all known values. If
4203 values are added in the future and collectd does not know about them, you will
4204 get an error much like this:
4206 powerdns plugin: submit: Not found in lookup table: foobar = 42
4208 In this case please file a bug report with the collectd team.
4210 =item B<Socket> I<Path>
4212 Configures the path to the UNIX domain socket to be used when connecting to the
4213 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
4214 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
4215 will be used for the recursor.
4219 =item B<LocalSocket> I<Path>
4221 Querying the recursor is done using UDP. When using UDP over UNIX domain
4222 sockets, the client socket needs a name in the file system, too. You can set
4223 this local name to I<Path> using the B<LocalSocket> option. The default is
4224 C<I<prefix>/var/run/collectd-powerdns>.
4228 =head2 Plugin C<processes>
4232 =item B<Process> I<Name>
4234 Select more detailed statistics of processes matching this name. The statistics
4235 collected for these selected processes are size of the resident segment size
4236 (RSS), user- and system-time used, number of processes and number of threads,
4237 io data (where available) and minor and major pagefaults.
4239 =item B<ProcessMatch> I<name> I<regex>
4241 Similar to the B<Process> option this allows to select more detailed
4242 statistics of processes matching the specified I<regex> (see L<regex(7)> for
4243 details). The statistics of all matching processes are summed up and
4244 dispatched to the daemon using the specified I<name> as an identifier. This
4245 allows to "group" several processes together. I<name> must not contain
4250 =head2 Plugin C<protocols>
4252 Collects a lot of information about various network protocols, such as I<IP>,
4253 I<TCP>, I<UDP>, etc.
4255 Available configuration options:
4259 =item B<Value> I<Selector>
4261 Selects whether or not to select a specific value. The string being matched is
4262 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
4263 plugin instance and I<ValueName> will be used as type instance. An example of
4264 the string being used would be C<Tcp:RetransSegs>.
4266 You can use regular expressions to match a large number of values with just one
4267 configuration option. To select all "extended" I<TCP> values, you could use the
4268 following statement:
4272 Whether only matched values are selected or all matched values are ignored
4273 depends on the B<IgnoreSelected>. By default, only matched values are selected.
4274 If no value is configured at all, all values will be selected.
4276 =item B<IgnoreSelected> B<true>|B<false>
4278 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
4279 matching values will be ignored.
4283 =head2 Plugin C<python>
4285 This plugin embeds a Python-interpreter into collectd and provides an interface
4286 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
4288 =head2 Plugin C<routeros>
4290 The C<routeros> plugin connects to a device running I<RouterOS>, the
4291 Linux-based operating system for routers by I<MikroTik>. The plugin uses
4292 I<librouteros> to connect and reads information about the interfaces and
4293 wireless connections of the device. The configuration supports querying
4298 Host "router0.example.com"
4301 CollectInterface true
4306 Host "router1.example.com"
4309 CollectInterface true
4310 CollectRegistrationTable true
4316 As you can see above, the configuration of the I<routeros> plugin consists of
4317 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
4318 options are understood:
4322 =item B<Host> I<Host>
4324 Hostname or IP-address of the router to connect to.
4326 =item B<Port> I<Port>
4328 Port name or port number used when connecting. If left unspecified, the default
4329 will be chosen by I<librouteros>, currently "8728". This option expects a
4330 string argument, even when a numeric port number is given.
4332 =item B<User> I<User>
4334 Use the user name I<User> to authenticate. Defaults to "admin".
4336 =item B<Password> I<Password>
4338 Set the password used to authenticate.
4340 =item B<CollectInterface> B<true>|B<false>
4342 When set to B<true>, interface statistics will be collected for all interfaces
4343 present on the device. Defaults to B<false>.
4345 =item B<CollectRegistrationTable> B<true>|B<false>
4347 When set to B<true>, information about wireless LAN connections will be
4348 collected. Defaults to B<false>.
4350 =item B<CollectCPULoad> B<true>|B<false>
4352 When set to B<true>, information about the CPU usage will be collected. The
4353 number is a dimensionless value where zero indicates no CPU usage at all.
4354 Defaults to B<false>.
4356 =item B<CollectMemory> B<true>|B<false>
4358 When enabled, the amount of used and free memory will be collected. How used
4359 memory is calculated is unknown, for example whether or not caches are counted
4361 Defaults to B<false>.
4363 =item B<CollectDF> B<true>|B<false>
4365 When enabled, the amount of used and free disk space will be collected.
4366 Defaults to B<false>.
4368 =item B<CollectDisk> B<true>|B<false>
4370 When enabled, the number of sectors written and bad blocks will be collected.
4371 Defaults to B<false>.
4375 =head2 Plugin C<redis>
4377 The I<Redis plugin> connects to one or more Redis servers and gathers
4378 information about each server's state. For each server there is a I<Node> block
4379 which configures the connection parameters for this node.
4389 The information shown in the synopsis above is the I<default configuration>
4390 which is used by the plugin if no configuration is present.
4394 =item B<Node> I<Nodename>
4396 The B<Node> block identifies a new Redis node, that is a new Redis instance
4397 running in an specified host and port. The name for node is a canonical
4398 identifier which is used as I<plugin instance>. It is limited to
4399 64E<nbsp>characters in length.
4401 =item B<Host> I<Hostname>
4403 The B<Host> option is the hostname or IP-address where the Redis instance is
4406 =item B<Port> I<Port>
4408 The B<Port> option is the TCP port on which the Redis instance accepts
4409 connections. Either a service name of a port number may be given. Please note
4410 that numerical port numbers must be given as a string, too.
4412 =item B<Password> I<Password>
4414 Use I<Password> to authenticate when connecting to I<Redis>.
4416 =item B<Timeout> I<Timeout in miliseconds>
4418 The B<Timeout> option set the socket timeout for node response. Since the Redis
4419 read function is blocking, you should keep this value as low as possible. Keep
4420 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
4421 than B<Interval> defined globally.
4425 =head2 Plugin C<rrdcached>
4427 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
4428 to store values to RRD files in an efficient manner. The combination of the
4429 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
4430 way the C<rrdtool> plugin works (see below). The added abstraction layer
4431 provides a number of benefits, though: Because the cache is not within
4432 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
4433 restarted. This results in much shorter (if any) gaps in graphs, especially
4434 under heavy load. Also, the C<rrdtool> command line utility is aware of the
4435 daemon so that it can flush values to disk automatically when needed. This
4436 allows to integrate automated flushing of values into graphing solutions much
4439 There are disadvantages, though: The daemon may reside on a different host, so
4440 it may not be possible for C<collectd> to create the appropriate RRD files
4441 anymore. And even if C<rrdcached> runs on the same host, it may run in a
4442 different base directory, so relative paths may do weird stuff if you're not
4445 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
4446 on the same host, communicating via a UNIX domain socket. The B<DataDir>
4447 setting should be set to an absolute path, so that a changed base directory
4448 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
4452 =item B<DaemonAddress> I<Address>
4454 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
4455 library. See L<rrdcached(1)> for details. Example:
4457 <Plugin "rrdcached">
4458 DaemonAddress "unix:/var/run/rrdcached.sock"
4461 =item B<DataDir> I<Directory>
4463 Set the base directory in which the RRD files reside. If this is a relative
4464 path, it is relative to the working base directory of the C<rrdcached> daemon!
4465 Use of an absolute path is recommended.
4467 =item B<CreateFiles> B<true>|B<false>
4469 Enables or disables the creation of RRD files. If the daemon is not running
4470 locally, or B<DataDir> is set to a relative path, this will not work as
4471 expected. Default is B<true>.
4473 =item B<StepSize> I<Seconds>
4475 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
4476 this setting is unset and the stepsize is set to the interval in which the data
4477 is collected. Do not use this option unless you absolutely have to for some
4478 reason. Setting this option may cause problems with the C<snmp plugin>, the
4479 C<exec plugin> or when the daemon is set up to receive data from other hosts.
4481 =item B<HeartBeat> I<Seconds>
4483 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
4484 in which case the heartbeat is set to twice the B<StepSize> which should equal
4485 the interval in which data is collected. Do not set this option unless you have
4486 a very good reason to do so.
4488 =item B<RRARows> I<NumRows>
4490 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
4491 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
4492 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
4493 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
4494 week, one month, and one year.
4496 So for each timespan, it calculates how many PDPs need to be consolidated into
4497 one CDP by calculating:
4498 number of PDPs = timespan / (stepsize * rrarows)
4500 Bottom line is, set this no smaller than the width of you graphs in pixels. The
4503 =item B<RRATimespan> I<Seconds>
4505 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
4506 more then one RRA. If this option is never used, the built-in default of (3600,
4507 86400, 604800, 2678400, 31622400) is used.
4509 For more information on how RRA-sizes are calculated see B<RRARows> above.
4511 =item B<XFF> I<Factor>
4513 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
4514 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
4519 =head2 Plugin C<rrdtool>
4521 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
4522 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
4523 using these settings. If you don't want to dive into the depths of RRDtool, you
4524 can safely ignore these settings.
4528 =item B<DataDir> I<Directory>
4530 Set the directory to store RRD-files under. Per default RRD-files are generated
4531 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
4533 =item B<StepSize> I<Seconds>
4535 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
4536 this setting is unset and the stepsize is set to the interval in which the data
4537 is collected. Do not use this option unless you absolutely have to for some
4538 reason. Setting this option may cause problems with the C<snmp plugin>, the
4539 C<exec plugin> or when the daemon is set up to receive data from other hosts.
4541 =item B<HeartBeat> I<Seconds>
4543 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
4544 in which case the heartbeat is set to twice the B<StepSize> which should equal
4545 the interval in which data is collected. Do not set this option unless you have
4546 a very good reason to do so.
4548 =item B<RRARows> I<NumRows>
4550 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
4551 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
4552 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
4553 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
4554 week, one month, and one year.
4556 So for each timespan, it calculates how many PDPs need to be consolidated into
4557 one CDP by calculating:
4558 number of PDPs = timespan / (stepsize * rrarows)
4560 Bottom line is, set this no smaller than the width of you graphs in pixels. The
4563 =item B<RRATimespan> I<Seconds>
4565 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
4566 more then one RRA. If this option is never used, the built-in default of (3600,
4567 86400, 604800, 2678400, 31622400) is used.
4569 For more information on how RRA-sizes are calculated see B<RRARows> above.
4571 =item B<XFF> I<Factor>
4573 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
4574 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
4577 =item B<CacheFlush> I<Seconds>
4579 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
4580 it writes all values for a certain RRD-file if the oldest value is older than
4581 (or equal to) the number of seconds specified. If some RRD-file is not updated
4582 anymore for some reason (the computer was shut down, the network is broken,
4583 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
4584 entire cache is searched for entries older than B<CacheTimeout> seconds and
4585 written to disk every I<Seconds> seconds. Since this is kind of expensive and
4586 does nothing under normal circumstances, this value should not be too small.
4587 900 seconds might be a good value, though setting this to 7200 seconds doesn't
4588 normally do much harm either.
4590 =item B<CacheTimeout> I<Seconds>
4592 If this option is set to a value greater than zero, the C<rrdtool plugin> will
4593 save values in a cache, as described above. Writing multiple values at once
4594 reduces IO-operations and thus lessens the load produced by updating the files.
4595 The trade off is that the graphs kind of "drag behind" and that more memory is
4598 =item B<WritesPerSecond> I<Updates>
4600 When collecting many statistics with collectd and the C<rrdtool> plugin, you
4601 will run serious performance problems. The B<CacheFlush> setting and the
4602 internal update queue assert that collectd continues to work just fine even
4603 under heavy load, but the system may become very unresponsive and slow. This is
4604 a problem especially if you create graphs from the RRD files on the same
4605 machine, for example using the C<graph.cgi> script included in the
4606 C<contrib/collection3/> directory.
4608 This setting is designed for very large setups. Setting this option to a value
4609 between 25 and 80 updates per second, depending on your hardware, will leave
4610 the server responsive enough to draw graphs even while all the cached values
4611 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
4612 by the B<FLUSH> command, are B<not> effected by this limit. They are still
4613 written as fast as possible, so that web frontends have up to date data when
4616 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
4617 updates per second, writing all values to disk will take approximately
4618 56E<nbsp>minutes. Together with the flushing ability that's integrated into
4619 "collection3" you'll end up with a responsive and fast system, up to date
4620 graphs and basically a "backup" of your values every hour.
4622 =item B<RandomTimeout> I<Seconds>
4624 When set, the actual timeout for each value is chosen randomly between
4625 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
4626 intention is to avoid high load situations that appear when many values timeout
4627 at the same time. This is especially a problem shortly after the daemon starts,
4628 because all values were added to the internal cache at roughly the same time.
4632 =head2 Plugin C<sensors>
4634 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
4635 that all the needed modules have to be loaded and lm_sensors has to be
4636 configured (most likely by editing F</etc/sensors.conf>. Read
4637 L<sensors.conf(5)> for details.
4639 The B<lm_sensors> homepage can be found at
4640 L<http://secure.netroedge.com/~lm78/>.
4644 =item B<SensorConfigFile> I<File>
4646 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
4647 the library's default will be used.
4649 =item B<Sensor> I<chip-bus-address/type-feature>
4651 Selects the name of the sensor which you want to collect or ignore, depending
4652 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
4653 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
4654 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
4656 =item B<IgnoreSelected> I<true>|I<false>
4658 If no configuration if given, the B<sensors>-plugin will collect data from all
4659 sensors. This may not be practical, especially for uninteresting sensors.
4660 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
4661 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
4662 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
4663 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
4664 and all other sensors are collected.
4668 =head2 Plugin C<snmp>
4670 Since the configuration of the C<snmp plugin> is a little more complicated than
4671 other plugins, its documentation has been moved to an own manpage,
4672 L<collectd-snmp(5)>. Please see there for details.
4674 =head2 Plugin C<swap>
4676 The I<Swap plugin> collects information about used and available swap space. On
4677 I<Linux> and I<Solaris>, the following options are available:
4681 =item B<ReportByDevice> B<false>|B<true>
4683 Configures how to report physical swap devices. If set to B<false> (the
4684 default), the summary over all swap devices is reported only, i.e. the globally
4685 used and available space over all devices. If B<true> is configured, the used
4686 and available space of each device will be reported separately.
4688 This option is only available if the I<Swap plugin> can read C</proc/swaps>
4689 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
4691 =item B<ReportBytes> B<false>|B<true>
4693 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
4694 I<swap I/O> is reported in pages. This option is available under Linux only.
4698 =head2 Plugin C<syslog>
4702 =item B<LogLevel> B<debug|info|notice|warning|err>
4704 Sets the log-level. If, for example, set to B<notice>, then all events with
4705 severity B<notice>, B<warning>, or B<err> will be submitted to the
4708 Please note that B<debug> is only available if collectd has been compiled with
4711 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
4713 Controls which notifications should be sent to syslog. The default behaviour is
4714 not to send any. Less severe notifications always imply logging more severe
4715 notifications: Setting this to B<OKAY> means all notifications will be sent to
4716 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
4717 notifications but will dismiss B<OKAY> notifications. Setting this option to
4718 B<FAILURE> will only send failures to syslog.
4722 =head2 Plugin C<table>
4724 The C<table plugin> provides generic means to parse tabular data and dispatch
4725 user specified values. Values are selected based on column numbers. For
4726 example, this plugin may be used to get values from the Linux L<proc(5)>
4727 filesystem or CSV (comma separated values) files.
4730 <Table "/proc/slabinfo">
4735 InstancePrefix "active_objs"
4741 InstancePrefix "objperslab"
4748 The configuration consists of one or more B<Table> blocks, each of which
4749 configures one file to parse. Within each B<Table> block, there are one or
4750 more B<Result> blocks, which configure which data to select and how to
4753 The following options are available inside a B<Table> block:
4757 =item B<Instance> I<instance>
4759 If specified, I<instance> is used as the plugin instance. So, in the above
4760 example, the plugin name C<table-slabinfo> would be used. If omitted, the
4761 filename of the table is used instead, with all special characters replaced
4762 with an underscore (C<_>).
4764 =item B<Separator> I<string>
4766 Any character of I<string> is interpreted as a delimiter between the different
4767 columns of the table. A sequence of two or more contiguous delimiters in the
4768 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
4769 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
4770 of a table - see its documentation for more details. This option is mandatory.
4772 A horizontal tab, newline and carriage return may be specified by C<\\t>,
4773 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
4774 required because of collectd's config parsing.
4778 The following options are available inside a B<Result> block:
4782 =item B<Type> I<type>
4784 Sets the type used to dispatch the values to the daemon. Detailed information
4785 about types and their configuration can be found in L<types.db(5)>. This
4786 option is mandatory.
4788 =item B<InstancePrefix> I<prefix>
4790 If specified, prepend I<prefix> to the type instance. If omitted, only the
4791 B<InstancesFrom> option is considered for the type instance.
4793 =item B<InstancesFrom> I<column0> [I<column1> ...]
4795 If specified, the content of the given columns (identified by the column
4796 number starting at zero) will be used to create the type instance for each
4797 row. Multiple values (and the instance prefix) will be joined together with
4798 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
4799 option is considered for the type instance.
4801 The plugin itself does not check whether or not all built instances are
4802 different. It’s your responsibility to assure that each is unique. This is
4803 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
4804 sure that the table only contains one row.
4806 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
4809 =item B<ValuesFrom> I<column0> [I<column1> ...]
4811 Specifies the columns (identified by the column numbers starting at zero)
4812 whose content is used as the actual data for the data sets that are dispatched
4813 to the daemon. How many such columns you need is determined by the B<Type>
4814 setting above. If you specify too many or not enough columns, the plugin will
4815 complain about that and no data will be submitted to the daemon. The plugin
4816 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
4817 respectively, so anything supported by those functions is supported by the
4818 plugin as well. This option is mandatory.
4822 =head2 Plugin C<tail>
4824 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
4825 each line and dispatches found values. What is matched can be configured by the
4826 user using (extended) regular expressions, as described in L<regex(7)>.
4829 <File "/var/log/exim4/mainlog">
4832 Regex "S=([1-9][0-9]*)"
4838 Regex "\\<R=local_user\\>"
4839 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
4842 Instance "local_user"
4847 The config consists of one or more B<File> blocks, each of which configures one
4848 logfile to parse. Within each B<File> block, there are one or more B<Match>
4849 blocks, which configure a regular expression to search for.
4851 The B<Instance> option in the B<File> block may be used to set the plugin
4852 instance. So in the above example the plugin name C<tail-foo> would be used.
4853 This plugin instance is for all B<Match> blocks that B<follow> it, until the
4854 next B<Instance> option. This way you can extract several plugin instances from
4855 one logfile, handy when parsing syslog and the like.
4857 Each B<Match> block has the following options to describe how the match should
4862 =item B<Regex> I<regex>
4864 Sets the regular expression to use for matching against a line. The first
4865 subexpression has to match something that can be turned into a number by
4866 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
4867 below. Because B<extended> regular expressions are used, you do not need to use
4868 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
4869 collectd's config parsing you need to escape backslashes, though. So if you
4870 want to match literal parentheses you need to do the following:
4872 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
4874 =item B<ExcludeRegex> I<regex>
4876 Sets an optional regular expression to use for excluding lines from the match.
4877 An example which excludes all connections from localhost from the match:
4879 ExcludeRegex "127\\.0\\.0\\.1"
4881 =item B<DSType> I<Type>
4883 Sets how the values are cumulated. I<Type> is one of:
4887 =item B<GaugeAverage>
4889 Calculate the average.
4893 Use the smallest number only.
4897 Use the greatest number only.
4901 Use the last number found.
4907 =item B<AbsoluteSet>
4909 The matched number is a counter. Simply I<sets> the internal counter to this
4910 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
4916 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
4917 matched number may be negative, which will effectively subtract from the
4924 Increase the internal counter by one. These B<DSType> are the only ones that do
4925 not use the matched subexpression, but simply count the number of matched
4926 lines. Thus, you may use a regular expression without submatch in this case.
4930 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
4931 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
4932 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
4933 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
4934 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
4937 =item B<Type> I<Type>
4939 Sets the type used to dispatch this value. Detailed information about types and
4940 their configuration can be found in L<types.db(5)>.
4942 =item B<Instance> I<TypeInstance>
4944 This optional setting sets the type instance to use.
4948 =head2 Plugin C<teamspeak2>
4950 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
4951 polls interesting global and virtual server data. The plugin can query only one
4952 physical server but unlimited virtual servers. You can use the following
4953 options to configure it:
4957 =item B<Host> I<hostname/ip>
4959 The hostname or ip which identifies the physical server.
4962 =item B<Port> I<port>
4964 The query port of the physical server. This needs to be a string.
4967 =item B<Server> I<port>
4969 This option has to be added once for every virtual server the plugin should
4970 query. If you want to query the virtual server on port 8767 this is what the
4971 option would look like:
4975 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
4976 use quotes around it! If no such statement is given only global information
4981 =head2 Plugin C<ted>
4983 The I<TED> plugin connects to a device of "The Energy Detective", a device to
4984 measure power consumption. These devices are usually connected to a serial
4985 (RS232) or USB port. The plugin opens a configured device and tries to read the
4986 current energy readings. For more information on TED, visit
4987 L<http://www.theenergydetective.com/>.
4989 Available configuration options:
4993 =item B<Device> I<Path>
4995 Path to the device on which TED is connected. collectd will need read and write
4996 permissions on that file.
4998 Default: B</dev/ttyUSB0>
5000 =item B<Retries> I<Num>
5002 Apparently reading from TED is not that reliable. You can therefore configure a
5003 number of retries here. You only configure the I<retries> here, to if you
5004 specify zero, one reading will be performed (but no retries if that fails); if
5005 you specify three, a maximum of four readings are performed. Negative values
5012 =head2 Plugin C<tcpconns>
5014 The C<tcpconns plugin> counts the number of currently established TCP
5015 connections based on the local port and/or the remote port. Since there may be
5016 a lot of connections the default if to count all connections with a local port,
5017 for which a listening socket is opened. You can use the following options to
5018 fine-tune the ports you are interested in:
5022 =item B<ListeningPorts> I<true>|I<false>
5024 If this option is set to I<true>, statistics for all local ports for which a
5025 listening socket exists are collected. The default depends on B<LocalPort> and
5026 B<RemotePort> (see below): If no port at all is specifically selected, the
5027 default is to collect listening ports. If specific ports (no matter if local or
5028 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
5029 the selected ports will be collected unless this option is set to I<true>
5032 =item B<LocalPort> I<Port>
5034 Count the connections to a specific local port. This can be used to see how
5035 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
5036 You have to specify the port in numeric form, so for the mailserver example
5037 you'd need to set B<25>.
5039 =item B<RemotePort> I<Port>
5041 Count the connections to a specific remote port. This is useful to see how
5042 much a remote service is used. This is most useful if you want to know how many
5043 connections a local service has opened to remote services, e.E<nbsp>g. how many
5044 connections a mail server or news server has to other mail or news servers, or
5045 how many connections a web proxy holds to web servers. You have to give the
5046 port in numeric form.
5050 =head2 Plugin C<thermal>
5054 =item B<ForceUseProcfs> I<true>|I<false>
5056 By default, the I<Thermal plugin> tries to read the statistics from the Linux
5057 C<sysfs> interface. If that is not available, the plugin falls back to the
5058 C<procfs> interface. By setting this option to I<true>, you can force the
5059 plugin to use the latter. This option defaults to I<false>.
5061 =item B<Device> I<Device>
5063 Selects the name of the thermal device that you want to collect or ignore,
5064 depending on the value of the B<IgnoreSelected> option. This option may be
5065 used multiple times to specify a list of devices.
5067 =item B<IgnoreSelected> I<true>|I<false>
5069 Invert the selection: If set to true, all devices B<except> the ones that
5070 match the device names specified by the B<Device> option are collected. By
5071 default only selected devices are collected if a selection is made. If no
5072 selection is configured at all, B<all> devices are selected.
5076 =head2 Plugin C<threshold>
5078 The I<Threshold plugin> checks values collected or received by I<collectd>
5079 against a configurable I<threshold> and issues I<notifications> if values are
5082 Documentation for this plugin is available in the L<collectd-threshold(5)>
5085 =head2 Plugin C<tokyotyrant>
5087 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
5088 couple metrics: number of records, and database size on disk.
5092 =item B<Host> I<Hostname/IP>
5094 The hostname or ip which identifies the server.
5095 Default: B<127.0.0.1>
5097 =item B<Port> I<Service/Port>
5099 The query port of the server. This needs to be a string, even if the port is
5100 given in its numeric form.
5105 =head2 Plugin C<unixsock>
5109 =item B<SocketFile> I<Path>
5111 Sets the socket-file which is to be created.
5113 =item B<SocketGroup> I<Group>
5115 If running as root change the group of the UNIX-socket after it has been
5116 created. Defaults to B<collectd>.
5118 =item B<SocketPerms> I<Permissions>
5120 Change the file permissions of the UNIX-socket after it has been created. The
5121 permissions must be given as a numeric, octal value as you would pass to
5122 L<chmod(1)>. Defaults to B<0770>.
5124 =item B<DeleteSocket> B<false>|B<true>
5126 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
5127 with the given name already exists. If I<collectd> crashes a socket file may be
5128 left over, preventing the daemon from opening a new socket when restarted.
5129 Since this is potentially dangerous, this defaults to B<false>.
5133 =head2 Plugin C<uuid>
5135 This plugin, if loaded, causes the Hostname to be taken from the machine's
5136 UUID. The UUID is a universally unique designation for the machine, usually
5137 taken from the machine's BIOS. This is most useful if the machine is running in
5138 a virtual environment such as Xen, in which case the UUID is preserved across
5139 shutdowns and migration.
5141 The following methods are used to find the machine's UUID, in order:
5147 Check I</etc/uuid> (or I<UUIDFile>).
5151 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
5156 Check for UUID from C<dmidecode> / SMBIOS.
5160 Check for UUID from Xen hypervisor.
5164 If no UUID can be found then the hostname is not modified.
5168 =item B<UUIDFile> I<Path>
5170 Take the UUID from the given file (default I</etc/uuid>).
5174 =head2 Plugin C<varnish>
5176 The Varnish plugin collects information about Varnish, an HTTP accelerator.
5180 =item B<CollectCache> B<true>|B<false>
5182 Cache hits and misses. True by default.
5184 =item B<CollectConnections> B<true>|B<false>
5186 Number of client connections received, accepted and dropped. True by default.
5188 =item B<CollectBackend> B<true>|B<false>
5190 Back-end connection statistics, such as successful, reused,
5191 and closed connections. True by default.
5193 =item B<CollectSHM> B<true>|B<false>
5195 Statistics about the shared memory log, a memory region to store
5196 log messages which is flushed to disk when full. True by default.
5198 =item B<CollectESI> B<true>|B<false>
5200 Edge Side Includes (ESI) parse statistics. False by default.
5202 =item B<CollectFetch> B<true>|B<false>
5204 Statistics about fetches (HTTP requests sent to the backend). False by default.
5206 =item B<CollectHCB> B<true>|B<false>
5208 Inserts and look-ups in the crit bit tree based hash. Look-ups are
5209 divided into locked and unlocked look-ups. False by default.
5211 =item B<CollectSMA> B<true>|B<false>
5213 malloc or umem (umem_alloc(3MALLOC) based) storage statistics.
5214 The umem storage component is Solaris specific. False by default.
5216 =item B<CollectSMS> B<true>|B<false>
5218 synth (synthetic content) storage statistics. This storage
5219 component is used internally only. False by default.
5221 =item B<CollectSM> B<true>|B<false>
5223 file (memory mapped file) storage statistics. False by default.
5225 =item B<CollectTotals> B<true>|B<false>
5227 Collects overview counters, such as the number of sessions created,
5228 the number of requests and bytes transferred. False by default.
5230 =item B<CollectWorkers> B<true>|B<false>
5232 Collect statistics about worker threads. False by default.
5236 =head2 Plugin C<vmem>
5238 The C<vmem> plugin collects information about the usage of virtual memory.
5239 Since the statistics provided by the Linux kernel are very detailed, they are
5240 collected very detailed. However, to get all the details, you have to switch
5241 them on manually. Most people just want an overview over, such as the number of
5242 pages read from swap space.
5246 =item B<Verbose> B<true>|B<false>
5248 Enables verbose collection of information. This will start collecting page
5249 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
5250 Part of these statistics are collected on a "per zone" basis.
5254 =head2 Plugin C<vserver>
5256 This plugin doesn't have any options. B<VServer> support is only available for
5257 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
5258 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
5259 need to apply the patches and compile your own kernel, which will then provide
5260 the F</proc/virtual> filesystem that is required by this plugin.
5262 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
5264 B<Note>: The traffic collected by this plugin accounts for the amount of
5265 traffic passing a socket which might be a lot less than the actual on-wire
5266 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
5267 collect on-wire traffic you could, for example, use the logging facilities of
5268 iptables to feed data for the guest IPs into the iptables plugin.
5270 =head2 Plugin C<write_graphite>
5272 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
5273 storage and graphing project. The plugin connects to I<Carbon>, the data layer
5274 of I<Graphite>, and sends data via the "line based" protocol (per default using
5275 portE<nbsp>2003). The data will be sent in blocks of at most 1428 bytes to
5276 minimize the number of network packets.
5280 <Plugin write_graphite>
5290 =item B<Host> I<Address>
5292 Hostname or address to connect to. Defaults to C<localhost>.
5294 =item B<Port> I<Service>
5296 Service name or port number to connect to. Defaults to C<2003>.
5298 =item B<Prefix> I<String>
5300 When set, I<String> is added in front of the host name. Dots and whitespace are
5301 I<not> escaped in this string (see B<EscapeCharacter> below).
5303 =item B<Postfix> I<String>
5305 When set, I<String> is appended to the host name. Dots and whitespace are
5306 I<not> escaped in this string (see B<EscapeCharacter> below).
5308 =item B<EscapeCharacter> I<Char>
5310 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
5311 in the identifier. The B<EscapeCharacter> option determines which character
5312 dots, whitespace and control characters are replaced with. Defaults to
5315 =item B<StoreRates> B<false>|B<true>
5317 If set to B<true> (the default), convert counter values to rates. If set to
5318 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
5321 =item B<SeparateInstances> B<false>|B<true>
5323 If set to B<true>, the plugin instance and type instance will be in their own
5324 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
5325 default), the plugin and plugin instance (and likewise the type and type
5326 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
5328 =item B<AlwaysAppendDS> B<false>|B<true>
5330 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
5331 identifier. If set to B<false> (the default), this is only done when there is
5336 =head2 Plugin C<write_mongodb>
5338 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
5343 <Plugin "write_mongodb">
5352 The plugin can send values to multiple instances of I<MongoDB> by specifying
5353 one B<Node> block for each instance. Within the B<Node> blocks, the following
5354 options are available:
5358 =item B<Host> I<Address>
5360 Hostname or address to connect to. Defaults to C<localhost>.
5362 =item B<Port> I<Service>
5364 Service name or port number to connect to. Defaults to C<27017>.
5366 =item B<Timeout> I<Timeout>
5368 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
5369 Setting this option to zero means no timeout, which is the default.
5371 =item B<StoreRates> B<false>|B<true>
5373 If set to B<true> (the default), convert counter values to rates. If set to
5374 B<false> counter values are stored as is, i.e. as an increasing integer
5379 =head2 Plugin C<write_http>
5381 This output plugin submits values to an http server by POST them using the
5382 PUTVAL plain-text protocol. Each destination you want to post data to needs to
5383 have one B<URL> block, within which the destination can be configured further,
5384 for example by specifying authentication data.
5388 <Plugin "write_http">
5389 <URL "http://example.com/post-collectd">
5395 B<URL> blocks need one string argument which is used as the URL to which data
5396 is posted. The following options are understood within B<URL> blocks.
5400 =item B<User> I<Username>
5402 Optional user name needed for authentication.
5404 =item B<Password> I<Password>
5406 Optional password needed for authentication.
5408 =item B<VerifyPeer> B<true>|B<false>
5410 Enable or disable peer SSL certificate verification. See
5411 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5413 =item B<VerifyHost> B<true|false>
5415 Enable or disable peer host name verification. If enabled, the plugin checks if
5416 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
5417 matches the host name provided by the B<URL> option. If this identity check
5418 fails, the connection is aborted. Obviously, only works when connecting to a
5419 SSL enabled server. Enabled by default.
5421 =item B<CACert> I<File>
5423 File that holds one or more SSL certificates. If you want to use HTTPS you will
5424 possibly need this option. What CA certificates come bundled with C<libcurl>
5425 and are checked by default depends on the distribution you use.
5427 =item B<Format> B<Command>|B<JSON>
5429 Format of the output to generate. If set to B<Command>, will create output that
5430 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
5431 create output in the I<JavaScript Object Notation> (JSON).
5433 Defaults to B<Command>.
5435 =item B<StoreRates> B<true|false>
5437 If set to B<true>, convert counter values to rates. If set to B<false> (the
5438 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
5443 =head1 THRESHOLD CONFIGURATION
5445 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
5446 we mean that the values are not only stored or sent somewhere, but that they
5447 are judged and, if a problem is recognized, acted upon. The only action
5448 collectd takes itself is to generate and dispatch a "notification". Plugins can
5449 register to receive notifications and perform appropriate further actions.
5451 Since systems and what you expect them to do differ a lot, you can configure
5452 B<thresholds> for your values freely. This gives you a lot of flexibility but
5453 also a lot of responsibility.
5455 Every time a value is out of range a notification is dispatched. This means
5456 that the idle percentage of your CPU needs to be less then the configured
5457 threshold only once for a notification to be generated. There's no such thing
5458 as a moving average or similar - at least not now.
5460 Also, all values that match a threshold are considered to be relevant or
5461 "interesting". As a consequence collectd will issue a notification if they are
5462 not received for B<Timeout> iterations. The B<Timeout> configuration option is
5463 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
5464 "2" (the default) and some hosts sends it's CPU statistics to the server every
5465 60 seconds, a notification will be dispatched after about 120 seconds. It may
5466 take a little longer because the timeout is checked only once each B<Interval>
5469 When a value comes within range again or is received after it was missing, an
5470 "OKAY-notification" is dispatched.
5472 Here is a configuration example to get you started. Read below for more
5485 <Plugin "interface">
5502 WarningMin 100000000
5508 There are basically two types of configuration statements: The C<Host>,
5509 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
5510 configured. The C<Plugin> and C<Type> blocks may be specified further using the
5511 C<Instance> option. You can combine the block by nesting the blocks, though
5512 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
5513 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
5514 C<Type> may not contain other blocks. If multiple blocks apply to the same
5515 value the most specific block is used.
5517 The other statements specify the threshold to configure. They B<must> be
5518 included in a C<Type> block. Currently the following statements are recognized:
5522 =item B<FailureMax> I<Value>
5524 =item B<WarningMax> I<Value>
5526 Sets the upper bound of acceptable values. If unset defaults to positive
5527 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
5528 will be created. If the value is greater than B<WarningMax> but less than (or
5529 equal to) B<FailureMax> a B<WARNING> notification will be created.
5531 =item B<FailureMin> I<Value>
5533 =item B<WarningMin> I<Value>
5535 Sets the lower bound of acceptable values. If unset defaults to negative
5536 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
5537 be created. If the value is less than B<WarningMin> but greater than (or equal
5538 to) B<FailureMin> a B<WARNING> notification will be created.
5540 =item B<DataSource> I<DSName>
5542 Some data sets have more than one "data source". Interesting examples are the
5543 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
5544 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
5545 system load data set, C<load>, even has three data sources: C<shortterm>,
5546 C<midterm>, and C<longterm>.
5548 Normally, all data sources are checked against a configured threshold. If this
5549 is undesirable, or if you want to specify different limits for each data
5550 source, you can use the B<DataSource> option to have a threshold apply only to
5553 =item B<Invert> B<true>|B<false>
5555 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
5556 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
5557 B<WarningMax>) are not okay. Defaults to B<false>.
5559 =item B<Persist> B<true>|B<false>
5561 Sets how often notifications are generated. If set to B<true> one notification
5562 will be generated for each value that is out of the acceptable range. If set to
5563 B<false> (the default) then a notification is only generated if a value is out
5564 of range but the previous value was okay.
5566 This applies to missing values, too: If set to B<true> a notification about a
5567 missing value is generated once every B<Interval> seconds. If set to B<false>
5568 only one such notification is generated until the value appears again.
5570 =item B<Percentage> B<true>|B<false>
5572 If set to B<true>, the minimum and maximum values given are interpreted as
5573 percentage value, relative to the other data sources. This is helpful for
5574 example for the "df" type, where you may want to issue a warning when less than
5575 5E<nbsp>% of the total space is available. Defaults to B<false>.
5577 =item B<Hits> I<Number>
5579 Delay creating the notification until the threshold has been passed I<Number>
5580 times. When a notification has been generated, or when a subsequent value is
5581 inside the threshold, the counter is reset. If, for example, a value is
5582 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
5583 will be dispatched at most once every 30E<nbsp>seconds.
5585 This is useful when short bursts are not a problem. If, for example, 100% CPU
5586 usage for up to a minute is normal (and data is collected every
5587 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
5589 =item B<Hysteresis> I<Number>
5591 When set to non-zero, a hysteresis value is applied when checking minimum and
5592 maximum bounds. This is useful for values that increase slowly and fluctuate a
5593 bit while doing so. When these values come close to the threshold, they may
5594 "flap", i.e. switch between failure / warning case and okay case repeatedly.
5596 If, for example, the threshold is configures as
5601 then a I<Warning> notification is created when the value exceeds I<101> and the
5602 corresponding I<Okay> notification is only created once the value falls below
5603 I<99>, thus avoiding the "flapping".
5607 =head1 FILTER CONFIGURATION
5609 Starting with collectd 4.6 there is a powerful filtering infrastructure
5610 implemented in the daemon. The concept has mostly been copied from
5611 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
5612 terminology, so that users that are familiar with iptables feel right at home.
5616 The following are the terms used in the remainder of the filter configuration
5617 documentation. For an ASCII-art schema of the mechanism, see
5618 L<"General structure"> below.
5624 A I<match> is a criteria to select specific values. Examples are, of course, the
5625 name of the value or it's current value.
5627 Matches are implemented in plugins which you have to load prior to using the
5628 match. The name of such plugins starts with the "match_" prefix.
5632 A I<target> is some action that is to be performed with data. Such actions
5633 could, for example, be to change part of the value's identifier or to ignore
5634 the value completely.
5636 Some of these targets are built into the daemon, see L<"Built-in targets">
5637 below. Other targets are implemented in plugins which you have to load prior to
5638 using the target. The name of such plugins starts with the "target_" prefix.
5642 The combination of any number of matches and at least one target is called a
5643 I<rule>. The target actions will be performed for all values for which B<all>
5644 matches apply. If the rule does not have any matches associated with it, the
5645 target action will be performed for all values.
5649 A I<chain> is a list of rules and possibly default targets. The rules are tried
5650 in order and if one matches, the associated target will be called. If a value
5651 is handled by a rule, it depends on the target whether or not any subsequent
5652 rules are considered or if traversal of the chain is aborted, see
5653 L<"Flow control"> below. After all rules have been checked, the default targets
5658 =head2 General structure
5660 The following shows the resulting structure:
5667 +---------+ +---------+ +---------+ +---------+
5668 ! Rule !->! Match !->! Match !->! Target !
5669 +---------+ +---------+ +---------+ +---------+
5672 +---------+ +---------+ +---------+
5673 ! Rule !->! Target !->! Target !
5674 +---------+ +---------+ +---------+
5681 +---------+ +---------+ +---------+
5682 ! Rule !->! Match !->! Target !
5683 +---------+ +---------+ +---------+
5693 There are four ways to control which way a value takes through the filter
5700 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
5701 process the value with another chain. When the called chain finishes, usually
5702 the next target or rule after the jump is executed.
5706 The stop condition, signaled for example by the built-in target B<stop>, causes
5707 all processing of the value to be stopped immediately.
5711 Causes processing in the current chain to be aborted, but processing of the
5712 value generally will continue. This means that if the chain was called via
5713 B<Jump>, the next target or rule after the jump will be executed. If the chain
5714 was not called by another chain, control will be returned to the daemon and it
5715 may pass the value to another chain.
5719 Most targets will signal the B<continue> condition, meaning that processing
5720 should continue normally. There is no special built-in target for this
5727 The configuration reflects this structure directly:
5729 PostCacheChain "PostCache"
5731 <Rule "ignore_mysql_show">
5734 Type "^mysql_command$"
5735 TypeInstance "^show_"
5745 The above configuration example will ignore all values where the plugin field
5746 is "mysql", the type is "mysql_command" and the type instance begins with
5747 "show_". All other values will be sent to the C<rrdtool> write plugin via the
5748 default target of the chain. Since this chain is run after the value has been
5749 added to the cache, the MySQL C<show_*> command statistics will be available
5750 via the C<unixsock> plugin.
5752 =head2 List of configuration options
5756 =item B<PreCacheChain> I<ChainName>
5758 =item B<PostCacheChain> I<ChainName>
5760 Configure the name of the "pre-cache chain" and the "post-cache chain". The
5761 argument is the name of a I<chain> that should be executed before and/or after
5762 the values have been added to the cache.
5764 To understand the implications, it's important you know what is going on inside
5765 I<collectd>. The following diagram shows how values are passed from the
5766 read-plugins to the write-plugins:
5772 + - - - - V - - - - +
5773 : +---------------+ :
5776 : +-------+-------+ :
5779 : +-------+-------+ : +---------------+
5780 : ! Cache !--->! Value Cache !
5781 : ! insert ! : +---+---+-------+
5782 : +-------+-------+ : ! !
5783 : ! ,------------' !
5785 : +-------+---+---+ : +-------+-------+
5786 : ! Post-Cache +--->! Write-Plugins !
5787 : ! Chain ! : +---------------+
5788 : +---------------+ :
5791 + - - - - - - - - - +
5793 After the values are passed from the "read" plugins to the dispatch functions,
5794 the pre-cache chain is run first. The values are added to the internal cache
5795 afterwards. The post-cache chain is run after the values have been added to the
5796 cache. So why is it such a huge deal if chains are run before or after the
5797 values have been added to this cache?
5799 Targets that change the identifier of a value list should be executed before
5800 the values are added to the cache, so that the name in the cache matches the
5801 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
5802 this cache to receive a list of all available values. If you change the
5803 identifier after the value list has been added to the cache, this may easily
5804 lead to confusion, but it's not forbidden of course.
5806 The cache is also used to convert counter values to rates. These rates are, for
5807 example, used by the C<value> match (see below). If you use the rate stored in
5808 the cache B<before> the new value is added, you will use the old, B<previous>
5809 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
5810 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
5813 Last but not last, the B<stop> target makes a difference: If the pre-cache
5814 chain returns the stop condition, the value will not be added to the cache and
5815 the post-cache chain will not be run.
5817 =item B<Chain> I<Name>
5819 Adds a new chain with a certain name. This name can be used to refer to a
5820 specific chain, for example to jump to it.
5822 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
5824 =item B<Rule> [I<Name>]
5826 Adds a new rule to the current chain. The name of the rule is optional and
5827 currently has no meaning for the daemon.
5829 Within the B<Rule> block, there may be any number of B<Match> blocks and there
5830 must be at least one B<Target> block.
5832 =item B<Match> I<Name>
5834 Adds a match to a B<Rule> block. The name specifies what kind of match should
5835 be performed. Available matches depend on the plugins that have been loaded.
5837 The arguments inside the B<Match> block are passed to the plugin implementing
5838 the match, so which arguments are valid here depends on the plugin being used.
5839 If you do not need any to pass any arguments to a match, you can use the
5844 Which is equivalent to:
5849 =item B<Target> I<Name>
5851 Add a target to a rule or a default target to a chain. The name specifies what
5852 kind of target is to be added. Which targets are available depends on the
5853 plugins being loaded.
5855 The arguments inside the B<Target> block are passed to the plugin implementing
5856 the target, so which arguments are valid here depends on the plugin being used.
5857 If you do not need any to pass any arguments to a target, you can use the
5862 This is the same as writing:
5869 =head2 Built-in targets
5871 The following targets are built into the core daemon and therefore need no
5872 plugins to be loaded:
5878 Signals the "return" condition, see the L<"Flow control"> section above. This
5879 causes the current chain to stop processing the value and returns control to
5880 the calling chain. The calling chain will continue processing targets and rules
5881 just after the B<jump> target (see below). This is very similar to the
5882 B<RETURN> target of iptables, see L<iptables(8)>.
5884 This target does not have any options.
5892 Signals the "stop" condition, see the L<"Flow control"> section above. This
5893 causes processing of the value to be aborted immediately. This is similar to
5894 the B<DROP> target of iptables, see L<iptables(8)>.
5896 This target does not have any options.
5904 Sends the value to "write" plugins.
5910 =item B<Plugin> I<Name>
5912 Name of the write plugin to which the data should be sent. This option may be
5913 given multiple times to send the data to more than one write plugin.
5917 If no plugin is explicitly specified, the values will be sent to all available
5928 Starts processing the rules of another chain, see L<"Flow control"> above. If
5929 the end of that chain is reached, or a stop condition is encountered,
5930 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
5931 next target or the next rule. This is similar to the B<-j> command line option
5932 of iptables, see L<iptables(8)>.
5938 =item B<Chain> I<Name>
5940 Jumps to the chain I<Name>. This argument is required and may appear only once.
5952 =head2 Available matches
5958 Matches a value using regular expressions.
5964 =item B<Host> I<Regex>
5966 =item B<Plugin> I<Regex>
5968 =item B<PluginInstance> I<Regex>
5970 =item B<Type> I<Regex>
5972 =item B<TypeInstance> I<Regex>
5974 Match values where the given regular expressions match the various fields of
5975 the identifier of a value. If multiple regular expressions are given, B<all>
5976 regexen must match for a value to match.
5978 =item B<Invert> B<false>|B<true>
5980 When set to B<true>, the result of the match is inverted, i.e. all value lists
5981 where all regular expressions apply are not matched, all other value lists are
5982 matched. Defaults to B<false>.
5989 Host "customer[0-9]+"
5995 Matches values that have a time which differs from the time on the server.
5997 This match is mainly intended for servers that receive values over the
5998 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
5999 is very sensitive to the timestamp used when updating the RRD files. In
6000 particular, the time must be ever increasing. If a misbehaving client sends one
6001 packet with a timestamp far in the future, all further packets with a correct
6002 time will be ignored because of that one packet. What's worse, such corrupted
6003 RRD files are hard to fix.
6005 This match lets one match all values B<outside> a specified time range
6006 (relative to the server's time), so you can use the B<stop> target (see below)
6007 to ignore the value, for example.
6013 =item B<Future> I<Seconds>
6015 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
6016 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
6019 =item B<Past> I<Seconds>
6021 Matches all values that are I<behind> of the server's time by I<Seconds> or
6022 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
6034 This example matches all values that are five minutes or more ahead of the
6035 server or one hour (or more) lagging behind.
6039 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
6040 values. If a data-set consists of more than one data-source, all data-sources
6041 must match the specified ranges for a positive match.
6047 =item B<Min> I<Value>
6049 Sets the smallest value which still results in a match. If unset, behaves like
6052 =item B<Max> I<Value>
6054 Sets the largest value which still results in a match. If unset, behaves like
6057 =item B<Invert> B<true>|B<false>
6059 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
6060 no-match is returned and vice versa. Please note that the B<Invert> setting
6061 only effects how B<Min> and B<Max> are applied to a specific value. Especially
6062 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
6064 =item B<DataSource> I<DSName> [I<DSName> ...]
6066 Select one or more of the data sources. If no data source is configured, all
6067 data sources will be checked. If the type handled by the match does not have a
6068 data source of the specified name(s), this will always result in no match
6069 (independent of the B<Invert> setting).
6071 =item B<Satisfy> B<Any>|B<All>
6073 Specifies how checking with several data sources is performed. If set to
6074 B<Any>, the match succeeds if one of the data sources is in the configured
6075 range. If set to B<All> the match only succeeds if all data sources are within
6076 the configured range. Default is B<All>.
6078 Usually B<All> is used for positive matches, B<Any> is used for negative
6079 matches. This means that with B<All> you usually check that all values are in a
6080 "good" range, while with B<Any> you check if any value is within a "bad" range
6081 (or outside the "good" range).
6085 Either B<Min> or B<Max>, but not both, may be unset.
6089 # Match all values smaller than or equal to 100. Matches only if all data
6090 # sources are below 100.
6096 # Match if the value of any data source is outside the range of 0 - 100.
6104 =item B<empty_counter>
6106 Matches all values with one or more data sources of type B<COUNTER> and where
6107 all counter values are zero. These counters usually I<never> increased since
6108 they started existing (and are therefore uninteresting), or got reset recently
6109 or overflowed and you had really, I<really> bad luck.
6111 Please keep in mind that ignoring such counters can result in confusing
6112 behavior: Counters which hardly ever increase will be zero for long periods of
6113 time. If the counter is reset for some reason (machine or service restarted,
6114 usually), the graph will be empty (NAN) for a long time. People may not
6119 Calculates a hash value of the host name and matches values according to that
6120 hash value. This makes it possible to divide all hosts into groups and match
6121 only values that are in a specific group. The intended use is in load
6122 balancing, where you want to handle only part of all data and leave the rest
6125 The hashing function used tries to distribute the hosts evenly. First, it
6126 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
6129 for (i = 0; host[i] != 0; i++)
6130 hash_value = (hash_value * 251) + host[i];
6132 The constant 251 is a prime number which is supposed to make this hash value
6133 more random. The code then checks the group for this host according to the
6134 I<Total> and I<Match> arguments:
6136 if ((hash_value % Total) == Match)
6141 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
6142 groups), then the least significant bit of the hash value will be the XOR of
6143 all least significant bits in the host name. One consequence is that when you
6144 have two hosts, "server0.example.com" and "server1.example.com", where the host
6145 name differs in one digit only and the digits differ by one, those hosts will
6146 never end up in the same group.
6152 =item B<Match> I<Match> I<Total>
6154 Divide the data into I<Total> groups and match all hosts in group I<Match> as
6155 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
6156 be smaller than I<Total>. I<Total> must be at least one, although only values
6157 greater than one really do make any sense.
6159 You can repeat this option to match multiple groups, for example:
6164 The above config will divide the data into seven groups and match groups three
6165 and five. One use would be to keep every value on two hosts so that if one
6166 fails the missing data can later be reconstructed from the second host.
6172 # Operate on the pre-cache chain, so that ignored values are not even in the
6177 # Divide all received hosts in seven groups and accept all hosts in
6181 # If matched: Return and continue.
6184 # If not matched: Return and stop.
6190 =head2 Available targets
6194 =item B<notification>
6196 Creates and dispatches a notification.
6202 =item B<Message> I<String>
6204 This required option sets the message of the notification. The following
6205 placeholders will be replaced by an appropriate value:
6213 =item B<%{plugin_instance}>
6217 =item B<%{type_instance}>
6219 These placeholders are replaced by the identifier field of the same name.
6221 =item B<%{ds:>I<name>B<}>
6223 These placeholders are replaced by a (hopefully) human readable representation
6224 of the current rate of this data source. If you changed the instance name
6225 (using the B<set> or B<replace> targets, see below), it may not be possible to
6226 convert counter values to rates.
6230 Please note that these placeholders are B<case sensitive>!
6232 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
6234 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
6241 <Target "notification">
6242 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
6248 Replaces parts of the identifier using regular expressions.
6254 =item B<Host> I<Regex> I<Replacement>
6256 =item B<Plugin> I<Regex> I<Replacement>
6258 =item B<PluginInstance> I<Regex> I<Replacement>
6260 =item B<TypeInstance> I<Regex> I<Replacement>
6262 Match the appropriate field with the given regular expression I<Regex>. If the
6263 regular expression matches, that part that matches is replaced with
6264 I<Replacement>. If multiple places of the input buffer match a given regular
6265 expression, only the first occurrence will be replaced.
6267 You can specify each option multiple times to use multiple regular expressions
6275 # Replace "example.net" with "example.com"
6276 Host "\\<example.net\\>" "example.com"
6278 # Strip "www." from hostnames
6284 Sets part of the identifier of a value to a given string.
6290 =item B<Host> I<String>
6292 =item B<Plugin> I<String>
6294 =item B<PluginInstance> I<String>
6296 =item B<TypeInstance> I<String>
6298 Set the appropriate field to the given string. The strings for plugin instance
6299 and type instance may be empty, the strings for host and plugin may not be
6300 empty. It's currently not possible to set the type of a value this way.
6307 PluginInstance "coretemp"
6308 TypeInstance "core3"
6313 =head2 Backwards compatibility
6315 If you use collectd with an old configuration, i.E<nbsp>e. one without a
6316 B<Chain> block, it will behave as it used to. This is equivalent to the
6317 following configuration:
6323 If you specify a B<PostCacheChain>, the B<write> target will not be added
6324 anywhere and you will have to make sure that it is called where appropriate. We
6325 suggest to add the above snippet as default target to your "PostCache" chain.
6329 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
6345 L<collectd-exec(5)>,
6346 L<collectd-perl(5)>,
6347 L<collectd-unixsock(5)>,
6360 Florian Forster E<lt>octo@verplant.orgE<gt>