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<SetHost> I<Host>
322 =item B<SetPlugin> I<Plugin>
324 =item B<SetPluginInstance> I<PluginInstance>
326 =item B<SetTypeInstance> I<TypeInstance>
328 Sets the appropriate part of the identifier to the provided string.
330 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
331 will be replaced with the aggregation function, e.g. "average". Not including
332 the placeholder will result in duplication warnings and/or messed up values if
333 more than one aggregation function are enabled.
335 The following example calculates the average usage of all "even" CPUs:
337 <Plugin "aggregation">
340 PluginInstance "/[0,2,4,6,8]$/"
344 SetPluginInstance "even-%{aggregation}"
347 GroupBy "TypeInstance"
349 CalculateAverage true
353 This will create the files:
359 foo.example.com/cpu-even-average/cpu-idle
363 foo.example.com/cpu-even-average/cpu-system
367 foo.example.com/cpu-even-average/cpu-user
375 =item B<CalculateNum> B<true>|B<false>
377 =item B<CalculateSum> B<true>|B<false>
379 =item B<CalculateAverage> B<true>|B<false>
381 =item B<CalculateMinimum> B<true>|B<false>
383 =item B<CalculateMaximum> B<true>|B<false>
385 =item B<CalculateStddev> B<true>|B<false>
387 Boolean options for enabling calculation of the number of value lists, their
388 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
389 are disabled by default.
393 =head2 Plugin C<amqp>
395 The I<AMQMP plugin> can be used to communicate with other instances of
396 I<collectd> or third party applications using an AMQP message broker. Values
397 are sent to or received from the broker, which handles routing, queueing and
398 possibly filtering or messages.
401 # Send values to an AMQP broker
402 <Publish "some_name">
408 Exchange "amq.fanout"
409 # ExchangeType "fanout"
410 # RoutingKey "collectd"
414 # GraphitePrefix "collectd."
415 # GraphiteEscapeChar "_"
418 # Receive values from an AMQP broker
419 <Subscribe "some_name">
425 Exchange "amq.fanout"
426 # ExchangeType "fanout"
428 # RoutingKey "collectd.#"
432 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
433 blocks, which configure sending and receiving of values respectively. The two
434 blocks are very similar, so unless otherwise noted, an option can be used in
435 either block. The name given in the blocks starting tag is only used for
436 reporting messages, but may be used to support I<flushing> of certain
437 I<Publish> blocks in the future.
441 =item B<Host> I<Host>
443 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
444 the underlying communications library, I<rabbitmq-c>, which is "localhost".
446 =item B<Port> I<Port>
448 Service name or port number on which the AMQP broker accepts connections. This
449 argument must be a string, even if the numeric form is used. Defaults to
452 =item B<VHost> I<VHost>
454 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
456 =item B<User> I<User>
458 =item B<Password> I<Password>
460 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
463 =item B<Exchange> I<Exchange>
465 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
466 By default, "amq.fanout" will be used.
468 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
469 the given exchange and the I<queue> is created, using the I<routing key> if
470 configured. See the B<Queue> and B<RoutingKey> options below.
472 =item B<ExchangeType> I<Type>
474 If given, the plugin will try to create the configured I<exchange> with this
475 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
476 be bound to this exchange.
478 =item B<Queue> I<Queue> (Subscribe only)
480 Configures the I<queue> name to subscribe to. If no queue name was configures
481 explicitly, a unique queue name will be created by the broker.
483 =item B<RoutingKey> I<Key>
485 In I<Publish> blocks, this configures the routing key to set on all outgoing
486 messages. If not given, the routing key will be computed from the I<identifier>
487 of the value. The host, plugin, type and the two instances are concatenated
488 together using dots as the separator and all containing dots replaced with
489 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
490 possible to receive only specific values using a "topic" exchange.
492 In I<Subscribe> blocks, configures the I<routing key> used when creating a
493 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
494 used to filter messages when using a "topic" exchange. If you're only
495 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
498 =item B<Persistent> B<true>|B<false> (Publish only)
500 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
501 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
502 default), the I<transient> delivery mode will be used, i.e. messages may be
503 lost due to high load, overflowing queues or similar issues.
505 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
507 Selects the format in which messages are sent to the broker. If set to
508 B<Command> (the default), values are sent as C<PUTVAL> commands which are
509 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
510 case, the C<Content-Type> header field will be set to C<text/collectd>.
512 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
513 an easy and straight forward exchange format. The C<Content-Type> header field
514 will be set to C<application/json>.
516 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
517 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
520 A subscribing client I<should> use the C<Content-Type> header field to
521 determine how to decode the values. Currently, the I<AMQP plugin> itself can
522 only decode the B<Command> format.
524 =item B<StoreRates> B<true>|B<false> (Publish only)
526 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
527 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
528 default), no conversion is performed. Otherwise the conversion is performed
529 using the internal value cache.
531 Please note that currently this option is only used if the B<Format> option has
534 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
536 A prefix can be added in the metric name when outputting in the I<Graphite> format.
537 It's added before the I<Host> name.
538 Metric name will be "<prefix><host><postfix><plugin><type><name>"
540 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
542 A postfix can be added in the metric name when outputting in the I<Graphite> format.
543 It's added after the I<Host> name.
544 Metric name will be "<prefix><host><postfix><plugin><type><name>"
546 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
548 Specify a character to replace dots (.) in the host part of the metric name.
549 In I<Graphite> metric name, dots are used as separators between different
550 metric parts (host, plugin, type).
551 Default is "_" (I<Underscore>).
555 =head2 Plugin C<apache>
557 To configure the C<apache>-plugin you first need to configure the Apache
558 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
559 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
560 the following snipped to base your Apache config upon:
563 <IfModule mod_status.c>
564 <Location /mod_status>
565 SetHandler server-status
569 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
570 also supported. It introduces a new field, called C<BusyServers>, to count the
571 number of currently connected clients. This field is also supported.
573 The configuration of the I<Apache> plugin consists of one or more
574 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
575 as the instance name. For example:
579 URL "http://www1.example.com/mod_status?auto"
582 URL "http://www2.example.com/mod_status?auto"
586 The instance name will be used as the I<plugin instance>. To emulate the old
587 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
588 plugin to work correctly, each instance name must be unique. This is not
589 enforced by the plugin and it is your responsibility to ensure it.
591 The following options are accepted within each I<Instance> block:
595 =item B<URL> I<http://host/mod_status?auto>
597 Sets the URL of the C<mod_status> output. This needs to be the output generated
598 by C<ExtendedStatus on> and it needs to be the machine readable output
599 generated by appending the C<?auto> argument. This option is I<mandatory>.
601 =item B<User> I<Username>
603 Optional user name needed for authentication.
605 =item B<Password> I<Password>
607 Optional password needed for authentication.
609 =item B<VerifyPeer> B<true|false>
611 Enable or disable peer SSL certificate verification. See
612 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
614 =item B<VerifyHost> B<true|false>
616 Enable or disable peer host name verification. If enabled, the plugin checks
617 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
618 certificate matches the host name provided by the B<URL> option. If this
619 identity check fails, the connection is aborted. Obviously, only works when
620 connecting to a SSL enabled server. Enabled by default.
622 =item B<CACert> I<File>
624 File that holds one or more SSL certificates. If you want to use HTTPS you will
625 possibly need this option. What CA certificates come bundled with C<libcurl>
626 and are checked by default depends on the distribution you use.
630 =head2 Plugin C<apcups>
634 =item B<Host> I<Hostname>
636 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
637 that IPv6 support has been disabled unless someone can confirm or decline that
638 B<apcupsd> can handle it.
640 =item B<Port> I<Port>
642 TCP-Port to connect to. Defaults to B<3551>.
644 =item B<ReportSeconds> B<true|false>
646 If set to B<true>, the time reported in the C<timeleft> metric will be
647 converted to seconds. This is the recommended setting. If set to B<false>, the
648 default for backwards compatibility, the time will be reported in minutes.
652 =head2 Plugin C<ascent>
654 This plugin collects information about an Ascent server, a free server for the
655 "World of Warcraft" game. This plugin gathers the information by fetching the
656 XML status page using C<libcurl> and parses it using C<libxml2>.
658 The configuration options are the same as for the C<apache> plugin above:
662 =item B<URL> I<http://localhost/ascent/status/>
664 Sets the URL of the XML status output.
666 =item B<User> I<Username>
668 Optional user name needed for authentication.
670 =item B<Password> I<Password>
672 Optional password needed for authentication.
674 =item B<VerifyPeer> B<true|false>
676 Enable or disable peer SSL certificate verification. See
677 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
679 =item B<VerifyHost> B<true|false>
681 Enable or disable peer host name verification. If enabled, the plugin checks
682 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
683 certificate matches the host name provided by the B<URL> option. If this
684 identity check fails, the connection is aborted. Obviously, only works when
685 connecting to a SSL enabled server. Enabled by default.
687 =item B<CACert> I<File>
689 File that holds one or more SSL certificates. If you want to use HTTPS you will
690 possibly need this option. What CA certificates come bundled with C<libcurl>
691 and are checked by default depends on the distribution you use.
695 =head2 Plugin C<bind>
697 Starting with BIND 9.5.0, the most widely used DNS server software provides
698 extensive statistics about queries, responses and lots of other information.
699 The bind plugin retrieves this information that's encoded in XML and provided
700 via HTTP and submits the values to collectd.
702 To use this plugin, you first need to tell BIND to make this information
703 available. This is done with the C<statistics-channels> configuration option:
705 statistics-channels {
706 inet localhost port 8053;
709 The configuration follows the grouping that can be seen when looking at the
710 data with an XSLT compatible viewer, such as a modern web browser. It's
711 probably a good idea to make yourself familiar with the provided values, so you
712 can understand what the collected statistics actually mean.
717 URL "http://localhost:8053/"
732 Zone "127.in-addr.arpa/IN"
736 The bind plugin accepts the following configuration options:
742 URL from which to retrieve the XML data. If not specified,
743 C<http://localhost:8053/> will be used.
745 =item B<ParseTime> B<true>|B<false>
747 When set to B<true>, the time provided by BIND will be parsed and used to
748 dispatch the values. When set to B<false>, the local time source is queried.
750 This setting is set to B<true> by default for backwards compatibility; setting
751 this to B<false> is I<recommended> to avoid problems with timezones and
754 =item B<OpCodes> B<true>|B<false>
756 When enabled, statistics about the I<"OpCodes">, for example the number of
757 C<QUERY> packets, are collected.
761 =item B<QTypes> B<true>|B<false>
763 When enabled, the number of I<incoming> queries by query types (for example
764 C<A>, C<MX>, C<AAAA>) is collected.
768 =item B<ServerStats> B<true>|B<false>
770 Collect global server statistics, such as requests received over IPv4 and IPv6,
771 successful queries, and failed updates.
775 =item B<ZoneMaintStats> B<true>|B<false>
777 Collect zone maintenance statistics, mostly information about notifications
778 (zone updates) and zone transfers.
782 =item B<ResolverStats> B<true>|B<false>
784 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
785 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
786 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
787 default. Use the B<ResolverStats> option within a B<View "_default"> block
788 instead for the same functionality.
794 Collect global memory statistics.
798 =item B<View> I<Name>
800 Collect statistics about a specific I<"view">. BIND can behave different,
801 mostly depending on the source IP-address of the request. These different
802 configurations are called "views". If you don't use this feature, you most
803 likely are only interested in the C<_default> view.
805 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
806 information you want to collect about a view. If no B<View> block is
807 configured, no detailed view statistics will be collected.
811 =item B<QTypes> B<true>|B<false>
813 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
818 =item B<ResolverStats> B<true>|B<false>
820 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
821 (e.E<nbsp>g. queries over IPv4, lame servers).
825 =item B<CacheRRSets> B<true>|B<false>
827 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
828 type is collected. Negative entries (queries which resulted in an error, for
829 example names that do not exist) are reported with a leading exclamation mark,
834 =item B<Zone> I<Name>
836 When given, collect detailed information about the given zone in the view. The
837 information collected if very similar to the global B<ServerStats> information
840 You can repeat this option to collect detailed information about multiple
843 By default no detailed zone information is collected.
849 =head2 Plugin C<cpufreq>
851 This plugin doesn't have any options. It reads
852 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
853 installed) to get the current CPU frequency. If this file does not exist make
854 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
855 installed and an "cpu governor" (that's a kernel module) is loaded.
861 =item B<DataDir> I<Directory>
863 Set the directory to store CSV-files under. Per default CSV-files are generated
864 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
865 The special strings B<stdout> and B<stderr> can be used to write to the standard
866 output and standard error channels, respectively. This, of course, only makes
867 much sense when collectd is running in foreground- or non-daemon-mode.
869 =item B<StoreRates> B<true|false>
871 If set to B<true>, convert counter values to rates. If set to B<false> (the
872 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
877 =head2 Plugin C<curl>
879 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
880 and the match infrastructure (the same code used by the tail plugin) to use
881 regular expressions with the received data.
883 The following example will read the current value of AMD stock from Google's
884 finance page and dispatch the value to collectd.
887 <Page "stock_quotes">
888 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
892 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
893 DSType "GaugeAverage"
894 # Note: `stock_value' is not a standard type.
901 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
902 a web page and one or more "matches" to be performed on the returned data. The
903 string argument to the B<Page> block is used as plugin instance.
905 The following options are valid within B<Page> blocks:
911 URL of the web site to retrieve. Since a regular expression will be used to
912 extract information from this data, non-binary data is a big plus here ;)
914 =item B<User> I<Name>
916 Username to use if authorization is required to read the page.
918 =item B<Password> I<Password>
920 Password to use if authorization is required to read the page.
922 =item B<VerifyPeer> B<true>|B<false>
924 Enable or disable peer SSL certificate verification. See
925 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
927 =item B<VerifyHost> B<true>|B<false>
929 Enable or disable peer host name verification. If enabled, the plugin checks if
930 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
931 matches the host name provided by the B<URL> option. If this identity check
932 fails, the connection is aborted. Obviously, only works when connecting to a
933 SSL enabled server. Enabled by default.
935 =item B<CACert> I<file>
937 File that holds one or more SSL certificates. If you want to use HTTPS you will
938 possibly need this option. What CA certificates come bundled with C<libcurl>
939 and are checked by default depends on the distribution you use.
941 =item B<MeasureResponseTime> B<true>|B<false>
943 Measure response time for the request. If this setting is enabled, B<Match>
944 blocks (see below) are optional. Disabled by default.
946 =item B<E<lt>MatchE<gt>>
948 One or more B<Match> blocks that define how to match information in the data
949 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
950 used by the C<tail> plugin, so please see the documentation of the C<tail>
951 plugin below on how matches are defined. If the B<MeasureResponseTime> option
952 is set to B<true>, B<Match> blocks are optional.
956 =head2 Plugin C<curl_json>
958 The B<curl_json plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and
959 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) to retrieve JSON data
960 via cURL. This can be used to collect values from CouchDB documents (which are
961 stored JSON notation), for example.
963 The following example will collect several values from the built-in `_stats'
964 runtime statistics module of CouchDB
965 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
968 <URL "http://localhost:5984/_stats">
970 <Key "httpd/requests/count">
974 <Key "httpd_request_methods/*/count">
975 Type "http_request_methods"
978 <Key "httpd_status_codes/*/count">
979 Type "http_response_codes"
984 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining
985 a URL to be fetched via HTTP (using libcurl) and one or more B<Key> blocks.
986 The B<Key> string argument must be in a path format, which is used to collect a
987 value from a JSON map object. If a path element of B<Key> is the
988 I<*>E<nbsp>wildcard, the values for all keys will be collectd.
990 The following options are valid within B<URL> blocks:
994 =item B<Instance> I<Instance>
996 Sets the plugin instance to I<Instance>.
998 =item B<User> I<Name>
1000 Username to use if authorization is required to read the page.
1002 =item B<Password> I<Password>
1004 Password to use if authorization is required to read the page.
1006 =item B<VerifyPeer> B<true>|B<false>
1008 Enable or disable peer SSL certificate verification. See
1009 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1011 =item B<VerifyHost> B<true>|B<false>
1013 Enable or disable peer host name verification. If enabled, the plugin checks if
1014 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1015 matches the host name provided by the B<URL> option. If this identity check
1016 fails, the connection is aborted. Obviously, only works when connecting to a
1017 SSL enabled server. Enabled by default.
1019 =item B<CACert> I<file>
1021 File that holds one or more SSL certificates. If you want to use HTTPS you will
1022 possibly need this option. What CA certificates come bundled with C<libcurl>
1023 and are checked by default depends on the distribution you use.
1027 The following options are valid within B<Key> blocks:
1031 =item B<Type> I<Type>
1033 Sets the type used to dispatch the values to the daemon. Detailed information
1034 about types and their configuration can be found in L<types.db(5)>. This
1035 option is mandatory.
1037 =item B<Instance> I<Instance>
1039 Type-instance to use. Defaults to the current map key or current string array element value.
1043 =head2 Plugin C<curl_xml>
1045 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1046 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1049 <URL "http://localhost/stats.xml">
1051 Instance "some_instance"
1056 CACert "/path/to/ca.crt"
1058 <XPath "table[@id=\"magic_level\"]/tr">
1060 #InstancePrefix "prefix-"
1061 InstanceFrom "td[1]"
1062 ValuesFrom "td[2]/span[@class=\"level\"]"
1067 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1068 URL to be fetched using libcurl. Within each B<URL> block there are
1069 options which specify the connection parameters, for example authentication
1070 information, and one or more B<XPath> blocks.
1072 Each B<XPath> block specifies how to get one type of information. The
1073 string argument must be a valid XPath expression which returns a list
1074 of "base elements". One value is dispatched for each "base element". The
1075 I<type instance> and values are looked up using further I<XPath> expressions
1076 that should be relative to the base element.
1078 Within the B<URL> block the following options are accepted:
1082 =item B<Host> I<Name>
1084 Use I<Name> as the host name when submitting values. Defaults to the global
1087 =item B<Instance> I<Instance>
1089 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1090 empty string (no plugin instance).
1092 =item B<User> I<User>
1093 =item B<Password> I<Password>
1094 =item B<VerifyPeer> B<true>|B<false>
1095 =item B<VerifyHost> B<true>|B<false>
1096 =item B<CACert> I<CA Cert File>
1098 These options behave exactly equivalent to the appropriate options of the
1099 I<cURL> and I<cURL-JSON> plugins. Please see there for a detailed description.
1101 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1103 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1104 B<XPath> block specifies how to get one type of information. The string
1105 argument must be a valid XPath expression which returns a list of "base
1106 elements". One value is dispatched for each "base element".
1108 Within the B<XPath> block the following options are accepted:
1112 =item B<Type> I<Type>
1114 Specifies the I<Type> used for submitting patches. This determines the number
1115 of values that are required / expected and whether the strings are parsed as
1116 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1117 This option is required.
1119 =item B<InstancePrefix> I<InstancePrefix>
1121 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1122 concatenated together without any separator.
1123 This option is optional.
1125 =item B<InstanceFrom> I<InstanceFrom>
1127 Specifies a XPath expression to use for determining the I<type instance>. The
1128 XPath expression must return exactly one element. The element's value is then
1129 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1131 This value is required. As a special exception, if the "base XPath expression"
1132 (the argument to the B<XPath> block) returns exactly one argument, then this
1133 option may be omitted.
1135 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1137 Specifies one or more XPath expression to use for reading the values. The
1138 number of XPath expressions must match the number of data sources in the
1139 I<type> specified with B<Type> (see above). Each XPath expression must return
1140 exactly one element. The element's value is then parsed as a number and used as
1141 value for the appropriate value in the value list dispatched to the daemon.
1147 =head2 Plugin C<dbi>
1149 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1150 connect to various databases, execute I<SQL> statements and read back the
1151 results. I<dbi> is an acronym for "database interface" in case you were
1152 wondering about the name. You can configure how each column is to be
1153 interpreted and the plugin will generate one or more data sets from each row
1154 returned according to these rules.
1156 Because the plugin is very generic, the configuration is a little more complex
1157 than those of other plugins. It usually looks something like this:
1160 <Query "out_of_stock">
1161 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1162 # Use with MySQL 5.0.0 or later
1166 InstancePrefix "out_of_stock"
1167 InstancesFrom "category"
1171 <Database "product_information">
1173 DriverOption "host" "localhost"
1174 DriverOption "username" "collectd"
1175 DriverOption "password" "aZo6daiw"
1176 DriverOption "dbname" "prod_info"
1177 SelectDB "prod_info"
1178 Query "out_of_stock"
1182 The configuration above defines one query with one result and one database. The
1183 query is then linked to the database with the B<Query> option I<within> the
1184 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1185 and you can also use the B<Include> statement to split up the configuration
1186 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1187 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1190 The following is a complete list of options:
1192 =head3 B<Query> blocks
1194 Query blocks define I<SQL> statements and how the returned data should be
1195 interpreted. They are identified by the name that is given in the opening line
1196 of the block. Thus the name needs to be unique. Other than that, the name is
1197 not used in collectd.
1199 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1200 define which column holds which value or instance information. You can use
1201 multiple B<Result> blocks to create multiple values from one returned row. This
1202 is especially useful, when queries take a long time and sending almost the same
1203 query again and again is not desirable.
1207 <Query "environment">
1208 Statement "select station, temperature, humidity from environment"
1211 # InstancePrefix "foo"
1212 InstancesFrom "station"
1213 ValuesFrom "temperature"
1217 InstancesFrom "station"
1218 ValuesFrom "humidity"
1222 The following options are accepted:
1226 =item B<Statement> I<SQL>
1228 Sets the statement that should be executed on the server. This is B<not>
1229 interpreted by collectd, but simply passed to the database server. Therefore,
1230 the SQL dialect that's used depends on the server collectd is connected to.
1232 The query has to return at least two columns, one for the instance and one
1233 value. You cannot omit the instance, even if the statement is guaranteed to
1234 always return exactly one line. In that case, you can usually specify something
1237 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1239 (That works with MySQL but may not be valid SQL according to the spec. If you
1240 use a more strict database server, you may have to select from a dummy table or
1243 Please note that some databases, for example B<Oracle>, will fail if you
1244 include a semicolon at the end of the statement.
1246 =item B<MinVersion> I<Version>
1248 =item B<MaxVersion> I<Value>
1250 Only use this query for the specified database version. You can use these
1251 options to provide multiple queries with the same name but with a slightly
1252 different syntax. The plugin will use only those queries, where the specified
1253 minimum and maximum versions fit the version of the database in use.
1255 The database version is determined by C<dbi_conn_get_engine_version>, see the
1256 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1257 for details. Basically, each part of the version is assumed to be in the range
1258 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1259 "40102", version "5.0.42" becomes "50042".
1261 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1262 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1263 happen. Don't to it! A valid example would be something along these lines:
1274 In the above example, there are three ranges that don't overlap. The last one
1275 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1276 before "4.0.0" are not specified.
1278 =item B<Type> I<Type>
1280 The B<type> that's used for each line returned. See L<types.db(5)> for more
1281 details on how types are defined. In short: A type is a predefined layout of
1282 data and the number of values and type of values has to match the type
1285 If you specify "temperature" here, you need exactly one gauge column. If you
1286 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1289 There must be exactly one B<Type> option inside each B<Result> block.
1291 =item B<InstancePrefix> I<prefix>
1293 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1294 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1295 all strings returned in the appropriate columns are concatenated together,
1296 separated by dashes I<("-")>.
1298 =item B<InstancesFrom> I<column0> [I<column1> ...]
1300 Specifies the columns whose values will be used to create the "type-instance"
1301 for each row. If you specify more than one column, the value of all columns
1302 will be joined together with dashes I<("-")> as separation characters.
1304 The plugin itself does not check whether or not all built instances are
1305 different. It's your responsibility to assure that each is unique. This is
1306 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1307 sure that only one row is returned in this case.
1309 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1312 =item B<ValuesFrom> I<column0> [I<column1> ...]
1314 Names the columns whose content is used as the actual data for the data sets
1315 that are dispatched to the daemon. How many such columns you need is determined
1316 by the B<Type> setting above. If you specify too many or not enough columns,
1317 the plugin will complain about that and no data will be submitted to the
1320 The actual data type in the columns is not that important. The plugin will
1321 automatically cast the values to the right type if it know how to do that. So
1322 it should be able to handle integer an floating point types, as well as strings
1323 (if they include a number at the beginning).
1325 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1329 =head3 B<Database> blocks
1331 Database blocks define a connection to a database and which queries should be
1332 sent to that database. Since the used "dbi" library can handle a wide variety
1333 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1334 documentationE<nbsp>- we stick as close to the terminology used there.
1336 Each database needs a "name" as string argument in the starting tag of the
1337 block. This name will be used as "PluginInstance" in the values submitted to
1338 the daemon. Other than that, that name is not used.
1342 =item B<Driver> I<Driver>
1344 Specifies the driver to use to connect to the database. In many cases those
1345 drivers are named after the database they can connect to, but this is not a
1346 technical necessity. These drivers are sometimes referred to as "DBD",
1347 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1348 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1349 project at L<http://libdbi-drivers.sourceforge.net/>.
1351 You need to give the driver name as expected by the "dbi" library here. You
1352 should be able to find that in the documentation for each driver. If you
1353 mistype the driver name, the plugin will dump a list of all known driver names
1356 =item B<DriverOption> I<Key> I<Value>
1358 Sets driver-specific options. What option a driver supports can be found in the
1359 documentation for each driver, somewhere at
1360 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1361 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1363 DBDs can register two types of options: String options and numeric options. The
1364 plugin will use the C<dbi_conn_set_option> function when the configuration
1365 provides a string and the C<dbi_conn_require_option_numeric> function when the
1366 configuration provides a number. So these two lines will actually result in
1367 different calls being used:
1369 DriverOption "Port" 1234 # numeric
1370 DriverOption "Port" "1234" # string
1372 Unfortunately, drivers are not too keen to report errors when an unknown option
1373 is passed to them, so invalid settings here may go unnoticed. This is not the
1374 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1375 the driver. If a driver complains about an option, the plugin will dump a
1376 complete list of all options understood by that driver to the log. There is no
1377 way to programatically find out if an option expects a string or a numeric
1378 argument, so you will have to refer to the appropriate DBD's documentation to
1379 find this out. Sorry.
1381 =item B<SelectDB> I<Database>
1383 In some cases, the database name you connect with is not the database name you
1384 want to use for querying data. If this option is set, the plugin will "select"
1385 (switch to) that database after the connection is established.
1387 =item B<Query> I<QueryName>
1389 Associates the query named I<QueryName> with this database connection. The
1390 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1391 blocks you want to refer to must be placed above the database block you want to
1394 =item B<Host> I<Hostname>
1396 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
1397 values. Defaults to the global hostname setting.
1405 =item B<Device> I<Device>
1407 Select partitions based on the devicename.
1409 =item B<MountPoint> I<Directory>
1411 Select partitions based on the mountpoint.
1413 =item B<FSType> I<FSType>
1415 Select partitions based on the filesystem type.
1417 =item B<IgnoreSelected> B<true>|B<false>
1419 Invert the selection: If set to true, all partitions B<except> the ones that
1420 match any one of the criteria are collected. By default only selected
1421 partitions are collected if a selection is made. If no selection is configured
1422 at all, B<all> partitions are selected.
1424 =item B<ReportByDevice> B<true>|B<false>
1426 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1427 (the default), it will report a disk as "root", but with it I<true>, it will be
1428 "sda1" (or whichever).
1430 =item B<ReportInodes> B<true>|B<false>
1432 Enables or disables reporting of free, reserved and used inodes. Defaults to
1433 inode collection being disabled.
1435 Enable this option if inodes are a scarce resource for you, usually because
1436 many small files are stored on the disk. This is a usual scenario for mail
1437 transfer agents and web caches.
1441 =head2 Plugin C<disk>
1443 The C<disk> plugin collects information about the usage of physical disks and
1444 logical disks (partitions). Values collected are the number of octets written
1445 to and read from a disk or partition, the number of read/write operations
1446 issued to the disk and a rather complex "time" it took for these commands to be
1449 Using the following two options you can ignore some disks or configure the
1450 collection only of specific disks.
1454 =item B<Disk> I<Name>
1456 Select the disk I<Name>. Whether it is collected or ignored depends on the
1457 B<IgnoreSelected> setting, see below. As with other plugins that use the
1458 daemon's ignorelist functionality, a string that starts and ends with a slash
1459 is interpreted as a regular expression. Examples:
1464 =item B<IgnoreSelected> B<true>|B<false>
1466 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1467 statements, are ignored or if all other disks are ignored. The behavior
1468 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1469 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1470 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1471 is set to B<true>, all disks are collected B<except> the ones matched.
1475 =head2 Plugin C<dns>
1479 =item B<Interface> I<Interface>
1481 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1482 option sets the interface that should be used. If this option is not set, or
1483 set to "any", the plugin will try to get packets from B<all> interfaces. This
1484 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1486 =item B<IgnoreSource> I<IP-address>
1488 Ignore packets that originate from this address.
1490 =item B<SelectNumericQueryTypes> B<true>|B<false>
1492 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1496 =head2 Plugin C<email>
1500 =item B<SocketFile> I<Path>
1502 Sets the socket-file which is to be created.
1504 =item B<SocketGroup> I<Group>
1506 If running as root change the group of the UNIX-socket after it has been
1507 created. Defaults to B<collectd>.
1509 =item B<SocketPerms> I<Permissions>
1511 Change the file permissions of the UNIX-socket after it has been created. The
1512 permissions must be given as a numeric, octal value as you would pass to
1513 L<chmod(1)>. Defaults to B<0770>.
1515 =item B<MaxConns> I<Number>
1517 Sets the maximum number of connections that can be handled in parallel. Since
1518 this many threads will be started immediately setting this to a very high
1519 value will waste valuable resources. Defaults to B<5> and will be forced to be
1520 at most B<16384> to prevent typos and dumb mistakes.
1524 =head2 Plugin C<ethstat>
1526 The I<ethstat plugin> collects information about network interface cards (NICs)
1527 by talking directly with the underlying kernel driver using L<ioctl(2)>.
1533 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
1534 Map "multicast" "if_multicast"
1541 =item B<Interface> I<Name>
1543 Collect statistical information about interface I<Name>.
1545 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
1547 By default, the plugin will submit values as type C<derive> and I<type
1548 instance> set to I<Name>, the name of the metric as reported by the driver. If
1549 an appropriate B<Map> option exists, the given I<Type> and, optionally,
1550 I<TypeInstance> will be used.
1552 =item B<MappedOnly> B<true>|B<false>
1554 When set to B<true>, only metrics that can be mapped to to a I<type> will be
1555 collected, all other metrics will be ignored. Defaults to B<false>.
1559 =head2 Plugin C<exec>
1561 Please make sure to read L<collectd-exec(5)> before using this plugin. It
1562 contains valuable information on when the executable is executed and the
1563 output that is expected from it.
1567 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1569 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1571 Execute the executable I<Executable> as user I<User>. If the user name is
1572 followed by a colon and a group name, the effective group is set to that group.
1573 The real group and saved-set group will be set to the default group of that
1574 user. If no group is given the effective group ID will be the same as the real
1577 Please note that in order to change the user and/or group the daemon needs
1578 superuser privileges. If the daemon is run as an unprivileged user you must
1579 specify the same user/group here. If the daemon is run with superuser
1580 privileges, you must supply a non-root user here.
1582 The executable may be followed by optional arguments that are passed to the
1583 program. Please note that due to the configuration parsing numbers and boolean
1584 values may be changed. If you want to be absolutely sure that something is
1585 passed as-is please enclose it in quotes.
1587 The B<Exec> and B<NotificationExec> statements change the semantics of the
1588 programs executed, i.E<nbsp>e. the data passed to them and the response
1589 expected from them. This is documented in great detail in L<collectd-exec(5)>.
1593 =head2 Plugin C<filecount>
1595 The C<filecount> plugin counts the number of files in a certain directory (and
1596 its subdirectories) and their combined size. The configuration is very straight
1599 <Plugin "filecount">
1600 <Directory "/var/qmail/queue/mess">
1601 Instance "qmail-message"
1603 <Directory "/var/qmail/queue/todo">
1604 Instance "qmail-todo"
1606 <Directory "/var/lib/php5">
1607 Instance "php5-sessions"
1612 The example above counts the number of files in QMail's queue directories and
1613 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
1614 QMail has not yet looked at, the "message" queue holds the messages that were
1615 classified into "local" and "remote".
1617 As you can see, the configuration consists of one or more C<Directory> blocks,
1618 each of which specifies a directory in which to count the files. Within those
1619 blocks, the following options are recognized:
1623 =item B<Instance> I<Instance>
1625 Sets the plugin instance to I<Instance>. That instance name must be unique, but
1626 it's your responsibility, the plugin doesn't check for that. If not given, the
1627 instance is set to the directory name with all slashes replaced by underscores
1628 and all leading underscores removed.
1630 =item B<Name> I<Pattern>
1632 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
1633 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
1634 against the pattern, not the entire path. In case this makes it easier for you:
1635 This option has been named after the B<-name> parameter to L<find(1)>.
1637 =item B<MTime> I<Age>
1639 Count only files of a specific age: If I<Age> is greater than zero, only files
1640 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
1641 a negative number, this is inversed. For example, if B<-60> is specified, only
1642 files that have been modified in the last minute will be counted.
1644 The number can also be followed by a "multiplier" to easily specify a larger
1645 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
1646 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
1647 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
1648 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
1649 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
1652 =item B<Size> I<Size>
1654 Count only files of a specific size. When I<Size> is a positive number, only
1655 files that are at least this big are counted. If I<Size> is a negative number,
1656 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
1657 I<Size> are counted.
1659 As with the B<MTime> option, a "multiplier" may be added. For a detailed
1660 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
1661 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
1662 note that there are 1000 bytes in a kilobyte, not 1024.
1664 =item B<Recursive> I<true>|I<false>
1666 Controls whether or not to recurse into subdirectories. Enabled by default.
1668 =item B<IncludeHidden> I<true>|I<false>
1670 Controls whether or not to include "hidden" files and directories in the count.
1671 "Hidden" files and directories are those, whose name begins with a dot.
1672 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
1676 =head2 Plugin C<GenericJMX>
1678 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
1679 L<collectd-java(5)>.
1681 =head2 Plugin C<gmond>
1683 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
1684 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
1685 are built-in, custom mappings may be added via B<Metric> blocks, see below.
1690 MCReceiveFrom "239.2.11.71" "8649"
1691 <Metric "swap_total">
1693 TypeInstance "total"
1696 <Metric "swap_free">
1703 The following metrics are built-in:
1709 load_one, load_five, load_fifteen
1713 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
1717 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
1729 Available configuration options:
1733 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
1735 Sets sets the multicast group and UDP port to which to subscribe.
1737 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
1739 =item E<lt>B<Metric> I<Name>E<gt>
1741 These blocks add a new metric conversion to the internal table. I<Name>, the
1742 string argument to the B<Metric> block, is the metric name as used by Ganglia.
1746 =item B<Type> I<Type>
1748 Type to map this metric to. Required.
1750 =item B<TypeInstance> I<Instance>
1752 Type-instance to use. Optional.
1754 =item B<DataSource> I<Name>
1756 Data source to map this metric to. If the configured type has exactly one data
1757 source, this is optional. Otherwise the option is required.
1763 =head2 Plugin C<hddtemp>
1765 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
1766 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
1767 default values, see below. C<hddtemp> has to be running to work correctly. If
1768 C<hddtemp> is not running timeouts may appear which may interfere with other
1771 The B<hddtemp> homepage can be found at
1772 L<http://www.guzu.net/linux/hddtemp.php>.
1776 =item B<Host> I<Hostname>
1778 Hostname to connect to. Defaults to B<127.0.0.1>.
1780 =item B<Port> I<Port>
1782 TCP-Port to connect to. Defaults to B<7634>.
1786 =head2 Plugin C<interface>
1790 =item B<Interface> I<Interface>
1792 Select this interface. By default these interfaces will then be collected. For
1793 a more detailed description see B<IgnoreSelected> below.
1795 =item B<IgnoreSelected> I<true>|I<false>
1797 If no configuration if given, the B<traffic>-plugin will collect data from
1798 all interfaces. This may not be practical, especially for loopback- and
1799 similar interfaces. Thus, you can use the B<Interface>-option to pick the
1800 interfaces you're interested in. Sometimes, however, it's easier/preferred
1801 to collect all interfaces I<except> a few ones. This option enables you to
1802 do that: By setting B<IgnoreSelected> to I<true> the effect of
1803 B<Interface> is inverted: All selected interfaces are ignored and all
1804 other interfaces are collected.
1808 =head2 Plugin C<ipmi>
1812 =item B<Sensor> I<Sensor>
1814 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
1816 =item B<IgnoreSelected> I<true>|I<false>
1818 If no configuration if given, the B<ipmi> plugin will collect data from all
1819 sensors found of type "temperature", "voltage", "current" and "fanspeed".
1820 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
1821 the effect of B<Sensor> is inverted: All selected sensors are ignored and
1822 all other sensors are collected.
1824 =item B<NotifySensorAdd> I<true>|I<false>
1826 If a sensor appears after initialization time of a minute a notification
1829 =item B<NotifySensorRemove> I<true>|I<false>
1831 If a sensor disappears a notification is sent.
1833 =item B<NotifySensorNotPresent> I<true>|I<false>
1835 If you have for example dual power supply and one of them is (un)plugged then
1836 a notification is sent.
1840 =head2 Plugin C<iptables>
1844 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
1846 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
1847 will collect the counters of all rules which have a comment-match. The comment
1848 is then used as type-instance.
1850 If I<Comment> or I<Number> is given, only the rule with the matching comment or
1851 the I<n>th rule will be collected. Again, the comment (or the number) will be
1852 used as the type-instance.
1854 If I<Name> is supplied, it will be used as the type-instance instead of the
1855 comment or the number.
1859 =head2 Plugin C<irq>
1865 Select this irq. By default these irqs will then be collected. For a more
1866 detailed description see B<IgnoreSelected> below.
1868 =item B<IgnoreSelected> I<true>|I<false>
1870 If no configuration if given, the B<irq>-plugin will collect data from all
1871 irqs. This may not be practical, especially if no interrupts happen. Thus, you
1872 can use the B<Irq>-option to pick the interrupt you're interested in.
1873 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
1874 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
1875 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
1876 and all other interrupts are collected.
1880 =head2 Plugin C<java>
1882 The I<Java> plugin makes it possible to write extensions for collectd in Java.
1883 This section only discusses the syntax and semantic of the configuration
1884 options. For more in-depth information on the I<Java> plugin, please read
1885 L<collectd-java(5)>.
1890 JVMArg "-verbose:jni"
1891 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
1892 LoadPlugin "org.collectd.java.Foobar"
1893 <Plugin "org.collectd.java.Foobar">
1894 # To be parsed by the plugin
1898 Available configuration options:
1902 =item B<JVMArg> I<Argument>
1904 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
1905 exactly the way the arguments to the I<java> binary on the command line work.
1906 Execute C<javaE<nbsp>--help> for details.
1908 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
1909 any other options! When another option is found, the JVM will be started and
1910 later options will have to be ignored!
1912 =item B<LoadPlugin> I<JavaClass>
1914 Instantiates a new I<JavaClass> object. The constructor of this object very
1915 likely then registers one or more callback methods with the server.
1917 See L<collectd-java(5)> for details.
1919 When the first such option is found, the virtual machine (JVM) is created. This
1920 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
1921 B<LoadPlugin> options!
1923 =item B<Plugin> I<Name>
1925 The entire block is passed to the Java plugin as an
1926 I<org.collectd.api.OConfigItem> object.
1928 For this to work, the plugin has to register a configuration callback first,
1929 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
1930 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
1931 depends on the (Java) plugin registering the callback and is completely
1932 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
1936 =head2 Plugin C<libvirt>
1938 This plugin allows CPU, disk and network load to be collected for virtualized
1939 guests on the machine. This means that these characteristics can be collected
1940 for guest systems without installing any software on them - collectd only runs
1941 on the hosting system. The statistics are collected through libvirt
1942 (L<http://libvirt.org/>).
1944 Only I<Connection> is required.
1948 =item B<Connection> I<uri>
1950 Connect to the hypervisor given by I<uri>. For example if using Xen use:
1952 Connection "xen:///"
1954 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
1956 =item B<RefreshInterval> I<seconds>
1958 Refresh the list of domains and devices every I<seconds>. The default is 60
1959 seconds. Setting this to be the same or smaller than the I<Interval> will cause
1960 the list of domains and devices to be refreshed on every iteration.
1962 Refreshing the devices in particular is quite a costly operation, so if your
1963 virtualization setup is static you might consider increasing this. If this
1964 option is set to 0, refreshing is disabled completely.
1966 =item B<Domain> I<name>
1968 =item B<BlockDevice> I<name:dev>
1970 =item B<InterfaceDevice> I<name:dev>
1972 =item B<IgnoreSelected> I<true>|I<false>
1974 Select which domains and devices are collected.
1976 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
1977 disk/network devices are collected.
1979 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
1980 domains and disk/network devices are ignored, while the rest are collected.
1982 The domain name and device names may use a regular expression, if the name is
1983 surrounded by I</.../> and collectd was compiled with support for regexps.
1985 The default is to collect statistics for all domains and all their devices.
1989 BlockDevice "/:hdb/"
1990 IgnoreSelected "true"
1992 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
1995 =item B<HostnameFormat> B<name|uuid|hostname|...>
1997 When the libvirt plugin logs data, it sets the hostname of the collected data
1998 according to this setting. The default is to use the guest name as provided by
1999 the hypervisor, which is equal to setting B<name>.
2001 B<uuid> means use the guest's UUID. This is useful if you want to track the
2002 same guest across migrations.
2004 B<hostname> means to use the global B<Hostname> setting, which is probably not
2005 useful on its own because all guests will appear to have the same name.
2007 You can also specify combinations of these fields. For example B<name uuid>
2008 means to concatenate the guest name and UUID (with a literal colon character
2009 between, thus I<"foo:1234-1234-1234-1234">).
2011 =item B<InterfaceFormat> B<name>|B<address>
2013 When the libvirt plugin logs interface data, it sets the name of the collected
2014 data according to this setting. The default is to use the path as provided by
2015 the hypervisor (the "dev" property of the target node), which is equal to
2018 B<address> means use the interface's mac address. This is useful since the
2019 interface path might change between reboots of a guest or across migrations.
2023 =head2 Plugin C<logfile>
2027 =item B<LogLevel> B<debug|info|notice|warning|err>
2029 Sets the log-level. If, for example, set to B<notice>, then all events with
2030 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2032 Please note that B<debug> is only available if collectd has been compiled with
2035 =item B<File> I<File>
2037 Sets the file to write log messages to. The special strings B<stdout> and
2038 B<stderr> can be used to write to the standard output and standard error
2039 channels, respectively. This, of course, only makes much sense when I<collectd>
2040 is running in foreground- or non-daemon-mode.
2042 =item B<Timestamp> B<true>|B<false>
2044 Prefix all lines printed by the current time. Defaults to B<true>.
2046 =item B<PrintSeverity> B<true>|B<false>
2048 When enabled, all lines are prefixed by the severity of the log message, for
2049 example "warning". Defaults to B<false>.
2053 B<Note>: There is no need to notify the daemon after moving or removing the
2054 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2055 for each line it writes.
2057 =head2 Plugin C<lpar>
2059 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2060 virtualization technique for IBM POWER processors. It takes into account CPU
2061 time stolen from or donated to a partition, in addition to the usual user,
2062 system, I/O statistics.
2064 The following configuration options are available:
2068 =item B<CpuPoolStats> B<false>|B<true>
2070 When enabled, statistics about the processor pool are read, too. The partition
2071 needs to have pool authority in order to be able to acquire this information.
2074 =item B<ReportBySerial> B<false>|B<true>
2076 If enabled, the serial of the physical machine the partition is currently
2077 running on is reported as I<hostname> and the logical hostname of the machine
2078 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2079 used (just like other plugins) and the I<plugin instance> will be empty.
2084 =head2 Plugin C<mbmon>
2086 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2088 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2089 B<Host> and B<Port> options can be used to change these values, see below.
2090 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2091 timeouts may appear which may interfere with other statistics..
2093 C<mbmon> must be run with the -r option ("print TAG and Value format");
2094 Debian's F</etc/init.d/mbmon> script already does this, other people
2095 will need to ensure that this is the case.
2099 =item B<Host> I<Hostname>
2101 Hostname to connect to. Defaults to B<127.0.0.1>.
2103 =item B<Port> I<Port>
2105 TCP-Port to connect to. Defaults to B<411>.
2111 The C<md plugin> collects information from Linux Software-RAID devices (md).
2113 All reported values are of the type C<md_disks>. Reported type instances are
2114 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2115 I<missing> (physically absent) disks.
2119 =item B<Device> I<Device>
2121 Select md devices based on device name. The I<device name> is the basename of
2122 the device, i.e. the name of the block device without the leading C</dev/>.
2123 See B<IgnoreSelected> for more details.
2125 =item B<IgnoreSelected> B<true>|B<false>
2127 Invert device selection: If set to B<true>, all md devices B<except> those
2128 listed using B<Device> are collected. If B<false> (the default), only those
2129 listed are collected. If no configuration is given, the B<md> plugin will
2130 collect data from all md devices.
2134 =head2 Plugin C<memcachec>
2136 The C<memcachec plugin> connects to a memcached server, queries one or more
2137 given I<pages> and parses the returned data according to user specification.
2138 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2141 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2142 library. Please note that there is another library with a very similar name,
2143 libmemcache (notice the missing `d'), which is not applicable.
2145 Synopsis of the configuration:
2147 <Plugin "memcachec">
2148 <Page "plugin_instance">
2152 Regex "(\\d+) bytes sent"
2155 Instance "type_instance"
2160 The configuration options are:
2164 =item E<lt>B<Page> I<Name>E<gt>
2166 Each B<Page> block defines one I<page> to be queried from the memcached server.
2167 The block requires one string argument which is used as I<plugin instance>.
2169 =item B<Server> I<Address>
2171 Sets the server address to connect to when querying the page. Must be inside a
2176 When connected to the memcached server, asks for the page I<Key>.
2178 =item E<lt>B<Match>E<gt>
2180 Match blocks define which strings to look for and how matches substrings are
2181 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2185 =head2 Plugin C<memcached>
2187 The C<memcached plugin> connects to a memcached server and queries statistics
2188 about cache utilization, memory and bandwidth used.
2189 L<http://www.danga.com/memcached/>
2191 <Plugin "memcached">
2193 Host "memcache.example.com"
2198 The plugin configuration consists of one or more B<Instance> blocks which
2199 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2200 following options are allowed:
2204 =item B<Host> I<Hostname>
2206 Hostname to connect to. Defaults to B<127.0.0.1>.
2208 =item B<Port> I<Port>
2210 TCP-Port to connect to. Defaults to B<11211>.
2212 =item B<Socket> I<Path>
2214 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2215 setting is given, the B<Host> and B<Port> settings are ignored.
2219 =head2 Plugin C<modbus>
2221 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
2222 register values. It supports reading single registers (unsigned 16E<nbsp>bit
2223 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2224 values (two registers interpreted as IEEE floats in big endian notation).
2228 <Data "voltage-input-1">
2235 <Data "voltage-input-2">
2242 <Host "modbus.example.com">
2243 Address "192.168.0.42"
2248 Instance "power-supply"
2249 Collect "voltage-input-1"
2250 Collect "voltage-input-2"
2256 =item E<lt>B<Data> I<Name>E<gt> blocks
2258 Data blocks define a mapping between register numbers and the "types" used by
2261 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
2265 =item B<RegisterBase> I<Number>
2267 Configures the base register to read from the device. If the option
2268 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
2269 register will be read (the register number is increased by one).
2271 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
2273 Specifies what kind of data is returned by the device. If the type is B<Int32>,
2274 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
2275 combined into one value. Defaults to B<Uint16>.
2277 =item B<Type> I<Type>
2279 Specifies the "type" (data set) to use when dispatching the value to
2280 I<collectd>. Currently, only data sets with exactly one data source are
2283 =item B<Instance> I<Instance>
2285 Sets the type instance to use when dispatching the value to I<collectd>. If
2286 unset, an empty string (no type instance) is used.
2290 =item E<lt>B<Host> I<Name>E<gt> blocks
2292 Host blocks are used to specify to which hosts to connect and what data to read
2293 from their "slaves". The string argument I<Name> is used as hostname when
2294 dispatching the values to I<collectd>.
2296 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
2300 =item B<Address> I<Hostname>
2302 Specifies the node name (the actual network address) used to connect to the
2303 host. This may be an IP address or a hostname. Please note that the used
2304 I<libmodbus> library only supports IPv4 at the moment.
2306 =item B<Port> I<Service>
2308 Specifies the port used to connect to the host. The port can either be given as
2309 a number or as a service name. Please note that the I<Service> argument must be
2310 a string, even if ports are given in their numerical form. Defaults to "502".
2312 =item B<Interval> I<Interval>
2314 Sets the interval (in seconds) in which the values will be collected from this
2315 host. By default the global B<Interval> setting will be used.
2317 =item E<lt>B<Slave> I<ID>E<gt>
2319 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
2320 is used to specify which device should be addressed. For each device you want
2321 to query, one B<Slave> block must be given.
2323 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
2327 =item B<Instance> I<Instance>
2329 Specify the plugin instance to use when dispatching the values to I<collectd>.
2330 By default "slave_I<ID>" is used.
2332 =item B<Collect> I<DataName>
2334 Specifies which data to retrieve from the device. I<DataName> must be the same
2335 string as the I<Name> argument passed to a B<Data> block. You can specify this
2336 option multiple times to collect more than one value from a slave. At least one
2337 B<Collect> option is mandatory.
2345 =head2 Plugin C<mysql>
2347 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
2348 one or more databases when started and keeps the connection up as long as
2349 possible. When the connection is interrupted for whatever reason it will try
2350 to re-connect. The plugin will complain loudly in case anything goes wrong.
2352 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
2353 and collects information about MySQL network traffic, executed statements,
2354 requests, the query cache and threads by evaluating the
2355 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
2356 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
2357 Status Variables> for an explanation of these values.
2359 Optionally, master and slave statistics may be collected in a MySQL
2360 replication setup. In that case, information about the synchronization state
2361 of the nodes are collected by evaluating the C<Position> return value of the
2362 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
2363 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
2364 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
2365 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
2366 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
2381 Socket "/var/run/mysql/mysqld.sock"
2383 SlaveNotifications true
2387 A B<Database> block defines one connection to a MySQL database. It accepts a
2388 single argument which specifies the name of the database. None of the other
2389 options are required. MySQL will use default values as documented in the
2390 section "mysql_real_connect()" in the B<MySQL reference manual>.
2394 =item B<Host> I<Hostname>
2396 Hostname of the database server. Defaults to B<localhost>.
2398 =item B<User> I<Username>
2400 Username to use when connecting to the database. The user does not have to be
2401 granted any privileges (which is synonym to granting the C<USAGE> privilege),
2402 unless you want to collectd replication statistics (see B<MasterStats> and
2403 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
2404 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
2406 =item B<Password> I<Password>
2408 Password needed to log into the database.
2410 =item B<Database> I<Database>
2412 Select this database. Defaults to I<no database> which is a perfectly reasonable
2413 option for what this plugin does.
2415 =item B<Port> I<Port>
2417 TCP-port to connect to. The port must be specified in its numeric form, but it
2418 must be passed as a string nonetheless. For example:
2422 If B<Host> is set to B<localhost> (the default), this setting has no effect.
2423 See the documentation for the C<mysql_real_connect> function for details.
2425 =item B<Socket> I<Socket>
2427 Specifies the path to the UNIX domain socket of the MySQL server. This option
2428 only has any effect, if B<Host> is set to B<localhost> (the default).
2429 Otherwise, use the B<Port> option above. See the documentation for the
2430 C<mysql_real_connect> function for details.
2432 =item B<MasterStats> I<true|false>
2434 =item B<SlaveStats> I<true|false>
2436 Enable the collection of master / slave statistics in a replication setup. In
2437 order to be able to get access to these statistics, the user needs special
2438 privileges. See the B<User> documentation above.
2440 =item B<SlaveNotifications> I<true|false>
2442 If enabled, the plugin sends a notification if the replication slave I/O and /
2443 or SQL threads are not running.
2447 =head2 Plugin C<netapp>
2449 The netapp plugin can collect various performance and capacity information
2450 from a NetApp filer using the NetApp API.
2452 Please note that NetApp has a wide line of products and a lot of different
2453 software versions for each of these products. This plugin was developed for a
2454 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
2455 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
2456 model and software version but it is very hard to test this.
2457 If you have used this plugin with other models and/or software version, feel
2458 free to send us a mail to tell us about the results, even if it's just a short
2461 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
2462 basic authentication.
2464 B<Do not use a regular user for this!> Create a special collectd user with just
2465 the minimum of capabilities needed. The user only needs the "login-http-admin"
2466 capability as well as a few more depending on which data will be collected.
2467 Required capabilities are documented below.
2472 <Host "netapp1.example.com">
2496 IgnoreSelectedIO false
2498 IgnoreSelectedOps false
2499 GetLatency "volume0"
2500 IgnoreSelectedLatency false
2507 IgnoreSelectedCapacity false
2510 IgnoreSelectedSnapshot false
2523 The netapp plugin accepts the following configuration options:
2527 =item B<Host> I<Name>
2529 A host block defines one NetApp filer. It will appear in collectd with the name
2530 you specify here which does not have to be its real name nor its hostname.
2532 =item B<Protocol> B<httpd>|B<http>
2534 The protocol collectd will use to query this host.
2542 Valid options: http, https
2544 =item B<Address> I<Address>
2546 The hostname or IP address of the host.
2552 Default: The "host" block's name.
2554 =item B<Port> I<Port>
2556 The TCP port to connect to on the host.
2562 Default: 80 for protocol "http", 443 for protocol "https"
2564 =item B<User> I<User>
2566 =item B<Password> I<Password>
2568 The username and password to use to login to the NetApp.
2574 =item B<Interval> I<Interval>
2580 The following options decide what kind of data will be collected. You can
2581 either use them as a block and fine tune various parameters inside this block,
2582 use them as a single statement to just accept all default values, or omit it to
2583 not collect any data.
2585 The following options are valid inside all blocks:
2589 =item B<Interval> I<Seconds>
2591 Collect the respective statistics every I<Seconds> seconds. Defaults to the
2592 host specific setting.
2596 =head3 The System block
2598 This will collect various performance data about the whole system.
2600 B<Note:> To get this data the collectd user needs the
2601 "api-perf-object-get-instances" capability.
2605 =item B<Interval> I<Seconds>
2607 Collect disk statistics every I<Seconds> seconds.
2609 =item B<GetCPULoad> B<true>|B<false>
2611 If you set this option to true the current CPU usage will be read. This will be
2612 the average usage between all CPUs in your NetApp without any information about
2615 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2616 returns in the "CPU" field.
2624 Result: Two value lists of type "cpu", and type instances "idle" and "system".
2626 =item B<GetInterfaces> B<true>|B<false>
2628 If you set this option to true the current traffic of the network interfaces
2629 will be read. This will be the total traffic over all interfaces of your NetApp
2630 without any information about individual interfaces.
2632 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2633 in the "Net kB/s" field.
2643 Result: One value list of type "if_octects".
2645 =item B<GetDiskIO> B<true>|B<false>
2647 If you set this option to true the current IO throughput will be read. This
2648 will be the total IO of your NetApp without any information about individual
2649 disks, volumes or aggregates.
2651 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2652 in the "DiskE<nbsp>kB/s" field.
2660 Result: One value list of type "disk_octets".
2662 =item B<GetDiskOps> B<true>|B<false>
2664 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
2665 iSCSI, etc. operations will be read. This will be the total number of
2666 operations on your NetApp without any information about individual volumes or
2669 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2670 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
2678 Result: A variable number of value lists of type "disk_ops_complex". Each type
2679 of operation will result in one value list with the name of the operation as
2684 =head3 The WAFL block
2686 This will collect various performance data about the WAFL file system. At the
2687 moment this just means cache performance.
2689 B<Note:> To get this data the collectd user needs the
2690 "api-perf-object-get-instances" capability.
2692 B<Note:> The interface to get these values is classified as "Diagnostics" by
2693 NetApp. This means that it is not guaranteed to be stable even between minor
2698 =item B<Interval> I<Seconds>
2700 Collect disk statistics every I<Seconds> seconds.
2702 =item B<GetNameCache> B<true>|B<false>
2710 Result: One value list of type "cache_ratio" and type instance
2713 =item B<GetDirCache> B<true>|B<false>
2721 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
2723 =item B<GetInodeCache> B<true>|B<false>
2731 Result: One value list of type "cache_ratio" and type instance
2734 =item B<GetBufferCache> B<true>|B<false>
2736 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
2737 in the "Cache hit" field.
2745 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
2749 =head3 The Disks block
2751 This will collect performance data about the individual disks in the NetApp.
2753 B<Note:> To get this data the collectd user needs the
2754 "api-perf-object-get-instances" capability.
2758 =item B<Interval> I<Seconds>
2760 Collect disk statistics every I<Seconds> seconds.
2762 =item B<GetBusy> B<true>|B<false>
2764 If you set this option to true the busy time of all disks will be calculated
2765 and the value of the busiest disk in the system will be written.
2767 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2768 in the "Disk util" field. Probably.
2776 Result: One value list of type "percent" and type instance "disk_busy".
2780 =head3 The VolumePerf block
2782 This will collect various performance data about the individual volumes.
2784 You can select which data to collect about which volume using the following
2785 options. They follow the standard ignorelist semantic.
2787 B<Note:> To get this data the collectd user needs the
2788 I<api-perf-object-get-instances> capability.
2792 =item B<Interval> I<Seconds>
2794 Collect volume performance data every I<Seconds> seconds.
2796 =item B<GetIO> I<Volume>
2798 =item B<GetOps> I<Volume>
2800 =item B<GetLatency> I<Volume>
2802 Select the given volume for IO, operations or latency statistics collection.
2803 The argument is the name of the volume without the C</vol/> prefix.
2805 Since the standard ignorelist functionality is used here, you can use a string
2806 starting and ending with a slash to specify regular expression matching: To
2807 match the volumes "vol0", "vol2" and "vol7", you can use this regular
2810 GetIO "/^vol[027]$/"
2812 If no regular expression is specified, an exact match is required. Both,
2813 regular and exact matching are case sensitive.
2815 If no volume was specified at all for either of the three options, that data
2816 will be collected for all available volumes.
2818 =item B<IgnoreSelectedIO> B<true>|B<false>
2820 =item B<IgnoreSelectedOps> B<true>|B<false>
2822 =item B<IgnoreSelectedLatency> B<true>|B<false>
2824 When set to B<true>, the volumes selected for IO, operations or latency
2825 statistics collection will be ignored and the data will be collected for all
2828 When set to B<false>, data will only be collected for the specified volumes and
2829 all other volumes will be ignored.
2831 If no volumes have been specified with the above B<Get*> options, all volumes
2832 will be collected regardless of the B<IgnoreSelected*> option.
2834 Defaults to B<false>
2838 =head3 The VolumeUsage block
2840 This will collect capacity data about the individual volumes.
2842 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
2847 =item B<Interval> I<Seconds>
2849 Collect volume usage statistics every I<Seconds> seconds.
2851 =item B<GetCapacity> I<VolumeName>
2853 The current capacity of the volume will be collected. This will result in two
2854 to four value lists, depending on the configuration of the volume. All data
2855 sources are of type "df_complex" with the name of the volume as
2858 There will be type_instances "used" and "free" for the number of used and
2859 available bytes on the volume. If the volume has some space reserved for
2860 snapshots, a type_instance "snap_reserved" will be available. If the volume
2861 has SIS enabled, a type_instance "sis_saved" will be available. This is the
2862 number of bytes saved by the SIS feature.
2864 B<Note:> The current NetApp API has a bug that results in this value being
2865 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
2866 number which works most of the time. If you see strange values here, bug
2867 NetApp support to fix this.
2869 Repeat this option to specify multiple volumes.
2871 =item B<IgnoreSelectedCapacity> B<true>|B<false>
2873 Specify whether to collect only the volumes selected by the B<GetCapacity>
2874 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
2875 B<false>. However, if no B<GetCapacity> option is specified at all, all
2876 capacities will be selected anyway.
2878 =item B<GetSnapshot> I<VolumeName>
2880 Select volumes from which to collect snapshot information.
2882 Usually, the space used for snapshots is included in the space reported as
2883 "used". If snapshot information is collected as well, the space used for
2884 snapshots is subtracted from the used space.
2886 To make things even more interesting, it is possible to reserve space to be
2887 used for snapshots. If the space required for snapshots is less than that
2888 reserved space, there is "reserved free" and "reserved used" space in addition
2889 to "free" and "used". If the space required for snapshots exceeds the reserved
2890 space, that part allocated in the normal space is subtracted from the "used"
2893 Repeat this option to specify multiple volumes.
2895 =item B<IgnoreSelectedSnapshot>
2897 Specify whether to collect only the volumes selected by the B<GetSnapshot>
2898 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
2899 B<false>. However, if no B<GetSnapshot> option is specified at all, all
2900 capacities will be selected anyway.
2904 =head2 Plugin C<netlink>
2906 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
2907 statistics of various interface and routing aspects.
2911 =item B<Interface> I<Interface>
2913 =item B<VerboseInterface> I<Interface>
2915 Instruct the plugin to collect interface statistics. This is basically the same
2916 as the statistics provided by the C<interface> plugin (see above) but
2917 potentially much more detailed.
2919 When configuring with B<Interface> only the basic statistics will be collected,
2920 namely octets, packets, and errors. These statistics are collected by
2921 the C<interface> plugin, too, so using both at the same time is no benefit.
2923 When configured with B<VerboseInterface> all counters B<except> the basic ones,
2924 so that no data needs to be collected twice if you use the C<interface> plugin.
2925 This includes dropped packets, received multicast packets, collisions and a
2926 whole zoo of differentiated RX and TX errors. You can try the following command
2927 to get an idea of what awaits you:
2931 If I<Interface> is B<All>, all interfaces will be selected.
2933 =item B<QDisc> I<Interface> [I<QDisc>]
2935 =item B<Class> I<Interface> [I<Class>]
2937 =item B<Filter> I<Interface> [I<Filter>]
2939 Collect the octets and packets that pass a certain qdisc, class or filter.
2941 QDiscs and classes are identified by their type and handle (or classid).
2942 Filters don't necessarily have a handle, therefore the parent's handle is used.
2943 The notation used in collectd differs from that used in tc(1) in that it
2944 doesn't skip the major or minor number if it's zero and doesn't print special
2945 ids by their name. So, for example, a qdisc may be identified by
2946 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
2947 thus not displayed by tc(1).
2949 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
2950 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
2951 associated with that interface will be collected.
2953 Since a filter itself doesn't necessarily have a handle, the parent's handle is
2954 used. This may lead to problems when more than one filter is attached to a
2955 qdisc or class. This isn't nice, but we don't know how this could be done any
2956 better. If you have a idea, please don't hesitate to tell us.
2958 As with the B<Interface> option you can specify B<All> as the interface,
2959 meaning all interfaces.
2961 Here are some examples to help you understand the above text more easily:
2964 VerboseInterface "All"
2965 QDisc "eth0" "pfifo_fast-1:0"
2967 Class "ppp0" "htb-1:10"
2968 Filter "ppp0" "u32-1:0"
2971 =item B<IgnoreSelected>
2973 The behavior is the same as with all other similar plugins: If nothing is
2974 selected at all, everything is collected. If some things are selected using the
2975 options described above, only these statistics are collected. If you set
2976 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
2977 specified statistics will not be collected.
2981 =head2 Plugin C<network>
2983 The Network plugin sends data to a remote instance of collectd, receives data
2984 from a remote instance, or both at the same time. Data which has been received
2985 from the network is usually not transmitted again, but this can be activated, see
2986 the B<Forward> option below.
2988 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
2989 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
2991 Both, B<Server> and B<Listen> can be used as single option or as block. When
2992 used as block, given options are valid for this socket only. The following
2993 example will export the metrics twice: Once to an "internal" server (without
2994 encryption and signing) and one to an external server (with cryptographic
2998 # Export to an internal server
2999 # (demonstrates usage without additional options)
3000 Server "collectd.internal.tld"
3002 # Export to an external server
3003 # (demonstrates usage with signature options)
3004 <Server "collectd.external.tld">
3005 SecurityLevel "sign"
3006 Username "myhostname"
3013 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3015 The B<Server> statement/block sets the server to send datagrams to. The
3016 statement may occur multiple times to send each datagram to multiple
3019 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3020 optional second argument specifies a port number or a service name. If not
3021 given, the default, B<25826>, is used.
3023 The following options are recognized within B<Server> blocks:
3027 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3029 Set the security you require for network communication. When the security level
3030 has been set to B<Encrypt>, data sent over the network will be encrypted using
3031 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3032 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3033 authentication code. When set to B<None>, data is sent without any security.
3035 This feature is only available if the I<network> plugin was linked with
3038 =item B<Username> I<Username>
3040 Sets the username to transmit. This is used by the server to lookup the
3041 password. See B<AuthFile> below. All security levels except B<None> require
3044 This feature is only available if the I<network> plugin was linked with
3047 =item B<Password> I<Password>
3049 Sets a password (shared secret) for this socket. All security levels except
3050 B<None> require this setting.
3052 This feature is only available if the I<network> plugin was linked with
3055 =item B<Interface> I<Interface name>
3057 Set the outgoing interface for IP packets. This applies at least
3058 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3059 undefined or a non-existent interface name is specified, the default
3060 behavior is to let the kernel choose the appropriate interface. Be warned
3061 that the manual selection of an interface for unicast traffic is only
3062 necessary in rare cases.
3066 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
3068 The B<Listen> statement sets the interfaces to bind to. When multiple
3069 statements are found the daemon will bind to multiple interfaces.
3071 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
3072 the argument is a multicast address the daemon will join that multicast group.
3073 The optional second argument specifies a port number or a service name. If not
3074 given, the default, B<25826>, is used.
3076 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
3080 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3082 Set the security you require for network communication. When the security level
3083 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
3084 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
3085 signed and encrypted data is accepted. When set to B<None>, all data will be
3086 accepted. If an B<AuthFile> option was given (see below), encrypted data is
3087 decrypted if possible.
3089 This feature is only available if the I<network> plugin was linked with
3092 =item B<AuthFile> I<Filename>
3094 Sets a file in which usernames are mapped to passwords. These passwords are
3095 used to verify signatures and to decrypt encrypted network packets. If
3096 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
3097 verified and encrypted packets are decrypted. Otherwise, signed data is
3098 accepted without checking the signature and encrypted data cannot be decrypted.
3099 For the other security levels this option is mandatory.
3101 The file format is very simple: Each line consists of a username followed by a
3102 colon and any number of spaces followed by the password. To demonstrate, an
3103 example file could look like this:
3108 Each time a packet is received, the modification time of the file is checked
3109 using L<stat(2)>. If the file has been changed, the contents is re-read. While
3110 the file is being read, it is locked using L<fcntl(2)>.
3112 =item B<Interface> I<Interface name>
3114 Set the incoming interface for IP packets explicitly. This applies at least
3115 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3116 undefined or a non-existent interface name is specified, the default
3117 behavior is, to let the kernel choose the appropriate interface. Thus incoming
3118 traffic gets only accepted, if it arrives on the given interface.
3122 =item B<TimeToLive> I<1-255>
3124 Set the time-to-live of sent packets. This applies to all, unicast and
3125 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
3126 That means that multicast packets will be sent with a TTL of C<1> (one) on most
3129 =item B<MaxPacketSize> I<1024-65535>
3131 Set the maximum size for datagrams received over the network. Packets larger
3132 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
3133 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
3136 On the server side, this limit should be set to the largest value used on
3137 I<any> client. Likewise, the value on the client must not be larger than the
3138 value on the server, or data will be lost.
3140 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
3141 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
3142 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
3145 =item B<Forward> I<true|false>
3147 If set to I<true>, write packets that were received via the network plugin to
3148 the sending sockets. This should only be activated when the B<Listen>- and
3149 B<Server>-statements differ. Otherwise packets may be send multiple times to
3150 the same multicast group. While this results in more network traffic than
3151 necessary it's not a huge problem since the plugin has a duplicate detection,
3152 so the values will not loop.
3154 =item B<ReportStats> B<true>|B<false>
3156 The network plugin cannot only receive and send statistics, it can also create
3157 statistics about itself. Collected data included the number of received and
3158 sent octets and packets, the length of the receive queue and the number of
3159 values handled. When set to B<true>, the I<Network plugin> will make these
3160 statistics available. Defaults to B<false>.
3164 =head2 Plugin C<nginx>
3166 This plugin collects the number of connections and requests handled by the
3167 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
3168 queries the page provided by the C<ngx_http_stub_status_module> module, which
3169 isn't compiled by default. Please refer to
3170 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
3171 how to compile and configure nginx and this module.
3173 The following options are accepted by the C<nginx plugin>:
3177 =item B<URL> I<http://host/nginx_status>
3179 Sets the URL of the C<ngx_http_stub_status_module> output.
3181 =item B<User> I<Username>
3183 Optional user name needed for authentication.
3185 =item B<Password> I<Password>
3187 Optional password needed for authentication.
3189 =item B<VerifyPeer> B<true|false>
3191 Enable or disable peer SSL certificate verification. See
3192 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
3194 =item B<VerifyHost> B<true|false>
3196 Enable or disable peer host name verification. If enabled, the plugin checks
3197 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
3198 certificate matches the host name provided by the B<URL> option. If this
3199 identity check fails, the connection is aborted. Obviously, only works when
3200 connecting to a SSL enabled server. Enabled by default.
3202 =item B<CACert> I<File>
3204 File that holds one or more SSL certificates. If you want to use HTTPS you will
3205 possibly need this option. What CA certificates come bundled with C<libcurl>
3206 and are checked by default depends on the distribution you use.
3210 =head2 Plugin C<notify_desktop>
3212 This plugin sends a desktop notification to a notification daemon, as defined
3213 in the Desktop Notification Specification. To actually display the
3214 notifications, B<notification-daemon> is required and B<collectd> has to be
3215 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
3216 environment variables have to be set correctly) and the D-Bus message bus.
3218 The Desktop Notification Specification can be found at
3219 L<http://www.galago-project.org/specs/notification/>.
3223 =item B<OkayTimeout> I<timeout>
3225 =item B<WarningTimeout> I<timeout>
3227 =item B<FailureTimeout> I<timeout>
3229 Set the I<timeout>, in milliseconds, after which to expire the notification
3230 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
3231 been specified, the displayed notification will not be closed at all - the
3232 user has to do so herself. These options default to 5000. If a negative number
3233 has been specified, the default is used as well.
3237 =head2 Plugin C<notify_email>
3239 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
3240 configured email address.
3242 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
3244 Available configuration options:
3248 =item B<From> I<Address>
3250 Email address from which the emails should appear to come from.
3252 Default: C<root@localhost>
3254 =item B<Recipient> I<Address>
3256 Configures the email address(es) to which the notifications should be mailed.
3257 May be repeated to send notifications to multiple addresses.
3259 At least one B<Recipient> must be present for the plugin to work correctly.
3261 =item B<SMTPServer> I<Hostname>
3263 Hostname of the SMTP server to connect to.
3265 Default: C<localhost>
3267 =item B<SMTPPort> I<Port>
3269 TCP port to connect to.
3273 =item B<SMTPUser> I<Username>
3275 Username for ASMTP authentication. Optional.
3277 =item B<SMTPPassword> I<Password>
3279 Password for ASMTP authentication. Optional.
3281 =item B<Subject> I<Subject>
3283 Subject-template to use when sending emails. There must be exactly two
3284 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
3285 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
3288 Default: C<Collectd notify: %s@%s>
3292 =head2 Plugin C<ntpd>
3296 =item B<Host> I<Hostname>
3298 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
3300 =item B<Port> I<Port>
3302 UDP-Port to connect to. Defaults to B<123>.
3304 =item B<ReverseLookups> B<true>|B<false>
3306 Sets whether or not to perform reverse lookups on peers. Since the name or
3307 IP-address may be used in a filename it is recommended to disable reverse
3308 lookups. The default is to do reverse lookups to preserve backwards
3309 compatibility, though.
3311 =item B<IncludeUnitID> B<true>|B<false>
3313 When a peer is a refclock, include the unit ID in the I<type instance>.
3314 Defaults to B<false> for backward compatibility.
3316 If two refclock peers use the same driver and this is B<false>, the plugin will
3317 try to write simultaneous measurements from both to the same type instance.
3318 This will result in error messages in the log and only one set of measurements
3323 =head2 Plugin C<nut>
3327 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
3329 Add a UPS to collect data from. The format is identical to the one accepted by
3334 =head2 Plugin C<olsrd>
3336 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
3337 the Optimized Link State Routing daemon and reads information about the current
3338 state of the meshed network.
3340 The following configuration options are understood:
3344 =item B<Host> I<Host>
3346 Connect to I<Host>. Defaults to B<"localhost">.
3348 =item B<Port> I<Port>
3350 Specifies the port to connect to. This must be a string, even if you give the
3351 port as a number rather than a service name. Defaults to B<"2006">.
3353 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
3355 Specifies what information to collect about links, i.E<nbsp>e. direct
3356 connections of the daemon queried. If set to B<No>, no information is
3357 collected. If set to B<Summary>, the number of links and the average of all
3358 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
3359 If set to B<Detail> LQ and NLQ are collected per link.
3361 Defaults to B<Detail>.
3363 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
3365 Specifies what information to collect about routes of the daemon queried. If
3366 set to B<No>, no information is collected. If set to B<Summary>, the number of
3367 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
3368 metric and ETX are collected per route.
3370 Defaults to B<Summary>.
3372 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
3374 Specifies what information to collect about the global topology. If set to
3375 B<No>, no information is collected. If set to B<Summary>, the number of links
3376 in the entire topology and the average I<link quality> (LQ) is calculated.
3377 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
3379 Defaults to B<Summary>.
3383 =head2 Plugin C<onewire>
3385 B<EXPERIMENTAL!> See notes below.
3387 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
3388 L<http://owfs.org/> to read sensors connected via the onewire bus.
3390 Currently only temperature sensors (sensors with the family code C<10>,
3391 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
3392 would like to have included, please send a sort request to the mailing list.
3394 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
3395 experimental, below.
3399 =item B<Device> I<Device>
3401 Sets the device to read the values from. This can either be a "real" hardware
3402 device, such as a serial port or an USB port, or the address of the
3403 L<owserver(1)> socket, usually B<localhost:4304>.
3405 Though the documentation claims to automatically recognize the given address
3406 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
3407 with that version, the following configuration worked for us:
3410 Device "-s localhost:4304"
3413 This directive is B<required> and does not have a default value.
3415 =item B<Sensor> I<Sensor>
3417 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
3418 below. Sensors are specified without the family byte at the beginning, to you'd
3419 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
3422 =item B<IgnoreSelected> I<true>|I<false>
3424 If no configuration if given, the B<onewire> plugin will collect data from all
3425 sensors found. This may not be practical, especially if sensors are added and
3426 removed regularly. Sometimes, however, it's easier/preferred to collect only
3427 specific sensors or all sensors I<except> a few specified ones. This option
3428 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
3429 B<Sensor> is inverted: All selected interfaces are ignored and all other
3430 interfaces are collected.
3432 =item B<Interval> I<Seconds>
3434 Sets the interval in which all sensors should be read. If not specified, the
3435 global B<Interval> setting is used.
3439 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
3440 work with big setups. It works with one sensor being attached to one
3441 controller, but as soon as you throw in a couple more senors and maybe a hub
3442 or two, reading all values will take more than ten seconds (the default
3443 interval). We will probably add some separate thread for reading the sensors
3444 and some cache or something like that, but it's not done yet. We will try to
3445 maintain backwards compatibility in the future, but we can't promise. So in
3446 short: If it works for you: Great! But keep in mind that the config I<might>
3447 change, though this is unlikely. Oh, and if you want to help improving this
3448 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
3450 =head2 Plugin C<openvpn>
3452 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
3453 traffic statistics about connected clients.
3455 To set up OpenVPN to write to the status file periodically, use the
3456 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
3457 you need to set the required format, too. This is done by setting
3458 B<--status-version> to B<2>.
3460 So, in a nutshell you need:
3462 openvpn $OTHER_OPTIONS \
3463 --status "/var/run/openvpn-status" 10 \
3470 =item B<StatusFile> I<File>
3472 Specifies the location of the status file.
3474 =item B<ImprovedNamingSchema> B<true>|B<false>
3476 When enabled, the filename of the status file will be used as plugin instance
3477 and the client's "common name" will be used as type instance. This is required
3478 when reading multiple status files. Enabling this option is recommended, but to
3479 maintain backwards compatibility this option is disabled by default.
3481 =item B<CollectCompression> B<true>|B<false>
3483 Sets whether or not statistics about the compression used by OpenVPN should be
3484 collected. This information is only available in I<single> mode. Enabled by
3487 =item B<CollectIndividualUsers> B<true>|B<false>
3489 Sets whether or not traffic information is collected for each connected client
3490 individually. If set to false, currently no traffic data is collected at all
3491 because aggregating this data in a save manner is tricky. Defaults to B<true>.
3493 =item B<CollectUserCount> B<true>|B<false>
3495 When enabled, the number of currently connected clients or users is collected.
3496 This is especially interesting when B<CollectIndividualUsers> is disabled, but
3497 can be configured independently from that option. Defaults to B<false>.
3501 =head2 Plugin C<oracle>
3503 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
3504 Oracle® Database and lets you execute SQL statements there. It is very similar
3505 to the "dbi" plugin, because it was written around the same time. See the "dbi"
3506 plugin's documentation above for details.
3509 <Query "out_of_stock">
3510 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
3513 # InstancePrefix "foo"
3514 InstancesFrom "category"
3518 <Database "product_information">
3522 Query "out_of_stock"
3526 =head3 B<Query> blocks
3528 The Query blocks are handled identically to the Query blocks of the "dbi"
3529 plugin. Please see its documentation above for details on how to specify
3532 =head3 B<Database> blocks
3534 Database blocks define a connection to a database and which queries should be
3535 sent to that database. Each database needs a "name" as string argument in the
3536 starting tag of the block. This name will be used as "PluginInstance" in the
3537 values submitted to the daemon. Other than that, that name is not used.
3541 =item B<ConnectID> I<ID>
3543 Defines the "database alias" or "service name" to connect to. Usually, these
3544 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
3546 =item B<Host> I<Host>
3548 Hostname to use when dispatching values for this database. Defaults to using
3549 the global hostname of the I<collectd> instance.
3551 =item B<Username> I<Username>
3553 Username used for authentication.
3555 =item B<Password> I<Password>
3557 Password used for authentication.
3559 =item B<Query> I<QueryName>
3561 Associates the query named I<QueryName> with this database connection. The
3562 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
3563 blocks you want to refer to must be placed above the database block you want to
3568 =head2 Plugin C<perl>
3570 This plugin embeds a Perl-interpreter into collectd and provides an interface
3571 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
3573 =head2 Plugin C<pinba>
3575 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
3576 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
3577 PHP-based webpage has been delivered, the extension will send a UDP packet
3578 containing timing information, peak memory usage and so on. The plugin will
3579 wait for such packets, parse them and account the provided information, which
3580 is then dispatched to the daemon once per interval.
3587 # Overall statistics for the website.
3589 Server "www.example.com"
3591 # Statistics for www-a only
3593 Host "www-a.example.com"
3594 Server "www.example.com"
3596 # Statistics for www-b only
3598 Host "www-b.example.com"
3599 Server "www.example.com"
3603 The plugin provides the following configuration options:
3607 =item B<Address> I<Node>
3609 Configures the address used to open a listening socket. By default, plugin will
3610 bind to the I<any> address C<::0>.
3612 =item B<Port> I<Service>
3614 Configures the port (service) to bind to. By default the default Pinba port
3615 "30002" will be used. The option accepts service names in addition to port
3616 numbers and thus requires a I<string> argument.
3618 =item E<lt>B<View> I<Name>E<gt> block
3620 The packets sent by the Pinba extension include the hostname of the server, the
3621 server name (the name of the virtual host) and the script that was executed.
3622 Using B<View> blocks it is possible to separate the data into multiple groups
3623 to get more meaningful statistics. Each packet is added to all matching groups,
3624 so that a packet may be accounted for more than once.
3628 =item B<Host> I<Host>
3630 Matches the hostname of the system the webserver / script is running on. This
3631 will contain the result of the L<gethostname(2)> system call. If not
3632 configured, all hostnames will be accepted.
3634 =item B<Server> I<Server>
3636 Matches the name of the I<virtual host>, i.e. the contents of the
3637 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
3638 server names will be accepted.
3640 =item B<Script> I<Script>
3642 Matches the name of the I<script name>, i.e. the contents of the
3643 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
3644 script names will be accepted.
3650 =head2 Plugin C<ping>
3652 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
3653 configured hosts periodically and measures the network latency. Whenever the
3654 C<read> function of the plugin is called, it submits the average latency, the
3655 standard deviation and the drop rate for each host.
3657 Available configuration options:
3661 =item B<Host> I<IP-address>
3663 Host to ping periodically. This option may be repeated several times to ping
3666 =item B<Interval> I<Seconds>
3668 Sets the interval in which to send ICMP echo packets to the configured hosts.
3669 This is B<not> the interval in which statistics are queries from the plugin but
3670 the interval in which the hosts are "pinged". Therefore, the setting here
3671 should be smaller than or equal to the global B<Interval> setting. Fractional
3672 times, such as "1.24" are allowed.
3676 =item B<Timeout> I<Seconds>
3678 Time to wait for a response from the host to which an ICMP packet had been
3679 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
3680 to be down or the packet to be dropped. This setting must be smaller than the
3681 B<Interval> setting above for the plugin to work correctly. Fractional
3682 arguments are accepted.
3686 =item B<TTL> I<0-255>
3688 Sets the Time-To-Live of generated ICMP packets.
3690 =item B<SourceAddress> I<host>
3692 Sets the source address to use. I<host> may either be a numerical network
3693 address or a network hostname.
3695 =item B<Device> I<name>
3697 Sets the outgoing network device to be used. I<name> has to specify an
3698 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
3701 =item B<MaxMissed> I<Packets>
3703 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
3704 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
3706 Default: B<-1> (disabled)
3710 =head2 Plugin C<postgresql>
3712 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
3713 keeps a persistent connection to all configured databases and tries to
3714 reconnect if the connection has been interrupted. A database is configured by
3715 specifying a B<Database> block as described below. The default statistics are
3716 collected from PostgreSQL's B<statistics collector> which thus has to be
3717 enabled for this plugin to work correctly. This should usually be the case by
3718 default. See the section "The Statistics Collector" of the B<PostgreSQL
3719 Documentation> for details.
3721 By specifying custom database queries using a B<Query> block as described
3722 below, you may collect any data that is available from some PostgreSQL
3723 database. This way, you are able to access statistics of external daemons
3724 which are available in a PostgreSQL database or use future or special
3725 statistics provided by PostgreSQL without the need to upgrade your collectd
3728 Starting with version 5.2, the C<postgresql> plugin supports writing data to
3729 PostgreSQL databases as well. This has been implemented in a generic way. You
3730 need to specify an SQL statement which will then be executed by collectd in
3731 order to write the data (see below for details). The benefit of that approach
3732 is that there is no fixed database layout. Rather, the layout may be optimized
3733 for the current setup.
3735 The B<PostgreSQL Documentation> manual can be found at
3736 L<http://www.postgresql.org/docs/manuals/>.
3740 Statement "SELECT magic FROM wizard WHERE host = $1;"
3744 InstancePrefix "magic"
3749 <Query rt36_tickets>
3750 Statement "SELECT COUNT(type) AS count, type \
3752 WHEN resolved = 'epoch' THEN 'open' \
3753 ELSE 'resolved' END AS type \
3754 FROM tickets) type \
3758 InstancePrefix "rt36_tickets"
3759 InstancesFrom "type"
3765 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
3775 KRBSrvName "kerberos_service_name"
3781 Service "service_name"
3782 Query backend # predefined
3793 The B<Query> block defines one database query which may later be used by a
3794 database definition. It accepts a single mandatory argument which specifies
3795 the name of the query. The names of all queries have to be unique (see the
3796 B<MinVersion> and B<MaxVersion> options below for an exception to this
3797 rule). The following configuration options are available to define the query:
3799 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
3800 blocks define how to handle the values returned from the query. They define
3801 which column holds which value and how to dispatch that value to the daemon.
3802 Multiple B<Result> blocks may be used to extract multiple values from a single
3807 =item B<Statement> I<sql query statement>
3809 Specify the I<sql query statement> which the plugin should execute. The string
3810 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
3811 first, second, etc. parameter. The value of the parameters is specified by the
3812 B<Param> configuration option - see below for details. To include a literal
3813 B<$> character followed by a number, surround it with single quotes (B<'>).
3815 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
3816 allowed. Note, however, that only a single command may be used. Semicolons are
3817 allowed as long as a single non-empty command has been specified only.
3819 The returned lines will be handled separately one after another.
3821 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
3823 Specify the parameters which should be passed to the SQL query. The parameters
3824 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
3825 they appear in the configuration file. The value of the parameter is
3826 determined depending on the value of the B<Param> option as follows:
3832 The configured hostname of the database connection. If a UNIX domain socket is
3833 used, the parameter expands to "localhost".
3837 The name of the database of the current connection.
3841 The name of the database plugin instance. See the B<Instance> option of the
3842 database specification below for details.
3846 The username used to connect to the database.
3850 The interval with which this database is queried (as specified by the database
3851 specific or global B<Interval> options).
3855 Please note that parameters are only supported by PostgreSQL's protocol
3856 version 3 and above which was introduced in version 7.4 of PostgreSQL.
3858 =item B<Type> I<type>
3860 The I<type> name to be used when dispatching the values. The type describes
3861 how to handle the data and where to store it. See L<types.db(5)> for more
3862 details on types and their configuration. The number and type of values (as
3863 selected by the B<ValuesFrom> option) has to match the type of the given name.
3865 This option is required inside a B<Result> block.
3867 =item B<InstancePrefix> I<prefix>
3869 =item B<InstancesFrom> I<column0> [I<column1> ...]
3871 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
3872 B<InstancePrefix> defines a static prefix that will be prepended to all type
3873 instances. B<InstancesFrom> defines the column names whose values will be used
3874 to create the type instance. Multiple values will be joined together using the
3875 hyphen (C<->) as separation character.
3877 The plugin itself does not check whether or not all built instances are
3878 different. It is your responsibility to assure that each is unique.
3880 Both options are optional. If none is specified, the type instance will be
3883 =item B<ValuesFrom> I<column0> [I<column1> ...]
3885 Names the columns whose content is used as the actual data for the data sets
3886 that are dispatched to the daemon. How many such columns you need is
3887 determined by the B<Type> setting as explained above. If you specify too many
3888 or not enough columns, the plugin will complain about that and no data will be
3889 submitted to the daemon.
3891 The actual data type, as seen by PostgreSQL, is not that important as long as
3892 it represents numbers. The plugin will automatically cast the values to the
3893 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
3894 L<strtod(3)> functions, so anything supported by those functions is supported
3895 by the plugin as well.
3897 This option is required inside a B<Result> block and may be specified multiple
3898 times. If multiple B<ValuesFrom> options are specified, the columns are read
3901 =item B<MinVersion> I<version>
3903 =item B<MaxVersion> I<version>
3905 Specify the minimum or maximum version of PostgreSQL that this query should be
3906 used with. Some statistics might only be available with certain versions of
3907 PostgreSQL. This allows you to specify multiple queries with the same name but
3908 which apply to different versions, thus allowing you to use the same
3909 configuration in a heterogeneous environment.
3911 The I<version> has to be specified as the concatenation of the major, minor
3912 and patch-level versions, each represented as two-decimal-digit numbers. For
3913 example, version 8.2.3 will become 80203.
3917 The following predefined queries are available (the definitions can be found
3918 in the F<postgresql_default.conf> file which, by default, is available at
3919 C<I<prefix>/share/collectd/>):
3925 This query collects the number of backends, i.E<nbsp>e. the number of
3928 =item B<transactions>
3930 This query collects the numbers of committed and rolled-back transactions of
3935 This query collects the numbers of various table modifications (i.E<nbsp>e.
3936 insertions, updates, deletions) of the user tables.
3938 =item B<query_plans>
3940 This query collects the numbers of various table scans and returned tuples of
3943 =item B<table_states>
3945 This query collects the numbers of live and dead rows in the user tables.
3949 This query collects disk block access counts for user tables.
3953 This query collects the on-disk size of the database in bytes.
3957 In addition, the following detailed queries are available by default. Please
3958 note that each of those queries collects information B<by table>, thus,
3959 potentially producing B<a lot> of data. For details see the description of the
3960 non-by_table queries above.
3964 =item B<queries_by_table>
3966 =item B<query_plans_by_table>
3968 =item B<table_states_by_table>
3970 =item B<disk_io_by_table>
3974 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
3975 mandatory argument specifying the name of the writer. This will then be used
3976 in the B<Database> specification in order to activate the writer instance. The
3977 names of all writers have to be unique. The following options may be
3982 =item B<Statement> I<sql statement>
3984 This mandatory option specifies the SQL statement that will be executed for
3985 each submitted value. A single SQL statement is allowed only. Anything after
3986 the first semicolon will be ignored.
3988 Nine parameters will be passed to the statement and should be specified as
3989 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
3990 values are made available through those parameters:
3996 The timestamp of the queried value as a floating point number.
4000 The hostname of the queried value.
4004 The plugin name of the queried value.
4008 The plugin instance of the queried value. This value may be B<NULL> if there
4009 is no plugin instance.
4013 The type of the queried value (cf. L<types.db(5)>).
4017 The type instance of the queried value. This value may be B<NULL> if there is
4022 An array of names for the submitted values (i.E<nbsp>e., the name of the data
4023 sources of the submitted value-list).
4027 An array of types for the submitted values (i.E<nbsp>e., the type of the data
4028 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
4029 B<StoreRates> is enabled (which is the default, see below), all types will be
4034 An array of the submitted values. The dimensions of the value name and value
4039 In general, it is advisable to create and call a custom function in the
4040 PostgreSQL database for this purpose. Any procedural language supported by
4041 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
4044 =item B<StoreRates> B<false>|B<true>
4046 If set to B<true> (the default), convert counter values to rates. If set to
4047 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
4052 The B<Database> block defines one PostgreSQL database for which to collect
4053 statistics. It accepts a single mandatory argument which specifies the
4054 database name. None of the other options are required. PostgreSQL will use
4055 default values as documented in the section "CONNECTING TO A DATABASE" in the
4056 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
4057 the user collectd is run as and special environment variables. See the manpage
4062 =item B<Interval> I<seconds>
4064 Specify the interval with which the database should be queried. The default is
4065 to use the global B<Interval> setting.
4067 =item B<CommitInterval> I<seconds>
4069 This option may be used for database connections which have "writers" assigned
4070 (see above). If specified, it causes a writer to put several updates into a
4071 single transaction. This transaction will last for the specified amount of
4072 time. By default, each update will be executed in a separate transaction. Each
4073 transaction generates a fair amount of overhead which can, thus, be reduced by
4074 activating this option. The draw-back is, that data covering the specified
4075 amount of time will be lost, for example, if a single statement within the
4076 transaction fails or if the database server crashes.
4078 =item B<Host> I<hostname>
4080 Specify the hostname or IP of the PostgreSQL server to connect to. If the
4081 value begins with a slash, it is interpreted as the directory name in which to
4082 look for the UNIX domain socket.
4084 This option is also used to determine the hostname that is associated with a
4085 collected data set. If it has been omitted or either begins with with a slash
4086 or equals B<localhost> it will be replaced with the global hostname definition
4087 of collectd. Any other value will be passed literally to collectd when
4088 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
4090 =item B<Port> I<port>
4092 Specify the TCP port or the local UNIX domain socket file extension of the
4095 =item B<User> I<username>
4097 Specify the username to be used when connecting to the server.
4099 =item B<Password> I<password>
4101 Specify the password to be used when connecting to the server.
4103 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
4105 Specify whether to use an SSL connection when contacting the server. The
4106 following modes are supported:
4108 =item B<Instance> I<name>
4110 Specify the plugin instance name that should be used instead of the database
4111 name (which is the default, if this option has not been specified). This
4112 allows to query multiple databases of the same name on the same host (e.g.
4113 when running multiple database server versions in parallel).
4119 Do not use SSL at all.
4123 First, try to connect without using SSL. If that fails, try using SSL.
4125 =item I<prefer> (default)
4127 First, try to connect using SSL. If that fails, try without using SSL.
4135 =item B<KRBSrvName> I<kerberos_service_name>
4137 Specify the Kerberos service name to use when authenticating with Kerberos 5
4138 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
4139 B<PostgreSQL Documentation> for details.
4141 =item B<Service> I<service_name>
4143 Specify the PostgreSQL service name to use for additional parameters. That
4144 service has to be defined in F<pg_service.conf> and holds additional
4145 connection parameters. See the section "The Connection Service File" in the
4146 B<PostgreSQL Documentation> for details.
4148 =item B<Query> I<query>
4150 Specifies a I<query> which should be executed in the context of the database
4151 connection. This may be any of the predefined or user-defined queries. If no
4152 such option is given, it defaults to "backends", "transactions", "queries",
4153 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
4154 has been specified). Else, the specified queries are used only.
4156 =item B<Writer> I<writer>
4158 Assigns the specified I<writer> backend to the database connection. This
4159 causes all collected data to be send to the database using the settings
4160 defined in the writer configuration (see the section "FILTER CONFIGURATION"
4161 below for details on how to selectively send data to certain plugins).
4163 Each writer will register a flush callback which may be used when having long
4164 transactions enabled (see the B<CommitInterval> option above). When issuing
4165 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
4166 transaction will be committed right away. Two different kinds of flush
4167 callbacks are available with the C<postgresql> plugin:
4173 Flush all writer backends.
4175 =item B<postgresql->I<database>
4177 Flush all writers of the specified I<database> only.
4183 =head2 Plugin C<powerdns>
4185 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
4186 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
4187 values, many of which are probably meaningless to most users, but may be useful
4188 for some. So you may chose which values to collect, but if you don't, some
4189 reasonable defaults will be collected.
4192 <Server "server_name">
4194 Collect "udp-answers" "udp-queries"
4195 Socket "/var/run/pdns.controlsocket"
4197 <Recursor "recursor_name">
4199 Collect "cache-hits" "cache-misses"
4200 Socket "/var/run/pdns_recursor.controlsocket"
4202 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
4207 =item B<Server> and B<Recursor> block
4209 The B<Server> block defines one authoritative server to query, the B<Recursor>
4210 does the same for an recursing server. The possible options in both blocks are
4211 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
4216 =item B<Collect> I<Field>
4218 Using the B<Collect> statement you can select which values to collect. Here,
4219 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
4220 C<dlg-only-drops>, C<answers10-100>.
4222 The method of getting the values differs for B<Server> and B<Recursor> blocks:
4223 When querying the server a C<SHOW *> command is issued in any case, because
4224 that's the only way of getting multiple values out of the server at once.
4225 collectd then picks out the values you have selected. When querying the
4226 recursor, a command is generated to query exactly these values. So if you
4227 specify invalid fields when querying the recursor, a syntax error may be
4228 returned by the daemon and collectd may not collect any values at all.
4230 If no B<Collect> statement is given, the following B<Server> values will be
4237 =item packetcache-hit
4239 =item packetcache-miss
4241 =item packetcache-size
4243 =item query-cache-hit
4245 =item query-cache-miss
4247 =item recursing-answers
4249 =item recursing-questions
4261 The following B<Recursor> values will be collected by default:
4265 =item noerror-answers
4267 =item nxdomain-answers
4269 =item servfail-answers
4287 Please note that up to that point collectd doesn't know what values are
4288 available on the server and values that are added do not need a change of the
4289 mechanism so far. However, the values must be mapped to collectd's naming
4290 scheme, which is done using a lookup table that lists all known values. If
4291 values are added in the future and collectd does not know about them, you will
4292 get an error much like this:
4294 powerdns plugin: submit: Not found in lookup table: foobar = 42
4296 In this case please file a bug report with the collectd team.
4298 =item B<Socket> I<Path>
4300 Configures the path to the UNIX domain socket to be used when connecting to the
4301 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
4302 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
4303 will be used for the recursor.
4307 =item B<LocalSocket> I<Path>
4309 Querying the recursor is done using UDP. When using UDP over UNIX domain
4310 sockets, the client socket needs a name in the file system, too. You can set
4311 this local name to I<Path> using the B<LocalSocket> option. The default is
4312 C<I<prefix>/var/run/collectd-powerdns>.
4316 =head2 Plugin C<processes>
4320 =item B<Process> I<Name>
4322 Select more detailed statistics of processes matching this name. The statistics
4323 collected for these selected processes are size of the resident segment size
4324 (RSS), user- and system-time used, number of processes and number of threads,
4325 io data (where available) and minor and major pagefaults.
4327 =item B<ProcessMatch> I<name> I<regex>
4329 Similar to the B<Process> option this allows to select more detailed
4330 statistics of processes matching the specified I<regex> (see L<regex(7)> for
4331 details). The statistics of all matching processes are summed up and
4332 dispatched to the daemon using the specified I<name> as an identifier. This
4333 allows to "group" several processes together. I<name> must not contain
4338 =head2 Plugin C<protocols>
4340 Collects a lot of information about various network protocols, such as I<IP>,
4341 I<TCP>, I<UDP>, etc.
4343 Available configuration options:
4347 =item B<Value> I<Selector>
4349 Selects whether or not to select a specific value. The string being matched is
4350 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
4351 plugin instance and I<ValueName> will be used as type instance. An example of
4352 the string being used would be C<Tcp:RetransSegs>.
4354 You can use regular expressions to match a large number of values with just one
4355 configuration option. To select all "extended" I<TCP> values, you could use the
4356 following statement:
4360 Whether only matched values are selected or all matched values are ignored
4361 depends on the B<IgnoreSelected>. By default, only matched values are selected.
4362 If no value is configured at all, all values will be selected.
4364 =item B<IgnoreSelected> B<true>|B<false>
4366 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
4367 matching values will be ignored.
4371 =head2 Plugin C<python>
4373 This plugin embeds a Python-interpreter into collectd and provides an interface
4374 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
4376 =head2 Plugin C<routeros>
4378 The C<routeros> plugin connects to a device running I<RouterOS>, the
4379 Linux-based operating system for routers by I<MikroTik>. The plugin uses
4380 I<librouteros> to connect and reads information about the interfaces and
4381 wireless connections of the device. The configuration supports querying
4386 Host "router0.example.com"
4389 CollectInterface true
4394 Host "router1.example.com"
4397 CollectInterface true
4398 CollectRegistrationTable true
4404 As you can see above, the configuration of the I<routeros> plugin consists of
4405 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
4406 options are understood:
4410 =item B<Host> I<Host>
4412 Hostname or IP-address of the router to connect to.
4414 =item B<Port> I<Port>
4416 Port name or port number used when connecting. If left unspecified, the default
4417 will be chosen by I<librouteros>, currently "8728". This option expects a
4418 string argument, even when a numeric port number is given.
4420 =item B<User> I<User>
4422 Use the user name I<User> to authenticate. Defaults to "admin".
4424 =item B<Password> I<Password>
4426 Set the password used to authenticate.
4428 =item B<CollectInterface> B<true>|B<false>
4430 When set to B<true>, interface statistics will be collected for all interfaces
4431 present on the device. Defaults to B<false>.
4433 =item B<CollectRegistrationTable> B<true>|B<false>
4435 When set to B<true>, information about wireless LAN connections will be
4436 collected. Defaults to B<false>.
4438 =item B<CollectCPULoad> B<true>|B<false>
4440 When set to B<true>, information about the CPU usage will be collected. The
4441 number is a dimensionless value where zero indicates no CPU usage at all.
4442 Defaults to B<false>.
4444 =item B<CollectMemory> B<true>|B<false>
4446 When enabled, the amount of used and free memory will be collected. How used
4447 memory is calculated is unknown, for example whether or not caches are counted
4449 Defaults to B<false>.
4451 =item B<CollectDF> B<true>|B<false>
4453 When enabled, the amount of used and free disk space will be collected.
4454 Defaults to B<false>.
4456 =item B<CollectDisk> B<true>|B<false>
4458 When enabled, the number of sectors written and bad blocks will be collected.
4459 Defaults to B<false>.
4463 =head2 Plugin C<redis>
4465 The I<Redis plugin> connects to one or more Redis servers and gathers
4466 information about each server's state. For each server there is a I<Node> block
4467 which configures the connection parameters for this node.
4477 The information shown in the synopsis above is the I<default configuration>
4478 which is used by the plugin if no configuration is present.
4482 =item B<Node> I<Nodename>
4484 The B<Node> block identifies a new Redis node, that is a new Redis instance
4485 running in an specified host and port. The name for node is a canonical
4486 identifier which is used as I<plugin instance>. It is limited to
4487 64E<nbsp>characters in length.
4489 =item B<Host> I<Hostname>
4491 The B<Host> option is the hostname or IP-address where the Redis instance is
4494 =item B<Port> I<Port>
4496 The B<Port> option is the TCP port on which the Redis instance accepts
4497 connections. Either a service name of a port number may be given. Please note
4498 that numerical port numbers must be given as a string, too.
4500 =item B<Password> I<Password>
4502 Use I<Password> to authenticate when connecting to I<Redis>.
4504 =item B<Timeout> I<Timeout in miliseconds>
4506 The B<Timeout> option set the socket timeout for node response. Since the Redis
4507 read function is blocking, you should keep this value as low as possible. Keep
4508 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
4509 than B<Interval> defined globally.
4513 =head2 Plugin C<rrdcached>
4515 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
4516 to store values to RRD files in an efficient manner. The combination of the
4517 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
4518 way the C<rrdtool> plugin works (see below). The added abstraction layer
4519 provides a number of benefits, though: Because the cache is not within
4520 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
4521 restarted. This results in much shorter (if any) gaps in graphs, especially
4522 under heavy load. Also, the C<rrdtool> command line utility is aware of the
4523 daemon so that it can flush values to disk automatically when needed. This
4524 allows to integrate automated flushing of values into graphing solutions much
4527 There are disadvantages, though: The daemon may reside on a different host, so
4528 it may not be possible for C<collectd> to create the appropriate RRD files
4529 anymore. And even if C<rrdcached> runs on the same host, it may run in a
4530 different base directory, so relative paths may do weird stuff if you're not
4533 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
4534 on the same host, communicating via a UNIX domain socket. The B<DataDir>
4535 setting should be set to an absolute path, so that a changed base directory
4536 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
4540 =item B<DaemonAddress> I<Address>
4542 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
4543 library. See L<rrdcached(1)> for details. Example:
4545 <Plugin "rrdcached">
4546 DaemonAddress "unix:/var/run/rrdcached.sock"
4549 =item B<DataDir> I<Directory>
4551 Set the base directory in which the RRD files reside. If this is a relative
4552 path, it is relative to the working base directory of the C<rrdcached> daemon!
4553 Use of an absolute path is recommended.
4555 =item B<CreateFiles> B<true>|B<false>
4557 Enables or disables the creation of RRD files. If the daemon is not running
4558 locally, or B<DataDir> is set to a relative path, this will not work as
4559 expected. Default is B<true>.
4561 =item B<StepSize> I<Seconds>
4563 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
4564 this setting is unset and the stepsize is set to the interval in which the data
4565 is collected. Do not use this option unless you absolutely have to for some
4566 reason. Setting this option may cause problems with the C<snmp plugin>, the
4567 C<exec plugin> or when the daemon is set up to receive data from other hosts.
4569 =item B<HeartBeat> I<Seconds>
4571 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
4572 in which case the heartbeat is set to twice the B<StepSize> which should equal
4573 the interval in which data is collected. Do not set this option unless you have
4574 a very good reason to do so.
4576 =item B<RRARows> I<NumRows>
4578 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
4579 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
4580 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
4581 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
4582 week, one month, and one year.
4584 So for each timespan, it calculates how many PDPs need to be consolidated into
4585 one CDP by calculating:
4586 number of PDPs = timespan / (stepsize * rrarows)
4588 Bottom line is, set this no smaller than the width of you graphs in pixels. The
4591 =item B<RRATimespan> I<Seconds>
4593 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
4594 more then one RRA. If this option is never used, the built-in default of (3600,
4595 86400, 604800, 2678400, 31622400) is used.
4597 For more information on how RRA-sizes are calculated see B<RRARows> above.
4599 =item B<XFF> I<Factor>
4601 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
4602 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
4607 =head2 Plugin C<rrdtool>
4609 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
4610 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
4611 using these settings. If you don't want to dive into the depths of RRDtool, you
4612 can safely ignore these settings.
4616 =item B<DataDir> I<Directory>
4618 Set the directory to store RRD-files under. Per default RRD-files are generated
4619 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
4621 =item B<StepSize> I<Seconds>
4623 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
4624 this setting is unset and the stepsize is set to the interval in which the data
4625 is collected. Do not use this option unless you absolutely have to for some
4626 reason. Setting this option may cause problems with the C<snmp plugin>, the
4627 C<exec plugin> or when the daemon is set up to receive data from other hosts.
4629 =item B<HeartBeat> I<Seconds>
4631 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
4632 in which case the heartbeat is set to twice the B<StepSize> which should equal
4633 the interval in which data is collected. Do not set this option unless you have
4634 a very good reason to do so.
4636 =item B<RRARows> I<NumRows>
4638 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
4639 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
4640 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
4641 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
4642 week, one month, and one year.
4644 So for each timespan, it calculates how many PDPs need to be consolidated into
4645 one CDP by calculating:
4646 number of PDPs = timespan / (stepsize * rrarows)
4648 Bottom line is, set this no smaller than the width of you graphs in pixels. The
4651 =item B<RRATimespan> I<Seconds>
4653 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
4654 more then one RRA. If this option is never used, the built-in default of (3600,
4655 86400, 604800, 2678400, 31622400) is used.
4657 For more information on how RRA-sizes are calculated see B<RRARows> above.
4659 =item B<XFF> I<Factor>
4661 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
4662 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
4665 =item B<CacheFlush> I<Seconds>
4667 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
4668 it writes all values for a certain RRD-file if the oldest value is older than
4669 (or equal to) the number of seconds specified. If some RRD-file is not updated
4670 anymore for some reason (the computer was shut down, the network is broken,
4671 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
4672 entire cache is searched for entries older than B<CacheTimeout> seconds and
4673 written to disk every I<Seconds> seconds. Since this is kind of expensive and
4674 does nothing under normal circumstances, this value should not be too small.
4675 900 seconds might be a good value, though setting this to 7200 seconds doesn't
4676 normally do much harm either.
4678 =item B<CacheTimeout> I<Seconds>
4680 If this option is set to a value greater than zero, the C<rrdtool plugin> will
4681 save values in a cache, as described above. Writing multiple values at once
4682 reduces IO-operations and thus lessens the load produced by updating the files.
4683 The trade off is that the graphs kind of "drag behind" and that more memory is
4686 =item B<WritesPerSecond> I<Updates>
4688 When collecting many statistics with collectd and the C<rrdtool> plugin, you
4689 will run serious performance problems. The B<CacheFlush> setting and the
4690 internal update queue assert that collectd continues to work just fine even
4691 under heavy load, but the system may become very unresponsive and slow. This is
4692 a problem especially if you create graphs from the RRD files on the same
4693 machine, for example using the C<graph.cgi> script included in the
4694 C<contrib/collection3/> directory.
4696 This setting is designed for very large setups. Setting this option to a value
4697 between 25 and 80 updates per second, depending on your hardware, will leave
4698 the server responsive enough to draw graphs even while all the cached values
4699 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
4700 by the B<FLUSH> command, are B<not> effected by this limit. They are still
4701 written as fast as possible, so that web frontends have up to date data when
4704 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
4705 updates per second, writing all values to disk will take approximately
4706 56E<nbsp>minutes. Together with the flushing ability that's integrated into
4707 "collection3" you'll end up with a responsive and fast system, up to date
4708 graphs and basically a "backup" of your values every hour.
4710 =item B<RandomTimeout> I<Seconds>
4712 When set, the actual timeout for each value is chosen randomly between
4713 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
4714 intention is to avoid high load situations that appear when many values timeout
4715 at the same time. This is especially a problem shortly after the daemon starts,
4716 because all values were added to the internal cache at roughly the same time.
4720 =head2 Plugin C<sensors>
4722 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
4723 that all the needed modules have to be loaded and lm_sensors has to be
4724 configured (most likely by editing F</etc/sensors.conf>. Read
4725 L<sensors.conf(5)> for details.
4727 The B<lm_sensors> homepage can be found at
4728 L<http://secure.netroedge.com/~lm78/>.
4732 =item B<SensorConfigFile> I<File>
4734 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
4735 the library's default will be used.
4737 =item B<Sensor> I<chip-bus-address/type-feature>
4739 Selects the name of the sensor which you want to collect or ignore, depending
4740 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
4741 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
4742 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
4744 =item B<IgnoreSelected> I<true>|I<false>
4746 If no configuration if given, the B<sensors>-plugin will collect data from all
4747 sensors. This may not be practical, especially for uninteresting sensors.
4748 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
4749 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
4750 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
4751 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
4752 and all other sensors are collected.
4756 =head2 Plugin C<snmp>
4758 Since the configuration of the C<snmp plugin> is a little more complicated than
4759 other plugins, its documentation has been moved to an own manpage,
4760 L<collectd-snmp(5)>. Please see there for details.
4762 =head2 Plugin C<swap>
4764 The I<Swap plugin> collects information about used and available swap space. On
4765 I<Linux> and I<Solaris>, the following options are available:
4769 =item B<ReportByDevice> B<false>|B<true>
4771 Configures how to report physical swap devices. If set to B<false> (the
4772 default), the summary over all swap devices is reported only, i.e. the globally
4773 used and available space over all devices. If B<true> is configured, the used
4774 and available space of each device will be reported separately.
4776 This option is only available if the I<Swap plugin> can read C</proc/swaps>
4777 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
4779 =item B<ReportBytes> B<false>|B<true>
4781 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
4782 I<swap I/O> is reported in pages. This option is available under Linux only.
4786 =head2 Plugin C<syslog>
4790 =item B<LogLevel> B<debug|info|notice|warning|err>
4792 Sets the log-level. If, for example, set to B<notice>, then all events with
4793 severity B<notice>, B<warning>, or B<err> will be submitted to the
4796 Please note that B<debug> is only available if collectd has been compiled with
4799 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
4801 Controls which notifications should be sent to syslog. The default behaviour is
4802 not to send any. Less severe notifications always imply logging more severe
4803 notifications: Setting this to B<OKAY> means all notifications will be sent to
4804 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
4805 notifications but will dismiss B<OKAY> notifications. Setting this option to
4806 B<FAILURE> will only send failures to syslog.
4810 =head2 Plugin C<table>
4812 The C<table plugin> provides generic means to parse tabular data and dispatch
4813 user specified values. Values are selected based on column numbers. For
4814 example, this plugin may be used to get values from the Linux L<proc(5)>
4815 filesystem or CSV (comma separated values) files.
4818 <Table "/proc/slabinfo">
4823 InstancePrefix "active_objs"
4829 InstancePrefix "objperslab"
4836 The configuration consists of one or more B<Table> blocks, each of which
4837 configures one file to parse. Within each B<Table> block, there are one or
4838 more B<Result> blocks, which configure which data to select and how to
4841 The following options are available inside a B<Table> block:
4845 =item B<Instance> I<instance>
4847 If specified, I<instance> is used as the plugin instance. So, in the above
4848 example, the plugin name C<table-slabinfo> would be used. If omitted, the
4849 filename of the table is used instead, with all special characters replaced
4850 with an underscore (C<_>).
4852 =item B<Separator> I<string>
4854 Any character of I<string> is interpreted as a delimiter between the different
4855 columns of the table. A sequence of two or more contiguous delimiters in the
4856 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
4857 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
4858 of a table - see its documentation for more details. This option is mandatory.
4860 A horizontal tab, newline and carriage return may be specified by C<\\t>,
4861 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
4862 required because of collectd's config parsing.
4866 The following options are available inside a B<Result> block:
4870 =item B<Type> I<type>
4872 Sets the type used to dispatch the values to the daemon. Detailed information
4873 about types and their configuration can be found in L<types.db(5)>. This
4874 option is mandatory.
4876 =item B<InstancePrefix> I<prefix>
4878 If specified, prepend I<prefix> to the type instance. If omitted, only the
4879 B<InstancesFrom> option is considered for the type instance.
4881 =item B<InstancesFrom> I<column0> [I<column1> ...]
4883 If specified, the content of the given columns (identified by the column
4884 number starting at zero) will be used to create the type instance for each
4885 row. Multiple values (and the instance prefix) will be joined together with
4886 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
4887 option is considered for the type instance.
4889 The plugin itself does not check whether or not all built instances are
4890 different. It’s your responsibility to assure that each is unique. This is
4891 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
4892 sure that the table only contains one row.
4894 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
4897 =item B<ValuesFrom> I<column0> [I<column1> ...]
4899 Specifies the columns (identified by the column numbers starting at zero)
4900 whose content is used as the actual data for the data sets that are dispatched
4901 to the daemon. How many such columns you need is determined by the B<Type>
4902 setting above. If you specify too many or not enough columns, the plugin will
4903 complain about that and no data will be submitted to the daemon. The plugin
4904 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
4905 respectively, so anything supported by those functions is supported by the
4906 plugin as well. This option is mandatory.
4910 =head2 Plugin C<tail>
4912 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
4913 each line and dispatches found values. What is matched can be configured by the
4914 user using (extended) regular expressions, as described in L<regex(7)>.
4917 <File "/var/log/exim4/mainlog">
4920 Regex "S=([1-9][0-9]*)"
4926 Regex "\\<R=local_user\\>"
4927 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
4930 Instance "local_user"
4935 The config consists of one or more B<File> blocks, each of which configures one
4936 logfile to parse. Within each B<File> block, there are one or more B<Match>
4937 blocks, which configure a regular expression to search for.
4939 The B<Instance> option in the B<File> block may be used to set the plugin
4940 instance. So in the above example the plugin name C<tail-foo> would be used.
4941 This plugin instance is for all B<Match> blocks that B<follow> it, until the
4942 next B<Instance> option. This way you can extract several plugin instances from
4943 one logfile, handy when parsing syslog and the like.
4945 Each B<Match> block has the following options to describe how the match should
4950 =item B<Regex> I<regex>
4952 Sets the regular expression to use for matching against a line. The first
4953 subexpression has to match something that can be turned into a number by
4954 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
4955 below. Because B<extended> regular expressions are used, you do not need to use
4956 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
4957 collectd's config parsing you need to escape backslashes, though. So if you
4958 want to match literal parentheses you need to do the following:
4960 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
4962 =item B<ExcludeRegex> I<regex>
4964 Sets an optional regular expression to use for excluding lines from the match.
4965 An example which excludes all connections from localhost from the match:
4967 ExcludeRegex "127\\.0\\.0\\.1"
4969 =item B<DSType> I<Type>
4971 Sets how the values are cumulated. I<Type> is one of:
4975 =item B<GaugeAverage>
4977 Calculate the average.
4981 Use the smallest number only.
4985 Use the greatest number only.
4989 Use the last number found.
4995 =item B<AbsoluteSet>
4997 The matched number is a counter. Simply I<sets> the internal counter to this
4998 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
5004 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
5005 matched number may be negative, which will effectively subtract from the
5012 Increase the internal counter by one. These B<DSType> are the only ones that do
5013 not use the matched subexpression, but simply count the number of matched
5014 lines. Thus, you may use a regular expression without submatch in this case.
5018 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
5019 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
5020 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
5021 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
5022 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
5025 =item B<Type> I<Type>
5027 Sets the type used to dispatch this value. Detailed information about types and
5028 their configuration can be found in L<types.db(5)>.
5030 =item B<Instance> I<TypeInstance>
5032 This optional setting sets the type instance to use.
5036 =head2 Plugin C<teamspeak2>
5038 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
5039 polls interesting global and virtual server data. The plugin can query only one
5040 physical server but unlimited virtual servers. You can use the following
5041 options to configure it:
5045 =item B<Host> I<hostname/ip>
5047 The hostname or ip which identifies the physical server.
5050 =item B<Port> I<port>
5052 The query port of the physical server. This needs to be a string.
5055 =item B<Server> I<port>
5057 This option has to be added once for every virtual server the plugin should
5058 query. If you want to query the virtual server on port 8767 this is what the
5059 option would look like:
5063 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
5064 use quotes around it! If no such statement is given only global information
5069 =head2 Plugin C<ted>
5071 The I<TED> plugin connects to a device of "The Energy Detective", a device to
5072 measure power consumption. These devices are usually connected to a serial
5073 (RS232) or USB port. The plugin opens a configured device and tries to read the
5074 current energy readings. For more information on TED, visit
5075 L<http://www.theenergydetective.com/>.
5077 Available configuration options:
5081 =item B<Device> I<Path>
5083 Path to the device on which TED is connected. collectd will need read and write
5084 permissions on that file.
5086 Default: B</dev/ttyUSB0>
5088 =item B<Retries> I<Num>
5090 Apparently reading from TED is not that reliable. You can therefore configure a
5091 number of retries here. You only configure the I<retries> here, to if you
5092 specify zero, one reading will be performed (but no retries if that fails); if
5093 you specify three, a maximum of four readings are performed. Negative values
5100 =head2 Plugin C<tcpconns>
5102 The C<tcpconns plugin> counts the number of currently established TCP
5103 connections based on the local port and/or the remote port. Since there may be
5104 a lot of connections the default if to count all connections with a local port,
5105 for which a listening socket is opened. You can use the following options to
5106 fine-tune the ports you are interested in:
5110 =item B<ListeningPorts> I<true>|I<false>
5112 If this option is set to I<true>, statistics for all local ports for which a
5113 listening socket exists are collected. The default depends on B<LocalPort> and
5114 B<RemotePort> (see below): If no port at all is specifically selected, the
5115 default is to collect listening ports. If specific ports (no matter if local or
5116 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
5117 the selected ports will be collected unless this option is set to I<true>
5120 =item B<LocalPort> I<Port>
5122 Count the connections to a specific local port. This can be used to see how
5123 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
5124 You have to specify the port in numeric form, so for the mailserver example
5125 you'd need to set B<25>.
5127 =item B<RemotePort> I<Port>
5129 Count the connections to a specific remote port. This is useful to see how
5130 much a remote service is used. This is most useful if you want to know how many
5131 connections a local service has opened to remote services, e.E<nbsp>g. how many
5132 connections a mail server or news server has to other mail or news servers, or
5133 how many connections a web proxy holds to web servers. You have to give the
5134 port in numeric form.
5138 =head2 Plugin C<thermal>
5142 =item B<ForceUseProcfs> I<true>|I<false>
5144 By default, the I<Thermal plugin> tries to read the statistics from the Linux
5145 C<sysfs> interface. If that is not available, the plugin falls back to the
5146 C<procfs> interface. By setting this option to I<true>, you can force the
5147 plugin to use the latter. This option defaults to I<false>.
5149 =item B<Device> I<Device>
5151 Selects the name of the thermal device that you want to collect or ignore,
5152 depending on the value of the B<IgnoreSelected> option. This option may be
5153 used multiple times to specify a list of devices.
5155 =item B<IgnoreSelected> I<true>|I<false>
5157 Invert the selection: If set to true, all devices B<except> the ones that
5158 match the device names specified by the B<Device> option are collected. By
5159 default only selected devices are collected if a selection is made. If no
5160 selection is configured at all, B<all> devices are selected.
5164 =head2 Plugin C<threshold>
5166 The I<Threshold plugin> checks values collected or received by I<collectd>
5167 against a configurable I<threshold> and issues I<notifications> if values are
5170 Documentation for this plugin is available in the L<collectd-threshold(5)>
5173 =head2 Plugin C<tokyotyrant>
5175 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
5176 couple metrics: number of records, and database size on disk.
5180 =item B<Host> I<Hostname/IP>
5182 The hostname or ip which identifies the server.
5183 Default: B<127.0.0.1>
5185 =item B<Port> I<Service/Port>
5187 The query port of the server. This needs to be a string, even if the port is
5188 given in its numeric form.
5193 =head2 Plugin C<unixsock>
5197 =item B<SocketFile> I<Path>
5199 Sets the socket-file which is to be created.
5201 =item B<SocketGroup> I<Group>
5203 If running as root change the group of the UNIX-socket after it has been
5204 created. Defaults to B<collectd>.
5206 =item B<SocketPerms> I<Permissions>
5208 Change the file permissions of the UNIX-socket after it has been created. The
5209 permissions must be given as a numeric, octal value as you would pass to
5210 L<chmod(1)>. Defaults to B<0770>.
5212 =item B<DeleteSocket> B<false>|B<true>
5214 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
5215 with the given name already exists. If I<collectd> crashes a socket file may be
5216 left over, preventing the daemon from opening a new socket when restarted.
5217 Since this is potentially dangerous, this defaults to B<false>.
5221 =head2 Plugin C<uuid>
5223 This plugin, if loaded, causes the Hostname to be taken from the machine's
5224 UUID. The UUID is a universally unique designation for the machine, usually
5225 taken from the machine's BIOS. This is most useful if the machine is running in
5226 a virtual environment such as Xen, in which case the UUID is preserved across
5227 shutdowns and migration.
5229 The following methods are used to find the machine's UUID, in order:
5235 Check I</etc/uuid> (or I<UUIDFile>).
5239 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
5244 Check for UUID from C<dmidecode> / SMBIOS.
5248 Check for UUID from Xen hypervisor.
5252 If no UUID can be found then the hostname is not modified.
5256 =item B<UUIDFile> I<Path>
5258 Take the UUID from the given file (default I</etc/uuid>).
5262 =head2 Plugin C<varnish>
5264 The Varnish plugin collects information about Varnish, an HTTP accelerator.
5268 =item B<CollectCache> B<true>|B<false>
5270 Cache hits and misses. True by default.
5272 =item B<CollectConnections> B<true>|B<false>
5274 Number of client connections received, accepted and dropped. True by default.
5276 =item B<CollectBackend> B<true>|B<false>
5278 Back-end connection statistics, such as successful, reused,
5279 and closed connections. True by default.
5281 =item B<CollectSHM> B<true>|B<false>
5283 Statistics about the shared memory log, a memory region to store
5284 log messages which is flushed to disk when full. True by default.
5286 =item B<CollectESI> B<true>|B<false>
5288 Edge Side Includes (ESI) parse statistics. False by default.
5290 =item B<CollectFetch> B<true>|B<false>
5292 Statistics about fetches (HTTP requests sent to the backend). False by default.
5294 =item B<CollectHCB> B<true>|B<false>
5296 Inserts and look-ups in the crit bit tree based hash. Look-ups are
5297 divided into locked and unlocked look-ups. False by default.
5299 =item B<CollectSMA> B<true>|B<false>
5301 malloc or umem (umem_alloc(3MALLOC) based) storage statistics.
5302 The umem storage component is Solaris specific. False by default.
5304 =item B<CollectSMS> B<true>|B<false>
5306 synth (synthetic content) storage statistics. This storage
5307 component is used internally only. False by default.
5309 =item B<CollectSM> B<true>|B<false>
5311 file (memory mapped file) storage statistics. False by default.
5313 =item B<CollectTotals> B<true>|B<false>
5315 Collects overview counters, such as the number of sessions created,
5316 the number of requests and bytes transferred. False by default.
5318 =item B<CollectWorkers> B<true>|B<false>
5320 Collect statistics about worker threads. False by default.
5324 =head2 Plugin C<vmem>
5326 The C<vmem> plugin collects information about the usage of virtual memory.
5327 Since the statistics provided by the Linux kernel are very detailed, they are
5328 collected very detailed. However, to get all the details, you have to switch
5329 them on manually. Most people just want an overview over, such as the number of
5330 pages read from swap space.
5334 =item B<Verbose> B<true>|B<false>
5336 Enables verbose collection of information. This will start collecting page
5337 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
5338 Part of these statistics are collected on a "per zone" basis.
5342 =head2 Plugin C<vserver>
5344 This plugin doesn't have any options. B<VServer> support is only available for
5345 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
5346 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
5347 need to apply the patches and compile your own kernel, which will then provide
5348 the F</proc/virtual> filesystem that is required by this plugin.
5350 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
5352 B<Note>: The traffic collected by this plugin accounts for the amount of
5353 traffic passing a socket which might be a lot less than the actual on-wire
5354 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
5355 collect on-wire traffic you could, for example, use the logging facilities of
5356 iptables to feed data for the guest IPs into the iptables plugin.
5358 =head2 Plugin C<write_graphite>
5360 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
5361 storage and graphing project. The plugin connects to I<Carbon>, the data layer
5362 of I<Graphite>, and sends data via the "line based" protocol (per default using
5363 portE<nbsp>2003). The data will be sent in blocks of at most 1428 bytes to
5364 minimize the number of network packets.
5368 <Plugin write_graphite>
5378 =item B<Host> I<Address>
5380 Hostname or address to connect to. Defaults to C<localhost>.
5382 =item B<Port> I<Service>
5384 Service name or port number to connect to. Defaults to C<2003>.
5386 =item B<Prefix> I<String>
5388 When set, I<String> is added in front of the host name. Dots and whitespace are
5389 I<not> escaped in this string (see B<EscapeCharacter> below).
5391 =item B<Postfix> I<String>
5393 When set, I<String> is appended to the host name. Dots and whitespace are
5394 I<not> escaped in this string (see B<EscapeCharacter> below).
5396 =item B<EscapeCharacter> I<Char>
5398 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
5399 in the identifier. The B<EscapeCharacter> option determines which character
5400 dots, whitespace and control characters are replaced with. Defaults to
5403 =item B<StoreRates> B<false>|B<true>
5405 If set to B<true> (the default), convert counter values to rates. If set to
5406 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
5409 =item B<SeparateInstances> B<false>|B<true>
5411 If set to B<true>, the plugin instance and type instance will be in their own
5412 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
5413 default), the plugin and plugin instance (and likewise the type and type
5414 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
5416 =item B<AlwaysAppendDS> B<false>|B<true>
5418 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
5419 identifier. If set to B<false> (the default), this is only done when there is
5424 =head2 Plugin C<write_mongodb>
5426 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
5431 <Plugin "write_mongodb">
5440 The plugin can send values to multiple instances of I<MongoDB> by specifying
5441 one B<Node> block for each instance. Within the B<Node> blocks, the following
5442 options are available:
5446 =item B<Host> I<Address>
5448 Hostname or address to connect to. Defaults to C<localhost>.
5450 =item B<Port> I<Service>
5452 Service name or port number to connect to. Defaults to C<27017>.
5454 =item B<Timeout> I<Timeout>
5456 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
5457 Setting this option to zero means no timeout, which is the default.
5459 =item B<StoreRates> B<false>|B<true>
5461 If set to B<true> (the default), convert counter values to rates. If set to
5462 B<false> counter values are stored as is, i.e. as an increasing integer
5467 =head2 Plugin C<write_http>
5469 This output plugin submits values to an http server by POST them using the
5470 PUTVAL plain-text protocol. Each destination you want to post data to needs to
5471 have one B<URL> block, within which the destination can be configured further,
5472 for example by specifying authentication data.
5476 <Plugin "write_http">
5477 <URL "http://example.com/post-collectd">
5483 B<URL> blocks need one string argument which is used as the URL to which data
5484 is posted. The following options are understood within B<URL> blocks.
5488 =item B<User> I<Username>
5490 Optional user name needed for authentication.
5492 =item B<Password> I<Password>
5494 Optional password needed for authentication.
5496 =item B<VerifyPeer> B<true>|B<false>
5498 Enable or disable peer SSL certificate verification. See
5499 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5501 =item B<VerifyHost> B<true|false>
5503 Enable or disable peer host name verification. If enabled, the plugin checks if
5504 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
5505 matches the host name provided by the B<URL> option. If this identity check
5506 fails, the connection is aborted. Obviously, only works when connecting to a
5507 SSL enabled server. Enabled by default.
5509 =item B<CACert> I<File>
5511 File that holds one or more SSL certificates. If you want to use HTTPS you will
5512 possibly need this option. What CA certificates come bundled with C<libcurl>
5513 and are checked by default depends on the distribution you use.
5515 =item B<Format> B<Command>|B<JSON>
5517 Format of the output to generate. If set to B<Command>, will create output that
5518 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
5519 create output in the I<JavaScript Object Notation> (JSON).
5521 Defaults to B<Command>.
5523 =item B<StoreRates> B<true|false>
5525 If set to B<true>, convert counter values to rates. If set to B<false> (the
5526 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
5531 =head1 THRESHOLD CONFIGURATION
5533 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
5534 we mean that the values are not only stored or sent somewhere, but that they
5535 are judged and, if a problem is recognized, acted upon. The only action
5536 collectd takes itself is to generate and dispatch a "notification". Plugins can
5537 register to receive notifications and perform appropriate further actions.
5539 Since systems and what you expect them to do differ a lot, you can configure
5540 B<thresholds> for your values freely. This gives you a lot of flexibility but
5541 also a lot of responsibility.
5543 Every time a value is out of range a notification is dispatched. This means
5544 that the idle percentage of your CPU needs to be less then the configured
5545 threshold only once for a notification to be generated. There's no such thing
5546 as a moving average or similar - at least not now.
5548 Also, all values that match a threshold are considered to be relevant or
5549 "interesting". As a consequence collectd will issue a notification if they are
5550 not received for B<Timeout> iterations. The B<Timeout> configuration option is
5551 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
5552 "2" (the default) and some hosts sends it's CPU statistics to the server every
5553 60 seconds, a notification will be dispatched after about 120 seconds. It may
5554 take a little longer because the timeout is checked only once each B<Interval>
5557 When a value comes within range again or is received after it was missing, an
5558 "OKAY-notification" is dispatched.
5560 Here is a configuration example to get you started. Read below for more
5573 <Plugin "interface">
5590 WarningMin 100000000
5596 There are basically two types of configuration statements: The C<Host>,
5597 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
5598 configured. The C<Plugin> and C<Type> blocks may be specified further using the
5599 C<Instance> option. You can combine the block by nesting the blocks, though
5600 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
5601 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
5602 C<Type> may not contain other blocks. If multiple blocks apply to the same
5603 value the most specific block is used.
5605 The other statements specify the threshold to configure. They B<must> be
5606 included in a C<Type> block. Currently the following statements are recognized:
5610 =item B<FailureMax> I<Value>
5612 =item B<WarningMax> I<Value>
5614 Sets the upper bound of acceptable values. If unset defaults to positive
5615 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
5616 will be created. If the value is greater than B<WarningMax> but less than (or
5617 equal to) B<FailureMax> a B<WARNING> notification will be created.
5619 =item B<FailureMin> I<Value>
5621 =item B<WarningMin> I<Value>
5623 Sets the lower bound of acceptable values. If unset defaults to negative
5624 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
5625 be created. If the value is less than B<WarningMin> but greater than (or equal
5626 to) B<FailureMin> a B<WARNING> notification will be created.
5628 =item B<DataSource> I<DSName>
5630 Some data sets have more than one "data source". Interesting examples are the
5631 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
5632 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
5633 system load data set, C<load>, even has three data sources: C<shortterm>,
5634 C<midterm>, and C<longterm>.
5636 Normally, all data sources are checked against a configured threshold. If this
5637 is undesirable, or if you want to specify different limits for each data
5638 source, you can use the B<DataSource> option to have a threshold apply only to
5641 =item B<Invert> B<true>|B<false>
5643 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
5644 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
5645 B<WarningMax>) are not okay. Defaults to B<false>.
5647 =item B<Persist> B<true>|B<false>
5649 Sets how often notifications are generated. If set to B<true> one notification
5650 will be generated for each value that is out of the acceptable range. If set to
5651 B<false> (the default) then a notification is only generated if a value is out
5652 of range but the previous value was okay.
5654 This applies to missing values, too: If set to B<true> a notification about a
5655 missing value is generated once every B<Interval> seconds. If set to B<false>
5656 only one such notification is generated until the value appears again.
5658 =item B<Percentage> B<true>|B<false>
5660 If set to B<true>, the minimum and maximum values given are interpreted as
5661 percentage value, relative to the other data sources. This is helpful for
5662 example for the "df" type, where you may want to issue a warning when less than
5663 5E<nbsp>% of the total space is available. Defaults to B<false>.
5665 =item B<Hits> I<Number>
5667 Delay creating the notification until the threshold has been passed I<Number>
5668 times. When a notification has been generated, or when a subsequent value is
5669 inside the threshold, the counter is reset. If, for example, a value is
5670 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
5671 will be dispatched at most once every 30E<nbsp>seconds.
5673 This is useful when short bursts are not a problem. If, for example, 100% CPU
5674 usage for up to a minute is normal (and data is collected every
5675 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
5677 =item B<Hysteresis> I<Number>
5679 When set to non-zero, a hysteresis value is applied when checking minimum and
5680 maximum bounds. This is useful for values that increase slowly and fluctuate a
5681 bit while doing so. When these values come close to the threshold, they may
5682 "flap", i.e. switch between failure / warning case and okay case repeatedly.
5684 If, for example, the threshold is configures as
5689 then a I<Warning> notification is created when the value exceeds I<101> and the
5690 corresponding I<Okay> notification is only created once the value falls below
5691 I<99>, thus avoiding the "flapping".
5695 =head1 FILTER CONFIGURATION
5697 Starting with collectd 4.6 there is a powerful filtering infrastructure
5698 implemented in the daemon. The concept has mostly been copied from
5699 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
5700 terminology, so that users that are familiar with iptables feel right at home.
5704 The following are the terms used in the remainder of the filter configuration
5705 documentation. For an ASCII-art schema of the mechanism, see
5706 L<"General structure"> below.
5712 A I<match> is a criteria to select specific values. Examples are, of course, the
5713 name of the value or it's current value.
5715 Matches are implemented in plugins which you have to load prior to using the
5716 match. The name of such plugins starts with the "match_" prefix.
5720 A I<target> is some action that is to be performed with data. Such actions
5721 could, for example, be to change part of the value's identifier or to ignore
5722 the value completely.
5724 Some of these targets are built into the daemon, see L<"Built-in targets">
5725 below. Other targets are implemented in plugins which you have to load prior to
5726 using the target. The name of such plugins starts with the "target_" prefix.
5730 The combination of any number of matches and at least one target is called a
5731 I<rule>. The target actions will be performed for all values for which B<all>
5732 matches apply. If the rule does not have any matches associated with it, the
5733 target action will be performed for all values.
5737 A I<chain> is a list of rules and possibly default targets. The rules are tried
5738 in order and if one matches, the associated target will be called. If a value
5739 is handled by a rule, it depends on the target whether or not any subsequent
5740 rules are considered or if traversal of the chain is aborted, see
5741 L<"Flow control"> below. After all rules have been checked, the default targets
5746 =head2 General structure
5748 The following shows the resulting structure:
5755 +---------+ +---------+ +---------+ +---------+
5756 ! Rule !->! Match !->! Match !->! Target !
5757 +---------+ +---------+ +---------+ +---------+
5760 +---------+ +---------+ +---------+
5761 ! Rule !->! Target !->! Target !
5762 +---------+ +---------+ +---------+
5769 +---------+ +---------+ +---------+
5770 ! Rule !->! Match !->! Target !
5771 +---------+ +---------+ +---------+
5781 There are four ways to control which way a value takes through the filter
5788 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
5789 process the value with another chain. When the called chain finishes, usually
5790 the next target or rule after the jump is executed.
5794 The stop condition, signaled for example by the built-in target B<stop>, causes
5795 all processing of the value to be stopped immediately.
5799 Causes processing in the current chain to be aborted, but processing of the
5800 value generally will continue. This means that if the chain was called via
5801 B<Jump>, the next target or rule after the jump will be executed. If the chain
5802 was not called by another chain, control will be returned to the daemon and it
5803 may pass the value to another chain.
5807 Most targets will signal the B<continue> condition, meaning that processing
5808 should continue normally. There is no special built-in target for this
5815 The configuration reflects this structure directly:
5817 PostCacheChain "PostCache"
5819 <Rule "ignore_mysql_show">
5822 Type "^mysql_command$"
5823 TypeInstance "^show_"
5833 The above configuration example will ignore all values where the plugin field
5834 is "mysql", the type is "mysql_command" and the type instance begins with
5835 "show_". All other values will be sent to the C<rrdtool> write plugin via the
5836 default target of the chain. Since this chain is run after the value has been
5837 added to the cache, the MySQL C<show_*> command statistics will be available
5838 via the C<unixsock> plugin.
5840 =head2 List of configuration options
5844 =item B<PreCacheChain> I<ChainName>
5846 =item B<PostCacheChain> I<ChainName>
5848 Configure the name of the "pre-cache chain" and the "post-cache chain". The
5849 argument is the name of a I<chain> that should be executed before and/or after
5850 the values have been added to the cache.
5852 To understand the implications, it's important you know what is going on inside
5853 I<collectd>. The following diagram shows how values are passed from the
5854 read-plugins to the write-plugins:
5860 + - - - - V - - - - +
5861 : +---------------+ :
5864 : +-------+-------+ :
5867 : +-------+-------+ : +---------------+
5868 : ! Cache !--->! Value Cache !
5869 : ! insert ! : +---+---+-------+
5870 : +-------+-------+ : ! !
5871 : ! ,------------' !
5873 : +-------+---+---+ : +-------+-------+
5874 : ! Post-Cache +--->! Write-Plugins !
5875 : ! Chain ! : +---------------+
5876 : +---------------+ :
5879 + - - - - - - - - - +
5881 After the values are passed from the "read" plugins to the dispatch functions,
5882 the pre-cache chain is run first. The values are added to the internal cache
5883 afterwards. The post-cache chain is run after the values have been added to the
5884 cache. So why is it such a huge deal if chains are run before or after the
5885 values have been added to this cache?
5887 Targets that change the identifier of a value list should be executed before
5888 the values are added to the cache, so that the name in the cache matches the
5889 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
5890 this cache to receive a list of all available values. If you change the
5891 identifier after the value list has been added to the cache, this may easily
5892 lead to confusion, but it's not forbidden of course.
5894 The cache is also used to convert counter values to rates. These rates are, for
5895 example, used by the C<value> match (see below). If you use the rate stored in
5896 the cache B<before> the new value is added, you will use the old, B<previous>
5897 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
5898 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
5901 Last but not last, the B<stop> target makes a difference: If the pre-cache
5902 chain returns the stop condition, the value will not be added to the cache and
5903 the post-cache chain will not be run.
5905 =item B<Chain> I<Name>
5907 Adds a new chain with a certain name. This name can be used to refer to a
5908 specific chain, for example to jump to it.
5910 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
5912 =item B<Rule> [I<Name>]
5914 Adds a new rule to the current chain. The name of the rule is optional and
5915 currently has no meaning for the daemon.
5917 Within the B<Rule> block, there may be any number of B<Match> blocks and there
5918 must be at least one B<Target> block.
5920 =item B<Match> I<Name>
5922 Adds a match to a B<Rule> block. The name specifies what kind of match should
5923 be performed. Available matches depend on the plugins that have been loaded.
5925 The arguments inside the B<Match> block are passed to the plugin implementing
5926 the match, so which arguments are valid here depends on the plugin being used.
5927 If you do not need any to pass any arguments to a match, you can use the
5932 Which is equivalent to:
5937 =item B<Target> I<Name>
5939 Add a target to a rule or a default target to a chain. The name specifies what
5940 kind of target is to be added. Which targets are available depends on the
5941 plugins being loaded.
5943 The arguments inside the B<Target> block are passed to the plugin implementing
5944 the target, so which arguments are valid here depends on the plugin being used.
5945 If you do not need any to pass any arguments to a target, you can use the
5950 This is the same as writing:
5957 =head2 Built-in targets
5959 The following targets are built into the core daemon and therefore need no
5960 plugins to be loaded:
5966 Signals the "return" condition, see the L<"Flow control"> section above. This
5967 causes the current chain to stop processing the value and returns control to
5968 the calling chain. The calling chain will continue processing targets and rules
5969 just after the B<jump> target (see below). This is very similar to the
5970 B<RETURN> target of iptables, see L<iptables(8)>.
5972 This target does not have any options.
5980 Signals the "stop" condition, see the L<"Flow control"> section above. This
5981 causes processing of the value to be aborted immediately. This is similar to
5982 the B<DROP> target of iptables, see L<iptables(8)>.
5984 This target does not have any options.
5992 Sends the value to "write" plugins.
5998 =item B<Plugin> I<Name>
6000 Name of the write plugin to which the data should be sent. This option may be
6001 given multiple times to send the data to more than one write plugin.
6005 If no plugin is explicitly specified, the values will be sent to all available
6016 Starts processing the rules of another chain, see L<"Flow control"> above. If
6017 the end of that chain is reached, or a stop condition is encountered,
6018 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
6019 next target or the next rule. This is similar to the B<-j> command line option
6020 of iptables, see L<iptables(8)>.
6026 =item B<Chain> I<Name>
6028 Jumps to the chain I<Name>. This argument is required and may appear only once.
6040 =head2 Available matches
6046 Matches a value using regular expressions.
6052 =item B<Host> I<Regex>
6054 =item B<Plugin> I<Regex>
6056 =item B<PluginInstance> I<Regex>
6058 =item B<Type> I<Regex>
6060 =item B<TypeInstance> I<Regex>
6062 Match values where the given regular expressions match the various fields of
6063 the identifier of a value. If multiple regular expressions are given, B<all>
6064 regexen must match for a value to match.
6066 =item B<Invert> B<false>|B<true>
6068 When set to B<true>, the result of the match is inverted, i.e. all value lists
6069 where all regular expressions apply are not matched, all other value lists are
6070 matched. Defaults to B<false>.
6077 Host "customer[0-9]+"
6083 Matches values that have a time which differs from the time on the server.
6085 This match is mainly intended for servers that receive values over the
6086 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
6087 is very sensitive to the timestamp used when updating the RRD files. In
6088 particular, the time must be ever increasing. If a misbehaving client sends one
6089 packet with a timestamp far in the future, all further packets with a correct
6090 time will be ignored because of that one packet. What's worse, such corrupted
6091 RRD files are hard to fix.
6093 This match lets one match all values B<outside> a specified time range
6094 (relative to the server's time), so you can use the B<stop> target (see below)
6095 to ignore the value, for example.
6101 =item B<Future> I<Seconds>
6103 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
6104 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
6107 =item B<Past> I<Seconds>
6109 Matches all values that are I<behind> of the server's time by I<Seconds> or
6110 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
6122 This example matches all values that are five minutes or more ahead of the
6123 server or one hour (or more) lagging behind.
6127 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
6128 values. If a data-set consists of more than one data-source, all data-sources
6129 must match the specified ranges for a positive match.
6135 =item B<Min> I<Value>
6137 Sets the smallest value which still results in a match. If unset, behaves like
6140 =item B<Max> I<Value>
6142 Sets the largest value which still results in a match. If unset, behaves like
6145 =item B<Invert> B<true>|B<false>
6147 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
6148 no-match is returned and vice versa. Please note that the B<Invert> setting
6149 only effects how B<Min> and B<Max> are applied to a specific value. Especially
6150 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
6152 =item B<DataSource> I<DSName> [I<DSName> ...]
6154 Select one or more of the data sources. If no data source is configured, all
6155 data sources will be checked. If the type handled by the match does not have a
6156 data source of the specified name(s), this will always result in no match
6157 (independent of the B<Invert> setting).
6159 =item B<Satisfy> B<Any>|B<All>
6161 Specifies how checking with several data sources is performed. If set to
6162 B<Any>, the match succeeds if one of the data sources is in the configured
6163 range. If set to B<All> the match only succeeds if all data sources are within
6164 the configured range. Default is B<All>.
6166 Usually B<All> is used for positive matches, B<Any> is used for negative
6167 matches. This means that with B<All> you usually check that all values are in a
6168 "good" range, while with B<Any> you check if any value is within a "bad" range
6169 (or outside the "good" range).
6173 Either B<Min> or B<Max>, but not both, may be unset.
6177 # Match all values smaller than or equal to 100. Matches only if all data
6178 # sources are below 100.
6184 # Match if the value of any data source is outside the range of 0 - 100.
6192 =item B<empty_counter>
6194 Matches all values with one or more data sources of type B<COUNTER> and where
6195 all counter values are zero. These counters usually I<never> increased since
6196 they started existing (and are therefore uninteresting), or got reset recently
6197 or overflowed and you had really, I<really> bad luck.
6199 Please keep in mind that ignoring such counters can result in confusing
6200 behavior: Counters which hardly ever increase will be zero for long periods of
6201 time. If the counter is reset for some reason (machine or service restarted,
6202 usually), the graph will be empty (NAN) for a long time. People may not
6207 Calculates a hash value of the host name and matches values according to that
6208 hash value. This makes it possible to divide all hosts into groups and match
6209 only values that are in a specific group. The intended use is in load
6210 balancing, where you want to handle only part of all data and leave the rest
6213 The hashing function used tries to distribute the hosts evenly. First, it
6214 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
6217 for (i = 0; host[i] != 0; i++)
6218 hash_value = (hash_value * 251) + host[i];
6220 The constant 251 is a prime number which is supposed to make this hash value
6221 more random. The code then checks the group for this host according to the
6222 I<Total> and I<Match> arguments:
6224 if ((hash_value % Total) == Match)
6229 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
6230 groups), then the least significant bit of the hash value will be the XOR of
6231 all least significant bits in the host name. One consequence is that when you
6232 have two hosts, "server0.example.com" and "server1.example.com", where the host
6233 name differs in one digit only and the digits differ by one, those hosts will
6234 never end up in the same group.
6240 =item B<Match> I<Match> I<Total>
6242 Divide the data into I<Total> groups and match all hosts in group I<Match> as
6243 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
6244 be smaller than I<Total>. I<Total> must be at least one, although only values
6245 greater than one really do make any sense.
6247 You can repeat this option to match multiple groups, for example:
6252 The above config will divide the data into seven groups and match groups three
6253 and five. One use would be to keep every value on two hosts so that if one
6254 fails the missing data can later be reconstructed from the second host.
6260 # Operate on the pre-cache chain, so that ignored values are not even in the
6265 # Divide all received hosts in seven groups and accept all hosts in
6269 # If matched: Return and continue.
6272 # If not matched: Return and stop.
6278 =head2 Available targets
6282 =item B<notification>
6284 Creates and dispatches a notification.
6290 =item B<Message> I<String>
6292 This required option sets the message of the notification. The following
6293 placeholders will be replaced by an appropriate value:
6301 =item B<%{plugin_instance}>
6305 =item B<%{type_instance}>
6307 These placeholders are replaced by the identifier field of the same name.
6309 =item B<%{ds:>I<name>B<}>
6311 These placeholders are replaced by a (hopefully) human readable representation
6312 of the current rate of this data source. If you changed the instance name
6313 (using the B<set> or B<replace> targets, see below), it may not be possible to
6314 convert counter values to rates.
6318 Please note that these placeholders are B<case sensitive>!
6320 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
6322 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
6329 <Target "notification">
6330 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
6336 Replaces parts of the identifier using regular expressions.
6342 =item B<Host> I<Regex> I<Replacement>
6344 =item B<Plugin> I<Regex> I<Replacement>
6346 =item B<PluginInstance> I<Regex> I<Replacement>
6348 =item B<TypeInstance> I<Regex> I<Replacement>
6350 Match the appropriate field with the given regular expression I<Regex>. If the
6351 regular expression matches, that part that matches is replaced with
6352 I<Replacement>. If multiple places of the input buffer match a given regular
6353 expression, only the first occurrence will be replaced.
6355 You can specify each option multiple times to use multiple regular expressions
6363 # Replace "example.net" with "example.com"
6364 Host "\\<example.net\\>" "example.com"
6366 # Strip "www." from hostnames
6372 Sets part of the identifier of a value to a given string.
6378 =item B<Host> I<String>
6380 =item B<Plugin> I<String>
6382 =item B<PluginInstance> I<String>
6384 =item B<TypeInstance> I<String>
6386 Set the appropriate field to the given string. The strings for plugin instance
6387 and type instance may be empty, the strings for host and plugin may not be
6388 empty. It's currently not possible to set the type of a value this way.
6395 PluginInstance "coretemp"
6396 TypeInstance "core3"
6401 =head2 Backwards compatibility
6403 If you use collectd with an old configuration, i.E<nbsp>e. one without a
6404 B<Chain> block, it will behave as it used to. This is equivalent to the
6405 following configuration:
6411 If you specify a B<PostCacheChain>, the B<write> target will not be added
6412 anywhere and you will have to make sure that it is called where appropriate. We
6413 suggest to add the above snippet as default target to your "PostCache" chain.
6417 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
6433 L<collectd-exec(5)>,
6434 L<collectd-perl(5)>,
6435 L<collectd-unixsock(5)>,
6448 Florian Forster E<lt>octo@verplant.orgE<gt>