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<Header> I<Header>
949 A HTTP header to add to the request. Multiple headers are added if this option
950 is specified more than once.
952 =item B<Post> I<Body>
954 Specifies that the HTTP operation should be a POST instead of a GET. The
955 complete data to be posted is given as the argument. This option will usually
956 need to be accompanied by a B<Header> option to set an appropriate
957 C<Content-Type> for the post body (e.g. to
958 C<application/x-www-form-urlencoded>).
960 =item B<MeasureResponseTime> B<true>|B<false>
962 Measure response time for the request. If this setting is enabled, B<Match>
963 blocks (see below) are optional. Disabled by default.
965 =item B<E<lt>MatchE<gt>>
967 One or more B<Match> blocks that define how to match information in the data
968 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
969 used by the C<tail> plugin, so please see the documentation of the C<tail>
970 plugin below on how matches are defined. If the B<MeasureResponseTime> option
971 is set to B<true>, B<Match> blocks are optional.
975 =head2 Plugin C<curl_json>
977 The B<curl_json plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and
978 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) to retrieve JSON data
979 via cURL. This can be used to collect values from CouchDB documents (which are
980 stored JSON notation), for example.
982 The following example will collect several values from the built-in `_stats'
983 runtime statistics module of CouchDB
984 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
987 <URL "http://localhost:5984/_stats">
989 <Key "httpd/requests/count">
993 <Key "httpd_request_methods/*/count">
994 Type "http_request_methods"
997 <Key "httpd_status_codes/*/count">
998 Type "http_response_codes"
1003 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining
1004 a URL to be fetched via HTTP (using libcurl) and one or more B<Key> blocks.
1005 The B<Key> string argument must be in a path format, which is used to collect a
1006 value from a JSON map object. If a path element of B<Key> is the
1007 I<*>E<nbsp>wildcard, the values for all keys will be collectd.
1009 The following options are valid within B<URL> blocks:
1013 =item B<Instance> I<Instance>
1015 Sets the plugin instance to I<Instance>.
1017 =item B<User> I<Name>
1018 =item B<Password> I<Password>
1019 =item B<VerifyPeer> B<true>|B<false>
1020 =item B<VerifyHost> B<true>|B<false>
1021 =item B<CACert> I<file>
1022 =item B<Header> I<Header>
1023 =item B<Post> I<Body>
1025 These options behave exactly equivalent to the appropriate options of the
1026 I<cURL> plugin. Please see there for a detailed description.
1030 The following options are valid within B<Key> blocks:
1034 =item B<Type> I<Type>
1036 Sets the type used to dispatch the values to the daemon. Detailed information
1037 about types and their configuration can be found in L<types.db(5)>. This
1038 option is mandatory.
1040 =item B<Instance> I<Instance>
1042 Type-instance to use. Defaults to the current map key or current string array element value.
1046 =head2 Plugin C<curl_xml>
1048 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1049 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1052 <URL "http://localhost/stats.xml">
1054 Instance "some_instance"
1059 CACert "/path/to/ca.crt"
1061 <XPath "table[@id=\"magic_level\"]/tr">
1063 #InstancePrefix "prefix-"
1064 InstanceFrom "td[1]"
1065 ValuesFrom "td[2]/span[@class=\"level\"]"
1070 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1071 URL to be fetched using libcurl. Within each B<URL> block there are
1072 options which specify the connection parameters, for example authentication
1073 information, and one or more B<XPath> blocks.
1075 Each B<XPath> block specifies how to get one type of information. The
1076 string argument must be a valid XPath expression which returns a list
1077 of "base elements". One value is dispatched for each "base element". The
1078 I<type instance> and values are looked up using further I<XPath> expressions
1079 that should be relative to the base element.
1081 Within the B<URL> block the following options are accepted:
1085 =item B<Host> I<Name>
1087 Use I<Name> as the host name when submitting values. Defaults to the global
1090 =item B<Instance> I<Instance>
1092 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1093 empty string (no plugin instance).
1095 =item B<Namespace> I<Prefix> I<URL>
1097 If an XPath expression references namespaces, they must be specified
1098 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1099 I<URL> is the "namespace name", an URI reference uniquely identifying the
1100 namespace. The option can be repeated to register multiple namespaces.
1104 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1105 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1107 =item B<User> I<User>
1109 =item B<Password> I<Password>
1111 =item B<VerifyPeer> B<true>|B<false>
1113 =item B<VerifyHost> B<true>|B<false>
1115 =item B<CACert> I<CA Cert File>
1117 =item B<Header> I<Header>
1119 =item B<Post> I<Body>
1121 These options behave exactly equivalent to the appropriate options of the
1122 I<cURL plugin>. Please see there for a detailed description.
1124 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1126 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1127 B<XPath> block specifies how to get one type of information. The string
1128 argument must be a valid XPath expression which returns a list of "base
1129 elements". One value is dispatched for each "base element".
1131 Within the B<XPath> block the following options are accepted:
1135 =item B<Type> I<Type>
1137 Specifies the I<Type> used for submitting patches. This determines the number
1138 of values that are required / expected and whether the strings are parsed as
1139 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1140 This option is required.
1142 =item B<InstancePrefix> I<InstancePrefix>
1144 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1145 concatenated together without any separator.
1146 This option is optional.
1148 =item B<InstanceFrom> I<InstanceFrom>
1150 Specifies a XPath expression to use for determining the I<type instance>. The
1151 XPath expression must return exactly one element. The element's value is then
1152 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1154 This value is required. As a special exception, if the "base XPath expression"
1155 (the argument to the B<XPath> block) returns exactly one argument, then this
1156 option may be omitted.
1158 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1160 Specifies one or more XPath expression to use for reading the values. The
1161 number of XPath expressions must match the number of data sources in the
1162 I<type> specified with B<Type> (see above). Each XPath expression must return
1163 exactly one element. The element's value is then parsed as a number and used as
1164 value for the appropriate value in the value list dispatched to the daemon.
1170 =head2 Plugin C<dbi>
1172 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1173 connect to various databases, execute I<SQL> statements and read back the
1174 results. I<dbi> is an acronym for "database interface" in case you were
1175 wondering about the name. You can configure how each column is to be
1176 interpreted and the plugin will generate one or more data sets from each row
1177 returned according to these rules.
1179 Because the plugin is very generic, the configuration is a little more complex
1180 than those of other plugins. It usually looks something like this:
1183 <Query "out_of_stock">
1184 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1185 # Use with MySQL 5.0.0 or later
1189 InstancePrefix "out_of_stock"
1190 InstancesFrom "category"
1194 <Database "product_information">
1196 DriverOption "host" "localhost"
1197 DriverOption "username" "collectd"
1198 DriverOption "password" "aZo6daiw"
1199 DriverOption "dbname" "prod_info"
1200 SelectDB "prod_info"
1201 Query "out_of_stock"
1205 The configuration above defines one query with one result and one database. The
1206 query is then linked to the database with the B<Query> option I<within> the
1207 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1208 and you can also use the B<Include> statement to split up the configuration
1209 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1210 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1213 The following is a complete list of options:
1215 =head3 B<Query> blocks
1217 Query blocks define I<SQL> statements and how the returned data should be
1218 interpreted. They are identified by the name that is given in the opening line
1219 of the block. Thus the name needs to be unique. Other than that, the name is
1220 not used in collectd.
1222 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1223 define which column holds which value or instance information. You can use
1224 multiple B<Result> blocks to create multiple values from one returned row. This
1225 is especially useful, when queries take a long time and sending almost the same
1226 query again and again is not desirable.
1230 <Query "environment">
1231 Statement "select station, temperature, humidity from environment"
1234 # InstancePrefix "foo"
1235 InstancesFrom "station"
1236 ValuesFrom "temperature"
1240 InstancesFrom "station"
1241 ValuesFrom "humidity"
1245 The following options are accepted:
1249 =item B<Statement> I<SQL>
1251 Sets the statement that should be executed on the server. This is B<not>
1252 interpreted by collectd, but simply passed to the database server. Therefore,
1253 the SQL dialect that's used depends on the server collectd is connected to.
1255 The query has to return at least two columns, one for the instance and one
1256 value. You cannot omit the instance, even if the statement is guaranteed to
1257 always return exactly one line. In that case, you can usually specify something
1260 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1262 (That works with MySQL but may not be valid SQL according to the spec. If you
1263 use a more strict database server, you may have to select from a dummy table or
1266 Please note that some databases, for example B<Oracle>, will fail if you
1267 include a semicolon at the end of the statement.
1269 =item B<MinVersion> I<Version>
1271 =item B<MaxVersion> I<Value>
1273 Only use this query for the specified database version. You can use these
1274 options to provide multiple queries with the same name but with a slightly
1275 different syntax. The plugin will use only those queries, where the specified
1276 minimum and maximum versions fit the version of the database in use.
1278 The database version is determined by C<dbi_conn_get_engine_version>, see the
1279 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1280 for details. Basically, each part of the version is assumed to be in the range
1281 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1282 "40102", version "5.0.42" becomes "50042".
1284 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1285 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1286 happen. Don't to it! A valid example would be something along these lines:
1297 In the above example, there are three ranges that don't overlap. The last one
1298 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1299 before "4.0.0" are not specified.
1301 =item B<Type> I<Type>
1303 The B<type> that's used for each line returned. See L<types.db(5)> for more
1304 details on how types are defined. In short: A type is a predefined layout of
1305 data and the number of values and type of values has to match the type
1308 If you specify "temperature" here, you need exactly one gauge column. If you
1309 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1312 There must be exactly one B<Type> option inside each B<Result> block.
1314 =item B<InstancePrefix> I<prefix>
1316 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1317 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1318 all strings returned in the appropriate columns are concatenated together,
1319 separated by dashes I<("-")>.
1321 =item B<InstancesFrom> I<column0> [I<column1> ...]
1323 Specifies the columns whose values will be used to create the "type-instance"
1324 for each row. If you specify more than one column, the value of all columns
1325 will be joined together with dashes I<("-")> as separation characters.
1327 The plugin itself does not check whether or not all built instances are
1328 different. It's your responsibility to assure that each is unique. This is
1329 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1330 sure that only one row is returned in this case.
1332 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1335 =item B<ValuesFrom> I<column0> [I<column1> ...]
1337 Names the columns whose content is used as the actual data for the data sets
1338 that are dispatched to the daemon. How many such columns you need is determined
1339 by the B<Type> setting above. If you specify too many or not enough columns,
1340 the plugin will complain about that and no data will be submitted to the
1343 The actual data type in the columns is not that important. The plugin will
1344 automatically cast the values to the right type if it know how to do that. So
1345 it should be able to handle integer an floating point types, as well as strings
1346 (if they include a number at the beginning).
1348 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1352 =head3 B<Database> blocks
1354 Database blocks define a connection to a database and which queries should be
1355 sent to that database. Since the used "dbi" library can handle a wide variety
1356 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1357 documentationE<nbsp>- we stick as close to the terminology used there.
1359 Each database needs a "name" as string argument in the starting tag of the
1360 block. This name will be used as "PluginInstance" in the values submitted to
1361 the daemon. Other than that, that name is not used.
1365 =item B<Driver> I<Driver>
1367 Specifies the driver to use to connect to the database. In many cases those
1368 drivers are named after the database they can connect to, but this is not a
1369 technical necessity. These drivers are sometimes referred to as "DBD",
1370 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1371 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1372 project at L<http://libdbi-drivers.sourceforge.net/>.
1374 You need to give the driver name as expected by the "dbi" library here. You
1375 should be able to find that in the documentation for each driver. If you
1376 mistype the driver name, the plugin will dump a list of all known driver names
1379 =item B<DriverOption> I<Key> I<Value>
1381 Sets driver-specific options. What option a driver supports can be found in the
1382 documentation for each driver, somewhere at
1383 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1384 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1386 DBDs can register two types of options: String options and numeric options. The
1387 plugin will use the C<dbi_conn_set_option> function when the configuration
1388 provides a string and the C<dbi_conn_require_option_numeric> function when the
1389 configuration provides a number. So these two lines will actually result in
1390 different calls being used:
1392 DriverOption "Port" 1234 # numeric
1393 DriverOption "Port" "1234" # string
1395 Unfortunately, drivers are not too keen to report errors when an unknown option
1396 is passed to them, so invalid settings here may go unnoticed. This is not the
1397 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1398 the driver. If a driver complains about an option, the plugin will dump a
1399 complete list of all options understood by that driver to the log. There is no
1400 way to programatically find out if an option expects a string or a numeric
1401 argument, so you will have to refer to the appropriate DBD's documentation to
1402 find this out. Sorry.
1404 =item B<SelectDB> I<Database>
1406 In some cases, the database name you connect with is not the database name you
1407 want to use for querying data. If this option is set, the plugin will "select"
1408 (switch to) that database after the connection is established.
1410 =item B<Query> I<QueryName>
1412 Associates the query named I<QueryName> with this database connection. The
1413 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1414 blocks you want to refer to must be placed above the database block you want to
1417 =item B<Host> I<Hostname>
1419 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
1420 values. Defaults to the global hostname setting.
1428 =item B<Device> I<Device>
1430 Select partitions based on the devicename.
1432 =item B<MountPoint> I<Directory>
1434 Select partitions based on the mountpoint.
1436 =item B<FSType> I<FSType>
1438 Select partitions based on the filesystem type.
1440 =item B<IgnoreSelected> B<true>|B<false>
1442 Invert the selection: If set to true, all partitions B<except> the ones that
1443 match any one of the criteria are collected. By default only selected
1444 partitions are collected if a selection is made. If no selection is configured
1445 at all, B<all> partitions are selected.
1447 =item B<ReportByDevice> B<true>|B<false>
1449 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1450 (the default), it will report a disk as "root", but with it I<true>, it will be
1451 "sda1" (or whichever).
1453 =item B<ReportInodes> B<true>|B<false>
1455 Enables or disables reporting of free, reserved and used inodes. Defaults to
1456 inode collection being disabled.
1458 Enable this option if inodes are a scarce resource for you, usually because
1459 many small files are stored on the disk. This is a usual scenario for mail
1460 transfer agents and web caches.
1464 =head2 Plugin C<disk>
1466 The C<disk> plugin collects information about the usage of physical disks and
1467 logical disks (partitions). Values collected are the number of octets written
1468 to and read from a disk or partition, the number of read/write operations
1469 issued to the disk and a rather complex "time" it took for these commands to be
1472 Using the following two options you can ignore some disks or configure the
1473 collection only of specific disks.
1477 =item B<Disk> I<Name>
1479 Select the disk I<Name>. Whether it is collected or ignored depends on the
1480 B<IgnoreSelected> setting, see below. As with other plugins that use the
1481 daemon's ignorelist functionality, a string that starts and ends with a slash
1482 is interpreted as a regular expression. Examples:
1487 =item B<IgnoreSelected> B<true>|B<false>
1489 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1490 statements, are ignored or if all other disks are ignored. The behavior
1491 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1492 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1493 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1494 is set to B<true>, all disks are collected B<except> the ones matched.
1498 =head2 Plugin C<dns>
1502 =item B<Interface> I<Interface>
1504 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1505 option sets the interface that should be used. If this option is not set, or
1506 set to "any", the plugin will try to get packets from B<all> interfaces. This
1507 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1509 =item B<IgnoreSource> I<IP-address>
1511 Ignore packets that originate from this address.
1513 =item B<SelectNumericQueryTypes> B<true>|B<false>
1515 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1519 =head2 Plugin C<email>
1523 =item B<SocketFile> I<Path>
1525 Sets the socket-file which is to be created.
1527 =item B<SocketGroup> I<Group>
1529 If running as root change the group of the UNIX-socket after it has been
1530 created. Defaults to B<collectd>.
1532 =item B<SocketPerms> I<Permissions>
1534 Change the file permissions of the UNIX-socket after it has been created. The
1535 permissions must be given as a numeric, octal value as you would pass to
1536 L<chmod(1)>. Defaults to B<0770>.
1538 =item B<MaxConns> I<Number>
1540 Sets the maximum number of connections that can be handled in parallel. Since
1541 this many threads will be started immediately setting this to a very high
1542 value will waste valuable resources. Defaults to B<5> and will be forced to be
1543 at most B<16384> to prevent typos and dumb mistakes.
1547 =head2 Plugin C<ethstat>
1549 The I<ethstat plugin> collects information about network interface cards (NICs)
1550 by talking directly with the underlying kernel driver using L<ioctl(2)>.
1556 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
1557 Map "multicast" "if_multicast"
1564 =item B<Interface> I<Name>
1566 Collect statistical information about interface I<Name>.
1568 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
1570 By default, the plugin will submit values as type C<derive> and I<type
1571 instance> set to I<Name>, the name of the metric as reported by the driver. If
1572 an appropriate B<Map> option exists, the given I<Type> and, optionally,
1573 I<TypeInstance> will be used.
1575 =item B<MappedOnly> B<true>|B<false>
1577 When set to B<true>, only metrics that can be mapped to to a I<type> will be
1578 collected, all other metrics will be ignored. Defaults to B<false>.
1582 =head2 Plugin C<exec>
1584 Please make sure to read L<collectd-exec(5)> before using this plugin. It
1585 contains valuable information on when the executable is executed and the
1586 output that is expected from it.
1590 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1592 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1594 Execute the executable I<Executable> as user I<User>. If the user name is
1595 followed by a colon and a group name, the effective group is set to that group.
1596 The real group and saved-set group will be set to the default group of that
1597 user. If no group is given the effective group ID will be the same as the real
1600 Please note that in order to change the user and/or group the daemon needs
1601 superuser privileges. If the daemon is run as an unprivileged user you must
1602 specify the same user/group here. If the daemon is run with superuser
1603 privileges, you must supply a non-root user here.
1605 The executable may be followed by optional arguments that are passed to the
1606 program. Please note that due to the configuration parsing numbers and boolean
1607 values may be changed. If you want to be absolutely sure that something is
1608 passed as-is please enclose it in quotes.
1610 The B<Exec> and B<NotificationExec> statements change the semantics of the
1611 programs executed, i.E<nbsp>e. the data passed to them and the response
1612 expected from them. This is documented in great detail in L<collectd-exec(5)>.
1616 =head2 Plugin C<filecount>
1618 The C<filecount> plugin counts the number of files in a certain directory (and
1619 its subdirectories) and their combined size. The configuration is very straight
1622 <Plugin "filecount">
1623 <Directory "/var/qmail/queue/mess">
1624 Instance "qmail-message"
1626 <Directory "/var/qmail/queue/todo">
1627 Instance "qmail-todo"
1629 <Directory "/var/lib/php5">
1630 Instance "php5-sessions"
1635 The example above counts the number of files in QMail's queue directories and
1636 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
1637 QMail has not yet looked at, the "message" queue holds the messages that were
1638 classified into "local" and "remote".
1640 As you can see, the configuration consists of one or more C<Directory> blocks,
1641 each of which specifies a directory in which to count the files. Within those
1642 blocks, the following options are recognized:
1646 =item B<Instance> I<Instance>
1648 Sets the plugin instance to I<Instance>. That instance name must be unique, but
1649 it's your responsibility, the plugin doesn't check for that. If not given, the
1650 instance is set to the directory name with all slashes replaced by underscores
1651 and all leading underscores removed.
1653 =item B<Name> I<Pattern>
1655 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
1656 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
1657 against the pattern, not the entire path. In case this makes it easier for you:
1658 This option has been named after the B<-name> parameter to L<find(1)>.
1660 =item B<MTime> I<Age>
1662 Count only files of a specific age: If I<Age> is greater than zero, only files
1663 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
1664 a negative number, this is inversed. For example, if B<-60> is specified, only
1665 files that have been modified in the last minute will be counted.
1667 The number can also be followed by a "multiplier" to easily specify a larger
1668 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
1669 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
1670 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
1671 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
1672 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
1675 =item B<Size> I<Size>
1677 Count only files of a specific size. When I<Size> is a positive number, only
1678 files that are at least this big are counted. If I<Size> is a negative number,
1679 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
1680 I<Size> are counted.
1682 As with the B<MTime> option, a "multiplier" may be added. For a detailed
1683 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
1684 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
1685 note that there are 1000 bytes in a kilobyte, not 1024.
1687 =item B<Recursive> I<true>|I<false>
1689 Controls whether or not to recurse into subdirectories. Enabled by default.
1691 =item B<IncludeHidden> I<true>|I<false>
1693 Controls whether or not to include "hidden" files and directories in the count.
1694 "Hidden" files and directories are those, whose name begins with a dot.
1695 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
1699 =head2 Plugin C<GenericJMX>
1701 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
1702 L<collectd-java(5)>.
1704 =head2 Plugin C<gmond>
1706 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
1707 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
1708 are built-in, custom mappings may be added via B<Metric> blocks, see below.
1713 MCReceiveFrom "239.2.11.71" "8649"
1714 <Metric "swap_total">
1716 TypeInstance "total"
1719 <Metric "swap_free">
1726 The following metrics are built-in:
1732 load_one, load_five, load_fifteen
1736 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
1740 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
1752 Available configuration options:
1756 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
1758 Sets sets the multicast group and UDP port to which to subscribe.
1760 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
1762 =item E<lt>B<Metric> I<Name>E<gt>
1764 These blocks add a new metric conversion to the internal table. I<Name>, the
1765 string argument to the B<Metric> block, is the metric name as used by Ganglia.
1769 =item B<Type> I<Type>
1771 Type to map this metric to. Required.
1773 =item B<TypeInstance> I<Instance>
1775 Type-instance to use. Optional.
1777 =item B<DataSource> I<Name>
1779 Data source to map this metric to. If the configured type has exactly one data
1780 source, this is optional. Otherwise the option is required.
1786 =head2 Plugin C<hddtemp>
1788 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
1789 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
1790 default values, see below. C<hddtemp> has to be running to work correctly. If
1791 C<hddtemp> is not running timeouts may appear which may interfere with other
1794 The B<hddtemp> homepage can be found at
1795 L<http://www.guzu.net/linux/hddtemp.php>.
1799 =item B<Host> I<Hostname>
1801 Hostname to connect to. Defaults to B<127.0.0.1>.
1803 =item B<Port> I<Port>
1805 TCP-Port to connect to. Defaults to B<7634>.
1809 =head2 Plugin C<interface>
1813 =item B<Interface> I<Interface>
1815 Select this interface. By default these interfaces will then be collected. For
1816 a more detailed description see B<IgnoreSelected> below.
1818 =item B<IgnoreSelected> I<true>|I<false>
1820 If no configuration if given, the B<traffic>-plugin will collect data from
1821 all interfaces. This may not be practical, especially for loopback- and
1822 similar interfaces. Thus, you can use the B<Interface>-option to pick the
1823 interfaces you're interested in. Sometimes, however, it's easier/preferred
1824 to collect all interfaces I<except> a few ones. This option enables you to
1825 do that: By setting B<IgnoreSelected> to I<true> the effect of
1826 B<Interface> is inverted: All selected interfaces are ignored and all
1827 other interfaces are collected.
1831 =head2 Plugin C<ipmi>
1835 =item B<Sensor> I<Sensor>
1837 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
1839 =item B<IgnoreSelected> I<true>|I<false>
1841 If no configuration if given, the B<ipmi> plugin will collect data from all
1842 sensors found of type "temperature", "voltage", "current" and "fanspeed".
1843 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
1844 the effect of B<Sensor> is inverted: All selected sensors are ignored and
1845 all other sensors are collected.
1847 =item B<NotifySensorAdd> I<true>|I<false>
1849 If a sensor appears after initialization time of a minute a notification
1852 =item B<NotifySensorRemove> I<true>|I<false>
1854 If a sensor disappears a notification is sent.
1856 =item B<NotifySensorNotPresent> I<true>|I<false>
1858 If you have for example dual power supply and one of them is (un)plugged then
1859 a notification is sent.
1863 =head2 Plugin C<iptables>
1867 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
1869 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
1870 will collect the counters of all rules which have a comment-match. The comment
1871 is then used as type-instance.
1873 If I<Comment> or I<Number> is given, only the rule with the matching comment or
1874 the I<n>th rule will be collected. Again, the comment (or the number) will be
1875 used as the type-instance.
1877 If I<Name> is supplied, it will be used as the type-instance instead of the
1878 comment or the number.
1882 =head2 Plugin C<irq>
1888 Select this irq. By default these irqs will then be collected. For a more
1889 detailed description see B<IgnoreSelected> below.
1891 =item B<IgnoreSelected> I<true>|I<false>
1893 If no configuration if given, the B<irq>-plugin will collect data from all
1894 irqs. This may not be practical, especially if no interrupts happen. Thus, you
1895 can use the B<Irq>-option to pick the interrupt you're interested in.
1896 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
1897 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
1898 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
1899 and all other interrupts are collected.
1903 =head2 Plugin C<java>
1905 The I<Java> plugin makes it possible to write extensions for collectd in Java.
1906 This section only discusses the syntax and semantic of the configuration
1907 options. For more in-depth information on the I<Java> plugin, please read
1908 L<collectd-java(5)>.
1913 JVMArg "-verbose:jni"
1914 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
1915 LoadPlugin "org.collectd.java.Foobar"
1916 <Plugin "org.collectd.java.Foobar">
1917 # To be parsed by the plugin
1921 Available configuration options:
1925 =item B<JVMArg> I<Argument>
1927 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
1928 exactly the way the arguments to the I<java> binary on the command line work.
1929 Execute C<javaE<nbsp>--help> for details.
1931 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
1932 any other options! When another option is found, the JVM will be started and
1933 later options will have to be ignored!
1935 =item B<LoadPlugin> I<JavaClass>
1937 Instantiates a new I<JavaClass> object. The constructor of this object very
1938 likely then registers one or more callback methods with the server.
1940 See L<collectd-java(5)> for details.
1942 When the first such option is found, the virtual machine (JVM) is created. This
1943 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
1944 B<LoadPlugin> options!
1946 =item B<Plugin> I<Name>
1948 The entire block is passed to the Java plugin as an
1949 I<org.collectd.api.OConfigItem> object.
1951 For this to work, the plugin has to register a configuration callback first,
1952 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
1953 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
1954 depends on the (Java) plugin registering the callback and is completely
1955 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
1959 =head2 Plugin C<libvirt>
1961 This plugin allows CPU, disk and network load to be collected for virtualized
1962 guests on the machine. This means that these characteristics can be collected
1963 for guest systems without installing any software on them - collectd only runs
1964 on the hosting system. The statistics are collected through libvirt
1965 (L<http://libvirt.org/>).
1967 Only I<Connection> is required.
1971 =item B<Connection> I<uri>
1973 Connect to the hypervisor given by I<uri>. For example if using Xen use:
1975 Connection "xen:///"
1977 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
1979 =item B<RefreshInterval> I<seconds>
1981 Refresh the list of domains and devices every I<seconds>. The default is 60
1982 seconds. Setting this to be the same or smaller than the I<Interval> will cause
1983 the list of domains and devices to be refreshed on every iteration.
1985 Refreshing the devices in particular is quite a costly operation, so if your
1986 virtualization setup is static you might consider increasing this. If this
1987 option is set to 0, refreshing is disabled completely.
1989 =item B<Domain> I<name>
1991 =item B<BlockDevice> I<name:dev>
1993 =item B<InterfaceDevice> I<name:dev>
1995 =item B<IgnoreSelected> I<true>|I<false>
1997 Select which domains and devices are collected.
1999 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
2000 disk/network devices are collected.
2002 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
2003 domains and disk/network devices are ignored, while the rest are collected.
2005 The domain name and device names may use a regular expression, if the name is
2006 surrounded by I</.../> and collectd was compiled with support for regexps.
2008 The default is to collect statistics for all domains and all their devices.
2012 BlockDevice "/:hdb/"
2013 IgnoreSelected "true"
2015 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
2018 =item B<HostnameFormat> B<name|uuid|hostname|...>
2020 When the libvirt plugin logs data, it sets the hostname of the collected data
2021 according to this setting. The default is to use the guest name as provided by
2022 the hypervisor, which is equal to setting B<name>.
2024 B<uuid> means use the guest's UUID. This is useful if you want to track the
2025 same guest across migrations.
2027 B<hostname> means to use the global B<Hostname> setting, which is probably not
2028 useful on its own because all guests will appear to have the same name.
2030 You can also specify combinations of these fields. For example B<name uuid>
2031 means to concatenate the guest name and UUID (with a literal colon character
2032 between, thus I<"foo:1234-1234-1234-1234">).
2034 =item B<InterfaceFormat> B<name>|B<address>
2036 When the libvirt plugin logs interface data, it sets the name of the collected
2037 data according to this setting. The default is to use the path as provided by
2038 the hypervisor (the "dev" property of the target node), which is equal to
2041 B<address> means use the interface's mac address. This is useful since the
2042 interface path might change between reboots of a guest or across migrations.
2046 =head2 Plugin C<logfile>
2050 =item B<LogLevel> B<debug|info|notice|warning|err>
2052 Sets the log-level. If, for example, set to B<notice>, then all events with
2053 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2055 Please note that B<debug> is only available if collectd has been compiled with
2058 =item B<File> I<File>
2060 Sets the file to write log messages to. The special strings B<stdout> and
2061 B<stderr> can be used to write to the standard output and standard error
2062 channels, respectively. This, of course, only makes much sense when I<collectd>
2063 is running in foreground- or non-daemon-mode.
2065 =item B<Timestamp> B<true>|B<false>
2067 Prefix all lines printed by the current time. Defaults to B<true>.
2069 =item B<PrintSeverity> B<true>|B<false>
2071 When enabled, all lines are prefixed by the severity of the log message, for
2072 example "warning". Defaults to B<false>.
2076 B<Note>: There is no need to notify the daemon after moving or removing the
2077 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2078 for each line it writes.
2080 =head2 Plugin C<lpar>
2082 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2083 virtualization technique for IBM POWER processors. It takes into account CPU
2084 time stolen from or donated to a partition, in addition to the usual user,
2085 system, I/O statistics.
2087 The following configuration options are available:
2091 =item B<CpuPoolStats> B<false>|B<true>
2093 When enabled, statistics about the processor pool are read, too. The partition
2094 needs to have pool authority in order to be able to acquire this information.
2097 =item B<ReportBySerial> B<false>|B<true>
2099 If enabled, the serial of the physical machine the partition is currently
2100 running on is reported as I<hostname> and the logical hostname of the machine
2101 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2102 used (just like other plugins) and the I<plugin instance> will be empty.
2107 =head2 Plugin C<mbmon>
2109 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2111 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2112 B<Host> and B<Port> options can be used to change these values, see below.
2113 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2114 timeouts may appear which may interfere with other statistics..
2116 C<mbmon> must be run with the -r option ("print TAG and Value format");
2117 Debian's F</etc/init.d/mbmon> script already does this, other people
2118 will need to ensure that this is the case.
2122 =item B<Host> I<Hostname>
2124 Hostname to connect to. Defaults to B<127.0.0.1>.
2126 =item B<Port> I<Port>
2128 TCP-Port to connect to. Defaults to B<411>.
2134 The C<md plugin> collects information from Linux Software-RAID devices (md).
2136 All reported values are of the type C<md_disks>. Reported type instances are
2137 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2138 I<missing> (physically absent) disks.
2142 =item B<Device> I<Device>
2144 Select md devices based on device name. The I<device name> is the basename of
2145 the device, i.e. the name of the block device without the leading C</dev/>.
2146 See B<IgnoreSelected> for more details.
2148 =item B<IgnoreSelected> B<true>|B<false>
2150 Invert device selection: If set to B<true>, all md devices B<except> those
2151 listed using B<Device> are collected. If B<false> (the default), only those
2152 listed are collected. If no configuration is given, the B<md> plugin will
2153 collect data from all md devices.
2157 =head2 Plugin C<memcachec>
2159 The C<memcachec plugin> connects to a memcached server, queries one or more
2160 given I<pages> and parses the returned data according to user specification.
2161 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2164 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2165 library. Please note that there is another library with a very similar name,
2166 libmemcache (notice the missing `d'), which is not applicable.
2168 Synopsis of the configuration:
2170 <Plugin "memcachec">
2171 <Page "plugin_instance">
2175 Regex "(\\d+) bytes sent"
2178 Instance "type_instance"
2183 The configuration options are:
2187 =item E<lt>B<Page> I<Name>E<gt>
2189 Each B<Page> block defines one I<page> to be queried from the memcached server.
2190 The block requires one string argument which is used as I<plugin instance>.
2192 =item B<Server> I<Address>
2194 Sets the server address to connect to when querying the page. Must be inside a
2199 When connected to the memcached server, asks for the page I<Key>.
2201 =item E<lt>B<Match>E<gt>
2203 Match blocks define which strings to look for and how matches substrings are
2204 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2208 =head2 Plugin C<memcached>
2210 The B<memcached plugin> connects to a memcached server and queries statistics
2211 about cache utilization, memory and bandwidth used.
2212 L<http://www.danga.com/memcached/>
2214 <Plugin "memcached">
2216 Host "memcache.example.com"
2221 The plugin configuration consists of one or more B<Instance> blocks which
2222 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2223 following options are allowed:
2227 =item B<Host> I<Hostname>
2229 Hostname to connect to. Defaults to B<127.0.0.1>.
2231 =item B<Port> I<Port>
2233 TCP-Port to connect to. Defaults to B<11211>.
2235 =item B<Socket> I<Path>
2237 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2238 setting is given, the B<Host> and B<Port> settings are ignored.
2242 =head2 Plugin C<mic>
2244 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2245 Intel's Many Integrated Core (MIC) systems.
2254 ShowTemperatures true
2257 IgnoreSelectedTemperature true
2260 The following options are valid inside the B<PluginE<nbsp>mic> block:
2264 =item B<ShowCPU> B<true>|B<false>
2266 If enabled (the default) a sum of the CPU usage accross all cores is reported.
2268 =item B<ShowCPUCores> B<true>|B<false>
2270 If enabled (the default) per-core CPU usage is reported.
2272 =item B<ShowMemory> B<true>|B<false>
2274 If enabled (the default) the physical memory usage of the MIC system is
2277 =item B<ShowTemperatures> B<true>|B<false>
2279 If enabled (the default) various temperatures of the MIC system are reported.
2281 =item B<Temperature> I<Name>
2283 This option controls which temperatures are being reported. Whether matching
2284 temperatures are being ignored or I<only> matching temperatures are reported
2285 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2286 temperatures are reported.
2288 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2290 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2291 (the default) only temperatures matching a B<Temperature> option are reported
2292 or, if no B<Temperature> option is specified, all temperatures are reported. If
2293 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2296 Known temperature names are:
2318 =head2 Plugin C<modbus>
2320 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
2321 register values. It supports reading single registers (unsigned 16E<nbsp>bit
2322 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2323 values (two registers interpreted as IEEE floats in big endian notation).
2327 <Data "voltage-input-1">
2334 <Data "voltage-input-2">
2341 <Host "modbus.example.com">
2342 Address "192.168.0.42"
2347 Instance "power-supply"
2348 Collect "voltage-input-1"
2349 Collect "voltage-input-2"
2355 =item E<lt>B<Data> I<Name>E<gt> blocks
2357 Data blocks define a mapping between register numbers and the "types" used by
2360 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
2364 =item B<RegisterBase> I<Number>
2366 Configures the base register to read from the device. If the option
2367 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
2368 register will be read (the register number is increased by one).
2370 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
2372 Specifies what kind of data is returned by the device. If the type is B<Int32>,
2373 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
2374 combined into one value. Defaults to B<Uint16>.
2376 =item B<Type> I<Type>
2378 Specifies the "type" (data set) to use when dispatching the value to
2379 I<collectd>. Currently, only data sets with exactly one data source are
2382 =item B<Instance> I<Instance>
2384 Sets the type instance to use when dispatching the value to I<collectd>. If
2385 unset, an empty string (no type instance) is used.
2389 =item E<lt>B<Host> I<Name>E<gt> blocks
2391 Host blocks are used to specify to which hosts to connect and what data to read
2392 from their "slaves". The string argument I<Name> is used as hostname when
2393 dispatching the values to I<collectd>.
2395 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
2399 =item B<Address> I<Hostname>
2401 Specifies the node name (the actual network address) used to connect to the
2402 host. This may be an IP address or a hostname. Please note that the used
2403 I<libmodbus> library only supports IPv4 at the moment.
2405 =item B<Port> I<Service>
2407 Specifies the port used to connect to the host. The port can either be given as
2408 a number or as a service name. Please note that the I<Service> argument must be
2409 a string, even if ports are given in their numerical form. Defaults to "502".
2411 =item B<Interval> I<Interval>
2413 Sets the interval (in seconds) in which the values will be collected from this
2414 host. By default the global B<Interval> setting will be used.
2416 =item E<lt>B<Slave> I<ID>E<gt>
2418 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
2419 is used to specify which device should be addressed. For each device you want
2420 to query, one B<Slave> block must be given.
2422 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
2426 =item B<Instance> I<Instance>
2428 Specify the plugin instance to use when dispatching the values to I<collectd>.
2429 By default "slave_I<ID>" is used.
2431 =item B<Collect> I<DataName>
2433 Specifies which data to retrieve from the device. I<DataName> must be the same
2434 string as the I<Name> argument passed to a B<Data> block. You can specify this
2435 option multiple times to collect more than one value from a slave. At least one
2436 B<Collect> option is mandatory.
2444 =head2 Plugin C<mysql>
2446 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
2447 one or more databases when started and keeps the connection up as long as
2448 possible. When the connection is interrupted for whatever reason it will try
2449 to re-connect. The plugin will complain loudly in case anything goes wrong.
2451 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
2452 and collects information about MySQL network traffic, executed statements,
2453 requests, the query cache and threads by evaluating the
2454 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
2455 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
2456 Status Variables> for an explanation of these values.
2458 Optionally, master and slave statistics may be collected in a MySQL
2459 replication setup. In that case, information about the synchronization state
2460 of the nodes are collected by evaluating the C<Position> return value of the
2461 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
2462 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
2463 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
2464 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
2465 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
2480 Socket "/var/run/mysql/mysqld.sock"
2482 SlaveNotifications true
2486 A B<Database> block defines one connection to a MySQL database. It accepts a
2487 single argument which specifies the name of the database. None of the other
2488 options are required. MySQL will use default values as documented in the
2489 section "mysql_real_connect()" in the B<MySQL reference manual>.
2493 =item B<Host> I<Hostname>
2495 Hostname of the database server. Defaults to B<localhost>.
2497 =item B<User> I<Username>
2499 Username to use when connecting to the database. The user does not have to be
2500 granted any privileges (which is synonym to granting the C<USAGE> privilege),
2501 unless you want to collectd replication statistics (see B<MasterStats> and
2502 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
2503 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
2505 =item B<Password> I<Password>
2507 Password needed to log into the database.
2509 =item B<Database> I<Database>
2511 Select this database. Defaults to I<no database> which is a perfectly reasonable
2512 option for what this plugin does.
2514 =item B<Port> I<Port>
2516 TCP-port to connect to. The port must be specified in its numeric form, but it
2517 must be passed as a string nonetheless. For example:
2521 If B<Host> is set to B<localhost> (the default), this setting has no effect.
2522 See the documentation for the C<mysql_real_connect> function for details.
2524 =item B<Socket> I<Socket>
2526 Specifies the path to the UNIX domain socket of the MySQL server. This option
2527 only has any effect, if B<Host> is set to B<localhost> (the default).
2528 Otherwise, use the B<Port> option above. See the documentation for the
2529 C<mysql_real_connect> function for details.
2531 =item B<MasterStats> I<true|false>
2533 =item B<SlaveStats> I<true|false>
2535 Enable the collection of master / slave statistics in a replication setup. In
2536 order to be able to get access to these statistics, the user needs special
2537 privileges. See the B<User> documentation above.
2539 =item B<SlaveNotifications> I<true|false>
2541 If enabled, the plugin sends a notification if the replication slave I/O and /
2542 or SQL threads are not running.
2546 =head2 Plugin C<netapp>
2548 The netapp plugin can collect various performance and capacity information
2549 from a NetApp filer using the NetApp API.
2551 Please note that NetApp has a wide line of products and a lot of different
2552 software versions for each of these products. This plugin was developed for a
2553 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
2554 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
2555 model and software version but it is very hard to test this.
2556 If you have used this plugin with other models and/or software version, feel
2557 free to send us a mail to tell us about the results, even if it's just a short
2560 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
2561 basic authentication.
2563 B<Do not use a regular user for this!> Create a special collectd user with just
2564 the minimum of capabilities needed. The user only needs the "login-http-admin"
2565 capability as well as a few more depending on which data will be collected.
2566 Required capabilities are documented below.
2571 <Host "netapp1.example.com">
2595 IgnoreSelectedIO false
2597 IgnoreSelectedOps false
2598 GetLatency "volume0"
2599 IgnoreSelectedLatency false
2606 IgnoreSelectedCapacity false
2609 IgnoreSelectedSnapshot false
2637 The netapp plugin accepts the following configuration options:
2641 =item B<Host> I<Name>
2643 A host block defines one NetApp filer. It will appear in collectd with the name
2644 you specify here which does not have to be its real name nor its hostname (see
2645 the B<Address> option below).
2647 =item B<VFiler> I<Name>
2649 A B<VFiler> block may only be used inside a host block. It accepts all the
2650 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
2651 will execute all NetApp API commands in the context of the specified
2652 VFiler(R). It will appear in collectd with the name you specify here which
2653 does not have to be its real name. The VFiler name may be specified using the
2654 B<VFilerName> option. If this is not specified, it will default to the name
2657 The VFiler block inherits all connection related settings from the surrounding
2658 B<Host> block (which appear before the B<VFiler> block) but they may be
2659 overwritten inside the B<VFiler> block.
2661 This feature is useful, for example, when using a VFiler as SnapVault target
2662 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
2663 available in the host filer (vfiler0) but only in the respective VFiler
2666 =item B<Protocol> B<httpd>|B<http>
2668 The protocol collectd will use to query this host.
2676 Valid options: http, https
2678 =item B<Address> I<Address>
2680 The hostname or IP address of the host.
2686 Default: The "host" block's name.
2688 =item B<Port> I<Port>
2690 The TCP port to connect to on the host.
2696 Default: 80 for protocol "http", 443 for protocol "https"
2698 =item B<User> I<User>
2700 =item B<Password> I<Password>
2702 The username and password to use to login to the NetApp.
2708 =item B<VFilerName> I<Name>
2710 The name of the VFiler in which context to execute API commands. If not
2711 specified, the name provided to the B<VFiler> block will be used instead.
2717 Default: name of the B<VFiler> block
2719 B<Note:> This option may only be used inside B<VFiler> blocks.
2721 =item B<Interval> I<Interval>
2727 The following options decide what kind of data will be collected. You can
2728 either use them as a block and fine tune various parameters inside this block,
2729 use them as a single statement to just accept all default values, or omit it to
2730 not collect any data.
2732 The following options are valid inside all blocks:
2736 =item B<Interval> I<Seconds>
2738 Collect the respective statistics every I<Seconds> seconds. Defaults to the
2739 host specific setting.
2743 =head3 The System block
2745 This will collect various performance data about the whole system.
2747 B<Note:> To get this data the collectd user needs the
2748 "api-perf-object-get-instances" capability.
2752 =item B<Interval> I<Seconds>
2754 Collect disk statistics every I<Seconds> seconds.
2756 =item B<GetCPULoad> B<true>|B<false>
2758 If you set this option to true the current CPU usage will be read. This will be
2759 the average usage between all CPUs in your NetApp without any information about
2762 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2763 returns in the "CPU" field.
2771 Result: Two value lists of type "cpu", and type instances "idle" and "system".
2773 =item B<GetInterfaces> B<true>|B<false>
2775 If you set this option to true the current traffic of the network interfaces
2776 will be read. This will be the total traffic over all interfaces of your NetApp
2777 without any information about individual interfaces.
2779 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2780 in the "Net kB/s" field.
2790 Result: One value list of type "if_octects".
2792 =item B<GetDiskIO> B<true>|B<false>
2794 If you set this option to true the current IO throughput will be read. This
2795 will be the total IO of your NetApp without any information about individual
2796 disks, volumes or aggregates.
2798 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2799 in the "DiskE<nbsp>kB/s" field.
2807 Result: One value list of type "disk_octets".
2809 =item B<GetDiskOps> B<true>|B<false>
2811 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
2812 iSCSI, etc. operations will be read. This will be the total number of
2813 operations on your NetApp without any information about individual volumes or
2816 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2817 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
2825 Result: A variable number of value lists of type "disk_ops_complex". Each type
2826 of operation will result in one value list with the name of the operation as
2831 =head3 The WAFL block
2833 This will collect various performance data about the WAFL file system. At the
2834 moment this just means cache performance.
2836 B<Note:> To get this data the collectd user needs the
2837 "api-perf-object-get-instances" capability.
2839 B<Note:> The interface to get these values is classified as "Diagnostics" by
2840 NetApp. This means that it is not guaranteed to be stable even between minor
2845 =item B<Interval> I<Seconds>
2847 Collect disk statistics every I<Seconds> seconds.
2849 =item B<GetNameCache> B<true>|B<false>
2857 Result: One value list of type "cache_ratio" and type instance
2860 =item B<GetDirCache> B<true>|B<false>
2868 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
2870 =item B<GetInodeCache> B<true>|B<false>
2878 Result: One value list of type "cache_ratio" and type instance
2881 =item B<GetBufferCache> B<true>|B<false>
2883 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
2884 in the "Cache hit" field.
2892 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
2896 =head3 The Disks block
2898 This will collect performance data about the individual disks in the NetApp.
2900 B<Note:> To get this data the collectd user needs the
2901 "api-perf-object-get-instances" capability.
2905 =item B<Interval> I<Seconds>
2907 Collect disk statistics every I<Seconds> seconds.
2909 =item B<GetBusy> B<true>|B<false>
2911 If you set this option to true the busy time of all disks will be calculated
2912 and the value of the busiest disk in the system will be written.
2914 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2915 in the "Disk util" field. Probably.
2923 Result: One value list of type "percent" and type instance "disk_busy".
2927 =head3 The VolumePerf block
2929 This will collect various performance data about the individual volumes.
2931 You can select which data to collect about which volume using the following
2932 options. They follow the standard ignorelist semantic.
2934 B<Note:> To get this data the collectd user needs the
2935 I<api-perf-object-get-instances> capability.
2939 =item B<Interval> I<Seconds>
2941 Collect volume performance data every I<Seconds> seconds.
2943 =item B<GetIO> I<Volume>
2945 =item B<GetOps> I<Volume>
2947 =item B<GetLatency> I<Volume>
2949 Select the given volume for IO, operations or latency statistics collection.
2950 The argument is the name of the volume without the C</vol/> prefix.
2952 Since the standard ignorelist functionality is used here, you can use a string
2953 starting and ending with a slash to specify regular expression matching: To
2954 match the volumes "vol0", "vol2" and "vol7", you can use this regular
2957 GetIO "/^vol[027]$/"
2959 If no regular expression is specified, an exact match is required. Both,
2960 regular and exact matching are case sensitive.
2962 If no volume was specified at all for either of the three options, that data
2963 will be collected for all available volumes.
2965 =item B<IgnoreSelectedIO> B<true>|B<false>
2967 =item B<IgnoreSelectedOps> B<true>|B<false>
2969 =item B<IgnoreSelectedLatency> B<true>|B<false>
2971 When set to B<true>, the volumes selected for IO, operations or latency
2972 statistics collection will be ignored and the data will be collected for all
2975 When set to B<false>, data will only be collected for the specified volumes and
2976 all other volumes will be ignored.
2978 If no volumes have been specified with the above B<Get*> options, all volumes
2979 will be collected regardless of the B<IgnoreSelected*> option.
2981 Defaults to B<false>
2985 =head3 The VolumeUsage block
2987 This will collect capacity data about the individual volumes.
2989 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
2994 =item B<Interval> I<Seconds>
2996 Collect volume usage statistics every I<Seconds> seconds.
2998 =item B<GetCapacity> I<VolumeName>
3000 The current capacity of the volume will be collected. This will result in two
3001 to four value lists, depending on the configuration of the volume. All data
3002 sources are of type "df_complex" with the name of the volume as
3005 There will be type_instances "used" and "free" for the number of used and
3006 available bytes on the volume. If the volume has some space reserved for
3007 snapshots, a type_instance "snap_reserved" will be available. If the volume
3008 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3009 number of bytes saved by the SIS feature.
3011 B<Note:> The current NetApp API has a bug that results in this value being
3012 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3013 number which works most of the time. If you see strange values here, bug
3014 NetApp support to fix this.
3016 Repeat this option to specify multiple volumes.
3018 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3020 Specify whether to collect only the volumes selected by the B<GetCapacity>
3021 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3022 B<false>. However, if no B<GetCapacity> option is specified at all, all
3023 capacities will be selected anyway.
3025 =item B<GetSnapshot> I<VolumeName>
3027 Select volumes from which to collect snapshot information.
3029 Usually, the space used for snapshots is included in the space reported as
3030 "used". If snapshot information is collected as well, the space used for
3031 snapshots is subtracted from the used space.
3033 To make things even more interesting, it is possible to reserve space to be
3034 used for snapshots. If the space required for snapshots is less than that
3035 reserved space, there is "reserved free" and "reserved used" space in addition
3036 to "free" and "used". If the space required for snapshots exceeds the reserved
3037 space, that part allocated in the normal space is subtracted from the "used"
3040 Repeat this option to specify multiple volumes.
3042 =item B<IgnoreSelectedSnapshot>
3044 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3045 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3046 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3047 capacities will be selected anyway.
3051 =head3 The Quota block
3053 This will collect (tree) quota statistics (used disk space and number of used
3054 files). This mechanism is useful to get usage information for single qtrees.
3055 In case the quotas are not used for any other purpose, an entry similar to the
3056 following in C</etc/quotas> would be sufficient:
3058 /vol/volA/some_qtree tree - - - - -
3060 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3064 =item B<Interval> I<Seconds>
3066 Collect SnapVault(R) statistics every I<Seconds> seconds.
3070 =head3 The SnapVault block
3072 This will collect statistics about the time and traffic of SnapVault(R)
3077 =item B<Interval> I<Seconds>
3079 Collect SnapVault(R) statistics every I<Seconds> seconds.
3083 =head2 Plugin C<netlink>
3085 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3086 statistics of various interface and routing aspects.
3090 =item B<Interface> I<Interface>
3092 =item B<VerboseInterface> I<Interface>
3094 Instruct the plugin to collect interface statistics. This is basically the same
3095 as the statistics provided by the C<interface> plugin (see above) but
3096 potentially much more detailed.
3098 When configuring with B<Interface> only the basic statistics will be collected,
3099 namely octets, packets, and errors. These statistics are collected by
3100 the C<interface> plugin, too, so using both at the same time is no benefit.
3102 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3103 so that no data needs to be collected twice if you use the C<interface> plugin.
3104 This includes dropped packets, received multicast packets, collisions and a
3105 whole zoo of differentiated RX and TX errors. You can try the following command
3106 to get an idea of what awaits you:
3110 If I<Interface> is B<All>, all interfaces will be selected.
3112 =item B<QDisc> I<Interface> [I<QDisc>]
3114 =item B<Class> I<Interface> [I<Class>]
3116 =item B<Filter> I<Interface> [I<Filter>]
3118 Collect the octets and packets that pass a certain qdisc, class or filter.
3120 QDiscs and classes are identified by their type and handle (or classid).
3121 Filters don't necessarily have a handle, therefore the parent's handle is used.
3122 The notation used in collectd differs from that used in tc(1) in that it
3123 doesn't skip the major or minor number if it's zero and doesn't print special
3124 ids by their name. So, for example, a qdisc may be identified by
3125 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3126 thus not displayed by tc(1).
3128 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3129 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3130 associated with that interface will be collected.
3132 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3133 used. This may lead to problems when more than one filter is attached to a
3134 qdisc or class. This isn't nice, but we don't know how this could be done any
3135 better. If you have a idea, please don't hesitate to tell us.
3137 As with the B<Interface> option you can specify B<All> as the interface,
3138 meaning all interfaces.
3140 Here are some examples to help you understand the above text more easily:
3143 VerboseInterface "All"
3144 QDisc "eth0" "pfifo_fast-1:0"
3146 Class "ppp0" "htb-1:10"
3147 Filter "ppp0" "u32-1:0"
3150 =item B<IgnoreSelected>
3152 The behavior is the same as with all other similar plugins: If nothing is
3153 selected at all, everything is collected. If some things are selected using the
3154 options described above, only these statistics are collected. If you set
3155 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3156 specified statistics will not be collected.
3160 =head2 Plugin C<network>
3162 The Network plugin sends data to a remote instance of collectd, receives data
3163 from a remote instance, or both at the same time. Data which has been received
3164 from the network is usually not transmitted again, but this can be activated, see
3165 the B<Forward> option below.
3167 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3168 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3170 Both, B<Server> and B<Listen> can be used as single option or as block. When
3171 used as block, given options are valid for this socket only. The following
3172 example will export the metrics twice: Once to an "internal" server (without
3173 encryption and signing) and one to an external server (with cryptographic
3177 # Export to an internal server
3178 # (demonstrates usage without additional options)
3179 Server "collectd.internal.tld"
3181 # Export to an external server
3182 # (demonstrates usage with signature options)
3183 <Server "collectd.external.tld">
3184 SecurityLevel "sign"
3185 Username "myhostname"
3192 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3194 The B<Server> statement/block sets the server to send datagrams to. The
3195 statement may occur multiple times to send each datagram to multiple
3198 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3199 optional second argument specifies a port number or a service name. If not
3200 given, the default, B<25826>, is used.
3202 The following options are recognized within B<Server> blocks:
3206 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3208 Set the security you require for network communication. When the security level
3209 has been set to B<Encrypt>, data sent over the network will be encrypted using
3210 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3211 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3212 authentication code. When set to B<None>, data is sent without any security.
3214 This feature is only available if the I<network> plugin was linked with
3217 =item B<Username> I<Username>
3219 Sets the username to transmit. This is used by the server to lookup the
3220 password. See B<AuthFile> below. All security levels except B<None> require
3223 This feature is only available if the I<network> plugin was linked with
3226 =item B<Password> I<Password>
3228 Sets a password (shared secret) for this socket. All security levels except
3229 B<None> require this setting.
3231 This feature is only available if the I<network> plugin was linked with
3234 =item B<Interface> I<Interface name>
3236 Set the outgoing interface for IP packets. This applies at least
3237 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3238 undefined or a non-existent interface name is specified, the default
3239 behavior is to let the kernel choose the appropriate interface. Be warned
3240 that the manual selection of an interface for unicast traffic is only
3241 necessary in rare cases.
3245 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
3247 The B<Listen> statement sets the interfaces to bind to. When multiple
3248 statements are found the daemon will bind to multiple interfaces.
3250 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
3251 the argument is a multicast address the daemon will join that multicast group.
3252 The optional second argument specifies a port number or a service name. If not
3253 given, the default, B<25826>, is used.
3255 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
3259 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3261 Set the security you require for network communication. When the security level
3262 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
3263 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
3264 signed and encrypted data is accepted. When set to B<None>, all data will be
3265 accepted. If an B<AuthFile> option was given (see below), encrypted data is
3266 decrypted if possible.
3268 This feature is only available if the I<network> plugin was linked with
3271 =item B<AuthFile> I<Filename>
3273 Sets a file in which usernames are mapped to passwords. These passwords are
3274 used to verify signatures and to decrypt encrypted network packets. If
3275 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
3276 verified and encrypted packets are decrypted. Otherwise, signed data is
3277 accepted without checking the signature and encrypted data cannot be decrypted.
3278 For the other security levels this option is mandatory.
3280 The file format is very simple: Each line consists of a username followed by a
3281 colon and any number of spaces followed by the password. To demonstrate, an
3282 example file could look like this:
3287 Each time a packet is received, the modification time of the file is checked
3288 using L<stat(2)>. If the file has been changed, the contents is re-read. While
3289 the file is being read, it is locked using L<fcntl(2)>.
3291 =item B<Interface> I<Interface name>
3293 Set the incoming interface for IP packets explicitly. This applies at least
3294 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3295 undefined or a non-existent interface name is specified, the default
3296 behavior is, to let the kernel choose the appropriate interface. Thus incoming
3297 traffic gets only accepted, if it arrives on the given interface.
3301 =item B<TimeToLive> I<1-255>
3303 Set the time-to-live of sent packets. This applies to all, unicast and
3304 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
3305 That means that multicast packets will be sent with a TTL of C<1> (one) on most
3308 =item B<MaxPacketSize> I<1024-65535>
3310 Set the maximum size for datagrams received over the network. Packets larger
3311 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
3312 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
3315 On the server side, this limit should be set to the largest value used on
3316 I<any> client. Likewise, the value on the client must not be larger than the
3317 value on the server, or data will be lost.
3319 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
3320 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
3321 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
3324 =item B<Forward> I<true|false>
3326 If set to I<true>, write packets that were received via the network plugin to
3327 the sending sockets. This should only be activated when the B<Listen>- and
3328 B<Server>-statements differ. Otherwise packets may be send multiple times to
3329 the same multicast group. While this results in more network traffic than
3330 necessary it's not a huge problem since the plugin has a duplicate detection,
3331 so the values will not loop.
3333 =item B<ReportStats> B<true>|B<false>
3335 The network plugin cannot only receive and send statistics, it can also create
3336 statistics about itself. Collected data included the number of received and
3337 sent octets and packets, the length of the receive queue and the number of
3338 values handled. When set to B<true>, the I<Network plugin> will make these
3339 statistics available. Defaults to B<false>.
3343 =head2 Plugin C<nginx>
3345 This plugin collects the number of connections and requests handled by the
3346 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
3347 queries the page provided by the C<ngx_http_stub_status_module> module, which
3348 isn't compiled by default. Please refer to
3349 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
3350 how to compile and configure nginx and this module.
3352 The following options are accepted by the C<nginx plugin>:
3356 =item B<URL> I<http://host/nginx_status>
3358 Sets the URL of the C<ngx_http_stub_status_module> output.
3360 =item B<User> I<Username>
3362 Optional user name needed for authentication.
3364 =item B<Password> I<Password>
3366 Optional password needed for authentication.
3368 =item B<VerifyPeer> B<true|false>
3370 Enable or disable peer SSL certificate verification. See
3371 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
3373 =item B<VerifyHost> B<true|false>
3375 Enable or disable peer host name verification. If enabled, the plugin checks
3376 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
3377 certificate matches the host name provided by the B<URL> option. If this
3378 identity check fails, the connection is aborted. Obviously, only works when
3379 connecting to a SSL enabled server. Enabled by default.
3381 =item B<CACert> I<File>
3383 File that holds one or more SSL certificates. If you want to use HTTPS you will
3384 possibly need this option. What CA certificates come bundled with C<libcurl>
3385 and are checked by default depends on the distribution you use.
3389 =head2 Plugin C<notify_desktop>
3391 This plugin sends a desktop notification to a notification daemon, as defined
3392 in the Desktop Notification Specification. To actually display the
3393 notifications, B<notification-daemon> is required and B<collectd> has to be
3394 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
3395 environment variables have to be set correctly) and the D-Bus message bus.
3397 The Desktop Notification Specification can be found at
3398 L<http://www.galago-project.org/specs/notification/>.
3402 =item B<OkayTimeout> I<timeout>
3404 =item B<WarningTimeout> I<timeout>
3406 =item B<FailureTimeout> I<timeout>
3408 Set the I<timeout>, in milliseconds, after which to expire the notification
3409 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
3410 been specified, the displayed notification will not be closed at all - the
3411 user has to do so herself. These options default to 5000. If a negative number
3412 has been specified, the default is used as well.
3416 =head2 Plugin C<notify_email>
3418 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
3419 configured email address.
3421 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
3423 Available configuration options:
3427 =item B<From> I<Address>
3429 Email address from which the emails should appear to come from.
3431 Default: C<root@localhost>
3433 =item B<Recipient> I<Address>
3435 Configures the email address(es) to which the notifications should be mailed.
3436 May be repeated to send notifications to multiple addresses.
3438 At least one B<Recipient> must be present for the plugin to work correctly.
3440 =item B<SMTPServer> I<Hostname>
3442 Hostname of the SMTP server to connect to.
3444 Default: C<localhost>
3446 =item B<SMTPPort> I<Port>
3448 TCP port to connect to.
3452 =item B<SMTPUser> I<Username>
3454 Username for ASMTP authentication. Optional.
3456 =item B<SMTPPassword> I<Password>
3458 Password for ASMTP authentication. Optional.
3460 =item B<Subject> I<Subject>
3462 Subject-template to use when sending emails. There must be exactly two
3463 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
3464 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
3467 Default: C<Collectd notify: %s@%s>
3471 =head2 Plugin C<ntpd>
3475 =item B<Host> I<Hostname>
3477 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
3479 =item B<Port> I<Port>
3481 UDP-Port to connect to. Defaults to B<123>.
3483 =item B<ReverseLookups> B<true>|B<false>
3485 Sets whether or not to perform reverse lookups on peers. Since the name or
3486 IP-address may be used in a filename it is recommended to disable reverse
3487 lookups. The default is to do reverse lookups to preserve backwards
3488 compatibility, though.
3490 =item B<IncludeUnitID> B<true>|B<false>
3492 When a peer is a refclock, include the unit ID in the I<type instance>.
3493 Defaults to B<false> for backward compatibility.
3495 If two refclock peers use the same driver and this is B<false>, the plugin will
3496 try to write simultaneous measurements from both to the same type instance.
3497 This will result in error messages in the log and only one set of measurements
3502 =head2 Plugin C<nut>
3506 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
3508 Add a UPS to collect data from. The format is identical to the one accepted by
3513 =head2 Plugin C<olsrd>
3515 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
3516 the Optimized Link State Routing daemon and reads information about the current
3517 state of the meshed network.
3519 The following configuration options are understood:
3523 =item B<Host> I<Host>
3525 Connect to I<Host>. Defaults to B<"localhost">.
3527 =item B<Port> I<Port>
3529 Specifies the port to connect to. This must be a string, even if you give the
3530 port as a number rather than a service name. Defaults to B<"2006">.
3532 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
3534 Specifies what information to collect about links, i.E<nbsp>e. direct
3535 connections of the daemon queried. If set to B<No>, no information is
3536 collected. If set to B<Summary>, the number of links and the average of all
3537 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
3538 If set to B<Detail> LQ and NLQ are collected per link.
3540 Defaults to B<Detail>.
3542 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
3544 Specifies what information to collect about routes of the daemon queried. If
3545 set to B<No>, no information is collected. If set to B<Summary>, the number of
3546 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
3547 metric and ETX are collected per route.
3549 Defaults to B<Summary>.
3551 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
3553 Specifies what information to collect about the global topology. If set to
3554 B<No>, no information is collected. If set to B<Summary>, the number of links
3555 in the entire topology and the average I<link quality> (LQ) is calculated.
3556 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
3558 Defaults to B<Summary>.
3562 =head2 Plugin C<onewire>
3564 B<EXPERIMENTAL!> See notes below.
3566 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
3567 L<http://owfs.org/> to read sensors connected via the onewire bus.
3569 Currently only temperature sensors (sensors with the family code C<10>,
3570 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
3571 would like to have included, please send a sort request to the mailing list.
3573 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
3574 experimental, below.
3578 =item B<Device> I<Device>
3580 Sets the device to read the values from. This can either be a "real" hardware
3581 device, such as a serial port or an USB port, or the address of the
3582 L<owserver(1)> socket, usually B<localhost:4304>.
3584 Though the documentation claims to automatically recognize the given address
3585 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
3586 with that version, the following configuration worked for us:
3589 Device "-s localhost:4304"
3592 This directive is B<required> and does not have a default value.
3594 =item B<Sensor> I<Sensor>
3596 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
3597 below. Sensors are specified without the family byte at the beginning, to you'd
3598 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
3601 =item B<IgnoreSelected> I<true>|I<false>
3603 If no configuration if given, the B<onewire> plugin will collect data from all
3604 sensors found. This may not be practical, especially if sensors are added and
3605 removed regularly. Sometimes, however, it's easier/preferred to collect only
3606 specific sensors or all sensors I<except> a few specified ones. This option
3607 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
3608 B<Sensor> is inverted: All selected interfaces are ignored and all other
3609 interfaces are collected.
3611 =item B<Interval> I<Seconds>
3613 Sets the interval in which all sensors should be read. If not specified, the
3614 global B<Interval> setting is used.
3618 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
3619 work with big setups. It works with one sensor being attached to one
3620 controller, but as soon as you throw in a couple more senors and maybe a hub
3621 or two, reading all values will take more than ten seconds (the default
3622 interval). We will probably add some separate thread for reading the sensors
3623 and some cache or something like that, but it's not done yet. We will try to
3624 maintain backwards compatibility in the future, but we can't promise. So in
3625 short: If it works for you: Great! But keep in mind that the config I<might>
3626 change, though this is unlikely. Oh, and if you want to help improving this
3627 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
3629 =head2 Plugin C<openvpn>
3631 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
3632 traffic statistics about connected clients.
3634 To set up OpenVPN to write to the status file periodically, use the
3635 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
3636 you need to set the required format, too. This is done by setting
3637 B<--status-version> to B<2>.
3639 So, in a nutshell you need:
3641 openvpn $OTHER_OPTIONS \
3642 --status "/var/run/openvpn-status" 10 \
3649 =item B<StatusFile> I<File>
3651 Specifies the location of the status file.
3653 =item B<ImprovedNamingSchema> B<true>|B<false>
3655 When enabled, the filename of the status file will be used as plugin instance
3656 and the client's "common name" will be used as type instance. This is required
3657 when reading multiple status files. Enabling this option is recommended, but to
3658 maintain backwards compatibility this option is disabled by default.
3660 =item B<CollectCompression> B<true>|B<false>
3662 Sets whether or not statistics about the compression used by OpenVPN should be
3663 collected. This information is only available in I<single> mode. Enabled by
3666 =item B<CollectIndividualUsers> B<true>|B<false>
3668 Sets whether or not traffic information is collected for each connected client
3669 individually. If set to false, currently no traffic data is collected at all
3670 because aggregating this data in a save manner is tricky. Defaults to B<true>.
3672 =item B<CollectUserCount> B<true>|B<false>
3674 When enabled, the number of currently connected clients or users is collected.
3675 This is especially interesting when B<CollectIndividualUsers> is disabled, but
3676 can be configured independently from that option. Defaults to B<false>.
3680 =head2 Plugin C<oracle>
3682 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
3683 Oracle® Database and lets you execute SQL statements there. It is very similar
3684 to the "dbi" plugin, because it was written around the same time. See the "dbi"
3685 plugin's documentation above for details.
3688 <Query "out_of_stock">
3689 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
3692 # InstancePrefix "foo"
3693 InstancesFrom "category"
3697 <Database "product_information">
3701 Query "out_of_stock"
3705 =head3 B<Query> blocks
3707 The Query blocks are handled identically to the Query blocks of the "dbi"
3708 plugin. Please see its documentation above for details on how to specify
3711 =head3 B<Database> blocks
3713 Database blocks define a connection to a database and which queries should be
3714 sent to that database. Each database needs a "name" as string argument in the
3715 starting tag of the block. This name will be used as "PluginInstance" in the
3716 values submitted to the daemon. Other than that, that name is not used.
3720 =item B<ConnectID> I<ID>
3722 Defines the "database alias" or "service name" to connect to. Usually, these
3723 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
3725 =item B<Host> I<Host>
3727 Hostname to use when dispatching values for this database. Defaults to using
3728 the global hostname of the I<collectd> instance.
3730 =item B<Username> I<Username>
3732 Username used for authentication.
3734 =item B<Password> I<Password>
3736 Password used for authentication.
3738 =item B<Query> I<QueryName>
3740 Associates the query named I<QueryName> with this database connection. The
3741 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
3742 blocks you want to refer to must be placed above the database block you want to
3747 =head2 Plugin C<perl>
3749 This plugin embeds a Perl-interpreter into collectd and provides an interface
3750 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
3752 =head2 Plugin C<pinba>
3754 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
3755 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
3756 PHP-based webpage has been delivered, the extension will send a UDP packet
3757 containing timing information, peak memory usage and so on. The plugin will
3758 wait for such packets, parse them and account the provided information, which
3759 is then dispatched to the daemon once per interval.
3766 # Overall statistics for the website.
3768 Server "www.example.com"
3770 # Statistics for www-a only
3772 Host "www-a.example.com"
3773 Server "www.example.com"
3775 # Statistics for www-b only
3777 Host "www-b.example.com"
3778 Server "www.example.com"
3782 The plugin provides the following configuration options:
3786 =item B<Address> I<Node>
3788 Configures the address used to open a listening socket. By default, plugin will
3789 bind to the I<any> address C<::0>.
3791 =item B<Port> I<Service>
3793 Configures the port (service) to bind to. By default the default Pinba port
3794 "30002" will be used. The option accepts service names in addition to port
3795 numbers and thus requires a I<string> argument.
3797 =item E<lt>B<View> I<Name>E<gt> block
3799 The packets sent by the Pinba extension include the hostname of the server, the
3800 server name (the name of the virtual host) and the script that was executed.
3801 Using B<View> blocks it is possible to separate the data into multiple groups
3802 to get more meaningful statistics. Each packet is added to all matching groups,
3803 so that a packet may be accounted for more than once.
3807 =item B<Host> I<Host>
3809 Matches the hostname of the system the webserver / script is running on. This
3810 will contain the result of the L<gethostname(2)> system call. If not
3811 configured, all hostnames will be accepted.
3813 =item B<Server> I<Server>
3815 Matches the name of the I<virtual host>, i.e. the contents of the
3816 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
3817 server names will be accepted.
3819 =item B<Script> I<Script>
3821 Matches the name of the I<script name>, i.e. the contents of the
3822 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
3823 script names will be accepted.
3829 =head2 Plugin C<ping>
3831 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
3832 configured hosts periodically and measures the network latency. Whenever the
3833 C<read> function of the plugin is called, it submits the average latency, the
3834 standard deviation and the drop rate for each host.
3836 Available configuration options:
3840 =item B<Host> I<IP-address>
3842 Host to ping periodically. This option may be repeated several times to ping
3845 =item B<Interval> I<Seconds>
3847 Sets the interval in which to send ICMP echo packets to the configured hosts.
3848 This is B<not> the interval in which statistics are queries from the plugin but
3849 the interval in which the hosts are "pinged". Therefore, the setting here
3850 should be smaller than or equal to the global B<Interval> setting. Fractional
3851 times, such as "1.24" are allowed.
3855 =item B<Timeout> I<Seconds>
3857 Time to wait for a response from the host to which an ICMP packet had been
3858 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
3859 to be down or the packet to be dropped. This setting must be smaller than the
3860 B<Interval> setting above for the plugin to work correctly. Fractional
3861 arguments are accepted.
3865 =item B<TTL> I<0-255>
3867 Sets the Time-To-Live of generated ICMP packets.
3869 =item B<SourceAddress> I<host>
3871 Sets the source address to use. I<host> may either be a numerical network
3872 address or a network hostname.
3874 =item B<Device> I<name>
3876 Sets the outgoing network device to be used. I<name> has to specify an
3877 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
3880 =item B<MaxMissed> I<Packets>
3882 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
3883 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
3885 Default: B<-1> (disabled)
3889 =head2 Plugin C<postgresql>
3891 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
3892 keeps a persistent connection to all configured databases and tries to
3893 reconnect if the connection has been interrupted. A database is configured by
3894 specifying a B<Database> block as described below. The default statistics are
3895 collected from PostgreSQL's B<statistics collector> which thus has to be
3896 enabled for this plugin to work correctly. This should usually be the case by
3897 default. See the section "The Statistics Collector" of the B<PostgreSQL
3898 Documentation> for details.
3900 By specifying custom database queries using a B<Query> block as described
3901 below, you may collect any data that is available from some PostgreSQL
3902 database. This way, you are able to access statistics of external daemons
3903 which are available in a PostgreSQL database or use future or special
3904 statistics provided by PostgreSQL without the need to upgrade your collectd
3907 Starting with version 5.2, the C<postgresql> plugin supports writing data to
3908 PostgreSQL databases as well. This has been implemented in a generic way. You
3909 need to specify an SQL statement which will then be executed by collectd in
3910 order to write the data (see below for details). The benefit of that approach
3911 is that there is no fixed database layout. Rather, the layout may be optimized
3912 for the current setup.
3914 The B<PostgreSQL Documentation> manual can be found at
3915 L<http://www.postgresql.org/docs/manuals/>.
3919 Statement "SELECT magic FROM wizard WHERE host = $1;"
3923 InstancePrefix "magic"
3928 <Query rt36_tickets>
3929 Statement "SELECT COUNT(type) AS count, type \
3931 WHEN resolved = 'epoch' THEN 'open' \
3932 ELSE 'resolved' END AS type \
3933 FROM tickets) type \
3937 InstancePrefix "rt36_tickets"
3938 InstancesFrom "type"
3944 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
3954 KRBSrvName "kerberos_service_name"
3960 Service "service_name"
3961 Query backend # predefined
3972 The B<Query> block defines one database query which may later be used by a
3973 database definition. It accepts a single mandatory argument which specifies
3974 the name of the query. The names of all queries have to be unique (see the
3975 B<MinVersion> and B<MaxVersion> options below for an exception to this
3976 rule). The following configuration options are available to define the query:
3978 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
3979 blocks define how to handle the values returned from the query. They define
3980 which column holds which value and how to dispatch that value to the daemon.
3981 Multiple B<Result> blocks may be used to extract multiple values from a single
3986 =item B<Statement> I<sql query statement>
3988 Specify the I<sql query statement> which the plugin should execute. The string
3989 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
3990 first, second, etc. parameter. The value of the parameters is specified by the
3991 B<Param> configuration option - see below for details. To include a literal
3992 B<$> character followed by a number, surround it with single quotes (B<'>).
3994 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
3995 allowed. Note, however, that only a single command may be used. Semicolons are
3996 allowed as long as a single non-empty command has been specified only.
3998 The returned lines will be handled separately one after another.
4000 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4002 Specify the parameters which should be passed to the SQL query. The parameters
4003 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4004 they appear in the configuration file. The value of the parameter is
4005 determined depending on the value of the B<Param> option as follows:
4011 The configured hostname of the database connection. If a UNIX domain socket is
4012 used, the parameter expands to "localhost".
4016 The name of the database of the current connection.
4020 The name of the database plugin instance. See the B<Instance> option of the
4021 database specification below for details.
4025 The username used to connect to the database.
4029 The interval with which this database is queried (as specified by the database
4030 specific or global B<Interval> options).
4034 Please note that parameters are only supported by PostgreSQL's protocol
4035 version 3 and above which was introduced in version 7.4 of PostgreSQL.
4037 =item B<Type> I<type>
4039 The I<type> name to be used when dispatching the values. The type describes
4040 how to handle the data and where to store it. See L<types.db(5)> for more
4041 details on types and their configuration. The number and type of values (as
4042 selected by the B<ValuesFrom> option) has to match the type of the given name.
4044 This option is required inside a B<Result> block.
4046 =item B<InstancePrefix> I<prefix>
4048 =item B<InstancesFrom> I<column0> [I<column1> ...]
4050 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
4051 B<InstancePrefix> defines a static prefix that will be prepended to all type
4052 instances. B<InstancesFrom> defines the column names whose values will be used
4053 to create the type instance. Multiple values will be joined together using the
4054 hyphen (C<->) as separation character.
4056 The plugin itself does not check whether or not all built instances are
4057 different. It is your responsibility to assure that each is unique.
4059 Both options are optional. If none is specified, the type instance will be
4062 =item B<ValuesFrom> I<column0> [I<column1> ...]
4064 Names the columns whose content is used as the actual data for the data sets
4065 that are dispatched to the daemon. How many such columns you need is
4066 determined by the B<Type> setting as explained above. If you specify too many
4067 or not enough columns, the plugin will complain about that and no data will be
4068 submitted to the daemon.
4070 The actual data type, as seen by PostgreSQL, is not that important as long as
4071 it represents numbers. The plugin will automatically cast the values to the
4072 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
4073 L<strtod(3)> functions, so anything supported by those functions is supported
4074 by the plugin as well.
4076 This option is required inside a B<Result> block and may be specified multiple
4077 times. If multiple B<ValuesFrom> options are specified, the columns are read
4080 =item B<MinVersion> I<version>
4082 =item B<MaxVersion> I<version>
4084 Specify the minimum or maximum version of PostgreSQL that this query should be
4085 used with. Some statistics might only be available with certain versions of
4086 PostgreSQL. This allows you to specify multiple queries with the same name but
4087 which apply to different versions, thus allowing you to use the same
4088 configuration in a heterogeneous environment.
4090 The I<version> has to be specified as the concatenation of the major, minor
4091 and patch-level versions, each represented as two-decimal-digit numbers. For
4092 example, version 8.2.3 will become 80203.
4096 The following predefined queries are available (the definitions can be found
4097 in the F<postgresql_default.conf> file which, by default, is available at
4098 C<I<prefix>/share/collectd/>):
4104 This query collects the number of backends, i.E<nbsp>e. the number of
4107 =item B<transactions>
4109 This query collects the numbers of committed and rolled-back transactions of
4114 This query collects the numbers of various table modifications (i.E<nbsp>e.
4115 insertions, updates, deletions) of the user tables.
4117 =item B<query_plans>
4119 This query collects the numbers of various table scans and returned tuples of
4122 =item B<table_states>
4124 This query collects the numbers of live and dead rows in the user tables.
4128 This query collects disk block access counts for user tables.
4132 This query collects the on-disk size of the database in bytes.
4136 In addition, the following detailed queries are available by default. Please
4137 note that each of those queries collects information B<by table>, thus,
4138 potentially producing B<a lot> of data. For details see the description of the
4139 non-by_table queries above.
4143 =item B<queries_by_table>
4145 =item B<query_plans_by_table>
4147 =item B<table_states_by_table>
4149 =item B<disk_io_by_table>
4153 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
4154 mandatory argument specifying the name of the writer. This will then be used
4155 in the B<Database> specification in order to activate the writer instance. The
4156 names of all writers have to be unique. The following options may be
4161 =item B<Statement> I<sql statement>
4163 This mandatory option specifies the SQL statement that will be executed for
4164 each submitted value. A single SQL statement is allowed only. Anything after
4165 the first semicolon will be ignored.
4167 Nine parameters will be passed to the statement and should be specified as
4168 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
4169 values are made available through those parameters:
4175 The timestamp of the queried value as a floating point number.
4179 The hostname of the queried value.
4183 The plugin name of the queried value.
4187 The plugin instance of the queried value. This value may be B<NULL> if there
4188 is no plugin instance.
4192 The type of the queried value (cf. L<types.db(5)>).
4196 The type instance of the queried value. This value may be B<NULL> if there is
4201 An array of names for the submitted values (i.E<nbsp>e., the name of the data
4202 sources of the submitted value-list).
4206 An array of types for the submitted values (i.E<nbsp>e., the type of the data
4207 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
4208 B<StoreRates> is enabled (which is the default, see below), all types will be
4213 An array of the submitted values. The dimensions of the value name and value
4218 In general, it is advisable to create and call a custom function in the
4219 PostgreSQL database for this purpose. Any procedural language supported by
4220 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
4223 =item B<StoreRates> B<false>|B<true>
4225 If set to B<true> (the default), convert counter values to rates. If set to
4226 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
4231 The B<Database> block defines one PostgreSQL database for which to collect
4232 statistics. It accepts a single mandatory argument which specifies the
4233 database name. None of the other options are required. PostgreSQL will use
4234 default values as documented in the section "CONNECTING TO A DATABASE" in the
4235 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
4236 the user collectd is run as and special environment variables. See the manpage
4241 =item B<Interval> I<seconds>
4243 Specify the interval with which the database should be queried. The default is
4244 to use the global B<Interval> setting.
4246 =item B<CommitInterval> I<seconds>
4248 This option may be used for database connections which have "writers" assigned
4249 (see above). If specified, it causes a writer to put several updates into a
4250 single transaction. This transaction will last for the specified amount of
4251 time. By default, each update will be executed in a separate transaction. Each
4252 transaction generates a fair amount of overhead which can, thus, be reduced by
4253 activating this option. The draw-back is, that data covering the specified
4254 amount of time will be lost, for example, if a single statement within the
4255 transaction fails or if the database server crashes.
4257 =item B<Host> I<hostname>
4259 Specify the hostname or IP of the PostgreSQL server to connect to. If the
4260 value begins with a slash, it is interpreted as the directory name in which to
4261 look for the UNIX domain socket.
4263 This option is also used to determine the hostname that is associated with a
4264 collected data set. If it has been omitted or either begins with with a slash
4265 or equals B<localhost> it will be replaced with the global hostname definition
4266 of collectd. Any other value will be passed literally to collectd when
4267 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
4269 =item B<Port> I<port>
4271 Specify the TCP port or the local UNIX domain socket file extension of the
4274 =item B<User> I<username>
4276 Specify the username to be used when connecting to the server.
4278 =item B<Password> I<password>
4280 Specify the password to be used when connecting to the server.
4282 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
4284 Specify whether to use an SSL connection when contacting the server. The
4285 following modes are supported:
4287 =item B<Instance> I<name>
4289 Specify the plugin instance name that should be used instead of the database
4290 name (which is the default, if this option has not been specified). This
4291 allows to query multiple databases of the same name on the same host (e.g.
4292 when running multiple database server versions in parallel).
4298 Do not use SSL at all.
4302 First, try to connect without using SSL. If that fails, try using SSL.
4304 =item I<prefer> (default)
4306 First, try to connect using SSL. If that fails, try without using SSL.
4314 =item B<KRBSrvName> I<kerberos_service_name>
4316 Specify the Kerberos service name to use when authenticating with Kerberos 5
4317 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
4318 B<PostgreSQL Documentation> for details.
4320 =item B<Service> I<service_name>
4322 Specify the PostgreSQL service name to use for additional parameters. That
4323 service has to be defined in F<pg_service.conf> and holds additional
4324 connection parameters. See the section "The Connection Service File" in the
4325 B<PostgreSQL Documentation> for details.
4327 =item B<Query> I<query>
4329 Specifies a I<query> which should be executed in the context of the database
4330 connection. This may be any of the predefined or user-defined queries. If no
4331 such option is given, it defaults to "backends", "transactions", "queries",
4332 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
4333 has been specified). Else, the specified queries are used only.
4335 =item B<Writer> I<writer>
4337 Assigns the specified I<writer> backend to the database connection. This
4338 causes all collected data to be send to the database using the settings
4339 defined in the writer configuration (see the section "FILTER CONFIGURATION"
4340 below for details on how to selectively send data to certain plugins).
4342 Each writer will register a flush callback which may be used when having long
4343 transactions enabled (see the B<CommitInterval> option above). When issuing
4344 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
4345 transaction will be committed right away. Two different kinds of flush
4346 callbacks are available with the C<postgresql> plugin:
4352 Flush all writer backends.
4354 =item B<postgresql->I<database>
4356 Flush all writers of the specified I<database> only.
4362 =head2 Plugin C<powerdns>
4364 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
4365 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
4366 values, many of which are probably meaningless to most users, but may be useful
4367 for some. So you may chose which values to collect, but if you don't, some
4368 reasonable defaults will be collected.
4371 <Server "server_name">
4373 Collect "udp-answers" "udp-queries"
4374 Socket "/var/run/pdns.controlsocket"
4376 <Recursor "recursor_name">
4378 Collect "cache-hits" "cache-misses"
4379 Socket "/var/run/pdns_recursor.controlsocket"
4381 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
4386 =item B<Server> and B<Recursor> block
4388 The B<Server> block defines one authoritative server to query, the B<Recursor>
4389 does the same for an recursing server. The possible options in both blocks are
4390 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
4395 =item B<Collect> I<Field>
4397 Using the B<Collect> statement you can select which values to collect. Here,
4398 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
4399 C<dlg-only-drops>, C<answers10-100>.
4401 The method of getting the values differs for B<Server> and B<Recursor> blocks:
4402 When querying the server a C<SHOW *> command is issued in any case, because
4403 that's the only way of getting multiple values out of the server at once.
4404 collectd then picks out the values you have selected. When querying the
4405 recursor, a command is generated to query exactly these values. So if you
4406 specify invalid fields when querying the recursor, a syntax error may be
4407 returned by the daemon and collectd may not collect any values at all.
4409 If no B<Collect> statement is given, the following B<Server> values will be
4416 =item packetcache-hit
4418 =item packetcache-miss
4420 =item packetcache-size
4422 =item query-cache-hit
4424 =item query-cache-miss
4426 =item recursing-answers
4428 =item recursing-questions
4440 The following B<Recursor> values will be collected by default:
4444 =item noerror-answers
4446 =item nxdomain-answers
4448 =item servfail-answers
4466 Please note that up to that point collectd doesn't know what values are
4467 available on the server and values that are added do not need a change of the
4468 mechanism so far. However, the values must be mapped to collectd's naming
4469 scheme, which is done using a lookup table that lists all known values. If
4470 values are added in the future and collectd does not know about them, you will
4471 get an error much like this:
4473 powerdns plugin: submit: Not found in lookup table: foobar = 42
4475 In this case please file a bug report with the collectd team.
4477 =item B<Socket> I<Path>
4479 Configures the path to the UNIX domain socket to be used when connecting to the
4480 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
4481 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
4482 will be used for the recursor.
4486 =item B<LocalSocket> I<Path>
4488 Querying the recursor is done using UDP. When using UDP over UNIX domain
4489 sockets, the client socket needs a name in the file system, too. You can set
4490 this local name to I<Path> using the B<LocalSocket> option. The default is
4491 C<I<prefix>/var/run/collectd-powerdns>.
4495 =head2 Plugin C<processes>
4499 =item B<Process> I<Name>
4501 Select more detailed statistics of processes matching this name. The statistics
4502 collected for these selected processes are size of the resident segment size
4503 (RSS), user- and system-time used, number of processes and number of threads,
4504 io data (where available) and minor and major pagefaults.
4506 =item B<ProcessMatch> I<name> I<regex>
4508 Similar to the B<Process> option this allows to select more detailed
4509 statistics of processes matching the specified I<regex> (see L<regex(7)> for
4510 details). The statistics of all matching processes are summed up and
4511 dispatched to the daemon using the specified I<name> as an identifier. This
4512 allows to "group" several processes together. I<name> must not contain
4517 =head2 Plugin C<protocols>
4519 Collects a lot of information about various network protocols, such as I<IP>,
4520 I<TCP>, I<UDP>, etc.
4522 Available configuration options:
4526 =item B<Value> I<Selector>
4528 Selects whether or not to select a specific value. The string being matched is
4529 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
4530 plugin instance and I<ValueName> will be used as type instance. An example of
4531 the string being used would be C<Tcp:RetransSegs>.
4533 You can use regular expressions to match a large number of values with just one
4534 configuration option. To select all "extended" I<TCP> values, you could use the
4535 following statement:
4539 Whether only matched values are selected or all matched values are ignored
4540 depends on the B<IgnoreSelected>. By default, only matched values are selected.
4541 If no value is configured at all, all values will be selected.
4543 =item B<IgnoreSelected> B<true>|B<false>
4545 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
4546 matching values will be ignored.
4550 =head2 Plugin C<python>
4552 This plugin embeds a Python-interpreter into collectd and provides an interface
4553 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
4555 =head2 Plugin C<routeros>
4557 The C<routeros> plugin connects to a device running I<RouterOS>, the
4558 Linux-based operating system for routers by I<MikroTik>. The plugin uses
4559 I<librouteros> to connect and reads information about the interfaces and
4560 wireless connections of the device. The configuration supports querying
4565 Host "router0.example.com"
4568 CollectInterface true
4573 Host "router1.example.com"
4576 CollectInterface true
4577 CollectRegistrationTable true
4583 As you can see above, the configuration of the I<routeros> plugin consists of
4584 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
4585 options are understood:
4589 =item B<Host> I<Host>
4591 Hostname or IP-address of the router to connect to.
4593 =item B<Port> I<Port>
4595 Port name or port number used when connecting. If left unspecified, the default
4596 will be chosen by I<librouteros>, currently "8728". This option expects a
4597 string argument, even when a numeric port number is given.
4599 =item B<User> I<User>
4601 Use the user name I<User> to authenticate. Defaults to "admin".
4603 =item B<Password> I<Password>
4605 Set the password used to authenticate.
4607 =item B<CollectInterface> B<true>|B<false>
4609 When set to B<true>, interface statistics will be collected for all interfaces
4610 present on the device. Defaults to B<false>.
4612 =item B<CollectRegistrationTable> B<true>|B<false>
4614 When set to B<true>, information about wireless LAN connections will be
4615 collected. Defaults to B<false>.
4617 =item B<CollectCPULoad> B<true>|B<false>
4619 When set to B<true>, information about the CPU usage will be collected. The
4620 number is a dimensionless value where zero indicates no CPU usage at all.
4621 Defaults to B<false>.
4623 =item B<CollectMemory> B<true>|B<false>
4625 When enabled, the amount of used and free memory will be collected. How used
4626 memory is calculated is unknown, for example whether or not caches are counted
4628 Defaults to B<false>.
4630 =item B<CollectDF> B<true>|B<false>
4632 When enabled, the amount of used and free disk space will be collected.
4633 Defaults to B<false>.
4635 =item B<CollectDisk> B<true>|B<false>
4637 When enabled, the number of sectors written and bad blocks will be collected.
4638 Defaults to B<false>.
4642 =head2 Plugin C<redis>
4644 The I<Redis plugin> connects to one or more Redis servers and gathers
4645 information about each server's state. For each server there is a I<Node> block
4646 which configures the connection parameters for this node.
4656 The information shown in the synopsis above is the I<default configuration>
4657 which is used by the plugin if no configuration is present.
4661 =item B<Node> I<Nodename>
4663 The B<Node> block identifies a new Redis node, that is a new Redis instance
4664 running in an specified host and port. The name for node is a canonical
4665 identifier which is used as I<plugin instance>. It is limited to
4666 64E<nbsp>characters in length.
4668 =item B<Host> I<Hostname>
4670 The B<Host> option is the hostname or IP-address where the Redis instance is
4673 =item B<Port> I<Port>
4675 The B<Port> option is the TCP port on which the Redis instance accepts
4676 connections. Either a service name of a port number may be given. Please note
4677 that numerical port numbers must be given as a string, too.
4679 =item B<Password> I<Password>
4681 Use I<Password> to authenticate when connecting to I<Redis>.
4683 =item B<Timeout> I<Timeout in miliseconds>
4685 The B<Timeout> option set the socket timeout for node response. Since the Redis
4686 read function is blocking, you should keep this value as low as possible. Keep
4687 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
4688 than B<Interval> defined globally.
4692 =head2 Plugin C<rrdcached>
4694 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
4695 to store values to RRD files in an efficient manner. The combination of the
4696 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
4697 way the C<rrdtool> plugin works (see below). The added abstraction layer
4698 provides a number of benefits, though: Because the cache is not within
4699 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
4700 restarted. This results in much shorter (if any) gaps in graphs, especially
4701 under heavy load. Also, the C<rrdtool> command line utility is aware of the
4702 daemon so that it can flush values to disk automatically when needed. This
4703 allows to integrate automated flushing of values into graphing solutions much
4706 There are disadvantages, though: The daemon may reside on a different host, so
4707 it may not be possible for C<collectd> to create the appropriate RRD files
4708 anymore. And even if C<rrdcached> runs on the same host, it may run in a
4709 different base directory, so relative paths may do weird stuff if you're not
4712 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
4713 on the same host, communicating via a UNIX domain socket. The B<DataDir>
4714 setting should be set to an absolute path, so that a changed base directory
4715 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
4719 =item B<DaemonAddress> I<Address>
4721 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
4722 library. See L<rrdcached(1)> for details. Example:
4724 <Plugin "rrdcached">
4725 DaemonAddress "unix:/var/run/rrdcached.sock"
4728 =item B<DataDir> I<Directory>
4730 Set the base directory in which the RRD files reside. If this is a relative
4731 path, it is relative to the working base directory of the C<rrdcached> daemon!
4732 Use of an absolute path is recommended.
4734 =item B<CreateFiles> B<true>|B<false>
4736 Enables or disables the creation of RRD files. If the daemon is not running
4737 locally, or B<DataDir> is set to a relative path, this will not work as
4738 expected. Default is B<true>.
4740 =item B<CreateFilesAsync> B<false>|B<true>
4742 When enabled, new RRD files are enabled asynchronously, using a separate thread
4743 that runs in the background. This prevents writes to block, which is a problem
4744 especially when many hundreds of files need to be created at once. However,
4745 since the purpose of creating the files asynchronously is I<not> to block until
4746 the file is available, values before the file is available will be discarded.
4747 When disabled (the default) files are created synchronously, blocking for a
4748 short while, while the file is being written.
4750 =item B<StepSize> I<Seconds>
4752 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
4753 this setting is unset and the stepsize is set to the interval in which the data
4754 is collected. Do not use this option unless you absolutely have to for some
4755 reason. Setting this option may cause problems with the C<snmp plugin>, the
4756 C<exec plugin> or when the daemon is set up to receive data from other hosts.
4758 =item B<HeartBeat> I<Seconds>
4760 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
4761 in which case the heartbeat is set to twice the B<StepSize> which should equal
4762 the interval in which data is collected. Do not set this option unless you have
4763 a very good reason to do so.
4765 =item B<RRARows> I<NumRows>
4767 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
4768 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
4769 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
4770 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
4771 week, one month, and one year.
4773 So for each timespan, it calculates how many PDPs need to be consolidated into
4774 one CDP by calculating:
4775 number of PDPs = timespan / (stepsize * rrarows)
4777 Bottom line is, set this no smaller than the width of you graphs in pixels. The
4780 =item B<RRATimespan> I<Seconds>
4782 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
4783 more then one RRA. If this option is never used, the built-in default of (3600,
4784 86400, 604800, 2678400, 31622400) is used.
4786 For more information on how RRA-sizes are calculated see B<RRARows> above.
4788 =item B<XFF> I<Factor>
4790 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
4791 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
4796 =head2 Plugin C<rrdtool>
4798 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
4799 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
4800 using these settings. If you don't want to dive into the depths of RRDtool, you
4801 can safely ignore these settings.
4805 =item B<DataDir> I<Directory>
4807 Set the directory to store RRD files under. By default RRD files are generated
4808 beneath the daemon's working directory, i.e. the B<BaseDir>.
4810 =item B<CreateFilesAsync> B<false>|B<true>
4812 When enabled, new RRD files are enabled asynchronously, using a separate thread
4813 that runs in the background. This prevents writes to block, which is a problem
4814 especially when many hundreds of files need to be created at once. However,
4815 since the purpose of creating the files asynchronously is I<not> to block until
4816 the file is available, values before the file is available will be discarded.
4817 When disabled (the default) files are created synchronously, blocking for a
4818 short while, while the file is being written.
4820 =item B<StepSize> I<Seconds>
4822 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
4823 this setting is unset and the stepsize is set to the interval in which the data
4824 is collected. Do not use this option unless you absolutely have to for some
4825 reason. Setting this option may cause problems with the C<snmp plugin>, the
4826 C<exec plugin> or when the daemon is set up to receive data from other hosts.
4828 =item B<HeartBeat> I<Seconds>
4830 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
4831 in which case the heartbeat is set to twice the B<StepSize> which should equal
4832 the interval in which data is collected. Do not set this option unless you have
4833 a very good reason to do so.
4835 =item B<RRARows> I<NumRows>
4837 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
4838 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
4839 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
4840 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
4841 week, one month, and one year.
4843 So for each timespan, it calculates how many PDPs need to be consolidated into
4844 one CDP by calculating:
4845 number of PDPs = timespan / (stepsize * rrarows)
4847 Bottom line is, set this no smaller than the width of you graphs in pixels. The
4850 =item B<RRATimespan> I<Seconds>
4852 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
4853 more then one RRA. If this option is never used, the built-in default of (3600,
4854 86400, 604800, 2678400, 31622400) is used.
4856 For more information on how RRA-sizes are calculated see B<RRARows> above.
4858 =item B<XFF> I<Factor>
4860 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
4861 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
4864 =item B<CacheFlush> I<Seconds>
4866 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
4867 it writes all values for a certain RRD-file if the oldest value is older than
4868 (or equal to) the number of seconds specified. If some RRD-file is not updated
4869 anymore for some reason (the computer was shut down, the network is broken,
4870 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
4871 entire cache is searched for entries older than B<CacheTimeout> seconds and
4872 written to disk every I<Seconds> seconds. Since this is kind of expensive and
4873 does nothing under normal circumstances, this value should not be too small.
4874 900 seconds might be a good value, though setting this to 7200 seconds doesn't
4875 normally do much harm either.
4877 =item B<CacheTimeout> I<Seconds>
4879 If this option is set to a value greater than zero, the C<rrdtool plugin> will
4880 save values in a cache, as described above. Writing multiple values at once
4881 reduces IO-operations and thus lessens the load produced by updating the files.
4882 The trade off is that the graphs kind of "drag behind" and that more memory is
4885 =item B<WritesPerSecond> I<Updates>
4887 When collecting many statistics with collectd and the C<rrdtool> plugin, you
4888 will run serious performance problems. The B<CacheFlush> setting and the
4889 internal update queue assert that collectd continues to work just fine even
4890 under heavy load, but the system may become very unresponsive and slow. This is
4891 a problem especially if you create graphs from the RRD files on the same
4892 machine, for example using the C<graph.cgi> script included in the
4893 C<contrib/collection3/> directory.
4895 This setting is designed for very large setups. Setting this option to a value
4896 between 25 and 80 updates per second, depending on your hardware, will leave
4897 the server responsive enough to draw graphs even while all the cached values
4898 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
4899 by the B<FLUSH> command, are B<not> effected by this limit. They are still
4900 written as fast as possible, so that web frontends have up to date data when
4903 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
4904 updates per second, writing all values to disk will take approximately
4905 56E<nbsp>minutes. Together with the flushing ability that's integrated into
4906 "collection3" you'll end up with a responsive and fast system, up to date
4907 graphs and basically a "backup" of your values every hour.
4909 =item B<RandomTimeout> I<Seconds>
4911 When set, the actual timeout for each value is chosen randomly between
4912 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
4913 intention is to avoid high load situations that appear when many values timeout
4914 at the same time. This is especially a problem shortly after the daemon starts,
4915 because all values were added to the internal cache at roughly the same time.
4919 =head2 Plugin C<sensors>
4921 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
4922 that all the needed modules have to be loaded and lm_sensors has to be
4923 configured (most likely by editing F</etc/sensors.conf>. Read
4924 L<sensors.conf(5)> for details.
4926 The B<lm_sensors> homepage can be found at
4927 L<http://secure.netroedge.com/~lm78/>.
4931 =item B<SensorConfigFile> I<File>
4933 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
4934 the library's default will be used.
4936 =item B<Sensor> I<chip-bus-address/type-feature>
4938 Selects the name of the sensor which you want to collect or ignore, depending
4939 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
4940 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
4941 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
4943 =item B<IgnoreSelected> I<true>|I<false>
4945 If no configuration if given, the B<sensors>-plugin will collect data from all
4946 sensors. This may not be practical, especially for uninteresting sensors.
4947 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
4948 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
4949 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
4950 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
4951 and all other sensors are collected.
4955 =head2 Plugin C<snmp>
4957 Since the configuration of the C<snmp plugin> is a little more complicated than
4958 other plugins, its documentation has been moved to an own manpage,
4959 L<collectd-snmp(5)>. Please see there for details.
4961 =head2 Plugin C<swap>
4963 The I<Swap plugin> collects information about used and available swap space. On
4964 I<Linux> and I<Solaris>, the following options are available:
4968 =item B<ReportByDevice> B<false>|B<true>
4970 Configures how to report physical swap devices. If set to B<false> (the
4971 default), the summary over all swap devices is reported only, i.e. the globally
4972 used and available space over all devices. If B<true> is configured, the used
4973 and available space of each device will be reported separately.
4975 This option is only available if the I<Swap plugin> can read C</proc/swaps>
4976 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
4978 =item B<ReportBytes> B<false>|B<true>
4980 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
4981 I<swap I/O> is reported in pages. This option is available under Linux only.
4985 =head2 Plugin C<syslog>
4989 =item B<LogLevel> B<debug|info|notice|warning|err>
4991 Sets the log-level. If, for example, set to B<notice>, then all events with
4992 severity B<notice>, B<warning>, or B<err> will be submitted to the
4995 Please note that B<debug> is only available if collectd has been compiled with
4998 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
5000 Controls which notifications should be sent to syslog. The default behaviour is
5001 not to send any. Less severe notifications always imply logging more severe
5002 notifications: Setting this to B<OKAY> means all notifications will be sent to
5003 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
5004 notifications but will dismiss B<OKAY> notifications. Setting this option to
5005 B<FAILURE> will only send failures to syslog.
5009 =head2 Plugin C<table>
5011 The C<table plugin> provides generic means to parse tabular data and dispatch
5012 user specified values. Values are selected based on column numbers. For
5013 example, this plugin may be used to get values from the Linux L<proc(5)>
5014 filesystem or CSV (comma separated values) files.
5017 <Table "/proc/slabinfo">
5022 InstancePrefix "active_objs"
5028 InstancePrefix "objperslab"
5035 The configuration consists of one or more B<Table> blocks, each of which
5036 configures one file to parse. Within each B<Table> block, there are one or
5037 more B<Result> blocks, which configure which data to select and how to
5040 The following options are available inside a B<Table> block:
5044 =item B<Instance> I<instance>
5046 If specified, I<instance> is used as the plugin instance. So, in the above
5047 example, the plugin name C<table-slabinfo> would be used. If omitted, the
5048 filename of the table is used instead, with all special characters replaced
5049 with an underscore (C<_>).
5051 =item B<Separator> I<string>
5053 Any character of I<string> is interpreted as a delimiter between the different
5054 columns of the table. A sequence of two or more contiguous delimiters in the
5055 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
5056 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
5057 of a table - see its documentation for more details. This option is mandatory.
5059 A horizontal tab, newline and carriage return may be specified by C<\\t>,
5060 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
5061 required because of collectd's config parsing.
5065 The following options are available inside a B<Result> block:
5069 =item B<Type> I<type>
5071 Sets the type used to dispatch the values to the daemon. Detailed information
5072 about types and their configuration can be found in L<types.db(5)>. This
5073 option is mandatory.
5075 =item B<InstancePrefix> I<prefix>
5077 If specified, prepend I<prefix> to the type instance. If omitted, only the
5078 B<InstancesFrom> option is considered for the type instance.
5080 =item B<InstancesFrom> I<column0> [I<column1> ...]
5082 If specified, the content of the given columns (identified by the column
5083 number starting at zero) will be used to create the type instance for each
5084 row. Multiple values (and the instance prefix) will be joined together with
5085 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
5086 option is considered for the type instance.
5088 The plugin itself does not check whether or not all built instances are
5089 different. It’s your responsibility to assure that each is unique. This is
5090 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
5091 sure that the table only contains one row.
5093 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
5096 =item B<ValuesFrom> I<column0> [I<column1> ...]
5098 Specifies the columns (identified by the column numbers starting at zero)
5099 whose content is used as the actual data for the data sets that are dispatched
5100 to the daemon. How many such columns you need is determined by the B<Type>
5101 setting above. If you specify too many or not enough columns, the plugin will
5102 complain about that and no data will be submitted to the daemon. The plugin
5103 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
5104 respectively, so anything supported by those functions is supported by the
5105 plugin as well. This option is mandatory.
5109 =head2 Plugin C<tail>
5111 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
5112 each line and dispatches found values. What is matched can be configured by the
5113 user using (extended) regular expressions, as described in L<regex(7)>.
5116 <File "/var/log/exim4/mainlog">
5119 Regex "S=([1-9][0-9]*)"
5125 Regex "\\<R=local_user\\>"
5126 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
5129 Instance "local_user"
5134 The config consists of one or more B<File> blocks, each of which configures one
5135 logfile to parse. Within each B<File> block, there are one or more B<Match>
5136 blocks, which configure a regular expression to search for.
5138 The B<Instance> option in the B<File> block may be used to set the plugin
5139 instance. So in the above example the plugin name C<tail-foo> would be used.
5140 This plugin instance is for all B<Match> blocks that B<follow> it, until the
5141 next B<Instance> option. This way you can extract several plugin instances from
5142 one logfile, handy when parsing syslog and the like.
5144 Each B<Match> block has the following options to describe how the match should
5149 =item B<Regex> I<regex>
5151 Sets the regular expression to use for matching against a line. The first
5152 subexpression has to match something that can be turned into a number by
5153 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
5154 below. Because B<extended> regular expressions are used, you do not need to use
5155 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
5156 collectd's config parsing you need to escape backslashes, though. So if you
5157 want to match literal parentheses you need to do the following:
5159 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
5161 =item B<ExcludeRegex> I<regex>
5163 Sets an optional regular expression to use for excluding lines from the match.
5164 An example which excludes all connections from localhost from the match:
5166 ExcludeRegex "127\\.0\\.0\\.1"
5168 =item B<DSType> I<Type>
5170 Sets how the values are cumulated. I<Type> is one of:
5174 =item B<GaugeAverage>
5176 Calculate the average.
5180 Use the smallest number only.
5184 Use the greatest number only.
5188 Use the last number found.
5194 =item B<AbsoluteSet>
5196 The matched number is a counter. Simply I<sets> the internal counter to this
5197 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
5203 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
5204 matched number may be negative, which will effectively subtract from the
5211 Increase the internal counter by one. These B<DSType> are the only ones that do
5212 not use the matched subexpression, but simply count the number of matched
5213 lines. Thus, you may use a regular expression without submatch in this case.
5217 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
5218 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
5219 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
5220 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
5221 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
5224 =item B<Type> I<Type>
5226 Sets the type used to dispatch this value. Detailed information about types and
5227 their configuration can be found in L<types.db(5)>.
5229 =item B<Instance> I<TypeInstance>
5231 This optional setting sets the type instance to use.
5235 =head2 Plugin C<tail_csv>
5237 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
5238 written by I<Snort>.
5243 <Metric "snort-dropped">
5248 <File "/var/log/snort/snort.stats">
5249 Instance "snort-eth0"
5251 Collect "snort-dropped"
5255 The configuration consists of one or more B<Metric> blocks that define an index
5256 into the line of the CSV file and how this value is mapped to I<collectd's>
5257 internal representation. These are followed by one or more B<Instance> blocks
5258 which configure which file to read, in which interval and which metrics to
5263 =item E<lt>B<Metric> I<Name>E<gt>
5265 The B<Metric> block configures a new metric to be extracted from the statistics
5266 file and how it is mapped on I<collectd's> data model. The string I<Name> is
5267 only used inside the B<Instance> blocks to refer to this block, so you can use
5268 one B<Metric> block for multiple CSV files.
5272 =item B<Type> I<Type>
5274 Configures which I<Type> to use when dispatching this metric. Types are defined
5275 in the L<types.db(5)> file, see the appropriate manual page for more
5276 information on specifying types. Only types with a single I<data source> are
5277 supported by the I<tail_csv plugin>. The information whether the value is an
5278 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
5279 I<Type's> definition.
5281 =item B<Instance> I<TypeInstance>
5283 If set, I<TypeInstance> is used to populate the type instance field of the
5284 created value lists. Otherwise, no type instance is used.
5286 =item B<ValueFrom> I<Index>
5288 Configure to read the value from the field with the zero-based index I<Index>.
5289 If the value is parsed as signed integer, unsigned integer or double depends on
5290 the B<Type> setting, see above.
5294 =item E<lt>B<File> I<Path>E<gt>
5296 Each B<File> block represents one CSV file to read. There must be at least one
5297 I<File> block but there can be multiple if you have multiple CSV files.
5301 =item B<Instance> I<PluginInstance>
5303 Sets the I<plugin instance> used when dispatching the values.
5305 =item B<Collect> I<Metric>
5307 Specifies which I<Metric> to collect. This option must be specified at least
5308 once, and you can use this option multiple times to specify more than one
5309 metric to be extracted from this statistic file.
5311 =item B<Interval> I<Seconds>
5313 Configures the interval in which to read values from this instance / file.
5314 Defaults to the plugin's default interval.
5316 =item B<TimeFrom> I<Index>
5318 Rather than using the local time when dispatching a value, read the timestamp
5319 from the field with the zero-based index I<Index>. The value is interpreted as
5320 seconds since epoch. The value is parsed as a double and may be factional.
5326 =head2 Plugin C<teamspeak2>
5328 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
5329 polls interesting global and virtual server data. The plugin can query only one
5330 physical server but unlimited virtual servers. You can use the following
5331 options to configure it:
5335 =item B<Host> I<hostname/ip>
5337 The hostname or ip which identifies the physical server.
5340 =item B<Port> I<port>
5342 The query port of the physical server. This needs to be a string.
5345 =item B<Server> I<port>
5347 This option has to be added once for every virtual server the plugin should
5348 query. If you want to query the virtual server on port 8767 this is what the
5349 option would look like:
5353 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
5354 use quotes around it! If no such statement is given only global information
5359 =head2 Plugin C<ted>
5361 The I<TED> plugin connects to a device of "The Energy Detective", a device to
5362 measure power consumption. These devices are usually connected to a serial
5363 (RS232) or USB port. The plugin opens a configured device and tries to read the
5364 current energy readings. For more information on TED, visit
5365 L<http://www.theenergydetective.com/>.
5367 Available configuration options:
5371 =item B<Device> I<Path>
5373 Path to the device on which TED is connected. collectd will need read and write
5374 permissions on that file.
5376 Default: B</dev/ttyUSB0>
5378 =item B<Retries> I<Num>
5380 Apparently reading from TED is not that reliable. You can therefore configure a
5381 number of retries here. You only configure the I<retries> here, to if you
5382 specify zero, one reading will be performed (but no retries if that fails); if
5383 you specify three, a maximum of four readings are performed. Negative values
5390 =head2 Plugin C<tcpconns>
5392 The C<tcpconns plugin> counts the number of currently established TCP
5393 connections based on the local port and/or the remote port. Since there may be
5394 a lot of connections the default if to count all connections with a local port,
5395 for which a listening socket is opened. You can use the following options to
5396 fine-tune the ports you are interested in:
5400 =item B<ListeningPorts> I<true>|I<false>
5402 If this option is set to I<true>, statistics for all local ports for which a
5403 listening socket exists are collected. The default depends on B<LocalPort> and
5404 B<RemotePort> (see below): If no port at all is specifically selected, the
5405 default is to collect listening ports. If specific ports (no matter if local or
5406 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
5407 the selected ports will be collected unless this option is set to I<true>
5410 =item B<LocalPort> I<Port>
5412 Count the connections to a specific local port. This can be used to see how
5413 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
5414 You have to specify the port in numeric form, so for the mailserver example
5415 you'd need to set B<25>.
5417 =item B<RemotePort> I<Port>
5419 Count the connections to a specific remote port. This is useful to see how
5420 much a remote service is used. This is most useful if you want to know how many
5421 connections a local service has opened to remote services, e.E<nbsp>g. how many
5422 connections a mail server or news server has to other mail or news servers, or
5423 how many connections a web proxy holds to web servers. You have to give the
5424 port in numeric form.
5428 =head2 Plugin C<thermal>
5432 =item B<ForceUseProcfs> I<true>|I<false>
5434 By default, the I<Thermal plugin> tries to read the statistics from the Linux
5435 C<sysfs> interface. If that is not available, the plugin falls back to the
5436 C<procfs> interface. By setting this option to I<true>, you can force the
5437 plugin to use the latter. This option defaults to I<false>.
5439 =item B<Device> I<Device>
5441 Selects the name of the thermal device that you want to collect or ignore,
5442 depending on the value of the B<IgnoreSelected> option. This option may be
5443 used multiple times to specify a list of devices.
5445 =item B<IgnoreSelected> I<true>|I<false>
5447 Invert the selection: If set to true, all devices B<except> the ones that
5448 match the device names specified by the B<Device> option are collected. By
5449 default only selected devices are collected if a selection is made. If no
5450 selection is configured at all, B<all> devices are selected.
5454 =head2 Plugin C<threshold>
5456 The I<Threshold plugin> checks values collected or received by I<collectd>
5457 against a configurable I<threshold> and issues I<notifications> if values are
5460 Documentation for this plugin is available in the L<collectd-threshold(5)>
5463 =head2 Plugin C<tokyotyrant>
5465 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
5466 couple metrics: number of records, and database size on disk.
5470 =item B<Host> I<Hostname/IP>
5472 The hostname or ip which identifies the server.
5473 Default: B<127.0.0.1>
5475 =item B<Port> I<Service/Port>
5477 The query port of the server. This needs to be a string, even if the port is
5478 given in its numeric form.
5483 =head2 Plugin C<unixsock>
5487 =item B<SocketFile> I<Path>
5489 Sets the socket-file which is to be created.
5491 =item B<SocketGroup> I<Group>
5493 If running as root change the group of the UNIX-socket after it has been
5494 created. Defaults to B<collectd>.
5496 =item B<SocketPerms> I<Permissions>
5498 Change the file permissions of the UNIX-socket after it has been created. The
5499 permissions must be given as a numeric, octal value as you would pass to
5500 L<chmod(1)>. Defaults to B<0770>.
5502 =item B<DeleteSocket> B<false>|B<true>
5504 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
5505 with the given name already exists. If I<collectd> crashes a socket file may be
5506 left over, preventing the daemon from opening a new socket when restarted.
5507 Since this is potentially dangerous, this defaults to B<false>.
5511 =head2 Plugin C<uuid>
5513 This plugin, if loaded, causes the Hostname to be taken from the machine's
5514 UUID. The UUID is a universally unique designation for the machine, usually
5515 taken from the machine's BIOS. This is most useful if the machine is running in
5516 a virtual environment such as Xen, in which case the UUID is preserved across
5517 shutdowns and migration.
5519 The following methods are used to find the machine's UUID, in order:
5525 Check I</etc/uuid> (or I<UUIDFile>).
5529 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
5534 Check for UUID from C<dmidecode> / SMBIOS.
5538 Check for UUID from Xen hypervisor.
5542 If no UUID can be found then the hostname is not modified.
5546 =item B<UUIDFile> I<Path>
5548 Take the UUID from the given file (default I</etc/uuid>).
5552 =head2 Plugin C<varnish>
5554 The Varnish plugin collects information about Varnish, an HTTP accelerator.
5558 =item B<CollectCache> B<true>|B<false>
5560 Cache hits and misses. True by default.
5562 =item B<CollectConnections> B<true>|B<false>
5564 Number of client connections received, accepted and dropped. True by default.
5566 =item B<CollectBackend> B<true>|B<false>
5568 Back-end connection statistics, such as successful, reused,
5569 and closed connections. True by default.
5571 =item B<CollectSHM> B<true>|B<false>
5573 Statistics about the shared memory log, a memory region to store
5574 log messages which is flushed to disk when full. True by default.
5576 =item B<CollectESI> B<true>|B<false>
5578 Edge Side Includes (ESI) parse statistics. False by default.
5580 =item B<CollectFetch> B<true>|B<false>
5582 Statistics about fetches (HTTP requests sent to the backend). False by default.
5584 =item B<CollectHCB> B<true>|B<false>
5586 Inserts and look-ups in the crit bit tree based hash. Look-ups are
5587 divided into locked and unlocked look-ups. False by default.
5589 =item B<CollectSMA> B<true>|B<false>
5591 malloc or umem (umem_alloc(3MALLOC) based) storage statistics.
5592 The umem storage component is Solaris specific. False by default.
5594 =item B<CollectSMS> B<true>|B<false>
5596 synth (synthetic content) storage statistics. This storage
5597 component is used internally only. False by default.
5599 =item B<CollectSM> B<true>|B<false>
5601 file (memory mapped file) storage statistics. False by default.
5603 =item B<CollectTotals> B<true>|B<false>
5605 Collects overview counters, such as the number of sessions created,
5606 the number of requests and bytes transferred. False by default.
5608 =item B<CollectWorkers> B<true>|B<false>
5610 Collect statistics about worker threads. False by default.
5614 =head2 Plugin C<vmem>
5616 The C<vmem> plugin collects information about the usage of virtual memory.
5617 Since the statistics provided by the Linux kernel are very detailed, they are
5618 collected very detailed. However, to get all the details, you have to switch
5619 them on manually. Most people just want an overview over, such as the number of
5620 pages read from swap space.
5624 =item B<Verbose> B<true>|B<false>
5626 Enables verbose collection of information. This will start collecting page
5627 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
5628 Part of these statistics are collected on a "per zone" basis.
5632 =head2 Plugin C<vserver>
5634 This plugin doesn't have any options. B<VServer> support is only available for
5635 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
5636 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
5637 need to apply the patches and compile your own kernel, which will then provide
5638 the F</proc/virtual> filesystem that is required by this plugin.
5640 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
5642 B<Note>: The traffic collected by this plugin accounts for the amount of
5643 traffic passing a socket which might be a lot less than the actual on-wire
5644 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
5645 collect on-wire traffic you could, for example, use the logging facilities of
5646 iptables to feed data for the guest IPs into the iptables plugin.
5648 =head2 Plugin C<write_graphite>
5650 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
5651 storage and graphing project. The plugin connects to I<Carbon>, the data layer
5652 of I<Graphite>, and sends data via the "line based" protocol (per default using
5653 portE<nbsp>2003). The data will be sent in blocks of at most 1428 bytes to
5654 minimize the number of network packets.
5658 <Plugin write_graphite>
5666 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
5667 blocks. Inside the B<Node> blocks, the following options are recognized:
5671 =item B<Host> I<Address>
5673 Hostname or address to connect to. Defaults to C<localhost>.
5675 =item B<Port> I<Service>
5677 Service name or port number to connect to. Defaults to C<2003>.
5679 =item B<Prefix> I<String>
5681 When set, I<String> is added in front of the host name. Dots and whitespace are
5682 I<not> escaped in this string (see B<EscapeCharacter> below).
5684 =item B<Postfix> I<String>
5686 When set, I<String> is appended to the host name. Dots and whitespace are
5687 I<not> escaped in this string (see B<EscapeCharacter> below).
5689 =item B<EscapeCharacter> I<Char>
5691 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
5692 in the identifier. The B<EscapeCharacter> option determines which character
5693 dots, whitespace and control characters are replaced with. Defaults to
5696 =item B<StoreRates> B<false>|B<true>
5698 If set to B<true> (the default), convert counter values to rates. If set to
5699 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
5702 =item B<SeparateInstances> B<false>|B<true>
5704 If set to B<true>, the plugin instance and type instance will be in their own
5705 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
5706 default), the plugin and plugin instance (and likewise the type and type
5707 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
5709 =item B<AlwaysAppendDS> B<false>|B<true>
5711 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
5712 identifier. If set to B<false> (the default), this is only done when there is
5717 =head2 Plugin C<write_mongodb>
5719 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
5724 <Plugin "write_mongodb">
5733 The plugin can send values to multiple instances of I<MongoDB> by specifying
5734 one B<Node> block for each instance. Within the B<Node> blocks, the following
5735 options are available:
5739 =item B<Host> I<Address>
5741 Hostname or address to connect to. Defaults to C<localhost>.
5743 =item B<Port> I<Service>
5745 Service name or port number to connect to. Defaults to C<27017>.
5747 =item B<Timeout> I<Timeout>
5749 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
5750 Setting this option to zero means no timeout, which is the default.
5752 =item B<StoreRates> B<false>|B<true>
5754 If set to B<true> (the default), convert counter values to rates. If set to
5755 B<false> counter values are stored as is, i.e. as an increasing integer
5758 =item B<Database> I<Database>
5760 =item B<User> I<User>
5762 =item B<Password> I<Password>
5764 Sets the information used when authenticating to a I<MongoDB> database. The
5765 fields are optional (in which case no authentication is attempted), but if you
5766 want to use authentication all three fields must be set.
5770 =head2 Plugin C<write_http>
5772 This output plugin submits values to an http server by POST them using the
5773 PUTVAL plain-text protocol. Each destination you want to post data to needs to
5774 have one B<URL> block, within which the destination can be configured further,
5775 for example by specifying authentication data.
5779 <Plugin "write_http">
5780 <URL "http://example.com/post-collectd">
5786 B<URL> blocks need one string argument which is used as the URL to which data
5787 is posted. The following options are understood within B<URL> blocks.
5791 =item B<User> I<Username>
5793 Optional user name needed for authentication.
5795 =item B<Password> I<Password>
5797 Optional password needed for authentication.
5799 =item B<VerifyPeer> B<true>|B<false>
5801 Enable or disable peer SSL certificate verification. See
5802 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5804 =item B<VerifyHost> B<true|false>
5806 Enable or disable peer host name verification. If enabled, the plugin checks if
5807 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
5808 matches the host name provided by the B<URL> option. If this identity check
5809 fails, the connection is aborted. Obviously, only works when connecting to a
5810 SSL enabled server. Enabled by default.
5812 =item B<CACert> I<File>
5814 File that holds one or more SSL certificates. If you want to use HTTPS you will
5815 possibly need this option. What CA certificates come bundled with C<libcurl>
5816 and are checked by default depends on the distribution you use.
5818 =item B<Format> B<Command>|B<JSON>
5820 Format of the output to generate. If set to B<Command>, will create output that
5821 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
5822 create output in the I<JavaScript Object Notation> (JSON).
5824 Defaults to B<Command>.
5826 =item B<StoreRates> B<true|false>
5828 If set to B<true>, convert counter values to rates. If set to B<false> (the
5829 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
5834 =head2 Plugin C<write_riemann>
5836 The I<write_riemann plugin> will send values to I<Riemann>, a powerfull stream
5837 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
5838 I<Riemann> using UDP packets.
5842 <Plugin "write_riemann">
5848 AlwaysAppendDS false
5854 The following options are understood by the I<write_riemann plugin>:
5858 =item E<lt>B<Node> I<Name>E<gt>
5860 The plugin's configuration consists of one or more B<Node> blocks. Each block
5861 is given a unique I<Name> and specifies one connection to an instance of
5862 I<Riemann>. Indise the B<Node> block, the following per-connection options are
5867 =item B<Host> I<Address>
5869 Hostname or address to connect to. Defaults to C<localhost>.
5871 =item B<Port> I<Service>
5873 Service name or port number to connect to. Defaults to C<5555>.
5875 =item B<Protocol> B<UDP>|B<TCP>
5877 Specify the protocol to use when communicating with I<Riemann>. Defaults to
5880 =item B<StoreRates> B<true>|B<false>
5882 If set to B<true> (the default), convert counter values to rates. If set to
5883 B<false> counter values are stored as is, i.e. as an increasing integer number.
5885 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
5886 converted values will have "rate" appended to the data source type, e.g.
5887 C<ds_type:derive:rate>.
5889 =item B<AlwaysAppendDS> B<false>|B<true>
5891 If set the B<true>, append the name of the I<Data Source> (DS) to the
5892 "service", i.e. the field that, together with the "host" field, uniquely
5893 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
5894 only done when there is more than one DS.
5898 =item B<Tag> I<String>
5900 Add the given string as an additional tag to the metric being sent to
5905 =head1 THRESHOLD CONFIGURATION
5907 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
5908 we mean that the values are not only stored or sent somewhere, but that they
5909 are judged and, if a problem is recognized, acted upon. The only action
5910 collectd takes itself is to generate and dispatch a "notification". Plugins can
5911 register to receive notifications and perform appropriate further actions.
5913 Since systems and what you expect them to do differ a lot, you can configure
5914 B<thresholds> for your values freely. This gives you a lot of flexibility but
5915 also a lot of responsibility.
5917 Every time a value is out of range a notification is dispatched. This means
5918 that the idle percentage of your CPU needs to be less then the configured
5919 threshold only once for a notification to be generated. There's no such thing
5920 as a moving average or similar - at least not now.
5922 Also, all values that match a threshold are considered to be relevant or
5923 "interesting". As a consequence collectd will issue a notification if they are
5924 not received for B<Timeout> iterations. The B<Timeout> configuration option is
5925 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
5926 "2" (the default) and some hosts sends it's CPU statistics to the server every
5927 60 seconds, a notification will be dispatched after about 120 seconds. It may
5928 take a little longer because the timeout is checked only once each B<Interval>
5931 When a value comes within range again or is received after it was missing, an
5932 "OKAY-notification" is dispatched.
5934 Here is a configuration example to get you started. Read below for more
5947 <Plugin "interface">
5964 WarningMin 100000000
5970 There are basically two types of configuration statements: The C<Host>,
5971 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
5972 configured. The C<Plugin> and C<Type> blocks may be specified further using the
5973 C<Instance> option. You can combine the block by nesting the blocks, though
5974 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
5975 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
5976 C<Type> may not contain other blocks. If multiple blocks apply to the same
5977 value the most specific block is used.
5979 The other statements specify the threshold to configure. They B<must> be
5980 included in a C<Type> block. Currently the following statements are recognized:
5984 =item B<FailureMax> I<Value>
5986 =item B<WarningMax> I<Value>
5988 Sets the upper bound of acceptable values. If unset defaults to positive
5989 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
5990 will be created. If the value is greater than B<WarningMax> but less than (or
5991 equal to) B<FailureMax> a B<WARNING> notification will be created.
5993 =item B<FailureMin> I<Value>
5995 =item B<WarningMin> I<Value>
5997 Sets the lower bound of acceptable values. If unset defaults to negative
5998 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
5999 be created. If the value is less than B<WarningMin> but greater than (or equal
6000 to) B<FailureMin> a B<WARNING> notification will be created.
6002 =item B<DataSource> I<DSName>
6004 Some data sets have more than one "data source". Interesting examples are the
6005 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
6006 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
6007 system load data set, C<load>, even has three data sources: C<shortterm>,
6008 C<midterm>, and C<longterm>.
6010 Normally, all data sources are checked against a configured threshold. If this
6011 is undesirable, or if you want to specify different limits for each data
6012 source, you can use the B<DataSource> option to have a threshold apply only to
6015 =item B<Invert> B<true>|B<false>
6017 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
6018 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
6019 B<WarningMax>) are not okay. Defaults to B<false>.
6021 =item B<Persist> B<true>|B<false>
6023 Sets how often notifications are generated. If set to B<true> one notification
6024 will be generated for each value that is out of the acceptable range. If set to
6025 B<false> (the default) then a notification is only generated if a value is out
6026 of range but the previous value was okay.
6028 This applies to missing values, too: If set to B<true> a notification about a
6029 missing value is generated once every B<Interval> seconds. If set to B<false>
6030 only one such notification is generated until the value appears again.
6032 =item B<Percentage> B<true>|B<false>
6034 If set to B<true>, the minimum and maximum values given are interpreted as
6035 percentage value, relative to the other data sources. This is helpful for
6036 example for the "df" type, where you may want to issue a warning when less than
6037 5E<nbsp>% of the total space is available. Defaults to B<false>.
6039 =item B<Hits> I<Number>
6041 Delay creating the notification until the threshold has been passed I<Number>
6042 times. When a notification has been generated, or when a subsequent value is
6043 inside the threshold, the counter is reset. If, for example, a value is
6044 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
6045 will be dispatched at most once every 30E<nbsp>seconds.
6047 This is useful when short bursts are not a problem. If, for example, 100% CPU
6048 usage for up to a minute is normal (and data is collected every
6049 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
6051 =item B<Hysteresis> I<Number>
6053 When set to non-zero, a hysteresis value is applied when checking minimum and
6054 maximum bounds. This is useful for values that increase slowly and fluctuate a
6055 bit while doing so. When these values come close to the threshold, they may
6056 "flap", i.e. switch between failure / warning case and okay case repeatedly.
6058 If, for example, the threshold is configures as
6063 then a I<Warning> notification is created when the value exceeds I<101> and the
6064 corresponding I<Okay> notification is only created once the value falls below
6065 I<99>, thus avoiding the "flapping".
6069 =head1 FILTER CONFIGURATION
6071 Starting with collectd 4.6 there is a powerful filtering infrastructure
6072 implemented in the daemon. The concept has mostly been copied from
6073 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
6074 terminology, so that users that are familiar with iptables feel right at home.
6078 The following are the terms used in the remainder of the filter configuration
6079 documentation. For an ASCII-art schema of the mechanism, see
6080 L<"General structure"> below.
6086 A I<match> is a criteria to select specific values. Examples are, of course, the
6087 name of the value or it's current value.
6089 Matches are implemented in plugins which you have to load prior to using the
6090 match. The name of such plugins starts with the "match_" prefix.
6094 A I<target> is some action that is to be performed with data. Such actions
6095 could, for example, be to change part of the value's identifier or to ignore
6096 the value completely.
6098 Some of these targets are built into the daemon, see L<"Built-in targets">
6099 below. Other targets are implemented in plugins which you have to load prior to
6100 using the target. The name of such plugins starts with the "target_" prefix.
6104 The combination of any number of matches and at least one target is called a
6105 I<rule>. The target actions will be performed for all values for which B<all>
6106 matches apply. If the rule does not have any matches associated with it, the
6107 target action will be performed for all values.
6111 A I<chain> is a list of rules and possibly default targets. The rules are tried
6112 in order and if one matches, the associated target will be called. If a value
6113 is handled by a rule, it depends on the target whether or not any subsequent
6114 rules are considered or if traversal of the chain is aborted, see
6115 L<"Flow control"> below. After all rules have been checked, the default targets
6120 =head2 General structure
6122 The following shows the resulting structure:
6129 +---------+ +---------+ +---------+ +---------+
6130 ! Rule !->! Match !->! Match !->! Target !
6131 +---------+ +---------+ +---------+ +---------+
6134 +---------+ +---------+ +---------+
6135 ! Rule !->! Target !->! Target !
6136 +---------+ +---------+ +---------+
6143 +---------+ +---------+ +---------+
6144 ! Rule !->! Match !->! Target !
6145 +---------+ +---------+ +---------+
6155 There are four ways to control which way a value takes through the filter
6162 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
6163 process the value with another chain. When the called chain finishes, usually
6164 the next target or rule after the jump is executed.
6168 The stop condition, signaled for example by the built-in target B<stop>, causes
6169 all processing of the value to be stopped immediately.
6173 Causes processing in the current chain to be aborted, but processing of the
6174 value generally will continue. This means that if the chain was called via
6175 B<Jump>, the next target or rule after the jump will be executed. If the chain
6176 was not called by another chain, control will be returned to the daemon and it
6177 may pass the value to another chain.
6181 Most targets will signal the B<continue> condition, meaning that processing
6182 should continue normally. There is no special built-in target for this
6189 The configuration reflects this structure directly:
6191 PostCacheChain "PostCache"
6193 <Rule "ignore_mysql_show">
6196 Type "^mysql_command$"
6197 TypeInstance "^show_"
6207 The above configuration example will ignore all values where the plugin field
6208 is "mysql", the type is "mysql_command" and the type instance begins with
6209 "show_". All other values will be sent to the C<rrdtool> write plugin via the
6210 default target of the chain. Since this chain is run after the value has been
6211 added to the cache, the MySQL C<show_*> command statistics will be available
6212 via the C<unixsock> plugin.
6214 =head2 List of configuration options
6218 =item B<PreCacheChain> I<ChainName>
6220 =item B<PostCacheChain> I<ChainName>
6222 Configure the name of the "pre-cache chain" and the "post-cache chain". The
6223 argument is the name of a I<chain> that should be executed before and/or after
6224 the values have been added to the cache.
6226 To understand the implications, it's important you know what is going on inside
6227 I<collectd>. The following diagram shows how values are passed from the
6228 read-plugins to the write-plugins:
6234 + - - - - V - - - - +
6235 : +---------------+ :
6238 : +-------+-------+ :
6241 : +-------+-------+ : +---------------+
6242 : ! Cache !--->! Value Cache !
6243 : ! insert ! : +---+---+-------+
6244 : +-------+-------+ : ! !
6245 : ! ,------------' !
6247 : +-------+---+---+ : +-------+-------+
6248 : ! Post-Cache +--->! Write-Plugins !
6249 : ! Chain ! : +---------------+
6250 : +---------------+ :
6253 + - - - - - - - - - +
6255 After the values are passed from the "read" plugins to the dispatch functions,
6256 the pre-cache chain is run first. The values are added to the internal cache
6257 afterwards. The post-cache chain is run after the values have been added to the
6258 cache. So why is it such a huge deal if chains are run before or after the
6259 values have been added to this cache?
6261 Targets that change the identifier of a value list should be executed before
6262 the values are added to the cache, so that the name in the cache matches the
6263 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
6264 this cache to receive a list of all available values. If you change the
6265 identifier after the value list has been added to the cache, this may easily
6266 lead to confusion, but it's not forbidden of course.
6268 The cache is also used to convert counter values to rates. These rates are, for
6269 example, used by the C<value> match (see below). If you use the rate stored in
6270 the cache B<before> the new value is added, you will use the old, B<previous>
6271 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
6272 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
6275 Last but not last, the B<stop> target makes a difference: If the pre-cache
6276 chain returns the stop condition, the value will not be added to the cache and
6277 the post-cache chain will not be run.
6279 =item B<Chain> I<Name>
6281 Adds a new chain with a certain name. This name can be used to refer to a
6282 specific chain, for example to jump to it.
6284 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
6286 =item B<Rule> [I<Name>]
6288 Adds a new rule to the current chain. The name of the rule is optional and
6289 currently has no meaning for the daemon.
6291 Within the B<Rule> block, there may be any number of B<Match> blocks and there
6292 must be at least one B<Target> block.
6294 =item B<Match> I<Name>
6296 Adds a match to a B<Rule> block. The name specifies what kind of match should
6297 be performed. Available matches depend on the plugins that have been loaded.
6299 The arguments inside the B<Match> block are passed to the plugin implementing
6300 the match, so which arguments are valid here depends on the plugin being used.
6301 If you do not need any to pass any arguments to a match, you can use the
6306 Which is equivalent to:
6311 =item B<Target> I<Name>
6313 Add a target to a rule or a default target to a chain. The name specifies what
6314 kind of target is to be added. Which targets are available depends on the
6315 plugins being loaded.
6317 The arguments inside the B<Target> block are passed to the plugin implementing
6318 the target, so which arguments are valid here depends on the plugin being used.
6319 If you do not need any to pass any arguments to a target, you can use the
6324 This is the same as writing:
6331 =head2 Built-in targets
6333 The following targets are built into the core daemon and therefore need no
6334 plugins to be loaded:
6340 Signals the "return" condition, see the L<"Flow control"> section above. This
6341 causes the current chain to stop processing the value and returns control to
6342 the calling chain. The calling chain will continue processing targets and rules
6343 just after the B<jump> target (see below). This is very similar to the
6344 B<RETURN> target of iptables, see L<iptables(8)>.
6346 This target does not have any options.
6354 Signals the "stop" condition, see the L<"Flow control"> section above. This
6355 causes processing of the value to be aborted immediately. This is similar to
6356 the B<DROP> target of iptables, see L<iptables(8)>.
6358 This target does not have any options.
6366 Sends the value to "write" plugins.
6372 =item B<Plugin> I<Name>
6374 Name of the write plugin to which the data should be sent. This option may be
6375 given multiple times to send the data to more than one write plugin.
6379 If no plugin is explicitly specified, the values will be sent to all available
6390 Starts processing the rules of another chain, see L<"Flow control"> above. If
6391 the end of that chain is reached, or a stop condition is encountered,
6392 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
6393 next target or the next rule. This is similar to the B<-j> command line option
6394 of iptables, see L<iptables(8)>.
6400 =item B<Chain> I<Name>
6402 Jumps to the chain I<Name>. This argument is required and may appear only once.
6414 =head2 Available matches
6420 Matches a value using regular expressions.
6426 =item B<Host> I<Regex>
6428 =item B<Plugin> I<Regex>
6430 =item B<PluginInstance> I<Regex>
6432 =item B<Type> I<Regex>
6434 =item B<TypeInstance> I<Regex>
6436 Match values where the given regular expressions match the various fields of
6437 the identifier of a value. If multiple regular expressions are given, B<all>
6438 regexen must match for a value to match.
6440 =item B<Invert> B<false>|B<true>
6442 When set to B<true>, the result of the match is inverted, i.e. all value lists
6443 where all regular expressions apply are not matched, all other value lists are
6444 matched. Defaults to B<false>.
6451 Host "customer[0-9]+"
6457 Matches values that have a time which differs from the time on the server.
6459 This match is mainly intended for servers that receive values over the
6460 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
6461 is very sensitive to the timestamp used when updating the RRD files. In
6462 particular, the time must be ever increasing. If a misbehaving client sends one
6463 packet with a timestamp far in the future, all further packets with a correct
6464 time will be ignored because of that one packet. What's worse, such corrupted
6465 RRD files are hard to fix.
6467 This match lets one match all values B<outside> a specified time range
6468 (relative to the server's time), so you can use the B<stop> target (see below)
6469 to ignore the value, for example.
6475 =item B<Future> I<Seconds>
6477 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
6478 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
6481 =item B<Past> I<Seconds>
6483 Matches all values that are I<behind> of the server's time by I<Seconds> or
6484 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
6496 This example matches all values that are five minutes or more ahead of the
6497 server or one hour (or more) lagging behind.
6501 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
6502 values. If a data-set consists of more than one data-source, all data-sources
6503 must match the specified ranges for a positive match.
6509 =item B<Min> I<Value>
6511 Sets the smallest value which still results in a match. If unset, behaves like
6514 =item B<Max> I<Value>
6516 Sets the largest value which still results in a match. If unset, behaves like
6519 =item B<Invert> B<true>|B<false>
6521 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
6522 no-match is returned and vice versa. Please note that the B<Invert> setting
6523 only effects how B<Min> and B<Max> are applied to a specific value. Especially
6524 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
6526 =item B<DataSource> I<DSName> [I<DSName> ...]
6528 Select one or more of the data sources. If no data source is configured, all
6529 data sources will be checked. If the type handled by the match does not have a
6530 data source of the specified name(s), this will always result in no match
6531 (independent of the B<Invert> setting).
6533 =item B<Satisfy> B<Any>|B<All>
6535 Specifies how checking with several data sources is performed. If set to
6536 B<Any>, the match succeeds if one of the data sources is in the configured
6537 range. If set to B<All> the match only succeeds if all data sources are within
6538 the configured range. Default is B<All>.
6540 Usually B<All> is used for positive matches, B<Any> is used for negative
6541 matches. This means that with B<All> you usually check that all values are in a
6542 "good" range, while with B<Any> you check if any value is within a "bad" range
6543 (or outside the "good" range).
6547 Either B<Min> or B<Max>, but not both, may be unset.
6551 # Match all values smaller than or equal to 100. Matches only if all data
6552 # sources are below 100.
6558 # Match if the value of any data source is outside the range of 0 - 100.
6566 =item B<empty_counter>
6568 Matches all values with one or more data sources of type B<COUNTER> and where
6569 all counter values are zero. These counters usually I<never> increased since
6570 they started existing (and are therefore uninteresting), or got reset recently
6571 or overflowed and you had really, I<really> bad luck.
6573 Please keep in mind that ignoring such counters can result in confusing
6574 behavior: Counters which hardly ever increase will be zero for long periods of
6575 time. If the counter is reset for some reason (machine or service restarted,
6576 usually), the graph will be empty (NAN) for a long time. People may not
6581 Calculates a hash value of the host name and matches values according to that
6582 hash value. This makes it possible to divide all hosts into groups and match
6583 only values that are in a specific group. The intended use is in load
6584 balancing, where you want to handle only part of all data and leave the rest
6587 The hashing function used tries to distribute the hosts evenly. First, it
6588 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
6591 for (i = 0; host[i] != 0; i++)
6592 hash_value = (hash_value * 251) + host[i];
6594 The constant 251 is a prime number which is supposed to make this hash value
6595 more random. The code then checks the group for this host according to the
6596 I<Total> and I<Match> arguments:
6598 if ((hash_value % Total) == Match)
6603 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
6604 groups), then the least significant bit of the hash value will be the XOR of
6605 all least significant bits in the host name. One consequence is that when you
6606 have two hosts, "server0.example.com" and "server1.example.com", where the host
6607 name differs in one digit only and the digits differ by one, those hosts will
6608 never end up in the same group.
6614 =item B<Match> I<Match> I<Total>
6616 Divide the data into I<Total> groups and match all hosts in group I<Match> as
6617 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
6618 be smaller than I<Total>. I<Total> must be at least one, although only values
6619 greater than one really do make any sense.
6621 You can repeat this option to match multiple groups, for example:
6626 The above config will divide the data into seven groups and match groups three
6627 and five. One use would be to keep every value on two hosts so that if one
6628 fails the missing data can later be reconstructed from the second host.
6634 # Operate on the pre-cache chain, so that ignored values are not even in the
6639 # Divide all received hosts in seven groups and accept all hosts in
6643 # If matched: Return and continue.
6646 # If not matched: Return and stop.
6652 =head2 Available targets
6656 =item B<notification>
6658 Creates and dispatches a notification.
6664 =item B<Message> I<String>
6666 This required option sets the message of the notification. The following
6667 placeholders will be replaced by an appropriate value:
6675 =item B<%{plugin_instance}>
6679 =item B<%{type_instance}>
6681 These placeholders are replaced by the identifier field of the same name.
6683 =item B<%{ds:>I<name>B<}>
6685 These placeholders are replaced by a (hopefully) human readable representation
6686 of the current rate of this data source. If you changed the instance name
6687 (using the B<set> or B<replace> targets, see below), it may not be possible to
6688 convert counter values to rates.
6692 Please note that these placeholders are B<case sensitive>!
6694 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
6696 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
6703 <Target "notification">
6704 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
6710 Replaces parts of the identifier using regular expressions.
6716 =item B<Host> I<Regex> I<Replacement>
6718 =item B<Plugin> I<Regex> I<Replacement>
6720 =item B<PluginInstance> I<Regex> I<Replacement>
6722 =item B<TypeInstance> I<Regex> I<Replacement>
6724 Match the appropriate field with the given regular expression I<Regex>. If the
6725 regular expression matches, that part that matches is replaced with
6726 I<Replacement>. If multiple places of the input buffer match a given regular
6727 expression, only the first occurrence will be replaced.
6729 You can specify each option multiple times to use multiple regular expressions
6737 # Replace "example.net" with "example.com"
6738 Host "\\<example.net\\>" "example.com"
6740 # Strip "www." from hostnames
6746 Sets part of the identifier of a value to a given string.
6752 =item B<Host> I<String>
6754 =item B<Plugin> I<String>
6756 =item B<PluginInstance> I<String>
6758 =item B<TypeInstance> I<String>
6760 Set the appropriate field to the given string. The strings for plugin instance
6761 and type instance may be empty, the strings for host and plugin may not be
6762 empty. It's currently not possible to set the type of a value this way.
6769 PluginInstance "coretemp"
6770 TypeInstance "core3"
6775 =head2 Backwards compatibility
6777 If you use collectd with an old configuration, i.E<nbsp>e. one without a
6778 B<Chain> block, it will behave as it used to. This is equivalent to the
6779 following configuration:
6785 If you specify a B<PostCacheChain>, the B<write> target will not be added
6786 anywhere and you will have to make sure that it is called where appropriate. We
6787 suggest to add the above snippet as default target to your "PostCache" chain.
6791 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
6807 L<collectd-exec(5)>,
6808 L<collectd-perl(5)>,
6809 L<collectd-unixsock(5)>,
6822 Florian Forster E<lt>octo@verplant.orgE<gt>