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_cpuacct>
857 This plugin collects the CPU user/system time for each cgroup by reading the
858 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 cgroup based on the name.
867 =item B<IgnoreSelected> B<true>|B<false>
869 Invert the selection: If set to true, all cgroups B<except> the ones that
870 match any one of the criteria are collected. By default only selected
871 cgroups are collected if a selection is made. If no selection is configured
872 at all, B<all> cgroups are selected.
876 =head2 Plugin C<cpufreq>
878 This plugin doesn't have any options. It reads
879 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
880 installed) to get the current CPU frequency. If this file does not exist make
881 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
882 installed and an "cpu governor" (that's a kernel module) is loaded.
888 =item B<DataDir> I<Directory>
890 Set the directory to store CSV-files under. Per default CSV-files are generated
891 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
892 The special strings B<stdout> and B<stderr> can be used to write to the standard
893 output and standard error channels, respectively. This, of course, only makes
894 much sense when collectd is running in foreground- or non-daemon-mode.
896 =item B<StoreRates> B<true|false>
898 If set to B<true>, convert counter values to rates. If set to B<false> (the
899 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
904 =head2 Plugin C<curl>
906 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
907 and the match infrastructure (the same code used by the tail plugin) to use
908 regular expressions with the received data.
910 The following example will read the current value of AMD stock from Google's
911 finance page and dispatch the value to collectd.
914 <Page "stock_quotes">
915 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
919 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
920 DSType "GaugeAverage"
921 # Note: `stock_value' is not a standard type.
928 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
929 a web page and one or more "matches" to be performed on the returned data. The
930 string argument to the B<Page> block is used as plugin instance.
932 The following options are valid within B<Page> blocks:
938 URL of the web site to retrieve. Since a regular expression will be used to
939 extract information from this data, non-binary data is a big plus here ;)
941 =item B<User> I<Name>
943 Username to use if authorization is required to read the page.
945 =item B<Password> I<Password>
947 Password to use if authorization is required to read the page.
949 =item B<VerifyPeer> B<true>|B<false>
951 Enable or disable peer SSL certificate verification. See
952 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
954 =item B<VerifyHost> B<true>|B<false>
956 Enable or disable peer host name verification. If enabled, the plugin checks if
957 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
958 matches the host name provided by the B<URL> option. If this identity check
959 fails, the connection is aborted. Obviously, only works when connecting to a
960 SSL enabled server. Enabled by default.
962 =item B<CACert> I<file>
964 File that holds one or more SSL certificates. If you want to use HTTPS you will
965 possibly need this option. What CA certificates come bundled with C<libcurl>
966 and are checked by default depends on the distribution you use.
968 =item B<Header> I<Header>
970 A HTTP header to add to the request. Multiple headers are added if this option
971 is specified more than once.
973 =item B<Post> I<Body>
975 Specifies that the HTTP operation should be a POST instead of a GET. The
976 complete data to be posted is given as the argument. This option will usually
977 need to be accompanied by a B<Header> option to set an appropriate
978 C<Content-Type> for the post body (e.g. to
979 C<application/x-www-form-urlencoded>).
981 =item B<MeasureResponseTime> B<true>|B<false>
983 Measure response time for the request. If this setting is enabled, B<Match>
984 blocks (see below) are optional. Disabled by default.
986 =item B<E<lt>MatchE<gt>>
988 One or more B<Match> blocks that define how to match information in the data
989 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
990 used by the C<tail> plugin, so please see the documentation of the C<tail>
991 plugin below on how matches are defined. If the B<MeasureResponseTime> option
992 is set to B<true>, B<Match> blocks are optional.
996 =head2 Plugin C<curl_json>
998 The B<curl_json plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and
999 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) to retrieve JSON data
1000 via cURL. This can be used to collect values from CouchDB documents (which are
1001 stored JSON notation), for example.
1003 The following example will collect several values from the built-in `_stats'
1004 runtime statistics module of CouchDB
1005 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1008 <URL "http://localhost:5984/_stats">
1010 <Key "httpd/requests/count">
1011 Type "http_requests"
1014 <Key "httpd_request_methods/*/count">
1015 Type "http_request_methods"
1018 <Key "httpd_status_codes/*/count">
1019 Type "http_response_codes"
1024 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining
1025 a URL to be fetched via HTTP (using libcurl) and one or more B<Key> blocks.
1026 The B<Key> string argument must be in a path format, which is used to collect a
1027 value from a JSON map object. If a path element of B<Key> is the
1028 I<*>E<nbsp>wildcard, the values for all keys will be collectd.
1030 The following options are valid within B<URL> blocks:
1034 =item B<Instance> I<Instance>
1036 Sets the plugin instance to I<Instance>.
1038 =item B<User> I<Name>
1039 =item B<Password> I<Password>
1040 =item B<VerifyPeer> B<true>|B<false>
1041 =item B<VerifyHost> B<true>|B<false>
1042 =item B<CACert> I<file>
1043 =item B<Header> I<Header>
1044 =item B<Post> I<Body>
1046 These options behave exactly equivalent to the appropriate options of the
1047 I<cURL> plugin. Please see there for a detailed description.
1051 The following options are valid within B<Key> blocks:
1055 =item B<Type> I<Type>
1057 Sets the type used to dispatch the values to the daemon. Detailed information
1058 about types and their configuration can be found in L<types.db(5)>. This
1059 option is mandatory.
1061 =item B<Instance> I<Instance>
1063 Type-instance to use. Defaults to the current map key or current string array element value.
1067 =head2 Plugin C<curl_xml>
1069 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1070 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1073 <URL "http://localhost/stats.xml">
1075 Instance "some_instance"
1080 CACert "/path/to/ca.crt"
1082 <XPath "table[@id=\"magic_level\"]/tr">
1084 #InstancePrefix "prefix-"
1085 InstanceFrom "td[1]"
1086 ValuesFrom "td[2]/span[@class=\"level\"]"
1091 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1092 URL to be fetched using libcurl. Within each B<URL> block there are
1093 options which specify the connection parameters, for example authentication
1094 information, and one or more B<XPath> blocks.
1096 Each B<XPath> block specifies how to get one type of information. The
1097 string argument must be a valid XPath expression which returns a list
1098 of "base elements". One value is dispatched for each "base element". The
1099 I<type instance> and values are looked up using further I<XPath> expressions
1100 that should be relative to the base element.
1102 Within the B<URL> block the following options are accepted:
1106 =item B<Host> I<Name>
1108 Use I<Name> as the host name when submitting values. Defaults to the global
1111 =item B<Instance> I<Instance>
1113 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1114 empty string (no plugin instance).
1116 =item B<Namespace> I<Prefix> I<URL>
1118 If an XPath expression references namespaces, they must be specified
1119 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1120 I<URL> is the "namespace name", an URI reference uniquely identifying the
1121 namespace. The option can be repeated to register multiple namespaces.
1125 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1126 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1128 =item B<User> I<User>
1130 =item B<Password> I<Password>
1132 =item B<VerifyPeer> B<true>|B<false>
1134 =item B<VerifyHost> B<true>|B<false>
1136 =item B<CACert> I<CA Cert File>
1138 =item B<Header> I<Header>
1140 =item B<Post> I<Body>
1142 These options behave exactly equivalent to the appropriate options of the
1143 I<cURL plugin>. Please see there for a detailed description.
1145 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1147 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1148 B<XPath> block specifies how to get one type of information. The string
1149 argument must be a valid XPath expression which returns a list of "base
1150 elements". One value is dispatched for each "base element".
1152 Within the B<XPath> block the following options are accepted:
1156 =item B<Type> I<Type>
1158 Specifies the I<Type> used for submitting patches. This determines the number
1159 of values that are required / expected and whether the strings are parsed as
1160 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1161 This option is required.
1163 =item B<InstancePrefix> I<InstancePrefix>
1165 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1166 concatenated together without any separator.
1167 This option is optional.
1169 =item B<InstanceFrom> I<InstanceFrom>
1171 Specifies a XPath expression to use for determining the I<type instance>. The
1172 XPath expression must return exactly one element. The element's value is then
1173 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1175 This value is required. As a special exception, if the "base XPath expression"
1176 (the argument to the B<XPath> block) returns exactly one argument, then this
1177 option may be omitted.
1179 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1181 Specifies one or more XPath expression to use for reading the values. The
1182 number of XPath expressions must match the number of data sources in the
1183 I<type> specified with B<Type> (see above). Each XPath expression must return
1184 exactly one element. The element's value is then parsed as a number and used as
1185 value for the appropriate value in the value list dispatched to the daemon.
1191 =head2 Plugin C<dbi>
1193 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1194 connect to various databases, execute I<SQL> statements and read back the
1195 results. I<dbi> is an acronym for "database interface" in case you were
1196 wondering about the name. You can configure how each column is to be
1197 interpreted and the plugin will generate one or more data sets from each row
1198 returned according to these rules.
1200 Because the plugin is very generic, the configuration is a little more complex
1201 than those of other plugins. It usually looks something like this:
1204 <Query "out_of_stock">
1205 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1206 # Use with MySQL 5.0.0 or later
1210 InstancePrefix "out_of_stock"
1211 InstancesFrom "category"
1215 <Database "product_information">
1217 DriverOption "host" "localhost"
1218 DriverOption "username" "collectd"
1219 DriverOption "password" "aZo6daiw"
1220 DriverOption "dbname" "prod_info"
1221 SelectDB "prod_info"
1222 Query "out_of_stock"
1226 The configuration above defines one query with one result and one database. The
1227 query is then linked to the database with the B<Query> option I<within> the
1228 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1229 and you can also use the B<Include> statement to split up the configuration
1230 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1231 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1234 The following is a complete list of options:
1236 =head3 B<Query> blocks
1238 Query blocks define I<SQL> statements and how the returned data should be
1239 interpreted. They are identified by the name that is given in the opening line
1240 of the block. Thus the name needs to be unique. Other than that, the name is
1241 not used in collectd.
1243 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1244 define which column holds which value or instance information. You can use
1245 multiple B<Result> blocks to create multiple values from one returned row. This
1246 is especially useful, when queries take a long time and sending almost the same
1247 query again and again is not desirable.
1251 <Query "environment">
1252 Statement "select station, temperature, humidity from environment"
1255 # InstancePrefix "foo"
1256 InstancesFrom "station"
1257 ValuesFrom "temperature"
1261 InstancesFrom "station"
1262 ValuesFrom "humidity"
1266 The following options are accepted:
1270 =item B<Statement> I<SQL>
1272 Sets the statement that should be executed on the server. This is B<not>
1273 interpreted by collectd, but simply passed to the database server. Therefore,
1274 the SQL dialect that's used depends on the server collectd is connected to.
1276 The query has to return at least two columns, one for the instance and one
1277 value. You cannot omit the instance, even if the statement is guaranteed to
1278 always return exactly one line. In that case, you can usually specify something
1281 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1283 (That works with MySQL but may not be valid SQL according to the spec. If you
1284 use a more strict database server, you may have to select from a dummy table or
1287 Please note that some databases, for example B<Oracle>, will fail if you
1288 include a semicolon at the end of the statement.
1290 =item B<MinVersion> I<Version>
1292 =item B<MaxVersion> I<Value>
1294 Only use this query for the specified database version. You can use these
1295 options to provide multiple queries with the same name but with a slightly
1296 different syntax. The plugin will use only those queries, where the specified
1297 minimum and maximum versions fit the version of the database in use.
1299 The database version is determined by C<dbi_conn_get_engine_version>, see the
1300 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1301 for details. Basically, each part of the version is assumed to be in the range
1302 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1303 "40102", version "5.0.42" becomes "50042".
1305 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1306 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1307 happen. Don't to it! A valid example would be something along these lines:
1318 In the above example, there are three ranges that don't overlap. The last one
1319 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1320 before "4.0.0" are not specified.
1322 =item B<Type> I<Type>
1324 The B<type> that's used for each line returned. See L<types.db(5)> for more
1325 details on how types are defined. In short: A type is a predefined layout of
1326 data and the number of values and type of values has to match the type
1329 If you specify "temperature" here, you need exactly one gauge column. If you
1330 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1333 There must be exactly one B<Type> option inside each B<Result> block.
1335 =item B<InstancePrefix> I<prefix>
1337 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1338 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1339 all strings returned in the appropriate columns are concatenated together,
1340 separated by dashes I<("-")>.
1342 =item B<InstancesFrom> I<column0> [I<column1> ...]
1344 Specifies the columns whose values will be used to create the "type-instance"
1345 for each row. If you specify more than one column, the value of all columns
1346 will be joined together with dashes I<("-")> as separation characters.
1348 The plugin itself does not check whether or not all built instances are
1349 different. It's your responsibility to assure that each is unique. This is
1350 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1351 sure that only one row is returned in this case.
1353 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1356 =item B<ValuesFrom> I<column0> [I<column1> ...]
1358 Names the columns whose content is used as the actual data for the data sets
1359 that are dispatched to the daemon. How many such columns you need is determined
1360 by the B<Type> setting above. If you specify too many or not enough columns,
1361 the plugin will complain about that and no data will be submitted to the
1364 The actual data type in the columns is not that important. The plugin will
1365 automatically cast the values to the right type if it know how to do that. So
1366 it should be able to handle integer an floating point types, as well as strings
1367 (if they include a number at the beginning).
1369 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1373 =head3 B<Database> blocks
1375 Database blocks define a connection to a database and which queries should be
1376 sent to that database. Since the used "dbi" library can handle a wide variety
1377 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1378 documentationE<nbsp>- we stick as close to the terminology used there.
1380 Each database needs a "name" as string argument in the starting tag of the
1381 block. This name will be used as "PluginInstance" in the values submitted to
1382 the daemon. Other than that, that name is not used.
1386 =item B<Driver> I<Driver>
1388 Specifies the driver to use to connect to the database. In many cases those
1389 drivers are named after the database they can connect to, but this is not a
1390 technical necessity. These drivers are sometimes referred to as "DBD",
1391 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1392 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1393 project at L<http://libdbi-drivers.sourceforge.net/>.
1395 You need to give the driver name as expected by the "dbi" library here. You
1396 should be able to find that in the documentation for each driver. If you
1397 mistype the driver name, the plugin will dump a list of all known driver names
1400 =item B<DriverOption> I<Key> I<Value>
1402 Sets driver-specific options. What option a driver supports can be found in the
1403 documentation for each driver, somewhere at
1404 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1405 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1407 DBDs can register two types of options: String options and numeric options. The
1408 plugin will use the C<dbi_conn_set_option> function when the configuration
1409 provides a string and the C<dbi_conn_require_option_numeric> function when the
1410 configuration provides a number. So these two lines will actually result in
1411 different calls being used:
1413 DriverOption "Port" 1234 # numeric
1414 DriverOption "Port" "1234" # string
1416 Unfortunately, drivers are not too keen to report errors when an unknown option
1417 is passed to them, so invalid settings here may go unnoticed. This is not the
1418 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1419 the driver. If a driver complains about an option, the plugin will dump a
1420 complete list of all options understood by that driver to the log. There is no
1421 way to programatically find out if an option expects a string or a numeric
1422 argument, so you will have to refer to the appropriate DBD's documentation to
1423 find this out. Sorry.
1425 =item B<SelectDB> I<Database>
1427 In some cases, the database name you connect with is not the database name you
1428 want to use for querying data. If this option is set, the plugin will "select"
1429 (switch to) that database after the connection is established.
1431 =item B<Query> I<QueryName>
1433 Associates the query named I<QueryName> with this database connection. The
1434 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1435 blocks you want to refer to must be placed above the database block you want to
1438 =item B<Host> I<Hostname>
1440 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
1441 values. Defaults to the global hostname setting.
1449 =item B<Device> I<Device>
1451 Select partitions based on the devicename.
1453 =item B<MountPoint> I<Directory>
1455 Select partitions based on the mountpoint.
1457 =item B<FSType> I<FSType>
1459 Select partitions based on the filesystem type.
1461 =item B<IgnoreSelected> B<true>|B<false>
1463 Invert the selection: If set to true, all partitions B<except> the ones that
1464 match any one of the criteria are collected. By default only selected
1465 partitions are collected if a selection is made. If no selection is configured
1466 at all, B<all> partitions are selected.
1468 =item B<ReportByDevice> B<true>|B<false>
1470 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1471 (the default), it will report a disk as "root", but with it I<true>, it will be
1472 "sda1" (or whichever).
1474 =item B<ReportInodes> B<true>|B<false>
1476 Enables or disables reporting of free, reserved and used inodes. Defaults to
1477 inode collection being disabled.
1479 Enable this option if inodes are a scarce resource for you, usually because
1480 many small files are stored on the disk. This is a usual scenario for mail
1481 transfer agents and web caches.
1485 =head2 Plugin C<disk>
1487 The C<disk> plugin collects information about the usage of physical disks and
1488 logical disks (partitions). Values collected are the number of octets written
1489 to and read from a disk or partition, the number of read/write operations
1490 issued to the disk and a rather complex "time" it took for these commands to be
1493 Using the following two options you can ignore some disks or configure the
1494 collection only of specific disks.
1498 =item B<Disk> I<Name>
1500 Select the disk I<Name>. Whether it is collected or ignored depends on the
1501 B<IgnoreSelected> setting, see below. As with other plugins that use the
1502 daemon's ignorelist functionality, a string that starts and ends with a slash
1503 is interpreted as a regular expression. Examples:
1508 =item B<IgnoreSelected> B<true>|B<false>
1510 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1511 statements, are ignored or if all other disks are ignored. The behavior
1512 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1513 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1514 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1515 is set to B<true>, all disks are collected B<except> the ones matched.
1519 =head2 Plugin C<dns>
1523 =item B<Interface> I<Interface>
1525 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1526 option sets the interface that should be used. If this option is not set, or
1527 set to "any", the plugin will try to get packets from B<all> interfaces. This
1528 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1530 =item B<IgnoreSource> I<IP-address>
1532 Ignore packets that originate from this address.
1534 =item B<SelectNumericQueryTypes> B<true>|B<false>
1536 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1540 =head2 Plugin C<email>
1544 =item B<SocketFile> I<Path>
1546 Sets the socket-file which is to be created.
1548 =item B<SocketGroup> I<Group>
1550 If running as root change the group of the UNIX-socket after it has been
1551 created. Defaults to B<collectd>.
1553 =item B<SocketPerms> I<Permissions>
1555 Change the file permissions of the UNIX-socket after it has been created. The
1556 permissions must be given as a numeric, octal value as you would pass to
1557 L<chmod(1)>. Defaults to B<0770>.
1559 =item B<MaxConns> I<Number>
1561 Sets the maximum number of connections that can be handled in parallel. Since
1562 this many threads will be started immediately setting this to a very high
1563 value will waste valuable resources. Defaults to B<5> and will be forced to be
1564 at most B<16384> to prevent typos and dumb mistakes.
1568 =head2 Plugin C<ethstat>
1570 The I<ethstat plugin> collects information about network interface cards (NICs)
1571 by talking directly with the underlying kernel driver using L<ioctl(2)>.
1577 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
1578 Map "multicast" "if_multicast"
1585 =item B<Interface> I<Name>
1587 Collect statistical information about interface I<Name>.
1589 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
1591 By default, the plugin will submit values as type C<derive> and I<type
1592 instance> set to I<Name>, the name of the metric as reported by the driver. If
1593 an appropriate B<Map> option exists, the given I<Type> and, optionally,
1594 I<TypeInstance> will be used.
1596 =item B<MappedOnly> B<true>|B<false>
1598 When set to B<true>, only metrics that can be mapped to to a I<type> will be
1599 collected, all other metrics will be ignored. Defaults to B<false>.
1603 =head2 Plugin C<exec>
1605 Please make sure to read L<collectd-exec(5)> before using this plugin. It
1606 contains valuable information on when the executable is executed and the
1607 output that is expected from it.
1611 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1613 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1615 Execute the executable I<Executable> as user I<User>. If the user name is
1616 followed by a colon and a group name, the effective group is set to that group.
1617 The real group and saved-set group will be set to the default group of that
1618 user. If no group is given the effective group ID will be the same as the real
1621 Please note that in order to change the user and/or group the daemon needs
1622 superuser privileges. If the daemon is run as an unprivileged user you must
1623 specify the same user/group here. If the daemon is run with superuser
1624 privileges, you must supply a non-root user here.
1626 The executable may be followed by optional arguments that are passed to the
1627 program. Please note that due to the configuration parsing numbers and boolean
1628 values may be changed. If you want to be absolutely sure that something is
1629 passed as-is please enclose it in quotes.
1631 The B<Exec> and B<NotificationExec> statements change the semantics of the
1632 programs executed, i.E<nbsp>e. the data passed to them and the response
1633 expected from them. This is documented in great detail in L<collectd-exec(5)>.
1637 =head2 Plugin C<filecount>
1639 The C<filecount> plugin counts the number of files in a certain directory (and
1640 its subdirectories) and their combined size. The configuration is very straight
1643 <Plugin "filecount">
1644 <Directory "/var/qmail/queue/mess">
1645 Instance "qmail-message"
1647 <Directory "/var/qmail/queue/todo">
1648 Instance "qmail-todo"
1650 <Directory "/var/lib/php5">
1651 Instance "php5-sessions"
1656 The example above counts the number of files in QMail's queue directories and
1657 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
1658 QMail has not yet looked at, the "message" queue holds the messages that were
1659 classified into "local" and "remote".
1661 As you can see, the configuration consists of one or more C<Directory> blocks,
1662 each of which specifies a directory in which to count the files. Within those
1663 blocks, the following options are recognized:
1667 =item B<Instance> I<Instance>
1669 Sets the plugin instance to I<Instance>. That instance name must be unique, but
1670 it's your responsibility, the plugin doesn't check for that. If not given, the
1671 instance is set to the directory name with all slashes replaced by underscores
1672 and all leading underscores removed.
1674 =item B<Name> I<Pattern>
1676 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
1677 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
1678 against the pattern, not the entire path. In case this makes it easier for you:
1679 This option has been named after the B<-name> parameter to L<find(1)>.
1681 =item B<MTime> I<Age>
1683 Count only files of a specific age: If I<Age> is greater than zero, only files
1684 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
1685 a negative number, this is inversed. For example, if B<-60> is specified, only
1686 files that have been modified in the last minute will be counted.
1688 The number can also be followed by a "multiplier" to easily specify a larger
1689 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
1690 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
1691 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
1692 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
1693 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
1696 =item B<Size> I<Size>
1698 Count only files of a specific size. When I<Size> is a positive number, only
1699 files that are at least this big are counted. If I<Size> is a negative number,
1700 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
1701 I<Size> are counted.
1703 As with the B<MTime> option, a "multiplier" may be added. For a detailed
1704 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
1705 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
1706 note that there are 1000 bytes in a kilobyte, not 1024.
1708 =item B<Recursive> I<true>|I<false>
1710 Controls whether or not to recurse into subdirectories. Enabled by default.
1712 =item B<IncludeHidden> I<true>|I<false>
1714 Controls whether or not to include "hidden" files and directories in the count.
1715 "Hidden" files and directories are those, whose name begins with a dot.
1716 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
1720 =head2 Plugin C<GenericJMX>
1722 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
1723 L<collectd-java(5)>.
1725 =head2 Plugin C<gmond>
1727 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
1728 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
1729 are built-in, custom mappings may be added via B<Metric> blocks, see below.
1734 MCReceiveFrom "239.2.11.71" "8649"
1735 <Metric "swap_total">
1737 TypeInstance "total"
1740 <Metric "swap_free">
1747 The following metrics are built-in:
1753 load_one, load_five, load_fifteen
1757 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
1761 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
1773 Available configuration options:
1777 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
1779 Sets sets the multicast group and UDP port to which to subscribe.
1781 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
1783 =item E<lt>B<Metric> I<Name>E<gt>
1785 These blocks add a new metric conversion to the internal table. I<Name>, the
1786 string argument to the B<Metric> block, is the metric name as used by Ganglia.
1790 =item B<Type> I<Type>
1792 Type to map this metric to. Required.
1794 =item B<TypeInstance> I<Instance>
1796 Type-instance to use. Optional.
1798 =item B<DataSource> I<Name>
1800 Data source to map this metric to. If the configured type has exactly one data
1801 source, this is optional. Otherwise the option is required.
1807 =head2 Plugin C<hddtemp>
1809 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
1810 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
1811 default values, see below. C<hddtemp> has to be running to work correctly. If
1812 C<hddtemp> is not running timeouts may appear which may interfere with other
1815 The B<hddtemp> homepage can be found at
1816 L<http://www.guzu.net/linux/hddtemp.php>.
1820 =item B<Host> I<Hostname>
1822 Hostname to connect to. Defaults to B<127.0.0.1>.
1824 =item B<Port> I<Port>
1826 TCP-Port to connect to. Defaults to B<7634>.
1830 =head2 Plugin C<interface>
1834 =item B<Interface> I<Interface>
1836 Select this interface. By default these interfaces will then be collected. For
1837 a more detailed description see B<IgnoreSelected> below.
1839 =item B<IgnoreSelected> I<true>|I<false>
1841 If no configuration if given, the B<traffic>-plugin will collect data from
1842 all interfaces. This may not be practical, especially for loopback- and
1843 similar interfaces. Thus, you can use the B<Interface>-option to pick the
1844 interfaces you're interested in. Sometimes, however, it's easier/preferred
1845 to collect all interfaces I<except> a few ones. This option enables you to
1846 do that: By setting B<IgnoreSelected> to I<true> the effect of
1847 B<Interface> is inverted: All selected interfaces are ignored and all
1848 other interfaces are collected.
1852 =head2 Plugin C<ipmi>
1856 =item B<Sensor> I<Sensor>
1858 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
1860 =item B<IgnoreSelected> I<true>|I<false>
1862 If no configuration if given, the B<ipmi> plugin will collect data from all
1863 sensors found of type "temperature", "voltage", "current" and "fanspeed".
1864 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
1865 the effect of B<Sensor> is inverted: All selected sensors are ignored and
1866 all other sensors are collected.
1868 =item B<NotifySensorAdd> I<true>|I<false>
1870 If a sensor appears after initialization time of a minute a notification
1873 =item B<NotifySensorRemove> I<true>|I<false>
1875 If a sensor disappears a notification is sent.
1877 =item B<NotifySensorNotPresent> I<true>|I<false>
1879 If you have for example dual power supply and one of them is (un)plugged then
1880 a notification is sent.
1884 =head2 Plugin C<iptables>
1888 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
1890 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
1891 will collect the counters of all rules which have a comment-match. The comment
1892 is then used as type-instance.
1894 If I<Comment> or I<Number> is given, only the rule with the matching comment or
1895 the I<n>th rule will be collected. Again, the comment (or the number) will be
1896 used as the type-instance.
1898 If I<Name> is supplied, it will be used as the type-instance instead of the
1899 comment or the number.
1903 =head2 Plugin C<irq>
1909 Select this irq. By default these irqs will then be collected. For a more
1910 detailed description see B<IgnoreSelected> below.
1912 =item B<IgnoreSelected> I<true>|I<false>
1914 If no configuration if given, the B<irq>-plugin will collect data from all
1915 irqs. This may not be practical, especially if no interrupts happen. Thus, you
1916 can use the B<Irq>-option to pick the interrupt you're interested in.
1917 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
1918 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
1919 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
1920 and all other interrupts are collected.
1924 =head2 Plugin C<java>
1926 The I<Java> plugin makes it possible to write extensions for collectd in Java.
1927 This section only discusses the syntax and semantic of the configuration
1928 options. For more in-depth information on the I<Java> plugin, please read
1929 L<collectd-java(5)>.
1934 JVMArg "-verbose:jni"
1935 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
1936 LoadPlugin "org.collectd.java.Foobar"
1937 <Plugin "org.collectd.java.Foobar">
1938 # To be parsed by the plugin
1942 Available configuration options:
1946 =item B<JVMArg> I<Argument>
1948 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
1949 exactly the way the arguments to the I<java> binary on the command line work.
1950 Execute C<javaE<nbsp>--help> for details.
1952 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
1953 any other options! When another option is found, the JVM will be started and
1954 later options will have to be ignored!
1956 =item B<LoadPlugin> I<JavaClass>
1958 Instantiates a new I<JavaClass> object. The constructor of this object very
1959 likely then registers one or more callback methods with the server.
1961 See L<collectd-java(5)> for details.
1963 When the first such option is found, the virtual machine (JVM) is created. This
1964 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
1965 B<LoadPlugin> options!
1967 =item B<Plugin> I<Name>
1969 The entire block is passed to the Java plugin as an
1970 I<org.collectd.api.OConfigItem> object.
1972 For this to work, the plugin has to register a configuration callback first,
1973 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
1974 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
1975 depends on the (Java) plugin registering the callback and is completely
1976 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
1980 =head2 Plugin C<libvirt>
1982 This plugin allows CPU, disk and network load to be collected for virtualized
1983 guests on the machine. This means that these characteristics can be collected
1984 for guest systems without installing any software on them - collectd only runs
1985 on the hosting system. The statistics are collected through libvirt
1986 (L<http://libvirt.org/>).
1988 Only I<Connection> is required.
1992 =item B<Connection> I<uri>
1994 Connect to the hypervisor given by I<uri>. For example if using Xen use:
1996 Connection "xen:///"
1998 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
2000 =item B<RefreshInterval> I<seconds>
2002 Refresh the list of domains and devices every I<seconds>. The default is 60
2003 seconds. Setting this to be the same or smaller than the I<Interval> will cause
2004 the list of domains and devices to be refreshed on every iteration.
2006 Refreshing the devices in particular is quite a costly operation, so if your
2007 virtualization setup is static you might consider increasing this. If this
2008 option is set to 0, refreshing is disabled completely.
2010 =item B<Domain> I<name>
2012 =item B<BlockDevice> I<name:dev>
2014 =item B<InterfaceDevice> I<name:dev>
2016 =item B<IgnoreSelected> I<true>|I<false>
2018 Select which domains and devices are collected.
2020 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
2021 disk/network devices are collected.
2023 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
2024 domains and disk/network devices are ignored, while the rest are collected.
2026 The domain name and device names may use a regular expression, if the name is
2027 surrounded by I</.../> and collectd was compiled with support for regexps.
2029 The default is to collect statistics for all domains and all their devices.
2033 BlockDevice "/:hdb/"
2034 IgnoreSelected "true"
2036 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
2039 =item B<HostnameFormat> B<name|uuid|hostname|...>
2041 When the libvirt plugin logs data, it sets the hostname of the collected data
2042 according to this setting. The default is to use the guest name as provided by
2043 the hypervisor, which is equal to setting B<name>.
2045 B<uuid> means use the guest's UUID. This is useful if you want to track the
2046 same guest across migrations.
2048 B<hostname> means to use the global B<Hostname> setting, which is probably not
2049 useful on its own because all guests will appear to have the same name.
2051 You can also specify combinations of these fields. For example B<name uuid>
2052 means to concatenate the guest name and UUID (with a literal colon character
2053 between, thus I<"foo:1234-1234-1234-1234">).
2055 =item B<InterfaceFormat> B<name>|B<address>
2057 When the libvirt plugin logs interface data, it sets the name of the collected
2058 data according to this setting. The default is to use the path as provided by
2059 the hypervisor (the "dev" property of the target node), which is equal to
2062 B<address> means use the interface's mac address. This is useful since the
2063 interface path might change between reboots of a guest or across migrations.
2067 =head2 Plugin C<logfile>
2071 =item B<LogLevel> B<debug|info|notice|warning|err>
2073 Sets the log-level. If, for example, set to B<notice>, then all events with
2074 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2076 Please note that B<debug> is only available if collectd has been compiled with
2079 =item B<File> I<File>
2081 Sets the file to write log messages to. The special strings B<stdout> and
2082 B<stderr> can be used to write to the standard output and standard error
2083 channels, respectively. This, of course, only makes much sense when I<collectd>
2084 is running in foreground- or non-daemon-mode.
2086 =item B<Timestamp> B<true>|B<false>
2088 Prefix all lines printed by the current time. Defaults to B<true>.
2090 =item B<PrintSeverity> B<true>|B<false>
2092 When enabled, all lines are prefixed by the severity of the log message, for
2093 example "warning". Defaults to B<false>.
2097 B<Note>: There is no need to notify the daemon after moving or removing the
2098 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2099 for each line it writes.
2101 =head2 Plugin C<lpar>
2103 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2104 virtualization technique for IBM POWER processors. It takes into account CPU
2105 time stolen from or donated to a partition, in addition to the usual user,
2106 system, I/O statistics.
2108 The following configuration options are available:
2112 =item B<CpuPoolStats> B<false>|B<true>
2114 When enabled, statistics about the processor pool are read, too. The partition
2115 needs to have pool authority in order to be able to acquire this information.
2118 =item B<ReportBySerial> B<false>|B<true>
2120 If enabled, the serial of the physical machine the partition is currently
2121 running on is reported as I<hostname> and the logical hostname of the machine
2122 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2123 used (just like other plugins) and the I<plugin instance> will be empty.
2128 =head2 Plugin C<mbmon>
2130 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2132 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2133 B<Host> and B<Port> options can be used to change these values, see below.
2134 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2135 timeouts may appear which may interfere with other statistics..
2137 C<mbmon> must be run with the -r option ("print TAG and Value format");
2138 Debian's F</etc/init.d/mbmon> script already does this, other people
2139 will need to ensure that this is the case.
2143 =item B<Host> I<Hostname>
2145 Hostname to connect to. Defaults to B<127.0.0.1>.
2147 =item B<Port> I<Port>
2149 TCP-Port to connect to. Defaults to B<411>.
2155 The C<md plugin> collects information from Linux Software-RAID devices (md).
2157 All reported values are of the type C<md_disks>. Reported type instances are
2158 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2159 I<missing> (physically absent) disks.
2163 =item B<Device> I<Device>
2165 Select md devices based on device name. The I<device name> is the basename of
2166 the device, i.e. the name of the block device without the leading C</dev/>.
2167 See B<IgnoreSelected> for more details.
2169 =item B<IgnoreSelected> B<true>|B<false>
2171 Invert device selection: If set to B<true>, all md devices B<except> those
2172 listed using B<Device> are collected. If B<false> (the default), only those
2173 listed are collected. If no configuration is given, the B<md> plugin will
2174 collect data from all md devices.
2178 =head2 Plugin C<memcachec>
2180 The C<memcachec plugin> connects to a memcached server, queries one or more
2181 given I<pages> and parses the returned data according to user specification.
2182 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2185 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2186 library. Please note that there is another library with a very similar name,
2187 libmemcache (notice the missing `d'), which is not applicable.
2189 Synopsis of the configuration:
2191 <Plugin "memcachec">
2192 <Page "plugin_instance">
2196 Regex "(\\d+) bytes sent"
2199 Instance "type_instance"
2204 The configuration options are:
2208 =item E<lt>B<Page> I<Name>E<gt>
2210 Each B<Page> block defines one I<page> to be queried from the memcached server.
2211 The block requires one string argument which is used as I<plugin instance>.
2213 =item B<Server> I<Address>
2215 Sets the server address to connect to when querying the page. Must be inside a
2220 When connected to the memcached server, asks for the page I<Key>.
2222 =item E<lt>B<Match>E<gt>
2224 Match blocks define which strings to look for and how matches substrings are
2225 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2229 =head2 Plugin C<memcached>
2231 The C<memcached plugin> connects to a memcached server and queries statistics
2232 about cache utilization, memory and bandwidth used.
2233 L<http://www.danga.com/memcached/>
2235 <Plugin "memcached">
2237 Host "memcache.example.com"
2242 The plugin configuration consists of one or more B<Instance> blocks which
2243 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2244 following options are allowed:
2248 =item B<Host> I<Hostname>
2250 Hostname to connect to. Defaults to B<127.0.0.1>.
2252 =item B<Port> I<Port>
2254 TCP-Port to connect to. Defaults to B<11211>.
2256 =item B<Socket> I<Path>
2258 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2259 setting is given, the B<Host> and B<Port> settings are ignored.
2263 =head2 Plugin C<modbus>
2265 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
2266 register values. It supports reading single registers (unsigned 16E<nbsp>bit
2267 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2268 values (two registers interpreted as IEEE floats in big endian notation).
2272 <Data "voltage-input-1">
2279 <Data "voltage-input-2">
2286 <Host "modbus.example.com">
2287 Address "192.168.0.42"
2292 Instance "power-supply"
2293 Collect "voltage-input-1"
2294 Collect "voltage-input-2"
2300 =item E<lt>B<Data> I<Name>E<gt> blocks
2302 Data blocks define a mapping between register numbers and the "types" used by
2305 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
2309 =item B<RegisterBase> I<Number>
2311 Configures the base register to read from the device. If the option
2312 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
2313 register will be read (the register number is increased by one).
2315 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
2317 Specifies what kind of data is returned by the device. If the type is B<Int32>,
2318 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
2319 combined into one value. Defaults to B<Uint16>.
2321 =item B<Type> I<Type>
2323 Specifies the "type" (data set) to use when dispatching the value to
2324 I<collectd>. Currently, only data sets with exactly one data source are
2327 =item B<Instance> I<Instance>
2329 Sets the type instance to use when dispatching the value to I<collectd>. If
2330 unset, an empty string (no type instance) is used.
2334 =item E<lt>B<Host> I<Name>E<gt> blocks
2336 Host blocks are used to specify to which hosts to connect and what data to read
2337 from their "slaves". The string argument I<Name> is used as hostname when
2338 dispatching the values to I<collectd>.
2340 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
2344 =item B<Address> I<Hostname>
2346 Specifies the node name (the actual network address) used to connect to the
2347 host. This may be an IP address or a hostname. Please note that the used
2348 I<libmodbus> library only supports IPv4 at the moment.
2350 =item B<Port> I<Service>
2352 Specifies the port used to connect to the host. The port can either be given as
2353 a number or as a service name. Please note that the I<Service> argument must be
2354 a string, even if ports are given in their numerical form. Defaults to "502".
2356 =item B<Interval> I<Interval>
2358 Sets the interval (in seconds) in which the values will be collected from this
2359 host. By default the global B<Interval> setting will be used.
2361 =item E<lt>B<Slave> I<ID>E<gt>
2363 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
2364 is used to specify which device should be addressed. For each device you want
2365 to query, one B<Slave> block must be given.
2367 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
2371 =item B<Instance> I<Instance>
2373 Specify the plugin instance to use when dispatching the values to I<collectd>.
2374 By default "slave_I<ID>" is used.
2376 =item B<Collect> I<DataName>
2378 Specifies which data to retrieve from the device. I<DataName> must be the same
2379 string as the I<Name> argument passed to a B<Data> block. You can specify this
2380 option multiple times to collect more than one value from a slave. At least one
2381 B<Collect> option is mandatory.
2389 =head2 Plugin C<mysql>
2391 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
2392 one or more databases when started and keeps the connection up as long as
2393 possible. When the connection is interrupted for whatever reason it will try
2394 to re-connect. The plugin will complain loudly in case anything goes wrong.
2396 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
2397 and collects information about MySQL network traffic, executed statements,
2398 requests, the query cache and threads by evaluating the
2399 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
2400 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
2401 Status Variables> for an explanation of these values.
2403 Optionally, master and slave statistics may be collected in a MySQL
2404 replication setup. In that case, information about the synchronization state
2405 of the nodes are collected by evaluating the C<Position> return value of the
2406 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
2407 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
2408 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
2409 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
2410 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
2425 Socket "/var/run/mysql/mysqld.sock"
2427 SlaveNotifications true
2431 A B<Database> block defines one connection to a MySQL database. It accepts a
2432 single argument which specifies the name of the database. None of the other
2433 options are required. MySQL will use default values as documented in the
2434 section "mysql_real_connect()" in the B<MySQL reference manual>.
2438 =item B<Host> I<Hostname>
2440 Hostname of the database server. Defaults to B<localhost>.
2442 =item B<User> I<Username>
2444 Username to use when connecting to the database. The user does not have to be
2445 granted any privileges (which is synonym to granting the C<USAGE> privilege),
2446 unless you want to collectd replication statistics (see B<MasterStats> and
2447 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
2448 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
2450 =item B<Password> I<Password>
2452 Password needed to log into the database.
2454 =item B<Database> I<Database>
2456 Select this database. Defaults to I<no database> which is a perfectly reasonable
2457 option for what this plugin does.
2459 =item B<Port> I<Port>
2461 TCP-port to connect to. The port must be specified in its numeric form, but it
2462 must be passed as a string nonetheless. For example:
2466 If B<Host> is set to B<localhost> (the default), this setting has no effect.
2467 See the documentation for the C<mysql_real_connect> function for details.
2469 =item B<Socket> I<Socket>
2471 Specifies the path to the UNIX domain socket of the MySQL server. This option
2472 only has any effect, if B<Host> is set to B<localhost> (the default).
2473 Otherwise, use the B<Port> option above. See the documentation for the
2474 C<mysql_real_connect> function for details.
2476 =item B<MasterStats> I<true|false>
2478 =item B<SlaveStats> I<true|false>
2480 Enable the collection of master / slave statistics in a replication setup. In
2481 order to be able to get access to these statistics, the user needs special
2482 privileges. See the B<User> documentation above.
2484 =item B<SlaveNotifications> I<true|false>
2486 If enabled, the plugin sends a notification if the replication slave I/O and /
2487 or SQL threads are not running.
2491 =head2 Plugin C<netapp>
2493 The netapp plugin can collect various performance and capacity information
2494 from a NetApp filer using the NetApp API.
2496 Please note that NetApp has a wide line of products and a lot of different
2497 software versions for each of these products. This plugin was developed for a
2498 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
2499 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
2500 model and software version but it is very hard to test this.
2501 If you have used this plugin with other models and/or software version, feel
2502 free to send us a mail to tell us about the results, even if it's just a short
2505 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
2506 basic authentication.
2508 B<Do not use a regular user for this!> Create a special collectd user with just
2509 the minimum of capabilities needed. The user only needs the "login-http-admin"
2510 capability as well as a few more depending on which data will be collected.
2511 Required capabilities are documented below.
2516 <Host "netapp1.example.com">
2540 IgnoreSelectedIO false
2542 IgnoreSelectedOps false
2543 GetLatency "volume0"
2544 IgnoreSelectedLatency false
2551 IgnoreSelectedCapacity false
2554 IgnoreSelectedSnapshot false
2582 The netapp plugin accepts the following configuration options:
2586 =item B<Host> I<Name>
2588 A host block defines one NetApp filer. It will appear in collectd with the name
2589 you specify here which does not have to be its real name nor its hostname (see
2590 the B<Address> option below).
2592 =item B<VFiler> I<Name>
2594 A B<VFiler> block may only be used inside a host block. It accepts all the
2595 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
2596 will execute all NetApp API commands in the context of the specified
2597 VFiler(R). It will appear in collectd with the name you specify here which
2598 does not have to be its real name. The VFiler name may be specified using the
2599 B<VFilerName> option. If this is not specified, it will default to the name
2602 The VFiler block inherits all connection related settings from the surrounding
2603 B<Host> block (which appear before the B<VFiler> block) but they may be
2604 overwritten inside the B<VFiler> block.
2606 This feature is useful, for example, when using a VFiler as SnapVault target
2607 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
2608 available in the host filer (vfiler0) but only in the respective VFiler
2611 =item B<Protocol> B<httpd>|B<http>
2613 The protocol collectd will use to query this host.
2621 Valid options: http, https
2623 =item B<Address> I<Address>
2625 The hostname or IP address of the host.
2631 Default: The "host" block's name.
2633 =item B<Port> I<Port>
2635 The TCP port to connect to on the host.
2641 Default: 80 for protocol "http", 443 for protocol "https"
2643 =item B<User> I<User>
2645 =item B<Password> I<Password>
2647 The username and password to use to login to the NetApp.
2653 =item B<VFilerName> I<Name>
2655 The name of the VFiler in which context to execute API commands. If not
2656 specified, the name provided to the B<VFiler> block will be used instead.
2662 Default: name of the B<VFiler> block
2664 B<Note:> This option may only be used inside B<VFiler> blocks.
2666 =item B<Interval> I<Interval>
2672 The following options decide what kind of data will be collected. You can
2673 either use them as a block and fine tune various parameters inside this block,
2674 use them as a single statement to just accept all default values, or omit it to
2675 not collect any data.
2677 The following options are valid inside all blocks:
2681 =item B<Interval> I<Seconds>
2683 Collect the respective statistics every I<Seconds> seconds. Defaults to the
2684 host specific setting.
2688 =head3 The System block
2690 This will collect various performance data about the whole system.
2692 B<Note:> To get this data the collectd user needs the
2693 "api-perf-object-get-instances" capability.
2697 =item B<Interval> I<Seconds>
2699 Collect disk statistics every I<Seconds> seconds.
2701 =item B<GetCPULoad> B<true>|B<false>
2703 If you set this option to true the current CPU usage will be read. This will be
2704 the average usage between all CPUs in your NetApp without any information about
2707 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2708 returns in the "CPU" field.
2716 Result: Two value lists of type "cpu", and type instances "idle" and "system".
2718 =item B<GetInterfaces> B<true>|B<false>
2720 If you set this option to true the current traffic of the network interfaces
2721 will be read. This will be the total traffic over all interfaces of your NetApp
2722 without any information about individual interfaces.
2724 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2725 in the "Net kB/s" field.
2735 Result: One value list of type "if_octects".
2737 =item B<GetDiskIO> B<true>|B<false>
2739 If you set this option to true the current IO throughput will be read. This
2740 will be the total IO of your NetApp without any information about individual
2741 disks, volumes or aggregates.
2743 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2744 in the "DiskE<nbsp>kB/s" field.
2752 Result: One value list of type "disk_octets".
2754 =item B<GetDiskOps> B<true>|B<false>
2756 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
2757 iSCSI, etc. operations will be read. This will be the total number of
2758 operations on your NetApp without any information about individual volumes or
2761 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2762 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
2770 Result: A variable number of value lists of type "disk_ops_complex". Each type
2771 of operation will result in one value list with the name of the operation as
2776 =head3 The WAFL block
2778 This will collect various performance data about the WAFL file system. At the
2779 moment this just means cache performance.
2781 B<Note:> To get this data the collectd user needs the
2782 "api-perf-object-get-instances" capability.
2784 B<Note:> The interface to get these values is classified as "Diagnostics" by
2785 NetApp. This means that it is not guaranteed to be stable even between minor
2790 =item B<Interval> I<Seconds>
2792 Collect disk statistics every I<Seconds> seconds.
2794 =item B<GetNameCache> B<true>|B<false>
2802 Result: One value list of type "cache_ratio" and type instance
2805 =item B<GetDirCache> B<true>|B<false>
2813 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
2815 =item B<GetInodeCache> B<true>|B<false>
2823 Result: One value list of type "cache_ratio" and type instance
2826 =item B<GetBufferCache> B<true>|B<false>
2828 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
2829 in the "Cache hit" field.
2837 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
2841 =head3 The Disks block
2843 This will collect performance data about the individual disks in the NetApp.
2845 B<Note:> To get this data the collectd user needs the
2846 "api-perf-object-get-instances" capability.
2850 =item B<Interval> I<Seconds>
2852 Collect disk statistics every I<Seconds> seconds.
2854 =item B<GetBusy> B<true>|B<false>
2856 If you set this option to true the busy time of all disks will be calculated
2857 and the value of the busiest disk in the system will be written.
2859 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2860 in the "Disk util" field. Probably.
2868 Result: One value list of type "percent" and type instance "disk_busy".
2872 =head3 The VolumePerf block
2874 This will collect various performance data about the individual volumes.
2876 You can select which data to collect about which volume using the following
2877 options. They follow the standard ignorelist semantic.
2879 B<Note:> To get this data the collectd user needs the
2880 I<api-perf-object-get-instances> capability.
2884 =item B<Interval> I<Seconds>
2886 Collect volume performance data every I<Seconds> seconds.
2888 =item B<GetIO> I<Volume>
2890 =item B<GetOps> I<Volume>
2892 =item B<GetLatency> I<Volume>
2894 Select the given volume for IO, operations or latency statistics collection.
2895 The argument is the name of the volume without the C</vol/> prefix.
2897 Since the standard ignorelist functionality is used here, you can use a string
2898 starting and ending with a slash to specify regular expression matching: To
2899 match the volumes "vol0", "vol2" and "vol7", you can use this regular
2902 GetIO "/^vol[027]$/"
2904 If no regular expression is specified, an exact match is required. Both,
2905 regular and exact matching are case sensitive.
2907 If no volume was specified at all for either of the three options, that data
2908 will be collected for all available volumes.
2910 =item B<IgnoreSelectedIO> B<true>|B<false>
2912 =item B<IgnoreSelectedOps> B<true>|B<false>
2914 =item B<IgnoreSelectedLatency> B<true>|B<false>
2916 When set to B<true>, the volumes selected for IO, operations or latency
2917 statistics collection will be ignored and the data will be collected for all
2920 When set to B<false>, data will only be collected for the specified volumes and
2921 all other volumes will be ignored.
2923 If no volumes have been specified with the above B<Get*> options, all volumes
2924 will be collected regardless of the B<IgnoreSelected*> option.
2926 Defaults to B<false>
2930 =head3 The VolumeUsage block
2932 This will collect capacity data about the individual volumes.
2934 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
2939 =item B<Interval> I<Seconds>
2941 Collect volume usage statistics every I<Seconds> seconds.
2943 =item B<GetCapacity> I<VolumeName>
2945 The current capacity of the volume will be collected. This will result in two
2946 to four value lists, depending on the configuration of the volume. All data
2947 sources are of type "df_complex" with the name of the volume as
2950 There will be type_instances "used" and "free" for the number of used and
2951 available bytes on the volume. If the volume has some space reserved for
2952 snapshots, a type_instance "snap_reserved" will be available. If the volume
2953 has SIS enabled, a type_instance "sis_saved" will be available. This is the
2954 number of bytes saved by the SIS feature.
2956 B<Note:> The current NetApp API has a bug that results in this value being
2957 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
2958 number which works most of the time. If you see strange values here, bug
2959 NetApp support to fix this.
2961 Repeat this option to specify multiple volumes.
2963 =item B<IgnoreSelectedCapacity> B<true>|B<false>
2965 Specify whether to collect only the volumes selected by the B<GetCapacity>
2966 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
2967 B<false>. However, if no B<GetCapacity> option is specified at all, all
2968 capacities will be selected anyway.
2970 =item B<GetSnapshot> I<VolumeName>
2972 Select volumes from which to collect snapshot information.
2974 Usually, the space used for snapshots is included in the space reported as
2975 "used". If snapshot information is collected as well, the space used for
2976 snapshots is subtracted from the used space.
2978 To make things even more interesting, it is possible to reserve space to be
2979 used for snapshots. If the space required for snapshots is less than that
2980 reserved space, there is "reserved free" and "reserved used" space in addition
2981 to "free" and "used". If the space required for snapshots exceeds the reserved
2982 space, that part allocated in the normal space is subtracted from the "used"
2985 Repeat this option to specify multiple volumes.
2987 =item B<IgnoreSelectedSnapshot>
2989 Specify whether to collect only the volumes selected by the B<GetSnapshot>
2990 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
2991 B<false>. However, if no B<GetSnapshot> option is specified at all, all
2992 capacities will be selected anyway.
2996 =head3 The Quota block
2998 This will collect (tree) quota statistics (used disk space and number of used
2999 files). This mechanism is useful to get usage information for single qtrees.
3000 In case the quotas are not used for any other purpose, an entry similar to the
3001 following in C</etc/quotas> would be sufficient:
3003 /vol/volA/some_qtree tree - - - - -
3005 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3009 =item B<Interval> I<Seconds>
3011 Collect SnapVault(R) statistics every I<Seconds> seconds.
3015 =head3 The SnapVault block
3017 This will collect statistics about the time and traffic of SnapVault(R)
3022 =item B<Interval> I<Seconds>
3024 Collect SnapVault(R) statistics every I<Seconds> seconds.
3028 =head2 Plugin C<netlink>
3030 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3031 statistics of various interface and routing aspects.
3035 =item B<Interface> I<Interface>
3037 =item B<VerboseInterface> I<Interface>
3039 Instruct the plugin to collect interface statistics. This is basically the same
3040 as the statistics provided by the C<interface> plugin (see above) but
3041 potentially much more detailed.
3043 When configuring with B<Interface> only the basic statistics will be collected,
3044 namely octets, packets, and errors. These statistics are collected by
3045 the C<interface> plugin, too, so using both at the same time is no benefit.
3047 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3048 so that no data needs to be collected twice if you use the C<interface> plugin.
3049 This includes dropped packets, received multicast packets, collisions and a
3050 whole zoo of differentiated RX and TX errors. You can try the following command
3051 to get an idea of what awaits you:
3055 If I<Interface> is B<All>, all interfaces will be selected.
3057 =item B<QDisc> I<Interface> [I<QDisc>]
3059 =item B<Class> I<Interface> [I<Class>]
3061 =item B<Filter> I<Interface> [I<Filter>]
3063 Collect the octets and packets that pass a certain qdisc, class or filter.
3065 QDiscs and classes are identified by their type and handle (or classid).
3066 Filters don't necessarily have a handle, therefore the parent's handle is used.
3067 The notation used in collectd differs from that used in tc(1) in that it
3068 doesn't skip the major or minor number if it's zero and doesn't print special
3069 ids by their name. So, for example, a qdisc may be identified by
3070 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3071 thus not displayed by tc(1).
3073 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3074 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3075 associated with that interface will be collected.
3077 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3078 used. This may lead to problems when more than one filter is attached to a
3079 qdisc or class. This isn't nice, but we don't know how this could be done any
3080 better. If you have a idea, please don't hesitate to tell us.
3082 As with the B<Interface> option you can specify B<All> as the interface,
3083 meaning all interfaces.
3085 Here are some examples to help you understand the above text more easily:
3088 VerboseInterface "All"
3089 QDisc "eth0" "pfifo_fast-1:0"
3091 Class "ppp0" "htb-1:10"
3092 Filter "ppp0" "u32-1:0"
3095 =item B<IgnoreSelected>
3097 The behavior is the same as with all other similar plugins: If nothing is
3098 selected at all, everything is collected. If some things are selected using the
3099 options described above, only these statistics are collected. If you set
3100 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3101 specified statistics will not be collected.
3105 =head2 Plugin C<network>
3107 The Network plugin sends data to a remote instance of collectd, receives data
3108 from a remote instance, or both at the same time. Data which has been received
3109 from the network is usually not transmitted again, but this can be activated, see
3110 the B<Forward> option below.
3112 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3113 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3115 Both, B<Server> and B<Listen> can be used as single option or as block. When
3116 used as block, given options are valid for this socket only. The following
3117 example will export the metrics twice: Once to an "internal" server (without
3118 encryption and signing) and one to an external server (with cryptographic
3122 # Export to an internal server
3123 # (demonstrates usage without additional options)
3124 Server "collectd.internal.tld"
3126 # Export to an external server
3127 # (demonstrates usage with signature options)
3128 <Server "collectd.external.tld">
3129 SecurityLevel "sign"
3130 Username "myhostname"
3137 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3139 The B<Server> statement/block sets the server to send datagrams to. The
3140 statement may occur multiple times to send each datagram to multiple
3143 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3144 optional second argument specifies a port number or a service name. If not
3145 given, the default, B<25826>, is used.
3147 The following options are recognized within B<Server> blocks:
3151 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3153 Set the security you require for network communication. When the security level
3154 has been set to B<Encrypt>, data sent over the network will be encrypted using
3155 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3156 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3157 authentication code. When set to B<None>, data is sent without any security.
3159 This feature is only available if the I<network> plugin was linked with
3162 =item B<Username> I<Username>
3164 Sets the username to transmit. This is used by the server to lookup the
3165 password. See B<AuthFile> below. All security levels except B<None> require
3168 This feature is only available if the I<network> plugin was linked with
3171 =item B<Password> I<Password>
3173 Sets a password (shared secret) for this socket. All security levels except
3174 B<None> require this setting.
3176 This feature is only available if the I<network> plugin was linked with
3179 =item B<Interface> I<Interface name>
3181 Set the outgoing interface for IP packets. This applies at least
3182 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3183 undefined or a non-existent interface name is specified, the default
3184 behavior is to let the kernel choose the appropriate interface. Be warned
3185 that the manual selection of an interface for unicast traffic is only
3186 necessary in rare cases.
3190 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
3192 The B<Listen> statement sets the interfaces to bind to. When multiple
3193 statements are found the daemon will bind to multiple interfaces.
3195 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
3196 the argument is a multicast address the daemon will join that multicast group.
3197 The optional second argument specifies a port number or a service name. If not
3198 given, the default, B<25826>, is used.
3200 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
3204 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3206 Set the security you require for network communication. When the security level
3207 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
3208 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
3209 signed and encrypted data is accepted. When set to B<None>, all data will be
3210 accepted. If an B<AuthFile> option was given (see below), encrypted data is
3211 decrypted if possible.
3213 This feature is only available if the I<network> plugin was linked with
3216 =item B<AuthFile> I<Filename>
3218 Sets a file in which usernames are mapped to passwords. These passwords are
3219 used to verify signatures and to decrypt encrypted network packets. If
3220 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
3221 verified and encrypted packets are decrypted. Otherwise, signed data is
3222 accepted without checking the signature and encrypted data cannot be decrypted.
3223 For the other security levels this option is mandatory.
3225 The file format is very simple: Each line consists of a username followed by a
3226 colon and any number of spaces followed by the password. To demonstrate, an
3227 example file could look like this:
3232 Each time a packet is received, the modification time of the file is checked
3233 using L<stat(2)>. If the file has been changed, the contents is re-read. While
3234 the file is being read, it is locked using L<fcntl(2)>.
3236 =item B<Interface> I<Interface name>
3238 Set the incoming interface for IP packets explicitly. This applies at least
3239 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3240 undefined or a non-existent interface name is specified, the default
3241 behavior is, to let the kernel choose the appropriate interface. Thus incoming
3242 traffic gets only accepted, if it arrives on the given interface.
3246 =item B<TimeToLive> I<1-255>
3248 Set the time-to-live of sent packets. This applies to all, unicast and
3249 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
3250 That means that multicast packets will be sent with a TTL of C<1> (one) on most
3253 =item B<MaxPacketSize> I<1024-65535>
3255 Set the maximum size for datagrams received over the network. Packets larger
3256 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
3257 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
3260 On the server side, this limit should be set to the largest value used on
3261 I<any> client. Likewise, the value on the client must not be larger than the
3262 value on the server, or data will be lost.
3264 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
3265 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
3266 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
3269 =item B<Forward> I<true|false>
3271 If set to I<true>, write packets that were received via the network plugin to
3272 the sending sockets. This should only be activated when the B<Listen>- and
3273 B<Server>-statements differ. Otherwise packets may be send multiple times to
3274 the same multicast group. While this results in more network traffic than
3275 necessary it's not a huge problem since the plugin has a duplicate detection,
3276 so the values will not loop.
3278 =item B<ReportStats> B<true>|B<false>
3280 The network plugin cannot only receive and send statistics, it can also create
3281 statistics about itself. Collected data included the number of received and
3282 sent octets and packets, the length of the receive queue and the number of
3283 values handled. When set to B<true>, the I<Network plugin> will make these
3284 statistics available. Defaults to B<false>.
3288 =head2 Plugin C<nginx>
3290 This plugin collects the number of connections and requests handled by the
3291 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
3292 queries the page provided by the C<ngx_http_stub_status_module> module, which
3293 isn't compiled by default. Please refer to
3294 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
3295 how to compile and configure nginx and this module.
3297 The following options are accepted by the C<nginx plugin>:
3301 =item B<URL> I<http://host/nginx_status>
3303 Sets the URL of the C<ngx_http_stub_status_module> output.
3305 =item B<User> I<Username>
3307 Optional user name needed for authentication.
3309 =item B<Password> I<Password>
3311 Optional password needed for authentication.
3313 =item B<VerifyPeer> B<true|false>
3315 Enable or disable peer SSL certificate verification. See
3316 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
3318 =item B<VerifyHost> B<true|false>
3320 Enable or disable peer host name verification. If enabled, the plugin checks
3321 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
3322 certificate matches the host name provided by the B<URL> option. If this
3323 identity check fails, the connection is aborted. Obviously, only works when
3324 connecting to a SSL enabled server. Enabled by default.
3326 =item B<CACert> I<File>
3328 File that holds one or more SSL certificates. If you want to use HTTPS you will
3329 possibly need this option. What CA certificates come bundled with C<libcurl>
3330 and are checked by default depends on the distribution you use.
3334 =head2 Plugin C<notify_desktop>
3336 This plugin sends a desktop notification to a notification daemon, as defined
3337 in the Desktop Notification Specification. To actually display the
3338 notifications, B<notification-daemon> is required and B<collectd> has to be
3339 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
3340 environment variables have to be set correctly) and the D-Bus message bus.
3342 The Desktop Notification Specification can be found at
3343 L<http://www.galago-project.org/specs/notification/>.
3347 =item B<OkayTimeout> I<timeout>
3349 =item B<WarningTimeout> I<timeout>
3351 =item B<FailureTimeout> I<timeout>
3353 Set the I<timeout>, in milliseconds, after which to expire the notification
3354 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
3355 been specified, the displayed notification will not be closed at all - the
3356 user has to do so herself. These options default to 5000. If a negative number
3357 has been specified, the default is used as well.
3361 =head2 Plugin C<notify_email>
3363 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
3364 configured email address.
3366 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
3368 Available configuration options:
3372 =item B<From> I<Address>
3374 Email address from which the emails should appear to come from.
3376 Default: C<root@localhost>
3378 =item B<Recipient> I<Address>
3380 Configures the email address(es) to which the notifications should be mailed.
3381 May be repeated to send notifications to multiple addresses.
3383 At least one B<Recipient> must be present for the plugin to work correctly.
3385 =item B<SMTPServer> I<Hostname>
3387 Hostname of the SMTP server to connect to.
3389 Default: C<localhost>
3391 =item B<SMTPPort> I<Port>
3393 TCP port to connect to.
3397 =item B<SMTPUser> I<Username>
3399 Username for ASMTP authentication. Optional.
3401 =item B<SMTPPassword> I<Password>
3403 Password for ASMTP authentication. Optional.
3405 =item B<Subject> I<Subject>
3407 Subject-template to use when sending emails. There must be exactly two
3408 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
3409 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
3412 Default: C<Collectd notify: %s@%s>
3416 =head2 Plugin C<ntpd>
3420 =item B<Host> I<Hostname>
3422 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
3424 =item B<Port> I<Port>
3426 UDP-Port to connect to. Defaults to B<123>.
3428 =item B<ReverseLookups> B<true>|B<false>
3430 Sets whether or not to perform reverse lookups on peers. Since the name or
3431 IP-address may be used in a filename it is recommended to disable reverse
3432 lookups. The default is to do reverse lookups to preserve backwards
3433 compatibility, though.
3435 =item B<IncludeUnitID> B<true>|B<false>
3437 When a peer is a refclock, include the unit ID in the I<type instance>.
3438 Defaults to B<false> for backward compatibility.
3440 If two refclock peers use the same driver and this is B<false>, the plugin will
3441 try to write simultaneous measurements from both to the same type instance.
3442 This will result in error messages in the log and only one set of measurements
3447 =head2 Plugin C<nut>
3451 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
3453 Add a UPS to collect data from. The format is identical to the one accepted by
3458 =head2 Plugin C<olsrd>
3460 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
3461 the Optimized Link State Routing daemon and reads information about the current
3462 state of the meshed network.
3464 The following configuration options are understood:
3468 =item B<Host> I<Host>
3470 Connect to I<Host>. Defaults to B<"localhost">.
3472 =item B<Port> I<Port>
3474 Specifies the port to connect to. This must be a string, even if you give the
3475 port as a number rather than a service name. Defaults to B<"2006">.
3477 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
3479 Specifies what information to collect about links, i.E<nbsp>e. direct
3480 connections of the daemon queried. If set to B<No>, no information is
3481 collected. If set to B<Summary>, the number of links and the average of all
3482 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
3483 If set to B<Detail> LQ and NLQ are collected per link.
3485 Defaults to B<Detail>.
3487 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
3489 Specifies what information to collect about routes of the daemon queried. If
3490 set to B<No>, no information is collected. If set to B<Summary>, the number of
3491 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
3492 metric and ETX are collected per route.
3494 Defaults to B<Summary>.
3496 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
3498 Specifies what information to collect about the global topology. If set to
3499 B<No>, no information is collected. If set to B<Summary>, the number of links
3500 in the entire topology and the average I<link quality> (LQ) is calculated.
3501 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
3503 Defaults to B<Summary>.
3507 =head2 Plugin C<onewire>
3509 B<EXPERIMENTAL!> See notes below.
3511 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
3512 L<http://owfs.org/> to read sensors connected via the onewire bus.
3514 Currently only temperature sensors (sensors with the family code C<10>,
3515 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
3516 would like to have included, please send a sort request to the mailing list.
3518 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
3519 experimental, below.
3523 =item B<Device> I<Device>
3525 Sets the device to read the values from. This can either be a "real" hardware
3526 device, such as a serial port or an USB port, or the address of the
3527 L<owserver(1)> socket, usually B<localhost:4304>.
3529 Though the documentation claims to automatically recognize the given address
3530 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
3531 with that version, the following configuration worked for us:
3534 Device "-s localhost:4304"
3537 This directive is B<required> and does not have a default value.
3539 =item B<Sensor> I<Sensor>
3541 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
3542 below. Sensors are specified without the family byte at the beginning, to you'd
3543 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
3546 =item B<IgnoreSelected> I<true>|I<false>
3548 If no configuration if given, the B<onewire> plugin will collect data from all
3549 sensors found. This may not be practical, especially if sensors are added and
3550 removed regularly. Sometimes, however, it's easier/preferred to collect only
3551 specific sensors or all sensors I<except> a few specified ones. This option
3552 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
3553 B<Sensor> is inverted: All selected interfaces are ignored and all other
3554 interfaces are collected.
3556 =item B<Interval> I<Seconds>
3558 Sets the interval in which all sensors should be read. If not specified, the
3559 global B<Interval> setting is used.
3563 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
3564 work with big setups. It works with one sensor being attached to one
3565 controller, but as soon as you throw in a couple more senors and maybe a hub
3566 or two, reading all values will take more than ten seconds (the default
3567 interval). We will probably add some separate thread for reading the sensors
3568 and some cache or something like that, but it's not done yet. We will try to
3569 maintain backwards compatibility in the future, but we can't promise. So in
3570 short: If it works for you: Great! But keep in mind that the config I<might>
3571 change, though this is unlikely. Oh, and if you want to help improving this
3572 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
3574 =head2 Plugin C<openvpn>
3576 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
3577 traffic statistics about connected clients.
3579 To set up OpenVPN to write to the status file periodically, use the
3580 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
3581 you need to set the required format, too. This is done by setting
3582 B<--status-version> to B<2>.
3584 So, in a nutshell you need:
3586 openvpn $OTHER_OPTIONS \
3587 --status "/var/run/openvpn-status" 10 \
3594 =item B<StatusFile> I<File>
3596 Specifies the location of the status file.
3598 =item B<ImprovedNamingSchema> B<true>|B<false>
3600 When enabled, the filename of the status file will be used as plugin instance
3601 and the client's "common name" will be used as type instance. This is required
3602 when reading multiple status files. Enabling this option is recommended, but to
3603 maintain backwards compatibility this option is disabled by default.
3605 =item B<CollectCompression> B<true>|B<false>
3607 Sets whether or not statistics about the compression used by OpenVPN should be
3608 collected. This information is only available in I<single> mode. Enabled by
3611 =item B<CollectIndividualUsers> B<true>|B<false>
3613 Sets whether or not traffic information is collected for each connected client
3614 individually. If set to false, currently no traffic data is collected at all
3615 because aggregating this data in a save manner is tricky. Defaults to B<true>.
3617 =item B<CollectUserCount> B<true>|B<false>
3619 When enabled, the number of currently connected clients or users is collected.
3620 This is especially interesting when B<CollectIndividualUsers> is disabled, but
3621 can be configured independently from that option. Defaults to B<false>.
3625 =head2 Plugin C<oracle>
3627 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
3628 Oracle® Database and lets you execute SQL statements there. It is very similar
3629 to the "dbi" plugin, because it was written around the same time. See the "dbi"
3630 plugin's documentation above for details.
3633 <Query "out_of_stock">
3634 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
3637 # InstancePrefix "foo"
3638 InstancesFrom "category"
3642 <Database "product_information">
3646 Query "out_of_stock"
3650 =head3 B<Query> blocks
3652 The Query blocks are handled identically to the Query blocks of the "dbi"
3653 plugin. Please see its documentation above for details on how to specify
3656 =head3 B<Database> blocks
3658 Database blocks define a connection to a database and which queries should be
3659 sent to that database. Each database needs a "name" as string argument in the
3660 starting tag of the block. This name will be used as "PluginInstance" in the
3661 values submitted to the daemon. Other than that, that name is not used.
3665 =item B<ConnectID> I<ID>
3667 Defines the "database alias" or "service name" to connect to. Usually, these
3668 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
3670 =item B<Host> I<Host>
3672 Hostname to use when dispatching values for this database. Defaults to using
3673 the global hostname of the I<collectd> instance.
3675 =item B<Username> I<Username>
3677 Username used for authentication.
3679 =item B<Password> I<Password>
3681 Password used for authentication.
3683 =item B<Query> I<QueryName>
3685 Associates the query named I<QueryName> with this database connection. The
3686 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
3687 blocks you want to refer to must be placed above the database block you want to
3692 =head2 Plugin C<perl>
3694 This plugin embeds a Perl-interpreter into collectd and provides an interface
3695 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
3697 =head2 Plugin C<pinba>
3699 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
3700 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
3701 PHP-based webpage has been delivered, the extension will send a UDP packet
3702 containing timing information, peak memory usage and so on. The plugin will
3703 wait for such packets, parse them and account the provided information, which
3704 is then dispatched to the daemon once per interval.
3711 # Overall statistics for the website.
3713 Server "www.example.com"
3715 # Statistics for www-a only
3717 Host "www-a.example.com"
3718 Server "www.example.com"
3720 # Statistics for www-b only
3722 Host "www-b.example.com"
3723 Server "www.example.com"
3727 The plugin provides the following configuration options:
3731 =item B<Address> I<Node>
3733 Configures the address used to open a listening socket. By default, plugin will
3734 bind to the I<any> address C<::0>.
3736 =item B<Port> I<Service>
3738 Configures the port (service) to bind to. By default the default Pinba port
3739 "30002" will be used. The option accepts service names in addition to port
3740 numbers and thus requires a I<string> argument.
3742 =item E<lt>B<View> I<Name>E<gt> block
3744 The packets sent by the Pinba extension include the hostname of the server, the
3745 server name (the name of the virtual host) and the script that was executed.
3746 Using B<View> blocks it is possible to separate the data into multiple groups
3747 to get more meaningful statistics. Each packet is added to all matching groups,
3748 so that a packet may be accounted for more than once.
3752 =item B<Host> I<Host>
3754 Matches the hostname of the system the webserver / script is running on. This
3755 will contain the result of the L<gethostname(2)> system call. If not
3756 configured, all hostnames will be accepted.
3758 =item B<Server> I<Server>
3760 Matches the name of the I<virtual host>, i.e. the contents of the
3761 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
3762 server names will be accepted.
3764 =item B<Script> I<Script>
3766 Matches the name of the I<script name>, i.e. the contents of the
3767 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
3768 script names will be accepted.
3774 =head2 Plugin C<ping>
3776 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
3777 configured hosts periodically and measures the network latency. Whenever the
3778 C<read> function of the plugin is called, it submits the average latency, the
3779 standard deviation and the drop rate for each host.
3781 Available configuration options:
3785 =item B<Host> I<IP-address>
3787 Host to ping periodically. This option may be repeated several times to ping
3790 =item B<Interval> I<Seconds>
3792 Sets the interval in which to send ICMP echo packets to the configured hosts.
3793 This is B<not> the interval in which statistics are queries from the plugin but
3794 the interval in which the hosts are "pinged". Therefore, the setting here
3795 should be smaller than or equal to the global B<Interval> setting. Fractional
3796 times, such as "1.24" are allowed.
3800 =item B<Timeout> I<Seconds>
3802 Time to wait for a response from the host to which an ICMP packet had been
3803 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
3804 to be down or the packet to be dropped. This setting must be smaller than the
3805 B<Interval> setting above for the plugin to work correctly. Fractional
3806 arguments are accepted.
3810 =item B<TTL> I<0-255>
3812 Sets the Time-To-Live of generated ICMP packets.
3814 =item B<SourceAddress> I<host>
3816 Sets the source address to use. I<host> may either be a numerical network
3817 address or a network hostname.
3819 =item B<Device> I<name>
3821 Sets the outgoing network device to be used. I<name> has to specify an
3822 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
3825 =item B<MaxMissed> I<Packets>
3827 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
3828 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
3830 Default: B<-1> (disabled)
3834 =head2 Plugin C<postgresql>
3836 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
3837 keeps a persistent connection to all configured databases and tries to
3838 reconnect if the connection has been interrupted. A database is configured by
3839 specifying a B<Database> block as described below. The default statistics are
3840 collected from PostgreSQL's B<statistics collector> which thus has to be
3841 enabled for this plugin to work correctly. This should usually be the case by
3842 default. See the section "The Statistics Collector" of the B<PostgreSQL
3843 Documentation> for details.
3845 By specifying custom database queries using a B<Query> block as described
3846 below, you may collect any data that is available from some PostgreSQL
3847 database. This way, you are able to access statistics of external daemons
3848 which are available in a PostgreSQL database or use future or special
3849 statistics provided by PostgreSQL without the need to upgrade your collectd
3852 Starting with version 5.2, the C<postgresql> plugin supports writing data to
3853 PostgreSQL databases as well. This has been implemented in a generic way. You
3854 need to specify an SQL statement which will then be executed by collectd in
3855 order to write the data (see below for details). The benefit of that approach
3856 is that there is no fixed database layout. Rather, the layout may be optimized
3857 for the current setup.
3859 The B<PostgreSQL Documentation> manual can be found at
3860 L<http://www.postgresql.org/docs/manuals/>.
3864 Statement "SELECT magic FROM wizard WHERE host = $1;"
3868 InstancePrefix "magic"
3873 <Query rt36_tickets>
3874 Statement "SELECT COUNT(type) AS count, type \
3876 WHEN resolved = 'epoch' THEN 'open' \
3877 ELSE 'resolved' END AS type \
3878 FROM tickets) type \
3882 InstancePrefix "rt36_tickets"
3883 InstancesFrom "type"
3889 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
3899 KRBSrvName "kerberos_service_name"
3905 Service "service_name"
3906 Query backend # predefined
3917 The B<Query> block defines one database query which may later be used by a
3918 database definition. It accepts a single mandatory argument which specifies
3919 the name of the query. The names of all queries have to be unique (see the
3920 B<MinVersion> and B<MaxVersion> options below for an exception to this
3921 rule). The following configuration options are available to define the query:
3923 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
3924 blocks define how to handle the values returned from the query. They define
3925 which column holds which value and how to dispatch that value to the daemon.
3926 Multiple B<Result> blocks may be used to extract multiple values from a single
3931 =item B<Statement> I<sql query statement>
3933 Specify the I<sql query statement> which the plugin should execute. The string
3934 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
3935 first, second, etc. parameter. The value of the parameters is specified by the
3936 B<Param> configuration option - see below for details. To include a literal
3937 B<$> character followed by a number, surround it with single quotes (B<'>).
3939 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
3940 allowed. Note, however, that only a single command may be used. Semicolons are
3941 allowed as long as a single non-empty command has been specified only.
3943 The returned lines will be handled separately one after another.
3945 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
3947 Specify the parameters which should be passed to the SQL query. The parameters
3948 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
3949 they appear in the configuration file. The value of the parameter is
3950 determined depending on the value of the B<Param> option as follows:
3956 The configured hostname of the database connection. If a UNIX domain socket is
3957 used, the parameter expands to "localhost".
3961 The name of the database of the current connection.
3965 The name of the database plugin instance. See the B<Instance> option of the
3966 database specification below for details.
3970 The username used to connect to the database.
3974 The interval with which this database is queried (as specified by the database
3975 specific or global B<Interval> options).
3979 Please note that parameters are only supported by PostgreSQL's protocol
3980 version 3 and above which was introduced in version 7.4 of PostgreSQL.
3982 =item B<Type> I<type>
3984 The I<type> name to be used when dispatching the values. The type describes
3985 how to handle the data and where to store it. See L<types.db(5)> for more
3986 details on types and their configuration. The number and type of values (as
3987 selected by the B<ValuesFrom> option) has to match the type of the given name.
3989 This option is required inside a B<Result> block.
3991 =item B<InstancePrefix> I<prefix>
3993 =item B<InstancesFrom> I<column0> [I<column1> ...]
3995 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
3996 B<InstancePrefix> defines a static prefix that will be prepended to all type
3997 instances. B<InstancesFrom> defines the column names whose values will be used
3998 to create the type instance. Multiple values will be joined together using the
3999 hyphen (C<->) as separation character.
4001 The plugin itself does not check whether or not all built instances are
4002 different. It is your responsibility to assure that each is unique.
4004 Both options are optional. If none is specified, the type instance will be
4007 =item B<ValuesFrom> I<column0> [I<column1> ...]
4009 Names the columns whose content is used as the actual data for the data sets
4010 that are dispatched to the daemon. How many such columns you need is
4011 determined by the B<Type> setting as explained above. If you specify too many
4012 or not enough columns, the plugin will complain about that and no data will be
4013 submitted to the daemon.
4015 The actual data type, as seen by PostgreSQL, is not that important as long as
4016 it represents numbers. The plugin will automatically cast the values to the
4017 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
4018 L<strtod(3)> functions, so anything supported by those functions is supported
4019 by the plugin as well.
4021 This option is required inside a B<Result> block and may be specified multiple
4022 times. If multiple B<ValuesFrom> options are specified, the columns are read
4025 =item B<MinVersion> I<version>
4027 =item B<MaxVersion> I<version>
4029 Specify the minimum or maximum version of PostgreSQL that this query should be
4030 used with. Some statistics might only be available with certain versions of
4031 PostgreSQL. This allows you to specify multiple queries with the same name but
4032 which apply to different versions, thus allowing you to use the same
4033 configuration in a heterogeneous environment.
4035 The I<version> has to be specified as the concatenation of the major, minor
4036 and patch-level versions, each represented as two-decimal-digit numbers. For
4037 example, version 8.2.3 will become 80203.
4041 The following predefined queries are available (the definitions can be found
4042 in the F<postgresql_default.conf> file which, by default, is available at
4043 C<I<prefix>/share/collectd/>):
4049 This query collects the number of backends, i.E<nbsp>e. the number of
4052 =item B<transactions>
4054 This query collects the numbers of committed and rolled-back transactions of
4059 This query collects the numbers of various table modifications (i.E<nbsp>e.
4060 insertions, updates, deletions) of the user tables.
4062 =item B<query_plans>
4064 This query collects the numbers of various table scans and returned tuples of
4067 =item B<table_states>
4069 This query collects the numbers of live and dead rows in the user tables.
4073 This query collects disk block access counts for user tables.
4077 This query collects the on-disk size of the database in bytes.
4081 In addition, the following detailed queries are available by default. Please
4082 note that each of those queries collects information B<by table>, thus,
4083 potentially producing B<a lot> of data. For details see the description of the
4084 non-by_table queries above.
4088 =item B<queries_by_table>
4090 =item B<query_plans_by_table>
4092 =item B<table_states_by_table>
4094 =item B<disk_io_by_table>
4098 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
4099 mandatory argument specifying the name of the writer. This will then be used
4100 in the B<Database> specification in order to activate the writer instance. The
4101 names of all writers have to be unique. The following options may be
4106 =item B<Statement> I<sql statement>
4108 This mandatory option specifies the SQL statement that will be executed for
4109 each submitted value. A single SQL statement is allowed only. Anything after
4110 the first semicolon will be ignored.
4112 Nine parameters will be passed to the statement and should be specified as
4113 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
4114 values are made available through those parameters:
4120 The timestamp of the queried value as a floating point number.
4124 The hostname of the queried value.
4128 The plugin name of the queried value.
4132 The plugin instance of the queried value. This value may be B<NULL> if there
4133 is no plugin instance.
4137 The type of the queried value (cf. L<types.db(5)>).
4141 The type instance of the queried value. This value may be B<NULL> if there is
4146 An array of names for the submitted values (i.E<nbsp>e., the name of the data
4147 sources of the submitted value-list).
4151 An array of types for the submitted values (i.E<nbsp>e., the type of the data
4152 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
4153 B<StoreRates> is enabled (which is the default, see below), all types will be
4158 An array of the submitted values. The dimensions of the value name and value
4163 In general, it is advisable to create and call a custom function in the
4164 PostgreSQL database for this purpose. Any procedural language supported by
4165 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
4168 =item B<StoreRates> B<false>|B<true>
4170 If set to B<true> (the default), convert counter values to rates. If set to
4171 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
4176 The B<Database> block defines one PostgreSQL database for which to collect
4177 statistics. It accepts a single mandatory argument which specifies the
4178 database name. None of the other options are required. PostgreSQL will use
4179 default values as documented in the section "CONNECTING TO A DATABASE" in the
4180 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
4181 the user collectd is run as and special environment variables. See the manpage
4186 =item B<Interval> I<seconds>
4188 Specify the interval with which the database should be queried. The default is
4189 to use the global B<Interval> setting.
4191 =item B<CommitInterval> I<seconds>
4193 This option may be used for database connections which have "writers" assigned
4194 (see above). If specified, it causes a writer to put several updates into a
4195 single transaction. This transaction will last for the specified amount of
4196 time. By default, each update will be executed in a separate transaction. Each
4197 transaction generates a fair amount of overhead which can, thus, be reduced by
4198 activating this option. The draw-back is, that data covering the specified
4199 amount of time will be lost, for example, if a single statement within the
4200 transaction fails or if the database server crashes.
4202 =item B<Host> I<hostname>
4204 Specify the hostname or IP of the PostgreSQL server to connect to. If the
4205 value begins with a slash, it is interpreted as the directory name in which to
4206 look for the UNIX domain socket.
4208 This option is also used to determine the hostname that is associated with a
4209 collected data set. If it has been omitted or either begins with with a slash
4210 or equals B<localhost> it will be replaced with the global hostname definition
4211 of collectd. Any other value will be passed literally to collectd when
4212 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
4214 =item B<Port> I<port>
4216 Specify the TCP port or the local UNIX domain socket file extension of the
4219 =item B<User> I<username>
4221 Specify the username to be used when connecting to the server.
4223 =item B<Password> I<password>
4225 Specify the password to be used when connecting to the server.
4227 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
4229 Specify whether to use an SSL connection when contacting the server. The
4230 following modes are supported:
4232 =item B<Instance> I<name>
4234 Specify the plugin instance name that should be used instead of the database
4235 name (which is the default, if this option has not been specified). This
4236 allows to query multiple databases of the same name on the same host (e.g.
4237 when running multiple database server versions in parallel).
4243 Do not use SSL at all.
4247 First, try to connect without using SSL. If that fails, try using SSL.
4249 =item I<prefer> (default)
4251 First, try to connect using SSL. If that fails, try without using SSL.
4259 =item B<KRBSrvName> I<kerberos_service_name>
4261 Specify the Kerberos service name to use when authenticating with Kerberos 5
4262 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
4263 B<PostgreSQL Documentation> for details.
4265 =item B<Service> I<service_name>
4267 Specify the PostgreSQL service name to use for additional parameters. That
4268 service has to be defined in F<pg_service.conf> and holds additional
4269 connection parameters. See the section "The Connection Service File" in the
4270 B<PostgreSQL Documentation> for details.
4272 =item B<Query> I<query>
4274 Specifies a I<query> which should be executed in the context of the database
4275 connection. This may be any of the predefined or user-defined queries. If no
4276 such option is given, it defaults to "backends", "transactions", "queries",
4277 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
4278 has been specified). Else, the specified queries are used only.
4280 =item B<Writer> I<writer>
4282 Assigns the specified I<writer> backend to the database connection. This
4283 causes all collected data to be send to the database using the settings
4284 defined in the writer configuration (see the section "FILTER CONFIGURATION"
4285 below for details on how to selectively send data to certain plugins).
4287 Each writer will register a flush callback which may be used when having long
4288 transactions enabled (see the B<CommitInterval> option above). When issuing
4289 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
4290 transaction will be committed right away. Two different kinds of flush
4291 callbacks are available with the C<postgresql> plugin:
4297 Flush all writer backends.
4299 =item B<postgresql->I<database>
4301 Flush all writers of the specified I<database> only.
4307 =head2 Plugin C<powerdns>
4309 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
4310 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
4311 values, many of which are probably meaningless to most users, but may be useful
4312 for some. So you may chose which values to collect, but if you don't, some
4313 reasonable defaults will be collected.
4316 <Server "server_name">
4318 Collect "udp-answers" "udp-queries"
4319 Socket "/var/run/pdns.controlsocket"
4321 <Recursor "recursor_name">
4323 Collect "cache-hits" "cache-misses"
4324 Socket "/var/run/pdns_recursor.controlsocket"
4326 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
4331 =item B<Server> and B<Recursor> block
4333 The B<Server> block defines one authoritative server to query, the B<Recursor>
4334 does the same for an recursing server. The possible options in both blocks are
4335 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
4340 =item B<Collect> I<Field>
4342 Using the B<Collect> statement you can select which values to collect. Here,
4343 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
4344 C<dlg-only-drops>, C<answers10-100>.
4346 The method of getting the values differs for B<Server> and B<Recursor> blocks:
4347 When querying the server a C<SHOW *> command is issued in any case, because
4348 that's the only way of getting multiple values out of the server at once.
4349 collectd then picks out the values you have selected. When querying the
4350 recursor, a command is generated to query exactly these values. So if you
4351 specify invalid fields when querying the recursor, a syntax error may be
4352 returned by the daemon and collectd may not collect any values at all.
4354 If no B<Collect> statement is given, the following B<Server> values will be
4361 =item packetcache-hit
4363 =item packetcache-miss
4365 =item packetcache-size
4367 =item query-cache-hit
4369 =item query-cache-miss
4371 =item recursing-answers
4373 =item recursing-questions
4385 The following B<Recursor> values will be collected by default:
4389 =item noerror-answers
4391 =item nxdomain-answers
4393 =item servfail-answers
4411 Please note that up to that point collectd doesn't know what values are
4412 available on the server and values that are added do not need a change of the
4413 mechanism so far. However, the values must be mapped to collectd's naming
4414 scheme, which is done using a lookup table that lists all known values. If
4415 values are added in the future and collectd does not know about them, you will
4416 get an error much like this:
4418 powerdns plugin: submit: Not found in lookup table: foobar = 42
4420 In this case please file a bug report with the collectd team.
4422 =item B<Socket> I<Path>
4424 Configures the path to the UNIX domain socket to be used when connecting to the
4425 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
4426 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
4427 will be used for the recursor.
4431 =item B<LocalSocket> I<Path>
4433 Querying the recursor is done using UDP. When using UDP over UNIX domain
4434 sockets, the client socket needs a name in the file system, too. You can set
4435 this local name to I<Path> using the B<LocalSocket> option. The default is
4436 C<I<prefix>/var/run/collectd-powerdns>.
4440 =head2 Plugin C<processes>
4444 =item B<Process> I<Name>
4446 Select more detailed statistics of processes matching this name. The statistics
4447 collected for these selected processes are size of the resident segment size
4448 (RSS), user- and system-time used, number of processes and number of threads,
4449 io data (where available) and minor and major pagefaults.
4451 =item B<ProcessMatch> I<name> I<regex>
4453 Similar to the B<Process> option this allows to select more detailed
4454 statistics of processes matching the specified I<regex> (see L<regex(7)> for
4455 details). The statistics of all matching processes are summed up and
4456 dispatched to the daemon using the specified I<name> as an identifier. This
4457 allows to "group" several processes together. I<name> must not contain
4462 =head2 Plugin C<protocols>
4464 Collects a lot of information about various network protocols, such as I<IP>,
4465 I<TCP>, I<UDP>, etc.
4467 Available configuration options:
4471 =item B<Value> I<Selector>
4473 Selects whether or not to select a specific value. The string being matched is
4474 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
4475 plugin instance and I<ValueName> will be used as type instance. An example of
4476 the string being used would be C<Tcp:RetransSegs>.
4478 You can use regular expressions to match a large number of values with just one
4479 configuration option. To select all "extended" I<TCP> values, you could use the
4480 following statement:
4484 Whether only matched values are selected or all matched values are ignored
4485 depends on the B<IgnoreSelected>. By default, only matched values are selected.
4486 If no value is configured at all, all values will be selected.
4488 =item B<IgnoreSelected> B<true>|B<false>
4490 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
4491 matching values will be ignored.
4495 =head2 Plugin C<python>
4497 This plugin embeds a Python-interpreter into collectd and provides an interface
4498 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
4500 =head2 Plugin C<routeros>
4502 The C<routeros> plugin connects to a device running I<RouterOS>, the
4503 Linux-based operating system for routers by I<MikroTik>. The plugin uses
4504 I<librouteros> to connect and reads information about the interfaces and
4505 wireless connections of the device. The configuration supports querying
4510 Host "router0.example.com"
4513 CollectInterface true
4518 Host "router1.example.com"
4521 CollectInterface true
4522 CollectRegistrationTable true
4528 As you can see above, the configuration of the I<routeros> plugin consists of
4529 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
4530 options are understood:
4534 =item B<Host> I<Host>
4536 Hostname or IP-address of the router to connect to.
4538 =item B<Port> I<Port>
4540 Port name or port number used when connecting. If left unspecified, the default
4541 will be chosen by I<librouteros>, currently "8728". This option expects a
4542 string argument, even when a numeric port number is given.
4544 =item B<User> I<User>
4546 Use the user name I<User> to authenticate. Defaults to "admin".
4548 =item B<Password> I<Password>
4550 Set the password used to authenticate.
4552 =item B<CollectInterface> B<true>|B<false>
4554 When set to B<true>, interface statistics will be collected for all interfaces
4555 present on the device. Defaults to B<false>.
4557 =item B<CollectRegistrationTable> B<true>|B<false>
4559 When set to B<true>, information about wireless LAN connections will be
4560 collected. Defaults to B<false>.
4562 =item B<CollectCPULoad> B<true>|B<false>
4564 When set to B<true>, information about the CPU usage will be collected. The
4565 number is a dimensionless value where zero indicates no CPU usage at all.
4566 Defaults to B<false>.
4568 =item B<CollectMemory> B<true>|B<false>
4570 When enabled, the amount of used and free memory will be collected. How used
4571 memory is calculated is unknown, for example whether or not caches are counted
4573 Defaults to B<false>.
4575 =item B<CollectDF> B<true>|B<false>
4577 When enabled, the amount of used and free disk space will be collected.
4578 Defaults to B<false>.
4580 =item B<CollectDisk> B<true>|B<false>
4582 When enabled, the number of sectors written and bad blocks will be collected.
4583 Defaults to B<false>.
4587 =head2 Plugin C<redis>
4589 The I<Redis plugin> connects to one or more Redis servers and gathers
4590 information about each server's state. For each server there is a I<Node> block
4591 which configures the connection parameters for this node.
4601 The information shown in the synopsis above is the I<default configuration>
4602 which is used by the plugin if no configuration is present.
4606 =item B<Node> I<Nodename>
4608 The B<Node> block identifies a new Redis node, that is a new Redis instance
4609 running in an specified host and port. The name for node is a canonical
4610 identifier which is used as I<plugin instance>. It is limited to
4611 64E<nbsp>characters in length.
4613 =item B<Host> I<Hostname>
4615 The B<Host> option is the hostname or IP-address where the Redis instance is
4618 =item B<Port> I<Port>
4620 The B<Port> option is the TCP port on which the Redis instance accepts
4621 connections. Either a service name of a port number may be given. Please note
4622 that numerical port numbers must be given as a string, too.
4624 =item B<Password> I<Password>
4626 Use I<Password> to authenticate when connecting to I<Redis>.
4628 =item B<Timeout> I<Timeout in miliseconds>
4630 The B<Timeout> option set the socket timeout for node response. Since the Redis
4631 read function is blocking, you should keep this value as low as possible. Keep
4632 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
4633 than B<Interval> defined globally.
4637 =head2 Plugin C<rrdcached>
4639 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
4640 to store values to RRD files in an efficient manner. The combination of the
4641 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
4642 way the C<rrdtool> plugin works (see below). The added abstraction layer
4643 provides a number of benefits, though: Because the cache is not within
4644 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
4645 restarted. This results in much shorter (if any) gaps in graphs, especially
4646 under heavy load. Also, the C<rrdtool> command line utility is aware of the
4647 daemon so that it can flush values to disk automatically when needed. This
4648 allows to integrate automated flushing of values into graphing solutions much
4651 There are disadvantages, though: The daemon may reside on a different host, so
4652 it may not be possible for C<collectd> to create the appropriate RRD files
4653 anymore. And even if C<rrdcached> runs on the same host, it may run in a
4654 different base directory, so relative paths may do weird stuff if you're not
4657 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
4658 on the same host, communicating via a UNIX domain socket. The B<DataDir>
4659 setting should be set to an absolute path, so that a changed base directory
4660 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
4664 =item B<DaemonAddress> I<Address>
4666 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
4667 library. See L<rrdcached(1)> for details. Example:
4669 <Plugin "rrdcached">
4670 DaemonAddress "unix:/var/run/rrdcached.sock"
4673 =item B<DataDir> I<Directory>
4675 Set the base directory in which the RRD files reside. If this is a relative
4676 path, it is relative to the working base directory of the C<rrdcached> daemon!
4677 Use of an absolute path is recommended.
4679 =item B<CreateFiles> B<true>|B<false>
4681 Enables or disables the creation of RRD files. If the daemon is not running
4682 locally, or B<DataDir> is set to a relative path, this will not work as
4683 expected. Default is B<true>.
4685 =item B<CreateFilesAsync> B<false>|B<true>
4687 When enabled, new RRD files are enabled asynchronously, using a separate thread
4688 that runs in the background. This prevents writes to block, which is a problem
4689 especially when many hundreds of files need to be created at once. However,
4690 since the purpose of creating the files asynchronously is I<not> to block until
4691 the file is available, values before the file is available will be discarded.
4692 When disabled (the default) files are created synchronously, blocking for a
4693 short while, while the file is being written.
4695 =item B<StepSize> I<Seconds>
4697 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
4698 this setting is unset and the stepsize is set to the interval in which the data
4699 is collected. Do not use this option unless you absolutely have to for some
4700 reason. Setting this option may cause problems with the C<snmp plugin>, the
4701 C<exec plugin> or when the daemon is set up to receive data from other hosts.
4703 =item B<HeartBeat> I<Seconds>
4705 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
4706 in which case the heartbeat is set to twice the B<StepSize> which should equal
4707 the interval in which data is collected. Do not set this option unless you have
4708 a very good reason to do so.
4710 =item B<RRARows> I<NumRows>
4712 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
4713 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
4714 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
4715 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
4716 week, one month, and one year.
4718 So for each timespan, it calculates how many PDPs need to be consolidated into
4719 one CDP by calculating:
4720 number of PDPs = timespan / (stepsize * rrarows)
4722 Bottom line is, set this no smaller than the width of you graphs in pixels. The
4725 =item B<RRATimespan> I<Seconds>
4727 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
4728 more then one RRA. If this option is never used, the built-in default of (3600,
4729 86400, 604800, 2678400, 31622400) is used.
4731 For more information on how RRA-sizes are calculated see B<RRARows> above.
4733 =item B<XFF> I<Factor>
4735 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
4736 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
4741 =head2 Plugin C<rrdtool>
4743 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
4744 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
4745 using these settings. If you don't want to dive into the depths of RRDtool, you
4746 can safely ignore these settings.
4750 =item B<DataDir> I<Directory>
4752 Set the directory to store RRD files under. By default RRD files are generated
4753 beneath the daemon's working directory, i.e. the B<BaseDir>.
4755 =item B<CreateFilesAsync> B<false>|B<true>
4757 When enabled, new RRD files are enabled asynchronously, using a separate thread
4758 that runs in the background. This prevents writes to block, which is a problem
4759 especially when many hundreds of files need to be created at once. However,
4760 since the purpose of creating the files asynchronously is I<not> to block until
4761 the file is available, values before the file is available will be discarded.
4762 When disabled (the default) files are created synchronously, blocking for a
4763 short while, while the file is being written.
4765 =item B<StepSize> I<Seconds>
4767 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
4768 this setting is unset and the stepsize is set to the interval in which the data
4769 is collected. Do not use this option unless you absolutely have to for some
4770 reason. Setting this option may cause problems with the C<snmp plugin>, the
4771 C<exec plugin> or when the daemon is set up to receive data from other hosts.
4773 =item B<HeartBeat> I<Seconds>
4775 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
4776 in which case the heartbeat is set to twice the B<StepSize> which should equal
4777 the interval in which data is collected. Do not set this option unless you have
4778 a very good reason to do so.
4780 =item B<RRARows> I<NumRows>
4782 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
4783 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
4784 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
4785 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
4786 week, one month, and one year.
4788 So for each timespan, it calculates how many PDPs need to be consolidated into
4789 one CDP by calculating:
4790 number of PDPs = timespan / (stepsize * rrarows)
4792 Bottom line is, set this no smaller than the width of you graphs in pixels. The
4795 =item B<RRATimespan> I<Seconds>
4797 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
4798 more then one RRA. If this option is never used, the built-in default of (3600,
4799 86400, 604800, 2678400, 31622400) is used.
4801 For more information on how RRA-sizes are calculated see B<RRARows> above.
4803 =item B<XFF> I<Factor>
4805 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
4806 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
4809 =item B<CacheFlush> I<Seconds>
4811 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
4812 it writes all values for a certain RRD-file if the oldest value is older than
4813 (or equal to) the number of seconds specified. If some RRD-file is not updated
4814 anymore for some reason (the computer was shut down, the network is broken,
4815 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
4816 entire cache is searched for entries older than B<CacheTimeout> seconds and
4817 written to disk every I<Seconds> seconds. Since this is kind of expensive and
4818 does nothing under normal circumstances, this value should not be too small.
4819 900 seconds might be a good value, though setting this to 7200 seconds doesn't
4820 normally do much harm either.
4822 =item B<CacheTimeout> I<Seconds>
4824 If this option is set to a value greater than zero, the C<rrdtool plugin> will
4825 save values in a cache, as described above. Writing multiple values at once
4826 reduces IO-operations and thus lessens the load produced by updating the files.
4827 The trade off is that the graphs kind of "drag behind" and that more memory is
4830 =item B<WritesPerSecond> I<Updates>
4832 When collecting many statistics with collectd and the C<rrdtool> plugin, you
4833 will run serious performance problems. The B<CacheFlush> setting and the
4834 internal update queue assert that collectd continues to work just fine even
4835 under heavy load, but the system may become very unresponsive and slow. This is
4836 a problem especially if you create graphs from the RRD files on the same
4837 machine, for example using the C<graph.cgi> script included in the
4838 C<contrib/collection3/> directory.
4840 This setting is designed for very large setups. Setting this option to a value
4841 between 25 and 80 updates per second, depending on your hardware, will leave
4842 the server responsive enough to draw graphs even while all the cached values
4843 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
4844 by the B<FLUSH> command, are B<not> effected by this limit. They are still
4845 written as fast as possible, so that web frontends have up to date data when
4848 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
4849 updates per second, writing all values to disk will take approximately
4850 56E<nbsp>minutes. Together with the flushing ability that's integrated into
4851 "collection3" you'll end up with a responsive and fast system, up to date
4852 graphs and basically a "backup" of your values every hour.
4854 =item B<RandomTimeout> I<Seconds>
4856 When set, the actual timeout for each value is chosen randomly between
4857 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
4858 intention is to avoid high load situations that appear when many values timeout
4859 at the same time. This is especially a problem shortly after the daemon starts,
4860 because all values were added to the internal cache at roughly the same time.
4864 =head2 Plugin C<sensors>
4866 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
4867 that all the needed modules have to be loaded and lm_sensors has to be
4868 configured (most likely by editing F</etc/sensors.conf>. Read
4869 L<sensors.conf(5)> for details.
4871 The B<lm_sensors> homepage can be found at
4872 L<http://secure.netroedge.com/~lm78/>.
4876 =item B<SensorConfigFile> I<File>
4878 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
4879 the library's default will be used.
4881 =item B<Sensor> I<chip-bus-address/type-feature>
4883 Selects the name of the sensor which you want to collect or ignore, depending
4884 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
4885 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
4886 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
4888 =item B<IgnoreSelected> I<true>|I<false>
4890 If no configuration if given, the B<sensors>-plugin will collect data from all
4891 sensors. This may not be practical, especially for uninteresting sensors.
4892 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
4893 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
4894 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
4895 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
4896 and all other sensors are collected.
4900 =head2 Plugin C<snmp>
4902 Since the configuration of the C<snmp plugin> is a little more complicated than
4903 other plugins, its documentation has been moved to an own manpage,
4904 L<collectd-snmp(5)>. Please see there for details.
4906 =head2 Plugin C<swap>
4908 The I<Swap plugin> collects information about used and available swap space. On
4909 I<Linux> and I<Solaris>, the following options are available:
4913 =item B<ReportByDevice> B<false>|B<true>
4915 Configures how to report physical swap devices. If set to B<false> (the
4916 default), the summary over all swap devices is reported only, i.e. the globally
4917 used and available space over all devices. If B<true> is configured, the used
4918 and available space of each device will be reported separately.
4920 This option is only available if the I<Swap plugin> can read C</proc/swaps>
4921 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
4923 =item B<ReportBytes> B<false>|B<true>
4925 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
4926 I<swap I/O> is reported in pages. This option is available under Linux only.
4930 =head2 Plugin C<syslog>
4934 =item B<LogLevel> B<debug|info|notice|warning|err>
4936 Sets the log-level. If, for example, set to B<notice>, then all events with
4937 severity B<notice>, B<warning>, or B<err> will be submitted to the
4940 Please note that B<debug> is only available if collectd has been compiled with
4943 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
4945 Controls which notifications should be sent to syslog. The default behaviour is
4946 not to send any. Less severe notifications always imply logging more severe
4947 notifications: Setting this to B<OKAY> means all notifications will be sent to
4948 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
4949 notifications but will dismiss B<OKAY> notifications. Setting this option to
4950 B<FAILURE> will only send failures to syslog.
4954 =head2 Plugin C<table>
4956 The C<table plugin> provides generic means to parse tabular data and dispatch
4957 user specified values. Values are selected based on column numbers. For
4958 example, this plugin may be used to get values from the Linux L<proc(5)>
4959 filesystem or CSV (comma separated values) files.
4962 <Table "/proc/slabinfo">
4967 InstancePrefix "active_objs"
4973 InstancePrefix "objperslab"
4980 The configuration consists of one or more B<Table> blocks, each of which
4981 configures one file to parse. Within each B<Table> block, there are one or
4982 more B<Result> blocks, which configure which data to select and how to
4985 The following options are available inside a B<Table> block:
4989 =item B<Instance> I<instance>
4991 If specified, I<instance> is used as the plugin instance. So, in the above
4992 example, the plugin name C<table-slabinfo> would be used. If omitted, the
4993 filename of the table is used instead, with all special characters replaced
4994 with an underscore (C<_>).
4996 =item B<Separator> I<string>
4998 Any character of I<string> is interpreted as a delimiter between the different
4999 columns of the table. A sequence of two or more contiguous delimiters in the
5000 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
5001 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
5002 of a table - see its documentation for more details. This option is mandatory.
5004 A horizontal tab, newline and carriage return may be specified by C<\\t>,
5005 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
5006 required because of collectd's config parsing.
5010 The following options are available inside a B<Result> block:
5014 =item B<Type> I<type>
5016 Sets the type used to dispatch the values to the daemon. Detailed information
5017 about types and their configuration can be found in L<types.db(5)>. This
5018 option is mandatory.
5020 =item B<InstancePrefix> I<prefix>
5022 If specified, prepend I<prefix> to the type instance. If omitted, only the
5023 B<InstancesFrom> option is considered for the type instance.
5025 =item B<InstancesFrom> I<column0> [I<column1> ...]
5027 If specified, the content of the given columns (identified by the column
5028 number starting at zero) will be used to create the type instance for each
5029 row. Multiple values (and the instance prefix) will be joined together with
5030 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
5031 option is considered for the type instance.
5033 The plugin itself does not check whether or not all built instances are
5034 different. It’s your responsibility to assure that each is unique. This is
5035 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
5036 sure that the table only contains one row.
5038 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
5041 =item B<ValuesFrom> I<column0> [I<column1> ...]
5043 Specifies the columns (identified by the column numbers starting at zero)
5044 whose content is used as the actual data for the data sets that are dispatched
5045 to the daemon. How many such columns you need is determined by the B<Type>
5046 setting above. If you specify too many or not enough columns, the plugin will
5047 complain about that and no data will be submitted to the daemon. The plugin
5048 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
5049 respectively, so anything supported by those functions is supported by the
5050 plugin as well. This option is mandatory.
5054 =head2 Plugin C<tail>
5056 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
5057 each line and dispatches found values. What is matched can be configured by the
5058 user using (extended) regular expressions, as described in L<regex(7)>.
5061 <File "/var/log/exim4/mainlog">
5064 Regex "S=([1-9][0-9]*)"
5070 Regex "\\<R=local_user\\>"
5071 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
5074 Instance "local_user"
5079 The config consists of one or more B<File> blocks, each of which configures one
5080 logfile to parse. Within each B<File> block, there are one or more B<Match>
5081 blocks, which configure a regular expression to search for.
5083 The B<Instance> option in the B<File> block may be used to set the plugin
5084 instance. So in the above example the plugin name C<tail-foo> would be used.
5085 This plugin instance is for all B<Match> blocks that B<follow> it, until the
5086 next B<Instance> option. This way you can extract several plugin instances from
5087 one logfile, handy when parsing syslog and the like.
5089 Each B<Match> block has the following options to describe how the match should
5094 =item B<Regex> I<regex>
5096 Sets the regular expression to use for matching against a line. The first
5097 subexpression has to match something that can be turned into a number by
5098 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
5099 below. Because B<extended> regular expressions are used, you do not need to use
5100 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
5101 collectd's config parsing you need to escape backslashes, though. So if you
5102 want to match literal parentheses you need to do the following:
5104 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
5106 =item B<ExcludeRegex> I<regex>
5108 Sets an optional regular expression to use for excluding lines from the match.
5109 An example which excludes all connections from localhost from the match:
5111 ExcludeRegex "127\\.0\\.0\\.1"
5113 =item B<DSType> I<Type>
5115 Sets how the values are cumulated. I<Type> is one of:
5119 =item B<GaugeAverage>
5121 Calculate the average.
5125 Use the smallest number only.
5129 Use the greatest number only.
5133 Use the last number found.
5139 =item B<AbsoluteSet>
5141 The matched number is a counter. Simply I<sets> the internal counter to this
5142 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
5148 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
5149 matched number may be negative, which will effectively subtract from the
5156 Increase the internal counter by one. These B<DSType> are the only ones that do
5157 not use the matched subexpression, but simply count the number of matched
5158 lines. Thus, you may use a regular expression without submatch in this case.
5162 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
5163 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
5164 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
5165 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
5166 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
5169 =item B<Type> I<Type>
5171 Sets the type used to dispatch this value. Detailed information about types and
5172 their configuration can be found in L<types.db(5)>.
5174 =item B<Instance> I<TypeInstance>
5176 This optional setting sets the type instance to use.
5180 =head2 Plugin C<tail_csv>
5182 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
5183 written by I<Snort>.
5188 <Metric "snort-dropped">
5193 <File "/var/log/snort/snort.stats">
5194 Instance "snort-eth0"
5196 Collect "snort-dropped"
5200 The configuration consists of one or more B<Metric> blocks that define an index
5201 into the line of the CSV file and how this value is mapped to I<collectd's>
5202 internal representation. These are followed by one or more B<Instance> blocks
5203 which configure which file to read, in which interval and which metrics to
5208 =item E<lt>B<Metric> I<Name>E<gt>
5210 The B<Metric> block configures a new metric to be extracted from the statistics
5211 file and how it is mapped on I<collectd's> data model. The string I<Name> is
5212 only used inside the B<Instance> blocks to refer to this block, so you can use
5213 one B<Metric> block for multiple CSV files.
5217 =item B<Type> I<Type>
5219 Configures which I<Type> to use when dispatching this metric. Types are defined
5220 in the L<types.db(5)> file, see the appropriate manual page for more
5221 information on specifying types. Only types with a single I<data source> are
5222 supported by the I<tail_csv plugin>. The information whether the value is an
5223 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
5224 I<Type's> definition.
5226 =item B<Instance> I<TypeInstance>
5228 If set, I<TypeInstance> is used to populate the type instance field of the
5229 created value lists. Otherwise, no type instance is used.
5231 =item B<ValueFrom> I<Index>
5233 Configure to read the value from the field with the zero-based index I<Index>.
5234 If the value is parsed as signed integer, unsigned integer or double depends on
5235 the B<Type> setting, see above.
5239 =item E<lt>B<File> I<Path>E<gt>
5241 Each B<File> block represents one CSV file to read. There must be at least one
5242 I<File> block but there can be multiple if you have multiple CSV files.
5246 =item B<Instance> I<PluginInstance>
5248 Sets the I<plugin instance> used when dispatching the values.
5250 =item B<Collect> I<Metric>
5252 Specifies which I<Metric> to collect. This option must be specified at least
5253 once, and you can use this option multiple times to specify more than one
5254 metric to be extracted from this statistic file.
5256 =item B<Interval> I<Seconds>
5258 Configures the interval in which to read values from this instance / file.
5259 Defaults to the plugin's default interval.
5261 =item B<TimeFrom> I<Index>
5263 Rather than using the local time when dispatching a value, read the timestamp
5264 from the field with the zero-based index I<Index>. The value is interpreted as
5265 seconds since epoch. The value is parsed as a double and may be factional.
5271 =head2 Plugin C<teamspeak2>
5273 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
5274 polls interesting global and virtual server data. The plugin can query only one
5275 physical server but unlimited virtual servers. You can use the following
5276 options to configure it:
5280 =item B<Host> I<hostname/ip>
5282 The hostname or ip which identifies the physical server.
5285 =item B<Port> I<port>
5287 The query port of the physical server. This needs to be a string.
5290 =item B<Server> I<port>
5292 This option has to be added once for every virtual server the plugin should
5293 query. If you want to query the virtual server on port 8767 this is what the
5294 option would look like:
5298 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
5299 use quotes around it! If no such statement is given only global information
5304 =head2 Plugin C<ted>
5306 The I<TED> plugin connects to a device of "The Energy Detective", a device to
5307 measure power consumption. These devices are usually connected to a serial
5308 (RS232) or USB port. The plugin opens a configured device and tries to read the
5309 current energy readings. For more information on TED, visit
5310 L<http://www.theenergydetective.com/>.
5312 Available configuration options:
5316 =item B<Device> I<Path>
5318 Path to the device on which TED is connected. collectd will need read and write
5319 permissions on that file.
5321 Default: B</dev/ttyUSB0>
5323 =item B<Retries> I<Num>
5325 Apparently reading from TED is not that reliable. You can therefore configure a
5326 number of retries here. You only configure the I<retries> here, to if you
5327 specify zero, one reading will be performed (but no retries if that fails); if
5328 you specify three, a maximum of four readings are performed. Negative values
5335 =head2 Plugin C<tcpconns>
5337 The C<tcpconns plugin> counts the number of currently established TCP
5338 connections based on the local port and/or the remote port. Since there may be
5339 a lot of connections the default if to count all connections with a local port,
5340 for which a listening socket is opened. You can use the following options to
5341 fine-tune the ports you are interested in:
5345 =item B<ListeningPorts> I<true>|I<false>
5347 If this option is set to I<true>, statistics for all local ports for which a
5348 listening socket exists are collected. The default depends on B<LocalPort> and
5349 B<RemotePort> (see below): If no port at all is specifically selected, the
5350 default is to collect listening ports. If specific ports (no matter if local or
5351 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
5352 the selected ports will be collected unless this option is set to I<true>
5355 =item B<LocalPort> I<Port>
5357 Count the connections to a specific local port. This can be used to see how
5358 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
5359 You have to specify the port in numeric form, so for the mailserver example
5360 you'd need to set B<25>.
5362 =item B<RemotePort> I<Port>
5364 Count the connections to a specific remote port. This is useful to see how
5365 much a remote service is used. This is most useful if you want to know how many
5366 connections a local service has opened to remote services, e.E<nbsp>g. how many
5367 connections a mail server or news server has to other mail or news servers, or
5368 how many connections a web proxy holds to web servers. You have to give the
5369 port in numeric form.
5373 =head2 Plugin C<thermal>
5377 =item B<ForceUseProcfs> I<true>|I<false>
5379 By default, the I<Thermal plugin> tries to read the statistics from the Linux
5380 C<sysfs> interface. If that is not available, the plugin falls back to the
5381 C<procfs> interface. By setting this option to I<true>, you can force the
5382 plugin to use the latter. This option defaults to I<false>.
5384 =item B<Device> I<Device>
5386 Selects the name of the thermal device that you want to collect or ignore,
5387 depending on the value of the B<IgnoreSelected> option. This option may be
5388 used multiple times to specify a list of devices.
5390 =item B<IgnoreSelected> I<true>|I<false>
5392 Invert the selection: If set to true, all devices B<except> the ones that
5393 match the device names specified by the B<Device> option are collected. By
5394 default only selected devices are collected if a selection is made. If no
5395 selection is configured at all, B<all> devices are selected.
5399 =head2 Plugin C<threshold>
5401 The I<Threshold plugin> checks values collected or received by I<collectd>
5402 against a configurable I<threshold> and issues I<notifications> if values are
5405 Documentation for this plugin is available in the L<collectd-threshold(5)>
5408 =head2 Plugin C<tokyotyrant>
5410 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
5411 couple metrics: number of records, and database size on disk.
5415 =item B<Host> I<Hostname/IP>
5417 The hostname or ip which identifies the server.
5418 Default: B<127.0.0.1>
5420 =item B<Port> I<Service/Port>
5422 The query port of the server. This needs to be a string, even if the port is
5423 given in its numeric form.
5428 =head2 Plugin C<unixsock>
5432 =item B<SocketFile> I<Path>
5434 Sets the socket-file which is to be created.
5436 =item B<SocketGroup> I<Group>
5438 If running as root change the group of the UNIX-socket after it has been
5439 created. Defaults to B<collectd>.
5441 =item B<SocketPerms> I<Permissions>
5443 Change the file permissions of the UNIX-socket after it has been created. The
5444 permissions must be given as a numeric, octal value as you would pass to
5445 L<chmod(1)>. Defaults to B<0770>.
5447 =item B<DeleteSocket> B<false>|B<true>
5449 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
5450 with the given name already exists. If I<collectd> crashes a socket file may be
5451 left over, preventing the daemon from opening a new socket when restarted.
5452 Since this is potentially dangerous, this defaults to B<false>.
5456 =head2 Plugin C<uuid>
5458 This plugin, if loaded, causes the Hostname to be taken from the machine's
5459 UUID. The UUID is a universally unique designation for the machine, usually
5460 taken from the machine's BIOS. This is most useful if the machine is running in
5461 a virtual environment such as Xen, in which case the UUID is preserved across
5462 shutdowns and migration.
5464 The following methods are used to find the machine's UUID, in order:
5470 Check I</etc/uuid> (or I<UUIDFile>).
5474 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
5479 Check for UUID from C<dmidecode> / SMBIOS.
5483 Check for UUID from Xen hypervisor.
5487 If no UUID can be found then the hostname is not modified.
5491 =item B<UUIDFile> I<Path>
5493 Take the UUID from the given file (default I</etc/uuid>).
5497 =head2 Plugin C<varnish>
5499 The Varnish plugin collects information about Varnish, an HTTP accelerator.
5503 =item B<CollectCache> B<true>|B<false>
5505 Cache hits and misses. True by default.
5507 =item B<CollectConnections> B<true>|B<false>
5509 Number of client connections received, accepted and dropped. True by default.
5511 =item B<CollectBackend> B<true>|B<false>
5513 Back-end connection statistics, such as successful, reused,
5514 and closed connections. True by default.
5516 =item B<CollectSHM> B<true>|B<false>
5518 Statistics about the shared memory log, a memory region to store
5519 log messages which is flushed to disk when full. True by default.
5521 =item B<CollectESI> B<true>|B<false>
5523 Edge Side Includes (ESI) parse statistics. False by default.
5525 =item B<CollectFetch> B<true>|B<false>
5527 Statistics about fetches (HTTP requests sent to the backend). False by default.
5529 =item B<CollectHCB> B<true>|B<false>
5531 Inserts and look-ups in the crit bit tree based hash. Look-ups are
5532 divided into locked and unlocked look-ups. False by default.
5534 =item B<CollectSMA> B<true>|B<false>
5536 malloc or umem (umem_alloc(3MALLOC) based) storage statistics.
5537 The umem storage component is Solaris specific. False by default.
5539 =item B<CollectSMS> B<true>|B<false>
5541 synth (synthetic content) storage statistics. This storage
5542 component is used internally only. False by default.
5544 =item B<CollectSM> B<true>|B<false>
5546 file (memory mapped file) storage statistics. False by default.
5548 =item B<CollectTotals> B<true>|B<false>
5550 Collects overview counters, such as the number of sessions created,
5551 the number of requests and bytes transferred. False by default.
5553 =item B<CollectWorkers> B<true>|B<false>
5555 Collect statistics about worker threads. False by default.
5559 =head2 Plugin C<vmem>
5561 The C<vmem> plugin collects information about the usage of virtual memory.
5562 Since the statistics provided by the Linux kernel are very detailed, they are
5563 collected very detailed. However, to get all the details, you have to switch
5564 them on manually. Most people just want an overview over, such as the number of
5565 pages read from swap space.
5569 =item B<Verbose> B<true>|B<false>
5571 Enables verbose collection of information. This will start collecting page
5572 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
5573 Part of these statistics are collected on a "per zone" basis.
5577 =head2 Plugin C<vserver>
5579 This plugin doesn't have any options. B<VServer> support is only available for
5580 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
5581 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
5582 need to apply the patches and compile your own kernel, which will then provide
5583 the F</proc/virtual> filesystem that is required by this plugin.
5585 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
5587 B<Note>: The traffic collected by this plugin accounts for the amount of
5588 traffic passing a socket which might be a lot less than the actual on-wire
5589 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
5590 collect on-wire traffic you could, for example, use the logging facilities of
5591 iptables to feed data for the guest IPs into the iptables plugin.
5593 =head2 Plugin C<write_graphite>
5595 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
5596 storage and graphing project. The plugin connects to I<Carbon>, the data layer
5597 of I<Graphite>, and sends data via the "line based" protocol (per default using
5598 portE<nbsp>2003). The data will be sent in blocks of at most 1428 bytes to
5599 minimize the number of network packets.
5603 <Plugin write_graphite>
5611 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
5612 blocks. Inside the B<Node> blocks, the following options are recognized:
5616 =item B<Host> I<Address>
5618 Hostname or address to connect to. Defaults to C<localhost>.
5620 =item B<Port> I<Service>
5622 Service name or port number to connect to. Defaults to C<2003>.
5624 =item B<Prefix> I<String>
5626 When set, I<String> is added in front of the host name. Dots and whitespace are
5627 I<not> escaped in this string (see B<EscapeCharacter> below).
5629 =item B<Postfix> I<String>
5631 When set, I<String> is appended to the host name. Dots and whitespace are
5632 I<not> escaped in this string (see B<EscapeCharacter> below).
5634 =item B<EscapeCharacter> I<Char>
5636 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
5637 in the identifier. The B<EscapeCharacter> option determines which character
5638 dots, whitespace and control characters are replaced with. Defaults to
5641 =item B<StoreRates> B<false>|B<true>
5643 If set to B<true> (the default), convert counter values to rates. If set to
5644 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
5647 =item B<SeparateInstances> B<false>|B<true>
5649 If set to B<true>, the plugin instance and type instance will be in their own
5650 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
5651 default), the plugin and plugin instance (and likewise the type and type
5652 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
5654 =item B<AlwaysAppendDS> B<false>|B<true>
5656 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
5657 identifier. If set to B<false> (the default), this is only done when there is
5662 =head2 Plugin C<write_mongodb>
5664 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
5669 <Plugin "write_mongodb">
5678 The plugin can send values to multiple instances of I<MongoDB> by specifying
5679 one B<Node> block for each instance. Within the B<Node> blocks, the following
5680 options are available:
5684 =item B<Host> I<Address>
5686 Hostname or address to connect to. Defaults to C<localhost>.
5688 =item B<Port> I<Service>
5690 Service name or port number to connect to. Defaults to C<27017>.
5692 =item B<Timeout> I<Timeout>
5694 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
5695 Setting this option to zero means no timeout, which is the default.
5697 =item B<StoreRates> B<false>|B<true>
5699 If set to B<true> (the default), convert counter values to rates. If set to
5700 B<false> counter values are stored as is, i.e. as an increasing integer
5703 =item B<Database> I<Database>
5705 =item B<User> I<User>
5707 =item B<Password> I<Password>
5709 Sets the information used when authenticating to a I<MongoDB> database. The
5710 fields are optional (in which case no authentication is attempted), but if you
5711 want to use authentication all three fields must be set.
5715 =head2 Plugin C<write_http>
5717 This output plugin submits values to an http server by POST them using the
5718 PUTVAL plain-text protocol. Each destination you want to post data to needs to
5719 have one B<URL> block, within which the destination can be configured further,
5720 for example by specifying authentication data.
5724 <Plugin "write_http">
5725 <URL "http://example.com/post-collectd">
5731 B<URL> blocks need one string argument which is used as the URL to which data
5732 is posted. The following options are understood within B<URL> blocks.
5736 =item B<User> I<Username>
5738 Optional user name needed for authentication.
5740 =item B<Password> I<Password>
5742 Optional password needed for authentication.
5744 =item B<VerifyPeer> B<true>|B<false>
5746 Enable or disable peer SSL certificate verification. See
5747 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5749 =item B<VerifyHost> B<true|false>
5751 Enable or disable peer host name verification. If enabled, the plugin checks if
5752 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
5753 matches the host name provided by the B<URL> option. If this identity check
5754 fails, the connection is aborted. Obviously, only works when connecting to a
5755 SSL enabled server. Enabled by default.
5757 =item B<CACert> I<File>
5759 File that holds one or more SSL certificates. If you want to use HTTPS you will
5760 possibly need this option. What CA certificates come bundled with C<libcurl>
5761 and are checked by default depends on the distribution you use.
5763 =item B<Format> B<Command>|B<JSON>
5765 Format of the output to generate. If set to B<Command>, will create output that
5766 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
5767 create output in the I<JavaScript Object Notation> (JSON).
5769 Defaults to B<Command>.
5771 =item B<StoreRates> B<true|false>
5773 If set to B<true>, convert counter values to rates. If set to B<false> (the
5774 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
5779 =head2 Plugin C<write_riemann>
5781 The I<write_riemann plugin> will send values to I<Riemann>, a powerfull stream
5782 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
5783 I<Riemann> using UDP packets.
5787 <Plugin "write_riemann">
5793 AlwaysAppendDS false
5799 The following options are understood by the I<write_riemann plugin>:
5803 =item E<lt>B<Node> I<Name>E<gt>
5805 The plugin's configuration consists of one or more B<Node> blocks. Each block
5806 is given a unique I<Name> and specifies one connection to an instance of
5807 I<Riemann>. Indise the B<Node> block, the following per-connection options are
5812 =item B<Host> I<Address>
5814 Hostname or address to connect to. Defaults to C<localhost>.
5816 =item B<Port> I<Service>
5818 Service name or port number to connect to. Defaults to C<5555>.
5820 =item B<Protocol> B<UDP>|B<TCP>
5822 Specify the protocol to use when communicating with I<Riemann>. Defaults to
5825 =item B<StoreRates> B<true>|B<false>
5827 If set to B<true> (the default), convert counter values to rates. If set to
5828 B<false> counter values are stored as is, i.e. as an increasing integer number.
5830 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
5831 converted values will have "rate" appended to the data source type, e.g.
5832 C<ds_type:derive:rate>.
5834 =item B<AlwaysAppendDS> B<false>|B<true>
5836 If set the B<true>, append the name of the I<Data Source> (DS) to the
5837 "service", i.e. the field that, together with the "host" field, uniquely
5838 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
5839 only done when there is more than one DS.
5843 =item B<Tag> I<String>
5845 Add the given string as an additional tag to the metric being sent to
5850 =head1 THRESHOLD CONFIGURATION
5852 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
5853 we mean that the values are not only stored or sent somewhere, but that they
5854 are judged and, if a problem is recognized, acted upon. The only action
5855 collectd takes itself is to generate and dispatch a "notification". Plugins can
5856 register to receive notifications and perform appropriate further actions.
5858 Since systems and what you expect them to do differ a lot, you can configure
5859 B<thresholds> for your values freely. This gives you a lot of flexibility but
5860 also a lot of responsibility.
5862 Every time a value is out of range a notification is dispatched. This means
5863 that the idle percentage of your CPU needs to be less then the configured
5864 threshold only once for a notification to be generated. There's no such thing
5865 as a moving average or similar - at least not now.
5867 Also, all values that match a threshold are considered to be relevant or
5868 "interesting". As a consequence collectd will issue a notification if they are
5869 not received for B<Timeout> iterations. The B<Timeout> configuration option is
5870 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
5871 "2" (the default) and some hosts sends it's CPU statistics to the server every
5872 60 seconds, a notification will be dispatched after about 120 seconds. It may
5873 take a little longer because the timeout is checked only once each B<Interval>
5876 When a value comes within range again or is received after it was missing, an
5877 "OKAY-notification" is dispatched.
5879 Here is a configuration example to get you started. Read below for more
5892 <Plugin "interface">
5909 WarningMin 100000000
5915 There are basically two types of configuration statements: The C<Host>,
5916 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
5917 configured. The C<Plugin> and C<Type> blocks may be specified further using the
5918 C<Instance> option. You can combine the block by nesting the blocks, though
5919 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
5920 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
5921 C<Type> may not contain other blocks. If multiple blocks apply to the same
5922 value the most specific block is used.
5924 The other statements specify the threshold to configure. They B<must> be
5925 included in a C<Type> block. Currently the following statements are recognized:
5929 =item B<FailureMax> I<Value>
5931 =item B<WarningMax> I<Value>
5933 Sets the upper bound of acceptable values. If unset defaults to positive
5934 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
5935 will be created. If the value is greater than B<WarningMax> but less than (or
5936 equal to) B<FailureMax> a B<WARNING> notification will be created.
5938 =item B<FailureMin> I<Value>
5940 =item B<WarningMin> I<Value>
5942 Sets the lower bound of acceptable values. If unset defaults to negative
5943 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
5944 be created. If the value is less than B<WarningMin> but greater than (or equal
5945 to) B<FailureMin> a B<WARNING> notification will be created.
5947 =item B<DataSource> I<DSName>
5949 Some data sets have more than one "data source". Interesting examples are the
5950 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
5951 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
5952 system load data set, C<load>, even has three data sources: C<shortterm>,
5953 C<midterm>, and C<longterm>.
5955 Normally, all data sources are checked against a configured threshold. If this
5956 is undesirable, or if you want to specify different limits for each data
5957 source, you can use the B<DataSource> option to have a threshold apply only to
5960 =item B<Invert> B<true>|B<false>
5962 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
5963 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
5964 B<WarningMax>) are not okay. Defaults to B<false>.
5966 =item B<Persist> B<true>|B<false>
5968 Sets how often notifications are generated. If set to B<true> one notification
5969 will be generated for each value that is out of the acceptable range. If set to
5970 B<false> (the default) then a notification is only generated if a value is out
5971 of range but the previous value was okay.
5973 This applies to missing values, too: If set to B<true> a notification about a
5974 missing value is generated once every B<Interval> seconds. If set to B<false>
5975 only one such notification is generated until the value appears again.
5977 =item B<Percentage> B<true>|B<false>
5979 If set to B<true>, the minimum and maximum values given are interpreted as
5980 percentage value, relative to the other data sources. This is helpful for
5981 example for the "df" type, where you may want to issue a warning when less than
5982 5E<nbsp>% of the total space is available. Defaults to B<false>.
5984 =item B<Hits> I<Number>
5986 Delay creating the notification until the threshold has been passed I<Number>
5987 times. When a notification has been generated, or when a subsequent value is
5988 inside the threshold, the counter is reset. If, for example, a value is
5989 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
5990 will be dispatched at most once every 30E<nbsp>seconds.
5992 This is useful when short bursts are not a problem. If, for example, 100% CPU
5993 usage for up to a minute is normal (and data is collected every
5994 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
5996 =item B<Hysteresis> I<Number>
5998 When set to non-zero, a hysteresis value is applied when checking minimum and
5999 maximum bounds. This is useful for values that increase slowly and fluctuate a
6000 bit while doing so. When these values come close to the threshold, they may
6001 "flap", i.e. switch between failure / warning case and okay case repeatedly.
6003 If, for example, the threshold is configures as
6008 then a I<Warning> notification is created when the value exceeds I<101> and the
6009 corresponding I<Okay> notification is only created once the value falls below
6010 I<99>, thus avoiding the "flapping".
6014 =head1 FILTER CONFIGURATION
6016 Starting with collectd 4.6 there is a powerful filtering infrastructure
6017 implemented in the daemon. The concept has mostly been copied from
6018 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
6019 terminology, so that users that are familiar with iptables feel right at home.
6023 The following are the terms used in the remainder of the filter configuration
6024 documentation. For an ASCII-art schema of the mechanism, see
6025 L<"General structure"> below.
6031 A I<match> is a criteria to select specific values. Examples are, of course, the
6032 name of the value or it's current value.
6034 Matches are implemented in plugins which you have to load prior to using the
6035 match. The name of such plugins starts with the "match_" prefix.
6039 A I<target> is some action that is to be performed with data. Such actions
6040 could, for example, be to change part of the value's identifier or to ignore
6041 the value completely.
6043 Some of these targets are built into the daemon, see L<"Built-in targets">
6044 below. Other targets are implemented in plugins which you have to load prior to
6045 using the target. The name of such plugins starts with the "target_" prefix.
6049 The combination of any number of matches and at least one target is called a
6050 I<rule>. The target actions will be performed for all values for which B<all>
6051 matches apply. If the rule does not have any matches associated with it, the
6052 target action will be performed for all values.
6056 A I<chain> is a list of rules and possibly default targets. The rules are tried
6057 in order and if one matches, the associated target will be called. If a value
6058 is handled by a rule, it depends on the target whether or not any subsequent
6059 rules are considered or if traversal of the chain is aborted, see
6060 L<"Flow control"> below. After all rules have been checked, the default targets
6065 =head2 General structure
6067 The following shows the resulting structure:
6074 +---------+ +---------+ +---------+ +---------+
6075 ! Rule !->! Match !->! Match !->! Target !
6076 +---------+ +---------+ +---------+ +---------+
6079 +---------+ +---------+ +---------+
6080 ! Rule !->! Target !->! Target !
6081 +---------+ +---------+ +---------+
6088 +---------+ +---------+ +---------+
6089 ! Rule !->! Match !->! Target !
6090 +---------+ +---------+ +---------+
6100 There are four ways to control which way a value takes through the filter
6107 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
6108 process the value with another chain. When the called chain finishes, usually
6109 the next target or rule after the jump is executed.
6113 The stop condition, signaled for example by the built-in target B<stop>, causes
6114 all processing of the value to be stopped immediately.
6118 Causes processing in the current chain to be aborted, but processing of the
6119 value generally will continue. This means that if the chain was called via
6120 B<Jump>, the next target or rule after the jump will be executed. If the chain
6121 was not called by another chain, control will be returned to the daemon and it
6122 may pass the value to another chain.
6126 Most targets will signal the B<continue> condition, meaning that processing
6127 should continue normally. There is no special built-in target for this
6134 The configuration reflects this structure directly:
6136 PostCacheChain "PostCache"
6138 <Rule "ignore_mysql_show">
6141 Type "^mysql_command$"
6142 TypeInstance "^show_"
6152 The above configuration example will ignore all values where the plugin field
6153 is "mysql", the type is "mysql_command" and the type instance begins with
6154 "show_". All other values will be sent to the C<rrdtool> write plugin via the
6155 default target of the chain. Since this chain is run after the value has been
6156 added to the cache, the MySQL C<show_*> command statistics will be available
6157 via the C<unixsock> plugin.
6159 =head2 List of configuration options
6163 =item B<PreCacheChain> I<ChainName>
6165 =item B<PostCacheChain> I<ChainName>
6167 Configure the name of the "pre-cache chain" and the "post-cache chain". The
6168 argument is the name of a I<chain> that should be executed before and/or after
6169 the values have been added to the cache.
6171 To understand the implications, it's important you know what is going on inside
6172 I<collectd>. The following diagram shows how values are passed from the
6173 read-plugins to the write-plugins:
6179 + - - - - V - - - - +
6180 : +---------------+ :
6183 : +-------+-------+ :
6186 : +-------+-------+ : +---------------+
6187 : ! Cache !--->! Value Cache !
6188 : ! insert ! : +---+---+-------+
6189 : +-------+-------+ : ! !
6190 : ! ,------------' !
6192 : +-------+---+---+ : +-------+-------+
6193 : ! Post-Cache +--->! Write-Plugins !
6194 : ! Chain ! : +---------------+
6195 : +---------------+ :
6198 + - - - - - - - - - +
6200 After the values are passed from the "read" plugins to the dispatch functions,
6201 the pre-cache chain is run first. The values are added to the internal cache
6202 afterwards. The post-cache chain is run after the values have been added to the
6203 cache. So why is it such a huge deal if chains are run before or after the
6204 values have been added to this cache?
6206 Targets that change the identifier of a value list should be executed before
6207 the values are added to the cache, so that the name in the cache matches the
6208 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
6209 this cache to receive a list of all available values. If you change the
6210 identifier after the value list has been added to the cache, this may easily
6211 lead to confusion, but it's not forbidden of course.
6213 The cache is also used to convert counter values to rates. These rates are, for
6214 example, used by the C<value> match (see below). If you use the rate stored in
6215 the cache B<before> the new value is added, you will use the old, B<previous>
6216 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
6217 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
6220 Last but not last, the B<stop> target makes a difference: If the pre-cache
6221 chain returns the stop condition, the value will not be added to the cache and
6222 the post-cache chain will not be run.
6224 =item B<Chain> I<Name>
6226 Adds a new chain with a certain name. This name can be used to refer to a
6227 specific chain, for example to jump to it.
6229 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
6231 =item B<Rule> [I<Name>]
6233 Adds a new rule to the current chain. The name of the rule is optional and
6234 currently has no meaning for the daemon.
6236 Within the B<Rule> block, there may be any number of B<Match> blocks and there
6237 must be at least one B<Target> block.
6239 =item B<Match> I<Name>
6241 Adds a match to a B<Rule> block. The name specifies what kind of match should
6242 be performed. Available matches depend on the plugins that have been loaded.
6244 The arguments inside the B<Match> block are passed to the plugin implementing
6245 the match, so which arguments are valid here depends on the plugin being used.
6246 If you do not need any to pass any arguments to a match, you can use the
6251 Which is equivalent to:
6256 =item B<Target> I<Name>
6258 Add a target to a rule or a default target to a chain. The name specifies what
6259 kind of target is to be added. Which targets are available depends on the
6260 plugins being loaded.
6262 The arguments inside the B<Target> block are passed to the plugin implementing
6263 the target, so which arguments are valid here depends on the plugin being used.
6264 If you do not need any to pass any arguments to a target, you can use the
6269 This is the same as writing:
6276 =head2 Built-in targets
6278 The following targets are built into the core daemon and therefore need no
6279 plugins to be loaded:
6285 Signals the "return" condition, see the L<"Flow control"> section above. This
6286 causes the current chain to stop processing the value and returns control to
6287 the calling chain. The calling chain will continue processing targets and rules
6288 just after the B<jump> target (see below). This is very similar to the
6289 B<RETURN> target of iptables, see L<iptables(8)>.
6291 This target does not have any options.
6299 Signals the "stop" condition, see the L<"Flow control"> section above. This
6300 causes processing of the value to be aborted immediately. This is similar to
6301 the B<DROP> target of iptables, see L<iptables(8)>.
6303 This target does not have any options.
6311 Sends the value to "write" plugins.
6317 =item B<Plugin> I<Name>
6319 Name of the write plugin to which the data should be sent. This option may be
6320 given multiple times to send the data to more than one write plugin.
6324 If no plugin is explicitly specified, the values will be sent to all available
6335 Starts processing the rules of another chain, see L<"Flow control"> above. If
6336 the end of that chain is reached, or a stop condition is encountered,
6337 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
6338 next target or the next rule. This is similar to the B<-j> command line option
6339 of iptables, see L<iptables(8)>.
6345 =item B<Chain> I<Name>
6347 Jumps to the chain I<Name>. This argument is required and may appear only once.
6359 =head2 Available matches
6365 Matches a value using regular expressions.
6371 =item B<Host> I<Regex>
6373 =item B<Plugin> I<Regex>
6375 =item B<PluginInstance> I<Regex>
6377 =item B<Type> I<Regex>
6379 =item B<TypeInstance> I<Regex>
6381 Match values where the given regular expressions match the various fields of
6382 the identifier of a value. If multiple regular expressions are given, B<all>
6383 regexen must match for a value to match.
6385 =item B<Invert> B<false>|B<true>
6387 When set to B<true>, the result of the match is inverted, i.e. all value lists
6388 where all regular expressions apply are not matched, all other value lists are
6389 matched. Defaults to B<false>.
6396 Host "customer[0-9]+"
6402 Matches values that have a time which differs from the time on the server.
6404 This match is mainly intended for servers that receive values over the
6405 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
6406 is very sensitive to the timestamp used when updating the RRD files. In
6407 particular, the time must be ever increasing. If a misbehaving client sends one
6408 packet with a timestamp far in the future, all further packets with a correct
6409 time will be ignored because of that one packet. What's worse, such corrupted
6410 RRD files are hard to fix.
6412 This match lets one match all values B<outside> a specified time range
6413 (relative to the server's time), so you can use the B<stop> target (see below)
6414 to ignore the value, for example.
6420 =item B<Future> I<Seconds>
6422 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
6423 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
6426 =item B<Past> I<Seconds>
6428 Matches all values that are I<behind> of the server's time by I<Seconds> or
6429 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
6441 This example matches all values that are five minutes or more ahead of the
6442 server or one hour (or more) lagging behind.
6446 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
6447 values. If a data-set consists of more than one data-source, all data-sources
6448 must match the specified ranges for a positive match.
6454 =item B<Min> I<Value>
6456 Sets the smallest value which still results in a match. If unset, behaves like
6459 =item B<Max> I<Value>
6461 Sets the largest value which still results in a match. If unset, behaves like
6464 =item B<Invert> B<true>|B<false>
6466 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
6467 no-match is returned and vice versa. Please note that the B<Invert> setting
6468 only effects how B<Min> and B<Max> are applied to a specific value. Especially
6469 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
6471 =item B<DataSource> I<DSName> [I<DSName> ...]
6473 Select one or more of the data sources. If no data source is configured, all
6474 data sources will be checked. If the type handled by the match does not have a
6475 data source of the specified name(s), this will always result in no match
6476 (independent of the B<Invert> setting).
6478 =item B<Satisfy> B<Any>|B<All>
6480 Specifies how checking with several data sources is performed. If set to
6481 B<Any>, the match succeeds if one of the data sources is in the configured
6482 range. If set to B<All> the match only succeeds if all data sources are within
6483 the configured range. Default is B<All>.
6485 Usually B<All> is used for positive matches, B<Any> is used for negative
6486 matches. This means that with B<All> you usually check that all values are in a
6487 "good" range, while with B<Any> you check if any value is within a "bad" range
6488 (or outside the "good" range).
6492 Either B<Min> or B<Max>, but not both, may be unset.
6496 # Match all values smaller than or equal to 100. Matches only if all data
6497 # sources are below 100.
6503 # Match if the value of any data source is outside the range of 0 - 100.
6511 =item B<empty_counter>
6513 Matches all values with one or more data sources of type B<COUNTER> and where
6514 all counter values are zero. These counters usually I<never> increased since
6515 they started existing (and are therefore uninteresting), or got reset recently
6516 or overflowed and you had really, I<really> bad luck.
6518 Please keep in mind that ignoring such counters can result in confusing
6519 behavior: Counters which hardly ever increase will be zero for long periods of
6520 time. If the counter is reset for some reason (machine or service restarted,
6521 usually), the graph will be empty (NAN) for a long time. People may not
6526 Calculates a hash value of the host name and matches values according to that
6527 hash value. This makes it possible to divide all hosts into groups and match
6528 only values that are in a specific group. The intended use is in load
6529 balancing, where you want to handle only part of all data and leave the rest
6532 The hashing function used tries to distribute the hosts evenly. First, it
6533 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
6536 for (i = 0; host[i] != 0; i++)
6537 hash_value = (hash_value * 251) + host[i];
6539 The constant 251 is a prime number which is supposed to make this hash value
6540 more random. The code then checks the group for this host according to the
6541 I<Total> and I<Match> arguments:
6543 if ((hash_value % Total) == Match)
6548 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
6549 groups), then the least significant bit of the hash value will be the XOR of
6550 all least significant bits in the host name. One consequence is that when you
6551 have two hosts, "server0.example.com" and "server1.example.com", where the host
6552 name differs in one digit only and the digits differ by one, those hosts will
6553 never end up in the same group.
6559 =item B<Match> I<Match> I<Total>
6561 Divide the data into I<Total> groups and match all hosts in group I<Match> as
6562 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
6563 be smaller than I<Total>. I<Total> must be at least one, although only values
6564 greater than one really do make any sense.
6566 You can repeat this option to match multiple groups, for example:
6571 The above config will divide the data into seven groups and match groups three
6572 and five. One use would be to keep every value on two hosts so that if one
6573 fails the missing data can later be reconstructed from the second host.
6579 # Operate on the pre-cache chain, so that ignored values are not even in the
6584 # Divide all received hosts in seven groups and accept all hosts in
6588 # If matched: Return and continue.
6591 # If not matched: Return and stop.
6597 =head2 Available targets
6601 =item B<notification>
6603 Creates and dispatches a notification.
6609 =item B<Message> I<String>
6611 This required option sets the message of the notification. The following
6612 placeholders will be replaced by an appropriate value:
6620 =item B<%{plugin_instance}>
6624 =item B<%{type_instance}>
6626 These placeholders are replaced by the identifier field of the same name.
6628 =item B<%{ds:>I<name>B<}>
6630 These placeholders are replaced by a (hopefully) human readable representation
6631 of the current rate of this data source. If you changed the instance name
6632 (using the B<set> or B<replace> targets, see below), it may not be possible to
6633 convert counter values to rates.
6637 Please note that these placeholders are B<case sensitive>!
6639 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
6641 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
6648 <Target "notification">
6649 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
6655 Replaces parts of the identifier using regular expressions.
6661 =item B<Host> I<Regex> I<Replacement>
6663 =item B<Plugin> I<Regex> I<Replacement>
6665 =item B<PluginInstance> I<Regex> I<Replacement>
6667 =item B<TypeInstance> I<Regex> I<Replacement>
6669 Match the appropriate field with the given regular expression I<Regex>. If the
6670 regular expression matches, that part that matches is replaced with
6671 I<Replacement>. If multiple places of the input buffer match a given regular
6672 expression, only the first occurrence will be replaced.
6674 You can specify each option multiple times to use multiple regular expressions
6682 # Replace "example.net" with "example.com"
6683 Host "\\<example.net\\>" "example.com"
6685 # Strip "www." from hostnames
6691 Sets part of the identifier of a value to a given string.
6697 =item B<Host> I<String>
6699 =item B<Plugin> I<String>
6701 =item B<PluginInstance> I<String>
6703 =item B<TypeInstance> I<String>
6705 Set the appropriate field to the given string. The strings for plugin instance
6706 and type instance may be empty, the strings for host and plugin may not be
6707 empty. It's currently not possible to set the type of a value this way.
6714 PluginInstance "coretemp"
6715 TypeInstance "core3"
6720 =head2 Backwards compatibility
6722 If you use collectd with an old configuration, i.E<nbsp>e. one without a
6723 B<Chain> block, it will behave as it used to. This is equivalent to the
6724 following configuration:
6730 If you specify a B<PostCacheChain>, the B<write> target will not be added
6731 anywhere and you will have to make sure that it is called where appropriate. We
6732 suggest to add the above snippet as default target to your "PostCache" chain.
6736 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
6752 L<collectd-exec(5)>,
6753 L<collectd-perl(5)>,
6754 L<collectd-unixsock(5)>,
6767 Florian Forster E<lt>octo@verplant.orgE<gt>