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 plugins that do network-IO. Setting this to
185 a value higher than the number of registered read callbacks is not recommended.
187 =item B<WriteThreads> I<Num>
189 Number of threads to start for dispatching value lists to write plugins. The
190 default value is B<5>, but you may want to increase this if you have more than
191 five plugins that may take relatively long to write to.
193 =item B<Hostname> I<Name>
195 Sets the hostname that identifies a host. If you omit this setting, the
196 hostname will be determined using the L<gethostname(2)> system call.
198 =item B<FQDNLookup> B<true|false>
200 If B<Hostname> is determined automatically this setting controls whether or not
201 the daemon should try to figure out the "fully qualified domain name", FQDN.
202 This is done using a lookup of the name returned by C<gethostname>. This option
203 is enabled by default.
205 =item B<PreCacheChain> I<ChainName>
207 =item B<PostCacheChain> I<ChainName>
209 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
210 see L<FILTER CONFIGURATION> below on information on chains and how these
211 setting change the daemon's behavior.
215 =head1 PLUGIN OPTIONS
217 Some plugins may register own options. These options must be enclosed in a
218 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
219 require external configuration, too. The C<apache plugin>, for example,
220 required C<mod_status> to be configured in the webserver you're going to
221 collect data from. These plugins are listed below as well, even if they don't
222 require any configuration within collectd's configuration file.
224 A list of all plugins and a short summary for each plugin can be found in the
225 F<README> file shipped with the sourcecode and hopefully binary packets as
228 =head2 Plugin C<aggregation>
230 The I<Aggregation plugin> makes it possible to aggregate several values into
231 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
232 This can be put to a wide variety of uses, e.g. average and total CPU
233 statistics for your entire fleet.
235 The grouping is powerful but, as with many powerful tools, may be a bit
236 difficult to wrap your head around. The grouping will therefore be
237 demonstrated using an example: The average and sum of the CPU usage across
238 all CPUs of each host is to be calculated.
240 To select all the affected values for our example, set C<Plugin cpu> and
241 C<Type cpu>. The other values are left unspecified, meaning "all values". The
242 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
243 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
249 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...) and
250 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
251 example, the intention is to have a new value for each host / type instance
252 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
253 It can be specified multiple times to group by more than one field.
256 GroupBy "TypeInstance"
258 We do neither specify nor group by I<plugin instance> (the CPU number), so all
259 metrics that differ in the CPU number only will be aggregated. Each
260 aggregation needs I<at least one> such field, otherwise no aggregation would
263 The full example configuration looks like this:
265 <Plugin "aggregation">
271 GroupBy "TypeInstance"
274 CalculateAverage true
278 There are a couple of limitations you should be aware of:
284 The I<Type> cannot be left unspecified, because it is not reasonable to add
285 apples to oranges. Also, the internal lookup structure won't work if you try
290 There must be at least one unspecified, ungrouped field. Otherwise nothing
295 As you can see in the example above, each aggregation has its own
296 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
297 blocks may match the same values, i.e. one value list can update multiple
298 aggregations. The following options are valid inside B<Aggregation> blocks:
302 =item B<Host> I<Host>
304 =item B<Plugin> I<Plugin>
306 =item B<PluginInstance> I<PluginInstance>
308 =item B<Type> I<Type>
310 =item B<TypeInstance> I<TypeInstance>
312 Selects the value lists to be added to this aggregation. B<Type> must be a
313 valid data set name, see L<types.db(5)> for details.
315 If the string starts with and ends with a slash (C</>), the string is
316 interpreted as a I<regular expression>. The regex flavor used are POSIX
317 extended regular expressions as described in L<regex(7)>. Example usage:
319 Host "/^db[0-9]\\.example\\.com$/"
321 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
323 Group valued by the specified field. The B<GroupBy> option may be repeated to
324 group by multiple fields.
326 =item B<SetHost> I<Host>
328 =item B<SetPlugin> I<Plugin>
330 =item B<SetPluginInstance> I<PluginInstance>
332 =item B<SetTypeInstance> I<TypeInstance>
334 Sets the appropriate part of the identifier to the provided string.
336 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
337 will be replaced with the aggregation function, e.g. "average". Not including
338 the placeholder will result in duplication warnings and/or messed up values if
339 more than one aggregation function are enabled.
341 The following example calculates the average usage of all "even" CPUs:
343 <Plugin "aggregation">
346 PluginInstance "/[0,2,4,6,8]$/"
350 SetPluginInstance "even-%{aggregation}"
353 GroupBy "TypeInstance"
355 CalculateAverage true
359 This will create the files:
365 foo.example.com/cpu-even-average/cpu-idle
369 foo.example.com/cpu-even-average/cpu-system
373 foo.example.com/cpu-even-average/cpu-user
381 =item B<CalculateNum> B<true>|B<false>
383 =item B<CalculateSum> B<true>|B<false>
385 =item B<CalculateAverage> B<true>|B<false>
387 =item B<CalculateMinimum> B<true>|B<false>
389 =item B<CalculateMaximum> B<true>|B<false>
391 =item B<CalculateStddev> B<true>|B<false>
393 Boolean options for enabling calculation of the number of value lists, their
394 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
395 are disabled by default.
399 =head2 Plugin C<amqp>
401 The I<AMQMP plugin> can be used to communicate with other instances of
402 I<collectd> or third party applications using an AMQP message broker. Values
403 are sent to or received from the broker, which handles routing, queueing and
404 possibly filtering or messages.
407 # Send values to an AMQP broker
408 <Publish "some_name">
414 Exchange "amq.fanout"
415 # ExchangeType "fanout"
416 # RoutingKey "collectd"
420 # GraphitePrefix "collectd."
421 # GraphiteEscapeChar "_"
424 # Receive values from an AMQP broker
425 <Subscribe "some_name">
431 Exchange "amq.fanout"
432 # ExchangeType "fanout"
434 # RoutingKey "collectd.#"
438 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
439 blocks, which configure sending and receiving of values respectively. The two
440 blocks are very similar, so unless otherwise noted, an option can be used in
441 either block. The name given in the blocks starting tag is only used for
442 reporting messages, but may be used to support I<flushing> of certain
443 I<Publish> blocks in the future.
447 =item B<Host> I<Host>
449 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
450 the underlying communications library, I<rabbitmq-c>, which is "localhost".
452 =item B<Port> I<Port>
454 Service name or port number on which the AMQP broker accepts connections. This
455 argument must be a string, even if the numeric form is used. Defaults to
458 =item B<VHost> I<VHost>
460 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
462 =item B<User> I<User>
464 =item B<Password> I<Password>
466 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
469 =item B<Exchange> I<Exchange>
471 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
472 By default, "amq.fanout" will be used.
474 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
475 the given exchange and the I<queue> is created, using the I<routing key> if
476 configured. See the B<Queue> and B<RoutingKey> options below.
478 =item B<ExchangeType> I<Type>
480 If given, the plugin will try to create the configured I<exchange> with this
481 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
482 be bound to this exchange.
484 =item B<Queue> I<Queue> (Subscribe only)
486 Configures the I<queue> name to subscribe to. If no queue name was configures
487 explicitly, a unique queue name will be created by the broker.
489 =item B<RoutingKey> I<Key>
491 In I<Publish> blocks, this configures the routing key to set on all outgoing
492 messages. If not given, the routing key will be computed from the I<identifier>
493 of the value. The host, plugin, type and the two instances are concatenated
494 together using dots as the separator and all containing dots replaced with
495 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
496 possible to receive only specific values using a "topic" exchange.
498 In I<Subscribe> blocks, configures the I<routing key> used when creating a
499 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
500 used to filter messages when using a "topic" exchange. If you're only
501 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
504 =item B<Persistent> B<true>|B<false> (Publish only)
506 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
507 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
508 default), the I<transient> delivery mode will be used, i.e. messages may be
509 lost due to high load, overflowing queues or similar issues.
511 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
513 Selects the format in which messages are sent to the broker. If set to
514 B<Command> (the default), values are sent as C<PUTVAL> commands which are
515 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
516 case, the C<Content-Type> header field will be set to C<text/collectd>.
518 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
519 an easy and straight forward exchange format. The C<Content-Type> header field
520 will be set to C<application/json>.
522 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
523 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
526 A subscribing client I<should> use the C<Content-Type> header field to
527 determine how to decode the values. Currently, the I<AMQP plugin> itself can
528 only decode the B<Command> format.
530 =item B<StoreRates> B<true>|B<false> (Publish only)
532 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
533 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
534 default), no conversion is performed. Otherwise the conversion is performed
535 using the internal value cache.
537 Please note that currently this option is only used if the B<Format> option has
540 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
542 A prefix can be added in the metric name when outputting in the I<Graphite> format.
543 It's added before the I<Host> name.
544 Metric name will be "<prefix><host><postfix><plugin><type><name>"
546 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
548 A postfix can be added in the metric name when outputting in the I<Graphite> format.
549 It's added after the I<Host> name.
550 Metric name will be "<prefix><host><postfix><plugin><type><name>"
552 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
554 Specify a character to replace dots (.) in the host part of the metric name.
555 In I<Graphite> metric name, dots are used as separators between different
556 metric parts (host, plugin, type).
557 Default is "_" (I<Underscore>).
561 =head2 Plugin C<apache>
563 To configure the C<apache>-plugin you first need to configure the Apache
564 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
565 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
566 the following snipped to base your Apache config upon:
569 <IfModule mod_status.c>
570 <Location /mod_status>
571 SetHandler server-status
575 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
576 also supported. It introduces a new field, called C<BusyServers>, to count the
577 number of currently connected clients. This field is also supported.
579 The configuration of the I<Apache> plugin consists of one or more
580 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
581 as the instance name. For example:
585 URL "http://www1.example.com/mod_status?auto"
588 URL "http://www2.example.com/mod_status?auto"
592 The instance name will be used as the I<plugin instance>. To emulate the old
593 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
594 plugin to work correctly, each instance name must be unique. This is not
595 enforced by the plugin and it is your responsibility to ensure it.
597 The following options are accepted within each I<Instance> block:
601 =item B<URL> I<http://host/mod_status?auto>
603 Sets the URL of the C<mod_status> output. This needs to be the output generated
604 by C<ExtendedStatus on> and it needs to be the machine readable output
605 generated by appending the C<?auto> argument. This option is I<mandatory>.
607 =item B<User> I<Username>
609 Optional user name needed for authentication.
611 =item B<Password> I<Password>
613 Optional password needed for authentication.
615 =item B<VerifyPeer> B<true|false>
617 Enable or disable peer SSL certificate verification. See
618 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
620 =item B<VerifyHost> B<true|false>
622 Enable or disable peer host name verification. If enabled, the plugin checks
623 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
624 certificate matches the host name provided by the B<URL> option. If this
625 identity check fails, the connection is aborted. Obviously, only works when
626 connecting to a SSL enabled server. Enabled by default.
628 =item B<CACert> I<File>
630 File that holds one or more SSL certificates. If you want to use HTTPS you will
631 possibly need this option. What CA certificates come bundled with C<libcurl>
632 and are checked by default depends on the distribution you use.
636 =head2 Plugin C<apcups>
640 =item B<Host> I<Hostname>
642 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
643 that IPv6 support has been disabled unless someone can confirm or decline that
644 B<apcupsd> can handle it.
646 =item B<Port> I<Port>
648 TCP-Port to connect to. Defaults to B<3551>.
650 =item B<ReportSeconds> B<true|false>
652 If set to B<true>, the time reported in the C<timeleft> metric will be
653 converted to seconds. This is the recommended setting. If set to B<false>, the
654 default for backwards compatibility, the time will be reported in minutes.
658 =head2 Plugin C<ascent>
660 This plugin collects information about an Ascent server, a free server for the
661 "World of Warcraft" game. This plugin gathers the information by fetching the
662 XML status page using C<libcurl> and parses it using C<libxml2>.
664 The configuration options are the same as for the C<apache> plugin above:
668 =item B<URL> I<http://localhost/ascent/status/>
670 Sets the URL of the XML status output.
672 =item B<User> I<Username>
674 Optional user name needed for authentication.
676 =item B<Password> I<Password>
678 Optional password needed for authentication.
680 =item B<VerifyPeer> B<true|false>
682 Enable or disable peer SSL certificate verification. See
683 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
685 =item B<VerifyHost> B<true|false>
687 Enable or disable peer host name verification. If enabled, the plugin checks
688 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
689 certificate matches the host name provided by the B<URL> option. If this
690 identity check fails, the connection is aborted. Obviously, only works when
691 connecting to a SSL enabled server. Enabled by default.
693 =item B<CACert> I<File>
695 File that holds one or more SSL certificates. If you want to use HTTPS you will
696 possibly need this option. What CA certificates come bundled with C<libcurl>
697 and are checked by default depends on the distribution you use.
701 =head2 Plugin C<bind>
703 Starting with BIND 9.5.0, the most widely used DNS server software provides
704 extensive statistics about queries, responses and lots of other information.
705 The bind plugin retrieves this information that's encoded in XML and provided
706 via HTTP and submits the values to collectd.
708 To use this plugin, you first need to tell BIND to make this information
709 available. This is done with the C<statistics-channels> configuration option:
711 statistics-channels {
712 inet localhost port 8053;
715 The configuration follows the grouping that can be seen when looking at the
716 data with an XSLT compatible viewer, such as a modern web browser. It's
717 probably a good idea to make yourself familiar with the provided values, so you
718 can understand what the collected statistics actually mean.
723 URL "http://localhost:8053/"
738 Zone "127.in-addr.arpa/IN"
742 The bind plugin accepts the following configuration options:
748 URL from which to retrieve the XML data. If not specified,
749 C<http://localhost:8053/> will be used.
751 =item B<ParseTime> B<true>|B<false>
753 When set to B<true>, the time provided by BIND will be parsed and used to
754 dispatch the values. When set to B<false>, the local time source is queried.
756 This setting is set to B<true> by default for backwards compatibility; setting
757 this to B<false> is I<recommended> to avoid problems with timezones and
760 =item B<OpCodes> B<true>|B<false>
762 When enabled, statistics about the I<"OpCodes">, for example the number of
763 C<QUERY> packets, are collected.
767 =item B<QTypes> B<true>|B<false>
769 When enabled, the number of I<incoming> queries by query types (for example
770 C<A>, C<MX>, C<AAAA>) is collected.
774 =item B<ServerStats> B<true>|B<false>
776 Collect global server statistics, such as requests received over IPv4 and IPv6,
777 successful queries, and failed updates.
781 =item B<ZoneMaintStats> B<true>|B<false>
783 Collect zone maintenance statistics, mostly information about notifications
784 (zone updates) and zone transfers.
788 =item B<ResolverStats> B<true>|B<false>
790 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
791 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
792 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
793 default. Use the B<ResolverStats> option within a B<View "_default"> block
794 instead for the same functionality.
800 Collect global memory statistics.
804 =item B<View> I<Name>
806 Collect statistics about a specific I<"view">. BIND can behave different,
807 mostly depending on the source IP-address of the request. These different
808 configurations are called "views". If you don't use this feature, you most
809 likely are only interested in the C<_default> view.
811 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
812 information you want to collect about a view. If no B<View> block is
813 configured, no detailed view statistics will be collected.
817 =item B<QTypes> B<true>|B<false>
819 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
824 =item B<ResolverStats> B<true>|B<false>
826 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
827 (e.E<nbsp>g. queries over IPv4, lame servers).
831 =item B<CacheRRSets> B<true>|B<false>
833 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
834 type is collected. Negative entries (queries which resulted in an error, for
835 example names that do not exist) are reported with a leading exclamation mark,
840 =item B<Zone> I<Name>
842 When given, collect detailed information about the given zone in the view. The
843 information collected if very similar to the global B<ServerStats> information
846 You can repeat this option to collect detailed information about multiple
849 By default no detailed zone information is collected.
855 =head2 Plugin C<cpufreq>
857 This plugin doesn't have any options. It reads
858 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
859 installed) to get the current CPU frequency. If this file does not exist make
860 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
861 installed and an "cpu governor" (that's a kernel module) is loaded.
867 =item B<DataDir> I<Directory>
869 Set the directory to store CSV-files under. Per default CSV-files are generated
870 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
871 The special strings B<stdout> and B<stderr> can be used to write to the standard
872 output and standard error channels, respectively. This, of course, only makes
873 much sense when collectd is running in foreground- or non-daemon-mode.
875 =item B<StoreRates> B<true|false>
877 If set to B<true>, convert counter values to rates. If set to B<false> (the
878 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
883 =head2 Plugin C<curl>
885 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
886 and the match infrastructure (the same code used by the tail plugin) to use
887 regular expressions with the received data.
889 The following example will read the current value of AMD stock from Google's
890 finance page and dispatch the value to collectd.
893 <Page "stock_quotes">
894 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
898 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
899 DSType "GaugeAverage"
900 # Note: `stock_value' is not a standard type.
907 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
908 a web page and one or more "matches" to be performed on the returned data. The
909 string argument to the B<Page> block is used as plugin instance.
911 The following options are valid within B<Page> blocks:
917 URL of the web site to retrieve. Since a regular expression will be used to
918 extract information from this data, non-binary data is a big plus here ;)
920 =item B<User> I<Name>
922 Username to use if authorization is required to read the page.
924 =item B<Password> I<Password>
926 Password to use if authorization is required to read the page.
928 =item B<VerifyPeer> B<true>|B<false>
930 Enable or disable peer SSL certificate verification. See
931 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
933 =item B<VerifyHost> B<true>|B<false>
935 Enable or disable peer host name verification. If enabled, the plugin checks if
936 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
937 matches the host name provided by the B<URL> option. If this identity check
938 fails, the connection is aborted. Obviously, only works when connecting to a
939 SSL enabled server. Enabled by default.
941 =item B<CACert> I<file>
943 File that holds one or more SSL certificates. If you want to use HTTPS you will
944 possibly need this option. What CA certificates come bundled with C<libcurl>
945 and are checked by default depends on the distribution you use.
947 =item B<MeasureResponseTime> B<true>|B<false>
949 Measure response time for the request. If this setting is enabled, B<Match>
950 blocks (see below) are optional. Disabled by default.
952 =item B<E<lt>MatchE<gt>>
954 One or more B<Match> blocks that define how to match information in the data
955 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
956 used by the C<tail> plugin, so please see the documentation of the C<tail>
957 plugin below on how matches are defined. If the B<MeasureResponseTime> option
958 is set to B<true>, B<Match> blocks are optional.
962 =head2 Plugin C<curl_json>
964 The B<curl_json plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and
965 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) to retrieve JSON data
966 via cURL. This can be used to collect values from CouchDB documents (which are
967 stored JSON notation), for example.
969 The following example will collect several values from the built-in `_stats'
970 runtime statistics module of CouchDB
971 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
974 <URL "http://localhost:5984/_stats">
976 <Key "httpd/requests/count">
980 <Key "httpd_request_methods/*/count">
981 Type "http_request_methods"
984 <Key "httpd_status_codes/*/count">
985 Type "http_response_codes"
990 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining
991 a URL to be fetched via HTTP (using libcurl) and one or more B<Key> blocks.
992 The B<Key> string argument must be in a path format, which is used to collect a
993 value from a JSON map object. If a path element of B<Key> is the
994 I<*>E<nbsp>wildcard, the values for all keys will be collectd.
996 The following options are valid within B<URL> blocks:
1000 =item B<Instance> I<Instance>
1002 Sets the plugin instance to I<Instance>.
1004 =item B<User> I<Name>
1006 Username to use if authorization is required to read the page.
1008 =item B<Password> I<Password>
1010 Password to use if authorization is required to read the page.
1012 =item B<VerifyPeer> B<true>|B<false>
1014 Enable or disable peer SSL certificate verification. See
1015 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1017 =item B<VerifyHost> B<true>|B<false>
1019 Enable or disable peer host name verification. If enabled, the plugin checks if
1020 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1021 matches the host name provided by the B<URL> option. If this identity check
1022 fails, the connection is aborted. Obviously, only works when connecting to a
1023 SSL enabled server. Enabled by default.
1025 =item B<CACert> I<file>
1027 File that holds one or more SSL certificates. If you want to use HTTPS you will
1028 possibly need this option. What CA certificates come bundled with C<libcurl>
1029 and are checked by default depends on the distribution you use.
1033 The following options are valid within B<Key> blocks:
1037 =item B<Type> I<Type>
1039 Sets the type used to dispatch the values to the daemon. Detailed information
1040 about types and their configuration can be found in L<types.db(5)>. This
1041 option is mandatory.
1043 =item B<Instance> I<Instance>
1045 Type-instance to use. Defaults to the current map key or current string array element value.
1049 =head2 Plugin C<curl_xml>
1051 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1052 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1055 <URL "http://localhost/stats.xml">
1057 Instance "some_instance"
1062 CACert "/path/to/ca.crt"
1064 <XPath "table[@id=\"magic_level\"]/tr">
1066 #InstancePrefix "prefix-"
1067 InstanceFrom "td[1]"
1068 ValuesFrom "td[2]/span[@class=\"level\"]"
1073 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1074 URL to be fetched using libcurl. Within each B<URL> block there are
1075 options which specify the connection parameters, for example authentication
1076 information, and one or more B<XPath> blocks.
1078 Each B<XPath> block specifies how to get one type of information. The
1079 string argument must be a valid XPath expression which returns a list
1080 of "base elements". One value is dispatched for each "base element". The
1081 I<type instance> and values are looked up using further I<XPath> expressions
1082 that should be relative to the base element.
1084 Within the B<URL> block the following options are accepted:
1088 =item B<Host> I<Name>
1090 Use I<Name> as the host name when submitting values. Defaults to the global
1093 =item B<Instance> I<Instance>
1095 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1096 empty string (no plugin instance).
1098 =item B<User> I<User>
1099 =item B<Password> I<Password>
1100 =item B<VerifyPeer> B<true>|B<false>
1101 =item B<VerifyHost> B<true>|B<false>
1102 =item B<CACert> I<CA Cert File>
1104 These options behave exactly equivalent to the appropriate options of the
1105 I<cURL> and I<cURL-JSON> plugins. Please see there for a detailed description.
1107 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1109 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1110 B<XPath> block specifies how to get one type of information. The string
1111 argument must be a valid XPath expression which returns a list of "base
1112 elements". One value is dispatched for each "base element".
1114 Within the B<XPath> block the following options are accepted:
1118 =item B<Type> I<Type>
1120 Specifies the I<Type> used for submitting patches. This determines the number
1121 of values that are required / expected and whether the strings are parsed as
1122 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1123 This option is required.
1125 =item B<InstancePrefix> I<InstancePrefix>
1127 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1128 concatenated together without any separator.
1129 This option is optional.
1131 =item B<InstanceFrom> I<InstanceFrom>
1133 Specifies a XPath expression to use for determining the I<type instance>. The
1134 XPath expression must return exactly one element. The element's value is then
1135 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1137 This value is required. As a special exception, if the "base XPath expression"
1138 (the argument to the B<XPath> block) returns exactly one argument, then this
1139 option may be omitted.
1141 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1143 Specifies one or more XPath expression to use for reading the values. The
1144 number of XPath expressions must match the number of data sources in the
1145 I<type> specified with B<Type> (see above). Each XPath expression must return
1146 exactly one element. The element's value is then parsed as a number and used as
1147 value for the appropriate value in the value list dispatched to the daemon.
1153 =head2 Plugin C<dbi>
1155 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1156 connect to various databases, execute I<SQL> statements and read back the
1157 results. I<dbi> is an acronym for "database interface" in case you were
1158 wondering about the name. You can configure how each column is to be
1159 interpreted and the plugin will generate one or more data sets from each row
1160 returned according to these rules.
1162 Because the plugin is very generic, the configuration is a little more complex
1163 than those of other plugins. It usually looks something like this:
1166 <Query "out_of_stock">
1167 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1168 # Use with MySQL 5.0.0 or later
1172 InstancePrefix "out_of_stock"
1173 InstancesFrom "category"
1177 <Database "product_information">
1179 DriverOption "host" "localhost"
1180 DriverOption "username" "collectd"
1181 DriverOption "password" "aZo6daiw"
1182 DriverOption "dbname" "prod_info"
1183 SelectDB "prod_info"
1184 Query "out_of_stock"
1188 The configuration above defines one query with one result and one database. The
1189 query is then linked to the database with the B<Query> option I<within> the
1190 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1191 and you can also use the B<Include> statement to split up the configuration
1192 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1193 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1196 The following is a complete list of options:
1198 =head3 B<Query> blocks
1200 Query blocks define I<SQL> statements and how the returned data should be
1201 interpreted. They are identified by the name that is given in the opening line
1202 of the block. Thus the name needs to be unique. Other than that, the name is
1203 not used in collectd.
1205 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1206 define which column holds which value or instance information. You can use
1207 multiple B<Result> blocks to create multiple values from one returned row. This
1208 is especially useful, when queries take a long time and sending almost the same
1209 query again and again is not desirable.
1213 <Query "environment">
1214 Statement "select station, temperature, humidity from environment"
1217 # InstancePrefix "foo"
1218 InstancesFrom "station"
1219 ValuesFrom "temperature"
1223 InstancesFrom "station"
1224 ValuesFrom "humidity"
1228 The following options are accepted:
1232 =item B<Statement> I<SQL>
1234 Sets the statement that should be executed on the server. This is B<not>
1235 interpreted by collectd, but simply passed to the database server. Therefore,
1236 the SQL dialect that's used depends on the server collectd is connected to.
1238 The query has to return at least two columns, one for the instance and one
1239 value. You cannot omit the instance, even if the statement is guaranteed to
1240 always return exactly one line. In that case, you can usually specify something
1243 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1245 (That works with MySQL but may not be valid SQL according to the spec. If you
1246 use a more strict database server, you may have to select from a dummy table or
1249 Please note that some databases, for example B<Oracle>, will fail if you
1250 include a semicolon at the end of the statement.
1252 =item B<MinVersion> I<Version>
1254 =item B<MaxVersion> I<Value>
1256 Only use this query for the specified database version. You can use these
1257 options to provide multiple queries with the same name but with a slightly
1258 different syntax. The plugin will use only those queries, where the specified
1259 minimum and maximum versions fit the version of the database in use.
1261 The database version is determined by C<dbi_conn_get_engine_version>, see the
1262 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1263 for details. Basically, each part of the version is assumed to be in the range
1264 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1265 "40102", version "5.0.42" becomes "50042".
1267 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1268 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1269 happen. Don't to it! A valid example would be something along these lines:
1280 In the above example, there are three ranges that don't overlap. The last one
1281 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1282 before "4.0.0" are not specified.
1284 =item B<Type> I<Type>
1286 The B<type> that's used for each line returned. See L<types.db(5)> for more
1287 details on how types are defined. In short: A type is a predefined layout of
1288 data and the number of values and type of values has to match the type
1291 If you specify "temperature" here, you need exactly one gauge column. If you
1292 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1295 There must be exactly one B<Type> option inside each B<Result> block.
1297 =item B<InstancePrefix> I<prefix>
1299 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1300 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1301 all strings returned in the appropriate columns are concatenated together,
1302 separated by dashes I<("-")>.
1304 =item B<InstancesFrom> I<column0> [I<column1> ...]
1306 Specifies the columns whose values will be used to create the "type-instance"
1307 for each row. If you specify more than one column, the value of all columns
1308 will be joined together with dashes I<("-")> as separation characters.
1310 The plugin itself does not check whether or not all built instances are
1311 different. It's your responsibility to assure that each is unique. This is
1312 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1313 sure that only one row is returned in this case.
1315 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1318 =item B<ValuesFrom> I<column0> [I<column1> ...]
1320 Names the columns whose content is used as the actual data for the data sets
1321 that are dispatched to the daemon. How many such columns you need is determined
1322 by the B<Type> setting above. If you specify too many or not enough columns,
1323 the plugin will complain about that and no data will be submitted to the
1326 The actual data type in the columns is not that important. The plugin will
1327 automatically cast the values to the right type if it know how to do that. So
1328 it should be able to handle integer an floating point types, as well as strings
1329 (if they include a number at the beginning).
1331 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1335 =head3 B<Database> blocks
1337 Database blocks define a connection to a database and which queries should be
1338 sent to that database. Since the used "dbi" library can handle a wide variety
1339 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1340 documentationE<nbsp>- we stick as close to the terminology used there.
1342 Each database needs a "name" as string argument in the starting tag of the
1343 block. This name will be used as "PluginInstance" in the values submitted to
1344 the daemon. Other than that, that name is not used.
1348 =item B<Driver> I<Driver>
1350 Specifies the driver to use to connect to the database. In many cases those
1351 drivers are named after the database they can connect to, but this is not a
1352 technical necessity. These drivers are sometimes referred to as "DBD",
1353 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1354 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1355 project at L<http://libdbi-drivers.sourceforge.net/>.
1357 You need to give the driver name as expected by the "dbi" library here. You
1358 should be able to find that in the documentation for each driver. If you
1359 mistype the driver name, the plugin will dump a list of all known driver names
1362 =item B<DriverOption> I<Key> I<Value>
1364 Sets driver-specific options. What option a driver supports can be found in the
1365 documentation for each driver, somewhere at
1366 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1367 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1369 DBDs can register two types of options: String options and numeric options. The
1370 plugin will use the C<dbi_conn_set_option> function when the configuration
1371 provides a string and the C<dbi_conn_require_option_numeric> function when the
1372 configuration provides a number. So these two lines will actually result in
1373 different calls being used:
1375 DriverOption "Port" 1234 # numeric
1376 DriverOption "Port" "1234" # string
1378 Unfortunately, drivers are not too keen to report errors when an unknown option
1379 is passed to them, so invalid settings here may go unnoticed. This is not the
1380 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1381 the driver. If a driver complains about an option, the plugin will dump a
1382 complete list of all options understood by that driver to the log. There is no
1383 way to programatically find out if an option expects a string or a numeric
1384 argument, so you will have to refer to the appropriate DBD's documentation to
1385 find this out. Sorry.
1387 =item B<SelectDB> I<Database>
1389 In some cases, the database name you connect with is not the database name you
1390 want to use for querying data. If this option is set, the plugin will "select"
1391 (switch to) that database after the connection is established.
1393 =item B<Query> I<QueryName>
1395 Associates the query named I<QueryName> with this database connection. The
1396 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1397 blocks you want to refer to must be placed above the database block you want to
1400 =item B<Host> I<Hostname>
1402 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
1403 values. Defaults to the global hostname setting.
1411 =item B<Device> I<Device>
1413 Select partitions based on the devicename.
1415 =item B<MountPoint> I<Directory>
1417 Select partitions based on the mountpoint.
1419 =item B<FSType> I<FSType>
1421 Select partitions based on the filesystem type.
1423 =item B<IgnoreSelected> B<true>|B<false>
1425 Invert the selection: If set to true, all partitions B<except> the ones that
1426 match any one of the criteria are collected. By default only selected
1427 partitions are collected if a selection is made. If no selection is configured
1428 at all, B<all> partitions are selected.
1430 =item B<ReportByDevice> B<true>|B<false>
1432 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1433 (the default), it will report a disk as "root", but with it I<true>, it will be
1434 "sda1" (or whichever).
1436 =item B<ReportInodes> B<true>|B<false>
1438 Enables or disables reporting of free, reserved and used inodes. Defaults to
1439 inode collection being disabled.
1441 Enable this option if inodes are a scarce resource for you, usually because
1442 many small files are stored on the disk. This is a usual scenario for mail
1443 transfer agents and web caches.
1447 =head2 Plugin C<disk>
1449 The C<disk> plugin collects information about the usage of physical disks and
1450 logical disks (partitions). Values collected are the number of octets written
1451 to and read from a disk or partition, the number of read/write operations
1452 issued to the disk and a rather complex "time" it took for these commands to be
1455 Using the following two options you can ignore some disks or configure the
1456 collection only of specific disks.
1460 =item B<Disk> I<Name>
1462 Select the disk I<Name>. Whether it is collected or ignored depends on the
1463 B<IgnoreSelected> setting, see below. As with other plugins that use the
1464 daemon's ignorelist functionality, a string that starts and ends with a slash
1465 is interpreted as a regular expression. Examples:
1470 =item B<IgnoreSelected> B<true>|B<false>
1472 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1473 statements, are ignored or if all other disks are ignored. The behavior
1474 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1475 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1476 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1477 is set to B<true>, all disks are collected B<except> the ones matched.
1481 =head2 Plugin C<dns>
1485 =item B<Interface> I<Interface>
1487 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1488 option sets the interface that should be used. If this option is not set, or
1489 set to "any", the plugin will try to get packets from B<all> interfaces. This
1490 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1492 =item B<IgnoreSource> I<IP-address>
1494 Ignore packets that originate from this address.
1496 =item B<SelectNumericQueryTypes> B<true>|B<false>
1498 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1502 =head2 Plugin C<email>
1506 =item B<SocketFile> I<Path>
1508 Sets the socket-file which is to be created.
1510 =item B<SocketGroup> I<Group>
1512 If running as root change the group of the UNIX-socket after it has been
1513 created. Defaults to B<collectd>.
1515 =item B<SocketPerms> I<Permissions>
1517 Change the file permissions of the UNIX-socket after it has been created. The
1518 permissions must be given as a numeric, octal value as you would pass to
1519 L<chmod(1)>. Defaults to B<0770>.
1521 =item B<MaxConns> I<Number>
1523 Sets the maximum number of connections that can be handled in parallel. Since
1524 this many threads will be started immediately setting this to a very high
1525 value will waste valuable resources. Defaults to B<5> and will be forced to be
1526 at most B<16384> to prevent typos and dumb mistakes.
1530 =head2 Plugin C<ethstat>
1532 The I<ethstat plugin> collects information about network interface cards (NICs)
1533 by talking directly with the underlying kernel driver using L<ioctl(2)>.
1539 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
1540 Map "multicast" "if_multicast"
1547 =item B<Interface> I<Name>
1549 Collect statistical information about interface I<Name>.
1551 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
1553 By default, the plugin will submit values as type C<derive> and I<type
1554 instance> set to I<Name>, the name of the metric as reported by the driver. If
1555 an appropriate B<Map> option exists, the given I<Type> and, optionally,
1556 I<TypeInstance> will be used.
1558 =item B<MappedOnly> B<true>|B<false>
1560 When set to B<true>, only metrics that can be mapped to to a I<type> will be
1561 collected, all other metrics will be ignored. Defaults to B<false>.
1565 =head2 Plugin C<exec>
1567 Please make sure to read L<collectd-exec(5)> before using this plugin. It
1568 contains valuable information on when the executable is executed and the
1569 output that is expected from it.
1573 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1575 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1577 Execute the executable I<Executable> as user I<User>. If the user name is
1578 followed by a colon and a group name, the effective group is set to that group.
1579 The real group and saved-set group will be set to the default group of that
1580 user. If no group is given the effective group ID will be the same as the real
1583 Please note that in order to change the user and/or group the daemon needs
1584 superuser privileges. If the daemon is run as an unprivileged user you must
1585 specify the same user/group here. If the daemon is run with superuser
1586 privileges, you must supply a non-root user here.
1588 The executable may be followed by optional arguments that are passed to the
1589 program. Please note that due to the configuration parsing numbers and boolean
1590 values may be changed. If you want to be absolutely sure that something is
1591 passed as-is please enclose it in quotes.
1593 The B<Exec> and B<NotificationExec> statements change the semantics of the
1594 programs executed, i.E<nbsp>e. the data passed to them and the response
1595 expected from them. This is documented in great detail in L<collectd-exec(5)>.
1599 =head2 Plugin C<filecount>
1601 The C<filecount> plugin counts the number of files in a certain directory (and
1602 its subdirectories) and their combined size. The configuration is very straight
1605 <Plugin "filecount">
1606 <Directory "/var/qmail/queue/mess">
1607 Instance "qmail-message"
1609 <Directory "/var/qmail/queue/todo">
1610 Instance "qmail-todo"
1612 <Directory "/var/lib/php5">
1613 Instance "php5-sessions"
1618 The example above counts the number of files in QMail's queue directories and
1619 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
1620 QMail has not yet looked at, the "message" queue holds the messages that were
1621 classified into "local" and "remote".
1623 As you can see, the configuration consists of one or more C<Directory> blocks,
1624 each of which specifies a directory in which to count the files. Within those
1625 blocks, the following options are recognized:
1629 =item B<Instance> I<Instance>
1631 Sets the plugin instance to I<Instance>. That instance name must be unique, but
1632 it's your responsibility, the plugin doesn't check for that. If not given, the
1633 instance is set to the directory name with all slashes replaced by underscores
1634 and all leading underscores removed.
1636 =item B<Name> I<Pattern>
1638 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
1639 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
1640 against the pattern, not the entire path. In case this makes it easier for you:
1641 This option has been named after the B<-name> parameter to L<find(1)>.
1643 =item B<MTime> I<Age>
1645 Count only files of a specific age: If I<Age> is greater than zero, only files
1646 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
1647 a negative number, this is inversed. For example, if B<-60> is specified, only
1648 files that have been modified in the last minute will be counted.
1650 The number can also be followed by a "multiplier" to easily specify a larger
1651 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
1652 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
1653 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
1654 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
1655 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
1658 =item B<Size> I<Size>
1660 Count only files of a specific size. When I<Size> is a positive number, only
1661 files that are at least this big are counted. If I<Size> is a negative number,
1662 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
1663 I<Size> are counted.
1665 As with the B<MTime> option, a "multiplier" may be added. For a detailed
1666 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
1667 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
1668 note that there are 1000 bytes in a kilobyte, not 1024.
1670 =item B<Recursive> I<true>|I<false>
1672 Controls whether or not to recurse into subdirectories. Enabled by default.
1674 =item B<IncludeHidden> I<true>|I<false>
1676 Controls whether or not to include "hidden" files and directories in the count.
1677 "Hidden" files and directories are those, whose name begins with a dot.
1678 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
1682 =head2 Plugin C<GenericJMX>
1684 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
1685 L<collectd-java(5)>.
1687 =head2 Plugin C<gmond>
1689 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
1690 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
1691 are built-in, custom mappings may be added via B<Metric> blocks, see below.
1696 MCReceiveFrom "239.2.11.71" "8649"
1697 <Metric "swap_total">
1699 TypeInstance "total"
1702 <Metric "swap_free">
1709 The following metrics are built-in:
1715 load_one, load_five, load_fifteen
1719 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
1723 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
1735 Available configuration options:
1739 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
1741 Sets sets the multicast group and UDP port to which to subscribe.
1743 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
1745 =item E<lt>B<Metric> I<Name>E<gt>
1747 These blocks add a new metric conversion to the internal table. I<Name>, the
1748 string argument to the B<Metric> block, is the metric name as used by Ganglia.
1752 =item B<Type> I<Type>
1754 Type to map this metric to. Required.
1756 =item B<TypeInstance> I<Instance>
1758 Type-instance to use. Optional.
1760 =item B<DataSource> I<Name>
1762 Data source to map this metric to. If the configured type has exactly one data
1763 source, this is optional. Otherwise the option is required.
1769 =head2 Plugin C<hddtemp>
1771 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
1772 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
1773 default values, see below. C<hddtemp> has to be running to work correctly. If
1774 C<hddtemp> is not running timeouts may appear which may interfere with other
1777 The B<hddtemp> homepage can be found at
1778 L<http://www.guzu.net/linux/hddtemp.php>.
1782 =item B<Host> I<Hostname>
1784 Hostname to connect to. Defaults to B<127.0.0.1>.
1786 =item B<Port> I<Port>
1788 TCP-Port to connect to. Defaults to B<7634>.
1792 =head2 Plugin C<interface>
1796 =item B<Interface> I<Interface>
1798 Select this interface. By default these interfaces will then be collected. For
1799 a more detailed description see B<IgnoreSelected> below.
1801 =item B<IgnoreSelected> I<true>|I<false>
1803 If no configuration if given, the B<traffic>-plugin will collect data from
1804 all interfaces. This may not be practical, especially for loopback- and
1805 similar interfaces. Thus, you can use the B<Interface>-option to pick the
1806 interfaces you're interested in. Sometimes, however, it's easier/preferred
1807 to collect all interfaces I<except> a few ones. This option enables you to
1808 do that: By setting B<IgnoreSelected> to I<true> the effect of
1809 B<Interface> is inverted: All selected interfaces are ignored and all
1810 other interfaces are collected.
1814 =head2 Plugin C<ipmi>
1818 =item B<Sensor> I<Sensor>
1820 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
1822 =item B<IgnoreSelected> I<true>|I<false>
1824 If no configuration if given, the B<ipmi> plugin will collect data from all
1825 sensors found of type "temperature", "voltage", "current" and "fanspeed".
1826 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
1827 the effect of B<Sensor> is inverted: All selected sensors are ignored and
1828 all other sensors are collected.
1830 =item B<NotifySensorAdd> I<true>|I<false>
1832 If a sensor appears after initialization time of a minute a notification
1835 =item B<NotifySensorRemove> I<true>|I<false>
1837 If a sensor disappears a notification is sent.
1839 =item B<NotifySensorNotPresent> I<true>|I<false>
1841 If you have for example dual power supply and one of them is (un)plugged then
1842 a notification is sent.
1846 =head2 Plugin C<iptables>
1850 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
1852 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
1853 will collect the counters of all rules which have a comment-match. The comment
1854 is then used as type-instance.
1856 If I<Comment> or I<Number> is given, only the rule with the matching comment or
1857 the I<n>th rule will be collected. Again, the comment (or the number) will be
1858 used as the type-instance.
1860 If I<Name> is supplied, it will be used as the type-instance instead of the
1861 comment or the number.
1865 =head2 Plugin C<irq>
1871 Select this irq. By default these irqs will then be collected. For a more
1872 detailed description see B<IgnoreSelected> below.
1874 =item B<IgnoreSelected> I<true>|I<false>
1876 If no configuration if given, the B<irq>-plugin will collect data from all
1877 irqs. This may not be practical, especially if no interrupts happen. Thus, you
1878 can use the B<Irq>-option to pick the interrupt you're interested in.
1879 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
1880 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
1881 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
1882 and all other interrupts are collected.
1886 =head2 Plugin C<java>
1888 The I<Java> plugin makes it possible to write extensions for collectd in Java.
1889 This section only discusses the syntax and semantic of the configuration
1890 options. For more in-depth information on the I<Java> plugin, please read
1891 L<collectd-java(5)>.
1896 JVMArg "-verbose:jni"
1897 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
1898 LoadPlugin "org.collectd.java.Foobar"
1899 <Plugin "org.collectd.java.Foobar">
1900 # To be parsed by the plugin
1904 Available configuration options:
1908 =item B<JVMArg> I<Argument>
1910 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
1911 exactly the way the arguments to the I<java> binary on the command line work.
1912 Execute C<javaE<nbsp>--help> for details.
1914 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
1915 any other options! When another option is found, the JVM will be started and
1916 later options will have to be ignored!
1918 =item B<LoadPlugin> I<JavaClass>
1920 Instantiates a new I<JavaClass> object. The constructor of this object very
1921 likely then registers one or more callback methods with the server.
1923 See L<collectd-java(5)> for details.
1925 When the first such option is found, the virtual machine (JVM) is created. This
1926 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
1927 B<LoadPlugin> options!
1929 =item B<Plugin> I<Name>
1931 The entire block is passed to the Java plugin as an
1932 I<org.collectd.api.OConfigItem> object.
1934 For this to work, the plugin has to register a configuration callback first,
1935 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
1936 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
1937 depends on the (Java) plugin registering the callback and is completely
1938 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
1942 =head2 Plugin C<libvirt>
1944 This plugin allows CPU, disk and network load to be collected for virtualized
1945 guests on the machine. This means that these characteristics can be collected
1946 for guest systems without installing any software on them - collectd only runs
1947 on the hosting system. The statistics are collected through libvirt
1948 (L<http://libvirt.org/>).
1950 Only I<Connection> is required.
1954 =item B<Connection> I<uri>
1956 Connect to the hypervisor given by I<uri>. For example if using Xen use:
1958 Connection "xen:///"
1960 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
1962 =item B<RefreshInterval> I<seconds>
1964 Refresh the list of domains and devices every I<seconds>. The default is 60
1965 seconds. Setting this to be the same or smaller than the I<Interval> will cause
1966 the list of domains and devices to be refreshed on every iteration.
1968 Refreshing the devices in particular is quite a costly operation, so if your
1969 virtualization setup is static you might consider increasing this. If this
1970 option is set to 0, refreshing is disabled completely.
1972 =item B<Domain> I<name>
1974 =item B<BlockDevice> I<name:dev>
1976 =item B<InterfaceDevice> I<name:dev>
1978 =item B<IgnoreSelected> I<true>|I<false>
1980 Select which domains and devices are collected.
1982 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
1983 disk/network devices are collected.
1985 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
1986 domains and disk/network devices are ignored, while the rest are collected.
1988 The domain name and device names may use a regular expression, if the name is
1989 surrounded by I</.../> and collectd was compiled with support for regexps.
1991 The default is to collect statistics for all domains and all their devices.
1995 BlockDevice "/:hdb/"
1996 IgnoreSelected "true"
1998 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
2001 =item B<HostnameFormat> B<name|uuid|hostname|...>
2003 When the libvirt plugin logs data, it sets the hostname of the collected data
2004 according to this setting. The default is to use the guest name as provided by
2005 the hypervisor, which is equal to setting B<name>.
2007 B<uuid> means use the guest's UUID. This is useful if you want to track the
2008 same guest across migrations.
2010 B<hostname> means to use the global B<Hostname> setting, which is probably not
2011 useful on its own because all guests will appear to have the same name.
2013 You can also specify combinations of these fields. For example B<name uuid>
2014 means to concatenate the guest name and UUID (with a literal colon character
2015 between, thus I<"foo:1234-1234-1234-1234">).
2017 =item B<InterfaceFormat> B<name>|B<address>
2019 When the libvirt plugin logs interface data, it sets the name of the collected
2020 data according to this setting. The default is to use the path as provided by
2021 the hypervisor (the "dev" property of the target node), which is equal to
2024 B<address> means use the interface's mac address. This is useful since the
2025 interface path might change between reboots of a guest or across migrations.
2029 =head2 Plugin C<logfile>
2033 =item B<LogLevel> B<debug|info|notice|warning|err>
2035 Sets the log-level. If, for example, set to B<notice>, then all events with
2036 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2038 Please note that B<debug> is only available if collectd has been compiled with
2041 =item B<File> I<File>
2043 Sets the file to write log messages to. The special strings B<stdout> and
2044 B<stderr> can be used to write to the standard output and standard error
2045 channels, respectively. This, of course, only makes much sense when I<collectd>
2046 is running in foreground- or non-daemon-mode.
2048 =item B<Timestamp> B<true>|B<false>
2050 Prefix all lines printed by the current time. Defaults to B<true>.
2052 =item B<PrintSeverity> B<true>|B<false>
2054 When enabled, all lines are prefixed by the severity of the log message, for
2055 example "warning". Defaults to B<false>.
2059 B<Note>: There is no need to notify the daemon after moving or removing the
2060 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2061 for each line it writes.
2063 =head2 Plugin C<lpar>
2065 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2066 virtualization technique for IBM POWER processors. It takes into account CPU
2067 time stolen from or donated to a partition, in addition to the usual user,
2068 system, I/O statistics.
2070 The following configuration options are available:
2074 =item B<CpuPoolStats> B<false>|B<true>
2076 When enabled, statistics about the processor pool are read, too. The partition
2077 needs to have pool authority in order to be able to acquire this information.
2080 =item B<ReportBySerial> B<false>|B<true>
2082 If enabled, the serial of the physical machine the partition is currently
2083 running on is reported as I<hostname> and the logical hostname of the machine
2084 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2085 used (just like other plugins) and the I<plugin instance> will be empty.
2090 =head2 Plugin C<mbmon>
2092 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2094 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2095 B<Host> and B<Port> options can be used to change these values, see below.
2096 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2097 timeouts may appear which may interfere with other statistics..
2099 C<mbmon> must be run with the -r option ("print TAG and Value format");
2100 Debian's F</etc/init.d/mbmon> script already does this, other people
2101 will need to ensure that this is the case.
2105 =item B<Host> I<Hostname>
2107 Hostname to connect to. Defaults to B<127.0.0.1>.
2109 =item B<Port> I<Port>
2111 TCP-Port to connect to. Defaults to B<411>.
2117 The C<md plugin> collects information from Linux Software-RAID devices (md).
2119 All reported values are of the type C<md_disks>. Reported type instances are
2120 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2121 I<missing> (physically absent) disks.
2125 =item B<Device> I<Device>
2127 Select md devices based on device name. The I<device name> is the basename of
2128 the device, i.e. the name of the block device without the leading C</dev/>.
2129 See B<IgnoreSelected> for more details.
2131 =item B<IgnoreSelected> B<true>|B<false>
2133 Invert device selection: If set to B<true>, all md devices B<except> those
2134 listed using B<Device> are collected. If B<false> (the default), only those
2135 listed are collected. If no configuration is given, the B<md> plugin will
2136 collect data from all md devices.
2140 =head2 Plugin C<memcachec>
2142 The C<memcachec plugin> connects to a memcached server, queries one or more
2143 given I<pages> and parses the returned data according to user specification.
2144 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2147 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2148 library. Please note that there is another library with a very similar name,
2149 libmemcache (notice the missing `d'), which is not applicable.
2151 Synopsis of the configuration:
2153 <Plugin "memcachec">
2154 <Page "plugin_instance">
2158 Regex "(\\d+) bytes sent"
2161 Instance "type_instance"
2166 The configuration options are:
2170 =item E<lt>B<Page> I<Name>E<gt>
2172 Each B<Page> block defines one I<page> to be queried from the memcached server.
2173 The block requires one string argument which is used as I<plugin instance>.
2175 =item B<Server> I<Address>
2177 Sets the server address to connect to when querying the page. Must be inside a
2182 When connected to the memcached server, asks for the page I<Key>.
2184 =item E<lt>B<Match>E<gt>
2186 Match blocks define which strings to look for and how matches substrings are
2187 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2191 =head2 Plugin C<memcached>
2193 The C<memcached plugin> connects to a memcached server and queries statistics
2194 about cache utilization, memory and bandwidth used.
2195 L<http://www.danga.com/memcached/>
2197 <Plugin "memcached">
2199 Host "memcache.example.com"
2204 The plugin configuration consists of one or more B<Instance> blocks which
2205 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2206 following options are allowed:
2210 =item B<Host> I<Hostname>
2212 Hostname to connect to. Defaults to B<127.0.0.1>.
2214 =item B<Port> I<Port>
2216 TCP-Port to connect to. Defaults to B<11211>.
2218 =item B<Socket> I<Path>
2220 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2221 setting is given, the B<Host> and B<Port> settings are ignored.
2225 =head2 Plugin C<modbus>
2227 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
2228 register values. It supports reading single registers (unsigned 16E<nbsp>bit
2229 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2230 values (two registers interpreted as IEEE floats in big endian notation).
2234 <Data "voltage-input-1">
2241 <Data "voltage-input-2">
2248 <Host "modbus.example.com">
2249 Address "192.168.0.42"
2254 Instance "power-supply"
2255 Collect "voltage-input-1"
2256 Collect "voltage-input-2"
2262 =item E<lt>B<Data> I<Name>E<gt> blocks
2264 Data blocks define a mapping between register numbers and the "types" used by
2267 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
2271 =item B<RegisterBase> I<Number>
2273 Configures the base register to read from the device. If the option
2274 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
2275 register will be read (the register number is increased by one).
2277 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
2279 Specifies what kind of data is returned by the device. If the type is B<Int32>,
2280 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
2281 combined into one value. Defaults to B<Uint16>.
2283 =item B<Type> I<Type>
2285 Specifies the "type" (data set) to use when dispatching the value to
2286 I<collectd>. Currently, only data sets with exactly one data source are
2289 =item B<Instance> I<Instance>
2291 Sets the type instance to use when dispatching the value to I<collectd>. If
2292 unset, an empty string (no type instance) is used.
2296 =item E<lt>B<Host> I<Name>E<gt> blocks
2298 Host blocks are used to specify to which hosts to connect and what data to read
2299 from their "slaves". The string argument I<Name> is used as hostname when
2300 dispatching the values to I<collectd>.
2302 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
2306 =item B<Address> I<Hostname>
2308 Specifies the node name (the actual network address) used to connect to the
2309 host. This may be an IP address or a hostname. Please note that the used
2310 I<libmodbus> library only supports IPv4 at the moment.
2312 =item B<Port> I<Service>
2314 Specifies the port used to connect to the host. The port can either be given as
2315 a number or as a service name. Please note that the I<Service> argument must be
2316 a string, even if ports are given in their numerical form. Defaults to "502".
2318 =item B<Interval> I<Interval>
2320 Sets the interval (in seconds) in which the values will be collected from this
2321 host. By default the global B<Interval> setting will be used.
2323 =item E<lt>B<Slave> I<ID>E<gt>
2325 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
2326 is used to specify which device should be addressed. For each device you want
2327 to query, one B<Slave> block must be given.
2329 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
2333 =item B<Instance> I<Instance>
2335 Specify the plugin instance to use when dispatching the values to I<collectd>.
2336 By default "slave_I<ID>" is used.
2338 =item B<Collect> I<DataName>
2340 Specifies which data to retrieve from the device. I<DataName> must be the same
2341 string as the I<Name> argument passed to a B<Data> block. You can specify this
2342 option multiple times to collect more than one value from a slave. At least one
2343 B<Collect> option is mandatory.
2351 =head2 Plugin C<mysql>
2353 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
2354 one or more databases when started and keeps the connection up as long as
2355 possible. When the connection is interrupted for whatever reason it will try
2356 to re-connect. The plugin will complain loudly in case anything goes wrong.
2358 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
2359 and collects information about MySQL network traffic, executed statements,
2360 requests, the query cache and threads by evaluating the
2361 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
2362 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
2363 Status Variables> for an explanation of these values.
2365 Optionally, master and slave statistics may be collected in a MySQL
2366 replication setup. In that case, information about the synchronization state
2367 of the nodes are collected by evaluating the C<Position> return value of the
2368 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
2369 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
2370 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
2371 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
2372 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
2387 Socket "/var/run/mysql/mysqld.sock"
2389 SlaveNotifications true
2393 A B<Database> block defines one connection to a MySQL database. It accepts a
2394 single argument which specifies the name of the database. None of the other
2395 options are required. MySQL will use default values as documented in the
2396 section "mysql_real_connect()" in the B<MySQL reference manual>.
2400 =item B<Host> I<Hostname>
2402 Hostname of the database server. Defaults to B<localhost>.
2404 =item B<User> I<Username>
2406 Username to use when connecting to the database. The user does not have to be
2407 granted any privileges (which is synonym to granting the C<USAGE> privilege),
2408 unless you want to collectd replication statistics (see B<MasterStats> and
2409 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
2410 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
2412 =item B<Password> I<Password>
2414 Password needed to log into the database.
2416 =item B<Database> I<Database>
2418 Select this database. Defaults to I<no database> which is a perfectly reasonable
2419 option for what this plugin does.
2421 =item B<Port> I<Port>
2423 TCP-port to connect to. The port must be specified in its numeric form, but it
2424 must be passed as a string nonetheless. For example:
2428 If B<Host> is set to B<localhost> (the default), this setting has no effect.
2429 See the documentation for the C<mysql_real_connect> function for details.
2431 =item B<Socket> I<Socket>
2433 Specifies the path to the UNIX domain socket of the MySQL server. This option
2434 only has any effect, if B<Host> is set to B<localhost> (the default).
2435 Otherwise, use the B<Port> option above. See the documentation for the
2436 C<mysql_real_connect> function for details.
2438 =item B<MasterStats> I<true|false>
2440 =item B<SlaveStats> I<true|false>
2442 Enable the collection of master / slave statistics in a replication setup. In
2443 order to be able to get access to these statistics, the user needs special
2444 privileges. See the B<User> documentation above.
2446 =item B<SlaveNotifications> I<true|false>
2448 If enabled, the plugin sends a notification if the replication slave I/O and /
2449 or SQL threads are not running.
2453 =head2 Plugin C<netapp>
2455 The netapp plugin can collect various performance and capacity information
2456 from a NetApp filer using the NetApp API.
2458 Please note that NetApp has a wide line of products and a lot of different
2459 software versions for each of these products. This plugin was developed for a
2460 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
2461 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
2462 model and software version but it is very hard to test this.
2463 If you have used this plugin with other models and/or software version, feel
2464 free to send us a mail to tell us about the results, even if it's just a short
2467 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
2468 basic authentication.
2470 B<Do not use a regular user for this!> Create a special collectd user with just
2471 the minimum of capabilities needed. The user only needs the "login-http-admin"
2472 capability as well as a few more depending on which data will be collected.
2473 Required capabilities are documented below.
2478 <Host "netapp1.example.com">
2502 IgnoreSelectedIO false
2504 IgnoreSelectedOps false
2505 GetLatency "volume0"
2506 IgnoreSelectedLatency false
2513 IgnoreSelectedCapacity false
2516 IgnoreSelectedSnapshot false
2540 The netapp plugin accepts the following configuration options:
2544 =item B<Host> I<Name>
2546 A host block defines one NetApp filer. It will appear in collectd with the name
2547 you specify here which does not have to be its real name nor its hostname (see
2548 the B<Address> option below).
2550 =item B<VFiler> I<Name>
2552 A B<VFiler> block may only be used inside a host block. It accepts all the
2553 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
2554 will execute all NetApp API commands in the context of the specified
2555 VFiler(R). It will appear in collectd with the name you specify here which
2556 does not have to be its real name. The VFiler name may be specified using the
2557 B<VFilerName> option. If this is not specified, it will default to the name
2560 The VFiler block inherits all connection related settings from the surrounding
2561 B<Host> block (which appear before the B<VFiler> block) but they may be
2562 overwritten inside the B<VFiler> block.
2564 This feature is useful, for example, when using a VFiler as SnapVault target
2565 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
2566 available in the host filer (vfiler0) but only in the respective VFiler
2569 =item B<Protocol> B<httpd>|B<http>
2571 The protocol collectd will use to query this host.
2579 Valid options: http, https
2581 =item B<Address> I<Address>
2583 The hostname or IP address of the host.
2589 Default: The "host" block's name.
2591 =item B<Port> I<Port>
2593 The TCP port to connect to on the host.
2599 Default: 80 for protocol "http", 443 for protocol "https"
2601 =item B<User> I<User>
2603 =item B<Password> I<Password>
2605 The username and password to use to login to the NetApp.
2611 =item B<VFilerName> I<Name>
2613 The name of the VFiler in which context to execute API commands. If not
2614 specified, the name provided to the B<VFiler> block will be used instead.
2620 Default: name of the B<VFiler> block
2622 B<Note:> This option may only be used inside B<VFiler> blocks.
2624 =item B<Interval> I<Interval>
2630 The following options decide what kind of data will be collected. You can
2631 either use them as a block and fine tune various parameters inside this block,
2632 use them as a single statement to just accept all default values, or omit it to
2633 not collect any data.
2635 The following options are valid inside all blocks:
2639 =item B<Interval> I<Seconds>
2641 Collect the respective statistics every I<Seconds> seconds. Defaults to the
2642 host specific setting.
2646 =head3 The System block
2648 This will collect various performance data about the whole system.
2650 B<Note:> To get this data the collectd user needs the
2651 "api-perf-object-get-instances" capability.
2655 =item B<Interval> I<Seconds>
2657 Collect disk statistics every I<Seconds> seconds.
2659 =item B<GetCPULoad> B<true>|B<false>
2661 If you set this option to true the current CPU usage will be read. This will be
2662 the average usage between all CPUs in your NetApp without any information about
2665 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2666 returns in the "CPU" field.
2674 Result: Two value lists of type "cpu", and type instances "idle" and "system".
2676 =item B<GetInterfaces> B<true>|B<false>
2678 If you set this option to true the current traffic of the network interfaces
2679 will be read. This will be the total traffic over all interfaces of your NetApp
2680 without any information about individual interfaces.
2682 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2683 in the "Net kB/s" field.
2693 Result: One value list of type "if_octects".
2695 =item B<GetDiskIO> B<true>|B<false>
2697 If you set this option to true the current IO throughput will be read. This
2698 will be the total IO of your NetApp without any information about individual
2699 disks, volumes or aggregates.
2701 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2702 in the "DiskE<nbsp>kB/s" field.
2710 Result: One value list of type "disk_octets".
2712 =item B<GetDiskOps> B<true>|B<false>
2714 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
2715 iSCSI, etc. operations will be read. This will be the total number of
2716 operations on your NetApp without any information about individual volumes or
2719 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2720 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
2728 Result: A variable number of value lists of type "disk_ops_complex". Each type
2729 of operation will result in one value list with the name of the operation as
2734 =head3 The WAFL block
2736 This will collect various performance data about the WAFL file system. At the
2737 moment this just means cache performance.
2739 B<Note:> To get this data the collectd user needs the
2740 "api-perf-object-get-instances" capability.
2742 B<Note:> The interface to get these values is classified as "Diagnostics" by
2743 NetApp. This means that it is not guaranteed to be stable even between minor
2748 =item B<Interval> I<Seconds>
2750 Collect disk statistics every I<Seconds> seconds.
2752 =item B<GetNameCache> B<true>|B<false>
2760 Result: One value list of type "cache_ratio" and type instance
2763 =item B<GetDirCache> B<true>|B<false>
2771 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
2773 =item B<GetInodeCache> B<true>|B<false>
2781 Result: One value list of type "cache_ratio" and type instance
2784 =item B<GetBufferCache> B<true>|B<false>
2786 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
2787 in the "Cache hit" field.
2795 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
2799 =head3 The Disks block
2801 This will collect performance data about the individual disks in the NetApp.
2803 B<Note:> To get this data the collectd user needs the
2804 "api-perf-object-get-instances" capability.
2808 =item B<Interval> I<Seconds>
2810 Collect disk statistics every I<Seconds> seconds.
2812 =item B<GetBusy> B<true>|B<false>
2814 If you set this option to true the busy time of all disks will be calculated
2815 and the value of the busiest disk in the system will be written.
2817 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2818 in the "Disk util" field. Probably.
2826 Result: One value list of type "percent" and type instance "disk_busy".
2830 =head3 The VolumePerf block
2832 This will collect various performance data about the individual volumes.
2834 You can select which data to collect about which volume using the following
2835 options. They follow the standard ignorelist semantic.
2837 B<Note:> To get this data the collectd user needs the
2838 I<api-perf-object-get-instances> capability.
2842 =item B<Interval> I<Seconds>
2844 Collect volume performance data every I<Seconds> seconds.
2846 =item B<GetIO> I<Volume>
2848 =item B<GetOps> I<Volume>
2850 =item B<GetLatency> I<Volume>
2852 Select the given volume for IO, operations or latency statistics collection.
2853 The argument is the name of the volume without the C</vol/> prefix.
2855 Since the standard ignorelist functionality is used here, you can use a string
2856 starting and ending with a slash to specify regular expression matching: To
2857 match the volumes "vol0", "vol2" and "vol7", you can use this regular
2860 GetIO "/^vol[027]$/"
2862 If no regular expression is specified, an exact match is required. Both,
2863 regular and exact matching are case sensitive.
2865 If no volume was specified at all for either of the three options, that data
2866 will be collected for all available volumes.
2868 =item B<IgnoreSelectedIO> B<true>|B<false>
2870 =item B<IgnoreSelectedOps> B<true>|B<false>
2872 =item B<IgnoreSelectedLatency> B<true>|B<false>
2874 When set to B<true>, the volumes selected for IO, operations or latency
2875 statistics collection will be ignored and the data will be collected for all
2878 When set to B<false>, data will only be collected for the specified volumes and
2879 all other volumes will be ignored.
2881 If no volumes have been specified with the above B<Get*> options, all volumes
2882 will be collected regardless of the B<IgnoreSelected*> option.
2884 Defaults to B<false>
2888 =head3 The VolumeUsage block
2890 This will collect capacity data about the individual volumes.
2892 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
2897 =item B<Interval> I<Seconds>
2899 Collect volume usage statistics every I<Seconds> seconds.
2901 =item B<GetCapacity> I<VolumeName>
2903 The current capacity of the volume will be collected. This will result in two
2904 to four value lists, depending on the configuration of the volume. All data
2905 sources are of type "df_complex" with the name of the volume as
2908 There will be type_instances "used" and "free" for the number of used and
2909 available bytes on the volume. If the volume has some space reserved for
2910 snapshots, a type_instance "snap_reserved" will be available. If the volume
2911 has SIS enabled, a type_instance "sis_saved" will be available. This is the
2912 number of bytes saved by the SIS feature.
2914 B<Note:> The current NetApp API has a bug that results in this value being
2915 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
2916 number which works most of the time. If you see strange values here, bug
2917 NetApp support to fix this.
2919 Repeat this option to specify multiple volumes.
2921 =item B<IgnoreSelectedCapacity> B<true>|B<false>
2923 Specify whether to collect only the volumes selected by the B<GetCapacity>
2924 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
2925 B<false>. However, if no B<GetCapacity> option is specified at all, all
2926 capacities will be selected anyway.
2928 =item B<GetSnapshot> I<VolumeName>
2930 Select volumes from which to collect snapshot information.
2932 Usually, the space used for snapshots is included in the space reported as
2933 "used". If snapshot information is collected as well, the space used for
2934 snapshots is subtracted from the used space.
2936 To make things even more interesting, it is possible to reserve space to be
2937 used for snapshots. If the space required for snapshots is less than that
2938 reserved space, there is "reserved free" and "reserved used" space in addition
2939 to "free" and "used". If the space required for snapshots exceeds the reserved
2940 space, that part allocated in the normal space is subtracted from the "used"
2943 Repeat this option to specify multiple volumes.
2945 =item B<IgnoreSelectedSnapshot>
2947 Specify whether to collect only the volumes selected by the B<GetSnapshot>
2948 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
2949 B<false>. However, if no B<GetSnapshot> option is specified at all, all
2950 capacities will be selected anyway.
2954 =head3 The SnapVault block
2956 This will collect statistics about the time and traffic of SnapVault(R)
2961 =item B<Interval> I<Seconds>
2963 Collect SnapVault(R) statistics every I<Seconds> seconds.
2967 =head2 Plugin C<netlink>
2969 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
2970 statistics of various interface and routing aspects.
2974 =item B<Interface> I<Interface>
2976 =item B<VerboseInterface> I<Interface>
2978 Instruct the plugin to collect interface statistics. This is basically the same
2979 as the statistics provided by the C<interface> plugin (see above) but
2980 potentially much more detailed.
2982 When configuring with B<Interface> only the basic statistics will be collected,
2983 namely octets, packets, and errors. These statistics are collected by
2984 the C<interface> plugin, too, so using both at the same time is no benefit.
2986 When configured with B<VerboseInterface> all counters B<except> the basic ones,
2987 so that no data needs to be collected twice if you use the C<interface> plugin.
2988 This includes dropped packets, received multicast packets, collisions and a
2989 whole zoo of differentiated RX and TX errors. You can try the following command
2990 to get an idea of what awaits you:
2994 If I<Interface> is B<All>, all interfaces will be selected.
2996 =item B<QDisc> I<Interface> [I<QDisc>]
2998 =item B<Class> I<Interface> [I<Class>]
3000 =item B<Filter> I<Interface> [I<Filter>]
3002 Collect the octets and packets that pass a certain qdisc, class or filter.
3004 QDiscs and classes are identified by their type and handle (or classid).
3005 Filters don't necessarily have a handle, therefore the parent's handle is used.
3006 The notation used in collectd differs from that used in tc(1) in that it
3007 doesn't skip the major or minor number if it's zero and doesn't print special
3008 ids by their name. So, for example, a qdisc may be identified by
3009 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3010 thus not displayed by tc(1).
3012 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3013 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3014 associated with that interface will be collected.
3016 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3017 used. This may lead to problems when more than one filter is attached to a
3018 qdisc or class. This isn't nice, but we don't know how this could be done any
3019 better. If you have a idea, please don't hesitate to tell us.
3021 As with the B<Interface> option you can specify B<All> as the interface,
3022 meaning all interfaces.
3024 Here are some examples to help you understand the above text more easily:
3027 VerboseInterface "All"
3028 QDisc "eth0" "pfifo_fast-1:0"
3030 Class "ppp0" "htb-1:10"
3031 Filter "ppp0" "u32-1:0"
3034 =item B<IgnoreSelected>
3036 The behavior is the same as with all other similar plugins: If nothing is
3037 selected at all, everything is collected. If some things are selected using the
3038 options described above, only these statistics are collected. If you set
3039 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3040 specified statistics will not be collected.
3044 =head2 Plugin C<network>
3046 The Network plugin sends data to a remote instance of collectd, receives data
3047 from a remote instance, or both at the same time. Data which has been received
3048 from the network is usually not transmitted again, but this can be activated, see
3049 the B<Forward> option below.
3051 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3052 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3054 Both, B<Server> and B<Listen> can be used as single option or as block. When
3055 used as block, given options are valid for this socket only. The following
3056 example will export the metrics twice: Once to an "internal" server (without
3057 encryption and signing) and one to an external server (with cryptographic
3061 # Export to an internal server
3062 # (demonstrates usage without additional options)
3063 Server "collectd.internal.tld"
3065 # Export to an external server
3066 # (demonstrates usage with signature options)
3067 <Server "collectd.external.tld">
3068 SecurityLevel "sign"
3069 Username "myhostname"
3076 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3078 The B<Server> statement/block sets the server to send datagrams to. The
3079 statement may occur multiple times to send each datagram to multiple
3082 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3083 optional second argument specifies a port number or a service name. If not
3084 given, the default, B<25826>, is used.
3086 The following options are recognized within B<Server> blocks:
3090 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3092 Set the security you require for network communication. When the security level
3093 has been set to B<Encrypt>, data sent over the network will be encrypted using
3094 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3095 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3096 authentication code. When set to B<None>, data is sent without any security.
3098 This feature is only available if the I<network> plugin was linked with
3101 =item B<Username> I<Username>
3103 Sets the username to transmit. This is used by the server to lookup the
3104 password. See B<AuthFile> below. All security levels except B<None> require
3107 This feature is only available if the I<network> plugin was linked with
3110 =item B<Password> I<Password>
3112 Sets a password (shared secret) for this socket. All security levels except
3113 B<None> require this setting.
3115 This feature is only available if the I<network> plugin was linked with
3118 =item B<Interface> I<Interface name>
3120 Set the outgoing interface for IP packets. This applies at least
3121 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3122 undefined or a non-existent interface name is specified, the default
3123 behavior is to let the kernel choose the appropriate interface. Be warned
3124 that the manual selection of an interface for unicast traffic is only
3125 necessary in rare cases.
3129 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
3131 The B<Listen> statement sets the interfaces to bind to. When multiple
3132 statements are found the daemon will bind to multiple interfaces.
3134 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
3135 the argument is a multicast address the daemon will join that multicast group.
3136 The optional second argument specifies a port number or a service name. If not
3137 given, the default, B<25826>, is used.
3139 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
3143 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3145 Set the security you require for network communication. When the security level
3146 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
3147 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
3148 signed and encrypted data is accepted. When set to B<None>, all data will be
3149 accepted. If an B<AuthFile> option was given (see below), encrypted data is
3150 decrypted if possible.
3152 This feature is only available if the I<network> plugin was linked with
3155 =item B<AuthFile> I<Filename>
3157 Sets a file in which usernames are mapped to passwords. These passwords are
3158 used to verify signatures and to decrypt encrypted network packets. If
3159 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
3160 verified and encrypted packets are decrypted. Otherwise, signed data is
3161 accepted without checking the signature and encrypted data cannot be decrypted.
3162 For the other security levels this option is mandatory.
3164 The file format is very simple: Each line consists of a username followed by a
3165 colon and any number of spaces followed by the password. To demonstrate, an
3166 example file could look like this:
3171 Each time a packet is received, the modification time of the file is checked
3172 using L<stat(2)>. If the file has been changed, the contents is re-read. While
3173 the file is being read, it is locked using L<fcntl(2)>.
3175 =item B<Interface> I<Interface name>
3177 Set the incoming interface for IP packets explicitly. This applies at least
3178 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3179 undefined or a non-existent interface name is specified, the default
3180 behavior is, to let the kernel choose the appropriate interface. Thus incoming
3181 traffic gets only accepted, if it arrives on the given interface.
3185 =item B<TimeToLive> I<1-255>
3187 Set the time-to-live of sent packets. This applies to all, unicast and
3188 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
3189 That means that multicast packets will be sent with a TTL of C<1> (one) on most
3192 =item B<MaxPacketSize> I<1024-65535>
3194 Set the maximum size for datagrams received over the network. Packets larger
3195 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
3196 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
3199 On the server side, this limit should be set to the largest value used on
3200 I<any> client. Likewise, the value on the client must not be larger than the
3201 value on the server, or data will be lost.
3203 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
3204 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
3205 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
3208 =item B<Forward> I<true|false>
3210 If set to I<true>, write packets that were received via the network plugin to
3211 the sending sockets. This should only be activated when the B<Listen>- and
3212 B<Server>-statements differ. Otherwise packets may be send multiple times to
3213 the same multicast group. While this results in more network traffic than
3214 necessary it's not a huge problem since the plugin has a duplicate detection,
3215 so the values will not loop.
3217 =item B<ReportStats> B<true>|B<false>
3219 The network plugin cannot only receive and send statistics, it can also create
3220 statistics about itself. Collected data included the number of received and
3221 sent octets and packets, the length of the receive queue and the number of
3222 values handled. When set to B<true>, the I<Network plugin> will make these
3223 statistics available. Defaults to B<false>.
3227 =head2 Plugin C<nginx>
3229 This plugin collects the number of connections and requests handled by the
3230 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
3231 queries the page provided by the C<ngx_http_stub_status_module> module, which
3232 isn't compiled by default. Please refer to
3233 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
3234 how to compile and configure nginx and this module.
3236 The following options are accepted by the C<nginx plugin>:
3240 =item B<URL> I<http://host/nginx_status>
3242 Sets the URL of the C<ngx_http_stub_status_module> output.
3244 =item B<User> I<Username>
3246 Optional user name needed for authentication.
3248 =item B<Password> I<Password>
3250 Optional password needed for authentication.
3252 =item B<VerifyPeer> B<true|false>
3254 Enable or disable peer SSL certificate verification. See
3255 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
3257 =item B<VerifyHost> B<true|false>
3259 Enable or disable peer host name verification. If enabled, the plugin checks
3260 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
3261 certificate matches the host name provided by the B<URL> option. If this
3262 identity check fails, the connection is aborted. Obviously, only works when
3263 connecting to a SSL enabled server. Enabled by default.
3265 =item B<CACert> I<File>
3267 File that holds one or more SSL certificates. If you want to use HTTPS you will
3268 possibly need this option. What CA certificates come bundled with C<libcurl>
3269 and are checked by default depends on the distribution you use.
3273 =head2 Plugin C<notify_desktop>
3275 This plugin sends a desktop notification to a notification daemon, as defined
3276 in the Desktop Notification Specification. To actually display the
3277 notifications, B<notification-daemon> is required and B<collectd> has to be
3278 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
3279 environment variables have to be set correctly) and the D-Bus message bus.
3281 The Desktop Notification Specification can be found at
3282 L<http://www.galago-project.org/specs/notification/>.
3286 =item B<OkayTimeout> I<timeout>
3288 =item B<WarningTimeout> I<timeout>
3290 =item B<FailureTimeout> I<timeout>
3292 Set the I<timeout>, in milliseconds, after which to expire the notification
3293 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
3294 been specified, the displayed notification will not be closed at all - the
3295 user has to do so herself. These options default to 5000. If a negative number
3296 has been specified, the default is used as well.
3300 =head2 Plugin C<notify_email>
3302 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
3303 configured email address.
3305 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
3307 Available configuration options:
3311 =item B<From> I<Address>
3313 Email address from which the emails should appear to come from.
3315 Default: C<root@localhost>
3317 =item B<Recipient> I<Address>
3319 Configures the email address(es) to which the notifications should be mailed.
3320 May be repeated to send notifications to multiple addresses.
3322 At least one B<Recipient> must be present for the plugin to work correctly.
3324 =item B<SMTPServer> I<Hostname>
3326 Hostname of the SMTP server to connect to.
3328 Default: C<localhost>
3330 =item B<SMTPPort> I<Port>
3332 TCP port to connect to.
3336 =item B<SMTPUser> I<Username>
3338 Username for ASMTP authentication. Optional.
3340 =item B<SMTPPassword> I<Password>
3342 Password for ASMTP authentication. Optional.
3344 =item B<Subject> I<Subject>
3346 Subject-template to use when sending emails. There must be exactly two
3347 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
3348 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
3351 Default: C<Collectd notify: %s@%s>
3355 =head2 Plugin C<ntpd>
3359 =item B<Host> I<Hostname>
3361 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
3363 =item B<Port> I<Port>
3365 UDP-Port to connect to. Defaults to B<123>.
3367 =item B<ReverseLookups> B<true>|B<false>
3369 Sets whether or not to perform reverse lookups on peers. Since the name or
3370 IP-address may be used in a filename it is recommended to disable reverse
3371 lookups. The default is to do reverse lookups to preserve backwards
3372 compatibility, though.
3374 =item B<IncludeUnitID> B<true>|B<false>
3376 When a peer is a refclock, include the unit ID in the I<type instance>.
3377 Defaults to B<false> for backward compatibility.
3379 If two refclock peers use the same driver and this is B<false>, the plugin will
3380 try to write simultaneous measurements from both to the same type instance.
3381 This will result in error messages in the log and only one set of measurements
3386 =head2 Plugin C<nut>
3390 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
3392 Add a UPS to collect data from. The format is identical to the one accepted by
3397 =head2 Plugin C<olsrd>
3399 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
3400 the Optimized Link State Routing daemon and reads information about the current
3401 state of the meshed network.
3403 The following configuration options are understood:
3407 =item B<Host> I<Host>
3409 Connect to I<Host>. Defaults to B<"localhost">.
3411 =item B<Port> I<Port>
3413 Specifies the port to connect to. This must be a string, even if you give the
3414 port as a number rather than a service name. Defaults to B<"2006">.
3416 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
3418 Specifies what information to collect about links, i.E<nbsp>e. direct
3419 connections of the daemon queried. If set to B<No>, no information is
3420 collected. If set to B<Summary>, the number of links and the average of all
3421 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
3422 If set to B<Detail> LQ and NLQ are collected per link.
3424 Defaults to B<Detail>.
3426 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
3428 Specifies what information to collect about routes of the daemon queried. If
3429 set to B<No>, no information is collected. If set to B<Summary>, the number of
3430 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
3431 metric and ETX are collected per route.
3433 Defaults to B<Summary>.
3435 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
3437 Specifies what information to collect about the global topology. If set to
3438 B<No>, no information is collected. If set to B<Summary>, the number of links
3439 in the entire topology and the average I<link quality> (LQ) is calculated.
3440 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
3442 Defaults to B<Summary>.
3446 =head2 Plugin C<onewire>
3448 B<EXPERIMENTAL!> See notes below.
3450 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
3451 L<http://owfs.org/> to read sensors connected via the onewire bus.
3453 Currently only temperature sensors (sensors with the family code C<10>,
3454 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
3455 would like to have included, please send a sort request to the mailing list.
3457 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
3458 experimental, below.
3462 =item B<Device> I<Device>
3464 Sets the device to read the values from. This can either be a "real" hardware
3465 device, such as a serial port or an USB port, or the address of the
3466 L<owserver(1)> socket, usually B<localhost:4304>.
3468 Though the documentation claims to automatically recognize the given address
3469 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
3470 with that version, the following configuration worked for us:
3473 Device "-s localhost:4304"
3476 This directive is B<required> and does not have a default value.
3478 =item B<Sensor> I<Sensor>
3480 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
3481 below. Sensors are specified without the family byte at the beginning, to you'd
3482 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
3485 =item B<IgnoreSelected> I<true>|I<false>
3487 If no configuration if given, the B<onewire> plugin will collect data from all
3488 sensors found. This may not be practical, especially if sensors are added and
3489 removed regularly. Sometimes, however, it's easier/preferred to collect only
3490 specific sensors or all sensors I<except> a few specified ones. This option
3491 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
3492 B<Sensor> is inverted: All selected interfaces are ignored and all other
3493 interfaces are collected.
3495 =item B<Interval> I<Seconds>
3497 Sets the interval in which all sensors should be read. If not specified, the
3498 global B<Interval> setting is used.
3502 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
3503 work with big setups. It works with one sensor being attached to one
3504 controller, but as soon as you throw in a couple more senors and maybe a hub
3505 or two, reading all values will take more than ten seconds (the default
3506 interval). We will probably add some separate thread for reading the sensors
3507 and some cache or something like that, but it's not done yet. We will try to
3508 maintain backwards compatibility in the future, but we can't promise. So in
3509 short: If it works for you: Great! But keep in mind that the config I<might>
3510 change, though this is unlikely. Oh, and if you want to help improving this
3511 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
3513 =head2 Plugin C<openvpn>
3515 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
3516 traffic statistics about connected clients.
3518 To set up OpenVPN to write to the status file periodically, use the
3519 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
3520 you need to set the required format, too. This is done by setting
3521 B<--status-version> to B<2>.
3523 So, in a nutshell you need:
3525 openvpn $OTHER_OPTIONS \
3526 --status "/var/run/openvpn-status" 10 \
3533 =item B<StatusFile> I<File>
3535 Specifies the location of the status file.
3537 =item B<ImprovedNamingSchema> B<true>|B<false>
3539 When enabled, the filename of the status file will be used as plugin instance
3540 and the client's "common name" will be used as type instance. This is required
3541 when reading multiple status files. Enabling this option is recommended, but to
3542 maintain backwards compatibility this option is disabled by default.
3544 =item B<CollectCompression> B<true>|B<false>
3546 Sets whether or not statistics about the compression used by OpenVPN should be
3547 collected. This information is only available in I<single> mode. Enabled by
3550 =item B<CollectIndividualUsers> B<true>|B<false>
3552 Sets whether or not traffic information is collected for each connected client
3553 individually. If set to false, currently no traffic data is collected at all
3554 because aggregating this data in a save manner is tricky. Defaults to B<true>.
3556 =item B<CollectUserCount> B<true>|B<false>
3558 When enabled, the number of currently connected clients or users is collected.
3559 This is especially interesting when B<CollectIndividualUsers> is disabled, but
3560 can be configured independently from that option. Defaults to B<false>.
3564 =head2 Plugin C<oracle>
3566 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
3567 Oracle® Database and lets you execute SQL statements there. It is very similar
3568 to the "dbi" plugin, because it was written around the same time. See the "dbi"
3569 plugin's documentation above for details.
3572 <Query "out_of_stock">
3573 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
3576 # InstancePrefix "foo"
3577 InstancesFrom "category"
3581 <Database "product_information">
3585 Query "out_of_stock"
3589 =head3 B<Query> blocks
3591 The Query blocks are handled identically to the Query blocks of the "dbi"
3592 plugin. Please see its documentation above for details on how to specify
3595 =head3 B<Database> blocks
3597 Database blocks define a connection to a database and which queries should be
3598 sent to that database. Each database needs a "name" as string argument in the
3599 starting tag of the block. This name will be used as "PluginInstance" in the
3600 values submitted to the daemon. Other than that, that name is not used.
3604 =item B<ConnectID> I<ID>
3606 Defines the "database alias" or "service name" to connect to. Usually, these
3607 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
3609 =item B<Host> I<Host>
3611 Hostname to use when dispatching values for this database. Defaults to using
3612 the global hostname of the I<collectd> instance.
3614 =item B<Username> I<Username>
3616 Username used for authentication.
3618 =item B<Password> I<Password>
3620 Password used for authentication.
3622 =item B<Query> I<QueryName>
3624 Associates the query named I<QueryName> with this database connection. The
3625 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
3626 blocks you want to refer to must be placed above the database block you want to
3631 =head2 Plugin C<perl>
3633 This plugin embeds a Perl-interpreter into collectd and provides an interface
3634 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
3636 =head2 Plugin C<pinba>
3638 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
3639 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
3640 PHP-based webpage has been delivered, the extension will send a UDP packet
3641 containing timing information, peak memory usage and so on. The plugin will
3642 wait for such packets, parse them and account the provided information, which
3643 is then dispatched to the daemon once per interval.
3650 # Overall statistics for the website.
3652 Server "www.example.com"
3654 # Statistics for www-a only
3656 Host "www-a.example.com"
3657 Server "www.example.com"
3659 # Statistics for www-b only
3661 Host "www-b.example.com"
3662 Server "www.example.com"
3666 The plugin provides the following configuration options:
3670 =item B<Address> I<Node>
3672 Configures the address used to open a listening socket. By default, plugin will
3673 bind to the I<any> address C<::0>.
3675 =item B<Port> I<Service>
3677 Configures the port (service) to bind to. By default the default Pinba port
3678 "30002" will be used. The option accepts service names in addition to port
3679 numbers and thus requires a I<string> argument.
3681 =item E<lt>B<View> I<Name>E<gt> block
3683 The packets sent by the Pinba extension include the hostname of the server, the
3684 server name (the name of the virtual host) and the script that was executed.
3685 Using B<View> blocks it is possible to separate the data into multiple groups
3686 to get more meaningful statistics. Each packet is added to all matching groups,
3687 so that a packet may be accounted for more than once.
3691 =item B<Host> I<Host>
3693 Matches the hostname of the system the webserver / script is running on. This
3694 will contain the result of the L<gethostname(2)> system call. If not
3695 configured, all hostnames will be accepted.
3697 =item B<Server> I<Server>
3699 Matches the name of the I<virtual host>, i.e. the contents of the
3700 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
3701 server names will be accepted.
3703 =item B<Script> I<Script>
3705 Matches the name of the I<script name>, i.e. the contents of the
3706 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
3707 script names will be accepted.
3713 =head2 Plugin C<ping>
3715 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
3716 configured hosts periodically and measures the network latency. Whenever the
3717 C<read> function of the plugin is called, it submits the average latency, the
3718 standard deviation and the drop rate for each host.
3720 Available configuration options:
3724 =item B<Host> I<IP-address>
3726 Host to ping periodically. This option may be repeated several times to ping
3729 =item B<Interval> I<Seconds>
3731 Sets the interval in which to send ICMP echo packets to the configured hosts.
3732 This is B<not> the interval in which statistics are queries from the plugin but
3733 the interval in which the hosts are "pinged". Therefore, the setting here
3734 should be smaller than or equal to the global B<Interval> setting. Fractional
3735 times, such as "1.24" are allowed.
3739 =item B<Timeout> I<Seconds>
3741 Time to wait for a response from the host to which an ICMP packet had been
3742 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
3743 to be down or the packet to be dropped. This setting must be smaller than the
3744 B<Interval> setting above for the plugin to work correctly. Fractional
3745 arguments are accepted.
3749 =item B<TTL> I<0-255>
3751 Sets the Time-To-Live of generated ICMP packets.
3753 =item B<SourceAddress> I<host>
3755 Sets the source address to use. I<host> may either be a numerical network
3756 address or a network hostname.
3758 =item B<Device> I<name>
3760 Sets the outgoing network device to be used. I<name> has to specify an
3761 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
3764 =item B<MaxMissed> I<Packets>
3766 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
3767 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
3769 Default: B<-1> (disabled)
3773 =head2 Plugin C<postgresql>
3775 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
3776 keeps a persistent connection to all configured databases and tries to
3777 reconnect if the connection has been interrupted. A database is configured by
3778 specifying a B<Database> block as described below. The default statistics are
3779 collected from PostgreSQL's B<statistics collector> which thus has to be
3780 enabled for this plugin to work correctly. This should usually be the case by
3781 default. See the section "The Statistics Collector" of the B<PostgreSQL
3782 Documentation> for details.
3784 By specifying custom database queries using a B<Query> block as described
3785 below, you may collect any data that is available from some PostgreSQL
3786 database. This way, you are able to access statistics of external daemons
3787 which are available in a PostgreSQL database or use future or special
3788 statistics provided by PostgreSQL without the need to upgrade your collectd
3791 Starting with version 5.2, the C<postgresql> plugin supports writing data to
3792 PostgreSQL databases as well. This has been implemented in a generic way. You
3793 need to specify an SQL statement which will then be executed by collectd in
3794 order to write the data (see below for details). The benefit of that approach
3795 is that there is no fixed database layout. Rather, the layout may be optimized
3796 for the current setup.
3798 The B<PostgreSQL Documentation> manual can be found at
3799 L<http://www.postgresql.org/docs/manuals/>.
3803 Statement "SELECT magic FROM wizard WHERE host = $1;"
3807 InstancePrefix "magic"
3812 <Query rt36_tickets>
3813 Statement "SELECT COUNT(type) AS count, type \
3815 WHEN resolved = 'epoch' THEN 'open' \
3816 ELSE 'resolved' END AS type \
3817 FROM tickets) type \
3821 InstancePrefix "rt36_tickets"
3822 InstancesFrom "type"
3828 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
3838 KRBSrvName "kerberos_service_name"
3844 Service "service_name"
3845 Query backend # predefined
3856 The B<Query> block defines one database query which may later be used by a
3857 database definition. It accepts a single mandatory argument which specifies
3858 the name of the query. The names of all queries have to be unique (see the
3859 B<MinVersion> and B<MaxVersion> options below for an exception to this
3860 rule). The following configuration options are available to define the query:
3862 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
3863 blocks define how to handle the values returned from the query. They define
3864 which column holds which value and how to dispatch that value to the daemon.
3865 Multiple B<Result> blocks may be used to extract multiple values from a single
3870 =item B<Statement> I<sql query statement>
3872 Specify the I<sql query statement> which the plugin should execute. The string
3873 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
3874 first, second, etc. parameter. The value of the parameters is specified by the
3875 B<Param> configuration option - see below for details. To include a literal
3876 B<$> character followed by a number, surround it with single quotes (B<'>).
3878 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
3879 allowed. Note, however, that only a single command may be used. Semicolons are
3880 allowed as long as a single non-empty command has been specified only.
3882 The returned lines will be handled separately one after another.
3884 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
3886 Specify the parameters which should be passed to the SQL query. The parameters
3887 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
3888 they appear in the configuration file. The value of the parameter is
3889 determined depending on the value of the B<Param> option as follows:
3895 The configured hostname of the database connection. If a UNIX domain socket is
3896 used, the parameter expands to "localhost".
3900 The name of the database of the current connection.
3904 The name of the database plugin instance. See the B<Instance> option of the
3905 database specification below for details.
3909 The username used to connect to the database.
3913 The interval with which this database is queried (as specified by the database
3914 specific or global B<Interval> options).
3918 Please note that parameters are only supported by PostgreSQL's protocol
3919 version 3 and above which was introduced in version 7.4 of PostgreSQL.
3921 =item B<Type> I<type>
3923 The I<type> name to be used when dispatching the values. The type describes
3924 how to handle the data and where to store it. See L<types.db(5)> for more
3925 details on types and their configuration. The number and type of values (as
3926 selected by the B<ValuesFrom> option) has to match the type of the given name.
3928 This option is required inside a B<Result> block.
3930 =item B<InstancePrefix> I<prefix>
3932 =item B<InstancesFrom> I<column0> [I<column1> ...]
3934 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
3935 B<InstancePrefix> defines a static prefix that will be prepended to all type
3936 instances. B<InstancesFrom> defines the column names whose values will be used
3937 to create the type instance. Multiple values will be joined together using the
3938 hyphen (C<->) as separation character.
3940 The plugin itself does not check whether or not all built instances are
3941 different. It is your responsibility to assure that each is unique.
3943 Both options are optional. If none is specified, the type instance will be
3946 =item B<ValuesFrom> I<column0> [I<column1> ...]
3948 Names the columns whose content is used as the actual data for the data sets
3949 that are dispatched to the daemon. How many such columns you need is
3950 determined by the B<Type> setting as explained above. If you specify too many
3951 or not enough columns, the plugin will complain about that and no data will be
3952 submitted to the daemon.
3954 The actual data type, as seen by PostgreSQL, is not that important as long as
3955 it represents numbers. The plugin will automatically cast the values to the
3956 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
3957 L<strtod(3)> functions, so anything supported by those functions is supported
3958 by the plugin as well.
3960 This option is required inside a B<Result> block and may be specified multiple
3961 times. If multiple B<ValuesFrom> options are specified, the columns are read
3964 =item B<MinVersion> I<version>
3966 =item B<MaxVersion> I<version>
3968 Specify the minimum or maximum version of PostgreSQL that this query should be
3969 used with. Some statistics might only be available with certain versions of
3970 PostgreSQL. This allows you to specify multiple queries with the same name but
3971 which apply to different versions, thus allowing you to use the same
3972 configuration in a heterogeneous environment.
3974 The I<version> has to be specified as the concatenation of the major, minor
3975 and patch-level versions, each represented as two-decimal-digit numbers. For
3976 example, version 8.2.3 will become 80203.
3980 The following predefined queries are available (the definitions can be found
3981 in the F<postgresql_default.conf> file which, by default, is available at
3982 C<I<prefix>/share/collectd/>):
3988 This query collects the number of backends, i.E<nbsp>e. the number of
3991 =item B<transactions>
3993 This query collects the numbers of committed and rolled-back transactions of
3998 This query collects the numbers of various table modifications (i.E<nbsp>e.
3999 insertions, updates, deletions) of the user tables.
4001 =item B<query_plans>
4003 This query collects the numbers of various table scans and returned tuples of
4006 =item B<table_states>
4008 This query collects the numbers of live and dead rows in the user tables.
4012 This query collects disk block access counts for user tables.
4016 This query collects the on-disk size of the database in bytes.
4020 In addition, the following detailed queries are available by default. Please
4021 note that each of those queries collects information B<by table>, thus,
4022 potentially producing B<a lot> of data. For details see the description of the
4023 non-by_table queries above.
4027 =item B<queries_by_table>
4029 =item B<query_plans_by_table>
4031 =item B<table_states_by_table>
4033 =item B<disk_io_by_table>
4037 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
4038 mandatory argument specifying the name of the writer. This will then be used
4039 in the B<Database> specification in order to activate the writer instance. The
4040 names of all writers have to be unique. The following options may be
4045 =item B<Statement> I<sql statement>
4047 This mandatory option specifies the SQL statement that will be executed for
4048 each submitted value. A single SQL statement is allowed only. Anything after
4049 the first semicolon will be ignored.
4051 Nine parameters will be passed to the statement and should be specified as
4052 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
4053 values are made available through those parameters:
4059 The timestamp of the queried value as a floating point number.
4063 The hostname of the queried value.
4067 The plugin name of the queried value.
4071 The plugin instance of the queried value. This value may be B<NULL> if there
4072 is no plugin instance.
4076 The type of the queried value (cf. L<types.db(5)>).
4080 The type instance of the queried value. This value may be B<NULL> if there is
4085 An array of names for the submitted values (i.E<nbsp>e., the name of the data
4086 sources of the submitted value-list).
4090 An array of types for the submitted values (i.E<nbsp>e., the type of the data
4091 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
4092 B<StoreRates> is enabled (which is the default, see below), all types will be
4097 An array of the submitted values. The dimensions of the value name and value
4102 In general, it is advisable to create and call a custom function in the
4103 PostgreSQL database for this purpose. Any procedural language supported by
4104 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
4107 =item B<StoreRates> B<false>|B<true>
4109 If set to B<true> (the default), convert counter values to rates. If set to
4110 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
4115 The B<Database> block defines one PostgreSQL database for which to collect
4116 statistics. It accepts a single mandatory argument which specifies the
4117 database name. None of the other options are required. PostgreSQL will use
4118 default values as documented in the section "CONNECTING TO A DATABASE" in the
4119 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
4120 the user collectd is run as and special environment variables. See the manpage
4125 =item B<Interval> I<seconds>
4127 Specify the interval with which the database should be queried. The default is
4128 to use the global B<Interval> setting.
4130 =item B<CommitInterval> I<seconds>
4132 This option may be used for database connections which have "writers" assigned
4133 (see above). If specified, it causes a writer to put several updates into a
4134 single transaction. This transaction will last for the specified amount of
4135 time. By default, each update will be executed in a separate transaction. Each
4136 transaction generates a fair amount of overhead which can, thus, be reduced by
4137 activating this option. The draw-back is, that data covering the specified
4138 amount of time will be lost, for example, if a single statement within the
4139 transaction fails or if the database server crashes.
4141 =item B<Host> I<hostname>
4143 Specify the hostname or IP of the PostgreSQL server to connect to. If the
4144 value begins with a slash, it is interpreted as the directory name in which to
4145 look for the UNIX domain socket.
4147 This option is also used to determine the hostname that is associated with a
4148 collected data set. If it has been omitted or either begins with with a slash
4149 or equals B<localhost> it will be replaced with the global hostname definition
4150 of collectd. Any other value will be passed literally to collectd when
4151 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
4153 =item B<Port> I<port>
4155 Specify the TCP port or the local UNIX domain socket file extension of the
4158 =item B<User> I<username>
4160 Specify the username to be used when connecting to the server.
4162 =item B<Password> I<password>
4164 Specify the password to be used when connecting to the server.
4166 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
4168 Specify whether to use an SSL connection when contacting the server. The
4169 following modes are supported:
4171 =item B<Instance> I<name>
4173 Specify the plugin instance name that should be used instead of the database
4174 name (which is the default, if this option has not been specified). This
4175 allows to query multiple databases of the same name on the same host (e.g.
4176 when running multiple database server versions in parallel).
4182 Do not use SSL at all.
4186 First, try to connect without using SSL. If that fails, try using SSL.
4188 =item I<prefer> (default)
4190 First, try to connect using SSL. If that fails, try without using SSL.
4198 =item B<KRBSrvName> I<kerberos_service_name>
4200 Specify the Kerberos service name to use when authenticating with Kerberos 5
4201 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
4202 B<PostgreSQL Documentation> for details.
4204 =item B<Service> I<service_name>
4206 Specify the PostgreSQL service name to use for additional parameters. That
4207 service has to be defined in F<pg_service.conf> and holds additional
4208 connection parameters. See the section "The Connection Service File" in the
4209 B<PostgreSQL Documentation> for details.
4211 =item B<Query> I<query>
4213 Specifies a I<query> which should be executed in the context of the database
4214 connection. This may be any of the predefined or user-defined queries. If no
4215 such option is given, it defaults to "backends", "transactions", "queries",
4216 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
4217 has been specified). Else, the specified queries are used only.
4219 =item B<Writer> I<writer>
4221 Assigns the specified I<writer> backend to the database connection. This
4222 causes all collected data to be send to the database using the settings
4223 defined in the writer configuration (see the section "FILTER CONFIGURATION"
4224 below for details on how to selectively send data to certain plugins).
4226 Each writer will register a flush callback which may be used when having long
4227 transactions enabled (see the B<CommitInterval> option above). When issuing
4228 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
4229 transaction will be committed right away. Two different kinds of flush
4230 callbacks are available with the C<postgresql> plugin:
4236 Flush all writer backends.
4238 =item B<postgresql->I<database>
4240 Flush all writers of the specified I<database> only.
4246 =head2 Plugin C<powerdns>
4248 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
4249 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
4250 values, many of which are probably meaningless to most users, but may be useful
4251 for some. So you may chose which values to collect, but if you don't, some
4252 reasonable defaults will be collected.
4255 <Server "server_name">
4257 Collect "udp-answers" "udp-queries"
4258 Socket "/var/run/pdns.controlsocket"
4260 <Recursor "recursor_name">
4262 Collect "cache-hits" "cache-misses"
4263 Socket "/var/run/pdns_recursor.controlsocket"
4265 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
4270 =item B<Server> and B<Recursor> block
4272 The B<Server> block defines one authoritative server to query, the B<Recursor>
4273 does the same for an recursing server. The possible options in both blocks are
4274 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
4279 =item B<Collect> I<Field>
4281 Using the B<Collect> statement you can select which values to collect. Here,
4282 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
4283 C<dlg-only-drops>, C<answers10-100>.
4285 The method of getting the values differs for B<Server> and B<Recursor> blocks:
4286 When querying the server a C<SHOW *> command is issued in any case, because
4287 that's the only way of getting multiple values out of the server at once.
4288 collectd then picks out the values you have selected. When querying the
4289 recursor, a command is generated to query exactly these values. So if you
4290 specify invalid fields when querying the recursor, a syntax error may be
4291 returned by the daemon and collectd may not collect any values at all.
4293 If no B<Collect> statement is given, the following B<Server> values will be
4300 =item packetcache-hit
4302 =item packetcache-miss
4304 =item packetcache-size
4306 =item query-cache-hit
4308 =item query-cache-miss
4310 =item recursing-answers
4312 =item recursing-questions
4324 The following B<Recursor> values will be collected by default:
4328 =item noerror-answers
4330 =item nxdomain-answers
4332 =item servfail-answers
4350 Please note that up to that point collectd doesn't know what values are
4351 available on the server and values that are added do not need a change of the
4352 mechanism so far. However, the values must be mapped to collectd's naming
4353 scheme, which is done using a lookup table that lists all known values. If
4354 values are added in the future and collectd does not know about them, you will
4355 get an error much like this:
4357 powerdns plugin: submit: Not found in lookup table: foobar = 42
4359 In this case please file a bug report with the collectd team.
4361 =item B<Socket> I<Path>
4363 Configures the path to the UNIX domain socket to be used when connecting to the
4364 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
4365 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
4366 will be used for the recursor.
4370 =item B<LocalSocket> I<Path>
4372 Querying the recursor is done using UDP. When using UDP over UNIX domain
4373 sockets, the client socket needs a name in the file system, too. You can set
4374 this local name to I<Path> using the B<LocalSocket> option. The default is
4375 C<I<prefix>/var/run/collectd-powerdns>.
4379 =head2 Plugin C<processes>
4383 =item B<Process> I<Name>
4385 Select more detailed statistics of processes matching this name. The statistics
4386 collected for these selected processes are size of the resident segment size
4387 (RSS), user- and system-time used, number of processes and number of threads,
4388 io data (where available) and minor and major pagefaults.
4390 =item B<ProcessMatch> I<name> I<regex>
4392 Similar to the B<Process> option this allows to select more detailed
4393 statistics of processes matching the specified I<regex> (see L<regex(7)> for
4394 details). The statistics of all matching processes are summed up and
4395 dispatched to the daemon using the specified I<name> as an identifier. This
4396 allows to "group" several processes together. I<name> must not contain
4401 =head2 Plugin C<protocols>
4403 Collects a lot of information about various network protocols, such as I<IP>,
4404 I<TCP>, I<UDP>, etc.
4406 Available configuration options:
4410 =item B<Value> I<Selector>
4412 Selects whether or not to select a specific value. The string being matched is
4413 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
4414 plugin instance and I<ValueName> will be used as type instance. An example of
4415 the string being used would be C<Tcp:RetransSegs>.
4417 You can use regular expressions to match a large number of values with just one
4418 configuration option. To select all "extended" I<TCP> values, you could use the
4419 following statement:
4423 Whether only matched values are selected or all matched values are ignored
4424 depends on the B<IgnoreSelected>. By default, only matched values are selected.
4425 If no value is configured at all, all values will be selected.
4427 =item B<IgnoreSelected> B<true>|B<false>
4429 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
4430 matching values will be ignored.
4434 =head2 Plugin C<python>
4436 This plugin embeds a Python-interpreter into collectd and provides an interface
4437 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
4439 =head2 Plugin C<routeros>
4441 The C<routeros> plugin connects to a device running I<RouterOS>, the
4442 Linux-based operating system for routers by I<MikroTik>. The plugin uses
4443 I<librouteros> to connect and reads information about the interfaces and
4444 wireless connections of the device. The configuration supports querying
4449 Host "router0.example.com"
4452 CollectInterface true
4457 Host "router1.example.com"
4460 CollectInterface true
4461 CollectRegistrationTable true
4467 As you can see above, the configuration of the I<routeros> plugin consists of
4468 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
4469 options are understood:
4473 =item B<Host> I<Host>
4475 Hostname or IP-address of the router to connect to.
4477 =item B<Port> I<Port>
4479 Port name or port number used when connecting. If left unspecified, the default
4480 will be chosen by I<librouteros>, currently "8728". This option expects a
4481 string argument, even when a numeric port number is given.
4483 =item B<User> I<User>
4485 Use the user name I<User> to authenticate. Defaults to "admin".
4487 =item B<Password> I<Password>
4489 Set the password used to authenticate.
4491 =item B<CollectInterface> B<true>|B<false>
4493 When set to B<true>, interface statistics will be collected for all interfaces
4494 present on the device. Defaults to B<false>.
4496 =item B<CollectRegistrationTable> B<true>|B<false>
4498 When set to B<true>, information about wireless LAN connections will be
4499 collected. Defaults to B<false>.
4501 =item B<CollectCPULoad> B<true>|B<false>
4503 When set to B<true>, information about the CPU usage will be collected. The
4504 number is a dimensionless value where zero indicates no CPU usage at all.
4505 Defaults to B<false>.
4507 =item B<CollectMemory> B<true>|B<false>
4509 When enabled, the amount of used and free memory will be collected. How used
4510 memory is calculated is unknown, for example whether or not caches are counted
4512 Defaults to B<false>.
4514 =item B<CollectDF> B<true>|B<false>
4516 When enabled, the amount of used and free disk space will be collected.
4517 Defaults to B<false>.
4519 =item B<CollectDisk> B<true>|B<false>
4521 When enabled, the number of sectors written and bad blocks will be collected.
4522 Defaults to B<false>.
4526 =head2 Plugin C<redis>
4528 The I<Redis plugin> connects to one or more Redis servers and gathers
4529 information about each server's state. For each server there is a I<Node> block
4530 which configures the connection parameters for this node.
4540 The information shown in the synopsis above is the I<default configuration>
4541 which is used by the plugin if no configuration is present.
4545 =item B<Node> I<Nodename>
4547 The B<Node> block identifies a new Redis node, that is a new Redis instance
4548 running in an specified host and port. The name for node is a canonical
4549 identifier which is used as I<plugin instance>. It is limited to
4550 64E<nbsp>characters in length.
4552 =item B<Host> I<Hostname>
4554 The B<Host> option is the hostname or IP-address where the Redis instance is
4557 =item B<Port> I<Port>
4559 The B<Port> option is the TCP port on which the Redis instance accepts
4560 connections. Either a service name of a port number may be given. Please note
4561 that numerical port numbers must be given as a string, too.
4563 =item B<Password> I<Password>
4565 Use I<Password> to authenticate when connecting to I<Redis>.
4567 =item B<Timeout> I<Timeout in miliseconds>
4569 The B<Timeout> option set the socket timeout for node response. Since the Redis
4570 read function is blocking, you should keep this value as low as possible. Keep
4571 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
4572 than B<Interval> defined globally.
4576 =head2 Plugin C<rrdcached>
4578 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
4579 to store values to RRD files in an efficient manner. The combination of the
4580 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
4581 way the C<rrdtool> plugin works (see below). The added abstraction layer
4582 provides a number of benefits, though: Because the cache is not within
4583 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
4584 restarted. This results in much shorter (if any) gaps in graphs, especially
4585 under heavy load. Also, the C<rrdtool> command line utility is aware of the
4586 daemon so that it can flush values to disk automatically when needed. This
4587 allows to integrate automated flushing of values into graphing solutions much
4590 There are disadvantages, though: The daemon may reside on a different host, so
4591 it may not be possible for C<collectd> to create the appropriate RRD files
4592 anymore. And even if C<rrdcached> runs on the same host, it may run in a
4593 different base directory, so relative paths may do weird stuff if you're not
4596 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
4597 on the same host, communicating via a UNIX domain socket. The B<DataDir>
4598 setting should be set to an absolute path, so that a changed base directory
4599 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
4603 =item B<DaemonAddress> I<Address>
4605 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
4606 library. See L<rrdcached(1)> for details. Example:
4608 <Plugin "rrdcached">
4609 DaemonAddress "unix:/var/run/rrdcached.sock"
4612 =item B<DataDir> I<Directory>
4614 Set the base directory in which the RRD files reside. If this is a relative
4615 path, it is relative to the working base directory of the C<rrdcached> daemon!
4616 Use of an absolute path is recommended.
4618 =item B<CreateFiles> B<true>|B<false>
4620 Enables or disables the creation of RRD files. If the daemon is not running
4621 locally, or B<DataDir> is set to a relative path, this will not work as
4622 expected. Default is B<true>.
4624 =item B<StepSize> I<Seconds>
4626 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
4627 this setting is unset and the stepsize is set to the interval in which the data
4628 is collected. Do not use this option unless you absolutely have to for some
4629 reason. Setting this option may cause problems with the C<snmp plugin>, the
4630 C<exec plugin> or when the daemon is set up to receive data from other hosts.
4632 =item B<HeartBeat> I<Seconds>
4634 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
4635 in which case the heartbeat is set to twice the B<StepSize> which should equal
4636 the interval in which data is collected. Do not set this option unless you have
4637 a very good reason to do so.
4639 =item B<RRARows> I<NumRows>
4641 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
4642 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
4643 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
4644 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
4645 week, one month, and one year.
4647 So for each timespan, it calculates how many PDPs need to be consolidated into
4648 one CDP by calculating:
4649 number of PDPs = timespan / (stepsize * rrarows)
4651 Bottom line is, set this no smaller than the width of you graphs in pixels. The
4654 =item B<RRATimespan> I<Seconds>
4656 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
4657 more then one RRA. If this option is never used, the built-in default of (3600,
4658 86400, 604800, 2678400, 31622400) is used.
4660 For more information on how RRA-sizes are calculated see B<RRARows> above.
4662 =item B<XFF> I<Factor>
4664 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
4665 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
4670 =head2 Plugin C<rrdtool>
4672 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
4673 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
4674 using these settings. If you don't want to dive into the depths of RRDtool, you
4675 can safely ignore these settings.
4679 =item B<DataDir> I<Directory>
4681 Set the directory to store RRD-files under. Per default RRD-files are generated
4682 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
4684 =item B<StepSize> I<Seconds>
4686 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
4687 this setting is unset and the stepsize is set to the interval in which the data
4688 is collected. Do not use this option unless you absolutely have to for some
4689 reason. Setting this option may cause problems with the C<snmp plugin>, the
4690 C<exec plugin> or when the daemon is set up to receive data from other hosts.
4692 =item B<HeartBeat> I<Seconds>
4694 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
4695 in which case the heartbeat is set to twice the B<StepSize> which should equal
4696 the interval in which data is collected. Do not set this option unless you have
4697 a very good reason to do so.
4699 =item B<RRARows> I<NumRows>
4701 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
4702 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
4703 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
4704 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
4705 week, one month, and one year.
4707 So for each timespan, it calculates how many PDPs need to be consolidated into
4708 one CDP by calculating:
4709 number of PDPs = timespan / (stepsize * rrarows)
4711 Bottom line is, set this no smaller than the width of you graphs in pixels. The
4714 =item B<RRATimespan> I<Seconds>
4716 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
4717 more then one RRA. If this option is never used, the built-in default of (3600,
4718 86400, 604800, 2678400, 31622400) is used.
4720 For more information on how RRA-sizes are calculated see B<RRARows> above.
4722 =item B<XFF> I<Factor>
4724 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
4725 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
4728 =item B<CacheFlush> I<Seconds>
4730 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
4731 it writes all values for a certain RRD-file if the oldest value is older than
4732 (or equal to) the number of seconds specified. If some RRD-file is not updated
4733 anymore for some reason (the computer was shut down, the network is broken,
4734 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
4735 entire cache is searched for entries older than B<CacheTimeout> seconds and
4736 written to disk every I<Seconds> seconds. Since this is kind of expensive and
4737 does nothing under normal circumstances, this value should not be too small.
4738 900 seconds might be a good value, though setting this to 7200 seconds doesn't
4739 normally do much harm either.
4741 =item B<CacheTimeout> I<Seconds>
4743 If this option is set to a value greater than zero, the C<rrdtool plugin> will
4744 save values in a cache, as described above. Writing multiple values at once
4745 reduces IO-operations and thus lessens the load produced by updating the files.
4746 The trade off is that the graphs kind of "drag behind" and that more memory is
4749 =item B<WritesPerSecond> I<Updates>
4751 When collecting many statistics with collectd and the C<rrdtool> plugin, you
4752 will run serious performance problems. The B<CacheFlush> setting and the
4753 internal update queue assert that collectd continues to work just fine even
4754 under heavy load, but the system may become very unresponsive and slow. This is
4755 a problem especially if you create graphs from the RRD files on the same
4756 machine, for example using the C<graph.cgi> script included in the
4757 C<contrib/collection3/> directory.
4759 This setting is designed for very large setups. Setting this option to a value
4760 between 25 and 80 updates per second, depending on your hardware, will leave
4761 the server responsive enough to draw graphs even while all the cached values
4762 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
4763 by the B<FLUSH> command, are B<not> effected by this limit. They are still
4764 written as fast as possible, so that web frontends have up to date data when
4767 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
4768 updates per second, writing all values to disk will take approximately
4769 56E<nbsp>minutes. Together with the flushing ability that's integrated into
4770 "collection3" you'll end up with a responsive and fast system, up to date
4771 graphs and basically a "backup" of your values every hour.
4773 =item B<RandomTimeout> I<Seconds>
4775 When set, the actual timeout for each value is chosen randomly between
4776 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
4777 intention is to avoid high load situations that appear when many values timeout
4778 at the same time. This is especially a problem shortly after the daemon starts,
4779 because all values were added to the internal cache at roughly the same time.
4783 =head2 Plugin C<sensors>
4785 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
4786 that all the needed modules have to be loaded and lm_sensors has to be
4787 configured (most likely by editing F</etc/sensors.conf>. Read
4788 L<sensors.conf(5)> for details.
4790 The B<lm_sensors> homepage can be found at
4791 L<http://secure.netroedge.com/~lm78/>.
4795 =item B<SensorConfigFile> I<File>
4797 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
4798 the library's default will be used.
4800 =item B<Sensor> I<chip-bus-address/type-feature>
4802 Selects the name of the sensor which you want to collect or ignore, depending
4803 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
4804 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
4805 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
4807 =item B<IgnoreSelected> I<true>|I<false>
4809 If no configuration if given, the B<sensors>-plugin will collect data from all
4810 sensors. This may not be practical, especially for uninteresting sensors.
4811 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
4812 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
4813 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
4814 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
4815 and all other sensors are collected.
4819 =head2 Plugin C<snmp>
4821 Since the configuration of the C<snmp plugin> is a little more complicated than
4822 other plugins, its documentation has been moved to an own manpage,
4823 L<collectd-snmp(5)>. Please see there for details.
4825 =head2 Plugin C<swap>
4827 The I<Swap plugin> collects information about used and available swap space. On
4828 I<Linux> and I<Solaris>, the following options are available:
4832 =item B<ReportByDevice> B<false>|B<true>
4834 Configures how to report physical swap devices. If set to B<false> (the
4835 default), the summary over all swap devices is reported only, i.e. the globally
4836 used and available space over all devices. If B<true> is configured, the used
4837 and available space of each device will be reported separately.
4839 This option is only available if the I<Swap plugin> can read C</proc/swaps>
4840 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
4842 =item B<ReportBytes> B<false>|B<true>
4844 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
4845 I<swap I/O> is reported in pages. This option is available under Linux only.
4849 =head2 Plugin C<syslog>
4853 =item B<LogLevel> B<debug|info|notice|warning|err>
4855 Sets the log-level. If, for example, set to B<notice>, then all events with
4856 severity B<notice>, B<warning>, or B<err> will be submitted to the
4859 Please note that B<debug> is only available if collectd has been compiled with
4862 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
4864 Controls which notifications should be sent to syslog. The default behaviour is
4865 not to send any. Less severe notifications always imply logging more severe
4866 notifications: Setting this to B<OKAY> means all notifications will be sent to
4867 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
4868 notifications but will dismiss B<OKAY> notifications. Setting this option to
4869 B<FAILURE> will only send failures to syslog.
4873 =head2 Plugin C<table>
4875 The C<table plugin> provides generic means to parse tabular data and dispatch
4876 user specified values. Values are selected based on column numbers. For
4877 example, this plugin may be used to get values from the Linux L<proc(5)>
4878 filesystem or CSV (comma separated values) files.
4881 <Table "/proc/slabinfo">
4886 InstancePrefix "active_objs"
4892 InstancePrefix "objperslab"
4899 The configuration consists of one or more B<Table> blocks, each of which
4900 configures one file to parse. Within each B<Table> block, there are one or
4901 more B<Result> blocks, which configure which data to select and how to
4904 The following options are available inside a B<Table> block:
4908 =item B<Instance> I<instance>
4910 If specified, I<instance> is used as the plugin instance. So, in the above
4911 example, the plugin name C<table-slabinfo> would be used. If omitted, the
4912 filename of the table is used instead, with all special characters replaced
4913 with an underscore (C<_>).
4915 =item B<Separator> I<string>
4917 Any character of I<string> is interpreted as a delimiter between the different
4918 columns of the table. A sequence of two or more contiguous delimiters in the
4919 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
4920 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
4921 of a table - see its documentation for more details. This option is mandatory.
4923 A horizontal tab, newline and carriage return may be specified by C<\\t>,
4924 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
4925 required because of collectd's config parsing.
4929 The following options are available inside a B<Result> block:
4933 =item B<Type> I<type>
4935 Sets the type used to dispatch the values to the daemon. Detailed information
4936 about types and their configuration can be found in L<types.db(5)>. This
4937 option is mandatory.
4939 =item B<InstancePrefix> I<prefix>
4941 If specified, prepend I<prefix> to the type instance. If omitted, only the
4942 B<InstancesFrom> option is considered for the type instance.
4944 =item B<InstancesFrom> I<column0> [I<column1> ...]
4946 If specified, the content of the given columns (identified by the column
4947 number starting at zero) will be used to create the type instance for each
4948 row. Multiple values (and the instance prefix) will be joined together with
4949 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
4950 option is considered for the type instance.
4952 The plugin itself does not check whether or not all built instances are
4953 different. It’s your responsibility to assure that each is unique. This is
4954 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
4955 sure that the table only contains one row.
4957 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
4960 =item B<ValuesFrom> I<column0> [I<column1> ...]
4962 Specifies the columns (identified by the column numbers starting at zero)
4963 whose content is used as the actual data for the data sets that are dispatched
4964 to the daemon. How many such columns you need is determined by the B<Type>
4965 setting above. If you specify too many or not enough columns, the plugin will
4966 complain about that and no data will be submitted to the daemon. The plugin
4967 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
4968 respectively, so anything supported by those functions is supported by the
4969 plugin as well. This option is mandatory.
4973 =head2 Plugin C<tail>
4975 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
4976 each line and dispatches found values. What is matched can be configured by the
4977 user using (extended) regular expressions, as described in L<regex(7)>.
4980 <File "/var/log/exim4/mainlog">
4983 Regex "S=([1-9][0-9]*)"
4989 Regex "\\<R=local_user\\>"
4990 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
4993 Instance "local_user"
4998 The config consists of one or more B<File> blocks, each of which configures one
4999 logfile to parse. Within each B<File> block, there are one or more B<Match>
5000 blocks, which configure a regular expression to search for.
5002 The B<Instance> option in the B<File> block may be used to set the plugin
5003 instance. So in the above example the plugin name C<tail-foo> would be used.
5004 This plugin instance is for all B<Match> blocks that B<follow> it, until the
5005 next B<Instance> option. This way you can extract several plugin instances from
5006 one logfile, handy when parsing syslog and the like.
5008 Each B<Match> block has the following options to describe how the match should
5013 =item B<Regex> I<regex>
5015 Sets the regular expression to use for matching against a line. The first
5016 subexpression has to match something that can be turned into a number by
5017 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
5018 below. Because B<extended> regular expressions are used, you do not need to use
5019 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
5020 collectd's config parsing you need to escape backslashes, though. So if you
5021 want to match literal parentheses you need to do the following:
5023 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
5025 =item B<ExcludeRegex> I<regex>
5027 Sets an optional regular expression to use for excluding lines from the match.
5028 An example which excludes all connections from localhost from the match:
5030 ExcludeRegex "127\\.0\\.0\\.1"
5032 =item B<DSType> I<Type>
5034 Sets how the values are cumulated. I<Type> is one of:
5038 =item B<GaugeAverage>
5040 Calculate the average.
5044 Use the smallest number only.
5048 Use the greatest number only.
5052 Use the last number found.
5058 =item B<AbsoluteSet>
5060 The matched number is a counter. Simply I<sets> the internal counter to this
5061 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
5067 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
5068 matched number may be negative, which will effectively subtract from the
5075 Increase the internal counter by one. These B<DSType> are the only ones that do
5076 not use the matched subexpression, but simply count the number of matched
5077 lines. Thus, you may use a regular expression without submatch in this case.
5081 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
5082 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
5083 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
5084 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
5085 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
5088 =item B<Type> I<Type>
5090 Sets the type used to dispatch this value. Detailed information about types and
5091 their configuration can be found in L<types.db(5)>.
5093 =item B<Instance> I<TypeInstance>
5095 This optional setting sets the type instance to use.
5099 =head2 Plugin C<teamspeak2>
5101 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
5102 polls interesting global and virtual server data. The plugin can query only one
5103 physical server but unlimited virtual servers. You can use the following
5104 options to configure it:
5108 =item B<Host> I<hostname/ip>
5110 The hostname or ip which identifies the physical server.
5113 =item B<Port> I<port>
5115 The query port of the physical server. This needs to be a string.
5118 =item B<Server> I<port>
5120 This option has to be added once for every virtual server the plugin should
5121 query. If you want to query the virtual server on port 8767 this is what the
5122 option would look like:
5126 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
5127 use quotes around it! If no such statement is given only global information
5132 =head2 Plugin C<ted>
5134 The I<TED> plugin connects to a device of "The Energy Detective", a device to
5135 measure power consumption. These devices are usually connected to a serial
5136 (RS232) or USB port. The plugin opens a configured device and tries to read the
5137 current energy readings. For more information on TED, visit
5138 L<http://www.theenergydetective.com/>.
5140 Available configuration options:
5144 =item B<Device> I<Path>
5146 Path to the device on which TED is connected. collectd will need read and write
5147 permissions on that file.
5149 Default: B</dev/ttyUSB0>
5151 =item B<Retries> I<Num>
5153 Apparently reading from TED is not that reliable. You can therefore configure a
5154 number of retries here. You only configure the I<retries> here, to if you
5155 specify zero, one reading will be performed (but no retries if that fails); if
5156 you specify three, a maximum of four readings are performed. Negative values
5163 =head2 Plugin C<tcpconns>
5165 The C<tcpconns plugin> counts the number of currently established TCP
5166 connections based on the local port and/or the remote port. Since there may be
5167 a lot of connections the default if to count all connections with a local port,
5168 for which a listening socket is opened. You can use the following options to
5169 fine-tune the ports you are interested in:
5173 =item B<ListeningPorts> I<true>|I<false>
5175 If this option is set to I<true>, statistics for all local ports for which a
5176 listening socket exists are collected. The default depends on B<LocalPort> and
5177 B<RemotePort> (see below): If no port at all is specifically selected, the
5178 default is to collect listening ports. If specific ports (no matter if local or
5179 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
5180 the selected ports will be collected unless this option is set to I<true>
5183 =item B<LocalPort> I<Port>
5185 Count the connections to a specific local port. This can be used to see how
5186 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
5187 You have to specify the port in numeric form, so for the mailserver example
5188 you'd need to set B<25>.
5190 =item B<RemotePort> I<Port>
5192 Count the connections to a specific remote port. This is useful to see how
5193 much a remote service is used. This is most useful if you want to know how many
5194 connections a local service has opened to remote services, e.E<nbsp>g. how many
5195 connections a mail server or news server has to other mail or news servers, or
5196 how many connections a web proxy holds to web servers. You have to give the
5197 port in numeric form.
5201 =head2 Plugin C<thermal>
5205 =item B<ForceUseProcfs> I<true>|I<false>
5207 By default, the I<Thermal plugin> tries to read the statistics from the Linux
5208 C<sysfs> interface. If that is not available, the plugin falls back to the
5209 C<procfs> interface. By setting this option to I<true>, you can force the
5210 plugin to use the latter. This option defaults to I<false>.
5212 =item B<Device> I<Device>
5214 Selects the name of the thermal device that you want to collect or ignore,
5215 depending on the value of the B<IgnoreSelected> option. This option may be
5216 used multiple times to specify a list of devices.
5218 =item B<IgnoreSelected> I<true>|I<false>
5220 Invert the selection: If set to true, all devices B<except> the ones that
5221 match the device names specified by the B<Device> option are collected. By
5222 default only selected devices are collected if a selection is made. If no
5223 selection is configured at all, B<all> devices are selected.
5227 =head2 Plugin C<threshold>
5229 The I<Threshold plugin> checks values collected or received by I<collectd>
5230 against a configurable I<threshold> and issues I<notifications> if values are
5233 Documentation for this plugin is available in the L<collectd-threshold(5)>
5236 =head2 Plugin C<tokyotyrant>
5238 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
5239 couple metrics: number of records, and database size on disk.
5243 =item B<Host> I<Hostname/IP>
5245 The hostname or ip which identifies the server.
5246 Default: B<127.0.0.1>
5248 =item B<Port> I<Service/Port>
5250 The query port of the server. This needs to be a string, even if the port is
5251 given in its numeric form.
5256 =head2 Plugin C<unixsock>
5260 =item B<SocketFile> I<Path>
5262 Sets the socket-file which is to be created.
5264 =item B<SocketGroup> I<Group>
5266 If running as root change the group of the UNIX-socket after it has been
5267 created. Defaults to B<collectd>.
5269 =item B<SocketPerms> I<Permissions>
5271 Change the file permissions of the UNIX-socket after it has been created. The
5272 permissions must be given as a numeric, octal value as you would pass to
5273 L<chmod(1)>. Defaults to B<0770>.
5275 =item B<DeleteSocket> B<false>|B<true>
5277 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
5278 with the given name already exists. If I<collectd> crashes a socket file may be
5279 left over, preventing the daemon from opening a new socket when restarted.
5280 Since this is potentially dangerous, this defaults to B<false>.
5284 =head2 Plugin C<uuid>
5286 This plugin, if loaded, causes the Hostname to be taken from the machine's
5287 UUID. The UUID is a universally unique designation for the machine, usually
5288 taken from the machine's BIOS. This is most useful if the machine is running in
5289 a virtual environment such as Xen, in which case the UUID is preserved across
5290 shutdowns and migration.
5292 The following methods are used to find the machine's UUID, in order:
5298 Check I</etc/uuid> (or I<UUIDFile>).
5302 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
5307 Check for UUID from C<dmidecode> / SMBIOS.
5311 Check for UUID from Xen hypervisor.
5315 If no UUID can be found then the hostname is not modified.
5319 =item B<UUIDFile> I<Path>
5321 Take the UUID from the given file (default I</etc/uuid>).
5325 =head2 Plugin C<varnish>
5327 The Varnish plugin collects information about Varnish, an HTTP accelerator.
5331 =item B<CollectCache> B<true>|B<false>
5333 Cache hits and misses. True by default.
5335 =item B<CollectConnections> B<true>|B<false>
5337 Number of client connections received, accepted and dropped. True by default.
5339 =item B<CollectBackend> B<true>|B<false>
5341 Back-end connection statistics, such as successful, reused,
5342 and closed connections. True by default.
5344 =item B<CollectSHM> B<true>|B<false>
5346 Statistics about the shared memory log, a memory region to store
5347 log messages which is flushed to disk when full. True by default.
5349 =item B<CollectESI> B<true>|B<false>
5351 Edge Side Includes (ESI) parse statistics. False by default.
5353 =item B<CollectFetch> B<true>|B<false>
5355 Statistics about fetches (HTTP requests sent to the backend). False by default.
5357 =item B<CollectHCB> B<true>|B<false>
5359 Inserts and look-ups in the crit bit tree based hash. Look-ups are
5360 divided into locked and unlocked look-ups. False by default.
5362 =item B<CollectSMA> B<true>|B<false>
5364 malloc or umem (umem_alloc(3MALLOC) based) storage statistics.
5365 The umem storage component is Solaris specific. False by default.
5367 =item B<CollectSMS> B<true>|B<false>
5369 synth (synthetic content) storage statistics. This storage
5370 component is used internally only. False by default.
5372 =item B<CollectSM> B<true>|B<false>
5374 file (memory mapped file) storage statistics. False by default.
5376 =item B<CollectTotals> B<true>|B<false>
5378 Collects overview counters, such as the number of sessions created,
5379 the number of requests and bytes transferred. False by default.
5381 =item B<CollectWorkers> B<true>|B<false>
5383 Collect statistics about worker threads. False by default.
5387 =head2 Plugin C<vmem>
5389 The C<vmem> plugin collects information about the usage of virtual memory.
5390 Since the statistics provided by the Linux kernel are very detailed, they are
5391 collected very detailed. However, to get all the details, you have to switch
5392 them on manually. Most people just want an overview over, such as the number of
5393 pages read from swap space.
5397 =item B<Verbose> B<true>|B<false>
5399 Enables verbose collection of information. This will start collecting page
5400 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
5401 Part of these statistics are collected on a "per zone" basis.
5405 =head2 Plugin C<vserver>
5407 This plugin doesn't have any options. B<VServer> support is only available for
5408 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
5409 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
5410 need to apply the patches and compile your own kernel, which will then provide
5411 the F</proc/virtual> filesystem that is required by this plugin.
5413 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
5415 B<Note>: The traffic collected by this plugin accounts for the amount of
5416 traffic passing a socket which might be a lot less than the actual on-wire
5417 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
5418 collect on-wire traffic you could, for example, use the logging facilities of
5419 iptables to feed data for the guest IPs into the iptables plugin.
5421 =head2 Plugin C<write_graphite>
5423 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
5424 storage and graphing project. The plugin connects to I<Carbon>, the data layer
5425 of I<Graphite>, and sends data via the "line based" protocol (per default using
5426 portE<nbsp>2003). The data will be sent in blocks of at most 1428 bytes to
5427 minimize the number of network packets.
5431 <Plugin write_graphite>
5441 =item B<Host> I<Address>
5443 Hostname or address to connect to. Defaults to C<localhost>.
5445 =item B<Port> I<Service>
5447 Service name or port number to connect to. Defaults to C<2003>.
5449 =item B<Prefix> I<String>
5451 When set, I<String> is added in front of the host name. Dots and whitespace are
5452 I<not> escaped in this string (see B<EscapeCharacter> below).
5454 =item B<Postfix> I<String>
5456 When set, I<String> is appended to the host name. Dots and whitespace are
5457 I<not> escaped in this string (see B<EscapeCharacter> below).
5459 =item B<EscapeCharacter> I<Char>
5461 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
5462 in the identifier. The B<EscapeCharacter> option determines which character
5463 dots, whitespace and control characters are replaced with. Defaults to
5466 =item B<StoreRates> B<false>|B<true>
5468 If set to B<true> (the default), convert counter values to rates. If set to
5469 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
5472 =item B<SeparateInstances> B<false>|B<true>
5474 If set to B<true>, the plugin instance and type instance will be in their own
5475 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
5476 default), the plugin and plugin instance (and likewise the type and type
5477 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
5479 =item B<AlwaysAppendDS> B<false>|B<true>
5481 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
5482 identifier. If set to B<false> (the default), this is only done when there is
5487 =head2 Plugin C<write_mongodb>
5489 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
5494 <Plugin "write_mongodb">
5503 The plugin can send values to multiple instances of I<MongoDB> by specifying
5504 one B<Node> block for each instance. Within the B<Node> blocks, the following
5505 options are available:
5509 =item B<Host> I<Address>
5511 Hostname or address to connect to. Defaults to C<localhost>.
5513 =item B<Port> I<Service>
5515 Service name or port number to connect to. Defaults to C<27017>.
5517 =item B<Timeout> I<Timeout>
5519 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
5520 Setting this option to zero means no timeout, which is the default.
5522 =item B<StoreRates> B<false>|B<true>
5524 If set to B<true> (the default), convert counter values to rates. If set to
5525 B<false> counter values are stored as is, i.e. as an increasing integer
5530 =head2 Plugin C<write_http>
5532 This output plugin submits values to an http server by POST them using the
5533 PUTVAL plain-text protocol. Each destination you want to post data to needs to
5534 have one B<URL> block, within which the destination can be configured further,
5535 for example by specifying authentication data.
5539 <Plugin "write_http">
5540 <URL "http://example.com/post-collectd">
5546 B<URL> blocks need one string argument which is used as the URL to which data
5547 is posted. The following options are understood within B<URL> blocks.
5551 =item B<User> I<Username>
5553 Optional user name needed for authentication.
5555 =item B<Password> I<Password>
5557 Optional password needed for authentication.
5559 =item B<VerifyPeer> B<true>|B<false>
5561 Enable or disable peer SSL certificate verification. See
5562 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5564 =item B<VerifyHost> B<true|false>
5566 Enable or disable peer host name verification. If enabled, the plugin checks if
5567 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
5568 matches the host name provided by the B<URL> option. If this identity check
5569 fails, the connection is aborted. Obviously, only works when connecting to a
5570 SSL enabled server. Enabled by default.
5572 =item B<CACert> I<File>
5574 File that holds one or more SSL certificates. If you want to use HTTPS you will
5575 possibly need this option. What CA certificates come bundled with C<libcurl>
5576 and are checked by default depends on the distribution you use.
5578 =item B<Format> B<Command>|B<JSON>
5580 Format of the output to generate. If set to B<Command>, will create output that
5581 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
5582 create output in the I<JavaScript Object Notation> (JSON).
5584 Defaults to B<Command>.
5586 =item B<StoreRates> B<true|false>
5588 If set to B<true>, convert counter values to rates. If set to B<false> (the
5589 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
5594 =head2 Plugin C<write_riemann>
5596 The I<write_riemann plugin> will send values to I<Riemann>, a powerfull stream
5597 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
5598 I<Riemann> using UDP packets.
5602 <Plugin "write_riemann">
5612 The following options are understood by the I<write_riemann plugin>:
5616 =item E<lt>B<Node> I<Name>E<gt>
5618 The plugin's configuration consists of one or more B<Node> blocks. Each block
5619 is given a unique I<Name> and specifies one connection to an instance of
5620 I<Riemann>. Indise the B<Node> block, the following per-connection options are
5625 =item B<Host> I<Address>
5627 Hostname or address to connect to. Defaults to C<localhost>.
5629 =item B<Port> I<Service>
5631 Service name or port number to connect to. Defaults to C<5555>.
5633 =item B<StoreRates> B<false>|B<true>
5635 If set to B<true> (the default), convert counter values to rates. If set to
5636 B<false> counter values are stored as is, i.e. as an increasing integer number.
5638 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
5639 converted values will have "rate" appended to the data source type, e.g.
5640 C<ds_type:derive:rate>.
5642 =item B<AlwaysAppendDS> B<false>|B<true>
5644 If set the B<true>, append the name of the I<Data Source> (DS) to the
5645 "service", i.e. the field that, together with the "host" field, uniquely
5646 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
5647 only done when there is more than one DS.
5651 =item B<Tag> I<String>
5653 Add the given string as an additional tag to the metric being sent to
5658 =head1 THRESHOLD CONFIGURATION
5660 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
5661 we mean that the values are not only stored or sent somewhere, but that they
5662 are judged and, if a problem is recognized, acted upon. The only action
5663 collectd takes itself is to generate and dispatch a "notification". Plugins can
5664 register to receive notifications and perform appropriate further actions.
5666 Since systems and what you expect them to do differ a lot, you can configure
5667 B<thresholds> for your values freely. This gives you a lot of flexibility but
5668 also a lot of responsibility.
5670 Every time a value is out of range a notification is dispatched. This means
5671 that the idle percentage of your CPU needs to be less then the configured
5672 threshold only once for a notification to be generated. There's no such thing
5673 as a moving average or similar - at least not now.
5675 Also, all values that match a threshold are considered to be relevant or
5676 "interesting". As a consequence collectd will issue a notification if they are
5677 not received for B<Timeout> iterations. The B<Timeout> configuration option is
5678 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
5679 "2" (the default) and some hosts sends it's CPU statistics to the server every
5680 60 seconds, a notification will be dispatched after about 120 seconds. It may
5681 take a little longer because the timeout is checked only once each B<Interval>
5684 When a value comes within range again or is received after it was missing, an
5685 "OKAY-notification" is dispatched.
5687 Here is a configuration example to get you started. Read below for more
5700 <Plugin "interface">
5717 WarningMin 100000000
5723 There are basically two types of configuration statements: The C<Host>,
5724 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
5725 configured. The C<Plugin> and C<Type> blocks may be specified further using the
5726 C<Instance> option. You can combine the block by nesting the blocks, though
5727 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
5728 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
5729 C<Type> may not contain other blocks. If multiple blocks apply to the same
5730 value the most specific block is used.
5732 The other statements specify the threshold to configure. They B<must> be
5733 included in a C<Type> block. Currently the following statements are recognized:
5737 =item B<FailureMax> I<Value>
5739 =item B<WarningMax> I<Value>
5741 Sets the upper bound of acceptable values. If unset defaults to positive
5742 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
5743 will be created. If the value is greater than B<WarningMax> but less than (or
5744 equal to) B<FailureMax> a B<WARNING> notification will be created.
5746 =item B<FailureMin> I<Value>
5748 =item B<WarningMin> I<Value>
5750 Sets the lower bound of acceptable values. If unset defaults to negative
5751 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
5752 be created. If the value is less than B<WarningMin> but greater than (or equal
5753 to) B<FailureMin> a B<WARNING> notification will be created.
5755 =item B<DataSource> I<DSName>
5757 Some data sets have more than one "data source". Interesting examples are the
5758 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
5759 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
5760 system load data set, C<load>, even has three data sources: C<shortterm>,
5761 C<midterm>, and C<longterm>.
5763 Normally, all data sources are checked against a configured threshold. If this
5764 is undesirable, or if you want to specify different limits for each data
5765 source, you can use the B<DataSource> option to have a threshold apply only to
5768 =item B<Invert> B<true>|B<false>
5770 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
5771 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
5772 B<WarningMax>) are not okay. Defaults to B<false>.
5774 =item B<Persist> B<true>|B<false>
5776 Sets how often notifications are generated. If set to B<true> one notification
5777 will be generated for each value that is out of the acceptable range. If set to
5778 B<false> (the default) then a notification is only generated if a value is out
5779 of range but the previous value was okay.
5781 This applies to missing values, too: If set to B<true> a notification about a
5782 missing value is generated once every B<Interval> seconds. If set to B<false>
5783 only one such notification is generated until the value appears again.
5785 =item B<Percentage> B<true>|B<false>
5787 If set to B<true>, the minimum and maximum values given are interpreted as
5788 percentage value, relative to the other data sources. This is helpful for
5789 example for the "df" type, where you may want to issue a warning when less than
5790 5E<nbsp>% of the total space is available. Defaults to B<false>.
5792 =item B<Hits> I<Number>
5794 Delay creating the notification until the threshold has been passed I<Number>
5795 times. When a notification has been generated, or when a subsequent value is
5796 inside the threshold, the counter is reset. If, for example, a value is
5797 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
5798 will be dispatched at most once every 30E<nbsp>seconds.
5800 This is useful when short bursts are not a problem. If, for example, 100% CPU
5801 usage for up to a minute is normal (and data is collected every
5802 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
5804 =item B<Hysteresis> I<Number>
5806 When set to non-zero, a hysteresis value is applied when checking minimum and
5807 maximum bounds. This is useful for values that increase slowly and fluctuate a
5808 bit while doing so. When these values come close to the threshold, they may
5809 "flap", i.e. switch between failure / warning case and okay case repeatedly.
5811 If, for example, the threshold is configures as
5816 then a I<Warning> notification is created when the value exceeds I<101> and the
5817 corresponding I<Okay> notification is only created once the value falls below
5818 I<99>, thus avoiding the "flapping".
5822 =head1 FILTER CONFIGURATION
5824 Starting with collectd 4.6 there is a powerful filtering infrastructure
5825 implemented in the daemon. The concept has mostly been copied from
5826 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
5827 terminology, so that users that are familiar with iptables feel right at home.
5831 The following are the terms used in the remainder of the filter configuration
5832 documentation. For an ASCII-art schema of the mechanism, see
5833 L<"General structure"> below.
5839 A I<match> is a criteria to select specific values. Examples are, of course, the
5840 name of the value or it's current value.
5842 Matches are implemented in plugins which you have to load prior to using the
5843 match. The name of such plugins starts with the "match_" prefix.
5847 A I<target> is some action that is to be performed with data. Such actions
5848 could, for example, be to change part of the value's identifier or to ignore
5849 the value completely.
5851 Some of these targets are built into the daemon, see L<"Built-in targets">
5852 below. Other targets are implemented in plugins which you have to load prior to
5853 using the target. The name of such plugins starts with the "target_" prefix.
5857 The combination of any number of matches and at least one target is called a
5858 I<rule>. The target actions will be performed for all values for which B<all>
5859 matches apply. If the rule does not have any matches associated with it, the
5860 target action will be performed for all values.
5864 A I<chain> is a list of rules and possibly default targets. The rules are tried
5865 in order and if one matches, the associated target will be called. If a value
5866 is handled by a rule, it depends on the target whether or not any subsequent
5867 rules are considered or if traversal of the chain is aborted, see
5868 L<"Flow control"> below. After all rules have been checked, the default targets
5873 =head2 General structure
5875 The following shows the resulting structure:
5882 +---------+ +---------+ +---------+ +---------+
5883 ! Rule !->! Match !->! Match !->! Target !
5884 +---------+ +---------+ +---------+ +---------+
5887 +---------+ +---------+ +---------+
5888 ! Rule !->! Target !->! Target !
5889 +---------+ +---------+ +---------+
5896 +---------+ +---------+ +---------+
5897 ! Rule !->! Match !->! Target !
5898 +---------+ +---------+ +---------+
5908 There are four ways to control which way a value takes through the filter
5915 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
5916 process the value with another chain. When the called chain finishes, usually
5917 the next target or rule after the jump is executed.
5921 The stop condition, signaled for example by the built-in target B<stop>, causes
5922 all processing of the value to be stopped immediately.
5926 Causes processing in the current chain to be aborted, but processing of the
5927 value generally will continue. This means that if the chain was called via
5928 B<Jump>, the next target or rule after the jump will be executed. If the chain
5929 was not called by another chain, control will be returned to the daemon and it
5930 may pass the value to another chain.
5934 Most targets will signal the B<continue> condition, meaning that processing
5935 should continue normally. There is no special built-in target for this
5942 The configuration reflects this structure directly:
5944 PostCacheChain "PostCache"
5946 <Rule "ignore_mysql_show">
5949 Type "^mysql_command$"
5950 TypeInstance "^show_"
5960 The above configuration example will ignore all values where the plugin field
5961 is "mysql", the type is "mysql_command" and the type instance begins with
5962 "show_". All other values will be sent to the C<rrdtool> write plugin via the
5963 default target of the chain. Since this chain is run after the value has been
5964 added to the cache, the MySQL C<show_*> command statistics will be available
5965 via the C<unixsock> plugin.
5967 =head2 List of configuration options
5971 =item B<PreCacheChain> I<ChainName>
5973 =item B<PostCacheChain> I<ChainName>
5975 Configure the name of the "pre-cache chain" and the "post-cache chain". The
5976 argument is the name of a I<chain> that should be executed before and/or after
5977 the values have been added to the cache.
5979 To understand the implications, it's important you know what is going on inside
5980 I<collectd>. The following diagram shows how values are passed from the
5981 read-plugins to the write-plugins:
5987 + - - - - V - - - - +
5988 : +---------------+ :
5991 : +-------+-------+ :
5994 : +-------+-------+ : +---------------+
5995 : ! Cache !--->! Value Cache !
5996 : ! insert ! : +---+---+-------+
5997 : +-------+-------+ : ! !
5998 : ! ,------------' !
6000 : +-------+---+---+ : +-------+-------+
6001 : ! Post-Cache +--->! Write-Plugins !
6002 : ! Chain ! : +---------------+
6003 : +---------------+ :
6006 + - - - - - - - - - +
6008 After the values are passed from the "read" plugins to the dispatch functions,
6009 the pre-cache chain is run first. The values are added to the internal cache
6010 afterwards. The post-cache chain is run after the values have been added to the
6011 cache. So why is it such a huge deal if chains are run before or after the
6012 values have been added to this cache?
6014 Targets that change the identifier of a value list should be executed before
6015 the values are added to the cache, so that the name in the cache matches the
6016 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
6017 this cache to receive a list of all available values. If you change the
6018 identifier after the value list has been added to the cache, this may easily
6019 lead to confusion, but it's not forbidden of course.
6021 The cache is also used to convert counter values to rates. These rates are, for
6022 example, used by the C<value> match (see below). If you use the rate stored in
6023 the cache B<before> the new value is added, you will use the old, B<previous>
6024 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
6025 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
6028 Last but not last, the B<stop> target makes a difference: If the pre-cache
6029 chain returns the stop condition, the value will not be added to the cache and
6030 the post-cache chain will not be run.
6032 =item B<Chain> I<Name>
6034 Adds a new chain with a certain name. This name can be used to refer to a
6035 specific chain, for example to jump to it.
6037 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
6039 =item B<Rule> [I<Name>]
6041 Adds a new rule to the current chain. The name of the rule is optional and
6042 currently has no meaning for the daemon.
6044 Within the B<Rule> block, there may be any number of B<Match> blocks and there
6045 must be at least one B<Target> block.
6047 =item B<Match> I<Name>
6049 Adds a match to a B<Rule> block. The name specifies what kind of match should
6050 be performed. Available matches depend on the plugins that have been loaded.
6052 The arguments inside the B<Match> block are passed to the plugin implementing
6053 the match, so which arguments are valid here depends on the plugin being used.
6054 If you do not need any to pass any arguments to a match, you can use the
6059 Which is equivalent to:
6064 =item B<Target> I<Name>
6066 Add a target to a rule or a default target to a chain. The name specifies what
6067 kind of target is to be added. Which targets are available depends on the
6068 plugins being loaded.
6070 The arguments inside the B<Target> block are passed to the plugin implementing
6071 the target, so which arguments are valid here depends on the plugin being used.
6072 If you do not need any to pass any arguments to a target, you can use the
6077 This is the same as writing:
6084 =head2 Built-in targets
6086 The following targets are built into the core daemon and therefore need no
6087 plugins to be loaded:
6093 Signals the "return" condition, see the L<"Flow control"> section above. This
6094 causes the current chain to stop processing the value and returns control to
6095 the calling chain. The calling chain will continue processing targets and rules
6096 just after the B<jump> target (see below). This is very similar to the
6097 B<RETURN> target of iptables, see L<iptables(8)>.
6099 This target does not have any options.
6107 Signals the "stop" condition, see the L<"Flow control"> section above. This
6108 causes processing of the value to be aborted immediately. This is similar to
6109 the B<DROP> target of iptables, see L<iptables(8)>.
6111 This target does not have any options.
6119 Sends the value to "write" plugins.
6125 =item B<Plugin> I<Name>
6127 Name of the write plugin to which the data should be sent. This option may be
6128 given multiple times to send the data to more than one write plugin.
6132 If no plugin is explicitly specified, the values will be sent to all available
6143 Starts processing the rules of another chain, see L<"Flow control"> above. If
6144 the end of that chain is reached, or a stop condition is encountered,
6145 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
6146 next target or the next rule. This is similar to the B<-j> command line option
6147 of iptables, see L<iptables(8)>.
6153 =item B<Chain> I<Name>
6155 Jumps to the chain I<Name>. This argument is required and may appear only once.
6167 =head2 Available matches
6173 Matches a value using regular expressions.
6179 =item B<Host> I<Regex>
6181 =item B<Plugin> I<Regex>
6183 =item B<PluginInstance> I<Regex>
6185 =item B<Type> I<Regex>
6187 =item B<TypeInstance> I<Regex>
6189 Match values where the given regular expressions match the various fields of
6190 the identifier of a value. If multiple regular expressions are given, B<all>
6191 regexen must match for a value to match.
6193 =item B<Invert> B<false>|B<true>
6195 When set to B<true>, the result of the match is inverted, i.e. all value lists
6196 where all regular expressions apply are not matched, all other value lists are
6197 matched. Defaults to B<false>.
6204 Host "customer[0-9]+"
6210 Matches values that have a time which differs from the time on the server.
6212 This match is mainly intended for servers that receive values over the
6213 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
6214 is very sensitive to the timestamp used when updating the RRD files. In
6215 particular, the time must be ever increasing. If a misbehaving client sends one
6216 packet with a timestamp far in the future, all further packets with a correct
6217 time will be ignored because of that one packet. What's worse, such corrupted
6218 RRD files are hard to fix.
6220 This match lets one match all values B<outside> a specified time range
6221 (relative to the server's time), so you can use the B<stop> target (see below)
6222 to ignore the value, for example.
6228 =item B<Future> I<Seconds>
6230 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
6231 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
6234 =item B<Past> I<Seconds>
6236 Matches all values that are I<behind> of the server's time by I<Seconds> or
6237 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
6249 This example matches all values that are five minutes or more ahead of the
6250 server or one hour (or more) lagging behind.
6254 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
6255 values. If a data-set consists of more than one data-source, all data-sources
6256 must match the specified ranges for a positive match.
6262 =item B<Min> I<Value>
6264 Sets the smallest value which still results in a match. If unset, behaves like
6267 =item B<Max> I<Value>
6269 Sets the largest value which still results in a match. If unset, behaves like
6272 =item B<Invert> B<true>|B<false>
6274 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
6275 no-match is returned and vice versa. Please note that the B<Invert> setting
6276 only effects how B<Min> and B<Max> are applied to a specific value. Especially
6277 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
6279 =item B<DataSource> I<DSName> [I<DSName> ...]
6281 Select one or more of the data sources. If no data source is configured, all
6282 data sources will be checked. If the type handled by the match does not have a
6283 data source of the specified name(s), this will always result in no match
6284 (independent of the B<Invert> setting).
6286 =item B<Satisfy> B<Any>|B<All>
6288 Specifies how checking with several data sources is performed. If set to
6289 B<Any>, the match succeeds if one of the data sources is in the configured
6290 range. If set to B<All> the match only succeeds if all data sources are within
6291 the configured range. Default is B<All>.
6293 Usually B<All> is used for positive matches, B<Any> is used for negative
6294 matches. This means that with B<All> you usually check that all values are in a
6295 "good" range, while with B<Any> you check if any value is within a "bad" range
6296 (or outside the "good" range).
6300 Either B<Min> or B<Max>, but not both, may be unset.
6304 # Match all values smaller than or equal to 100. Matches only if all data
6305 # sources are below 100.
6311 # Match if the value of any data source is outside the range of 0 - 100.
6319 =item B<empty_counter>
6321 Matches all values with one or more data sources of type B<COUNTER> and where
6322 all counter values are zero. These counters usually I<never> increased since
6323 they started existing (and are therefore uninteresting), or got reset recently
6324 or overflowed and you had really, I<really> bad luck.
6326 Please keep in mind that ignoring such counters can result in confusing
6327 behavior: Counters which hardly ever increase will be zero for long periods of
6328 time. If the counter is reset for some reason (machine or service restarted,
6329 usually), the graph will be empty (NAN) for a long time. People may not
6334 Calculates a hash value of the host name and matches values according to that
6335 hash value. This makes it possible to divide all hosts into groups and match
6336 only values that are in a specific group. The intended use is in load
6337 balancing, where you want to handle only part of all data and leave the rest
6340 The hashing function used tries to distribute the hosts evenly. First, it
6341 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
6344 for (i = 0; host[i] != 0; i++)
6345 hash_value = (hash_value * 251) + host[i];
6347 The constant 251 is a prime number which is supposed to make this hash value
6348 more random. The code then checks the group for this host according to the
6349 I<Total> and I<Match> arguments:
6351 if ((hash_value % Total) == Match)
6356 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
6357 groups), then the least significant bit of the hash value will be the XOR of
6358 all least significant bits in the host name. One consequence is that when you
6359 have two hosts, "server0.example.com" and "server1.example.com", where the host
6360 name differs in one digit only and the digits differ by one, those hosts will
6361 never end up in the same group.
6367 =item B<Match> I<Match> I<Total>
6369 Divide the data into I<Total> groups and match all hosts in group I<Match> as
6370 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
6371 be smaller than I<Total>. I<Total> must be at least one, although only values
6372 greater than one really do make any sense.
6374 You can repeat this option to match multiple groups, for example:
6379 The above config will divide the data into seven groups and match groups three
6380 and five. One use would be to keep every value on two hosts so that if one
6381 fails the missing data can later be reconstructed from the second host.
6387 # Operate on the pre-cache chain, so that ignored values are not even in the
6392 # Divide all received hosts in seven groups and accept all hosts in
6396 # If matched: Return and continue.
6399 # If not matched: Return and stop.
6405 =head2 Available targets
6409 =item B<notification>
6411 Creates and dispatches a notification.
6417 =item B<Message> I<String>
6419 This required option sets the message of the notification. The following
6420 placeholders will be replaced by an appropriate value:
6428 =item B<%{plugin_instance}>
6432 =item B<%{type_instance}>
6434 These placeholders are replaced by the identifier field of the same name.
6436 =item B<%{ds:>I<name>B<}>
6438 These placeholders are replaced by a (hopefully) human readable representation
6439 of the current rate of this data source. If you changed the instance name
6440 (using the B<set> or B<replace> targets, see below), it may not be possible to
6441 convert counter values to rates.
6445 Please note that these placeholders are B<case sensitive>!
6447 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
6449 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
6456 <Target "notification">
6457 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
6463 Replaces parts of the identifier using regular expressions.
6469 =item B<Host> I<Regex> I<Replacement>
6471 =item B<Plugin> I<Regex> I<Replacement>
6473 =item B<PluginInstance> I<Regex> I<Replacement>
6475 =item B<TypeInstance> I<Regex> I<Replacement>
6477 Match the appropriate field with the given regular expression I<Regex>. If the
6478 regular expression matches, that part that matches is replaced with
6479 I<Replacement>. If multiple places of the input buffer match a given regular
6480 expression, only the first occurrence will be replaced.
6482 You can specify each option multiple times to use multiple regular expressions
6490 # Replace "example.net" with "example.com"
6491 Host "\\<example.net\\>" "example.com"
6493 # Strip "www." from hostnames
6499 Sets part of the identifier of a value to a given string.
6505 =item B<Host> I<String>
6507 =item B<Plugin> I<String>
6509 =item B<PluginInstance> I<String>
6511 =item B<TypeInstance> I<String>
6513 Set the appropriate field to the given string. The strings for plugin instance
6514 and type instance may be empty, the strings for host and plugin may not be
6515 empty. It's currently not possible to set the type of a value this way.
6522 PluginInstance "coretemp"
6523 TypeInstance "core3"
6528 =head2 Backwards compatibility
6530 If you use collectd with an old configuration, i.E<nbsp>e. one without a
6531 B<Chain> block, it will behave as it used to. This is equivalent to the
6532 following configuration:
6538 If you specify a B<PostCacheChain>, the B<write> target will not be added
6539 anywhere and you will have to make sure that it is called where appropriate. We
6540 suggest to add the above snippet as default target to your "PostCache" chain.
6544 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
6560 L<collectd-exec(5)>,
6561 L<collectd-perl(5)>,
6562 L<collectd-unixsock(5)>,
6575 Florian Forster E<lt>octo@verplant.orgE<gt>