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<ceph>
955 The ceph plugin collects values from JSON data to be parsed by B<libyajl>
956 (L<https://lloyd.github.io/yajl/>) retrieved from ceph daemon admin sockets.
958 A separate B<Daemon> block must be configured for each ceph daemon to be
959 monitored. The following example will read daemon statistics from four
960 separate ceph daemons running on the same device (two OSDs, one MON, one MDS) :
963 LongRunAvgLatency false
964 ConvertSpecialMetricTypes true
966 SocketPath "/var/run/ceph/ceph-osd.0.asok"
969 SocketPath "/var/run/ceph/ceph-osd.1.asok"
972 SocketPath "/var/run/ceph/ceph-mon.ceph1.asok"
975 SocketPath "/var/run/ceph/ceph-mds.ceph1.asok"
979 The ceph plugin accepts the following configuration options:
983 =item B<LongRunAvgLatency> B<true>|B<false>
985 If enabled, latency values(sum,count pairs) are calculated as the long run
986 average - average since the ceph daemon was started = (sum / count).
987 When disabled, latency values are calculated as the average since the last
988 collection = (sum_now - sum_last) / (count_now - count_last).
992 =item B<ConvertSpecialMetricTypes> B<true>|B<false>
994 If enabled, special metrics (metrics that differ in type from similar counters)
995 are converted to the type of those similar counters. This currently only
996 applies to filestore.journal_wr_bytes which is a counter for OSD daemons. The
997 ceph schema reports this metric type as a sum,count pair while similar counters
998 are treated as derive types. When converted, the sum is used as the counter
999 value and is treated as a derive type.
1000 When disabled, all metrics are treated as the types received from the ceph schema.
1006 Each B<Daemon> block must have a string argument for the plugin instance name.
1007 A B<SocketPath> is also required for each B<Daemon> block:
1009 =item B<Daemon> I<DaemonName>
1011 Name to be used as the instance name for this daemon.
1015 =item B<SocketPath> I<SocketPath>
1017 Specifies the path to the UNIX admin socket of the ceph daemon.
1023 =head2 Plugin C<cgroups>
1025 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1026 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1027 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1031 =item B<CGroup> I<Directory>
1033 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1034 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1037 =item B<IgnoreSelected> B<true>|B<false>
1039 Invert the selection: If set to true, all cgroups I<except> the ones that
1040 match any one of the criteria are collected. By default only selected
1041 cgroups are collected if a selection is made. If no selection is configured
1042 at all, B<all> cgroups are selected.
1046 =head2 Plugin C<cpu>
1048 The I<CPU plugin> collects CPU usage metrics.
1050 The following configuration options are available:
1054 =item B<ReportActive> B<false>|B<true>
1056 Reports non-idle CPU usage as the "active" value. Defaults to false.
1058 =item B<ReportByCpu> B<false>|B<true>
1060 When true reports usage for all cores. When false, reports cpu usage
1061 aggregated over all cores. Implies ValuesPercentage when false.
1064 =item B<ValuesPercentage> B<false>|B<true>
1066 When true report percentage usage instead of tick values. Defaults to false.
1071 =head2 Plugin C<cpufreq>
1073 This plugin doesn't have any options. It reads
1074 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1075 installed) to get the current CPU frequency. If this file does not exist make
1076 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1077 installed and an "cpu governor" (that's a kernel module) is loaded.
1079 =head2 Plugin C<csv>
1083 =item B<DataDir> I<Directory>
1085 Set the directory to store CSV-files under. Per default CSV-files are generated
1086 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1087 The special strings B<stdout> and B<stderr> can be used to write to the standard
1088 output and standard error channels, respectively. This, of course, only makes
1089 much sense when collectd is running in foreground- or non-daemon-mode.
1091 =item B<StoreRates> B<true|false>
1093 If set to B<true>, convert counter values to rates. If set to B<false> (the
1094 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1099 =head2 Plugin C<curl>
1101 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1102 and the match infrastructure (the same code used by the tail plugin) to use
1103 regular expressions with the received data.
1105 The following example will read the current value of AMD stock from Google's
1106 finance page and dispatch the value to collectd.
1109 <Page "stock_quotes">
1110 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1114 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1115 DSType "GaugeAverage"
1116 # Note: `stock_value' is not a standard type.
1123 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1124 a web page and one or more "matches" to be performed on the returned data. The
1125 string argument to the B<Page> block is used as plugin instance.
1127 The following options are valid within B<Page> blocks:
1133 URL of the web site to retrieve. Since a regular expression will be used to
1134 extract information from this data, non-binary data is a big plus here ;)
1136 =item B<User> I<Name>
1138 Username to use if authorization is required to read the page.
1140 =item B<Password> I<Password>
1142 Password to use if authorization is required to read the page.
1144 =item B<Digest> B<true>|B<false>
1146 Enable HTTP digest authentication.
1148 =item B<VerifyPeer> B<true>|B<false>
1150 Enable or disable peer SSL certificate verification. See
1151 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1153 =item B<VerifyHost> B<true>|B<false>
1155 Enable or disable peer host name verification. If enabled, the plugin checks if
1156 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1157 matches the host name provided by the B<URL> option. If this identity check
1158 fails, the connection is aborted. Obviously, only works when connecting to a
1159 SSL enabled server. Enabled by default.
1161 =item B<CACert> I<file>
1163 File that holds one or more SSL certificates. If you want to use HTTPS you will
1164 possibly need this option. What CA certificates come bundled with C<libcurl>
1165 and are checked by default depends on the distribution you use.
1167 =item B<Header> I<Header>
1169 A HTTP header to add to the request. Multiple headers are added if this option
1170 is specified more than once.
1172 =item B<Post> I<Body>
1174 Specifies that the HTTP operation should be a POST instead of a GET. The
1175 complete data to be posted is given as the argument. This option will usually
1176 need to be accompanied by a B<Header> option to set an appropriate
1177 C<Content-Type> for the post body (e.g. to
1178 C<application/x-www-form-urlencoded>).
1180 =item B<MeasureResponseTime> B<true>|B<false>
1182 Measure response time for the request. If this setting is enabled, B<Match>
1183 blocks (see below) are optional. Disabled by default.
1185 =item B<E<lt>MatchE<gt>>
1187 One or more B<Match> blocks that define how to match information in the data
1188 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1189 used by the C<tail> plugin, so please see the documentation of the C<tail>
1190 plugin below on how matches are defined. If the B<MeasureResponseTime> option
1191 is set to B<true>, B<Match> blocks are optional.
1195 =head2 Plugin C<curl_json>
1197 The B<curl_json plugin> collects values from JSON data to be parsed by
1198 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) retrieved via
1199 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1200 unix socket. The former can be used, for example, to collect values
1201 from CouchDB documents (which are stored JSON notation), and the
1202 latter to collect values from a uWSGI stats socket.
1204 The following example will collect several values from the built-in
1205 C<_stats> runtime statistics module of I<CouchDB>
1206 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1209 <URL "http://localhost:5984/_stats">
1211 <Key "httpd/requests/count">
1212 Type "http_requests"
1215 <Key "httpd_request_methods/*/count">
1216 Type "http_request_methods"
1219 <Key "httpd_status_codes/*/count">
1220 Type "http_response_codes"
1225 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1228 <Sock "/var/run/uwsgi.stats.sock">
1230 <Key "workers/*/requests">
1231 Type "http_requests"
1234 <Key "workers/*/apps/*/requests">
1235 Type "http_requests"
1240 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1241 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1242 blocks defining a unix socket to read JSON from directly. Each of
1243 these blocks may have one or more B<Key> blocks.
1245 The B<Key> string argument must be in a path format. Each component is
1246 used to match the key from a JSON map or the index of an JSON
1247 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1248 values for all map keys or array indices will be collectd.
1250 The following options are valid within B<URL> blocks:
1254 =item B<Instance> I<Instance>
1256 Sets the plugin instance to I<Instance>.
1258 =item B<User> I<Name>
1260 =item B<Password> I<Password>
1262 =item B<Digest> B<true>|B<false>
1264 =item B<VerifyPeer> B<true>|B<false>
1266 =item B<VerifyHost> B<true>|B<false>
1268 =item B<CACert> I<file>
1270 =item B<Header> I<Header>
1272 =item B<Post> I<Body>
1274 These options behave exactly equivalent to the appropriate options of the
1275 I<cURL> plugin. Please see there for a detailed description.
1279 The following options are valid within B<Key> blocks:
1283 =item B<Type> I<Type>
1285 Sets the type used to dispatch the values to the daemon. Detailed information
1286 about types and their configuration can be found in L<types.db(5)>. This
1287 option is mandatory.
1289 =item B<Instance> I<Instance>
1291 Type-instance to use. Defaults to the current map key or current string array element value.
1295 =head2 Plugin C<curl_xml>
1297 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1298 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1301 <URL "http://localhost/stats.xml">
1303 Instance "some_instance"
1308 CACert "/path/to/ca.crt"
1310 <XPath "table[@id=\"magic_level\"]/tr">
1312 #InstancePrefix "prefix-"
1313 InstanceFrom "td[1]"
1314 ValuesFrom "td[2]/span[@class=\"level\"]"
1319 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1320 URL to be fetched using libcurl. Within each B<URL> block there are
1321 options which specify the connection parameters, for example authentication
1322 information, and one or more B<XPath> blocks.
1324 Each B<XPath> block specifies how to get one type of information. The
1325 string argument must be a valid XPath expression which returns a list
1326 of "base elements". One value is dispatched for each "base element". The
1327 I<type instance> and values are looked up using further I<XPath> expressions
1328 that should be relative to the base element.
1330 Within the B<URL> block the following options are accepted:
1334 =item B<Host> I<Name>
1336 Use I<Name> as the host name when submitting values. Defaults to the global
1339 =item B<Instance> I<Instance>
1341 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1342 empty string (no plugin instance).
1344 =item B<Namespace> I<Prefix> I<URL>
1346 If an XPath expression references namespaces, they must be specified
1347 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1348 I<URL> is the "namespace name", an URI reference uniquely identifying the
1349 namespace. The option can be repeated to register multiple namespaces.
1353 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1354 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1356 =item B<User> I<User>
1358 =item B<Password> I<Password>
1360 =item B<Digest> B<true>|B<false>
1362 =item B<VerifyPeer> B<true>|B<false>
1364 =item B<VerifyHost> B<true>|B<false>
1366 =item B<CACert> I<CA Cert File>
1368 =item B<Header> I<Header>
1370 =item B<Post> I<Body>
1372 These options behave exactly equivalent to the appropriate options of the
1373 I<cURL plugin>. Please see there for a detailed description.
1375 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1377 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1378 B<XPath> block specifies how to get one type of information. The string
1379 argument must be a valid XPath expression which returns a list of "base
1380 elements". One value is dispatched for each "base element".
1382 Within the B<XPath> block the following options are accepted:
1386 =item B<Type> I<Type>
1388 Specifies the I<Type> used for submitting patches. This determines the number
1389 of values that are required / expected and whether the strings are parsed as
1390 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1391 This option is required.
1393 =item B<InstancePrefix> I<InstancePrefix>
1395 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1396 concatenated together without any separator.
1397 This option is optional.
1399 =item B<InstanceFrom> I<InstanceFrom>
1401 Specifies a XPath expression to use for determining the I<type instance>. The
1402 XPath expression must return exactly one element. The element's value is then
1403 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1405 This value is required. As a special exception, if the "base XPath expression"
1406 (the argument to the B<XPath> block) returns exactly one argument, then this
1407 option may be omitted.
1409 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1411 Specifies one or more XPath expression to use for reading the values. The
1412 number of XPath expressions must match the number of data sources in the
1413 I<type> specified with B<Type> (see above). Each XPath expression must return
1414 exactly one element. The element's value is then parsed as a number and used as
1415 value for the appropriate value in the value list dispatched to the daemon.
1421 =head2 Plugin C<dbi>
1423 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1424 connect to various databases, execute I<SQL> statements and read back the
1425 results. I<dbi> is an acronym for "database interface" in case you were
1426 wondering about the name. You can configure how each column is to be
1427 interpreted and the plugin will generate one or more data sets from each row
1428 returned according to these rules.
1430 Because the plugin is very generic, the configuration is a little more complex
1431 than those of other plugins. It usually looks something like this:
1434 <Query "out_of_stock">
1435 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1436 # Use with MySQL 5.0.0 or later
1440 InstancePrefix "out_of_stock"
1441 InstancesFrom "category"
1445 <Database "product_information">
1447 DriverOption "host" "localhost"
1448 DriverOption "username" "collectd"
1449 DriverOption "password" "aZo6daiw"
1450 DriverOption "dbname" "prod_info"
1451 SelectDB "prod_info"
1452 Query "out_of_stock"
1456 The configuration above defines one query with one result and one database. The
1457 query is then linked to the database with the B<Query> option I<within> the
1458 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1459 and you can also use the B<Include> statement to split up the configuration
1460 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1461 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1464 The following is a complete list of options:
1466 =head3 B<Query> blocks
1468 Query blocks define I<SQL> statements and how the returned data should be
1469 interpreted. They are identified by the name that is given in the opening line
1470 of the block. Thus the name needs to be unique. Other than that, the name is
1471 not used in collectd.
1473 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1474 define which column holds which value or instance information. You can use
1475 multiple B<Result> blocks to create multiple values from one returned row. This
1476 is especially useful, when queries take a long time and sending almost the same
1477 query again and again is not desirable.
1481 <Query "environment">
1482 Statement "select station, temperature, humidity from environment"
1485 # InstancePrefix "foo"
1486 InstancesFrom "station"
1487 ValuesFrom "temperature"
1491 InstancesFrom "station"
1492 ValuesFrom "humidity"
1496 The following options are accepted:
1500 =item B<Statement> I<SQL>
1502 Sets the statement that should be executed on the server. This is B<not>
1503 interpreted by collectd, but simply passed to the database server. Therefore,
1504 the SQL dialect that's used depends on the server collectd is connected to.
1506 The query has to return at least two columns, one for the instance and one
1507 value. You cannot omit the instance, even if the statement is guaranteed to
1508 always return exactly one line. In that case, you can usually specify something
1511 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1513 (That works with MySQL but may not be valid SQL according to the spec. If you
1514 use a more strict database server, you may have to select from a dummy table or
1517 Please note that some databases, for example B<Oracle>, will fail if you
1518 include a semicolon at the end of the statement.
1520 =item B<MinVersion> I<Version>
1522 =item B<MaxVersion> I<Value>
1524 Only use this query for the specified database version. You can use these
1525 options to provide multiple queries with the same name but with a slightly
1526 different syntax. The plugin will use only those queries, where the specified
1527 minimum and maximum versions fit the version of the database in use.
1529 The database version is determined by C<dbi_conn_get_engine_version>, see the
1530 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1531 for details. Basically, each part of the version is assumed to be in the range
1532 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1533 "40102", version "5.0.42" becomes "50042".
1535 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1536 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1537 happen. Don't to it! A valid example would be something along these lines:
1548 In the above example, there are three ranges that don't overlap. The last one
1549 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1550 before "4.0.0" are not specified.
1552 =item B<Type> I<Type>
1554 The B<type> that's used for each line returned. See L<types.db(5)> for more
1555 details on how types are defined. In short: A type is a predefined layout of
1556 data and the number of values and type of values has to match the type
1559 If you specify "temperature" here, you need exactly one gauge column. If you
1560 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1563 There must be exactly one B<Type> option inside each B<Result> block.
1565 =item B<InstancePrefix> I<prefix>
1567 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1568 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1569 all strings returned in the appropriate columns are concatenated together,
1570 separated by dashes I<("-")>.
1572 =item B<InstancesFrom> I<column0> [I<column1> ...]
1574 Specifies the columns whose values will be used to create the "type-instance"
1575 for each row. If you specify more than one column, the value of all columns
1576 will be joined together with dashes I<("-")> as separation characters.
1578 The plugin itself does not check whether or not all built instances are
1579 different. It's your responsibility to assure that each is unique. This is
1580 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1581 sure that only one row is returned in this case.
1583 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1586 =item B<ValuesFrom> I<column0> [I<column1> ...]
1588 Names the columns whose content is used as the actual data for the data sets
1589 that are dispatched to the daemon. How many such columns you need is determined
1590 by the B<Type> setting above. If you specify too many or not enough columns,
1591 the plugin will complain about that and no data will be submitted to the
1594 The actual data type in the columns is not that important. The plugin will
1595 automatically cast the values to the right type if it know how to do that. So
1596 it should be able to handle integer an floating point types, as well as strings
1597 (if they include a number at the beginning).
1599 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1603 =head3 B<Database> blocks
1605 Database blocks define a connection to a database and which queries should be
1606 sent to that database. Since the used "dbi" library can handle a wide variety
1607 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1608 documentationE<nbsp>- we stick as close to the terminology used there.
1610 Each database needs a "name" as string argument in the starting tag of the
1611 block. This name will be used as "PluginInstance" in the values submitted to
1612 the daemon. Other than that, that name is not used.
1616 =item B<Driver> I<Driver>
1618 Specifies the driver to use to connect to the database. In many cases those
1619 drivers are named after the database they can connect to, but this is not a
1620 technical necessity. These drivers are sometimes referred to as "DBD",
1621 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1622 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1623 project at L<http://libdbi-drivers.sourceforge.net/>.
1625 You need to give the driver name as expected by the "dbi" library here. You
1626 should be able to find that in the documentation for each driver. If you
1627 mistype the driver name, the plugin will dump a list of all known driver names
1630 =item B<DriverOption> I<Key> I<Value>
1632 Sets driver-specific options. What option a driver supports can be found in the
1633 documentation for each driver, somewhere at
1634 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1635 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1637 DBDs can register two types of options: String options and numeric options. The
1638 plugin will use the C<dbi_conn_set_option> function when the configuration
1639 provides a string and the C<dbi_conn_require_option_numeric> function when the
1640 configuration provides a number. So these two lines will actually result in
1641 different calls being used:
1643 DriverOption "Port" 1234 # numeric
1644 DriverOption "Port" "1234" # string
1646 Unfortunately, drivers are not too keen to report errors when an unknown option
1647 is passed to them, so invalid settings here may go unnoticed. This is not the
1648 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1649 the driver. If a driver complains about an option, the plugin will dump a
1650 complete list of all options understood by that driver to the log. There is no
1651 way to programatically find out if an option expects a string or a numeric
1652 argument, so you will have to refer to the appropriate DBD's documentation to
1653 find this out. Sorry.
1655 =item B<SelectDB> I<Database>
1657 In some cases, the database name you connect with is not the database name you
1658 want to use for querying data. If this option is set, the plugin will "select"
1659 (switch to) that database after the connection is established.
1661 =item B<Query> I<QueryName>
1663 Associates the query named I<QueryName> with this database connection. The
1664 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1665 blocks you want to refer to must be placed above the database block you want to
1668 =item B<Host> I<Hostname>
1670 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
1671 values. Defaults to the global hostname setting.
1679 =item B<Device> I<Device>
1681 Select partitions based on the devicename.
1683 =item B<MountPoint> I<Directory>
1685 Select partitions based on the mountpoint.
1687 =item B<FSType> I<FSType>
1689 Select partitions based on the filesystem type.
1691 =item B<IgnoreSelected> B<true>|B<false>
1693 Invert the selection: If set to true, all partitions B<except> the ones that
1694 match any one of the criteria are collected. By default only selected
1695 partitions are collected if a selection is made. If no selection is configured
1696 at all, B<all> partitions are selected.
1698 =item B<ReportByDevice> B<true>|B<false>
1700 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1701 (the default), it will report a disk as "root", but with it I<true>, it will be
1702 "sda1" (or whichever).
1704 =item B<ReportInodes> B<true>|B<false>
1706 Enables or disables reporting of free, reserved and used inodes. Defaults to
1707 inode collection being disabled.
1709 Enable this option if inodes are a scarce resource for you, usually because
1710 many small files are stored on the disk. This is a usual scenario for mail
1711 transfer agents and web caches.
1713 =item B<ValuesAbsolute> B<true>|B<false>
1715 Enables or disables reporting of free and used disk space in 1K-blocks.
1716 Defaults to B<true>.
1718 =item B<ValuesPercentage> B<false>|B<true>
1720 Enables or disables reporting of free and used disk space in percentage.
1721 Defaults to B<false>.
1723 This is useful for deploying I<collectd> on the cloud, where machines with
1724 different disk size may exist. Then it is more practical to configure
1725 thresholds based on relative disk size.
1729 =head2 Plugin C<disk>
1731 The C<disk> plugin collects information about the usage of physical disks and
1732 logical disks (partitions). Values collected are the number of octets written
1733 to and read from a disk or partition, the number of read/write operations
1734 issued to the disk and a rather complex "time" it took for these commands to be
1737 Using the following two options you can ignore some disks or configure the
1738 collection only of specific disks.
1742 =item B<Disk> I<Name>
1744 Select the disk I<Name>. Whether it is collected or ignored depends on the
1745 B<IgnoreSelected> setting, see below. As with other plugins that use the
1746 daemon's ignorelist functionality, a string that starts and ends with a slash
1747 is interpreted as a regular expression. Examples:
1752 =item B<IgnoreSelected> B<true>|B<false>
1754 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1755 statements, are ignored or if all other disks are ignored. The behavior
1756 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1757 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1758 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1759 is set to B<true>, all disks are collected B<except> the ones matched.
1763 =head2 Plugin C<dns>
1767 =item B<Interface> I<Interface>
1769 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1770 option sets the interface that should be used. If this option is not set, or
1771 set to "any", the plugin will try to get packets from B<all> interfaces. This
1772 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1774 =item B<IgnoreSource> I<IP-address>
1776 Ignore packets that originate from this address.
1778 =item B<SelectNumericQueryTypes> B<true>|B<false>
1780 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1784 =head2 Plugin C<email>
1788 =item B<SocketFile> I<Path>
1790 Sets the socket-file which is to be created.
1792 =item B<SocketGroup> I<Group>
1794 If running as root change the group of the UNIX-socket after it has been
1795 created. Defaults to B<collectd>.
1797 =item B<SocketPerms> I<Permissions>
1799 Change the file permissions of the UNIX-socket after it has been created. The
1800 permissions must be given as a numeric, octal value as you would pass to
1801 L<chmod(1)>. Defaults to B<0770>.
1803 =item B<MaxConns> I<Number>
1805 Sets the maximum number of connections that can be handled in parallel. Since
1806 this many threads will be started immediately setting this to a very high
1807 value will waste valuable resources. Defaults to B<5> and will be forced to be
1808 at most B<16384> to prevent typos and dumb mistakes.
1812 =head2 Plugin C<ethstat>
1814 The I<ethstat plugin> collects information about network interface cards (NICs)
1815 by talking directly with the underlying kernel driver using L<ioctl(2)>.
1821 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
1822 Map "multicast" "if_multicast"
1829 =item B<Interface> I<Name>
1831 Collect statistical information about interface I<Name>.
1833 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
1835 By default, the plugin will submit values as type C<derive> and I<type
1836 instance> set to I<Name>, the name of the metric as reported by the driver. If
1837 an appropriate B<Map> option exists, the given I<Type> and, optionally,
1838 I<TypeInstance> will be used.
1840 =item B<MappedOnly> B<true>|B<false>
1842 When set to B<true>, only metrics that can be mapped to to a I<type> will be
1843 collected, all other metrics will be ignored. Defaults to B<false>.
1847 =head2 Plugin C<exec>
1849 Please make sure to read L<collectd-exec(5)> before using this plugin. It
1850 contains valuable information on when the executable is executed and the
1851 output that is expected from it.
1855 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1857 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1859 Execute the executable I<Executable> as user I<User>. If the user name is
1860 followed by a colon and a group name, the effective group is set to that group.
1861 The real group and saved-set group will be set to the default group of that
1862 user. If no group is given the effective group ID will be the same as the real
1865 Please note that in order to change the user and/or group the daemon needs
1866 superuser privileges. If the daemon is run as an unprivileged user you must
1867 specify the same user/group here. If the daemon is run with superuser
1868 privileges, you must supply a non-root user here.
1870 The executable may be followed by optional arguments that are passed to the
1871 program. Please note that due to the configuration parsing numbers and boolean
1872 values may be changed. If you want to be absolutely sure that something is
1873 passed as-is please enclose it in quotes.
1875 The B<Exec> and B<NotificationExec> statements change the semantics of the
1876 programs executed, i.E<nbsp>e. the data passed to them and the response
1877 expected from them. This is documented in great detail in L<collectd-exec(5)>.
1881 =head2 Plugin C<filecount>
1883 The C<filecount> plugin counts the number of files in a certain directory (and
1884 its subdirectories) and their combined size. The configuration is very straight
1887 <Plugin "filecount">
1888 <Directory "/var/qmail/queue/mess">
1889 Instance "qmail-message"
1891 <Directory "/var/qmail/queue/todo">
1892 Instance "qmail-todo"
1894 <Directory "/var/lib/php5">
1895 Instance "php5-sessions"
1900 The example above counts the number of files in QMail's queue directories and
1901 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
1902 QMail has not yet looked at, the "message" queue holds the messages that were
1903 classified into "local" and "remote".
1905 As you can see, the configuration consists of one or more C<Directory> blocks,
1906 each of which specifies a directory in which to count the files. Within those
1907 blocks, the following options are recognized:
1911 =item B<Instance> I<Instance>
1913 Sets the plugin instance to I<Instance>. That instance name must be unique, but
1914 it's your responsibility, the plugin doesn't check for that. If not given, the
1915 instance is set to the directory name with all slashes replaced by underscores
1916 and all leading underscores removed.
1918 =item B<Name> I<Pattern>
1920 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
1921 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
1922 against the pattern, not the entire path. In case this makes it easier for you:
1923 This option has been named after the B<-name> parameter to L<find(1)>.
1925 =item B<MTime> I<Age>
1927 Count only files of a specific age: If I<Age> is greater than zero, only files
1928 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
1929 a negative number, this is inversed. For example, if B<-60> is specified, only
1930 files that have been modified in the last minute will be counted.
1932 The number can also be followed by a "multiplier" to easily specify a larger
1933 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
1934 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
1935 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
1936 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
1937 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
1940 =item B<Size> I<Size>
1942 Count only files of a specific size. When I<Size> is a positive number, only
1943 files that are at least this big are counted. If I<Size> is a negative number,
1944 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
1945 I<Size> are counted.
1947 As with the B<MTime> option, a "multiplier" may be added. For a detailed
1948 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
1949 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
1950 note that there are 1000 bytes in a kilobyte, not 1024.
1952 =item B<Recursive> I<true>|I<false>
1954 Controls whether or not to recurse into subdirectories. Enabled by default.
1956 =item B<IncludeHidden> I<true>|I<false>
1958 Controls whether or not to include "hidden" files and directories in the count.
1959 "Hidden" files and directories are those, whose name begins with a dot.
1960 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
1964 =head2 Plugin C<GenericJMX>
1966 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
1967 L<collectd-java(5)>.
1969 =head2 Plugin C<gmond>
1971 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
1972 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
1973 are built-in, custom mappings may be added via B<Metric> blocks, see below.
1978 MCReceiveFrom "239.2.11.71" "8649"
1979 <Metric "swap_total">
1981 TypeInstance "total"
1984 <Metric "swap_free">
1991 The following metrics are built-in:
1997 load_one, load_five, load_fifteen
2001 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2005 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2017 Available configuration options:
2021 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2023 Sets sets the multicast group and UDP port to which to subscribe.
2025 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2027 =item E<lt>B<Metric> I<Name>E<gt>
2029 These blocks add a new metric conversion to the internal table. I<Name>, the
2030 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2034 =item B<Type> I<Type>
2036 Type to map this metric to. Required.
2038 =item B<TypeInstance> I<Instance>
2040 Type-instance to use. Optional.
2042 =item B<DataSource> I<Name>
2044 Data source to map this metric to. If the configured type has exactly one data
2045 source, this is optional. Otherwise the option is required.
2051 =head2 Plugin C<hddtemp>
2053 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
2054 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
2055 default values, see below. C<hddtemp> has to be running to work correctly. If
2056 C<hddtemp> is not running timeouts may appear which may interfere with other
2059 The B<hddtemp> homepage can be found at
2060 L<http://www.guzu.net/linux/hddtemp.php>.
2064 =item B<Host> I<Hostname>
2066 Hostname to connect to. Defaults to B<127.0.0.1>.
2068 =item B<Port> I<Port>
2070 TCP-Port to connect to. Defaults to B<7634>.
2074 =head2 Plugin C<interface>
2078 =item B<Interface> I<Interface>
2080 Select this interface. By default these interfaces will then be collected. For
2081 a more detailed description see B<IgnoreSelected> below.
2083 =item B<IgnoreSelected> I<true>|I<false>
2085 If no configuration if given, the B<traffic>-plugin will collect data from
2086 all interfaces. This may not be practical, especially for loopback- and
2087 similar interfaces. Thus, you can use the B<Interface>-option to pick the
2088 interfaces you're interested in. Sometimes, however, it's easier/preferred
2089 to collect all interfaces I<except> a few ones. This option enables you to
2090 do that: By setting B<IgnoreSelected> to I<true> the effect of
2091 B<Interface> is inverted: All selected interfaces are ignored and all
2092 other interfaces are collected.
2096 =head2 Plugin C<ipmi>
2100 =item B<Sensor> I<Sensor>
2102 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2104 =item B<IgnoreSelected> I<true>|I<false>
2106 If no configuration if given, the B<ipmi> plugin will collect data from all
2107 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2108 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2109 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2110 all other sensors are collected.
2112 =item B<NotifySensorAdd> I<true>|I<false>
2114 If a sensor appears after initialization time of a minute a notification
2117 =item B<NotifySensorRemove> I<true>|I<false>
2119 If a sensor disappears a notification is sent.
2121 =item B<NotifySensorNotPresent> I<true>|I<false>
2123 If you have for example dual power supply and one of them is (un)plugged then
2124 a notification is sent.
2128 =head2 Plugin C<iptables>
2132 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2134 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
2135 will collect the counters of all rules which have a comment-match. The comment
2136 is then used as type-instance.
2138 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2139 the I<n>th rule will be collected. Again, the comment (or the number) will be
2140 used as the type-instance.
2142 If I<Name> is supplied, it will be used as the type-instance instead of the
2143 comment or the number.
2147 =head2 Plugin C<irq>
2153 Select this irq. By default these irqs will then be collected. For a more
2154 detailed description see B<IgnoreSelected> below.
2156 =item B<IgnoreSelected> I<true>|I<false>
2158 If no configuration if given, the B<irq>-plugin will collect data from all
2159 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2160 can use the B<Irq>-option to pick the interrupt you're interested in.
2161 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2162 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2163 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2164 and all other interrupts are collected.
2168 =head2 Plugin C<java>
2170 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2171 This section only discusses the syntax and semantic of the configuration
2172 options. For more in-depth information on the I<Java> plugin, please read
2173 L<collectd-java(5)>.
2178 JVMArg "-verbose:jni"
2179 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2180 LoadPlugin "org.collectd.java.Foobar"
2181 <Plugin "org.collectd.java.Foobar">
2182 # To be parsed by the plugin
2186 Available configuration options:
2190 =item B<JVMArg> I<Argument>
2192 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2193 exactly the way the arguments to the I<java> binary on the command line work.
2194 Execute C<javaE<nbsp>--help> for details.
2196 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2197 any other options! When another option is found, the JVM will be started and
2198 later options will have to be ignored!
2200 =item B<LoadPlugin> I<JavaClass>
2202 Instantiates a new I<JavaClass> object. The constructor of this object very
2203 likely then registers one or more callback methods with the server.
2205 See L<collectd-java(5)> for details.
2207 When the first such option is found, the virtual machine (JVM) is created. This
2208 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2209 B<LoadPlugin> options!
2211 =item B<Plugin> I<Name>
2213 The entire block is passed to the Java plugin as an
2214 I<org.collectd.api.OConfigItem> object.
2216 For this to work, the plugin has to register a configuration callback first,
2217 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2218 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2219 depends on the (Java) plugin registering the callback and is completely
2220 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2224 =head2 Plugin C<libvirt>
2226 This plugin allows CPU, disk and network load to be collected for virtualized
2227 guests on the machine. This means that these characteristics can be collected
2228 for guest systems without installing any software on them - collectd only runs
2229 on the hosting system. The statistics are collected through libvirt
2230 (L<http://libvirt.org/>).
2232 Only I<Connection> is required.
2236 =item B<Connection> I<uri>
2238 Connect to the hypervisor given by I<uri>. For example if using Xen use:
2240 Connection "xen:///"
2242 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
2244 =item B<RefreshInterval> I<seconds>
2246 Refresh the list of domains and devices every I<seconds>. The default is 60
2247 seconds. Setting this to be the same or smaller than the I<Interval> will cause
2248 the list of domains and devices to be refreshed on every iteration.
2250 Refreshing the devices in particular is quite a costly operation, so if your
2251 virtualization setup is static you might consider increasing this. If this
2252 option is set to 0, refreshing is disabled completely.
2254 =item B<Domain> I<name>
2256 =item B<BlockDevice> I<name:dev>
2258 =item B<InterfaceDevice> I<name:dev>
2260 =item B<IgnoreSelected> I<true>|I<false>
2262 Select which domains and devices are collected.
2264 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
2265 disk/network devices are collected.
2267 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
2268 domains and disk/network devices are ignored, while the rest are collected.
2270 The domain name and device names may use a regular expression, if the name is
2271 surrounded by I</.../> and collectd was compiled with support for regexps.
2273 The default is to collect statistics for all domains and all their devices.
2277 BlockDevice "/:hdb/"
2278 IgnoreSelected "true"
2280 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
2283 =item B<HostnameFormat> B<name|uuid|hostname|...>
2285 When the libvirt plugin logs data, it sets the hostname of the collected data
2286 according to this setting. The default is to use the guest name as provided by
2287 the hypervisor, which is equal to setting B<name>.
2289 B<uuid> means use the guest's UUID. This is useful if you want to track the
2290 same guest across migrations.
2292 B<hostname> means to use the global B<Hostname> setting, which is probably not
2293 useful on its own because all guests will appear to have the same name.
2295 You can also specify combinations of these fields. For example B<name uuid>
2296 means to concatenate the guest name and UUID (with a literal colon character
2297 between, thus I<"foo:1234-1234-1234-1234">).
2299 =item B<InterfaceFormat> B<name>|B<address>
2301 When the libvirt plugin logs interface data, it sets the name of the collected
2302 data according to this setting. The default is to use the path as provided by
2303 the hypervisor (the "dev" property of the target node), which is equal to
2306 B<address> means use the interface's mac address. This is useful since the
2307 interface path might change between reboots of a guest or across migrations.
2311 +=head2 Plugin C<load>
2313 The I<Load plugin> collects the system load. These numbers give a rough overview
2314 over the utilization of a machine. The system load is defined as the number of
2315 runnable tasks in the run-queue and is provided by many operating systems as a
2316 one, five or fifteen minute average.
2318 The following configuration options are available:
2322 =item B<ReportRelative> B<false>|B<true>
2324 When enabled, system load divided by number of available CPU cores is reported
2325 for intervals 1 min, 5 min and 15 min. Defaults to false.
2330 =head2 Plugin C<logfile>
2334 =item B<LogLevel> B<debug|info|notice|warning|err>
2336 Sets the log-level. If, for example, set to B<notice>, then all events with
2337 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2339 Please note that B<debug> is only available if collectd has been compiled with
2342 =item B<File> I<File>
2344 Sets the file to write log messages to. The special strings B<stdout> and
2345 B<stderr> can be used to write to the standard output and standard error
2346 channels, respectively. This, of course, only makes much sense when I<collectd>
2347 is running in foreground- or non-daemon-mode.
2349 =item B<Timestamp> B<true>|B<false>
2351 Prefix all lines printed by the current time. Defaults to B<true>.
2353 =item B<PrintSeverity> B<true>|B<false>
2355 When enabled, all lines are prefixed by the severity of the log message, for
2356 example "warning". Defaults to B<false>.
2360 B<Note>: There is no need to notify the daemon after moving or removing the
2361 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2362 for each line it writes.
2364 =head2 Plugin C<lpar>
2366 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2367 virtualization technique for IBM POWER processors. It takes into account CPU
2368 time stolen from or donated to a partition, in addition to the usual user,
2369 system, I/O statistics.
2371 The following configuration options are available:
2375 =item B<CpuPoolStats> B<false>|B<true>
2377 When enabled, statistics about the processor pool are read, too. The partition
2378 needs to have pool authority in order to be able to acquire this information.
2381 =item B<ReportBySerial> B<false>|B<true>
2383 If enabled, the serial of the physical machine the partition is currently
2384 running on is reported as I<hostname> and the logical hostname of the machine
2385 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2386 used (just like other plugins) and the I<plugin instance> will be empty.
2391 =head2 Plugin C<mbmon>
2393 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2395 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2396 B<Host> and B<Port> options can be used to change these values, see below.
2397 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2398 timeouts may appear which may interfere with other statistics..
2400 C<mbmon> must be run with the -r option ("print TAG and Value format");
2401 Debian's F</etc/init.d/mbmon> script already does this, other people
2402 will need to ensure that this is the case.
2406 =item B<Host> I<Hostname>
2408 Hostname to connect to. Defaults to B<127.0.0.1>.
2410 =item B<Port> I<Port>
2412 TCP-Port to connect to. Defaults to B<411>.
2418 The C<md plugin> collects information from Linux Software-RAID devices (md).
2420 All reported values are of the type C<md_disks>. Reported type instances are
2421 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2422 I<missing> (physically absent) disks.
2426 =item B<Device> I<Device>
2428 Select md devices based on device name. The I<device name> is the basename of
2429 the device, i.e. the name of the block device without the leading C</dev/>.
2430 See B<IgnoreSelected> for more details.
2432 =item B<IgnoreSelected> B<true>|B<false>
2434 Invert device selection: If set to B<true>, all md devices B<except> those
2435 listed using B<Device> are collected. If B<false> (the default), only those
2436 listed are collected. If no configuration is given, the B<md> plugin will
2437 collect data from all md devices.
2441 =head2 Plugin C<memcachec>
2443 The C<memcachec plugin> connects to a memcached server, queries one or more
2444 given I<pages> and parses the returned data according to user specification.
2445 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2448 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2449 library. Please note that there is another library with a very similar name,
2450 libmemcache (notice the missing `d'), which is not applicable.
2452 Synopsis of the configuration:
2454 <Plugin "memcachec">
2455 <Page "plugin_instance">
2459 Regex "(\\d+) bytes sent"
2462 Instance "type_instance"
2467 The configuration options are:
2471 =item E<lt>B<Page> I<Name>E<gt>
2473 Each B<Page> block defines one I<page> to be queried from the memcached server.
2474 The block requires one string argument which is used as I<plugin instance>.
2476 =item B<Server> I<Address>
2478 Sets the server address to connect to when querying the page. Must be inside a
2483 When connected to the memcached server, asks for the page I<Key>.
2485 =item E<lt>B<Match>E<gt>
2487 Match blocks define which strings to look for and how matches substrings are
2488 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2492 =head2 Plugin C<memcached>
2494 The B<memcached plugin> connects to a memcached server and queries statistics
2495 about cache utilization, memory and bandwidth used.
2496 L<http://www.danga.com/memcached/>
2498 <Plugin "memcached">
2500 Host "memcache.example.com"
2505 The plugin configuration consists of one or more B<Instance> blocks which
2506 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2507 following options are allowed:
2511 =item B<Host> I<Hostname>
2513 Hostname to connect to. Defaults to B<127.0.0.1>.
2515 =item B<Port> I<Port>
2517 TCP-Port to connect to. Defaults to B<11211>.
2519 =item B<Socket> I<Path>
2521 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2522 setting is given, the B<Host> and B<Port> settings are ignored.
2526 =head2 Plugin C<mic>
2528 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2529 Intel's Many Integrated Core (MIC) systems.
2538 ShowTemperatures true
2541 IgnoreSelectedTemperature true
2546 IgnoreSelectedPower true
2549 The following options are valid inside the B<PluginE<nbsp>mic> block:
2553 =item B<ShowCPU> B<true>|B<false>
2555 If enabled (the default) a sum of the CPU usage accross all cores is reported.
2557 =item B<ShowCPUCores> B<true>|B<false>
2559 If enabled (the default) per-core CPU usage is reported.
2561 =item B<ShowMemory> B<true>|B<false>
2563 If enabled (the default) the physical memory usage of the MIC system is
2566 =item B<ShowTemperatures> B<true>|B<false>
2568 If enabled (the default) various temperatures of the MIC system are reported.
2570 =item B<Temperature> I<Name>
2572 This option controls which temperatures are being reported. Whether matching
2573 temperatures are being ignored or I<only> matching temperatures are reported
2574 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2575 temperatures are reported.
2577 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2579 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2580 (the default) only temperatures matching a B<Temperature> option are reported
2581 or, if no B<Temperature> option is specified, all temperatures are reported. If
2582 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2585 Known temperature names are:
2619 =item B<ShowPower> B<true>|B<false>
2621 If enabled (the default) various temperatures of the MIC system are reported.
2623 =item B<Power> I<Name>
2625 This option controls which power readings are being reported. Whether matching
2626 power readings are being ignored or I<only> matching power readings are reported
2627 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
2628 power readings are reported.
2630 =item B<IgnoreSelectedPower> B<false>|B<true>
2632 Controls the behavior of the B<Power> setting above. If set to B<false>
2633 (the default) only power readings matching a B<Power> option are reported
2634 or, if no B<Power> option is specified, all power readings are reported. If
2635 set to B<true>, matching power readings are I<ignored> and all other power readings
2638 Known power names are:
2644 Total power utilization averaged over Time Window 0 (uWatts).
2648 Total power utilization averaged over Time Window 0 (uWatts).
2652 Instantaneous power (uWatts).
2656 Max instantaneous power (uWatts).
2660 PCI-E connector power (uWatts).
2664 2x3 connector power (uWatts).
2668 2x4 connector power (uWatts).
2676 Uncore rail (uVolts).
2680 Memory subsystem rail (uVolts).
2686 =head2 Plugin C<memory>
2688 The I<memory plugin> provides the following configuration options:
2692 =item B<ValuesAbsolute> B<true>|B<false>
2694 Enables or disables reporting of physical memory usage in absolute numbers,
2695 i.e. bytes. Defaults to B<true>.
2697 =item B<ValuesPercentage> B<false>|B<true>
2699 Enables or disables reporting of physical memory usage in percentages, e.g.
2700 percent of physical memory used. Defaults to B<false>.
2702 This is useful for deploying I<collectd> in a heterogeneous environment in
2703 which the sizes of physical memory vary.
2707 =head2 Plugin C<modbus>
2709 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
2710 register values. It supports reading single registers (unsigned 16E<nbsp>bit
2711 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2712 values (two registers interpreted as IEEE floats in big endian notation).
2716 <Data "voltage-input-1">
2723 <Data "voltage-input-2">
2730 <Host "modbus.example.com">
2731 Address "192.168.0.42"
2736 Instance "power-supply"
2737 Collect "voltage-input-1"
2738 Collect "voltage-input-2"
2744 =item E<lt>B<Data> I<Name>E<gt> blocks
2746 Data blocks define a mapping between register numbers and the "types" used by
2749 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
2753 =item B<RegisterBase> I<Number>
2755 Configures the base register to read from the device. If the option
2756 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
2757 register will be read (the register number is increased by one).
2759 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
2761 Specifies what kind of data is returned by the device. If the type is B<Int32>,
2762 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
2763 combined into one value. Defaults to B<Uint16>.
2765 =item B<Type> I<Type>
2767 Specifies the "type" (data set) to use when dispatching the value to
2768 I<collectd>. Currently, only data sets with exactly one data source are
2771 =item B<Instance> I<Instance>
2773 Sets the type instance to use when dispatching the value to I<collectd>. If
2774 unset, an empty string (no type instance) is used.
2778 =item E<lt>B<Host> I<Name>E<gt> blocks
2780 Host blocks are used to specify to which hosts to connect and what data to read
2781 from their "slaves". The string argument I<Name> is used as hostname when
2782 dispatching the values to I<collectd>.
2784 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
2788 =item B<Address> I<Hostname>
2790 Specifies the node name (the actual network address) used to connect to the
2791 host. This may be an IP address or a hostname. Please note that the used
2792 I<libmodbus> library only supports IPv4 at the moment.
2794 =item B<Port> I<Service>
2796 Specifies the port used to connect to the host. The port can either be given as
2797 a number or as a service name. Please note that the I<Service> argument must be
2798 a string, even if ports are given in their numerical form. Defaults to "502".
2800 =item B<Interval> I<Interval>
2802 Sets the interval (in seconds) in which the values will be collected from this
2803 host. By default the global B<Interval> setting will be used.
2805 =item E<lt>B<Slave> I<ID>E<gt>
2807 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
2808 is used to specify which device should be addressed. For each device you want
2809 to query, one B<Slave> block must be given.
2811 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
2815 =item B<Instance> I<Instance>
2817 Specify the plugin instance to use when dispatching the values to I<collectd>.
2818 By default "slave_I<ID>" is used.
2820 =item B<Collect> I<DataName>
2822 Specifies which data to retrieve from the device. I<DataName> must be the same
2823 string as the I<Name> argument passed to a B<Data> block. You can specify this
2824 option multiple times to collect more than one value from a slave. At least one
2825 B<Collect> option is mandatory.
2833 =head2 Plugin C<mysql>
2835 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
2836 one or more databases when started and keeps the connection up as long as
2837 possible. When the connection is interrupted for whatever reason it will try
2838 to re-connect. The plugin will complain loudly in case anything goes wrong.
2840 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
2841 and collects information about MySQL network traffic, executed statements,
2842 requests, the query cache and threads by evaluating the
2843 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
2844 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
2845 Status Variables> for an explanation of these values.
2847 Optionally, master and slave statistics may be collected in a MySQL
2848 replication setup. In that case, information about the synchronization state
2849 of the nodes are collected by evaluating the C<Position> return value of the
2850 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
2851 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
2852 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
2853 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
2854 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
2869 Socket "/var/run/mysql/mysqld.sock"
2871 SlaveNotifications true
2875 A B<Database> block defines one connection to a MySQL database. It accepts a
2876 single argument which specifies the name of the database. None of the other
2877 options are required. MySQL will use default values as documented in the
2878 section "mysql_real_connect()" in the B<MySQL reference manual>.
2882 =item B<Host> I<Hostname>
2884 Hostname of the database server. Defaults to B<localhost>.
2886 =item B<User> I<Username>
2888 Username to use when connecting to the database. The user does not have to be
2889 granted any privileges (which is synonym to granting the C<USAGE> privilege),
2890 unless you want to collectd replication statistics (see B<MasterStats> and
2891 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
2892 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
2894 =item B<Password> I<Password>
2896 Password needed to log into the database.
2898 =item B<Database> I<Database>
2900 Select this database. Defaults to I<no database> which is a perfectly reasonable
2901 option for what this plugin does.
2903 =item B<Port> I<Port>
2905 TCP-port to connect to. The port must be specified in its numeric form, but it
2906 must be passed as a string nonetheless. For example:
2910 If B<Host> is set to B<localhost> (the default), this setting has no effect.
2911 See the documentation for the C<mysql_real_connect> function for details.
2913 =item B<Socket> I<Socket>
2915 Specifies the path to the UNIX domain socket of the MySQL server. This option
2916 only has any effect, if B<Host> is set to B<localhost> (the default).
2917 Otherwise, use the B<Port> option above. See the documentation for the
2918 C<mysql_real_connect> function for details.
2920 =item B<MasterStats> I<true|false>
2922 =item B<SlaveStats> I<true|false>
2924 Enable the collection of master / slave statistics in a replication setup. In
2925 order to be able to get access to these statistics, the user needs special
2926 privileges. See the B<User> documentation above.
2928 =item B<SlaveNotifications> I<true|false>
2930 If enabled, the plugin sends a notification if the replication slave I/O and /
2931 or SQL threads are not running.
2935 =head2 Plugin C<netapp>
2937 The netapp plugin can collect various performance and capacity information
2938 from a NetApp filer using the NetApp API.
2940 Please note that NetApp has a wide line of products and a lot of different
2941 software versions for each of these products. This plugin was developed for a
2942 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
2943 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
2944 model and software version but it is very hard to test this.
2945 If you have used this plugin with other models and/or software version, feel
2946 free to send us a mail to tell us about the results, even if it's just a short
2949 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
2950 basic authentication.
2952 B<Do not use a regular user for this!> Create a special collectd user with just
2953 the minimum of capabilities needed. The user only needs the "login-http-admin"
2954 capability as well as a few more depending on which data will be collected.
2955 Required capabilities are documented below.
2960 <Host "netapp1.example.com">
2984 IgnoreSelectedIO false
2986 IgnoreSelectedOps false
2987 GetLatency "volume0"
2988 IgnoreSelectedLatency false
2995 IgnoreSelectedCapacity false
2998 IgnoreSelectedSnapshot false
3026 The netapp plugin accepts the following configuration options:
3030 =item B<Host> I<Name>
3032 A host block defines one NetApp filer. It will appear in collectd with the name
3033 you specify here which does not have to be its real name nor its hostname (see
3034 the B<Address> option below).
3036 =item B<VFiler> I<Name>
3038 A B<VFiler> block may only be used inside a host block. It accepts all the
3039 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
3040 will execute all NetApp API commands in the context of the specified
3041 VFiler(R). It will appear in collectd with the name you specify here which
3042 does not have to be its real name. The VFiler name may be specified using the
3043 B<VFilerName> option. If this is not specified, it will default to the name
3046 The VFiler block inherits all connection related settings from the surrounding
3047 B<Host> block (which appear before the B<VFiler> block) but they may be
3048 overwritten inside the B<VFiler> block.
3050 This feature is useful, for example, when using a VFiler as SnapVault target
3051 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
3052 available in the host filer (vfiler0) but only in the respective VFiler
3055 =item B<Protocol> B<httpd>|B<http>
3057 The protocol collectd will use to query this host.
3065 Valid options: http, https
3067 =item B<Address> I<Address>
3069 The hostname or IP address of the host.
3075 Default: The "host" block's name.
3077 =item B<Port> I<Port>
3079 The TCP port to connect to on the host.
3085 Default: 80 for protocol "http", 443 for protocol "https"
3087 =item B<User> I<User>
3089 =item B<Password> I<Password>
3091 The username and password to use to login to the NetApp.
3097 =item B<VFilerName> I<Name>
3099 The name of the VFiler in which context to execute API commands. If not
3100 specified, the name provided to the B<VFiler> block will be used instead.
3106 Default: name of the B<VFiler> block
3108 B<Note:> This option may only be used inside B<VFiler> blocks.
3110 =item B<Interval> I<Interval>
3116 The following options decide what kind of data will be collected. You can
3117 either use them as a block and fine tune various parameters inside this block,
3118 use them as a single statement to just accept all default values, or omit it to
3119 not collect any data.
3121 The following options are valid inside all blocks:
3125 =item B<Interval> I<Seconds>
3127 Collect the respective statistics every I<Seconds> seconds. Defaults to the
3128 host specific setting.
3132 =head3 The System block
3134 This will collect various performance data about the whole system.
3136 B<Note:> To get this data the collectd user needs the
3137 "api-perf-object-get-instances" capability.
3141 =item B<Interval> I<Seconds>
3143 Collect disk statistics every I<Seconds> seconds.
3145 =item B<GetCPULoad> B<true>|B<false>
3147 If you set this option to true the current CPU usage will be read. This will be
3148 the average usage between all CPUs in your NetApp without any information about
3151 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3152 returns in the "CPU" field.
3160 Result: Two value lists of type "cpu", and type instances "idle" and "system".
3162 =item B<GetInterfaces> B<true>|B<false>
3164 If you set this option to true the current traffic of the network interfaces
3165 will be read. This will be the total traffic over all interfaces of your NetApp
3166 without any information about individual interfaces.
3168 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3169 in the "Net kB/s" field.
3179 Result: One value list of type "if_octects".
3181 =item B<GetDiskIO> B<true>|B<false>
3183 If you set this option to true the current IO throughput will be read. This
3184 will be the total IO of your NetApp without any information about individual
3185 disks, volumes or aggregates.
3187 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3188 in the "DiskE<nbsp>kB/s" field.
3196 Result: One value list of type "disk_octets".
3198 =item B<GetDiskOps> B<true>|B<false>
3200 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
3201 iSCSI, etc. operations will be read. This will be the total number of
3202 operations on your NetApp without any information about individual volumes or
3205 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3206 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
3214 Result: A variable number of value lists of type "disk_ops_complex". Each type
3215 of operation will result in one value list with the name of the operation as
3220 =head3 The WAFL block
3222 This will collect various performance data about the WAFL file system. At the
3223 moment this just means cache performance.
3225 B<Note:> To get this data the collectd user needs the
3226 "api-perf-object-get-instances" capability.
3228 B<Note:> The interface to get these values is classified as "Diagnostics" by
3229 NetApp. This means that it is not guaranteed to be stable even between minor
3234 =item B<Interval> I<Seconds>
3236 Collect disk statistics every I<Seconds> seconds.
3238 =item B<GetNameCache> B<true>|B<false>
3246 Result: One value list of type "cache_ratio" and type instance
3249 =item B<GetDirCache> B<true>|B<false>
3257 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3259 =item B<GetInodeCache> B<true>|B<false>
3267 Result: One value list of type "cache_ratio" and type instance
3270 =item B<GetBufferCache> B<true>|B<false>
3272 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3273 in the "Cache hit" field.
3281 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3285 =head3 The Disks block
3287 This will collect performance data about the individual disks in the NetApp.
3289 B<Note:> To get this data the collectd user needs the
3290 "api-perf-object-get-instances" capability.
3294 =item B<Interval> I<Seconds>
3296 Collect disk statistics every I<Seconds> seconds.
3298 =item B<GetBusy> B<true>|B<false>
3300 If you set this option to true the busy time of all disks will be calculated
3301 and the value of the busiest disk in the system will be written.
3303 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3304 in the "Disk util" field. Probably.
3312 Result: One value list of type "percent" and type instance "disk_busy".
3316 =head3 The VolumePerf block
3318 This will collect various performance data about the individual volumes.
3320 You can select which data to collect about which volume using the following
3321 options. They follow the standard ignorelist semantic.
3323 B<Note:> To get this data the collectd user needs the
3324 I<api-perf-object-get-instances> capability.
3328 =item B<Interval> I<Seconds>
3330 Collect volume performance data every I<Seconds> seconds.
3332 =item B<GetIO> I<Volume>
3334 =item B<GetOps> I<Volume>
3336 =item B<GetLatency> I<Volume>
3338 Select the given volume for IO, operations or latency statistics collection.
3339 The argument is the name of the volume without the C</vol/> prefix.
3341 Since the standard ignorelist functionality is used here, you can use a string
3342 starting and ending with a slash to specify regular expression matching: To
3343 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3346 GetIO "/^vol[027]$/"
3348 If no regular expression is specified, an exact match is required. Both,
3349 regular and exact matching are case sensitive.
3351 If no volume was specified at all for either of the three options, that data
3352 will be collected for all available volumes.
3354 =item B<IgnoreSelectedIO> B<true>|B<false>
3356 =item B<IgnoreSelectedOps> B<true>|B<false>
3358 =item B<IgnoreSelectedLatency> B<true>|B<false>
3360 When set to B<true>, the volumes selected for IO, operations or latency
3361 statistics collection will be ignored and the data will be collected for all
3364 When set to B<false>, data will only be collected for the specified volumes and
3365 all other volumes will be ignored.
3367 If no volumes have been specified with the above B<Get*> options, all volumes
3368 will be collected regardless of the B<IgnoreSelected*> option.
3370 Defaults to B<false>
3374 =head3 The VolumeUsage block
3376 This will collect capacity data about the individual volumes.
3378 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3383 =item B<Interval> I<Seconds>
3385 Collect volume usage statistics every I<Seconds> seconds.
3387 =item B<GetCapacity> I<VolumeName>
3389 The current capacity of the volume will be collected. This will result in two
3390 to four value lists, depending on the configuration of the volume. All data
3391 sources are of type "df_complex" with the name of the volume as
3394 There will be type_instances "used" and "free" for the number of used and
3395 available bytes on the volume. If the volume has some space reserved for
3396 snapshots, a type_instance "snap_reserved" will be available. If the volume
3397 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3398 number of bytes saved by the SIS feature.
3400 B<Note:> The current NetApp API has a bug that results in this value being
3401 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3402 number which works most of the time. If you see strange values here, bug
3403 NetApp support to fix this.
3405 Repeat this option to specify multiple volumes.
3407 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3409 Specify whether to collect only the volumes selected by the B<GetCapacity>
3410 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3411 B<false>. However, if no B<GetCapacity> option is specified at all, all
3412 capacities will be selected anyway.
3414 =item B<GetSnapshot> I<VolumeName>
3416 Select volumes from which to collect snapshot information.
3418 Usually, the space used for snapshots is included in the space reported as
3419 "used". If snapshot information is collected as well, the space used for
3420 snapshots is subtracted from the used space.
3422 To make things even more interesting, it is possible to reserve space to be
3423 used for snapshots. If the space required for snapshots is less than that
3424 reserved space, there is "reserved free" and "reserved used" space in addition
3425 to "free" and "used". If the space required for snapshots exceeds the reserved
3426 space, that part allocated in the normal space is subtracted from the "used"
3429 Repeat this option to specify multiple volumes.
3431 =item B<IgnoreSelectedSnapshot>
3433 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3434 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3435 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3436 capacities will be selected anyway.
3440 =head3 The Quota block
3442 This will collect (tree) quota statistics (used disk space and number of used
3443 files). This mechanism is useful to get usage information for single qtrees.
3444 In case the quotas are not used for any other purpose, an entry similar to the
3445 following in C</etc/quotas> would be sufficient:
3447 /vol/volA/some_qtree tree - - - - -
3449 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3453 =item B<Interval> I<Seconds>
3455 Collect SnapVault(R) statistics every I<Seconds> seconds.
3459 =head3 The SnapVault block
3461 This will collect statistics about the time and traffic of SnapVault(R)
3466 =item B<Interval> I<Seconds>
3468 Collect SnapVault(R) statistics every I<Seconds> seconds.
3472 =head2 Plugin C<netlink>
3474 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3475 statistics of various interface and routing aspects.
3479 =item B<Interface> I<Interface>
3481 =item B<VerboseInterface> I<Interface>
3483 Instruct the plugin to collect interface statistics. This is basically the same
3484 as the statistics provided by the C<interface> plugin (see above) but
3485 potentially much more detailed.
3487 When configuring with B<Interface> only the basic statistics will be collected,
3488 namely octets, packets, and errors. These statistics are collected by
3489 the C<interface> plugin, too, so using both at the same time is no benefit.
3491 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3492 so that no data needs to be collected twice if you use the C<interface> plugin.
3493 This includes dropped packets, received multicast packets, collisions and a
3494 whole zoo of differentiated RX and TX errors. You can try the following command
3495 to get an idea of what awaits you:
3499 If I<Interface> is B<All>, all interfaces will be selected.
3501 =item B<QDisc> I<Interface> [I<QDisc>]
3503 =item B<Class> I<Interface> [I<Class>]
3505 =item B<Filter> I<Interface> [I<Filter>]
3507 Collect the octets and packets that pass a certain qdisc, class or filter.
3509 QDiscs and classes are identified by their type and handle (or classid).
3510 Filters don't necessarily have a handle, therefore the parent's handle is used.
3511 The notation used in collectd differs from that used in tc(1) in that it
3512 doesn't skip the major or minor number if it's zero and doesn't print special
3513 ids by their name. So, for example, a qdisc may be identified by
3514 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3515 thus not displayed by tc(1).
3517 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3518 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3519 associated with that interface will be collected.
3521 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3522 used. This may lead to problems when more than one filter is attached to a
3523 qdisc or class. This isn't nice, but we don't know how this could be done any
3524 better. If you have a idea, please don't hesitate to tell us.
3526 As with the B<Interface> option you can specify B<All> as the interface,
3527 meaning all interfaces.
3529 Here are some examples to help you understand the above text more easily:
3532 VerboseInterface "All"
3533 QDisc "eth0" "pfifo_fast-1:0"
3535 Class "ppp0" "htb-1:10"
3536 Filter "ppp0" "u32-1:0"
3539 =item B<IgnoreSelected>
3541 The behavior is the same as with all other similar plugins: If nothing is
3542 selected at all, everything is collected. If some things are selected using the
3543 options described above, only these statistics are collected. If you set
3544 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3545 specified statistics will not be collected.
3549 =head2 Plugin C<network>
3551 The Network plugin sends data to a remote instance of collectd, receives data
3552 from a remote instance, or both at the same time. Data which has been received
3553 from the network is usually not transmitted again, but this can be activated, see
3554 the B<Forward> option below.
3556 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3557 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3559 Both, B<Server> and B<Listen> can be used as single option or as block. When
3560 used as block, given options are valid for this socket only. The following
3561 example will export the metrics twice: Once to an "internal" server (without
3562 encryption and signing) and one to an external server (with cryptographic
3566 # Export to an internal server
3567 # (demonstrates usage without additional options)
3568 Server "collectd.internal.tld"
3570 # Export to an external server
3571 # (demonstrates usage with signature options)
3572 <Server "collectd.external.tld">
3573 SecurityLevel "sign"
3574 Username "myhostname"
3581 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3583 The B<Server> statement/block sets the server to send datagrams to. The
3584 statement may occur multiple times to send each datagram to multiple
3587 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3588 optional second argument specifies a port number or a service name. If not
3589 given, the default, B<25826>, is used.
3591 The following options are recognized within B<Server> blocks:
3595 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3597 Set the security you require for network communication. When the security level
3598 has been set to B<Encrypt>, data sent over the network will be encrypted using
3599 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3600 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3601 authentication code. When set to B<None>, data is sent without any security.
3603 This feature is only available if the I<network> plugin was linked with
3606 =item B<Username> I<Username>
3608 Sets the username to transmit. This is used by the server to lookup the
3609 password. See B<AuthFile> below. All security levels except B<None> require
3612 This feature is only available if the I<network> plugin was linked with
3615 =item B<Password> I<Password>
3617 Sets a password (shared secret) for this socket. All security levels except
3618 B<None> require this setting.
3620 This feature is only available if the I<network> plugin was linked with
3623 =item B<Interface> I<Interface name>
3625 Set the outgoing interface for IP packets. This applies at least
3626 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3627 undefined or a non-existent interface name is specified, the default
3628 behavior is to let the kernel choose the appropriate interface. Be warned
3629 that the manual selection of an interface for unicast traffic is only
3630 necessary in rare cases.
3634 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
3636 The B<Listen> statement sets the interfaces to bind to. When multiple
3637 statements are found the daemon will bind to multiple interfaces.
3639 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
3640 the argument is a multicast address the daemon will join that multicast group.
3641 The optional second argument specifies a port number or a service name. If not
3642 given, the default, B<25826>, is used.
3644 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
3648 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3650 Set the security you require for network communication. When the security level
3651 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
3652 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
3653 signed and encrypted data is accepted. When set to B<None>, all data will be
3654 accepted. If an B<AuthFile> option was given (see below), encrypted data is
3655 decrypted if possible.
3657 This feature is only available if the I<network> plugin was linked with
3660 =item B<AuthFile> I<Filename>
3662 Sets a file in which usernames are mapped to passwords. These passwords are
3663 used to verify signatures and to decrypt encrypted network packets. If
3664 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
3665 verified and encrypted packets are decrypted. Otherwise, signed data is
3666 accepted without checking the signature and encrypted data cannot be decrypted.
3667 For the other security levels this option is mandatory.
3669 The file format is very simple: Each line consists of a username followed by a
3670 colon and any number of spaces followed by the password. To demonstrate, an
3671 example file could look like this:
3676 Each time a packet is received, the modification time of the file is checked
3677 using L<stat(2)>. If the file has been changed, the contents is re-read. While
3678 the file is being read, it is locked using L<fcntl(2)>.
3680 =item B<Interface> I<Interface name>
3682 Set the incoming interface for IP packets explicitly. This applies at least
3683 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3684 undefined or a non-existent interface name is specified, the default
3685 behavior is, to let the kernel choose the appropriate interface. Thus incoming
3686 traffic gets only accepted, if it arrives on the given interface.
3690 =item B<TimeToLive> I<1-255>
3692 Set the time-to-live of sent packets. This applies to all, unicast and
3693 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
3694 That means that multicast packets will be sent with a TTL of C<1> (one) on most
3697 =item B<MaxPacketSize> I<1024-65535>
3699 Set the maximum size for datagrams received over the network. Packets larger
3700 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
3701 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
3704 On the server side, this limit should be set to the largest value used on
3705 I<any> client. Likewise, the value on the client must not be larger than the
3706 value on the server, or data will be lost.
3708 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
3709 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
3710 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
3713 =item B<Forward> I<true|false>
3715 If set to I<true>, write packets that were received via the network plugin to
3716 the sending sockets. This should only be activated when the B<Listen>- and
3717 B<Server>-statements differ. Otherwise packets may be send multiple times to
3718 the same multicast group. While this results in more network traffic than
3719 necessary it's not a huge problem since the plugin has a duplicate detection,
3720 so the values will not loop.
3722 =item B<ReportStats> B<true>|B<false>
3724 The network plugin cannot only receive and send statistics, it can also create
3725 statistics about itself. Collected data included the number of received and
3726 sent octets and packets, the length of the receive queue and the number of
3727 values handled. When set to B<true>, the I<Network plugin> will make these
3728 statistics available. Defaults to B<false>.
3732 =head2 Plugin C<nginx>
3734 This plugin collects the number of connections and requests handled by the
3735 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
3736 queries the page provided by the C<ngx_http_stub_status_module> module, which
3737 isn't compiled by default. Please refer to
3738 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
3739 how to compile and configure nginx and this module.
3741 The following options are accepted by the C<nginx plugin>:
3745 =item B<URL> I<http://host/nginx_status>
3747 Sets the URL of the C<ngx_http_stub_status_module> output.
3749 =item B<User> I<Username>
3751 Optional user name needed for authentication.
3753 =item B<Password> I<Password>
3755 Optional password needed for authentication.
3757 =item B<VerifyPeer> B<true|false>
3759 Enable or disable peer SSL certificate verification. See
3760 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
3762 =item B<VerifyHost> B<true|false>
3764 Enable or disable peer host name verification. If enabled, the plugin checks
3765 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
3766 certificate matches the host name provided by the B<URL> option. If this
3767 identity check fails, the connection is aborted. Obviously, only works when
3768 connecting to a SSL enabled server. Enabled by default.
3770 =item B<CACert> I<File>
3772 File that holds one or more SSL certificates. If you want to use HTTPS you will
3773 possibly need this option. What CA certificates come bundled with C<libcurl>
3774 and are checked by default depends on the distribution you use.
3778 =head2 Plugin C<notify_desktop>
3780 This plugin sends a desktop notification to a notification daemon, as defined
3781 in the Desktop Notification Specification. To actually display the
3782 notifications, B<notification-daemon> is required and B<collectd> has to be
3783 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
3784 environment variables have to be set correctly) and the D-Bus message bus.
3786 The Desktop Notification Specification can be found at
3787 L<http://www.galago-project.org/specs/notification/>.
3791 =item B<OkayTimeout> I<timeout>
3793 =item B<WarningTimeout> I<timeout>
3795 =item B<FailureTimeout> I<timeout>
3797 Set the I<timeout>, in milliseconds, after which to expire the notification
3798 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
3799 been specified, the displayed notification will not be closed at all - the
3800 user has to do so herself. These options default to 5000. If a negative number
3801 has been specified, the default is used as well.
3805 =head2 Plugin C<notify_email>
3807 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
3808 configured email address.
3810 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
3812 Available configuration options:
3816 =item B<From> I<Address>
3818 Email address from which the emails should appear to come from.
3820 Default: C<root@localhost>
3822 =item B<Recipient> I<Address>
3824 Configures the email address(es) to which the notifications should be mailed.
3825 May be repeated to send notifications to multiple addresses.
3827 At least one B<Recipient> must be present for the plugin to work correctly.
3829 =item B<SMTPServer> I<Hostname>
3831 Hostname of the SMTP server to connect to.
3833 Default: C<localhost>
3835 =item B<SMTPPort> I<Port>
3837 TCP port to connect to.
3841 =item B<SMTPUser> I<Username>
3843 Username for ASMTP authentication. Optional.
3845 =item B<SMTPPassword> I<Password>
3847 Password for ASMTP authentication. Optional.
3849 =item B<Subject> I<Subject>
3851 Subject-template to use when sending emails. There must be exactly two
3852 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
3853 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
3856 Default: C<Collectd notify: %s@%s>
3860 =head2 Plugin C<ntpd>
3864 =item B<Host> I<Hostname>
3866 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
3868 =item B<Port> I<Port>
3870 UDP-Port to connect to. Defaults to B<123>.
3872 =item B<ReverseLookups> B<true>|B<false>
3874 Sets whether or not to perform reverse lookups on peers. Since the name or
3875 IP-address may be used in a filename it is recommended to disable reverse
3876 lookups. The default is to do reverse lookups to preserve backwards
3877 compatibility, though.
3879 =item B<IncludeUnitID> B<true>|B<false>
3881 When a peer is a refclock, include the unit ID in the I<type instance>.
3882 Defaults to B<false> for backward compatibility.
3884 If two refclock peers use the same driver and this is B<false>, the plugin will
3885 try to write simultaneous measurements from both to the same type instance.
3886 This will result in error messages in the log and only one set of measurements
3891 =head2 Plugin C<nut>
3895 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
3897 Add a UPS to collect data from. The format is identical to the one accepted by
3902 =head2 Plugin C<olsrd>
3904 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
3905 the Optimized Link State Routing daemon and reads information about the current
3906 state of the meshed network.
3908 The following configuration options are understood:
3912 =item B<Host> I<Host>
3914 Connect to I<Host>. Defaults to B<"localhost">.
3916 =item B<Port> I<Port>
3918 Specifies the port to connect to. This must be a string, even if you give the
3919 port as a number rather than a service name. Defaults to B<"2006">.
3921 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
3923 Specifies what information to collect about links, i.E<nbsp>e. direct
3924 connections of the daemon queried. If set to B<No>, no information is
3925 collected. If set to B<Summary>, the number of links and the average of all
3926 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
3927 If set to B<Detail> LQ and NLQ are collected per link.
3929 Defaults to B<Detail>.
3931 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
3933 Specifies what information to collect about routes of the daemon queried. If
3934 set to B<No>, no information is collected. If set to B<Summary>, the number of
3935 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
3936 metric and ETX are collected per route.
3938 Defaults to B<Summary>.
3940 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
3942 Specifies what information to collect about the global topology. If set to
3943 B<No>, no information is collected. If set to B<Summary>, the number of links
3944 in the entire topology and the average I<link quality> (LQ) is calculated.
3945 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
3947 Defaults to B<Summary>.
3951 =head2 Plugin C<onewire>
3953 B<EXPERIMENTAL!> See notes below.
3955 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
3956 L<http://owfs.org/> to read sensors connected via the onewire bus.
3958 Currently only temperature sensors (sensors with the family code C<10>,
3959 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
3960 would like to have included, please send a sort request to the mailing list.
3962 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
3963 experimental, below.
3967 =item B<Device> I<Device>
3969 Sets the device to read the values from. This can either be a "real" hardware
3970 device, such as a serial port or an USB port, or the address of the
3971 L<owserver(1)> socket, usually B<localhost:4304>.
3973 Though the documentation claims to automatically recognize the given address
3974 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
3975 with that version, the following configuration worked for us:
3978 Device "-s localhost:4304"
3981 This directive is B<required> and does not have a default value.
3983 =item B<Sensor> I<Sensor>
3985 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
3986 below. Sensors are specified without the family byte at the beginning, to you'd
3987 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
3990 =item B<IgnoreSelected> I<true>|I<false>
3992 If no configuration if given, the B<onewire> plugin will collect data from all
3993 sensors found. This may not be practical, especially if sensors are added and
3994 removed regularly. Sometimes, however, it's easier/preferred to collect only
3995 specific sensors or all sensors I<except> a few specified ones. This option
3996 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
3997 B<Sensor> is inverted: All selected interfaces are ignored and all other
3998 interfaces are collected.
4000 =item B<Interval> I<Seconds>
4002 Sets the interval in which all sensors should be read. If not specified, the
4003 global B<Interval> setting is used.
4007 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
4008 work with big setups. It works with one sensor being attached to one
4009 controller, but as soon as you throw in a couple more senors and maybe a hub
4010 or two, reading all values will take more than ten seconds (the default
4011 interval). We will probably add some separate thread for reading the sensors
4012 and some cache or something like that, but it's not done yet. We will try to
4013 maintain backwards compatibility in the future, but we can't promise. So in
4014 short: If it works for you: Great! But keep in mind that the config I<might>
4015 change, though this is unlikely. Oh, and if you want to help improving this
4016 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
4018 =head2 Plugin C<openvpn>
4020 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
4021 traffic statistics about connected clients.
4023 To set up OpenVPN to write to the status file periodically, use the
4024 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
4025 you need to set the required format, too. This is done by setting
4026 B<--status-version> to B<2>.
4028 So, in a nutshell you need:
4030 openvpn $OTHER_OPTIONS \
4031 --status "/var/run/openvpn-status" 10 \
4038 =item B<StatusFile> I<File>
4040 Specifies the location of the status file.
4042 =item B<ImprovedNamingSchema> B<true>|B<false>
4044 When enabled, the filename of the status file will be used as plugin instance
4045 and the client's "common name" will be used as type instance. This is required
4046 when reading multiple status files. Enabling this option is recommended, but to
4047 maintain backwards compatibility this option is disabled by default.
4049 =item B<CollectCompression> B<true>|B<false>
4051 Sets whether or not statistics about the compression used by OpenVPN should be
4052 collected. This information is only available in I<single> mode. Enabled by
4055 =item B<CollectIndividualUsers> B<true>|B<false>
4057 Sets whether or not traffic information is collected for each connected client
4058 individually. If set to false, currently no traffic data is collected at all
4059 because aggregating this data in a save manner is tricky. Defaults to B<true>.
4061 =item B<CollectUserCount> B<true>|B<false>
4063 When enabled, the number of currently connected clients or users is collected.
4064 This is especially interesting when B<CollectIndividualUsers> is disabled, but
4065 can be configured independently from that option. Defaults to B<false>.
4069 =head2 Plugin C<oracle>
4071 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
4072 Oracle® Database and lets you execute SQL statements there. It is very similar
4073 to the "dbi" plugin, because it was written around the same time. See the "dbi"
4074 plugin's documentation above for details.
4077 <Query "out_of_stock">
4078 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
4081 # InstancePrefix "foo"
4082 InstancesFrom "category"
4086 <Database "product_information">
4090 Query "out_of_stock"
4094 =head3 B<Query> blocks
4096 The Query blocks are handled identically to the Query blocks of the "dbi"
4097 plugin. Please see its documentation above for details on how to specify
4100 =head3 B<Database> blocks
4102 Database blocks define a connection to a database and which queries should be
4103 sent to that database. Each database needs a "name" as string argument in the
4104 starting tag of the block. This name will be used as "PluginInstance" in the
4105 values submitted to the daemon. Other than that, that name is not used.
4109 =item B<ConnectID> I<ID>
4111 Defines the "database alias" or "service name" to connect to. Usually, these
4112 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
4114 =item B<Host> I<Host>
4116 Hostname to use when dispatching values for this database. Defaults to using
4117 the global hostname of the I<collectd> instance.
4119 =item B<Username> I<Username>
4121 Username used for authentication.
4123 =item B<Password> I<Password>
4125 Password used for authentication.
4127 =item B<Query> I<QueryName>
4129 Associates the query named I<QueryName> with this database connection. The
4130 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
4131 blocks you want to refer to must be placed above the database block you want to
4136 =head2 Plugin C<perl>
4138 This plugin embeds a Perl-interpreter into collectd and provides an interface
4139 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
4141 =head2 Plugin C<pinba>
4143 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
4144 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
4145 PHP-based webpage has been delivered, the extension will send a UDP packet
4146 containing timing information, peak memory usage and so on. The plugin will
4147 wait for such packets, parse them and account the provided information, which
4148 is then dispatched to the daemon once per interval.
4155 # Overall statistics for the website.
4157 Server "www.example.com"
4159 # Statistics for www-a only
4161 Host "www-a.example.com"
4162 Server "www.example.com"
4164 # Statistics for www-b only
4166 Host "www-b.example.com"
4167 Server "www.example.com"
4171 The plugin provides the following configuration options:
4175 =item B<Address> I<Node>
4177 Configures the address used to open a listening socket. By default, plugin will
4178 bind to the I<any> address C<::0>.
4180 =item B<Port> I<Service>
4182 Configures the port (service) to bind to. By default the default Pinba port
4183 "30002" will be used. The option accepts service names in addition to port
4184 numbers and thus requires a I<string> argument.
4186 =item E<lt>B<View> I<Name>E<gt> block
4188 The packets sent by the Pinba extension include the hostname of the server, the
4189 server name (the name of the virtual host) and the script that was executed.
4190 Using B<View> blocks it is possible to separate the data into multiple groups
4191 to get more meaningful statistics. Each packet is added to all matching groups,
4192 so that a packet may be accounted for more than once.
4196 =item B<Host> I<Host>
4198 Matches the hostname of the system the webserver / script is running on. This
4199 will contain the result of the L<gethostname(2)> system call. If not
4200 configured, all hostnames will be accepted.
4202 =item B<Server> I<Server>
4204 Matches the name of the I<virtual host>, i.e. the contents of the
4205 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
4206 server names will be accepted.
4208 =item B<Script> I<Script>
4210 Matches the name of the I<script name>, i.e. the contents of the
4211 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
4212 script names will be accepted.
4218 =head2 Plugin C<ping>
4220 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
4221 configured hosts periodically and measures the network latency. Whenever the
4222 C<read> function of the plugin is called, it submits the average latency, the
4223 standard deviation and the drop rate for each host.
4225 Available configuration options:
4229 =item B<Host> I<IP-address>
4231 Host to ping periodically. This option may be repeated several times to ping
4234 =item B<Interval> I<Seconds>
4236 Sets the interval in which to send ICMP echo packets to the configured hosts.
4237 This is B<not> the interval in which statistics are queries from the plugin but
4238 the interval in which the hosts are "pinged". Therefore, the setting here
4239 should be smaller than or equal to the global B<Interval> setting. Fractional
4240 times, such as "1.24" are allowed.
4244 =item B<Timeout> I<Seconds>
4246 Time to wait for a response from the host to which an ICMP packet had been
4247 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
4248 to be down or the packet to be dropped. This setting must be smaller than the
4249 B<Interval> setting above for the plugin to work correctly. Fractional
4250 arguments are accepted.
4254 =item B<TTL> I<0-255>
4256 Sets the Time-To-Live of generated ICMP packets.
4258 =item B<SourceAddress> I<host>
4260 Sets the source address to use. I<host> may either be a numerical network
4261 address or a network hostname.
4263 =item B<Device> I<name>
4265 Sets the outgoing network device to be used. I<name> has to specify an
4266 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
4269 =item B<MaxMissed> I<Packets>
4271 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
4272 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
4274 Default: B<-1> (disabled)
4278 =head2 Plugin C<postgresql>
4280 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
4281 keeps a persistent connection to all configured databases and tries to
4282 reconnect if the connection has been interrupted. A database is configured by
4283 specifying a B<Database> block as described below. The default statistics are
4284 collected from PostgreSQL's B<statistics collector> which thus has to be
4285 enabled for this plugin to work correctly. This should usually be the case by
4286 default. See the section "The Statistics Collector" of the B<PostgreSQL
4287 Documentation> for details.
4289 By specifying custom database queries using a B<Query> block as described
4290 below, you may collect any data that is available from some PostgreSQL
4291 database. This way, you are able to access statistics of external daemons
4292 which are available in a PostgreSQL database or use future or special
4293 statistics provided by PostgreSQL without the need to upgrade your collectd
4296 Starting with version 5.2, the C<postgresql> plugin supports writing data to
4297 PostgreSQL databases as well. This has been implemented in a generic way. You
4298 need to specify an SQL statement which will then be executed by collectd in
4299 order to write the data (see below for details). The benefit of that approach
4300 is that there is no fixed database layout. Rather, the layout may be optimized
4301 for the current setup.
4303 The B<PostgreSQL Documentation> manual can be found at
4304 L<http://www.postgresql.org/docs/manuals/>.
4308 Statement "SELECT magic FROM wizard WHERE host = $1;"
4312 InstancePrefix "magic"
4317 <Query rt36_tickets>
4318 Statement "SELECT COUNT(type) AS count, type \
4320 WHEN resolved = 'epoch' THEN 'open' \
4321 ELSE 'resolved' END AS type \
4322 FROM tickets) type \
4326 InstancePrefix "rt36_tickets"
4327 InstancesFrom "type"
4333 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
4343 KRBSrvName "kerberos_service_name"
4349 Service "service_name"
4350 Query backend # predefined
4361 The B<Query> block defines one database query which may later be used by a
4362 database definition. It accepts a single mandatory argument which specifies
4363 the name of the query. The names of all queries have to be unique (see the
4364 B<MinVersion> and B<MaxVersion> options below for an exception to this
4365 rule). The following configuration options are available to define the query:
4367 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
4368 blocks define how to handle the values returned from the query. They define
4369 which column holds which value and how to dispatch that value to the daemon.
4370 Multiple B<Result> blocks may be used to extract multiple values from a single
4375 =item B<Statement> I<sql query statement>
4377 Specify the I<sql query statement> which the plugin should execute. The string
4378 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
4379 first, second, etc. parameter. The value of the parameters is specified by the
4380 B<Param> configuration option - see below for details. To include a literal
4381 B<$> character followed by a number, surround it with single quotes (B<'>).
4383 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
4384 allowed. Note, however, that only a single command may be used. Semicolons are
4385 allowed as long as a single non-empty command has been specified only.
4387 The returned lines will be handled separately one after another.
4389 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4391 Specify the parameters which should be passed to the SQL query. The parameters
4392 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4393 they appear in the configuration file. The value of the parameter is
4394 determined depending on the value of the B<Param> option as follows:
4400 The configured hostname of the database connection. If a UNIX domain socket is
4401 used, the parameter expands to "localhost".
4405 The name of the database of the current connection.
4409 The name of the database plugin instance. See the B<Instance> option of the
4410 database specification below for details.
4414 The username used to connect to the database.
4418 The interval with which this database is queried (as specified by the database
4419 specific or global B<Interval> options).
4423 Please note that parameters are only supported by PostgreSQL's protocol
4424 version 3 and above which was introduced in version 7.4 of PostgreSQL.
4426 =item B<Type> I<type>
4428 The I<type> name to be used when dispatching the values. The type describes
4429 how to handle the data and where to store it. See L<types.db(5)> for more
4430 details on types and their configuration. The number and type of values (as
4431 selected by the B<ValuesFrom> option) has to match the type of the given name.
4433 This option is required inside a B<Result> block.
4435 =item B<InstancePrefix> I<prefix>
4437 =item B<InstancesFrom> I<column0> [I<column1> ...]
4439 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
4440 B<InstancePrefix> defines a static prefix that will be prepended to all type
4441 instances. B<InstancesFrom> defines the column names whose values will be used
4442 to create the type instance. Multiple values will be joined together using the
4443 hyphen (C<->) as separation character.
4445 The plugin itself does not check whether or not all built instances are
4446 different. It is your responsibility to assure that each is unique.
4448 Both options are optional. If none is specified, the type instance will be
4451 =item B<ValuesFrom> I<column0> [I<column1> ...]
4453 Names the columns whose content is used as the actual data for the data sets
4454 that are dispatched to the daemon. How many such columns you need is
4455 determined by the B<Type> setting as explained above. If you specify too many
4456 or not enough columns, the plugin will complain about that and no data will be
4457 submitted to the daemon.
4459 The actual data type, as seen by PostgreSQL, is not that important as long as
4460 it represents numbers. The plugin will automatically cast the values to the
4461 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
4462 L<strtod(3)> functions, so anything supported by those functions is supported
4463 by the plugin as well.
4465 This option is required inside a B<Result> block and may be specified multiple
4466 times. If multiple B<ValuesFrom> options are specified, the columns are read
4469 =item B<MinVersion> I<version>
4471 =item B<MaxVersion> I<version>
4473 Specify the minimum or maximum version of PostgreSQL that this query should be
4474 used with. Some statistics might only be available with certain versions of
4475 PostgreSQL. This allows you to specify multiple queries with the same name but
4476 which apply to different versions, thus allowing you to use the same
4477 configuration in a heterogeneous environment.
4479 The I<version> has to be specified as the concatenation of the major, minor
4480 and patch-level versions, each represented as two-decimal-digit numbers. For
4481 example, version 8.2.3 will become 80203.
4485 The following predefined queries are available (the definitions can be found
4486 in the F<postgresql_default.conf> file which, by default, is available at
4487 C<I<prefix>/share/collectd/>):
4493 This query collects the number of backends, i.E<nbsp>e. the number of
4496 =item B<transactions>
4498 This query collects the numbers of committed and rolled-back transactions of
4503 This query collects the numbers of various table modifications (i.E<nbsp>e.
4504 insertions, updates, deletions) of the user tables.
4506 =item B<query_plans>
4508 This query collects the numbers of various table scans and returned tuples of
4511 =item B<table_states>
4513 This query collects the numbers of live and dead rows in the user tables.
4517 This query collects disk block access counts for user tables.
4521 This query collects the on-disk size of the database in bytes.
4525 In addition, the following detailed queries are available by default. Please
4526 note that each of those queries collects information B<by table>, thus,
4527 potentially producing B<a lot> of data. For details see the description of the
4528 non-by_table queries above.
4532 =item B<queries_by_table>
4534 =item B<query_plans_by_table>
4536 =item B<table_states_by_table>
4538 =item B<disk_io_by_table>
4542 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
4543 mandatory argument specifying the name of the writer. This will then be used
4544 in the B<Database> specification in order to activate the writer instance. The
4545 names of all writers have to be unique. The following options may be
4550 =item B<Statement> I<sql statement>
4552 This mandatory option specifies the SQL statement that will be executed for
4553 each submitted value. A single SQL statement is allowed only. Anything after
4554 the first semicolon will be ignored.
4556 Nine parameters will be passed to the statement and should be specified as
4557 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
4558 values are made available through those parameters:
4564 The timestamp of the queried value as a floating point number.
4568 The hostname of the queried value.
4572 The plugin name of the queried value.
4576 The plugin instance of the queried value. This value may be B<NULL> if there
4577 is no plugin instance.
4581 The type of the queried value (cf. L<types.db(5)>).
4585 The type instance of the queried value. This value may be B<NULL> if there is
4590 An array of names for the submitted values (i.E<nbsp>e., the name of the data
4591 sources of the submitted value-list).
4595 An array of types for the submitted values (i.E<nbsp>e., the type of the data
4596 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
4597 B<StoreRates> is enabled (which is the default, see below), all types will be
4602 An array of the submitted values. The dimensions of the value name and value
4607 In general, it is advisable to create and call a custom function in the
4608 PostgreSQL database for this purpose. Any procedural language supported by
4609 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
4612 =item B<StoreRates> B<false>|B<true>
4614 If set to B<true> (the default), convert counter values to rates. If set to
4615 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
4620 The B<Database> block defines one PostgreSQL database for which to collect
4621 statistics. It accepts a single mandatory argument which specifies the
4622 database name. None of the other options are required. PostgreSQL will use
4623 default values as documented in the section "CONNECTING TO A DATABASE" in the
4624 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
4625 the user collectd is run as and special environment variables. See the manpage
4630 =item B<Interval> I<seconds>
4632 Specify the interval with which the database should be queried. The default is
4633 to use the global B<Interval> setting.
4635 =item B<CommitInterval> I<seconds>
4637 This option may be used for database connections which have "writers" assigned
4638 (see above). If specified, it causes a writer to put several updates into a
4639 single transaction. This transaction will last for the specified amount of
4640 time. By default, each update will be executed in a separate transaction. Each
4641 transaction generates a fair amount of overhead which can, thus, be reduced by
4642 activating this option. The draw-back is, that data covering the specified
4643 amount of time will be lost, for example, if a single statement within the
4644 transaction fails or if the database server crashes.
4646 =item B<Host> I<hostname>
4648 Specify the hostname or IP of the PostgreSQL server to connect to. If the
4649 value begins with a slash, it is interpreted as the directory name in which to
4650 look for the UNIX domain socket.
4652 This option is also used to determine the hostname that is associated with a
4653 collected data set. If it has been omitted or either begins with with a slash
4654 or equals B<localhost> it will be replaced with the global hostname definition
4655 of collectd. Any other value will be passed literally to collectd when
4656 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
4658 =item B<Port> I<port>
4660 Specify the TCP port or the local UNIX domain socket file extension of the
4663 =item B<User> I<username>
4665 Specify the username to be used when connecting to the server.
4667 =item B<Password> I<password>
4669 Specify the password to be used when connecting to the server.
4671 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
4673 Specify whether to use an SSL connection when contacting the server. The
4674 following modes are supported:
4676 =item B<Instance> I<name>
4678 Specify the plugin instance name that should be used instead of the database
4679 name (which is the default, if this option has not been specified). This
4680 allows to query multiple databases of the same name on the same host (e.g.
4681 when running multiple database server versions in parallel).
4687 Do not use SSL at all.
4691 First, try to connect without using SSL. If that fails, try using SSL.
4693 =item I<prefer> (default)
4695 First, try to connect using SSL. If that fails, try without using SSL.
4703 =item B<KRBSrvName> I<kerberos_service_name>
4705 Specify the Kerberos service name to use when authenticating with Kerberos 5
4706 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
4707 B<PostgreSQL Documentation> for details.
4709 =item B<Service> I<service_name>
4711 Specify the PostgreSQL service name to use for additional parameters. That
4712 service has to be defined in F<pg_service.conf> and holds additional
4713 connection parameters. See the section "The Connection Service File" in the
4714 B<PostgreSQL Documentation> for details.
4716 =item B<Query> I<query>
4718 Specifies a I<query> which should be executed in the context of the database
4719 connection. This may be any of the predefined or user-defined queries. If no
4720 such option is given, it defaults to "backends", "transactions", "queries",
4721 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
4722 has been specified). Else, the specified queries are used only.
4724 =item B<Writer> I<writer>
4726 Assigns the specified I<writer> backend to the database connection. This
4727 causes all collected data to be send to the database using the settings
4728 defined in the writer configuration (see the section "FILTER CONFIGURATION"
4729 below for details on how to selectively send data to certain plugins).
4731 Each writer will register a flush callback which may be used when having long
4732 transactions enabled (see the B<CommitInterval> option above). When issuing
4733 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
4734 transaction will be committed right away. Two different kinds of flush
4735 callbacks are available with the C<postgresql> plugin:
4741 Flush all writer backends.
4743 =item B<postgresql->I<database>
4745 Flush all writers of the specified I<database> only.
4751 =head2 Plugin C<powerdns>
4753 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
4754 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
4755 values, many of which are probably meaningless to most users, but may be useful
4756 for some. So you may chose which values to collect, but if you don't, some
4757 reasonable defaults will be collected.
4760 <Server "server_name">
4762 Collect "udp-answers" "udp-queries"
4763 Socket "/var/run/pdns.controlsocket"
4765 <Recursor "recursor_name">
4767 Collect "cache-hits" "cache-misses"
4768 Socket "/var/run/pdns_recursor.controlsocket"
4770 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
4775 =item B<Server> and B<Recursor> block
4777 The B<Server> block defines one authoritative server to query, the B<Recursor>
4778 does the same for an recursing server. The possible options in both blocks are
4779 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
4784 =item B<Collect> I<Field>
4786 Using the B<Collect> statement you can select which values to collect. Here,
4787 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
4788 C<dlg-only-drops>, C<answers10-100>.
4790 The method of getting the values differs for B<Server> and B<Recursor> blocks:
4791 When querying the server a C<SHOW *> command is issued in any case, because
4792 that's the only way of getting multiple values out of the server at once.
4793 collectd then picks out the values you have selected. When querying the
4794 recursor, a command is generated to query exactly these values. So if you
4795 specify invalid fields when querying the recursor, a syntax error may be
4796 returned by the daemon and collectd may not collect any values at all.
4798 If no B<Collect> statement is given, the following B<Server> values will be
4805 =item packetcache-hit
4807 =item packetcache-miss
4809 =item packetcache-size
4811 =item query-cache-hit
4813 =item query-cache-miss
4815 =item recursing-answers
4817 =item recursing-questions
4829 The following B<Recursor> values will be collected by default:
4833 =item noerror-answers
4835 =item nxdomain-answers
4837 =item servfail-answers
4855 Please note that up to that point collectd doesn't know what values are
4856 available on the server and values that are added do not need a change of the
4857 mechanism so far. However, the values must be mapped to collectd's naming
4858 scheme, which is done using a lookup table that lists all known values. If
4859 values are added in the future and collectd does not know about them, you will
4860 get an error much like this:
4862 powerdns plugin: submit: Not found in lookup table: foobar = 42
4864 In this case please file a bug report with the collectd team.
4866 =item B<Socket> I<Path>
4868 Configures the path to the UNIX domain socket to be used when connecting to the
4869 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
4870 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
4871 will be used for the recursor.
4875 =item B<LocalSocket> I<Path>
4877 Querying the recursor is done using UDP. When using UDP over UNIX domain
4878 sockets, the client socket needs a name in the file system, too. You can set
4879 this local name to I<Path> using the B<LocalSocket> option. The default is
4880 C<I<prefix>/var/run/collectd-powerdns>.
4884 =head2 Plugin C<processes>
4888 =item B<Process> I<Name>
4890 Select more detailed statistics of processes matching this name. The statistics
4891 collected for these selected processes are size of the resident segment size
4892 (RSS), user- and system-time used, number of processes and number of threads,
4893 io data (where available) and minor and major pagefaults.
4895 =item B<ProcessMatch> I<name> I<regex>
4897 Similar to the B<Process> option this allows to select more detailed
4898 statistics of processes matching the specified I<regex> (see L<regex(7)> for
4899 details). The statistics of all matching processes are summed up and
4900 dispatched to the daemon using the specified I<name> as an identifier. This
4901 allows to "group" several processes together. I<name> must not contain
4906 =head2 Plugin C<protocols>
4908 Collects a lot of information about various network protocols, such as I<IP>,
4909 I<TCP>, I<UDP>, etc.
4911 Available configuration options:
4915 =item B<Value> I<Selector>
4917 Selects whether or not to select a specific value. The string being matched is
4918 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
4919 plugin instance and I<ValueName> will be used as type instance. An example of
4920 the string being used would be C<Tcp:RetransSegs>.
4922 You can use regular expressions to match a large number of values with just one
4923 configuration option. To select all "extended" I<TCP> values, you could use the
4924 following statement:
4928 Whether only matched values are selected or all matched values are ignored
4929 depends on the B<IgnoreSelected>. By default, only matched values are selected.
4930 If no value is configured at all, all values will be selected.
4932 =item B<IgnoreSelected> B<true>|B<false>
4934 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
4935 matching values will be ignored.
4939 =head2 Plugin C<python>
4941 This plugin embeds a Python-interpreter into collectd and provides an interface
4942 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
4944 =head2 Plugin C<routeros>
4946 The C<routeros> plugin connects to a device running I<RouterOS>, the
4947 Linux-based operating system for routers by I<MikroTik>. The plugin uses
4948 I<librouteros> to connect and reads information about the interfaces and
4949 wireless connections of the device. The configuration supports querying
4954 Host "router0.example.com"
4957 CollectInterface true
4962 Host "router1.example.com"
4965 CollectInterface true
4966 CollectRegistrationTable true
4972 As you can see above, the configuration of the I<routeros> plugin consists of
4973 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
4974 options are understood:
4978 =item B<Host> I<Host>
4980 Hostname or IP-address of the router to connect to.
4982 =item B<Port> I<Port>
4984 Port name or port number used when connecting. If left unspecified, the default
4985 will be chosen by I<librouteros>, currently "8728". This option expects a
4986 string argument, even when a numeric port number is given.
4988 =item B<User> I<User>
4990 Use the user name I<User> to authenticate. Defaults to "admin".
4992 =item B<Password> I<Password>
4994 Set the password used to authenticate.
4996 =item B<CollectInterface> B<true>|B<false>
4998 When set to B<true>, interface statistics will be collected for all interfaces
4999 present on the device. Defaults to B<false>.
5001 =item B<CollectRegistrationTable> B<true>|B<false>
5003 When set to B<true>, information about wireless LAN connections will be
5004 collected. Defaults to B<false>.
5006 =item B<CollectCPULoad> B<true>|B<false>
5008 When set to B<true>, information about the CPU usage will be collected. The
5009 number is a dimensionless value where zero indicates no CPU usage at all.
5010 Defaults to B<false>.
5012 =item B<CollectMemory> B<true>|B<false>
5014 When enabled, the amount of used and free memory will be collected. How used
5015 memory is calculated is unknown, for example whether or not caches are counted
5017 Defaults to B<false>.
5019 =item B<CollectDF> B<true>|B<false>
5021 When enabled, the amount of used and free disk space will be collected.
5022 Defaults to B<false>.
5024 =item B<CollectDisk> B<true>|B<false>
5026 When enabled, the number of sectors written and bad blocks will be collected.
5027 Defaults to B<false>.
5031 =head2 Plugin C<redis>
5033 The I<Redis plugin> connects to one or more Redis servers and gathers
5034 information about each server's state. For each server there is a I<Node> block
5035 which configures the connection parameters for this node.
5045 The information shown in the synopsis above is the I<default configuration>
5046 which is used by the plugin if no configuration is present.
5050 =item B<Node> I<Nodename>
5052 The B<Node> block identifies a new Redis node, that is a new Redis instance
5053 running in an specified host and port. The name for node is a canonical
5054 identifier which is used as I<plugin instance>. It is limited to
5055 64E<nbsp>characters in length.
5057 =item B<Host> I<Hostname>
5059 The B<Host> option is the hostname or IP-address where the Redis instance is
5062 =item B<Port> I<Port>
5064 The B<Port> option is the TCP port on which the Redis instance accepts
5065 connections. Either a service name of a port number may be given. Please note
5066 that numerical port numbers must be given as a string, too.
5068 =item B<Password> I<Password>
5070 Use I<Password> to authenticate when connecting to I<Redis>.
5072 =item B<Timeout> I<Timeout in miliseconds>
5074 The B<Timeout> option set the socket timeout for node response. Since the Redis
5075 read function is blocking, you should keep this value as low as possible. Keep
5076 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
5077 than B<Interval> defined globally.
5081 =head2 Plugin C<rrdcached>
5083 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
5084 to store values to RRD files in an efficient manner. The combination of the
5085 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
5086 way the C<rrdtool> plugin works (see below). The added abstraction layer
5087 provides a number of benefits, though: Because the cache is not within
5088 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
5089 restarted. This results in much shorter (if any) gaps in graphs, especially
5090 under heavy load. Also, the C<rrdtool> command line utility is aware of the
5091 daemon so that it can flush values to disk automatically when needed. This
5092 allows to integrate automated flushing of values into graphing solutions much
5095 There are disadvantages, though: The daemon may reside on a different host, so
5096 it may not be possible for C<collectd> to create the appropriate RRD files
5097 anymore. And even if C<rrdcached> runs on the same host, it may run in a
5098 different base directory, so relative paths may do weird stuff if you're not
5101 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
5102 on the same host, communicating via a UNIX domain socket. The B<DataDir>
5103 setting should be set to an absolute path, so that a changed base directory
5104 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
5108 =item B<DaemonAddress> I<Address>
5110 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
5111 library. See L<rrdcached(1)> for details. Example:
5113 <Plugin "rrdcached">
5114 DaemonAddress "unix:/var/run/rrdcached.sock"
5117 =item B<DataDir> I<Directory>
5119 Set the base directory in which the RRD files reside. If this is a relative
5120 path, it is relative to the working base directory of the C<rrdcached> daemon!
5121 Use of an absolute path is recommended.
5123 =item B<CreateFiles> B<true>|B<false>
5125 Enables or disables the creation of RRD files. If the daemon is not running
5126 locally, or B<DataDir> is set to a relative path, this will not work as
5127 expected. Default is B<true>.
5129 =item B<CreateFilesAsync> B<false>|B<true>
5131 When enabled, new RRD files are enabled asynchronously, using a separate thread
5132 that runs in the background. This prevents writes to block, which is a problem
5133 especially when many hundreds of files need to be created at once. However,
5134 since the purpose of creating the files asynchronously is I<not> to block until
5135 the file is available, values before the file is available will be discarded.
5136 When disabled (the default) files are created synchronously, blocking for a
5137 short while, while the file is being written.
5139 =item B<StepSize> I<Seconds>
5141 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5142 this setting is unset and the stepsize is set to the interval in which the data
5143 is collected. Do not use this option unless you absolutely have to for some
5144 reason. Setting this option may cause problems with the C<snmp plugin>, the
5145 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5147 =item B<HeartBeat> I<Seconds>
5149 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5150 in which case the heartbeat is set to twice the B<StepSize> which should equal
5151 the interval in which data is collected. Do not set this option unless you have
5152 a very good reason to do so.
5154 =item B<RRARows> I<NumRows>
5156 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5157 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5158 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5159 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5160 week, one month, and one year.
5162 So for each timespan, it calculates how many PDPs need to be consolidated into
5163 one CDP by calculating:
5164 number of PDPs = timespan / (stepsize * rrarows)
5166 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5169 =item B<RRATimespan> I<Seconds>
5171 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5172 more then one RRA. If this option is never used, the built-in default of (3600,
5173 86400, 604800, 2678400, 31622400) is used.
5175 For more information on how RRA-sizes are calculated see B<RRARows> above.
5177 =item B<XFF> I<Factor>
5179 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5180 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5185 =head2 Plugin C<rrdtool>
5187 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
5188 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
5189 using these settings. If you don't want to dive into the depths of RRDtool, you
5190 can safely ignore these settings.
5194 =item B<DataDir> I<Directory>
5196 Set the directory to store RRD files under. By default RRD files are generated
5197 beneath the daemon's working directory, i.e. the B<BaseDir>.
5199 =item B<CreateFilesAsync> B<false>|B<true>
5201 When enabled, new RRD files are enabled asynchronously, using a separate thread
5202 that runs in the background. This prevents writes to block, which is a problem
5203 especially when many hundreds of files need to be created at once. However,
5204 since the purpose of creating the files asynchronously is I<not> to block until
5205 the file is available, values before the file is available will be discarded.
5206 When disabled (the default) files are created synchronously, blocking for a
5207 short while, while the file is being written.
5209 =item B<StepSize> I<Seconds>
5211 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5212 this setting is unset and the stepsize is set to the interval in which the data
5213 is collected. Do not use this option unless you absolutely have to for some
5214 reason. Setting this option may cause problems with the C<snmp plugin>, the
5215 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5217 =item B<HeartBeat> I<Seconds>
5219 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5220 in which case the heartbeat is set to twice the B<StepSize> which should equal
5221 the interval in which data is collected. Do not set this option unless you have
5222 a very good reason to do so.
5224 =item B<RRARows> I<NumRows>
5226 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5227 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5228 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5229 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5230 week, one month, and one year.
5232 So for each timespan, it calculates how many PDPs need to be consolidated into
5233 one CDP by calculating:
5234 number of PDPs = timespan / (stepsize * rrarows)
5236 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5239 =item B<RRATimespan> I<Seconds>
5241 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5242 more then one RRA. If this option is never used, the built-in default of (3600,
5243 86400, 604800, 2678400, 31622400) is used.
5245 For more information on how RRA-sizes are calculated see B<RRARows> above.
5247 =item B<XFF> I<Factor>
5249 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5250 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5253 =item B<CacheFlush> I<Seconds>
5255 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
5256 it writes all values for a certain RRD-file if the oldest value is older than
5257 (or equal to) the number of seconds specified. If some RRD-file is not updated
5258 anymore for some reason (the computer was shut down, the network is broken,
5259 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
5260 entire cache is searched for entries older than B<CacheTimeout> seconds and
5261 written to disk every I<Seconds> seconds. Since this is kind of expensive and
5262 does nothing under normal circumstances, this value should not be too small.
5263 900 seconds might be a good value, though setting this to 7200 seconds doesn't
5264 normally do much harm either.
5266 =item B<CacheTimeout> I<Seconds>
5268 If this option is set to a value greater than zero, the C<rrdtool plugin> will
5269 save values in a cache, as described above. Writing multiple values at once
5270 reduces IO-operations and thus lessens the load produced by updating the files.
5271 The trade off is that the graphs kind of "drag behind" and that more memory is
5274 =item B<WritesPerSecond> I<Updates>
5276 When collecting many statistics with collectd and the C<rrdtool> plugin, you
5277 will run serious performance problems. The B<CacheFlush> setting and the
5278 internal update queue assert that collectd continues to work just fine even
5279 under heavy load, but the system may become very unresponsive and slow. This is
5280 a problem especially if you create graphs from the RRD files on the same
5281 machine, for example using the C<graph.cgi> script included in the
5282 C<contrib/collection3/> directory.
5284 This setting is designed for very large setups. Setting this option to a value
5285 between 25 and 80 updates per second, depending on your hardware, will leave
5286 the server responsive enough to draw graphs even while all the cached values
5287 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
5288 by the B<FLUSH> command, are B<not> effected by this limit. They are still
5289 written as fast as possible, so that web frontends have up to date data when
5292 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
5293 updates per second, writing all values to disk will take approximately
5294 56E<nbsp>minutes. Together with the flushing ability that's integrated into
5295 "collection3" you'll end up with a responsive and fast system, up to date
5296 graphs and basically a "backup" of your values every hour.
5298 =item B<RandomTimeout> I<Seconds>
5300 When set, the actual timeout for each value is chosen randomly between
5301 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
5302 intention is to avoid high load situations that appear when many values timeout
5303 at the same time. This is especially a problem shortly after the daemon starts,
5304 because all values were added to the internal cache at roughly the same time.
5308 =head2 Plugin C<sensors>
5310 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
5311 that all the needed modules have to be loaded and lm_sensors has to be
5312 configured (most likely by editing F</etc/sensors.conf>. Read
5313 L<sensors.conf(5)> for details.
5315 The B<lm_sensors> homepage can be found at
5316 L<http://secure.netroedge.com/~lm78/>.
5320 =item B<SensorConfigFile> I<File>
5322 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
5323 the library's default will be used.
5325 =item B<Sensor> I<chip-bus-address/type-feature>
5327 Selects the name of the sensor which you want to collect or ignore, depending
5328 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
5329 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
5330 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
5332 =item B<IgnoreSelected> I<true>|I<false>
5334 If no configuration if given, the B<sensors>-plugin will collect data from all
5335 sensors. This may not be practical, especially for uninteresting sensors.
5336 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
5337 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
5338 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
5339 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
5340 and all other sensors are collected.
5344 =head2 Plugin C<sigrok>
5346 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
5347 supported by the L<sigrok|http://sigrok.org/> project.
5353 <Device "AC Voltage">
5358 <Device "Sound Level">
5359 Driver "cem-dt-885x"
5366 =item B<LogLevel> B<0-5>
5368 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
5369 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
5370 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
5371 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
5372 their level, are always submitted to I<collectd> at its INFO log level.
5374 =item E<lt>B<Device> I<Name>E<gt>
5376 A sigrok-supported device, uniquely identified by this section's options. The
5377 I<Name> is passed to I<collectd> as the I<plugin instance>.
5379 =item B<Driver> I<DriverName>
5381 The sigrok driver to use for this device.
5383 =item B<Conn> I<ConnectionSpec>
5385 If the device cannot be auto-discovered, or more than one might be discovered
5386 by the driver, I<ConnectionSpec> specifies the connection string to the device.
5387 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
5388 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
5389 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
5390 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
5392 =item B<SerialComm> I<SerialSpec>
5394 For serial devices with non-standard port settings, this option can be used
5395 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
5396 This should not be necessary; drivers know how to communicate with devices they
5399 =item B<MinimumInterval> I<Seconds>
5401 Specifies the minimum time between measurement dispatches to I<collectd>, in
5402 seconds. Since some I<sigrok> supported devices can acquire measurements many
5403 times per second, it may be necessary to throttle these. For example, the
5404 I<RRD plugin> cannot process writes more than once per second.
5406 The default B<MinimumInterval> is B<0>, meaning measurements received from the
5407 device are always dispatched to I<collectd>. When throttled, unused
5408 measurements are discarded.
5412 =head2 Plugin C<snmp>
5414 Since the configuration of the C<snmp plugin> is a little more complicated than
5415 other plugins, its documentation has been moved to an own manpage,
5416 L<collectd-snmp(5)>. Please see there for details.
5418 =head2 Plugin C<statsd>
5420 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
5421 protocol and dispatches rates or other aggregates of these numbers
5424 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
5425 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
5426 C<objects> respectively.
5428 The following configuration options are valid:
5432 =item B<Host> I<Host>
5434 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
5435 "any" address, i.e. accept packets sent to any of the hosts addresses.
5437 =item B<Port> I<Port>
5439 UDP port to listen to. This can be either a service name or a port number.
5440 Defaults to C<8125>.
5442 =item B<DeleteCounters> B<false>|B<true>
5444 =item B<DeleteTimers> B<false>|B<true>
5446 =item B<DeleteGauges> B<false>|B<true>
5448 =item B<DeleteSets> B<false>|B<true>
5450 These options control what happens if metrics are not updated in an interval.
5451 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
5452 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
5453 are unchanged. If set to B<True>, the such metrics are not dispatched and
5454 removed from the internal cache.
5456 =item B<TimerPercentile> I<Percent>
5458 Calculate and dispatch the configured percentile, i.e. compute the latency, so
5459 that I<Percent> of all reported timers are smaller than or equal to the
5460 computed latency. This is useful for cutting off the long tail latency, as it's
5461 often done in I<Service Level Agreements> (SLAs).
5463 If not specified, no percentile is calculated / dispatched.
5467 =head2 Plugin C<swap>
5469 The I<Swap plugin> collects information about used and available swap space. On
5470 I<Linux> and I<Solaris>, the following options are available:
5474 =item B<ReportByDevice> B<false>|B<true>
5476 Configures how to report physical swap devices. If set to B<false> (the
5477 default), the summary over all swap devices is reported only, i.e. the globally
5478 used and available space over all devices. If B<true> is configured, the used
5479 and available space of each device will be reported separately.
5481 This option is only available if the I<Swap plugin> can read C</proc/swaps>
5482 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
5484 =item B<ReportBytes> B<false>|B<true>
5486 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
5487 I<swap I/O> is reported in pages. This option is available under Linux only.
5489 =item B<ValuesAbsolute> B<true>|B<false>
5491 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
5492 available and used. Defaults to B<true>.
5494 =item B<ValuesPercentage> B<false>|B<true>
5496 Enables or disables reporting of relative swap metrics, i.e. I<percent>
5497 available and free. Defaults to B<false>.
5499 This is useful for deploying I<collectd> in a heterogeneous environment, where
5500 swap sizes differ and you want to specify generic thresholds or similar.
5504 =head2 Plugin C<syslog>
5508 =item B<LogLevel> B<debug|info|notice|warning|err>
5510 Sets the log-level. If, for example, set to B<notice>, then all events with
5511 severity B<notice>, B<warning>, or B<err> will be submitted to the
5514 Please note that B<debug> is only available if collectd has been compiled with
5517 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
5519 Controls which notifications should be sent to syslog. The default behaviour is
5520 not to send any. Less severe notifications always imply logging more severe
5521 notifications: Setting this to B<OKAY> means all notifications will be sent to
5522 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
5523 notifications but will dismiss B<OKAY> notifications. Setting this option to
5524 B<FAILURE> will only send failures to syslog.
5528 =head2 Plugin C<table>
5530 The C<table plugin> provides generic means to parse tabular data and dispatch
5531 user specified values. Values are selected based on column numbers. For
5532 example, this plugin may be used to get values from the Linux L<proc(5)>
5533 filesystem or CSV (comma separated values) files.
5536 <Table "/proc/slabinfo">
5541 InstancePrefix "active_objs"
5547 InstancePrefix "objperslab"
5554 The configuration consists of one or more B<Table> blocks, each of which
5555 configures one file to parse. Within each B<Table> block, there are one or
5556 more B<Result> blocks, which configure which data to select and how to
5559 The following options are available inside a B<Table> block:
5563 =item B<Instance> I<instance>
5565 If specified, I<instance> is used as the plugin instance. So, in the above
5566 example, the plugin name C<table-slabinfo> would be used. If omitted, the
5567 filename of the table is used instead, with all special characters replaced
5568 with an underscore (C<_>).
5570 =item B<Separator> I<string>
5572 Any character of I<string> is interpreted as a delimiter between the different
5573 columns of the table. A sequence of two or more contiguous delimiters in the
5574 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
5575 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
5576 of a table - see its documentation for more details. This option is mandatory.
5578 A horizontal tab, newline and carriage return may be specified by C<\\t>,
5579 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
5580 required because of collectd's config parsing.
5584 The following options are available inside a B<Result> block:
5588 =item B<Type> I<type>
5590 Sets the type used to dispatch the values to the daemon. Detailed information
5591 about types and their configuration can be found in L<types.db(5)>. This
5592 option is mandatory.
5594 =item B<InstancePrefix> I<prefix>
5596 If specified, prepend I<prefix> to the type instance. If omitted, only the
5597 B<InstancesFrom> option is considered for the type instance.
5599 =item B<InstancesFrom> I<column0> [I<column1> ...]
5601 If specified, the content of the given columns (identified by the column
5602 number starting at zero) will be used to create the type instance for each
5603 row. Multiple values (and the instance prefix) will be joined together with
5604 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
5605 option is considered for the type instance.
5607 The plugin itself does not check whether or not all built instances are
5608 different. It’s your responsibility to assure that each is unique. This is
5609 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
5610 sure that the table only contains one row.
5612 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
5615 =item B<ValuesFrom> I<column0> [I<column1> ...]
5617 Specifies the columns (identified by the column numbers starting at zero)
5618 whose content is used as the actual data for the data sets that are dispatched
5619 to the daemon. How many such columns you need is determined by the B<Type>
5620 setting above. If you specify too many or not enough columns, the plugin will
5621 complain about that and no data will be submitted to the daemon. The plugin
5622 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
5623 respectively, so anything supported by those functions is supported by the
5624 plugin as well. This option is mandatory.
5628 =head2 Plugin C<tail>
5630 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
5631 each line and dispatches found values. What is matched can be configured by the
5632 user using (extended) regular expressions, as described in L<regex(7)>.
5635 <File "/var/log/exim4/mainlog">
5639 Regex "S=([1-9][0-9]*)"
5645 Regex "\\<R=local_user\\>"
5646 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
5649 Instance "local_user"
5654 The config consists of one or more B<File> blocks, each of which configures one
5655 logfile to parse. Within each B<File> block, there are one or more B<Match>
5656 blocks, which configure a regular expression to search for.
5658 The B<Instance> option in the B<File> block may be used to set the plugin
5659 instance. So in the above example the plugin name C<tail-foo> would be used.
5660 This plugin instance is for all B<Match> blocks that B<follow> it, until the
5661 next B<Instance> option. This way you can extract several plugin instances from
5662 one logfile, handy when parsing syslog and the like.
5664 The B<Interval> option allows you to define the length of time between reads. If
5665 this is not set, the default Interval will be used.
5667 Each B<Match> block has the following options to describe how the match should
5672 =item B<Regex> I<regex>
5674 Sets the regular expression to use for matching against a line. The first
5675 subexpression has to match something that can be turned into a number by
5676 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
5677 below. Because B<extended> regular expressions are used, you do not need to use
5678 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
5679 collectd's config parsing you need to escape backslashes, though. So if you
5680 want to match literal parentheses you need to do the following:
5682 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
5684 =item B<ExcludeRegex> I<regex>
5686 Sets an optional regular expression to use for excluding lines from the match.
5687 An example which excludes all connections from localhost from the match:
5689 ExcludeRegex "127\\.0\\.0\\.1"
5691 =item B<DSType> I<Type>
5693 Sets how the values are cumulated. I<Type> is one of:
5697 =item B<GaugeAverage>
5699 Calculate the average.
5703 Use the smallest number only.
5707 Use the greatest number only.
5711 Use the last number found.
5717 =item B<AbsoluteSet>
5719 The matched number is a counter. Simply I<sets> the internal counter to this
5720 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
5726 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
5727 matched number may be negative, which will effectively subtract from the
5734 Increase the internal counter by one. These B<DSType> are the only ones that do
5735 not use the matched subexpression, but simply count the number of matched
5736 lines. Thus, you may use a regular expression without submatch in this case.
5740 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
5741 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
5742 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
5743 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
5744 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
5747 =item B<Type> I<Type>
5749 Sets the type used to dispatch this value. Detailed information about types and
5750 their configuration can be found in L<types.db(5)>.
5752 =item B<Instance> I<TypeInstance>
5754 This optional setting sets the type instance to use.
5758 =head2 Plugin C<tail_csv>
5760 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
5761 written by I<Snort>.
5766 <Metric "snort-dropped">
5771 <File "/var/log/snort/snort.stats">
5772 Instance "snort-eth0"
5774 Collect "snort-dropped"
5778 The configuration consists of one or more B<Metric> blocks that define an index
5779 into the line of the CSV file and how this value is mapped to I<collectd's>
5780 internal representation. These are followed by one or more B<Instance> blocks
5781 which configure which file to read, in which interval and which metrics to
5786 =item E<lt>B<Metric> I<Name>E<gt>
5788 The B<Metric> block configures a new metric to be extracted from the statistics
5789 file and how it is mapped on I<collectd's> data model. The string I<Name> is
5790 only used inside the B<Instance> blocks to refer to this block, so you can use
5791 one B<Metric> block for multiple CSV files.
5795 =item B<Type> I<Type>
5797 Configures which I<Type> to use when dispatching this metric. Types are defined
5798 in the L<types.db(5)> file, see the appropriate manual page for more
5799 information on specifying types. Only types with a single I<data source> are
5800 supported by the I<tail_csv plugin>. The information whether the value is an
5801 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
5802 I<Type's> definition.
5804 =item B<Instance> I<TypeInstance>
5806 If set, I<TypeInstance> is used to populate the type instance field of the
5807 created value lists. Otherwise, no type instance is used.
5809 =item B<ValueFrom> I<Index>
5811 Configure to read the value from the field with the zero-based index I<Index>.
5812 If the value is parsed as signed integer, unsigned integer or double depends on
5813 the B<Type> setting, see above.
5817 =item E<lt>B<File> I<Path>E<gt>
5819 Each B<File> block represents one CSV file to read. There must be at least one
5820 I<File> block but there can be multiple if you have multiple CSV files.
5824 =item B<Instance> I<PluginInstance>
5826 Sets the I<plugin instance> used when dispatching the values.
5828 =item B<Collect> I<Metric>
5830 Specifies which I<Metric> to collect. This option must be specified at least
5831 once, and you can use this option multiple times to specify more than one
5832 metric to be extracted from this statistic file.
5834 =item B<Interval> I<Seconds>
5836 Configures the interval in which to read values from this instance / file.
5837 Defaults to the plugin's default interval.
5839 =item B<TimeFrom> I<Index>
5841 Rather than using the local time when dispatching a value, read the timestamp
5842 from the field with the zero-based index I<Index>. The value is interpreted as
5843 seconds since epoch. The value is parsed as a double and may be factional.
5849 =head2 Plugin C<teamspeak2>
5851 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
5852 polls interesting global and virtual server data. The plugin can query only one
5853 physical server but unlimited virtual servers. You can use the following
5854 options to configure it:
5858 =item B<Host> I<hostname/ip>
5860 The hostname or ip which identifies the physical server.
5863 =item B<Port> I<port>
5865 The query port of the physical server. This needs to be a string.
5868 =item B<Server> I<port>
5870 This option has to be added once for every virtual server the plugin should
5871 query. If you want to query the virtual server on port 8767 this is what the
5872 option would look like:
5876 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
5877 use quotes around it! If no such statement is given only global information
5882 =head2 Plugin C<ted>
5884 The I<TED> plugin connects to a device of "The Energy Detective", a device to
5885 measure power consumption. These devices are usually connected to a serial
5886 (RS232) or USB port. The plugin opens a configured device and tries to read the
5887 current energy readings. For more information on TED, visit
5888 L<http://www.theenergydetective.com/>.
5890 Available configuration options:
5894 =item B<Device> I<Path>
5896 Path to the device on which TED is connected. collectd will need read and write
5897 permissions on that file.
5899 Default: B</dev/ttyUSB0>
5901 =item B<Retries> I<Num>
5903 Apparently reading from TED is not that reliable. You can therefore configure a
5904 number of retries here. You only configure the I<retries> here, to if you
5905 specify zero, one reading will be performed (but no retries if that fails); if
5906 you specify three, a maximum of four readings are performed. Negative values
5913 =head2 Plugin C<tcpconns>
5915 The C<tcpconns plugin> counts the number of currently established TCP
5916 connections based on the local port and/or the remote port. Since there may be
5917 a lot of connections the default if to count all connections with a local port,
5918 for which a listening socket is opened. You can use the following options to
5919 fine-tune the ports you are interested in:
5923 =item B<ListeningPorts> I<true>|I<false>
5925 If this option is set to I<true>, statistics for all local ports for which a
5926 listening socket exists are collected. The default depends on B<LocalPort> and
5927 B<RemotePort> (see below): If no port at all is specifically selected, the
5928 default is to collect listening ports. If specific ports (no matter if local or
5929 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
5930 the selected ports will be collected unless this option is set to I<true>
5933 =item B<LocalPort> I<Port>
5935 Count the connections to a specific local port. This can be used to see how
5936 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
5937 You have to specify the port in numeric form, so for the mailserver example
5938 you'd need to set B<25>.
5940 =item B<RemotePort> I<Port>
5942 Count the connections to a specific remote port. This is useful to see how
5943 much a remote service is used. This is most useful if you want to know how many
5944 connections a local service has opened to remote services, e.E<nbsp>g. how many
5945 connections a mail server or news server has to other mail or news servers, or
5946 how many connections a web proxy holds to web servers. You have to give the
5947 port in numeric form.
5951 =head2 Plugin C<thermal>
5955 =item B<ForceUseProcfs> I<true>|I<false>
5957 By default, the I<Thermal plugin> tries to read the statistics from the Linux
5958 C<sysfs> interface. If that is not available, the plugin falls back to the
5959 C<procfs> interface. By setting this option to I<true>, you can force the
5960 plugin to use the latter. This option defaults to I<false>.
5962 =item B<Device> I<Device>
5964 Selects the name of the thermal device that you want to collect or ignore,
5965 depending on the value of the B<IgnoreSelected> option. This option may be
5966 used multiple times to specify a list of devices.
5968 =item B<IgnoreSelected> I<true>|I<false>
5970 Invert the selection: If set to true, all devices B<except> the ones that
5971 match the device names specified by the B<Device> option are collected. By
5972 default only selected devices are collected if a selection is made. If no
5973 selection is configured at all, B<all> devices are selected.
5977 =head2 Plugin C<threshold>
5979 The I<Threshold plugin> checks values collected or received by I<collectd>
5980 against a configurable I<threshold> and issues I<notifications> if values are
5983 Documentation for this plugin is available in the L<collectd-threshold(5)>
5986 =head2 Plugin C<tokyotyrant>
5988 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
5989 couple metrics: number of records, and database size on disk.
5993 =item B<Host> I<Hostname/IP>
5995 The hostname or ip which identifies the server.
5996 Default: B<127.0.0.1>
5998 =item B<Port> I<Service/Port>
6000 The query port of the server. This needs to be a string, even if the port is
6001 given in its numeric form.
6006 =head2 Plugin C<unixsock>
6010 =item B<SocketFile> I<Path>
6012 Sets the socket-file which is to be created.
6014 =item B<SocketGroup> I<Group>
6016 If running as root change the group of the UNIX-socket after it has been
6017 created. Defaults to B<collectd>.
6019 =item B<SocketPerms> I<Permissions>
6021 Change the file permissions of the UNIX-socket after it has been created. The
6022 permissions must be given as a numeric, octal value as you would pass to
6023 L<chmod(1)>. Defaults to B<0770>.
6025 =item B<DeleteSocket> B<false>|B<true>
6027 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
6028 with the given name already exists. If I<collectd> crashes a socket file may be
6029 left over, preventing the daemon from opening a new socket when restarted.
6030 Since this is potentially dangerous, this defaults to B<false>.
6034 =head2 Plugin C<uuid>
6036 This plugin, if loaded, causes the Hostname to be taken from the machine's
6037 UUID. The UUID is a universally unique designation for the machine, usually
6038 taken from the machine's BIOS. This is most useful if the machine is running in
6039 a virtual environment such as Xen, in which case the UUID is preserved across
6040 shutdowns and migration.
6042 The following methods are used to find the machine's UUID, in order:
6048 Check I</etc/uuid> (or I<UUIDFile>).
6052 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
6057 Check for UUID from C<dmidecode> / SMBIOS.
6061 Check for UUID from Xen hypervisor.
6065 If no UUID can be found then the hostname is not modified.
6069 =item B<UUIDFile> I<Path>
6071 Take the UUID from the given file (default I</etc/uuid>).
6075 =head2 Plugin C<varnish>
6077 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
6082 <Instance "example">
6084 CollectConnections true
6094 CollectWorkers false
6098 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
6099 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
6100 will collectd statistics from the default "varnishd" instance (this should work
6101 fine in most cases).
6103 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
6107 =item B<CollectCache> B<true>|B<false>
6109 Cache hits and misses. True by default.
6111 =item B<CollectConnections> B<true>|B<false>
6113 Number of client connections received, accepted and dropped. True by default.
6115 =item B<CollectBackend> B<true>|B<false>
6117 Back-end connection statistics, such as successful, reused,
6118 and closed connections. True by default.
6120 =item B<CollectSHM> B<true>|B<false>
6122 Statistics about the shared memory log, a memory region to store
6123 log messages which is flushed to disk when full. True by default.
6125 =item B<CollectBan> B<true>|B<false>
6127 Statistics about ban operations, such as number of bans added, retired, and
6128 number of objects tested against ban operations. Only available with Varnish
6129 3.x. False by default.
6131 =item B<CollectDirectorDNS> B<true>|B<false>
6133 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
6136 =item B<CollectESI> B<true>|B<false>
6138 Edge Side Includes (ESI) parse statistics. False by default.
6140 =item B<CollectFetch> B<true>|B<false>
6142 Statistics about fetches (HTTP requests sent to the backend). False by default.
6144 =item B<CollectHCB> B<true>|B<false>
6146 Inserts and look-ups in the crit bit tree based hash. Look-ups are
6147 divided into locked and unlocked look-ups. False by default.
6149 =item B<CollectObjects> B<true>|B<false>
6151 Statistics on cached objects: number of objects expired, nuked (prematurely
6152 expired), saved, moved, etc. False by default.
6154 =item B<CollectPurge> B<true>|B<false>
6156 Statistics about purge operations, such as number of purges added, retired, and
6157 number of objects tested against purge operations. Only available with Varnish
6158 2.x. False by default.
6160 =item B<CollectSession> B<true>|B<false>
6162 Client session statistics. Number of past and current sessions, session herd and
6163 linger counters, etc. False by default.
6165 =item B<CollectSMA> B<true>|B<false>
6167 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
6168 component is Solaris specific. Only available with Varnish 2.x. False by
6171 =item B<CollectSMS> B<true>|B<false>
6173 synth (synthetic content) storage statistics. This storage
6174 component is used internally only. False by default.
6176 =item B<CollectSM> B<true>|B<false>
6178 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
6181 =item B<CollectStruct> B<true>|B<false>
6183 Current varnish internal state statistics. Number of current sessions, objects
6184 in cache store, open connections to backends (with Varnish 2.x), etc. False by
6187 =item B<CollectTotals> B<true>|B<false>
6189 Collects overview counters, such as the number of sessions created,
6190 the number of requests and bytes transferred. False by default.
6192 =item B<CollectUptime> B<true>|B<false>
6194 Varnish uptime. False by default.
6196 =item B<CollectVCL> B<true>|B<false>
6198 Number of total (available + discarded) VCL (config files). False by default.
6200 =item B<CollectWorkers> B<true>|B<false>
6202 Collect statistics about worker threads. False by default.
6206 =head2 Plugin C<vmem>
6208 The C<vmem> plugin collects information about the usage of virtual memory.
6209 Since the statistics provided by the Linux kernel are very detailed, they are
6210 collected very detailed. However, to get all the details, you have to switch
6211 them on manually. Most people just want an overview over, such as the number of
6212 pages read from swap space.
6216 =item B<Verbose> B<true>|B<false>
6218 Enables verbose collection of information. This will start collecting page
6219 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
6220 Part of these statistics are collected on a "per zone" basis.
6224 =head2 Plugin C<vserver>
6226 This plugin doesn't have any options. B<VServer> support is only available for
6227 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
6228 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
6229 need to apply the patches and compile your own kernel, which will then provide
6230 the F</proc/virtual> filesystem that is required by this plugin.
6232 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
6234 B<Note>: The traffic collected by this plugin accounts for the amount of
6235 traffic passing a socket which might be a lot less than the actual on-wire
6236 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
6237 collect on-wire traffic you could, for example, use the logging facilities of
6238 iptables to feed data for the guest IPs into the iptables plugin.
6240 =head2 Plugin C<write_graphite>
6242 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
6243 storage and graphing project. The plugin connects to I<Carbon>, the data layer
6244 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
6245 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
6246 of at most 1428 bytes to minimize the number of network packets.
6250 <Plugin write_graphite>
6260 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6261 blocks. Inside the B<Node> blocks, the following options are recognized:
6265 =item B<Host> I<Address>
6267 Hostname or address to connect to. Defaults to C<localhost>.
6269 =item B<Port> I<Service>
6271 Service name or port number to connect to. Defaults to C<2003>.
6273 =item B<Protocol> I<String>
6275 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
6277 =item B<LogSendErrors> B<false>|B<true>
6279 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
6280 If set to B<false>, it will not log the errors. This is especially useful when
6281 using Protocol UDP since many times we want to use the "fire-and-forget"
6282 approach and logging errors fills syslog with unneeded messages.
6284 =item B<Prefix> I<String>
6286 When set, I<String> is added in front of the host name. Dots and whitespace are
6287 I<not> escaped in this string (see B<EscapeCharacter> below).
6289 =item B<Postfix> I<String>
6291 When set, I<String> is appended to the host name. Dots and whitespace are
6292 I<not> escaped in this string (see B<EscapeCharacter> below).
6294 =item B<EscapeCharacter> I<Char>
6296 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
6297 in the identifier. The B<EscapeCharacter> option determines which character
6298 dots, whitespace and control characters are replaced with. Defaults to
6301 =item B<StoreRates> B<false>|B<true>
6303 If set to B<true> (the default), convert counter values to rates. If set to
6304 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6307 =item B<SeparateInstances> B<false>|B<true>
6309 If set to B<true>, the plugin instance and type instance will be in their own
6310 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6311 default), the plugin and plugin instance (and likewise the type and type
6312 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6314 =item B<AlwaysAppendDS> B<false>|B<true>
6316 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
6317 identifier. If set to B<false> (the default), this is only done when there is
6322 =head2 Plugin C<write_mongodb>
6324 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
6329 <Plugin "write_mongodb">
6338 The plugin can send values to multiple instances of I<MongoDB> by specifying
6339 one B<Node> block for each instance. Within the B<Node> blocks, the following
6340 options are available:
6344 =item B<Host> I<Address>
6346 Hostname or address to connect to. Defaults to C<localhost>.
6348 =item B<Port> I<Service>
6350 Service name or port number to connect to. Defaults to C<27017>.
6352 =item B<Timeout> I<Timeout>
6354 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
6355 Setting this option to zero means no timeout, which is the default.
6357 =item B<StoreRates> B<false>|B<true>
6359 If set to B<true> (the default), convert counter values to rates. If set to
6360 B<false> counter values are stored as is, i.e. as an increasing integer
6363 =item B<Database> I<Database>
6365 =item B<User> I<User>
6367 =item B<Password> I<Password>
6369 Sets the information used when authenticating to a I<MongoDB> database. The
6370 fields are optional (in which case no authentication is attempted), but if you
6371 want to use authentication all three fields must be set.
6375 =head2 Plugin C<write_http>
6377 This output plugin submits values to an http server by POST them using the
6378 PUTVAL plain-text protocol. Each destination you want to post data to needs to
6379 have one B<URL> block, within which the destination can be configured further,
6380 for example by specifying authentication data.
6384 <Plugin "write_http">
6385 <URL "http://example.com/post-collectd">
6391 B<URL> blocks need one string argument which is used as the URL to which data
6392 is posted. The following options are understood within B<URL> blocks.
6396 =item B<User> I<Username>
6398 Optional user name needed for authentication.
6400 =item B<Password> I<Password>
6402 Optional password needed for authentication.
6404 =item B<VerifyPeer> B<true>|B<false>
6406 Enable or disable peer SSL certificate verification. See
6407 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
6409 =item B<VerifyHost> B<true|false>
6411 Enable or disable peer host name verification. If enabled, the plugin checks if
6412 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
6413 matches the host name provided by the B<URL> option. If this identity check
6414 fails, the connection is aborted. Obviously, only works when connecting to a
6415 SSL enabled server. Enabled by default.
6417 =item B<CACert> I<File>
6419 File that holds one or more SSL certificates. If you want to use HTTPS you will
6420 possibly need this option. What CA certificates come bundled with C<libcurl>
6421 and are checked by default depends on the distribution you use.
6423 =item B<Format> B<Command>|B<JSON>
6425 Format of the output to generate. If set to B<Command>, will create output that
6426 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
6427 create output in the I<JavaScript Object Notation> (JSON).
6429 Defaults to B<Command>.
6431 =item B<StoreRates> B<true|false>
6433 If set to B<true>, convert counter values to rates. If set to B<false> (the
6434 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
6439 =head2 Plugin C<write_riemann>
6441 The I<write_riemann plugin> will send values to I<Riemann>, a powerfull stream
6442 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
6443 I<Riemann> using UDP packets.
6447 <Plugin "write_riemann">
6453 AlwaysAppendDS false
6457 Attribute "foo" "bar"
6460 The following options are understood by the I<write_riemann plugin>:
6464 =item E<lt>B<Node> I<Name>E<gt>
6466 The plugin's configuration consists of one or more B<Node> blocks. Each block
6467 is given a unique I<Name> and specifies one connection to an instance of
6468 I<Riemann>. Indise the B<Node> block, the following per-connection options are
6473 =item B<Host> I<Address>
6475 Hostname or address to connect to. Defaults to C<localhost>.
6477 =item B<Port> I<Service>
6479 Service name or port number to connect to. Defaults to C<5555>.
6481 =item B<Protocol> B<UDP>|B<TCP>
6483 Specify the protocol to use when communicating with I<Riemann>. Defaults to
6486 =item B<StoreRates> B<true>|B<false>
6488 If set to B<true> (the default), convert counter values to rates. If set to
6489 B<false> counter values are stored as is, i.e. as an increasing integer number.
6491 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
6492 converted values will have "rate" appended to the data source type, e.g.
6493 C<ds_type:derive:rate>.
6495 =item B<AlwaysAppendDS> B<false>|B<true>
6497 If set the B<true>, append the name of the I<Data Source> (DS) to the
6498 "service", i.e. the field that, together with the "host" field, uniquely
6499 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
6500 only done when there is more than one DS.
6502 =item B<TTLFactor> I<Factor>
6504 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
6505 event is considered active. I<collectd> populates this field based on the
6506 metrics interval setting. This setting controls the factor with which the
6507 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
6508 know exactly what you're doing, you should only increase this setting from its
6513 =item B<Tag> I<String>
6515 Add the given string as an additional tag to the metric being sent to
6518 =item B<Attribute> I<String> I<String>
6520 Consider the two given strings to be the key and value of an additional
6521 attribute for each metric being sent out to I<Riemann>.
6525 =head1 THRESHOLD CONFIGURATION
6527 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
6528 we mean that the values are not only stored or sent somewhere, but that they
6529 are judged and, if a problem is recognized, acted upon. The only action
6530 collectd takes itself is to generate and dispatch a "notification". Plugins can
6531 register to receive notifications and perform appropriate further actions.
6533 Since systems and what you expect them to do differ a lot, you can configure
6534 B<thresholds> for your values freely. This gives you a lot of flexibility but
6535 also a lot of responsibility.
6537 Every time a value is out of range a notification is dispatched. This means
6538 that the idle percentage of your CPU needs to be less then the configured
6539 threshold only once for a notification to be generated. There's no such thing
6540 as a moving average or similar - at least not now.
6542 Also, all values that match a threshold are considered to be relevant or
6543 "interesting". As a consequence collectd will issue a notification if they are
6544 not received for B<Timeout> iterations. The B<Timeout> configuration option is
6545 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
6546 "2" (the default) and some hosts sends it's CPU statistics to the server every
6547 60 seconds, a notification will be dispatched after about 120 seconds. It may
6548 take a little longer because the timeout is checked only once each B<Interval>
6551 When a value comes within range again or is received after it was missing, an
6552 "OKAY-notification" is dispatched.
6554 Here is a configuration example to get you started. Read below for more
6567 <Plugin "interface">
6584 WarningMin 100000000
6590 There are basically two types of configuration statements: The C<Host>,
6591 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
6592 configured. The C<Plugin> and C<Type> blocks may be specified further using the
6593 C<Instance> option. You can combine the block by nesting the blocks, though
6594 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
6595 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
6596 C<Type> may not contain other blocks. If multiple blocks apply to the same
6597 value the most specific block is used.
6599 The other statements specify the threshold to configure. They B<must> be
6600 included in a C<Type> block. Currently the following statements are recognized:
6604 =item B<FailureMax> I<Value>
6606 =item B<WarningMax> I<Value>
6608 Sets the upper bound of acceptable values. If unset defaults to positive
6609 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
6610 will be created. If the value is greater than B<WarningMax> but less than (or
6611 equal to) B<FailureMax> a B<WARNING> notification will be created.
6613 =item B<FailureMin> I<Value>
6615 =item B<WarningMin> I<Value>
6617 Sets the lower bound of acceptable values. If unset defaults to negative
6618 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
6619 be created. If the value is less than B<WarningMin> but greater than (or equal
6620 to) B<FailureMin> a B<WARNING> notification will be created.
6622 =item B<DataSource> I<DSName>
6624 Some data sets have more than one "data source". Interesting examples are the
6625 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
6626 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
6627 system load data set, C<load>, even has three data sources: C<shortterm>,
6628 C<midterm>, and C<longterm>.
6630 Normally, all data sources are checked against a configured threshold. If this
6631 is undesirable, or if you want to specify different limits for each data
6632 source, you can use the B<DataSource> option to have a threshold apply only to
6635 =item B<Invert> B<true>|B<false>
6637 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
6638 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
6639 B<WarningMax>) are not okay. Defaults to B<false>.
6641 =item B<Persist> B<true>|B<false>
6643 Sets how often notifications are generated. If set to B<true> one notification
6644 will be generated for each value that is out of the acceptable range. If set to
6645 B<false> (the default) then a notification is only generated if a value is out
6646 of range but the previous value was okay.
6648 This applies to missing values, too: If set to B<true> a notification about a
6649 missing value is generated once every B<Interval> seconds. If set to B<false>
6650 only one such notification is generated until the value appears again.
6652 =item B<Percentage> B<true>|B<false>
6654 If set to B<true>, the minimum and maximum values given are interpreted as
6655 percentage value, relative to the other data sources. This is helpful for
6656 example for the "df" type, where you may want to issue a warning when less than
6657 5E<nbsp>% of the total space is available. Defaults to B<false>.
6659 =item B<Hits> I<Number>
6661 Delay creating the notification until the threshold has been passed I<Number>
6662 times. When a notification has been generated, or when a subsequent value is
6663 inside the threshold, the counter is reset. If, for example, a value is
6664 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
6665 will be dispatched at most once every 30E<nbsp>seconds.
6667 This is useful when short bursts are not a problem. If, for example, 100% CPU
6668 usage for up to a minute is normal (and data is collected every
6669 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
6671 =item B<Hysteresis> I<Number>
6673 When set to non-zero, a hysteresis value is applied when checking minimum and
6674 maximum bounds. This is useful for values that increase slowly and fluctuate a
6675 bit while doing so. When these values come close to the threshold, they may
6676 "flap", i.e. switch between failure / warning case and okay case repeatedly.
6678 If, for example, the threshold is configures as
6683 then a I<Warning> notification is created when the value exceeds I<101> and the
6684 corresponding I<Okay> notification is only created once the value falls below
6685 I<99>, thus avoiding the "flapping".
6689 =head1 FILTER CONFIGURATION
6691 Starting with collectd 4.6 there is a powerful filtering infrastructure
6692 implemented in the daemon. The concept has mostly been copied from
6693 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
6694 terminology, so that users that are familiar with iptables feel right at home.
6698 The following are the terms used in the remainder of the filter configuration
6699 documentation. For an ASCII-art schema of the mechanism, see
6700 L<"General structure"> below.
6706 A I<match> is a criteria to select specific values. Examples are, of course, the
6707 name of the value or it's current value.
6709 Matches are implemented in plugins which you have to load prior to using the
6710 match. The name of such plugins starts with the "match_" prefix.
6714 A I<target> is some action that is to be performed with data. Such actions
6715 could, for example, be to change part of the value's identifier or to ignore
6716 the value completely.
6718 Some of these targets are built into the daemon, see L<"Built-in targets">
6719 below. Other targets are implemented in plugins which you have to load prior to
6720 using the target. The name of such plugins starts with the "target_" prefix.
6724 The combination of any number of matches and at least one target is called a
6725 I<rule>. The target actions will be performed for all values for which B<all>
6726 matches apply. If the rule does not have any matches associated with it, the
6727 target action will be performed for all values.
6731 A I<chain> is a list of rules and possibly default targets. The rules are tried
6732 in order and if one matches, the associated target will be called. If a value
6733 is handled by a rule, it depends on the target whether or not any subsequent
6734 rules are considered or if traversal of the chain is aborted, see
6735 L<"Flow control"> below. After all rules have been checked, the default targets
6740 =head2 General structure
6742 The following shows the resulting structure:
6749 +---------+ +---------+ +---------+ +---------+
6750 ! Rule !->! Match !->! Match !->! Target !
6751 +---------+ +---------+ +---------+ +---------+
6754 +---------+ +---------+ +---------+
6755 ! Rule !->! Target !->! Target !
6756 +---------+ +---------+ +---------+
6763 +---------+ +---------+ +---------+
6764 ! Rule !->! Match !->! Target !
6765 +---------+ +---------+ +---------+
6775 There are four ways to control which way a value takes through the filter
6782 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
6783 process the value with another chain. When the called chain finishes, usually
6784 the next target or rule after the jump is executed.
6788 The stop condition, signaled for example by the built-in target B<stop>, causes
6789 all processing of the value to be stopped immediately.
6793 Causes processing in the current chain to be aborted, but processing of the
6794 value generally will continue. This means that if the chain was called via
6795 B<Jump>, the next target or rule after the jump will be executed. If the chain
6796 was not called by another chain, control will be returned to the daemon and it
6797 may pass the value to another chain.
6801 Most targets will signal the B<continue> condition, meaning that processing
6802 should continue normally. There is no special built-in target for this
6809 The configuration reflects this structure directly:
6811 PostCacheChain "PostCache"
6813 <Rule "ignore_mysql_show">
6816 Type "^mysql_command$"
6817 TypeInstance "^show_"
6827 The above configuration example will ignore all values where the plugin field
6828 is "mysql", the type is "mysql_command" and the type instance begins with
6829 "show_". All other values will be sent to the C<rrdtool> write plugin via the
6830 default target of the chain. Since this chain is run after the value has been
6831 added to the cache, the MySQL C<show_*> command statistics will be available
6832 via the C<unixsock> plugin.
6834 =head2 List of configuration options
6838 =item B<PreCacheChain> I<ChainName>
6840 =item B<PostCacheChain> I<ChainName>
6842 Configure the name of the "pre-cache chain" and the "post-cache chain". The
6843 argument is the name of a I<chain> that should be executed before and/or after
6844 the values have been added to the cache.
6846 To understand the implications, it's important you know what is going on inside
6847 I<collectd>. The following diagram shows how values are passed from the
6848 read-plugins to the write-plugins:
6854 + - - - - V - - - - +
6855 : +---------------+ :
6858 : +-------+-------+ :
6861 : +-------+-------+ : +---------------+
6862 : ! Cache !--->! Value Cache !
6863 : ! insert ! : +---+---+-------+
6864 : +-------+-------+ : ! !
6865 : ! ,------------' !
6867 : +-------+---+---+ : +-------+-------+
6868 : ! Post-Cache +--->! Write-Plugins !
6869 : ! Chain ! : +---------------+
6870 : +---------------+ :
6873 + - - - - - - - - - +
6875 After the values are passed from the "read" plugins to the dispatch functions,
6876 the pre-cache chain is run first. The values are added to the internal cache
6877 afterwards. The post-cache chain is run after the values have been added to the
6878 cache. So why is it such a huge deal if chains are run before or after the
6879 values have been added to this cache?
6881 Targets that change the identifier of a value list should be executed before
6882 the values are added to the cache, so that the name in the cache matches the
6883 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
6884 this cache to receive a list of all available values. If you change the
6885 identifier after the value list has been added to the cache, this may easily
6886 lead to confusion, but it's not forbidden of course.
6888 The cache is also used to convert counter values to rates. These rates are, for
6889 example, used by the C<value> match (see below). If you use the rate stored in
6890 the cache B<before> the new value is added, you will use the old, B<previous>
6891 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
6892 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
6895 Last but not last, the B<stop> target makes a difference: If the pre-cache
6896 chain returns the stop condition, the value will not be added to the cache and
6897 the post-cache chain will not be run.
6899 =item B<Chain> I<Name>
6901 Adds a new chain with a certain name. This name can be used to refer to a
6902 specific chain, for example to jump to it.
6904 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
6906 =item B<Rule> [I<Name>]
6908 Adds a new rule to the current chain. The name of the rule is optional and
6909 currently has no meaning for the daemon.
6911 Within the B<Rule> block, there may be any number of B<Match> blocks and there
6912 must be at least one B<Target> block.
6914 =item B<Match> I<Name>
6916 Adds a match to a B<Rule> block. The name specifies what kind of match should
6917 be performed. Available matches depend on the plugins that have been loaded.
6919 The arguments inside the B<Match> block are passed to the plugin implementing
6920 the match, so which arguments are valid here depends on the plugin being used.
6921 If you do not need any to pass any arguments to a match, you can use the
6926 Which is equivalent to:
6931 =item B<Target> I<Name>
6933 Add a target to a rule or a default target to a chain. The name specifies what
6934 kind of target is to be added. Which targets are available depends on the
6935 plugins being loaded.
6937 The arguments inside the B<Target> block are passed to the plugin implementing
6938 the target, so which arguments are valid here depends on the plugin being used.
6939 If you do not need any to pass any arguments to a target, you can use the
6944 This is the same as writing:
6951 =head2 Built-in targets
6953 The following targets are built into the core daemon and therefore need no
6954 plugins to be loaded:
6960 Signals the "return" condition, see the L<"Flow control"> section above. This
6961 causes the current chain to stop processing the value and returns control to
6962 the calling chain. The calling chain will continue processing targets and rules
6963 just after the B<jump> target (see below). This is very similar to the
6964 B<RETURN> target of iptables, see L<iptables(8)>.
6966 This target does not have any options.
6974 Signals the "stop" condition, see the L<"Flow control"> section above. This
6975 causes processing of the value to be aborted immediately. This is similar to
6976 the B<DROP> target of iptables, see L<iptables(8)>.
6978 This target does not have any options.
6986 Sends the value to "write" plugins.
6992 =item B<Plugin> I<Name>
6994 Name of the write plugin to which the data should be sent. This option may be
6995 given multiple times to send the data to more than one write plugin.
6999 If no plugin is explicitly specified, the values will be sent to all available
7010 Starts processing the rules of another chain, see L<"Flow control"> above. If
7011 the end of that chain is reached, or a stop condition is encountered,
7012 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
7013 next target or the next rule. This is similar to the B<-j> command line option
7014 of iptables, see L<iptables(8)>.
7020 =item B<Chain> I<Name>
7022 Jumps to the chain I<Name>. This argument is required and may appear only once.
7034 =head2 Available matches
7040 Matches a value using regular expressions.
7046 =item B<Host> I<Regex>
7048 =item B<Plugin> I<Regex>
7050 =item B<PluginInstance> I<Regex>
7052 =item B<Type> I<Regex>
7054 =item B<TypeInstance> I<Regex>
7056 Match values where the given regular expressions match the various fields of
7057 the identifier of a value. If multiple regular expressions are given, B<all>
7058 regexen must match for a value to match.
7060 =item B<Invert> B<false>|B<true>
7062 When set to B<true>, the result of the match is inverted, i.e. all value lists
7063 where all regular expressions apply are not matched, all other value lists are
7064 matched. Defaults to B<false>.
7071 Host "customer[0-9]+"
7077 Matches values that have a time which differs from the time on the server.
7079 This match is mainly intended for servers that receive values over the
7080 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
7081 is very sensitive to the timestamp used when updating the RRD files. In
7082 particular, the time must be ever increasing. If a misbehaving client sends one
7083 packet with a timestamp far in the future, all further packets with a correct
7084 time will be ignored because of that one packet. What's worse, such corrupted
7085 RRD files are hard to fix.
7087 This match lets one match all values B<outside> a specified time range
7088 (relative to the server's time), so you can use the B<stop> target (see below)
7089 to ignore the value, for example.
7095 =item B<Future> I<Seconds>
7097 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
7098 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7101 =item B<Past> I<Seconds>
7103 Matches all values that are I<behind> of the server's time by I<Seconds> or
7104 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7116 This example matches all values that are five minutes or more ahead of the
7117 server or one hour (or more) lagging behind.
7121 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
7122 values. If a data-set consists of more than one data-source, all data-sources
7123 must match the specified ranges for a positive match.
7129 =item B<Min> I<Value>
7131 Sets the smallest value which still results in a match. If unset, behaves like
7134 =item B<Max> I<Value>
7136 Sets the largest value which still results in a match. If unset, behaves like
7139 =item B<Invert> B<true>|B<false>
7141 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
7142 no-match is returned and vice versa. Please note that the B<Invert> setting
7143 only effects how B<Min> and B<Max> are applied to a specific value. Especially
7144 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
7146 =item B<DataSource> I<DSName> [I<DSName> ...]
7148 Select one or more of the data sources. If no data source is configured, all
7149 data sources will be checked. If the type handled by the match does not have a
7150 data source of the specified name(s), this will always result in no match
7151 (independent of the B<Invert> setting).
7153 =item B<Satisfy> B<Any>|B<All>
7155 Specifies how checking with several data sources is performed. If set to
7156 B<Any>, the match succeeds if one of the data sources is in the configured
7157 range. If set to B<All> the match only succeeds if all data sources are within
7158 the configured range. Default is B<All>.
7160 Usually B<All> is used for positive matches, B<Any> is used for negative
7161 matches. This means that with B<All> you usually check that all values are in a
7162 "good" range, while with B<Any> you check if any value is within a "bad" range
7163 (or outside the "good" range).
7167 Either B<Min> or B<Max>, but not both, may be unset.
7171 # Match all values smaller than or equal to 100. Matches only if all data
7172 # sources are below 100.
7178 # Match if the value of any data source is outside the range of 0 - 100.
7186 =item B<empty_counter>
7188 Matches all values with one or more data sources of type B<COUNTER> and where
7189 all counter values are zero. These counters usually I<never> increased since
7190 they started existing (and are therefore uninteresting), or got reset recently
7191 or overflowed and you had really, I<really> bad luck.
7193 Please keep in mind that ignoring such counters can result in confusing
7194 behavior: Counters which hardly ever increase will be zero for long periods of
7195 time. If the counter is reset for some reason (machine or service restarted,
7196 usually), the graph will be empty (NAN) for a long time. People may not
7201 Calculates a hash value of the host name and matches values according to that
7202 hash value. This makes it possible to divide all hosts into groups and match
7203 only values that are in a specific group. The intended use is in load
7204 balancing, where you want to handle only part of all data and leave the rest
7207 The hashing function used tries to distribute the hosts evenly. First, it
7208 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
7211 for (i = 0; host[i] != 0; i++)
7212 hash_value = (hash_value * 251) + host[i];
7214 The constant 251 is a prime number which is supposed to make this hash value
7215 more random. The code then checks the group for this host according to the
7216 I<Total> and I<Match> arguments:
7218 if ((hash_value % Total) == Match)
7223 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
7224 groups), then the least significant bit of the hash value will be the XOR of
7225 all least significant bits in the host name. One consequence is that when you
7226 have two hosts, "server0.example.com" and "server1.example.com", where the host
7227 name differs in one digit only and the digits differ by one, those hosts will
7228 never end up in the same group.
7234 =item B<Match> I<Match> I<Total>
7236 Divide the data into I<Total> groups and match all hosts in group I<Match> as
7237 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
7238 be smaller than I<Total>. I<Total> must be at least one, although only values
7239 greater than one really do make any sense.
7241 You can repeat this option to match multiple groups, for example:
7246 The above config will divide the data into seven groups and match groups three
7247 and five. One use would be to keep every value on two hosts so that if one
7248 fails the missing data can later be reconstructed from the second host.
7254 # Operate on the pre-cache chain, so that ignored values are not even in the
7259 # Divide all received hosts in seven groups and accept all hosts in
7263 # If matched: Return and continue.
7266 # If not matched: Return and stop.
7272 =head2 Available targets
7276 =item B<notification>
7278 Creates and dispatches a notification.
7284 =item B<Message> I<String>
7286 This required option sets the message of the notification. The following
7287 placeholders will be replaced by an appropriate value:
7295 =item B<%{plugin_instance}>
7299 =item B<%{type_instance}>
7301 These placeholders are replaced by the identifier field of the same name.
7303 =item B<%{ds:>I<name>B<}>
7305 These placeholders are replaced by a (hopefully) human readable representation
7306 of the current rate of this data source. If you changed the instance name
7307 (using the B<set> or B<replace> targets, see below), it may not be possible to
7308 convert counter values to rates.
7312 Please note that these placeholders are B<case sensitive>!
7314 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
7316 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
7323 <Target "notification">
7324 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
7330 Replaces parts of the identifier using regular expressions.
7336 =item B<Host> I<Regex> I<Replacement>
7338 =item B<Plugin> I<Regex> I<Replacement>
7340 =item B<PluginInstance> I<Regex> I<Replacement>
7342 =item B<TypeInstance> I<Regex> I<Replacement>
7344 Match the appropriate field with the given regular expression I<Regex>. If the
7345 regular expression matches, that part that matches is replaced with
7346 I<Replacement>. If multiple places of the input buffer match a given regular
7347 expression, only the first occurrence will be replaced.
7349 You can specify each option multiple times to use multiple regular expressions
7357 # Replace "example.net" with "example.com"
7358 Host "\\<example.net\\>" "example.com"
7360 # Strip "www." from hostnames
7366 Sets part of the identifier of a value to a given string.
7372 =item B<Host> I<String>
7374 =item B<Plugin> I<String>
7376 =item B<PluginInstance> I<String>
7378 =item B<TypeInstance> I<String>
7380 Set the appropriate field to the given string. The strings for plugin instance
7381 and type instance may be empty, the strings for host and plugin may not be
7382 empty. It's currently not possible to set the type of a value this way.
7389 PluginInstance "coretemp"
7390 TypeInstance "core3"
7395 =head2 Backwards compatibility
7397 If you use collectd with an old configuration, i.E<nbsp>e. one without a
7398 B<Chain> block, it will behave as it used to. This is equivalent to the
7399 following configuration:
7405 If you specify a B<PostCacheChain>, the B<write> target will not be added
7406 anywhere and you will have to make sure that it is called where appropriate. We
7407 suggest to add the above snippet as default target to your "PostCache" chain.
7411 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
7427 L<collectd-exec(5)>,
7428 L<collectd-perl(5)>,
7429 L<collectd-unixsock(5)>,
7442 Florian Forster E<lt>octo@verplant.orgE<gt>