5 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
9 BaseDir "/path/to/data/"
10 PIDFile "/path/to/pidfile/collectd.pid"
11 Server "123.123.123.123" 12345
28 This config file controls how the system statistics collection daemon
29 B<collectd> behaves. The most significant option is B<LoadPlugin>, which
30 controls which plugins to load. These plugins ultimately define collectd's
33 The syntax of this config file is similar to the config file of the famous
34 I<Apache> webserver. Each line contains either an option (a key and a list of
35 one or more values) or a section-start or -end. Empty lines and everything
36 after a non-quoted hash-symbol (C<#>) is ignored. I<Keys> are unquoted
37 strings, consisting only of alphanumeric characters and the underscore (C<_>)
38 character. Keys are handled case insensitive by I<collectd> itself and all
39 plugins included with it. I<Values> can either be an I<unquoted string>, a
40 I<quoted string> (enclosed in double-quotes) a I<number> or a I<boolean>
41 expression. I<Unquoted strings> consist of only alphanumeric characters and
42 underscores (C<_>) and do not need to be quoted. I<Quoted strings> are
43 enclosed in double quotes (C<">). You can use the backslash character (C<\>)
44 to include double quotes as part of the string. I<Numbers> can be specified in
45 decimal and floating point format (using a dot C<.> as decimal separator),
46 hexadecimal when using the C<0x> prefix and octal with a leading zero (C<0>).
47 I<Boolean> values are either B<true> or B<false>.
49 Lines may be wrapped by using C<\> as the last character before the newline.
50 This allows long lines to be split into multiple lines. Quoted strings may be
51 wrapped as well. However, those are treated special in that whitespace at the
52 beginning of the following lines will be ignored, which allows for nicely
53 indenting the wrapped lines.
55 The configuration is read and processed in order, i.e. from top to bottom. So
56 the plugins are loaded in the order listed in this config file. It is a good
57 idea to load any logging plugins first in order to catch messages from plugins
58 during configuration. Also, the C<LoadPlugin> option B<must> occur B<before>
59 the appropriate C<E<lt>Plugin ...E<gt>> block.
65 =item B<BaseDir> I<Directory>
67 Sets the base directory. This is the directory beneath all RRD-files are
68 created. Possibly more subdirectories are created. This is also the working
69 directory for the daemon.
71 =item B<LoadPlugin> I<Plugin>
73 Loads the plugin I<Plugin>. This is required to load plugins, unless the
74 B<AutoLoadPlugin> option is enabled (see below). Without any loaded plugins,
75 I<collectd> will be mostly useless.
77 Only the first B<LoadPlugin> statement or block for a given plugin name has any
78 effect. This is useful when you want to split up the configuration into smaller
79 files and want each file to be "self contained", i.e. it contains a B<Plugin>
80 block I<and> then appropriate B<LoadPlugin> statement. The downside is that if
81 you have multiple conflicting B<LoadPlugin> blocks, e.g. when they specify
82 different intervals, only one of them (the first one encountered) will take
83 effect and all others will be silently ignored.
85 B<LoadPlugin> may either be a simple configuration I<statement> or a I<block>
86 with additional options, affecting the behavior of B<LoadPlugin>. A simple
87 statement looks like this:
91 Options inside a B<LoadPlugin> block can override default settings and
92 influence the way plugins are loaded, e.g.:
99 The following options are valid inside B<LoadPlugin> blocks:
103 =item B<Globals> B<true|false>
105 If enabled, collectd will export all global symbols of the plugin (and of all
106 libraries loaded as dependencies of the plugin) and, thus, makes those symbols
107 available for resolving unresolved symbols in subsequently loaded plugins if
108 that is supported by your system.
110 This is useful (or possibly even required), e.g., when loading a plugin that
111 embeds some scripting language into the daemon (e.g. the I<Perl> and
112 I<Python plugins>). Scripting languages usually provide means to load
113 extensions written in C. Those extensions require symbols provided by the
114 interpreter, which is loaded as a dependency of the respective collectd plugin.
115 See the documentation of those plugins (e.g., L<collectd-perl(5)> or
116 L<collectd-python(5)>) for details.
118 By default, this is disabled. As a special exception, if the plugin name is
119 either C<perl> or C<python>, the default is changed to enabled in order to keep
120 the average user from ever having to deal with this low level linking stuff.
122 =item B<Interval> I<Seconds>
124 Sets a plugin-specific interval for collecting metrics. This overrides the
125 global B<Interval> setting. If a plugin provides own support for specifying an
126 interval, that setting will take precedence.
130 =item B<AutoLoadPlugin> B<false>|B<true>
132 When set to B<false> (the default), each plugin needs to be loaded explicitly,
133 using the B<LoadPlugin> statement documented above. If a
134 B<E<lt>PluginE<nbsp>...E<gt>> block is encountered and no configuration
135 handling callback for this plugin has been registered, a warning is logged and
136 the block is ignored.
138 When set to B<true>, explicit B<LoadPlugin> statements are not required. Each
139 B<E<lt>PluginE<nbsp>...E<gt>> block acts as if it was immediately preceded by a
140 B<LoadPlugin> statement. B<LoadPlugin> statements are still required for
141 plugins that don't provide any configuration, e.g. the I<Load plugin>.
143 =item B<Include> I<Path> [I<pattern>]
145 If I<Path> points to a file, includes that file. If I<Path> points to a
146 directory, recursively includes all files within that directory and its
147 subdirectories. If the C<wordexp> function is available on your system,
148 shell-like wildcards are expanded before files are included. This means you can
149 use statements like the following:
151 Include "/etc/collectd.d/*.conf"
153 Starting with version 5.3, this may also be a block in which further options
154 affecting the behavior of B<Include> may be specified. The following option is
157 <Include "/etc/collectd.d">
163 =item B<Filter> I<pattern>
165 If the C<fnmatch> function is available on your system, a shell-like wildcard
166 I<pattern> may be specified to filter which files to include. This may be used
167 in combination with recursively including a directory to easily be able to
168 arbitrarily mix configuration files and other documents (e.g. README files).
169 The given example is similar to the first example above but includes all files
170 matching C<*.conf> in any subdirectory of C</etc/collectd.d>:
172 Include "/etc/collectd.d" "*.conf"
176 If more than one files are included by a single B<Include> option, the files
177 will be included in lexicographical order (as defined by the C<strcmp>
178 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
179 order in which the files are loaded.
181 To prevent loops and shooting yourself in the foot in interesting ways the
182 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
183 most uses. Since symlinks are followed it is still possible to crash the daemon
184 by looping symlinks. In our opinion significant stupidity should result in an
185 appropriate amount of pain.
187 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
188 file, but you cannot include files from within blocks.
190 =item B<PIDFile> I<File>
192 Sets where to write the PID file to. This file is overwritten when it exists
193 and deleted when the program is stopped. Some init-scripts might override this
194 setting using the B<-P> command-line option.
196 =item B<PluginDir> I<Directory>
198 Path to the plugins (shared objects) of collectd.
200 =item B<TypesDB> I<File> [I<File> ...]
202 Set one or more files that contain the data-set descriptions. See
203 L<types.db(5)> for a description of the format of this file.
205 =item B<Interval> I<Seconds>
207 Configures the interval in which to query the read plugins. Obviously smaller
208 values lead to a higher system load produced by collectd, while higher values
209 lead to more coarse statistics.
211 B<Warning:> You should set this once and then never touch it again. If you do,
212 I<you will have to delete all your RRD files> or know some serious RRDtool
213 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
215 =item B<Timeout> I<Iterations>
217 Consider a value list "missing" when no update has been read or received for
218 I<Iterations> iterations. By default, I<collectd> considers a value list
219 missing when no update has been received for twice the update interval. Since
220 this setting uses iterations, the maximum allowed time without update depends
221 on the I<Interval> information contained in each value list. This is used in
222 the I<Threshold> configuration to dispatch notifications about missing values,
223 see L<collectd-threshold(5)> for details.
225 =item B<ReadThreads> I<Num>
227 Number of threads to start for reading plugins. The default value is B<5>, but
228 you may want to increase this if you have more than five plugins that take a
229 long time to read. Mostly those are plugins that do network-IO. Setting this to
230 a value higher than the number of registered read callbacks is not recommended.
232 =item B<WriteThreads> I<Num>
234 Number of threads to start for dispatching value lists to write plugins. The
235 default value is B<5>, but you may want to increase this if you have more than
236 five plugins that may take relatively long to write to.
238 =item B<WriteQueueLimitHigh> I<HighNum>
240 =item B<WriteQueueLimitLow> I<LowNum>
242 Metrics are read by the I<read threads> and then put into a queue to be handled
243 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
244 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
245 running into memory issues in such a case, you can limit the size of this
248 By default, there is no limit and memory may grow indefinitely. This is most
249 likely not an issue for clients, i.e. instances that only handle the local
250 metrics. For servers it is recommended to set this to a non-zero value, though.
252 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
253 Each of them takes a numerical argument which is the number of metrics in the
254 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
255 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
256 I<will> be enqueued. If the number of metrics currently in the queue is between
257 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
258 proportional to the number of metrics in the queue (i.e. it increases linearly
259 until it reaches 100%.)
261 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
262 unset, the latter will default to half of B<WriteQueueLimitHigh>.
264 If you do not want to randomly drop values when the queue size is between
265 I<LowNum> and I<HighNum>, set If B<WriteQueueLimitHigh> and
266 B<WriteQueueLimitLow> to same value.
268 =item B<Hostname> I<Name>
270 Sets the hostname that identifies a host. If you omit this setting, the
271 hostname will be determined using the L<gethostname(2)> system call.
273 =item B<FQDNLookup> B<true|false>
275 If B<Hostname> is determined automatically this setting controls whether or not
276 the daemon should try to figure out the "fully qualified domain name", FQDN.
277 This is done using a lookup of the name returned by C<gethostname>. This option
278 is enabled by default.
280 =item B<PreCacheChain> I<ChainName>
282 =item B<PostCacheChain> I<ChainName>
284 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
285 see L<FILTER CONFIGURATION> below on information on chains and how these
286 setting change the daemon's behavior.
290 =head1 PLUGIN OPTIONS
292 Some plugins may register own options. These options must be enclosed in a
293 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
294 require external configuration, too. The C<apache plugin>, for example,
295 required C<mod_status> to be configured in the webserver you're going to
296 collect data from. These plugins are listed below as well, even if they don't
297 require any configuration within collectd's configuration file.
299 A list of all plugins and a short summary for each plugin can be found in the
300 F<README> file shipped with the sourcecode and hopefully binary packets as
303 =head2 Plugin C<aggregation>
305 The I<Aggregation plugin> makes it possible to aggregate several values into
306 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
307 This can be put to a wide variety of uses, e.g. average and total CPU
308 statistics for your entire fleet.
310 The grouping is powerful but, as with many powerful tools, may be a bit
311 difficult to wrap your head around. The grouping will therefore be
312 demonstrated using an example: The average and sum of the CPU usage across
313 all CPUs of each host is to be calculated.
315 To select all the affected values for our example, set C<Plugin cpu> and
316 C<Type cpu>. The other values are left unspecified, meaning "all values". The
317 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
318 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
324 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...) and
325 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
326 example, the intention is to have a new value for each host / type instance
327 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
328 It can be specified multiple times to group by more than one field.
331 GroupBy "TypeInstance"
333 We do neither specify nor group by I<plugin instance> (the CPU number), so all
334 metrics that differ in the CPU number only will be aggregated. Each
335 aggregation needs I<at least one> such field, otherwise no aggregation would
338 The full example configuration looks like this:
340 <Plugin "aggregation">
346 GroupBy "TypeInstance"
349 CalculateAverage true
353 There are a couple of limitations you should be aware of:
359 The I<Type> cannot be left unspecified, because it is not reasonable to add
360 apples to oranges. Also, the internal lookup structure won't work if you try
365 There must be at least one unspecified, ungrouped field. Otherwise nothing
370 As you can see in the example above, each aggregation has its own
371 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
372 blocks may match the same values, i.e. one value list can update multiple
373 aggregations. The following options are valid inside B<Aggregation> blocks:
377 =item B<Host> I<Host>
379 =item B<Plugin> I<Plugin>
381 =item B<PluginInstance> I<PluginInstance>
383 =item B<Type> I<Type>
385 =item B<TypeInstance> I<TypeInstance>
387 Selects the value lists to be added to this aggregation. B<Type> must be a
388 valid data set name, see L<types.db(5)> for details.
390 If the string starts with and ends with a slash (C</>), the string is
391 interpreted as a I<regular expression>. The regex flavor used are POSIX
392 extended regular expressions as described in L<regex(7)>. Example usage:
394 Host "/^db[0-9]\\.example\\.com$/"
396 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
398 Group valued by the specified field. The B<GroupBy> option may be repeated to
399 group by multiple fields.
401 =item B<SetHost> I<Host>
403 =item B<SetPlugin> I<Plugin>
405 =item B<SetPluginInstance> I<PluginInstance>
407 =item B<SetTypeInstance> I<TypeInstance>
409 Sets the appropriate part of the identifier to the provided string.
411 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
412 will be replaced with the aggregation function, e.g. "average". Not including
413 the placeholder will result in duplication warnings and/or messed up values if
414 more than one aggregation function are enabled.
416 The following example calculates the average usage of all "even" CPUs:
418 <Plugin "aggregation">
421 PluginInstance "/[0,2,4,6,8]$/"
425 SetPluginInstance "even-%{aggregation}"
428 GroupBy "TypeInstance"
430 CalculateAverage true
434 This will create the files:
440 foo.example.com/cpu-even-average/cpu-idle
444 foo.example.com/cpu-even-average/cpu-system
448 foo.example.com/cpu-even-average/cpu-user
456 =item B<CalculateNum> B<true>|B<false>
458 =item B<CalculateSum> B<true>|B<false>
460 =item B<CalculateAverage> B<true>|B<false>
462 =item B<CalculateMinimum> B<true>|B<false>
464 =item B<CalculateMaximum> B<true>|B<false>
466 =item B<CalculateStddev> B<true>|B<false>
468 Boolean options for enabling calculation of the number of value lists, their
469 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
470 are disabled by default.
474 =head2 Plugin C<amqp>
476 The I<AMQMP plugin> can be used to communicate with other instances of
477 I<collectd> or third party applications using an AMQP message broker. Values
478 are sent to or received from the broker, which handles routing, queueing and
479 possibly filtering or messages.
482 # Send values to an AMQP broker
483 <Publish "some_name">
489 Exchange "amq.fanout"
490 # ExchangeType "fanout"
491 # RoutingKey "collectd"
495 # GraphitePrefix "collectd."
496 # GraphiteEscapeChar "_"
499 # Receive values from an AMQP broker
500 <Subscribe "some_name">
506 Exchange "amq.fanout"
507 # ExchangeType "fanout"
509 # RoutingKey "collectd.#"
513 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
514 blocks, which configure sending and receiving of values respectively. The two
515 blocks are very similar, so unless otherwise noted, an option can be used in
516 either block. The name given in the blocks starting tag is only used for
517 reporting messages, but may be used to support I<flushing> of certain
518 I<Publish> blocks in the future.
522 =item B<Host> I<Host>
524 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
525 the underlying communications library, I<rabbitmq-c>, which is "localhost".
527 =item B<Port> I<Port>
529 Service name or port number on which the AMQP broker accepts connections. This
530 argument must be a string, even if the numeric form is used. Defaults to
533 =item B<VHost> I<VHost>
535 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
537 =item B<User> I<User>
539 =item B<Password> I<Password>
541 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
544 =item B<Exchange> I<Exchange>
546 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
547 By default, "amq.fanout" will be used.
549 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
550 the given exchange and the I<queue> is created, using the I<routing key> if
551 configured. See the B<Queue> and B<RoutingKey> options below.
553 =item B<ExchangeType> I<Type>
555 If given, the plugin will try to create the configured I<exchange> with this
556 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
557 be bound to this exchange.
559 =item B<Queue> I<Queue> (Subscribe only)
561 Configures the I<queue> name to subscribe to. If no queue name was configures
562 explicitly, a unique queue name will be created by the broker.
564 =item B<RoutingKey> I<Key>
566 In I<Publish> blocks, this configures the routing key to set on all outgoing
567 messages. If not given, the routing key will be computed from the I<identifier>
568 of the value. The host, plugin, type and the two instances are concatenated
569 together using dots as the separator and all containing dots replaced with
570 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
571 possible to receive only specific values using a "topic" exchange.
573 In I<Subscribe> blocks, configures the I<routing key> used when creating a
574 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
575 used to filter messages when using a "topic" exchange. If you're only
576 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
579 =item B<Persistent> B<true>|B<false> (Publish only)
581 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
582 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
583 default), the I<transient> delivery mode will be used, i.e. messages may be
584 lost due to high load, overflowing queues or similar issues.
586 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
588 Selects the format in which messages are sent to the broker. If set to
589 B<Command> (the default), values are sent as C<PUTVAL> commands which are
590 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
591 case, the C<Content-Type> header field will be set to C<text/collectd>.
593 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
594 an easy and straight forward exchange format. The C<Content-Type> header field
595 will be set to C<application/json>.
597 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
598 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
601 A subscribing client I<should> use the C<Content-Type> header field to
602 determine how to decode the values. Currently, the I<AMQP plugin> itself can
603 only decode the B<Command> format.
605 =item B<StoreRates> B<true>|B<false> (Publish only)
607 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
608 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
609 default), no conversion is performed. Otherwise the conversion is performed
610 using the internal value cache.
612 Please note that currently this option is only used if the B<Format> option has
615 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
617 A prefix can be added in the metric name when outputting in the I<Graphite> format.
618 It's added before the I<Host> name.
619 Metric name will be "<prefix><host><postfix><plugin><type><name>"
621 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
623 A postfix can be added in the metric name when outputting in the I<Graphite> format.
624 It's added after the I<Host> name.
625 Metric name will be "<prefix><host><postfix><plugin><type><name>"
627 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
629 Specify a character to replace dots (.) in the host part of the metric name.
630 In I<Graphite> metric name, dots are used as separators between different
631 metric parts (host, plugin, type).
632 Default is "_" (I<Underscore>).
636 =head2 Plugin C<apache>
638 To configure the C<apache>-plugin you first need to configure the Apache
639 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
640 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
641 the following snipped to base your Apache config upon:
644 <IfModule mod_status.c>
645 <Location /mod_status>
646 SetHandler server-status
650 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
651 also supported. It introduces a new field, called C<BusyServers>, to count the
652 number of currently connected clients. This field is also supported.
654 The configuration of the I<Apache> plugin consists of one or more
655 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
656 as the instance name. For example:
660 URL "http://www1.example.com/mod_status?auto"
663 URL "http://www2.example.com/mod_status?auto"
667 The instance name will be used as the I<plugin instance>. To emulate the old
668 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
669 plugin to work correctly, each instance name must be unique. This is not
670 enforced by the plugin and it is your responsibility to ensure it.
672 The following options are accepted within each I<Instance> block:
676 =item B<URL> I<http://host/mod_status?auto>
678 Sets the URL of the C<mod_status> output. This needs to be the output generated
679 by C<ExtendedStatus on> and it needs to be the machine readable output
680 generated by appending the C<?auto> argument. This option is I<mandatory>.
682 =item B<User> I<Username>
684 Optional user name needed for authentication.
686 =item B<Password> I<Password>
688 Optional password needed for authentication.
690 =item B<VerifyPeer> B<true|false>
692 Enable or disable peer SSL certificate verification. See
693 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
695 =item B<VerifyHost> B<true|false>
697 Enable or disable peer host name verification. If enabled, the plugin checks
698 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
699 certificate matches the host name provided by the B<URL> option. If this
700 identity check fails, the connection is aborted. Obviously, only works when
701 connecting to a SSL enabled server. Enabled by default.
703 =item B<CACert> I<File>
705 File that holds one or more SSL certificates. If you want to use HTTPS you will
706 possibly need this option. What CA certificates come bundled with C<libcurl>
707 and are checked by default depends on the distribution you use.
711 =head2 Plugin C<apcups>
715 =item B<Host> I<Hostname>
717 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
718 that IPv6 support has been disabled unless someone can confirm or decline that
719 B<apcupsd> can handle it.
721 =item B<Port> I<Port>
723 TCP-Port to connect to. Defaults to B<3551>.
725 =item B<ReportSeconds> B<true|false>
727 If set to B<true>, the time reported in the C<timeleft> metric will be
728 converted to seconds. This is the recommended setting. If set to B<false>, the
729 default for backwards compatibility, the time will be reported in minutes.
733 =head2 Plugin C<aquaero>
735 This plugin collects the value of the available sensors in an
736 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
737 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
738 connection for monitoring and configuration. The board can handle multiple
739 temperature sensors, fans, water pumps and water level sensors and adjust the
740 output settings such as fan voltage or power used by the water pump based on
741 the available inputs using a configurable controller included in the board.
742 This plugin collects all the available inputs as well as some of the output
743 values chosen by this controller. The plugin is based on the I<libaquaero5>
744 library provided by I<aquatools-ng>.
748 =item B<Device> I<DevicePath>
750 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
751 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
752 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
756 =head2 Plugin C<ascent>
758 This plugin collects information about an Ascent server, a free server for the
759 "World of Warcraft" game. This plugin gathers the information by fetching the
760 XML status page using C<libcurl> and parses it using C<libxml2>.
762 The configuration options are the same as for the C<apache> plugin above:
766 =item B<URL> I<http://localhost/ascent/status/>
768 Sets the URL of the XML status output.
770 =item B<User> I<Username>
772 Optional user name needed for authentication.
774 =item B<Password> I<Password>
776 Optional password needed for authentication.
778 =item B<VerifyPeer> B<true|false>
780 Enable or disable peer SSL certificate verification. See
781 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
783 =item B<VerifyHost> B<true|false>
785 Enable or disable peer host name verification. If enabled, the plugin checks
786 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
787 certificate matches the host name provided by the B<URL> option. If this
788 identity check fails, the connection is aborted. Obviously, only works when
789 connecting to a SSL enabled server. Enabled by default.
791 =item B<CACert> I<File>
793 File that holds one or more SSL certificates. If you want to use HTTPS you will
794 possibly need this option. What CA certificates come bundled with C<libcurl>
795 and are checked by default depends on the distribution you use.
799 =head2 Plugin C<bind>
801 Starting with BIND 9.5.0, the most widely used DNS server software provides
802 extensive statistics about queries, responses and lots of other information.
803 The bind plugin retrieves this information that's encoded in XML and provided
804 via HTTP and submits the values to collectd.
806 To use this plugin, you first need to tell BIND to make this information
807 available. This is done with the C<statistics-channels> configuration option:
809 statistics-channels {
810 inet localhost port 8053;
813 The configuration follows the grouping that can be seen when looking at the
814 data with an XSLT compatible viewer, such as a modern web browser. It's
815 probably a good idea to make yourself familiar with the provided values, so you
816 can understand what the collected statistics actually mean.
821 URL "http://localhost:8053/"
836 Zone "127.in-addr.arpa/IN"
840 The bind plugin accepts the following configuration options:
846 URL from which to retrieve the XML data. If not specified,
847 C<http://localhost:8053/> will be used.
849 =item B<ParseTime> B<true>|B<false>
851 When set to B<true>, the time provided by BIND will be parsed and used to
852 dispatch the values. When set to B<false>, the local time source is queried.
854 This setting is set to B<true> by default for backwards compatibility; setting
855 this to B<false> is I<recommended> to avoid problems with timezones and
858 =item B<OpCodes> B<true>|B<false>
860 When enabled, statistics about the I<"OpCodes">, for example the number of
861 C<QUERY> packets, are collected.
865 =item B<QTypes> B<true>|B<false>
867 When enabled, the number of I<incoming> queries by query types (for example
868 C<A>, C<MX>, C<AAAA>) is collected.
872 =item B<ServerStats> B<true>|B<false>
874 Collect global server statistics, such as requests received over IPv4 and IPv6,
875 successful queries, and failed updates.
879 =item B<ZoneMaintStats> B<true>|B<false>
881 Collect zone maintenance statistics, mostly information about notifications
882 (zone updates) and zone transfers.
886 =item B<ResolverStats> B<true>|B<false>
888 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
889 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
890 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
891 default. Use the B<ResolverStats> option within a B<View "_default"> block
892 instead for the same functionality.
898 Collect global memory statistics.
902 =item B<View> I<Name>
904 Collect statistics about a specific I<"view">. BIND can behave different,
905 mostly depending on the source IP-address of the request. These different
906 configurations are called "views". If you don't use this feature, you most
907 likely are only interested in the C<_default> view.
909 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
910 information you want to collect about a view. If no B<View> block is
911 configured, no detailed view statistics will be collected.
915 =item B<QTypes> B<true>|B<false>
917 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
922 =item B<ResolverStats> B<true>|B<false>
924 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
925 (e.E<nbsp>g. queries over IPv4, lame servers).
929 =item B<CacheRRSets> B<true>|B<false>
931 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
932 type is collected. Negative entries (queries which resulted in an error, for
933 example names that do not exist) are reported with a leading exclamation mark,
938 =item B<Zone> I<Name>
940 When given, collect detailed information about the given zone in the view. The
941 information collected if very similar to the global B<ServerStats> information
944 You can repeat this option to collect detailed information about multiple
947 By default no detailed zone information is collected.
953 =head2 Plugin C<cgroups>
955 This plugin collects the CPU user/system time for each I<cgroup> by reading the
956 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
957 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
961 =item B<CGroup> I<Directory>
963 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
964 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
967 =item B<IgnoreSelected> B<true>|B<false>
969 Invert the selection: If set to true, all cgroups I<except> the ones that
970 match any one of the criteria are collected. By default only selected
971 cgroups are collected if a selection is made. If no selection is configured
972 at all, B<all> cgroups are selected.
976 =head2 Plugin C<cpufreq>
978 This plugin doesn't have any options. It reads
979 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
980 installed) to get the current CPU frequency. If this file does not exist make
981 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
982 installed and an "cpu governor" (that's a kernel module) is loaded.
988 =item B<DataDir> I<Directory>
990 Set the directory to store CSV-files under. Per default CSV-files are generated
991 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
992 The special strings B<stdout> and B<stderr> can be used to write to the standard
993 output and standard error channels, respectively. This, of course, only makes
994 much sense when collectd is running in foreground- or non-daemon-mode.
996 =item B<StoreRates> B<true|false>
998 If set to B<true>, convert counter values to rates. If set to B<false> (the
999 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1004 =head2 Plugin C<curl>
1006 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1007 and the match infrastructure (the same code used by the tail plugin) to use
1008 regular expressions with the received data.
1010 The following example will read the current value of AMD stock from Google's
1011 finance page and dispatch the value to collectd.
1014 <Page "stock_quotes">
1015 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1019 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1020 DSType "GaugeAverage"
1021 # Note: `stock_value' is not a standard type.
1028 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1029 a web page and one or more "matches" to be performed on the returned data. The
1030 string argument to the B<Page> block is used as plugin instance.
1032 The following options are valid within B<Page> blocks:
1038 URL of the web site to retrieve. Since a regular expression will be used to
1039 extract information from this data, non-binary data is a big plus here ;)
1041 =item B<User> I<Name>
1043 Username to use if authorization is required to read the page.
1045 =item B<Password> I<Password>
1047 Password to use if authorization is required to read the page.
1049 =item B<VerifyPeer> B<true>|B<false>
1051 Enable or disable peer SSL certificate verification. See
1052 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1054 =item B<VerifyHost> B<true>|B<false>
1056 Enable or disable peer host name verification. If enabled, the plugin checks if
1057 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1058 matches the host name provided by the B<URL> option. If this identity check
1059 fails, the connection is aborted. Obviously, only works when connecting to a
1060 SSL enabled server. Enabled by default.
1062 =item B<CACert> I<file>
1064 File that holds one or more SSL certificates. If you want to use HTTPS you will
1065 possibly need this option. What CA certificates come bundled with C<libcurl>
1066 and are checked by default depends on the distribution you use.
1068 =item B<Header> I<Header>
1070 A HTTP header to add to the request. Multiple headers are added if this option
1071 is specified more than once.
1073 =item B<Post> I<Body>
1075 Specifies that the HTTP operation should be a POST instead of a GET. The
1076 complete data to be posted is given as the argument. This option will usually
1077 need to be accompanied by a B<Header> option to set an appropriate
1078 C<Content-Type> for the post body (e.g. to
1079 C<application/x-www-form-urlencoded>).
1081 =item B<MeasureResponseTime> B<true>|B<false>
1083 Measure response time for the request. If this setting is enabled, B<Match>
1084 blocks (see below) are optional. Disabled by default.
1086 =item B<E<lt>MatchE<gt>>
1088 One or more B<Match> blocks that define how to match information in the data
1089 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1090 used by the C<tail> plugin, so please see the documentation of the C<tail>
1091 plugin below on how matches are defined. If the B<MeasureResponseTime> option
1092 is set to B<true>, B<Match> blocks are optional.
1096 =head2 Plugin C<curl_json>
1098 The B<curl_json plugin> collects values from JSON data to be parsed by
1099 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) retrieved via
1100 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1101 unix socket. The former can be used, for example, to collect values
1102 from CouchDB documents (which are stored JSON notation), and the
1103 latter to collect values from a uWSGI stats socket.
1105 The following example will collect several values from the built-in
1106 C<_stats> runtime statistics module of I<CouchDB>
1107 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1110 <URL "http://localhost:5984/_stats">
1112 <Key "httpd/requests/count">
1113 Type "http_requests"
1116 <Key "httpd_request_methods/*/count">
1117 Type "http_request_methods"
1120 <Key "httpd_status_codes/*/count">
1121 Type "http_response_codes"
1126 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1129 <Sock "/var/run/uwsgi.stats.sock">
1131 <Key "workers/*/requests">
1132 Type "http_requests"
1135 <Key "workers/*/apps/*/requests">
1136 Type "http_requests"
1141 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1142 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1143 blocks defining a unix socket to read JSON from directly. Each of
1144 these blocks may have one or more B<Key> blocks.
1146 The B<Key> string argument must be in a path format. Each component is
1147 used to match the key from a JSON map or the index of an JSON
1148 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1149 values for all map keys or array indices will be collectd.
1151 The following options are valid within B<URL> blocks:
1155 =item B<Instance> I<Instance>
1157 Sets the plugin instance to I<Instance>.
1159 =item B<User> I<Name>
1160 =item B<Password> I<Password>
1161 =item B<VerifyPeer> B<true>|B<false>
1162 =item B<VerifyHost> B<true>|B<false>
1163 =item B<CACert> I<file>
1164 =item B<Header> I<Header>
1165 =item B<Post> I<Body>
1167 These options behave exactly equivalent to the appropriate options of the
1168 I<cURL> plugin. Please see there for a detailed description.
1172 The following options are valid within B<Key> blocks:
1176 =item B<Type> I<Type>
1178 Sets the type used to dispatch the values to the daemon. Detailed information
1179 about types and their configuration can be found in L<types.db(5)>. This
1180 option is mandatory.
1182 =item B<Instance> I<Instance>
1184 Type-instance to use. Defaults to the current map key or current string array element value.
1188 =head2 Plugin C<curl_xml>
1190 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1191 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1194 <URL "http://localhost/stats.xml">
1196 Instance "some_instance"
1201 CACert "/path/to/ca.crt"
1203 <XPath "table[@id=\"magic_level\"]/tr">
1205 #InstancePrefix "prefix-"
1206 InstanceFrom "td[1]"
1207 ValuesFrom "td[2]/span[@class=\"level\"]"
1212 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1213 URL to be fetched using libcurl. Within each B<URL> block there are
1214 options which specify the connection parameters, for example authentication
1215 information, and one or more B<XPath> blocks.
1217 Each B<XPath> block specifies how to get one type of information. The
1218 string argument must be a valid XPath expression which returns a list
1219 of "base elements". One value is dispatched for each "base element". The
1220 I<type instance> and values are looked up using further I<XPath> expressions
1221 that should be relative to the base element.
1223 Within the B<URL> block the following options are accepted:
1227 =item B<Host> I<Name>
1229 Use I<Name> as the host name when submitting values. Defaults to the global
1232 =item B<Instance> I<Instance>
1234 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1235 empty string (no plugin instance).
1237 =item B<Namespace> I<Prefix> I<URL>
1239 If an XPath expression references namespaces, they must be specified
1240 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1241 I<URL> is the "namespace name", an URI reference uniquely identifying the
1242 namespace. The option can be repeated to register multiple namespaces.
1246 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1247 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1249 =item B<User> I<User>
1251 =item B<Password> I<Password>
1253 =item B<VerifyPeer> B<true>|B<false>
1255 =item B<VerifyHost> B<true>|B<false>
1257 =item B<CACert> I<CA Cert File>
1259 =item B<Header> I<Header>
1261 =item B<Post> I<Body>
1263 These options behave exactly equivalent to the appropriate options of the
1264 I<cURL plugin>. Please see there for a detailed description.
1266 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1268 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1269 B<XPath> block specifies how to get one type of information. The string
1270 argument must be a valid XPath expression which returns a list of "base
1271 elements". One value is dispatched for each "base element".
1273 Within the B<XPath> block the following options are accepted:
1277 =item B<Type> I<Type>
1279 Specifies the I<Type> used for submitting patches. This determines the number
1280 of values that are required / expected and whether the strings are parsed as
1281 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1282 This option is required.
1284 =item B<InstancePrefix> I<InstancePrefix>
1286 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1287 concatenated together without any separator.
1288 This option is optional.
1290 =item B<InstanceFrom> I<InstanceFrom>
1292 Specifies a XPath expression to use for determining the I<type instance>. The
1293 XPath expression must return exactly one element. The element's value is then
1294 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1296 This value is required. As a special exception, if the "base XPath expression"
1297 (the argument to the B<XPath> block) returns exactly one argument, then this
1298 option may be omitted.
1300 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1302 Specifies one or more XPath expression to use for reading the values. The
1303 number of XPath expressions must match the number of data sources in the
1304 I<type> specified with B<Type> (see above). Each XPath expression must return
1305 exactly one element. The element's value is then parsed as a number and used as
1306 value for the appropriate value in the value list dispatched to the daemon.
1312 =head2 Plugin C<dbi>
1314 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1315 connect to various databases, execute I<SQL> statements and read back the
1316 results. I<dbi> is an acronym for "database interface" in case you were
1317 wondering about the name. You can configure how each column is to be
1318 interpreted and the plugin will generate one or more data sets from each row
1319 returned according to these rules.
1321 Because the plugin is very generic, the configuration is a little more complex
1322 than those of other plugins. It usually looks something like this:
1325 <Query "out_of_stock">
1326 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1327 # Use with MySQL 5.0.0 or later
1331 InstancePrefix "out_of_stock"
1332 InstancesFrom "category"
1336 <Database "product_information">
1338 DriverOption "host" "localhost"
1339 DriverOption "username" "collectd"
1340 DriverOption "password" "aZo6daiw"
1341 DriverOption "dbname" "prod_info"
1342 SelectDB "prod_info"
1343 Query "out_of_stock"
1347 The configuration above defines one query with one result and one database. The
1348 query is then linked to the database with the B<Query> option I<within> the
1349 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1350 and you can also use the B<Include> statement to split up the configuration
1351 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1352 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1355 The following is a complete list of options:
1357 =head3 B<Query> blocks
1359 Query blocks define I<SQL> statements and how the returned data should be
1360 interpreted. They are identified by the name that is given in the opening line
1361 of the block. Thus the name needs to be unique. Other than that, the name is
1362 not used in collectd.
1364 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1365 define which column holds which value or instance information. You can use
1366 multiple B<Result> blocks to create multiple values from one returned row. This
1367 is especially useful, when queries take a long time and sending almost the same
1368 query again and again is not desirable.
1372 <Query "environment">
1373 Statement "select station, temperature, humidity from environment"
1376 # InstancePrefix "foo"
1377 InstancesFrom "station"
1378 ValuesFrom "temperature"
1382 InstancesFrom "station"
1383 ValuesFrom "humidity"
1387 The following options are accepted:
1391 =item B<Statement> I<SQL>
1393 Sets the statement that should be executed on the server. This is B<not>
1394 interpreted by collectd, but simply passed to the database server. Therefore,
1395 the SQL dialect that's used depends on the server collectd is connected to.
1397 The query has to return at least two columns, one for the instance and one
1398 value. You cannot omit the instance, even if the statement is guaranteed to
1399 always return exactly one line. In that case, you can usually specify something
1402 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1404 (That works with MySQL but may not be valid SQL according to the spec. If you
1405 use a more strict database server, you may have to select from a dummy table or
1408 Please note that some databases, for example B<Oracle>, will fail if you
1409 include a semicolon at the end of the statement.
1411 =item B<MinVersion> I<Version>
1413 =item B<MaxVersion> I<Value>
1415 Only use this query for the specified database version. You can use these
1416 options to provide multiple queries with the same name but with a slightly
1417 different syntax. The plugin will use only those queries, where the specified
1418 minimum and maximum versions fit the version of the database in use.
1420 The database version is determined by C<dbi_conn_get_engine_version>, see the
1421 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1422 for details. Basically, each part of the version is assumed to be in the range
1423 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1424 "40102", version "5.0.42" becomes "50042".
1426 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1427 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1428 happen. Don't to it! A valid example would be something along these lines:
1439 In the above example, there are three ranges that don't overlap. The last one
1440 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1441 before "4.0.0" are not specified.
1443 =item B<Type> I<Type>
1445 The B<type> that's used for each line returned. See L<types.db(5)> for more
1446 details on how types are defined. In short: A type is a predefined layout of
1447 data and the number of values and type of values has to match the type
1450 If you specify "temperature" here, you need exactly one gauge column. If you
1451 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1454 There must be exactly one B<Type> option inside each B<Result> block.
1456 =item B<InstancePrefix> I<prefix>
1458 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1459 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1460 all strings returned in the appropriate columns are concatenated together,
1461 separated by dashes I<("-")>.
1463 =item B<InstancesFrom> I<column0> [I<column1> ...]
1465 Specifies the columns whose values will be used to create the "type-instance"
1466 for each row. If you specify more than one column, the value of all columns
1467 will be joined together with dashes I<("-")> as separation characters.
1469 The plugin itself does not check whether or not all built instances are
1470 different. It's your responsibility to assure that each is unique. This is
1471 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1472 sure that only one row is returned in this case.
1474 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1477 =item B<ValuesFrom> I<column0> [I<column1> ...]
1479 Names the columns whose content is used as the actual data for the data sets
1480 that are dispatched to the daemon. How many such columns you need is determined
1481 by the B<Type> setting above. If you specify too many or not enough columns,
1482 the plugin will complain about that and no data will be submitted to the
1485 The actual data type in the columns is not that important. The plugin will
1486 automatically cast the values to the right type if it know how to do that. So
1487 it should be able to handle integer an floating point types, as well as strings
1488 (if they include a number at the beginning).
1490 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1494 =head3 B<Database> blocks
1496 Database blocks define a connection to a database and which queries should be
1497 sent to that database. Since the used "dbi" library can handle a wide variety
1498 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1499 documentationE<nbsp>- we stick as close to the terminology used there.
1501 Each database needs a "name" as string argument in the starting tag of the
1502 block. This name will be used as "PluginInstance" in the values submitted to
1503 the daemon. Other than that, that name is not used.
1507 =item B<Driver> I<Driver>
1509 Specifies the driver to use to connect to the database. In many cases those
1510 drivers are named after the database they can connect to, but this is not a
1511 technical necessity. These drivers are sometimes referred to as "DBD",
1512 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1513 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1514 project at L<http://libdbi-drivers.sourceforge.net/>.
1516 You need to give the driver name as expected by the "dbi" library here. You
1517 should be able to find that in the documentation for each driver. If you
1518 mistype the driver name, the plugin will dump a list of all known driver names
1521 =item B<DriverOption> I<Key> I<Value>
1523 Sets driver-specific options. What option a driver supports can be found in the
1524 documentation for each driver, somewhere at
1525 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1526 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1528 DBDs can register two types of options: String options and numeric options. The
1529 plugin will use the C<dbi_conn_set_option> function when the configuration
1530 provides a string and the C<dbi_conn_require_option_numeric> function when the
1531 configuration provides a number. So these two lines will actually result in
1532 different calls being used:
1534 DriverOption "Port" 1234 # numeric
1535 DriverOption "Port" "1234" # string
1537 Unfortunately, drivers are not too keen to report errors when an unknown option
1538 is passed to them, so invalid settings here may go unnoticed. This is not the
1539 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1540 the driver. If a driver complains about an option, the plugin will dump a
1541 complete list of all options understood by that driver to the log. There is no
1542 way to programatically find out if an option expects a string or a numeric
1543 argument, so you will have to refer to the appropriate DBD's documentation to
1544 find this out. Sorry.
1546 =item B<SelectDB> I<Database>
1548 In some cases, the database name you connect with is not the database name you
1549 want to use for querying data. If this option is set, the plugin will "select"
1550 (switch to) that database after the connection is established.
1552 =item B<Query> I<QueryName>
1554 Associates the query named I<QueryName> with this database connection. The
1555 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1556 blocks you want to refer to must be placed above the database block you want to
1559 =item B<Host> I<Hostname>
1561 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
1562 values. Defaults to the global hostname setting.
1570 =item B<Device> I<Device>
1572 Select partitions based on the devicename.
1574 =item B<MountPoint> I<Directory>
1576 Select partitions based on the mountpoint.
1578 =item B<FSType> I<FSType>
1580 Select partitions based on the filesystem type.
1582 =item B<IgnoreSelected> B<true>|B<false>
1584 Invert the selection: If set to true, all partitions B<except> the ones that
1585 match any one of the criteria are collected. By default only selected
1586 partitions are collected if a selection is made. If no selection is configured
1587 at all, B<all> partitions are selected.
1589 =item B<ReportByDevice> B<true>|B<false>
1591 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1592 (the default), it will report a disk as "root", but with it I<true>, it will be
1593 "sda1" (or whichever).
1595 =item B<ReportInodes> B<true>|B<false>
1597 Enables or disables reporting of free, reserved and used inodes. Defaults to
1598 inode collection being disabled.
1600 Enable this option if inodes are a scarce resource for you, usually because
1601 many small files are stored on the disk. This is a usual scenario for mail
1602 transfer agents and web caches.
1604 =item B<ValuesAbsolute> B<true>|B<false>
1606 Enables or disables reporting of free, used and used disk space in 1K-blocks.
1609 =item B<ValuesPercentage> B<true>|B<false>
1611 Enables or disables reporting of free, used and used disk space in percentage.
1614 This is useful for deploying collectd on the cloud, where machines with
1615 different disk size may exist. Then it is more practical to configure thresholds
1616 based on relative disk size.
1620 =head2 Plugin C<disk>
1622 The C<disk> plugin collects information about the usage of physical disks and
1623 logical disks (partitions). Values collected are the number of octets written
1624 to and read from a disk or partition, the number of read/write operations
1625 issued to the disk and a rather complex "time" it took for these commands to be
1628 Using the following two options you can ignore some disks or configure the
1629 collection only of specific disks.
1633 =item B<Disk> I<Name>
1635 Select the disk I<Name>. Whether it is collected or ignored depends on the
1636 B<IgnoreSelected> setting, see below. As with other plugins that use the
1637 daemon's ignorelist functionality, a string that starts and ends with a slash
1638 is interpreted as a regular expression. Examples:
1643 =item B<IgnoreSelected> B<true>|B<false>
1645 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1646 statements, are ignored or if all other disks are ignored. The behavior
1647 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1648 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1649 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1650 is set to B<true>, all disks are collected B<except> the ones matched.
1652 =item B<UseBSDName> B<true>|B<false>
1654 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
1655 default major/minor numbers. Requires collectd to be built with Apple's
1658 =item B<UdevNameAttr> I<Attribute>
1660 Attempt to override disk instance name with the value of a specified udev
1661 attribute when built with B<libudev>. If the attribute is not defined for the
1662 given device, the default name is used. Example:
1664 UdevNameAttr "DM_NAME"
1668 =head2 Plugin C<dns>
1672 =item B<Interface> I<Interface>
1674 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1675 option sets the interface that should be used. If this option is not set, or
1676 set to "any", the plugin will try to get packets from B<all> interfaces. This
1677 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1679 =item B<IgnoreSource> I<IP-address>
1681 Ignore packets that originate from this address.
1683 =item B<SelectNumericQueryTypes> B<true>|B<false>
1685 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1689 =head2 Plugin C<email>
1693 =item B<SocketFile> I<Path>
1695 Sets the socket-file which is to be created.
1697 =item B<SocketGroup> I<Group>
1699 If running as root change the group of the UNIX-socket after it has been
1700 created. Defaults to B<collectd>.
1702 =item B<SocketPerms> I<Permissions>
1704 Change the file permissions of the UNIX-socket after it has been created. The
1705 permissions must be given as a numeric, octal value as you would pass to
1706 L<chmod(1)>. Defaults to B<0770>.
1708 =item B<MaxConns> I<Number>
1710 Sets the maximum number of connections that can be handled in parallel. Since
1711 this many threads will be started immediately setting this to a very high
1712 value will waste valuable resources. Defaults to B<5> and will be forced to be
1713 at most B<16384> to prevent typos and dumb mistakes.
1717 =head2 Plugin C<ethstat>
1719 The I<ethstat plugin> collects information about network interface cards (NICs)
1720 by talking directly with the underlying kernel driver using L<ioctl(2)>.
1726 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
1727 Map "multicast" "if_multicast"
1734 =item B<Interface> I<Name>
1736 Collect statistical information about interface I<Name>.
1738 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
1740 By default, the plugin will submit values as type C<derive> and I<type
1741 instance> set to I<Name>, the name of the metric as reported by the driver. If
1742 an appropriate B<Map> option exists, the given I<Type> and, optionally,
1743 I<TypeInstance> will be used.
1745 =item B<MappedOnly> B<true>|B<false>
1747 When set to B<true>, only metrics that can be mapped to to a I<type> will be
1748 collected, all other metrics will be ignored. Defaults to B<false>.
1752 =head2 Plugin C<exec>
1754 Please make sure to read L<collectd-exec(5)> before using this plugin. It
1755 contains valuable information on when the executable is executed and the
1756 output that is expected from it.
1760 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1762 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1764 Execute the executable I<Executable> as user I<User>. If the user name is
1765 followed by a colon and a group name, the effective group is set to that group.
1766 The real group and saved-set group will be set to the default group of that
1767 user. If no group is given the effective group ID will be the same as the real
1770 Please note that in order to change the user and/or group the daemon needs
1771 superuser privileges. If the daemon is run as an unprivileged user you must
1772 specify the same user/group here. If the daemon is run with superuser
1773 privileges, you must supply a non-root user here.
1775 The executable may be followed by optional arguments that are passed to the
1776 program. Please note that due to the configuration parsing numbers and boolean
1777 values may be changed. If you want to be absolutely sure that something is
1778 passed as-is please enclose it in quotes.
1780 The B<Exec> and B<NotificationExec> statements change the semantics of the
1781 programs executed, i.E<nbsp>e. the data passed to them and the response
1782 expected from them. This is documented in great detail in L<collectd-exec(5)>.
1786 =head2 Plugin C<filecount>
1788 The C<filecount> plugin counts the number of files in a certain directory (and
1789 its subdirectories) and their combined size. The configuration is very straight
1792 <Plugin "filecount">
1793 <Directory "/var/qmail/queue/mess">
1794 Instance "qmail-message"
1796 <Directory "/var/qmail/queue/todo">
1797 Instance "qmail-todo"
1799 <Directory "/var/lib/php5">
1800 Instance "php5-sessions"
1805 The example above counts the number of files in QMail's queue directories and
1806 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
1807 QMail has not yet looked at, the "message" queue holds the messages that were
1808 classified into "local" and "remote".
1810 As you can see, the configuration consists of one or more C<Directory> blocks,
1811 each of which specifies a directory in which to count the files. Within those
1812 blocks, the following options are recognized:
1816 =item B<Instance> I<Instance>
1818 Sets the plugin instance to I<Instance>. That instance name must be unique, but
1819 it's your responsibility, the plugin doesn't check for that. If not given, the
1820 instance is set to the directory name with all slashes replaced by underscores
1821 and all leading underscores removed.
1823 =item B<Name> I<Pattern>
1825 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
1826 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
1827 against the pattern, not the entire path. In case this makes it easier for you:
1828 This option has been named after the B<-name> parameter to L<find(1)>.
1830 =item B<MTime> I<Age>
1832 Count only files of a specific age: If I<Age> is greater than zero, only files
1833 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
1834 a negative number, this is inversed. For example, if B<-60> is specified, only
1835 files that have been modified in the last minute will be counted.
1837 The number can also be followed by a "multiplier" to easily specify a larger
1838 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
1839 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
1840 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
1841 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
1842 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
1845 =item B<Size> I<Size>
1847 Count only files of a specific size. When I<Size> is a positive number, only
1848 files that are at least this big are counted. If I<Size> is a negative number,
1849 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
1850 I<Size> are counted.
1852 As with the B<MTime> option, a "multiplier" may be added. For a detailed
1853 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
1854 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
1855 note that there are 1000 bytes in a kilobyte, not 1024.
1857 =item B<Recursive> I<true>|I<false>
1859 Controls whether or not to recurse into subdirectories. Enabled by default.
1861 =item B<IncludeHidden> I<true>|I<false>
1863 Controls whether or not to include "hidden" files and directories in the count.
1864 "Hidden" files and directories are those, whose name begins with a dot.
1865 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
1869 =head2 Plugin C<GenericJMX>
1871 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
1872 L<collectd-java(5)>.
1874 =head2 Plugin C<gmond>
1876 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
1877 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
1878 are built-in, custom mappings may be added via B<Metric> blocks, see below.
1883 MCReceiveFrom "239.2.11.71" "8649"
1884 <Metric "swap_total">
1886 TypeInstance "total"
1889 <Metric "swap_free">
1896 The following metrics are built-in:
1902 load_one, load_five, load_fifteen
1906 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
1910 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
1922 Available configuration options:
1926 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
1928 Sets sets the multicast group and UDP port to which to subscribe.
1930 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
1932 =item E<lt>B<Metric> I<Name>E<gt>
1934 These blocks add a new metric conversion to the internal table. I<Name>, the
1935 string argument to the B<Metric> block, is the metric name as used by Ganglia.
1939 =item B<Type> I<Type>
1941 Type to map this metric to. Required.
1943 =item B<TypeInstance> I<Instance>
1945 Type-instance to use. Optional.
1947 =item B<DataSource> I<Name>
1949 Data source to map this metric to. If the configured type has exactly one data
1950 source, this is optional. Otherwise the option is required.
1956 =head2 Plugin C<hddtemp>
1958 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
1959 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
1960 default values, see below. C<hddtemp> has to be running to work correctly. If
1961 C<hddtemp> is not running timeouts may appear which may interfere with other
1964 The B<hddtemp> homepage can be found at
1965 L<http://www.guzu.net/linux/hddtemp.php>.
1969 =item B<Host> I<Hostname>
1971 Hostname to connect to. Defaults to B<127.0.0.1>.
1973 =item B<Port> I<Port>
1975 TCP-Port to connect to. Defaults to B<7634>.
1979 =head2 Plugin C<interface>
1983 =item B<Interface> I<Interface>
1985 Select this interface. By default these interfaces will then be collected. For
1986 a more detailed description see B<IgnoreSelected> below.
1988 =item B<IgnoreSelected> I<true>|I<false>
1990 If no configuration if given, the B<traffic>-plugin will collect data from
1991 all interfaces. This may not be practical, especially for loopback- and
1992 similar interfaces. Thus, you can use the B<Interface>-option to pick the
1993 interfaces you're interested in. Sometimes, however, it's easier/preferred
1994 to collect all interfaces I<except> a few ones. This option enables you to
1995 do that: By setting B<IgnoreSelected> to I<true> the effect of
1996 B<Interface> is inverted: All selected interfaces are ignored and all
1997 other interfaces are collected.
2001 =head2 Plugin C<ipmi>
2005 =item B<Sensor> I<Sensor>
2007 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2009 =item B<IgnoreSelected> I<true>|I<false>
2011 If no configuration if given, the B<ipmi> plugin will collect data from all
2012 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2013 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2014 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2015 all other sensors are collected.
2017 =item B<NotifySensorAdd> I<true>|I<false>
2019 If a sensor appears after initialization time of a minute a notification
2022 =item B<NotifySensorRemove> I<true>|I<false>
2024 If a sensor disappears a notification is sent.
2026 =item B<NotifySensorNotPresent> I<true>|I<false>
2028 If you have for example dual power supply and one of them is (un)plugged then
2029 a notification is sent.
2033 =head2 Plugin C<iptables>
2037 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2039 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
2040 will collect the counters of all rules which have a comment-match. The comment
2041 is then used as type-instance.
2043 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2044 the I<n>th rule will be collected. Again, the comment (or the number) will be
2045 used as the type-instance.
2047 If I<Name> is supplied, it will be used as the type-instance instead of the
2048 comment or the number.
2052 =head2 Plugin C<irq>
2058 Select this irq. By default these irqs will then be collected. For a more
2059 detailed description see B<IgnoreSelected> below.
2061 =item B<IgnoreSelected> I<true>|I<false>
2063 If no configuration if given, the B<irq>-plugin will collect data from all
2064 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2065 can use the B<Irq>-option to pick the interrupt you're interested in.
2066 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2067 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2068 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2069 and all other interrupts are collected.
2073 =head2 Plugin C<java>
2075 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2076 This section only discusses the syntax and semantic of the configuration
2077 options. For more in-depth information on the I<Java> plugin, please read
2078 L<collectd-java(5)>.
2083 JVMArg "-verbose:jni"
2084 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2085 LoadPlugin "org.collectd.java.Foobar"
2086 <Plugin "org.collectd.java.Foobar">
2087 # To be parsed by the plugin
2091 Available configuration options:
2095 =item B<JVMArg> I<Argument>
2097 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2098 exactly the way the arguments to the I<java> binary on the command line work.
2099 Execute C<javaE<nbsp>--help> for details.
2101 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2102 any other options! When another option is found, the JVM will be started and
2103 later options will have to be ignored!
2105 =item B<LoadPlugin> I<JavaClass>
2107 Instantiates a new I<JavaClass> object. The constructor of this object very
2108 likely then registers one or more callback methods with the server.
2110 See L<collectd-java(5)> for details.
2112 When the first such option is found, the virtual machine (JVM) is created. This
2113 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2114 B<LoadPlugin> options!
2116 =item B<Plugin> I<Name>
2118 The entire block is passed to the Java plugin as an
2119 I<org.collectd.api.OConfigItem> object.
2121 For this to work, the plugin has to register a configuration callback first,
2122 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2123 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2124 depends on the (Java) plugin registering the callback and is completely
2125 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2129 =head2 Plugin C<libvirt>
2131 This plugin allows CPU, disk and network load to be collected for virtualized
2132 guests on the machine. This means that these characteristics can be collected
2133 for guest systems without installing any software on them - collectd only runs
2134 on the hosting system. The statistics are collected through libvirt
2135 (L<http://libvirt.org/>).
2137 Only I<Connection> is required.
2141 =item B<Connection> I<uri>
2143 Connect to the hypervisor given by I<uri>. For example if using Xen use:
2145 Connection "xen:///"
2147 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
2149 =item B<RefreshInterval> I<seconds>
2151 Refresh the list of domains and devices every I<seconds>. The default is 60
2152 seconds. Setting this to be the same or smaller than the I<Interval> will cause
2153 the list of domains and devices to be refreshed on every iteration.
2155 Refreshing the devices in particular is quite a costly operation, so if your
2156 virtualization setup is static you might consider increasing this. If this
2157 option is set to 0, refreshing is disabled completely.
2159 =item B<Domain> I<name>
2161 =item B<BlockDevice> I<name:dev>
2163 =item B<InterfaceDevice> I<name:dev>
2165 =item B<IgnoreSelected> I<true>|I<false>
2167 Select which domains and devices are collected.
2169 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
2170 disk/network devices are collected.
2172 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
2173 domains and disk/network devices are ignored, while the rest are collected.
2175 The domain name and device names may use a regular expression, if the name is
2176 surrounded by I</.../> and collectd was compiled with support for regexps.
2178 The default is to collect statistics for all domains and all their devices.
2182 BlockDevice "/:hdb/"
2183 IgnoreSelected "true"
2185 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
2188 =item B<HostnameFormat> B<name|uuid|hostname|...>
2190 When the libvirt plugin logs data, it sets the hostname of the collected data
2191 according to this setting. The default is to use the guest name as provided by
2192 the hypervisor, which is equal to setting B<name>.
2194 B<uuid> means use the guest's UUID. This is useful if you want to track the
2195 same guest across migrations.
2197 B<hostname> means to use the global B<Hostname> setting, which is probably not
2198 useful on its own because all guests will appear to have the same name.
2200 You can also specify combinations of these fields. For example B<name uuid>
2201 means to concatenate the guest name and UUID (with a literal colon character
2202 between, thus I<"foo:1234-1234-1234-1234">).
2204 =item B<InterfaceFormat> B<name>|B<address>
2206 When the libvirt plugin logs interface data, it sets the name of the collected
2207 data according to this setting. The default is to use the path as provided by
2208 the hypervisor (the "dev" property of the target node), which is equal to
2211 B<address> means use the interface's mac address. This is useful since the
2212 interface path might change between reboots of a guest or across migrations.
2216 =head2 Plugin C<logfile>
2220 =item B<LogLevel> B<debug|info|notice|warning|err>
2222 Sets the log-level. If, for example, set to B<notice>, then all events with
2223 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2225 Please note that B<debug> is only available if collectd has been compiled with
2228 =item B<File> I<File>
2230 Sets the file to write log messages to. The special strings B<stdout> and
2231 B<stderr> can be used to write to the standard output and standard error
2232 channels, respectively. This, of course, only makes much sense when I<collectd>
2233 is running in foreground- or non-daemon-mode.
2235 =item B<Timestamp> B<true>|B<false>
2237 Prefix all lines printed by the current time. Defaults to B<true>.
2239 =item B<PrintSeverity> B<true>|B<false>
2241 When enabled, all lines are prefixed by the severity of the log message, for
2242 example "warning". Defaults to B<false>.
2246 B<Note>: There is no need to notify the daemon after moving or removing the
2247 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2248 for each line it writes.
2250 =head2 Plugin C<lpar>
2252 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2253 virtualization technique for IBM POWER processors. It takes into account CPU
2254 time stolen from or donated to a partition, in addition to the usual user,
2255 system, I/O statistics.
2257 The following configuration options are available:
2261 =item B<CpuPoolStats> B<false>|B<true>
2263 When enabled, statistics about the processor pool are read, too. The partition
2264 needs to have pool authority in order to be able to acquire this information.
2267 =item B<ReportBySerial> B<false>|B<true>
2269 If enabled, the serial of the physical machine the partition is currently
2270 running on is reported as I<hostname> and the logical hostname of the machine
2271 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2272 used (just like other plugins) and the I<plugin instance> will be empty.
2277 =head2 Plugin C<mbmon>
2279 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2281 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2282 B<Host> and B<Port> options can be used to change these values, see below.
2283 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2284 timeouts may appear which may interfere with other statistics..
2286 C<mbmon> must be run with the -r option ("print TAG and Value format");
2287 Debian's F</etc/init.d/mbmon> script already does this, other people
2288 will need to ensure that this is the case.
2292 =item B<Host> I<Hostname>
2294 Hostname to connect to. Defaults to B<127.0.0.1>.
2296 =item B<Port> I<Port>
2298 TCP-Port to connect to. Defaults to B<411>.
2304 The C<md plugin> collects information from Linux Software-RAID devices (md).
2306 All reported values are of the type C<md_disks>. Reported type instances are
2307 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2308 I<missing> (physically absent) disks.
2312 =item B<Device> I<Device>
2314 Select md devices based on device name. The I<device name> is the basename of
2315 the device, i.e. the name of the block device without the leading C</dev/>.
2316 See B<IgnoreSelected> for more details.
2318 =item B<IgnoreSelected> B<true>|B<false>
2320 Invert device selection: If set to B<true>, all md devices B<except> those
2321 listed using B<Device> are collected. If B<false> (the default), only those
2322 listed are collected. If no configuration is given, the B<md> plugin will
2323 collect data from all md devices.
2327 =head2 Plugin C<memcachec>
2329 The C<memcachec plugin> connects to a memcached server, queries one or more
2330 given I<pages> and parses the returned data according to user specification.
2331 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2334 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2335 library. Please note that there is another library with a very similar name,
2336 libmemcache (notice the missing `d'), which is not applicable.
2338 Synopsis of the configuration:
2340 <Plugin "memcachec">
2341 <Page "plugin_instance">
2345 Regex "(\\d+) bytes sent"
2348 Instance "type_instance"
2353 The configuration options are:
2357 =item E<lt>B<Page> I<Name>E<gt>
2359 Each B<Page> block defines one I<page> to be queried from the memcached server.
2360 The block requires one string argument which is used as I<plugin instance>.
2362 =item B<Server> I<Address>
2364 Sets the server address to connect to when querying the page. Must be inside a
2369 When connected to the memcached server, asks for the page I<Key>.
2371 =item E<lt>B<Match>E<gt>
2373 Match blocks define which strings to look for and how matches substrings are
2374 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2378 =head2 Plugin C<memcached>
2380 The B<memcached plugin> connects to a memcached server and queries statistics
2381 about cache utilization, memory and bandwidth used.
2382 L<http://www.danga.com/memcached/>
2384 <Plugin "memcached">
2386 Host "memcache.example.com"
2391 The plugin configuration consists of one or more B<Instance> blocks which
2392 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2393 following options are allowed:
2397 =item B<Host> I<Hostname>
2399 Hostname to connect to. Defaults to B<127.0.0.1>.
2401 =item B<Port> I<Port>
2403 TCP-Port to connect to. Defaults to B<11211>.
2405 =item B<Socket> I<Path>
2407 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2408 setting is given, the B<Host> and B<Port> settings are ignored.
2412 =head2 Plugin C<mic>
2414 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2415 Intel's Many Integrated Core (MIC) systems.
2424 ShowTemperatures true
2427 IgnoreSelectedTemperature true
2432 IgnoreSelectedPower true
2435 The following options are valid inside the B<PluginE<nbsp>mic> block:
2439 =item B<ShowCPU> B<true>|B<false>
2441 If enabled (the default) a sum of the CPU usage accross all cores is reported.
2443 =item B<ShowCPUCores> B<true>|B<false>
2445 If enabled (the default) per-core CPU usage is reported.
2447 =item B<ShowMemory> B<true>|B<false>
2449 If enabled (the default) the physical memory usage of the MIC system is
2452 =item B<ShowTemperatures> B<true>|B<false>
2454 If enabled (the default) various temperatures of the MIC system are reported.
2456 =item B<Temperature> I<Name>
2458 This option controls which temperatures are being reported. Whether matching
2459 temperatures are being ignored or I<only> matching temperatures are reported
2460 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2461 temperatures are reported.
2463 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2465 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2466 (the default) only temperatures matching a B<Temperature> option are reported
2467 or, if no B<Temperature> option is specified, all temperatures are reported. If
2468 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2471 Known temperature names are:
2505 =item B<ShowPower> B<true>|B<false>
2507 If enabled (the default) various temperatures of the MIC system are reported.
2509 =item B<Power> I<Name>
2511 This option controls which power readings are being reported. Whether matching
2512 power readings are being ignored or I<only> matching power readings are reported
2513 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
2514 power readings are reported.
2516 =item B<IgnoreSelectedPower> B<false>|B<true>
2518 Controls the behavior of the B<Power> setting above. If set to B<false>
2519 (the default) only power readings matching a B<Power> option are reported
2520 or, if no B<Power> option is specified, all power readings are reported. If
2521 set to B<true>, matching power readings are I<ignored> and all other power readings
2524 Known power names are:
2530 Total power utilization averaged over Time Window 0 (uWatts).
2534 Total power utilization averaged over Time Window 0 (uWatts).
2538 Instantaneous power (uWatts).
2542 Max instantaneous power (uWatts).
2546 PCI-E connector power (uWatts).
2550 2x3 connector power (uWatts).
2554 2x4 connector power (uWatts).
2562 Uncore rail (uVolts).
2566 Memory subsystem rail (uVolts).
2572 =head2 Plugin C<modbus>
2574 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
2575 register values. It supports reading single registers (unsigned 16E<nbsp>bit
2576 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2577 values (two registers interpreted as IEEE floats in big endian notation).
2581 <Data "voltage-input-1">
2588 <Data "voltage-input-2">
2595 <Host "modbus.example.com">
2596 Address "192.168.0.42"
2601 Instance "power-supply"
2602 Collect "voltage-input-1"
2603 Collect "voltage-input-2"
2609 =item E<lt>B<Data> I<Name>E<gt> blocks
2611 Data blocks define a mapping between register numbers and the "types" used by
2614 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
2618 =item B<RegisterBase> I<Number>
2620 Configures the base register to read from the device. If the option
2621 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
2622 register will be read (the register number is increased by one).
2624 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
2626 Specifies what kind of data is returned by the device. If the type is B<Int32>,
2627 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
2628 combined into one value. Defaults to B<Uint16>.
2630 =item B<Type> I<Type>
2632 Specifies the "type" (data set) to use when dispatching the value to
2633 I<collectd>. Currently, only data sets with exactly one data source are
2636 =item B<Instance> I<Instance>
2638 Sets the type instance to use when dispatching the value to I<collectd>. If
2639 unset, an empty string (no type instance) is used.
2643 =item E<lt>B<Host> I<Name>E<gt> blocks
2645 Host blocks are used to specify to which hosts to connect and what data to read
2646 from their "slaves". The string argument I<Name> is used as hostname when
2647 dispatching the values to I<collectd>.
2649 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
2653 =item B<Address> I<Hostname>
2655 Specifies the node name (the actual network address) used to connect to the
2656 host. This may be an IP address or a hostname. Please note that the used
2657 I<libmodbus> library only supports IPv4 at the moment.
2659 =item B<Port> I<Service>
2661 Specifies the port used to connect to the host. The port can either be given as
2662 a number or as a service name. Please note that the I<Service> argument must be
2663 a string, even if ports are given in their numerical form. Defaults to "502".
2665 =item B<Interval> I<Interval>
2667 Sets the interval (in seconds) in which the values will be collected from this
2668 host. By default the global B<Interval> setting will be used.
2670 =item E<lt>B<Slave> I<ID>E<gt>
2672 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
2673 is used to specify which device should be addressed. For each device you want
2674 to query, one B<Slave> block must be given.
2676 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
2680 =item B<Instance> I<Instance>
2682 Specify the plugin instance to use when dispatching the values to I<collectd>.
2683 By default "slave_I<ID>" is used.
2685 =item B<Collect> I<DataName>
2687 Specifies which data to retrieve from the device. I<DataName> must be the same
2688 string as the I<Name> argument passed to a B<Data> block. You can specify this
2689 option multiple times to collect more than one value from a slave. At least one
2690 B<Collect> option is mandatory.
2698 =head2 Plugin C<mysql>
2700 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
2701 one or more databases when started and keeps the connection up as long as
2702 possible. When the connection is interrupted for whatever reason it will try
2703 to re-connect. The plugin will complain loudly in case anything goes wrong.
2705 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
2706 and collects information about MySQL network traffic, executed statements,
2707 requests, the query cache and threads by evaluating the
2708 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
2709 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
2710 Status Variables> for an explanation of these values.
2712 Optionally, master and slave statistics may be collected in a MySQL
2713 replication setup. In that case, information about the synchronization state
2714 of the nodes are collected by evaluating the C<Position> return value of the
2715 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
2716 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
2717 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
2718 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
2719 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
2734 Socket "/var/run/mysql/mysqld.sock"
2736 SlaveNotifications true
2740 A B<Database> block defines one connection to a MySQL database. It accepts a
2741 single argument which specifies the name of the database. None of the other
2742 options are required. MySQL will use default values as documented in the
2743 section "mysql_real_connect()" in the B<MySQL reference manual>.
2747 =item B<Host> I<Hostname>
2749 Hostname of the database server. Defaults to B<localhost>.
2751 =item B<User> I<Username>
2753 Username to use when connecting to the database. The user does not have to be
2754 granted any privileges (which is synonym to granting the C<USAGE> privilege),
2755 unless you want to collectd replication statistics (see B<MasterStats> and
2756 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
2757 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
2759 =item B<Password> I<Password>
2761 Password needed to log into the database.
2763 =item B<Database> I<Database>
2765 Select this database. Defaults to I<no database> which is a perfectly reasonable
2766 option for what this plugin does.
2768 =item B<Port> I<Port>
2770 TCP-port to connect to. The port must be specified in its numeric form, but it
2771 must be passed as a string nonetheless. For example:
2775 If B<Host> is set to B<localhost> (the default), this setting has no effect.
2776 See the documentation for the C<mysql_real_connect> function for details.
2778 =item B<Socket> I<Socket>
2780 Specifies the path to the UNIX domain socket of the MySQL server. This option
2781 only has any effect, if B<Host> is set to B<localhost> (the default).
2782 Otherwise, use the B<Port> option above. See the documentation for the
2783 C<mysql_real_connect> function for details.
2785 =item B<MasterStats> I<true|false>
2787 =item B<SlaveStats> I<true|false>
2789 Enable the collection of master / slave statistics in a replication setup. In
2790 order to be able to get access to these statistics, the user needs special
2791 privileges. See the B<User> documentation above.
2793 =item B<SlaveNotifications> I<true|false>
2795 If enabled, the plugin sends a notification if the replication slave I/O and /
2796 or SQL threads are not running.
2800 =head2 Plugin C<netapp>
2802 The netapp plugin can collect various performance and capacity information
2803 from a NetApp filer using the NetApp API.
2805 Please note that NetApp has a wide line of products and a lot of different
2806 software versions for each of these products. This plugin was developed for a
2807 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
2808 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
2809 model and software version but it is very hard to test this.
2810 If you have used this plugin with other models and/or software version, feel
2811 free to send us a mail to tell us about the results, even if it's just a short
2814 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
2815 basic authentication.
2817 B<Do not use a regular user for this!> Create a special collectd user with just
2818 the minimum of capabilities needed. The user only needs the "login-http-admin"
2819 capability as well as a few more depending on which data will be collected.
2820 Required capabilities are documented below.
2825 <Host "netapp1.example.com">
2849 IgnoreSelectedIO false
2851 IgnoreSelectedOps false
2852 GetLatency "volume0"
2853 IgnoreSelectedLatency false
2860 IgnoreSelectedCapacity false
2863 IgnoreSelectedSnapshot false
2891 The netapp plugin accepts the following configuration options:
2895 =item B<Host> I<Name>
2897 A host block defines one NetApp filer. It will appear in collectd with the name
2898 you specify here which does not have to be its real name nor its hostname (see
2899 the B<Address> option below).
2901 =item B<VFiler> I<Name>
2903 A B<VFiler> block may only be used inside a host block. It accepts all the
2904 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
2905 will execute all NetApp API commands in the context of the specified
2906 VFiler(R). It will appear in collectd with the name you specify here which
2907 does not have to be its real name. The VFiler name may be specified using the
2908 B<VFilerName> option. If this is not specified, it will default to the name
2911 The VFiler block inherits all connection related settings from the surrounding
2912 B<Host> block (which appear before the B<VFiler> block) but they may be
2913 overwritten inside the B<VFiler> block.
2915 This feature is useful, for example, when using a VFiler as SnapVault target
2916 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
2917 available in the host filer (vfiler0) but only in the respective VFiler
2920 =item B<Protocol> B<httpd>|B<http>
2922 The protocol collectd will use to query this host.
2930 Valid options: http, https
2932 =item B<Address> I<Address>
2934 The hostname or IP address of the host.
2940 Default: The "host" block's name.
2942 =item B<Port> I<Port>
2944 The TCP port to connect to on the host.
2950 Default: 80 for protocol "http", 443 for protocol "https"
2952 =item B<User> I<User>
2954 =item B<Password> I<Password>
2956 The username and password to use to login to the NetApp.
2962 =item B<VFilerName> I<Name>
2964 The name of the VFiler in which context to execute API commands. If not
2965 specified, the name provided to the B<VFiler> block will be used instead.
2971 Default: name of the B<VFiler> block
2973 B<Note:> This option may only be used inside B<VFiler> blocks.
2975 =item B<Interval> I<Interval>
2981 The following options decide what kind of data will be collected. You can
2982 either use them as a block and fine tune various parameters inside this block,
2983 use them as a single statement to just accept all default values, or omit it to
2984 not collect any data.
2986 The following options are valid inside all blocks:
2990 =item B<Interval> I<Seconds>
2992 Collect the respective statistics every I<Seconds> seconds. Defaults to the
2993 host specific setting.
2997 =head3 The System block
2999 This will collect various performance data about the whole system.
3001 B<Note:> To get this data the collectd user needs the
3002 "api-perf-object-get-instances" capability.
3006 =item B<Interval> I<Seconds>
3008 Collect disk statistics every I<Seconds> seconds.
3010 =item B<GetCPULoad> B<true>|B<false>
3012 If you set this option to true the current CPU usage will be read. This will be
3013 the average usage between all CPUs in your NetApp without any information about
3016 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3017 returns in the "CPU" field.
3025 Result: Two value lists of type "cpu", and type instances "idle" and "system".
3027 =item B<GetInterfaces> B<true>|B<false>
3029 If you set this option to true the current traffic of the network interfaces
3030 will be read. This will be the total traffic over all interfaces of your NetApp
3031 without any information about individual interfaces.
3033 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3034 in the "Net kB/s" field.
3044 Result: One value list of type "if_octects".
3046 =item B<GetDiskIO> B<true>|B<false>
3048 If you set this option to true the current IO throughput will be read. This
3049 will be the total IO of your NetApp without any information about individual
3050 disks, volumes or aggregates.
3052 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3053 in the "DiskE<nbsp>kB/s" field.
3061 Result: One value list of type "disk_octets".
3063 =item B<GetDiskOps> B<true>|B<false>
3065 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
3066 iSCSI, etc. operations will be read. This will be the total number of
3067 operations on your NetApp without any information about individual volumes or
3070 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3071 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
3079 Result: A variable number of value lists of type "disk_ops_complex". Each type
3080 of operation will result in one value list with the name of the operation as
3085 =head3 The WAFL block
3087 This will collect various performance data about the WAFL file system. At the
3088 moment this just means cache performance.
3090 B<Note:> To get this data the collectd user needs the
3091 "api-perf-object-get-instances" capability.
3093 B<Note:> The interface to get these values is classified as "Diagnostics" by
3094 NetApp. This means that it is not guaranteed to be stable even between minor
3099 =item B<Interval> I<Seconds>
3101 Collect disk statistics every I<Seconds> seconds.
3103 =item B<GetNameCache> B<true>|B<false>
3111 Result: One value list of type "cache_ratio" and type instance
3114 =item B<GetDirCache> B<true>|B<false>
3122 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3124 =item B<GetInodeCache> B<true>|B<false>
3132 Result: One value list of type "cache_ratio" and type instance
3135 =item B<GetBufferCache> B<true>|B<false>
3137 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3138 in the "Cache hit" field.
3146 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3150 =head3 The Disks block
3152 This will collect performance data about the individual disks in the NetApp.
3154 B<Note:> To get this data the collectd user needs the
3155 "api-perf-object-get-instances" capability.
3159 =item B<Interval> I<Seconds>
3161 Collect disk statistics every I<Seconds> seconds.
3163 =item B<GetBusy> B<true>|B<false>
3165 If you set this option to true the busy time of all disks will be calculated
3166 and the value of the busiest disk in the system will be written.
3168 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3169 in the "Disk util" field. Probably.
3177 Result: One value list of type "percent" and type instance "disk_busy".
3181 =head3 The VolumePerf block
3183 This will collect various performance data about the individual volumes.
3185 You can select which data to collect about which volume using the following
3186 options. They follow the standard ignorelist semantic.
3188 B<Note:> To get this data the collectd user needs the
3189 I<api-perf-object-get-instances> capability.
3193 =item B<Interval> I<Seconds>
3195 Collect volume performance data every I<Seconds> seconds.
3197 =item B<GetIO> I<Volume>
3199 =item B<GetOps> I<Volume>
3201 =item B<GetLatency> I<Volume>
3203 Select the given volume for IO, operations or latency statistics collection.
3204 The argument is the name of the volume without the C</vol/> prefix.
3206 Since the standard ignorelist functionality is used here, you can use a string
3207 starting and ending with a slash to specify regular expression matching: To
3208 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3211 GetIO "/^vol[027]$/"
3213 If no regular expression is specified, an exact match is required. Both,
3214 regular and exact matching are case sensitive.
3216 If no volume was specified at all for either of the three options, that data
3217 will be collected for all available volumes.
3219 =item B<IgnoreSelectedIO> B<true>|B<false>
3221 =item B<IgnoreSelectedOps> B<true>|B<false>
3223 =item B<IgnoreSelectedLatency> B<true>|B<false>
3225 When set to B<true>, the volumes selected for IO, operations or latency
3226 statistics collection will be ignored and the data will be collected for all
3229 When set to B<false>, data will only be collected for the specified volumes and
3230 all other volumes will be ignored.
3232 If no volumes have been specified with the above B<Get*> options, all volumes
3233 will be collected regardless of the B<IgnoreSelected*> option.
3235 Defaults to B<false>
3239 =head3 The VolumeUsage block
3241 This will collect capacity data about the individual volumes.
3243 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3248 =item B<Interval> I<Seconds>
3250 Collect volume usage statistics every I<Seconds> seconds.
3252 =item B<GetCapacity> I<VolumeName>
3254 The current capacity of the volume will be collected. This will result in two
3255 to four value lists, depending on the configuration of the volume. All data
3256 sources are of type "df_complex" with the name of the volume as
3259 There will be type_instances "used" and "free" for the number of used and
3260 available bytes on the volume. If the volume has some space reserved for
3261 snapshots, a type_instance "snap_reserved" will be available. If the volume
3262 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3263 number of bytes saved by the SIS feature.
3265 B<Note:> The current NetApp API has a bug that results in this value being
3266 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3267 number which works most of the time. If you see strange values here, bug
3268 NetApp support to fix this.
3270 Repeat this option to specify multiple volumes.
3272 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3274 Specify whether to collect only the volumes selected by the B<GetCapacity>
3275 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3276 B<false>. However, if no B<GetCapacity> option is specified at all, all
3277 capacities will be selected anyway.
3279 =item B<GetSnapshot> I<VolumeName>
3281 Select volumes from which to collect snapshot information.
3283 Usually, the space used for snapshots is included in the space reported as
3284 "used". If snapshot information is collected as well, the space used for
3285 snapshots is subtracted from the used space.
3287 To make things even more interesting, it is possible to reserve space to be
3288 used for snapshots. If the space required for snapshots is less than that
3289 reserved space, there is "reserved free" and "reserved used" space in addition
3290 to "free" and "used". If the space required for snapshots exceeds the reserved
3291 space, that part allocated in the normal space is subtracted from the "used"
3294 Repeat this option to specify multiple volumes.
3296 =item B<IgnoreSelectedSnapshot>
3298 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3299 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3300 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3301 capacities will be selected anyway.
3305 =head3 The Quota block
3307 This will collect (tree) quota statistics (used disk space and number of used
3308 files). This mechanism is useful to get usage information for single qtrees.
3309 In case the quotas are not used for any other purpose, an entry similar to the
3310 following in C</etc/quotas> would be sufficient:
3312 /vol/volA/some_qtree tree - - - - -
3314 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3318 =item B<Interval> I<Seconds>
3320 Collect SnapVault(R) statistics every I<Seconds> seconds.
3324 =head3 The SnapVault block
3326 This will collect statistics about the time and traffic of SnapVault(R)
3331 =item B<Interval> I<Seconds>
3333 Collect SnapVault(R) statistics every I<Seconds> seconds.
3337 =head2 Plugin C<netlink>
3339 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3340 statistics of various interface and routing aspects.
3344 =item B<Interface> I<Interface>
3346 =item B<VerboseInterface> I<Interface>
3348 Instruct the plugin to collect interface statistics. This is basically the same
3349 as the statistics provided by the C<interface> plugin (see above) but
3350 potentially much more detailed.
3352 When configuring with B<Interface> only the basic statistics will be collected,
3353 namely octets, packets, and errors. These statistics are collected by
3354 the C<interface> plugin, too, so using both at the same time is no benefit.
3356 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3357 so that no data needs to be collected twice if you use the C<interface> plugin.
3358 This includes dropped packets, received multicast packets, collisions and a
3359 whole zoo of differentiated RX and TX errors. You can try the following command
3360 to get an idea of what awaits you:
3364 If I<Interface> is B<All>, all interfaces will be selected.
3366 =item B<QDisc> I<Interface> [I<QDisc>]
3368 =item B<Class> I<Interface> [I<Class>]
3370 =item B<Filter> I<Interface> [I<Filter>]
3372 Collect the octets and packets that pass a certain qdisc, class or filter.
3374 QDiscs and classes are identified by their type and handle (or classid).
3375 Filters don't necessarily have a handle, therefore the parent's handle is used.
3376 The notation used in collectd differs from that used in tc(1) in that it
3377 doesn't skip the major or minor number if it's zero and doesn't print special
3378 ids by their name. So, for example, a qdisc may be identified by
3379 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3380 thus not displayed by tc(1).
3382 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3383 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3384 associated with that interface will be collected.
3386 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3387 used. This may lead to problems when more than one filter is attached to a
3388 qdisc or class. This isn't nice, but we don't know how this could be done any
3389 better. If you have a idea, please don't hesitate to tell us.
3391 As with the B<Interface> option you can specify B<All> as the interface,
3392 meaning all interfaces.
3394 Here are some examples to help you understand the above text more easily:
3397 VerboseInterface "All"
3398 QDisc "eth0" "pfifo_fast-1:0"
3400 Class "ppp0" "htb-1:10"
3401 Filter "ppp0" "u32-1:0"
3404 =item B<IgnoreSelected>
3406 The behavior is the same as with all other similar plugins: If nothing is
3407 selected at all, everything is collected. If some things are selected using the
3408 options described above, only these statistics are collected. If you set
3409 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3410 specified statistics will not be collected.
3414 =head2 Plugin C<network>
3416 The Network plugin sends data to a remote instance of collectd, receives data
3417 from a remote instance, or both at the same time. Data which has been received
3418 from the network is usually not transmitted again, but this can be activated, see
3419 the B<Forward> option below.
3421 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3422 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3424 Both, B<Server> and B<Listen> can be used as single option or as block. When
3425 used as block, given options are valid for this socket only. The following
3426 example will export the metrics twice: Once to an "internal" server (without
3427 encryption and signing) and one to an external server (with cryptographic
3431 # Export to an internal server
3432 # (demonstrates usage without additional options)
3433 Server "collectd.internal.tld"
3435 # Export to an external server
3436 # (demonstrates usage with signature options)
3437 <Server "collectd.external.tld">
3438 SecurityLevel "sign"
3439 Username "myhostname"
3446 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3448 The B<Server> statement/block sets the server to send datagrams to. The
3449 statement may occur multiple times to send each datagram to multiple
3452 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3453 optional second argument specifies a port number or a service name. If not
3454 given, the default, B<25826>, is used.
3456 The following options are recognized within B<Server> blocks:
3460 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3462 Set the security you require for network communication. When the security level
3463 has been set to B<Encrypt>, data sent over the network will be encrypted using
3464 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3465 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3466 authentication code. When set to B<None>, data is sent without any security.
3468 This feature is only available if the I<network> plugin was linked with
3471 =item B<Username> I<Username>
3473 Sets the username to transmit. This is used by the server to lookup the
3474 password. See B<AuthFile> below. All security levels except B<None> require
3477 This feature is only available if the I<network> plugin was linked with
3480 =item B<Password> I<Password>
3482 Sets a password (shared secret) for this socket. All security levels except
3483 B<None> require this setting.
3485 This feature is only available if the I<network> plugin was linked with
3488 =item B<Interface> I<Interface name>
3490 Set the outgoing interface for IP packets. This applies at least
3491 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3492 undefined or a non-existent interface name is specified, the default
3493 behavior is to let the kernel choose the appropriate interface. Be warned
3494 that the manual selection of an interface for unicast traffic is only
3495 necessary in rare cases.
3499 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
3501 The B<Listen> statement sets the interfaces to bind to. When multiple
3502 statements are found the daemon will bind to multiple interfaces.
3504 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
3505 the argument is a multicast address the daemon will join that multicast group.
3506 The optional second argument specifies a port number or a service name. If not
3507 given, the default, B<25826>, is used.
3509 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
3513 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3515 Set the security you require for network communication. When the security level
3516 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
3517 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
3518 signed and encrypted data is accepted. When set to B<None>, all data will be
3519 accepted. If an B<AuthFile> option was given (see below), encrypted data is
3520 decrypted if possible.
3522 This feature is only available if the I<network> plugin was linked with
3525 =item B<AuthFile> I<Filename>
3527 Sets a file in which usernames are mapped to passwords. These passwords are
3528 used to verify signatures and to decrypt encrypted network packets. If
3529 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
3530 verified and encrypted packets are decrypted. Otherwise, signed data is
3531 accepted without checking the signature and encrypted data cannot be decrypted.
3532 For the other security levels this option is mandatory.
3534 The file format is very simple: Each line consists of a username followed by a
3535 colon and any number of spaces followed by the password. To demonstrate, an
3536 example file could look like this:
3541 Each time a packet is received, the modification time of the file is checked
3542 using L<stat(2)>. If the file has been changed, the contents is re-read. While
3543 the file is being read, it is locked using L<fcntl(2)>.
3545 =item B<Interface> I<Interface name>
3547 Set the incoming interface for IP packets explicitly. This applies at least
3548 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3549 undefined or a non-existent interface name is specified, the default
3550 behavior is, to let the kernel choose the appropriate interface. Thus incoming
3551 traffic gets only accepted, if it arrives on the given interface.
3555 =item B<TimeToLive> I<1-255>
3557 Set the time-to-live of sent packets. This applies to all, unicast and
3558 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
3559 That means that multicast packets will be sent with a TTL of C<1> (one) on most
3562 =item B<MaxPacketSize> I<1024-65535>
3564 Set the maximum size for datagrams received over the network. Packets larger
3565 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
3566 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
3569 On the server side, this limit should be set to the largest value used on
3570 I<any> client. Likewise, the value on the client must not be larger than the
3571 value on the server, or data will be lost.
3573 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
3574 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
3575 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
3578 =item B<Forward> I<true|false>
3580 If set to I<true>, write packets that were received via the network plugin to
3581 the sending sockets. This should only be activated when the B<Listen>- and
3582 B<Server>-statements differ. Otherwise packets may be send multiple times to
3583 the same multicast group. While this results in more network traffic than
3584 necessary it's not a huge problem since the plugin has a duplicate detection,
3585 so the values will not loop.
3587 =item B<ReportStats> B<true>|B<false>
3589 The network plugin cannot only receive and send statistics, it can also create
3590 statistics about itself. Collected data included the number of received and
3591 sent octets and packets, the length of the receive queue and the number of
3592 values handled. When set to B<true>, the I<Network plugin> will make these
3593 statistics available. Defaults to B<false>.
3597 =head2 Plugin C<nginx>
3599 This plugin collects the number of connections and requests handled by the
3600 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
3601 queries the page provided by the C<ngx_http_stub_status_module> module, which
3602 isn't compiled by default. Please refer to
3603 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
3604 how to compile and configure nginx and this module.
3606 The following options are accepted by the C<nginx plugin>:
3610 =item B<URL> I<http://host/nginx_status>
3612 Sets the URL of the C<ngx_http_stub_status_module> output.
3614 =item B<User> I<Username>
3616 Optional user name needed for authentication.
3618 =item B<Password> I<Password>
3620 Optional password needed for authentication.
3622 =item B<VerifyPeer> B<true|false>
3624 Enable or disable peer SSL certificate verification. See
3625 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
3627 =item B<VerifyHost> B<true|false>
3629 Enable or disable peer host name verification. If enabled, the plugin checks
3630 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
3631 certificate matches the host name provided by the B<URL> option. If this
3632 identity check fails, the connection is aborted. Obviously, only works when
3633 connecting to a SSL enabled server. Enabled by default.
3635 =item B<CACert> I<File>
3637 File that holds one or more SSL certificates. If you want to use HTTPS you will
3638 possibly need this option. What CA certificates come bundled with C<libcurl>
3639 and are checked by default depends on the distribution you use.
3643 =head2 Plugin C<notify_desktop>
3645 This plugin sends a desktop notification to a notification daemon, as defined
3646 in the Desktop Notification Specification. To actually display the
3647 notifications, B<notification-daemon> is required and B<collectd> has to be
3648 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
3649 environment variables have to be set correctly) and the D-Bus message bus.
3651 The Desktop Notification Specification can be found at
3652 L<http://www.galago-project.org/specs/notification/>.
3656 =item B<OkayTimeout> I<timeout>
3658 =item B<WarningTimeout> I<timeout>
3660 =item B<FailureTimeout> I<timeout>
3662 Set the I<timeout>, in milliseconds, after which to expire the notification
3663 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
3664 been specified, the displayed notification will not be closed at all - the
3665 user has to do so herself. These options default to 5000. If a negative number
3666 has been specified, the default is used as well.
3670 =head2 Plugin C<notify_email>
3672 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
3673 configured email address.
3675 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
3677 Available configuration options:
3681 =item B<From> I<Address>
3683 Email address from which the emails should appear to come from.
3685 Default: C<root@localhost>
3687 =item B<Recipient> I<Address>
3689 Configures the email address(es) to which the notifications should be mailed.
3690 May be repeated to send notifications to multiple addresses.
3692 At least one B<Recipient> must be present for the plugin to work correctly.
3694 =item B<SMTPServer> I<Hostname>
3696 Hostname of the SMTP server to connect to.
3698 Default: C<localhost>
3700 =item B<SMTPPort> I<Port>
3702 TCP port to connect to.
3706 =item B<SMTPUser> I<Username>
3708 Username for ASMTP authentication. Optional.
3710 =item B<SMTPPassword> I<Password>
3712 Password for ASMTP authentication. Optional.
3714 =item B<Subject> I<Subject>
3716 Subject-template to use when sending emails. There must be exactly two
3717 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
3718 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
3721 Default: C<Collectd notify: %s@%s>
3725 =head2 Plugin C<ntpd>
3729 =item B<Host> I<Hostname>
3731 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
3733 =item B<Port> I<Port>
3735 UDP-Port to connect to. Defaults to B<123>.
3737 =item B<ReverseLookups> B<true>|B<false>
3739 Sets whether or not to perform reverse lookups on peers. Since the name or
3740 IP-address may be used in a filename it is recommended to disable reverse
3741 lookups. The default is to do reverse lookups to preserve backwards
3742 compatibility, though.
3744 =item B<IncludeUnitID> B<true>|B<false>
3746 When a peer is a refclock, include the unit ID in the I<type instance>.
3747 Defaults to B<false> for backward compatibility.
3749 If two refclock peers use the same driver and this is B<false>, the plugin will
3750 try to write simultaneous measurements from both to the same type instance.
3751 This will result in error messages in the log and only one set of measurements
3756 =head2 Plugin C<nut>
3760 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
3762 Add a UPS to collect data from. The format is identical to the one accepted by
3767 =head2 Plugin C<olsrd>
3769 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
3770 the Optimized Link State Routing daemon and reads information about the current
3771 state of the meshed network.
3773 The following configuration options are understood:
3777 =item B<Host> I<Host>
3779 Connect to I<Host>. Defaults to B<"localhost">.
3781 =item B<Port> I<Port>
3783 Specifies the port to connect to. This must be a string, even if you give the
3784 port as a number rather than a service name. Defaults to B<"2006">.
3786 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
3788 Specifies what information to collect about links, i.E<nbsp>e. direct
3789 connections of the daemon queried. If set to B<No>, no information is
3790 collected. If set to B<Summary>, the number of links and the average of all
3791 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
3792 If set to B<Detail> LQ and NLQ are collected per link.
3794 Defaults to B<Detail>.
3796 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
3798 Specifies what information to collect about routes of the daemon queried. If
3799 set to B<No>, no information is collected. If set to B<Summary>, the number of
3800 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
3801 metric and ETX are collected per route.
3803 Defaults to B<Summary>.
3805 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
3807 Specifies what information to collect about the global topology. If set to
3808 B<No>, no information is collected. If set to B<Summary>, the number of links
3809 in the entire topology and the average I<link quality> (LQ) is calculated.
3810 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
3812 Defaults to B<Summary>.
3816 =head2 Plugin C<onewire>
3818 B<EXPERIMENTAL!> See notes below.
3820 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
3821 L<http://owfs.org/> to read sensors connected via the onewire bus.
3823 Currently only temperature sensors (sensors with the family code C<10>,
3824 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
3825 would like to have included, please send a sort request to the mailing list.
3827 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
3828 experimental, below.
3832 =item B<Device> I<Device>
3834 Sets the device to read the values from. This can either be a "real" hardware
3835 device, such as a serial port or an USB port, or the address of the
3836 L<owserver(1)> socket, usually B<localhost:4304>.
3838 Though the documentation claims to automatically recognize the given address
3839 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
3840 with that version, the following configuration worked for us:
3843 Device "-s localhost:4304"
3846 This directive is B<required> and does not have a default value.
3848 =item B<Sensor> I<Sensor>
3850 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
3851 below. Sensors are specified without the family byte at the beginning, to you'd
3852 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
3855 =item B<IgnoreSelected> I<true>|I<false>
3857 If no configuration if given, the B<onewire> plugin will collect data from all
3858 sensors found. This may not be practical, especially if sensors are added and
3859 removed regularly. Sometimes, however, it's easier/preferred to collect only
3860 specific sensors or all sensors I<except> a few specified ones. This option
3861 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
3862 B<Sensor> is inverted: All selected interfaces are ignored and all other
3863 interfaces are collected.
3865 =item B<Interval> I<Seconds>
3867 Sets the interval in which all sensors should be read. If not specified, the
3868 global B<Interval> setting is used.
3872 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
3873 work with big setups. It works with one sensor being attached to one
3874 controller, but as soon as you throw in a couple more senors and maybe a hub
3875 or two, reading all values will take more than ten seconds (the default
3876 interval). We will probably add some separate thread for reading the sensors
3877 and some cache or something like that, but it's not done yet. We will try to
3878 maintain backwards compatibility in the future, but we can't promise. So in
3879 short: If it works for you: Great! But keep in mind that the config I<might>
3880 change, though this is unlikely. Oh, and if you want to help improving this
3881 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
3883 =head2 Plugin C<openvpn>
3885 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
3886 traffic statistics about connected clients.
3888 To set up OpenVPN to write to the status file periodically, use the
3889 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
3890 you need to set the required format, too. This is done by setting
3891 B<--status-version> to B<2>.
3893 So, in a nutshell you need:
3895 openvpn $OTHER_OPTIONS \
3896 --status "/var/run/openvpn-status" 10 \
3903 =item B<StatusFile> I<File>
3905 Specifies the location of the status file.
3907 =item B<ImprovedNamingSchema> B<true>|B<false>
3909 When enabled, the filename of the status file will be used as plugin instance
3910 and the client's "common name" will be used as type instance. This is required
3911 when reading multiple status files. Enabling this option is recommended, but to
3912 maintain backwards compatibility this option is disabled by default.
3914 =item B<CollectCompression> B<true>|B<false>
3916 Sets whether or not statistics about the compression used by OpenVPN should be
3917 collected. This information is only available in I<single> mode. Enabled by
3920 =item B<CollectIndividualUsers> B<true>|B<false>
3922 Sets whether or not traffic information is collected for each connected client
3923 individually. If set to false, currently no traffic data is collected at all
3924 because aggregating this data in a save manner is tricky. Defaults to B<true>.
3926 =item B<CollectUserCount> B<true>|B<false>
3928 When enabled, the number of currently connected clients or users is collected.
3929 This is especially interesting when B<CollectIndividualUsers> is disabled, but
3930 can be configured independently from that option. Defaults to B<false>.
3934 =head2 Plugin C<oracle>
3936 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
3937 Oracle® Database and lets you execute SQL statements there. It is very similar
3938 to the "dbi" plugin, because it was written around the same time. See the "dbi"
3939 plugin's documentation above for details.
3942 <Query "out_of_stock">
3943 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
3946 # InstancePrefix "foo"
3947 InstancesFrom "category"
3951 <Database "product_information">
3955 Query "out_of_stock"
3959 =head3 B<Query> blocks
3961 The Query blocks are handled identically to the Query blocks of the "dbi"
3962 plugin. Please see its documentation above for details on how to specify
3965 =head3 B<Database> blocks
3967 Database blocks define a connection to a database and which queries should be
3968 sent to that database. Each database needs a "name" as string argument in the
3969 starting tag of the block. This name will be used as "PluginInstance" in the
3970 values submitted to the daemon. Other than that, that name is not used.
3974 =item B<ConnectID> I<ID>
3976 Defines the "database alias" or "service name" to connect to. Usually, these
3977 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
3979 =item B<Host> I<Host>
3981 Hostname to use when dispatching values for this database. Defaults to using
3982 the global hostname of the I<collectd> instance.
3984 =item B<Username> I<Username>
3986 Username used for authentication.
3988 =item B<Password> I<Password>
3990 Password used for authentication.
3992 =item B<Query> I<QueryName>
3994 Associates the query named I<QueryName> with this database connection. The
3995 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
3996 blocks you want to refer to must be placed above the database block you want to
4001 =head2 Plugin C<perl>
4003 This plugin embeds a Perl-interpreter into collectd and provides an interface
4004 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
4006 =head2 Plugin C<pinba>
4008 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
4009 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
4010 PHP-based webpage has been delivered, the extension will send a UDP packet
4011 containing timing information, peak memory usage and so on. The plugin will
4012 wait for such packets, parse them and account the provided information, which
4013 is then dispatched to the daemon once per interval.
4020 # Overall statistics for the website.
4022 Server "www.example.com"
4024 # Statistics for www-a only
4026 Host "www-a.example.com"
4027 Server "www.example.com"
4029 # Statistics for www-b only
4031 Host "www-b.example.com"
4032 Server "www.example.com"
4036 The plugin provides the following configuration options:
4040 =item B<Address> I<Node>
4042 Configures the address used to open a listening socket. By default, plugin will
4043 bind to the I<any> address C<::0>.
4045 =item B<Port> I<Service>
4047 Configures the port (service) to bind to. By default the default Pinba port
4048 "30002" will be used. The option accepts service names in addition to port
4049 numbers and thus requires a I<string> argument.
4051 =item E<lt>B<View> I<Name>E<gt> block
4053 The packets sent by the Pinba extension include the hostname of the server, the
4054 server name (the name of the virtual host) and the script that was executed.
4055 Using B<View> blocks it is possible to separate the data into multiple groups
4056 to get more meaningful statistics. Each packet is added to all matching groups,
4057 so that a packet may be accounted for more than once.
4061 =item B<Host> I<Host>
4063 Matches the hostname of the system the webserver / script is running on. This
4064 will contain the result of the L<gethostname(2)> system call. If not
4065 configured, all hostnames will be accepted.
4067 =item B<Server> I<Server>
4069 Matches the name of the I<virtual host>, i.e. the contents of the
4070 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
4071 server names will be accepted.
4073 =item B<Script> I<Script>
4075 Matches the name of the I<script name>, i.e. the contents of the
4076 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
4077 script names will be accepted.
4083 =head2 Plugin C<ping>
4085 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
4086 configured hosts periodically and measures the network latency. Whenever the
4087 C<read> function of the plugin is called, it submits the average latency, the
4088 standard deviation and the drop rate for each host.
4090 Available configuration options:
4094 =item B<Host> I<IP-address>
4096 Host to ping periodically. This option may be repeated several times to ping
4099 =item B<Interval> I<Seconds>
4101 Sets the interval in which to send ICMP echo packets to the configured hosts.
4102 This is B<not> the interval in which statistics are queries from the plugin but
4103 the interval in which the hosts are "pinged". Therefore, the setting here
4104 should be smaller than or equal to the global B<Interval> setting. Fractional
4105 times, such as "1.24" are allowed.
4109 =item B<Timeout> I<Seconds>
4111 Time to wait for a response from the host to which an ICMP packet had been
4112 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
4113 to be down or the packet to be dropped. This setting must be smaller than the
4114 B<Interval> setting above for the plugin to work correctly. Fractional
4115 arguments are accepted.
4119 =item B<TTL> I<0-255>
4121 Sets the Time-To-Live of generated ICMP packets.
4123 =item B<SourceAddress> I<host>
4125 Sets the source address to use. I<host> may either be a numerical network
4126 address or a network hostname.
4128 =item B<Device> I<name>
4130 Sets the outgoing network device to be used. I<name> has to specify an
4131 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
4134 =item B<MaxMissed> I<Packets>
4136 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
4137 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
4139 Default: B<-1> (disabled)
4143 =head2 Plugin C<postgresql>
4145 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
4146 keeps a persistent connection to all configured databases and tries to
4147 reconnect if the connection has been interrupted. A database is configured by
4148 specifying a B<Database> block as described below. The default statistics are
4149 collected from PostgreSQL's B<statistics collector> which thus has to be
4150 enabled for this plugin to work correctly. This should usually be the case by
4151 default. See the section "The Statistics Collector" of the B<PostgreSQL
4152 Documentation> for details.
4154 By specifying custom database queries using a B<Query> block as described
4155 below, you may collect any data that is available from some PostgreSQL
4156 database. This way, you are able to access statistics of external daemons
4157 which are available in a PostgreSQL database or use future or special
4158 statistics provided by PostgreSQL without the need to upgrade your collectd
4161 Starting with version 5.2, the C<postgresql> plugin supports writing data to
4162 PostgreSQL databases as well. This has been implemented in a generic way. You
4163 need to specify an SQL statement which will then be executed by collectd in
4164 order to write the data (see below for details). The benefit of that approach
4165 is that there is no fixed database layout. Rather, the layout may be optimized
4166 for the current setup.
4168 The B<PostgreSQL Documentation> manual can be found at
4169 L<http://www.postgresql.org/docs/manuals/>.
4173 Statement "SELECT magic FROM wizard WHERE host = $1;"
4177 InstancePrefix "magic"
4182 <Query rt36_tickets>
4183 Statement "SELECT COUNT(type) AS count, type \
4185 WHEN resolved = 'epoch' THEN 'open' \
4186 ELSE 'resolved' END AS type \
4187 FROM tickets) type \
4191 InstancePrefix "rt36_tickets"
4192 InstancesFrom "type"
4198 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
4208 KRBSrvName "kerberos_service_name"
4214 Service "service_name"
4215 Query backend # predefined
4226 The B<Query> block defines one database query which may later be used by a
4227 database definition. It accepts a single mandatory argument which specifies
4228 the name of the query. The names of all queries have to be unique (see the
4229 B<MinVersion> and B<MaxVersion> options below for an exception to this
4230 rule). The following configuration options are available to define the query:
4232 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
4233 blocks define how to handle the values returned from the query. They define
4234 which column holds which value and how to dispatch that value to the daemon.
4235 Multiple B<Result> blocks may be used to extract multiple values from a single
4240 =item B<Statement> I<sql query statement>
4242 Specify the I<sql query statement> which the plugin should execute. The string
4243 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
4244 first, second, etc. parameter. The value of the parameters is specified by the
4245 B<Param> configuration option - see below for details. To include a literal
4246 B<$> character followed by a number, surround it with single quotes (B<'>).
4248 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
4249 allowed. Note, however, that only a single command may be used. Semicolons are
4250 allowed as long as a single non-empty command has been specified only.
4252 The returned lines will be handled separately one after another.
4254 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4256 Specify the parameters which should be passed to the SQL query. The parameters
4257 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4258 they appear in the configuration file. The value of the parameter is
4259 determined depending on the value of the B<Param> option as follows:
4265 The configured hostname of the database connection. If a UNIX domain socket is
4266 used, the parameter expands to "localhost".
4270 The name of the database of the current connection.
4274 The name of the database plugin instance. See the B<Instance> option of the
4275 database specification below for details.
4279 The username used to connect to the database.
4283 The interval with which this database is queried (as specified by the database
4284 specific or global B<Interval> options).
4288 Please note that parameters are only supported by PostgreSQL's protocol
4289 version 3 and above which was introduced in version 7.4 of PostgreSQL.
4291 =item B<Type> I<type>
4293 The I<type> name to be used when dispatching the values. The type describes
4294 how to handle the data and where to store it. See L<types.db(5)> for more
4295 details on types and their configuration. The number and type of values (as
4296 selected by the B<ValuesFrom> option) has to match the type of the given name.
4298 This option is required inside a B<Result> block.
4300 =item B<InstancePrefix> I<prefix>
4302 =item B<InstancesFrom> I<column0> [I<column1> ...]
4304 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
4305 B<InstancePrefix> defines a static prefix that will be prepended to all type
4306 instances. B<InstancesFrom> defines the column names whose values will be used
4307 to create the type instance. Multiple values will be joined together using the
4308 hyphen (C<->) as separation character.
4310 The plugin itself does not check whether or not all built instances are
4311 different. It is your responsibility to assure that each is unique.
4313 Both options are optional. If none is specified, the type instance will be
4316 =item B<ValuesFrom> I<column0> [I<column1> ...]
4318 Names the columns whose content is used as the actual data for the data sets
4319 that are dispatched to the daemon. How many such columns you need is
4320 determined by the B<Type> setting as explained above. If you specify too many
4321 or not enough columns, the plugin will complain about that and no data will be
4322 submitted to the daemon.
4324 The actual data type, as seen by PostgreSQL, is not that important as long as
4325 it represents numbers. The plugin will automatically cast the values to the
4326 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
4327 L<strtod(3)> functions, so anything supported by those functions is supported
4328 by the plugin as well.
4330 This option is required inside a B<Result> block and may be specified multiple
4331 times. If multiple B<ValuesFrom> options are specified, the columns are read
4334 =item B<MinVersion> I<version>
4336 =item B<MaxVersion> I<version>
4338 Specify the minimum or maximum version of PostgreSQL that this query should be
4339 used with. Some statistics might only be available with certain versions of
4340 PostgreSQL. This allows you to specify multiple queries with the same name but
4341 which apply to different versions, thus allowing you to use the same
4342 configuration in a heterogeneous environment.
4344 The I<version> has to be specified as the concatenation of the major, minor
4345 and patch-level versions, each represented as two-decimal-digit numbers. For
4346 example, version 8.2.3 will become 80203.
4350 The following predefined queries are available (the definitions can be found
4351 in the F<postgresql_default.conf> file which, by default, is available at
4352 C<I<prefix>/share/collectd/>):
4358 This query collects the number of backends, i.E<nbsp>e. the number of
4361 =item B<transactions>
4363 This query collects the numbers of committed and rolled-back transactions of
4368 This query collects the numbers of various table modifications (i.E<nbsp>e.
4369 insertions, updates, deletions) of the user tables.
4371 =item B<query_plans>
4373 This query collects the numbers of various table scans and returned tuples of
4376 =item B<table_states>
4378 This query collects the numbers of live and dead rows in the user tables.
4382 This query collects disk block access counts for user tables.
4386 This query collects the on-disk size of the database in bytes.
4390 In addition, the following detailed queries are available by default. Please
4391 note that each of those queries collects information B<by table>, thus,
4392 potentially producing B<a lot> of data. For details see the description of the
4393 non-by_table queries above.
4397 =item B<queries_by_table>
4399 =item B<query_plans_by_table>
4401 =item B<table_states_by_table>
4403 =item B<disk_io_by_table>
4407 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
4408 mandatory argument specifying the name of the writer. This will then be used
4409 in the B<Database> specification in order to activate the writer instance. The
4410 names of all writers have to be unique. The following options may be
4415 =item B<Statement> I<sql statement>
4417 This mandatory option specifies the SQL statement that will be executed for
4418 each submitted value. A single SQL statement is allowed only. Anything after
4419 the first semicolon will be ignored.
4421 Nine parameters will be passed to the statement and should be specified as
4422 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
4423 values are made available through those parameters:
4429 The timestamp of the queried value as a floating point number.
4433 The hostname of the queried value.
4437 The plugin name of the queried value.
4441 The plugin instance of the queried value. This value may be B<NULL> if there
4442 is no plugin instance.
4446 The type of the queried value (cf. L<types.db(5)>).
4450 The type instance of the queried value. This value may be B<NULL> if there is
4455 An array of names for the submitted values (i.E<nbsp>e., the name of the data
4456 sources of the submitted value-list).
4460 An array of types for the submitted values (i.E<nbsp>e., the type of the data
4461 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
4462 B<StoreRates> is enabled (which is the default, see below), all types will be
4467 An array of the submitted values. The dimensions of the value name and value
4472 In general, it is advisable to create and call a custom function in the
4473 PostgreSQL database for this purpose. Any procedural language supported by
4474 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
4477 =item B<StoreRates> B<false>|B<true>
4479 If set to B<true> (the default), convert counter values to rates. If set to
4480 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
4485 The B<Database> block defines one PostgreSQL database for which to collect
4486 statistics. It accepts a single mandatory argument which specifies the
4487 database name. None of the other options are required. PostgreSQL will use
4488 default values as documented in the section "CONNECTING TO A DATABASE" in the
4489 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
4490 the user collectd is run as and special environment variables. See the manpage
4495 =item B<Interval> I<seconds>
4497 Specify the interval with which the database should be queried. The default is
4498 to use the global B<Interval> setting.
4500 =item B<CommitInterval> I<seconds>
4502 This option may be used for database connections which have "writers" assigned
4503 (see above). If specified, it causes a writer to put several updates into a
4504 single transaction. This transaction will last for the specified amount of
4505 time. By default, each update will be executed in a separate transaction. Each
4506 transaction generates a fair amount of overhead which can, thus, be reduced by
4507 activating this option. The draw-back is, that data covering the specified
4508 amount of time will be lost, for example, if a single statement within the
4509 transaction fails or if the database server crashes.
4511 =item B<Host> I<hostname>
4513 Specify the hostname or IP of the PostgreSQL server to connect to. If the
4514 value begins with a slash, it is interpreted as the directory name in which to
4515 look for the UNIX domain socket.
4517 This option is also used to determine the hostname that is associated with a
4518 collected data set. If it has been omitted or either begins with with a slash
4519 or equals B<localhost> it will be replaced with the global hostname definition
4520 of collectd. Any other value will be passed literally to collectd when
4521 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
4523 =item B<Port> I<port>
4525 Specify the TCP port or the local UNIX domain socket file extension of the
4528 =item B<User> I<username>
4530 Specify the username to be used when connecting to the server.
4532 =item B<Password> I<password>
4534 Specify the password to be used when connecting to the server.
4536 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
4538 Specify whether to use an SSL connection when contacting the server. The
4539 following modes are supported:
4541 =item B<Instance> I<name>
4543 Specify the plugin instance name that should be used instead of the database
4544 name (which is the default, if this option has not been specified). This
4545 allows to query multiple databases of the same name on the same host (e.g.
4546 when running multiple database server versions in parallel).
4552 Do not use SSL at all.
4556 First, try to connect without using SSL. If that fails, try using SSL.
4558 =item I<prefer> (default)
4560 First, try to connect using SSL. If that fails, try without using SSL.
4568 =item B<KRBSrvName> I<kerberos_service_name>
4570 Specify the Kerberos service name to use when authenticating with Kerberos 5
4571 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
4572 B<PostgreSQL Documentation> for details.
4574 =item B<Service> I<service_name>
4576 Specify the PostgreSQL service name to use for additional parameters. That
4577 service has to be defined in F<pg_service.conf> and holds additional
4578 connection parameters. See the section "The Connection Service File" in the
4579 B<PostgreSQL Documentation> for details.
4581 =item B<Query> I<query>
4583 Specifies a I<query> which should be executed in the context of the database
4584 connection. This may be any of the predefined or user-defined queries. If no
4585 such option is given, it defaults to "backends", "transactions", "queries",
4586 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
4587 has been specified). Else, the specified queries are used only.
4589 =item B<Writer> I<writer>
4591 Assigns the specified I<writer> backend to the database connection. This
4592 causes all collected data to be send to the database using the settings
4593 defined in the writer configuration (see the section "FILTER CONFIGURATION"
4594 below for details on how to selectively send data to certain plugins).
4596 Each writer will register a flush callback which may be used when having long
4597 transactions enabled (see the B<CommitInterval> option above). When issuing
4598 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
4599 transaction will be committed right away. Two different kinds of flush
4600 callbacks are available with the C<postgresql> plugin:
4606 Flush all writer backends.
4608 =item B<postgresql->I<database>
4610 Flush all writers of the specified I<database> only.
4616 =head2 Plugin C<powerdns>
4618 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
4619 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
4620 values, many of which are probably meaningless to most users, but may be useful
4621 for some. So you may chose which values to collect, but if you don't, some
4622 reasonable defaults will be collected.
4625 <Server "server_name">
4627 Collect "udp-answers" "udp-queries"
4628 Socket "/var/run/pdns.controlsocket"
4630 <Recursor "recursor_name">
4632 Collect "cache-hits" "cache-misses"
4633 Socket "/var/run/pdns_recursor.controlsocket"
4635 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
4640 =item B<Server> and B<Recursor> block
4642 The B<Server> block defines one authoritative server to query, the B<Recursor>
4643 does the same for an recursing server. The possible options in both blocks are
4644 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
4649 =item B<Collect> I<Field>
4651 Using the B<Collect> statement you can select which values to collect. Here,
4652 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
4653 C<dlg-only-drops>, C<answers10-100>.
4655 The method of getting the values differs for B<Server> and B<Recursor> blocks:
4656 When querying the server a C<SHOW *> command is issued in any case, because
4657 that's the only way of getting multiple values out of the server at once.
4658 collectd then picks out the values you have selected. When querying the
4659 recursor, a command is generated to query exactly these values. So if you
4660 specify invalid fields when querying the recursor, a syntax error may be
4661 returned by the daemon and collectd may not collect any values at all.
4663 If no B<Collect> statement is given, the following B<Server> values will be
4670 =item packetcache-hit
4672 =item packetcache-miss
4674 =item packetcache-size
4676 =item query-cache-hit
4678 =item query-cache-miss
4680 =item recursing-answers
4682 =item recursing-questions
4694 The following B<Recursor> values will be collected by default:
4698 =item noerror-answers
4700 =item nxdomain-answers
4702 =item servfail-answers
4720 Please note that up to that point collectd doesn't know what values are
4721 available on the server and values that are added do not need a change of the
4722 mechanism so far. However, the values must be mapped to collectd's naming
4723 scheme, which is done using a lookup table that lists all known values. If
4724 values are added in the future and collectd does not know about them, you will
4725 get an error much like this:
4727 powerdns plugin: submit: Not found in lookup table: foobar = 42
4729 In this case please file a bug report with the collectd team.
4731 =item B<Socket> I<Path>
4733 Configures the path to the UNIX domain socket to be used when connecting to the
4734 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
4735 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
4736 will be used for the recursor.
4740 =item B<LocalSocket> I<Path>
4742 Querying the recursor is done using UDP. When using UDP over UNIX domain
4743 sockets, the client socket needs a name in the file system, too. You can set
4744 this local name to I<Path> using the B<LocalSocket> option. The default is
4745 C<I<prefix>/var/run/collectd-powerdns>.
4749 =head2 Plugin C<processes>
4753 =item B<Process> I<Name>
4755 Select more detailed statistics of processes matching this name. The statistics
4756 collected for these selected processes are size of the resident segment size
4757 (RSS), user- and system-time used, number of processes and number of threads,
4758 io data (where available) and minor and major pagefaults.
4760 =item B<ProcessMatch> I<name> I<regex>
4762 Similar to the B<Process> option this allows to select more detailed
4763 statistics of processes matching the specified I<regex> (see L<regex(7)> for
4764 details). The statistics of all matching processes are summed up and
4765 dispatched to the daemon using the specified I<name> as an identifier. This
4766 allows to "group" several processes together. I<name> must not contain
4771 =head2 Plugin C<protocols>
4773 Collects a lot of information about various network protocols, such as I<IP>,
4774 I<TCP>, I<UDP>, etc.
4776 Available configuration options:
4780 =item B<Value> I<Selector>
4782 Selects whether or not to select a specific value. The string being matched is
4783 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
4784 plugin instance and I<ValueName> will be used as type instance. An example of
4785 the string being used would be C<Tcp:RetransSegs>.
4787 You can use regular expressions to match a large number of values with just one
4788 configuration option. To select all "extended" I<TCP> values, you could use the
4789 following statement:
4793 Whether only matched values are selected or all matched values are ignored
4794 depends on the B<IgnoreSelected>. By default, only matched values are selected.
4795 If no value is configured at all, all values will be selected.
4797 =item B<IgnoreSelected> B<true>|B<false>
4799 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
4800 matching values will be ignored.
4804 =head2 Plugin C<python>
4806 This plugin embeds a Python-interpreter into collectd and provides an interface
4807 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
4809 =head2 Plugin C<routeros>
4811 The C<routeros> plugin connects to a device running I<RouterOS>, the
4812 Linux-based operating system for routers by I<MikroTik>. The plugin uses
4813 I<librouteros> to connect and reads information about the interfaces and
4814 wireless connections of the device. The configuration supports querying
4819 Host "router0.example.com"
4822 CollectInterface true
4827 Host "router1.example.com"
4830 CollectInterface true
4831 CollectRegistrationTable true
4837 As you can see above, the configuration of the I<routeros> plugin consists of
4838 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
4839 options are understood:
4843 =item B<Host> I<Host>
4845 Hostname or IP-address of the router to connect to.
4847 =item B<Port> I<Port>
4849 Port name or port number used when connecting. If left unspecified, the default
4850 will be chosen by I<librouteros>, currently "8728". This option expects a
4851 string argument, even when a numeric port number is given.
4853 =item B<User> I<User>
4855 Use the user name I<User> to authenticate. Defaults to "admin".
4857 =item B<Password> I<Password>
4859 Set the password used to authenticate.
4861 =item B<CollectInterface> B<true>|B<false>
4863 When set to B<true>, interface statistics will be collected for all interfaces
4864 present on the device. Defaults to B<false>.
4866 =item B<CollectRegistrationTable> B<true>|B<false>
4868 When set to B<true>, information about wireless LAN connections will be
4869 collected. Defaults to B<false>.
4871 =item B<CollectCPULoad> B<true>|B<false>
4873 When set to B<true>, information about the CPU usage will be collected. The
4874 number is a dimensionless value where zero indicates no CPU usage at all.
4875 Defaults to B<false>.
4877 =item B<CollectMemory> B<true>|B<false>
4879 When enabled, the amount of used and free memory will be collected. How used
4880 memory is calculated is unknown, for example whether or not caches are counted
4882 Defaults to B<false>.
4884 =item B<CollectDF> B<true>|B<false>
4886 When enabled, the amount of used and free disk space will be collected.
4887 Defaults to B<false>.
4889 =item B<CollectDisk> B<true>|B<false>
4891 When enabled, the number of sectors written and bad blocks will be collected.
4892 Defaults to B<false>.
4896 =head2 Plugin C<redis>
4898 The I<Redis plugin> connects to one or more Redis servers and gathers
4899 information about each server's state. For each server there is a I<Node> block
4900 which configures the connection parameters for this node.
4910 The information shown in the synopsis above is the I<default configuration>
4911 which is used by the plugin if no configuration is present.
4915 =item B<Node> I<Nodename>
4917 The B<Node> block identifies a new Redis node, that is a new Redis instance
4918 running in an specified host and port. The name for node is a canonical
4919 identifier which is used as I<plugin instance>. It is limited to
4920 64E<nbsp>characters in length.
4922 =item B<Host> I<Hostname>
4924 The B<Host> option is the hostname or IP-address where the Redis instance is
4927 =item B<Port> I<Port>
4929 The B<Port> option is the TCP port on which the Redis instance accepts
4930 connections. Either a service name of a port number may be given. Please note
4931 that numerical port numbers must be given as a string, too.
4933 =item B<Password> I<Password>
4935 Use I<Password> to authenticate when connecting to I<Redis>.
4937 =item B<Timeout> I<Timeout in miliseconds>
4939 The B<Timeout> option set the socket timeout for node response. Since the Redis
4940 read function is blocking, you should keep this value as low as possible. Keep
4941 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
4942 than B<Interval> defined globally.
4946 =head2 Plugin C<rrdcached>
4948 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
4949 to store values to RRD files in an efficient manner. The combination of the
4950 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
4951 way the C<rrdtool> plugin works (see below). The added abstraction layer
4952 provides a number of benefits, though: Because the cache is not within
4953 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
4954 restarted. This results in much shorter (if any) gaps in graphs, especially
4955 under heavy load. Also, the C<rrdtool> command line utility is aware of the
4956 daemon so that it can flush values to disk automatically when needed. This
4957 allows to integrate automated flushing of values into graphing solutions much
4960 There are disadvantages, though: The daemon may reside on a different host, so
4961 it may not be possible for C<collectd> to create the appropriate RRD files
4962 anymore. And even if C<rrdcached> runs on the same host, it may run in a
4963 different base directory, so relative paths may do weird stuff if you're not
4966 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
4967 on the same host, communicating via a UNIX domain socket. The B<DataDir>
4968 setting should be set to an absolute path, so that a changed base directory
4969 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
4973 =item B<DaemonAddress> I<Address>
4975 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
4976 library. See L<rrdcached(1)> for details. Example:
4978 <Plugin "rrdcached">
4979 DaemonAddress "unix:/var/run/rrdcached.sock"
4982 =item B<DataDir> I<Directory>
4984 Set the base directory in which the RRD files reside. If this is a relative
4985 path, it is relative to the working base directory of the C<rrdcached> daemon!
4986 Use of an absolute path is recommended.
4988 =item B<CreateFiles> B<true>|B<false>
4990 Enables or disables the creation of RRD files. If the daemon is not running
4991 locally, or B<DataDir> is set to a relative path, this will not work as
4992 expected. Default is B<true>.
4994 =item B<CreateFilesAsync> B<false>|B<true>
4996 When enabled, new RRD files are enabled asynchronously, using a separate thread
4997 that runs in the background. This prevents writes to block, which is a problem
4998 especially when many hundreds of files need to be created at once. However,
4999 since the purpose of creating the files asynchronously is I<not> to block until
5000 the file is available, values before the file is available will be discarded.
5001 When disabled (the default) files are created synchronously, blocking for a
5002 short while, while the file is being written.
5004 =item B<StepSize> I<Seconds>
5006 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5007 this setting is unset and the stepsize is set to the interval in which the data
5008 is collected. Do not use this option unless you absolutely have to for some
5009 reason. Setting this option may cause problems with the C<snmp plugin>, the
5010 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5012 =item B<HeartBeat> I<Seconds>
5014 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5015 in which case the heartbeat is set to twice the B<StepSize> which should equal
5016 the interval in which data is collected. Do not set this option unless you have
5017 a very good reason to do so.
5019 =item B<RRARows> I<NumRows>
5021 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5022 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5023 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5024 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5025 week, one month, and one year.
5027 So for each timespan, it calculates how many PDPs need to be consolidated into
5028 one CDP by calculating:
5029 number of PDPs = timespan / (stepsize * rrarows)
5031 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5034 =item B<RRATimespan> I<Seconds>
5036 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5037 more then one RRA. If this option is never used, the built-in default of (3600,
5038 86400, 604800, 2678400, 31622400) is used.
5040 For more information on how RRA-sizes are calculated see B<RRARows> above.
5042 =item B<XFF> I<Factor>
5044 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5045 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5050 =head2 Plugin C<rrdtool>
5052 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
5053 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
5054 using these settings. If you don't want to dive into the depths of RRDtool, you
5055 can safely ignore these settings.
5059 =item B<DataDir> I<Directory>
5061 Set the directory to store RRD files under. By default RRD files are generated
5062 beneath the daemon's working directory, i.e. the B<BaseDir>.
5064 =item B<CreateFilesAsync> B<false>|B<true>
5066 When enabled, new RRD files are enabled asynchronously, using a separate thread
5067 that runs in the background. This prevents writes to block, which is a problem
5068 especially when many hundreds of files need to be created at once. However,
5069 since the purpose of creating the files asynchronously is I<not> to block until
5070 the file is available, values before the file is available will be discarded.
5071 When disabled (the default) files are created synchronously, blocking for a
5072 short while, while the file is being written.
5074 =item B<StepSize> I<Seconds>
5076 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5077 this setting is unset and the stepsize is set to the interval in which the data
5078 is collected. Do not use this option unless you absolutely have to for some
5079 reason. Setting this option may cause problems with the C<snmp plugin>, the
5080 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5082 =item B<HeartBeat> I<Seconds>
5084 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5085 in which case the heartbeat is set to twice the B<StepSize> which should equal
5086 the interval in which data is collected. Do not set this option unless you have
5087 a very good reason to do so.
5089 =item B<RRARows> I<NumRows>
5091 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5092 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5093 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5094 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5095 week, one month, and one year.
5097 So for each timespan, it calculates how many PDPs need to be consolidated into
5098 one CDP by calculating:
5099 number of PDPs = timespan / (stepsize * rrarows)
5101 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5104 =item B<RRATimespan> I<Seconds>
5106 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5107 more then one RRA. If this option is never used, the built-in default of (3600,
5108 86400, 604800, 2678400, 31622400) is used.
5110 For more information on how RRA-sizes are calculated see B<RRARows> above.
5112 =item B<XFF> I<Factor>
5114 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5115 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5118 =item B<CacheFlush> I<Seconds>
5120 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
5121 it writes all values for a certain RRD-file if the oldest value is older than
5122 (or equal to) the number of seconds specified. If some RRD-file is not updated
5123 anymore for some reason (the computer was shut down, the network is broken,
5124 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
5125 entire cache is searched for entries older than B<CacheTimeout> seconds and
5126 written to disk every I<Seconds> seconds. Since this is kind of expensive and
5127 does nothing under normal circumstances, this value should not be too small.
5128 900 seconds might be a good value, though setting this to 7200 seconds doesn't
5129 normally do much harm either.
5131 =item B<CacheTimeout> I<Seconds>
5133 If this option is set to a value greater than zero, the C<rrdtool plugin> will
5134 save values in a cache, as described above. Writing multiple values at once
5135 reduces IO-operations and thus lessens the load produced by updating the files.
5136 The trade off is that the graphs kind of "drag behind" and that more memory is
5139 =item B<WritesPerSecond> I<Updates>
5141 When collecting many statistics with collectd and the C<rrdtool> plugin, you
5142 will run serious performance problems. The B<CacheFlush> setting and the
5143 internal update queue assert that collectd continues to work just fine even
5144 under heavy load, but the system may become very unresponsive and slow. This is
5145 a problem especially if you create graphs from the RRD files on the same
5146 machine, for example using the C<graph.cgi> script included in the
5147 C<contrib/collection3/> directory.
5149 This setting is designed for very large setups. Setting this option to a value
5150 between 25 and 80 updates per second, depending on your hardware, will leave
5151 the server responsive enough to draw graphs even while all the cached values
5152 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
5153 by the B<FLUSH> command, are B<not> effected by this limit. They are still
5154 written as fast as possible, so that web frontends have up to date data when
5157 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
5158 updates per second, writing all values to disk will take approximately
5159 56E<nbsp>minutes. Together with the flushing ability that's integrated into
5160 "collection3" you'll end up with a responsive and fast system, up to date
5161 graphs and basically a "backup" of your values every hour.
5163 =item B<RandomTimeout> I<Seconds>
5165 When set, the actual timeout for each value is chosen randomly between
5166 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
5167 intention is to avoid high load situations that appear when many values timeout
5168 at the same time. This is especially a problem shortly after the daemon starts,
5169 because all values were added to the internal cache at roughly the same time.
5173 =head2 Plugin C<sensors>
5175 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
5176 that all the needed modules have to be loaded and lm_sensors has to be
5177 configured (most likely by editing F</etc/sensors.conf>. Read
5178 L<sensors.conf(5)> for details.
5180 The B<lm_sensors> homepage can be found at
5181 L<http://secure.netroedge.com/~lm78/>.
5185 =item B<SensorConfigFile> I<File>
5187 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
5188 the library's default will be used.
5190 =item B<Sensor> I<chip-bus-address/type-feature>
5192 Selects the name of the sensor which you want to collect or ignore, depending
5193 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
5194 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
5195 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
5197 =item B<IgnoreSelected> I<true>|I<false>
5199 If no configuration if given, the B<sensors>-plugin will collect data from all
5200 sensors. This may not be practical, especially for uninteresting sensors.
5201 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
5202 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
5203 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
5204 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
5205 and all other sensors are collected.
5209 =head2 Plugin C<sigrok>
5211 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
5212 supported by the L<sigrok|http://sigrok.org/> project.
5218 <Device "AC Voltage">
5223 <Device "Sound Level">
5224 Driver "cem-dt-885x"
5231 =item B<LogLevel> B<0-5>
5233 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
5234 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
5235 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
5236 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
5237 their level, are always submitted to I<collectd> at its INFO log level.
5239 =item E<lt>B<Device> I<Name>E<gt>
5241 A sigrok-supported device, uniquely identified by this section's options. The
5242 I<Name> is passed to I<collectd> as the I<plugin instance>.
5244 =item B<Driver> I<DriverName>
5246 The sigrok driver to use for this device.
5248 =item B<Conn> I<ConnectionSpec>
5250 If the device cannot be auto-discovered, or more than one might be discovered
5251 by the driver, I<ConnectionSpec> specifies the connection string to the device.
5252 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
5253 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
5254 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
5255 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
5257 =item B<SerialComm> I<SerialSpec>
5259 For serial devices with non-standard port settings, this option can be used
5260 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
5261 This should not be necessary; drivers know how to communicate with devices they
5264 =item B<MinimumInterval> I<Seconds>
5266 Specifies the minimum time between measurement dispatches to I<collectd>, in
5267 seconds. Since some I<sigrok> supported devices can acquire measurements many
5268 times per second, it may be necessary to throttle these. For example, the
5269 I<RRD plugin> cannot process writes more than once per second.
5271 The default B<MinimumInterval> is B<0>, meaning measurements received from the
5272 device are always dispatched to I<collectd>. When throttled, unused
5273 measurements are discarded.
5277 =head2 Plugin C<snmp>
5279 Since the configuration of the C<snmp plugin> is a little more complicated than
5280 other plugins, its documentation has been moved to an own manpage,
5281 L<collectd-snmp(5)>. Please see there for details.
5283 =head2 Plugin C<statsd>
5285 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
5286 protocol and dispatches rates or other aggregates of these numbers
5289 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
5290 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
5291 C<objects> respectively.
5293 The following configuration options are valid:
5297 =item B<Host> I<Host>
5299 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
5300 "any" address, i.e. accept packets sent to any of the hosts addresses.
5302 =item B<Port> I<Port>
5304 UDP port to listen to. This can be either a service name or a port number.
5305 Defaults to C<8125>.
5307 =item B<DeleteCounters> B<false>|B<true>
5309 =item B<DeleteTimers> B<false>|B<true>
5311 =item B<DeleteGauges> B<false>|B<true>
5313 =item B<DeleteSets> B<false>|B<true>
5315 These options control what happens if metrics are not updated in an interval.
5316 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
5317 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
5318 are unchanged. If set to B<True>, the such metrics are not dispatched and
5319 removed from the internal cache.
5321 =item B<TimerPercentile> I<Percent>
5323 Calculate and dispatch the configured percentile, i.e. compute the latency, so
5324 that I<Percent> of all reported timers are smaller than or equal to the
5325 computed latency. This is useful for cutting off the long tail latency, as it's
5326 often done in I<Service Level Agreements> (SLAs).
5328 If not specified, no percentile is calculated / dispatched.
5332 =head2 Plugin C<swap>
5334 The I<Swap plugin> collects information about used and available swap space. On
5335 I<Linux> and I<Solaris>, the following options are available:
5339 =item B<ReportByDevice> B<false>|B<true>
5341 Configures how to report physical swap devices. If set to B<false> (the
5342 default), the summary over all swap devices is reported only, i.e. the globally
5343 used and available space over all devices. If B<true> is configured, the used
5344 and available space of each device will be reported separately.
5346 This option is only available if the I<Swap plugin> can read C</proc/swaps>
5347 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
5349 =item B<ReportBytes> B<false>|B<true>
5351 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
5352 I<swap I/O> is reported in pages. This option is available under Linux only.
5356 =head2 Plugin C<syslog>
5360 =item B<LogLevel> B<debug|info|notice|warning|err>
5362 Sets the log-level. If, for example, set to B<notice>, then all events with
5363 severity B<notice>, B<warning>, or B<err> will be submitted to the
5366 Please note that B<debug> is only available if collectd has been compiled with
5369 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
5371 Controls which notifications should be sent to syslog. The default behaviour is
5372 not to send any. Less severe notifications always imply logging more severe
5373 notifications: Setting this to B<OKAY> means all notifications will be sent to
5374 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
5375 notifications but will dismiss B<OKAY> notifications. Setting this option to
5376 B<FAILURE> will only send failures to syslog.
5380 =head2 Plugin C<table>
5382 The C<table plugin> provides generic means to parse tabular data and dispatch
5383 user specified values. Values are selected based on column numbers. For
5384 example, this plugin may be used to get values from the Linux L<proc(5)>
5385 filesystem or CSV (comma separated values) files.
5388 <Table "/proc/slabinfo">
5393 InstancePrefix "active_objs"
5399 InstancePrefix "objperslab"
5406 The configuration consists of one or more B<Table> blocks, each of which
5407 configures one file to parse. Within each B<Table> block, there are one or
5408 more B<Result> blocks, which configure which data to select and how to
5411 The following options are available inside a B<Table> block:
5415 =item B<Instance> I<instance>
5417 If specified, I<instance> is used as the plugin instance. So, in the above
5418 example, the plugin name C<table-slabinfo> would be used. If omitted, the
5419 filename of the table is used instead, with all special characters replaced
5420 with an underscore (C<_>).
5422 =item B<Separator> I<string>
5424 Any character of I<string> is interpreted as a delimiter between the different
5425 columns of the table. A sequence of two or more contiguous delimiters in the
5426 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
5427 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
5428 of a table - see its documentation for more details. This option is mandatory.
5430 A horizontal tab, newline and carriage return may be specified by C<\\t>,
5431 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
5432 required because of collectd's config parsing.
5436 The following options are available inside a B<Result> block:
5440 =item B<Type> I<type>
5442 Sets the type used to dispatch the values to the daemon. Detailed information
5443 about types and their configuration can be found in L<types.db(5)>. This
5444 option is mandatory.
5446 =item B<InstancePrefix> I<prefix>
5448 If specified, prepend I<prefix> to the type instance. If omitted, only the
5449 B<InstancesFrom> option is considered for the type instance.
5451 =item B<InstancesFrom> I<column0> [I<column1> ...]
5453 If specified, the content of the given columns (identified by the column
5454 number starting at zero) will be used to create the type instance for each
5455 row. Multiple values (and the instance prefix) will be joined together with
5456 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
5457 option is considered for the type instance.
5459 The plugin itself does not check whether or not all built instances are
5460 different. It’s your responsibility to assure that each is unique. This is
5461 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
5462 sure that the table only contains one row.
5464 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
5467 =item B<ValuesFrom> I<column0> [I<column1> ...]
5469 Specifies the columns (identified by the column numbers starting at zero)
5470 whose content is used as the actual data for the data sets that are dispatched
5471 to the daemon. How many such columns you need is determined by the B<Type>
5472 setting above. If you specify too many or not enough columns, the plugin will
5473 complain about that and no data will be submitted to the daemon. The plugin
5474 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
5475 respectively, so anything supported by those functions is supported by the
5476 plugin as well. This option is mandatory.
5480 =head2 Plugin C<tail>
5482 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
5483 each line and dispatches found values. What is matched can be configured by the
5484 user using (extended) regular expressions, as described in L<regex(7)>.
5487 <File "/var/log/exim4/mainlog">
5490 Regex "S=([1-9][0-9]*)"
5496 Regex "\\<R=local_user\\>"
5497 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
5500 Instance "local_user"
5505 The config consists of one or more B<File> blocks, each of which configures one
5506 logfile to parse. Within each B<File> block, there are one or more B<Match>
5507 blocks, which configure a regular expression to search for.
5509 The B<Instance> option in the B<File> block may be used to set the plugin
5510 instance. So in the above example the plugin name C<tail-foo> would be used.
5511 This plugin instance is for all B<Match> blocks that B<follow> it, until the
5512 next B<Instance> option. This way you can extract several plugin instances from
5513 one logfile, handy when parsing syslog and the like.
5515 Each B<Match> block has the following options to describe how the match should
5520 =item B<Regex> I<regex>
5522 Sets the regular expression to use for matching against a line. The first
5523 subexpression has to match something that can be turned into a number by
5524 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
5525 below. Because B<extended> regular expressions are used, you do not need to use
5526 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
5527 collectd's config parsing you need to escape backslashes, though. So if you
5528 want to match literal parentheses you need to do the following:
5530 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
5532 =item B<ExcludeRegex> I<regex>
5534 Sets an optional regular expression to use for excluding lines from the match.
5535 An example which excludes all connections from localhost from the match:
5537 ExcludeRegex "127\\.0\\.0\\.1"
5539 =item B<DSType> I<Type>
5541 Sets how the values are cumulated. I<Type> is one of:
5545 =item B<GaugeAverage>
5547 Calculate the average.
5551 Use the smallest number only.
5555 Use the greatest number only.
5559 Use the last number found.
5565 =item B<AbsoluteSet>
5567 The matched number is a counter. Simply I<sets> the internal counter to this
5568 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
5574 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
5575 matched number may be negative, which will effectively subtract from the
5582 Increase the internal counter by one. These B<DSType> are the only ones that do
5583 not use the matched subexpression, but simply count the number of matched
5584 lines. Thus, you may use a regular expression without submatch in this case.
5588 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
5589 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
5590 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
5591 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
5592 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
5595 =item B<Type> I<Type>
5597 Sets the type used to dispatch this value. Detailed information about types and
5598 their configuration can be found in L<types.db(5)>.
5600 =item B<Instance> I<TypeInstance>
5602 This optional setting sets the type instance to use.
5606 =head2 Plugin C<tail_csv>
5608 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
5609 written by I<Snort>.
5614 <Metric "snort-dropped">
5619 <File "/var/log/snort/snort.stats">
5620 Instance "snort-eth0"
5622 Collect "snort-dropped"
5626 The configuration consists of one or more B<Metric> blocks that define an index
5627 into the line of the CSV file and how this value is mapped to I<collectd's>
5628 internal representation. These are followed by one or more B<Instance> blocks
5629 which configure which file to read, in which interval and which metrics to
5634 =item E<lt>B<Metric> I<Name>E<gt>
5636 The B<Metric> block configures a new metric to be extracted from the statistics
5637 file and how it is mapped on I<collectd's> data model. The string I<Name> is
5638 only used inside the B<Instance> blocks to refer to this block, so you can use
5639 one B<Metric> block for multiple CSV files.
5643 =item B<Type> I<Type>
5645 Configures which I<Type> to use when dispatching this metric. Types are defined
5646 in the L<types.db(5)> file, see the appropriate manual page for more
5647 information on specifying types. Only types with a single I<data source> are
5648 supported by the I<tail_csv plugin>. The information whether the value is an
5649 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
5650 I<Type's> definition.
5652 =item B<Instance> I<TypeInstance>
5654 If set, I<TypeInstance> is used to populate the type instance field of the
5655 created value lists. Otherwise, no type instance is used.
5657 =item B<ValueFrom> I<Index>
5659 Configure to read the value from the field with the zero-based index I<Index>.
5660 If the value is parsed as signed integer, unsigned integer or double depends on
5661 the B<Type> setting, see above.
5665 =item E<lt>B<File> I<Path>E<gt>
5667 Each B<File> block represents one CSV file to read. There must be at least one
5668 I<File> block but there can be multiple if you have multiple CSV files.
5672 =item B<Instance> I<PluginInstance>
5674 Sets the I<plugin instance> used when dispatching the values.
5676 =item B<Collect> I<Metric>
5678 Specifies which I<Metric> to collect. This option must be specified at least
5679 once, and you can use this option multiple times to specify more than one
5680 metric to be extracted from this statistic file.
5682 =item B<Interval> I<Seconds>
5684 Configures the interval in which to read values from this instance / file.
5685 Defaults to the plugin's default interval.
5687 =item B<TimeFrom> I<Index>
5689 Rather than using the local time when dispatching a value, read the timestamp
5690 from the field with the zero-based index I<Index>. The value is interpreted as
5691 seconds since epoch. The value is parsed as a double and may be factional.
5697 =head2 Plugin C<teamspeak2>
5699 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
5700 polls interesting global and virtual server data. The plugin can query only one
5701 physical server but unlimited virtual servers. You can use the following
5702 options to configure it:
5706 =item B<Host> I<hostname/ip>
5708 The hostname or ip which identifies the physical server.
5711 =item B<Port> I<port>
5713 The query port of the physical server. This needs to be a string.
5716 =item B<Server> I<port>
5718 This option has to be added once for every virtual server the plugin should
5719 query. If you want to query the virtual server on port 8767 this is what the
5720 option would look like:
5724 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
5725 use quotes around it! If no such statement is given only global information
5730 =head2 Plugin C<ted>
5732 The I<TED> plugin connects to a device of "The Energy Detective", a device to
5733 measure power consumption. These devices are usually connected to a serial
5734 (RS232) or USB port. The plugin opens a configured device and tries to read the
5735 current energy readings. For more information on TED, visit
5736 L<http://www.theenergydetective.com/>.
5738 Available configuration options:
5742 =item B<Device> I<Path>
5744 Path to the device on which TED is connected. collectd will need read and write
5745 permissions on that file.
5747 Default: B</dev/ttyUSB0>
5749 =item B<Retries> I<Num>
5751 Apparently reading from TED is not that reliable. You can therefore configure a
5752 number of retries here. You only configure the I<retries> here, to if you
5753 specify zero, one reading will be performed (but no retries if that fails); if
5754 you specify three, a maximum of four readings are performed. Negative values
5761 =head2 Plugin C<tcpconns>
5763 The C<tcpconns plugin> counts the number of currently established TCP
5764 connections based on the local port and/or the remote port. Since there may be
5765 a lot of connections the default if to count all connections with a local port,
5766 for which a listening socket is opened. You can use the following options to
5767 fine-tune the ports you are interested in:
5771 =item B<ListeningPorts> I<true>|I<false>
5773 If this option is set to I<true>, statistics for all local ports for which a
5774 listening socket exists are collected. The default depends on B<LocalPort> and
5775 B<RemotePort> (see below): If no port at all is specifically selected, the
5776 default is to collect listening ports. If specific ports (no matter if local or
5777 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
5778 the selected ports will be collected unless this option is set to I<true>
5781 =item B<LocalPort> I<Port>
5783 Count the connections to a specific local port. This can be used to see how
5784 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
5785 You have to specify the port in numeric form, so for the mailserver example
5786 you'd need to set B<25>.
5788 =item B<RemotePort> I<Port>
5790 Count the connections to a specific remote port. This is useful to see how
5791 much a remote service is used. This is most useful if you want to know how many
5792 connections a local service has opened to remote services, e.E<nbsp>g. how many
5793 connections a mail server or news server has to other mail or news servers, or
5794 how many connections a web proxy holds to web servers. You have to give the
5795 port in numeric form.
5799 =head2 Plugin C<thermal>
5803 =item B<ForceUseProcfs> I<true>|I<false>
5805 By default, the I<Thermal plugin> tries to read the statistics from the Linux
5806 C<sysfs> interface. If that is not available, the plugin falls back to the
5807 C<procfs> interface. By setting this option to I<true>, you can force the
5808 plugin to use the latter. This option defaults to I<false>.
5810 =item B<Device> I<Device>
5812 Selects the name of the thermal device that you want to collect or ignore,
5813 depending on the value of the B<IgnoreSelected> option. This option may be
5814 used multiple times to specify a list of devices.
5816 =item B<IgnoreSelected> I<true>|I<false>
5818 Invert the selection: If set to true, all devices B<except> the ones that
5819 match the device names specified by the B<Device> option are collected. By
5820 default only selected devices are collected if a selection is made. If no
5821 selection is configured at all, B<all> devices are selected.
5825 =head2 Plugin C<threshold>
5827 The I<Threshold plugin> checks values collected or received by I<collectd>
5828 against a configurable I<threshold> and issues I<notifications> if values are
5831 Documentation for this plugin is available in the L<collectd-threshold(5)>
5834 =head2 Plugin C<tokyotyrant>
5836 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
5837 couple metrics: number of records, and database size on disk.
5841 =item B<Host> I<Hostname/IP>
5843 The hostname or ip which identifies the server.
5844 Default: B<127.0.0.1>
5846 =item B<Port> I<Service/Port>
5848 The query port of the server. This needs to be a string, even if the port is
5849 given in its numeric form.
5854 =head2 Plugin C<unixsock>
5858 =item B<SocketFile> I<Path>
5860 Sets the socket-file which is to be created.
5862 =item B<SocketGroup> I<Group>
5864 If running as root change the group of the UNIX-socket after it has been
5865 created. Defaults to B<collectd>.
5867 =item B<SocketPerms> I<Permissions>
5869 Change the file permissions of the UNIX-socket after it has been created. The
5870 permissions must be given as a numeric, octal value as you would pass to
5871 L<chmod(1)>. Defaults to B<0770>.
5873 =item B<DeleteSocket> B<false>|B<true>
5875 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
5876 with the given name already exists. If I<collectd> crashes a socket file may be
5877 left over, preventing the daemon from opening a new socket when restarted.
5878 Since this is potentially dangerous, this defaults to B<false>.
5882 =head2 Plugin C<uuid>
5884 This plugin, if loaded, causes the Hostname to be taken from the machine's
5885 UUID. The UUID is a universally unique designation for the machine, usually
5886 taken from the machine's BIOS. This is most useful if the machine is running in
5887 a virtual environment such as Xen, in which case the UUID is preserved across
5888 shutdowns and migration.
5890 The following methods are used to find the machine's UUID, in order:
5896 Check I</etc/uuid> (or I<UUIDFile>).
5900 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
5905 Check for UUID from C<dmidecode> / SMBIOS.
5909 Check for UUID from Xen hypervisor.
5913 If no UUID can be found then the hostname is not modified.
5917 =item B<UUIDFile> I<Path>
5919 Take the UUID from the given file (default I</etc/uuid>).
5923 =head2 Plugin C<varnish>
5925 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
5930 <Instance "example">
5932 CollectConnections true
5942 CollectWorkers false
5946 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
5947 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
5948 will collectd statistics from the default "varnishd" instance (this should work
5949 fine in most cases).
5951 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
5955 =item B<CollectCache> B<true>|B<false>
5957 Cache hits and misses. True by default.
5959 =item B<CollectConnections> B<true>|B<false>
5961 Number of client connections received, accepted and dropped. True by default.
5963 =item B<CollectBackend> B<true>|B<false>
5965 Back-end connection statistics, such as successful, reused,
5966 and closed connections. True by default.
5968 =item B<CollectSHM> B<true>|B<false>
5970 Statistics about the shared memory log, a memory region to store
5971 log messages which is flushed to disk when full. True by default.
5973 =item B<CollectBan> B<true>|B<false>
5975 Statistics about ban operations, such as number of bans added, retired, and
5976 number of objects tested against ban operations. Only available with Varnish
5977 3.x. False by default.
5979 =item B<CollectDirectorDNS> B<true>|B<false>
5981 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
5984 =item B<CollectESI> B<true>|B<false>
5986 Edge Side Includes (ESI) parse statistics. False by default.
5988 =item B<CollectFetch> B<true>|B<false>
5990 Statistics about fetches (HTTP requests sent to the backend). False by default.
5992 =item B<CollectHCB> B<true>|B<false>
5994 Inserts and look-ups in the crit bit tree based hash. Look-ups are
5995 divided into locked and unlocked look-ups. False by default.
5997 =item B<CollectObjects> B<true>|B<false>
5999 Statistics on cached objects: number of objects expired, nuked (prematurely
6000 expired), saved, moved, etc. False by default.
6002 =item B<CollectPurge> B<true>|B<false>
6004 Statistics about purge operations, such as number of purges added, retired, and
6005 number of objects tested against purge operations. Only available with Varnish
6006 2.x. False by default.
6008 =item B<CollectSession> B<true>|B<false>
6010 Client session statistics. Number of past and current sessions, session herd and
6011 linger counters, etc. False by default.
6013 =item B<CollectSMA> B<true>|B<false>
6015 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
6016 component is Solaris specific. Only available with Varnish 2.x. False by
6019 =item B<CollectSMS> B<true>|B<false>
6021 synth (synthetic content) storage statistics. This storage
6022 component is used internally only. False by default.
6024 =item B<CollectSM> B<true>|B<false>
6026 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
6029 =item B<CollectStruct> B<true>|B<false>
6031 Current varnish internal state statistics. Number of current sessions, objects
6032 in cache store, open connections to backends (with Varnish 2.x), etc. False by
6035 =item B<CollectTotals> B<true>|B<false>
6037 Collects overview counters, such as the number of sessions created,
6038 the number of requests and bytes transferred. False by default.
6040 =item B<CollectUptime> B<true>|B<false>
6042 Varnish uptime. False by default.
6044 =item B<CollectVCL> B<true>|B<false>
6046 Number of total (available + discarded) VCL (config files). False by default.
6048 =item B<CollectWorkers> B<true>|B<false>
6050 Collect statistics about worker threads. False by default.
6054 =head2 Plugin C<vmem>
6056 The C<vmem> plugin collects information about the usage of virtual memory.
6057 Since the statistics provided by the Linux kernel are very detailed, they are
6058 collected very detailed. However, to get all the details, you have to switch
6059 them on manually. Most people just want an overview over, such as the number of
6060 pages read from swap space.
6064 =item B<Verbose> B<true>|B<false>
6066 Enables verbose collection of information. This will start collecting page
6067 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
6068 Part of these statistics are collected on a "per zone" basis.
6072 =head2 Plugin C<vserver>
6074 This plugin doesn't have any options. B<VServer> support is only available for
6075 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
6076 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
6077 need to apply the patches and compile your own kernel, which will then provide
6078 the F</proc/virtual> filesystem that is required by this plugin.
6080 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
6082 B<Note>: The traffic collected by this plugin accounts for the amount of
6083 traffic passing a socket which might be a lot less than the actual on-wire
6084 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
6085 collect on-wire traffic you could, for example, use the logging facilities of
6086 iptables to feed data for the guest IPs into the iptables plugin.
6088 =head2 Plugin C<write_graphite>
6090 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
6091 storage and graphing project. The plugin connects to I<Carbon>, the data layer
6092 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
6093 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
6094 of at most 1428 bytes to minimize the number of network packets.
6098 <Plugin write_graphite>
6108 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6109 blocks. Inside the B<Node> blocks, the following options are recognized:
6113 =item B<Host> I<Address>
6115 Hostname or address to connect to. Defaults to C<localhost>.
6117 =item B<Port> I<Service>
6119 Service name or port number to connect to. Defaults to C<2003>.
6121 =item B<Protocol> I<String>
6123 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
6125 =item B<LogSendErrors> B<false>|B<true>
6127 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
6128 If set to B<false>, it will not log the errors. This is especially useful when
6129 using Protocol UDP since many times we want to use the "fire-and-forget"
6130 approach and logging errors fills syslog with unneeded messages.
6132 =item B<Prefix> I<String>
6134 When set, I<String> is added in front of the host name. Dots and whitespace are
6135 I<not> escaped in this string (see B<EscapeCharacter> below).
6137 =item B<Postfix> I<String>
6139 When set, I<String> is appended to the host name. Dots and whitespace are
6140 I<not> escaped in this string (see B<EscapeCharacter> below).
6142 =item B<EscapeCharacter> I<Char>
6144 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
6145 in the identifier. The B<EscapeCharacter> option determines which character
6146 dots, whitespace and control characters are replaced with. Defaults to
6149 =item B<StoreRates> B<false>|B<true>
6151 If set to B<true> (the default), convert counter values to rates. If set to
6152 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6155 =item B<SeparateInstances> B<false>|B<true>
6157 If set to B<true>, the plugin instance and type instance will be in their own
6158 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6159 default), the plugin and plugin instance (and likewise the type and type
6160 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6162 =item B<AlwaysAppendDS> B<false>|B<true>
6164 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
6165 identifier. If set to B<false> (the default), this is only done when there is
6170 =head2 Plugin C<write_mongodb>
6172 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
6177 <Plugin "write_mongodb">
6186 The plugin can send values to multiple instances of I<MongoDB> by specifying
6187 one B<Node> block for each instance. Within the B<Node> blocks, the following
6188 options are available:
6192 =item B<Host> I<Address>
6194 Hostname or address to connect to. Defaults to C<localhost>.
6196 =item B<Port> I<Service>
6198 Service name or port number to connect to. Defaults to C<27017>.
6200 =item B<Timeout> I<Timeout>
6202 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
6203 Setting this option to zero means no timeout, which is the default.
6205 =item B<StoreRates> B<false>|B<true>
6207 If set to B<true> (the default), convert counter values to rates. If set to
6208 B<false> counter values are stored as is, i.e. as an increasing integer
6211 =item B<Database> I<Database>
6213 =item B<User> I<User>
6215 =item B<Password> I<Password>
6217 Sets the information used when authenticating to a I<MongoDB> database. The
6218 fields are optional (in which case no authentication is attempted), but if you
6219 want to use authentication all three fields must be set.
6223 =head2 Plugin C<write_http>
6225 This output plugin submits values to an http server by POST them using the
6226 PUTVAL plain-text protocol. Each destination you want to post data to needs to
6227 have one B<URL> block, within which the destination can be configured further,
6228 for example by specifying authentication data.
6232 <Plugin "write_http">
6233 <URL "http://example.com/post-collectd">
6239 B<URL> blocks need one string argument which is used as the URL to which data
6240 is posted. The following options are understood within B<URL> blocks.
6244 =item B<User> I<Username>
6246 Optional user name needed for authentication.
6248 =item B<Password> I<Password>
6250 Optional password needed for authentication.
6252 =item B<VerifyPeer> B<true>|B<false>
6254 Enable or disable peer SSL certificate verification. See
6255 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
6257 =item B<VerifyHost> B<true|false>
6259 Enable or disable peer host name verification. If enabled, the plugin checks if
6260 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
6261 matches the host name provided by the B<URL> option. If this identity check
6262 fails, the connection is aborted. Obviously, only works when connecting to a
6263 SSL enabled server. Enabled by default.
6265 =item B<CACert> I<File>
6267 File that holds one or more SSL certificates. If you want to use HTTPS you will
6268 possibly need this option. What CA certificates come bundled with C<libcurl>
6269 and are checked by default depends on the distribution you use.
6271 =item B<Format> B<Command>|B<JSON>
6273 Format of the output to generate. If set to B<Command>, will create output that
6274 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
6275 create output in the I<JavaScript Object Notation> (JSON).
6277 Defaults to B<Command>.
6279 =item B<StoreRates> B<true|false>
6281 If set to B<true>, convert counter values to rates. If set to B<false> (the
6282 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
6287 =head2 Plugin C<write_riemann>
6289 The I<write_riemann plugin> will send values to I<Riemann>, a powerfull stream
6290 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
6291 I<Riemann> using UDP packets.
6295 <Plugin "write_riemann">
6301 AlwaysAppendDS false
6307 The following options are understood by the I<write_riemann plugin>:
6311 =item E<lt>B<Node> I<Name>E<gt>
6313 The plugin's configuration consists of one or more B<Node> blocks. Each block
6314 is given a unique I<Name> and specifies one connection to an instance of
6315 I<Riemann>. Indise the B<Node> block, the following per-connection options are
6320 =item B<Host> I<Address>
6322 Hostname or address to connect to. Defaults to C<localhost>.
6324 =item B<Port> I<Service>
6326 Service name or port number to connect to. Defaults to C<5555>.
6328 =item B<Protocol> B<UDP>|B<TCP>
6330 Specify the protocol to use when communicating with I<Riemann>. Defaults to
6333 =item B<StoreRates> B<true>|B<false>
6335 If set to B<true> (the default), convert counter values to rates. If set to
6336 B<false> counter values are stored as is, i.e. as an increasing integer number.
6338 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
6339 converted values will have "rate" appended to the data source type, e.g.
6340 C<ds_type:derive:rate>.
6342 =item B<AlwaysAppendDS> B<false>|B<true>
6344 If set the B<true>, append the name of the I<Data Source> (DS) to the
6345 "service", i.e. the field that, together with the "host" field, uniquely
6346 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
6347 only done when there is more than one DS.
6349 =item B<TTLFactor> I<Factor>
6351 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
6352 event is considered active. I<collectd> populates this field based on the
6353 metrics interval setting. This setting controls the factor with which the
6354 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
6355 know exactly what you're doing, you should only increase this setting from its
6360 =item B<Tag> I<String>
6362 Add the given string as an additional tag to the metric being sent to
6367 =head1 THRESHOLD CONFIGURATION
6369 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
6370 we mean that the values are not only stored or sent somewhere, but that they
6371 are judged and, if a problem is recognized, acted upon. The only action
6372 collectd takes itself is to generate and dispatch a "notification". Plugins can
6373 register to receive notifications and perform appropriate further actions.
6375 Since systems and what you expect them to do differ a lot, you can configure
6376 B<thresholds> for your values freely. This gives you a lot of flexibility but
6377 also a lot of responsibility.
6379 Every time a value is out of range a notification is dispatched. This means
6380 that the idle percentage of your CPU needs to be less then the configured
6381 threshold only once for a notification to be generated. There's no such thing
6382 as a moving average or similar - at least not now.
6384 Also, all values that match a threshold are considered to be relevant or
6385 "interesting". As a consequence collectd will issue a notification if they are
6386 not received for B<Timeout> iterations. The B<Timeout> configuration option is
6387 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
6388 "2" (the default) and some hosts sends it's CPU statistics to the server every
6389 60 seconds, a notification will be dispatched after about 120 seconds. It may
6390 take a little longer because the timeout is checked only once each B<Interval>
6393 When a value comes within range again or is received after it was missing, an
6394 "OKAY-notification" is dispatched.
6396 Here is a configuration example to get you started. Read below for more
6409 <Plugin "interface">
6426 WarningMin 100000000
6432 There are basically two types of configuration statements: The C<Host>,
6433 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
6434 configured. The C<Plugin> and C<Type> blocks may be specified further using the
6435 C<Instance> option. You can combine the block by nesting the blocks, though
6436 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
6437 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
6438 C<Type> may not contain other blocks. If multiple blocks apply to the same
6439 value the most specific block is used.
6441 The other statements specify the threshold to configure. They B<must> be
6442 included in a C<Type> block. Currently the following statements are recognized:
6446 =item B<FailureMax> I<Value>
6448 =item B<WarningMax> I<Value>
6450 Sets the upper bound of acceptable values. If unset defaults to positive
6451 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
6452 will be created. If the value is greater than B<WarningMax> but less than (or
6453 equal to) B<FailureMax> a B<WARNING> notification will be created.
6455 =item B<FailureMin> I<Value>
6457 =item B<WarningMin> I<Value>
6459 Sets the lower bound of acceptable values. If unset defaults to negative
6460 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
6461 be created. If the value is less than B<WarningMin> but greater than (or equal
6462 to) B<FailureMin> a B<WARNING> notification will be created.
6464 =item B<DataSource> I<DSName>
6466 Some data sets have more than one "data source". Interesting examples are the
6467 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
6468 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
6469 system load data set, C<load>, even has three data sources: C<shortterm>,
6470 C<midterm>, and C<longterm>.
6472 Normally, all data sources are checked against a configured threshold. If this
6473 is undesirable, or if you want to specify different limits for each data
6474 source, you can use the B<DataSource> option to have a threshold apply only to
6477 =item B<Invert> B<true>|B<false>
6479 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
6480 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
6481 B<WarningMax>) are not okay. Defaults to B<false>.
6483 =item B<Persist> B<true>|B<false>
6485 Sets how often notifications are generated. If set to B<true> one notification
6486 will be generated for each value that is out of the acceptable range. If set to
6487 B<false> (the default) then a notification is only generated if a value is out
6488 of range but the previous value was okay.
6490 This applies to missing values, too: If set to B<true> a notification about a
6491 missing value is generated once every B<Interval> seconds. If set to B<false>
6492 only one such notification is generated until the value appears again.
6494 =item B<Percentage> B<true>|B<false>
6496 If set to B<true>, the minimum and maximum values given are interpreted as
6497 percentage value, relative to the other data sources. This is helpful for
6498 example for the "df" type, where you may want to issue a warning when less than
6499 5E<nbsp>% of the total space is available. Defaults to B<false>.
6501 =item B<Hits> I<Number>
6503 Delay creating the notification until the threshold has been passed I<Number>
6504 times. When a notification has been generated, or when a subsequent value is
6505 inside the threshold, the counter is reset. If, for example, a value is
6506 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
6507 will be dispatched at most once every 30E<nbsp>seconds.
6509 This is useful when short bursts are not a problem. If, for example, 100% CPU
6510 usage for up to a minute is normal (and data is collected every
6511 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
6513 =item B<Hysteresis> I<Number>
6515 When set to non-zero, a hysteresis value is applied when checking minimum and
6516 maximum bounds. This is useful for values that increase slowly and fluctuate a
6517 bit while doing so. When these values come close to the threshold, they may
6518 "flap", i.e. switch between failure / warning case and okay case repeatedly.
6520 If, for example, the threshold is configures as
6525 then a I<Warning> notification is created when the value exceeds I<101> and the
6526 corresponding I<Okay> notification is only created once the value falls below
6527 I<99>, thus avoiding the "flapping".
6531 =head1 FILTER CONFIGURATION
6533 Starting with collectd 4.6 there is a powerful filtering infrastructure
6534 implemented in the daemon. The concept has mostly been copied from
6535 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
6536 terminology, so that users that are familiar with iptables feel right at home.
6540 The following are the terms used in the remainder of the filter configuration
6541 documentation. For an ASCII-art schema of the mechanism, see
6542 L<"General structure"> below.
6548 A I<match> is a criteria to select specific values. Examples are, of course, the
6549 name of the value or it's current value.
6551 Matches are implemented in plugins which you have to load prior to using the
6552 match. The name of such plugins starts with the "match_" prefix.
6556 A I<target> is some action that is to be performed with data. Such actions
6557 could, for example, be to change part of the value's identifier or to ignore
6558 the value completely.
6560 Some of these targets are built into the daemon, see L<"Built-in targets">
6561 below. Other targets are implemented in plugins which you have to load prior to
6562 using the target. The name of such plugins starts with the "target_" prefix.
6566 The combination of any number of matches and at least one target is called a
6567 I<rule>. The target actions will be performed for all values for which B<all>
6568 matches apply. If the rule does not have any matches associated with it, the
6569 target action will be performed for all values.
6573 A I<chain> is a list of rules and possibly default targets. The rules are tried
6574 in order and if one matches, the associated target will be called. If a value
6575 is handled by a rule, it depends on the target whether or not any subsequent
6576 rules are considered or if traversal of the chain is aborted, see
6577 L<"Flow control"> below. After all rules have been checked, the default targets
6582 =head2 General structure
6584 The following shows the resulting structure:
6591 +---------+ +---------+ +---------+ +---------+
6592 ! Rule !->! Match !->! Match !->! Target !
6593 +---------+ +---------+ +---------+ +---------+
6596 +---------+ +---------+ +---------+
6597 ! Rule !->! Target !->! Target !
6598 +---------+ +---------+ +---------+
6605 +---------+ +---------+ +---------+
6606 ! Rule !->! Match !->! Target !
6607 +---------+ +---------+ +---------+
6617 There are four ways to control which way a value takes through the filter
6624 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
6625 process the value with another chain. When the called chain finishes, usually
6626 the next target or rule after the jump is executed.
6630 The stop condition, signaled for example by the built-in target B<stop>, causes
6631 all processing of the value to be stopped immediately.
6635 Causes processing in the current chain to be aborted, but processing of the
6636 value generally will continue. This means that if the chain was called via
6637 B<Jump>, the next target or rule after the jump will be executed. If the chain
6638 was not called by another chain, control will be returned to the daemon and it
6639 may pass the value to another chain.
6643 Most targets will signal the B<continue> condition, meaning that processing
6644 should continue normally. There is no special built-in target for this
6651 The configuration reflects this structure directly:
6653 PostCacheChain "PostCache"
6655 <Rule "ignore_mysql_show">
6658 Type "^mysql_command$"
6659 TypeInstance "^show_"
6669 The above configuration example will ignore all values where the plugin field
6670 is "mysql", the type is "mysql_command" and the type instance begins with
6671 "show_". All other values will be sent to the C<rrdtool> write plugin via the
6672 default target of the chain. Since this chain is run after the value has been
6673 added to the cache, the MySQL C<show_*> command statistics will be available
6674 via the C<unixsock> plugin.
6676 =head2 List of configuration options
6680 =item B<PreCacheChain> I<ChainName>
6682 =item B<PostCacheChain> I<ChainName>
6684 Configure the name of the "pre-cache chain" and the "post-cache chain". The
6685 argument is the name of a I<chain> that should be executed before and/or after
6686 the values have been added to the cache.
6688 To understand the implications, it's important you know what is going on inside
6689 I<collectd>. The following diagram shows how values are passed from the
6690 read-plugins to the write-plugins:
6696 + - - - - V - - - - +
6697 : +---------------+ :
6700 : +-------+-------+ :
6703 : +-------+-------+ : +---------------+
6704 : ! Cache !--->! Value Cache !
6705 : ! insert ! : +---+---+-------+
6706 : +-------+-------+ : ! !
6707 : ! ,------------' !
6709 : +-------+---+---+ : +-------+-------+
6710 : ! Post-Cache +--->! Write-Plugins !
6711 : ! Chain ! : +---------------+
6712 : +---------------+ :
6715 + - - - - - - - - - +
6717 After the values are passed from the "read" plugins to the dispatch functions,
6718 the pre-cache chain is run first. The values are added to the internal cache
6719 afterwards. The post-cache chain is run after the values have been added to the
6720 cache. So why is it such a huge deal if chains are run before or after the
6721 values have been added to this cache?
6723 Targets that change the identifier of a value list should be executed before
6724 the values are added to the cache, so that the name in the cache matches the
6725 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
6726 this cache to receive a list of all available values. If you change the
6727 identifier after the value list has been added to the cache, this may easily
6728 lead to confusion, but it's not forbidden of course.
6730 The cache is also used to convert counter values to rates. These rates are, for
6731 example, used by the C<value> match (see below). If you use the rate stored in
6732 the cache B<before> the new value is added, you will use the old, B<previous>
6733 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
6734 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
6737 Last but not last, the B<stop> target makes a difference: If the pre-cache
6738 chain returns the stop condition, the value will not be added to the cache and
6739 the post-cache chain will not be run.
6741 =item B<Chain> I<Name>
6743 Adds a new chain with a certain name. This name can be used to refer to a
6744 specific chain, for example to jump to it.
6746 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
6748 =item B<Rule> [I<Name>]
6750 Adds a new rule to the current chain. The name of the rule is optional and
6751 currently has no meaning for the daemon.
6753 Within the B<Rule> block, there may be any number of B<Match> blocks and there
6754 must be at least one B<Target> block.
6756 =item B<Match> I<Name>
6758 Adds a match to a B<Rule> block. The name specifies what kind of match should
6759 be performed. Available matches depend on the plugins that have been loaded.
6761 The arguments inside the B<Match> block are passed to the plugin implementing
6762 the match, so which arguments are valid here depends on the plugin being used.
6763 If you do not need any to pass any arguments to a match, you can use the
6768 Which is equivalent to:
6773 =item B<Target> I<Name>
6775 Add a target to a rule or a default target to a chain. The name specifies what
6776 kind of target is to be added. Which targets are available depends on the
6777 plugins being loaded.
6779 The arguments inside the B<Target> block are passed to the plugin implementing
6780 the target, so which arguments are valid here depends on the plugin being used.
6781 If you do not need any to pass any arguments to a target, you can use the
6786 This is the same as writing:
6793 =head2 Built-in targets
6795 The following targets are built into the core daemon and therefore need no
6796 plugins to be loaded:
6802 Signals the "return" condition, see the L<"Flow control"> section above. This
6803 causes the current chain to stop processing the value and returns control to
6804 the calling chain. The calling chain will continue processing targets and rules
6805 just after the B<jump> target (see below). This is very similar to the
6806 B<RETURN> target of iptables, see L<iptables(8)>.
6808 This target does not have any options.
6816 Signals the "stop" condition, see the L<"Flow control"> section above. This
6817 causes processing of the value to be aborted immediately. This is similar to
6818 the B<DROP> target of iptables, see L<iptables(8)>.
6820 This target does not have any options.
6828 Sends the value to "write" plugins.
6834 =item B<Plugin> I<Name>
6836 Name of the write plugin to which the data should be sent. This option may be
6837 given multiple times to send the data to more than one write plugin.
6841 If no plugin is explicitly specified, the values will be sent to all available
6852 Starts processing the rules of another chain, see L<"Flow control"> above. If
6853 the end of that chain is reached, or a stop condition is encountered,
6854 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
6855 next target or the next rule. This is similar to the B<-j> command line option
6856 of iptables, see L<iptables(8)>.
6862 =item B<Chain> I<Name>
6864 Jumps to the chain I<Name>. This argument is required and may appear only once.
6876 =head2 Available matches
6882 Matches a value using regular expressions.
6888 =item B<Host> I<Regex>
6890 =item B<Plugin> I<Regex>
6892 =item B<PluginInstance> I<Regex>
6894 =item B<Type> I<Regex>
6896 =item B<TypeInstance> I<Regex>
6898 Match values where the given regular expressions match the various fields of
6899 the identifier of a value. If multiple regular expressions are given, B<all>
6900 regexen must match for a value to match.
6902 =item B<Invert> B<false>|B<true>
6904 When set to B<true>, the result of the match is inverted, i.e. all value lists
6905 where all regular expressions apply are not matched, all other value lists are
6906 matched. Defaults to B<false>.
6913 Host "customer[0-9]+"
6919 Matches values that have a time which differs from the time on the server.
6921 This match is mainly intended for servers that receive values over the
6922 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
6923 is very sensitive to the timestamp used when updating the RRD files. In
6924 particular, the time must be ever increasing. If a misbehaving client sends one
6925 packet with a timestamp far in the future, all further packets with a correct
6926 time will be ignored because of that one packet. What's worse, such corrupted
6927 RRD files are hard to fix.
6929 This match lets one match all values B<outside> a specified time range
6930 (relative to the server's time), so you can use the B<stop> target (see below)
6931 to ignore the value, for example.
6937 =item B<Future> I<Seconds>
6939 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
6940 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
6943 =item B<Past> I<Seconds>
6945 Matches all values that are I<behind> of the server's time by I<Seconds> or
6946 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
6958 This example matches all values that are five minutes or more ahead of the
6959 server or one hour (or more) lagging behind.
6963 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
6964 values. If a data-set consists of more than one data-source, all data-sources
6965 must match the specified ranges for a positive match.
6971 =item B<Min> I<Value>
6973 Sets the smallest value which still results in a match. If unset, behaves like
6976 =item B<Max> I<Value>
6978 Sets the largest value which still results in a match. If unset, behaves like
6981 =item B<Invert> B<true>|B<false>
6983 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
6984 no-match is returned and vice versa. Please note that the B<Invert> setting
6985 only effects how B<Min> and B<Max> are applied to a specific value. Especially
6986 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
6988 =item B<DataSource> I<DSName> [I<DSName> ...]
6990 Select one or more of the data sources. If no data source is configured, all
6991 data sources will be checked. If the type handled by the match does not have a
6992 data source of the specified name(s), this will always result in no match
6993 (independent of the B<Invert> setting).
6995 =item B<Satisfy> B<Any>|B<All>
6997 Specifies how checking with several data sources is performed. If set to
6998 B<Any>, the match succeeds if one of the data sources is in the configured
6999 range. If set to B<All> the match only succeeds if all data sources are within
7000 the configured range. Default is B<All>.
7002 Usually B<All> is used for positive matches, B<Any> is used for negative
7003 matches. This means that with B<All> you usually check that all values are in a
7004 "good" range, while with B<Any> you check if any value is within a "bad" range
7005 (or outside the "good" range).
7009 Either B<Min> or B<Max>, but not both, may be unset.
7013 # Match all values smaller than or equal to 100. Matches only if all data
7014 # sources are below 100.
7020 # Match if the value of any data source is outside the range of 0 - 100.
7028 =item B<empty_counter>
7030 Matches all values with one or more data sources of type B<COUNTER> and where
7031 all counter values are zero. These counters usually I<never> increased since
7032 they started existing (and are therefore uninteresting), or got reset recently
7033 or overflowed and you had really, I<really> bad luck.
7035 Please keep in mind that ignoring such counters can result in confusing
7036 behavior: Counters which hardly ever increase will be zero for long periods of
7037 time. If the counter is reset for some reason (machine or service restarted,
7038 usually), the graph will be empty (NAN) for a long time. People may not
7043 Calculates a hash value of the host name and matches values according to that
7044 hash value. This makes it possible to divide all hosts into groups and match
7045 only values that are in a specific group. The intended use is in load
7046 balancing, where you want to handle only part of all data and leave the rest
7049 The hashing function used tries to distribute the hosts evenly. First, it
7050 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
7053 for (i = 0; host[i] != 0; i++)
7054 hash_value = (hash_value * 251) + host[i];
7056 The constant 251 is a prime number which is supposed to make this hash value
7057 more random. The code then checks the group for this host according to the
7058 I<Total> and I<Match> arguments:
7060 if ((hash_value % Total) == Match)
7065 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
7066 groups), then the least significant bit of the hash value will be the XOR of
7067 all least significant bits in the host name. One consequence is that when you
7068 have two hosts, "server0.example.com" and "server1.example.com", where the host
7069 name differs in one digit only and the digits differ by one, those hosts will
7070 never end up in the same group.
7076 =item B<Match> I<Match> I<Total>
7078 Divide the data into I<Total> groups and match all hosts in group I<Match> as
7079 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
7080 be smaller than I<Total>. I<Total> must be at least one, although only values
7081 greater than one really do make any sense.
7083 You can repeat this option to match multiple groups, for example:
7088 The above config will divide the data into seven groups and match groups three
7089 and five. One use would be to keep every value on two hosts so that if one
7090 fails the missing data can later be reconstructed from the second host.
7096 # Operate on the pre-cache chain, so that ignored values are not even in the
7101 # Divide all received hosts in seven groups and accept all hosts in
7105 # If matched: Return and continue.
7108 # If not matched: Return and stop.
7114 =head2 Available targets
7118 =item B<notification>
7120 Creates and dispatches a notification.
7126 =item B<Message> I<String>
7128 This required option sets the message of the notification. The following
7129 placeholders will be replaced by an appropriate value:
7137 =item B<%{plugin_instance}>
7141 =item B<%{type_instance}>
7143 These placeholders are replaced by the identifier field of the same name.
7145 =item B<%{ds:>I<name>B<}>
7147 These placeholders are replaced by a (hopefully) human readable representation
7148 of the current rate of this data source. If you changed the instance name
7149 (using the B<set> or B<replace> targets, see below), it may not be possible to
7150 convert counter values to rates.
7154 Please note that these placeholders are B<case sensitive>!
7156 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
7158 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
7165 <Target "notification">
7166 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
7172 Replaces parts of the identifier using regular expressions.
7178 =item B<Host> I<Regex> I<Replacement>
7180 =item B<Plugin> I<Regex> I<Replacement>
7182 =item B<PluginInstance> I<Regex> I<Replacement>
7184 =item B<TypeInstance> I<Regex> I<Replacement>
7186 Match the appropriate field with the given regular expression I<Regex>. If the
7187 regular expression matches, that part that matches is replaced with
7188 I<Replacement>. If multiple places of the input buffer match a given regular
7189 expression, only the first occurrence will be replaced.
7191 You can specify each option multiple times to use multiple regular expressions
7199 # Replace "example.net" with "example.com"
7200 Host "\\<example.net\\>" "example.com"
7202 # Strip "www." from hostnames
7208 Sets part of the identifier of a value to a given string.
7214 =item B<Host> I<String>
7216 =item B<Plugin> I<String>
7218 =item B<PluginInstance> I<String>
7220 =item B<TypeInstance> I<String>
7222 Set the appropriate field to the given string. The strings for plugin instance
7223 and type instance may be empty, the strings for host and plugin may not be
7224 empty. It's currently not possible to set the type of a value this way.
7231 PluginInstance "coretemp"
7232 TypeInstance "core3"
7237 =head2 Backwards compatibility
7239 If you use collectd with an old configuration, i.E<nbsp>e. one without a
7240 B<Chain> block, it will behave as it used to. This is equivalent to the
7241 following configuration:
7247 If you specify a B<PostCacheChain>, the B<write> target will not be added
7248 anywhere and you will have to make sure that it is called where appropriate. We
7249 suggest to add the above snippet as default target to your "PostCache" chain.
7253 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
7269 L<collectd-exec(5)>,
7270 L<collectd-perl(5)>,
7271 L<collectd-unixsock(5)>,
7284 Florian Forster E<lt>octo@verplant.orgE<gt>