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<cgroups>
857 This plugin collects the CPU user/system time for each I<cgroup> by reading the
858 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
859 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
863 =item B<CGroup> I<Directory>
865 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
866 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
869 =item B<IgnoreSelected> B<true>|B<false>
871 Invert the selection: If set to true, all cgroups I<except> the ones that
872 match any one of the criteria are collected. By default only selected
873 cgroups are collected if a selection is made. If no selection is configured
874 at all, B<all> cgroups are selected.
878 =head2 Plugin C<cpufreq>
880 This plugin doesn't have any options. It reads
881 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
882 installed) to get the current CPU frequency. If this file does not exist make
883 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
884 installed and an "cpu governor" (that's a kernel module) is loaded.
890 =item B<DataDir> I<Directory>
892 Set the directory to store CSV-files under. Per default CSV-files are generated
893 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
894 The special strings B<stdout> and B<stderr> can be used to write to the standard
895 output and standard error channels, respectively. This, of course, only makes
896 much sense when collectd is running in foreground- or non-daemon-mode.
898 =item B<StoreRates> B<true|false>
900 If set to B<true>, convert counter values to rates. If set to B<false> (the
901 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
906 =head2 Plugin C<curl>
908 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
909 and the match infrastructure (the same code used by the tail plugin) to use
910 regular expressions with the received data.
912 The following example will read the current value of AMD stock from Google's
913 finance page and dispatch the value to collectd.
916 <Page "stock_quotes">
917 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
921 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
922 DSType "GaugeAverage"
923 # Note: `stock_value' is not a standard type.
930 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
931 a web page and one or more "matches" to be performed on the returned data. The
932 string argument to the B<Page> block is used as plugin instance.
934 The following options are valid within B<Page> blocks:
940 URL of the web site to retrieve. Since a regular expression will be used to
941 extract information from this data, non-binary data is a big plus here ;)
943 =item B<User> I<Name>
945 Username to use if authorization is required to read the page.
947 =item B<Password> I<Password>
949 Password to use if authorization is required to read the page.
951 =item B<VerifyPeer> B<true>|B<false>
953 Enable or disable peer SSL certificate verification. See
954 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
956 =item B<VerifyHost> B<true>|B<false>
958 Enable or disable peer host name verification. If enabled, the plugin checks if
959 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
960 matches the host name provided by the B<URL> option. If this identity check
961 fails, the connection is aborted. Obviously, only works when connecting to a
962 SSL enabled server. Enabled by default.
964 =item B<CACert> I<file>
966 File that holds one or more SSL certificates. If you want to use HTTPS you will
967 possibly need this option. What CA certificates come bundled with C<libcurl>
968 and are checked by default depends on the distribution you use.
970 =item B<Header> I<Header>
972 A HTTP header to add to the request. Multiple headers are added if this option
973 is specified more than once.
975 =item B<Post> I<Body>
977 Specifies that the HTTP operation should be a POST instead of a GET. The
978 complete data to be posted is given as the argument. This option will usually
979 need to be accompanied by a B<Header> option to set an appropriate
980 C<Content-Type> for the post body (e.g. to
981 C<application/x-www-form-urlencoded>).
983 =item B<MeasureResponseTime> B<true>|B<false>
985 Measure response time for the request. If this setting is enabled, B<Match>
986 blocks (see below) are optional. Disabled by default.
988 =item B<E<lt>MatchE<gt>>
990 One or more B<Match> blocks that define how to match information in the data
991 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
992 used by the C<tail> plugin, so please see the documentation of the C<tail>
993 plugin below on how matches are defined. If the B<MeasureResponseTime> option
994 is set to B<true>, B<Match> blocks are optional.
998 =head2 Plugin C<curl_json>
1000 The B<curl_json plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and
1001 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) to retrieve JSON data
1002 via cURL. This can be used to collect values from CouchDB documents (which are
1003 stored JSON notation), for example.
1005 The following example will collect several values from the built-in `_stats'
1006 runtime statistics module of CouchDB
1007 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1010 <URL "http://localhost:5984/_stats">
1012 <Key "httpd/requests/count">
1013 Type "http_requests"
1016 <Key "httpd_request_methods/*/count">
1017 Type "http_request_methods"
1020 <Key "httpd_status_codes/*/count">
1021 Type "http_response_codes"
1026 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining
1027 a URL to be fetched via HTTP (using libcurl) and one or more B<Key> blocks.
1028 The B<Key> string argument must be in a path format, which is used to collect a
1029 value from a JSON map object. If a path element of B<Key> is the
1030 I<*>E<nbsp>wildcard, the values for all keys will be collectd.
1032 The following options are valid within B<URL> blocks:
1036 =item B<Instance> I<Instance>
1038 Sets the plugin instance to I<Instance>.
1040 =item B<User> I<Name>
1041 =item B<Password> I<Password>
1042 =item B<VerifyPeer> B<true>|B<false>
1043 =item B<VerifyHost> B<true>|B<false>
1044 =item B<CACert> I<file>
1045 =item B<Header> I<Header>
1046 =item B<Post> I<Body>
1048 These options behave exactly equivalent to the appropriate options of the
1049 I<cURL> plugin. Please see there for a detailed description.
1053 The following options are valid within B<Key> blocks:
1057 =item B<Type> I<Type>
1059 Sets the type used to dispatch the values to the daemon. Detailed information
1060 about types and their configuration can be found in L<types.db(5)>. This
1061 option is mandatory.
1063 =item B<Instance> I<Instance>
1065 Type-instance to use. Defaults to the current map key or current string array element value.
1069 =head2 Plugin C<curl_xml>
1071 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1072 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1075 <URL "http://localhost/stats.xml">
1077 Instance "some_instance"
1082 CACert "/path/to/ca.crt"
1084 <XPath "table[@id=\"magic_level\"]/tr">
1086 #InstancePrefix "prefix-"
1087 InstanceFrom "td[1]"
1088 ValuesFrom "td[2]/span[@class=\"level\"]"
1093 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1094 URL to be fetched using libcurl. Within each B<URL> block there are
1095 options which specify the connection parameters, for example authentication
1096 information, and one or more B<XPath> blocks.
1098 Each B<XPath> block specifies how to get one type of information. The
1099 string argument must be a valid XPath expression which returns a list
1100 of "base elements". One value is dispatched for each "base element". The
1101 I<type instance> and values are looked up using further I<XPath> expressions
1102 that should be relative to the base element.
1104 Within the B<URL> block the following options are accepted:
1108 =item B<Host> I<Name>
1110 Use I<Name> as the host name when submitting values. Defaults to the global
1113 =item B<Instance> I<Instance>
1115 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1116 empty string (no plugin instance).
1118 =item B<Namespace> I<Prefix> I<URL>
1120 If an XPath expression references namespaces, they must be specified
1121 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1122 I<URL> is the "namespace name", an URI reference uniquely identifying the
1123 namespace. The option can be repeated to register multiple namespaces.
1127 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1128 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1130 =item B<User> I<User>
1132 =item B<Password> I<Password>
1134 =item B<VerifyPeer> B<true>|B<false>
1136 =item B<VerifyHost> B<true>|B<false>
1138 =item B<CACert> I<CA Cert File>
1140 =item B<Header> I<Header>
1142 =item B<Post> I<Body>
1144 These options behave exactly equivalent to the appropriate options of the
1145 I<cURL plugin>. Please see there for a detailed description.
1147 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1149 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1150 B<XPath> block specifies how to get one type of information. The string
1151 argument must be a valid XPath expression which returns a list of "base
1152 elements". One value is dispatched for each "base element".
1154 Within the B<XPath> block the following options are accepted:
1158 =item B<Type> I<Type>
1160 Specifies the I<Type> used for submitting patches. This determines the number
1161 of values that are required / expected and whether the strings are parsed as
1162 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1163 This option is required.
1165 =item B<InstancePrefix> I<InstancePrefix>
1167 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1168 concatenated together without any separator.
1169 This option is optional.
1171 =item B<InstanceFrom> I<InstanceFrom>
1173 Specifies a XPath expression to use for determining the I<type instance>. The
1174 XPath expression must return exactly one element. The element's value is then
1175 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1177 This value is required. As a special exception, if the "base XPath expression"
1178 (the argument to the B<XPath> block) returns exactly one argument, then this
1179 option may be omitted.
1181 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1183 Specifies one or more XPath expression to use for reading the values. The
1184 number of XPath expressions must match the number of data sources in the
1185 I<type> specified with B<Type> (see above). Each XPath expression must return
1186 exactly one element. The element's value is then parsed as a number and used as
1187 value for the appropriate value in the value list dispatched to the daemon.
1193 =head2 Plugin C<dbi>
1195 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1196 connect to various databases, execute I<SQL> statements and read back the
1197 results. I<dbi> is an acronym for "database interface" in case you were
1198 wondering about the name. You can configure how each column is to be
1199 interpreted and the plugin will generate one or more data sets from each row
1200 returned according to these rules.
1202 Because the plugin is very generic, the configuration is a little more complex
1203 than those of other plugins. It usually looks something like this:
1206 <Query "out_of_stock">
1207 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1208 # Use with MySQL 5.0.0 or later
1212 InstancePrefix "out_of_stock"
1213 InstancesFrom "category"
1217 <Database "product_information">
1219 DriverOption "host" "localhost"
1220 DriverOption "username" "collectd"
1221 DriverOption "password" "aZo6daiw"
1222 DriverOption "dbname" "prod_info"
1223 SelectDB "prod_info"
1224 Query "out_of_stock"
1228 The configuration above defines one query with one result and one database. The
1229 query is then linked to the database with the B<Query> option I<within> the
1230 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1231 and you can also use the B<Include> statement to split up the configuration
1232 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1233 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1236 The following is a complete list of options:
1238 =head3 B<Query> blocks
1240 Query blocks define I<SQL> statements and how the returned data should be
1241 interpreted. They are identified by the name that is given in the opening line
1242 of the block. Thus the name needs to be unique. Other than that, the name is
1243 not used in collectd.
1245 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1246 define which column holds which value or instance information. You can use
1247 multiple B<Result> blocks to create multiple values from one returned row. This
1248 is especially useful, when queries take a long time and sending almost the same
1249 query again and again is not desirable.
1253 <Query "environment">
1254 Statement "select station, temperature, humidity from environment"
1257 # InstancePrefix "foo"
1258 InstancesFrom "station"
1259 ValuesFrom "temperature"
1263 InstancesFrom "station"
1264 ValuesFrom "humidity"
1268 The following options are accepted:
1272 =item B<Statement> I<SQL>
1274 Sets the statement that should be executed on the server. This is B<not>
1275 interpreted by collectd, but simply passed to the database server. Therefore,
1276 the SQL dialect that's used depends on the server collectd is connected to.
1278 The query has to return at least two columns, one for the instance and one
1279 value. You cannot omit the instance, even if the statement is guaranteed to
1280 always return exactly one line. In that case, you can usually specify something
1283 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1285 (That works with MySQL but may not be valid SQL according to the spec. If you
1286 use a more strict database server, you may have to select from a dummy table or
1289 Please note that some databases, for example B<Oracle>, will fail if you
1290 include a semicolon at the end of the statement.
1292 =item B<MinVersion> I<Version>
1294 =item B<MaxVersion> I<Value>
1296 Only use this query for the specified database version. You can use these
1297 options to provide multiple queries with the same name but with a slightly
1298 different syntax. The plugin will use only those queries, where the specified
1299 minimum and maximum versions fit the version of the database in use.
1301 The database version is determined by C<dbi_conn_get_engine_version>, see the
1302 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1303 for details. Basically, each part of the version is assumed to be in the range
1304 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1305 "40102", version "5.0.42" becomes "50042".
1307 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1308 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1309 happen. Don't to it! A valid example would be something along these lines:
1320 In the above example, there are three ranges that don't overlap. The last one
1321 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1322 before "4.0.0" are not specified.
1324 =item B<Type> I<Type>
1326 The B<type> that's used for each line returned. See L<types.db(5)> for more
1327 details on how types are defined. In short: A type is a predefined layout of
1328 data and the number of values and type of values has to match the type
1331 If you specify "temperature" here, you need exactly one gauge column. If you
1332 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1335 There must be exactly one B<Type> option inside each B<Result> block.
1337 =item B<InstancePrefix> I<prefix>
1339 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1340 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1341 all strings returned in the appropriate columns are concatenated together,
1342 separated by dashes I<("-")>.
1344 =item B<InstancesFrom> I<column0> [I<column1> ...]
1346 Specifies the columns whose values will be used to create the "type-instance"
1347 for each row. If you specify more than one column, the value of all columns
1348 will be joined together with dashes I<("-")> as separation characters.
1350 The plugin itself does not check whether or not all built instances are
1351 different. It's your responsibility to assure that each is unique. This is
1352 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1353 sure that only one row is returned in this case.
1355 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1358 =item B<ValuesFrom> I<column0> [I<column1> ...]
1360 Names the columns whose content is used as the actual data for the data sets
1361 that are dispatched to the daemon. How many such columns you need is determined
1362 by the B<Type> setting above. If you specify too many or not enough columns,
1363 the plugin will complain about that and no data will be submitted to the
1366 The actual data type in the columns is not that important. The plugin will
1367 automatically cast the values to the right type if it know how to do that. So
1368 it should be able to handle integer an floating point types, as well as strings
1369 (if they include a number at the beginning).
1371 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1375 =head3 B<Database> blocks
1377 Database blocks define a connection to a database and which queries should be
1378 sent to that database. Since the used "dbi" library can handle a wide variety
1379 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1380 documentationE<nbsp>- we stick as close to the terminology used there.
1382 Each database needs a "name" as string argument in the starting tag of the
1383 block. This name will be used as "PluginInstance" in the values submitted to
1384 the daemon. Other than that, that name is not used.
1388 =item B<Driver> I<Driver>
1390 Specifies the driver to use to connect to the database. In many cases those
1391 drivers are named after the database they can connect to, but this is not a
1392 technical necessity. These drivers are sometimes referred to as "DBD",
1393 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1394 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1395 project at L<http://libdbi-drivers.sourceforge.net/>.
1397 You need to give the driver name as expected by the "dbi" library here. You
1398 should be able to find that in the documentation for each driver. If you
1399 mistype the driver name, the plugin will dump a list of all known driver names
1402 =item B<DriverOption> I<Key> I<Value>
1404 Sets driver-specific options. What option a driver supports can be found in the
1405 documentation for each driver, somewhere at
1406 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1407 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1409 DBDs can register two types of options: String options and numeric options. The
1410 plugin will use the C<dbi_conn_set_option> function when the configuration
1411 provides a string and the C<dbi_conn_require_option_numeric> function when the
1412 configuration provides a number. So these two lines will actually result in
1413 different calls being used:
1415 DriverOption "Port" 1234 # numeric
1416 DriverOption "Port" "1234" # string
1418 Unfortunately, drivers are not too keen to report errors when an unknown option
1419 is passed to them, so invalid settings here may go unnoticed. This is not the
1420 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1421 the driver. If a driver complains about an option, the plugin will dump a
1422 complete list of all options understood by that driver to the log. There is no
1423 way to programatically find out if an option expects a string or a numeric
1424 argument, so you will have to refer to the appropriate DBD's documentation to
1425 find this out. Sorry.
1427 =item B<SelectDB> I<Database>
1429 In some cases, the database name you connect with is not the database name you
1430 want to use for querying data. If this option is set, the plugin will "select"
1431 (switch to) that database after the connection is established.
1433 =item B<Query> I<QueryName>
1435 Associates the query named I<QueryName> with this database connection. The
1436 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1437 blocks you want to refer to must be placed above the database block you want to
1440 =item B<Host> I<Hostname>
1442 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
1443 values. Defaults to the global hostname setting.
1451 =item B<Device> I<Device>
1453 Select partitions based on the devicename.
1455 =item B<MountPoint> I<Directory>
1457 Select partitions based on the mountpoint.
1459 =item B<FSType> I<FSType>
1461 Select partitions based on the filesystem type.
1463 =item B<IgnoreSelected> B<true>|B<false>
1465 Invert the selection: If set to true, all partitions B<except> the ones that
1466 match any one of the criteria are collected. By default only selected
1467 partitions are collected if a selection is made. If no selection is configured
1468 at all, B<all> partitions are selected.
1470 =item B<ReportByDevice> B<true>|B<false>
1472 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1473 (the default), it will report a disk as "root", but with it I<true>, it will be
1474 "sda1" (or whichever).
1476 =item B<ReportInodes> B<true>|B<false>
1478 Enables or disables reporting of free, reserved and used inodes. Defaults to
1479 inode collection being disabled.
1481 Enable this option if inodes are a scarce resource for you, usually because
1482 many small files are stored on the disk. This is a usual scenario for mail
1483 transfer agents and web caches.
1487 =head2 Plugin C<disk>
1489 The C<disk> plugin collects information about the usage of physical disks and
1490 logical disks (partitions). Values collected are the number of octets written
1491 to and read from a disk or partition, the number of read/write operations
1492 issued to the disk and a rather complex "time" it took for these commands to be
1495 Using the following two options you can ignore some disks or configure the
1496 collection only of specific disks.
1500 =item B<Disk> I<Name>
1502 Select the disk I<Name>. Whether it is collected or ignored depends on the
1503 B<IgnoreSelected> setting, see below. As with other plugins that use the
1504 daemon's ignorelist functionality, a string that starts and ends with a slash
1505 is interpreted as a regular expression. Examples:
1510 =item B<IgnoreSelected> B<true>|B<false>
1512 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1513 statements, are ignored or if all other disks are ignored. The behavior
1514 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1515 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1516 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1517 is set to B<true>, all disks are collected B<except> the ones matched.
1521 =head2 Plugin C<dns>
1525 =item B<Interface> I<Interface>
1527 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1528 option sets the interface that should be used. If this option is not set, or
1529 set to "any", the plugin will try to get packets from B<all> interfaces. This
1530 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1532 =item B<IgnoreSource> I<IP-address>
1534 Ignore packets that originate from this address.
1536 =item B<SelectNumericQueryTypes> B<true>|B<false>
1538 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1542 =head2 Plugin C<email>
1546 =item B<SocketFile> I<Path>
1548 Sets the socket-file which is to be created.
1550 =item B<SocketGroup> I<Group>
1552 If running as root change the group of the UNIX-socket after it has been
1553 created. Defaults to B<collectd>.
1555 =item B<SocketPerms> I<Permissions>
1557 Change the file permissions of the UNIX-socket after it has been created. The
1558 permissions must be given as a numeric, octal value as you would pass to
1559 L<chmod(1)>. Defaults to B<0770>.
1561 =item B<MaxConns> I<Number>
1563 Sets the maximum number of connections that can be handled in parallel. Since
1564 this many threads will be started immediately setting this to a very high
1565 value will waste valuable resources. Defaults to B<5> and will be forced to be
1566 at most B<16384> to prevent typos and dumb mistakes.
1570 =head2 Plugin C<ethstat>
1572 The I<ethstat plugin> collects information about network interface cards (NICs)
1573 by talking directly with the underlying kernel driver using L<ioctl(2)>.
1579 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
1580 Map "multicast" "if_multicast"
1587 =item B<Interface> I<Name>
1589 Collect statistical information about interface I<Name>.
1591 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
1593 By default, the plugin will submit values as type C<derive> and I<type
1594 instance> set to I<Name>, the name of the metric as reported by the driver. If
1595 an appropriate B<Map> option exists, the given I<Type> and, optionally,
1596 I<TypeInstance> will be used.
1598 =item B<MappedOnly> B<true>|B<false>
1600 When set to B<true>, only metrics that can be mapped to to a I<type> will be
1601 collected, all other metrics will be ignored. Defaults to B<false>.
1605 =head2 Plugin C<exec>
1607 Please make sure to read L<collectd-exec(5)> before using this plugin. It
1608 contains valuable information on when the executable is executed and the
1609 output that is expected from it.
1613 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1615 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1617 Execute the executable I<Executable> as user I<User>. If the user name is
1618 followed by a colon and a group name, the effective group is set to that group.
1619 The real group and saved-set group will be set to the default group of that
1620 user. If no group is given the effective group ID will be the same as the real
1623 Please note that in order to change the user and/or group the daemon needs
1624 superuser privileges. If the daemon is run as an unprivileged user you must
1625 specify the same user/group here. If the daemon is run with superuser
1626 privileges, you must supply a non-root user here.
1628 The executable may be followed by optional arguments that are passed to the
1629 program. Please note that due to the configuration parsing numbers and boolean
1630 values may be changed. If you want to be absolutely sure that something is
1631 passed as-is please enclose it in quotes.
1633 The B<Exec> and B<NotificationExec> statements change the semantics of the
1634 programs executed, i.E<nbsp>e. the data passed to them and the response
1635 expected from them. This is documented in great detail in L<collectd-exec(5)>.
1639 =head2 Plugin C<filecount>
1641 The C<filecount> plugin counts the number of files in a certain directory (and
1642 its subdirectories) and their combined size. The configuration is very straight
1645 <Plugin "filecount">
1646 <Directory "/var/qmail/queue/mess">
1647 Instance "qmail-message"
1649 <Directory "/var/qmail/queue/todo">
1650 Instance "qmail-todo"
1652 <Directory "/var/lib/php5">
1653 Instance "php5-sessions"
1658 The example above counts the number of files in QMail's queue directories and
1659 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
1660 QMail has not yet looked at, the "message" queue holds the messages that were
1661 classified into "local" and "remote".
1663 As you can see, the configuration consists of one or more C<Directory> blocks,
1664 each of which specifies a directory in which to count the files. Within those
1665 blocks, the following options are recognized:
1669 =item B<Instance> I<Instance>
1671 Sets the plugin instance to I<Instance>. That instance name must be unique, but
1672 it's your responsibility, the plugin doesn't check for that. If not given, the
1673 instance is set to the directory name with all slashes replaced by underscores
1674 and all leading underscores removed.
1676 =item B<Name> I<Pattern>
1678 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
1679 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
1680 against the pattern, not the entire path. In case this makes it easier for you:
1681 This option has been named after the B<-name> parameter to L<find(1)>.
1683 =item B<MTime> I<Age>
1685 Count only files of a specific age: If I<Age> is greater than zero, only files
1686 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
1687 a negative number, this is inversed. For example, if B<-60> is specified, only
1688 files that have been modified in the last minute will be counted.
1690 The number can also be followed by a "multiplier" to easily specify a larger
1691 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
1692 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
1693 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
1694 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
1695 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
1698 =item B<Size> I<Size>
1700 Count only files of a specific size. When I<Size> is a positive number, only
1701 files that are at least this big are counted. If I<Size> is a negative number,
1702 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
1703 I<Size> are counted.
1705 As with the B<MTime> option, a "multiplier" may be added. For a detailed
1706 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
1707 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
1708 note that there are 1000 bytes in a kilobyte, not 1024.
1710 =item B<Recursive> I<true>|I<false>
1712 Controls whether or not to recurse into subdirectories. Enabled by default.
1714 =item B<IncludeHidden> I<true>|I<false>
1716 Controls whether or not to include "hidden" files and directories in the count.
1717 "Hidden" files and directories are those, whose name begins with a dot.
1718 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
1722 =head2 Plugin C<GenericJMX>
1724 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
1725 L<collectd-java(5)>.
1727 =head2 Plugin C<gmond>
1729 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
1730 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
1731 are built-in, custom mappings may be added via B<Metric> blocks, see below.
1736 MCReceiveFrom "239.2.11.71" "8649"
1737 <Metric "swap_total">
1739 TypeInstance "total"
1742 <Metric "swap_free">
1749 The following metrics are built-in:
1755 load_one, load_five, load_fifteen
1759 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
1763 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
1775 Available configuration options:
1779 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
1781 Sets sets the multicast group and UDP port to which to subscribe.
1783 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
1785 =item E<lt>B<Metric> I<Name>E<gt>
1787 These blocks add a new metric conversion to the internal table. I<Name>, the
1788 string argument to the B<Metric> block, is the metric name as used by Ganglia.
1792 =item B<Type> I<Type>
1794 Type to map this metric to. Required.
1796 =item B<TypeInstance> I<Instance>
1798 Type-instance to use. Optional.
1800 =item B<DataSource> I<Name>
1802 Data source to map this metric to. If the configured type has exactly one data
1803 source, this is optional. Otherwise the option is required.
1809 =head2 Plugin C<hddtemp>
1811 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
1812 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
1813 default values, see below. C<hddtemp> has to be running to work correctly. If
1814 C<hddtemp> is not running timeouts may appear which may interfere with other
1817 The B<hddtemp> homepage can be found at
1818 L<http://www.guzu.net/linux/hddtemp.php>.
1822 =item B<Host> I<Hostname>
1824 Hostname to connect to. Defaults to B<127.0.0.1>.
1826 =item B<Port> I<Port>
1828 TCP-Port to connect to. Defaults to B<7634>.
1832 =head2 Plugin C<interface>
1836 =item B<Interface> I<Interface>
1838 Select this interface. By default these interfaces will then be collected. For
1839 a more detailed description see B<IgnoreSelected> below.
1841 =item B<IgnoreSelected> I<true>|I<false>
1843 If no configuration if given, the B<traffic>-plugin will collect data from
1844 all interfaces. This may not be practical, especially for loopback- and
1845 similar interfaces. Thus, you can use the B<Interface>-option to pick the
1846 interfaces you're interested in. Sometimes, however, it's easier/preferred
1847 to collect all interfaces I<except> a few ones. This option enables you to
1848 do that: By setting B<IgnoreSelected> to I<true> the effect of
1849 B<Interface> is inverted: All selected interfaces are ignored and all
1850 other interfaces are collected.
1854 =head2 Plugin C<ipmi>
1858 =item B<Sensor> I<Sensor>
1860 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
1862 =item B<IgnoreSelected> I<true>|I<false>
1864 If no configuration if given, the B<ipmi> plugin will collect data from all
1865 sensors found of type "temperature", "voltage", "current" and "fanspeed".
1866 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
1867 the effect of B<Sensor> is inverted: All selected sensors are ignored and
1868 all other sensors are collected.
1870 =item B<NotifySensorAdd> I<true>|I<false>
1872 If a sensor appears after initialization time of a minute a notification
1875 =item B<NotifySensorRemove> I<true>|I<false>
1877 If a sensor disappears a notification is sent.
1879 =item B<NotifySensorNotPresent> I<true>|I<false>
1881 If you have for example dual power supply and one of them is (un)plugged then
1882 a notification is sent.
1886 =head2 Plugin C<iptables>
1890 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
1892 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
1893 will collect the counters of all rules which have a comment-match. The comment
1894 is then used as type-instance.
1896 If I<Comment> or I<Number> is given, only the rule with the matching comment or
1897 the I<n>th rule will be collected. Again, the comment (or the number) will be
1898 used as the type-instance.
1900 If I<Name> is supplied, it will be used as the type-instance instead of the
1901 comment or the number.
1905 =head2 Plugin C<irq>
1911 Select this irq. By default these irqs will then be collected. For a more
1912 detailed description see B<IgnoreSelected> below.
1914 =item B<IgnoreSelected> I<true>|I<false>
1916 If no configuration if given, the B<irq>-plugin will collect data from all
1917 irqs. This may not be practical, especially if no interrupts happen. Thus, you
1918 can use the B<Irq>-option to pick the interrupt you're interested in.
1919 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
1920 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
1921 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
1922 and all other interrupts are collected.
1926 =head2 Plugin C<java>
1928 The I<Java> plugin makes it possible to write extensions for collectd in Java.
1929 This section only discusses the syntax and semantic of the configuration
1930 options. For more in-depth information on the I<Java> plugin, please read
1931 L<collectd-java(5)>.
1936 JVMArg "-verbose:jni"
1937 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
1938 LoadPlugin "org.collectd.java.Foobar"
1939 <Plugin "org.collectd.java.Foobar">
1940 # To be parsed by the plugin
1944 Available configuration options:
1948 =item B<JVMArg> I<Argument>
1950 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
1951 exactly the way the arguments to the I<java> binary on the command line work.
1952 Execute C<javaE<nbsp>--help> for details.
1954 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
1955 any other options! When another option is found, the JVM will be started and
1956 later options will have to be ignored!
1958 =item B<LoadPlugin> I<JavaClass>
1960 Instantiates a new I<JavaClass> object. The constructor of this object very
1961 likely then registers one or more callback methods with the server.
1963 See L<collectd-java(5)> for details.
1965 When the first such option is found, the virtual machine (JVM) is created. This
1966 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
1967 B<LoadPlugin> options!
1969 =item B<Plugin> I<Name>
1971 The entire block is passed to the Java plugin as an
1972 I<org.collectd.api.OConfigItem> object.
1974 For this to work, the plugin has to register a configuration callback first,
1975 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
1976 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
1977 depends on the (Java) plugin registering the callback and is completely
1978 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
1982 =head2 Plugin C<libvirt>
1984 This plugin allows CPU, disk and network load to be collected for virtualized
1985 guests on the machine. This means that these characteristics can be collected
1986 for guest systems without installing any software on them - collectd only runs
1987 on the hosting system. The statistics are collected through libvirt
1988 (L<http://libvirt.org/>).
1990 Only I<Connection> is required.
1994 =item B<Connection> I<uri>
1996 Connect to the hypervisor given by I<uri>. For example if using Xen use:
1998 Connection "xen:///"
2000 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
2002 =item B<RefreshInterval> I<seconds>
2004 Refresh the list of domains and devices every I<seconds>. The default is 60
2005 seconds. Setting this to be the same or smaller than the I<Interval> will cause
2006 the list of domains and devices to be refreshed on every iteration.
2008 Refreshing the devices in particular is quite a costly operation, so if your
2009 virtualization setup is static you might consider increasing this. If this
2010 option is set to 0, refreshing is disabled completely.
2012 =item B<Domain> I<name>
2014 =item B<BlockDevice> I<name:dev>
2016 =item B<InterfaceDevice> I<name:dev>
2018 =item B<IgnoreSelected> I<true>|I<false>
2020 Select which domains and devices are collected.
2022 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
2023 disk/network devices are collected.
2025 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
2026 domains and disk/network devices are ignored, while the rest are collected.
2028 The domain name and device names may use a regular expression, if the name is
2029 surrounded by I</.../> and collectd was compiled with support for regexps.
2031 The default is to collect statistics for all domains and all their devices.
2035 BlockDevice "/:hdb/"
2036 IgnoreSelected "true"
2038 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
2041 =item B<HostnameFormat> B<name|uuid|hostname|...>
2043 When the libvirt plugin logs data, it sets the hostname of the collected data
2044 according to this setting. The default is to use the guest name as provided by
2045 the hypervisor, which is equal to setting B<name>.
2047 B<uuid> means use the guest's UUID. This is useful if you want to track the
2048 same guest across migrations.
2050 B<hostname> means to use the global B<Hostname> setting, which is probably not
2051 useful on its own because all guests will appear to have the same name.
2053 You can also specify combinations of these fields. For example B<name uuid>
2054 means to concatenate the guest name and UUID (with a literal colon character
2055 between, thus I<"foo:1234-1234-1234-1234">).
2057 =item B<InterfaceFormat> B<name>|B<address>
2059 When the libvirt plugin logs interface data, it sets the name of the collected
2060 data according to this setting. The default is to use the path as provided by
2061 the hypervisor (the "dev" property of the target node), which is equal to
2064 B<address> means use the interface's mac address. This is useful since the
2065 interface path might change between reboots of a guest or across migrations.
2069 =head2 Plugin C<logfile>
2073 =item B<LogLevel> B<debug|info|notice|warning|err>
2075 Sets the log-level. If, for example, set to B<notice>, then all events with
2076 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2078 Please note that B<debug> is only available if collectd has been compiled with
2081 =item B<File> I<File>
2083 Sets the file to write log messages to. The special strings B<stdout> and
2084 B<stderr> can be used to write to the standard output and standard error
2085 channels, respectively. This, of course, only makes much sense when I<collectd>
2086 is running in foreground- or non-daemon-mode.
2088 =item B<Timestamp> B<true>|B<false>
2090 Prefix all lines printed by the current time. Defaults to B<true>.
2092 =item B<PrintSeverity> B<true>|B<false>
2094 When enabled, all lines are prefixed by the severity of the log message, for
2095 example "warning". Defaults to B<false>.
2099 B<Note>: There is no need to notify the daemon after moving or removing the
2100 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2101 for each line it writes.
2103 =head2 Plugin C<lpar>
2105 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2106 virtualization technique for IBM POWER processors. It takes into account CPU
2107 time stolen from or donated to a partition, in addition to the usual user,
2108 system, I/O statistics.
2110 The following configuration options are available:
2114 =item B<CpuPoolStats> B<false>|B<true>
2116 When enabled, statistics about the processor pool are read, too. The partition
2117 needs to have pool authority in order to be able to acquire this information.
2120 =item B<ReportBySerial> B<false>|B<true>
2122 If enabled, the serial of the physical machine the partition is currently
2123 running on is reported as I<hostname> and the logical hostname of the machine
2124 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2125 used (just like other plugins) and the I<plugin instance> will be empty.
2130 =head2 Plugin C<mbmon>
2132 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2134 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2135 B<Host> and B<Port> options can be used to change these values, see below.
2136 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2137 timeouts may appear which may interfere with other statistics..
2139 C<mbmon> must be run with the -r option ("print TAG and Value format");
2140 Debian's F</etc/init.d/mbmon> script already does this, other people
2141 will need to ensure that this is the case.
2145 =item B<Host> I<Hostname>
2147 Hostname to connect to. Defaults to B<127.0.0.1>.
2149 =item B<Port> I<Port>
2151 TCP-Port to connect to. Defaults to B<411>.
2157 The C<md plugin> collects information from Linux Software-RAID devices (md).
2159 All reported values are of the type C<md_disks>. Reported type instances are
2160 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2161 I<missing> (physically absent) disks.
2165 =item B<Device> I<Device>
2167 Select md devices based on device name. The I<device name> is the basename of
2168 the device, i.e. the name of the block device without the leading C</dev/>.
2169 See B<IgnoreSelected> for more details.
2171 =item B<IgnoreSelected> B<true>|B<false>
2173 Invert device selection: If set to B<true>, all md devices B<except> those
2174 listed using B<Device> are collected. If B<false> (the default), only those
2175 listed are collected. If no configuration is given, the B<md> plugin will
2176 collect data from all md devices.
2180 =head2 Plugin C<memcachec>
2182 The C<memcachec plugin> connects to a memcached server, queries one or more
2183 given I<pages> and parses the returned data according to user specification.
2184 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2187 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2188 library. Please note that there is another library with a very similar name,
2189 libmemcache (notice the missing `d'), which is not applicable.
2191 Synopsis of the configuration:
2193 <Plugin "memcachec">
2194 <Page "plugin_instance">
2198 Regex "(\\d+) bytes sent"
2201 Instance "type_instance"
2206 The configuration options are:
2210 =item E<lt>B<Page> I<Name>E<gt>
2212 Each B<Page> block defines one I<page> to be queried from the memcached server.
2213 The block requires one string argument which is used as I<plugin instance>.
2215 =item B<Server> I<Address>
2217 Sets the server address to connect to when querying the page. Must be inside a
2222 When connected to the memcached server, asks for the page I<Key>.
2224 =item E<lt>B<Match>E<gt>
2226 Match blocks define which strings to look for and how matches substrings are
2227 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2231 =head2 Plugin C<memcached>
2233 The B<memcached plugin> connects to a memcached server and queries statistics
2234 about cache utilization, memory and bandwidth used.
2235 L<http://www.danga.com/memcached/>
2237 <Plugin "memcached">
2239 Host "memcache.example.com"
2244 The plugin configuration consists of one or more B<Instance> blocks which
2245 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2246 following options are allowed:
2250 =item B<Host> I<Hostname>
2252 Hostname to connect to. Defaults to B<127.0.0.1>.
2254 =item B<Port> I<Port>
2256 TCP-Port to connect to. Defaults to B<11211>.
2258 =item B<Socket> I<Path>
2260 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2261 setting is given, the B<Host> and B<Port> settings are ignored.
2265 =head2 Plugin C<mic>
2267 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2268 Intel's Many Integrated Core (MIC) systems.
2277 ShowTemperatures true
2280 IgnoreSelectedTemperature true
2285 IgnoreSelectedPower true
2288 The following options are valid inside the B<PluginE<nbsp>mic> block:
2292 =item B<ShowCPU> B<true>|B<false>
2294 If enabled (the default) a sum of the CPU usage accross all cores is reported.
2296 =item B<ShowCPUCores> B<true>|B<false>
2298 If enabled (the default) per-core CPU usage is reported.
2300 =item B<ShowMemory> B<true>|B<false>
2302 If enabled (the default) the physical memory usage of the MIC system is
2305 =item B<ShowTemperatures> B<true>|B<false>
2307 If enabled (the default) various temperatures of the MIC system are reported.
2309 =item B<Temperature> I<Name>
2311 This option controls which temperatures are being reported. Whether matching
2312 temperatures are being ignored or I<only> matching temperatures are reported
2313 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2314 temperatures are reported.
2316 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2318 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2319 (the default) only temperatures matching a B<Temperature> option are reported
2320 or, if no B<Temperature> option is specified, all temperatures are reported. If
2321 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2324 Known temperature names are:
2358 =item B<ShowPower> B<true>|B<false>
2360 If enabled (the default) various temperatures of the MIC system are reported.
2362 =item B<Power> I<Name>
2364 This option controls which power readings are being reported. Whether matching
2365 power readings are being ignored or I<only> matching power readings are reported
2366 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
2367 power readings are reported.
2369 =item B<IgnoreSelectedPower> B<false>|B<true>
2371 Controls the behavior of the B<Power> setting above. If set to B<false>
2372 (the default) only power readings matching a B<Power> option are reported
2373 or, if no B<Power> option is specified, all power readings are reported. If
2374 set to B<true>, matching power readings are I<ignored> and all other power readings
2377 Known power names are:
2383 Total power utilization averaged over Time Window 0 (uWatts).
2387 Total power utilization averaged over Time Window 0 (uWatts).
2391 Instantaneous power (uWatts).
2395 Max instantaneous power (uWatts).
2399 PCI-E connector power (uWatts).
2403 2x3 connector power (uWatts).
2407 2x4 connector power (uWatts).
2415 Uncore rail (uVolts).
2419 Memory subsystem rail (uVolts).
2425 =head2 Plugin C<modbus>
2427 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
2428 register values. It supports reading single registers (unsigned 16E<nbsp>bit
2429 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2430 values (two registers interpreted as IEEE floats in big endian notation).
2434 <Data "voltage-input-1">
2441 <Data "voltage-input-2">
2448 <Host "modbus.example.com">
2449 Address "192.168.0.42"
2454 Instance "power-supply"
2455 Collect "voltage-input-1"
2456 Collect "voltage-input-2"
2462 =item E<lt>B<Data> I<Name>E<gt> blocks
2464 Data blocks define a mapping between register numbers and the "types" used by
2467 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
2471 =item B<RegisterBase> I<Number>
2473 Configures the base register to read from the device. If the option
2474 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
2475 register will be read (the register number is increased by one).
2477 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
2479 Specifies what kind of data is returned by the device. If the type is B<Int32>,
2480 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
2481 combined into one value. Defaults to B<Uint16>.
2483 =item B<Type> I<Type>
2485 Specifies the "type" (data set) to use when dispatching the value to
2486 I<collectd>. Currently, only data sets with exactly one data source are
2489 =item B<Instance> I<Instance>
2491 Sets the type instance to use when dispatching the value to I<collectd>. If
2492 unset, an empty string (no type instance) is used.
2496 =item E<lt>B<Host> I<Name>E<gt> blocks
2498 Host blocks are used to specify to which hosts to connect and what data to read
2499 from their "slaves". The string argument I<Name> is used as hostname when
2500 dispatching the values to I<collectd>.
2502 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
2506 =item B<Address> I<Hostname>
2508 Specifies the node name (the actual network address) used to connect to the
2509 host. This may be an IP address or a hostname. Please note that the used
2510 I<libmodbus> library only supports IPv4 at the moment.
2512 =item B<Port> I<Service>
2514 Specifies the port used to connect to the host. The port can either be given as
2515 a number or as a service name. Please note that the I<Service> argument must be
2516 a string, even if ports are given in their numerical form. Defaults to "502".
2518 =item B<Interval> I<Interval>
2520 Sets the interval (in seconds) in which the values will be collected from this
2521 host. By default the global B<Interval> setting will be used.
2523 =item E<lt>B<Slave> I<ID>E<gt>
2525 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
2526 is used to specify which device should be addressed. For each device you want
2527 to query, one B<Slave> block must be given.
2529 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
2533 =item B<Instance> I<Instance>
2535 Specify the plugin instance to use when dispatching the values to I<collectd>.
2536 By default "slave_I<ID>" is used.
2538 =item B<Collect> I<DataName>
2540 Specifies which data to retrieve from the device. I<DataName> must be the same
2541 string as the I<Name> argument passed to a B<Data> block. You can specify this
2542 option multiple times to collect more than one value from a slave. At least one
2543 B<Collect> option is mandatory.
2551 =head2 Plugin C<mysql>
2553 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
2554 one or more databases when started and keeps the connection up as long as
2555 possible. When the connection is interrupted for whatever reason it will try
2556 to re-connect. The plugin will complain loudly in case anything goes wrong.
2558 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
2559 and collects information about MySQL network traffic, executed statements,
2560 requests, the query cache and threads by evaluating the
2561 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
2562 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
2563 Status Variables> for an explanation of these values.
2565 Optionally, master and slave statistics may be collected in a MySQL
2566 replication setup. In that case, information about the synchronization state
2567 of the nodes are collected by evaluating the C<Position> return value of the
2568 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
2569 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
2570 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
2571 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
2572 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
2587 Socket "/var/run/mysql/mysqld.sock"
2589 SlaveNotifications true
2593 A B<Database> block defines one connection to a MySQL database. It accepts a
2594 single argument which specifies the name of the database. None of the other
2595 options are required. MySQL will use default values as documented in the
2596 section "mysql_real_connect()" in the B<MySQL reference manual>.
2600 =item B<Host> I<Hostname>
2602 Hostname of the database server. Defaults to B<localhost>.
2604 =item B<User> I<Username>
2606 Username to use when connecting to the database. The user does not have to be
2607 granted any privileges (which is synonym to granting the C<USAGE> privilege),
2608 unless you want to collectd replication statistics (see B<MasterStats> and
2609 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
2610 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
2612 =item B<Password> I<Password>
2614 Password needed to log into the database.
2616 =item B<Database> I<Database>
2618 Select this database. Defaults to I<no database> which is a perfectly reasonable
2619 option for what this plugin does.
2621 =item B<Port> I<Port>
2623 TCP-port to connect to. The port must be specified in its numeric form, but it
2624 must be passed as a string nonetheless. For example:
2628 If B<Host> is set to B<localhost> (the default), this setting has no effect.
2629 See the documentation for the C<mysql_real_connect> function for details.
2631 =item B<Socket> I<Socket>
2633 Specifies the path to the UNIX domain socket of the MySQL server. This option
2634 only has any effect, if B<Host> is set to B<localhost> (the default).
2635 Otherwise, use the B<Port> option above. See the documentation for the
2636 C<mysql_real_connect> function for details.
2638 =item B<MasterStats> I<true|false>
2640 =item B<SlaveStats> I<true|false>
2642 Enable the collection of master / slave statistics in a replication setup. In
2643 order to be able to get access to these statistics, the user needs special
2644 privileges. See the B<User> documentation above.
2646 =item B<SlaveNotifications> I<true|false>
2648 If enabled, the plugin sends a notification if the replication slave I/O and /
2649 or SQL threads are not running.
2653 =head2 Plugin C<netapp>
2655 The netapp plugin can collect various performance and capacity information
2656 from a NetApp filer using the NetApp API.
2658 Please note that NetApp has a wide line of products and a lot of different
2659 software versions for each of these products. This plugin was developed for a
2660 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
2661 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
2662 model and software version but it is very hard to test this.
2663 If you have used this plugin with other models and/or software version, feel
2664 free to send us a mail to tell us about the results, even if it's just a short
2667 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
2668 basic authentication.
2670 B<Do not use a regular user for this!> Create a special collectd user with just
2671 the minimum of capabilities needed. The user only needs the "login-http-admin"
2672 capability as well as a few more depending on which data will be collected.
2673 Required capabilities are documented below.
2678 <Host "netapp1.example.com">
2702 IgnoreSelectedIO false
2704 IgnoreSelectedOps false
2705 GetLatency "volume0"
2706 IgnoreSelectedLatency false
2713 IgnoreSelectedCapacity false
2716 IgnoreSelectedSnapshot false
2744 The netapp plugin accepts the following configuration options:
2748 =item B<Host> I<Name>
2750 A host block defines one NetApp filer. It will appear in collectd with the name
2751 you specify here which does not have to be its real name nor its hostname (see
2752 the B<Address> option below).
2754 =item B<VFiler> I<Name>
2756 A B<VFiler> block may only be used inside a host block. It accepts all the
2757 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
2758 will execute all NetApp API commands in the context of the specified
2759 VFiler(R). It will appear in collectd with the name you specify here which
2760 does not have to be its real name. The VFiler name may be specified using the
2761 B<VFilerName> option. If this is not specified, it will default to the name
2764 The VFiler block inherits all connection related settings from the surrounding
2765 B<Host> block (which appear before the B<VFiler> block) but they may be
2766 overwritten inside the B<VFiler> block.
2768 This feature is useful, for example, when using a VFiler as SnapVault target
2769 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
2770 available in the host filer (vfiler0) but only in the respective VFiler
2773 =item B<Protocol> B<httpd>|B<http>
2775 The protocol collectd will use to query this host.
2783 Valid options: http, https
2785 =item B<Address> I<Address>
2787 The hostname or IP address of the host.
2793 Default: The "host" block's name.
2795 =item B<Port> I<Port>
2797 The TCP port to connect to on the host.
2803 Default: 80 for protocol "http", 443 for protocol "https"
2805 =item B<User> I<User>
2807 =item B<Password> I<Password>
2809 The username and password to use to login to the NetApp.
2815 =item B<VFilerName> I<Name>
2817 The name of the VFiler in which context to execute API commands. If not
2818 specified, the name provided to the B<VFiler> block will be used instead.
2824 Default: name of the B<VFiler> block
2826 B<Note:> This option may only be used inside B<VFiler> blocks.
2828 =item B<Interval> I<Interval>
2834 The following options decide what kind of data will be collected. You can
2835 either use them as a block and fine tune various parameters inside this block,
2836 use them as a single statement to just accept all default values, or omit it to
2837 not collect any data.
2839 The following options are valid inside all blocks:
2843 =item B<Interval> I<Seconds>
2845 Collect the respective statistics every I<Seconds> seconds. Defaults to the
2846 host specific setting.
2850 =head3 The System block
2852 This will collect various performance data about the whole system.
2854 B<Note:> To get this data the collectd user needs the
2855 "api-perf-object-get-instances" capability.
2859 =item B<Interval> I<Seconds>
2861 Collect disk statistics every I<Seconds> seconds.
2863 =item B<GetCPULoad> B<true>|B<false>
2865 If you set this option to true the current CPU usage will be read. This will be
2866 the average usage between all CPUs in your NetApp without any information about
2869 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2870 returns in the "CPU" field.
2878 Result: Two value lists of type "cpu", and type instances "idle" and "system".
2880 =item B<GetInterfaces> B<true>|B<false>
2882 If you set this option to true the current traffic of the network interfaces
2883 will be read. This will be the total traffic over all interfaces of your NetApp
2884 without any information about individual interfaces.
2886 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2887 in the "Net kB/s" field.
2897 Result: One value list of type "if_octects".
2899 =item B<GetDiskIO> B<true>|B<false>
2901 If you set this option to true the current IO throughput will be read. This
2902 will be the total IO of your NetApp without any information about individual
2903 disks, volumes or aggregates.
2905 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2906 in the "DiskE<nbsp>kB/s" field.
2914 Result: One value list of type "disk_octets".
2916 =item B<GetDiskOps> B<true>|B<false>
2918 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
2919 iSCSI, etc. operations will be read. This will be the total number of
2920 operations on your NetApp without any information about individual volumes or
2923 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2924 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
2932 Result: A variable number of value lists of type "disk_ops_complex". Each type
2933 of operation will result in one value list with the name of the operation as
2938 =head3 The WAFL block
2940 This will collect various performance data about the WAFL file system. At the
2941 moment this just means cache performance.
2943 B<Note:> To get this data the collectd user needs the
2944 "api-perf-object-get-instances" capability.
2946 B<Note:> The interface to get these values is classified as "Diagnostics" by
2947 NetApp. This means that it is not guaranteed to be stable even between minor
2952 =item B<Interval> I<Seconds>
2954 Collect disk statistics every I<Seconds> seconds.
2956 =item B<GetNameCache> B<true>|B<false>
2964 Result: One value list of type "cache_ratio" and type instance
2967 =item B<GetDirCache> B<true>|B<false>
2975 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
2977 =item B<GetInodeCache> B<true>|B<false>
2985 Result: One value list of type "cache_ratio" and type instance
2988 =item B<GetBufferCache> B<true>|B<false>
2990 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
2991 in the "Cache hit" field.
2999 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3003 =head3 The Disks block
3005 This will collect performance data about the individual disks in the NetApp.
3007 B<Note:> To get this data the collectd user needs the
3008 "api-perf-object-get-instances" capability.
3012 =item B<Interval> I<Seconds>
3014 Collect disk statistics every I<Seconds> seconds.
3016 =item B<GetBusy> B<true>|B<false>
3018 If you set this option to true the busy time of all disks will be calculated
3019 and the value of the busiest disk in the system will be written.
3021 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3022 in the "Disk util" field. Probably.
3030 Result: One value list of type "percent" and type instance "disk_busy".
3034 =head3 The VolumePerf block
3036 This will collect various performance data about the individual volumes.
3038 You can select which data to collect about which volume using the following
3039 options. They follow the standard ignorelist semantic.
3041 B<Note:> To get this data the collectd user needs the
3042 I<api-perf-object-get-instances> capability.
3046 =item B<Interval> I<Seconds>
3048 Collect volume performance data every I<Seconds> seconds.
3050 =item B<GetIO> I<Volume>
3052 =item B<GetOps> I<Volume>
3054 =item B<GetLatency> I<Volume>
3056 Select the given volume for IO, operations or latency statistics collection.
3057 The argument is the name of the volume without the C</vol/> prefix.
3059 Since the standard ignorelist functionality is used here, you can use a string
3060 starting and ending with a slash to specify regular expression matching: To
3061 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3064 GetIO "/^vol[027]$/"
3066 If no regular expression is specified, an exact match is required. Both,
3067 regular and exact matching are case sensitive.
3069 If no volume was specified at all for either of the three options, that data
3070 will be collected for all available volumes.
3072 =item B<IgnoreSelectedIO> B<true>|B<false>
3074 =item B<IgnoreSelectedOps> B<true>|B<false>
3076 =item B<IgnoreSelectedLatency> B<true>|B<false>
3078 When set to B<true>, the volumes selected for IO, operations or latency
3079 statistics collection will be ignored and the data will be collected for all
3082 When set to B<false>, data will only be collected for the specified volumes and
3083 all other volumes will be ignored.
3085 If no volumes have been specified with the above B<Get*> options, all volumes
3086 will be collected regardless of the B<IgnoreSelected*> option.
3088 Defaults to B<false>
3092 =head3 The VolumeUsage block
3094 This will collect capacity data about the individual volumes.
3096 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3101 =item B<Interval> I<Seconds>
3103 Collect volume usage statistics every I<Seconds> seconds.
3105 =item B<GetCapacity> I<VolumeName>
3107 The current capacity of the volume will be collected. This will result in two
3108 to four value lists, depending on the configuration of the volume. All data
3109 sources are of type "df_complex" with the name of the volume as
3112 There will be type_instances "used" and "free" for the number of used and
3113 available bytes on the volume. If the volume has some space reserved for
3114 snapshots, a type_instance "snap_reserved" will be available. If the volume
3115 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3116 number of bytes saved by the SIS feature.
3118 B<Note:> The current NetApp API has a bug that results in this value being
3119 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3120 number which works most of the time. If you see strange values here, bug
3121 NetApp support to fix this.
3123 Repeat this option to specify multiple volumes.
3125 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3127 Specify whether to collect only the volumes selected by the B<GetCapacity>
3128 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3129 B<false>. However, if no B<GetCapacity> option is specified at all, all
3130 capacities will be selected anyway.
3132 =item B<GetSnapshot> I<VolumeName>
3134 Select volumes from which to collect snapshot information.
3136 Usually, the space used for snapshots is included in the space reported as
3137 "used". If snapshot information is collected as well, the space used for
3138 snapshots is subtracted from the used space.
3140 To make things even more interesting, it is possible to reserve space to be
3141 used for snapshots. If the space required for snapshots is less than that
3142 reserved space, there is "reserved free" and "reserved used" space in addition
3143 to "free" and "used". If the space required for snapshots exceeds the reserved
3144 space, that part allocated in the normal space is subtracted from the "used"
3147 Repeat this option to specify multiple volumes.
3149 =item B<IgnoreSelectedSnapshot>
3151 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3152 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3153 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3154 capacities will be selected anyway.
3158 =head3 The Quota block
3160 This will collect (tree) quota statistics (used disk space and number of used
3161 files). This mechanism is useful to get usage information for single qtrees.
3162 In case the quotas are not used for any other purpose, an entry similar to the
3163 following in C</etc/quotas> would be sufficient:
3165 /vol/volA/some_qtree tree - - - - -
3167 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3171 =item B<Interval> I<Seconds>
3173 Collect SnapVault(R) statistics every I<Seconds> seconds.
3177 =head3 The SnapVault block
3179 This will collect statistics about the time and traffic of SnapVault(R)
3184 =item B<Interval> I<Seconds>
3186 Collect SnapVault(R) statistics every I<Seconds> seconds.
3190 =head2 Plugin C<netlink>
3192 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3193 statistics of various interface and routing aspects.
3197 =item B<Interface> I<Interface>
3199 =item B<VerboseInterface> I<Interface>
3201 Instruct the plugin to collect interface statistics. This is basically the same
3202 as the statistics provided by the C<interface> plugin (see above) but
3203 potentially much more detailed.
3205 When configuring with B<Interface> only the basic statistics will be collected,
3206 namely octets, packets, and errors. These statistics are collected by
3207 the C<interface> plugin, too, so using both at the same time is no benefit.
3209 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3210 so that no data needs to be collected twice if you use the C<interface> plugin.
3211 This includes dropped packets, received multicast packets, collisions and a
3212 whole zoo of differentiated RX and TX errors. You can try the following command
3213 to get an idea of what awaits you:
3217 If I<Interface> is B<All>, all interfaces will be selected.
3219 =item B<QDisc> I<Interface> [I<QDisc>]
3221 =item B<Class> I<Interface> [I<Class>]
3223 =item B<Filter> I<Interface> [I<Filter>]
3225 Collect the octets and packets that pass a certain qdisc, class or filter.
3227 QDiscs and classes are identified by their type and handle (or classid).
3228 Filters don't necessarily have a handle, therefore the parent's handle is used.
3229 The notation used in collectd differs from that used in tc(1) in that it
3230 doesn't skip the major or minor number if it's zero and doesn't print special
3231 ids by their name. So, for example, a qdisc may be identified by
3232 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3233 thus not displayed by tc(1).
3235 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3236 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3237 associated with that interface will be collected.
3239 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3240 used. This may lead to problems when more than one filter is attached to a
3241 qdisc or class. This isn't nice, but we don't know how this could be done any
3242 better. If you have a idea, please don't hesitate to tell us.
3244 As with the B<Interface> option you can specify B<All> as the interface,
3245 meaning all interfaces.
3247 Here are some examples to help you understand the above text more easily:
3250 VerboseInterface "All"
3251 QDisc "eth0" "pfifo_fast-1:0"
3253 Class "ppp0" "htb-1:10"
3254 Filter "ppp0" "u32-1:0"
3257 =item B<IgnoreSelected>
3259 The behavior is the same as with all other similar plugins: If nothing is
3260 selected at all, everything is collected. If some things are selected using the
3261 options described above, only these statistics are collected. If you set
3262 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3263 specified statistics will not be collected.
3267 =head2 Plugin C<network>
3269 The Network plugin sends data to a remote instance of collectd, receives data
3270 from a remote instance, or both at the same time. Data which has been received
3271 from the network is usually not transmitted again, but this can be activated, see
3272 the B<Forward> option below.
3274 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3275 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3277 Both, B<Server> and B<Listen> can be used as single option or as block. When
3278 used as block, given options are valid for this socket only. The following
3279 example will export the metrics twice: Once to an "internal" server (without
3280 encryption and signing) and one to an external server (with cryptographic
3284 # Export to an internal server
3285 # (demonstrates usage without additional options)
3286 Server "collectd.internal.tld"
3288 # Export to an external server
3289 # (demonstrates usage with signature options)
3290 <Server "collectd.external.tld">
3291 SecurityLevel "sign"
3292 Username "myhostname"
3299 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3301 The B<Server> statement/block sets the server to send datagrams to. The
3302 statement may occur multiple times to send each datagram to multiple
3305 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3306 optional second argument specifies a port number or a service name. If not
3307 given, the default, B<25826>, is used.
3309 The following options are recognized within B<Server> blocks:
3313 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3315 Set the security you require for network communication. When the security level
3316 has been set to B<Encrypt>, data sent over the network will be encrypted using
3317 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3318 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3319 authentication code. When set to B<None>, data is sent without any security.
3321 This feature is only available if the I<network> plugin was linked with
3324 =item B<Username> I<Username>
3326 Sets the username to transmit. This is used by the server to lookup the
3327 password. See B<AuthFile> below. All security levels except B<None> require
3330 This feature is only available if the I<network> plugin was linked with
3333 =item B<Password> I<Password>
3335 Sets a password (shared secret) for this socket. All security levels except
3336 B<None> require this setting.
3338 This feature is only available if the I<network> plugin was linked with
3341 =item B<Interface> I<Interface name>
3343 Set the outgoing interface for IP packets. This applies at least
3344 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3345 undefined or a non-existent interface name is specified, the default
3346 behavior is to let the kernel choose the appropriate interface. Be warned
3347 that the manual selection of an interface for unicast traffic is only
3348 necessary in rare cases.
3352 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
3354 The B<Listen> statement sets the interfaces to bind to. When multiple
3355 statements are found the daemon will bind to multiple interfaces.
3357 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
3358 the argument is a multicast address the daemon will join that multicast group.
3359 The optional second argument specifies a port number or a service name. If not
3360 given, the default, B<25826>, is used.
3362 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
3366 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3368 Set the security you require for network communication. When the security level
3369 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
3370 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
3371 signed and encrypted data is accepted. When set to B<None>, all data will be
3372 accepted. If an B<AuthFile> option was given (see below), encrypted data is
3373 decrypted if possible.
3375 This feature is only available if the I<network> plugin was linked with
3378 =item B<AuthFile> I<Filename>
3380 Sets a file in which usernames are mapped to passwords. These passwords are
3381 used to verify signatures and to decrypt encrypted network packets. If
3382 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
3383 verified and encrypted packets are decrypted. Otherwise, signed data is
3384 accepted without checking the signature and encrypted data cannot be decrypted.
3385 For the other security levels this option is mandatory.
3387 The file format is very simple: Each line consists of a username followed by a
3388 colon and any number of spaces followed by the password. To demonstrate, an
3389 example file could look like this:
3394 Each time a packet is received, the modification time of the file is checked
3395 using L<stat(2)>. If the file has been changed, the contents is re-read. While
3396 the file is being read, it is locked using L<fcntl(2)>.
3398 =item B<Interface> I<Interface name>
3400 Set the incoming interface for IP packets explicitly. This applies at least
3401 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3402 undefined or a non-existent interface name is specified, the default
3403 behavior is, to let the kernel choose the appropriate interface. Thus incoming
3404 traffic gets only accepted, if it arrives on the given interface.
3408 =item B<TimeToLive> I<1-255>
3410 Set the time-to-live of sent packets. This applies to all, unicast and
3411 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
3412 That means that multicast packets will be sent with a TTL of C<1> (one) on most
3415 =item B<MaxPacketSize> I<1024-65535>
3417 Set the maximum size for datagrams received over the network. Packets larger
3418 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
3419 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
3422 On the server side, this limit should be set to the largest value used on
3423 I<any> client. Likewise, the value on the client must not be larger than the
3424 value on the server, or data will be lost.
3426 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
3427 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
3428 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
3431 =item B<Forward> I<true|false>
3433 If set to I<true>, write packets that were received via the network plugin to
3434 the sending sockets. This should only be activated when the B<Listen>- and
3435 B<Server>-statements differ. Otherwise packets may be send multiple times to
3436 the same multicast group. While this results in more network traffic than
3437 necessary it's not a huge problem since the plugin has a duplicate detection,
3438 so the values will not loop.
3440 =item B<ReportStats> B<true>|B<false>
3442 The network plugin cannot only receive and send statistics, it can also create
3443 statistics about itself. Collected data included the number of received and
3444 sent octets and packets, the length of the receive queue and the number of
3445 values handled. When set to B<true>, the I<Network plugin> will make these
3446 statistics available. Defaults to B<false>.
3450 =head2 Plugin C<nginx>
3452 This plugin collects the number of connections and requests handled by the
3453 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
3454 queries the page provided by the C<ngx_http_stub_status_module> module, which
3455 isn't compiled by default. Please refer to
3456 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
3457 how to compile and configure nginx and this module.
3459 The following options are accepted by the C<nginx plugin>:
3463 =item B<URL> I<http://host/nginx_status>
3465 Sets the URL of the C<ngx_http_stub_status_module> output.
3467 =item B<User> I<Username>
3469 Optional user name needed for authentication.
3471 =item B<Password> I<Password>
3473 Optional password needed for authentication.
3475 =item B<VerifyPeer> B<true|false>
3477 Enable or disable peer SSL certificate verification. See
3478 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
3480 =item B<VerifyHost> B<true|false>
3482 Enable or disable peer host name verification. If enabled, the plugin checks
3483 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
3484 certificate matches the host name provided by the B<URL> option. If this
3485 identity check fails, the connection is aborted. Obviously, only works when
3486 connecting to a SSL enabled server. Enabled by default.
3488 =item B<CACert> I<File>
3490 File that holds one or more SSL certificates. If you want to use HTTPS you will
3491 possibly need this option. What CA certificates come bundled with C<libcurl>
3492 and are checked by default depends on the distribution you use.
3496 =head2 Plugin C<notify_desktop>
3498 This plugin sends a desktop notification to a notification daemon, as defined
3499 in the Desktop Notification Specification. To actually display the
3500 notifications, B<notification-daemon> is required and B<collectd> has to be
3501 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
3502 environment variables have to be set correctly) and the D-Bus message bus.
3504 The Desktop Notification Specification can be found at
3505 L<http://www.galago-project.org/specs/notification/>.
3509 =item B<OkayTimeout> I<timeout>
3511 =item B<WarningTimeout> I<timeout>
3513 =item B<FailureTimeout> I<timeout>
3515 Set the I<timeout>, in milliseconds, after which to expire the notification
3516 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
3517 been specified, the displayed notification will not be closed at all - the
3518 user has to do so herself. These options default to 5000. If a negative number
3519 has been specified, the default is used as well.
3523 =head2 Plugin C<notify_email>
3525 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
3526 configured email address.
3528 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
3530 Available configuration options:
3534 =item B<From> I<Address>
3536 Email address from which the emails should appear to come from.
3538 Default: C<root@localhost>
3540 =item B<Recipient> I<Address>
3542 Configures the email address(es) to which the notifications should be mailed.
3543 May be repeated to send notifications to multiple addresses.
3545 At least one B<Recipient> must be present for the plugin to work correctly.
3547 =item B<SMTPServer> I<Hostname>
3549 Hostname of the SMTP server to connect to.
3551 Default: C<localhost>
3553 =item B<SMTPPort> I<Port>
3555 TCP port to connect to.
3559 =item B<SMTPUser> I<Username>
3561 Username for ASMTP authentication. Optional.
3563 =item B<SMTPPassword> I<Password>
3565 Password for ASMTP authentication. Optional.
3567 =item B<Subject> I<Subject>
3569 Subject-template to use when sending emails. There must be exactly two
3570 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
3571 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
3574 Default: C<Collectd notify: %s@%s>
3578 =head2 Plugin C<ntpd>
3582 =item B<Host> I<Hostname>
3584 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
3586 =item B<Port> I<Port>
3588 UDP-Port to connect to. Defaults to B<123>.
3590 =item B<ReverseLookups> B<true>|B<false>
3592 Sets whether or not to perform reverse lookups on peers. Since the name or
3593 IP-address may be used in a filename it is recommended to disable reverse
3594 lookups. The default is to do reverse lookups to preserve backwards
3595 compatibility, though.
3597 =item B<IncludeUnitID> B<true>|B<false>
3599 When a peer is a refclock, include the unit ID in the I<type instance>.
3600 Defaults to B<false> for backward compatibility.
3602 If two refclock peers use the same driver and this is B<false>, the plugin will
3603 try to write simultaneous measurements from both to the same type instance.
3604 This will result in error messages in the log and only one set of measurements
3609 =head2 Plugin C<nut>
3613 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
3615 Add a UPS to collect data from. The format is identical to the one accepted by
3620 =head2 Plugin C<olsrd>
3622 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
3623 the Optimized Link State Routing daemon and reads information about the current
3624 state of the meshed network.
3626 The following configuration options are understood:
3630 =item B<Host> I<Host>
3632 Connect to I<Host>. Defaults to B<"localhost">.
3634 =item B<Port> I<Port>
3636 Specifies the port to connect to. This must be a string, even if you give the
3637 port as a number rather than a service name. Defaults to B<"2006">.
3639 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
3641 Specifies what information to collect about links, i.E<nbsp>e. direct
3642 connections of the daemon queried. If set to B<No>, no information is
3643 collected. If set to B<Summary>, the number of links and the average of all
3644 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
3645 If set to B<Detail> LQ and NLQ are collected per link.
3647 Defaults to B<Detail>.
3649 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
3651 Specifies what information to collect about routes of the daemon queried. If
3652 set to B<No>, no information is collected. If set to B<Summary>, the number of
3653 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
3654 metric and ETX are collected per route.
3656 Defaults to B<Summary>.
3658 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
3660 Specifies what information to collect about the global topology. If set to
3661 B<No>, no information is collected. If set to B<Summary>, the number of links
3662 in the entire topology and the average I<link quality> (LQ) is calculated.
3663 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
3665 Defaults to B<Summary>.
3669 =head2 Plugin C<onewire>
3671 B<EXPERIMENTAL!> See notes below.
3673 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
3674 L<http://owfs.org/> to read sensors connected via the onewire bus.
3676 Currently only temperature sensors (sensors with the family code C<10>,
3677 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
3678 would like to have included, please send a sort request to the mailing list.
3680 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
3681 experimental, below.
3685 =item B<Device> I<Device>
3687 Sets the device to read the values from. This can either be a "real" hardware
3688 device, such as a serial port or an USB port, or the address of the
3689 L<owserver(1)> socket, usually B<localhost:4304>.
3691 Though the documentation claims to automatically recognize the given address
3692 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
3693 with that version, the following configuration worked for us:
3696 Device "-s localhost:4304"
3699 This directive is B<required> and does not have a default value.
3701 =item B<Sensor> I<Sensor>
3703 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
3704 below. Sensors are specified without the family byte at the beginning, to you'd
3705 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
3708 =item B<IgnoreSelected> I<true>|I<false>
3710 If no configuration if given, the B<onewire> plugin will collect data from all
3711 sensors found. This may not be practical, especially if sensors are added and
3712 removed regularly. Sometimes, however, it's easier/preferred to collect only
3713 specific sensors or all sensors I<except> a few specified ones. This option
3714 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
3715 B<Sensor> is inverted: All selected interfaces are ignored and all other
3716 interfaces are collected.
3718 =item B<Interval> I<Seconds>
3720 Sets the interval in which all sensors should be read. If not specified, the
3721 global B<Interval> setting is used.
3725 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
3726 work with big setups. It works with one sensor being attached to one
3727 controller, but as soon as you throw in a couple more senors and maybe a hub
3728 or two, reading all values will take more than ten seconds (the default
3729 interval). We will probably add some separate thread for reading the sensors
3730 and some cache or something like that, but it's not done yet. We will try to
3731 maintain backwards compatibility in the future, but we can't promise. So in
3732 short: If it works for you: Great! But keep in mind that the config I<might>
3733 change, though this is unlikely. Oh, and if you want to help improving this
3734 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
3736 =head2 Plugin C<openvpn>
3738 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
3739 traffic statistics about connected clients.
3741 To set up OpenVPN to write to the status file periodically, use the
3742 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
3743 you need to set the required format, too. This is done by setting
3744 B<--status-version> to B<2>.
3746 So, in a nutshell you need:
3748 openvpn $OTHER_OPTIONS \
3749 --status "/var/run/openvpn-status" 10 \
3756 =item B<StatusFile> I<File>
3758 Specifies the location of the status file.
3760 =item B<ImprovedNamingSchema> B<true>|B<false>
3762 When enabled, the filename of the status file will be used as plugin instance
3763 and the client's "common name" will be used as type instance. This is required
3764 when reading multiple status files. Enabling this option is recommended, but to
3765 maintain backwards compatibility this option is disabled by default.
3767 =item B<CollectCompression> B<true>|B<false>
3769 Sets whether or not statistics about the compression used by OpenVPN should be
3770 collected. This information is only available in I<single> mode. Enabled by
3773 =item B<CollectIndividualUsers> B<true>|B<false>
3775 Sets whether or not traffic information is collected for each connected client
3776 individually. If set to false, currently no traffic data is collected at all
3777 because aggregating this data in a save manner is tricky. Defaults to B<true>.
3779 =item B<CollectUserCount> B<true>|B<false>
3781 When enabled, the number of currently connected clients or users is collected.
3782 This is especially interesting when B<CollectIndividualUsers> is disabled, but
3783 can be configured independently from that option. Defaults to B<false>.
3787 =head2 Plugin C<oracle>
3789 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
3790 Oracle® Database and lets you execute SQL statements there. It is very similar
3791 to the "dbi" plugin, because it was written around the same time. See the "dbi"
3792 plugin's documentation above for details.
3795 <Query "out_of_stock">
3796 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
3799 # InstancePrefix "foo"
3800 InstancesFrom "category"
3804 <Database "product_information">
3808 Query "out_of_stock"
3812 =head3 B<Query> blocks
3814 The Query blocks are handled identically to the Query blocks of the "dbi"
3815 plugin. Please see its documentation above for details on how to specify
3818 =head3 B<Database> blocks
3820 Database blocks define a connection to a database and which queries should be
3821 sent to that database. Each database needs a "name" as string argument in the
3822 starting tag of the block. This name will be used as "PluginInstance" in the
3823 values submitted to the daemon. Other than that, that name is not used.
3827 =item B<ConnectID> I<ID>
3829 Defines the "database alias" or "service name" to connect to. Usually, these
3830 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
3832 =item B<Host> I<Host>
3834 Hostname to use when dispatching values for this database. Defaults to using
3835 the global hostname of the I<collectd> instance.
3837 =item B<Username> I<Username>
3839 Username used for authentication.
3841 =item B<Password> I<Password>
3843 Password used for authentication.
3845 =item B<Query> I<QueryName>
3847 Associates the query named I<QueryName> with this database connection. The
3848 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
3849 blocks you want to refer to must be placed above the database block you want to
3854 =head2 Plugin C<perl>
3856 This plugin embeds a Perl-interpreter into collectd and provides an interface
3857 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
3859 =head2 Plugin C<pinba>
3861 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
3862 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
3863 PHP-based webpage has been delivered, the extension will send a UDP packet
3864 containing timing information, peak memory usage and so on. The plugin will
3865 wait for such packets, parse them and account the provided information, which
3866 is then dispatched to the daemon once per interval.
3873 # Overall statistics for the website.
3875 Server "www.example.com"
3877 # Statistics for www-a only
3879 Host "www-a.example.com"
3880 Server "www.example.com"
3882 # Statistics for www-b only
3884 Host "www-b.example.com"
3885 Server "www.example.com"
3889 The plugin provides the following configuration options:
3893 =item B<Address> I<Node>
3895 Configures the address used to open a listening socket. By default, plugin will
3896 bind to the I<any> address C<::0>.
3898 =item B<Port> I<Service>
3900 Configures the port (service) to bind to. By default the default Pinba port
3901 "30002" will be used. The option accepts service names in addition to port
3902 numbers and thus requires a I<string> argument.
3904 =item E<lt>B<View> I<Name>E<gt> block
3906 The packets sent by the Pinba extension include the hostname of the server, the
3907 server name (the name of the virtual host) and the script that was executed.
3908 Using B<View> blocks it is possible to separate the data into multiple groups
3909 to get more meaningful statistics. Each packet is added to all matching groups,
3910 so that a packet may be accounted for more than once.
3914 =item B<Host> I<Host>
3916 Matches the hostname of the system the webserver / script is running on. This
3917 will contain the result of the L<gethostname(2)> system call. If not
3918 configured, all hostnames will be accepted.
3920 =item B<Server> I<Server>
3922 Matches the name of the I<virtual host>, i.e. the contents of the
3923 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
3924 server names will be accepted.
3926 =item B<Script> I<Script>
3928 Matches the name of the I<script name>, i.e. the contents of the
3929 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
3930 script names will be accepted.
3936 =head2 Plugin C<ping>
3938 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
3939 configured hosts periodically and measures the network latency. Whenever the
3940 C<read> function of the plugin is called, it submits the average latency, the
3941 standard deviation and the drop rate for each host.
3943 Available configuration options:
3947 =item B<Host> I<IP-address>
3949 Host to ping periodically. This option may be repeated several times to ping
3952 =item B<Interval> I<Seconds>
3954 Sets the interval in which to send ICMP echo packets to the configured hosts.
3955 This is B<not> the interval in which statistics are queries from the plugin but
3956 the interval in which the hosts are "pinged". Therefore, the setting here
3957 should be smaller than or equal to the global B<Interval> setting. Fractional
3958 times, such as "1.24" are allowed.
3962 =item B<Timeout> I<Seconds>
3964 Time to wait for a response from the host to which an ICMP packet had been
3965 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
3966 to be down or the packet to be dropped. This setting must be smaller than the
3967 B<Interval> setting above for the plugin to work correctly. Fractional
3968 arguments are accepted.
3972 =item B<TTL> I<0-255>
3974 Sets the Time-To-Live of generated ICMP packets.
3976 =item B<SourceAddress> I<host>
3978 Sets the source address to use. I<host> may either be a numerical network
3979 address or a network hostname.
3981 =item B<Device> I<name>
3983 Sets the outgoing network device to be used. I<name> has to specify an
3984 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
3987 =item B<MaxMissed> I<Packets>
3989 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
3990 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
3992 Default: B<-1> (disabled)
3996 =head2 Plugin C<postgresql>
3998 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
3999 keeps a persistent connection to all configured databases and tries to
4000 reconnect if the connection has been interrupted. A database is configured by
4001 specifying a B<Database> block as described below. The default statistics are
4002 collected from PostgreSQL's B<statistics collector> which thus has to be
4003 enabled for this plugin to work correctly. This should usually be the case by
4004 default. See the section "The Statistics Collector" of the B<PostgreSQL
4005 Documentation> for details.
4007 By specifying custom database queries using a B<Query> block as described
4008 below, you may collect any data that is available from some PostgreSQL
4009 database. This way, you are able to access statistics of external daemons
4010 which are available in a PostgreSQL database or use future or special
4011 statistics provided by PostgreSQL without the need to upgrade your collectd
4014 Starting with version 5.2, the C<postgresql> plugin supports writing data to
4015 PostgreSQL databases as well. This has been implemented in a generic way. You
4016 need to specify an SQL statement which will then be executed by collectd in
4017 order to write the data (see below for details). The benefit of that approach
4018 is that there is no fixed database layout. Rather, the layout may be optimized
4019 for the current setup.
4021 The B<PostgreSQL Documentation> manual can be found at
4022 L<http://www.postgresql.org/docs/manuals/>.
4026 Statement "SELECT magic FROM wizard WHERE host = $1;"
4030 InstancePrefix "magic"
4035 <Query rt36_tickets>
4036 Statement "SELECT COUNT(type) AS count, type \
4038 WHEN resolved = 'epoch' THEN 'open' \
4039 ELSE 'resolved' END AS type \
4040 FROM tickets) type \
4044 InstancePrefix "rt36_tickets"
4045 InstancesFrom "type"
4051 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
4061 KRBSrvName "kerberos_service_name"
4067 Service "service_name"
4068 Query backend # predefined
4079 The B<Query> block defines one database query which may later be used by a
4080 database definition. It accepts a single mandatory argument which specifies
4081 the name of the query. The names of all queries have to be unique (see the
4082 B<MinVersion> and B<MaxVersion> options below for an exception to this
4083 rule). The following configuration options are available to define the query:
4085 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
4086 blocks define how to handle the values returned from the query. They define
4087 which column holds which value and how to dispatch that value to the daemon.
4088 Multiple B<Result> blocks may be used to extract multiple values from a single
4093 =item B<Statement> I<sql query statement>
4095 Specify the I<sql query statement> which the plugin should execute. The string
4096 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
4097 first, second, etc. parameter. The value of the parameters is specified by the
4098 B<Param> configuration option - see below for details. To include a literal
4099 B<$> character followed by a number, surround it with single quotes (B<'>).
4101 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
4102 allowed. Note, however, that only a single command may be used. Semicolons are
4103 allowed as long as a single non-empty command has been specified only.
4105 The returned lines will be handled separately one after another.
4107 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4109 Specify the parameters which should be passed to the SQL query. The parameters
4110 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4111 they appear in the configuration file. The value of the parameter is
4112 determined depending on the value of the B<Param> option as follows:
4118 The configured hostname of the database connection. If a UNIX domain socket is
4119 used, the parameter expands to "localhost".
4123 The name of the database of the current connection.
4127 The name of the database plugin instance. See the B<Instance> option of the
4128 database specification below for details.
4132 The username used to connect to the database.
4136 The interval with which this database is queried (as specified by the database
4137 specific or global B<Interval> options).
4141 Please note that parameters are only supported by PostgreSQL's protocol
4142 version 3 and above which was introduced in version 7.4 of PostgreSQL.
4144 =item B<Type> I<type>
4146 The I<type> name to be used when dispatching the values. The type describes
4147 how to handle the data and where to store it. See L<types.db(5)> for more
4148 details on types and their configuration. The number and type of values (as
4149 selected by the B<ValuesFrom> option) has to match the type of the given name.
4151 This option is required inside a B<Result> block.
4153 =item B<InstancePrefix> I<prefix>
4155 =item B<InstancesFrom> I<column0> [I<column1> ...]
4157 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
4158 B<InstancePrefix> defines a static prefix that will be prepended to all type
4159 instances. B<InstancesFrom> defines the column names whose values will be used
4160 to create the type instance. Multiple values will be joined together using the
4161 hyphen (C<->) as separation character.
4163 The plugin itself does not check whether or not all built instances are
4164 different. It is your responsibility to assure that each is unique.
4166 Both options are optional. If none is specified, the type instance will be
4169 =item B<ValuesFrom> I<column0> [I<column1> ...]
4171 Names the columns whose content is used as the actual data for the data sets
4172 that are dispatched to the daemon. How many such columns you need is
4173 determined by the B<Type> setting as explained above. If you specify too many
4174 or not enough columns, the plugin will complain about that and no data will be
4175 submitted to the daemon.
4177 The actual data type, as seen by PostgreSQL, is not that important as long as
4178 it represents numbers. The plugin will automatically cast the values to the
4179 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
4180 L<strtod(3)> functions, so anything supported by those functions is supported
4181 by the plugin as well.
4183 This option is required inside a B<Result> block and may be specified multiple
4184 times. If multiple B<ValuesFrom> options are specified, the columns are read
4187 =item B<MinVersion> I<version>
4189 =item B<MaxVersion> I<version>
4191 Specify the minimum or maximum version of PostgreSQL that this query should be
4192 used with. Some statistics might only be available with certain versions of
4193 PostgreSQL. This allows you to specify multiple queries with the same name but
4194 which apply to different versions, thus allowing you to use the same
4195 configuration in a heterogeneous environment.
4197 The I<version> has to be specified as the concatenation of the major, minor
4198 and patch-level versions, each represented as two-decimal-digit numbers. For
4199 example, version 8.2.3 will become 80203.
4203 The following predefined queries are available (the definitions can be found
4204 in the F<postgresql_default.conf> file which, by default, is available at
4205 C<I<prefix>/share/collectd/>):
4211 This query collects the number of backends, i.E<nbsp>e. the number of
4214 =item B<transactions>
4216 This query collects the numbers of committed and rolled-back transactions of
4221 This query collects the numbers of various table modifications (i.E<nbsp>e.
4222 insertions, updates, deletions) of the user tables.
4224 =item B<query_plans>
4226 This query collects the numbers of various table scans and returned tuples of
4229 =item B<table_states>
4231 This query collects the numbers of live and dead rows in the user tables.
4235 This query collects disk block access counts for user tables.
4239 This query collects the on-disk size of the database in bytes.
4243 In addition, the following detailed queries are available by default. Please
4244 note that each of those queries collects information B<by table>, thus,
4245 potentially producing B<a lot> of data. For details see the description of the
4246 non-by_table queries above.
4250 =item B<queries_by_table>
4252 =item B<query_plans_by_table>
4254 =item B<table_states_by_table>
4256 =item B<disk_io_by_table>
4260 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
4261 mandatory argument specifying the name of the writer. This will then be used
4262 in the B<Database> specification in order to activate the writer instance. The
4263 names of all writers have to be unique. The following options may be
4268 =item B<Statement> I<sql statement>
4270 This mandatory option specifies the SQL statement that will be executed for
4271 each submitted value. A single SQL statement is allowed only. Anything after
4272 the first semicolon will be ignored.
4274 Nine parameters will be passed to the statement and should be specified as
4275 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
4276 values are made available through those parameters:
4282 The timestamp of the queried value as a floating point number.
4286 The hostname of the queried value.
4290 The plugin name of the queried value.
4294 The plugin instance of the queried value. This value may be B<NULL> if there
4295 is no plugin instance.
4299 The type of the queried value (cf. L<types.db(5)>).
4303 The type instance of the queried value. This value may be B<NULL> if there is
4308 An array of names for the submitted values (i.E<nbsp>e., the name of the data
4309 sources of the submitted value-list).
4313 An array of types for the submitted values (i.E<nbsp>e., the type of the data
4314 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
4315 B<StoreRates> is enabled (which is the default, see below), all types will be
4320 An array of the submitted values. The dimensions of the value name and value
4325 In general, it is advisable to create and call a custom function in the
4326 PostgreSQL database for this purpose. Any procedural language supported by
4327 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
4330 =item B<StoreRates> B<false>|B<true>
4332 If set to B<true> (the default), convert counter values to rates. If set to
4333 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
4338 The B<Database> block defines one PostgreSQL database for which to collect
4339 statistics. It accepts a single mandatory argument which specifies the
4340 database name. None of the other options are required. PostgreSQL will use
4341 default values as documented in the section "CONNECTING TO A DATABASE" in the
4342 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
4343 the user collectd is run as and special environment variables. See the manpage
4348 =item B<Interval> I<seconds>
4350 Specify the interval with which the database should be queried. The default is
4351 to use the global B<Interval> setting.
4353 =item B<CommitInterval> I<seconds>
4355 This option may be used for database connections which have "writers" assigned
4356 (see above). If specified, it causes a writer to put several updates into a
4357 single transaction. This transaction will last for the specified amount of
4358 time. By default, each update will be executed in a separate transaction. Each
4359 transaction generates a fair amount of overhead which can, thus, be reduced by
4360 activating this option. The draw-back is, that data covering the specified
4361 amount of time will be lost, for example, if a single statement within the
4362 transaction fails or if the database server crashes.
4364 =item B<Host> I<hostname>
4366 Specify the hostname or IP of the PostgreSQL server to connect to. If the
4367 value begins with a slash, it is interpreted as the directory name in which to
4368 look for the UNIX domain socket.
4370 This option is also used to determine the hostname that is associated with a
4371 collected data set. If it has been omitted or either begins with with a slash
4372 or equals B<localhost> it will be replaced with the global hostname definition
4373 of collectd. Any other value will be passed literally to collectd when
4374 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
4376 =item B<Port> I<port>
4378 Specify the TCP port or the local UNIX domain socket file extension of the
4381 =item B<User> I<username>
4383 Specify the username to be used when connecting to the server.
4385 =item B<Password> I<password>
4387 Specify the password to be used when connecting to the server.
4389 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
4391 Specify whether to use an SSL connection when contacting the server. The
4392 following modes are supported:
4394 =item B<Instance> I<name>
4396 Specify the plugin instance name that should be used instead of the database
4397 name (which is the default, if this option has not been specified). This
4398 allows to query multiple databases of the same name on the same host (e.g.
4399 when running multiple database server versions in parallel).
4405 Do not use SSL at all.
4409 First, try to connect without using SSL. If that fails, try using SSL.
4411 =item I<prefer> (default)
4413 First, try to connect using SSL. If that fails, try without using SSL.
4421 =item B<KRBSrvName> I<kerberos_service_name>
4423 Specify the Kerberos service name to use when authenticating with Kerberos 5
4424 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
4425 B<PostgreSQL Documentation> for details.
4427 =item B<Service> I<service_name>
4429 Specify the PostgreSQL service name to use for additional parameters. That
4430 service has to be defined in F<pg_service.conf> and holds additional
4431 connection parameters. See the section "The Connection Service File" in the
4432 B<PostgreSQL Documentation> for details.
4434 =item B<Query> I<query>
4436 Specifies a I<query> which should be executed in the context of the database
4437 connection. This may be any of the predefined or user-defined queries. If no
4438 such option is given, it defaults to "backends", "transactions", "queries",
4439 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
4440 has been specified). Else, the specified queries are used only.
4442 =item B<Writer> I<writer>
4444 Assigns the specified I<writer> backend to the database connection. This
4445 causes all collected data to be send to the database using the settings
4446 defined in the writer configuration (see the section "FILTER CONFIGURATION"
4447 below for details on how to selectively send data to certain plugins).
4449 Each writer will register a flush callback which may be used when having long
4450 transactions enabled (see the B<CommitInterval> option above). When issuing
4451 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
4452 transaction will be committed right away. Two different kinds of flush
4453 callbacks are available with the C<postgresql> plugin:
4459 Flush all writer backends.
4461 =item B<postgresql->I<database>
4463 Flush all writers of the specified I<database> only.
4469 =head2 Plugin C<powerdns>
4471 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
4472 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
4473 values, many of which are probably meaningless to most users, but may be useful
4474 for some. So you may chose which values to collect, but if you don't, some
4475 reasonable defaults will be collected.
4478 <Server "server_name">
4480 Collect "udp-answers" "udp-queries"
4481 Socket "/var/run/pdns.controlsocket"
4483 <Recursor "recursor_name">
4485 Collect "cache-hits" "cache-misses"
4486 Socket "/var/run/pdns_recursor.controlsocket"
4488 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
4493 =item B<Server> and B<Recursor> block
4495 The B<Server> block defines one authoritative server to query, the B<Recursor>
4496 does the same for an recursing server. The possible options in both blocks are
4497 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
4502 =item B<Collect> I<Field>
4504 Using the B<Collect> statement you can select which values to collect. Here,
4505 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
4506 C<dlg-only-drops>, C<answers10-100>.
4508 The method of getting the values differs for B<Server> and B<Recursor> blocks:
4509 When querying the server a C<SHOW *> command is issued in any case, because
4510 that's the only way of getting multiple values out of the server at once.
4511 collectd then picks out the values you have selected. When querying the
4512 recursor, a command is generated to query exactly these values. So if you
4513 specify invalid fields when querying the recursor, a syntax error may be
4514 returned by the daemon and collectd may not collect any values at all.
4516 If no B<Collect> statement is given, the following B<Server> values will be
4523 =item packetcache-hit
4525 =item packetcache-miss
4527 =item packetcache-size
4529 =item query-cache-hit
4531 =item query-cache-miss
4533 =item recursing-answers
4535 =item recursing-questions
4547 The following B<Recursor> values will be collected by default:
4551 =item noerror-answers
4553 =item nxdomain-answers
4555 =item servfail-answers
4573 Please note that up to that point collectd doesn't know what values are
4574 available on the server and values that are added do not need a change of the
4575 mechanism so far. However, the values must be mapped to collectd's naming
4576 scheme, which is done using a lookup table that lists all known values. If
4577 values are added in the future and collectd does not know about them, you will
4578 get an error much like this:
4580 powerdns plugin: submit: Not found in lookup table: foobar = 42
4582 In this case please file a bug report with the collectd team.
4584 =item B<Socket> I<Path>
4586 Configures the path to the UNIX domain socket to be used when connecting to the
4587 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
4588 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
4589 will be used for the recursor.
4593 =item B<LocalSocket> I<Path>
4595 Querying the recursor is done using UDP. When using UDP over UNIX domain
4596 sockets, the client socket needs a name in the file system, too. You can set
4597 this local name to I<Path> using the B<LocalSocket> option. The default is
4598 C<I<prefix>/var/run/collectd-powerdns>.
4602 =head2 Plugin C<processes>
4606 =item B<Process> I<Name>
4608 Select more detailed statistics of processes matching this name. The statistics
4609 collected for these selected processes are size of the resident segment size
4610 (RSS), user- and system-time used, number of processes and number of threads,
4611 io data (where available) and minor and major pagefaults.
4613 =item B<ProcessMatch> I<name> I<regex>
4615 Similar to the B<Process> option this allows to select more detailed
4616 statistics of processes matching the specified I<regex> (see L<regex(7)> for
4617 details). The statistics of all matching processes are summed up and
4618 dispatched to the daemon using the specified I<name> as an identifier. This
4619 allows to "group" several processes together. I<name> must not contain
4624 =head2 Plugin C<protocols>
4626 Collects a lot of information about various network protocols, such as I<IP>,
4627 I<TCP>, I<UDP>, etc.
4629 Available configuration options:
4633 =item B<Value> I<Selector>
4635 Selects whether or not to select a specific value. The string being matched is
4636 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
4637 plugin instance and I<ValueName> will be used as type instance. An example of
4638 the string being used would be C<Tcp:RetransSegs>.
4640 You can use regular expressions to match a large number of values with just one
4641 configuration option. To select all "extended" I<TCP> values, you could use the
4642 following statement:
4646 Whether only matched values are selected or all matched values are ignored
4647 depends on the B<IgnoreSelected>. By default, only matched values are selected.
4648 If no value is configured at all, all values will be selected.
4650 =item B<IgnoreSelected> B<true>|B<false>
4652 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
4653 matching values will be ignored.
4657 =head2 Plugin C<python>
4659 This plugin embeds a Python-interpreter into collectd and provides an interface
4660 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
4662 =head2 Plugin C<routeros>
4664 The C<routeros> plugin connects to a device running I<RouterOS>, the
4665 Linux-based operating system for routers by I<MikroTik>. The plugin uses
4666 I<librouteros> to connect and reads information about the interfaces and
4667 wireless connections of the device. The configuration supports querying
4672 Host "router0.example.com"
4675 CollectInterface true
4680 Host "router1.example.com"
4683 CollectInterface true
4684 CollectRegistrationTable true
4690 As you can see above, the configuration of the I<routeros> plugin consists of
4691 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
4692 options are understood:
4696 =item B<Host> I<Host>
4698 Hostname or IP-address of the router to connect to.
4700 =item B<Port> I<Port>
4702 Port name or port number used when connecting. If left unspecified, the default
4703 will be chosen by I<librouteros>, currently "8728". This option expects a
4704 string argument, even when a numeric port number is given.
4706 =item B<User> I<User>
4708 Use the user name I<User> to authenticate. Defaults to "admin".
4710 =item B<Password> I<Password>
4712 Set the password used to authenticate.
4714 =item B<CollectInterface> B<true>|B<false>
4716 When set to B<true>, interface statistics will be collected for all interfaces
4717 present on the device. Defaults to B<false>.
4719 =item B<CollectRegistrationTable> B<true>|B<false>
4721 When set to B<true>, information about wireless LAN connections will be
4722 collected. Defaults to B<false>.
4724 =item B<CollectCPULoad> B<true>|B<false>
4726 When set to B<true>, information about the CPU usage will be collected. The
4727 number is a dimensionless value where zero indicates no CPU usage at all.
4728 Defaults to B<false>.
4730 =item B<CollectMemory> B<true>|B<false>
4732 When enabled, the amount of used and free memory will be collected. How used
4733 memory is calculated is unknown, for example whether or not caches are counted
4735 Defaults to B<false>.
4737 =item B<CollectDF> B<true>|B<false>
4739 When enabled, the amount of used and free disk space will be collected.
4740 Defaults to B<false>.
4742 =item B<CollectDisk> B<true>|B<false>
4744 When enabled, the number of sectors written and bad blocks will be collected.
4745 Defaults to B<false>.
4749 =head2 Plugin C<redis>
4751 The I<Redis plugin> connects to one or more Redis servers and gathers
4752 information about each server's state. For each server there is a I<Node> block
4753 which configures the connection parameters for this node.
4763 The information shown in the synopsis above is the I<default configuration>
4764 which is used by the plugin if no configuration is present.
4768 =item B<Node> I<Nodename>
4770 The B<Node> block identifies a new Redis node, that is a new Redis instance
4771 running in an specified host and port. The name for node is a canonical
4772 identifier which is used as I<plugin instance>. It is limited to
4773 64E<nbsp>characters in length.
4775 =item B<Host> I<Hostname>
4777 The B<Host> option is the hostname or IP-address where the Redis instance is
4780 =item B<Port> I<Port>
4782 The B<Port> option is the TCP port on which the Redis instance accepts
4783 connections. Either a service name of a port number may be given. Please note
4784 that numerical port numbers must be given as a string, too.
4786 =item B<Password> I<Password>
4788 Use I<Password> to authenticate when connecting to I<Redis>.
4790 =item B<Timeout> I<Timeout in miliseconds>
4792 The B<Timeout> option set the socket timeout for node response. Since the Redis
4793 read function is blocking, you should keep this value as low as possible. Keep
4794 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
4795 than B<Interval> defined globally.
4799 =head2 Plugin C<rrdcached>
4801 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
4802 to store values to RRD files in an efficient manner. The combination of the
4803 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
4804 way the C<rrdtool> plugin works (see below). The added abstraction layer
4805 provides a number of benefits, though: Because the cache is not within
4806 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
4807 restarted. This results in much shorter (if any) gaps in graphs, especially
4808 under heavy load. Also, the C<rrdtool> command line utility is aware of the
4809 daemon so that it can flush values to disk automatically when needed. This
4810 allows to integrate automated flushing of values into graphing solutions much
4813 There are disadvantages, though: The daemon may reside on a different host, so
4814 it may not be possible for C<collectd> to create the appropriate RRD files
4815 anymore. And even if C<rrdcached> runs on the same host, it may run in a
4816 different base directory, so relative paths may do weird stuff if you're not
4819 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
4820 on the same host, communicating via a UNIX domain socket. The B<DataDir>
4821 setting should be set to an absolute path, so that a changed base directory
4822 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
4826 =item B<DaemonAddress> I<Address>
4828 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
4829 library. See L<rrdcached(1)> for details. Example:
4831 <Plugin "rrdcached">
4832 DaemonAddress "unix:/var/run/rrdcached.sock"
4835 =item B<DataDir> I<Directory>
4837 Set the base directory in which the RRD files reside. If this is a relative
4838 path, it is relative to the working base directory of the C<rrdcached> daemon!
4839 Use of an absolute path is recommended.
4841 =item B<CreateFiles> B<true>|B<false>
4843 Enables or disables the creation of RRD files. If the daemon is not running
4844 locally, or B<DataDir> is set to a relative path, this will not work as
4845 expected. Default is B<true>.
4847 =item B<CreateFilesAsync> B<false>|B<true>
4849 When enabled, new RRD files are enabled asynchronously, using a separate thread
4850 that runs in the background. This prevents writes to block, which is a problem
4851 especially when many hundreds of files need to be created at once. However,
4852 since the purpose of creating the files asynchronously is I<not> to block until
4853 the file is available, values before the file is available will be discarded.
4854 When disabled (the default) files are created synchronously, blocking for a
4855 short while, while the file is being written.
4857 =item B<StepSize> I<Seconds>
4859 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
4860 this setting is unset and the stepsize is set to the interval in which the data
4861 is collected. Do not use this option unless you absolutely have to for some
4862 reason. Setting this option may cause problems with the C<snmp plugin>, the
4863 C<exec plugin> or when the daemon is set up to receive data from other hosts.
4865 =item B<HeartBeat> I<Seconds>
4867 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
4868 in which case the heartbeat is set to twice the B<StepSize> which should equal
4869 the interval in which data is collected. Do not set this option unless you have
4870 a very good reason to do so.
4872 =item B<RRARows> I<NumRows>
4874 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
4875 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
4876 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
4877 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
4878 week, one month, and one year.
4880 So for each timespan, it calculates how many PDPs need to be consolidated into
4881 one CDP by calculating:
4882 number of PDPs = timespan / (stepsize * rrarows)
4884 Bottom line is, set this no smaller than the width of you graphs in pixels. The
4887 =item B<RRATimespan> I<Seconds>
4889 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
4890 more then one RRA. If this option is never used, the built-in default of (3600,
4891 86400, 604800, 2678400, 31622400) is used.
4893 For more information on how RRA-sizes are calculated see B<RRARows> above.
4895 =item B<XFF> I<Factor>
4897 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
4898 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
4903 =head2 Plugin C<rrdtool>
4905 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
4906 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
4907 using these settings. If you don't want to dive into the depths of RRDtool, you
4908 can safely ignore these settings.
4912 =item B<DataDir> I<Directory>
4914 Set the directory to store RRD files under. By default RRD files are generated
4915 beneath the daemon's working directory, i.e. the B<BaseDir>.
4917 =item B<CreateFilesAsync> B<false>|B<true>
4919 When enabled, new RRD files are enabled asynchronously, using a separate thread
4920 that runs in the background. This prevents writes to block, which is a problem
4921 especially when many hundreds of files need to be created at once. However,
4922 since the purpose of creating the files asynchronously is I<not> to block until
4923 the file is available, values before the file is available will be discarded.
4924 When disabled (the default) files are created synchronously, blocking for a
4925 short while, while the file is being written.
4927 =item B<StepSize> I<Seconds>
4929 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
4930 this setting is unset and the stepsize is set to the interval in which the data
4931 is collected. Do not use this option unless you absolutely have to for some
4932 reason. Setting this option may cause problems with the C<snmp plugin>, the
4933 C<exec plugin> or when the daemon is set up to receive data from other hosts.
4935 =item B<HeartBeat> I<Seconds>
4937 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
4938 in which case the heartbeat is set to twice the B<StepSize> which should equal
4939 the interval in which data is collected. Do not set this option unless you have
4940 a very good reason to do so.
4942 =item B<RRARows> I<NumRows>
4944 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
4945 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
4946 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
4947 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
4948 week, one month, and one year.
4950 So for each timespan, it calculates how many PDPs need to be consolidated into
4951 one CDP by calculating:
4952 number of PDPs = timespan / (stepsize * rrarows)
4954 Bottom line is, set this no smaller than the width of you graphs in pixels. The
4957 =item B<RRATimespan> I<Seconds>
4959 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
4960 more then one RRA. If this option is never used, the built-in default of (3600,
4961 86400, 604800, 2678400, 31622400) is used.
4963 For more information on how RRA-sizes are calculated see B<RRARows> above.
4965 =item B<XFF> I<Factor>
4967 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
4968 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
4971 =item B<CacheFlush> I<Seconds>
4973 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
4974 it writes all values for a certain RRD-file if the oldest value is older than
4975 (or equal to) the number of seconds specified. If some RRD-file is not updated
4976 anymore for some reason (the computer was shut down, the network is broken,
4977 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
4978 entire cache is searched for entries older than B<CacheTimeout> seconds and
4979 written to disk every I<Seconds> seconds. Since this is kind of expensive and
4980 does nothing under normal circumstances, this value should not be too small.
4981 900 seconds might be a good value, though setting this to 7200 seconds doesn't
4982 normally do much harm either.
4984 =item B<CacheTimeout> I<Seconds>
4986 If this option is set to a value greater than zero, the C<rrdtool plugin> will
4987 save values in a cache, as described above. Writing multiple values at once
4988 reduces IO-operations and thus lessens the load produced by updating the files.
4989 The trade off is that the graphs kind of "drag behind" and that more memory is
4992 =item B<WritesPerSecond> I<Updates>
4994 When collecting many statistics with collectd and the C<rrdtool> plugin, you
4995 will run serious performance problems. The B<CacheFlush> setting and the
4996 internal update queue assert that collectd continues to work just fine even
4997 under heavy load, but the system may become very unresponsive and slow. This is
4998 a problem especially if you create graphs from the RRD files on the same
4999 machine, for example using the C<graph.cgi> script included in the
5000 C<contrib/collection3/> directory.
5002 This setting is designed for very large setups. Setting this option to a value
5003 between 25 and 80 updates per second, depending on your hardware, will leave
5004 the server responsive enough to draw graphs even while all the cached values
5005 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
5006 by the B<FLUSH> command, are B<not> effected by this limit. They are still
5007 written as fast as possible, so that web frontends have up to date data when
5010 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
5011 updates per second, writing all values to disk will take approximately
5012 56E<nbsp>minutes. Together with the flushing ability that's integrated into
5013 "collection3" you'll end up with a responsive and fast system, up to date
5014 graphs and basically a "backup" of your values every hour.
5016 =item B<RandomTimeout> I<Seconds>
5018 When set, the actual timeout for each value is chosen randomly between
5019 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
5020 intention is to avoid high load situations that appear when many values timeout
5021 at the same time. This is especially a problem shortly after the daemon starts,
5022 because all values were added to the internal cache at roughly the same time.
5026 =head2 Plugin C<sensors>
5028 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
5029 that all the needed modules have to be loaded and lm_sensors has to be
5030 configured (most likely by editing F</etc/sensors.conf>. Read
5031 L<sensors.conf(5)> for details.
5033 The B<lm_sensors> homepage can be found at
5034 L<http://secure.netroedge.com/~lm78/>.
5038 =item B<SensorConfigFile> I<File>
5040 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
5041 the library's default will be used.
5043 =item B<Sensor> I<chip-bus-address/type-feature>
5045 Selects the name of the sensor which you want to collect or ignore, depending
5046 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
5047 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
5048 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
5050 =item B<IgnoreSelected> I<true>|I<false>
5052 If no configuration if given, the B<sensors>-plugin will collect data from all
5053 sensors. This may not be practical, especially for uninteresting sensors.
5054 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
5055 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
5056 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
5057 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
5058 and all other sensors are collected.
5062 =head2 Plugin C<snmp>
5064 Since the configuration of the C<snmp plugin> is a little more complicated than
5065 other plugins, its documentation has been moved to an own manpage,
5066 L<collectd-snmp(5)>. Please see there for details.
5068 =head2 Plugin C<swap>
5070 The I<Swap plugin> collects information about used and available swap space. On
5071 I<Linux> and I<Solaris>, the following options are available:
5075 =item B<ReportByDevice> B<false>|B<true>
5077 Configures how to report physical swap devices. If set to B<false> (the
5078 default), the summary over all swap devices is reported only, i.e. the globally
5079 used and available space over all devices. If B<true> is configured, the used
5080 and available space of each device will be reported separately.
5082 This option is only available if the I<Swap plugin> can read C</proc/swaps>
5083 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
5085 =item B<ReportBytes> B<false>|B<true>
5087 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
5088 I<swap I/O> is reported in pages. This option is available under Linux only.
5092 =head2 Plugin C<syslog>
5096 =item B<LogLevel> B<debug|info|notice|warning|err>
5098 Sets the log-level. If, for example, set to B<notice>, then all events with
5099 severity B<notice>, B<warning>, or B<err> will be submitted to the
5102 Please note that B<debug> is only available if collectd has been compiled with
5105 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
5107 Controls which notifications should be sent to syslog. The default behaviour is
5108 not to send any. Less severe notifications always imply logging more severe
5109 notifications: Setting this to B<OKAY> means all notifications will be sent to
5110 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
5111 notifications but will dismiss B<OKAY> notifications. Setting this option to
5112 B<FAILURE> will only send failures to syslog.
5116 =head2 Plugin C<table>
5118 The C<table plugin> provides generic means to parse tabular data and dispatch
5119 user specified values. Values are selected based on column numbers. For
5120 example, this plugin may be used to get values from the Linux L<proc(5)>
5121 filesystem or CSV (comma separated values) files.
5124 <Table "/proc/slabinfo">
5129 InstancePrefix "active_objs"
5135 InstancePrefix "objperslab"
5142 The configuration consists of one or more B<Table> blocks, each of which
5143 configures one file to parse. Within each B<Table> block, there are one or
5144 more B<Result> blocks, which configure which data to select and how to
5147 The following options are available inside a B<Table> block:
5151 =item B<Instance> I<instance>
5153 If specified, I<instance> is used as the plugin instance. So, in the above
5154 example, the plugin name C<table-slabinfo> would be used. If omitted, the
5155 filename of the table is used instead, with all special characters replaced
5156 with an underscore (C<_>).
5158 =item B<Separator> I<string>
5160 Any character of I<string> is interpreted as a delimiter between the different
5161 columns of the table. A sequence of two or more contiguous delimiters in the
5162 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
5163 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
5164 of a table - see its documentation for more details. This option is mandatory.
5166 A horizontal tab, newline and carriage return may be specified by C<\\t>,
5167 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
5168 required because of collectd's config parsing.
5172 The following options are available inside a B<Result> block:
5176 =item B<Type> I<type>
5178 Sets the type used to dispatch the values to the daemon. Detailed information
5179 about types and their configuration can be found in L<types.db(5)>. This
5180 option is mandatory.
5182 =item B<InstancePrefix> I<prefix>
5184 If specified, prepend I<prefix> to the type instance. If omitted, only the
5185 B<InstancesFrom> option is considered for the type instance.
5187 =item B<InstancesFrom> I<column0> [I<column1> ...]
5189 If specified, the content of the given columns (identified by the column
5190 number starting at zero) will be used to create the type instance for each
5191 row. Multiple values (and the instance prefix) will be joined together with
5192 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
5193 option is considered for the type instance.
5195 The plugin itself does not check whether or not all built instances are
5196 different. It’s your responsibility to assure that each is unique. This is
5197 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
5198 sure that the table only contains one row.
5200 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
5203 =item B<ValuesFrom> I<column0> [I<column1> ...]
5205 Specifies the columns (identified by the column numbers starting at zero)
5206 whose content is used as the actual data for the data sets that are dispatched
5207 to the daemon. How many such columns you need is determined by the B<Type>
5208 setting above. If you specify too many or not enough columns, the plugin will
5209 complain about that and no data will be submitted to the daemon. The plugin
5210 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
5211 respectively, so anything supported by those functions is supported by the
5212 plugin as well. This option is mandatory.
5216 =head2 Plugin C<tail>
5218 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
5219 each line and dispatches found values. What is matched can be configured by the
5220 user using (extended) regular expressions, as described in L<regex(7)>.
5223 <File "/var/log/exim4/mainlog">
5226 Regex "S=([1-9][0-9]*)"
5232 Regex "\\<R=local_user\\>"
5233 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
5236 Instance "local_user"
5241 The config consists of one or more B<File> blocks, each of which configures one
5242 logfile to parse. Within each B<File> block, there are one or more B<Match>
5243 blocks, which configure a regular expression to search for.
5245 The B<Instance> option in the B<File> block may be used to set the plugin
5246 instance. So in the above example the plugin name C<tail-foo> would be used.
5247 This plugin instance is for all B<Match> blocks that B<follow> it, until the
5248 next B<Instance> option. This way you can extract several plugin instances from
5249 one logfile, handy when parsing syslog and the like.
5251 Each B<Match> block has the following options to describe how the match should
5256 =item B<Regex> I<regex>
5258 Sets the regular expression to use for matching against a line. The first
5259 subexpression has to match something that can be turned into a number by
5260 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
5261 below. Because B<extended> regular expressions are used, you do not need to use
5262 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
5263 collectd's config parsing you need to escape backslashes, though. So if you
5264 want to match literal parentheses you need to do the following:
5266 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
5268 =item B<ExcludeRegex> I<regex>
5270 Sets an optional regular expression to use for excluding lines from the match.
5271 An example which excludes all connections from localhost from the match:
5273 ExcludeRegex "127\\.0\\.0\\.1"
5275 =item B<DSType> I<Type>
5277 Sets how the values are cumulated. I<Type> is one of:
5281 =item B<GaugeAverage>
5283 Calculate the average.
5287 Use the smallest number only.
5291 Use the greatest number only.
5295 Use the last number found.
5301 =item B<AbsoluteSet>
5303 The matched number is a counter. Simply I<sets> the internal counter to this
5304 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
5310 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
5311 matched number may be negative, which will effectively subtract from the
5318 Increase the internal counter by one. These B<DSType> are the only ones that do
5319 not use the matched subexpression, but simply count the number of matched
5320 lines. Thus, you may use a regular expression without submatch in this case.
5324 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
5325 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
5326 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
5327 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
5328 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
5331 =item B<Type> I<Type>
5333 Sets the type used to dispatch this value. Detailed information about types and
5334 their configuration can be found in L<types.db(5)>.
5336 =item B<Instance> I<TypeInstance>
5338 This optional setting sets the type instance to use.
5342 =head2 Plugin C<tail_csv>
5344 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
5345 written by I<Snort>.
5350 <Metric "snort-dropped">
5355 <File "/var/log/snort/snort.stats">
5356 Instance "snort-eth0"
5358 Collect "snort-dropped"
5362 The configuration consists of one or more B<Metric> blocks that define an index
5363 into the line of the CSV file and how this value is mapped to I<collectd's>
5364 internal representation. These are followed by one or more B<Instance> blocks
5365 which configure which file to read, in which interval and which metrics to
5370 =item E<lt>B<Metric> I<Name>E<gt>
5372 The B<Metric> block configures a new metric to be extracted from the statistics
5373 file and how it is mapped on I<collectd's> data model. The string I<Name> is
5374 only used inside the B<Instance> blocks to refer to this block, so you can use
5375 one B<Metric> block for multiple CSV files.
5379 =item B<Type> I<Type>
5381 Configures which I<Type> to use when dispatching this metric. Types are defined
5382 in the L<types.db(5)> file, see the appropriate manual page for more
5383 information on specifying types. Only types with a single I<data source> are
5384 supported by the I<tail_csv plugin>. The information whether the value is an
5385 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
5386 I<Type's> definition.
5388 =item B<Instance> I<TypeInstance>
5390 If set, I<TypeInstance> is used to populate the type instance field of the
5391 created value lists. Otherwise, no type instance is used.
5393 =item B<ValueFrom> I<Index>
5395 Configure to read the value from the field with the zero-based index I<Index>.
5396 If the value is parsed as signed integer, unsigned integer or double depends on
5397 the B<Type> setting, see above.
5401 =item E<lt>B<File> I<Path>E<gt>
5403 Each B<File> block represents one CSV file to read. There must be at least one
5404 I<File> block but there can be multiple if you have multiple CSV files.
5408 =item B<Instance> I<PluginInstance>
5410 Sets the I<plugin instance> used when dispatching the values.
5412 =item B<Collect> I<Metric>
5414 Specifies which I<Metric> to collect. This option must be specified at least
5415 once, and you can use this option multiple times to specify more than one
5416 metric to be extracted from this statistic file.
5418 =item B<Interval> I<Seconds>
5420 Configures the interval in which to read values from this instance / file.
5421 Defaults to the plugin's default interval.
5423 =item B<TimeFrom> I<Index>
5425 Rather than using the local time when dispatching a value, read the timestamp
5426 from the field with the zero-based index I<Index>. The value is interpreted as
5427 seconds since epoch. The value is parsed as a double and may be factional.
5433 =head2 Plugin C<teamspeak2>
5435 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
5436 polls interesting global and virtual server data. The plugin can query only one
5437 physical server but unlimited virtual servers. You can use the following
5438 options to configure it:
5442 =item B<Host> I<hostname/ip>
5444 The hostname or ip which identifies the physical server.
5447 =item B<Port> I<port>
5449 The query port of the physical server. This needs to be a string.
5452 =item B<Server> I<port>
5454 This option has to be added once for every virtual server the plugin should
5455 query. If you want to query the virtual server on port 8767 this is what the
5456 option would look like:
5460 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
5461 use quotes around it! If no such statement is given only global information
5466 =head2 Plugin C<ted>
5468 The I<TED> plugin connects to a device of "The Energy Detective", a device to
5469 measure power consumption. These devices are usually connected to a serial
5470 (RS232) or USB port. The plugin opens a configured device and tries to read the
5471 current energy readings. For more information on TED, visit
5472 L<http://www.theenergydetective.com/>.
5474 Available configuration options:
5478 =item B<Device> I<Path>
5480 Path to the device on which TED is connected. collectd will need read and write
5481 permissions on that file.
5483 Default: B</dev/ttyUSB0>
5485 =item B<Retries> I<Num>
5487 Apparently reading from TED is not that reliable. You can therefore configure a
5488 number of retries here. You only configure the I<retries> here, to if you
5489 specify zero, one reading will be performed (but no retries if that fails); if
5490 you specify three, a maximum of four readings are performed. Negative values
5497 =head2 Plugin C<tcpconns>
5499 The C<tcpconns plugin> counts the number of currently established TCP
5500 connections based on the local port and/or the remote port. Since there may be
5501 a lot of connections the default if to count all connections with a local port,
5502 for which a listening socket is opened. You can use the following options to
5503 fine-tune the ports you are interested in:
5507 =item B<ListeningPorts> I<true>|I<false>
5509 If this option is set to I<true>, statistics for all local ports for which a
5510 listening socket exists are collected. The default depends on B<LocalPort> and
5511 B<RemotePort> (see below): If no port at all is specifically selected, the
5512 default is to collect listening ports. If specific ports (no matter if local or
5513 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
5514 the selected ports will be collected unless this option is set to I<true>
5517 =item B<LocalPort> I<Port>
5519 Count the connections to a specific local port. This can be used to see how
5520 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
5521 You have to specify the port in numeric form, so for the mailserver example
5522 you'd need to set B<25>.
5524 =item B<RemotePort> I<Port>
5526 Count the connections to a specific remote port. This is useful to see how
5527 much a remote service is used. This is most useful if you want to know how many
5528 connections a local service has opened to remote services, e.E<nbsp>g. how many
5529 connections a mail server or news server has to other mail or news servers, or
5530 how many connections a web proxy holds to web servers. You have to give the
5531 port in numeric form.
5535 =head2 Plugin C<thermal>
5539 =item B<ForceUseProcfs> I<true>|I<false>
5541 By default, the I<Thermal plugin> tries to read the statistics from the Linux
5542 C<sysfs> interface. If that is not available, the plugin falls back to the
5543 C<procfs> interface. By setting this option to I<true>, you can force the
5544 plugin to use the latter. This option defaults to I<false>.
5546 =item B<Device> I<Device>
5548 Selects the name of the thermal device that you want to collect or ignore,
5549 depending on the value of the B<IgnoreSelected> option. This option may be
5550 used multiple times to specify a list of devices.
5552 =item B<IgnoreSelected> I<true>|I<false>
5554 Invert the selection: If set to true, all devices B<except> the ones that
5555 match the device names specified by the B<Device> option are collected. By
5556 default only selected devices are collected if a selection is made. If no
5557 selection is configured at all, B<all> devices are selected.
5561 =head2 Plugin C<threshold>
5563 The I<Threshold plugin> checks values collected or received by I<collectd>
5564 against a configurable I<threshold> and issues I<notifications> if values are
5567 Documentation for this plugin is available in the L<collectd-threshold(5)>
5570 =head2 Plugin C<tokyotyrant>
5572 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
5573 couple metrics: number of records, and database size on disk.
5577 =item B<Host> I<Hostname/IP>
5579 The hostname or ip which identifies the server.
5580 Default: B<127.0.0.1>
5582 =item B<Port> I<Service/Port>
5584 The query port of the server. This needs to be a string, even if the port is
5585 given in its numeric form.
5590 =head2 Plugin C<unixsock>
5594 =item B<SocketFile> I<Path>
5596 Sets the socket-file which is to be created.
5598 =item B<SocketGroup> I<Group>
5600 If running as root change the group of the UNIX-socket after it has been
5601 created. Defaults to B<collectd>.
5603 =item B<SocketPerms> I<Permissions>
5605 Change the file permissions of the UNIX-socket after it has been created. The
5606 permissions must be given as a numeric, octal value as you would pass to
5607 L<chmod(1)>. Defaults to B<0770>.
5609 =item B<DeleteSocket> B<false>|B<true>
5611 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
5612 with the given name already exists. If I<collectd> crashes a socket file may be
5613 left over, preventing the daemon from opening a new socket when restarted.
5614 Since this is potentially dangerous, this defaults to B<false>.
5618 =head2 Plugin C<uuid>
5620 This plugin, if loaded, causes the Hostname to be taken from the machine's
5621 UUID. The UUID is a universally unique designation for the machine, usually
5622 taken from the machine's BIOS. This is most useful if the machine is running in
5623 a virtual environment such as Xen, in which case the UUID is preserved across
5624 shutdowns and migration.
5626 The following methods are used to find the machine's UUID, in order:
5632 Check I</etc/uuid> (or I<UUIDFile>).
5636 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
5641 Check for UUID from C<dmidecode> / SMBIOS.
5645 Check for UUID from Xen hypervisor.
5649 If no UUID can be found then the hostname is not modified.
5653 =item B<UUIDFile> I<Path>
5655 Take the UUID from the given file (default I</etc/uuid>).
5659 =head2 Plugin C<varnish>
5661 The Varnish plugin collects information about Varnish, an HTTP accelerator.
5665 =item B<CollectCache> B<true>|B<false>
5667 Cache hits and misses. True by default.
5669 =item B<CollectConnections> B<true>|B<false>
5671 Number of client connections received, accepted and dropped. True by default.
5673 =item B<CollectBackend> B<true>|B<false>
5675 Back-end connection statistics, such as successful, reused,
5676 and closed connections. True by default.
5678 =item B<CollectSHM> B<true>|B<false>
5680 Statistics about the shared memory log, a memory region to store
5681 log messages which is flushed to disk when full. True by default.
5683 =item B<CollectESI> B<true>|B<false>
5685 Edge Side Includes (ESI) parse statistics. False by default.
5687 =item B<CollectFetch> B<true>|B<false>
5689 Statistics about fetches (HTTP requests sent to the backend). False by default.
5691 =item B<CollectHCB> B<true>|B<false>
5693 Inserts and look-ups in the crit bit tree based hash. Look-ups are
5694 divided into locked and unlocked look-ups. False by default.
5696 =item B<CollectSMA> B<true>|B<false>
5698 malloc or umem (umem_alloc(3MALLOC) based) storage statistics.
5699 The umem storage component is Solaris specific. False by default.
5701 =item B<CollectSMS> B<true>|B<false>
5703 synth (synthetic content) storage statistics. This storage
5704 component is used internally only. False by default.
5706 =item B<CollectSM> B<true>|B<false>
5708 file (memory mapped file) storage statistics. False by default.
5710 =item B<CollectTotals> B<true>|B<false>
5712 Collects overview counters, such as the number of sessions created,
5713 the number of requests and bytes transferred. False by default.
5715 =item B<CollectWorkers> B<true>|B<false>
5717 Collect statistics about worker threads. False by default.
5721 =head2 Plugin C<vmem>
5723 The C<vmem> plugin collects information about the usage of virtual memory.
5724 Since the statistics provided by the Linux kernel are very detailed, they are
5725 collected very detailed. However, to get all the details, you have to switch
5726 them on manually. Most people just want an overview over, such as the number of
5727 pages read from swap space.
5731 =item B<Verbose> B<true>|B<false>
5733 Enables verbose collection of information. This will start collecting page
5734 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
5735 Part of these statistics are collected on a "per zone" basis.
5739 =head2 Plugin C<vserver>
5741 This plugin doesn't have any options. B<VServer> support is only available for
5742 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
5743 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
5744 need to apply the patches and compile your own kernel, which will then provide
5745 the F</proc/virtual> filesystem that is required by this plugin.
5747 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
5749 B<Note>: The traffic collected by this plugin accounts for the amount of
5750 traffic passing a socket which might be a lot less than the actual on-wire
5751 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
5752 collect on-wire traffic you could, for example, use the logging facilities of
5753 iptables to feed data for the guest IPs into the iptables plugin.
5755 =head2 Plugin C<write_graphite>
5757 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
5758 storage and graphing project. The plugin connects to I<Carbon>, the data layer
5759 of I<Graphite>, and sends data via the "line based" protocol (per default using
5760 portE<nbsp>2003). The data will be sent in blocks of at most 1428 bytes to
5761 minimize the number of network packets.
5765 <Plugin write_graphite>
5773 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
5774 blocks. Inside the B<Node> blocks, the following options are recognized:
5778 =item B<Host> I<Address>
5780 Hostname or address to connect to. Defaults to C<localhost>.
5782 =item B<Port> I<Service>
5784 Service name or port number to connect to. Defaults to C<2003>.
5786 =item B<Prefix> I<String>
5788 When set, I<String> is added in front of the host name. Dots and whitespace are
5789 I<not> escaped in this string (see B<EscapeCharacter> below).
5791 =item B<Postfix> I<String>
5793 When set, I<String> is appended to the host name. Dots and whitespace are
5794 I<not> escaped in this string (see B<EscapeCharacter> below).
5796 =item B<EscapeCharacter> I<Char>
5798 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
5799 in the identifier. The B<EscapeCharacter> option determines which character
5800 dots, whitespace and control characters are replaced with. Defaults to
5803 =item B<StoreRates> B<false>|B<true>
5805 If set to B<true> (the default), convert counter values to rates. If set to
5806 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
5809 =item B<SeparateInstances> B<false>|B<true>
5811 If set to B<true>, the plugin instance and type instance will be in their own
5812 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
5813 default), the plugin and plugin instance (and likewise the type and type
5814 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
5816 =item B<AlwaysAppendDS> B<false>|B<true>
5818 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
5819 identifier. If set to B<false> (the default), this is only done when there is
5824 =head2 Plugin C<write_mongodb>
5826 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
5831 <Plugin "write_mongodb">
5840 The plugin can send values to multiple instances of I<MongoDB> by specifying
5841 one B<Node> block for each instance. Within the B<Node> blocks, the following
5842 options are available:
5846 =item B<Host> I<Address>
5848 Hostname or address to connect to. Defaults to C<localhost>.
5850 =item B<Port> I<Service>
5852 Service name or port number to connect to. Defaults to C<27017>.
5854 =item B<Timeout> I<Timeout>
5856 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
5857 Setting this option to zero means no timeout, which is the default.
5859 =item B<StoreRates> B<false>|B<true>
5861 If set to B<true> (the default), convert counter values to rates. If set to
5862 B<false> counter values are stored as is, i.e. as an increasing integer
5865 =item B<Database> I<Database>
5867 =item B<User> I<User>
5869 =item B<Password> I<Password>
5871 Sets the information used when authenticating to a I<MongoDB> database. The
5872 fields are optional (in which case no authentication is attempted), but if you
5873 want to use authentication all three fields must be set.
5877 =head2 Plugin C<write_http>
5879 This output plugin submits values to an http server by POST them using the
5880 PUTVAL plain-text protocol. Each destination you want to post data to needs to
5881 have one B<URL> block, within which the destination can be configured further,
5882 for example by specifying authentication data.
5886 <Plugin "write_http">
5887 <URL "http://example.com/post-collectd">
5893 B<URL> blocks need one string argument which is used as the URL to which data
5894 is posted. The following options are understood within B<URL> blocks.
5898 =item B<User> I<Username>
5900 Optional user name needed for authentication.
5902 =item B<Password> I<Password>
5904 Optional password needed for authentication.
5906 =item B<VerifyPeer> B<true>|B<false>
5908 Enable or disable peer SSL certificate verification. See
5909 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5911 =item B<VerifyHost> B<true|false>
5913 Enable or disable peer host name verification. If enabled, the plugin checks if
5914 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
5915 matches the host name provided by the B<URL> option. If this identity check
5916 fails, the connection is aborted. Obviously, only works when connecting to a
5917 SSL enabled server. Enabled by default.
5919 =item B<CACert> I<File>
5921 File that holds one or more SSL certificates. If you want to use HTTPS you will
5922 possibly need this option. What CA certificates come bundled with C<libcurl>
5923 and are checked by default depends on the distribution you use.
5925 =item B<Format> B<Command>|B<JSON>
5927 Format of the output to generate. If set to B<Command>, will create output that
5928 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
5929 create output in the I<JavaScript Object Notation> (JSON).
5931 Defaults to B<Command>.
5933 =item B<StoreRates> B<true|false>
5935 If set to B<true>, convert counter values to rates. If set to B<false> (the
5936 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
5941 =head2 Plugin C<write_riemann>
5943 The I<write_riemann plugin> will send values to I<Riemann>, a powerfull stream
5944 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
5945 I<Riemann> using UDP packets.
5949 <Plugin "write_riemann">
5955 AlwaysAppendDS false
5961 The following options are understood by the I<write_riemann plugin>:
5965 =item E<lt>B<Node> I<Name>E<gt>
5967 The plugin's configuration consists of one or more B<Node> blocks. Each block
5968 is given a unique I<Name> and specifies one connection to an instance of
5969 I<Riemann>. Indise the B<Node> block, the following per-connection options are
5974 =item B<Host> I<Address>
5976 Hostname or address to connect to. Defaults to C<localhost>.
5978 =item B<Port> I<Service>
5980 Service name or port number to connect to. Defaults to C<5555>.
5982 =item B<Protocol> B<UDP>|B<TCP>
5984 Specify the protocol to use when communicating with I<Riemann>. Defaults to
5987 =item B<StoreRates> B<true>|B<false>
5989 If set to B<true> (the default), convert counter values to rates. If set to
5990 B<false> counter values are stored as is, i.e. as an increasing integer number.
5992 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
5993 converted values will have "rate" appended to the data source type, e.g.
5994 C<ds_type:derive:rate>.
5996 =item B<AlwaysAppendDS> B<false>|B<true>
5998 If set the B<true>, append the name of the I<Data Source> (DS) to the
5999 "service", i.e. the field that, together with the "host" field, uniquely
6000 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
6001 only done when there is more than one DS.
6005 =item B<Tag> I<String>
6007 Add the given string as an additional tag to the metric being sent to
6012 =head1 THRESHOLD CONFIGURATION
6014 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
6015 we mean that the values are not only stored or sent somewhere, but that they
6016 are judged and, if a problem is recognized, acted upon. The only action
6017 collectd takes itself is to generate and dispatch a "notification". Plugins can
6018 register to receive notifications and perform appropriate further actions.
6020 Since systems and what you expect them to do differ a lot, you can configure
6021 B<thresholds> for your values freely. This gives you a lot of flexibility but
6022 also a lot of responsibility.
6024 Every time a value is out of range a notification is dispatched. This means
6025 that the idle percentage of your CPU needs to be less then the configured
6026 threshold only once for a notification to be generated. There's no such thing
6027 as a moving average or similar - at least not now.
6029 Also, all values that match a threshold are considered to be relevant or
6030 "interesting". As a consequence collectd will issue a notification if they are
6031 not received for B<Timeout> iterations. The B<Timeout> configuration option is
6032 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
6033 "2" (the default) and some hosts sends it's CPU statistics to the server every
6034 60 seconds, a notification will be dispatched after about 120 seconds. It may
6035 take a little longer because the timeout is checked only once each B<Interval>
6038 When a value comes within range again or is received after it was missing, an
6039 "OKAY-notification" is dispatched.
6041 Here is a configuration example to get you started. Read below for more
6054 <Plugin "interface">
6071 WarningMin 100000000
6077 There are basically two types of configuration statements: The C<Host>,
6078 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
6079 configured. The C<Plugin> and C<Type> blocks may be specified further using the
6080 C<Instance> option. You can combine the block by nesting the blocks, though
6081 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
6082 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
6083 C<Type> may not contain other blocks. If multiple blocks apply to the same
6084 value the most specific block is used.
6086 The other statements specify the threshold to configure. They B<must> be
6087 included in a C<Type> block. Currently the following statements are recognized:
6091 =item B<FailureMax> I<Value>
6093 =item B<WarningMax> I<Value>
6095 Sets the upper bound of acceptable values. If unset defaults to positive
6096 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
6097 will be created. If the value is greater than B<WarningMax> but less than (or
6098 equal to) B<FailureMax> a B<WARNING> notification will be created.
6100 =item B<FailureMin> I<Value>
6102 =item B<WarningMin> I<Value>
6104 Sets the lower bound of acceptable values. If unset defaults to negative
6105 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
6106 be created. If the value is less than B<WarningMin> but greater than (or equal
6107 to) B<FailureMin> a B<WARNING> notification will be created.
6109 =item B<DataSource> I<DSName>
6111 Some data sets have more than one "data source". Interesting examples are the
6112 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
6113 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
6114 system load data set, C<load>, even has three data sources: C<shortterm>,
6115 C<midterm>, and C<longterm>.
6117 Normally, all data sources are checked against a configured threshold. If this
6118 is undesirable, or if you want to specify different limits for each data
6119 source, you can use the B<DataSource> option to have a threshold apply only to
6122 =item B<Invert> B<true>|B<false>
6124 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
6125 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
6126 B<WarningMax>) are not okay. Defaults to B<false>.
6128 =item B<Persist> B<true>|B<false>
6130 Sets how often notifications are generated. If set to B<true> one notification
6131 will be generated for each value that is out of the acceptable range. If set to
6132 B<false> (the default) then a notification is only generated if a value is out
6133 of range but the previous value was okay.
6135 This applies to missing values, too: If set to B<true> a notification about a
6136 missing value is generated once every B<Interval> seconds. If set to B<false>
6137 only one such notification is generated until the value appears again.
6139 =item B<Percentage> B<true>|B<false>
6141 If set to B<true>, the minimum and maximum values given are interpreted as
6142 percentage value, relative to the other data sources. This is helpful for
6143 example for the "df" type, where you may want to issue a warning when less than
6144 5E<nbsp>% of the total space is available. Defaults to B<false>.
6146 =item B<Hits> I<Number>
6148 Delay creating the notification until the threshold has been passed I<Number>
6149 times. When a notification has been generated, or when a subsequent value is
6150 inside the threshold, the counter is reset. If, for example, a value is
6151 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
6152 will be dispatched at most once every 30E<nbsp>seconds.
6154 This is useful when short bursts are not a problem. If, for example, 100% CPU
6155 usage for up to a minute is normal (and data is collected every
6156 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
6158 =item B<Hysteresis> I<Number>
6160 When set to non-zero, a hysteresis value is applied when checking minimum and
6161 maximum bounds. This is useful for values that increase slowly and fluctuate a
6162 bit while doing so. When these values come close to the threshold, they may
6163 "flap", i.e. switch between failure / warning case and okay case repeatedly.
6165 If, for example, the threshold is configures as
6170 then a I<Warning> notification is created when the value exceeds I<101> and the
6171 corresponding I<Okay> notification is only created once the value falls below
6172 I<99>, thus avoiding the "flapping".
6176 =head1 FILTER CONFIGURATION
6178 Starting with collectd 4.6 there is a powerful filtering infrastructure
6179 implemented in the daemon. The concept has mostly been copied from
6180 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
6181 terminology, so that users that are familiar with iptables feel right at home.
6185 The following are the terms used in the remainder of the filter configuration
6186 documentation. For an ASCII-art schema of the mechanism, see
6187 L<"General structure"> below.
6193 A I<match> is a criteria to select specific values. Examples are, of course, the
6194 name of the value or it's current value.
6196 Matches are implemented in plugins which you have to load prior to using the
6197 match. The name of such plugins starts with the "match_" prefix.
6201 A I<target> is some action that is to be performed with data. Such actions
6202 could, for example, be to change part of the value's identifier or to ignore
6203 the value completely.
6205 Some of these targets are built into the daemon, see L<"Built-in targets">
6206 below. Other targets are implemented in plugins which you have to load prior to
6207 using the target. The name of such plugins starts with the "target_" prefix.
6211 The combination of any number of matches and at least one target is called a
6212 I<rule>. The target actions will be performed for all values for which B<all>
6213 matches apply. If the rule does not have any matches associated with it, the
6214 target action will be performed for all values.
6218 A I<chain> is a list of rules and possibly default targets. The rules are tried
6219 in order and if one matches, the associated target will be called. If a value
6220 is handled by a rule, it depends on the target whether or not any subsequent
6221 rules are considered or if traversal of the chain is aborted, see
6222 L<"Flow control"> below. After all rules have been checked, the default targets
6227 =head2 General structure
6229 The following shows the resulting structure:
6236 +---------+ +---------+ +---------+ +---------+
6237 ! Rule !->! Match !->! Match !->! Target !
6238 +---------+ +---------+ +---------+ +---------+
6241 +---------+ +---------+ +---------+
6242 ! Rule !->! Target !->! Target !
6243 +---------+ +---------+ +---------+
6250 +---------+ +---------+ +---------+
6251 ! Rule !->! Match !->! Target !
6252 +---------+ +---------+ +---------+
6262 There are four ways to control which way a value takes through the filter
6269 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
6270 process the value with another chain. When the called chain finishes, usually
6271 the next target or rule after the jump is executed.
6275 The stop condition, signaled for example by the built-in target B<stop>, causes
6276 all processing of the value to be stopped immediately.
6280 Causes processing in the current chain to be aborted, but processing of the
6281 value generally will continue. This means that if the chain was called via
6282 B<Jump>, the next target or rule after the jump will be executed. If the chain
6283 was not called by another chain, control will be returned to the daemon and it
6284 may pass the value to another chain.
6288 Most targets will signal the B<continue> condition, meaning that processing
6289 should continue normally. There is no special built-in target for this
6296 The configuration reflects this structure directly:
6298 PostCacheChain "PostCache"
6300 <Rule "ignore_mysql_show">
6303 Type "^mysql_command$"
6304 TypeInstance "^show_"
6314 The above configuration example will ignore all values where the plugin field
6315 is "mysql", the type is "mysql_command" and the type instance begins with
6316 "show_". All other values will be sent to the C<rrdtool> write plugin via the
6317 default target of the chain. Since this chain is run after the value has been
6318 added to the cache, the MySQL C<show_*> command statistics will be available
6319 via the C<unixsock> plugin.
6321 =head2 List of configuration options
6325 =item B<PreCacheChain> I<ChainName>
6327 =item B<PostCacheChain> I<ChainName>
6329 Configure the name of the "pre-cache chain" and the "post-cache chain". The
6330 argument is the name of a I<chain> that should be executed before and/or after
6331 the values have been added to the cache.
6333 To understand the implications, it's important you know what is going on inside
6334 I<collectd>. The following diagram shows how values are passed from the
6335 read-plugins to the write-plugins:
6341 + - - - - V - - - - +
6342 : +---------------+ :
6345 : +-------+-------+ :
6348 : +-------+-------+ : +---------------+
6349 : ! Cache !--->! Value Cache !
6350 : ! insert ! : +---+---+-------+
6351 : +-------+-------+ : ! !
6352 : ! ,------------' !
6354 : +-------+---+---+ : +-------+-------+
6355 : ! Post-Cache +--->! Write-Plugins !
6356 : ! Chain ! : +---------------+
6357 : +---------------+ :
6360 + - - - - - - - - - +
6362 After the values are passed from the "read" plugins to the dispatch functions,
6363 the pre-cache chain is run first. The values are added to the internal cache
6364 afterwards. The post-cache chain is run after the values have been added to the
6365 cache. So why is it such a huge deal if chains are run before or after the
6366 values have been added to this cache?
6368 Targets that change the identifier of a value list should be executed before
6369 the values are added to the cache, so that the name in the cache matches the
6370 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
6371 this cache to receive a list of all available values. If you change the
6372 identifier after the value list has been added to the cache, this may easily
6373 lead to confusion, but it's not forbidden of course.
6375 The cache is also used to convert counter values to rates. These rates are, for
6376 example, used by the C<value> match (see below). If you use the rate stored in
6377 the cache B<before> the new value is added, you will use the old, B<previous>
6378 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
6379 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
6382 Last but not last, the B<stop> target makes a difference: If the pre-cache
6383 chain returns the stop condition, the value will not be added to the cache and
6384 the post-cache chain will not be run.
6386 =item B<Chain> I<Name>
6388 Adds a new chain with a certain name. This name can be used to refer to a
6389 specific chain, for example to jump to it.
6391 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
6393 =item B<Rule> [I<Name>]
6395 Adds a new rule to the current chain. The name of the rule is optional and
6396 currently has no meaning for the daemon.
6398 Within the B<Rule> block, there may be any number of B<Match> blocks and there
6399 must be at least one B<Target> block.
6401 =item B<Match> I<Name>
6403 Adds a match to a B<Rule> block. The name specifies what kind of match should
6404 be performed. Available matches depend on the plugins that have been loaded.
6406 The arguments inside the B<Match> block are passed to the plugin implementing
6407 the match, so which arguments are valid here depends on the plugin being used.
6408 If you do not need any to pass any arguments to a match, you can use the
6413 Which is equivalent to:
6418 =item B<Target> I<Name>
6420 Add a target to a rule or a default target to a chain. The name specifies what
6421 kind of target is to be added. Which targets are available depends on the
6422 plugins being loaded.
6424 The arguments inside the B<Target> block are passed to the plugin implementing
6425 the target, so which arguments are valid here depends on the plugin being used.
6426 If you do not need any to pass any arguments to a target, you can use the
6431 This is the same as writing:
6438 =head2 Built-in targets
6440 The following targets are built into the core daemon and therefore need no
6441 plugins to be loaded:
6447 Signals the "return" condition, see the L<"Flow control"> section above. This
6448 causes the current chain to stop processing the value and returns control to
6449 the calling chain. The calling chain will continue processing targets and rules
6450 just after the B<jump> target (see below). This is very similar to the
6451 B<RETURN> target of iptables, see L<iptables(8)>.
6453 This target does not have any options.
6461 Signals the "stop" condition, see the L<"Flow control"> section above. This
6462 causes processing of the value to be aborted immediately. This is similar to
6463 the B<DROP> target of iptables, see L<iptables(8)>.
6465 This target does not have any options.
6473 Sends the value to "write" plugins.
6479 =item B<Plugin> I<Name>
6481 Name of the write plugin to which the data should be sent. This option may be
6482 given multiple times to send the data to more than one write plugin.
6486 If no plugin is explicitly specified, the values will be sent to all available
6497 Starts processing the rules of another chain, see L<"Flow control"> above. If
6498 the end of that chain is reached, or a stop condition is encountered,
6499 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
6500 next target or the next rule. This is similar to the B<-j> command line option
6501 of iptables, see L<iptables(8)>.
6507 =item B<Chain> I<Name>
6509 Jumps to the chain I<Name>. This argument is required and may appear only once.
6521 =head2 Available matches
6527 Matches a value using regular expressions.
6533 =item B<Host> I<Regex>
6535 =item B<Plugin> I<Regex>
6537 =item B<PluginInstance> I<Regex>
6539 =item B<Type> I<Regex>
6541 =item B<TypeInstance> I<Regex>
6543 Match values where the given regular expressions match the various fields of
6544 the identifier of a value. If multiple regular expressions are given, B<all>
6545 regexen must match for a value to match.
6547 =item B<Invert> B<false>|B<true>
6549 When set to B<true>, the result of the match is inverted, i.e. all value lists
6550 where all regular expressions apply are not matched, all other value lists are
6551 matched. Defaults to B<false>.
6558 Host "customer[0-9]+"
6564 Matches values that have a time which differs from the time on the server.
6566 This match is mainly intended for servers that receive values over the
6567 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
6568 is very sensitive to the timestamp used when updating the RRD files. In
6569 particular, the time must be ever increasing. If a misbehaving client sends one
6570 packet with a timestamp far in the future, all further packets with a correct
6571 time will be ignored because of that one packet. What's worse, such corrupted
6572 RRD files are hard to fix.
6574 This match lets one match all values B<outside> a specified time range
6575 (relative to the server's time), so you can use the B<stop> target (see below)
6576 to ignore the value, for example.
6582 =item B<Future> I<Seconds>
6584 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
6585 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
6588 =item B<Past> I<Seconds>
6590 Matches all values that are I<behind> of the server's time by I<Seconds> or
6591 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
6603 This example matches all values that are five minutes or more ahead of the
6604 server or one hour (or more) lagging behind.
6608 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
6609 values. If a data-set consists of more than one data-source, all data-sources
6610 must match the specified ranges for a positive match.
6616 =item B<Min> I<Value>
6618 Sets the smallest value which still results in a match. If unset, behaves like
6621 =item B<Max> I<Value>
6623 Sets the largest value which still results in a match. If unset, behaves like
6626 =item B<Invert> B<true>|B<false>
6628 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
6629 no-match is returned and vice versa. Please note that the B<Invert> setting
6630 only effects how B<Min> and B<Max> are applied to a specific value. Especially
6631 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
6633 =item B<DataSource> I<DSName> [I<DSName> ...]
6635 Select one or more of the data sources. If no data source is configured, all
6636 data sources will be checked. If the type handled by the match does not have a
6637 data source of the specified name(s), this will always result in no match
6638 (independent of the B<Invert> setting).
6640 =item B<Satisfy> B<Any>|B<All>
6642 Specifies how checking with several data sources is performed. If set to
6643 B<Any>, the match succeeds if one of the data sources is in the configured
6644 range. If set to B<All> the match only succeeds if all data sources are within
6645 the configured range. Default is B<All>.
6647 Usually B<All> is used for positive matches, B<Any> is used for negative
6648 matches. This means that with B<All> you usually check that all values are in a
6649 "good" range, while with B<Any> you check if any value is within a "bad" range
6650 (or outside the "good" range).
6654 Either B<Min> or B<Max>, but not both, may be unset.
6658 # Match all values smaller than or equal to 100. Matches only if all data
6659 # sources are below 100.
6665 # Match if the value of any data source is outside the range of 0 - 100.
6673 =item B<empty_counter>
6675 Matches all values with one or more data sources of type B<COUNTER> and where
6676 all counter values are zero. These counters usually I<never> increased since
6677 they started existing (and are therefore uninteresting), or got reset recently
6678 or overflowed and you had really, I<really> bad luck.
6680 Please keep in mind that ignoring such counters can result in confusing
6681 behavior: Counters which hardly ever increase will be zero for long periods of
6682 time. If the counter is reset for some reason (machine or service restarted,
6683 usually), the graph will be empty (NAN) for a long time. People may not
6688 Calculates a hash value of the host name and matches values according to that
6689 hash value. This makes it possible to divide all hosts into groups and match
6690 only values that are in a specific group. The intended use is in load
6691 balancing, where you want to handle only part of all data and leave the rest
6694 The hashing function used tries to distribute the hosts evenly. First, it
6695 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
6698 for (i = 0; host[i] != 0; i++)
6699 hash_value = (hash_value * 251) + host[i];
6701 The constant 251 is a prime number which is supposed to make this hash value
6702 more random. The code then checks the group for this host according to the
6703 I<Total> and I<Match> arguments:
6705 if ((hash_value % Total) == Match)
6710 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
6711 groups), then the least significant bit of the hash value will be the XOR of
6712 all least significant bits in the host name. One consequence is that when you
6713 have two hosts, "server0.example.com" and "server1.example.com", where the host
6714 name differs in one digit only and the digits differ by one, those hosts will
6715 never end up in the same group.
6721 =item B<Match> I<Match> I<Total>
6723 Divide the data into I<Total> groups and match all hosts in group I<Match> as
6724 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
6725 be smaller than I<Total>. I<Total> must be at least one, although only values
6726 greater than one really do make any sense.
6728 You can repeat this option to match multiple groups, for example:
6733 The above config will divide the data into seven groups and match groups three
6734 and five. One use would be to keep every value on two hosts so that if one
6735 fails the missing data can later be reconstructed from the second host.
6741 # Operate on the pre-cache chain, so that ignored values are not even in the
6746 # Divide all received hosts in seven groups and accept all hosts in
6750 # If matched: Return and continue.
6753 # If not matched: Return and stop.
6759 =head2 Available targets
6763 =item B<notification>
6765 Creates and dispatches a notification.
6771 =item B<Message> I<String>
6773 This required option sets the message of the notification. The following
6774 placeholders will be replaced by an appropriate value:
6782 =item B<%{plugin_instance}>
6786 =item B<%{type_instance}>
6788 These placeholders are replaced by the identifier field of the same name.
6790 =item B<%{ds:>I<name>B<}>
6792 These placeholders are replaced by a (hopefully) human readable representation
6793 of the current rate of this data source. If you changed the instance name
6794 (using the B<set> or B<replace> targets, see below), it may not be possible to
6795 convert counter values to rates.
6799 Please note that these placeholders are B<case sensitive>!
6801 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
6803 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
6810 <Target "notification">
6811 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
6817 Replaces parts of the identifier using regular expressions.
6823 =item B<Host> I<Regex> I<Replacement>
6825 =item B<Plugin> I<Regex> I<Replacement>
6827 =item B<PluginInstance> I<Regex> I<Replacement>
6829 =item B<TypeInstance> I<Regex> I<Replacement>
6831 Match the appropriate field with the given regular expression I<Regex>. If the
6832 regular expression matches, that part that matches is replaced with
6833 I<Replacement>. If multiple places of the input buffer match a given regular
6834 expression, only the first occurrence will be replaced.
6836 You can specify each option multiple times to use multiple regular expressions
6844 # Replace "example.net" with "example.com"
6845 Host "\\<example.net\\>" "example.com"
6847 # Strip "www." from hostnames
6853 Sets part of the identifier of a value to a given string.
6859 =item B<Host> I<String>
6861 =item B<Plugin> I<String>
6863 =item B<PluginInstance> I<String>
6865 =item B<TypeInstance> I<String>
6867 Set the appropriate field to the given string. The strings for plugin instance
6868 and type instance may be empty, the strings for host and plugin may not be
6869 empty. It's currently not possible to set the type of a value this way.
6876 PluginInstance "coretemp"
6877 TypeInstance "core3"
6882 =head2 Backwards compatibility
6884 If you use collectd with an old configuration, i.E<nbsp>e. one without a
6885 B<Chain> block, it will behave as it used to. This is equivalent to the
6886 following configuration:
6892 If you specify a B<PostCacheChain>, the B<write> target will not be added
6893 anywhere and you will have to make sure that it is called where appropriate. We
6894 suggest to add the above snippet as default target to your "PostCache" chain.
6898 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
6914 L<collectd-exec(5)>,
6915 L<collectd-perl(5)>,
6916 L<collectd-unixsock(5)>,
6929 Florian Forster E<lt>octo@verplant.orgE<gt>