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
26 This config file controls how the system statistics collection daemon
27 B<collectd> behaves. The most significant option is B<LoadPlugin>, which
28 controls which plugins to load. These plugins ultimately define collectd's
31 The syntax of this config file is similar to the config file of the famous
32 I<Apache> webserver. Each line contains either an option (a key and a list of
33 one or more values) or a section-start or -end. Empty lines and everything
34 after a non-quoted hash-symbol (C<#>) is ignored. I<Keys> are unquoted
35 strings, consisting only of alphanumeric characters and the underscore (C<_>)
36 character. Keys are handled case insensitive by I<collectd> itself and all
37 plugins included with it. I<Values> can either be an I<unquoted string>, a
38 I<quoted string> (enclosed in double-quotes) a I<number> or a I<boolean>
39 expression. I<Unquoted strings> consist of only alphanumeric characters and
40 underscores (C<_>) and do not need to be quoted. I<Quoted strings> are
41 enclosed in double quotes (C<">). You can use the backslash character (C<\>)
42 to include double quotes as part of the string. I<Numbers> can be specified in
43 decimal and floating point format (using a dot C<.> as decimal separator),
44 hexadecimal when using the C<0x> prefix and octal with a leading zero (C<0>).
45 I<Boolean> values are either B<true> or B<false>.
47 Lines may be wrapped by using C<\> as the last character before the newline.
48 This allows long lines to be split into multiple lines. Quoted strings may be
49 wrapped as well. However, those are treated special in that whitespace at the
50 beginning of the following lines will be ignored, which allows for nicely
51 indenting the wrapped lines.
53 The configuration is read and processed in order, i.e. from top to bottom. So
54 the plugins are loaded in the order listed in this config file. It is a good
55 idea to load any logging plugins first in order to catch messages from plugins
56 during configuration. Also, the C<LoadPlugin> option B<must> occur B<before>
57 the appropriate C<E<lt>Plugin ...E<gt>> block.
63 =item B<BaseDir> I<Directory>
65 Sets the base directory. This is the directory beneath all RRD-files are
66 created. Possibly more subdirectories are created. This is also the working
67 directory for the daemon.
69 =item B<LoadPlugin> I<Plugin>
71 Loads the plugin I<Plugin>. There must be at least one such line or B<collectd>
72 will be mostly useless.
74 Starting with collectd 4.9, this may also be a block in which further options
75 affecting the behavior of B<LoadPlugin> may be specified. The following
76 options are allowed inside a B<LoadPlugin> block:
85 =item B<Globals> B<true|false>
87 If enabled, collectd will export all global symbols of the plugin (and of all
88 libraries loaded as dependencies of the plugin) and, thus, makes those symbols
89 available for resolving unresolved symbols in subsequently loaded plugins if
90 that is supported by your system.
92 This is useful (or possibly even required), e.g., when loading a plugin that
93 embeds some scripting language into the daemon (e.g. the I<Perl> and
94 I<Python plugins>). Scripting languages usually provide means to load
95 extensions written in C. Those extensions require symbols provided by the
96 interpreter, which is loaded as a dependency of the respective collectd plugin.
97 See the documentation of those plugins (e.g., L<collectd-perl(5)> or
98 L<collectd-python(5)>) for details.
100 By default, this is disabled. As a special exception, if the plugin name is
101 either C<perl> or C<python>, the default is changed to enabled in order to keep
102 the average user from ever having to deal with this low level linking stuff.
104 =item B<Interval> I<Seconds>
106 Sets a plugin-specific interval for collecting metrics. This overrides the
107 global B<Interval> setting. If a plugin provides own support for specifying an
108 interval, that setting will take precedence.
112 =item B<Include> I<Path> [I<pattern>]
114 If I<Path> points to a file, includes that file. If I<Path> points to a
115 directory, recursively includes all files within that directory and its
116 subdirectories. If the C<wordexp> function is available on your system,
117 shell-like wildcards are expanded before files are included. This means you can
118 use statements like the following:
120 Include "/etc/collectd.d/*.conf"
122 If the C<fnmatch> function is available on your system, a shell-like wildcard
123 I<pattern> may be specified to filter which files to include. This may be used
124 in combination with recursively including a directory to easily be able to
125 arbitrarily mix configuration files and other documents (e.g. README files).
126 The following statement is similar to the example above but includes all files
127 matching C<*.conf> in any subdirectory of C</etc/collectd.d>:
129 Include "/etc/collectd.d" "*.conf"
131 If more than one files are included by a single B<Include> option, the files
132 will be included in lexicographical order (as defined by the C<strcmp>
133 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
134 order in which the files are loaded.
136 To prevent loops and shooting yourself in the foot in interesting ways the
137 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
138 most uses. Since symlinks are followed it is still possible to crash the daemon
139 by looping symlinks. In our opinion significant stupidity should result in an
140 appropriate amount of pain.
142 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
143 file, but you cannot include files from within blocks.
145 =item B<PIDFile> I<File>
147 Sets where to write the PID file to. This file is overwritten when it exists
148 and deleted when the program is stopped. Some init-scripts might override this
149 setting using the B<-P> command-line option.
151 =item B<PluginDir> I<Directory>
153 Path to the plugins (shared objects) of collectd.
155 =item B<TypesDB> I<File> [I<File> ...]
157 Set one or more files that contain the data-set descriptions. See
158 L<types.db(5)> for a description of the format of this file.
160 =item B<Interval> I<Seconds>
162 Configures the interval in which to query the read plugins. Obviously smaller
163 values lead to a higher system load produced by collectd, while higher values
164 lead to more coarse statistics.
166 B<Warning:> You should set this once and then never touch it again. If you do,
167 I<you will have to delete all your RRD files> or know some serious RRDtool
168 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
170 =item B<Timeout> I<Iterations>
172 Consider a value list "missing" when no update has been read or received for
173 I<Iterations> iterations. By default, I<collectd> considers a value list
174 missing when no update has been received for twice the update interval. Since
175 this setting uses iterations, the maximum allowed time without update depends
176 on the I<Interval> information contained in each value list. This is used in
177 the I<Threshold> configuration to dispatch notifications about missing values,
178 see L<collectd-threshold(5)> for details.
180 =item B<ReadThreads> I<Num>
182 Number of threads to start for reading plugins. The default value is B<5>, but
183 you may want to increase this if you have more than five plugins that take a
184 long time to read. Mostly those are plugin that do network-IO. Setting this to
185 a value higher than the number of plugins you've loaded is totally useless.
187 =item B<Hostname> I<Name>
189 Sets the hostname that identifies a host. If you omit this setting, the
190 hostname will be determined using the L<gethostname(2)> system call.
192 =item B<FQDNLookup> B<true|false>
194 If B<Hostname> is determined automatically this setting controls whether or not
195 the daemon should try to figure out the "fully qualified domain name", FQDN.
196 This is done using a lookup of the name returned by C<gethostname>. This option
197 is enabled by default.
199 =item B<PreCacheChain> I<ChainName>
201 =item B<PostCacheChain> I<ChainName>
203 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
204 see L<FILTER CONFIGURATION> below on information on chains and how these
205 setting change the daemon's behavior.
209 =head1 PLUGIN OPTIONS
211 Some plugins may register own options. These options must be enclosed in a
212 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
213 require external configuration, too. The C<apache plugin>, for example,
214 required C<mod_status> to be configured in the webserver you're going to
215 collect data from. These plugins are listed below as well, even if they don't
216 require any configuration within collectd's configuration file.
218 A list of all plugins and a short summary for each plugin can be found in the
219 F<README> file shipped with the sourcecode and hopefully binary packets as
222 =head2 Plugin C<aggregation>
224 The I<Aggregation plugin> makes it possible to aggregate several values into
225 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
226 This can be put to a wide variety of uses, e.g. average and total CPU
227 statistics for your entire fleet.
229 The grouping is powerful but, as with many powerful tools, may be a bit
230 difficult to wrap your head around. The grouping will therefore be
231 demonstrated using an example: The average and sum of the CPU usage across
232 all CPUs of each host is to be calculated.
234 To select all the affected values for our example, set C<Plugin cpu> and
235 C<Type cpu>. The other values are left unspecified, meaning "all values". The
236 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
237 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
243 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...) and
244 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
245 example, the intention is to have a new value for each host / type instance
246 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
247 It can be specified multiple times to group by more than one field.
250 GroupBy "TypeInstance"
252 We do neither specify nor group by I<plugin instance> (the CPU number), so all
253 metrics that differ in the CPU number only will be aggregated. Each
254 aggregation needs I<at least one> such field, otherwise no aggregation would
257 The full example configuration looks like this:
259 <Plugin "aggregation">
265 GroupBy "TypeInstance"
268 CalculateAverage true
272 There are a couple of limitations you should be aware of:
278 The I<Type> cannot be left unspecified, because it is not reasonable to add
279 apples to oranges. Also, the internal lookup structure won't work if you try
284 There must be at least one unspecified, ungrouped field. Otherwise nothing
289 As you can see in the example above, each aggregation has its own
290 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
291 blocks may match the same values, i.e. one value list can update multiple
292 aggregations. The following options are valid inside B<Aggregation> blocks:
296 =item B<Host> I<Host>
298 =item B<Plugin> I<Plugin>
300 =item B<PluginInstance> I<PluginInstance>
302 =item B<Type> I<Type>
304 =item B<TypeInstance> I<TypeInstance>
306 Selects the value lists to be added to this aggregation. B<Type> must be a
307 valid data set name, see L<types.db(5)> for details.
309 If the string starts with and ends with a slash (C</>), the string is
310 interpreted as a I<regular expression>. The regex flavor used are POSIX
311 extended regular expressions as described in L<regex(7)>. Example usage:
313 Host "/^db[0-9]\\.example\\.com$/"
315 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
317 Group valued by the specified field. The B<GroupBy> option may be repeated to
318 group by multiple fields.
320 =item B<CalculateNum> B<true>|B<false>
322 =item B<CalculateSum> B<true>|B<false>
324 =item B<CalculateAverage> B<true>|B<false>
326 =item B<CalculateMinimum> B<true>|B<false>
328 =item B<CalculateMaximum> B<true>|B<false>
330 =item B<CalculateStddev> B<true>|B<false>
332 Boolean options for enabling calculation of the number of value lists, their
333 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
334 are disabled by default.
338 =head2 Plugin C<amqp>
340 The I<AMQMP plugin> can be used to communicate with other instances of
341 I<collectd> or third party applications using an AMQP message broker. Values
342 are sent to or received from the broker, which handles routing, queueing and
343 possibly filtering or messages.
346 # Send values to an AMQP broker
347 <Publish "some_name">
353 Exchange "amq.fanout"
354 # ExchangeType "fanout"
355 # RoutingKey "collectd"
359 # GraphitePrefix "collectd."
360 # GraphiteEscapeChar "_"
363 # Receive values from an AMQP broker
364 <Subscribe "some_name">
370 Exchange "amq.fanout"
371 # ExchangeType "fanout"
373 # RoutingKey "collectd.#"
377 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
378 blocks, which configure sending and receiving of values respectively. The two
379 blocks are very similar, so unless otherwise noted, an option can be used in
380 either block. The name given in the blocks starting tag is only used for
381 reporting messages, but may be used to support I<flushing> of certain
382 I<Publish> blocks in the future.
386 =item B<Host> I<Host>
388 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
389 the underlying communications library, I<rabbitmq-c>, which is "localhost".
391 =item B<Port> I<Port>
393 Service name or port number on which the AMQP broker accepts connections. This
394 argument must be a string, even if the numeric form is used. Defaults to
397 =item B<VHost> I<VHost>
399 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
401 =item B<User> I<User>
403 =item B<Password> I<Password>
405 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
408 =item B<Exchange> I<Exchange>
410 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
411 By default, "amq.fanout" will be used.
413 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
414 the given exchange and the I<queue> is created, using the I<routing key> if
415 configured. See the B<Queue> and B<RoutingKey> options below.
417 =item B<ExchangeType> I<Type>
419 If given, the plugin will try to create the configured I<exchange> with this
420 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
421 be bound to this exchange.
423 =item B<Queue> I<Queue> (Subscribe only)
425 Configures the I<queue> name to subscribe to. If no queue name was configures
426 explicitly, a unique queue name will be created by the broker.
428 =item B<RoutingKey> I<Key>
430 In I<Publish> blocks, this configures the routing key to set on all outgoing
431 messages. If not given, the routing key will be computed from the I<identifier>
432 of the value. The host, plugin, type and the two instances are concatenated
433 together using dots as the separator and all containing dots replaced with
434 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
435 possible to receive only specific values using a "topic" exchange.
437 In I<Subscribe> blocks, configures the I<routing key> used when creating a
438 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
439 used to filter messages when using a "topic" exchange. If you're only
440 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
443 =item B<Persistent> B<true>|B<false> (Publish only)
445 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
446 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
447 default), the I<transient> delivery mode will be used, i.e. messages may be
448 lost due to high load, overflowing queues or similar issues.
450 =item B<Format> B<Command>|B<JSON> (Publish only)
452 Selects the format in which messages are sent to the broker. If set to
453 B<Command> (the default), values are sent as C<PUTVAL> commands which are
454 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
455 case, the C<Content-Type> header field will be set to C<text/collectd>.
457 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
458 an easy and straight forward exchange format. The C<Content-Type> header field
459 will be set to C<application/json>.
461 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
462 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
465 A subscribing client I<should> use the C<Content-Type> header field to
466 determine how to decode the values. Currently, the I<AMQP plugin> itself can
467 only decode the B<Command> format.
469 =item B<StoreRates> B<true>|B<false> (Publish only)
471 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
472 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
473 default), no conversion is performed. Otherwise the conversion is performed
474 using the internal value cache.
476 Please note that currently this option is only used if the B<Format> option has
479 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
481 A prefix can be added in the metric name when outputting in the I<Graphite> format.
482 It's added before the I<Host> name.
483 Metric name will be "<prefix><host><postfix><plugin><type><name>"
485 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
487 A postfix can be added in the metric name when outputting in the I<Graphite> format.
488 It's added after the I<Host> name.
489 Metric name will be "<prefix><host><postfix><plugin><type><name>"
491 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
493 Specify a character to replace dots (.) in the host part of the metric name.
494 In I<Graphite> metric name, dots are used as separators between different
495 metric parts (host, plugin, type).
496 Default is "_" (I<Underscore>).
500 =head2 Plugin C<apache>
502 To configure the C<apache>-plugin you first need to configure the Apache
503 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
504 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
505 the following snipped to base your Apache config upon:
508 <IfModule mod_status.c>
509 <Location /mod_status>
510 SetHandler server-status
514 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
515 also supported. It introduces a new field, called C<BusyServers>, to count the
516 number of currently connected clients. This field is also supported.
518 The configuration of the I<Apache> plugin consists of one or more
519 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
520 as the instance name. For example:
524 URL "http://www1.example.com/mod_status?auto"
527 URL "http://www2.example.com/mod_status?auto"
531 The instance name will be used as the I<plugin instance>. To emulate the old
532 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
533 plugin to work correctly, each instance name must be unique. This is not
534 enforced by the plugin and it is your responsibility to ensure it.
536 The following options are accepted within each I<Instance> block:
540 =item B<URL> I<http://host/mod_status?auto>
542 Sets the URL of the C<mod_status> output. This needs to be the output generated
543 by C<ExtendedStatus on> and it needs to be the machine readable output
544 generated by appending the C<?auto> argument. This option is I<mandatory>.
546 =item B<User> I<Username>
548 Optional user name needed for authentication.
550 =item B<Password> I<Password>
552 Optional password needed for authentication.
554 =item B<VerifyPeer> B<true|false>
556 Enable or disable peer SSL certificate verification. See
557 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
559 =item B<VerifyHost> B<true|false>
561 Enable or disable peer host name verification. If enabled, the plugin checks
562 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
563 certificate matches the host name provided by the B<URL> option. If this
564 identity check fails, the connection is aborted. Obviously, only works when
565 connecting to a SSL enabled server. Enabled by default.
567 =item B<CACert> I<File>
569 File that holds one or more SSL certificates. If you want to use HTTPS you will
570 possibly need this option. What CA certificates come bundled with C<libcurl>
571 and are checked by default depends on the distribution you use.
575 =head2 Plugin C<apcups>
579 =item B<Host> I<Hostname>
581 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
582 that IPv6 support has been disabled unless someone can confirm or decline that
583 B<apcupsd> can handle it.
585 =item B<Port> I<Port>
587 TCP-Port to connect to. Defaults to B<3551>.
591 =head2 Plugin C<ascent>
593 This plugin collects information about an Ascent server, a free server for the
594 "World of Warcraft" game. This plugin gathers the information by fetching the
595 XML status page using C<libcurl> and parses it using C<libxml2>.
597 The configuration options are the same as for the C<apache> plugin above:
601 =item B<URL> I<http://localhost/ascent/status/>
603 Sets the URL of the XML status output.
605 =item B<User> I<Username>
607 Optional user name needed for authentication.
609 =item B<Password> I<Password>
611 Optional password needed for authentication.
613 =item B<VerifyPeer> B<true|false>
615 Enable or disable peer SSL certificate verification. See
616 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
618 =item B<VerifyHost> B<true|false>
620 Enable or disable peer host name verification. If enabled, the plugin checks
621 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
622 certificate matches the host name provided by the B<URL> option. If this
623 identity check fails, the connection is aborted. Obviously, only works when
624 connecting to a SSL enabled server. Enabled by default.
626 =item B<CACert> I<File>
628 File that holds one or more SSL certificates. If you want to use HTTPS you will
629 possibly need this option. What CA certificates come bundled with C<libcurl>
630 and are checked by default depends on the distribution you use.
634 =head2 Plugin C<bind>
636 Starting with BIND 9.5.0, the most widely used DNS server software provides
637 extensive statistics about queries, responses and lots of other information.
638 The bind plugin retrieves this information that's encoded in XML and provided
639 via HTTP and submits the values to collectd.
641 To use this plugin, you first need to tell BIND to make this information
642 available. This is done with the C<statistics-channels> configuration option:
644 statistics-channels {
645 inet localhost port 8053;
648 The configuration follows the grouping that can be seen when looking at the
649 data with an XSLT compatible viewer, such as a modern web browser. It's
650 probably a good idea to make yourself familiar with the provided values, so you
651 can understand what the collected statistics actually mean.
656 URL "http://localhost:8053/"
671 Zone "127.in-addr.arpa/IN"
675 The bind plugin accepts the following configuration options:
681 URL from which to retrieve the XML data. If not specified,
682 C<http://localhost:8053/> will be used.
684 =item B<ParseTime> B<true>|B<false>
686 When set to B<true>, the time provided by BIND will be parsed and used to
687 dispatch the values. When set to B<false>, the local time source is queried.
689 This setting is set to B<true> by default for backwards compatibility; setting
690 this to B<false> is I<recommended> to avoid problems with timezones and
693 =item B<OpCodes> B<true>|B<false>
695 When enabled, statistics about the I<"OpCodes">, for example the number of
696 C<QUERY> packets, are collected.
700 =item B<QTypes> B<true>|B<false>
702 When enabled, the number of I<incoming> queries by query types (for example
703 C<A>, C<MX>, C<AAAA>) is collected.
707 =item B<ServerStats> B<true>|B<false>
709 Collect global server statistics, such as requests received over IPv4 and IPv6,
710 successful queries, and failed updates.
714 =item B<ZoneMaintStats> B<true>|B<false>
716 Collect zone maintenance statistics, mostly information about notifications
717 (zone updates) and zone transfers.
721 =item B<ResolverStats> B<true>|B<false>
723 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
724 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
725 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
726 default. Use the B<ResolverStats> option within a B<View "_default"> block
727 instead for the same functionality.
733 Collect global memory statistics.
737 =item B<View> I<Name>
739 Collect statistics about a specific I<"view">. BIND can behave different,
740 mostly depending on the source IP-address of the request. These different
741 configurations are called "views". If you don't use this feature, you most
742 likely are only interested in the C<_default> view.
744 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
745 information you want to collect about a view. If no B<View> block is
746 configured, no detailed view statistics will be collected.
750 =item B<QTypes> B<true>|B<false>
752 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
757 =item B<ResolverStats> B<true>|B<false>
759 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
760 (e.E<nbsp>g. queries over IPv4, lame servers).
764 =item B<CacheRRSets> B<true>|B<false>
766 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
767 type is collected. Negative entries (queries which resulted in an error, for
768 example names that do not exist) are reported with a leading exclamation mark,
773 =item B<Zone> I<Name>
775 When given, collect detailed information about the given zone in the view. The
776 information collected if very similar to the global B<ServerStats> information
779 You can repeat this option to collect detailed information about multiple
782 By default no detailed zone information is collected.
788 =head2 Plugin C<cpufreq>
790 This plugin doesn't have any options. It reads
791 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
792 installed) to get the current CPU frequency. If this file does not exist make
793 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
794 installed and an "cpu governor" (that's a kernel module) is loaded.
800 =item B<DataDir> I<Directory>
802 Set the directory to store CSV-files under. Per default CSV-files are generated
803 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
804 The special strings B<stdout> and B<stderr> can be used to write to the standard
805 output and standard error channels, respectively. This, of course, only makes
806 much sense when collectd is running in foreground- or non-daemon-mode.
808 =item B<StoreRates> B<true|false>
810 If set to B<true>, convert counter values to rates. If set to B<false> (the
811 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
816 =head2 Plugin C<curl>
818 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
819 and the match infrastructure (the same code used by the tail plugin) to use
820 regular expressions with the received data.
822 The following example will read the current value of AMD stock from Google's
823 finance page and dispatch the value to collectd.
826 <Page "stock_quotes">
827 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
831 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
832 DSType "GaugeAverage"
833 # Note: `stock_value' is not a standard type.
840 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
841 a web page and one or more "matches" to be performed on the returned data. The
842 string argument to the B<Page> block is used as plugin instance.
844 The following options are valid within B<Page> blocks:
850 URL of the web site to retrieve. Since a regular expression will be used to
851 extract information from this data, non-binary data is a big plus here ;)
853 =item B<User> I<Name>
855 Username to use if authorization is required to read the page.
857 =item B<Password> I<Password>
859 Password to use if authorization is required to read the page.
861 =item B<VerifyPeer> B<true>|B<false>
863 Enable or disable peer SSL certificate verification. See
864 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
866 =item B<VerifyHost> B<true>|B<false>
868 Enable or disable peer host name verification. If enabled, the plugin checks if
869 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
870 matches the host name provided by the B<URL> option. If this identity check
871 fails, the connection is aborted. Obviously, only works when connecting to a
872 SSL enabled server. Enabled by default.
874 =item B<CACert> I<file>
876 File that holds one or more SSL certificates. If you want to use HTTPS you will
877 possibly need this option. What CA certificates come bundled with C<libcurl>
878 and are checked by default depends on the distribution you use.
880 =item B<MeasureResponseTime> B<true>|B<false>
882 Measure response time for the request. If this setting is enabled, B<Match>
883 blocks (see below) are optional. Disabled by default.
885 =item B<E<lt>MatchE<gt>>
887 One or more B<Match> blocks that define how to match information in the data
888 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
889 used by the C<tail> plugin, so please see the documentation of the C<tail>
890 plugin below on how matches are defined. If the B<MeasureResponseTime> option
891 is set to B<true>, B<Match> blocks are optional.
895 =head2 Plugin C<curl_json>
897 The B<curl_json plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and
898 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) to retrieve JSON data
899 via cURL. This can be used to collect values from CouchDB documents (which are
900 stored JSON notation), for example.
902 The following example will collect several values from the built-in `_stats'
903 runtime statistics module of CouchDB
904 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
907 <URL "http://localhost:5984/_stats">
909 <Key "httpd/requests/count">
913 <Key "httpd_request_methods/*/count">
914 Type "http_request_methods"
917 <Key "httpd_status_codes/*/count">
918 Type "http_response_codes"
923 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining
924 a URL to be fetched via HTTP (using libcurl) and one or more B<Key> blocks.
925 The B<Key> string argument must be in a path format, which is used to collect a
926 value from a JSON map object. If a path element of B<Key> is the
927 I<*>E<nbsp>wildcard, the values for all keys will be collectd.
929 The following options are valid within B<URL> blocks:
933 =item B<Instance> I<Instance>
935 Sets the plugin instance to I<Instance>.
937 =item B<User> I<Name>
939 Username to use if authorization is required to read the page.
941 =item B<Password> I<Password>
943 Password to use if authorization is required to read the page.
945 =item B<VerifyPeer> B<true>|B<false>
947 Enable or disable peer SSL certificate verification. See
948 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
950 =item B<VerifyHost> B<true>|B<false>
952 Enable or disable peer host name verification. If enabled, the plugin checks if
953 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
954 matches the host name provided by the B<URL> option. If this identity check
955 fails, the connection is aborted. Obviously, only works when connecting to a
956 SSL enabled server. Enabled by default.
958 =item B<CACert> I<file>
960 File that holds one or more SSL certificates. If you want to use HTTPS you will
961 possibly need this option. What CA certificates come bundled with C<libcurl>
962 and are checked by default depends on the distribution you use.
966 The following options are valid within B<Key> blocks:
970 =item B<Type> I<Type>
972 Sets the type used to dispatch the values to the daemon. Detailed information
973 about types and their configuration can be found in L<types.db(5)>. This
976 =item B<Instance> I<Instance>
978 Type-instance to use. Defaults to the current map key or current string array element value.
982 =head2 Plugin C<curl_xml>
984 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
985 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
988 <URL "http://localhost/stats.xml">
990 Instance "some_instance"
995 CACert "/path/to/ca.crt"
997 <XPath "table[@id=\"magic_level\"]/tr">
999 #InstancePrefix "prefix-"
1000 InstanceFrom "td[1]"
1001 ValuesFrom "td[2]/span[@class=\"level\"]"
1006 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1007 URL to be fetched using libcurl. Within each B<URL> block there are
1008 options which specify the connection parameters, for example authentication
1009 information, and one or more B<XPath> blocks.
1011 Each B<XPath> block specifies how to get one type of information. The
1012 string argument must be a valid XPath expression which returns a list
1013 of "base elements". One value is dispatched for each "base element". The
1014 I<type instance> and values are looked up using further I<XPath> expressions
1015 that should be relative to the base element.
1017 Within the B<URL> block the following options are accepted:
1021 =item B<Host> I<Name>
1023 Use I<Name> as the host name when submitting values. Defaults to the global
1026 =item B<Instance> I<Instance>
1028 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1029 empty string (no plugin instance).
1031 =item B<User> I<User>
1032 =item B<Password> I<Password>
1033 =item B<VerifyPeer> B<true>|B<false>
1034 =item B<VerifyHost> B<true>|B<false>
1035 =item B<CACert> I<CA Cert File>
1037 These options behave exactly equivalent to the appropriate options of the
1038 I<cURL> and I<cURL-JSON> plugins. Please see there for a detailed description.
1040 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1042 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1043 B<XPath> block specifies how to get one type of information. The string
1044 argument must be a valid XPath expression which returns a list of "base
1045 elements". One value is dispatched for each "base element".
1047 Within the B<XPath> block the following options are accepted:
1051 =item B<Type> I<Type>
1053 Specifies the I<Type> used for submitting patches. This determines the number
1054 of values that are required / expected and whether the strings are parsed as
1055 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1056 This option is required.
1058 =item B<InstancePrefix> I<InstancePrefix>
1060 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1061 concatenated together without any separator.
1062 This option is optional.
1064 =item B<InstanceFrom> I<InstanceFrom>
1066 Specifies a XPath expression to use for determining the I<type instance>. The
1067 XPath expression must return exactly one element. The element's value is then
1068 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1070 This value is required. As a special exception, if the "base XPath expression"
1071 (the argument to the B<XPath> block) returns exactly one argument, then this
1072 option may be omitted.
1074 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1076 Specifies one or more XPath expression to use for reading the values. The
1077 number of XPath expressions must match the number of data sources in the
1078 I<type> specified with B<Type> (see above). Each XPath expression must return
1079 exactly one element. The element's value is then parsed as a number and used as
1080 value for the appropriate value in the value list dispatched to the daemon.
1086 =head2 Plugin C<dbi>
1088 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1089 connect to various databases, execute I<SQL> statements and read back the
1090 results. I<dbi> is an acronym for "database interface" in case you were
1091 wondering about the name. You can configure how each column is to be
1092 interpreted and the plugin will generate one or more data sets from each row
1093 returned according to these rules.
1095 Because the plugin is very generic, the configuration is a little more complex
1096 than those of other plugins. It usually looks something like this:
1099 <Query "out_of_stock">
1100 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1101 # Use with MySQL 5.0.0 or later
1105 InstancePrefix "out_of_stock"
1106 InstancesFrom "category"
1110 <Database "product_information">
1112 DriverOption "host" "localhost"
1113 DriverOption "username" "collectd"
1114 DriverOption "password" "aZo6daiw"
1115 DriverOption "dbname" "prod_info"
1116 SelectDB "prod_info"
1117 Query "out_of_stock"
1121 The configuration above defines one query with one result and one database. The
1122 query is then linked to the database with the B<Query> option I<within> the
1123 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1124 and you can also use the B<Include> statement to split up the configuration
1125 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1126 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1129 The following is a complete list of options:
1131 =head3 B<Query> blocks
1133 Query blocks define I<SQL> statements and how the returned data should be
1134 interpreted. They are identified by the name that is given in the opening line
1135 of the block. Thus the name needs to be unique. Other than that, the name is
1136 not used in collectd.
1138 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1139 define which column holds which value or instance information. You can use
1140 multiple B<Result> blocks to create multiple values from one returned row. This
1141 is especially useful, when queries take a long time and sending almost the same
1142 query again and again is not desirable.
1146 <Query "environment">
1147 Statement "select station, temperature, humidity from environment"
1150 # InstancePrefix "foo"
1151 InstancesFrom "station"
1152 ValuesFrom "temperature"
1156 InstancesFrom "station"
1157 ValuesFrom "humidity"
1161 The following options are accepted:
1165 =item B<Statement> I<SQL>
1167 Sets the statement that should be executed on the server. This is B<not>
1168 interpreted by collectd, but simply passed to the database server. Therefore,
1169 the SQL dialect that's used depends on the server collectd is connected to.
1171 The query has to return at least two columns, one for the instance and one
1172 value. You cannot omit the instance, even if the statement is guaranteed to
1173 always return exactly one line. In that case, you can usually specify something
1176 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1178 (That works with MySQL but may not be valid SQL according to the spec. If you
1179 use a more strict database server, you may have to select from a dummy table or
1182 Please note that some databases, for example B<Oracle>, will fail if you
1183 include a semicolon at the end of the statement.
1185 =item B<MinVersion> I<Version>
1187 =item B<MaxVersion> I<Value>
1189 Only use this query for the specified database version. You can use these
1190 options to provide multiple queries with the same name but with a slightly
1191 different syntax. The plugin will use only those queries, where the specified
1192 minimum and maximum versions fit the version of the database in use.
1194 The database version is determined by C<dbi_conn_get_engine_version>, see the
1195 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1196 for details. Basically, each part of the version is assumed to be in the range
1197 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1198 "40102", version "5.0.42" becomes "50042".
1200 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1201 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1202 happen. Don't to it! A valid example would be something along these lines:
1213 In the above example, there are three ranges that don't overlap. The last one
1214 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1215 before "4.0.0" are not specified.
1217 =item B<Type> I<Type>
1219 The B<type> that's used for each line returned. See L<types.db(5)> for more
1220 details on how types are defined. In short: A type is a predefined layout of
1221 data and the number of values and type of values has to match the type
1224 If you specify "temperature" here, you need exactly one gauge column. If you
1225 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1228 There must be exactly one B<Type> option inside each B<Result> block.
1230 =item B<InstancePrefix> I<prefix>
1232 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1233 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1234 all strings returned in the appropriate columns are concatenated together,
1235 separated by dashes I<("-")>.
1237 =item B<InstancesFrom> I<column0> [I<column1> ...]
1239 Specifies the columns whose values will be used to create the "type-instance"
1240 for each row. If you specify more than one column, the value of all columns
1241 will be joined together with dashes I<("-")> as separation characters.
1243 The plugin itself does not check whether or not all built instances are
1244 different. It's your responsibility to assure that each is unique. This is
1245 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1246 sure that only one row is returned in this case.
1248 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1251 =item B<ValuesFrom> I<column0> [I<column1> ...]
1253 Names the columns whose content is used as the actual data for the data sets
1254 that are dispatched to the daemon. How many such columns you need is determined
1255 by the B<Type> setting above. If you specify too many or not enough columns,
1256 the plugin will complain about that and no data will be submitted to the
1259 The actual data type in the columns is not that important. The plugin will
1260 automatically cast the values to the right type if it know how to do that. So
1261 it should be able to handle integer an floating point types, as well as strings
1262 (if they include a number at the beginning).
1264 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1268 =head3 B<Database> blocks
1270 Database blocks define a connection to a database and which queries should be
1271 sent to that database. Since the used "dbi" library can handle a wide variety
1272 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1273 documentationE<nbsp>- we stick as close to the terminology used there.
1275 Each database needs a "name" as string argument in the starting tag of the
1276 block. This name will be used as "PluginInstance" in the values submitted to
1277 the daemon. Other than that, that name is not used.
1281 =item B<Driver> I<Driver>
1283 Specifies the driver to use to connect to the database. In many cases those
1284 drivers are named after the database they can connect to, but this is not a
1285 technical necessity. These drivers are sometimes referred to as "DBD",
1286 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1287 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1288 project at L<http://libdbi-drivers.sourceforge.net/>.
1290 You need to give the driver name as expected by the "dbi" library here. You
1291 should be able to find that in the documentation for each driver. If you
1292 mistype the driver name, the plugin will dump a list of all known driver names
1295 =item B<DriverOption> I<Key> I<Value>
1297 Sets driver-specific options. What option a driver supports can be found in the
1298 documentation for each driver, somewhere at
1299 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1300 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1302 Unfortunately, drivers are not too keen to report errors when an unknown option
1303 is passed to them, so invalid settings here may go unnoticed. This is not the
1304 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1305 the driver. If a driver complains about an option, the plugin will dump a
1306 complete list of all options understood by that driver to the log.
1308 =item B<SelectDB> I<Database>
1310 In some cases, the database name you connect with is not the database name you
1311 want to use for querying data. If this option is set, the plugin will "select"
1312 (switch to) that database after the connection is established.
1314 =item B<Query> I<QueryName>
1316 Associates the query named I<QueryName> with this database connection. The
1317 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1318 blocks you want to refer to must be placed above the database block you want to
1327 =item B<Device> I<Device>
1329 Select partitions based on the devicename.
1331 =item B<MountPoint> I<Directory>
1333 Select partitions based on the mountpoint.
1335 =item B<FSType> I<FSType>
1337 Select partitions based on the filesystem type.
1339 =item B<IgnoreSelected> B<true>|B<false>
1341 Invert the selection: If set to true, all partitions B<except> the ones that
1342 match any one of the criteria are collected. By default only selected
1343 partitions are collected if a selection is made. If no selection is configured
1344 at all, B<all> partitions are selected.
1346 =item B<ReportByDevice> B<true>|B<false>
1348 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1349 (the default), it will report a disk as "root", but with it I<true>, it will be
1350 "sda1" (or whichever).
1352 =item B<ReportInodes> B<true>|B<false>
1354 Enables or disables reporting of free, reserved and used inodes. Defaults to
1355 inode collection being disabled.
1357 Enable this option if inodes are a scarce resource for you, usually because
1358 many small files are stored on the disk. This is a usual scenario for mail
1359 transfer agents and web caches.
1363 =head2 Plugin C<disk>
1365 The C<disk> plugin collects information about the usage of physical disks and
1366 logical disks (partitions). Values collected are the number of octets written
1367 to and read from a disk or partition, the number of read/write operations
1368 issued to the disk and a rather complex "time" it took for these commands to be
1371 Using the following two options you can ignore some disks or configure the
1372 collection only of specific disks.
1376 =item B<Disk> I<Name>
1378 Select the disk I<Name>. Whether it is collected or ignored depends on the
1379 B<IgnoreSelected> setting, see below. As with other plugins that use the
1380 daemon's ignorelist functionality, a string that starts and ends with a slash
1381 is interpreted as a regular expression. Examples:
1386 =item B<IgnoreSelected> B<true>|B<false>
1388 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1389 statements, are ignored or if all other disks are ignored. The behavior
1390 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1391 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1392 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1393 is set to B<true>, all disks are collected B<except> the ones matched.
1397 =head2 Plugin C<dns>
1401 =item B<Interface> I<Interface>
1403 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1404 option sets the interface that should be used. If this option is not set, or
1405 set to "any", the plugin will try to get packets from B<all> interfaces. This
1406 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1408 =item B<IgnoreSource> I<IP-address>
1410 Ignore packets that originate from this address.
1412 =item B<SelectNumericQueryTypes> B<true>|B<false>
1414 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1418 =head2 Plugin C<email>
1422 =item B<SocketFile> I<Path>
1424 Sets the socket-file which is to be created.
1426 =item B<SocketGroup> I<Group>
1428 If running as root change the group of the UNIX-socket after it has been
1429 created. Defaults to B<collectd>.
1431 =item B<SocketPerms> I<Permissions>
1433 Change the file permissions of the UNIX-socket after it has been created. The
1434 permissions must be given as a numeric, octal value as you would pass to
1435 L<chmod(1)>. Defaults to B<0770>.
1437 =item B<MaxConns> I<Number>
1439 Sets the maximum number of connections that can be handled in parallel. Since
1440 this many threads will be started immediately setting this to a very high
1441 value will waste valuable resources. Defaults to B<5> and will be forced to be
1442 at most B<16384> to prevent typos and dumb mistakes.
1446 =head2 Plugin C<ethstat>
1448 The I<ethstat plugin> collects information about network interface cards (NICs)
1449 by talking directly with the underlying kernel driver using L<ioctl(2)>.
1455 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
1456 Map "multicast" "if_multicast"
1463 =item B<Interface> I<Name>
1465 Collect statistical information about interface I<Name>.
1467 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
1469 By default, the plugin will submit values as type C<derive> and I<type
1470 instance> set to I<Name>, the name of the metric as reported by the driver. If
1471 an appropriate B<Map> option exists, the given I<Type> and, optionally,
1472 I<TypeInstance> will be used.
1474 =item B<MappedOnly> B<true>|B<false>
1476 When set to B<true>, only metrics that can be mapped to to a I<type> will be
1477 collected, all other metrics will be ignored. Defaults to B<false>.
1481 =head2 Plugin C<exec>
1483 Please make sure to read L<collectd-exec(5)> before using this plugin. It
1484 contains valuable information on when the executable is executed and the
1485 output that is expected from it.
1489 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1491 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1493 Execute the executable I<Executable> as user I<User>. If the user name is
1494 followed by a colon and a group name, the effective group is set to that group.
1495 The real group and saved-set group will be set to the default group of that
1496 user. If no group is given the effective group ID will be the same as the real
1499 Please note that in order to change the user and/or group the daemon needs
1500 superuser privileges. If the daemon is run as an unprivileged user you must
1501 specify the same user/group here. If the daemon is run with superuser
1502 privileges, you must supply a non-root user here.
1504 The executable may be followed by optional arguments that are passed to the
1505 program. Please note that due to the configuration parsing numbers and boolean
1506 values may be changed. If you want to be absolutely sure that something is
1507 passed as-is please enclose it in quotes.
1509 The B<Exec> and B<NotificationExec> statements change the semantics of the
1510 programs executed, i.E<nbsp>e. the data passed to them and the response
1511 expected from them. This is documented in great detail in L<collectd-exec(5)>.
1515 =head2 Plugin C<filecount>
1517 The C<filecount> plugin counts the number of files in a certain directory (and
1518 its subdirectories) and their combined size. The configuration is very straight
1521 <Plugin "filecount">
1522 <Directory "/var/qmail/queue/mess">
1523 Instance "qmail-message"
1525 <Directory "/var/qmail/queue/todo">
1526 Instance "qmail-todo"
1528 <Directory "/var/lib/php5">
1529 Instance "php5-sessions"
1534 The example above counts the number of files in QMail's queue directories and
1535 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
1536 QMail has not yet looked at, the "message" queue holds the messages that were
1537 classified into "local" and "remote".
1539 As you can see, the configuration consists of one or more C<Directory> blocks,
1540 each of which specifies a directory in which to count the files. Within those
1541 blocks, the following options are recognized:
1545 =item B<Instance> I<Instance>
1547 Sets the plugin instance to I<Instance>. That instance name must be unique, but
1548 it's your responsibility, the plugin doesn't check for that. If not given, the
1549 instance is set to the directory name with all slashes replaced by underscores
1550 and all leading underscores removed.
1552 =item B<Name> I<Pattern>
1554 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
1555 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
1556 against the pattern, not the entire path. In case this makes it easier for you:
1557 This option has been named after the B<-name> parameter to L<find(1)>.
1559 =item B<MTime> I<Age>
1561 Count only files of a specific age: If I<Age> is greater than zero, only files
1562 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
1563 a negative number, this is inversed. For example, if B<-60> is specified, only
1564 files that have been modified in the last minute will be counted.
1566 The number can also be followed by a "multiplier" to easily specify a larger
1567 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
1568 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
1569 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
1570 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
1571 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
1574 =item B<Size> I<Size>
1576 Count only files of a specific size. When I<Size> is a positive number, only
1577 files that are at least this big are counted. If I<Size> is a negative number,
1578 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
1579 I<Size> are counted.
1581 As with the B<MTime> option, a "multiplier" may be added. For a detailed
1582 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
1583 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
1584 note that there are 1000 bytes in a kilobyte, not 1024.
1586 =item B<Recursive> I<true>|I<false>
1588 Controls whether or not to recurse into subdirectories. Enabled by default.
1590 =item B<IncludeHidden> I<true>|I<false>
1592 Controls whether or not to include "hidden" files and directories in the count.
1593 "Hidden" files and directories are those, whose name begins with a dot.
1594 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
1598 =head2 Plugin C<GenericJMX>
1600 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
1601 L<collectd-java(5)>.
1603 =head2 Plugin C<gmond>
1605 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
1606 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
1607 are built-in, custom mappings may be added via B<Metric> blocks, see below.
1612 MCReceiveFrom "239.2.11.71" "8649"
1613 <Metric "swap_total">
1615 TypeInstance "total"
1618 <Metric "swap_free">
1625 The following metrics are built-in:
1631 load_one, load_five, load_fifteen
1635 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
1639 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
1651 Available configuration options:
1655 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
1657 Sets sets the multicast group and UDP port to which to subscribe.
1659 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
1661 =item E<lt>B<Metric> I<Name>E<gt>
1663 These blocks add a new metric conversion to the internal table. I<Name>, the
1664 string argument to the B<Metric> block, is the metric name as used by Ganglia.
1668 =item B<Type> I<Type>
1670 Type to map this metric to. Required.
1672 =item B<TypeInstance> I<Instance>
1674 Type-instance to use. Optional.
1676 =item B<DataSource> I<Name>
1678 Data source to map this metric to. If the configured type has exactly one data
1679 source, this is optional. Otherwise the option is required.
1685 =head2 Plugin C<hddtemp>
1687 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
1688 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
1689 default values, see below. C<hddtemp> has to be running to work correctly. If
1690 C<hddtemp> is not running timeouts may appear which may interfere with other
1693 The B<hddtemp> homepage can be found at
1694 L<http://www.guzu.net/linux/hddtemp.php>.
1698 =item B<Host> I<Hostname>
1700 Hostname to connect to. Defaults to B<127.0.0.1>.
1702 =item B<Port> I<Port>
1704 TCP-Port to connect to. Defaults to B<7634>.
1708 =head2 Plugin C<interface>
1712 =item B<Interface> I<Interface>
1714 Select this interface. By default these interfaces will then be collected. For
1715 a more detailed description see B<IgnoreSelected> below.
1717 =item B<IgnoreSelected> I<true>|I<false>
1719 If no configuration if given, the B<traffic>-plugin will collect data from
1720 all interfaces. This may not be practical, especially for loopback- and
1721 similar interfaces. Thus, you can use the B<Interface>-option to pick the
1722 interfaces you're interested in. Sometimes, however, it's easier/preferred
1723 to collect all interfaces I<except> a few ones. This option enables you to
1724 do that: By setting B<IgnoreSelected> to I<true> the effect of
1725 B<Interface> is inverted: All selected interfaces are ignored and all
1726 other interfaces are collected.
1730 =head2 Plugin C<ipmi>
1734 =item B<Sensor> I<Sensor>
1736 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
1738 =item B<IgnoreSelected> I<true>|I<false>
1740 If no configuration if given, the B<ipmi> plugin will collect data from all
1741 sensors found of type "temperature", "voltage", "current" and "fanspeed".
1742 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
1743 the effect of B<Sensor> is inverted: All selected sensors are ignored and
1744 all other sensors are collected.
1746 =item B<NotifySensorAdd> I<true>|I<false>
1748 If a sensor appears after initialization time of a minute a notification
1751 =item B<NotifySensorRemove> I<true>|I<false>
1753 If a sensor disappears a notification is sent.
1755 =item B<NotifySensorNotPresent> I<true>|I<false>
1757 If you have for example dual power supply and one of them is (un)plugged then
1758 a notification is sent.
1762 =head2 Plugin C<iptables>
1766 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
1768 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
1769 will collect the counters of all rules which have a comment-match. The comment
1770 is then used as type-instance.
1772 If I<Comment> or I<Number> is given, only the rule with the matching comment or
1773 the I<n>th rule will be collected. Again, the comment (or the number) will be
1774 used as the type-instance.
1776 If I<Name> is supplied, it will be used as the type-instance instead of the
1777 comment or the number.
1781 =head2 Plugin C<irq>
1787 Select this irq. By default these irqs will then be collected. For a more
1788 detailed description see B<IgnoreSelected> below.
1790 =item B<IgnoreSelected> I<true>|I<false>
1792 If no configuration if given, the B<irq>-plugin will collect data from all
1793 irqs. This may not be practical, especially if no interrupts happen. Thus, you
1794 can use the B<Irq>-option to pick the interrupt you're interested in.
1795 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
1796 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
1797 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
1798 and all other interrupts are collected.
1802 =head2 Plugin C<java>
1804 The I<Java> plugin makes it possible to write extensions for collectd in Java.
1805 This section only discusses the syntax and semantic of the configuration
1806 options. For more in-depth information on the I<Java> plugin, please read
1807 L<collectd-java(5)>.
1812 JVMArg "-verbose:jni"
1813 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
1814 LoadPlugin "org.collectd.java.Foobar"
1815 <Plugin "org.collectd.java.Foobar">
1816 # To be parsed by the plugin
1820 Available configuration options:
1824 =item B<JVMArg> I<Argument>
1826 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
1827 exactly the way the arguments to the I<java> binary on the command line work.
1828 Execute C<javaE<nbsp>--help> for details.
1830 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
1831 any other options! When another option is found, the JVM will be started and
1832 later options will have to be ignored!
1834 =item B<LoadPlugin> I<JavaClass>
1836 Instantiates a new I<JavaClass> object. The constructor of this object very
1837 likely then registers one or more callback methods with the server.
1839 See L<collectd-java(5)> for details.
1841 When the first such option is found, the virtual machine (JVM) is created. This
1842 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
1843 B<LoadPlugin> options!
1845 =item B<Plugin> I<Name>
1847 The entire block is passed to the Java plugin as an
1848 I<org.collectd.api.OConfigItem> object.
1850 For this to work, the plugin has to register a configuration callback first,
1851 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
1852 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
1853 depends on the (Java) plugin registering the callback and is completely
1854 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
1858 =head2 Plugin C<libvirt>
1860 This plugin allows CPU, disk and network load to be collected for virtualized
1861 guests on the machine. This means that these characteristics can be collected
1862 for guest systems without installing any software on them - collectd only runs
1863 on the hosting system. The statistics are collected through libvirt
1864 (L<http://libvirt.org/>).
1866 Only I<Connection> is required.
1870 =item B<Connection> I<uri>
1872 Connect to the hypervisor given by I<uri>. For example if using Xen use:
1874 Connection "xen:///"
1876 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
1878 =item B<RefreshInterval> I<seconds>
1880 Refresh the list of domains and devices every I<seconds>. The default is 60
1881 seconds. Setting this to be the same or smaller than the I<Interval> will cause
1882 the list of domains and devices to be refreshed on every iteration.
1884 Refreshing the devices in particular is quite a costly operation, so if your
1885 virtualization setup is static you might consider increasing this. If this
1886 option is set to 0, refreshing is disabled completely.
1888 =item B<Domain> I<name>
1890 =item B<BlockDevice> I<name:dev>
1892 =item B<InterfaceDevice> I<name:dev>
1894 =item B<IgnoreSelected> I<true>|I<false>
1896 Select which domains and devices are collected.
1898 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
1899 disk/network devices are collected.
1901 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
1902 domains and disk/network devices are ignored, while the rest are collected.
1904 The domain name and device names may use a regular expression, if the name is
1905 surrounded by I</.../> and collectd was compiled with support for regexps.
1907 The default is to collect statistics for all domains and all their devices.
1911 BlockDevice "/:hdb/"
1912 IgnoreSelected "true"
1914 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
1917 =item B<HostnameFormat> B<name|uuid|hostname|...>
1919 When the libvirt plugin logs data, it sets the hostname of the collected data
1920 according to this setting. The default is to use the guest name as provided by
1921 the hypervisor, which is equal to setting B<name>.
1923 B<uuid> means use the guest's UUID. This is useful if you want to track the
1924 same guest across migrations.
1926 B<hostname> means to use the global B<Hostname> setting, which is probably not
1927 useful on its own because all guests will appear to have the same name.
1929 You can also specify combinations of these fields. For example B<name uuid>
1930 means to concatenate the guest name and UUID (with a literal colon character
1931 between, thus I<"foo:1234-1234-1234-1234">).
1933 =item B<InterfaceFormat> B<name>|B<address>
1935 When the libvirt plugin logs interface data, it sets the name of the collected
1936 data according to this setting. The default is to use the path as provided by
1937 the hypervisor (the "dev" property of the target node), which is equal to
1940 B<address> means use the interface's mac address. This is useful since the
1941 interface path might change between reboots of a guest or across migrations.
1945 =head2 Plugin C<logfile>
1949 =item B<LogLevel> B<debug|info|notice|warning|err>
1951 Sets the log-level. If, for example, set to B<notice>, then all events with
1952 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
1954 Please note that B<debug> is only available if collectd has been compiled with
1957 =item B<File> I<File>
1959 Sets the file to write log messages to. The special strings B<stdout> and
1960 B<stderr> can be used to write to the standard output and standard error
1961 channels, respectively. This, of course, only makes much sense when I<collectd>
1962 is running in foreground- or non-daemon-mode.
1964 =item B<Timestamp> B<true>|B<false>
1966 Prefix all lines printed by the current time. Defaults to B<true>.
1968 =item B<PrintSeverity> B<true>|B<false>
1970 When enabled, all lines are prefixed by the severity of the log message, for
1971 example "warning". Defaults to B<false>.
1975 B<Note>: There is no need to notify the daemon after moving or removing the
1976 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
1977 for each line it writes.
1979 =head2 Plugin C<lpar>
1981 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
1982 virtualization technique for IBM POWER processors. It takes into account CPU
1983 time stolen from or donated to a partition, in addition to the usual user,
1984 system, I/O statistics.
1986 The following configuration options are available:
1990 =item B<CpuPoolStats> B<false>|B<true>
1992 When enabled, statistics about the processor pool are read, too. The partition
1993 needs to have pool authority in order to be able to acquire this information.
1996 =item B<ReportBySerial> B<false>|B<true>
1998 If enabled, the serial of the physical machine the partition is currently
1999 running on is reported as I<hostname> and the logical hostname of the machine
2000 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2001 used (just like other plugins) and the I<plugin instance> will be empty.
2006 =head2 Plugin C<mbmon>
2008 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2010 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2011 B<Host> and B<Port> options can be used to change these values, see below.
2012 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2013 timeouts may appear which may interfere with other statistics..
2015 C<mbmon> must be run with the -r option ("print TAG and Value format");
2016 Debian's F</etc/init.d/mbmon> script already does this, other people
2017 will need to ensure that this is the case.
2021 =item B<Host> I<Hostname>
2023 Hostname to connect to. Defaults to B<127.0.0.1>.
2025 =item B<Port> I<Port>
2027 TCP-Port to connect to. Defaults to B<411>.
2033 The C<md plugin> collects information from Linux Software-RAID devices (md).
2035 All reported values are of the type C<md_disks>. Reported type instances are
2036 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2037 I<missing> (physically absent) disks.
2041 =item B<Device> I<Device>
2043 Select md devices based on device name. The I<device name> is the basename of
2044 the device, i.e. the name of the block device without the leading C</dev/>.
2045 See B<IgnoreSelected> for more details.
2047 =item B<IgnoreSelected> B<true>|B<false>
2049 Invert device selection: If set to B<true>, all md devices B<except> those
2050 listed using B<Device> are collected. If B<false> (the default), only those
2051 listed are collected. If no configuration is given, the B<md> plugin will
2052 collect data from all md devices.
2056 =head2 Plugin C<memcachec>
2058 The C<memcachec plugin> connects to a memcached server, queries one or more
2059 given I<pages> and parses the returned data according to user specification.
2060 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2063 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2064 library. Please note that there is another library with a very similar name,
2065 libmemcache (notice the missing `d'), which is not applicable.
2067 Synopsis of the configuration:
2069 <Plugin "memcachec">
2070 <Page "plugin_instance">
2074 Regex "(\\d+) bytes sent"
2077 Instance "type_instance"
2082 The configuration options are:
2086 =item E<lt>B<Page> I<Name>E<gt>
2088 Each B<Page> block defines one I<page> to be queried from the memcached server.
2089 The block requires one string argument which is used as I<plugin instance>.
2091 =item B<Server> I<Address>
2093 Sets the server address to connect to when querying the page. Must be inside a
2098 When connected to the memcached server, asks for the page I<Key>.
2100 =item E<lt>B<Match>E<gt>
2102 Match blocks define which strings to look for and how matches substrings are
2103 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2107 =head2 Plugin C<memcached>
2109 The C<memcached plugin> connects to a memcached server and queries statistics
2110 about cache utilization, memory and bandwidth used.
2111 L<http://www.danga.com/memcached/>
2113 <Plugin "memcached">
2115 Host "memcache.example.com"
2120 The plugin configuration consists of one or more B<Instance> blocks which
2121 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2122 following options are allowed:
2126 =item B<Host> I<Hostname>
2128 Hostname to connect to. Defaults to B<127.0.0.1>.
2130 =item B<Port> I<Port>
2132 TCP-Port to connect to. Defaults to B<11211>.
2134 =item B<Socket> I<Path>
2136 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2137 setting is given, the B<Host> and B<Port> settings are ignored.
2141 =head2 Plugin C<modbus>
2143 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
2144 register values. It supports reading single registers (unsigned 16E<nbsp>bit
2145 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2146 values (two registers interpreted as IEEE floats in big endian notation).
2150 <Data "voltage-input-1">
2157 <Data "voltage-input-2">
2164 <Host "modbus.example.com">
2165 Address "192.168.0.42"
2170 Instance "power-supply"
2171 Collect "voltage-input-1"
2172 Collect "voltage-input-2"
2178 =item E<lt>B<Data> I<Name>E<gt> blocks
2180 Data blocks define a mapping between register numbers and the "types" used by
2183 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
2187 =item B<RegisterBase> I<Number>
2189 Configures the base register to read from the device. If the option
2190 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
2191 register will be read (the register number is increased by one).
2193 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
2195 Specifies what kind of data is returned by the device. If the type is B<Int32>,
2196 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
2197 combined into one value. Defaults to B<Uint16>.
2199 =item B<Type> I<Type>
2201 Specifies the "type" (data set) to use when dispatching the value to
2202 I<collectd>. Currently, only data sets with exactly one data source are
2205 =item B<Instance> I<Instance>
2207 Sets the type instance to use when dispatching the value to I<collectd>. If
2208 unset, an empty string (no type instance) is used.
2212 =item E<lt>B<Host> I<Name>E<gt> blocks
2214 Host blocks are used to specify to which hosts to connect and what data to read
2215 from their "slaves". The string argument I<Name> is used as hostname when
2216 dispatching the values to I<collectd>.
2218 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
2222 =item B<Address> I<Hostname>
2224 Specifies the node name (the actual network address) used to connect to the
2225 host. This may be an IP address or a hostname. Please note that the used
2226 I<libmodbus> library only supports IPv4 at the moment.
2228 =item B<Port> I<Service>
2230 Specifies the port used to connect to the host. The port can either be given as
2231 a number or as a service name. Please note that the I<Service> argument must be
2232 a string, even if ports are given in their numerical form. Defaults to "502".
2234 =item B<Interval> I<Interval>
2236 Sets the interval (in seconds) in which the values will be collected from this
2237 host. By default the global B<Interval> setting will be used.
2239 =item E<lt>B<Slave> I<ID>E<gt>
2241 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
2242 is used to specify which device should be addressed. For each device you want
2243 to query, one B<Slave> block must be given.
2245 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
2249 =item B<Instance> I<Instance>
2251 Specify the plugin instance to use when dispatching the values to I<collectd>.
2252 By default "slave_I<ID>" is used.
2254 =item B<Collect> I<DataName>
2256 Specifies which data to retrieve from the device. I<DataName> must be the same
2257 string as the I<Name> argument passed to a B<Data> block. You can specify this
2258 option multiple times to collect more than one value from a slave. At least one
2259 B<Collect> option is mandatory.
2267 =head2 Plugin C<mysql>
2269 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
2270 one or more databases when started and keeps the connection up as long as
2271 possible. When the connection is interrupted for whatever reason it will try
2272 to re-connect. The plugin will complain loudly in case anything goes wrong.
2274 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
2275 and collects information about MySQL network traffic, executed statements,
2276 requests, the query cache and threads by evaluating the
2277 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
2278 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
2279 Status Variables> for an explanation of these values.
2281 Optionally, master and slave statistics may be collected in a MySQL
2282 replication setup. In that case, information about the synchronization state
2283 of the nodes are collected by evaluating the C<Position> return value of the
2284 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
2285 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
2286 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
2287 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
2288 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
2303 Socket "/var/run/mysql/mysqld.sock"
2305 SlaveNotifications true
2309 A B<Database> block defines one connection to a MySQL database. It accepts a
2310 single argument which specifies the name of the database. None of the other
2311 options are required. MySQL will use default values as documented in the
2312 section "mysql_real_connect()" in the B<MySQL reference manual>.
2316 =item B<Host> I<Hostname>
2318 Hostname of the database server. Defaults to B<localhost>.
2320 =item B<User> I<Username>
2322 Username to use when connecting to the database. The user does not have to be
2323 granted any privileges (which is synonym to granting the C<USAGE> privilege),
2324 unless you want to collectd replication statistics (see B<MasterStats> and
2325 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
2326 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
2328 =item B<Password> I<Password>
2330 Password needed to log into the database.
2332 =item B<Database> I<Database>
2334 Select this database. Defaults to I<no database> which is a perfectly reasonable
2335 option for what this plugin does.
2337 =item B<Port> I<Port>
2339 TCP-port to connect to. The port must be specified in its numeric form, but it
2340 must be passed as a string nonetheless. For example:
2344 If B<Host> is set to B<localhost> (the default), this setting has no effect.
2345 See the documentation for the C<mysql_real_connect> function for details.
2347 =item B<Socket> I<Socket>
2349 Specifies the path to the UNIX domain socket of the MySQL server. This option
2350 only has any effect, if B<Host> is set to B<localhost> (the default).
2351 Otherwise, use the B<Port> option above. See the documentation for the
2352 C<mysql_real_connect> function for details.
2354 =item B<MasterStats> I<true|false>
2356 =item B<SlaveStats> I<true|false>
2358 Enable the collection of master / slave statistics in a replication setup. In
2359 order to be able to get access to these statistics, the user needs special
2360 privileges. See the B<User> documentation above.
2362 =item B<SlaveNotifications> I<true|false>
2364 If enabled, the plugin sends a notification if the replication slave I/O and /
2365 or SQL threads are not running.
2369 =head2 Plugin C<netapp>
2371 The netapp plugin can collect various performance and capacity information
2372 from a NetApp filer using the NetApp API.
2374 Please note that NetApp has a wide line of products and a lot of different
2375 software versions for each of these products. This plugin was developed for a
2376 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
2377 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
2378 model and software version but it is very hard to test this.
2379 If you have used this plugin with other models and/or software version, feel
2380 free to send us a mail to tell us about the results, even if it's just a short
2383 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
2384 basic authentication.
2386 B<Do not use a regular user for this!> Create a special collectd user with just
2387 the minimum of capabilities needed. The user only needs the "login-http-admin"
2388 capability as well as a few more depending on which data will be collected.
2389 Required capabilities are documented below.
2394 <Host "netapp1.example.com">
2418 IgnoreSelectedIO false
2420 IgnoreSelectedOps false
2421 GetLatency "volume0"
2422 IgnoreSelectedLatency false
2429 IgnoreSelectedCapacity false
2432 IgnoreSelectedSnapshot false
2445 The netapp plugin accepts the following configuration options:
2449 =item B<Host> I<Name>
2451 A host block defines one NetApp filer. It will appear in collectd with the name
2452 you specify here which does not have to be its real name nor its hostname.
2454 =item B<Protocol> B<httpd>|B<http>
2456 The protocol collectd will use to query this host.
2464 Valid options: http, https
2466 =item B<Address> I<Address>
2468 The hostname or IP address of the host.
2474 Default: The "host" block's name.
2476 =item B<Port> I<Port>
2478 The TCP port to connect to on the host.
2484 Default: 80 for protocol "http", 443 for protocol "https"
2486 =item B<User> I<User>
2488 =item B<Password> I<Password>
2490 The username and password to use to login to the NetApp.
2496 =item B<Interval> I<Interval>
2502 The following options decide what kind of data will be collected. You can
2503 either use them as a block and fine tune various parameters inside this block,
2504 use them as a single statement to just accept all default values, or omit it to
2505 not collect any data.
2507 The following options are valid inside all blocks:
2511 =item B<Interval> I<Seconds>
2513 Collect the respective statistics every I<Seconds> seconds. Defaults to the
2514 host specific setting.
2518 =head3 The System block
2520 This will collect various performance data about the whole system.
2522 B<Note:> To get this data the collectd user needs the
2523 "api-perf-object-get-instances" capability.
2527 =item B<Interval> I<Seconds>
2529 Collect disk statistics every I<Seconds> seconds.
2531 =item B<GetCPULoad> B<true>|B<false>
2533 If you set this option to true the current CPU usage will be read. This will be
2534 the average usage between all CPUs in your NetApp without any information about
2537 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2538 returns in the "CPU" field.
2546 Result: Two value lists of type "cpu", and type instances "idle" and "system".
2548 =item B<GetInterfaces> B<true>|B<false>
2550 If you set this option to true the current traffic of the network interfaces
2551 will be read. This will be the total traffic over all interfaces of your NetApp
2552 without any information about individual interfaces.
2554 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2555 in the "Net kB/s" field.
2565 Result: One value list of type "if_octects".
2567 =item B<GetDiskIO> B<true>|B<false>
2569 If you set this option to true the current IO throughput will be read. This
2570 will be the total IO of your NetApp without any information about individual
2571 disks, volumes or aggregates.
2573 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2574 in the "DiskE<nbsp>kB/s" field.
2582 Result: One value list of type "disk_octets".
2584 =item B<GetDiskOps> B<true>|B<false>
2586 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
2587 iSCSI, etc. operations will be read. This will be the total number of
2588 operations on your NetApp without any information about individual volumes or
2591 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2592 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
2600 Result: A variable number of value lists of type "disk_ops_complex". Each type
2601 of operation will result in one value list with the name of the operation as
2606 =head3 The WAFL block
2608 This will collect various performance data about the WAFL file system. At the
2609 moment this just means cache performance.
2611 B<Note:> To get this data the collectd user needs the
2612 "api-perf-object-get-instances" capability.
2614 B<Note:> The interface to get these values is classified as "Diagnostics" by
2615 NetApp. This means that it is not guaranteed to be stable even between minor
2620 =item B<Interval> I<Seconds>
2622 Collect disk statistics every I<Seconds> seconds.
2624 =item B<GetNameCache> B<true>|B<false>
2632 Result: One value list of type "cache_ratio" and type instance
2635 =item B<GetDirCache> B<true>|B<false>
2643 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
2645 =item B<GetInodeCache> B<true>|B<false>
2653 Result: One value list of type "cache_ratio" and type instance
2656 =item B<GetBufferCache> B<true>|B<false>
2658 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
2659 in the "Cache hit" field.
2667 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
2671 =head3 The Disks block
2673 This will collect performance data about the individual disks in the NetApp.
2675 B<Note:> To get this data the collectd user needs the
2676 "api-perf-object-get-instances" capability.
2680 =item B<Interval> I<Seconds>
2682 Collect disk statistics every I<Seconds> seconds.
2684 =item B<GetBusy> B<true>|B<false>
2686 If you set this option to true the busy time of all disks will be calculated
2687 and the value of the busiest disk in the system will be written.
2689 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2690 in the "Disk util" field. Probably.
2698 Result: One value list of type "percent" and type instance "disk_busy".
2702 =head3 The VolumePerf block
2704 This will collect various performance data about the individual volumes.
2706 You can select which data to collect about which volume using the following
2707 options. They follow the standard ignorelist semantic.
2709 B<Note:> To get this data the collectd user needs the
2710 I<api-perf-object-get-instances> capability.
2714 =item B<Interval> I<Seconds>
2716 Collect volume performance data every I<Seconds> seconds.
2718 =item B<GetIO> I<Volume>
2720 =item B<GetOps> I<Volume>
2722 =item B<GetLatency> I<Volume>
2724 Select the given volume for IO, operations or latency statistics collection.
2725 The argument is the name of the volume without the C</vol/> prefix.
2727 Since the standard ignorelist functionality is used here, you can use a string
2728 starting and ending with a slash to specify regular expression matching: To
2729 match the volumes "vol0", "vol2" and "vol7", you can use this regular
2732 GetIO "/^vol[027]$/"
2734 If no regular expression is specified, an exact match is required. Both,
2735 regular and exact matching are case sensitive.
2737 If no volume was specified at all for either of the three options, that data
2738 will be collected for all available volumes.
2740 =item B<IgnoreSelectedIO> B<true>|B<false>
2742 =item B<IgnoreSelectedOps> B<true>|B<false>
2744 =item B<IgnoreSelectedLatency> B<true>|B<false>
2746 When set to B<true>, the volumes selected for IO, operations or latency
2747 statistics collection will be ignored and the data will be collected for all
2750 When set to B<false>, data will only be collected for the specified volumes and
2751 all other volumes will be ignored.
2753 If no volumes have been specified with the above B<Get*> options, all volumes
2754 will be collected regardless of the B<IgnoreSelected*> option.
2756 Defaults to B<false>
2760 =head3 The VolumeUsage block
2762 This will collect capacity data about the individual volumes.
2764 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
2769 =item B<Interval> I<Seconds>
2771 Collect volume usage statistics every I<Seconds> seconds.
2773 =item B<GetCapacity> I<VolumeName>
2775 The current capacity of the volume will be collected. This will result in two
2776 to four value lists, depending on the configuration of the volume. All data
2777 sources are of type "df_complex" with the name of the volume as
2780 There will be type_instances "used" and "free" for the number of used and
2781 available bytes on the volume. If the volume has some space reserved for
2782 snapshots, a type_instance "snap_reserved" will be available. If the volume
2783 has SIS enabled, a type_instance "sis_saved" will be available. This is the
2784 number of bytes saved by the SIS feature.
2786 B<Note:> The current NetApp API has a bug that results in this value being
2787 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
2788 number which works most of the time. If you see strange values here, bug
2789 NetApp support to fix this.
2791 Repeat this option to specify multiple volumes.
2793 =item B<IgnoreSelectedCapacity> B<true>|B<false>
2795 Specify whether to collect only the volumes selected by the B<GetCapacity>
2796 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
2797 B<false>. However, if no B<GetCapacity> option is specified at all, all
2798 capacities will be selected anyway.
2800 =item B<GetSnapshot> I<VolumeName>
2802 Select volumes from which to collect snapshot information.
2804 Usually, the space used for snapshots is included in the space reported as
2805 "used". If snapshot information is collected as well, the space used for
2806 snapshots is subtracted from the used space.
2808 To make things even more interesting, it is possible to reserve space to be
2809 used for snapshots. If the space required for snapshots is less than that
2810 reserved space, there is "reserved free" and "reserved used" space in addition
2811 to "free" and "used". If the space required for snapshots exceeds the reserved
2812 space, that part allocated in the normal space is subtracted from the "used"
2815 Repeat this option to specify multiple volumes.
2817 =item B<IgnoreSelectedSnapshot>
2819 Specify whether to collect only the volumes selected by the B<GetSnapshot>
2820 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
2821 B<false>. However, if no B<GetSnapshot> option is specified at all, all
2822 capacities will be selected anyway.
2826 =head2 Plugin C<netlink>
2828 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
2829 statistics of various interface and routing aspects.
2833 =item B<Interface> I<Interface>
2835 =item B<VerboseInterface> I<Interface>
2837 Instruct the plugin to collect interface statistics. This is basically the same
2838 as the statistics provided by the C<interface> plugin (see above) but
2839 potentially much more detailed.
2841 When configuring with B<Interface> only the basic statistics will be collected,
2842 namely octets, packets, and errors. These statistics are collected by
2843 the C<interface> plugin, too, so using both at the same time is no benefit.
2845 When configured with B<VerboseInterface> all counters B<except> the basic ones,
2846 so that no data needs to be collected twice if you use the C<interface> plugin.
2847 This includes dropped packets, received multicast packets, collisions and a
2848 whole zoo of differentiated RX and TX errors. You can try the following command
2849 to get an idea of what awaits you:
2853 If I<Interface> is B<All>, all interfaces will be selected.
2855 =item B<QDisc> I<Interface> [I<QDisc>]
2857 =item B<Class> I<Interface> [I<Class>]
2859 =item B<Filter> I<Interface> [I<Filter>]
2861 Collect the octets and packets that pass a certain qdisc, class or filter.
2863 QDiscs and classes are identified by their type and handle (or classid).
2864 Filters don't necessarily have a handle, therefore the parent's handle is used.
2865 The notation used in collectd differs from that used in tc(1) in that it
2866 doesn't skip the major or minor number if it's zero and doesn't print special
2867 ids by their name. So, for example, a qdisc may be identified by
2868 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
2869 thus not displayed by tc(1).
2871 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
2872 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
2873 associated with that interface will be collected.
2875 Since a filter itself doesn't necessarily have a handle, the parent's handle is
2876 used. This may lead to problems when more than one filter is attached to a
2877 qdisc or class. This isn't nice, but we don't know how this could be done any
2878 better. If you have a idea, please don't hesitate to tell us.
2880 As with the B<Interface> option you can specify B<All> as the interface,
2881 meaning all interfaces.
2883 Here are some examples to help you understand the above text more easily:
2886 VerboseInterface "All"
2887 QDisc "eth0" "pfifo_fast-1:0"
2889 Class "ppp0" "htb-1:10"
2890 Filter "ppp0" "u32-1:0"
2893 =item B<IgnoreSelected>
2895 The behavior is the same as with all other similar plugins: If nothing is
2896 selected at all, everything is collected. If some things are selected using the
2897 options described above, only these statistics are collected. If you set
2898 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
2899 specified statistics will not be collected.
2903 =head2 Plugin C<network>
2905 The Network plugin sends data to a remote instance of collectd, receives data
2906 from a remote instance, or both at the same time. Data which has been received
2907 from the network is usually not transmitted again, but this can be activated, see
2908 the B<Forward> option below.
2910 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
2911 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
2913 Both, B<Server> and B<Listen> can be used as single option or as block. When
2914 used as block, given options are valid for this socket only. The following
2915 example will export the metrics twice: Once to an "internal" server (without
2916 encryption and signing) and one to an external server (with cryptographic
2920 # Export to an internal server
2921 # (demonstrates usage without additional options)
2922 Server "collectd.internal.tld"
2924 # Export to an external server
2925 # (demonstrates usage with signature options)
2926 <Server "collectd.external.tld">
2927 SecurityLevel "sign"
2928 Username "myhostname"
2935 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
2937 The B<Server> statement/block sets the server to send datagrams to. The
2938 statement may occur multiple times to send each datagram to multiple
2941 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
2942 optional second argument specifies a port number or a service name. If not
2943 given, the default, B<25826>, is used.
2945 The following options are recognized within B<Server> blocks:
2949 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
2951 Set the security you require for network communication. When the security level
2952 has been set to B<Encrypt>, data sent over the network will be encrypted using
2953 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
2954 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
2955 authentication code. When set to B<None>, data is sent without any security.
2957 This feature is only available if the I<network> plugin was linked with
2960 =item B<Username> I<Username>
2962 Sets the username to transmit. This is used by the server to lookup the
2963 password. See B<AuthFile> below. All security levels except B<None> require
2966 This feature is only available if the I<network> plugin was linked with
2969 =item B<Password> I<Password>
2971 Sets a password (shared secret) for this socket. All security levels except
2972 B<None> require this setting.
2974 This feature is only available if the I<network> plugin was linked with
2977 =item B<Interface> I<Interface name>
2979 Set the outgoing interface for IP packets. This applies at least
2980 to IPv6 packets and if possible to IPv4. If this option is not applicable,
2981 undefined or a non-existent interface name is specified, the default
2982 behavior is to let the kernel choose the appropriate interface. Be warned
2983 that the manual selection of an interface for unicast traffic is only
2984 necessary in rare cases.
2988 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
2990 The B<Listen> statement sets the interfaces to bind to. When multiple
2991 statements are found the daemon will bind to multiple interfaces.
2993 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
2994 the argument is a multicast address the daemon will join that multicast group.
2995 The optional second argument specifies a port number or a service name. If not
2996 given, the default, B<25826>, is used.
2998 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
3002 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3004 Set the security you require for network communication. When the security level
3005 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
3006 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
3007 signed and encrypted data is accepted. When set to B<None>, all data will be
3008 accepted. If an B<AuthFile> option was given (see below), encrypted data is
3009 decrypted if possible.
3011 This feature is only available if the I<network> plugin was linked with
3014 =item B<AuthFile> I<Filename>
3016 Sets a file in which usernames are mapped to passwords. These passwords are
3017 used to verify signatures and to decrypt encrypted network packets. If
3018 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
3019 verified and encrypted packets are decrypted. Otherwise, signed data is
3020 accepted without checking the signature and encrypted data cannot be decrypted.
3021 For the other security levels this option is mandatory.
3023 The file format is very simple: Each line consists of a username followed by a
3024 colon and any number of spaces followed by the password. To demonstrate, an
3025 example file could look like this:
3030 Each time a packet is received, the modification time of the file is checked
3031 using L<stat(2)>. If the file has been changed, the contents is re-read. While
3032 the file is being read, it is locked using L<fcntl(2)>.
3034 =item B<Interface> I<Interface name>
3036 Set the incoming interface for IP packets explicitly. This applies at least
3037 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3038 undefined or a non-existent interface name is specified, the default
3039 behavior is, to let the kernel choose the appropriate interface. Thus incoming
3040 traffic gets only accepted, if it arrives on the given interface.
3044 =item B<TimeToLive> I<1-255>
3046 Set the time-to-live of sent packets. This applies to all, unicast and
3047 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
3048 That means that multicast packets will be sent with a TTL of C<1> (one) on most
3051 =item B<MaxPacketSize> I<1024-65535>
3053 Set the maximum size for datagrams received over the network. Packets larger
3054 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
3055 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
3058 On the server side, this limit should be set to the largest value used on
3059 I<any> client. Likewise, the value on the client must not be larger than the
3060 value on the server, or data will be lost.
3062 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
3063 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
3064 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
3067 =item B<Forward> I<true|false>
3069 If set to I<true>, write packets that were received via the network plugin to
3070 the sending sockets. This should only be activated when the B<Listen>- and
3071 B<Server>-statements differ. Otherwise packets may be send multiple times to
3072 the same multicast group. While this results in more network traffic than
3073 necessary it's not a huge problem since the plugin has a duplicate detection,
3074 so the values will not loop.
3076 =item B<ReportStats> B<true>|B<false>
3078 The network plugin cannot only receive and send statistics, it can also create
3079 statistics about itself. Collected data included the number of received and
3080 sent octets and packets, the length of the receive queue and the number of
3081 values handled. When set to B<true>, the I<Network plugin> will make these
3082 statistics available. Defaults to B<false>.
3086 =head2 Plugin C<nginx>
3088 This plugin collects the number of connections and requests handled by the
3089 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
3090 queries the page provided by the C<ngx_http_stub_status_module> module, which
3091 isn't compiled by default. Please refer to
3092 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
3093 how to compile and configure nginx and this module.
3095 The following options are accepted by the C<nginx plugin>:
3099 =item B<URL> I<http://host/nginx_status>
3101 Sets the URL of the C<ngx_http_stub_status_module> output.
3103 =item B<User> I<Username>
3105 Optional user name needed for authentication.
3107 =item B<Password> I<Password>
3109 Optional password needed for authentication.
3111 =item B<VerifyPeer> B<true|false>
3113 Enable or disable peer SSL certificate verification. See
3114 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
3116 =item B<VerifyHost> B<true|false>
3118 Enable or disable peer host name verification. If enabled, the plugin checks
3119 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
3120 certificate matches the host name provided by the B<URL> option. If this
3121 identity check fails, the connection is aborted. Obviously, only works when
3122 connecting to a SSL enabled server. Enabled by default.
3124 =item B<CACert> I<File>
3126 File that holds one or more SSL certificates. If you want to use HTTPS you will
3127 possibly need this option. What CA certificates come bundled with C<libcurl>
3128 and are checked by default depends on the distribution you use.
3132 =head2 Plugin C<notify_desktop>
3134 This plugin sends a desktop notification to a notification daemon, as defined
3135 in the Desktop Notification Specification. To actually display the
3136 notifications, B<notification-daemon> is required and B<collectd> has to be
3137 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
3138 environment variables have to be set correctly) and the D-Bus message bus.
3140 The Desktop Notification Specification can be found at
3141 L<http://www.galago-project.org/specs/notification/>.
3145 =item B<OkayTimeout> I<timeout>
3147 =item B<WarningTimeout> I<timeout>
3149 =item B<FailureTimeout> I<timeout>
3151 Set the I<timeout>, in milliseconds, after which to expire the notification
3152 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
3153 been specified, the displayed notification will not be closed at all - the
3154 user has to do so herself. These options default to 5000. If a negative number
3155 has been specified, the default is used as well.
3159 =head2 Plugin C<notify_email>
3161 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
3162 configured email address.
3164 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
3166 Available configuration options:
3170 =item B<From> I<Address>
3172 Email address from which the emails should appear to come from.
3174 Default: C<root@localhost>
3176 =item B<Recipient> I<Address>
3178 Configures the email address(es) to which the notifications should be mailed.
3179 May be repeated to send notifications to multiple addresses.
3181 At least one B<Recipient> must be present for the plugin to work correctly.
3183 =item B<SMTPServer> I<Hostname>
3185 Hostname of the SMTP server to connect to.
3187 Default: C<localhost>
3189 =item B<SMTPPort> I<Port>
3191 TCP port to connect to.
3195 =item B<SMTPUser> I<Username>
3197 Username for ASMTP authentication. Optional.
3199 =item B<SMTPPassword> I<Password>
3201 Password for ASMTP authentication. Optional.
3203 =item B<Subject> I<Subject>
3205 Subject-template to use when sending emails. There must be exactly two
3206 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
3207 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
3210 Default: C<Collectd notify: %s@%s>
3214 =head2 Plugin C<ntpd>
3218 =item B<Host> I<Hostname>
3220 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
3222 =item B<Port> I<Port>
3224 UDP-Port to connect to. Defaults to B<123>.
3226 =item B<ReverseLookups> B<true>|B<false>
3228 Sets whether or not to perform reverse lookups on peers. Since the name or
3229 IP-address may be used in a filename it is recommended to disable reverse
3230 lookups. The default is to do reverse lookups to preserve backwards
3231 compatibility, though.
3233 =item B<IncludeUnitID> B<true>|B<false>
3235 When a peer is a refclock, include the unit ID in the I<type instance>.
3236 Defaults to B<false> for backward compatibility.
3238 If two refclock peers use the same driver and this is B<false>, the plugin will
3239 try to write simultaneous measurements from both to the same type instance.
3240 This will result in error messages in the log and only one set of measurements
3245 =head2 Plugin C<nut>
3249 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
3251 Add a UPS to collect data from. The format is identical to the one accepted by
3256 =head2 Plugin C<olsrd>
3258 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
3259 the Optimized Link State Routing daemon and reads information about the current
3260 state of the meshed network.
3262 The following configuration options are understood:
3266 =item B<Host> I<Host>
3268 Connect to I<Host>. Defaults to B<"localhost">.
3270 =item B<Port> I<Port>
3272 Specifies the port to connect to. This must be a string, even if you give the
3273 port as a number rather than a service name. Defaults to B<"2006">.
3275 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
3277 Specifies what information to collect about links, i.E<nbsp>e. direct
3278 connections of the daemon queried. If set to B<No>, no information is
3279 collected. If set to B<Summary>, the number of links and the average of all
3280 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
3281 If set to B<Detail> LQ and NLQ are collected per link.
3283 Defaults to B<Detail>.
3285 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
3287 Specifies what information to collect about routes of the daemon queried. If
3288 set to B<No>, no information is collected. If set to B<Summary>, the number of
3289 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
3290 metric and ETX are collected per route.
3292 Defaults to B<Summary>.
3294 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
3296 Specifies what information to collect about the global topology. If set to
3297 B<No>, no information is collected. If set to B<Summary>, the number of links
3298 in the entire topology and the average I<link quality> (LQ) is calculated.
3299 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
3301 Defaults to B<Summary>.
3305 =head2 Plugin C<onewire>
3307 B<EXPERIMENTAL!> See notes below.
3309 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
3310 L<http://owfs.org/> to read sensors connected via the onewire bus.
3312 Currently only temperature sensors (sensors with the family code C<10>,
3313 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
3314 would like to have included, please send a sort request to the mailing list.
3316 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
3317 experimental, below.
3321 =item B<Device> I<Device>
3323 Sets the device to read the values from. This can either be a "real" hardware
3324 device, such as a serial port or an USB port, or the address of the
3325 L<owserver(1)> socket, usually B<localhost:4304>.
3327 Though the documentation claims to automatically recognize the given address
3328 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
3329 with that version, the following configuration worked for us:
3332 Device "-s localhost:4304"
3335 This directive is B<required> and does not have a default value.
3337 =item B<Sensor> I<Sensor>
3339 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
3340 below. Sensors are specified without the family byte at the beginning, to you'd
3341 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
3344 =item B<IgnoreSelected> I<true>|I<false>
3346 If no configuration if given, the B<onewire> plugin will collect data from all
3347 sensors found. This may not be practical, especially if sensors are added and
3348 removed regularly. Sometimes, however, it's easier/preferred to collect only
3349 specific sensors or all sensors I<except> a few specified ones. This option
3350 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
3351 B<Sensor> is inverted: All selected interfaces are ignored and all other
3352 interfaces are collected.
3354 =item B<Interval> I<Seconds>
3356 Sets the interval in which all sensors should be read. If not specified, the
3357 global B<Interval> setting is used.
3361 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
3362 work with big setups. It works with one sensor being attached to one
3363 controller, but as soon as you throw in a couple more senors and maybe a hub
3364 or two, reading all values will take more than ten seconds (the default
3365 interval). We will probably add some separate thread for reading the sensors
3366 and some cache or something like that, but it's not done yet. We will try to
3367 maintain backwards compatibility in the future, but we can't promise. So in
3368 short: If it works for you: Great! But keep in mind that the config I<might>
3369 change, though this is unlikely. Oh, and if you want to help improving this
3370 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
3372 =head2 Plugin C<openvpn>
3374 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
3375 traffic statistics about connected clients.
3377 To set up OpenVPN to write to the status file periodically, use the
3378 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
3379 you need to set the required format, too. This is done by setting
3380 B<--status-version> to B<2>.
3382 So, in a nutshell you need:
3384 openvpn $OTHER_OPTIONS \
3385 --status "/var/run/openvpn-status" 10 \
3392 =item B<StatusFile> I<File>
3394 Specifies the location of the status file.
3396 =item B<ImprovedNamingSchema> B<true>|B<false>
3398 When enabled, the filename of the status file will be used as plugin instance
3399 and the client's "common name" will be used as type instance. This is required
3400 when reading multiple status files. Enabling this option is recommended, but to
3401 maintain backwards compatibility this option is disabled by default.
3403 =item B<CollectCompression> B<true>|B<false>
3405 Sets whether or not statistics about the compression used by OpenVPN should be
3406 collected. This information is only available in I<single> mode. Enabled by
3409 =item B<CollectIndividualUsers> B<true>|B<false>
3411 Sets whether or not traffic information is collected for each connected client
3412 individually. If set to false, currently no traffic data is collected at all
3413 because aggregating this data in a save manner is tricky. Defaults to B<true>.
3415 =item B<CollectUserCount> B<true>|B<false>
3417 When enabled, the number of currently connected clients or users is collected.
3418 This is especially interesting when B<CollectIndividualUsers> is disabled, but
3419 can be configured independently from that option. Defaults to B<false>.
3423 =head2 Plugin C<oracle>
3425 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
3426 Oracle® Database and lets you execute SQL statements there. It is very similar
3427 to the "dbi" plugin, because it was written around the same time. See the "dbi"
3428 plugin's documentation above for details.
3431 <Query "out_of_stock">
3432 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
3435 # InstancePrefix "foo"
3436 InstancesFrom "category"
3440 <Database "product_information">
3444 Query "out_of_stock"
3448 =head3 B<Query> blocks
3450 The Query blocks are handled identically to the Query blocks of the "dbi"
3451 plugin. Please see its documentation above for details on how to specify
3454 =head3 B<Database> blocks
3456 Database blocks define a connection to a database and which queries should be
3457 sent to that database. Each database needs a "name" as string argument in the
3458 starting tag of the block. This name will be used as "PluginInstance" in the
3459 values submitted to the daemon. Other than that, that name is not used.
3463 =item B<ConnectID> I<ID>
3465 Defines the "database alias" or "service name" to connect to. Usually, these
3466 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
3468 =item B<Host> I<Host>
3470 Hostname to use when dispatching values for this database. Defaults to using
3471 the global hostname of the I<collectd> instance.
3473 =item B<Username> I<Username>
3475 Username used for authentication.
3477 =item B<Password> I<Password>
3479 Password used for authentication.
3481 =item B<Query> I<QueryName>
3483 Associates the query named I<QueryName> with this database connection. The
3484 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
3485 blocks you want to refer to must be placed above the database block you want to
3490 =head2 Plugin C<perl>
3492 This plugin embeds a Perl-interpreter into collectd and provides an interface
3493 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
3495 =head2 Plugin C<pinba>
3497 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
3498 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
3499 PHP-based webpage has been delivered, the extension will send a UDP packet
3500 containing timing information, peak memory usage and so on. The plugin will
3501 wait for such packets, parse them and account the provided information, which
3502 is then dispatched to the daemon once per interval.
3509 # Overall statistics for the website.
3511 Server "www.example.com"
3513 # Statistics for www-a only
3515 Host "www-a.example.com"
3516 Server "www.example.com"
3518 # Statistics for www-b only
3520 Host "www-b.example.com"
3521 Server "www.example.com"
3525 The plugin provides the following configuration options:
3529 =item B<Address> I<Node>
3531 Configures the address used to open a listening socket. By default, plugin will
3532 bind to the I<any> address C<::0>.
3534 =item B<Port> I<Service>
3536 Configures the port (service) to bind to. By default the default Pinba port
3537 "30002" will be used. The option accepts service names in addition to port
3538 numbers and thus requires a I<string> argument.
3540 =item E<lt>B<View> I<Name>E<gt> block
3542 The packets sent by the Pinba extension include the hostname of the server, the
3543 server name (the name of the virtual host) and the script that was executed.
3544 Using B<View> blocks it is possible to separate the data into multiple groups
3545 to get more meaningful statistics. Each packet is added to all matching groups,
3546 so that a packet may be accounted for more than once.
3550 =item B<Host> I<Host>
3552 Matches the hostname of the system the webserver / script is running on. This
3553 will contain the result of the L<gethostname(2)> system call. If not
3554 configured, all hostnames will be accepted.
3556 =item B<Server> I<Server>
3558 Matches the name of the I<virtual host>, i.e. the contents of the
3559 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
3560 server names will be accepted.
3562 =item B<Script> I<Script>
3564 Matches the name of the I<script name>, i.e. the contents of the
3565 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
3566 script names will be accepted.
3572 =head2 Plugin C<ping>
3574 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
3575 configured hosts periodically and measures the network latency. Whenever the
3576 C<read> function of the plugin is called, it submits the average latency, the
3577 standard deviation and the drop rate for each host.
3579 Available configuration options:
3583 =item B<Host> I<IP-address>
3585 Host to ping periodically. This option may be repeated several times to ping
3588 =item B<Interval> I<Seconds>
3590 Sets the interval in which to send ICMP echo packets to the configured hosts.
3591 This is B<not> the interval in which statistics are queries from the plugin but
3592 the interval in which the hosts are "pinged". Therefore, the setting here
3593 should be smaller than or equal to the global B<Interval> setting. Fractional
3594 times, such as "1.24" are allowed.
3598 =item B<Timeout> I<Seconds>
3600 Time to wait for a response from the host to which an ICMP packet had been
3601 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
3602 to be down or the packet to be dropped. This setting must be smaller than the
3603 B<Interval> setting above for the plugin to work correctly. Fractional
3604 arguments are accepted.
3608 =item B<TTL> I<0-255>
3610 Sets the Time-To-Live of generated ICMP packets.
3612 =item B<SourceAddress> I<host>
3614 Sets the source address to use. I<host> may either be a numerical network
3615 address or a network hostname.
3617 =item B<Device> I<name>
3619 Sets the outgoing network device to be used. I<name> has to specify an
3620 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
3623 =item B<MaxMissed> I<Packets>
3625 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
3626 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
3628 Default: B<-1> (disabled)
3632 =head2 Plugin C<postgresql>
3634 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
3635 keeps a persistent connection to all configured databases and tries to
3636 reconnect if the connection has been interrupted. A database is configured by
3637 specifying a B<Database> block as described below. The default statistics are
3638 collected from PostgreSQL's B<statistics collector> which thus has to be
3639 enabled for this plugin to work correctly. This should usually be the case by
3640 default. See the section "The Statistics Collector" of the B<PostgreSQL
3641 Documentation> for details.
3643 By specifying custom database queries using a B<Query> block as described
3644 below, you may collect any data that is available from some PostgreSQL
3645 database. This way, you are able to access statistics of external daemons
3646 which are available in a PostgreSQL database or use future or special
3647 statistics provided by PostgreSQL without the need to upgrade your collectd
3650 Starting with version 5.2, the C<postgresql> plugin supports writing data to
3651 PostgreSQL databases as well. This has been implemented in a generic way. You
3652 need to specify an SQL statement which will then be executed by collectd in
3653 order to write the data (see below for details). The benefit of that approach
3654 is that there is no fixed database layout. Rather, the layout may be optimized
3655 for the current setup.
3657 The B<PostgreSQL Documentation> manual can be found at
3658 L<http://www.postgresql.org/docs/manuals/>.
3662 Statement "SELECT magic FROM wizard WHERE host = $1;"
3666 InstancePrefix "magic"
3671 <Query rt36_tickets>
3672 Statement "SELECT COUNT(type) AS count, type \
3674 WHEN resolved = 'epoch' THEN 'open' \
3675 ELSE 'resolved' END AS type \
3676 FROM tickets) type \
3680 InstancePrefix "rt36_tickets"
3681 InstancesFrom "type"
3687 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
3697 KRBSrvName "kerberos_service_name"
3703 Service "service_name"
3704 Query backend # predefined
3715 The B<Query> block defines one database query which may later be used by a
3716 database definition. It accepts a single mandatory argument which specifies
3717 the name of the query. The names of all queries have to be unique (see the
3718 B<MinVersion> and B<MaxVersion> options below for an exception to this
3719 rule). The following configuration options are available to define the query:
3721 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
3722 blocks define how to handle the values returned from the query. They define
3723 which column holds which value and how to dispatch that value to the daemon.
3724 Multiple B<Result> blocks may be used to extract multiple values from a single
3729 =item B<Statement> I<sql query statement>
3731 Specify the I<sql query statement> which the plugin should execute. The string
3732 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
3733 first, second, etc. parameter. The value of the parameters is specified by the
3734 B<Param> configuration option - see below for details. To include a literal
3735 B<$> character followed by a number, surround it with single quotes (B<'>).
3737 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
3738 allowed. Note, however, that only a single command may be used. Semicolons are
3739 allowed as long as a single non-empty command has been specified only.
3741 The returned lines will be handled separately one after another.
3743 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
3745 Specify the parameters which should be passed to the SQL query. The parameters
3746 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
3747 they appear in the configuration file. The value of the parameter is
3748 determined depending on the value of the B<Param> option as follows:
3754 The configured hostname of the database connection. If a UNIX domain socket is
3755 used, the parameter expands to "localhost".
3759 The name of the database of the current connection.
3763 The name of the database plugin instance. See the B<Instance> option of the
3764 database specification below for details.
3768 The username used to connect to the database.
3772 The interval with which this database is queried (as specified by the database
3773 specific or global B<Interval> options).
3777 Please note that parameters are only supported by PostgreSQL's protocol
3778 version 3 and above which was introduced in version 7.4 of PostgreSQL.
3780 =item B<Type> I<type>
3782 The I<type> name to be used when dispatching the values. The type describes
3783 how to handle the data and where to store it. See L<types.db(5)> for more
3784 details on types and their configuration. The number and type of values (as
3785 selected by the B<ValuesFrom> option) has to match the type of the given name.
3787 This option is required inside a B<Result> block.
3789 =item B<InstancePrefix> I<prefix>
3791 =item B<InstancesFrom> I<column0> [I<column1> ...]
3793 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
3794 B<InstancePrefix> defines a static prefix that will be prepended to all type
3795 instances. B<InstancesFrom> defines the column names whose values will be used
3796 to create the type instance. Multiple values will be joined together using the
3797 hyphen (C<->) as separation character.
3799 The plugin itself does not check whether or not all built instances are
3800 different. It is your responsibility to assure that each is unique.
3802 Both options are optional. If none is specified, the type instance will be
3805 =item B<ValuesFrom> I<column0> [I<column1> ...]
3807 Names the columns whose content is used as the actual data for the data sets
3808 that are dispatched to the daemon. How many such columns you need is
3809 determined by the B<Type> setting as explained above. If you specify too many
3810 or not enough columns, the plugin will complain about that and no data will be
3811 submitted to the daemon.
3813 The actual data type, as seen by PostgreSQL, is not that important as long as
3814 it represents numbers. The plugin will automatically cast the values to the
3815 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
3816 L<strtod(3)> functions, so anything supported by those functions is supported
3817 by the plugin as well.
3819 This option is required inside a B<Result> block and may be specified multiple
3820 times. If multiple B<ValuesFrom> options are specified, the columns are read
3823 =item B<MinVersion> I<version>
3825 =item B<MaxVersion> I<version>
3827 Specify the minimum or maximum version of PostgreSQL that this query should be
3828 used with. Some statistics might only be available with certain versions of
3829 PostgreSQL. This allows you to specify multiple queries with the same name but
3830 which apply to different versions, thus allowing you to use the same
3831 configuration in a heterogeneous environment.
3833 The I<version> has to be specified as the concatenation of the major, minor
3834 and patch-level versions, each represented as two-decimal-digit numbers. For
3835 example, version 8.2.3 will become 80203.
3839 The following predefined queries are available (the definitions can be found
3840 in the F<postgresql_default.conf> file which, by default, is available at
3841 C<I<prefix>/share/collectd/>):
3847 This query collects the number of backends, i.E<nbsp>e. the number of
3850 =item B<transactions>
3852 This query collects the numbers of committed and rolled-back transactions of
3857 This query collects the numbers of various table modifications (i.E<nbsp>e.
3858 insertions, updates, deletions) of the user tables.
3860 =item B<query_plans>
3862 This query collects the numbers of various table scans and returned tuples of
3865 =item B<table_states>
3867 This query collects the numbers of live and dead rows in the user tables.
3871 This query collects disk block access counts for user tables.
3875 This query collects the on-disk size of the database in bytes.
3879 In addition, the following detailed queries are available by default. Please
3880 note that each of those queries collects information B<by table>, thus,
3881 potentially producing B<a lot> of data. For details see the description of the
3882 non-by_table queries above.
3886 =item B<queries_by_table>
3888 =item B<query_plans_by_table>
3890 =item B<table_states_by_table>
3892 =item B<disk_io_by_table>
3896 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
3897 mandatory argument specifying the name of the writer. This will then be used
3898 in the B<Database> specification in order to activate the writer instance. The
3899 names of all writers have to be unique. The following options may be
3904 =item B<Statement> I<sql statement>
3906 This mandatory option specifies the SQL statement that will be executed for
3907 each submitted value. A single SQL statement is allowed only. Anything after
3908 the first semicolon will be ignored.
3910 Nine parameters will be passed to the statement and should be specified as
3911 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
3912 values are made available through those parameters:
3918 The timestamp of the queried value as a floating point number.
3922 The hostname of the queried value.
3926 The plugin name of the queried value.
3930 The plugin instance of the queried value. This value may be B<NULL> if there
3931 is no plugin instance.
3935 The type of the queried value (cf. L<types.db(5)>).
3939 The type instance of the queried value. This value may be B<NULL> if there is
3944 An array of names for the submitted values (i.E<nbsp>e., the name of the data
3945 sources of the submitted value-list).
3949 An array of types for the submitted values (i.E<nbsp>e., the type of the data
3950 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
3951 B<StoreRates> is enabled (which is the default, see below), all types will be
3956 An array of the submitted values. The dimensions of the value name and value
3961 In general, it is advisable to create and call a custom function in the
3962 PostgreSQL database for this purpose. Any procedural language supported by
3963 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
3966 =item B<StoreRates> B<false>|B<true>
3968 If set to B<true> (the default), convert counter values to rates. If set to
3969 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
3974 The B<Database> block defines one PostgreSQL database for which to collect
3975 statistics. It accepts a single mandatory argument which specifies the
3976 database name. None of the other options are required. PostgreSQL will use
3977 default values as documented in the section "CONNECTING TO A DATABASE" in the
3978 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
3979 the user collectd is run as and special environment variables. See the manpage
3984 =item B<Interval> I<seconds>
3986 Specify the interval with which the database should be queried. The default is
3987 to use the global B<Interval> setting.
3989 =item B<CommitInterval> I<seconds>
3991 This option may be used for database connections which have "writers" assigned
3992 (see above). If specified, it causes a writer to put several updates into a
3993 single transaction. This transaction will last for the specified amount of
3994 time. By default, each update will be executed in a separate transaction. Each
3995 transaction generates a fair amount of overhead which can, thus, be reduced by
3996 activating this option. The draw-back is, that data covering the specified
3997 amount of time will be lost, for example, if a single statement within the
3998 transaction fails or if the database server crashes.
4000 =item B<Host> I<hostname>
4002 Specify the hostname or IP of the PostgreSQL server to connect to. If the
4003 value begins with a slash, it is interpreted as the directory name in which to
4004 look for the UNIX domain socket.
4006 This option is also used to determine the hostname that is associated with a
4007 collected data set. If it has been omitted or either begins with with a slash
4008 or equals B<localhost> it will be replaced with the global hostname definition
4009 of collectd. Any other value will be passed literally to collectd when
4010 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
4012 =item B<Port> I<port>
4014 Specify the TCP port or the local UNIX domain socket file extension of the
4017 =item B<User> I<username>
4019 Specify the username to be used when connecting to the server.
4021 =item B<Password> I<password>
4023 Specify the password to be used when connecting to the server.
4025 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
4027 Specify whether to use an SSL connection when contacting the server. The
4028 following modes are supported:
4030 =item B<Instance> I<name>
4032 Specify the plugin instance name that should be used instead of the database
4033 name (which is the default, if this option has not been specified). This
4034 allows to query multiple databases of the same name on the same host (e.g.
4035 when running multiple database server versions in parallel).
4041 Do not use SSL at all.
4045 First, try to connect without using SSL. If that fails, try using SSL.
4047 =item I<prefer> (default)
4049 First, try to connect using SSL. If that fails, try without using SSL.
4057 =item B<KRBSrvName> I<kerberos_service_name>
4059 Specify the Kerberos service name to use when authenticating with Kerberos 5
4060 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
4061 B<PostgreSQL Documentation> for details.
4063 =item B<Service> I<service_name>
4065 Specify the PostgreSQL service name to use for additional parameters. That
4066 service has to be defined in F<pg_service.conf> and holds additional
4067 connection parameters. See the section "The Connection Service File" in the
4068 B<PostgreSQL Documentation> for details.
4070 =item B<Query> I<query>
4072 Specifies a I<query> which should be executed in the context of the database
4073 connection. This may be any of the predefined or user-defined queries. If no
4074 such option is given, it defaults to "backends", "transactions", "queries",
4075 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
4076 has been specified). Else, the specified queries are used only.
4078 =item B<Writer> I<writer>
4080 Assigns the specified I<writer> backend to the database connection. This
4081 causes all collected data to be send to the database using the settings
4082 defined in the writer configuration (see the section "FILTER CONFIGURATION"
4083 below for details on how to selectively send data to certain plugins).
4085 Each writer will register a flush callback which may be used when having long
4086 transactions enabled (see the B<CommitInterval> option above). When issuing
4087 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
4088 transaction will be committed right away. Two different kinds of flush
4089 callbacks are available with the C<postgresql> plugin:
4095 Flush all writer backends.
4097 =item B<postgresql->I<database>
4099 Flush all writers of the specified I<database> only.
4105 =head2 Plugin C<powerdns>
4107 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
4108 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
4109 values, many of which are probably meaningless to most users, but may be useful
4110 for some. So you may chose which values to collect, but if you don't, some
4111 reasonable defaults will be collected.
4114 <Server "server_name">
4116 Collect "udp-answers" "udp-queries"
4117 Socket "/var/run/pdns.controlsocket"
4119 <Recursor "recursor_name">
4121 Collect "cache-hits" "cache-misses"
4122 Socket "/var/run/pdns_recursor.controlsocket"
4124 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
4129 =item B<Server> and B<Recursor> block
4131 The B<Server> block defines one authoritative server to query, the B<Recursor>
4132 does the same for an recursing server. The possible options in both blocks are
4133 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
4138 =item B<Collect> I<Field>
4140 Using the B<Collect> statement you can select which values to collect. Here,
4141 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
4142 C<dlg-only-drops>, C<answers10-100>.
4144 The method of getting the values differs for B<Server> and B<Recursor> blocks:
4145 When querying the server a C<SHOW *> command is issued in any case, because
4146 that's the only way of getting multiple values out of the server at once.
4147 collectd then picks out the values you have selected. When querying the
4148 recursor, a command is generated to query exactly these values. So if you
4149 specify invalid fields when querying the recursor, a syntax error may be
4150 returned by the daemon and collectd may not collect any values at all.
4152 If no B<Collect> statement is given, the following B<Server> values will be
4159 =item packetcache-hit
4161 =item packetcache-miss
4163 =item packetcache-size
4165 =item query-cache-hit
4167 =item query-cache-miss
4169 =item recursing-answers
4171 =item recursing-questions
4183 The following B<Recursor> values will be collected by default:
4187 =item noerror-answers
4189 =item nxdomain-answers
4191 =item servfail-answers
4209 Please note that up to that point collectd doesn't know what values are
4210 available on the server and values that are added do not need a change of the
4211 mechanism so far. However, the values must be mapped to collectd's naming
4212 scheme, which is done using a lookup table that lists all known values. If
4213 values are added in the future and collectd does not know about them, you will
4214 get an error much like this:
4216 powerdns plugin: submit: Not found in lookup table: foobar = 42
4218 In this case please file a bug report with the collectd team.
4220 =item B<Socket> I<Path>
4222 Configures the path to the UNIX domain socket to be used when connecting to the
4223 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
4224 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
4225 will be used for the recursor.
4229 =item B<LocalSocket> I<Path>
4231 Querying the recursor is done using UDP. When using UDP over UNIX domain
4232 sockets, the client socket needs a name in the file system, too. You can set
4233 this local name to I<Path> using the B<LocalSocket> option. The default is
4234 C<I<prefix>/var/run/collectd-powerdns>.
4238 =head2 Plugin C<processes>
4242 =item B<Process> I<Name>
4244 Select more detailed statistics of processes matching this name. The statistics
4245 collected for these selected processes are size of the resident segment size
4246 (RSS), user- and system-time used, number of processes and number of threads,
4247 io data (where available) and minor and major pagefaults.
4249 =item B<ProcessMatch> I<name> I<regex>
4251 Similar to the B<Process> option this allows to select more detailed
4252 statistics of processes matching the specified I<regex> (see L<regex(7)> for
4253 details). The statistics of all matching processes are summed up and
4254 dispatched to the daemon using the specified I<name> as an identifier. This
4255 allows to "group" several processes together. I<name> must not contain
4260 =head2 Plugin C<protocols>
4262 Collects a lot of information about various network protocols, such as I<IP>,
4263 I<TCP>, I<UDP>, etc.
4265 Available configuration options:
4269 =item B<Value> I<Selector>
4271 Selects whether or not to select a specific value. The string being matched is
4272 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
4273 plugin instance and I<ValueName> will be used as type instance. An example of
4274 the string being used would be C<Tcp:RetransSegs>.
4276 You can use regular expressions to match a large number of values with just one
4277 configuration option. To select all "extended" I<TCP> values, you could use the
4278 following statement:
4282 Whether only matched values are selected or all matched values are ignored
4283 depends on the B<IgnoreSelected>. By default, only matched values are selected.
4284 If no value is configured at all, all values will be selected.
4286 =item B<IgnoreSelected> B<true>|B<false>
4288 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
4289 matching values will be ignored.
4293 =head2 Plugin C<python>
4295 This plugin embeds a Python-interpreter into collectd and provides an interface
4296 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
4298 =head2 Plugin C<routeros>
4300 The C<routeros> plugin connects to a device running I<RouterOS>, the
4301 Linux-based operating system for routers by I<MikroTik>. The plugin uses
4302 I<librouteros> to connect and reads information about the interfaces and
4303 wireless connections of the device. The configuration supports querying
4308 Host "router0.example.com"
4311 CollectInterface true
4316 Host "router1.example.com"
4319 CollectInterface true
4320 CollectRegistrationTable true
4326 As you can see above, the configuration of the I<routeros> plugin consists of
4327 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
4328 options are understood:
4332 =item B<Host> I<Host>
4334 Hostname or IP-address of the router to connect to.
4336 =item B<Port> I<Port>
4338 Port name or port number used when connecting. If left unspecified, the default
4339 will be chosen by I<librouteros>, currently "8728". This option expects a
4340 string argument, even when a numeric port number is given.
4342 =item B<User> I<User>
4344 Use the user name I<User> to authenticate. Defaults to "admin".
4346 =item B<Password> I<Password>
4348 Set the password used to authenticate.
4350 =item B<CollectInterface> B<true>|B<false>
4352 When set to B<true>, interface statistics will be collected for all interfaces
4353 present on the device. Defaults to B<false>.
4355 =item B<CollectRegistrationTable> B<true>|B<false>
4357 When set to B<true>, information about wireless LAN connections will be
4358 collected. Defaults to B<false>.
4360 =item B<CollectCPULoad> B<true>|B<false>
4362 When set to B<true>, information about the CPU usage will be collected. The
4363 number is a dimensionless value where zero indicates no CPU usage at all.
4364 Defaults to B<false>.
4366 =item B<CollectMemory> B<true>|B<false>
4368 When enabled, the amount of used and free memory will be collected. How used
4369 memory is calculated is unknown, for example whether or not caches are counted
4371 Defaults to B<false>.
4373 =item B<CollectDF> B<true>|B<false>
4375 When enabled, the amount of used and free disk space will be collected.
4376 Defaults to B<false>.
4378 =item B<CollectDisk> B<true>|B<false>
4380 When enabled, the number of sectors written and bad blocks will be collected.
4381 Defaults to B<false>.
4385 =head2 Plugin C<redis>
4387 The I<Redis plugin> connects to one or more Redis servers and gathers
4388 information about each server's state. For each server there is a I<Node> block
4389 which configures the connection parameters for this node.
4399 The information shown in the synopsis above is the I<default configuration>
4400 which is used by the plugin if no configuration is present.
4404 =item B<Node> I<Nodename>
4406 The B<Node> block identifies a new Redis node, that is a new Redis instance
4407 running in an specified host and port. The name for node is a canonical
4408 identifier which is used as I<plugin instance>. It is limited to
4409 64E<nbsp>characters in length.
4411 =item B<Host> I<Hostname>
4413 The B<Host> option is the hostname or IP-address where the Redis instance is
4416 =item B<Port> I<Port>
4418 The B<Port> option is the TCP port on which the Redis instance accepts
4419 connections. Either a service name of a port number may be given. Please note
4420 that numerical port numbers must be given as a string, too.
4422 =item B<Password> I<Password>
4424 Use I<Password> to authenticate when connecting to I<Redis>.
4426 =item B<Timeout> I<Timeout in miliseconds>
4428 The B<Timeout> option set the socket timeout for node response. Since the Redis
4429 read function is blocking, you should keep this value as low as possible. Keep
4430 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
4431 than B<Interval> defined globally.
4435 =head2 Plugin C<rrdcached>
4437 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
4438 to store values to RRD files in an efficient manner. The combination of the
4439 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
4440 way the C<rrdtool> plugin works (see below). The added abstraction layer
4441 provides a number of benefits, though: Because the cache is not within
4442 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
4443 restarted. This results in much shorter (if any) gaps in graphs, especially
4444 under heavy load. Also, the C<rrdtool> command line utility is aware of the
4445 daemon so that it can flush values to disk automatically when needed. This
4446 allows to integrate automated flushing of values into graphing solutions much
4449 There are disadvantages, though: The daemon may reside on a different host, so
4450 it may not be possible for C<collectd> to create the appropriate RRD files
4451 anymore. And even if C<rrdcached> runs on the same host, it may run in a
4452 different base directory, so relative paths may do weird stuff if you're not
4455 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
4456 on the same host, communicating via a UNIX domain socket. The B<DataDir>
4457 setting should be set to an absolute path, so that a changed base directory
4458 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
4462 =item B<DaemonAddress> I<Address>
4464 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
4465 library. See L<rrdcached(1)> for details. Example:
4467 <Plugin "rrdcached">
4468 DaemonAddress "unix:/var/run/rrdcached.sock"
4471 =item B<DataDir> I<Directory>
4473 Set the base directory in which the RRD files reside. If this is a relative
4474 path, it is relative to the working base directory of the C<rrdcached> daemon!
4475 Use of an absolute path is recommended.
4477 =item B<CreateFiles> B<true>|B<false>
4479 Enables or disables the creation of RRD files. If the daemon is not running
4480 locally, or B<DataDir> is set to a relative path, this will not work as
4481 expected. Default is B<true>.
4483 =item B<StepSize> I<Seconds>
4485 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
4486 this setting is unset and the stepsize is set to the interval in which the data
4487 is collected. Do not use this option unless you absolutely have to for some
4488 reason. Setting this option may cause problems with the C<snmp plugin>, the
4489 C<exec plugin> or when the daemon is set up to receive data from other hosts.
4491 =item B<HeartBeat> I<Seconds>
4493 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
4494 in which case the heartbeat is set to twice the B<StepSize> which should equal
4495 the interval in which data is collected. Do not set this option unless you have
4496 a very good reason to do so.
4498 =item B<RRARows> I<NumRows>
4500 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
4501 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
4502 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
4503 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
4504 week, one month, and one year.
4506 So for each timespan, it calculates how many PDPs need to be consolidated into
4507 one CDP by calculating:
4508 number of PDPs = timespan / (stepsize * rrarows)
4510 Bottom line is, set this no smaller than the width of you graphs in pixels. The
4513 =item B<RRATimespan> I<Seconds>
4515 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
4516 more then one RRA. If this option is never used, the built-in default of (3600,
4517 86400, 604800, 2678400, 31622400) is used.
4519 For more information on how RRA-sizes are calculated see B<RRARows> above.
4521 =item B<XFF> I<Factor>
4523 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
4524 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
4529 =head2 Plugin C<rrdtool>
4531 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
4532 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
4533 using these settings. If you don't want to dive into the depths of RRDtool, you
4534 can safely ignore these settings.
4538 =item B<DataDir> I<Directory>
4540 Set the directory to store RRD-files under. Per default RRD-files are generated
4541 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
4543 =item B<StepSize> I<Seconds>
4545 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
4546 this setting is unset and the stepsize is set to the interval in which the data
4547 is collected. Do not use this option unless you absolutely have to for some
4548 reason. Setting this option may cause problems with the C<snmp plugin>, the
4549 C<exec plugin> or when the daemon is set up to receive data from other hosts.
4551 =item B<HeartBeat> I<Seconds>
4553 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
4554 in which case the heartbeat is set to twice the B<StepSize> which should equal
4555 the interval in which data is collected. Do not set this option unless you have
4556 a very good reason to do so.
4558 =item B<RRARows> I<NumRows>
4560 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
4561 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
4562 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
4563 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
4564 week, one month, and one year.
4566 So for each timespan, it calculates how many PDPs need to be consolidated into
4567 one CDP by calculating:
4568 number of PDPs = timespan / (stepsize * rrarows)
4570 Bottom line is, set this no smaller than the width of you graphs in pixels. The
4573 =item B<RRATimespan> I<Seconds>
4575 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
4576 more then one RRA. If this option is never used, the built-in default of (3600,
4577 86400, 604800, 2678400, 31622400) is used.
4579 For more information on how RRA-sizes are calculated see B<RRARows> above.
4581 =item B<XFF> I<Factor>
4583 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
4584 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
4587 =item B<CacheFlush> I<Seconds>
4589 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
4590 it writes all values for a certain RRD-file if the oldest value is older than
4591 (or equal to) the number of seconds specified. If some RRD-file is not updated
4592 anymore for some reason (the computer was shut down, the network is broken,
4593 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
4594 entire cache is searched for entries older than B<CacheTimeout> seconds and
4595 written to disk every I<Seconds> seconds. Since this is kind of expensive and
4596 does nothing under normal circumstances, this value should not be too small.
4597 900 seconds might be a good value, though setting this to 7200 seconds doesn't
4598 normally do much harm either.
4600 =item B<CacheTimeout> I<Seconds>
4602 If this option is set to a value greater than zero, the C<rrdtool plugin> will
4603 save values in a cache, as described above. Writing multiple values at once
4604 reduces IO-operations and thus lessens the load produced by updating the files.
4605 The trade off is that the graphs kind of "drag behind" and that more memory is
4608 =item B<WritesPerSecond> I<Updates>
4610 When collecting many statistics with collectd and the C<rrdtool> plugin, you
4611 will run serious performance problems. The B<CacheFlush> setting and the
4612 internal update queue assert that collectd continues to work just fine even
4613 under heavy load, but the system may become very unresponsive and slow. This is
4614 a problem especially if you create graphs from the RRD files on the same
4615 machine, for example using the C<graph.cgi> script included in the
4616 C<contrib/collection3/> directory.
4618 This setting is designed for very large setups. Setting this option to a value
4619 between 25 and 80 updates per second, depending on your hardware, will leave
4620 the server responsive enough to draw graphs even while all the cached values
4621 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
4622 by the B<FLUSH> command, are B<not> effected by this limit. They are still
4623 written as fast as possible, so that web frontends have up to date data when
4626 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
4627 updates per second, writing all values to disk will take approximately
4628 56E<nbsp>minutes. Together with the flushing ability that's integrated into
4629 "collection3" you'll end up with a responsive and fast system, up to date
4630 graphs and basically a "backup" of your values every hour.
4632 =item B<RandomTimeout> I<Seconds>
4634 When set, the actual timeout for each value is chosen randomly between
4635 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
4636 intention is to avoid high load situations that appear when many values timeout
4637 at the same time. This is especially a problem shortly after the daemon starts,
4638 because all values were added to the internal cache at roughly the same time.
4642 =head2 Plugin C<sensors>
4644 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
4645 that all the needed modules have to be loaded and lm_sensors has to be
4646 configured (most likely by editing F</etc/sensors.conf>. Read
4647 L<sensors.conf(5)> for details.
4649 The B<lm_sensors> homepage can be found at
4650 L<http://secure.netroedge.com/~lm78/>.
4654 =item B<SensorConfigFile> I<File>
4656 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
4657 the library's default will be used.
4659 =item B<Sensor> I<chip-bus-address/type-feature>
4661 Selects the name of the sensor which you want to collect or ignore, depending
4662 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
4663 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
4664 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
4666 =item B<IgnoreSelected> I<true>|I<false>
4668 If no configuration if given, the B<sensors>-plugin will collect data from all
4669 sensors. This may not be practical, especially for uninteresting sensors.
4670 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
4671 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
4672 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
4673 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
4674 and all other sensors are collected.
4678 =head2 Plugin C<snmp>
4680 Since the configuration of the C<snmp plugin> is a little more complicated than
4681 other plugins, its documentation has been moved to an own manpage,
4682 L<collectd-snmp(5)>. Please see there for details.
4684 =head2 Plugin C<swap>
4686 The I<Swap plugin> collects information about used and available swap space. On
4687 I<Linux> and I<Solaris>, the following options are available:
4691 =item B<ReportByDevice> B<false>|B<true>
4693 Configures how to report physical swap devices. If set to B<false> (the
4694 default), the summary over all swap devices is reported only, i.e. the globally
4695 used and available space over all devices. If B<true> is configured, the used
4696 and available space of each device will be reported separately.
4698 This option is only available if the I<Swap plugin> can read C</proc/swaps>
4699 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
4701 =item B<ReportBytes> B<false>|B<true>
4703 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
4704 I<swap I/O> is reported in pages. This option is available under Linux only.
4708 =head2 Plugin C<syslog>
4712 =item B<LogLevel> B<debug|info|notice|warning|err>
4714 Sets the log-level. If, for example, set to B<notice>, then all events with
4715 severity B<notice>, B<warning>, or B<err> will be submitted to the
4718 Please note that B<debug> is only available if collectd has been compiled with
4721 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
4723 Controls which notifications should be sent to syslog. The default behaviour is
4724 not to send any. Less severe notifications always imply logging more severe
4725 notifications: Setting this to B<OKAY> means all notifications will be sent to
4726 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
4727 notifications but will dismiss B<OKAY> notifications. Setting this option to
4728 B<FAILURE> will only send failures to syslog.
4732 =head2 Plugin C<table>
4734 The C<table plugin> provides generic means to parse tabular data and dispatch
4735 user specified values. Values are selected based on column numbers. For
4736 example, this plugin may be used to get values from the Linux L<proc(5)>
4737 filesystem or CSV (comma separated values) files.
4740 <Table "/proc/slabinfo">
4745 InstancePrefix "active_objs"
4751 InstancePrefix "objperslab"
4758 The configuration consists of one or more B<Table> blocks, each of which
4759 configures one file to parse. Within each B<Table> block, there are one or
4760 more B<Result> blocks, which configure which data to select and how to
4763 The following options are available inside a B<Table> block:
4767 =item B<Instance> I<instance>
4769 If specified, I<instance> is used as the plugin instance. So, in the above
4770 example, the plugin name C<table-slabinfo> would be used. If omitted, the
4771 filename of the table is used instead, with all special characters replaced
4772 with an underscore (C<_>).
4774 =item B<Separator> I<string>
4776 Any character of I<string> is interpreted as a delimiter between the different
4777 columns of the table. A sequence of two or more contiguous delimiters in the
4778 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
4779 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
4780 of a table - see its documentation for more details. This option is mandatory.
4782 A horizontal tab, newline and carriage return may be specified by C<\\t>,
4783 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
4784 required because of collectd's config parsing.
4788 The following options are available inside a B<Result> block:
4792 =item B<Type> I<type>
4794 Sets the type used to dispatch the values to the daemon. Detailed information
4795 about types and their configuration can be found in L<types.db(5)>. This
4796 option is mandatory.
4798 =item B<InstancePrefix> I<prefix>
4800 If specified, prepend I<prefix> to the type instance. If omitted, only the
4801 B<InstancesFrom> option is considered for the type instance.
4803 =item B<InstancesFrom> I<column0> [I<column1> ...]
4805 If specified, the content of the given columns (identified by the column
4806 number starting at zero) will be used to create the type instance for each
4807 row. Multiple values (and the instance prefix) will be joined together with
4808 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
4809 option is considered for the type instance.
4811 The plugin itself does not check whether or not all built instances are
4812 different. It’s your responsibility to assure that each is unique. This is
4813 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
4814 sure that the table only contains one row.
4816 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
4819 =item B<ValuesFrom> I<column0> [I<column1> ...]
4821 Specifies the columns (identified by the column numbers starting at zero)
4822 whose content is used as the actual data for the data sets that are dispatched
4823 to the daemon. How many such columns you need is determined by the B<Type>
4824 setting above. If you specify too many or not enough columns, the plugin will
4825 complain about that and no data will be submitted to the daemon. The plugin
4826 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
4827 respectively, so anything supported by those functions is supported by the
4828 plugin as well. This option is mandatory.
4832 =head2 Plugin C<tail>
4834 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
4835 each line and dispatches found values. What is matched can be configured by the
4836 user using (extended) regular expressions, as described in L<regex(7)>.
4839 <File "/var/log/exim4/mainlog">
4842 Regex "S=([1-9][0-9]*)"
4848 Regex "\\<R=local_user\\>"
4849 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
4852 Instance "local_user"
4857 The config consists of one or more B<File> blocks, each of which configures one
4858 logfile to parse. Within each B<File> block, there are one or more B<Match>
4859 blocks, which configure a regular expression to search for.
4861 The B<Instance> option in the B<File> block may be used to set the plugin
4862 instance. So in the above example the plugin name C<tail-foo> would be used.
4863 This plugin instance is for all B<Match> blocks that B<follow> it, until the
4864 next B<Instance> option. This way you can extract several plugin instances from
4865 one logfile, handy when parsing syslog and the like.
4867 Each B<Match> block has the following options to describe how the match should
4872 =item B<Regex> I<regex>
4874 Sets the regular expression to use for matching against a line. The first
4875 subexpression has to match something that can be turned into a number by
4876 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
4877 below. Because B<extended> regular expressions are used, you do not need to use
4878 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
4879 collectd's config parsing you need to escape backslashes, though. So if you
4880 want to match literal parentheses you need to do the following:
4882 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
4884 =item B<ExcludeRegex> I<regex>
4886 Sets an optional regular expression to use for excluding lines from the match.
4887 An example which excludes all connections from localhost from the match:
4889 ExcludeRegex "127\\.0\\.0\\.1"
4891 =item B<DSType> I<Type>
4893 Sets how the values are cumulated. I<Type> is one of:
4897 =item B<GaugeAverage>
4899 Calculate the average.
4903 Use the smallest number only.
4907 Use the greatest number only.
4911 Use the last number found.
4917 =item B<AbsoluteSet>
4919 The matched number is a counter. Simply I<sets> the internal counter to this
4920 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
4926 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
4927 matched number may be negative, which will effectively subtract from the
4934 Increase the internal counter by one. These B<DSType> are the only ones that do
4935 not use the matched subexpression, but simply count the number of matched
4936 lines. Thus, you may use a regular expression without submatch in this case.
4940 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
4941 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
4942 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
4943 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
4944 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
4947 =item B<Type> I<Type>
4949 Sets the type used to dispatch this value. Detailed information about types and
4950 their configuration can be found in L<types.db(5)>.
4952 =item B<Instance> I<TypeInstance>
4954 This optional setting sets the type instance to use.
4958 =head2 Plugin C<teamspeak2>
4960 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
4961 polls interesting global and virtual server data. The plugin can query only one
4962 physical server but unlimited virtual servers. You can use the following
4963 options to configure it:
4967 =item B<Host> I<hostname/ip>
4969 The hostname or ip which identifies the physical server.
4972 =item B<Port> I<port>
4974 The query port of the physical server. This needs to be a string.
4977 =item B<Server> I<port>
4979 This option has to be added once for every virtual server the plugin should
4980 query. If you want to query the virtual server on port 8767 this is what the
4981 option would look like:
4985 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
4986 use quotes around it! If no such statement is given only global information
4991 =head2 Plugin C<ted>
4993 The I<TED> plugin connects to a device of "The Energy Detective", a device to
4994 measure power consumption. These devices are usually connected to a serial
4995 (RS232) or USB port. The plugin opens a configured device and tries to read the
4996 current energy readings. For more information on TED, visit
4997 L<http://www.theenergydetective.com/>.
4999 Available configuration options:
5003 =item B<Device> I<Path>
5005 Path to the device on which TED is connected. collectd will need read and write
5006 permissions on that file.
5008 Default: B</dev/ttyUSB0>
5010 =item B<Retries> I<Num>
5012 Apparently reading from TED is not that reliable. You can therefore configure a
5013 number of retries here. You only configure the I<retries> here, to if you
5014 specify zero, one reading will be performed (but no retries if that fails); if
5015 you specify three, a maximum of four readings are performed. Negative values
5022 =head2 Plugin C<tcpconns>
5024 The C<tcpconns plugin> counts the number of currently established TCP
5025 connections based on the local port and/or the remote port. Since there may be
5026 a lot of connections the default if to count all connections with a local port,
5027 for which a listening socket is opened. You can use the following options to
5028 fine-tune the ports you are interested in:
5032 =item B<ListeningPorts> I<true>|I<false>
5034 If this option is set to I<true>, statistics for all local ports for which a
5035 listening socket exists are collected. The default depends on B<LocalPort> and
5036 B<RemotePort> (see below): If no port at all is specifically selected, the
5037 default is to collect listening ports. If specific ports (no matter if local or
5038 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
5039 the selected ports will be collected unless this option is set to I<true>
5042 =item B<LocalPort> I<Port>
5044 Count the connections to a specific local port. This can be used to see how
5045 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
5046 You have to specify the port in numeric form, so for the mailserver example
5047 you'd need to set B<25>.
5049 =item B<RemotePort> I<Port>
5051 Count the connections to a specific remote port. This is useful to see how
5052 much a remote service is used. This is most useful if you want to know how many
5053 connections a local service has opened to remote services, e.E<nbsp>g. how many
5054 connections a mail server or news server has to other mail or news servers, or
5055 how many connections a web proxy holds to web servers. You have to give the
5056 port in numeric form.
5060 =head2 Plugin C<thermal>
5064 =item B<ForceUseProcfs> I<true>|I<false>
5066 By default, the I<Thermal plugin> tries to read the statistics from the Linux
5067 C<sysfs> interface. If that is not available, the plugin falls back to the
5068 C<procfs> interface. By setting this option to I<true>, you can force the
5069 plugin to use the latter. This option defaults to I<false>.
5071 =item B<Device> I<Device>
5073 Selects the name of the thermal device that you want to collect or ignore,
5074 depending on the value of the B<IgnoreSelected> option. This option may be
5075 used multiple times to specify a list of devices.
5077 =item B<IgnoreSelected> I<true>|I<false>
5079 Invert the selection: If set to true, all devices B<except> the ones that
5080 match the device names specified by the B<Device> option are collected. By
5081 default only selected devices are collected if a selection is made. If no
5082 selection is configured at all, B<all> devices are selected.
5086 =head2 Plugin C<threshold>
5088 The I<Threshold plugin> checks values collected or received by I<collectd>
5089 against a configurable I<threshold> and issues I<notifications> if values are
5092 Documentation for this plugin is available in the L<collectd-threshold(5)>
5095 =head2 Plugin C<tokyotyrant>
5097 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
5098 couple metrics: number of records, and database size on disk.
5102 =item B<Host> I<Hostname/IP>
5104 The hostname or ip which identifies the server.
5105 Default: B<127.0.0.1>
5107 =item B<Port> I<Service/Port>
5109 The query port of the server. This needs to be a string, even if the port is
5110 given in its numeric form.
5115 =head2 Plugin C<unixsock>
5119 =item B<SocketFile> I<Path>
5121 Sets the socket-file which is to be created.
5123 =item B<SocketGroup> I<Group>
5125 If running as root change the group of the UNIX-socket after it has been
5126 created. Defaults to B<collectd>.
5128 =item B<SocketPerms> I<Permissions>
5130 Change the file permissions of the UNIX-socket after it has been created. The
5131 permissions must be given as a numeric, octal value as you would pass to
5132 L<chmod(1)>. Defaults to B<0770>.
5134 =item B<DeleteSocket> B<false>|B<true>
5136 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
5137 with the given name already exists. If I<collectd> crashes a socket file may be
5138 left over, preventing the daemon from opening a new socket when restarted.
5139 Since this is potentially dangerous, this defaults to B<false>.
5143 =head2 Plugin C<uuid>
5145 This plugin, if loaded, causes the Hostname to be taken from the machine's
5146 UUID. The UUID is a universally unique designation for the machine, usually
5147 taken from the machine's BIOS. This is most useful if the machine is running in
5148 a virtual environment such as Xen, in which case the UUID is preserved across
5149 shutdowns and migration.
5151 The following methods are used to find the machine's UUID, in order:
5157 Check I</etc/uuid> (or I<UUIDFile>).
5161 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
5166 Check for UUID from C<dmidecode> / SMBIOS.
5170 Check for UUID from Xen hypervisor.
5174 If no UUID can be found then the hostname is not modified.
5178 =item B<UUIDFile> I<Path>
5180 Take the UUID from the given file (default I</etc/uuid>).
5184 =head2 Plugin C<varnish>
5186 The Varnish plugin collects information about Varnish, an HTTP accelerator.
5190 =item B<CollectCache> B<true>|B<false>
5192 Cache hits and misses. True by default.
5194 =item B<CollectConnections> B<true>|B<false>
5196 Number of client connections received, accepted and dropped. True by default.
5198 =item B<CollectBackend> B<true>|B<false>
5200 Back-end connection statistics, such as successful, reused,
5201 and closed connections. True by default.
5203 =item B<CollectSHM> B<true>|B<false>
5205 Statistics about the shared memory log, a memory region to store
5206 log messages which is flushed to disk when full. True by default.
5208 =item B<CollectESI> B<true>|B<false>
5210 Edge Side Includes (ESI) parse statistics. False by default.
5212 =item B<CollectFetch> B<true>|B<false>
5214 Statistics about fetches (HTTP requests sent to the backend). False by default.
5216 =item B<CollectHCB> B<true>|B<false>
5218 Inserts and look-ups in the crit bit tree based hash. Look-ups are
5219 divided into locked and unlocked look-ups. False by default.
5221 =item B<CollectSMA> B<true>|B<false>
5223 malloc or umem (umem_alloc(3MALLOC) based) storage statistics.
5224 The umem storage component is Solaris specific. False by default.
5226 =item B<CollectSMS> B<true>|B<false>
5228 synth (synthetic content) storage statistics. This storage
5229 component is used internally only. False by default.
5231 =item B<CollectSM> B<true>|B<false>
5233 file (memory mapped file) storage statistics. False by default.
5235 =item B<CollectTotals> B<true>|B<false>
5237 Collects overview counters, such as the number of sessions created,
5238 the number of requests and bytes transferred. False by default.
5240 =item B<CollectWorkers> B<true>|B<false>
5242 Collect statistics about worker threads. False by default.
5246 =head2 Plugin C<vmem>
5248 The C<vmem> plugin collects information about the usage of virtual memory.
5249 Since the statistics provided by the Linux kernel are very detailed, they are
5250 collected very detailed. However, to get all the details, you have to switch
5251 them on manually. Most people just want an overview over, such as the number of
5252 pages read from swap space.
5256 =item B<Verbose> B<true>|B<false>
5258 Enables verbose collection of information. This will start collecting page
5259 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
5260 Part of these statistics are collected on a "per zone" basis.
5264 =head2 Plugin C<vserver>
5266 This plugin doesn't have any options. B<VServer> support is only available for
5267 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
5268 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
5269 need to apply the patches and compile your own kernel, which will then provide
5270 the F</proc/virtual> filesystem that is required by this plugin.
5272 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
5274 B<Note>: The traffic collected by this plugin accounts for the amount of
5275 traffic passing a socket which might be a lot less than the actual on-wire
5276 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
5277 collect on-wire traffic you could, for example, use the logging facilities of
5278 iptables to feed data for the guest IPs into the iptables plugin.
5280 =head2 Plugin C<write_graphite>
5282 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
5283 storage and graphing project. The plugin connects to I<Carbon>, the data layer
5284 of I<Graphite>, and sends data via the "line based" protocol (per default using
5285 portE<nbsp>2003). The data will be sent in blocks of at most 1428 bytes to
5286 minimize the number of network packets.
5290 <Plugin write_graphite>
5300 =item B<Host> I<Address>
5302 Hostname or address to connect to. Defaults to C<localhost>.
5304 =item B<Port> I<Service>
5306 Service name or port number to connect to. Defaults to C<2003>.
5308 =item B<Prefix> I<String>
5310 When set, I<String> is added in front of the host name. Dots and whitespace are
5311 I<not> escaped in this string (see B<EscapeCharacter> below).
5313 =item B<Postfix> I<String>
5315 When set, I<String> is appended to the host name. Dots and whitespace are
5316 I<not> escaped in this string (see B<EscapeCharacter> below).
5318 =item B<EscapeCharacter> I<Char>
5320 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
5321 in the identifier. The B<EscapeCharacter> option determines which character
5322 dots, whitespace and control characters are replaced with. Defaults to
5325 =item B<StoreRates> B<false>|B<true>
5327 If set to B<true> (the default), convert counter values to rates. If set to
5328 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
5331 =item B<SeparateInstances> B<false>|B<true>
5333 If set to B<true>, the plugin instance and type instance will be in their own
5334 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
5335 default), the plugin and plugin instance (and likewise the type and type
5336 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
5338 =item B<AlwaysAppendDS> B<false>|B<true>
5340 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
5341 identifier. If set to B<false> (the default), this is only done when there is
5346 =head2 Plugin C<write_mongodb>
5348 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
5353 <Plugin "write_mongodb">
5362 The plugin can send values to multiple instances of I<MongoDB> by specifying
5363 one B<Node> block for each instance. Within the B<Node> blocks, the following
5364 options are available:
5368 =item B<Host> I<Address>
5370 Hostname or address to connect to. Defaults to C<localhost>.
5372 =item B<Port> I<Service>
5374 Service name or port number to connect to. Defaults to C<27017>.
5376 =item B<Timeout> I<Timeout>
5378 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
5379 Setting this option to zero means no timeout, which is the default.
5381 =item B<StoreRates> B<false>|B<true>
5383 If set to B<true> (the default), convert counter values to rates. If set to
5384 B<false> counter values are stored as is, i.e. as an increasing integer
5389 =head2 Plugin C<write_http>
5391 This output plugin submits values to an http server by POST them using the
5392 PUTVAL plain-text protocol. Each destination you want to post data to needs to
5393 have one B<URL> block, within which the destination can be configured further,
5394 for example by specifying authentication data.
5398 <Plugin "write_http">
5399 <URL "http://example.com/post-collectd">
5405 B<URL> blocks need one string argument which is used as the URL to which data
5406 is posted. The following options are understood within B<URL> blocks.
5410 =item B<User> I<Username>
5412 Optional user name needed for authentication.
5414 =item B<Password> I<Password>
5416 Optional password needed for authentication.
5418 =item B<VerifyPeer> B<true>|B<false>
5420 Enable or disable peer SSL certificate verification. See
5421 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5423 =item B<VerifyHost> B<true|false>
5425 Enable or disable peer host name verification. If enabled, the plugin checks if
5426 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
5427 matches the host name provided by the B<URL> option. If this identity check
5428 fails, the connection is aborted. Obviously, only works when connecting to a
5429 SSL enabled server. Enabled by default.
5431 =item B<CACert> I<File>
5433 File that holds one or more SSL certificates. If you want to use HTTPS you will
5434 possibly need this option. What CA certificates come bundled with C<libcurl>
5435 and are checked by default depends on the distribution you use.
5437 =item B<Format> B<Command>|B<JSON>
5439 Format of the output to generate. If set to B<Command>, will create output that
5440 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
5441 create output in the I<JavaScript Object Notation> (JSON).
5443 Defaults to B<Command>.
5445 =item B<StoreRates> B<true|false>
5447 If set to B<true>, convert counter values to rates. If set to B<false> (the
5448 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
5453 =head1 THRESHOLD CONFIGURATION
5455 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
5456 we mean that the values are not only stored or sent somewhere, but that they
5457 are judged and, if a problem is recognized, acted upon. The only action
5458 collectd takes itself is to generate and dispatch a "notification". Plugins can
5459 register to receive notifications and perform appropriate further actions.
5461 Since systems and what you expect them to do differ a lot, you can configure
5462 B<thresholds> for your values freely. This gives you a lot of flexibility but
5463 also a lot of responsibility.
5465 Every time a value is out of range a notification is dispatched. This means
5466 that the idle percentage of your CPU needs to be less then the configured
5467 threshold only once for a notification to be generated. There's no such thing
5468 as a moving average or similar - at least not now.
5470 Also, all values that match a threshold are considered to be relevant or
5471 "interesting". As a consequence collectd will issue a notification if they are
5472 not received for B<Timeout> iterations. The B<Timeout> configuration option is
5473 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
5474 "2" (the default) and some hosts sends it's CPU statistics to the server every
5475 60 seconds, a notification will be dispatched after about 120 seconds. It may
5476 take a little longer because the timeout is checked only once each B<Interval>
5479 When a value comes within range again or is received after it was missing, an
5480 "OKAY-notification" is dispatched.
5482 Here is a configuration example to get you started. Read below for more
5495 <Plugin "interface">
5512 WarningMin 100000000
5518 There are basically two types of configuration statements: The C<Host>,
5519 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
5520 configured. The C<Plugin> and C<Type> blocks may be specified further using the
5521 C<Instance> option. You can combine the block by nesting the blocks, though
5522 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
5523 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
5524 C<Type> may not contain other blocks. If multiple blocks apply to the same
5525 value the most specific block is used.
5527 The other statements specify the threshold to configure. They B<must> be
5528 included in a C<Type> block. Currently the following statements are recognized:
5532 =item B<FailureMax> I<Value>
5534 =item B<WarningMax> I<Value>
5536 Sets the upper bound of acceptable values. If unset defaults to positive
5537 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
5538 will be created. If the value is greater than B<WarningMax> but less than (or
5539 equal to) B<FailureMax> a B<WARNING> notification will be created.
5541 =item B<FailureMin> I<Value>
5543 =item B<WarningMin> I<Value>
5545 Sets the lower bound of acceptable values. If unset defaults to negative
5546 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
5547 be created. If the value is less than B<WarningMin> but greater than (or equal
5548 to) B<FailureMin> a B<WARNING> notification will be created.
5550 =item B<DataSource> I<DSName>
5552 Some data sets have more than one "data source". Interesting examples are the
5553 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
5554 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
5555 system load data set, C<load>, even has three data sources: C<shortterm>,
5556 C<midterm>, and C<longterm>.
5558 Normally, all data sources are checked against a configured threshold. If this
5559 is undesirable, or if you want to specify different limits for each data
5560 source, you can use the B<DataSource> option to have a threshold apply only to
5563 =item B<Invert> B<true>|B<false>
5565 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
5566 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
5567 B<WarningMax>) are not okay. Defaults to B<false>.
5569 =item B<Persist> B<true>|B<false>
5571 Sets how often notifications are generated. If set to B<true> one notification
5572 will be generated for each value that is out of the acceptable range. If set to
5573 B<false> (the default) then a notification is only generated if a value is out
5574 of range but the previous value was okay.
5576 This applies to missing values, too: If set to B<true> a notification about a
5577 missing value is generated once every B<Interval> seconds. If set to B<false>
5578 only one such notification is generated until the value appears again.
5580 =item B<Percentage> B<true>|B<false>
5582 If set to B<true>, the minimum and maximum values given are interpreted as
5583 percentage value, relative to the other data sources. This is helpful for
5584 example for the "df" type, where you may want to issue a warning when less than
5585 5E<nbsp>% of the total space is available. Defaults to B<false>.
5587 =item B<Hits> I<Number>
5589 Delay creating the notification until the threshold has been passed I<Number>
5590 times. When a notification has been generated, or when a subsequent value is
5591 inside the threshold, the counter is reset. If, for example, a value is
5592 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
5593 will be dispatched at most once every 30E<nbsp>seconds.
5595 This is useful when short bursts are not a problem. If, for example, 100% CPU
5596 usage for up to a minute is normal (and data is collected every
5597 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
5599 =item B<Hysteresis> I<Number>
5601 When set to non-zero, a hysteresis value is applied when checking minimum and
5602 maximum bounds. This is useful for values that increase slowly and fluctuate a
5603 bit while doing so. When these values come close to the threshold, they may
5604 "flap", i.e. switch between failure / warning case and okay case repeatedly.
5606 If, for example, the threshold is configures as
5611 then a I<Warning> notification is created when the value exceeds I<101> and the
5612 corresponding I<Okay> notification is only created once the value falls below
5613 I<99>, thus avoiding the "flapping".
5617 =head1 FILTER CONFIGURATION
5619 Starting with collectd 4.6 there is a powerful filtering infrastructure
5620 implemented in the daemon. The concept has mostly been copied from
5621 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
5622 terminology, so that users that are familiar with iptables feel right at home.
5626 The following are the terms used in the remainder of the filter configuration
5627 documentation. For an ASCII-art schema of the mechanism, see
5628 L<"General structure"> below.
5634 A I<match> is a criteria to select specific values. Examples are, of course, the
5635 name of the value or it's current value.
5637 Matches are implemented in plugins which you have to load prior to using the
5638 match. The name of such plugins starts with the "match_" prefix.
5642 A I<target> is some action that is to be performed with data. Such actions
5643 could, for example, be to change part of the value's identifier or to ignore
5644 the value completely.
5646 Some of these targets are built into the daemon, see L<"Built-in targets">
5647 below. Other targets are implemented in plugins which you have to load prior to
5648 using the target. The name of such plugins starts with the "target_" prefix.
5652 The combination of any number of matches and at least one target is called a
5653 I<rule>. The target actions will be performed for all values for which B<all>
5654 matches apply. If the rule does not have any matches associated with it, the
5655 target action will be performed for all values.
5659 A I<chain> is a list of rules and possibly default targets. The rules are tried
5660 in order and if one matches, the associated target will be called. If a value
5661 is handled by a rule, it depends on the target whether or not any subsequent
5662 rules are considered or if traversal of the chain is aborted, see
5663 L<"Flow control"> below. After all rules have been checked, the default targets
5668 =head2 General structure
5670 The following shows the resulting structure:
5677 +---------+ +---------+ +---------+ +---------+
5678 ! Rule !->! Match !->! Match !->! Target !
5679 +---------+ +---------+ +---------+ +---------+
5682 +---------+ +---------+ +---------+
5683 ! Rule !->! Target !->! Target !
5684 +---------+ +---------+ +---------+
5691 +---------+ +---------+ +---------+
5692 ! Rule !->! Match !->! Target !
5693 +---------+ +---------+ +---------+
5703 There are four ways to control which way a value takes through the filter
5710 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
5711 process the value with another chain. When the called chain finishes, usually
5712 the next target or rule after the jump is executed.
5716 The stop condition, signaled for example by the built-in target B<stop>, causes
5717 all processing of the value to be stopped immediately.
5721 Causes processing in the current chain to be aborted, but processing of the
5722 value generally will continue. This means that if the chain was called via
5723 B<Jump>, the next target or rule after the jump will be executed. If the chain
5724 was not called by another chain, control will be returned to the daemon and it
5725 may pass the value to another chain.
5729 Most targets will signal the B<continue> condition, meaning that processing
5730 should continue normally. There is no special built-in target for this
5737 The configuration reflects this structure directly:
5739 PostCacheChain "PostCache"
5741 <Rule "ignore_mysql_show">
5744 Type "^mysql_command$"
5745 TypeInstance "^show_"
5755 The above configuration example will ignore all values where the plugin field
5756 is "mysql", the type is "mysql_command" and the type instance begins with
5757 "show_". All other values will be sent to the C<rrdtool> write plugin via the
5758 default target of the chain. Since this chain is run after the value has been
5759 added to the cache, the MySQL C<show_*> command statistics will be available
5760 via the C<unixsock> plugin.
5762 =head2 List of configuration options
5766 =item B<PreCacheChain> I<ChainName>
5768 =item B<PostCacheChain> I<ChainName>
5770 Configure the name of the "pre-cache chain" and the "post-cache chain". The
5771 argument is the name of a I<chain> that should be executed before and/or after
5772 the values have been added to the cache.
5774 To understand the implications, it's important you know what is going on inside
5775 I<collectd>. The following diagram shows how values are passed from the
5776 read-plugins to the write-plugins:
5782 + - - - - V - - - - +
5783 : +---------------+ :
5786 : +-------+-------+ :
5789 : +-------+-------+ : +---------------+
5790 : ! Cache !--->! Value Cache !
5791 : ! insert ! : +---+---+-------+
5792 : +-------+-------+ : ! !
5793 : ! ,------------' !
5795 : +-------+---+---+ : +-------+-------+
5796 : ! Post-Cache +--->! Write-Plugins !
5797 : ! Chain ! : +---------------+
5798 : +---------------+ :
5801 + - - - - - - - - - +
5803 After the values are passed from the "read" plugins to the dispatch functions,
5804 the pre-cache chain is run first. The values are added to the internal cache
5805 afterwards. The post-cache chain is run after the values have been added to the
5806 cache. So why is it such a huge deal if chains are run before or after the
5807 values have been added to this cache?
5809 Targets that change the identifier of a value list should be executed before
5810 the values are added to the cache, so that the name in the cache matches the
5811 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
5812 this cache to receive a list of all available values. If you change the
5813 identifier after the value list has been added to the cache, this may easily
5814 lead to confusion, but it's not forbidden of course.
5816 The cache is also used to convert counter values to rates. These rates are, for
5817 example, used by the C<value> match (see below). If you use the rate stored in
5818 the cache B<before> the new value is added, you will use the old, B<previous>
5819 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
5820 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
5823 Last but not last, the B<stop> target makes a difference: If the pre-cache
5824 chain returns the stop condition, the value will not be added to the cache and
5825 the post-cache chain will not be run.
5827 =item B<Chain> I<Name>
5829 Adds a new chain with a certain name. This name can be used to refer to a
5830 specific chain, for example to jump to it.
5832 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
5834 =item B<Rule> [I<Name>]
5836 Adds a new rule to the current chain. The name of the rule is optional and
5837 currently has no meaning for the daemon.
5839 Within the B<Rule> block, there may be any number of B<Match> blocks and there
5840 must be at least one B<Target> block.
5842 =item B<Match> I<Name>
5844 Adds a match to a B<Rule> block. The name specifies what kind of match should
5845 be performed. Available matches depend on the plugins that have been loaded.
5847 The arguments inside the B<Match> block are passed to the plugin implementing
5848 the match, so which arguments are valid here depends on the plugin being used.
5849 If you do not need any to pass any arguments to a match, you can use the
5854 Which is equivalent to:
5859 =item B<Target> I<Name>
5861 Add a target to a rule or a default target to a chain. The name specifies what
5862 kind of target is to be added. Which targets are available depends on the
5863 plugins being loaded.
5865 The arguments inside the B<Target> block are passed to the plugin implementing
5866 the target, so which arguments are valid here depends on the plugin being used.
5867 If you do not need any to pass any arguments to a target, you can use the
5872 This is the same as writing:
5879 =head2 Built-in targets
5881 The following targets are built into the core daemon and therefore need no
5882 plugins to be loaded:
5888 Signals the "return" condition, see the L<"Flow control"> section above. This
5889 causes the current chain to stop processing the value and returns control to
5890 the calling chain. The calling chain will continue processing targets and rules
5891 just after the B<jump> target (see below). This is very similar to the
5892 B<RETURN> target of iptables, see L<iptables(8)>.
5894 This target does not have any options.
5902 Signals the "stop" condition, see the L<"Flow control"> section above. This
5903 causes processing of the value to be aborted immediately. This is similar to
5904 the B<DROP> target of iptables, see L<iptables(8)>.
5906 This target does not have any options.
5914 Sends the value to "write" plugins.
5920 =item B<Plugin> I<Name>
5922 Name of the write plugin to which the data should be sent. This option may be
5923 given multiple times to send the data to more than one write plugin.
5927 If no plugin is explicitly specified, the values will be sent to all available
5938 Starts processing the rules of another chain, see L<"Flow control"> above. If
5939 the end of that chain is reached, or a stop condition is encountered,
5940 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
5941 next target or the next rule. This is similar to the B<-j> command line option
5942 of iptables, see L<iptables(8)>.
5948 =item B<Chain> I<Name>
5950 Jumps to the chain I<Name>. This argument is required and may appear only once.
5962 =head2 Available matches
5968 Matches a value using regular expressions.
5974 =item B<Host> I<Regex>
5976 =item B<Plugin> I<Regex>
5978 =item B<PluginInstance> I<Regex>
5980 =item B<Type> I<Regex>
5982 =item B<TypeInstance> I<Regex>
5984 Match values where the given regular expressions match the various fields of
5985 the identifier of a value. If multiple regular expressions are given, B<all>
5986 regexen must match for a value to match.
5988 =item B<Invert> B<false>|B<true>
5990 When set to B<true>, the result of the match is inverted, i.e. all value lists
5991 where all regular expressions apply are not matched, all other value lists are
5992 matched. Defaults to B<false>.
5999 Host "customer[0-9]+"
6005 Matches values that have a time which differs from the time on the server.
6007 This match is mainly intended for servers that receive values over the
6008 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
6009 is very sensitive to the timestamp used when updating the RRD files. In
6010 particular, the time must be ever increasing. If a misbehaving client sends one
6011 packet with a timestamp far in the future, all further packets with a correct
6012 time will be ignored because of that one packet. What's worse, such corrupted
6013 RRD files are hard to fix.
6015 This match lets one match all values B<outside> a specified time range
6016 (relative to the server's time), so you can use the B<stop> target (see below)
6017 to ignore the value, for example.
6023 =item B<Future> I<Seconds>
6025 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
6026 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
6029 =item B<Past> I<Seconds>
6031 Matches all values that are I<behind> of the server's time by I<Seconds> or
6032 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
6044 This example matches all values that are five minutes or more ahead of the
6045 server or one hour (or more) lagging behind.
6049 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
6050 values. If a data-set consists of more than one data-source, all data-sources
6051 must match the specified ranges for a positive match.
6057 =item B<Min> I<Value>
6059 Sets the smallest value which still results in a match. If unset, behaves like
6062 =item B<Max> I<Value>
6064 Sets the largest value which still results in a match. If unset, behaves like
6067 =item B<Invert> B<true>|B<false>
6069 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
6070 no-match is returned and vice versa. Please note that the B<Invert> setting
6071 only effects how B<Min> and B<Max> are applied to a specific value. Especially
6072 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
6074 =item B<DataSource> I<DSName> [I<DSName> ...]
6076 Select one or more of the data sources. If no data source is configured, all
6077 data sources will be checked. If the type handled by the match does not have a
6078 data source of the specified name(s), this will always result in no match
6079 (independent of the B<Invert> setting).
6081 =item B<Satisfy> B<Any>|B<All>
6083 Specifies how checking with several data sources is performed. If set to
6084 B<Any>, the match succeeds if one of the data sources is in the configured
6085 range. If set to B<All> the match only succeeds if all data sources are within
6086 the configured range. Default is B<All>.
6088 Usually B<All> is used for positive matches, B<Any> is used for negative
6089 matches. This means that with B<All> you usually check that all values are in a
6090 "good" range, while with B<Any> you check if any value is within a "bad" range
6091 (or outside the "good" range).
6095 Either B<Min> or B<Max>, but not both, may be unset.
6099 # Match all values smaller than or equal to 100. Matches only if all data
6100 # sources are below 100.
6106 # Match if the value of any data source is outside the range of 0 - 100.
6114 =item B<empty_counter>
6116 Matches all values with one or more data sources of type B<COUNTER> and where
6117 all counter values are zero. These counters usually I<never> increased since
6118 they started existing (and are therefore uninteresting), or got reset recently
6119 or overflowed and you had really, I<really> bad luck.
6121 Please keep in mind that ignoring such counters can result in confusing
6122 behavior: Counters which hardly ever increase will be zero for long periods of
6123 time. If the counter is reset for some reason (machine or service restarted,
6124 usually), the graph will be empty (NAN) for a long time. People may not
6129 Calculates a hash value of the host name and matches values according to that
6130 hash value. This makes it possible to divide all hosts into groups and match
6131 only values that are in a specific group. The intended use is in load
6132 balancing, where you want to handle only part of all data and leave the rest
6135 The hashing function used tries to distribute the hosts evenly. First, it
6136 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
6139 for (i = 0; host[i] != 0; i++)
6140 hash_value = (hash_value * 251) + host[i];
6142 The constant 251 is a prime number which is supposed to make this hash value
6143 more random. The code then checks the group for this host according to the
6144 I<Total> and I<Match> arguments:
6146 if ((hash_value % Total) == Match)
6151 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
6152 groups), then the least significant bit of the hash value will be the XOR of
6153 all least significant bits in the host name. One consequence is that when you
6154 have two hosts, "server0.example.com" and "server1.example.com", where the host
6155 name differs in one digit only and the digits differ by one, those hosts will
6156 never end up in the same group.
6162 =item B<Match> I<Match> I<Total>
6164 Divide the data into I<Total> groups and match all hosts in group I<Match> as
6165 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
6166 be smaller than I<Total>. I<Total> must be at least one, although only values
6167 greater than one really do make any sense.
6169 You can repeat this option to match multiple groups, for example:
6174 The above config will divide the data into seven groups and match groups three
6175 and five. One use would be to keep every value on two hosts so that if one
6176 fails the missing data can later be reconstructed from the second host.
6182 # Operate on the pre-cache chain, so that ignored values are not even in the
6187 # Divide all received hosts in seven groups and accept all hosts in
6191 # If matched: Return and continue.
6194 # If not matched: Return and stop.
6200 =head2 Available targets
6204 =item B<notification>
6206 Creates and dispatches a notification.
6212 =item B<Message> I<String>
6214 This required option sets the message of the notification. The following
6215 placeholders will be replaced by an appropriate value:
6223 =item B<%{plugin_instance}>
6227 =item B<%{type_instance}>
6229 These placeholders are replaced by the identifier field of the same name.
6231 =item B<%{ds:>I<name>B<}>
6233 These placeholders are replaced by a (hopefully) human readable representation
6234 of the current rate of this data source. If you changed the instance name
6235 (using the B<set> or B<replace> targets, see below), it may not be possible to
6236 convert counter values to rates.
6240 Please note that these placeholders are B<case sensitive>!
6242 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
6244 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
6251 <Target "notification">
6252 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
6258 Replaces parts of the identifier using regular expressions.
6264 =item B<Host> I<Regex> I<Replacement>
6266 =item B<Plugin> I<Regex> I<Replacement>
6268 =item B<PluginInstance> I<Regex> I<Replacement>
6270 =item B<TypeInstance> I<Regex> I<Replacement>
6272 Match the appropriate field with the given regular expression I<Regex>. If the
6273 regular expression matches, that part that matches is replaced with
6274 I<Replacement>. If multiple places of the input buffer match a given regular
6275 expression, only the first occurrence will be replaced.
6277 You can specify each option multiple times to use multiple regular expressions
6285 # Replace "example.net" with "example.com"
6286 Host "\\<example.net\\>" "example.com"
6288 # Strip "www." from hostnames
6294 Sets part of the identifier of a value to a given string.
6300 =item B<Host> I<String>
6302 =item B<Plugin> I<String>
6304 =item B<PluginInstance> I<String>
6306 =item B<TypeInstance> I<String>
6308 Set the appropriate field to the given string. The strings for plugin instance
6309 and type instance may be empty, the strings for host and plugin may not be
6310 empty. It's currently not possible to set the type of a value this way.
6317 PluginInstance "coretemp"
6318 TypeInstance "core3"
6323 =head2 Backwards compatibility
6325 If you use collectd with an old configuration, i.E<nbsp>e. one without a
6326 B<Chain> block, it will behave as it used to. This is equivalent to the
6327 following configuration:
6333 If you specify a B<PostCacheChain>, the B<write> target will not be added
6334 anywhere and you will have to make sure that it is called where appropriate. We
6335 suggest to add the above snippet as default target to your "PostCache" chain.
6339 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
6355 L<collectd-exec(5)>,
6356 L<collectd-perl(5)>,
6357 L<collectd-unixsock(5)>,
6370 Florian Forster E<lt>octo@verplant.orgE<gt>