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"
510 # QueueAutoDelete true
511 # RoutingKey "collectd.#"
515 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
516 blocks, which configure sending and receiving of values respectively. The two
517 blocks are very similar, so unless otherwise noted, an option can be used in
518 either block. The name given in the blocks starting tag is only used for
519 reporting messages, but may be used to support I<flushing> of certain
520 I<Publish> blocks in the future.
524 =item B<Host> I<Host>
526 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
527 the underlying communications library, I<rabbitmq-c>, which is "localhost".
529 =item B<Port> I<Port>
531 Service name or port number on which the AMQP broker accepts connections. This
532 argument must be a string, even if the numeric form is used. Defaults to
535 =item B<VHost> I<VHost>
537 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
539 =item B<User> I<User>
541 =item B<Password> I<Password>
543 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
546 =item B<Exchange> I<Exchange>
548 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
549 By default, "amq.fanout" will be used.
551 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
552 the given exchange and the I<queue> is created, using the I<routing key> if
553 configured. See the B<Queue> and B<RoutingKey> options below.
555 =item B<ExchangeType> I<Type>
557 If given, the plugin will try to create the configured I<exchange> with this
558 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
559 be bound to this exchange.
561 =item B<Queue> I<Queue> (Subscribe only)
563 Configures the I<queue> name to subscribe to. If no queue name was configured
564 explicitly, a unique queue name will be created by the broker.
566 =item B<QueueDurable> B<true>|B<false> (Subscribe only)
568 Defines if the I<queue> subscribed to is durable (saved to persistent storage)
569 or transient (will disappear if the AMQP broker is restarted). Defaults to
572 This option should be used in conjunction with the I<Persistent> option on the
575 =item B<QueueAutoDelete> B<true>|B<false> (Subscribe only)
577 Defines if the I<queue> subscribed to will be deleted once the last consumer
578 unsubscribes. Defaults to "true".
580 =item B<RoutingKey> I<Key>
582 In I<Publish> blocks, this configures the routing key to set on all outgoing
583 messages. If not given, the routing key will be computed from the I<identifier>
584 of the value. The host, plugin, type and the two instances are concatenated
585 together using dots as the separator and all containing dots replaced with
586 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
587 possible to receive only specific values using a "topic" exchange.
589 In I<Subscribe> blocks, configures the I<routing key> used when creating a
590 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
591 used to filter messages when using a "topic" exchange. If you're only
592 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
595 =item B<Persistent> B<true>|B<false> (Publish only)
597 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
598 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
599 default), the I<transient> delivery mode will be used, i.e. messages may be
600 lost due to high load, overflowing queues or similar issues.
602 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
604 Selects the format in which messages are sent to the broker. If set to
605 B<Command> (the default), values are sent as C<PUTVAL> commands which are
606 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
607 case, the C<Content-Type> header field will be set to C<text/collectd>.
609 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
610 an easy and straight forward exchange format. The C<Content-Type> header field
611 will be set to C<application/json>.
613 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
614 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
617 A subscribing client I<should> use the C<Content-Type> header field to
618 determine how to decode the values. Currently, the I<AMQP plugin> itself can
619 only decode the B<Command> format.
621 =item B<StoreRates> B<true>|B<false> (Publish only)
623 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
624 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
625 default), no conversion is performed. Otherwise the conversion is performed
626 using the internal value cache.
628 Please note that currently this option is only used if the B<Format> option has
631 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
633 A prefix can be added in the metric name when outputting in the I<Graphite> format.
634 It's added before the I<Host> name.
635 Metric name will be "<prefix><host><postfix><plugin><type><name>"
637 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
639 A postfix can be added in the metric name when outputting in the I<Graphite> format.
640 It's added after the I<Host> name.
641 Metric name will be "<prefix><host><postfix><plugin><type><name>"
643 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
645 Specify a character to replace dots (.) in the host part of the metric name.
646 In I<Graphite> metric name, dots are used as separators between different
647 metric parts (host, plugin, type).
648 Default is "_" (I<Underscore>).
652 =head2 Plugin C<apache>
654 To configure the C<apache>-plugin you first need to configure the Apache
655 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
656 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
657 the following snipped to base your Apache config upon:
660 <IfModule mod_status.c>
661 <Location /mod_status>
662 SetHandler server-status
666 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
667 also supported. It introduces a new field, called C<BusyServers>, to count the
668 number of currently connected clients. This field is also supported.
670 The configuration of the I<Apache> plugin consists of one or more
671 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
672 as the instance name. For example:
676 URL "http://www1.example.com/mod_status?auto"
679 URL "http://www2.example.com/mod_status?auto"
683 The instance name will be used as the I<plugin instance>. To emulate the old
684 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
685 plugin to work correctly, each instance name must be unique. This is not
686 enforced by the plugin and it is your responsibility to ensure it.
688 The following options are accepted within each I<Instance> block:
692 =item B<URL> I<http://host/mod_status?auto>
694 Sets the URL of the C<mod_status> output. This needs to be the output generated
695 by C<ExtendedStatus on> and it needs to be the machine readable output
696 generated by appending the C<?auto> argument. This option is I<mandatory>.
698 =item B<User> I<Username>
700 Optional user name needed for authentication.
702 =item B<Password> I<Password>
704 Optional password needed for authentication.
706 =item B<VerifyPeer> B<true|false>
708 Enable or disable peer SSL certificate verification. See
709 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
711 =item B<VerifyHost> B<true|false>
713 Enable or disable peer host name verification. If enabled, the plugin checks
714 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
715 certificate matches the host name provided by the B<URL> option. If this
716 identity check fails, the connection is aborted. Obviously, only works when
717 connecting to a SSL enabled server. Enabled by default.
719 =item B<CACert> I<File>
721 File that holds one or more SSL certificates. If you want to use HTTPS you will
722 possibly need this option. What CA certificates come bundled with C<libcurl>
723 and are checked by default depends on the distribution you use.
727 =head2 Plugin C<apcups>
731 =item B<Host> I<Hostname>
733 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
734 that IPv6 support has been disabled unless someone can confirm or decline that
735 B<apcupsd> can handle it.
737 =item B<Port> I<Port>
739 TCP-Port to connect to. Defaults to B<3551>.
741 =item B<ReportSeconds> B<true|false>
743 If set to B<true>, the time reported in the C<timeleft> metric will be
744 converted to seconds. This is the recommended setting. If set to B<false>, the
745 default for backwards compatibility, the time will be reported in minutes.
749 =head2 Plugin C<aquaero>
751 This plugin collects the value of the available sensors in an
752 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
753 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
754 connection for monitoring and configuration. The board can handle multiple
755 temperature sensors, fans, water pumps and water level sensors and adjust the
756 output settings such as fan voltage or power used by the water pump based on
757 the available inputs using a configurable controller included in the board.
758 This plugin collects all the available inputs as well as some of the output
759 values chosen by this controller. The plugin is based on the I<libaquaero5>
760 library provided by I<aquatools-ng>.
764 =item B<Device> I<DevicePath>
766 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
767 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
768 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
772 =head2 Plugin C<ascent>
774 This plugin collects information about an Ascent server, a free server for the
775 "World of Warcraft" game. This plugin gathers the information by fetching the
776 XML status page using C<libcurl> and parses it using C<libxml2>.
778 The configuration options are the same as for the C<apache> plugin above:
782 =item B<URL> I<http://localhost/ascent/status/>
784 Sets the URL of the XML status output.
786 =item B<User> I<Username>
788 Optional user name needed for authentication.
790 =item B<Password> I<Password>
792 Optional password needed for authentication.
794 =item B<VerifyPeer> B<true|false>
796 Enable or disable peer SSL certificate verification. See
797 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
799 =item B<VerifyHost> B<true|false>
801 Enable or disable peer host name verification. If enabled, the plugin checks
802 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
803 certificate matches the host name provided by the B<URL> option. If this
804 identity check fails, the connection is aborted. Obviously, only works when
805 connecting to a SSL enabled server. Enabled by default.
807 =item B<CACert> I<File>
809 File that holds one or more SSL certificates. If you want to use HTTPS you will
810 possibly need this option. What CA certificates come bundled with C<libcurl>
811 and are checked by default depends on the distribution you use.
815 =head2 Plugin C<bind>
817 Starting with BIND 9.5.0, the most widely used DNS server software provides
818 extensive statistics about queries, responses and lots of other information.
819 The bind plugin retrieves this information that's encoded in XML and provided
820 via HTTP and submits the values to collectd.
822 To use this plugin, you first need to tell BIND to make this information
823 available. This is done with the C<statistics-channels> configuration option:
825 statistics-channels {
826 inet localhost port 8053;
829 The configuration follows the grouping that can be seen when looking at the
830 data with an XSLT compatible viewer, such as a modern web browser. It's
831 probably a good idea to make yourself familiar with the provided values, so you
832 can understand what the collected statistics actually mean.
837 URL "http://localhost:8053/"
852 Zone "127.in-addr.arpa/IN"
856 The bind plugin accepts the following configuration options:
862 URL from which to retrieve the XML data. If not specified,
863 C<http://localhost:8053/> will be used.
865 =item B<ParseTime> B<true>|B<false>
867 When set to B<true>, the time provided by BIND will be parsed and used to
868 dispatch the values. When set to B<false>, the local time source is queried.
870 This setting is set to B<true> by default for backwards compatibility; setting
871 this to B<false> is I<recommended> to avoid problems with timezones and
874 =item B<OpCodes> B<true>|B<false>
876 When enabled, statistics about the I<"OpCodes">, for example the number of
877 C<QUERY> packets, are collected.
881 =item B<QTypes> B<true>|B<false>
883 When enabled, the number of I<incoming> queries by query types (for example
884 C<A>, C<MX>, C<AAAA>) is collected.
888 =item B<ServerStats> B<true>|B<false>
890 Collect global server statistics, such as requests received over IPv4 and IPv6,
891 successful queries, and failed updates.
895 =item B<ZoneMaintStats> B<true>|B<false>
897 Collect zone maintenance statistics, mostly information about notifications
898 (zone updates) and zone transfers.
902 =item B<ResolverStats> B<true>|B<false>
904 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
905 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
906 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
907 default. Use the B<ResolverStats> option within a B<View "_default"> block
908 instead for the same functionality.
914 Collect global memory statistics.
918 =item B<View> I<Name>
920 Collect statistics about a specific I<"view">. BIND can behave different,
921 mostly depending on the source IP-address of the request. These different
922 configurations are called "views". If you don't use this feature, you most
923 likely are only interested in the C<_default> view.
925 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
926 information you want to collect about a view. If no B<View> block is
927 configured, no detailed view statistics will be collected.
931 =item B<QTypes> B<true>|B<false>
933 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
938 =item B<ResolverStats> B<true>|B<false>
940 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
941 (e.E<nbsp>g. queries over IPv4, lame servers).
945 =item B<CacheRRSets> B<true>|B<false>
947 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
948 type is collected. Negative entries (queries which resulted in an error, for
949 example names that do not exist) are reported with a leading exclamation mark,
954 =item B<Zone> I<Name>
956 When given, collect detailed information about the given zone in the view. The
957 information collected if very similar to the global B<ServerStats> information
960 You can repeat this option to collect detailed information about multiple
963 By default no detailed zone information is collected.
969 =head2 Plugin C<cgroups>
971 This plugin collects the CPU user/system time for each I<cgroup> by reading the
972 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
973 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
977 =item B<CGroup> I<Directory>
979 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
980 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
983 =item B<IgnoreSelected> B<true>|B<false>
985 Invert the selection: If set to true, all cgroups I<except> the ones that
986 match any one of the criteria are collected. By default only selected
987 cgroups are collected if a selection is made. If no selection is configured
988 at all, B<all> cgroups are selected.
994 The I<CPU plugin> collects CPU usage metrics.
996 The following configuration options are available:
1000 =item B<ReportActive> B<false>|B<true>
1002 Reports non-idle CPU usage as the "active" value. Defaults to false.
1004 =item B<ReportByCpu> B<false>|B<true>
1006 When true reports usage for all cores. When false, reports cpu usage
1007 aggregated over all cores. Implies ValuesPercentage when false.
1010 =item B<ValuesPercentage> B<false>|B<true>
1012 When true report percentage usage instead of tick values. Defaults to false.
1017 =head2 Plugin C<cpufreq>
1019 This plugin doesn't have any options. It reads
1020 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1021 installed) to get the current CPU frequency. If this file does not exist make
1022 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1023 installed and an "cpu governor" (that's a kernel module) is loaded.
1025 =head2 Plugin C<csv>
1029 =item B<DataDir> I<Directory>
1031 Set the directory to store CSV-files under. Per default CSV-files are generated
1032 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1033 The special strings B<stdout> and B<stderr> can be used to write to the standard
1034 output and standard error channels, respectively. This, of course, only makes
1035 much sense when collectd is running in foreground- or non-daemon-mode.
1037 =item B<StoreRates> B<true|false>
1039 If set to B<true>, convert counter values to rates. If set to B<false> (the
1040 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1045 =head2 Plugin C<curl>
1047 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1048 and the match infrastructure (the same code used by the tail plugin) to use
1049 regular expressions with the received data.
1051 The following example will read the current value of AMD stock from Google's
1052 finance page and dispatch the value to collectd.
1055 <Page "stock_quotes">
1056 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1060 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1061 DSType "GaugeAverage"
1062 # Note: `stock_value' is not a standard type.
1069 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1070 a web page and one or more "matches" to be performed on the returned data. The
1071 string argument to the B<Page> block is used as plugin instance.
1073 The following options are valid within B<Page> blocks:
1079 URL of the web site to retrieve. Since a regular expression will be used to
1080 extract information from this data, non-binary data is a big plus here ;)
1082 =item B<User> I<Name>
1084 Username to use if authorization is required to read the page.
1086 =item B<Password> I<Password>
1088 Password to use if authorization is required to read the page.
1090 =item B<Digest> B<true>|B<false>
1092 Enable HTTP digest authentication.
1094 =item B<VerifyPeer> B<true>|B<false>
1096 Enable or disable peer SSL certificate verification. See
1097 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1099 =item B<VerifyHost> B<true>|B<false>
1101 Enable or disable peer host name verification. If enabled, the plugin checks if
1102 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1103 matches the host name provided by the B<URL> option. If this identity check
1104 fails, the connection is aborted. Obviously, only works when connecting to a
1105 SSL enabled server. Enabled by default.
1107 =item B<CACert> I<file>
1109 File that holds one or more SSL certificates. If you want to use HTTPS you will
1110 possibly need this option. What CA certificates come bundled with C<libcurl>
1111 and are checked by default depends on the distribution you use.
1113 =item B<Header> I<Header>
1115 A HTTP header to add to the request. Multiple headers are added if this option
1116 is specified more than once.
1118 =item B<Post> I<Body>
1120 Specifies that the HTTP operation should be a POST instead of a GET. The
1121 complete data to be posted is given as the argument. This option will usually
1122 need to be accompanied by a B<Header> option to set an appropriate
1123 C<Content-Type> for the post body (e.g. to
1124 C<application/x-www-form-urlencoded>).
1126 =item B<MeasureResponseTime> B<true>|B<false>
1128 Measure response time for the request. If this setting is enabled, B<Match>
1129 blocks (see below) are optional. Disabled by default.
1131 =item B<E<lt>MatchE<gt>>
1133 One or more B<Match> blocks that define how to match information in the data
1134 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1135 used by the C<tail> plugin, so please see the documentation of the C<tail>
1136 plugin below on how matches are defined. If the B<MeasureResponseTime> option
1137 is set to B<true>, B<Match> blocks are optional.
1141 =head2 Plugin C<curl_json>
1143 The B<curl_json plugin> collects values from JSON data to be parsed by
1144 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) retrieved via
1145 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1146 unix socket. The former can be used, for example, to collect values
1147 from CouchDB documents (which are stored JSON notation), and the
1148 latter to collect values from a uWSGI stats socket.
1150 The following example will collect several values from the built-in
1151 C<_stats> runtime statistics module of I<CouchDB>
1152 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1155 <URL "http://localhost:5984/_stats">
1157 <Key "httpd/requests/count">
1158 Type "http_requests"
1161 <Key "httpd_request_methods/*/count">
1162 Type "http_request_methods"
1165 <Key "httpd_status_codes/*/count">
1166 Type "http_response_codes"
1171 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1174 <Sock "/var/run/uwsgi.stats.sock">
1176 <Key "workers/*/requests">
1177 Type "http_requests"
1180 <Key "workers/*/apps/*/requests">
1181 Type "http_requests"
1186 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1187 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1188 blocks defining a unix socket to read JSON from directly. Each of
1189 these blocks may have one or more B<Key> blocks.
1191 The B<Key> string argument must be in a path format. Each component is
1192 used to match the key from a JSON map or the index of an JSON
1193 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1194 values for all map keys or array indices will be collectd.
1196 The following options are valid within B<URL> blocks:
1200 =item B<Instance> I<Instance>
1202 Sets the plugin instance to I<Instance>.
1204 =item B<User> I<Name>
1206 =item B<Password> I<Password>
1208 =item B<Digest> B<true>|B<false>
1210 =item B<VerifyPeer> B<true>|B<false>
1212 =item B<VerifyHost> B<true>|B<false>
1214 =item B<CACert> I<file>
1216 =item B<Header> I<Header>
1218 =item B<Post> I<Body>
1220 These options behave exactly equivalent to the appropriate options of the
1221 I<cURL> plugin. Please see there for a detailed description.
1225 The following options are valid within B<Key> blocks:
1229 =item B<Type> I<Type>
1231 Sets the type used to dispatch the values to the daemon. Detailed information
1232 about types and their configuration can be found in L<types.db(5)>. This
1233 option is mandatory.
1235 =item B<Instance> I<Instance>
1237 Type-instance to use. Defaults to the current map key or current string array element value.
1241 =head2 Plugin C<curl_xml>
1243 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1244 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1247 <URL "http://localhost/stats.xml">
1249 Instance "some_instance"
1254 CACert "/path/to/ca.crt"
1256 <XPath "table[@id=\"magic_level\"]/tr">
1258 #InstancePrefix "prefix-"
1259 InstanceFrom "td[1]"
1260 ValuesFrom "td[2]/span[@class=\"level\"]"
1265 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1266 URL to be fetched using libcurl. Within each B<URL> block there are
1267 options which specify the connection parameters, for example authentication
1268 information, and one or more B<XPath> blocks.
1270 Each B<XPath> block specifies how to get one type of information. The
1271 string argument must be a valid XPath expression which returns a list
1272 of "base elements". One value is dispatched for each "base element". The
1273 I<type instance> and values are looked up using further I<XPath> expressions
1274 that should be relative to the base element.
1276 Within the B<URL> block the following options are accepted:
1280 =item B<Host> I<Name>
1282 Use I<Name> as the host name when submitting values. Defaults to the global
1285 =item B<Instance> I<Instance>
1287 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1288 empty string (no plugin instance).
1290 =item B<Namespace> I<Prefix> I<URL>
1292 If an XPath expression references namespaces, they must be specified
1293 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1294 I<URL> is the "namespace name", an URI reference uniquely identifying the
1295 namespace. The option can be repeated to register multiple namespaces.
1299 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1300 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1302 =item B<User> I<User>
1304 =item B<Password> I<Password>
1306 =item B<Digest> B<true>|B<false>
1308 =item B<VerifyPeer> B<true>|B<false>
1310 =item B<VerifyHost> B<true>|B<false>
1312 =item B<CACert> I<CA Cert File>
1314 =item B<Header> I<Header>
1316 =item B<Post> I<Body>
1318 These options behave exactly equivalent to the appropriate options of the
1319 I<cURL plugin>. Please see there for a detailed description.
1321 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1323 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1324 B<XPath> block specifies how to get one type of information. The string
1325 argument must be a valid XPath expression which returns a list of "base
1326 elements". One value is dispatched for each "base element".
1328 Within the B<XPath> block the following options are accepted:
1332 =item B<Type> I<Type>
1334 Specifies the I<Type> used for submitting patches. This determines the number
1335 of values that are required / expected and whether the strings are parsed as
1336 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1337 This option is required.
1339 =item B<InstancePrefix> I<InstancePrefix>
1341 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1342 concatenated together without any separator.
1343 This option is optional.
1345 =item B<InstanceFrom> I<InstanceFrom>
1347 Specifies a XPath expression to use for determining the I<type instance>. The
1348 XPath expression must return exactly one element. The element's value is then
1349 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1351 This value is required. As a special exception, if the "base XPath expression"
1352 (the argument to the B<XPath> block) returns exactly one argument, then this
1353 option may be omitted.
1355 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1357 Specifies one or more XPath expression to use for reading the values. The
1358 number of XPath expressions must match the number of data sources in the
1359 I<type> specified with B<Type> (see above). Each XPath expression must return
1360 exactly one element. The element's value is then parsed as a number and used as
1361 value for the appropriate value in the value list dispatched to the daemon.
1367 =head2 Plugin C<dbi>
1369 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1370 connect to various databases, execute I<SQL> statements and read back the
1371 results. I<dbi> is an acronym for "database interface" in case you were
1372 wondering about the name. You can configure how each column is to be
1373 interpreted and the plugin will generate one or more data sets from each row
1374 returned according to these rules.
1376 Because the plugin is very generic, the configuration is a little more complex
1377 than those of other plugins. It usually looks something like this:
1380 <Query "out_of_stock">
1381 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1382 # Use with MySQL 5.0.0 or later
1386 InstancePrefix "out_of_stock"
1387 InstancesFrom "category"
1391 <Database "product_information">
1393 DriverOption "host" "localhost"
1394 DriverOption "username" "collectd"
1395 DriverOption "password" "aZo6daiw"
1396 DriverOption "dbname" "prod_info"
1397 SelectDB "prod_info"
1398 Query "out_of_stock"
1402 The configuration above defines one query with one result and one database. The
1403 query is then linked to the database with the B<Query> option I<within> the
1404 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1405 and you can also use the B<Include> statement to split up the configuration
1406 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1407 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1410 The following is a complete list of options:
1412 =head3 B<Query> blocks
1414 Query blocks define I<SQL> statements and how the returned data should be
1415 interpreted. They are identified by the name that is given in the opening line
1416 of the block. Thus the name needs to be unique. Other than that, the name is
1417 not used in collectd.
1419 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1420 define which column holds which value or instance information. You can use
1421 multiple B<Result> blocks to create multiple values from one returned row. This
1422 is especially useful, when queries take a long time and sending almost the same
1423 query again and again is not desirable.
1427 <Query "environment">
1428 Statement "select station, temperature, humidity from environment"
1431 # InstancePrefix "foo"
1432 InstancesFrom "station"
1433 ValuesFrom "temperature"
1437 InstancesFrom "station"
1438 ValuesFrom "humidity"
1442 The following options are accepted:
1446 =item B<Statement> I<SQL>
1448 Sets the statement that should be executed on the server. This is B<not>
1449 interpreted by collectd, but simply passed to the database server. Therefore,
1450 the SQL dialect that's used depends on the server collectd is connected to.
1452 The query has to return at least two columns, one for the instance and one
1453 value. You cannot omit the instance, even if the statement is guaranteed to
1454 always return exactly one line. In that case, you can usually specify something
1457 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1459 (That works with MySQL but may not be valid SQL according to the spec. If you
1460 use a more strict database server, you may have to select from a dummy table or
1463 Please note that some databases, for example B<Oracle>, will fail if you
1464 include a semicolon at the end of the statement.
1466 =item B<MinVersion> I<Version>
1468 =item B<MaxVersion> I<Value>
1470 Only use this query for the specified database version. You can use these
1471 options to provide multiple queries with the same name but with a slightly
1472 different syntax. The plugin will use only those queries, where the specified
1473 minimum and maximum versions fit the version of the database in use.
1475 The database version is determined by C<dbi_conn_get_engine_version>, see the
1476 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1477 for details. Basically, each part of the version is assumed to be in the range
1478 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1479 "40102", version "5.0.42" becomes "50042".
1481 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1482 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1483 happen. Don't to it! A valid example would be something along these lines:
1494 In the above example, there are three ranges that don't overlap. The last one
1495 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1496 before "4.0.0" are not specified.
1498 =item B<Type> I<Type>
1500 The B<type> that's used for each line returned. See L<types.db(5)> for more
1501 details on how types are defined. In short: A type is a predefined layout of
1502 data and the number of values and type of values has to match the type
1505 If you specify "temperature" here, you need exactly one gauge column. If you
1506 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1509 There must be exactly one B<Type> option inside each B<Result> block.
1511 =item B<InstancePrefix> I<prefix>
1513 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1514 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1515 all strings returned in the appropriate columns are concatenated together,
1516 separated by dashes I<("-")>.
1518 =item B<InstancesFrom> I<column0> [I<column1> ...]
1520 Specifies the columns whose values will be used to create the "type-instance"
1521 for each row. If you specify more than one column, the value of all columns
1522 will be joined together with dashes I<("-")> as separation characters.
1524 The plugin itself does not check whether or not all built instances are
1525 different. It's your responsibility to assure that each is unique. This is
1526 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1527 sure that only one row is returned in this case.
1529 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1532 =item B<ValuesFrom> I<column0> [I<column1> ...]
1534 Names the columns whose content is used as the actual data for the data sets
1535 that are dispatched to the daemon. How many such columns you need is determined
1536 by the B<Type> setting above. If you specify too many or not enough columns,
1537 the plugin will complain about that and no data will be submitted to the
1540 The actual data type in the columns is not that important. The plugin will
1541 automatically cast the values to the right type if it know how to do that. So
1542 it should be able to handle integer an floating point types, as well as strings
1543 (if they include a number at the beginning).
1545 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1549 =head3 B<Database> blocks
1551 Database blocks define a connection to a database and which queries should be
1552 sent to that database. Since the used "dbi" library can handle a wide variety
1553 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1554 documentationE<nbsp>- we stick as close to the terminology used there.
1556 Each database needs a "name" as string argument in the starting tag of the
1557 block. This name will be used as "PluginInstance" in the values submitted to
1558 the daemon. Other than that, that name is not used.
1562 =item B<Driver> I<Driver>
1564 Specifies the driver to use to connect to the database. In many cases those
1565 drivers are named after the database they can connect to, but this is not a
1566 technical necessity. These drivers are sometimes referred to as "DBD",
1567 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1568 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1569 project at L<http://libdbi-drivers.sourceforge.net/>.
1571 You need to give the driver name as expected by the "dbi" library here. You
1572 should be able to find that in the documentation for each driver. If you
1573 mistype the driver name, the plugin will dump a list of all known driver names
1576 =item B<DriverOption> I<Key> I<Value>
1578 Sets driver-specific options. What option a driver supports can be found in the
1579 documentation for each driver, somewhere at
1580 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1581 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1583 DBDs can register two types of options: String options and numeric options. The
1584 plugin will use the C<dbi_conn_set_option> function when the configuration
1585 provides a string and the C<dbi_conn_require_option_numeric> function when the
1586 configuration provides a number. So these two lines will actually result in
1587 different calls being used:
1589 DriverOption "Port" 1234 # numeric
1590 DriverOption "Port" "1234" # string
1592 Unfortunately, drivers are not too keen to report errors when an unknown option
1593 is passed to them, so invalid settings here may go unnoticed. This is not the
1594 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1595 the driver. If a driver complains about an option, the plugin will dump a
1596 complete list of all options understood by that driver to the log. There is no
1597 way to programatically find out if an option expects a string or a numeric
1598 argument, so you will have to refer to the appropriate DBD's documentation to
1599 find this out. Sorry.
1601 =item B<SelectDB> I<Database>
1603 In some cases, the database name you connect with is not the database name you
1604 want to use for querying data. If this option is set, the plugin will "select"
1605 (switch to) that database after the connection is established.
1607 =item B<Query> I<QueryName>
1609 Associates the query named I<QueryName> with this database connection. The
1610 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1611 blocks you want to refer to must be placed above the database block you want to
1614 =item B<Host> I<Hostname>
1616 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
1617 values. Defaults to the global hostname setting.
1625 =item B<Device> I<Device>
1627 Select partitions based on the devicename.
1629 =item B<MountPoint> I<Directory>
1631 Select partitions based on the mountpoint.
1633 =item B<FSType> I<FSType>
1635 Select partitions based on the filesystem type.
1637 =item B<IgnoreSelected> B<true>|B<false>
1639 Invert the selection: If set to true, all partitions B<except> the ones that
1640 match any one of the criteria are collected. By default only selected
1641 partitions are collected if a selection is made. If no selection is configured
1642 at all, B<all> partitions are selected.
1644 =item B<ReportByDevice> B<true>|B<false>
1646 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1647 (the default), it will report a disk as "root", but with it I<true>, it will be
1648 "sda1" (or whichever).
1650 =item B<ReportInodes> B<true>|B<false>
1652 Enables or disables reporting of free, reserved and used inodes. Defaults to
1653 inode collection being disabled.
1655 Enable this option if inodes are a scarce resource for you, usually because
1656 many small files are stored on the disk. This is a usual scenario for mail
1657 transfer agents and web caches.
1659 =item B<ValuesAbsolute> B<true>|B<false>
1661 Enables or disables reporting of free and used disk space in 1K-blocks.
1662 Defaults to B<true>.
1664 =item B<ValuesPercentage> B<false>|B<true>
1666 Enables or disables reporting of free and used disk space in percentage.
1667 Defaults to B<false>.
1669 This is useful for deploying I<collectd> on the cloud, where machines with
1670 different disk size may exist. Then it is more practical to configure
1671 thresholds based on relative disk size.
1675 =head2 Plugin C<disk>
1677 The C<disk> plugin collects information about the usage of physical disks and
1678 logical disks (partitions). Values collected are the number of octets written
1679 to and read from a disk or partition, the number of read/write operations
1680 issued to the disk and a rather complex "time" it took for these commands to be
1683 Using the following two options you can ignore some disks or configure the
1684 collection only of specific disks.
1688 =item B<Disk> I<Name>
1690 Select the disk I<Name>. Whether it is collected or ignored depends on the
1691 B<IgnoreSelected> setting, see below. As with other plugins that use the
1692 daemon's ignorelist functionality, a string that starts and ends with a slash
1693 is interpreted as a regular expression. Examples:
1698 =item B<IgnoreSelected> B<true>|B<false>
1700 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1701 statements, are ignored or if all other disks are ignored. The behavior
1702 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1703 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1704 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1705 is set to B<true>, all disks are collected B<except> the ones matched.
1709 =head2 Plugin C<dns>
1713 =item B<Interface> I<Interface>
1715 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1716 option sets the interface that should be used. If this option is not set, or
1717 set to "any", the plugin will try to get packets from B<all> interfaces. This
1718 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1720 =item B<IgnoreSource> I<IP-address>
1722 Ignore packets that originate from this address.
1724 =item B<SelectNumericQueryTypes> B<true>|B<false>
1726 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1730 =head2 Plugin C<email>
1734 =item B<SocketFile> I<Path>
1736 Sets the socket-file which is to be created.
1738 =item B<SocketGroup> I<Group>
1740 If running as root change the group of the UNIX-socket after it has been
1741 created. Defaults to B<collectd>.
1743 =item B<SocketPerms> I<Permissions>
1745 Change the file permissions of the UNIX-socket after it has been created. The
1746 permissions must be given as a numeric, octal value as you would pass to
1747 L<chmod(1)>. Defaults to B<0770>.
1749 =item B<MaxConns> I<Number>
1751 Sets the maximum number of connections that can be handled in parallel. Since
1752 this many threads will be started immediately setting this to a very high
1753 value will waste valuable resources. Defaults to B<5> and will be forced to be
1754 at most B<16384> to prevent typos and dumb mistakes.
1758 =head2 Plugin C<ethstat>
1760 The I<ethstat plugin> collects information about network interface cards (NICs)
1761 by talking directly with the underlying kernel driver using L<ioctl(2)>.
1767 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
1768 Map "multicast" "if_multicast"
1775 =item B<Interface> I<Name>
1777 Collect statistical information about interface I<Name>.
1779 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
1781 By default, the plugin will submit values as type C<derive> and I<type
1782 instance> set to I<Name>, the name of the metric as reported by the driver. If
1783 an appropriate B<Map> option exists, the given I<Type> and, optionally,
1784 I<TypeInstance> will be used.
1786 =item B<MappedOnly> B<true>|B<false>
1788 When set to B<true>, only metrics that can be mapped to to a I<type> will be
1789 collected, all other metrics will be ignored. Defaults to B<false>.
1793 =head2 Plugin C<exec>
1795 Please make sure to read L<collectd-exec(5)> before using this plugin. It
1796 contains valuable information on when the executable is executed and the
1797 output that is expected from it.
1801 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1803 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1805 Execute the executable I<Executable> as user I<User>. If the user name is
1806 followed by a colon and a group name, the effective group is set to that group.
1807 The real group and saved-set group will be set to the default group of that
1808 user. If no group is given the effective group ID will be the same as the real
1811 Please note that in order to change the user and/or group the daemon needs
1812 superuser privileges. If the daemon is run as an unprivileged user you must
1813 specify the same user/group here. If the daemon is run with superuser
1814 privileges, you must supply a non-root user here.
1816 The executable may be followed by optional arguments that are passed to the
1817 program. Please note that due to the configuration parsing numbers and boolean
1818 values may be changed. If you want to be absolutely sure that something is
1819 passed as-is please enclose it in quotes.
1821 The B<Exec> and B<NotificationExec> statements change the semantics of the
1822 programs executed, i.E<nbsp>e. the data passed to them and the response
1823 expected from them. This is documented in great detail in L<collectd-exec(5)>.
1827 =head2 Plugin C<filecount>
1829 The C<filecount> plugin counts the number of files in a certain directory (and
1830 its subdirectories) and their combined size. The configuration is very straight
1833 <Plugin "filecount">
1834 <Directory "/var/qmail/queue/mess">
1835 Instance "qmail-message"
1837 <Directory "/var/qmail/queue/todo">
1838 Instance "qmail-todo"
1840 <Directory "/var/lib/php5">
1841 Instance "php5-sessions"
1846 The example above counts the number of files in QMail's queue directories and
1847 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
1848 QMail has not yet looked at, the "message" queue holds the messages that were
1849 classified into "local" and "remote".
1851 As you can see, the configuration consists of one or more C<Directory> blocks,
1852 each of which specifies a directory in which to count the files. Within those
1853 blocks, the following options are recognized:
1857 =item B<Instance> I<Instance>
1859 Sets the plugin instance to I<Instance>. That instance name must be unique, but
1860 it's your responsibility, the plugin doesn't check for that. If not given, the
1861 instance is set to the directory name with all slashes replaced by underscores
1862 and all leading underscores removed.
1864 =item B<Name> I<Pattern>
1866 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
1867 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
1868 against the pattern, not the entire path. In case this makes it easier for you:
1869 This option has been named after the B<-name> parameter to L<find(1)>.
1871 =item B<MTime> I<Age>
1873 Count only files of a specific age: If I<Age> is greater than zero, only files
1874 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
1875 a negative number, this is inversed. For example, if B<-60> is specified, only
1876 files that have been modified in the last minute will be counted.
1878 The number can also be followed by a "multiplier" to easily specify a larger
1879 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
1880 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
1881 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
1882 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
1883 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
1886 =item B<Size> I<Size>
1888 Count only files of a specific size. When I<Size> is a positive number, only
1889 files that are at least this big are counted. If I<Size> is a negative number,
1890 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
1891 I<Size> are counted.
1893 As with the B<MTime> option, a "multiplier" may be added. For a detailed
1894 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
1895 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
1896 note that there are 1000 bytes in a kilobyte, not 1024.
1898 =item B<Recursive> I<true>|I<false>
1900 Controls whether or not to recurse into subdirectories. Enabled by default.
1902 =item B<IncludeHidden> I<true>|I<false>
1904 Controls whether or not to include "hidden" files and directories in the count.
1905 "Hidden" files and directories are those, whose name begins with a dot.
1906 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
1910 =head2 Plugin C<GenericJMX>
1912 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
1913 L<collectd-java(5)>.
1915 =head2 Plugin C<gmond>
1917 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
1918 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
1919 are built-in, custom mappings may be added via B<Metric> blocks, see below.
1924 MCReceiveFrom "239.2.11.71" "8649"
1925 <Metric "swap_total">
1927 TypeInstance "total"
1930 <Metric "swap_free">
1937 The following metrics are built-in:
1943 load_one, load_five, load_fifteen
1947 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
1951 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
1963 Available configuration options:
1967 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
1969 Sets sets the multicast group and UDP port to which to subscribe.
1971 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
1973 =item E<lt>B<Metric> I<Name>E<gt>
1975 These blocks add a new metric conversion to the internal table. I<Name>, the
1976 string argument to the B<Metric> block, is the metric name as used by Ganglia.
1980 =item B<Type> I<Type>
1982 Type to map this metric to. Required.
1984 =item B<TypeInstance> I<Instance>
1986 Type-instance to use. Optional.
1988 =item B<DataSource> I<Name>
1990 Data source to map this metric to. If the configured type has exactly one data
1991 source, this is optional. Otherwise the option is required.
1997 =head2 Plugin C<hddtemp>
1999 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
2000 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
2001 default values, see below. C<hddtemp> has to be running to work correctly. If
2002 C<hddtemp> is not running timeouts may appear which may interfere with other
2005 The B<hddtemp> homepage can be found at
2006 L<http://www.guzu.net/linux/hddtemp.php>.
2010 =item B<Host> I<Hostname>
2012 Hostname to connect to. Defaults to B<127.0.0.1>.
2014 =item B<Port> I<Port>
2016 TCP-Port to connect to. Defaults to B<7634>.
2020 =head2 Plugin C<interface>
2024 =item B<Interface> I<Interface>
2026 Select this interface. By default these interfaces will then be collected. For
2027 a more detailed description see B<IgnoreSelected> below.
2029 =item B<IgnoreSelected> I<true>|I<false>
2031 If no configuration if given, the B<traffic>-plugin will collect data from
2032 all interfaces. This may not be practical, especially for loopback- and
2033 similar interfaces. Thus, you can use the B<Interface>-option to pick the
2034 interfaces you're interested in. Sometimes, however, it's easier/preferred
2035 to collect all interfaces I<except> a few ones. This option enables you to
2036 do that: By setting B<IgnoreSelected> to I<true> the effect of
2037 B<Interface> is inverted: All selected interfaces are ignored and all
2038 other interfaces are collected.
2042 =head2 Plugin C<ipmi>
2046 =item B<Sensor> I<Sensor>
2048 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2050 =item B<IgnoreSelected> I<true>|I<false>
2052 If no configuration if given, the B<ipmi> plugin will collect data from all
2053 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2054 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2055 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2056 all other sensors are collected.
2058 =item B<NotifySensorAdd> I<true>|I<false>
2060 If a sensor appears after initialization time of a minute a notification
2063 =item B<NotifySensorRemove> I<true>|I<false>
2065 If a sensor disappears a notification is sent.
2067 =item B<NotifySensorNotPresent> I<true>|I<false>
2069 If you have for example dual power supply and one of them is (un)plugged then
2070 a notification is sent.
2074 =head2 Plugin C<iptables>
2078 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2080 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
2081 will collect the counters of all rules which have a comment-match. The comment
2082 is then used as type-instance.
2084 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2085 the I<n>th rule will be collected. Again, the comment (or the number) will be
2086 used as the type-instance.
2088 If I<Name> is supplied, it will be used as the type-instance instead of the
2089 comment or the number.
2093 =head2 Plugin C<irq>
2099 Select this irq. By default these irqs will then be collected. For a more
2100 detailed description see B<IgnoreSelected> below.
2102 =item B<IgnoreSelected> I<true>|I<false>
2104 If no configuration if given, the B<irq>-plugin will collect data from all
2105 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2106 can use the B<Irq>-option to pick the interrupt you're interested in.
2107 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2108 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2109 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2110 and all other interrupts are collected.
2114 =head2 Plugin C<java>
2116 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2117 This section only discusses the syntax and semantic of the configuration
2118 options. For more in-depth information on the I<Java> plugin, please read
2119 L<collectd-java(5)>.
2124 JVMArg "-verbose:jni"
2125 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2126 LoadPlugin "org.collectd.java.Foobar"
2127 <Plugin "org.collectd.java.Foobar">
2128 # To be parsed by the plugin
2132 Available configuration options:
2136 =item B<JVMArg> I<Argument>
2138 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2139 exactly the way the arguments to the I<java> binary on the command line work.
2140 Execute C<javaE<nbsp>--help> for details.
2142 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2143 any other options! When another option is found, the JVM will be started and
2144 later options will have to be ignored!
2146 =item B<LoadPlugin> I<JavaClass>
2148 Instantiates a new I<JavaClass> object. The constructor of this object very
2149 likely then registers one or more callback methods with the server.
2151 See L<collectd-java(5)> for details.
2153 When the first such option is found, the virtual machine (JVM) is created. This
2154 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2155 B<LoadPlugin> options!
2157 =item B<Plugin> I<Name>
2159 The entire block is passed to the Java plugin as an
2160 I<org.collectd.api.OConfigItem> object.
2162 For this to work, the plugin has to register a configuration callback first,
2163 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2164 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2165 depends on the (Java) plugin registering the callback and is completely
2166 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2170 =head2 Plugin C<libvirt>
2172 This plugin allows CPU, disk and network load to be collected for virtualized
2173 guests on the machine. This means that these characteristics can be collected
2174 for guest systems without installing any software on them - collectd only runs
2175 on the hosting system. The statistics are collected through libvirt
2176 (L<http://libvirt.org/>).
2178 Only I<Connection> is required.
2182 =item B<Connection> I<uri>
2184 Connect to the hypervisor given by I<uri>. For example if using Xen use:
2186 Connection "xen:///"
2188 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
2190 =item B<RefreshInterval> I<seconds>
2192 Refresh the list of domains and devices every I<seconds>. The default is 60
2193 seconds. Setting this to be the same or smaller than the I<Interval> will cause
2194 the list of domains and devices to be refreshed on every iteration.
2196 Refreshing the devices in particular is quite a costly operation, so if your
2197 virtualization setup is static you might consider increasing this. If this
2198 option is set to 0, refreshing is disabled completely.
2200 =item B<Domain> I<name>
2202 =item B<BlockDevice> I<name:dev>
2204 =item B<InterfaceDevice> I<name:dev>
2206 =item B<IgnoreSelected> I<true>|I<false>
2208 Select which domains and devices are collected.
2210 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
2211 disk/network devices are collected.
2213 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
2214 domains and disk/network devices are ignored, while the rest are collected.
2216 The domain name and device names may use a regular expression, if the name is
2217 surrounded by I</.../> and collectd was compiled with support for regexps.
2219 The default is to collect statistics for all domains and all their devices.
2223 BlockDevice "/:hdb/"
2224 IgnoreSelected "true"
2226 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
2229 =item B<HostnameFormat> B<name|uuid|hostname|...>
2231 When the libvirt plugin logs data, it sets the hostname of the collected data
2232 according to this setting. The default is to use the guest name as provided by
2233 the hypervisor, which is equal to setting B<name>.
2235 B<uuid> means use the guest's UUID. This is useful if you want to track the
2236 same guest across migrations.
2238 B<hostname> means to use the global B<Hostname> setting, which is probably not
2239 useful on its own because all guests will appear to have the same name.
2241 You can also specify combinations of these fields. For example B<name uuid>
2242 means to concatenate the guest name and UUID (with a literal colon character
2243 between, thus I<"foo:1234-1234-1234-1234">).
2245 =item B<InterfaceFormat> B<name>|B<address>
2247 When the libvirt plugin logs interface data, it sets the name of the collected
2248 data according to this setting. The default is to use the path as provided by
2249 the hypervisor (the "dev" property of the target node), which is equal to
2252 B<address> means use the interface's mac address. This is useful since the
2253 interface path might change between reboots of a guest or across migrations.
2257 +=head2 Plugin C<load>
2259 The I<Load plugin> collects the system load. These numbers give a rough overview
2260 over the utilization of a machine. The system load is defined as the number of
2261 runnable tasks in the run-queue and is provided by many operating systems as a
2262 one, five or fifteen minute average.
2264 The following configuration options are available:
2268 =item B<ReportRelative> B<false>|B<true>
2270 When enabled, system load divided by number of available CPU cores is reported
2271 for intervals 1 min, 5 min and 15 min. Defaults to false.
2276 =head2 Plugin C<logfile>
2280 =item B<LogLevel> B<debug|info|notice|warning|err>
2282 Sets the log-level. If, for example, set to B<notice>, then all events with
2283 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2285 Please note that B<debug> is only available if collectd has been compiled with
2288 =item B<File> I<File>
2290 Sets the file to write log messages to. The special strings B<stdout> and
2291 B<stderr> can be used to write to the standard output and standard error
2292 channels, respectively. This, of course, only makes much sense when I<collectd>
2293 is running in foreground- or non-daemon-mode.
2295 =item B<Timestamp> B<true>|B<false>
2297 Prefix all lines printed by the current time. Defaults to B<true>.
2299 =item B<PrintSeverity> B<true>|B<false>
2301 When enabled, all lines are prefixed by the severity of the log message, for
2302 example "warning". Defaults to B<false>.
2306 B<Note>: There is no need to notify the daemon after moving or removing the
2307 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2308 for each line it writes.
2310 =head2 Plugin C<lpar>
2312 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2313 virtualization technique for IBM POWER processors. It takes into account CPU
2314 time stolen from or donated to a partition, in addition to the usual user,
2315 system, I/O statistics.
2317 The following configuration options are available:
2321 =item B<CpuPoolStats> B<false>|B<true>
2323 When enabled, statistics about the processor pool are read, too. The partition
2324 needs to have pool authority in order to be able to acquire this information.
2327 =item B<ReportBySerial> B<false>|B<true>
2329 If enabled, the serial of the physical machine the partition is currently
2330 running on is reported as I<hostname> and the logical hostname of the machine
2331 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2332 used (just like other plugins) and the I<plugin instance> will be empty.
2337 =head2 Plugin C<mbmon>
2339 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2341 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2342 B<Host> and B<Port> options can be used to change these values, see below.
2343 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2344 timeouts may appear which may interfere with other statistics..
2346 C<mbmon> must be run with the -r option ("print TAG and Value format");
2347 Debian's F</etc/init.d/mbmon> script already does this, other people
2348 will need to ensure that this is the case.
2352 =item B<Host> I<Hostname>
2354 Hostname to connect to. Defaults to B<127.0.0.1>.
2356 =item B<Port> I<Port>
2358 TCP-Port to connect to. Defaults to B<411>.
2364 The C<md plugin> collects information from Linux Software-RAID devices (md).
2366 All reported values are of the type C<md_disks>. Reported type instances are
2367 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2368 I<missing> (physically absent) disks.
2372 =item B<Device> I<Device>
2374 Select md devices based on device name. The I<device name> is the basename of
2375 the device, i.e. the name of the block device without the leading C</dev/>.
2376 See B<IgnoreSelected> for more details.
2378 =item B<IgnoreSelected> B<true>|B<false>
2380 Invert device selection: If set to B<true>, all md devices B<except> those
2381 listed using B<Device> are collected. If B<false> (the default), only those
2382 listed are collected. If no configuration is given, the B<md> plugin will
2383 collect data from all md devices.
2387 =head2 Plugin C<memcachec>
2389 The C<memcachec plugin> connects to a memcached server, queries one or more
2390 given I<pages> and parses the returned data according to user specification.
2391 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2394 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2395 library. Please note that there is another library with a very similar name,
2396 libmemcache (notice the missing `d'), which is not applicable.
2398 Synopsis of the configuration:
2400 <Plugin "memcachec">
2401 <Page "plugin_instance">
2405 Regex "(\\d+) bytes sent"
2408 Instance "type_instance"
2413 The configuration options are:
2417 =item E<lt>B<Page> I<Name>E<gt>
2419 Each B<Page> block defines one I<page> to be queried from the memcached server.
2420 The block requires one string argument which is used as I<plugin instance>.
2422 =item B<Server> I<Address>
2424 Sets the server address to connect to when querying the page. Must be inside a
2429 When connected to the memcached server, asks for the page I<Key>.
2431 =item E<lt>B<Match>E<gt>
2433 Match blocks define which strings to look for and how matches substrings are
2434 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2438 =head2 Plugin C<memcached>
2440 The B<memcached plugin> connects to a memcached server and queries statistics
2441 about cache utilization, memory and bandwidth used.
2442 L<http://www.danga.com/memcached/>
2444 <Plugin "memcached">
2446 Host "memcache.example.com"
2451 The plugin configuration consists of one or more B<Instance> blocks which
2452 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2453 following options are allowed:
2457 =item B<Host> I<Hostname>
2459 Hostname to connect to. Defaults to B<127.0.0.1>.
2461 =item B<Port> I<Port>
2463 TCP-Port to connect to. Defaults to B<11211>.
2465 =item B<Socket> I<Path>
2467 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2468 setting is given, the B<Host> and B<Port> settings are ignored.
2472 =head2 Plugin C<mic>
2474 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2475 Intel's Many Integrated Core (MIC) systems.
2484 ShowTemperatures true
2487 IgnoreSelectedTemperature true
2492 IgnoreSelectedPower true
2495 The following options are valid inside the B<PluginE<nbsp>mic> block:
2499 =item B<ShowCPU> B<true>|B<false>
2501 If enabled (the default) a sum of the CPU usage accross all cores is reported.
2503 =item B<ShowCPUCores> B<true>|B<false>
2505 If enabled (the default) per-core CPU usage is reported.
2507 =item B<ShowMemory> B<true>|B<false>
2509 If enabled (the default) the physical memory usage of the MIC system is
2512 =item B<ShowTemperatures> B<true>|B<false>
2514 If enabled (the default) various temperatures of the MIC system are reported.
2516 =item B<Temperature> I<Name>
2518 This option controls which temperatures are being reported. Whether matching
2519 temperatures are being ignored or I<only> matching temperatures are reported
2520 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2521 temperatures are reported.
2523 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2525 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2526 (the default) only temperatures matching a B<Temperature> option are reported
2527 or, if no B<Temperature> option is specified, all temperatures are reported. If
2528 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2531 Known temperature names are:
2565 =item B<ShowPower> B<true>|B<false>
2567 If enabled (the default) various temperatures of the MIC system are reported.
2569 =item B<Power> I<Name>
2571 This option controls which power readings are being reported. Whether matching
2572 power readings are being ignored or I<only> matching power readings are reported
2573 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
2574 power readings are reported.
2576 =item B<IgnoreSelectedPower> B<false>|B<true>
2578 Controls the behavior of the B<Power> setting above. If set to B<false>
2579 (the default) only power readings matching a B<Power> option are reported
2580 or, if no B<Power> option is specified, all power readings are reported. If
2581 set to B<true>, matching power readings are I<ignored> and all other power readings
2584 Known power names are:
2590 Total power utilization averaged over Time Window 0 (uWatts).
2594 Total power utilization averaged over Time Window 0 (uWatts).
2598 Instantaneous power (uWatts).
2602 Max instantaneous power (uWatts).
2606 PCI-E connector power (uWatts).
2610 2x3 connector power (uWatts).
2614 2x4 connector power (uWatts).
2622 Uncore rail (uVolts).
2626 Memory subsystem rail (uVolts).
2632 =head2 Plugin C<memory>
2634 The I<memory plugin> provides the following configuration options:
2638 =item B<ValuesAbsolute> B<true>|B<false>
2640 Enables or disables reporting of physical memory usage in absolute numbers,
2641 i.e. bytes. Defaults to B<true>.
2643 =item B<ValuesPercentage> B<false>|B<true>
2645 Enables or disables reporting of physical memory usage in percentages, e.g.
2646 percent of physical memory used. Defaults to B<false>.
2648 This is useful for deploying I<collectd> in a heterogeneous environment in
2649 which the sizes of physical memory vary.
2653 =head2 Plugin C<modbus>
2655 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
2656 register values. It supports reading single registers (unsigned 16E<nbsp>bit
2657 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2658 values (two registers interpreted as IEEE floats in big endian notation).
2662 <Data "voltage-input-1">
2669 <Data "voltage-input-2">
2676 <Host "modbus.example.com">
2677 Address "192.168.0.42"
2682 Instance "power-supply"
2683 Collect "voltage-input-1"
2684 Collect "voltage-input-2"
2690 =item E<lt>B<Data> I<Name>E<gt> blocks
2692 Data blocks define a mapping between register numbers and the "types" used by
2695 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
2699 =item B<RegisterBase> I<Number>
2701 Configures the base register to read from the device. If the option
2702 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
2703 register will be read (the register number is increased by one).
2705 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
2707 Specifies what kind of data is returned by the device. If the type is B<Int32>,
2708 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
2709 combined into one value. Defaults to B<Uint16>.
2711 =item B<Type> I<Type>
2713 Specifies the "type" (data set) to use when dispatching the value to
2714 I<collectd>. Currently, only data sets with exactly one data source are
2717 =item B<Instance> I<Instance>
2719 Sets the type instance to use when dispatching the value to I<collectd>. If
2720 unset, an empty string (no type instance) is used.
2724 =item E<lt>B<Host> I<Name>E<gt> blocks
2726 Host blocks are used to specify to which hosts to connect and what data to read
2727 from their "slaves". The string argument I<Name> is used as hostname when
2728 dispatching the values to I<collectd>.
2730 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
2734 =item B<Address> I<Hostname>
2736 Specifies the node name (the actual network address) used to connect to the
2737 host. This may be an IP address or a hostname. Please note that the used
2738 I<libmodbus> library only supports IPv4 at the moment.
2740 =item B<Port> I<Service>
2742 Specifies the port used to connect to the host. The port can either be given as
2743 a number or as a service name. Please note that the I<Service> argument must be
2744 a string, even if ports are given in their numerical form. Defaults to "502".
2746 =item B<Interval> I<Interval>
2748 Sets the interval (in seconds) in which the values will be collected from this
2749 host. By default the global B<Interval> setting will be used.
2751 =item E<lt>B<Slave> I<ID>E<gt>
2753 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
2754 is used to specify which device should be addressed. For each device you want
2755 to query, one B<Slave> block must be given.
2757 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
2761 =item B<Instance> I<Instance>
2763 Specify the plugin instance to use when dispatching the values to I<collectd>.
2764 By default "slave_I<ID>" is used.
2766 =item B<Collect> I<DataName>
2768 Specifies which data to retrieve from the device. I<DataName> must be the same
2769 string as the I<Name> argument passed to a B<Data> block. You can specify this
2770 option multiple times to collect more than one value from a slave. At least one
2771 B<Collect> option is mandatory.
2779 =head2 Plugin C<mysql>
2781 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
2782 one or more databases when started and keeps the connection up as long as
2783 possible. When the connection is interrupted for whatever reason it will try
2784 to re-connect. The plugin will complain loudly in case anything goes wrong.
2786 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
2787 and collects information about MySQL network traffic, executed statements,
2788 requests, the query cache and threads by evaluating the
2789 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
2790 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
2791 Status Variables> for an explanation of these values.
2793 Optionally, master and slave statistics may be collected in a MySQL
2794 replication setup. In that case, information about the synchronization state
2795 of the nodes are collected by evaluating the C<Position> return value of the
2796 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
2797 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
2798 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
2799 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
2800 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
2815 Socket "/var/run/mysql/mysqld.sock"
2817 SlaveNotifications true
2821 A B<Database> block defines one connection to a MySQL database. It accepts a
2822 single argument which specifies the name of the database. None of the other
2823 options are required. MySQL will use default values as documented in the
2824 section "mysql_real_connect()" in the B<MySQL reference manual>.
2828 =item B<Host> I<Hostname>
2830 Hostname of the database server. Defaults to B<localhost>.
2832 =item B<User> I<Username>
2834 Username to use when connecting to the database. The user does not have to be
2835 granted any privileges (which is synonym to granting the C<USAGE> privilege),
2836 unless you want to collectd replication statistics (see B<MasterStats> and
2837 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
2838 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
2840 =item B<Password> I<Password>
2842 Password needed to log into the database.
2844 =item B<Database> I<Database>
2846 Select this database. Defaults to I<no database> which is a perfectly reasonable
2847 option for what this plugin does.
2849 =item B<Port> I<Port>
2851 TCP-port to connect to. The port must be specified in its numeric form, but it
2852 must be passed as a string nonetheless. For example:
2856 If B<Host> is set to B<localhost> (the default), this setting has no effect.
2857 See the documentation for the C<mysql_real_connect> function for details.
2859 =item B<Socket> I<Socket>
2861 Specifies the path to the UNIX domain socket of the MySQL server. This option
2862 only has any effect, if B<Host> is set to B<localhost> (the default).
2863 Otherwise, use the B<Port> option above. See the documentation for the
2864 C<mysql_real_connect> function for details.
2866 =item B<MasterStats> I<true|false>
2868 =item B<SlaveStats> I<true|false>
2870 Enable the collection of master / slave statistics in a replication setup. In
2871 order to be able to get access to these statistics, the user needs special
2872 privileges. See the B<User> documentation above.
2874 =item B<SlaveNotifications> I<true|false>
2876 If enabled, the plugin sends a notification if the replication slave I/O and /
2877 or SQL threads are not running.
2881 =head2 Plugin C<netapp>
2883 The netapp plugin can collect various performance and capacity information
2884 from a NetApp filer using the NetApp API.
2886 Please note that NetApp has a wide line of products and a lot of different
2887 software versions for each of these products. This plugin was developed for a
2888 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
2889 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
2890 model and software version but it is very hard to test this.
2891 If you have used this plugin with other models and/or software version, feel
2892 free to send us a mail to tell us about the results, even if it's just a short
2895 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
2896 basic authentication.
2898 B<Do not use a regular user for this!> Create a special collectd user with just
2899 the minimum of capabilities needed. The user only needs the "login-http-admin"
2900 capability as well as a few more depending on which data will be collected.
2901 Required capabilities are documented below.
2906 <Host "netapp1.example.com">
2930 IgnoreSelectedIO false
2932 IgnoreSelectedOps false
2933 GetLatency "volume0"
2934 IgnoreSelectedLatency false
2941 IgnoreSelectedCapacity false
2944 IgnoreSelectedSnapshot false
2972 The netapp plugin accepts the following configuration options:
2976 =item B<Host> I<Name>
2978 A host block defines one NetApp filer. It will appear in collectd with the name
2979 you specify here which does not have to be its real name nor its hostname (see
2980 the B<Address> option below).
2982 =item B<VFiler> I<Name>
2984 A B<VFiler> block may only be used inside a host block. It accepts all the
2985 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
2986 will execute all NetApp API commands in the context of the specified
2987 VFiler(R). It will appear in collectd with the name you specify here which
2988 does not have to be its real name. The VFiler name may be specified using the
2989 B<VFilerName> option. If this is not specified, it will default to the name
2992 The VFiler block inherits all connection related settings from the surrounding
2993 B<Host> block (which appear before the B<VFiler> block) but they may be
2994 overwritten inside the B<VFiler> block.
2996 This feature is useful, for example, when using a VFiler as SnapVault target
2997 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
2998 available in the host filer (vfiler0) but only in the respective VFiler
3001 =item B<Protocol> B<httpd>|B<http>
3003 The protocol collectd will use to query this host.
3011 Valid options: http, https
3013 =item B<Address> I<Address>
3015 The hostname or IP address of the host.
3021 Default: The "host" block's name.
3023 =item B<Port> I<Port>
3025 The TCP port to connect to on the host.
3031 Default: 80 for protocol "http", 443 for protocol "https"
3033 =item B<User> I<User>
3035 =item B<Password> I<Password>
3037 The username and password to use to login to the NetApp.
3043 =item B<VFilerName> I<Name>
3045 The name of the VFiler in which context to execute API commands. If not
3046 specified, the name provided to the B<VFiler> block will be used instead.
3052 Default: name of the B<VFiler> block
3054 B<Note:> This option may only be used inside B<VFiler> blocks.
3056 =item B<Interval> I<Interval>
3062 The following options decide what kind of data will be collected. You can
3063 either use them as a block and fine tune various parameters inside this block,
3064 use them as a single statement to just accept all default values, or omit it to
3065 not collect any data.
3067 The following options are valid inside all blocks:
3071 =item B<Interval> I<Seconds>
3073 Collect the respective statistics every I<Seconds> seconds. Defaults to the
3074 host specific setting.
3078 =head3 The System block
3080 This will collect various performance data about the whole system.
3082 B<Note:> To get this data the collectd user needs the
3083 "api-perf-object-get-instances" capability.
3087 =item B<Interval> I<Seconds>
3089 Collect disk statistics every I<Seconds> seconds.
3091 =item B<GetCPULoad> B<true>|B<false>
3093 If you set this option to true the current CPU usage will be read. This will be
3094 the average usage between all CPUs in your NetApp without any information about
3097 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3098 returns in the "CPU" field.
3106 Result: Two value lists of type "cpu", and type instances "idle" and "system".
3108 =item B<GetInterfaces> B<true>|B<false>
3110 If you set this option to true the current traffic of the network interfaces
3111 will be read. This will be the total traffic over all interfaces of your NetApp
3112 without any information about individual interfaces.
3114 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3115 in the "Net kB/s" field.
3125 Result: One value list of type "if_octects".
3127 =item B<GetDiskIO> B<true>|B<false>
3129 If you set this option to true the current IO throughput will be read. This
3130 will be the total IO of your NetApp without any information about individual
3131 disks, volumes or aggregates.
3133 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3134 in the "DiskE<nbsp>kB/s" field.
3142 Result: One value list of type "disk_octets".
3144 =item B<GetDiskOps> B<true>|B<false>
3146 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
3147 iSCSI, etc. operations will be read. This will be the total number of
3148 operations on your NetApp without any information about individual volumes or
3151 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3152 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
3160 Result: A variable number of value lists of type "disk_ops_complex". Each type
3161 of operation will result in one value list with the name of the operation as
3166 =head3 The WAFL block
3168 This will collect various performance data about the WAFL file system. At the
3169 moment this just means cache performance.
3171 B<Note:> To get this data the collectd user needs the
3172 "api-perf-object-get-instances" capability.
3174 B<Note:> The interface to get these values is classified as "Diagnostics" by
3175 NetApp. This means that it is not guaranteed to be stable even between minor
3180 =item B<Interval> I<Seconds>
3182 Collect disk statistics every I<Seconds> seconds.
3184 =item B<GetNameCache> B<true>|B<false>
3192 Result: One value list of type "cache_ratio" and type instance
3195 =item B<GetDirCache> B<true>|B<false>
3203 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3205 =item B<GetInodeCache> B<true>|B<false>
3213 Result: One value list of type "cache_ratio" and type instance
3216 =item B<GetBufferCache> B<true>|B<false>
3218 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3219 in the "Cache hit" field.
3227 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3231 =head3 The Disks block
3233 This will collect performance data about the individual disks in the NetApp.
3235 B<Note:> To get this data the collectd user needs the
3236 "api-perf-object-get-instances" capability.
3240 =item B<Interval> I<Seconds>
3242 Collect disk statistics every I<Seconds> seconds.
3244 =item B<GetBusy> B<true>|B<false>
3246 If you set this option to true the busy time of all disks will be calculated
3247 and the value of the busiest disk in the system will be written.
3249 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3250 in the "Disk util" field. Probably.
3258 Result: One value list of type "percent" and type instance "disk_busy".
3262 =head3 The VolumePerf block
3264 This will collect various performance data about the individual volumes.
3266 You can select which data to collect about which volume using the following
3267 options. They follow the standard ignorelist semantic.
3269 B<Note:> To get this data the collectd user needs the
3270 I<api-perf-object-get-instances> capability.
3274 =item B<Interval> I<Seconds>
3276 Collect volume performance data every I<Seconds> seconds.
3278 =item B<GetIO> I<Volume>
3280 =item B<GetOps> I<Volume>
3282 =item B<GetLatency> I<Volume>
3284 Select the given volume for IO, operations or latency statistics collection.
3285 The argument is the name of the volume without the C</vol/> prefix.
3287 Since the standard ignorelist functionality is used here, you can use a string
3288 starting and ending with a slash to specify regular expression matching: To
3289 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3292 GetIO "/^vol[027]$/"
3294 If no regular expression is specified, an exact match is required. Both,
3295 regular and exact matching are case sensitive.
3297 If no volume was specified at all for either of the three options, that data
3298 will be collected for all available volumes.
3300 =item B<IgnoreSelectedIO> B<true>|B<false>
3302 =item B<IgnoreSelectedOps> B<true>|B<false>
3304 =item B<IgnoreSelectedLatency> B<true>|B<false>
3306 When set to B<true>, the volumes selected for IO, operations or latency
3307 statistics collection will be ignored and the data will be collected for all
3310 When set to B<false>, data will only be collected for the specified volumes and
3311 all other volumes will be ignored.
3313 If no volumes have been specified with the above B<Get*> options, all volumes
3314 will be collected regardless of the B<IgnoreSelected*> option.
3316 Defaults to B<false>
3320 =head3 The VolumeUsage block
3322 This will collect capacity data about the individual volumes.
3324 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3329 =item B<Interval> I<Seconds>
3331 Collect volume usage statistics every I<Seconds> seconds.
3333 =item B<GetCapacity> I<VolumeName>
3335 The current capacity of the volume will be collected. This will result in two
3336 to four value lists, depending on the configuration of the volume. All data
3337 sources are of type "df_complex" with the name of the volume as
3340 There will be type_instances "used" and "free" for the number of used and
3341 available bytes on the volume. If the volume has some space reserved for
3342 snapshots, a type_instance "snap_reserved" will be available. If the volume
3343 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3344 number of bytes saved by the SIS feature.
3346 B<Note:> The current NetApp API has a bug that results in this value being
3347 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3348 number which works most of the time. If you see strange values here, bug
3349 NetApp support to fix this.
3351 Repeat this option to specify multiple volumes.
3353 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3355 Specify whether to collect only the volumes selected by the B<GetCapacity>
3356 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3357 B<false>. However, if no B<GetCapacity> option is specified at all, all
3358 capacities will be selected anyway.
3360 =item B<GetSnapshot> I<VolumeName>
3362 Select volumes from which to collect snapshot information.
3364 Usually, the space used for snapshots is included in the space reported as
3365 "used". If snapshot information is collected as well, the space used for
3366 snapshots is subtracted from the used space.
3368 To make things even more interesting, it is possible to reserve space to be
3369 used for snapshots. If the space required for snapshots is less than that
3370 reserved space, there is "reserved free" and "reserved used" space in addition
3371 to "free" and "used". If the space required for snapshots exceeds the reserved
3372 space, that part allocated in the normal space is subtracted from the "used"
3375 Repeat this option to specify multiple volumes.
3377 =item B<IgnoreSelectedSnapshot>
3379 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3380 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3381 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3382 capacities will be selected anyway.
3386 =head3 The Quota block
3388 This will collect (tree) quota statistics (used disk space and number of used
3389 files). This mechanism is useful to get usage information for single qtrees.
3390 In case the quotas are not used for any other purpose, an entry similar to the
3391 following in C</etc/quotas> would be sufficient:
3393 /vol/volA/some_qtree tree - - - - -
3395 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3399 =item B<Interval> I<Seconds>
3401 Collect SnapVault(R) statistics every I<Seconds> seconds.
3405 =head3 The SnapVault block
3407 This will collect statistics about the time and traffic of SnapVault(R)
3412 =item B<Interval> I<Seconds>
3414 Collect SnapVault(R) statistics every I<Seconds> seconds.
3418 =head2 Plugin C<netlink>
3420 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3421 statistics of various interface and routing aspects.
3425 =item B<Interface> I<Interface>
3427 =item B<VerboseInterface> I<Interface>
3429 Instruct the plugin to collect interface statistics. This is basically the same
3430 as the statistics provided by the C<interface> plugin (see above) but
3431 potentially much more detailed.
3433 When configuring with B<Interface> only the basic statistics will be collected,
3434 namely octets, packets, and errors. These statistics are collected by
3435 the C<interface> plugin, too, so using both at the same time is no benefit.
3437 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3438 so that no data needs to be collected twice if you use the C<interface> plugin.
3439 This includes dropped packets, received multicast packets, collisions and a
3440 whole zoo of differentiated RX and TX errors. You can try the following command
3441 to get an idea of what awaits you:
3445 If I<Interface> is B<All>, all interfaces will be selected.
3447 =item B<QDisc> I<Interface> [I<QDisc>]
3449 =item B<Class> I<Interface> [I<Class>]
3451 =item B<Filter> I<Interface> [I<Filter>]
3453 Collect the octets and packets that pass a certain qdisc, class or filter.
3455 QDiscs and classes are identified by their type and handle (or classid).
3456 Filters don't necessarily have a handle, therefore the parent's handle is used.
3457 The notation used in collectd differs from that used in tc(1) in that it
3458 doesn't skip the major or minor number if it's zero and doesn't print special
3459 ids by their name. So, for example, a qdisc may be identified by
3460 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3461 thus not displayed by tc(1).
3463 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3464 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3465 associated with that interface will be collected.
3467 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3468 used. This may lead to problems when more than one filter is attached to a
3469 qdisc or class. This isn't nice, but we don't know how this could be done any
3470 better. If you have a idea, please don't hesitate to tell us.
3472 As with the B<Interface> option you can specify B<All> as the interface,
3473 meaning all interfaces.
3475 Here are some examples to help you understand the above text more easily:
3478 VerboseInterface "All"
3479 QDisc "eth0" "pfifo_fast-1:0"
3481 Class "ppp0" "htb-1:10"
3482 Filter "ppp0" "u32-1:0"
3485 =item B<IgnoreSelected>
3487 The behavior is the same as with all other similar plugins: If nothing is
3488 selected at all, everything is collected. If some things are selected using the
3489 options described above, only these statistics are collected. If you set
3490 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3491 specified statistics will not be collected.
3495 =head2 Plugin C<network>
3497 The Network plugin sends data to a remote instance of collectd, receives data
3498 from a remote instance, or both at the same time. Data which has been received
3499 from the network is usually not transmitted again, but this can be activated, see
3500 the B<Forward> option below.
3502 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3503 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3505 Both, B<Server> and B<Listen> can be used as single option or as block. When
3506 used as block, given options are valid for this socket only. The following
3507 example will export the metrics twice: Once to an "internal" server (without
3508 encryption and signing) and one to an external server (with cryptographic
3512 # Export to an internal server
3513 # (demonstrates usage without additional options)
3514 Server "collectd.internal.tld"
3516 # Export to an external server
3517 # (demonstrates usage with signature options)
3518 <Server "collectd.external.tld">
3519 SecurityLevel "sign"
3520 Username "myhostname"
3527 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3529 The B<Server> statement/block sets the server to send datagrams to. The
3530 statement may occur multiple times to send each datagram to multiple
3533 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3534 optional second argument specifies a port number or a service name. If not
3535 given, the default, B<25826>, is used.
3537 The following options are recognized within B<Server> blocks:
3541 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3543 Set the security you require for network communication. When the security level
3544 has been set to B<Encrypt>, data sent over the network will be encrypted using
3545 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3546 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3547 authentication code. When set to B<None>, data is sent without any security.
3549 This feature is only available if the I<network> plugin was linked with
3552 =item B<Username> I<Username>
3554 Sets the username to transmit. This is used by the server to lookup the
3555 password. See B<AuthFile> below. All security levels except B<None> require
3558 This feature is only available if the I<network> plugin was linked with
3561 =item B<Password> I<Password>
3563 Sets a password (shared secret) for this socket. All security levels except
3564 B<None> require this setting.
3566 This feature is only available if the I<network> plugin was linked with
3569 =item B<Interface> I<Interface name>
3571 Set the outgoing interface for IP packets. This applies at least
3572 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3573 undefined or a non-existent interface name is specified, the default
3574 behavior is to let the kernel choose the appropriate interface. Be warned
3575 that the manual selection of an interface for unicast traffic is only
3576 necessary in rare cases.
3580 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
3582 The B<Listen> statement sets the interfaces to bind to. When multiple
3583 statements are found the daemon will bind to multiple interfaces.
3585 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
3586 the argument is a multicast address the daemon will join that multicast group.
3587 The optional second argument specifies a port number or a service name. If not
3588 given, the default, B<25826>, is used.
3590 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
3594 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3596 Set the security you require for network communication. When the security level
3597 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
3598 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
3599 signed and encrypted data is accepted. When set to B<None>, all data will be
3600 accepted. If an B<AuthFile> option was given (see below), encrypted data is
3601 decrypted if possible.
3603 This feature is only available if the I<network> plugin was linked with
3606 =item B<AuthFile> I<Filename>
3608 Sets a file in which usernames are mapped to passwords. These passwords are
3609 used to verify signatures and to decrypt encrypted network packets. If
3610 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
3611 verified and encrypted packets are decrypted. Otherwise, signed data is
3612 accepted without checking the signature and encrypted data cannot be decrypted.
3613 For the other security levels this option is mandatory.
3615 The file format is very simple: Each line consists of a username followed by a
3616 colon and any number of spaces followed by the password. To demonstrate, an
3617 example file could look like this:
3622 Each time a packet is received, the modification time of the file is checked
3623 using L<stat(2)>. If the file has been changed, the contents is re-read. While
3624 the file is being read, it is locked using L<fcntl(2)>.
3626 =item B<Interface> I<Interface name>
3628 Set the incoming interface for IP packets explicitly. This applies at least
3629 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3630 undefined or a non-existent interface name is specified, the default
3631 behavior is, to let the kernel choose the appropriate interface. Thus incoming
3632 traffic gets only accepted, if it arrives on the given interface.
3636 =item B<TimeToLive> I<1-255>
3638 Set the time-to-live of sent packets. This applies to all, unicast and
3639 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
3640 That means that multicast packets will be sent with a TTL of C<1> (one) on most
3643 =item B<MaxPacketSize> I<1024-65535>
3645 Set the maximum size for datagrams received over the network. Packets larger
3646 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
3647 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
3650 On the server side, this limit should be set to the largest value used on
3651 I<any> client. Likewise, the value on the client must not be larger than the
3652 value on the server, or data will be lost.
3654 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
3655 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
3656 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
3659 =item B<Forward> I<true|false>
3661 If set to I<true>, write packets that were received via the network plugin to
3662 the sending sockets. This should only be activated when the B<Listen>- and
3663 B<Server>-statements differ. Otherwise packets may be send multiple times to
3664 the same multicast group. While this results in more network traffic than
3665 necessary it's not a huge problem since the plugin has a duplicate detection,
3666 so the values will not loop.
3668 =item B<ReportStats> B<true>|B<false>
3670 The network plugin cannot only receive and send statistics, it can also create
3671 statistics about itself. Collected data included the number of received and
3672 sent octets and packets, the length of the receive queue and the number of
3673 values handled. When set to B<true>, the I<Network plugin> will make these
3674 statistics available. Defaults to B<false>.
3678 =head2 Plugin C<nginx>
3680 This plugin collects the number of connections and requests handled by the
3681 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
3682 queries the page provided by the C<ngx_http_stub_status_module> module, which
3683 isn't compiled by default. Please refer to
3684 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
3685 how to compile and configure nginx and this module.
3687 The following options are accepted by the C<nginx plugin>:
3691 =item B<URL> I<http://host/nginx_status>
3693 Sets the URL of the C<ngx_http_stub_status_module> output.
3695 =item B<User> I<Username>
3697 Optional user name needed for authentication.
3699 =item B<Password> I<Password>
3701 Optional password needed for authentication.
3703 =item B<VerifyPeer> B<true|false>
3705 Enable or disable peer SSL certificate verification. See
3706 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
3708 =item B<VerifyHost> B<true|false>
3710 Enable or disable peer host name verification. If enabled, the plugin checks
3711 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
3712 certificate matches the host name provided by the B<URL> option. If this
3713 identity check fails, the connection is aborted. Obviously, only works when
3714 connecting to a SSL enabled server. Enabled by default.
3716 =item B<CACert> I<File>
3718 File that holds one or more SSL certificates. If you want to use HTTPS you will
3719 possibly need this option. What CA certificates come bundled with C<libcurl>
3720 and are checked by default depends on the distribution you use.
3724 =head2 Plugin C<notify_desktop>
3726 This plugin sends a desktop notification to a notification daemon, as defined
3727 in the Desktop Notification Specification. To actually display the
3728 notifications, B<notification-daemon> is required and B<collectd> has to be
3729 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
3730 environment variables have to be set correctly) and the D-Bus message bus.
3732 The Desktop Notification Specification can be found at
3733 L<http://www.galago-project.org/specs/notification/>.
3737 =item B<OkayTimeout> I<timeout>
3739 =item B<WarningTimeout> I<timeout>
3741 =item B<FailureTimeout> I<timeout>
3743 Set the I<timeout>, in milliseconds, after which to expire the notification
3744 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
3745 been specified, the displayed notification will not be closed at all - the
3746 user has to do so herself. These options default to 5000. If a negative number
3747 has been specified, the default is used as well.
3751 =head2 Plugin C<notify_email>
3753 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
3754 configured email address.
3756 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
3758 Available configuration options:
3762 =item B<From> I<Address>
3764 Email address from which the emails should appear to come from.
3766 Default: C<root@localhost>
3768 =item B<Recipient> I<Address>
3770 Configures the email address(es) to which the notifications should be mailed.
3771 May be repeated to send notifications to multiple addresses.
3773 At least one B<Recipient> must be present for the plugin to work correctly.
3775 =item B<SMTPServer> I<Hostname>
3777 Hostname of the SMTP server to connect to.
3779 Default: C<localhost>
3781 =item B<SMTPPort> I<Port>
3783 TCP port to connect to.
3787 =item B<SMTPUser> I<Username>
3789 Username for ASMTP authentication. Optional.
3791 =item B<SMTPPassword> I<Password>
3793 Password for ASMTP authentication. Optional.
3795 =item B<Subject> I<Subject>
3797 Subject-template to use when sending emails. There must be exactly two
3798 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
3799 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
3802 Default: C<Collectd notify: %s@%s>
3806 =head2 Plugin C<ntpd>
3810 =item B<Host> I<Hostname>
3812 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
3814 =item B<Port> I<Port>
3816 UDP-Port to connect to. Defaults to B<123>.
3818 =item B<ReverseLookups> B<true>|B<false>
3820 Sets whether or not to perform reverse lookups on peers. Since the name or
3821 IP-address may be used in a filename it is recommended to disable reverse
3822 lookups. The default is to do reverse lookups to preserve backwards
3823 compatibility, though.
3825 =item B<IncludeUnitID> B<true>|B<false>
3827 When a peer is a refclock, include the unit ID in the I<type instance>.
3828 Defaults to B<false> for backward compatibility.
3830 If two refclock peers use the same driver and this is B<false>, the plugin will
3831 try to write simultaneous measurements from both to the same type instance.
3832 This will result in error messages in the log and only one set of measurements
3837 =head2 Plugin C<nut>
3841 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
3843 Add a UPS to collect data from. The format is identical to the one accepted by
3848 =head2 Plugin C<olsrd>
3850 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
3851 the Optimized Link State Routing daemon and reads information about the current
3852 state of the meshed network.
3854 The following configuration options are understood:
3858 =item B<Host> I<Host>
3860 Connect to I<Host>. Defaults to B<"localhost">.
3862 =item B<Port> I<Port>
3864 Specifies the port to connect to. This must be a string, even if you give the
3865 port as a number rather than a service name. Defaults to B<"2006">.
3867 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
3869 Specifies what information to collect about links, i.E<nbsp>e. direct
3870 connections of the daemon queried. If set to B<No>, no information is
3871 collected. If set to B<Summary>, the number of links and the average of all
3872 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
3873 If set to B<Detail> LQ and NLQ are collected per link.
3875 Defaults to B<Detail>.
3877 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
3879 Specifies what information to collect about routes of the daemon queried. If
3880 set to B<No>, no information is collected. If set to B<Summary>, the number of
3881 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
3882 metric and ETX are collected per route.
3884 Defaults to B<Summary>.
3886 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
3888 Specifies what information to collect about the global topology. If set to
3889 B<No>, no information is collected. If set to B<Summary>, the number of links
3890 in the entire topology and the average I<link quality> (LQ) is calculated.
3891 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
3893 Defaults to B<Summary>.
3897 =head2 Plugin C<onewire>
3899 B<EXPERIMENTAL!> See notes below.
3901 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
3902 L<http://owfs.org/> to read sensors connected via the onewire bus.
3904 Currently only temperature sensors (sensors with the family code C<10>,
3905 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
3906 would like to have included, please send a sort request to the mailing list.
3908 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
3909 experimental, below.
3913 =item B<Device> I<Device>
3915 Sets the device to read the values from. This can either be a "real" hardware
3916 device, such as a serial port or an USB port, or the address of the
3917 L<owserver(1)> socket, usually B<localhost:4304>.
3919 Though the documentation claims to automatically recognize the given address
3920 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
3921 with that version, the following configuration worked for us:
3924 Device "-s localhost:4304"
3927 This directive is B<required> and does not have a default value.
3929 =item B<Sensor> I<Sensor>
3931 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
3932 below. Sensors are specified without the family byte at the beginning, to you'd
3933 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
3936 =item B<IgnoreSelected> I<true>|I<false>
3938 If no configuration if given, the B<onewire> plugin will collect data from all
3939 sensors found. This may not be practical, especially if sensors are added and
3940 removed regularly. Sometimes, however, it's easier/preferred to collect only
3941 specific sensors or all sensors I<except> a few specified ones. This option
3942 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
3943 B<Sensor> is inverted: All selected interfaces are ignored and all other
3944 interfaces are collected.
3946 =item B<Interval> I<Seconds>
3948 Sets the interval in which all sensors should be read. If not specified, the
3949 global B<Interval> setting is used.
3953 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
3954 work with big setups. It works with one sensor being attached to one
3955 controller, but as soon as you throw in a couple more senors and maybe a hub
3956 or two, reading all values will take more than ten seconds (the default
3957 interval). We will probably add some separate thread for reading the sensors
3958 and some cache or something like that, but it's not done yet. We will try to
3959 maintain backwards compatibility in the future, but we can't promise. So in
3960 short: If it works for you: Great! But keep in mind that the config I<might>
3961 change, though this is unlikely. Oh, and if you want to help improving this
3962 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
3964 =head2 Plugin C<openvpn>
3966 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
3967 traffic statistics about connected clients.
3969 To set up OpenVPN to write to the status file periodically, use the
3970 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
3971 you need to set the required format, too. This is done by setting
3972 B<--status-version> to B<2>.
3974 So, in a nutshell you need:
3976 openvpn $OTHER_OPTIONS \
3977 --status "/var/run/openvpn-status" 10 \
3984 =item B<StatusFile> I<File>
3986 Specifies the location of the status file.
3988 =item B<ImprovedNamingSchema> B<true>|B<false>
3990 When enabled, the filename of the status file will be used as plugin instance
3991 and the client's "common name" will be used as type instance. This is required
3992 when reading multiple status files. Enabling this option is recommended, but to
3993 maintain backwards compatibility this option is disabled by default.
3995 =item B<CollectCompression> B<true>|B<false>
3997 Sets whether or not statistics about the compression used by OpenVPN should be
3998 collected. This information is only available in I<single> mode. Enabled by
4001 =item B<CollectIndividualUsers> B<true>|B<false>
4003 Sets whether or not traffic information is collected for each connected client
4004 individually. If set to false, currently no traffic data is collected at all
4005 because aggregating this data in a save manner is tricky. Defaults to B<true>.
4007 =item B<CollectUserCount> B<true>|B<false>
4009 When enabled, the number of currently connected clients or users is collected.
4010 This is especially interesting when B<CollectIndividualUsers> is disabled, but
4011 can be configured independently from that option. Defaults to B<false>.
4015 =head2 Plugin C<oracle>
4017 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
4018 Oracle® Database and lets you execute SQL statements there. It is very similar
4019 to the "dbi" plugin, because it was written around the same time. See the "dbi"
4020 plugin's documentation above for details.
4023 <Query "out_of_stock">
4024 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
4027 # InstancePrefix "foo"
4028 InstancesFrom "category"
4032 <Database "product_information">
4036 Query "out_of_stock"
4040 =head3 B<Query> blocks
4042 The Query blocks are handled identically to the Query blocks of the "dbi"
4043 plugin. Please see its documentation above for details on how to specify
4046 =head3 B<Database> blocks
4048 Database blocks define a connection to a database and which queries should be
4049 sent to that database. Each database needs a "name" as string argument in the
4050 starting tag of the block. This name will be used as "PluginInstance" in the
4051 values submitted to the daemon. Other than that, that name is not used.
4055 =item B<ConnectID> I<ID>
4057 Defines the "database alias" or "service name" to connect to. Usually, these
4058 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
4060 =item B<Host> I<Host>
4062 Hostname to use when dispatching values for this database. Defaults to using
4063 the global hostname of the I<collectd> instance.
4065 =item B<Username> I<Username>
4067 Username used for authentication.
4069 =item B<Password> I<Password>
4071 Password used for authentication.
4073 =item B<Query> I<QueryName>
4075 Associates the query named I<QueryName> with this database connection. The
4076 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
4077 blocks you want to refer to must be placed above the database block you want to
4082 =head2 Plugin C<perl>
4084 This plugin embeds a Perl-interpreter into collectd and provides an interface
4085 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
4087 =head2 Plugin C<pinba>
4089 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
4090 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
4091 PHP-based webpage has been delivered, the extension will send a UDP packet
4092 containing timing information, peak memory usage and so on. The plugin will
4093 wait for such packets, parse them and account the provided information, which
4094 is then dispatched to the daemon once per interval.
4101 # Overall statistics for the website.
4103 Server "www.example.com"
4105 # Statistics for www-a only
4107 Host "www-a.example.com"
4108 Server "www.example.com"
4110 # Statistics for www-b only
4112 Host "www-b.example.com"
4113 Server "www.example.com"
4117 The plugin provides the following configuration options:
4121 =item B<Address> I<Node>
4123 Configures the address used to open a listening socket. By default, plugin will
4124 bind to the I<any> address C<::0>.
4126 =item B<Port> I<Service>
4128 Configures the port (service) to bind to. By default the default Pinba port
4129 "30002" will be used. The option accepts service names in addition to port
4130 numbers and thus requires a I<string> argument.
4132 =item E<lt>B<View> I<Name>E<gt> block
4134 The packets sent by the Pinba extension include the hostname of the server, the
4135 server name (the name of the virtual host) and the script that was executed.
4136 Using B<View> blocks it is possible to separate the data into multiple groups
4137 to get more meaningful statistics. Each packet is added to all matching groups,
4138 so that a packet may be accounted for more than once.
4142 =item B<Host> I<Host>
4144 Matches the hostname of the system the webserver / script is running on. This
4145 will contain the result of the L<gethostname(2)> system call. If not
4146 configured, all hostnames will be accepted.
4148 =item B<Server> I<Server>
4150 Matches the name of the I<virtual host>, i.e. the contents of the
4151 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
4152 server names will be accepted.
4154 =item B<Script> I<Script>
4156 Matches the name of the I<script name>, i.e. the contents of the
4157 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
4158 script names will be accepted.
4164 =head2 Plugin C<ping>
4166 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
4167 configured hosts periodically and measures the network latency. Whenever the
4168 C<read> function of the plugin is called, it submits the average latency, the
4169 standard deviation and the drop rate for each host.
4171 Available configuration options:
4175 =item B<Host> I<IP-address>
4177 Host to ping periodically. This option may be repeated several times to ping
4180 =item B<Interval> I<Seconds>
4182 Sets the interval in which to send ICMP echo packets to the configured hosts.
4183 This is B<not> the interval in which statistics are queries from the plugin but
4184 the interval in which the hosts are "pinged". Therefore, the setting here
4185 should be smaller than or equal to the global B<Interval> setting. Fractional
4186 times, such as "1.24" are allowed.
4190 =item B<Timeout> I<Seconds>
4192 Time to wait for a response from the host to which an ICMP packet had been
4193 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
4194 to be down or the packet to be dropped. This setting must be smaller than the
4195 B<Interval> setting above for the plugin to work correctly. Fractional
4196 arguments are accepted.
4200 =item B<TTL> I<0-255>
4202 Sets the Time-To-Live of generated ICMP packets.
4204 =item B<SourceAddress> I<host>
4206 Sets the source address to use. I<host> may either be a numerical network
4207 address or a network hostname.
4209 =item B<Device> I<name>
4211 Sets the outgoing network device to be used. I<name> has to specify an
4212 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
4215 =item B<MaxMissed> I<Packets>
4217 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
4218 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
4220 Default: B<-1> (disabled)
4224 =head2 Plugin C<postgresql>
4226 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
4227 keeps a persistent connection to all configured databases and tries to
4228 reconnect if the connection has been interrupted. A database is configured by
4229 specifying a B<Database> block as described below. The default statistics are
4230 collected from PostgreSQL's B<statistics collector> which thus has to be
4231 enabled for this plugin to work correctly. This should usually be the case by
4232 default. See the section "The Statistics Collector" of the B<PostgreSQL
4233 Documentation> for details.
4235 By specifying custom database queries using a B<Query> block as described
4236 below, you may collect any data that is available from some PostgreSQL
4237 database. This way, you are able to access statistics of external daemons
4238 which are available in a PostgreSQL database or use future or special
4239 statistics provided by PostgreSQL without the need to upgrade your collectd
4242 Starting with version 5.2, the C<postgresql> plugin supports writing data to
4243 PostgreSQL databases as well. This has been implemented in a generic way. You
4244 need to specify an SQL statement which will then be executed by collectd in
4245 order to write the data (see below for details). The benefit of that approach
4246 is that there is no fixed database layout. Rather, the layout may be optimized
4247 for the current setup.
4249 The B<PostgreSQL Documentation> manual can be found at
4250 L<http://www.postgresql.org/docs/manuals/>.
4254 Statement "SELECT magic FROM wizard WHERE host = $1;"
4258 InstancePrefix "magic"
4263 <Query rt36_tickets>
4264 Statement "SELECT COUNT(type) AS count, type \
4266 WHEN resolved = 'epoch' THEN 'open' \
4267 ELSE 'resolved' END AS type \
4268 FROM tickets) type \
4272 InstancePrefix "rt36_tickets"
4273 InstancesFrom "type"
4279 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
4289 KRBSrvName "kerberos_service_name"
4295 Service "service_name"
4296 Query backend # predefined
4307 The B<Query> block defines one database query which may later be used by a
4308 database definition. It accepts a single mandatory argument which specifies
4309 the name of the query. The names of all queries have to be unique (see the
4310 B<MinVersion> and B<MaxVersion> options below for an exception to this
4311 rule). The following configuration options are available to define the query:
4313 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
4314 blocks define how to handle the values returned from the query. They define
4315 which column holds which value and how to dispatch that value to the daemon.
4316 Multiple B<Result> blocks may be used to extract multiple values from a single
4321 =item B<Statement> I<sql query statement>
4323 Specify the I<sql query statement> which the plugin should execute. The string
4324 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
4325 first, second, etc. parameter. The value of the parameters is specified by the
4326 B<Param> configuration option - see below for details. To include a literal
4327 B<$> character followed by a number, surround it with single quotes (B<'>).
4329 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
4330 allowed. Note, however, that only a single command may be used. Semicolons are
4331 allowed as long as a single non-empty command has been specified only.
4333 The returned lines will be handled separately one after another.
4335 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4337 Specify the parameters which should be passed to the SQL query. The parameters
4338 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4339 they appear in the configuration file. The value of the parameter is
4340 determined depending on the value of the B<Param> option as follows:
4346 The configured hostname of the database connection. If a UNIX domain socket is
4347 used, the parameter expands to "localhost".
4351 The name of the database of the current connection.
4355 The name of the database plugin instance. See the B<Instance> option of the
4356 database specification below for details.
4360 The username used to connect to the database.
4364 The interval with which this database is queried (as specified by the database
4365 specific or global B<Interval> options).
4369 Please note that parameters are only supported by PostgreSQL's protocol
4370 version 3 and above which was introduced in version 7.4 of PostgreSQL.
4372 =item B<Type> I<type>
4374 The I<type> name to be used when dispatching the values. The type describes
4375 how to handle the data and where to store it. See L<types.db(5)> for more
4376 details on types and their configuration. The number and type of values (as
4377 selected by the B<ValuesFrom> option) has to match the type of the given name.
4379 This option is required inside a B<Result> block.
4381 =item B<InstancePrefix> I<prefix>
4383 =item B<InstancesFrom> I<column0> [I<column1> ...]
4385 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
4386 B<InstancePrefix> defines a static prefix that will be prepended to all type
4387 instances. B<InstancesFrom> defines the column names whose values will be used
4388 to create the type instance. Multiple values will be joined together using the
4389 hyphen (C<->) as separation character.
4391 The plugin itself does not check whether or not all built instances are
4392 different. It is your responsibility to assure that each is unique.
4394 Both options are optional. If none is specified, the type instance will be
4397 =item B<ValuesFrom> I<column0> [I<column1> ...]
4399 Names the columns whose content is used as the actual data for the data sets
4400 that are dispatched to the daemon. How many such columns you need is
4401 determined by the B<Type> setting as explained above. If you specify too many
4402 or not enough columns, the plugin will complain about that and no data will be
4403 submitted to the daemon.
4405 The actual data type, as seen by PostgreSQL, is not that important as long as
4406 it represents numbers. The plugin will automatically cast the values to the
4407 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
4408 L<strtod(3)> functions, so anything supported by those functions is supported
4409 by the plugin as well.
4411 This option is required inside a B<Result> block and may be specified multiple
4412 times. If multiple B<ValuesFrom> options are specified, the columns are read
4415 =item B<MinVersion> I<version>
4417 =item B<MaxVersion> I<version>
4419 Specify the minimum or maximum version of PostgreSQL that this query should be
4420 used with. Some statistics might only be available with certain versions of
4421 PostgreSQL. This allows you to specify multiple queries with the same name but
4422 which apply to different versions, thus allowing you to use the same
4423 configuration in a heterogeneous environment.
4425 The I<version> has to be specified as the concatenation of the major, minor
4426 and patch-level versions, each represented as two-decimal-digit numbers. For
4427 example, version 8.2.3 will become 80203.
4431 The following predefined queries are available (the definitions can be found
4432 in the F<postgresql_default.conf> file which, by default, is available at
4433 C<I<prefix>/share/collectd/>):
4439 This query collects the number of backends, i.E<nbsp>e. the number of
4442 =item B<transactions>
4444 This query collects the numbers of committed and rolled-back transactions of
4449 This query collects the numbers of various table modifications (i.E<nbsp>e.
4450 insertions, updates, deletions) of the user tables.
4452 =item B<query_plans>
4454 This query collects the numbers of various table scans and returned tuples of
4457 =item B<table_states>
4459 This query collects the numbers of live and dead rows in the user tables.
4463 This query collects disk block access counts for user tables.
4467 This query collects the on-disk size of the database in bytes.
4471 In addition, the following detailed queries are available by default. Please
4472 note that each of those queries collects information B<by table>, thus,
4473 potentially producing B<a lot> of data. For details see the description of the
4474 non-by_table queries above.
4478 =item B<queries_by_table>
4480 =item B<query_plans_by_table>
4482 =item B<table_states_by_table>
4484 =item B<disk_io_by_table>
4488 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
4489 mandatory argument specifying the name of the writer. This will then be used
4490 in the B<Database> specification in order to activate the writer instance. The
4491 names of all writers have to be unique. The following options may be
4496 =item B<Statement> I<sql statement>
4498 This mandatory option specifies the SQL statement that will be executed for
4499 each submitted value. A single SQL statement is allowed only. Anything after
4500 the first semicolon will be ignored.
4502 Nine parameters will be passed to the statement and should be specified as
4503 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
4504 values are made available through those parameters:
4510 The timestamp of the queried value as a floating point number.
4514 The hostname of the queried value.
4518 The plugin name of the queried value.
4522 The plugin instance of the queried value. This value may be B<NULL> if there
4523 is no plugin instance.
4527 The type of the queried value (cf. L<types.db(5)>).
4531 The type instance of the queried value. This value may be B<NULL> if there is
4536 An array of names for the submitted values (i.E<nbsp>e., the name of the data
4537 sources of the submitted value-list).
4541 An array of types for the submitted values (i.E<nbsp>e., the type of the data
4542 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
4543 B<StoreRates> is enabled (which is the default, see below), all types will be
4548 An array of the submitted values. The dimensions of the value name and value
4553 In general, it is advisable to create and call a custom function in the
4554 PostgreSQL database for this purpose. Any procedural language supported by
4555 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
4558 =item B<StoreRates> B<false>|B<true>
4560 If set to B<true> (the default), convert counter values to rates. If set to
4561 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
4566 The B<Database> block defines one PostgreSQL database for which to collect
4567 statistics. It accepts a single mandatory argument which specifies the
4568 database name. None of the other options are required. PostgreSQL will use
4569 default values as documented in the section "CONNECTING TO A DATABASE" in the
4570 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
4571 the user collectd is run as and special environment variables. See the manpage
4576 =item B<Interval> I<seconds>
4578 Specify the interval with which the database should be queried. The default is
4579 to use the global B<Interval> setting.
4581 =item B<CommitInterval> I<seconds>
4583 This option may be used for database connections which have "writers" assigned
4584 (see above). If specified, it causes a writer to put several updates into a
4585 single transaction. This transaction will last for the specified amount of
4586 time. By default, each update will be executed in a separate transaction. Each
4587 transaction generates a fair amount of overhead which can, thus, be reduced by
4588 activating this option. The draw-back is, that data covering the specified
4589 amount of time will be lost, for example, if a single statement within the
4590 transaction fails or if the database server crashes.
4592 =item B<Host> I<hostname>
4594 Specify the hostname or IP of the PostgreSQL server to connect to. If the
4595 value begins with a slash, it is interpreted as the directory name in which to
4596 look for the UNIX domain socket.
4598 This option is also used to determine the hostname that is associated with a
4599 collected data set. If it has been omitted or either begins with with a slash
4600 or equals B<localhost> it will be replaced with the global hostname definition
4601 of collectd. Any other value will be passed literally to collectd when
4602 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
4604 =item B<Port> I<port>
4606 Specify the TCP port or the local UNIX domain socket file extension of the
4609 =item B<User> I<username>
4611 Specify the username to be used when connecting to the server.
4613 =item B<Password> I<password>
4615 Specify the password to be used when connecting to the server.
4617 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
4619 Specify whether to use an SSL connection when contacting the server. The
4620 following modes are supported:
4622 =item B<Instance> I<name>
4624 Specify the plugin instance name that should be used instead of the database
4625 name (which is the default, if this option has not been specified). This
4626 allows to query multiple databases of the same name on the same host (e.g.
4627 when running multiple database server versions in parallel).
4633 Do not use SSL at all.
4637 First, try to connect without using SSL. If that fails, try using SSL.
4639 =item I<prefer> (default)
4641 First, try to connect using SSL. If that fails, try without using SSL.
4649 =item B<KRBSrvName> I<kerberos_service_name>
4651 Specify the Kerberos service name to use when authenticating with Kerberos 5
4652 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
4653 B<PostgreSQL Documentation> for details.
4655 =item B<Service> I<service_name>
4657 Specify the PostgreSQL service name to use for additional parameters. That
4658 service has to be defined in F<pg_service.conf> and holds additional
4659 connection parameters. See the section "The Connection Service File" in the
4660 B<PostgreSQL Documentation> for details.
4662 =item B<Query> I<query>
4664 Specifies a I<query> which should be executed in the context of the database
4665 connection. This may be any of the predefined or user-defined queries. If no
4666 such option is given, it defaults to "backends", "transactions", "queries",
4667 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
4668 has been specified). Else, the specified queries are used only.
4670 =item B<Writer> I<writer>
4672 Assigns the specified I<writer> backend to the database connection. This
4673 causes all collected data to be send to the database using the settings
4674 defined in the writer configuration (see the section "FILTER CONFIGURATION"
4675 below for details on how to selectively send data to certain plugins).
4677 Each writer will register a flush callback which may be used when having long
4678 transactions enabled (see the B<CommitInterval> option above). When issuing
4679 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
4680 transaction will be committed right away. Two different kinds of flush
4681 callbacks are available with the C<postgresql> plugin:
4687 Flush all writer backends.
4689 =item B<postgresql->I<database>
4691 Flush all writers of the specified I<database> only.
4697 =head2 Plugin C<powerdns>
4699 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
4700 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
4701 values, many of which are probably meaningless to most users, but may be useful
4702 for some. So you may chose which values to collect, but if you don't, some
4703 reasonable defaults will be collected.
4706 <Server "server_name">
4708 Collect "udp-answers" "udp-queries"
4709 Socket "/var/run/pdns.controlsocket"
4711 <Recursor "recursor_name">
4713 Collect "cache-hits" "cache-misses"
4714 Socket "/var/run/pdns_recursor.controlsocket"
4716 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
4721 =item B<Server> and B<Recursor> block
4723 The B<Server> block defines one authoritative server to query, the B<Recursor>
4724 does the same for an recursing server. The possible options in both blocks are
4725 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
4730 =item B<Collect> I<Field>
4732 Using the B<Collect> statement you can select which values to collect. Here,
4733 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
4734 C<dlg-only-drops>, C<answers10-100>.
4736 The method of getting the values differs for B<Server> and B<Recursor> blocks:
4737 When querying the server a C<SHOW *> command is issued in any case, because
4738 that's the only way of getting multiple values out of the server at once.
4739 collectd then picks out the values you have selected. When querying the
4740 recursor, a command is generated to query exactly these values. So if you
4741 specify invalid fields when querying the recursor, a syntax error may be
4742 returned by the daemon and collectd may not collect any values at all.
4744 If no B<Collect> statement is given, the following B<Server> values will be
4751 =item packetcache-hit
4753 =item packetcache-miss
4755 =item packetcache-size
4757 =item query-cache-hit
4759 =item query-cache-miss
4761 =item recursing-answers
4763 =item recursing-questions
4775 The following B<Recursor> values will be collected by default:
4779 =item noerror-answers
4781 =item nxdomain-answers
4783 =item servfail-answers
4801 Please note that up to that point collectd doesn't know what values are
4802 available on the server and values that are added do not need a change of the
4803 mechanism so far. However, the values must be mapped to collectd's naming
4804 scheme, which is done using a lookup table that lists all known values. If
4805 values are added in the future and collectd does not know about them, you will
4806 get an error much like this:
4808 powerdns plugin: submit: Not found in lookup table: foobar = 42
4810 In this case please file a bug report with the collectd team.
4812 =item B<Socket> I<Path>
4814 Configures the path to the UNIX domain socket to be used when connecting to the
4815 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
4816 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
4817 will be used for the recursor.
4821 =item B<LocalSocket> I<Path>
4823 Querying the recursor is done using UDP. When using UDP over UNIX domain
4824 sockets, the client socket needs a name in the file system, too. You can set
4825 this local name to I<Path> using the B<LocalSocket> option. The default is
4826 C<I<prefix>/var/run/collectd-powerdns>.
4830 =head2 Plugin C<processes>
4834 =item B<Process> I<Name>
4836 Select more detailed statistics of processes matching this name. The statistics
4837 collected for these selected processes are size of the resident segment size
4838 (RSS), user- and system-time used, number of processes and number of threads,
4839 io data (where available) and minor and major pagefaults.
4841 =item B<ProcessMatch> I<name> I<regex>
4843 Similar to the B<Process> option this allows to select more detailed
4844 statistics of processes matching the specified I<regex> (see L<regex(7)> for
4845 details). The statistics of all matching processes are summed up and
4846 dispatched to the daemon using the specified I<name> as an identifier. This
4847 allows to "group" several processes together. I<name> must not contain
4852 =head2 Plugin C<protocols>
4854 Collects a lot of information about various network protocols, such as I<IP>,
4855 I<TCP>, I<UDP>, etc.
4857 Available configuration options:
4861 =item B<Value> I<Selector>
4863 Selects whether or not to select a specific value. The string being matched is
4864 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
4865 plugin instance and I<ValueName> will be used as type instance. An example of
4866 the string being used would be C<Tcp:RetransSegs>.
4868 You can use regular expressions to match a large number of values with just one
4869 configuration option. To select all "extended" I<TCP> values, you could use the
4870 following statement:
4874 Whether only matched values are selected or all matched values are ignored
4875 depends on the B<IgnoreSelected>. By default, only matched values are selected.
4876 If no value is configured at all, all values will be selected.
4878 =item B<IgnoreSelected> B<true>|B<false>
4880 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
4881 matching values will be ignored.
4885 =head2 Plugin C<python>
4887 This plugin embeds a Python-interpreter into collectd and provides an interface
4888 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
4890 =head2 Plugin C<routeros>
4892 The C<routeros> plugin connects to a device running I<RouterOS>, the
4893 Linux-based operating system for routers by I<MikroTik>. The plugin uses
4894 I<librouteros> to connect and reads information about the interfaces and
4895 wireless connections of the device. The configuration supports querying
4900 Host "router0.example.com"
4903 CollectInterface true
4908 Host "router1.example.com"
4911 CollectInterface true
4912 CollectRegistrationTable true
4918 As you can see above, the configuration of the I<routeros> plugin consists of
4919 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
4920 options are understood:
4924 =item B<Host> I<Host>
4926 Hostname or IP-address of the router to connect to.
4928 =item B<Port> I<Port>
4930 Port name or port number used when connecting. If left unspecified, the default
4931 will be chosen by I<librouteros>, currently "8728". This option expects a
4932 string argument, even when a numeric port number is given.
4934 =item B<User> I<User>
4936 Use the user name I<User> to authenticate. Defaults to "admin".
4938 =item B<Password> I<Password>
4940 Set the password used to authenticate.
4942 =item B<CollectInterface> B<true>|B<false>
4944 When set to B<true>, interface statistics will be collected for all interfaces
4945 present on the device. Defaults to B<false>.
4947 =item B<CollectRegistrationTable> B<true>|B<false>
4949 When set to B<true>, information about wireless LAN connections will be
4950 collected. Defaults to B<false>.
4952 =item B<CollectCPULoad> B<true>|B<false>
4954 When set to B<true>, information about the CPU usage will be collected. The
4955 number is a dimensionless value where zero indicates no CPU usage at all.
4956 Defaults to B<false>.
4958 =item B<CollectMemory> B<true>|B<false>
4960 When enabled, the amount of used and free memory will be collected. How used
4961 memory is calculated is unknown, for example whether or not caches are counted
4963 Defaults to B<false>.
4965 =item B<CollectDF> B<true>|B<false>
4967 When enabled, the amount of used and free disk space will be collected.
4968 Defaults to B<false>.
4970 =item B<CollectDisk> B<true>|B<false>
4972 When enabled, the number of sectors written and bad blocks will be collected.
4973 Defaults to B<false>.
4977 =head2 Plugin C<redis>
4979 The I<Redis plugin> connects to one or more Redis servers and gathers
4980 information about each server's state. For each server there is a I<Node> block
4981 which configures the connection parameters for this node.
4991 The information shown in the synopsis above is the I<default configuration>
4992 which is used by the plugin if no configuration is present.
4996 =item B<Node> I<Nodename>
4998 The B<Node> block identifies a new Redis node, that is a new Redis instance
4999 running in an specified host and port. The name for node is a canonical
5000 identifier which is used as I<plugin instance>. It is limited to
5001 64E<nbsp>characters in length.
5003 =item B<Host> I<Hostname>
5005 The B<Host> option is the hostname or IP-address where the Redis instance is
5008 =item B<Port> I<Port>
5010 The B<Port> option is the TCP port on which the Redis instance accepts
5011 connections. Either a service name of a port number may be given. Please note
5012 that numerical port numbers must be given as a string, too.
5014 =item B<Password> I<Password>
5016 Use I<Password> to authenticate when connecting to I<Redis>.
5018 =item B<Timeout> I<Timeout in miliseconds>
5020 The B<Timeout> option set the socket timeout for node response. Since the Redis
5021 read function is blocking, you should keep this value as low as possible. Keep
5022 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
5023 than B<Interval> defined globally.
5027 =head2 Plugin C<rrdcached>
5029 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
5030 to store values to RRD files in an efficient manner. The combination of the
5031 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
5032 way the C<rrdtool> plugin works (see below). The added abstraction layer
5033 provides a number of benefits, though: Because the cache is not within
5034 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
5035 restarted. This results in much shorter (if any) gaps in graphs, especially
5036 under heavy load. Also, the C<rrdtool> command line utility is aware of the
5037 daemon so that it can flush values to disk automatically when needed. This
5038 allows to integrate automated flushing of values into graphing solutions much
5041 There are disadvantages, though: The daemon may reside on a different host, so
5042 it may not be possible for C<collectd> to create the appropriate RRD files
5043 anymore. And even if C<rrdcached> runs on the same host, it may run in a
5044 different base directory, so relative paths may do weird stuff if you're not
5047 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
5048 on the same host, communicating via a UNIX domain socket. The B<DataDir>
5049 setting should be set to an absolute path, so that a changed base directory
5050 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
5054 =item B<DaemonAddress> I<Address>
5056 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
5057 library. See L<rrdcached(1)> for details. Example:
5059 <Plugin "rrdcached">
5060 DaemonAddress "unix:/var/run/rrdcached.sock"
5063 =item B<DataDir> I<Directory>
5065 Set the base directory in which the RRD files reside. If this is a relative
5066 path, it is relative to the working base directory of the C<rrdcached> daemon!
5067 Use of an absolute path is recommended.
5069 =item B<CreateFiles> B<true>|B<false>
5071 Enables or disables the creation of RRD files. If the daemon is not running
5072 locally, or B<DataDir> is set to a relative path, this will not work as
5073 expected. Default is B<true>.
5075 =item B<CreateFilesAsync> B<false>|B<true>
5077 When enabled, new RRD files are enabled asynchronously, using a separate thread
5078 that runs in the background. This prevents writes to block, which is a problem
5079 especially when many hundreds of files need to be created at once. However,
5080 since the purpose of creating the files asynchronously is I<not> to block until
5081 the file is available, values before the file is available will be discarded.
5082 When disabled (the default) files are created synchronously, blocking for a
5083 short while, while the file is being written.
5085 =item B<StepSize> I<Seconds>
5087 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5088 this setting is unset and the stepsize is set to the interval in which the data
5089 is collected. Do not use this option unless you absolutely have to for some
5090 reason. Setting this option may cause problems with the C<snmp plugin>, the
5091 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5093 =item B<HeartBeat> I<Seconds>
5095 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5096 in which case the heartbeat is set to twice the B<StepSize> which should equal
5097 the interval in which data is collected. Do not set this option unless you have
5098 a very good reason to do so.
5100 =item B<RRARows> I<NumRows>
5102 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5103 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5104 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5105 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5106 week, one month, and one year.
5108 So for each timespan, it calculates how many PDPs need to be consolidated into
5109 one CDP by calculating:
5110 number of PDPs = timespan / (stepsize * rrarows)
5112 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5115 =item B<RRATimespan> I<Seconds>
5117 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5118 more then one RRA. If this option is never used, the built-in default of (3600,
5119 86400, 604800, 2678400, 31622400) is used.
5121 For more information on how RRA-sizes are calculated see B<RRARows> above.
5123 =item B<XFF> I<Factor>
5125 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5126 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5131 =head2 Plugin C<rrdtool>
5133 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
5134 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
5135 using these settings. If you don't want to dive into the depths of RRDtool, you
5136 can safely ignore these settings.
5140 =item B<DataDir> I<Directory>
5142 Set the directory to store RRD files under. By default RRD files are generated
5143 beneath the daemon's working directory, i.e. the B<BaseDir>.
5145 =item B<CreateFilesAsync> B<false>|B<true>
5147 When enabled, new RRD files are enabled asynchronously, using a separate thread
5148 that runs in the background. This prevents writes to block, which is a problem
5149 especially when many hundreds of files need to be created at once. However,
5150 since the purpose of creating the files asynchronously is I<not> to block until
5151 the file is available, values before the file is available will be discarded.
5152 When disabled (the default) files are created synchronously, blocking for a
5153 short while, while the file is being written.
5155 =item B<StepSize> I<Seconds>
5157 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5158 this setting is unset and the stepsize is set to the interval in which the data
5159 is collected. Do not use this option unless you absolutely have to for some
5160 reason. Setting this option may cause problems with the C<snmp plugin>, the
5161 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5163 =item B<HeartBeat> I<Seconds>
5165 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5166 in which case the heartbeat is set to twice the B<StepSize> which should equal
5167 the interval in which data is collected. Do not set this option unless you have
5168 a very good reason to do so.
5170 =item B<RRARows> I<NumRows>
5172 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5173 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5174 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5175 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5176 week, one month, and one year.
5178 So for each timespan, it calculates how many PDPs need to be consolidated into
5179 one CDP by calculating:
5180 number of PDPs = timespan / (stepsize * rrarows)
5182 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5185 =item B<RRATimespan> I<Seconds>
5187 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5188 more then one RRA. If this option is never used, the built-in default of (3600,
5189 86400, 604800, 2678400, 31622400) is used.
5191 For more information on how RRA-sizes are calculated see B<RRARows> above.
5193 =item B<XFF> I<Factor>
5195 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5196 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5199 =item B<CacheFlush> I<Seconds>
5201 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
5202 it writes all values for a certain RRD-file if the oldest value is older than
5203 (or equal to) the number of seconds specified. If some RRD-file is not updated
5204 anymore for some reason (the computer was shut down, the network is broken,
5205 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
5206 entire cache is searched for entries older than B<CacheTimeout> seconds and
5207 written to disk every I<Seconds> seconds. Since this is kind of expensive and
5208 does nothing under normal circumstances, this value should not be too small.
5209 900 seconds might be a good value, though setting this to 7200 seconds doesn't
5210 normally do much harm either.
5212 =item B<CacheTimeout> I<Seconds>
5214 If this option is set to a value greater than zero, the C<rrdtool plugin> will
5215 save values in a cache, as described above. Writing multiple values at once
5216 reduces IO-operations and thus lessens the load produced by updating the files.
5217 The trade off is that the graphs kind of "drag behind" and that more memory is
5220 =item B<WritesPerSecond> I<Updates>
5222 When collecting many statistics with collectd and the C<rrdtool> plugin, you
5223 will run serious performance problems. The B<CacheFlush> setting and the
5224 internal update queue assert that collectd continues to work just fine even
5225 under heavy load, but the system may become very unresponsive and slow. This is
5226 a problem especially if you create graphs from the RRD files on the same
5227 machine, for example using the C<graph.cgi> script included in the
5228 C<contrib/collection3/> directory.
5230 This setting is designed for very large setups. Setting this option to a value
5231 between 25 and 80 updates per second, depending on your hardware, will leave
5232 the server responsive enough to draw graphs even while all the cached values
5233 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
5234 by the B<FLUSH> command, are B<not> effected by this limit. They are still
5235 written as fast as possible, so that web frontends have up to date data when
5238 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
5239 updates per second, writing all values to disk will take approximately
5240 56E<nbsp>minutes. Together with the flushing ability that's integrated into
5241 "collection3" you'll end up with a responsive and fast system, up to date
5242 graphs and basically a "backup" of your values every hour.
5244 =item B<RandomTimeout> I<Seconds>
5246 When set, the actual timeout for each value is chosen randomly between
5247 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
5248 intention is to avoid high load situations that appear when many values timeout
5249 at the same time. This is especially a problem shortly after the daemon starts,
5250 because all values were added to the internal cache at roughly the same time.
5254 =head2 Plugin C<sensors>
5256 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
5257 that all the needed modules have to be loaded and lm_sensors has to be
5258 configured (most likely by editing F</etc/sensors.conf>. Read
5259 L<sensors.conf(5)> for details.
5261 The B<lm_sensors> homepage can be found at
5262 L<http://secure.netroedge.com/~lm78/>.
5266 =item B<SensorConfigFile> I<File>
5268 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
5269 the library's default will be used.
5271 =item B<Sensor> I<chip-bus-address/type-feature>
5273 Selects the name of the sensor which you want to collect or ignore, depending
5274 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
5275 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
5276 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
5278 =item B<IgnoreSelected> I<true>|I<false>
5280 If no configuration if given, the B<sensors>-plugin will collect data from all
5281 sensors. This may not be practical, especially for uninteresting sensors.
5282 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
5283 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
5284 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
5285 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
5286 and all other sensors are collected.
5290 =head2 Plugin C<sigrok>
5292 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
5293 supported by the L<sigrok|http://sigrok.org/> project.
5299 <Device "AC Voltage">
5304 <Device "Sound Level">
5305 Driver "cem-dt-885x"
5312 =item B<LogLevel> B<0-5>
5314 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
5315 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
5316 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
5317 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
5318 their level, are always submitted to I<collectd> at its INFO log level.
5320 =item E<lt>B<Device> I<Name>E<gt>
5322 A sigrok-supported device, uniquely identified by this section's options. The
5323 I<Name> is passed to I<collectd> as the I<plugin instance>.
5325 =item B<Driver> I<DriverName>
5327 The sigrok driver to use for this device.
5329 =item B<Conn> I<ConnectionSpec>
5331 If the device cannot be auto-discovered, or more than one might be discovered
5332 by the driver, I<ConnectionSpec> specifies the connection string to the device.
5333 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
5334 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
5335 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
5336 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
5338 =item B<SerialComm> I<SerialSpec>
5340 For serial devices with non-standard port settings, this option can be used
5341 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
5342 This should not be necessary; drivers know how to communicate with devices they
5345 =item B<MinimumInterval> I<Seconds>
5347 Specifies the minimum time between measurement dispatches to I<collectd>, in
5348 seconds. Since some I<sigrok> supported devices can acquire measurements many
5349 times per second, it may be necessary to throttle these. For example, the
5350 I<RRD plugin> cannot process writes more than once per second.
5352 The default B<MinimumInterval> is B<0>, meaning measurements received from the
5353 device are always dispatched to I<collectd>. When throttled, unused
5354 measurements are discarded.
5358 =head2 Plugin C<snmp>
5360 Since the configuration of the C<snmp plugin> is a little more complicated than
5361 other plugins, its documentation has been moved to an own manpage,
5362 L<collectd-snmp(5)>. Please see there for details.
5364 =head2 Plugin C<statsd>
5366 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
5367 protocol and dispatches rates or other aggregates of these numbers
5370 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
5371 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
5372 C<objects> respectively.
5374 The following configuration options are valid:
5378 =item B<Host> I<Host>
5380 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
5381 "any" address, i.e. accept packets sent to any of the hosts addresses.
5383 =item B<Port> I<Port>
5385 UDP port to listen to. This can be either a service name or a port number.
5386 Defaults to C<8125>.
5388 =item B<DeleteCounters> B<false>|B<true>
5390 =item B<DeleteTimers> B<false>|B<true>
5392 =item B<DeleteGauges> B<false>|B<true>
5394 =item B<DeleteSets> B<false>|B<true>
5396 These options control what happens if metrics are not updated in an interval.
5397 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
5398 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
5399 are unchanged. If set to B<True>, the such metrics are not dispatched and
5400 removed from the internal cache.
5402 =item B<TimerPercentile> I<Percent>
5404 Calculate and dispatch the configured percentile, i.e. compute the latency, so
5405 that I<Percent> of all reported timers are smaller than or equal to the
5406 computed latency. This is useful for cutting off the long tail latency, as it's
5407 often done in I<Service Level Agreements> (SLAs).
5409 If not specified, no percentile is calculated / dispatched.
5413 =head2 Plugin C<swap>
5415 The I<Swap plugin> collects information about used and available swap space. On
5416 I<Linux> and I<Solaris>, the following options are available:
5420 =item B<ReportByDevice> B<false>|B<true>
5422 Configures how to report physical swap devices. If set to B<false> (the
5423 default), the summary over all swap devices is reported only, i.e. the globally
5424 used and available space over all devices. If B<true> is configured, the used
5425 and available space of each device will be reported separately.
5427 This option is only available if the I<Swap plugin> can read C</proc/swaps>
5428 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
5430 =item B<ReportBytes> B<false>|B<true>
5432 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
5433 I<swap I/O> is reported in pages. This option is available under Linux only.
5435 =item B<ValuesAbsolute> B<true>|B<false>
5437 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
5438 available and used. Defaults to B<true>.
5440 =item B<ValuesPercentage> B<false>|B<true>
5442 Enables or disables reporting of relative swap metrics, i.e. I<percent>
5443 available and free. Defaults to B<false>.
5445 This is useful for deploying I<collectd> in a heterogeneous environment, where
5446 swap sizes differ and you want to specify generic thresholds or similar.
5450 =head2 Plugin C<syslog>
5454 =item B<LogLevel> B<debug|info|notice|warning|err>
5456 Sets the log-level. If, for example, set to B<notice>, then all events with
5457 severity B<notice>, B<warning>, or B<err> will be submitted to the
5460 Please note that B<debug> is only available if collectd has been compiled with
5463 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
5465 Controls which notifications should be sent to syslog. The default behaviour is
5466 not to send any. Less severe notifications always imply logging more severe
5467 notifications: Setting this to B<OKAY> means all notifications will be sent to
5468 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
5469 notifications but will dismiss B<OKAY> notifications. Setting this option to
5470 B<FAILURE> will only send failures to syslog.
5474 =head2 Plugin C<table>
5476 The C<table plugin> provides generic means to parse tabular data and dispatch
5477 user specified values. Values are selected based on column numbers. For
5478 example, this plugin may be used to get values from the Linux L<proc(5)>
5479 filesystem or CSV (comma separated values) files.
5482 <Table "/proc/slabinfo">
5487 InstancePrefix "active_objs"
5493 InstancePrefix "objperslab"
5500 The configuration consists of one or more B<Table> blocks, each of which
5501 configures one file to parse. Within each B<Table> block, there are one or
5502 more B<Result> blocks, which configure which data to select and how to
5505 The following options are available inside a B<Table> block:
5509 =item B<Instance> I<instance>
5511 If specified, I<instance> is used as the plugin instance. So, in the above
5512 example, the plugin name C<table-slabinfo> would be used. If omitted, the
5513 filename of the table is used instead, with all special characters replaced
5514 with an underscore (C<_>).
5516 =item B<Separator> I<string>
5518 Any character of I<string> is interpreted as a delimiter between the different
5519 columns of the table. A sequence of two or more contiguous delimiters in the
5520 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
5521 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
5522 of a table - see its documentation for more details. This option is mandatory.
5524 A horizontal tab, newline and carriage return may be specified by C<\\t>,
5525 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
5526 required because of collectd's config parsing.
5530 The following options are available inside a B<Result> block:
5534 =item B<Type> I<type>
5536 Sets the type used to dispatch the values to the daemon. Detailed information
5537 about types and their configuration can be found in L<types.db(5)>. This
5538 option is mandatory.
5540 =item B<InstancePrefix> I<prefix>
5542 If specified, prepend I<prefix> to the type instance. If omitted, only the
5543 B<InstancesFrom> option is considered for the type instance.
5545 =item B<InstancesFrom> I<column0> [I<column1> ...]
5547 If specified, the content of the given columns (identified by the column
5548 number starting at zero) will be used to create the type instance for each
5549 row. Multiple values (and the instance prefix) will be joined together with
5550 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
5551 option is considered for the type instance.
5553 The plugin itself does not check whether or not all built instances are
5554 different. It’s your responsibility to assure that each is unique. This is
5555 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
5556 sure that the table only contains one row.
5558 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
5561 =item B<ValuesFrom> I<column0> [I<column1> ...]
5563 Specifies the columns (identified by the column numbers starting at zero)
5564 whose content is used as the actual data for the data sets that are dispatched
5565 to the daemon. How many such columns you need is determined by the B<Type>
5566 setting above. If you specify too many or not enough columns, the plugin will
5567 complain about that and no data will be submitted to the daemon. The plugin
5568 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
5569 respectively, so anything supported by those functions is supported by the
5570 plugin as well. This option is mandatory.
5574 =head2 Plugin C<tail>
5576 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
5577 each line and dispatches found values. What is matched can be configured by the
5578 user using (extended) regular expressions, as described in L<regex(7)>.
5581 <File "/var/log/exim4/mainlog">
5585 Regex "S=([1-9][0-9]*)"
5591 Regex "\\<R=local_user\\>"
5592 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
5595 Instance "local_user"
5600 The config consists of one or more B<File> blocks, each of which configures one
5601 logfile to parse. Within each B<File> block, there are one or more B<Match>
5602 blocks, which configure a regular expression to search for.
5604 The B<Instance> option in the B<File> block may be used to set the plugin
5605 instance. So in the above example the plugin name C<tail-foo> would be used.
5606 This plugin instance is for all B<Match> blocks that B<follow> it, until the
5607 next B<Instance> option. This way you can extract several plugin instances from
5608 one logfile, handy when parsing syslog and the like.
5610 The B<Interval> option allows you to define the length of time between reads. If
5611 this is not set, the default Interval will be used.
5613 Each B<Match> block has the following options to describe how the match should
5618 =item B<Regex> I<regex>
5620 Sets the regular expression to use for matching against a line. The first
5621 subexpression has to match something that can be turned into a number by
5622 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
5623 below. Because B<extended> regular expressions are used, you do not need to use
5624 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
5625 collectd's config parsing you need to escape backslashes, though. So if you
5626 want to match literal parentheses you need to do the following:
5628 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
5630 =item B<ExcludeRegex> I<regex>
5632 Sets an optional regular expression to use for excluding lines from the match.
5633 An example which excludes all connections from localhost from the match:
5635 ExcludeRegex "127\\.0\\.0\\.1"
5637 =item B<DSType> I<Type>
5639 Sets how the values are cumulated. I<Type> is one of:
5643 =item B<GaugeAverage>
5645 Calculate the average.
5649 Use the smallest number only.
5653 Use the greatest number only.
5657 Use the last number found.
5663 =item B<AbsoluteSet>
5665 The matched number is a counter. Simply I<sets> the internal counter to this
5666 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
5672 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
5673 matched number may be negative, which will effectively subtract from the
5680 Increase the internal counter by one. These B<DSType> are the only ones that do
5681 not use the matched subexpression, but simply count the number of matched
5682 lines. Thus, you may use a regular expression without submatch in this case.
5686 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
5687 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
5688 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
5689 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
5690 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
5693 =item B<Type> I<Type>
5695 Sets the type used to dispatch this value. Detailed information about types and
5696 their configuration can be found in L<types.db(5)>.
5698 =item B<Instance> I<TypeInstance>
5700 This optional setting sets the type instance to use.
5704 =head2 Plugin C<tail_csv>
5706 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
5707 written by I<Snort>.
5712 <Metric "snort-dropped">
5717 <File "/var/log/snort/snort.stats">
5718 Instance "snort-eth0"
5720 Collect "snort-dropped"
5724 The configuration consists of one or more B<Metric> blocks that define an index
5725 into the line of the CSV file and how this value is mapped to I<collectd's>
5726 internal representation. These are followed by one or more B<Instance> blocks
5727 which configure which file to read, in which interval and which metrics to
5732 =item E<lt>B<Metric> I<Name>E<gt>
5734 The B<Metric> block configures a new metric to be extracted from the statistics
5735 file and how it is mapped on I<collectd's> data model. The string I<Name> is
5736 only used inside the B<Instance> blocks to refer to this block, so you can use
5737 one B<Metric> block for multiple CSV files.
5741 =item B<Type> I<Type>
5743 Configures which I<Type> to use when dispatching this metric. Types are defined
5744 in the L<types.db(5)> file, see the appropriate manual page for more
5745 information on specifying types. Only types with a single I<data source> are
5746 supported by the I<tail_csv plugin>. The information whether the value is an
5747 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
5748 I<Type's> definition.
5750 =item B<Instance> I<TypeInstance>
5752 If set, I<TypeInstance> is used to populate the type instance field of the
5753 created value lists. Otherwise, no type instance is used.
5755 =item B<ValueFrom> I<Index>
5757 Configure to read the value from the field with the zero-based index I<Index>.
5758 If the value is parsed as signed integer, unsigned integer or double depends on
5759 the B<Type> setting, see above.
5763 =item E<lt>B<File> I<Path>E<gt>
5765 Each B<File> block represents one CSV file to read. There must be at least one
5766 I<File> block but there can be multiple if you have multiple CSV files.
5770 =item B<Instance> I<PluginInstance>
5772 Sets the I<plugin instance> used when dispatching the values.
5774 =item B<Collect> I<Metric>
5776 Specifies which I<Metric> to collect. This option must be specified at least
5777 once, and you can use this option multiple times to specify more than one
5778 metric to be extracted from this statistic file.
5780 =item B<Interval> I<Seconds>
5782 Configures the interval in which to read values from this instance / file.
5783 Defaults to the plugin's default interval.
5785 =item B<TimeFrom> I<Index>
5787 Rather than using the local time when dispatching a value, read the timestamp
5788 from the field with the zero-based index I<Index>. The value is interpreted as
5789 seconds since epoch. The value is parsed as a double and may be factional.
5795 =head2 Plugin C<teamspeak2>
5797 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
5798 polls interesting global and virtual server data. The plugin can query only one
5799 physical server but unlimited virtual servers. You can use the following
5800 options to configure it:
5804 =item B<Host> I<hostname/ip>
5806 The hostname or ip which identifies the physical server.
5809 =item B<Port> I<port>
5811 The query port of the physical server. This needs to be a string.
5814 =item B<Server> I<port>
5816 This option has to be added once for every virtual server the plugin should
5817 query. If you want to query the virtual server on port 8767 this is what the
5818 option would look like:
5822 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
5823 use quotes around it! If no such statement is given only global information
5828 =head2 Plugin C<ted>
5830 The I<TED> plugin connects to a device of "The Energy Detective", a device to
5831 measure power consumption. These devices are usually connected to a serial
5832 (RS232) or USB port. The plugin opens a configured device and tries to read the
5833 current energy readings. For more information on TED, visit
5834 L<http://www.theenergydetective.com/>.
5836 Available configuration options:
5840 =item B<Device> I<Path>
5842 Path to the device on which TED is connected. collectd will need read and write
5843 permissions on that file.
5845 Default: B</dev/ttyUSB0>
5847 =item B<Retries> I<Num>
5849 Apparently reading from TED is not that reliable. You can therefore configure a
5850 number of retries here. You only configure the I<retries> here, to if you
5851 specify zero, one reading will be performed (but no retries if that fails); if
5852 you specify three, a maximum of four readings are performed. Negative values
5859 =head2 Plugin C<tcpconns>
5861 The C<tcpconns plugin> counts the number of currently established TCP
5862 connections based on the local port and/or the remote port. Since there may be
5863 a lot of connections the default if to count all connections with a local port,
5864 for which a listening socket is opened. You can use the following options to
5865 fine-tune the ports you are interested in:
5869 =item B<ListeningPorts> I<true>|I<false>
5871 If this option is set to I<true>, statistics for all local ports for which a
5872 listening socket exists are collected. The default depends on B<LocalPort> and
5873 B<RemotePort> (see below): If no port at all is specifically selected, the
5874 default is to collect listening ports. If specific ports (no matter if local or
5875 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
5876 the selected ports will be collected unless this option is set to I<true>
5879 =item B<LocalPort> I<Port>
5881 Count the connections to a specific local port. This can be used to see how
5882 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
5883 You have to specify the port in numeric form, so for the mailserver example
5884 you'd need to set B<25>.
5886 =item B<RemotePort> I<Port>
5888 Count the connections to a specific remote port. This is useful to see how
5889 much a remote service is used. This is most useful if you want to know how many
5890 connections a local service has opened to remote services, e.E<nbsp>g. how many
5891 connections a mail server or news server has to other mail or news servers, or
5892 how many connections a web proxy holds to web servers. You have to give the
5893 port in numeric form.
5897 =head2 Plugin C<thermal>
5901 =item B<ForceUseProcfs> I<true>|I<false>
5903 By default, the I<Thermal plugin> tries to read the statistics from the Linux
5904 C<sysfs> interface. If that is not available, the plugin falls back to the
5905 C<procfs> interface. By setting this option to I<true>, you can force the
5906 plugin to use the latter. This option defaults to I<false>.
5908 =item B<Device> I<Device>
5910 Selects the name of the thermal device that you want to collect or ignore,
5911 depending on the value of the B<IgnoreSelected> option. This option may be
5912 used multiple times to specify a list of devices.
5914 =item B<IgnoreSelected> I<true>|I<false>
5916 Invert the selection: If set to true, all devices B<except> the ones that
5917 match the device names specified by the B<Device> option are collected. By
5918 default only selected devices are collected if a selection is made. If no
5919 selection is configured at all, B<all> devices are selected.
5923 =head2 Plugin C<threshold>
5925 The I<Threshold plugin> checks values collected or received by I<collectd>
5926 against a configurable I<threshold> and issues I<notifications> if values are
5929 Documentation for this plugin is available in the L<collectd-threshold(5)>
5932 =head2 Plugin C<tokyotyrant>
5934 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
5935 couple metrics: number of records, and database size on disk.
5939 =item B<Host> I<Hostname/IP>
5941 The hostname or ip which identifies the server.
5942 Default: B<127.0.0.1>
5944 =item B<Port> I<Service/Port>
5946 The query port of the server. This needs to be a string, even if the port is
5947 given in its numeric form.
5952 =head2 Plugin C<unixsock>
5956 =item B<SocketFile> I<Path>
5958 Sets the socket-file which is to be created.
5960 =item B<SocketGroup> I<Group>
5962 If running as root change the group of the UNIX-socket after it has been
5963 created. Defaults to B<collectd>.
5965 =item B<SocketPerms> I<Permissions>
5967 Change the file permissions of the UNIX-socket after it has been created. The
5968 permissions must be given as a numeric, octal value as you would pass to
5969 L<chmod(1)>. Defaults to B<0770>.
5971 =item B<DeleteSocket> B<false>|B<true>
5973 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
5974 with the given name already exists. If I<collectd> crashes a socket file may be
5975 left over, preventing the daemon from opening a new socket when restarted.
5976 Since this is potentially dangerous, this defaults to B<false>.
5980 =head2 Plugin C<uuid>
5982 This plugin, if loaded, causes the Hostname to be taken from the machine's
5983 UUID. The UUID is a universally unique designation for the machine, usually
5984 taken from the machine's BIOS. This is most useful if the machine is running in
5985 a virtual environment such as Xen, in which case the UUID is preserved across
5986 shutdowns and migration.
5988 The following methods are used to find the machine's UUID, in order:
5994 Check I</etc/uuid> (or I<UUIDFile>).
5998 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
6003 Check for UUID from C<dmidecode> / SMBIOS.
6007 Check for UUID from Xen hypervisor.
6011 If no UUID can be found then the hostname is not modified.
6015 =item B<UUIDFile> I<Path>
6017 Take the UUID from the given file (default I</etc/uuid>).
6021 =head2 Plugin C<varnish>
6023 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
6028 <Instance "example">
6030 CollectConnections true
6040 CollectWorkers false
6044 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
6045 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
6046 will collectd statistics from the default "varnishd" instance (this should work
6047 fine in most cases).
6049 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
6053 =item B<CollectCache> B<true>|B<false>
6055 Cache hits and misses. True by default.
6057 =item B<CollectConnections> B<true>|B<false>
6059 Number of client connections received, accepted and dropped. True by default.
6061 =item B<CollectBackend> B<true>|B<false>
6063 Back-end connection statistics, such as successful, reused,
6064 and closed connections. True by default.
6066 =item B<CollectSHM> B<true>|B<false>
6068 Statistics about the shared memory log, a memory region to store
6069 log messages which is flushed to disk when full. True by default.
6071 =item B<CollectBan> B<true>|B<false>
6073 Statistics about ban operations, such as number of bans added, retired, and
6074 number of objects tested against ban operations. Only available with Varnish
6075 3.x. False by default.
6077 =item B<CollectDirectorDNS> B<true>|B<false>
6079 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
6082 =item B<CollectESI> B<true>|B<false>
6084 Edge Side Includes (ESI) parse statistics. False by default.
6086 =item B<CollectFetch> B<true>|B<false>
6088 Statistics about fetches (HTTP requests sent to the backend). False by default.
6090 =item B<CollectHCB> B<true>|B<false>
6092 Inserts and look-ups in the crit bit tree based hash. Look-ups are
6093 divided into locked and unlocked look-ups. False by default.
6095 =item B<CollectObjects> B<true>|B<false>
6097 Statistics on cached objects: number of objects expired, nuked (prematurely
6098 expired), saved, moved, etc. False by default.
6100 =item B<CollectPurge> B<true>|B<false>
6102 Statistics about purge operations, such as number of purges added, retired, and
6103 number of objects tested against purge operations. Only available with Varnish
6104 2.x. False by default.
6106 =item B<CollectSession> B<true>|B<false>
6108 Client session statistics. Number of past and current sessions, session herd and
6109 linger counters, etc. False by default.
6111 =item B<CollectSMA> B<true>|B<false>
6113 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
6114 component is Solaris specific. Only available with Varnish 2.x. False by
6117 =item B<CollectSMS> B<true>|B<false>
6119 synth (synthetic content) storage statistics. This storage
6120 component is used internally only. False by default.
6122 =item B<CollectSM> B<true>|B<false>
6124 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
6127 =item B<CollectStruct> B<true>|B<false>
6129 Current varnish internal state statistics. Number of current sessions, objects
6130 in cache store, open connections to backends (with Varnish 2.x), etc. False by
6133 =item B<CollectTotals> B<true>|B<false>
6135 Collects overview counters, such as the number of sessions created,
6136 the number of requests and bytes transferred. False by default.
6138 =item B<CollectUptime> B<true>|B<false>
6140 Varnish uptime. False by default.
6142 =item B<CollectVCL> B<true>|B<false>
6144 Number of total (available + discarded) VCL (config files). False by default.
6146 =item B<CollectWorkers> B<true>|B<false>
6148 Collect statistics about worker threads. False by default.
6152 =head2 Plugin C<vmem>
6154 The C<vmem> plugin collects information about the usage of virtual memory.
6155 Since the statistics provided by the Linux kernel are very detailed, they are
6156 collected very detailed. However, to get all the details, you have to switch
6157 them on manually. Most people just want an overview over, such as the number of
6158 pages read from swap space.
6162 =item B<Verbose> B<true>|B<false>
6164 Enables verbose collection of information. This will start collecting page
6165 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
6166 Part of these statistics are collected on a "per zone" basis.
6170 =head2 Plugin C<vserver>
6172 This plugin doesn't have any options. B<VServer> support is only available for
6173 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
6174 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
6175 need to apply the patches and compile your own kernel, which will then provide
6176 the F</proc/virtual> filesystem that is required by this plugin.
6178 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
6180 B<Note>: The traffic collected by this plugin accounts for the amount of
6181 traffic passing a socket which might be a lot less than the actual on-wire
6182 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
6183 collect on-wire traffic you could, for example, use the logging facilities of
6184 iptables to feed data for the guest IPs into the iptables plugin.
6186 =head2 Plugin C<write_graphite>
6188 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
6189 storage and graphing project. The plugin connects to I<Carbon>, the data layer
6190 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
6191 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
6192 of at most 1428 bytes to minimize the number of network packets.
6196 <Plugin write_graphite>
6206 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6207 blocks. Inside the B<Node> blocks, the following options are recognized:
6211 =item B<Host> I<Address>
6213 Hostname or address to connect to. Defaults to C<localhost>.
6215 =item B<Port> I<Service>
6217 Service name or port number to connect to. Defaults to C<2003>.
6219 =item B<Protocol> I<String>
6221 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
6223 =item B<LogSendErrors> B<false>|B<true>
6225 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
6226 If set to B<false>, it will not log the errors. This is especially useful when
6227 using Protocol UDP since many times we want to use the "fire-and-forget"
6228 approach and logging errors fills syslog with unneeded messages.
6230 =item B<Prefix> I<String>
6232 When set, I<String> is added in front of the host name. Dots and whitespace are
6233 I<not> escaped in this string (see B<EscapeCharacter> below).
6235 =item B<Postfix> I<String>
6237 When set, I<String> is appended to the host name. Dots and whitespace are
6238 I<not> escaped in this string (see B<EscapeCharacter> below).
6240 =item B<EscapeCharacter> I<Char>
6242 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
6243 in the identifier. The B<EscapeCharacter> option determines which character
6244 dots, whitespace and control characters are replaced with. Defaults to
6247 =item B<StoreRates> B<false>|B<true>
6249 If set to B<true> (the default), convert counter values to rates. If set to
6250 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6253 =item B<SeparateInstances> B<false>|B<true>
6255 If set to B<true>, the plugin instance and type instance will be in their own
6256 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6257 default), the plugin and plugin instance (and likewise the type and type
6258 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6260 =item B<AlwaysAppendDS> B<false>|B<true>
6262 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
6263 identifier. If set to B<false> (the default), this is only done when there is
6268 =head2 Plugin C<write_mongodb>
6270 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
6275 <Plugin "write_mongodb">
6284 The plugin can send values to multiple instances of I<MongoDB> by specifying
6285 one B<Node> block for each instance. Within the B<Node> blocks, the following
6286 options are available:
6290 =item B<Host> I<Address>
6292 Hostname or address to connect to. Defaults to C<localhost>.
6294 =item B<Port> I<Service>
6296 Service name or port number to connect to. Defaults to C<27017>.
6298 =item B<Timeout> I<Timeout>
6300 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
6301 Setting this option to zero means no timeout, which is the default.
6303 =item B<StoreRates> B<false>|B<true>
6305 If set to B<true> (the default), convert counter values to rates. If set to
6306 B<false> counter values are stored as is, i.e. as an increasing integer
6309 =item B<Database> I<Database>
6311 =item B<User> I<User>
6313 =item B<Password> I<Password>
6315 Sets the information used when authenticating to a I<MongoDB> database. The
6316 fields are optional (in which case no authentication is attempted), but if you
6317 want to use authentication all three fields must be set.
6321 =head2 Plugin C<write_http>
6323 This output plugin submits values to an http server by POST them using the
6324 PUTVAL plain-text protocol. Each destination you want to post data to needs to
6325 have one B<URL> block, within which the destination can be configured further,
6326 for example by specifying authentication data.
6330 <Plugin "write_http">
6331 <URL "http://example.com/post-collectd">
6337 B<URL> blocks need one string argument which is used as the URL to which data
6338 is posted. The following options are understood within B<URL> blocks.
6342 =item B<User> I<Username>
6344 Optional user name needed for authentication.
6346 =item B<Password> I<Password>
6348 Optional password needed for authentication.
6350 =item B<VerifyPeer> B<true>|B<false>
6352 Enable or disable peer SSL certificate verification. See
6353 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
6355 =item B<VerifyHost> B<true|false>
6357 Enable or disable peer host name verification. If enabled, the plugin checks if
6358 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
6359 matches the host name provided by the B<URL> option. If this identity check
6360 fails, the connection is aborted. Obviously, only works when connecting to a
6361 SSL enabled server. Enabled by default.
6363 =item B<CACert> I<File>
6365 File that holds one or more SSL certificates. If you want to use HTTPS you will
6366 possibly need this option. What CA certificates come bundled with C<libcurl>
6367 and are checked by default depends on the distribution you use.
6369 =item B<Format> B<Command>|B<JSON>
6371 Format of the output to generate. If set to B<Command>, will create output that
6372 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
6373 create output in the I<JavaScript Object Notation> (JSON).
6375 Defaults to B<Command>.
6377 =item B<StoreRates> B<true|false>
6379 If set to B<true>, convert counter values to rates. If set to B<false> (the
6380 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
6385 =head2 Plugin C<write_riemann>
6387 The I<write_riemann plugin> will send values to I<Riemann>, a powerfull stream
6388 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
6389 I<Riemann> using UDP packets.
6393 <Plugin "write_riemann">
6399 AlwaysAppendDS false
6403 Attribute "foo" "bar"
6406 The following options are understood by the I<write_riemann plugin>:
6410 =item E<lt>B<Node> I<Name>E<gt>
6412 The plugin's configuration consists of one or more B<Node> blocks. Each block
6413 is given a unique I<Name> and specifies one connection to an instance of
6414 I<Riemann>. Indise the B<Node> block, the following per-connection options are
6419 =item B<Host> I<Address>
6421 Hostname or address to connect to. Defaults to C<localhost>.
6423 =item B<Port> I<Service>
6425 Service name or port number to connect to. Defaults to C<5555>.
6427 =item B<Protocol> B<UDP>|B<TCP>
6429 Specify the protocol to use when communicating with I<Riemann>. Defaults to
6432 =item B<StoreRates> B<true>|B<false>
6434 If set to B<true> (the default), convert counter values to rates. If set to
6435 B<false> counter values are stored as is, i.e. as an increasing integer number.
6437 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
6438 converted values will have "rate" appended to the data source type, e.g.
6439 C<ds_type:derive:rate>.
6441 =item B<AlwaysAppendDS> B<false>|B<true>
6443 If set the B<true>, append the name of the I<Data Source> (DS) to the
6444 "service", i.e. the field that, together with the "host" field, uniquely
6445 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
6446 only done when there is more than one DS.
6448 =item B<TTLFactor> I<Factor>
6450 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
6451 event is considered active. I<collectd> populates this field based on the
6452 metrics interval setting. This setting controls the factor with which the
6453 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
6454 know exactly what you're doing, you should only increase this setting from its
6459 =item B<Tag> I<String>
6461 Add the given string as an additional tag to the metric being sent to
6464 =item B<Attribute> I<String> I<String>
6466 Consider the two given strings to be the key and value of an additional
6467 attribute for each metric being sent out to I<Riemann>.
6471 =head1 THRESHOLD CONFIGURATION
6473 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
6474 we mean that the values are not only stored or sent somewhere, but that they
6475 are judged and, if a problem is recognized, acted upon. The only action
6476 collectd takes itself is to generate and dispatch a "notification". Plugins can
6477 register to receive notifications and perform appropriate further actions.
6479 Since systems and what you expect them to do differ a lot, you can configure
6480 B<thresholds> for your values freely. This gives you a lot of flexibility but
6481 also a lot of responsibility.
6483 Every time a value is out of range a notification is dispatched. This means
6484 that the idle percentage of your CPU needs to be less then the configured
6485 threshold only once for a notification to be generated. There's no such thing
6486 as a moving average or similar - at least not now.
6488 Also, all values that match a threshold are considered to be relevant or
6489 "interesting". As a consequence collectd will issue a notification if they are
6490 not received for B<Timeout> iterations. The B<Timeout> configuration option is
6491 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
6492 "2" (the default) and some hosts sends it's CPU statistics to the server every
6493 60 seconds, a notification will be dispatched after about 120 seconds. It may
6494 take a little longer because the timeout is checked only once each B<Interval>
6497 When a value comes within range again or is received after it was missing, an
6498 "OKAY-notification" is dispatched.
6500 Here is a configuration example to get you started. Read below for more
6513 <Plugin "interface">
6530 WarningMin 100000000
6536 There are basically two types of configuration statements: The C<Host>,
6537 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
6538 configured. The C<Plugin> and C<Type> blocks may be specified further using the
6539 C<Instance> option. You can combine the block by nesting the blocks, though
6540 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
6541 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
6542 C<Type> may not contain other blocks. If multiple blocks apply to the same
6543 value the most specific block is used.
6545 The other statements specify the threshold to configure. They B<must> be
6546 included in a C<Type> block. Currently the following statements are recognized:
6550 =item B<FailureMax> I<Value>
6552 =item B<WarningMax> I<Value>
6554 Sets the upper bound of acceptable values. If unset defaults to positive
6555 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
6556 will be created. If the value is greater than B<WarningMax> but less than (or
6557 equal to) B<FailureMax> a B<WARNING> notification will be created.
6559 =item B<FailureMin> I<Value>
6561 =item B<WarningMin> I<Value>
6563 Sets the lower bound of acceptable values. If unset defaults to negative
6564 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
6565 be created. If the value is less than B<WarningMin> but greater than (or equal
6566 to) B<FailureMin> a B<WARNING> notification will be created.
6568 =item B<DataSource> I<DSName>
6570 Some data sets have more than one "data source". Interesting examples are the
6571 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
6572 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
6573 system load data set, C<load>, even has three data sources: C<shortterm>,
6574 C<midterm>, and C<longterm>.
6576 Normally, all data sources are checked against a configured threshold. If this
6577 is undesirable, or if you want to specify different limits for each data
6578 source, you can use the B<DataSource> option to have a threshold apply only to
6581 =item B<Invert> B<true>|B<false>
6583 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
6584 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
6585 B<WarningMax>) are not okay. Defaults to B<false>.
6587 =item B<Persist> B<true>|B<false>
6589 Sets how often notifications are generated. If set to B<true> one notification
6590 will be generated for each value that is out of the acceptable range. If set to
6591 B<false> (the default) then a notification is only generated if a value is out
6592 of range but the previous value was okay.
6594 This applies to missing values, too: If set to B<true> a notification about a
6595 missing value is generated once every B<Interval> seconds. If set to B<false>
6596 only one such notification is generated until the value appears again.
6598 =item B<Percentage> B<true>|B<false>
6600 If set to B<true>, the minimum and maximum values given are interpreted as
6601 percentage value, relative to the other data sources. This is helpful for
6602 example for the "df" type, where you may want to issue a warning when less than
6603 5E<nbsp>% of the total space is available. Defaults to B<false>.
6605 =item B<Hits> I<Number>
6607 Delay creating the notification until the threshold has been passed I<Number>
6608 times. When a notification has been generated, or when a subsequent value is
6609 inside the threshold, the counter is reset. If, for example, a value is
6610 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
6611 will be dispatched at most once every 30E<nbsp>seconds.
6613 This is useful when short bursts are not a problem. If, for example, 100% CPU
6614 usage for up to a minute is normal (and data is collected every
6615 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
6617 =item B<Hysteresis> I<Number>
6619 When set to non-zero, a hysteresis value is applied when checking minimum and
6620 maximum bounds. This is useful for values that increase slowly and fluctuate a
6621 bit while doing so. When these values come close to the threshold, they may
6622 "flap", i.e. switch between failure / warning case and okay case repeatedly.
6624 If, for example, the threshold is configures as
6629 then a I<Warning> notification is created when the value exceeds I<101> and the
6630 corresponding I<Okay> notification is only created once the value falls below
6631 I<99>, thus avoiding the "flapping".
6635 =head1 FILTER CONFIGURATION
6637 Starting with collectd 4.6 there is a powerful filtering infrastructure
6638 implemented in the daemon. The concept has mostly been copied from
6639 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
6640 terminology, so that users that are familiar with iptables feel right at home.
6644 The following are the terms used in the remainder of the filter configuration
6645 documentation. For an ASCII-art schema of the mechanism, see
6646 L<"General structure"> below.
6652 A I<match> is a criteria to select specific values. Examples are, of course, the
6653 name of the value or it's current value.
6655 Matches are implemented in plugins which you have to load prior to using the
6656 match. The name of such plugins starts with the "match_" prefix.
6660 A I<target> is some action that is to be performed with data. Such actions
6661 could, for example, be to change part of the value's identifier or to ignore
6662 the value completely.
6664 Some of these targets are built into the daemon, see L<"Built-in targets">
6665 below. Other targets are implemented in plugins which you have to load prior to
6666 using the target. The name of such plugins starts with the "target_" prefix.
6670 The combination of any number of matches and at least one target is called a
6671 I<rule>. The target actions will be performed for all values for which B<all>
6672 matches apply. If the rule does not have any matches associated with it, the
6673 target action will be performed for all values.
6677 A I<chain> is a list of rules and possibly default targets. The rules are tried
6678 in order and if one matches, the associated target will be called. If a value
6679 is handled by a rule, it depends on the target whether or not any subsequent
6680 rules are considered or if traversal of the chain is aborted, see
6681 L<"Flow control"> below. After all rules have been checked, the default targets
6686 =head2 General structure
6688 The following shows the resulting structure:
6695 +---------+ +---------+ +---------+ +---------+
6696 ! Rule !->! Match !->! Match !->! Target !
6697 +---------+ +---------+ +---------+ +---------+
6700 +---------+ +---------+ +---------+
6701 ! Rule !->! Target !->! Target !
6702 +---------+ +---------+ +---------+
6709 +---------+ +---------+ +---------+
6710 ! Rule !->! Match !->! Target !
6711 +---------+ +---------+ +---------+
6721 There are four ways to control which way a value takes through the filter
6728 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
6729 process the value with another chain. When the called chain finishes, usually
6730 the next target or rule after the jump is executed.
6734 The stop condition, signaled for example by the built-in target B<stop>, causes
6735 all processing of the value to be stopped immediately.
6739 Causes processing in the current chain to be aborted, but processing of the
6740 value generally will continue. This means that if the chain was called via
6741 B<Jump>, the next target or rule after the jump will be executed. If the chain
6742 was not called by another chain, control will be returned to the daemon and it
6743 may pass the value to another chain.
6747 Most targets will signal the B<continue> condition, meaning that processing
6748 should continue normally. There is no special built-in target for this
6755 The configuration reflects this structure directly:
6757 PostCacheChain "PostCache"
6759 <Rule "ignore_mysql_show">
6762 Type "^mysql_command$"
6763 TypeInstance "^show_"
6773 The above configuration example will ignore all values where the plugin field
6774 is "mysql", the type is "mysql_command" and the type instance begins with
6775 "show_". All other values will be sent to the C<rrdtool> write plugin via the
6776 default target of the chain. Since this chain is run after the value has been
6777 added to the cache, the MySQL C<show_*> command statistics will be available
6778 via the C<unixsock> plugin.
6780 =head2 List of configuration options
6784 =item B<PreCacheChain> I<ChainName>
6786 =item B<PostCacheChain> I<ChainName>
6788 Configure the name of the "pre-cache chain" and the "post-cache chain". The
6789 argument is the name of a I<chain> that should be executed before and/or after
6790 the values have been added to the cache.
6792 To understand the implications, it's important you know what is going on inside
6793 I<collectd>. The following diagram shows how values are passed from the
6794 read-plugins to the write-plugins:
6800 + - - - - V - - - - +
6801 : +---------------+ :
6804 : +-------+-------+ :
6807 : +-------+-------+ : +---------------+
6808 : ! Cache !--->! Value Cache !
6809 : ! insert ! : +---+---+-------+
6810 : +-------+-------+ : ! !
6811 : ! ,------------' !
6813 : +-------+---+---+ : +-------+-------+
6814 : ! Post-Cache +--->! Write-Plugins !
6815 : ! Chain ! : +---------------+
6816 : +---------------+ :
6819 + - - - - - - - - - +
6821 After the values are passed from the "read" plugins to the dispatch functions,
6822 the pre-cache chain is run first. The values are added to the internal cache
6823 afterwards. The post-cache chain is run after the values have been added to the
6824 cache. So why is it such a huge deal if chains are run before or after the
6825 values have been added to this cache?
6827 Targets that change the identifier of a value list should be executed before
6828 the values are added to the cache, so that the name in the cache matches the
6829 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
6830 this cache to receive a list of all available values. If you change the
6831 identifier after the value list has been added to the cache, this may easily
6832 lead to confusion, but it's not forbidden of course.
6834 The cache is also used to convert counter values to rates. These rates are, for
6835 example, used by the C<value> match (see below). If you use the rate stored in
6836 the cache B<before> the new value is added, you will use the old, B<previous>
6837 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
6838 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
6841 Last but not last, the B<stop> target makes a difference: If the pre-cache
6842 chain returns the stop condition, the value will not be added to the cache and
6843 the post-cache chain will not be run.
6845 =item B<Chain> I<Name>
6847 Adds a new chain with a certain name. This name can be used to refer to a
6848 specific chain, for example to jump to it.
6850 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
6852 =item B<Rule> [I<Name>]
6854 Adds a new rule to the current chain. The name of the rule is optional and
6855 currently has no meaning for the daemon.
6857 Within the B<Rule> block, there may be any number of B<Match> blocks and there
6858 must be at least one B<Target> block.
6860 =item B<Match> I<Name>
6862 Adds a match to a B<Rule> block. The name specifies what kind of match should
6863 be performed. Available matches depend on the plugins that have been loaded.
6865 The arguments inside the B<Match> block are passed to the plugin implementing
6866 the match, so which arguments are valid here depends on the plugin being used.
6867 If you do not need any to pass any arguments to a match, you can use the
6872 Which is equivalent to:
6877 =item B<Target> I<Name>
6879 Add a target to a rule or a default target to a chain. The name specifies what
6880 kind of target is to be added. Which targets are available depends on the
6881 plugins being loaded.
6883 The arguments inside the B<Target> block are passed to the plugin implementing
6884 the target, so which arguments are valid here depends on the plugin being used.
6885 If you do not need any to pass any arguments to a target, you can use the
6890 This is the same as writing:
6897 =head2 Built-in targets
6899 The following targets are built into the core daemon and therefore need no
6900 plugins to be loaded:
6906 Signals the "return" condition, see the L<"Flow control"> section above. This
6907 causes the current chain to stop processing the value and returns control to
6908 the calling chain. The calling chain will continue processing targets and rules
6909 just after the B<jump> target (see below). This is very similar to the
6910 B<RETURN> target of iptables, see L<iptables(8)>.
6912 This target does not have any options.
6920 Signals the "stop" condition, see the L<"Flow control"> section above. This
6921 causes processing of the value to be aborted immediately. This is similar to
6922 the B<DROP> target of iptables, see L<iptables(8)>.
6924 This target does not have any options.
6932 Sends the value to "write" plugins.
6938 =item B<Plugin> I<Name>
6940 Name of the write plugin to which the data should be sent. This option may be
6941 given multiple times to send the data to more than one write plugin.
6945 If no plugin is explicitly specified, the values will be sent to all available
6956 Starts processing the rules of another chain, see L<"Flow control"> above. If
6957 the end of that chain is reached, or a stop condition is encountered,
6958 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
6959 next target or the next rule. This is similar to the B<-j> command line option
6960 of iptables, see L<iptables(8)>.
6966 =item B<Chain> I<Name>
6968 Jumps to the chain I<Name>. This argument is required and may appear only once.
6980 =head2 Available matches
6986 Matches a value using regular expressions.
6992 =item B<Host> I<Regex>
6994 =item B<Plugin> I<Regex>
6996 =item B<PluginInstance> I<Regex>
6998 =item B<Type> I<Regex>
7000 =item B<TypeInstance> I<Regex>
7002 Match values where the given regular expressions match the various fields of
7003 the identifier of a value. If multiple regular expressions are given, B<all>
7004 regexen must match for a value to match.
7006 =item B<Invert> B<false>|B<true>
7008 When set to B<true>, the result of the match is inverted, i.e. all value lists
7009 where all regular expressions apply are not matched, all other value lists are
7010 matched. Defaults to B<false>.
7017 Host "customer[0-9]+"
7023 Matches values that have a time which differs from the time on the server.
7025 This match is mainly intended for servers that receive values over the
7026 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
7027 is very sensitive to the timestamp used when updating the RRD files. In
7028 particular, the time must be ever increasing. If a misbehaving client sends one
7029 packet with a timestamp far in the future, all further packets with a correct
7030 time will be ignored because of that one packet. What's worse, such corrupted
7031 RRD files are hard to fix.
7033 This match lets one match all values B<outside> a specified time range
7034 (relative to the server's time), so you can use the B<stop> target (see below)
7035 to ignore the value, for example.
7041 =item B<Future> I<Seconds>
7043 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
7044 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7047 =item B<Past> I<Seconds>
7049 Matches all values that are I<behind> of the server's time by I<Seconds> or
7050 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7062 This example matches all values that are five minutes or more ahead of the
7063 server or one hour (or more) lagging behind.
7067 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
7068 values. If a data-set consists of more than one data-source, all data-sources
7069 must match the specified ranges for a positive match.
7075 =item B<Min> I<Value>
7077 Sets the smallest value which still results in a match. If unset, behaves like
7080 =item B<Max> I<Value>
7082 Sets the largest value which still results in a match. If unset, behaves like
7085 =item B<Invert> B<true>|B<false>
7087 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
7088 no-match is returned and vice versa. Please note that the B<Invert> setting
7089 only effects how B<Min> and B<Max> are applied to a specific value. Especially
7090 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
7092 =item B<DataSource> I<DSName> [I<DSName> ...]
7094 Select one or more of the data sources. If no data source is configured, all
7095 data sources will be checked. If the type handled by the match does not have a
7096 data source of the specified name(s), this will always result in no match
7097 (independent of the B<Invert> setting).
7099 =item B<Satisfy> B<Any>|B<All>
7101 Specifies how checking with several data sources is performed. If set to
7102 B<Any>, the match succeeds if one of the data sources is in the configured
7103 range. If set to B<All> the match only succeeds if all data sources are within
7104 the configured range. Default is B<All>.
7106 Usually B<All> is used for positive matches, B<Any> is used for negative
7107 matches. This means that with B<All> you usually check that all values are in a
7108 "good" range, while with B<Any> you check if any value is within a "bad" range
7109 (or outside the "good" range).
7113 Either B<Min> or B<Max>, but not both, may be unset.
7117 # Match all values smaller than or equal to 100. Matches only if all data
7118 # sources are below 100.
7124 # Match if the value of any data source is outside the range of 0 - 100.
7132 =item B<empty_counter>
7134 Matches all values with one or more data sources of type B<COUNTER> and where
7135 all counter values are zero. These counters usually I<never> increased since
7136 they started existing (and are therefore uninteresting), or got reset recently
7137 or overflowed and you had really, I<really> bad luck.
7139 Please keep in mind that ignoring such counters can result in confusing
7140 behavior: Counters which hardly ever increase will be zero for long periods of
7141 time. If the counter is reset for some reason (machine or service restarted,
7142 usually), the graph will be empty (NAN) for a long time. People may not
7147 Calculates a hash value of the host name and matches values according to that
7148 hash value. This makes it possible to divide all hosts into groups and match
7149 only values that are in a specific group. The intended use is in load
7150 balancing, where you want to handle only part of all data and leave the rest
7153 The hashing function used tries to distribute the hosts evenly. First, it
7154 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
7157 for (i = 0; host[i] != 0; i++)
7158 hash_value = (hash_value * 251) + host[i];
7160 The constant 251 is a prime number which is supposed to make this hash value
7161 more random. The code then checks the group for this host according to the
7162 I<Total> and I<Match> arguments:
7164 if ((hash_value % Total) == Match)
7169 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
7170 groups), then the least significant bit of the hash value will be the XOR of
7171 all least significant bits in the host name. One consequence is that when you
7172 have two hosts, "server0.example.com" and "server1.example.com", where the host
7173 name differs in one digit only and the digits differ by one, those hosts will
7174 never end up in the same group.
7180 =item B<Match> I<Match> I<Total>
7182 Divide the data into I<Total> groups and match all hosts in group I<Match> as
7183 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
7184 be smaller than I<Total>. I<Total> must be at least one, although only values
7185 greater than one really do make any sense.
7187 You can repeat this option to match multiple groups, for example:
7192 The above config will divide the data into seven groups and match groups three
7193 and five. One use would be to keep every value on two hosts so that if one
7194 fails the missing data can later be reconstructed from the second host.
7200 # Operate on the pre-cache chain, so that ignored values are not even in the
7205 # Divide all received hosts in seven groups and accept all hosts in
7209 # If matched: Return and continue.
7212 # If not matched: Return and stop.
7218 =head2 Available targets
7222 =item B<notification>
7224 Creates and dispatches a notification.
7230 =item B<Message> I<String>
7232 This required option sets the message of the notification. The following
7233 placeholders will be replaced by an appropriate value:
7241 =item B<%{plugin_instance}>
7245 =item B<%{type_instance}>
7247 These placeholders are replaced by the identifier field of the same name.
7249 =item B<%{ds:>I<name>B<}>
7251 These placeholders are replaced by a (hopefully) human readable representation
7252 of the current rate of this data source. If you changed the instance name
7253 (using the B<set> or B<replace> targets, see below), it may not be possible to
7254 convert counter values to rates.
7258 Please note that these placeholders are B<case sensitive>!
7260 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
7262 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
7269 <Target "notification">
7270 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
7276 Replaces parts of the identifier using regular expressions.
7282 =item B<Host> I<Regex> I<Replacement>
7284 =item B<Plugin> I<Regex> I<Replacement>
7286 =item B<PluginInstance> I<Regex> I<Replacement>
7288 =item B<TypeInstance> I<Regex> I<Replacement>
7290 Match the appropriate field with the given regular expression I<Regex>. If the
7291 regular expression matches, that part that matches is replaced with
7292 I<Replacement>. If multiple places of the input buffer match a given regular
7293 expression, only the first occurrence will be replaced.
7295 You can specify each option multiple times to use multiple regular expressions
7303 # Replace "example.net" with "example.com"
7304 Host "\\<example.net\\>" "example.com"
7306 # Strip "www." from hostnames
7312 Sets part of the identifier of a value to a given string.
7318 =item B<Host> I<String>
7320 =item B<Plugin> I<String>
7322 =item B<PluginInstance> I<String>
7324 =item B<TypeInstance> I<String>
7326 Set the appropriate field to the given string. The strings for plugin instance
7327 and type instance may be empty, the strings for host and plugin may not be
7328 empty. It's currently not possible to set the type of a value this way.
7335 PluginInstance "coretemp"
7336 TypeInstance "core3"
7341 =head2 Backwards compatibility
7343 If you use collectd with an old configuration, i.E<nbsp>e. one without a
7344 B<Chain> block, it will behave as it used to. This is equivalent to the
7345 following configuration:
7351 If you specify a B<PostCacheChain>, the B<write> target will not be added
7352 anywhere and you will have to make sure that it is called where appropriate. We
7353 suggest to add the above snippet as default target to your "PostCache" chain.
7357 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
7373 L<collectd-exec(5)>,
7374 L<collectd-perl(5)>,
7375 L<collectd-unixsock(5)>,
7388 Florian Forster E<lt>octo@verplant.orgE<gt>