5 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
9 BaseDir "/path/to/data/"
10 PIDFile "/path/to/pidfile/collectd.pid"
11 Server "123.123.123.123" 12345
28 This config file controls how the system statistics collection daemon
29 B<collectd> behaves. The most significant option is B<LoadPlugin>, which
30 controls which plugins to load. These plugins ultimately define collectd's
33 The syntax of this config file is similar to the config file of the famous
34 I<Apache> webserver. Each line contains either an option (a key and a list of
35 one or more values) or a section-start or -end. Empty lines and everything
36 after a non-quoted hash-symbol (C<#>) is ignored. I<Keys> are unquoted
37 strings, consisting only of alphanumeric characters and the underscore (C<_>)
38 character. Keys are handled case insensitive by I<collectd> itself and all
39 plugins included with it. I<Values> can either be an I<unquoted string>, a
40 I<quoted string> (enclosed in double-quotes) a I<number> or a I<boolean>
41 expression. I<Unquoted strings> consist of only alphanumeric characters and
42 underscores (C<_>) and do not need to be quoted. I<Quoted strings> are
43 enclosed in double quotes (C<">). You can use the backslash character (C<\>)
44 to include double quotes as part of the string. I<Numbers> can be specified in
45 decimal and floating point format (using a dot C<.> as decimal separator),
46 hexadecimal when using the C<0x> prefix and octal with a leading zero (C<0>).
47 I<Boolean> values are either B<true> or B<false>.
49 Lines may be wrapped by using C<\> as the last character before the newline.
50 This allows long lines to be split into multiple lines. Quoted strings may be
51 wrapped as well. However, those are treated special in that whitespace at the
52 beginning of the following lines will be ignored, which allows for nicely
53 indenting the wrapped lines.
55 The configuration is read and processed in order, i.e. from top to bottom. So
56 the plugins are loaded in the order listed in this config file. It is a good
57 idea to load any logging plugins first in order to catch messages from plugins
58 during configuration. Also, the C<LoadPlugin> option B<must> occur B<before>
59 the appropriate C<E<lt>Plugin ...E<gt>> block.
65 =item B<BaseDir> I<Directory>
67 Sets the base directory. This is the directory beneath all RRD-files are
68 created. Possibly more subdirectories are created. This is also the working
69 directory for the daemon.
71 =item B<LoadPlugin> I<Plugin>
73 Loads the plugin I<Plugin>. This is required to load plugins, unless the
74 B<AutoLoadPlugin> option is enabled (see below). Without any loaded plugins,
75 I<collectd> will be mostly useless.
77 Only the first B<LoadPlugin> statement or block for a given plugin name has any
78 effect. This is useful when you want to split up the configuration into smaller
79 files and want each file to be "self contained", i.e. it contains a B<Plugin>
80 block I<and> then appropriate B<LoadPlugin> statement. The downside is that if
81 you have multiple conflicting B<LoadPlugin> blocks, e.g. when they specify
82 different intervals, only one of them (the first one encountered) will take
83 effect and all others will be silently ignored.
85 B<LoadPlugin> may either be a simple configuration I<statement> or a I<block>
86 with additional options, affecting the behavior of B<LoadPlugin>. A simple
87 statement looks like this:
91 Options inside a B<LoadPlugin> block can override default settings and
92 influence the way plugins are loaded, e.g.:
99 The following options are valid inside B<LoadPlugin> blocks:
103 =item B<Globals> B<true|false>
105 If enabled, collectd will export all global symbols of the plugin (and of all
106 libraries loaded as dependencies of the plugin) and, thus, makes those symbols
107 available for resolving unresolved symbols in subsequently loaded plugins if
108 that is supported by your system.
110 This is useful (or possibly even required), e.g., when loading a plugin that
111 embeds some scripting language into the daemon (e.g. the I<Perl> and
112 I<Python plugins>). Scripting languages usually provide means to load
113 extensions written in C. Those extensions require symbols provided by the
114 interpreter, which is loaded as a dependency of the respective collectd plugin.
115 See the documentation of those plugins (e.g., L<collectd-perl(5)> or
116 L<collectd-python(5)>) for details.
118 By default, this is disabled. As a special exception, if the plugin name is
119 either C<perl> or C<python>, the default is changed to enabled in order to keep
120 the average user from ever having to deal with this low level linking stuff.
122 =item B<Interval> I<Seconds>
124 Sets a plugin-specific interval for collecting metrics. This overrides the
125 global B<Interval> setting. If a plugin provides own support for specifying an
126 interval, that setting will take precedence.
130 =item B<AutoLoadPlugin> B<false>|B<true>
132 When set to B<false> (the default), each plugin needs to be loaded explicitly,
133 using the B<LoadPlugin> statement documented above. If a
134 B<E<lt>PluginE<nbsp>...E<gt>> block is encountered and no configuration
135 handling callback for this plugin has been registered, a warning is logged and
136 the block is ignored.
138 When set to B<true>, explicit B<LoadPlugin> statements are not required. Each
139 B<E<lt>PluginE<nbsp>...E<gt>> block acts as if it was immediately preceded by a
140 B<LoadPlugin> statement. B<LoadPlugin> statements are still required for
141 plugins that don't provide any configuration, e.g. the I<Load plugin>.
143 =item B<Include> I<Path> [I<pattern>]
145 If I<Path> points to a file, includes that file. If I<Path> points to a
146 directory, recursively includes all files within that directory and its
147 subdirectories. If the C<wordexp> function is available on your system,
148 shell-like wildcards are expanded before files are included. This means you can
149 use statements like the following:
151 Include "/etc/collectd.d/*.conf"
153 Starting with version 5.3, this may also be a block in which further options
154 affecting the behavior of B<Include> may be specified. The following option is
157 <Include "/etc/collectd.d">
163 =item B<Filter> I<pattern>
165 If the C<fnmatch> function is available on your system, a shell-like wildcard
166 I<pattern> may be specified to filter which files to include. This may be used
167 in combination with recursively including a directory to easily be able to
168 arbitrarily mix configuration files and other documents (e.g. README files).
169 The given example is similar to the first example above but includes all files
170 matching C<*.conf> in any subdirectory of C</etc/collectd.d>:
172 Include "/etc/collectd.d" "*.conf"
176 If more than one files are included by a single B<Include> option, the files
177 will be included in lexicographical order (as defined by the C<strcmp>
178 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
179 order in which the files are loaded.
181 To prevent loops and shooting yourself in the foot in interesting ways the
182 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
183 most uses. Since symlinks are followed it is still possible to crash the daemon
184 by looping symlinks. In our opinion significant stupidity should result in an
185 appropriate amount of pain.
187 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
188 file, but you cannot include files from within blocks.
190 =item B<PIDFile> I<File>
192 Sets where to write the PID file to. This file is overwritten when it exists
193 and deleted when the program is stopped. Some init-scripts might override this
194 setting using the B<-P> command-line option.
196 =item B<PluginDir> I<Directory>
198 Path to the plugins (shared objects) of collectd.
200 =item B<TypesDB> I<File> [I<File> ...]
202 Set one or more files that contain the data-set descriptions. See
203 L<types.db(5)> for a description of the format of this file.
205 =item B<Interval> I<Seconds>
207 Configures the interval in which to query the read plugins. Obviously smaller
208 values lead to a higher system load produced by collectd, while higher values
209 lead to more coarse statistics.
211 B<Warning:> You should set this once and then never touch it again. If you do,
212 I<you will have to delete all your RRD files> or know some serious RRDtool
213 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
215 =item B<Timeout> I<Iterations>
217 Consider a value list "missing" when no update has been read or received for
218 I<Iterations> iterations. By default, I<collectd> considers a value list
219 missing when no update has been received for twice the update interval. Since
220 this setting uses iterations, the maximum allowed time without update depends
221 on the I<Interval> information contained in each value list. This is used in
222 the I<Threshold> configuration to dispatch notifications about missing values,
223 see L<collectd-threshold(5)> for details.
225 =item B<ReadThreads> I<Num>
227 Number of threads to start for reading plugins. The default value is B<5>, but
228 you may want to increase this if you have more than five plugins that take a
229 long time to read. Mostly those are plugins that do network-IO. Setting this to
230 a value higher than the number of registered read callbacks is not recommended.
232 =item B<WriteThreads> I<Num>
234 Number of threads to start for dispatching value lists to write plugins. The
235 default value is B<5>, but you may want to increase this if you have more than
236 five plugins that may take relatively long to write to.
238 =item B<WriteQueueLimitHigh> I<HighNum>
240 =item B<WriteQueueLimitLow> I<LowNum>
242 Metrics are read by the I<read threads> and then put into a queue to be handled
243 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
244 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
245 running into memory issues in such a case, you can limit the size of this
248 By default, there is no limit and memory may grow indefinitely. This is most
249 likely not an issue for clients, i.e. instances that only handle the local
250 metrics. For servers it is recommended to set this to a non-zero value, though.
252 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
253 Each of them takes a numerical argument which is the number of metrics in the
254 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
255 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
256 I<will> be enqueued. If the number of metrics currently in the queue is between
257 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
258 proportional to the number of metrics in the queue (i.e. it increases linearly
259 until it reaches 100%.)
261 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
262 unset, the latter will default to half of B<WriteQueueLimitHigh>.
264 If you do not want to randomly drop values when the queue size is between
265 I<LowNum> and I<HighNum>, set If B<WriteQueueLimitHigh> and
266 B<WriteQueueLimitLow> to same value.
268 =item B<Hostname> I<Name>
270 Sets the hostname that identifies a host. If you omit this setting, the
271 hostname will be determined using the L<gethostname(2)> system call.
273 =item B<FQDNLookup> B<true|false>
275 If B<Hostname> is determined automatically this setting controls whether or not
276 the daemon should try to figure out the "fully qualified domain name", FQDN.
277 This is done using a lookup of the name returned by C<gethostname>. This option
278 is enabled by default.
280 =item B<PreCacheChain> I<ChainName>
282 =item B<PostCacheChain> I<ChainName>
284 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
285 see L<FILTER CONFIGURATION> below on information on chains and how these
286 setting change the daemon's behavior.
290 =head1 PLUGIN OPTIONS
292 Some plugins may register own options. These options must be enclosed in a
293 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
294 require external configuration, too. The C<apache plugin>, for example,
295 required C<mod_status> to be configured in the webserver you're going to
296 collect data from. These plugins are listed below as well, even if they don't
297 require any configuration within collectd's configuration file.
299 A list of all plugins and a short summary for each plugin can be found in the
300 F<README> file shipped with the sourcecode and hopefully binary packets as
303 =head2 Plugin C<aggregation>
305 The I<Aggregation plugin> makes it possible to aggregate several values into
306 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
307 This can be put to a wide variety of uses, e.g. average and total CPU
308 statistics for your entire fleet.
310 The grouping is powerful but, as with many powerful tools, may be a bit
311 difficult to wrap your head around. The grouping will therefore be
312 demonstrated using an example: The average and sum of the CPU usage across
313 all CPUs of each host is to be calculated.
315 To select all the affected values for our example, set C<Plugin cpu> and
316 C<Type cpu>. The other values are left unspecified, meaning "all values". The
317 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
318 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
324 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...) and
325 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
326 example, the intention is to have a new value for each host / type instance
327 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
328 It can be specified multiple times to group by more than one field.
331 GroupBy "TypeInstance"
333 We do neither specify nor group by I<plugin instance> (the CPU number), so all
334 metrics that differ in the CPU number only will be aggregated. Each
335 aggregation needs I<at least one> such field, otherwise no aggregation would
338 The full example configuration looks like this:
340 <Plugin "aggregation">
346 GroupBy "TypeInstance"
349 CalculateAverage true
353 There are a couple of limitations you should be aware of:
359 The I<Type> cannot be left unspecified, because it is not reasonable to add
360 apples to oranges. Also, the internal lookup structure won't work if you try
365 There must be at least one unspecified, ungrouped field. Otherwise nothing
370 As you can see in the example above, each aggregation has its own
371 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
372 blocks may match the same values, i.e. one value list can update multiple
373 aggregations. The following options are valid inside B<Aggregation> blocks:
377 =item B<Host> I<Host>
379 =item B<Plugin> I<Plugin>
381 =item B<PluginInstance> I<PluginInstance>
383 =item B<Type> I<Type>
385 =item B<TypeInstance> I<TypeInstance>
387 Selects the value lists to be added to this aggregation. B<Type> must be a
388 valid data set name, see L<types.db(5)> for details.
390 If the string starts with and ends with a slash (C</>), the string is
391 interpreted as a I<regular expression>. The regex flavor used are POSIX
392 extended regular expressions as described in L<regex(7)>. Example usage:
394 Host "/^db[0-9]\\.example\\.com$/"
396 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
398 Group valued by the specified field. The B<GroupBy> option may be repeated to
399 group by multiple fields.
401 =item B<SetHost> I<Host>
403 =item B<SetPlugin> I<Plugin>
405 =item B<SetPluginInstance> I<PluginInstance>
407 =item B<SetTypeInstance> I<TypeInstance>
409 Sets the appropriate part of the identifier to the provided string.
411 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
412 will be replaced with the aggregation function, e.g. "average". Not including
413 the placeholder will result in duplication warnings and/or messed up values if
414 more than one aggregation function are enabled.
416 The following example calculates the average usage of all "even" CPUs:
418 <Plugin "aggregation">
421 PluginInstance "/[0,2,4,6,8]$/"
425 SetPluginInstance "even-%{aggregation}"
428 GroupBy "TypeInstance"
430 CalculateAverage true
434 This will create the files:
440 foo.example.com/cpu-even-average/cpu-idle
444 foo.example.com/cpu-even-average/cpu-system
448 foo.example.com/cpu-even-average/cpu-user
456 =item B<CalculateNum> B<true>|B<false>
458 =item B<CalculateSum> B<true>|B<false>
460 =item B<CalculateAverage> B<true>|B<false>
462 =item B<CalculateMinimum> B<true>|B<false>
464 =item B<CalculateMaximum> B<true>|B<false>
466 =item B<CalculateStddev> B<true>|B<false>
468 Boolean options for enabling calculation of the number of value lists, their
469 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
470 are disabled by default.
474 =head2 Plugin C<amqp>
476 The I<AMQMP plugin> can be used to communicate with other instances of
477 I<collectd> or third party applications using an AMQP message broker. Values
478 are sent to or received from the broker, which handles routing, queueing and
479 possibly filtering or messages.
482 # Send values to an AMQP broker
483 <Publish "some_name">
489 Exchange "amq.fanout"
490 # ExchangeType "fanout"
491 # RoutingKey "collectd"
495 # GraphitePrefix "collectd."
496 # GraphiteEscapeChar "_"
499 # Receive values from an AMQP broker
500 <Subscribe "some_name">
506 Exchange "amq.fanout"
507 # ExchangeType "fanout"
509 # RoutingKey "collectd.#"
513 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
514 blocks, which configure sending and receiving of values respectively. The two
515 blocks are very similar, so unless otherwise noted, an option can be used in
516 either block. The name given in the blocks starting tag is only used for
517 reporting messages, but may be used to support I<flushing> of certain
518 I<Publish> blocks in the future.
522 =item B<Host> I<Host>
524 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
525 the underlying communications library, I<rabbitmq-c>, which is "localhost".
527 =item B<Port> I<Port>
529 Service name or port number on which the AMQP broker accepts connections. This
530 argument must be a string, even if the numeric form is used. Defaults to
533 =item B<VHost> I<VHost>
535 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
537 =item B<User> I<User>
539 =item B<Password> I<Password>
541 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
544 =item B<Exchange> I<Exchange>
546 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
547 By default, "amq.fanout" will be used.
549 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
550 the given exchange and the I<queue> is created, using the I<routing key> if
551 configured. See the B<Queue> and B<RoutingKey> options below.
553 =item B<ExchangeType> I<Type>
555 If given, the plugin will try to create the configured I<exchange> with this
556 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
557 be bound to this exchange.
559 =item B<Queue> I<Queue> (Subscribe only)
561 Configures the I<queue> name to subscribe to. If no queue name was configures
562 explicitly, a unique queue name will be created by the broker.
564 =item B<RoutingKey> I<Key>
566 In I<Publish> blocks, this configures the routing key to set on all outgoing
567 messages. If not given, the routing key will be computed from the I<identifier>
568 of the value. The host, plugin, type and the two instances are concatenated
569 together using dots as the separator and all containing dots replaced with
570 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
571 possible to receive only specific values using a "topic" exchange.
573 In I<Subscribe> blocks, configures the I<routing key> used when creating a
574 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
575 used to filter messages when using a "topic" exchange. If you're only
576 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
579 =item B<Persistent> B<true>|B<false> (Publish only)
581 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
582 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
583 default), the I<transient> delivery mode will be used, i.e. messages may be
584 lost due to high load, overflowing queues or similar issues.
586 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
588 Selects the format in which messages are sent to the broker. If set to
589 B<Command> (the default), values are sent as C<PUTVAL> commands which are
590 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
591 case, the C<Content-Type> header field will be set to C<text/collectd>.
593 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
594 an easy and straight forward exchange format. The C<Content-Type> header field
595 will be set to C<application/json>.
597 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
598 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
601 A subscribing client I<should> use the C<Content-Type> header field to
602 determine how to decode the values. Currently, the I<AMQP plugin> itself can
603 only decode the B<Command> format.
605 =item B<StoreRates> B<true>|B<false> (Publish only)
607 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
608 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
609 default), no conversion is performed. Otherwise the conversion is performed
610 using the internal value cache.
612 Please note that currently this option is only used if the B<Format> option has
615 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
617 A prefix can be added in the metric name when outputting in the I<Graphite> format.
618 It's added before the I<Host> name.
619 Metric name will be "<prefix><host><postfix><plugin><type><name>"
621 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
623 A postfix can be added in the metric name when outputting in the I<Graphite> format.
624 It's added after the I<Host> name.
625 Metric name will be "<prefix><host><postfix><plugin><type><name>"
627 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
629 Specify a character to replace dots (.) in the host part of the metric name.
630 In I<Graphite> metric name, dots are used as separators between different
631 metric parts (host, plugin, type).
632 Default is "_" (I<Underscore>).
636 =head2 Plugin C<apache>
638 To configure the C<apache>-plugin you first need to configure the Apache
639 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
640 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
641 the following snipped to base your Apache config upon:
644 <IfModule mod_status.c>
645 <Location /mod_status>
646 SetHandler server-status
650 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
651 also supported. It introduces a new field, called C<BusyServers>, to count the
652 number of currently connected clients. This field is also supported.
654 The configuration of the I<Apache> plugin consists of one or more
655 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
656 as the instance name. For example:
660 URL "http://www1.example.com/mod_status?auto"
663 URL "http://www2.example.com/mod_status?auto"
667 The instance name will be used as the I<plugin instance>. To emulate the old
668 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
669 plugin to work correctly, each instance name must be unique. This is not
670 enforced by the plugin and it is your responsibility to ensure it.
672 The following options are accepted within each I<Instance> block:
676 =item B<URL> I<http://host/mod_status?auto>
678 Sets the URL of the C<mod_status> output. This needs to be the output generated
679 by C<ExtendedStatus on> and it needs to be the machine readable output
680 generated by appending the C<?auto> argument. This option is I<mandatory>.
682 =item B<User> I<Username>
684 Optional user name needed for authentication.
686 =item B<Password> I<Password>
688 Optional password needed for authentication.
690 =item B<VerifyPeer> B<true|false>
692 Enable or disable peer SSL certificate verification. See
693 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
695 =item B<VerifyHost> B<true|false>
697 Enable or disable peer host name verification. If enabled, the plugin checks
698 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
699 certificate matches the host name provided by the B<URL> option. If this
700 identity check fails, the connection is aborted. Obviously, only works when
701 connecting to a SSL enabled server. Enabled by default.
703 =item B<CACert> I<File>
705 File that holds one or more SSL certificates. If you want to use HTTPS you will
706 possibly need this option. What CA certificates come bundled with C<libcurl>
707 and are checked by default depends on the distribution you use.
711 =head2 Plugin C<apcups>
715 =item B<Host> I<Hostname>
717 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
718 that IPv6 support has been disabled unless someone can confirm or decline that
719 B<apcupsd> can handle it.
721 =item B<Port> I<Port>
723 TCP-Port to connect to. Defaults to B<3551>.
725 =item B<ReportSeconds> B<true|false>
727 If set to B<true>, the time reported in the C<timeleft> metric will be
728 converted to seconds. This is the recommended setting. If set to B<false>, the
729 default for backwards compatibility, the time will be reported in minutes.
733 =head2 Plugin C<aquaero>
735 This plugin collects the value of the available sensors in an
736 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
737 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
738 connection for monitoring and configuration. The board can handle multiple
739 temperature sensors, fans, water pumps and water level sensors and adjust the
740 output settings such as fan voltage or power used by the water pump based on
741 the available inputs using a configurable controller included in the board.
742 This plugin collects all the available inputs as well as some of the output
743 values chosen by this controller. The plugin is based on the I<libaquaero5>
744 library provided by I<aquatools-ng>.
748 =item B<Device> I<DevicePath>
750 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
751 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
752 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
756 =head2 Plugin C<ascent>
758 This plugin collects information about an Ascent server, a free server for the
759 "World of Warcraft" game. This plugin gathers the information by fetching the
760 XML status page using C<libcurl> and parses it using C<libxml2>.
762 The configuration options are the same as for the C<apache> plugin above:
766 =item B<URL> I<http://localhost/ascent/status/>
768 Sets the URL of the XML status output.
770 =item B<User> I<Username>
772 Optional user name needed for authentication.
774 =item B<Password> I<Password>
776 Optional password needed for authentication.
778 =item B<VerifyPeer> B<true|false>
780 Enable or disable peer SSL certificate verification. See
781 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
783 =item B<VerifyHost> B<true|false>
785 Enable or disable peer host name verification. If enabled, the plugin checks
786 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
787 certificate matches the host name provided by the B<URL> option. If this
788 identity check fails, the connection is aborted. Obviously, only works when
789 connecting to a SSL enabled server. Enabled by default.
791 =item B<CACert> I<File>
793 File that holds one or more SSL certificates. If you want to use HTTPS you will
794 possibly need this option. What CA certificates come bundled with C<libcurl>
795 and are checked by default depends on the distribution you use.
799 =head2 Plugin C<bind>
801 Starting with BIND 9.5.0, the most widely used DNS server software provides
802 extensive statistics about queries, responses and lots of other information.
803 The bind plugin retrieves this information that's encoded in XML and provided
804 via HTTP and submits the values to collectd.
806 To use this plugin, you first need to tell BIND to make this information
807 available. This is done with the C<statistics-channels> configuration option:
809 statistics-channels {
810 inet localhost port 8053;
813 The configuration follows the grouping that can be seen when looking at the
814 data with an XSLT compatible viewer, such as a modern web browser. It's
815 probably a good idea to make yourself familiar with the provided values, so you
816 can understand what the collected statistics actually mean.
821 URL "http://localhost:8053/"
836 Zone "127.in-addr.arpa/IN"
840 The bind plugin accepts the following configuration options:
846 URL from which to retrieve the XML data. If not specified,
847 C<http://localhost:8053/> will be used.
849 =item B<ParseTime> B<true>|B<false>
851 When set to B<true>, the time provided by BIND will be parsed and used to
852 dispatch the values. When set to B<false>, the local time source is queried.
854 This setting is set to B<true> by default for backwards compatibility; setting
855 this to B<false> is I<recommended> to avoid problems with timezones and
858 =item B<OpCodes> B<true>|B<false>
860 When enabled, statistics about the I<"OpCodes">, for example the number of
861 C<QUERY> packets, are collected.
865 =item B<QTypes> B<true>|B<false>
867 When enabled, the number of I<incoming> queries by query types (for example
868 C<A>, C<MX>, C<AAAA>) is collected.
872 =item B<ServerStats> B<true>|B<false>
874 Collect global server statistics, such as requests received over IPv4 and IPv6,
875 successful queries, and failed updates.
879 =item B<ZoneMaintStats> B<true>|B<false>
881 Collect zone maintenance statistics, mostly information about notifications
882 (zone updates) and zone transfers.
886 =item B<ResolverStats> B<true>|B<false>
888 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
889 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
890 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
891 default. Use the B<ResolverStats> option within a B<View "_default"> block
892 instead for the same functionality.
898 Collect global memory statistics.
902 =item B<View> I<Name>
904 Collect statistics about a specific I<"view">. BIND can behave different,
905 mostly depending on the source IP-address of the request. These different
906 configurations are called "views". If you don't use this feature, you most
907 likely are only interested in the C<_default> view.
909 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
910 information you want to collect about a view. If no B<View> block is
911 configured, no detailed view statistics will be collected.
915 =item B<QTypes> B<true>|B<false>
917 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
922 =item B<ResolverStats> B<true>|B<false>
924 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
925 (e.E<nbsp>g. queries over IPv4, lame servers).
929 =item B<CacheRRSets> B<true>|B<false>
931 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
932 type is collected. Negative entries (queries which resulted in an error, for
933 example names that do not exist) are reported with a leading exclamation mark,
938 =item B<Zone> I<Name>
940 When given, collect detailed information about the given zone in the view. The
941 information collected if very similar to the global B<ServerStats> information
944 You can repeat this option to collect detailed information about multiple
947 By default no detailed zone information is collected.
953 =head2 Plugin C<ceph>
955 The ceph plugin collects values from JSON data to be parsed by B<libjson-c>
956 (L<https://github.com/json-c/json-c>) retrieved from a ceph daemon admin socket.
958 A separate B<Daemon> block must be configured for each ceph daemon to be
959 monitored. The following example will read daemon statistics from three
960 separate ceph daemons running on the same device (one OSD, one MON, one MDS) :
964 SocketPath "/var/run/ceph/ceph-osd.0.asok"
967 SocketPath "/var/run/ceph/ceph-mon.ceph1.asok"
970 SocketPath "/var/run/ceph/ceph-mds.ceph1.asok"
974 Each B<Daemon> block must have a string argument for the plugin instance name.
975 A B<SocketPath> is also required for each B<Daemon> block.
979 =item B<Daemon> I<Name>
981 Name to be used as the instance name for this daemon.
983 =item B<SocketPath> I<SocketPath>
985 Specifies the path to the UNIX admin socket of the ceph daemon.
989 =head2 Plugin C<cgroups>
991 This plugin collects the CPU user/system time for each I<cgroup> by reading the
992 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
993 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
997 =item B<CGroup> I<Directory>
999 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1000 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1003 =item B<IgnoreSelected> B<true>|B<false>
1005 Invert the selection: If set to true, all cgroups I<except> the ones that
1006 match any one of the criteria are collected. By default only selected
1007 cgroups are collected if a selection is made. If no selection is configured
1008 at all, B<all> cgroups are selected.
1012 =head2 Plugin C<cpu>
1014 The I<CPU plugin> collects CPU usage metrics.
1016 The following configuration options are available:
1020 =item B<ReportActive> B<false>|B<true>
1022 Reports non-idle CPU usage as the "active" value. Defaults to false.
1024 =item B<ReportByCpu> B<false>|B<true>
1026 When true reports usage for all cores. When false, reports cpu usage
1027 aggregated over all cores. Implies ValuesPercentage when false.
1030 =item B<ValuesPercentage> B<false>|B<true>
1032 When true report percentage usage instead of tick values. Defaults to false.
1037 =head2 Plugin C<cpufreq>
1039 This plugin doesn't have any options. It reads
1040 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1041 installed) to get the current CPU frequency. If this file does not exist make
1042 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1043 installed and an "cpu governor" (that's a kernel module) is loaded.
1045 =head2 Plugin C<csv>
1049 =item B<DataDir> I<Directory>
1051 Set the directory to store CSV-files under. Per default CSV-files are generated
1052 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1053 The special strings B<stdout> and B<stderr> can be used to write to the standard
1054 output and standard error channels, respectively. This, of course, only makes
1055 much sense when collectd is running in foreground- or non-daemon-mode.
1057 =item B<StoreRates> B<true|false>
1059 If set to B<true>, convert counter values to rates. If set to B<false> (the
1060 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1065 =head2 Plugin C<curl>
1067 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1068 and the match infrastructure (the same code used by the tail plugin) to use
1069 regular expressions with the received data.
1071 The following example will read the current value of AMD stock from Google's
1072 finance page and dispatch the value to collectd.
1075 <Page "stock_quotes">
1076 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1080 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1081 DSType "GaugeAverage"
1082 # Note: `stock_value' is not a standard type.
1089 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1090 a web page and one or more "matches" to be performed on the returned data. The
1091 string argument to the B<Page> block is used as plugin instance.
1093 The following options are valid within B<Page> blocks:
1099 URL of the web site to retrieve. Since a regular expression will be used to
1100 extract information from this data, non-binary data is a big plus here ;)
1102 =item B<User> I<Name>
1104 Username to use if authorization is required to read the page.
1106 =item B<Password> I<Password>
1108 Password to use if authorization is required to read the page.
1110 =item B<Digest> B<true>|B<false>
1112 Enable HTTP digest authentication.
1114 =item B<VerifyPeer> B<true>|B<false>
1116 Enable or disable peer SSL certificate verification. See
1117 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1119 =item B<VerifyHost> B<true>|B<false>
1121 Enable or disable peer host name verification. If enabled, the plugin checks if
1122 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1123 matches the host name provided by the B<URL> option. If this identity check
1124 fails, the connection is aborted. Obviously, only works when connecting to a
1125 SSL enabled server. Enabled by default.
1127 =item B<CACert> I<file>
1129 File that holds one or more SSL certificates. If you want to use HTTPS you will
1130 possibly need this option. What CA certificates come bundled with C<libcurl>
1131 and are checked by default depends on the distribution you use.
1133 =item B<Header> I<Header>
1135 A HTTP header to add to the request. Multiple headers are added if this option
1136 is specified more than once.
1138 =item B<Post> I<Body>
1140 Specifies that the HTTP operation should be a POST instead of a GET. The
1141 complete data to be posted is given as the argument. This option will usually
1142 need to be accompanied by a B<Header> option to set an appropriate
1143 C<Content-Type> for the post body (e.g. to
1144 C<application/x-www-form-urlencoded>).
1146 =item B<MeasureResponseTime> B<true>|B<false>
1148 Measure response time for the request. If this setting is enabled, B<Match>
1149 blocks (see below) are optional. Disabled by default.
1151 =item B<E<lt>MatchE<gt>>
1153 One or more B<Match> blocks that define how to match information in the data
1154 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1155 used by the C<tail> plugin, so please see the documentation of the C<tail>
1156 plugin below on how matches are defined. If the B<MeasureResponseTime> option
1157 is set to B<true>, B<Match> blocks are optional.
1161 =head2 Plugin C<curl_json>
1163 The B<curl_json plugin> collects values from JSON data to be parsed by
1164 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) retrieved via
1165 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1166 unix socket. The former can be used, for example, to collect values
1167 from CouchDB documents (which are stored JSON notation), and the
1168 latter to collect values from a uWSGI stats socket.
1170 The following example will collect several values from the built-in
1171 C<_stats> runtime statistics module of I<CouchDB>
1172 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1175 <URL "http://localhost:5984/_stats">
1177 <Key "httpd/requests/count">
1178 Type "http_requests"
1181 <Key "httpd_request_methods/*/count">
1182 Type "http_request_methods"
1185 <Key "httpd_status_codes/*/count">
1186 Type "http_response_codes"
1191 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1194 <Sock "/var/run/uwsgi.stats.sock">
1196 <Key "workers/*/requests">
1197 Type "http_requests"
1200 <Key "workers/*/apps/*/requests">
1201 Type "http_requests"
1206 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1207 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1208 blocks defining a unix socket to read JSON from directly. Each of
1209 these blocks may have one or more B<Key> blocks.
1211 The B<Key> string argument must be in a path format. Each component is
1212 used to match the key from a JSON map or the index of an JSON
1213 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1214 values for all map keys or array indices will be collectd.
1216 The following options are valid within B<URL> blocks:
1220 =item B<Instance> I<Instance>
1222 Sets the plugin instance to I<Instance>.
1224 =item B<User> I<Name>
1226 =item B<Password> I<Password>
1228 =item B<Digest> B<true>|B<false>
1230 =item B<VerifyPeer> B<true>|B<false>
1232 =item B<VerifyHost> B<true>|B<false>
1234 =item B<CACert> I<file>
1236 =item B<Header> I<Header>
1238 =item B<Post> I<Body>
1240 These options behave exactly equivalent to the appropriate options of the
1241 I<cURL> plugin. Please see there for a detailed description.
1245 The following options are valid within B<Key> blocks:
1249 =item B<Type> I<Type>
1251 Sets the type used to dispatch the values to the daemon. Detailed information
1252 about types and their configuration can be found in L<types.db(5)>. This
1253 option is mandatory.
1255 =item B<Instance> I<Instance>
1257 Type-instance to use. Defaults to the current map key or current string array element value.
1261 =head2 Plugin C<curl_xml>
1263 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1264 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1267 <URL "http://localhost/stats.xml">
1269 Instance "some_instance"
1274 CACert "/path/to/ca.crt"
1276 <XPath "table[@id=\"magic_level\"]/tr">
1278 #InstancePrefix "prefix-"
1279 InstanceFrom "td[1]"
1280 ValuesFrom "td[2]/span[@class=\"level\"]"
1285 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1286 URL to be fetched using libcurl. Within each B<URL> block there are
1287 options which specify the connection parameters, for example authentication
1288 information, and one or more B<XPath> blocks.
1290 Each B<XPath> block specifies how to get one type of information. The
1291 string argument must be a valid XPath expression which returns a list
1292 of "base elements". One value is dispatched for each "base element". The
1293 I<type instance> and values are looked up using further I<XPath> expressions
1294 that should be relative to the base element.
1296 Within the B<URL> block the following options are accepted:
1300 =item B<Host> I<Name>
1302 Use I<Name> as the host name when submitting values. Defaults to the global
1305 =item B<Instance> I<Instance>
1307 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1308 empty string (no plugin instance).
1310 =item B<Namespace> I<Prefix> I<URL>
1312 If an XPath expression references namespaces, they must be specified
1313 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1314 I<URL> is the "namespace name", an URI reference uniquely identifying the
1315 namespace. The option can be repeated to register multiple namespaces.
1319 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1320 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1322 =item B<User> I<User>
1324 =item B<Password> I<Password>
1326 =item B<Digest> B<true>|B<false>
1328 =item B<VerifyPeer> B<true>|B<false>
1330 =item B<VerifyHost> B<true>|B<false>
1332 =item B<CACert> I<CA Cert File>
1334 =item B<Header> I<Header>
1336 =item B<Post> I<Body>
1338 These options behave exactly equivalent to the appropriate options of the
1339 I<cURL plugin>. Please see there for a detailed description.
1341 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1343 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1344 B<XPath> block specifies how to get one type of information. The string
1345 argument must be a valid XPath expression which returns a list of "base
1346 elements". One value is dispatched for each "base element".
1348 Within the B<XPath> block the following options are accepted:
1352 =item B<Type> I<Type>
1354 Specifies the I<Type> used for submitting patches. This determines the number
1355 of values that are required / expected and whether the strings are parsed as
1356 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1357 This option is required.
1359 =item B<InstancePrefix> I<InstancePrefix>
1361 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1362 concatenated together without any separator.
1363 This option is optional.
1365 =item B<InstanceFrom> I<InstanceFrom>
1367 Specifies a XPath expression to use for determining the I<type instance>. The
1368 XPath expression must return exactly one element. The element's value is then
1369 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1371 This value is required. As a special exception, if the "base XPath expression"
1372 (the argument to the B<XPath> block) returns exactly one argument, then this
1373 option may be omitted.
1375 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1377 Specifies one or more XPath expression to use for reading the values. The
1378 number of XPath expressions must match the number of data sources in the
1379 I<type> specified with B<Type> (see above). Each XPath expression must return
1380 exactly one element. The element's value is then parsed as a number and used as
1381 value for the appropriate value in the value list dispatched to the daemon.
1387 =head2 Plugin C<dbi>
1389 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1390 connect to various databases, execute I<SQL> statements and read back the
1391 results. I<dbi> is an acronym for "database interface" in case you were
1392 wondering about the name. You can configure how each column is to be
1393 interpreted and the plugin will generate one or more data sets from each row
1394 returned according to these rules.
1396 Because the plugin is very generic, the configuration is a little more complex
1397 than those of other plugins. It usually looks something like this:
1400 <Query "out_of_stock">
1401 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1402 # Use with MySQL 5.0.0 or later
1406 InstancePrefix "out_of_stock"
1407 InstancesFrom "category"
1411 <Database "product_information">
1413 DriverOption "host" "localhost"
1414 DriverOption "username" "collectd"
1415 DriverOption "password" "aZo6daiw"
1416 DriverOption "dbname" "prod_info"
1417 SelectDB "prod_info"
1418 Query "out_of_stock"
1422 The configuration above defines one query with one result and one database. The
1423 query is then linked to the database with the B<Query> option I<within> the
1424 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1425 and you can also use the B<Include> statement to split up the configuration
1426 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1427 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1430 The following is a complete list of options:
1432 =head3 B<Query> blocks
1434 Query blocks define I<SQL> statements and how the returned data should be
1435 interpreted. They are identified by the name that is given in the opening line
1436 of the block. Thus the name needs to be unique. Other than that, the name is
1437 not used in collectd.
1439 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1440 define which column holds which value or instance information. You can use
1441 multiple B<Result> blocks to create multiple values from one returned row. This
1442 is especially useful, when queries take a long time and sending almost the same
1443 query again and again is not desirable.
1447 <Query "environment">
1448 Statement "select station, temperature, humidity from environment"
1451 # InstancePrefix "foo"
1452 InstancesFrom "station"
1453 ValuesFrom "temperature"
1457 InstancesFrom "station"
1458 ValuesFrom "humidity"
1462 The following options are accepted:
1466 =item B<Statement> I<SQL>
1468 Sets the statement that should be executed on the server. This is B<not>
1469 interpreted by collectd, but simply passed to the database server. Therefore,
1470 the SQL dialect that's used depends on the server collectd is connected to.
1472 The query has to return at least two columns, one for the instance and one
1473 value. You cannot omit the instance, even if the statement is guaranteed to
1474 always return exactly one line. In that case, you can usually specify something
1477 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1479 (That works with MySQL but may not be valid SQL according to the spec. If you
1480 use a more strict database server, you may have to select from a dummy table or
1483 Please note that some databases, for example B<Oracle>, will fail if you
1484 include a semicolon at the end of the statement.
1486 =item B<MinVersion> I<Version>
1488 =item B<MaxVersion> I<Value>
1490 Only use this query for the specified database version. You can use these
1491 options to provide multiple queries with the same name but with a slightly
1492 different syntax. The plugin will use only those queries, where the specified
1493 minimum and maximum versions fit the version of the database in use.
1495 The database version is determined by C<dbi_conn_get_engine_version>, see the
1496 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1497 for details. Basically, each part of the version is assumed to be in the range
1498 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1499 "40102", version "5.0.42" becomes "50042".
1501 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1502 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1503 happen. Don't to it! A valid example would be something along these lines:
1514 In the above example, there are three ranges that don't overlap. The last one
1515 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1516 before "4.0.0" are not specified.
1518 =item B<Type> I<Type>
1520 The B<type> that's used for each line returned. See L<types.db(5)> for more
1521 details on how types are defined. In short: A type is a predefined layout of
1522 data and the number of values and type of values has to match the type
1525 If you specify "temperature" here, you need exactly one gauge column. If you
1526 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1529 There must be exactly one B<Type> option inside each B<Result> block.
1531 =item B<InstancePrefix> I<prefix>
1533 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1534 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1535 all strings returned in the appropriate columns are concatenated together,
1536 separated by dashes I<("-")>.
1538 =item B<InstancesFrom> I<column0> [I<column1> ...]
1540 Specifies the columns whose values will be used to create the "type-instance"
1541 for each row. If you specify more than one column, the value of all columns
1542 will be joined together with dashes I<("-")> as separation characters.
1544 The plugin itself does not check whether or not all built instances are
1545 different. It's your responsibility to assure that each is unique. This is
1546 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1547 sure that only one row is returned in this case.
1549 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1552 =item B<ValuesFrom> I<column0> [I<column1> ...]
1554 Names the columns whose content is used as the actual data for the data sets
1555 that are dispatched to the daemon. How many such columns you need is determined
1556 by the B<Type> setting above. If you specify too many or not enough columns,
1557 the plugin will complain about that and no data will be submitted to the
1560 The actual data type in the columns is not that important. The plugin will
1561 automatically cast the values to the right type if it know how to do that. So
1562 it should be able to handle integer an floating point types, as well as strings
1563 (if they include a number at the beginning).
1565 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1569 =head3 B<Database> blocks
1571 Database blocks define a connection to a database and which queries should be
1572 sent to that database. Since the used "dbi" library can handle a wide variety
1573 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1574 documentationE<nbsp>- we stick as close to the terminology used there.
1576 Each database needs a "name" as string argument in the starting tag of the
1577 block. This name will be used as "PluginInstance" in the values submitted to
1578 the daemon. Other than that, that name is not used.
1582 =item B<Driver> I<Driver>
1584 Specifies the driver to use to connect to the database. In many cases those
1585 drivers are named after the database they can connect to, but this is not a
1586 technical necessity. These drivers are sometimes referred to as "DBD",
1587 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1588 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1589 project at L<http://libdbi-drivers.sourceforge.net/>.
1591 You need to give the driver name as expected by the "dbi" library here. You
1592 should be able to find that in the documentation for each driver. If you
1593 mistype the driver name, the plugin will dump a list of all known driver names
1596 =item B<DriverOption> I<Key> I<Value>
1598 Sets driver-specific options. What option a driver supports can be found in the
1599 documentation for each driver, somewhere at
1600 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1601 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1603 DBDs can register two types of options: String options and numeric options. The
1604 plugin will use the C<dbi_conn_set_option> function when the configuration
1605 provides a string and the C<dbi_conn_require_option_numeric> function when the
1606 configuration provides a number. So these two lines will actually result in
1607 different calls being used:
1609 DriverOption "Port" 1234 # numeric
1610 DriverOption "Port" "1234" # string
1612 Unfortunately, drivers are not too keen to report errors when an unknown option
1613 is passed to them, so invalid settings here may go unnoticed. This is not the
1614 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1615 the driver. If a driver complains about an option, the plugin will dump a
1616 complete list of all options understood by that driver to the log. There is no
1617 way to programatically find out if an option expects a string or a numeric
1618 argument, so you will have to refer to the appropriate DBD's documentation to
1619 find this out. Sorry.
1621 =item B<SelectDB> I<Database>
1623 In some cases, the database name you connect with is not the database name you
1624 want to use for querying data. If this option is set, the plugin will "select"
1625 (switch to) that database after the connection is established.
1627 =item B<Query> I<QueryName>
1629 Associates the query named I<QueryName> with this database connection. The
1630 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1631 blocks you want to refer to must be placed above the database block you want to
1634 =item B<Host> I<Hostname>
1636 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
1637 values. Defaults to the global hostname setting.
1645 =item B<Device> I<Device>
1647 Select partitions based on the devicename.
1649 =item B<MountPoint> I<Directory>
1651 Select partitions based on the mountpoint.
1653 =item B<FSType> I<FSType>
1655 Select partitions based on the filesystem type.
1657 =item B<IgnoreSelected> B<true>|B<false>
1659 Invert the selection: If set to true, all partitions B<except> the ones that
1660 match any one of the criteria are collected. By default only selected
1661 partitions are collected if a selection is made. If no selection is configured
1662 at all, B<all> partitions are selected.
1664 =item B<ReportByDevice> B<true>|B<false>
1666 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1667 (the default), it will report a disk as "root", but with it I<true>, it will be
1668 "sda1" (or whichever).
1670 =item B<ReportInodes> B<true>|B<false>
1672 Enables or disables reporting of free, reserved and used inodes. Defaults to
1673 inode collection being disabled.
1675 Enable this option if inodes are a scarce resource for you, usually because
1676 many small files are stored on the disk. This is a usual scenario for mail
1677 transfer agents and web caches.
1679 =item B<ValuesAbsolute> B<true>|B<false>
1681 Enables or disables reporting of free and used disk space in 1K-blocks.
1682 Defaults to B<true>.
1684 =item B<ValuesPercentage> B<false>|B<true>
1686 Enables or disables reporting of free and used disk space in percentage.
1687 Defaults to B<false>.
1689 This is useful for deploying I<collectd> on the cloud, where machines with
1690 different disk size may exist. Then it is more practical to configure
1691 thresholds based on relative disk size.
1695 =head2 Plugin C<disk>
1697 The C<disk> plugin collects information about the usage of physical disks and
1698 logical disks (partitions). Values collected are the number of octets written
1699 to and read from a disk or partition, the number of read/write operations
1700 issued to the disk and a rather complex "time" it took for these commands to be
1703 Using the following two options you can ignore some disks or configure the
1704 collection only of specific disks.
1708 =item B<Disk> I<Name>
1710 Select the disk I<Name>. Whether it is collected or ignored depends on the
1711 B<IgnoreSelected> setting, see below. As with other plugins that use the
1712 daemon's ignorelist functionality, a string that starts and ends with a slash
1713 is interpreted as a regular expression. Examples:
1718 =item B<IgnoreSelected> B<true>|B<false>
1720 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1721 statements, are ignored or if all other disks are ignored. The behavior
1722 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1723 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1724 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1725 is set to B<true>, all disks are collected B<except> the ones matched.
1729 =head2 Plugin C<dns>
1733 =item B<Interface> I<Interface>
1735 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1736 option sets the interface that should be used. If this option is not set, or
1737 set to "any", the plugin will try to get packets from B<all> interfaces. This
1738 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1740 =item B<IgnoreSource> I<IP-address>
1742 Ignore packets that originate from this address.
1744 =item B<SelectNumericQueryTypes> B<true>|B<false>
1746 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1750 =head2 Plugin C<email>
1754 =item B<SocketFile> I<Path>
1756 Sets the socket-file which is to be created.
1758 =item B<SocketGroup> I<Group>
1760 If running as root change the group of the UNIX-socket after it has been
1761 created. Defaults to B<collectd>.
1763 =item B<SocketPerms> I<Permissions>
1765 Change the file permissions of the UNIX-socket after it has been created. The
1766 permissions must be given as a numeric, octal value as you would pass to
1767 L<chmod(1)>. Defaults to B<0770>.
1769 =item B<MaxConns> I<Number>
1771 Sets the maximum number of connections that can be handled in parallel. Since
1772 this many threads will be started immediately setting this to a very high
1773 value will waste valuable resources. Defaults to B<5> and will be forced to be
1774 at most B<16384> to prevent typos and dumb mistakes.
1778 =head2 Plugin C<ethstat>
1780 The I<ethstat plugin> collects information about network interface cards (NICs)
1781 by talking directly with the underlying kernel driver using L<ioctl(2)>.
1787 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
1788 Map "multicast" "if_multicast"
1795 =item B<Interface> I<Name>
1797 Collect statistical information about interface I<Name>.
1799 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
1801 By default, the plugin will submit values as type C<derive> and I<type
1802 instance> set to I<Name>, the name of the metric as reported by the driver. If
1803 an appropriate B<Map> option exists, the given I<Type> and, optionally,
1804 I<TypeInstance> will be used.
1806 =item B<MappedOnly> B<true>|B<false>
1808 When set to B<true>, only metrics that can be mapped to to a I<type> will be
1809 collected, all other metrics will be ignored. Defaults to B<false>.
1813 =head2 Plugin C<exec>
1815 Please make sure to read L<collectd-exec(5)> before using this plugin. It
1816 contains valuable information on when the executable is executed and the
1817 output that is expected from it.
1821 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1823 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1825 Execute the executable I<Executable> as user I<User>. If the user name is
1826 followed by a colon and a group name, the effective group is set to that group.
1827 The real group and saved-set group will be set to the default group of that
1828 user. If no group is given the effective group ID will be the same as the real
1831 Please note that in order to change the user and/or group the daemon needs
1832 superuser privileges. If the daemon is run as an unprivileged user you must
1833 specify the same user/group here. If the daemon is run with superuser
1834 privileges, you must supply a non-root user here.
1836 The executable may be followed by optional arguments that are passed to the
1837 program. Please note that due to the configuration parsing numbers and boolean
1838 values may be changed. If you want to be absolutely sure that something is
1839 passed as-is please enclose it in quotes.
1841 The B<Exec> and B<NotificationExec> statements change the semantics of the
1842 programs executed, i.E<nbsp>e. the data passed to them and the response
1843 expected from them. This is documented in great detail in L<collectd-exec(5)>.
1847 =head2 Plugin C<filecount>
1849 The C<filecount> plugin counts the number of files in a certain directory (and
1850 its subdirectories) and their combined size. The configuration is very straight
1853 <Plugin "filecount">
1854 <Directory "/var/qmail/queue/mess">
1855 Instance "qmail-message"
1857 <Directory "/var/qmail/queue/todo">
1858 Instance "qmail-todo"
1860 <Directory "/var/lib/php5">
1861 Instance "php5-sessions"
1866 The example above counts the number of files in QMail's queue directories and
1867 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
1868 QMail has not yet looked at, the "message" queue holds the messages that were
1869 classified into "local" and "remote".
1871 As you can see, the configuration consists of one or more C<Directory> blocks,
1872 each of which specifies a directory in which to count the files. Within those
1873 blocks, the following options are recognized:
1877 =item B<Instance> I<Instance>
1879 Sets the plugin instance to I<Instance>. That instance name must be unique, but
1880 it's your responsibility, the plugin doesn't check for that. If not given, the
1881 instance is set to the directory name with all slashes replaced by underscores
1882 and all leading underscores removed.
1884 =item B<Name> I<Pattern>
1886 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
1887 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
1888 against the pattern, not the entire path. In case this makes it easier for you:
1889 This option has been named after the B<-name> parameter to L<find(1)>.
1891 =item B<MTime> I<Age>
1893 Count only files of a specific age: If I<Age> is greater than zero, only files
1894 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
1895 a negative number, this is inversed. For example, if B<-60> is specified, only
1896 files that have been modified in the last minute will be counted.
1898 The number can also be followed by a "multiplier" to easily specify a larger
1899 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
1900 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
1901 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
1902 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
1903 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
1906 =item B<Size> I<Size>
1908 Count only files of a specific size. When I<Size> is a positive number, only
1909 files that are at least this big are counted. If I<Size> is a negative number,
1910 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
1911 I<Size> are counted.
1913 As with the B<MTime> option, a "multiplier" may be added. For a detailed
1914 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
1915 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
1916 note that there are 1000 bytes in a kilobyte, not 1024.
1918 =item B<Recursive> I<true>|I<false>
1920 Controls whether or not to recurse into subdirectories. Enabled by default.
1922 =item B<IncludeHidden> I<true>|I<false>
1924 Controls whether or not to include "hidden" files and directories in the count.
1925 "Hidden" files and directories are those, whose name begins with a dot.
1926 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
1930 =head2 Plugin C<GenericJMX>
1932 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
1933 L<collectd-java(5)>.
1935 =head2 Plugin C<gmond>
1937 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
1938 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
1939 are built-in, custom mappings may be added via B<Metric> blocks, see below.
1944 MCReceiveFrom "239.2.11.71" "8649"
1945 <Metric "swap_total">
1947 TypeInstance "total"
1950 <Metric "swap_free">
1957 The following metrics are built-in:
1963 load_one, load_five, load_fifteen
1967 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
1971 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
1983 Available configuration options:
1987 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
1989 Sets sets the multicast group and UDP port to which to subscribe.
1991 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
1993 =item E<lt>B<Metric> I<Name>E<gt>
1995 These blocks add a new metric conversion to the internal table. I<Name>, the
1996 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2000 =item B<Type> I<Type>
2002 Type to map this metric to. Required.
2004 =item B<TypeInstance> I<Instance>
2006 Type-instance to use. Optional.
2008 =item B<DataSource> I<Name>
2010 Data source to map this metric to. If the configured type has exactly one data
2011 source, this is optional. Otherwise the option is required.
2017 =head2 Plugin C<hddtemp>
2019 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
2020 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
2021 default values, see below. C<hddtemp> has to be running to work correctly. If
2022 C<hddtemp> is not running timeouts may appear which may interfere with other
2025 The B<hddtemp> homepage can be found at
2026 L<http://www.guzu.net/linux/hddtemp.php>.
2030 =item B<Host> I<Hostname>
2032 Hostname to connect to. Defaults to B<127.0.0.1>.
2034 =item B<Port> I<Port>
2036 TCP-Port to connect to. Defaults to B<7634>.
2040 =head2 Plugin C<interface>
2044 =item B<Interface> I<Interface>
2046 Select this interface. By default these interfaces will then be collected. For
2047 a more detailed description see B<IgnoreSelected> below.
2049 =item B<IgnoreSelected> I<true>|I<false>
2051 If no configuration if given, the B<traffic>-plugin will collect data from
2052 all interfaces. This may not be practical, especially for loopback- and
2053 similar interfaces. Thus, you can use the B<Interface>-option to pick the
2054 interfaces you're interested in. Sometimes, however, it's easier/preferred
2055 to collect all interfaces I<except> a few ones. This option enables you to
2056 do that: By setting B<IgnoreSelected> to I<true> the effect of
2057 B<Interface> is inverted: All selected interfaces are ignored and all
2058 other interfaces are collected.
2062 =head2 Plugin C<ipmi>
2066 =item B<Sensor> I<Sensor>
2068 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2070 =item B<IgnoreSelected> I<true>|I<false>
2072 If no configuration if given, the B<ipmi> plugin will collect data from all
2073 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2074 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2075 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2076 all other sensors are collected.
2078 =item B<NotifySensorAdd> I<true>|I<false>
2080 If a sensor appears after initialization time of a minute a notification
2083 =item B<NotifySensorRemove> I<true>|I<false>
2085 If a sensor disappears a notification is sent.
2087 =item B<NotifySensorNotPresent> I<true>|I<false>
2089 If you have for example dual power supply and one of them is (un)plugged then
2090 a notification is sent.
2094 =head2 Plugin C<iptables>
2098 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2100 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
2101 will collect the counters of all rules which have a comment-match. The comment
2102 is then used as type-instance.
2104 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2105 the I<n>th rule will be collected. Again, the comment (or the number) will be
2106 used as the type-instance.
2108 If I<Name> is supplied, it will be used as the type-instance instead of the
2109 comment or the number.
2113 =head2 Plugin C<irq>
2119 Select this irq. By default these irqs will then be collected. For a more
2120 detailed description see B<IgnoreSelected> below.
2122 =item B<IgnoreSelected> I<true>|I<false>
2124 If no configuration if given, the B<irq>-plugin will collect data from all
2125 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2126 can use the B<Irq>-option to pick the interrupt you're interested in.
2127 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2128 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2129 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2130 and all other interrupts are collected.
2134 =head2 Plugin C<java>
2136 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2137 This section only discusses the syntax and semantic of the configuration
2138 options. For more in-depth information on the I<Java> plugin, please read
2139 L<collectd-java(5)>.
2144 JVMArg "-verbose:jni"
2145 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2146 LoadPlugin "org.collectd.java.Foobar"
2147 <Plugin "org.collectd.java.Foobar">
2148 # To be parsed by the plugin
2152 Available configuration options:
2156 =item B<JVMArg> I<Argument>
2158 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2159 exactly the way the arguments to the I<java> binary on the command line work.
2160 Execute C<javaE<nbsp>--help> for details.
2162 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2163 any other options! When another option is found, the JVM will be started and
2164 later options will have to be ignored!
2166 =item B<LoadPlugin> I<JavaClass>
2168 Instantiates a new I<JavaClass> object. The constructor of this object very
2169 likely then registers one or more callback methods with the server.
2171 See L<collectd-java(5)> for details.
2173 When the first such option is found, the virtual machine (JVM) is created. This
2174 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2175 B<LoadPlugin> options!
2177 =item B<Plugin> I<Name>
2179 The entire block is passed to the Java plugin as an
2180 I<org.collectd.api.OConfigItem> object.
2182 For this to work, the plugin has to register a configuration callback first,
2183 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2184 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2185 depends on the (Java) plugin registering the callback and is completely
2186 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2190 =head2 Plugin C<libvirt>
2192 This plugin allows CPU, disk and network load to be collected for virtualized
2193 guests on the machine. This means that these characteristics can be collected
2194 for guest systems without installing any software on them - collectd only runs
2195 on the hosting system. The statistics are collected through libvirt
2196 (L<http://libvirt.org/>).
2198 Only I<Connection> is required.
2202 =item B<Connection> I<uri>
2204 Connect to the hypervisor given by I<uri>. For example if using Xen use:
2206 Connection "xen:///"
2208 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
2210 =item B<RefreshInterval> I<seconds>
2212 Refresh the list of domains and devices every I<seconds>. The default is 60
2213 seconds. Setting this to be the same or smaller than the I<Interval> will cause
2214 the list of domains and devices to be refreshed on every iteration.
2216 Refreshing the devices in particular is quite a costly operation, so if your
2217 virtualization setup is static you might consider increasing this. If this
2218 option is set to 0, refreshing is disabled completely.
2220 =item B<Domain> I<name>
2222 =item B<BlockDevice> I<name:dev>
2224 =item B<InterfaceDevice> I<name:dev>
2226 =item B<IgnoreSelected> I<true>|I<false>
2228 Select which domains and devices are collected.
2230 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
2231 disk/network devices are collected.
2233 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
2234 domains and disk/network devices are ignored, while the rest are collected.
2236 The domain name and device names may use a regular expression, if the name is
2237 surrounded by I</.../> and collectd was compiled with support for regexps.
2239 The default is to collect statistics for all domains and all their devices.
2243 BlockDevice "/:hdb/"
2244 IgnoreSelected "true"
2246 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
2249 =item B<HostnameFormat> B<name|uuid|hostname|...>
2251 When the libvirt plugin logs data, it sets the hostname of the collected data
2252 according to this setting. The default is to use the guest name as provided by
2253 the hypervisor, which is equal to setting B<name>.
2255 B<uuid> means use the guest's UUID. This is useful if you want to track the
2256 same guest across migrations.
2258 B<hostname> means to use the global B<Hostname> setting, which is probably not
2259 useful on its own because all guests will appear to have the same name.
2261 You can also specify combinations of these fields. For example B<name uuid>
2262 means to concatenate the guest name and UUID (with a literal colon character
2263 between, thus I<"foo:1234-1234-1234-1234">).
2265 =item B<InterfaceFormat> B<name>|B<address>
2267 When the libvirt plugin logs interface data, it sets the name of the collected
2268 data according to this setting. The default is to use the path as provided by
2269 the hypervisor (the "dev" property of the target node), which is equal to
2272 B<address> means use the interface's mac address. This is useful since the
2273 interface path might change between reboots of a guest or across migrations.
2277 +=head2 Plugin C<load>
2279 The I<Load plugin> collects the system load. These numbers give a rough overview
2280 over the utilization of a machine. The system load is defined as the number of
2281 runnable tasks in the run-queue and is provided by many operating systems as a
2282 one, five or fifteen minute average.
2284 The following configuration options are available:
2288 =item B<ReportRelative> B<false>|B<true>
2290 When enabled, system load divided by number of available CPU cores is reported
2291 for intervals 1 min, 5 min and 15 min. Defaults to false.
2296 =head2 Plugin C<logfile>
2300 =item B<LogLevel> B<debug|info|notice|warning|err>
2302 Sets the log-level. If, for example, set to B<notice>, then all events with
2303 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2305 Please note that B<debug> is only available if collectd has been compiled with
2308 =item B<File> I<File>
2310 Sets the file to write log messages to. The special strings B<stdout> and
2311 B<stderr> can be used to write to the standard output and standard error
2312 channels, respectively. This, of course, only makes much sense when I<collectd>
2313 is running in foreground- or non-daemon-mode.
2315 =item B<Timestamp> B<true>|B<false>
2317 Prefix all lines printed by the current time. Defaults to B<true>.
2319 =item B<PrintSeverity> B<true>|B<false>
2321 When enabled, all lines are prefixed by the severity of the log message, for
2322 example "warning". Defaults to B<false>.
2326 B<Note>: There is no need to notify the daemon after moving or removing the
2327 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2328 for each line it writes.
2330 =head2 Plugin C<lpar>
2332 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2333 virtualization technique for IBM POWER processors. It takes into account CPU
2334 time stolen from or donated to a partition, in addition to the usual user,
2335 system, I/O statistics.
2337 The following configuration options are available:
2341 =item B<CpuPoolStats> B<false>|B<true>
2343 When enabled, statistics about the processor pool are read, too. The partition
2344 needs to have pool authority in order to be able to acquire this information.
2347 =item B<ReportBySerial> B<false>|B<true>
2349 If enabled, the serial of the physical machine the partition is currently
2350 running on is reported as I<hostname> and the logical hostname of the machine
2351 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2352 used (just like other plugins) and the I<plugin instance> will be empty.
2357 =head2 Plugin C<mbmon>
2359 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2361 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2362 B<Host> and B<Port> options can be used to change these values, see below.
2363 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2364 timeouts may appear which may interfere with other statistics..
2366 C<mbmon> must be run with the -r option ("print TAG and Value format");
2367 Debian's F</etc/init.d/mbmon> script already does this, other people
2368 will need to ensure that this is the case.
2372 =item B<Host> I<Hostname>
2374 Hostname to connect to. Defaults to B<127.0.0.1>.
2376 =item B<Port> I<Port>
2378 TCP-Port to connect to. Defaults to B<411>.
2384 The C<md plugin> collects information from Linux Software-RAID devices (md).
2386 All reported values are of the type C<md_disks>. Reported type instances are
2387 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2388 I<missing> (physically absent) disks.
2392 =item B<Device> I<Device>
2394 Select md devices based on device name. The I<device name> is the basename of
2395 the device, i.e. the name of the block device without the leading C</dev/>.
2396 See B<IgnoreSelected> for more details.
2398 =item B<IgnoreSelected> B<true>|B<false>
2400 Invert device selection: If set to B<true>, all md devices B<except> those
2401 listed using B<Device> are collected. If B<false> (the default), only those
2402 listed are collected. If no configuration is given, the B<md> plugin will
2403 collect data from all md devices.
2407 =head2 Plugin C<memcachec>
2409 The C<memcachec plugin> connects to a memcached server, queries one or more
2410 given I<pages> and parses the returned data according to user specification.
2411 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2414 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2415 library. Please note that there is another library with a very similar name,
2416 libmemcache (notice the missing `d'), which is not applicable.
2418 Synopsis of the configuration:
2420 <Plugin "memcachec">
2421 <Page "plugin_instance">
2425 Regex "(\\d+) bytes sent"
2428 Instance "type_instance"
2433 The configuration options are:
2437 =item E<lt>B<Page> I<Name>E<gt>
2439 Each B<Page> block defines one I<page> to be queried from the memcached server.
2440 The block requires one string argument which is used as I<plugin instance>.
2442 =item B<Server> I<Address>
2444 Sets the server address to connect to when querying the page. Must be inside a
2449 When connected to the memcached server, asks for the page I<Key>.
2451 =item E<lt>B<Match>E<gt>
2453 Match blocks define which strings to look for and how matches substrings are
2454 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2458 =head2 Plugin C<memcached>
2460 The B<memcached plugin> connects to a memcached server and queries statistics
2461 about cache utilization, memory and bandwidth used.
2462 L<http://www.danga.com/memcached/>
2464 <Plugin "memcached">
2466 Host "memcache.example.com"
2471 The plugin configuration consists of one or more B<Instance> blocks which
2472 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2473 following options are allowed:
2477 =item B<Host> I<Hostname>
2479 Hostname to connect to. Defaults to B<127.0.0.1>.
2481 =item B<Port> I<Port>
2483 TCP-Port to connect to. Defaults to B<11211>.
2485 =item B<Socket> I<Path>
2487 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2488 setting is given, the B<Host> and B<Port> settings are ignored.
2492 =head2 Plugin C<mic>
2494 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2495 Intel's Many Integrated Core (MIC) systems.
2504 ShowTemperatures true
2507 IgnoreSelectedTemperature true
2512 IgnoreSelectedPower true
2515 The following options are valid inside the B<PluginE<nbsp>mic> block:
2519 =item B<ShowCPU> B<true>|B<false>
2521 If enabled (the default) a sum of the CPU usage accross all cores is reported.
2523 =item B<ShowCPUCores> B<true>|B<false>
2525 If enabled (the default) per-core CPU usage is reported.
2527 =item B<ShowMemory> B<true>|B<false>
2529 If enabled (the default) the physical memory usage of the MIC system is
2532 =item B<ShowTemperatures> B<true>|B<false>
2534 If enabled (the default) various temperatures of the MIC system are reported.
2536 =item B<Temperature> I<Name>
2538 This option controls which temperatures are being reported. Whether matching
2539 temperatures are being ignored or I<only> matching temperatures are reported
2540 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2541 temperatures are reported.
2543 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2545 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2546 (the default) only temperatures matching a B<Temperature> option are reported
2547 or, if no B<Temperature> option is specified, all temperatures are reported. If
2548 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2551 Known temperature names are:
2585 =item B<ShowPower> B<true>|B<false>
2587 If enabled (the default) various temperatures of the MIC system are reported.
2589 =item B<Power> I<Name>
2591 This option controls which power readings are being reported. Whether matching
2592 power readings are being ignored or I<only> matching power readings are reported
2593 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
2594 power readings are reported.
2596 =item B<IgnoreSelectedPower> B<false>|B<true>
2598 Controls the behavior of the B<Power> setting above. If set to B<false>
2599 (the default) only power readings matching a B<Power> option are reported
2600 or, if no B<Power> option is specified, all power readings are reported. If
2601 set to B<true>, matching power readings are I<ignored> and all other power readings
2604 Known power names are:
2610 Total power utilization averaged over Time Window 0 (uWatts).
2614 Total power utilization averaged over Time Window 0 (uWatts).
2618 Instantaneous power (uWatts).
2622 Max instantaneous power (uWatts).
2626 PCI-E connector power (uWatts).
2630 2x3 connector power (uWatts).
2634 2x4 connector power (uWatts).
2642 Uncore rail (uVolts).
2646 Memory subsystem rail (uVolts).
2652 =head2 Plugin C<memory>
2654 The I<memory plugin> provides the following configuration options:
2658 =item B<ValuesAbsolute> B<true>|B<false>
2660 Enables or disables reporting of physical memory usage in absolute numbers,
2661 i.e. bytes. Defaults to B<true>.
2663 =item B<ValuesPercentage> B<false>|B<true>
2665 Enables or disables reporting of physical memory usage in percentages, e.g.
2666 percent of physical memory used. Defaults to B<false>.
2668 This is useful for deploying I<collectd> in a heterogeneous environment in
2669 which the sizes of physical memory vary.
2673 =head2 Plugin C<modbus>
2675 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
2676 register values. It supports reading single registers (unsigned 16E<nbsp>bit
2677 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2678 values (two registers interpreted as IEEE floats in big endian notation).
2682 <Data "voltage-input-1">
2689 <Data "voltage-input-2">
2696 <Host "modbus.example.com">
2697 Address "192.168.0.42"
2702 Instance "power-supply"
2703 Collect "voltage-input-1"
2704 Collect "voltage-input-2"
2710 =item E<lt>B<Data> I<Name>E<gt> blocks
2712 Data blocks define a mapping between register numbers and the "types" used by
2715 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
2719 =item B<RegisterBase> I<Number>
2721 Configures the base register to read from the device. If the option
2722 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
2723 register will be read (the register number is increased by one).
2725 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
2727 Specifies what kind of data is returned by the device. If the type is B<Int32>,
2728 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
2729 combined into one value. Defaults to B<Uint16>.
2731 =item B<Type> I<Type>
2733 Specifies the "type" (data set) to use when dispatching the value to
2734 I<collectd>. Currently, only data sets with exactly one data source are
2737 =item B<Instance> I<Instance>
2739 Sets the type instance to use when dispatching the value to I<collectd>. If
2740 unset, an empty string (no type instance) is used.
2744 =item E<lt>B<Host> I<Name>E<gt> blocks
2746 Host blocks are used to specify to which hosts to connect and what data to read
2747 from their "slaves". The string argument I<Name> is used as hostname when
2748 dispatching the values to I<collectd>.
2750 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
2754 =item B<Address> I<Hostname>
2756 Specifies the node name (the actual network address) used to connect to the
2757 host. This may be an IP address or a hostname. Please note that the used
2758 I<libmodbus> library only supports IPv4 at the moment.
2760 =item B<Port> I<Service>
2762 Specifies the port used to connect to the host. The port can either be given as
2763 a number or as a service name. Please note that the I<Service> argument must be
2764 a string, even if ports are given in their numerical form. Defaults to "502".
2766 =item B<Interval> I<Interval>
2768 Sets the interval (in seconds) in which the values will be collected from this
2769 host. By default the global B<Interval> setting will be used.
2771 =item E<lt>B<Slave> I<ID>E<gt>
2773 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
2774 is used to specify which device should be addressed. For each device you want
2775 to query, one B<Slave> block must be given.
2777 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
2781 =item B<Instance> I<Instance>
2783 Specify the plugin instance to use when dispatching the values to I<collectd>.
2784 By default "slave_I<ID>" is used.
2786 =item B<Collect> I<DataName>
2788 Specifies which data to retrieve from the device. I<DataName> must be the same
2789 string as the I<Name> argument passed to a B<Data> block. You can specify this
2790 option multiple times to collect more than one value from a slave. At least one
2791 B<Collect> option is mandatory.
2799 =head2 Plugin C<mysql>
2801 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
2802 one or more databases when started and keeps the connection up as long as
2803 possible. When the connection is interrupted for whatever reason it will try
2804 to re-connect. The plugin will complain loudly in case anything goes wrong.
2806 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
2807 and collects information about MySQL network traffic, executed statements,
2808 requests, the query cache and threads by evaluating the
2809 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
2810 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
2811 Status Variables> for an explanation of these values.
2813 Optionally, master and slave statistics may be collected in a MySQL
2814 replication setup. In that case, information about the synchronization state
2815 of the nodes are collected by evaluating the C<Position> return value of the
2816 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
2817 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
2818 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
2819 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
2820 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
2835 Socket "/var/run/mysql/mysqld.sock"
2837 SlaveNotifications true
2841 A B<Database> block defines one connection to a MySQL database. It accepts a
2842 single argument which specifies the name of the database. None of the other
2843 options are required. MySQL will use default values as documented in the
2844 section "mysql_real_connect()" in the B<MySQL reference manual>.
2848 =item B<Host> I<Hostname>
2850 Hostname of the database server. Defaults to B<localhost>.
2852 =item B<User> I<Username>
2854 Username to use when connecting to the database. The user does not have to be
2855 granted any privileges (which is synonym to granting the C<USAGE> privilege),
2856 unless you want to collectd replication statistics (see B<MasterStats> and
2857 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
2858 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
2860 =item B<Password> I<Password>
2862 Password needed to log into the database.
2864 =item B<Database> I<Database>
2866 Select this database. Defaults to I<no database> which is a perfectly reasonable
2867 option for what this plugin does.
2869 =item B<Port> I<Port>
2871 TCP-port to connect to. The port must be specified in its numeric form, but it
2872 must be passed as a string nonetheless. For example:
2876 If B<Host> is set to B<localhost> (the default), this setting has no effect.
2877 See the documentation for the C<mysql_real_connect> function for details.
2879 =item B<Socket> I<Socket>
2881 Specifies the path to the UNIX domain socket of the MySQL server. This option
2882 only has any effect, if B<Host> is set to B<localhost> (the default).
2883 Otherwise, use the B<Port> option above. See the documentation for the
2884 C<mysql_real_connect> function for details.
2886 =item B<MasterStats> I<true|false>
2888 =item B<SlaveStats> I<true|false>
2890 Enable the collection of master / slave statistics in a replication setup. In
2891 order to be able to get access to these statistics, the user needs special
2892 privileges. See the B<User> documentation above.
2894 =item B<SlaveNotifications> I<true|false>
2896 If enabled, the plugin sends a notification if the replication slave I/O and /
2897 or SQL threads are not running.
2901 =head2 Plugin C<netapp>
2903 The netapp plugin can collect various performance and capacity information
2904 from a NetApp filer using the NetApp API.
2906 Please note that NetApp has a wide line of products and a lot of different
2907 software versions for each of these products. This plugin was developed for a
2908 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
2909 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
2910 model and software version but it is very hard to test this.
2911 If you have used this plugin with other models and/or software version, feel
2912 free to send us a mail to tell us about the results, even if it's just a short
2915 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
2916 basic authentication.
2918 B<Do not use a regular user for this!> Create a special collectd user with just
2919 the minimum of capabilities needed. The user only needs the "login-http-admin"
2920 capability as well as a few more depending on which data will be collected.
2921 Required capabilities are documented below.
2926 <Host "netapp1.example.com">
2950 IgnoreSelectedIO false
2952 IgnoreSelectedOps false
2953 GetLatency "volume0"
2954 IgnoreSelectedLatency false
2961 IgnoreSelectedCapacity false
2964 IgnoreSelectedSnapshot false
2992 The netapp plugin accepts the following configuration options:
2996 =item B<Host> I<Name>
2998 A host block defines one NetApp filer. It will appear in collectd with the name
2999 you specify here which does not have to be its real name nor its hostname (see
3000 the B<Address> option below).
3002 =item B<VFiler> I<Name>
3004 A B<VFiler> block may only be used inside a host block. It accepts all the
3005 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
3006 will execute all NetApp API commands in the context of the specified
3007 VFiler(R). It will appear in collectd with the name you specify here which
3008 does not have to be its real name. The VFiler name may be specified using the
3009 B<VFilerName> option. If this is not specified, it will default to the name
3012 The VFiler block inherits all connection related settings from the surrounding
3013 B<Host> block (which appear before the B<VFiler> block) but they may be
3014 overwritten inside the B<VFiler> block.
3016 This feature is useful, for example, when using a VFiler as SnapVault target
3017 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
3018 available in the host filer (vfiler0) but only in the respective VFiler
3021 =item B<Protocol> B<httpd>|B<http>
3023 The protocol collectd will use to query this host.
3031 Valid options: http, https
3033 =item B<Address> I<Address>
3035 The hostname or IP address of the host.
3041 Default: The "host" block's name.
3043 =item B<Port> I<Port>
3045 The TCP port to connect to on the host.
3051 Default: 80 for protocol "http", 443 for protocol "https"
3053 =item B<User> I<User>
3055 =item B<Password> I<Password>
3057 The username and password to use to login to the NetApp.
3063 =item B<VFilerName> I<Name>
3065 The name of the VFiler in which context to execute API commands. If not
3066 specified, the name provided to the B<VFiler> block will be used instead.
3072 Default: name of the B<VFiler> block
3074 B<Note:> This option may only be used inside B<VFiler> blocks.
3076 =item B<Interval> I<Interval>
3082 The following options decide what kind of data will be collected. You can
3083 either use them as a block and fine tune various parameters inside this block,
3084 use them as a single statement to just accept all default values, or omit it to
3085 not collect any data.
3087 The following options are valid inside all blocks:
3091 =item B<Interval> I<Seconds>
3093 Collect the respective statistics every I<Seconds> seconds. Defaults to the
3094 host specific setting.
3098 =head3 The System block
3100 This will collect various performance data about the whole system.
3102 B<Note:> To get this data the collectd user needs the
3103 "api-perf-object-get-instances" capability.
3107 =item B<Interval> I<Seconds>
3109 Collect disk statistics every I<Seconds> seconds.
3111 =item B<GetCPULoad> B<true>|B<false>
3113 If you set this option to true the current CPU usage will be read. This will be
3114 the average usage between all CPUs in your NetApp without any information about
3117 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3118 returns in the "CPU" field.
3126 Result: Two value lists of type "cpu", and type instances "idle" and "system".
3128 =item B<GetInterfaces> B<true>|B<false>
3130 If you set this option to true the current traffic of the network interfaces
3131 will be read. This will be the total traffic over all interfaces of your NetApp
3132 without any information about individual interfaces.
3134 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3135 in the "Net kB/s" field.
3145 Result: One value list of type "if_octects".
3147 =item B<GetDiskIO> B<true>|B<false>
3149 If you set this option to true the current IO throughput will be read. This
3150 will be the total IO of your NetApp without any information about individual
3151 disks, volumes or aggregates.
3153 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3154 in the "DiskE<nbsp>kB/s" field.
3162 Result: One value list of type "disk_octets".
3164 =item B<GetDiskOps> B<true>|B<false>
3166 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
3167 iSCSI, etc. operations will be read. This will be the total number of
3168 operations on your NetApp without any information about individual volumes or
3171 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3172 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
3180 Result: A variable number of value lists of type "disk_ops_complex". Each type
3181 of operation will result in one value list with the name of the operation as
3186 =head3 The WAFL block
3188 This will collect various performance data about the WAFL file system. At the
3189 moment this just means cache performance.
3191 B<Note:> To get this data the collectd user needs the
3192 "api-perf-object-get-instances" capability.
3194 B<Note:> The interface to get these values is classified as "Diagnostics" by
3195 NetApp. This means that it is not guaranteed to be stable even between minor
3200 =item B<Interval> I<Seconds>
3202 Collect disk statistics every I<Seconds> seconds.
3204 =item B<GetNameCache> B<true>|B<false>
3212 Result: One value list of type "cache_ratio" and type instance
3215 =item B<GetDirCache> B<true>|B<false>
3223 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3225 =item B<GetInodeCache> B<true>|B<false>
3233 Result: One value list of type "cache_ratio" and type instance
3236 =item B<GetBufferCache> B<true>|B<false>
3238 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3239 in the "Cache hit" field.
3247 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3251 =head3 The Disks block
3253 This will collect performance data about the individual disks in the NetApp.
3255 B<Note:> To get this data the collectd user needs the
3256 "api-perf-object-get-instances" capability.
3260 =item B<Interval> I<Seconds>
3262 Collect disk statistics every I<Seconds> seconds.
3264 =item B<GetBusy> B<true>|B<false>
3266 If you set this option to true the busy time of all disks will be calculated
3267 and the value of the busiest disk in the system will be written.
3269 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3270 in the "Disk util" field. Probably.
3278 Result: One value list of type "percent" and type instance "disk_busy".
3282 =head3 The VolumePerf block
3284 This will collect various performance data about the individual volumes.
3286 You can select which data to collect about which volume using the following
3287 options. They follow the standard ignorelist semantic.
3289 B<Note:> To get this data the collectd user needs the
3290 I<api-perf-object-get-instances> capability.
3294 =item B<Interval> I<Seconds>
3296 Collect volume performance data every I<Seconds> seconds.
3298 =item B<GetIO> I<Volume>
3300 =item B<GetOps> I<Volume>
3302 =item B<GetLatency> I<Volume>
3304 Select the given volume for IO, operations or latency statistics collection.
3305 The argument is the name of the volume without the C</vol/> prefix.
3307 Since the standard ignorelist functionality is used here, you can use a string
3308 starting and ending with a slash to specify regular expression matching: To
3309 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3312 GetIO "/^vol[027]$/"
3314 If no regular expression is specified, an exact match is required. Both,
3315 regular and exact matching are case sensitive.
3317 If no volume was specified at all for either of the three options, that data
3318 will be collected for all available volumes.
3320 =item B<IgnoreSelectedIO> B<true>|B<false>
3322 =item B<IgnoreSelectedOps> B<true>|B<false>
3324 =item B<IgnoreSelectedLatency> B<true>|B<false>
3326 When set to B<true>, the volumes selected for IO, operations or latency
3327 statistics collection will be ignored and the data will be collected for all
3330 When set to B<false>, data will only be collected for the specified volumes and
3331 all other volumes will be ignored.
3333 If no volumes have been specified with the above B<Get*> options, all volumes
3334 will be collected regardless of the B<IgnoreSelected*> option.
3336 Defaults to B<false>
3340 =head3 The VolumeUsage block
3342 This will collect capacity data about the individual volumes.
3344 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3349 =item B<Interval> I<Seconds>
3351 Collect volume usage statistics every I<Seconds> seconds.
3353 =item B<GetCapacity> I<VolumeName>
3355 The current capacity of the volume will be collected. This will result in two
3356 to four value lists, depending on the configuration of the volume. All data
3357 sources are of type "df_complex" with the name of the volume as
3360 There will be type_instances "used" and "free" for the number of used and
3361 available bytes on the volume. If the volume has some space reserved for
3362 snapshots, a type_instance "snap_reserved" will be available. If the volume
3363 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3364 number of bytes saved by the SIS feature.
3366 B<Note:> The current NetApp API has a bug that results in this value being
3367 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3368 number which works most of the time. If you see strange values here, bug
3369 NetApp support to fix this.
3371 Repeat this option to specify multiple volumes.
3373 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3375 Specify whether to collect only the volumes selected by the B<GetCapacity>
3376 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3377 B<false>. However, if no B<GetCapacity> option is specified at all, all
3378 capacities will be selected anyway.
3380 =item B<GetSnapshot> I<VolumeName>
3382 Select volumes from which to collect snapshot information.
3384 Usually, the space used for snapshots is included in the space reported as
3385 "used". If snapshot information is collected as well, the space used for
3386 snapshots is subtracted from the used space.
3388 To make things even more interesting, it is possible to reserve space to be
3389 used for snapshots. If the space required for snapshots is less than that
3390 reserved space, there is "reserved free" and "reserved used" space in addition
3391 to "free" and "used". If the space required for snapshots exceeds the reserved
3392 space, that part allocated in the normal space is subtracted from the "used"
3395 Repeat this option to specify multiple volumes.
3397 =item B<IgnoreSelectedSnapshot>
3399 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3400 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3401 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3402 capacities will be selected anyway.
3406 =head3 The Quota block
3408 This will collect (tree) quota statistics (used disk space and number of used
3409 files). This mechanism is useful to get usage information for single qtrees.
3410 In case the quotas are not used for any other purpose, an entry similar to the
3411 following in C</etc/quotas> would be sufficient:
3413 /vol/volA/some_qtree tree - - - - -
3415 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3419 =item B<Interval> I<Seconds>
3421 Collect SnapVault(R) statistics every I<Seconds> seconds.
3425 =head3 The SnapVault block
3427 This will collect statistics about the time and traffic of SnapVault(R)
3432 =item B<Interval> I<Seconds>
3434 Collect SnapVault(R) statistics every I<Seconds> seconds.
3438 =head2 Plugin C<netlink>
3440 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3441 statistics of various interface and routing aspects.
3445 =item B<Interface> I<Interface>
3447 =item B<VerboseInterface> I<Interface>
3449 Instruct the plugin to collect interface statistics. This is basically the same
3450 as the statistics provided by the C<interface> plugin (see above) but
3451 potentially much more detailed.
3453 When configuring with B<Interface> only the basic statistics will be collected,
3454 namely octets, packets, and errors. These statistics are collected by
3455 the C<interface> plugin, too, so using both at the same time is no benefit.
3457 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3458 so that no data needs to be collected twice if you use the C<interface> plugin.
3459 This includes dropped packets, received multicast packets, collisions and a
3460 whole zoo of differentiated RX and TX errors. You can try the following command
3461 to get an idea of what awaits you:
3465 If I<Interface> is B<All>, all interfaces will be selected.
3467 =item B<QDisc> I<Interface> [I<QDisc>]
3469 =item B<Class> I<Interface> [I<Class>]
3471 =item B<Filter> I<Interface> [I<Filter>]
3473 Collect the octets and packets that pass a certain qdisc, class or filter.
3475 QDiscs and classes are identified by their type and handle (or classid).
3476 Filters don't necessarily have a handle, therefore the parent's handle is used.
3477 The notation used in collectd differs from that used in tc(1) in that it
3478 doesn't skip the major or minor number if it's zero and doesn't print special
3479 ids by their name. So, for example, a qdisc may be identified by
3480 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3481 thus not displayed by tc(1).
3483 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3484 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3485 associated with that interface will be collected.
3487 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3488 used. This may lead to problems when more than one filter is attached to a
3489 qdisc or class. This isn't nice, but we don't know how this could be done any
3490 better. If you have a idea, please don't hesitate to tell us.
3492 As with the B<Interface> option you can specify B<All> as the interface,
3493 meaning all interfaces.
3495 Here are some examples to help you understand the above text more easily:
3498 VerboseInterface "All"
3499 QDisc "eth0" "pfifo_fast-1:0"
3501 Class "ppp0" "htb-1:10"
3502 Filter "ppp0" "u32-1:0"
3505 =item B<IgnoreSelected>
3507 The behavior is the same as with all other similar plugins: If nothing is
3508 selected at all, everything is collected. If some things are selected using the
3509 options described above, only these statistics are collected. If you set
3510 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3511 specified statistics will not be collected.
3515 =head2 Plugin C<network>
3517 The Network plugin sends data to a remote instance of collectd, receives data
3518 from a remote instance, or both at the same time. Data which has been received
3519 from the network is usually not transmitted again, but this can be activated, see
3520 the B<Forward> option below.
3522 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3523 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3525 Both, B<Server> and B<Listen> can be used as single option or as block. When
3526 used as block, given options are valid for this socket only. The following
3527 example will export the metrics twice: Once to an "internal" server (without
3528 encryption and signing) and one to an external server (with cryptographic
3532 # Export to an internal server
3533 # (demonstrates usage without additional options)
3534 Server "collectd.internal.tld"
3536 # Export to an external server
3537 # (demonstrates usage with signature options)
3538 <Server "collectd.external.tld">
3539 SecurityLevel "sign"
3540 Username "myhostname"
3547 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3549 The B<Server> statement/block sets the server to send datagrams to. The
3550 statement may occur multiple times to send each datagram to multiple
3553 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3554 optional second argument specifies a port number or a service name. If not
3555 given, the default, B<25826>, is used.
3557 The following options are recognized within B<Server> blocks:
3561 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3563 Set the security you require for network communication. When the security level
3564 has been set to B<Encrypt>, data sent over the network will be encrypted using
3565 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3566 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3567 authentication code. When set to B<None>, data is sent without any security.
3569 This feature is only available if the I<network> plugin was linked with
3572 =item B<Username> I<Username>
3574 Sets the username to transmit. This is used by the server to lookup the
3575 password. See B<AuthFile> below. All security levels except B<None> require
3578 This feature is only available if the I<network> plugin was linked with
3581 =item B<Password> I<Password>
3583 Sets a password (shared secret) for this socket. All security levels except
3584 B<None> require this setting.
3586 This feature is only available if the I<network> plugin was linked with
3589 =item B<Interface> I<Interface name>
3591 Set the outgoing interface for IP packets. This applies at least
3592 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3593 undefined or a non-existent interface name is specified, the default
3594 behavior is to let the kernel choose the appropriate interface. Be warned
3595 that the manual selection of an interface for unicast traffic is only
3596 necessary in rare cases.
3600 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
3602 The B<Listen> statement sets the interfaces to bind to. When multiple
3603 statements are found the daemon will bind to multiple interfaces.
3605 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
3606 the argument is a multicast address the daemon will join that multicast group.
3607 The optional second argument specifies a port number or a service name. If not
3608 given, the default, B<25826>, is used.
3610 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
3614 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3616 Set the security you require for network communication. When the security level
3617 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
3618 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
3619 signed and encrypted data is accepted. When set to B<None>, all data will be
3620 accepted. If an B<AuthFile> option was given (see below), encrypted data is
3621 decrypted if possible.
3623 This feature is only available if the I<network> plugin was linked with
3626 =item B<AuthFile> I<Filename>
3628 Sets a file in which usernames are mapped to passwords. These passwords are
3629 used to verify signatures and to decrypt encrypted network packets. If
3630 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
3631 verified and encrypted packets are decrypted. Otherwise, signed data is
3632 accepted without checking the signature and encrypted data cannot be decrypted.
3633 For the other security levels this option is mandatory.
3635 The file format is very simple: Each line consists of a username followed by a
3636 colon and any number of spaces followed by the password. To demonstrate, an
3637 example file could look like this:
3642 Each time a packet is received, the modification time of the file is checked
3643 using L<stat(2)>. If the file has been changed, the contents is re-read. While
3644 the file is being read, it is locked using L<fcntl(2)>.
3646 =item B<Interface> I<Interface name>
3648 Set the incoming interface for IP packets explicitly. This applies at least
3649 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3650 undefined or a non-existent interface name is specified, the default
3651 behavior is, to let the kernel choose the appropriate interface. Thus incoming
3652 traffic gets only accepted, if it arrives on the given interface.
3656 =item B<TimeToLive> I<1-255>
3658 Set the time-to-live of sent packets. This applies to all, unicast and
3659 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
3660 That means that multicast packets will be sent with a TTL of C<1> (one) on most
3663 =item B<MaxPacketSize> I<1024-65535>
3665 Set the maximum size for datagrams received over the network. Packets larger
3666 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
3667 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
3670 On the server side, this limit should be set to the largest value used on
3671 I<any> client. Likewise, the value on the client must not be larger than the
3672 value on the server, or data will be lost.
3674 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
3675 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
3676 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
3679 =item B<Forward> I<true|false>
3681 If set to I<true>, write packets that were received via the network plugin to
3682 the sending sockets. This should only be activated when the B<Listen>- and
3683 B<Server>-statements differ. Otherwise packets may be send multiple times to
3684 the same multicast group. While this results in more network traffic than
3685 necessary it's not a huge problem since the plugin has a duplicate detection,
3686 so the values will not loop.
3688 =item B<ReportStats> B<true>|B<false>
3690 The network plugin cannot only receive and send statistics, it can also create
3691 statistics about itself. Collected data included the number of received and
3692 sent octets and packets, the length of the receive queue and the number of
3693 values handled. When set to B<true>, the I<Network plugin> will make these
3694 statistics available. Defaults to B<false>.
3698 =head2 Plugin C<nginx>
3700 This plugin collects the number of connections and requests handled by the
3701 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
3702 queries the page provided by the C<ngx_http_stub_status_module> module, which
3703 isn't compiled by default. Please refer to
3704 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
3705 how to compile and configure nginx and this module.
3707 The following options are accepted by the C<nginx plugin>:
3711 =item B<URL> I<http://host/nginx_status>
3713 Sets the URL of the C<ngx_http_stub_status_module> output.
3715 =item B<User> I<Username>
3717 Optional user name needed for authentication.
3719 =item B<Password> I<Password>
3721 Optional password needed for authentication.
3723 =item B<VerifyPeer> B<true|false>
3725 Enable or disable peer SSL certificate verification. See
3726 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
3728 =item B<VerifyHost> B<true|false>
3730 Enable or disable peer host name verification. If enabled, the plugin checks
3731 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
3732 certificate matches the host name provided by the B<URL> option. If this
3733 identity check fails, the connection is aborted. Obviously, only works when
3734 connecting to a SSL enabled server. Enabled by default.
3736 =item B<CACert> I<File>
3738 File that holds one or more SSL certificates. If you want to use HTTPS you will
3739 possibly need this option. What CA certificates come bundled with C<libcurl>
3740 and are checked by default depends on the distribution you use.
3744 =head2 Plugin C<notify_desktop>
3746 This plugin sends a desktop notification to a notification daemon, as defined
3747 in the Desktop Notification Specification. To actually display the
3748 notifications, B<notification-daemon> is required and B<collectd> has to be
3749 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
3750 environment variables have to be set correctly) and the D-Bus message bus.
3752 The Desktop Notification Specification can be found at
3753 L<http://www.galago-project.org/specs/notification/>.
3757 =item B<OkayTimeout> I<timeout>
3759 =item B<WarningTimeout> I<timeout>
3761 =item B<FailureTimeout> I<timeout>
3763 Set the I<timeout>, in milliseconds, after which to expire the notification
3764 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
3765 been specified, the displayed notification will not be closed at all - the
3766 user has to do so herself. These options default to 5000. If a negative number
3767 has been specified, the default is used as well.
3771 =head2 Plugin C<notify_email>
3773 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
3774 configured email address.
3776 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
3778 Available configuration options:
3782 =item B<From> I<Address>
3784 Email address from which the emails should appear to come from.
3786 Default: C<root@localhost>
3788 =item B<Recipient> I<Address>
3790 Configures the email address(es) to which the notifications should be mailed.
3791 May be repeated to send notifications to multiple addresses.
3793 At least one B<Recipient> must be present for the plugin to work correctly.
3795 =item B<SMTPServer> I<Hostname>
3797 Hostname of the SMTP server to connect to.
3799 Default: C<localhost>
3801 =item B<SMTPPort> I<Port>
3803 TCP port to connect to.
3807 =item B<SMTPUser> I<Username>
3809 Username for ASMTP authentication. Optional.
3811 =item B<SMTPPassword> I<Password>
3813 Password for ASMTP authentication. Optional.
3815 =item B<Subject> I<Subject>
3817 Subject-template to use when sending emails. There must be exactly two
3818 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
3819 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
3822 Default: C<Collectd notify: %s@%s>
3826 =head2 Plugin C<ntpd>
3830 =item B<Host> I<Hostname>
3832 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
3834 =item B<Port> I<Port>
3836 UDP-Port to connect to. Defaults to B<123>.
3838 =item B<ReverseLookups> B<true>|B<false>
3840 Sets whether or not to perform reverse lookups on peers. Since the name or
3841 IP-address may be used in a filename it is recommended to disable reverse
3842 lookups. The default is to do reverse lookups to preserve backwards
3843 compatibility, though.
3845 =item B<IncludeUnitID> B<true>|B<false>
3847 When a peer is a refclock, include the unit ID in the I<type instance>.
3848 Defaults to B<false> for backward compatibility.
3850 If two refclock peers use the same driver and this is B<false>, the plugin will
3851 try to write simultaneous measurements from both to the same type instance.
3852 This will result in error messages in the log and only one set of measurements
3857 =head2 Plugin C<nut>
3861 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
3863 Add a UPS to collect data from. The format is identical to the one accepted by
3868 =head2 Plugin C<olsrd>
3870 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
3871 the Optimized Link State Routing daemon and reads information about the current
3872 state of the meshed network.
3874 The following configuration options are understood:
3878 =item B<Host> I<Host>
3880 Connect to I<Host>. Defaults to B<"localhost">.
3882 =item B<Port> I<Port>
3884 Specifies the port to connect to. This must be a string, even if you give the
3885 port as a number rather than a service name. Defaults to B<"2006">.
3887 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
3889 Specifies what information to collect about links, i.E<nbsp>e. direct
3890 connections of the daemon queried. If set to B<No>, no information is
3891 collected. If set to B<Summary>, the number of links and the average of all
3892 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
3893 If set to B<Detail> LQ and NLQ are collected per link.
3895 Defaults to B<Detail>.
3897 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
3899 Specifies what information to collect about routes of the daemon queried. If
3900 set to B<No>, no information is collected. If set to B<Summary>, the number of
3901 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
3902 metric and ETX are collected per route.
3904 Defaults to B<Summary>.
3906 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
3908 Specifies what information to collect about the global topology. If set to
3909 B<No>, no information is collected. If set to B<Summary>, the number of links
3910 in the entire topology and the average I<link quality> (LQ) is calculated.
3911 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
3913 Defaults to B<Summary>.
3917 =head2 Plugin C<onewire>
3919 B<EXPERIMENTAL!> See notes below.
3921 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
3922 L<http://owfs.org/> to read sensors connected via the onewire bus.
3924 Currently only temperature sensors (sensors with the family code C<10>,
3925 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
3926 would like to have included, please send a sort request to the mailing list.
3928 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
3929 experimental, below.
3933 =item B<Device> I<Device>
3935 Sets the device to read the values from. This can either be a "real" hardware
3936 device, such as a serial port or an USB port, or the address of the
3937 L<owserver(1)> socket, usually B<localhost:4304>.
3939 Though the documentation claims to automatically recognize the given address
3940 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
3941 with that version, the following configuration worked for us:
3944 Device "-s localhost:4304"
3947 This directive is B<required> and does not have a default value.
3949 =item B<Sensor> I<Sensor>
3951 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
3952 below. Sensors are specified without the family byte at the beginning, to you'd
3953 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
3956 =item B<IgnoreSelected> I<true>|I<false>
3958 If no configuration if given, the B<onewire> plugin will collect data from all
3959 sensors found. This may not be practical, especially if sensors are added and
3960 removed regularly. Sometimes, however, it's easier/preferred to collect only
3961 specific sensors or all sensors I<except> a few specified ones. This option
3962 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
3963 B<Sensor> is inverted: All selected interfaces are ignored and all other
3964 interfaces are collected.
3966 =item B<Interval> I<Seconds>
3968 Sets the interval in which all sensors should be read. If not specified, the
3969 global B<Interval> setting is used.
3973 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
3974 work with big setups. It works with one sensor being attached to one
3975 controller, but as soon as you throw in a couple more senors and maybe a hub
3976 or two, reading all values will take more than ten seconds (the default
3977 interval). We will probably add some separate thread for reading the sensors
3978 and some cache or something like that, but it's not done yet. We will try to
3979 maintain backwards compatibility in the future, but we can't promise. So in
3980 short: If it works for you: Great! But keep in mind that the config I<might>
3981 change, though this is unlikely. Oh, and if you want to help improving this
3982 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
3984 =head2 Plugin C<openvpn>
3986 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
3987 traffic statistics about connected clients.
3989 To set up OpenVPN to write to the status file periodically, use the
3990 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
3991 you need to set the required format, too. This is done by setting
3992 B<--status-version> to B<2>.
3994 So, in a nutshell you need:
3996 openvpn $OTHER_OPTIONS \
3997 --status "/var/run/openvpn-status" 10 \
4004 =item B<StatusFile> I<File>
4006 Specifies the location of the status file.
4008 =item B<ImprovedNamingSchema> B<true>|B<false>
4010 When enabled, the filename of the status file will be used as plugin instance
4011 and the client's "common name" will be used as type instance. This is required
4012 when reading multiple status files. Enabling this option is recommended, but to
4013 maintain backwards compatibility this option is disabled by default.
4015 =item B<CollectCompression> B<true>|B<false>
4017 Sets whether or not statistics about the compression used by OpenVPN should be
4018 collected. This information is only available in I<single> mode. Enabled by
4021 =item B<CollectIndividualUsers> B<true>|B<false>
4023 Sets whether or not traffic information is collected for each connected client
4024 individually. If set to false, currently no traffic data is collected at all
4025 because aggregating this data in a save manner is tricky. Defaults to B<true>.
4027 =item B<CollectUserCount> B<true>|B<false>
4029 When enabled, the number of currently connected clients or users is collected.
4030 This is especially interesting when B<CollectIndividualUsers> is disabled, but
4031 can be configured independently from that option. Defaults to B<false>.
4035 =head2 Plugin C<oracle>
4037 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
4038 Oracle® Database and lets you execute SQL statements there. It is very similar
4039 to the "dbi" plugin, because it was written around the same time. See the "dbi"
4040 plugin's documentation above for details.
4043 <Query "out_of_stock">
4044 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
4047 # InstancePrefix "foo"
4048 InstancesFrom "category"
4052 <Database "product_information">
4056 Query "out_of_stock"
4060 =head3 B<Query> blocks
4062 The Query blocks are handled identically to the Query blocks of the "dbi"
4063 plugin. Please see its documentation above for details on how to specify
4066 =head3 B<Database> blocks
4068 Database blocks define a connection to a database and which queries should be
4069 sent to that database. Each database needs a "name" as string argument in the
4070 starting tag of the block. This name will be used as "PluginInstance" in the
4071 values submitted to the daemon. Other than that, that name is not used.
4075 =item B<ConnectID> I<ID>
4077 Defines the "database alias" or "service name" to connect to. Usually, these
4078 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
4080 =item B<Host> I<Host>
4082 Hostname to use when dispatching values for this database. Defaults to using
4083 the global hostname of the I<collectd> instance.
4085 =item B<Username> I<Username>
4087 Username used for authentication.
4089 =item B<Password> I<Password>
4091 Password used for authentication.
4093 =item B<Query> I<QueryName>
4095 Associates the query named I<QueryName> with this database connection. The
4096 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
4097 blocks you want to refer to must be placed above the database block you want to
4102 =head2 Plugin C<perl>
4104 This plugin embeds a Perl-interpreter into collectd and provides an interface
4105 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
4107 =head2 Plugin C<pinba>
4109 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
4110 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
4111 PHP-based webpage has been delivered, the extension will send a UDP packet
4112 containing timing information, peak memory usage and so on. The plugin will
4113 wait for such packets, parse them and account the provided information, which
4114 is then dispatched to the daemon once per interval.
4121 # Overall statistics for the website.
4123 Server "www.example.com"
4125 # Statistics for www-a only
4127 Host "www-a.example.com"
4128 Server "www.example.com"
4130 # Statistics for www-b only
4132 Host "www-b.example.com"
4133 Server "www.example.com"
4137 The plugin provides the following configuration options:
4141 =item B<Address> I<Node>
4143 Configures the address used to open a listening socket. By default, plugin will
4144 bind to the I<any> address C<::0>.
4146 =item B<Port> I<Service>
4148 Configures the port (service) to bind to. By default the default Pinba port
4149 "30002" will be used. The option accepts service names in addition to port
4150 numbers and thus requires a I<string> argument.
4152 =item E<lt>B<View> I<Name>E<gt> block
4154 The packets sent by the Pinba extension include the hostname of the server, the
4155 server name (the name of the virtual host) and the script that was executed.
4156 Using B<View> blocks it is possible to separate the data into multiple groups
4157 to get more meaningful statistics. Each packet is added to all matching groups,
4158 so that a packet may be accounted for more than once.
4162 =item B<Host> I<Host>
4164 Matches the hostname of the system the webserver / script is running on. This
4165 will contain the result of the L<gethostname(2)> system call. If not
4166 configured, all hostnames will be accepted.
4168 =item B<Server> I<Server>
4170 Matches the name of the I<virtual host>, i.e. the contents of the
4171 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
4172 server names will be accepted.
4174 =item B<Script> I<Script>
4176 Matches the name of the I<script name>, i.e. the contents of the
4177 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
4178 script names will be accepted.
4184 =head2 Plugin C<ping>
4186 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
4187 configured hosts periodically and measures the network latency. Whenever the
4188 C<read> function of the plugin is called, it submits the average latency, the
4189 standard deviation and the drop rate for each host.
4191 Available configuration options:
4195 =item B<Host> I<IP-address>
4197 Host to ping periodically. This option may be repeated several times to ping
4200 =item B<Interval> I<Seconds>
4202 Sets the interval in which to send ICMP echo packets to the configured hosts.
4203 This is B<not> the interval in which statistics are queries from the plugin but
4204 the interval in which the hosts are "pinged". Therefore, the setting here
4205 should be smaller than or equal to the global B<Interval> setting. Fractional
4206 times, such as "1.24" are allowed.
4210 =item B<Timeout> I<Seconds>
4212 Time to wait for a response from the host to which an ICMP packet had been
4213 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
4214 to be down or the packet to be dropped. This setting must be smaller than the
4215 B<Interval> setting above for the plugin to work correctly. Fractional
4216 arguments are accepted.
4220 =item B<TTL> I<0-255>
4222 Sets the Time-To-Live of generated ICMP packets.
4224 =item B<SourceAddress> I<host>
4226 Sets the source address to use. I<host> may either be a numerical network
4227 address or a network hostname.
4229 =item B<Device> I<name>
4231 Sets the outgoing network device to be used. I<name> has to specify an
4232 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
4235 =item B<MaxMissed> I<Packets>
4237 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
4238 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
4240 Default: B<-1> (disabled)
4244 =head2 Plugin C<postgresql>
4246 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
4247 keeps a persistent connection to all configured databases and tries to
4248 reconnect if the connection has been interrupted. A database is configured by
4249 specifying a B<Database> block as described below. The default statistics are
4250 collected from PostgreSQL's B<statistics collector> which thus has to be
4251 enabled for this plugin to work correctly. This should usually be the case by
4252 default. See the section "The Statistics Collector" of the B<PostgreSQL
4253 Documentation> for details.
4255 By specifying custom database queries using a B<Query> block as described
4256 below, you may collect any data that is available from some PostgreSQL
4257 database. This way, you are able to access statistics of external daemons
4258 which are available in a PostgreSQL database or use future or special
4259 statistics provided by PostgreSQL without the need to upgrade your collectd
4262 Starting with version 5.2, the C<postgresql> plugin supports writing data to
4263 PostgreSQL databases as well. This has been implemented in a generic way. You
4264 need to specify an SQL statement which will then be executed by collectd in
4265 order to write the data (see below for details). The benefit of that approach
4266 is that there is no fixed database layout. Rather, the layout may be optimized
4267 for the current setup.
4269 The B<PostgreSQL Documentation> manual can be found at
4270 L<http://www.postgresql.org/docs/manuals/>.
4274 Statement "SELECT magic FROM wizard WHERE host = $1;"
4278 InstancePrefix "magic"
4283 <Query rt36_tickets>
4284 Statement "SELECT COUNT(type) AS count, type \
4286 WHEN resolved = 'epoch' THEN 'open' \
4287 ELSE 'resolved' END AS type \
4288 FROM tickets) type \
4292 InstancePrefix "rt36_tickets"
4293 InstancesFrom "type"
4299 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
4309 KRBSrvName "kerberos_service_name"
4315 Service "service_name"
4316 Query backend # predefined
4327 The B<Query> block defines one database query which may later be used by a
4328 database definition. It accepts a single mandatory argument which specifies
4329 the name of the query. The names of all queries have to be unique (see the
4330 B<MinVersion> and B<MaxVersion> options below for an exception to this
4331 rule). The following configuration options are available to define the query:
4333 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
4334 blocks define how to handle the values returned from the query. They define
4335 which column holds which value and how to dispatch that value to the daemon.
4336 Multiple B<Result> blocks may be used to extract multiple values from a single
4341 =item B<Statement> I<sql query statement>
4343 Specify the I<sql query statement> which the plugin should execute. The string
4344 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
4345 first, second, etc. parameter. The value of the parameters is specified by the
4346 B<Param> configuration option - see below for details. To include a literal
4347 B<$> character followed by a number, surround it with single quotes (B<'>).
4349 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
4350 allowed. Note, however, that only a single command may be used. Semicolons are
4351 allowed as long as a single non-empty command has been specified only.
4353 The returned lines will be handled separately one after another.
4355 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4357 Specify the parameters which should be passed to the SQL query. The parameters
4358 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4359 they appear in the configuration file. The value of the parameter is
4360 determined depending on the value of the B<Param> option as follows:
4366 The configured hostname of the database connection. If a UNIX domain socket is
4367 used, the parameter expands to "localhost".
4371 The name of the database of the current connection.
4375 The name of the database plugin instance. See the B<Instance> option of the
4376 database specification below for details.
4380 The username used to connect to the database.
4384 The interval with which this database is queried (as specified by the database
4385 specific or global B<Interval> options).
4389 Please note that parameters are only supported by PostgreSQL's protocol
4390 version 3 and above which was introduced in version 7.4 of PostgreSQL.
4392 =item B<Type> I<type>
4394 The I<type> name to be used when dispatching the values. The type describes
4395 how to handle the data and where to store it. See L<types.db(5)> for more
4396 details on types and their configuration. The number and type of values (as
4397 selected by the B<ValuesFrom> option) has to match the type of the given name.
4399 This option is required inside a B<Result> block.
4401 =item B<InstancePrefix> I<prefix>
4403 =item B<InstancesFrom> I<column0> [I<column1> ...]
4405 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
4406 B<InstancePrefix> defines a static prefix that will be prepended to all type
4407 instances. B<InstancesFrom> defines the column names whose values will be used
4408 to create the type instance. Multiple values will be joined together using the
4409 hyphen (C<->) as separation character.
4411 The plugin itself does not check whether or not all built instances are
4412 different. It is your responsibility to assure that each is unique.
4414 Both options are optional. If none is specified, the type instance will be
4417 =item B<ValuesFrom> I<column0> [I<column1> ...]
4419 Names the columns whose content is used as the actual data for the data sets
4420 that are dispatched to the daemon. How many such columns you need is
4421 determined by the B<Type> setting as explained above. If you specify too many
4422 or not enough columns, the plugin will complain about that and no data will be
4423 submitted to the daemon.
4425 The actual data type, as seen by PostgreSQL, is not that important as long as
4426 it represents numbers. The plugin will automatically cast the values to the
4427 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
4428 L<strtod(3)> functions, so anything supported by those functions is supported
4429 by the plugin as well.
4431 This option is required inside a B<Result> block and may be specified multiple
4432 times. If multiple B<ValuesFrom> options are specified, the columns are read
4435 =item B<MinVersion> I<version>
4437 =item B<MaxVersion> I<version>
4439 Specify the minimum or maximum version of PostgreSQL that this query should be
4440 used with. Some statistics might only be available with certain versions of
4441 PostgreSQL. This allows you to specify multiple queries with the same name but
4442 which apply to different versions, thus allowing you to use the same
4443 configuration in a heterogeneous environment.
4445 The I<version> has to be specified as the concatenation of the major, minor
4446 and patch-level versions, each represented as two-decimal-digit numbers. For
4447 example, version 8.2.3 will become 80203.
4451 The following predefined queries are available (the definitions can be found
4452 in the F<postgresql_default.conf> file which, by default, is available at
4453 C<I<prefix>/share/collectd/>):
4459 This query collects the number of backends, i.E<nbsp>e. the number of
4462 =item B<transactions>
4464 This query collects the numbers of committed and rolled-back transactions of
4469 This query collects the numbers of various table modifications (i.E<nbsp>e.
4470 insertions, updates, deletions) of the user tables.
4472 =item B<query_plans>
4474 This query collects the numbers of various table scans and returned tuples of
4477 =item B<table_states>
4479 This query collects the numbers of live and dead rows in the user tables.
4483 This query collects disk block access counts for user tables.
4487 This query collects the on-disk size of the database in bytes.
4491 In addition, the following detailed queries are available by default. Please
4492 note that each of those queries collects information B<by table>, thus,
4493 potentially producing B<a lot> of data. For details see the description of the
4494 non-by_table queries above.
4498 =item B<queries_by_table>
4500 =item B<query_plans_by_table>
4502 =item B<table_states_by_table>
4504 =item B<disk_io_by_table>
4508 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
4509 mandatory argument specifying the name of the writer. This will then be used
4510 in the B<Database> specification in order to activate the writer instance. The
4511 names of all writers have to be unique. The following options may be
4516 =item B<Statement> I<sql statement>
4518 This mandatory option specifies the SQL statement that will be executed for
4519 each submitted value. A single SQL statement is allowed only. Anything after
4520 the first semicolon will be ignored.
4522 Nine parameters will be passed to the statement and should be specified as
4523 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
4524 values are made available through those parameters:
4530 The timestamp of the queried value as a floating point number.
4534 The hostname of the queried value.
4538 The plugin name of the queried value.
4542 The plugin instance of the queried value. This value may be B<NULL> if there
4543 is no plugin instance.
4547 The type of the queried value (cf. L<types.db(5)>).
4551 The type instance of the queried value. This value may be B<NULL> if there is
4556 An array of names for the submitted values (i.E<nbsp>e., the name of the data
4557 sources of the submitted value-list).
4561 An array of types for the submitted values (i.E<nbsp>e., the type of the data
4562 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
4563 B<StoreRates> is enabled (which is the default, see below), all types will be
4568 An array of the submitted values. The dimensions of the value name and value
4573 In general, it is advisable to create and call a custom function in the
4574 PostgreSQL database for this purpose. Any procedural language supported by
4575 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
4578 =item B<StoreRates> B<false>|B<true>
4580 If set to B<true> (the default), convert counter values to rates. If set to
4581 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
4586 The B<Database> block defines one PostgreSQL database for which to collect
4587 statistics. It accepts a single mandatory argument which specifies the
4588 database name. None of the other options are required. PostgreSQL will use
4589 default values as documented in the section "CONNECTING TO A DATABASE" in the
4590 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
4591 the user collectd is run as and special environment variables. See the manpage
4596 =item B<Interval> I<seconds>
4598 Specify the interval with which the database should be queried. The default is
4599 to use the global B<Interval> setting.
4601 =item B<CommitInterval> I<seconds>
4603 This option may be used for database connections which have "writers" assigned
4604 (see above). If specified, it causes a writer to put several updates into a
4605 single transaction. This transaction will last for the specified amount of
4606 time. By default, each update will be executed in a separate transaction. Each
4607 transaction generates a fair amount of overhead which can, thus, be reduced by
4608 activating this option. The draw-back is, that data covering the specified
4609 amount of time will be lost, for example, if a single statement within the
4610 transaction fails or if the database server crashes.
4612 =item B<Host> I<hostname>
4614 Specify the hostname or IP of the PostgreSQL server to connect to. If the
4615 value begins with a slash, it is interpreted as the directory name in which to
4616 look for the UNIX domain socket.
4618 This option is also used to determine the hostname that is associated with a
4619 collected data set. If it has been omitted or either begins with with a slash
4620 or equals B<localhost> it will be replaced with the global hostname definition
4621 of collectd. Any other value will be passed literally to collectd when
4622 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
4624 =item B<Port> I<port>
4626 Specify the TCP port or the local UNIX domain socket file extension of the
4629 =item B<User> I<username>
4631 Specify the username to be used when connecting to the server.
4633 =item B<Password> I<password>
4635 Specify the password to be used when connecting to the server.
4637 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
4639 Specify whether to use an SSL connection when contacting the server. The
4640 following modes are supported:
4642 =item B<Instance> I<name>
4644 Specify the plugin instance name that should be used instead of the database
4645 name (which is the default, if this option has not been specified). This
4646 allows to query multiple databases of the same name on the same host (e.g.
4647 when running multiple database server versions in parallel).
4653 Do not use SSL at all.
4657 First, try to connect without using SSL. If that fails, try using SSL.
4659 =item I<prefer> (default)
4661 First, try to connect using SSL. If that fails, try without using SSL.
4669 =item B<KRBSrvName> I<kerberos_service_name>
4671 Specify the Kerberos service name to use when authenticating with Kerberos 5
4672 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
4673 B<PostgreSQL Documentation> for details.
4675 =item B<Service> I<service_name>
4677 Specify the PostgreSQL service name to use for additional parameters. That
4678 service has to be defined in F<pg_service.conf> and holds additional
4679 connection parameters. See the section "The Connection Service File" in the
4680 B<PostgreSQL Documentation> for details.
4682 =item B<Query> I<query>
4684 Specifies a I<query> which should be executed in the context of the database
4685 connection. This may be any of the predefined or user-defined queries. If no
4686 such option is given, it defaults to "backends", "transactions", "queries",
4687 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
4688 has been specified). Else, the specified queries are used only.
4690 =item B<Writer> I<writer>
4692 Assigns the specified I<writer> backend to the database connection. This
4693 causes all collected data to be send to the database using the settings
4694 defined in the writer configuration (see the section "FILTER CONFIGURATION"
4695 below for details on how to selectively send data to certain plugins).
4697 Each writer will register a flush callback which may be used when having long
4698 transactions enabled (see the B<CommitInterval> option above). When issuing
4699 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
4700 transaction will be committed right away. Two different kinds of flush
4701 callbacks are available with the C<postgresql> plugin:
4707 Flush all writer backends.
4709 =item B<postgresql->I<database>
4711 Flush all writers of the specified I<database> only.
4717 =head2 Plugin C<powerdns>
4719 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
4720 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
4721 values, many of which are probably meaningless to most users, but may be useful
4722 for some. So you may chose which values to collect, but if you don't, some
4723 reasonable defaults will be collected.
4726 <Server "server_name">
4728 Collect "udp-answers" "udp-queries"
4729 Socket "/var/run/pdns.controlsocket"
4731 <Recursor "recursor_name">
4733 Collect "cache-hits" "cache-misses"
4734 Socket "/var/run/pdns_recursor.controlsocket"
4736 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
4741 =item B<Server> and B<Recursor> block
4743 The B<Server> block defines one authoritative server to query, the B<Recursor>
4744 does the same for an recursing server. The possible options in both blocks are
4745 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
4750 =item B<Collect> I<Field>
4752 Using the B<Collect> statement you can select which values to collect. Here,
4753 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
4754 C<dlg-only-drops>, C<answers10-100>.
4756 The method of getting the values differs for B<Server> and B<Recursor> blocks:
4757 When querying the server a C<SHOW *> command is issued in any case, because
4758 that's the only way of getting multiple values out of the server at once.
4759 collectd then picks out the values you have selected. When querying the
4760 recursor, a command is generated to query exactly these values. So if you
4761 specify invalid fields when querying the recursor, a syntax error may be
4762 returned by the daemon and collectd may not collect any values at all.
4764 If no B<Collect> statement is given, the following B<Server> values will be
4771 =item packetcache-hit
4773 =item packetcache-miss
4775 =item packetcache-size
4777 =item query-cache-hit
4779 =item query-cache-miss
4781 =item recursing-answers
4783 =item recursing-questions
4795 The following B<Recursor> values will be collected by default:
4799 =item noerror-answers
4801 =item nxdomain-answers
4803 =item servfail-answers
4821 Please note that up to that point collectd doesn't know what values are
4822 available on the server and values that are added do not need a change of the
4823 mechanism so far. However, the values must be mapped to collectd's naming
4824 scheme, which is done using a lookup table that lists all known values. If
4825 values are added in the future and collectd does not know about them, you will
4826 get an error much like this:
4828 powerdns plugin: submit: Not found in lookup table: foobar = 42
4830 In this case please file a bug report with the collectd team.
4832 =item B<Socket> I<Path>
4834 Configures the path to the UNIX domain socket to be used when connecting to the
4835 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
4836 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
4837 will be used for the recursor.
4841 =item B<LocalSocket> I<Path>
4843 Querying the recursor is done using UDP. When using UDP over UNIX domain
4844 sockets, the client socket needs a name in the file system, too. You can set
4845 this local name to I<Path> using the B<LocalSocket> option. The default is
4846 C<I<prefix>/var/run/collectd-powerdns>.
4850 =head2 Plugin C<processes>
4854 =item B<Process> I<Name>
4856 Select more detailed statistics of processes matching this name. The statistics
4857 collected for these selected processes are size of the resident segment size
4858 (RSS), user- and system-time used, number of processes and number of threads,
4859 io data (where available) and minor and major pagefaults.
4861 =item B<ProcessMatch> I<name> I<regex>
4863 Similar to the B<Process> option this allows to select more detailed
4864 statistics of processes matching the specified I<regex> (see L<regex(7)> for
4865 details). The statistics of all matching processes are summed up and
4866 dispatched to the daemon using the specified I<name> as an identifier. This
4867 allows to "group" several processes together. I<name> must not contain
4872 =head2 Plugin C<protocols>
4874 Collects a lot of information about various network protocols, such as I<IP>,
4875 I<TCP>, I<UDP>, etc.
4877 Available configuration options:
4881 =item B<Value> I<Selector>
4883 Selects whether or not to select a specific value. The string being matched is
4884 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
4885 plugin instance and I<ValueName> will be used as type instance. An example of
4886 the string being used would be C<Tcp:RetransSegs>.
4888 You can use regular expressions to match a large number of values with just one
4889 configuration option. To select all "extended" I<TCP> values, you could use the
4890 following statement:
4894 Whether only matched values are selected or all matched values are ignored
4895 depends on the B<IgnoreSelected>. By default, only matched values are selected.
4896 If no value is configured at all, all values will be selected.
4898 =item B<IgnoreSelected> B<true>|B<false>
4900 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
4901 matching values will be ignored.
4905 =head2 Plugin C<python>
4907 This plugin embeds a Python-interpreter into collectd and provides an interface
4908 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
4910 =head2 Plugin C<routeros>
4912 The C<routeros> plugin connects to a device running I<RouterOS>, the
4913 Linux-based operating system for routers by I<MikroTik>. The plugin uses
4914 I<librouteros> to connect and reads information about the interfaces and
4915 wireless connections of the device. The configuration supports querying
4920 Host "router0.example.com"
4923 CollectInterface true
4928 Host "router1.example.com"
4931 CollectInterface true
4932 CollectRegistrationTable true
4938 As you can see above, the configuration of the I<routeros> plugin consists of
4939 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
4940 options are understood:
4944 =item B<Host> I<Host>
4946 Hostname or IP-address of the router to connect to.
4948 =item B<Port> I<Port>
4950 Port name or port number used when connecting. If left unspecified, the default
4951 will be chosen by I<librouteros>, currently "8728". This option expects a
4952 string argument, even when a numeric port number is given.
4954 =item B<User> I<User>
4956 Use the user name I<User> to authenticate. Defaults to "admin".
4958 =item B<Password> I<Password>
4960 Set the password used to authenticate.
4962 =item B<CollectInterface> B<true>|B<false>
4964 When set to B<true>, interface statistics will be collected for all interfaces
4965 present on the device. Defaults to B<false>.
4967 =item B<CollectRegistrationTable> B<true>|B<false>
4969 When set to B<true>, information about wireless LAN connections will be
4970 collected. Defaults to B<false>.
4972 =item B<CollectCPULoad> B<true>|B<false>
4974 When set to B<true>, information about the CPU usage will be collected. The
4975 number is a dimensionless value where zero indicates no CPU usage at all.
4976 Defaults to B<false>.
4978 =item B<CollectMemory> B<true>|B<false>
4980 When enabled, the amount of used and free memory will be collected. How used
4981 memory is calculated is unknown, for example whether or not caches are counted
4983 Defaults to B<false>.
4985 =item B<CollectDF> B<true>|B<false>
4987 When enabled, the amount of used and free disk space will be collected.
4988 Defaults to B<false>.
4990 =item B<CollectDisk> B<true>|B<false>
4992 When enabled, the number of sectors written and bad blocks will be collected.
4993 Defaults to B<false>.
4997 =head2 Plugin C<redis>
4999 The I<Redis plugin> connects to one or more Redis servers and gathers
5000 information about each server's state. For each server there is a I<Node> block
5001 which configures the connection parameters for this node.
5011 The information shown in the synopsis above is the I<default configuration>
5012 which is used by the plugin if no configuration is present.
5016 =item B<Node> I<Nodename>
5018 The B<Node> block identifies a new Redis node, that is a new Redis instance
5019 running in an specified host and port. The name for node is a canonical
5020 identifier which is used as I<plugin instance>. It is limited to
5021 64E<nbsp>characters in length.
5023 =item B<Host> I<Hostname>
5025 The B<Host> option is the hostname or IP-address where the Redis instance is
5028 =item B<Port> I<Port>
5030 The B<Port> option is the TCP port on which the Redis instance accepts
5031 connections. Either a service name of a port number may be given. Please note
5032 that numerical port numbers must be given as a string, too.
5034 =item B<Password> I<Password>
5036 Use I<Password> to authenticate when connecting to I<Redis>.
5038 =item B<Timeout> I<Timeout in miliseconds>
5040 The B<Timeout> option set the socket timeout for node response. Since the Redis
5041 read function is blocking, you should keep this value as low as possible. Keep
5042 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
5043 than B<Interval> defined globally.
5047 =head2 Plugin C<rrdcached>
5049 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
5050 to store values to RRD files in an efficient manner. The combination of the
5051 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
5052 way the C<rrdtool> plugin works (see below). The added abstraction layer
5053 provides a number of benefits, though: Because the cache is not within
5054 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
5055 restarted. This results in much shorter (if any) gaps in graphs, especially
5056 under heavy load. Also, the C<rrdtool> command line utility is aware of the
5057 daemon so that it can flush values to disk automatically when needed. This
5058 allows to integrate automated flushing of values into graphing solutions much
5061 There are disadvantages, though: The daemon may reside on a different host, so
5062 it may not be possible for C<collectd> to create the appropriate RRD files
5063 anymore. And even if C<rrdcached> runs on the same host, it may run in a
5064 different base directory, so relative paths may do weird stuff if you're not
5067 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
5068 on the same host, communicating via a UNIX domain socket. The B<DataDir>
5069 setting should be set to an absolute path, so that a changed base directory
5070 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
5074 =item B<DaemonAddress> I<Address>
5076 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
5077 library. See L<rrdcached(1)> for details. Example:
5079 <Plugin "rrdcached">
5080 DaemonAddress "unix:/var/run/rrdcached.sock"
5083 =item B<DataDir> I<Directory>
5085 Set the base directory in which the RRD files reside. If this is a relative
5086 path, it is relative to the working base directory of the C<rrdcached> daemon!
5087 Use of an absolute path is recommended.
5089 =item B<CreateFiles> B<true>|B<false>
5091 Enables or disables the creation of RRD files. If the daemon is not running
5092 locally, or B<DataDir> is set to a relative path, this will not work as
5093 expected. Default is B<true>.
5095 =item B<CreateFilesAsync> B<false>|B<true>
5097 When enabled, new RRD files are enabled asynchronously, using a separate thread
5098 that runs in the background. This prevents writes to block, which is a problem
5099 especially when many hundreds of files need to be created at once. However,
5100 since the purpose of creating the files asynchronously is I<not> to block until
5101 the file is available, values before the file is available will be discarded.
5102 When disabled (the default) files are created synchronously, blocking for a
5103 short while, while the file is being written.
5105 =item B<StepSize> I<Seconds>
5107 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5108 this setting is unset and the stepsize is set to the interval in which the data
5109 is collected. Do not use this option unless you absolutely have to for some
5110 reason. Setting this option may cause problems with the C<snmp plugin>, the
5111 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5113 =item B<HeartBeat> I<Seconds>
5115 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5116 in which case the heartbeat is set to twice the B<StepSize> which should equal
5117 the interval in which data is collected. Do not set this option unless you have
5118 a very good reason to do so.
5120 =item B<RRARows> I<NumRows>
5122 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5123 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5124 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5125 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5126 week, one month, and one year.
5128 So for each timespan, it calculates how many PDPs need to be consolidated into
5129 one CDP by calculating:
5130 number of PDPs = timespan / (stepsize * rrarows)
5132 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5135 =item B<RRATimespan> I<Seconds>
5137 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5138 more then one RRA. If this option is never used, the built-in default of (3600,
5139 86400, 604800, 2678400, 31622400) is used.
5141 For more information on how RRA-sizes are calculated see B<RRARows> above.
5143 =item B<XFF> I<Factor>
5145 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5146 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5151 =head2 Plugin C<rrdtool>
5153 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
5154 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
5155 using these settings. If you don't want to dive into the depths of RRDtool, you
5156 can safely ignore these settings.
5160 =item B<DataDir> I<Directory>
5162 Set the directory to store RRD files under. By default RRD files are generated
5163 beneath the daemon's working directory, i.e. the B<BaseDir>.
5165 =item B<CreateFilesAsync> B<false>|B<true>
5167 When enabled, new RRD files are enabled asynchronously, using a separate thread
5168 that runs in the background. This prevents writes to block, which is a problem
5169 especially when many hundreds of files need to be created at once. However,
5170 since the purpose of creating the files asynchronously is I<not> to block until
5171 the file is available, values before the file is available will be discarded.
5172 When disabled (the default) files are created synchronously, blocking for a
5173 short while, while the file is being written.
5175 =item B<StepSize> I<Seconds>
5177 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5178 this setting is unset and the stepsize is set to the interval in which the data
5179 is collected. Do not use this option unless you absolutely have to for some
5180 reason. Setting this option may cause problems with the C<snmp plugin>, the
5181 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5183 =item B<HeartBeat> I<Seconds>
5185 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5186 in which case the heartbeat is set to twice the B<StepSize> which should equal
5187 the interval in which data is collected. Do not set this option unless you have
5188 a very good reason to do so.
5190 =item B<RRARows> I<NumRows>
5192 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5193 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5194 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5195 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5196 week, one month, and one year.
5198 So for each timespan, it calculates how many PDPs need to be consolidated into
5199 one CDP by calculating:
5200 number of PDPs = timespan / (stepsize * rrarows)
5202 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5205 =item B<RRATimespan> I<Seconds>
5207 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5208 more then one RRA. If this option is never used, the built-in default of (3600,
5209 86400, 604800, 2678400, 31622400) is used.
5211 For more information on how RRA-sizes are calculated see B<RRARows> above.
5213 =item B<XFF> I<Factor>
5215 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5216 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5219 =item B<CacheFlush> I<Seconds>
5221 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
5222 it writes all values for a certain RRD-file if the oldest value is older than
5223 (or equal to) the number of seconds specified. If some RRD-file is not updated
5224 anymore for some reason (the computer was shut down, the network is broken,
5225 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
5226 entire cache is searched for entries older than B<CacheTimeout> seconds and
5227 written to disk every I<Seconds> seconds. Since this is kind of expensive and
5228 does nothing under normal circumstances, this value should not be too small.
5229 900 seconds might be a good value, though setting this to 7200 seconds doesn't
5230 normally do much harm either.
5232 =item B<CacheTimeout> I<Seconds>
5234 If this option is set to a value greater than zero, the C<rrdtool plugin> will
5235 save values in a cache, as described above. Writing multiple values at once
5236 reduces IO-operations and thus lessens the load produced by updating the files.
5237 The trade off is that the graphs kind of "drag behind" and that more memory is
5240 =item B<WritesPerSecond> I<Updates>
5242 When collecting many statistics with collectd and the C<rrdtool> plugin, you
5243 will run serious performance problems. The B<CacheFlush> setting and the
5244 internal update queue assert that collectd continues to work just fine even
5245 under heavy load, but the system may become very unresponsive and slow. This is
5246 a problem especially if you create graphs from the RRD files on the same
5247 machine, for example using the C<graph.cgi> script included in the
5248 C<contrib/collection3/> directory.
5250 This setting is designed for very large setups. Setting this option to a value
5251 between 25 and 80 updates per second, depending on your hardware, will leave
5252 the server responsive enough to draw graphs even while all the cached values
5253 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
5254 by the B<FLUSH> command, are B<not> effected by this limit. They are still
5255 written as fast as possible, so that web frontends have up to date data when
5258 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
5259 updates per second, writing all values to disk will take approximately
5260 56E<nbsp>minutes. Together with the flushing ability that's integrated into
5261 "collection3" you'll end up with a responsive and fast system, up to date
5262 graphs and basically a "backup" of your values every hour.
5264 =item B<RandomTimeout> I<Seconds>
5266 When set, the actual timeout for each value is chosen randomly between
5267 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
5268 intention is to avoid high load situations that appear when many values timeout
5269 at the same time. This is especially a problem shortly after the daemon starts,
5270 because all values were added to the internal cache at roughly the same time.
5274 =head2 Plugin C<sensors>
5276 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
5277 that all the needed modules have to be loaded and lm_sensors has to be
5278 configured (most likely by editing F</etc/sensors.conf>. Read
5279 L<sensors.conf(5)> for details.
5281 The B<lm_sensors> homepage can be found at
5282 L<http://secure.netroedge.com/~lm78/>.
5286 =item B<SensorConfigFile> I<File>
5288 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
5289 the library's default will be used.
5291 =item B<Sensor> I<chip-bus-address/type-feature>
5293 Selects the name of the sensor which you want to collect or ignore, depending
5294 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
5295 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
5296 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
5298 =item B<IgnoreSelected> I<true>|I<false>
5300 If no configuration if given, the B<sensors>-plugin will collect data from all
5301 sensors. This may not be practical, especially for uninteresting sensors.
5302 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
5303 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
5304 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
5305 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
5306 and all other sensors are collected.
5310 =head2 Plugin C<sigrok>
5312 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
5313 supported by the L<sigrok|http://sigrok.org/> project.
5319 <Device "AC Voltage">
5324 <Device "Sound Level">
5325 Driver "cem-dt-885x"
5332 =item B<LogLevel> B<0-5>
5334 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
5335 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
5336 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
5337 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
5338 their level, are always submitted to I<collectd> at its INFO log level.
5340 =item E<lt>B<Device> I<Name>E<gt>
5342 A sigrok-supported device, uniquely identified by this section's options. The
5343 I<Name> is passed to I<collectd> as the I<plugin instance>.
5345 =item B<Driver> I<DriverName>
5347 The sigrok driver to use for this device.
5349 =item B<Conn> I<ConnectionSpec>
5351 If the device cannot be auto-discovered, or more than one might be discovered
5352 by the driver, I<ConnectionSpec> specifies the connection string to the device.
5353 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
5354 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
5355 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
5356 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
5358 =item B<SerialComm> I<SerialSpec>
5360 For serial devices with non-standard port settings, this option can be used
5361 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
5362 This should not be necessary; drivers know how to communicate with devices they
5365 =item B<MinimumInterval> I<Seconds>
5367 Specifies the minimum time between measurement dispatches to I<collectd>, in
5368 seconds. Since some I<sigrok> supported devices can acquire measurements many
5369 times per second, it may be necessary to throttle these. For example, the
5370 I<RRD plugin> cannot process writes more than once per second.
5372 The default B<MinimumInterval> is B<0>, meaning measurements received from the
5373 device are always dispatched to I<collectd>. When throttled, unused
5374 measurements are discarded.
5378 =head2 Plugin C<snmp>
5380 Since the configuration of the C<snmp plugin> is a little more complicated than
5381 other plugins, its documentation has been moved to an own manpage,
5382 L<collectd-snmp(5)>. Please see there for details.
5384 =head2 Plugin C<statsd>
5386 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
5387 protocol and dispatches rates or other aggregates of these numbers
5390 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
5391 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
5392 C<objects> respectively.
5394 The following configuration options are valid:
5398 =item B<Host> I<Host>
5400 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
5401 "any" address, i.e. accept packets sent to any of the hosts addresses.
5403 =item B<Port> I<Port>
5405 UDP port to listen to. This can be either a service name or a port number.
5406 Defaults to C<8125>.
5408 =item B<DeleteCounters> B<false>|B<true>
5410 =item B<DeleteTimers> B<false>|B<true>
5412 =item B<DeleteGauges> B<false>|B<true>
5414 =item B<DeleteSets> B<false>|B<true>
5416 These options control what happens if metrics are not updated in an interval.
5417 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
5418 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
5419 are unchanged. If set to B<True>, the such metrics are not dispatched and
5420 removed from the internal cache.
5422 =item B<TimerPercentile> I<Percent>
5424 Calculate and dispatch the configured percentile, i.e. compute the latency, so
5425 that I<Percent> of all reported timers are smaller than or equal to the
5426 computed latency. This is useful for cutting off the long tail latency, as it's
5427 often done in I<Service Level Agreements> (SLAs).
5429 If not specified, no percentile is calculated / dispatched.
5433 =head2 Plugin C<swap>
5435 The I<Swap plugin> collects information about used and available swap space. On
5436 I<Linux> and I<Solaris>, the following options are available:
5440 =item B<ReportByDevice> B<false>|B<true>
5442 Configures how to report physical swap devices. If set to B<false> (the
5443 default), the summary over all swap devices is reported only, i.e. the globally
5444 used and available space over all devices. If B<true> is configured, the used
5445 and available space of each device will be reported separately.
5447 This option is only available if the I<Swap plugin> can read C</proc/swaps>
5448 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
5450 =item B<ReportBytes> B<false>|B<true>
5452 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
5453 I<swap I/O> is reported in pages. This option is available under Linux only.
5455 =item B<ValuesAbsolute> B<true>|B<false>
5457 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
5458 available and used. Defaults to B<true>.
5460 =item B<ValuesPercentage> B<false>|B<true>
5462 Enables or disables reporting of relative swap metrics, i.e. I<percent>
5463 available and free. Defaults to B<false>.
5465 This is useful for deploying I<collectd> in a heterogeneous environment, where
5466 swap sizes differ and you want to specify generic thresholds or similar.
5470 =head2 Plugin C<syslog>
5474 =item B<LogLevel> B<debug|info|notice|warning|err>
5476 Sets the log-level. If, for example, set to B<notice>, then all events with
5477 severity B<notice>, B<warning>, or B<err> will be submitted to the
5480 Please note that B<debug> is only available if collectd has been compiled with
5483 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
5485 Controls which notifications should be sent to syslog. The default behaviour is
5486 not to send any. Less severe notifications always imply logging more severe
5487 notifications: Setting this to B<OKAY> means all notifications will be sent to
5488 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
5489 notifications but will dismiss B<OKAY> notifications. Setting this option to
5490 B<FAILURE> will only send failures to syslog.
5494 =head2 Plugin C<table>
5496 The C<table plugin> provides generic means to parse tabular data and dispatch
5497 user specified values. Values are selected based on column numbers. For
5498 example, this plugin may be used to get values from the Linux L<proc(5)>
5499 filesystem or CSV (comma separated values) files.
5502 <Table "/proc/slabinfo">
5507 InstancePrefix "active_objs"
5513 InstancePrefix "objperslab"
5520 The configuration consists of one or more B<Table> blocks, each of which
5521 configures one file to parse. Within each B<Table> block, there are one or
5522 more B<Result> blocks, which configure which data to select and how to
5525 The following options are available inside a B<Table> block:
5529 =item B<Instance> I<instance>
5531 If specified, I<instance> is used as the plugin instance. So, in the above
5532 example, the plugin name C<table-slabinfo> would be used. If omitted, the
5533 filename of the table is used instead, with all special characters replaced
5534 with an underscore (C<_>).
5536 =item B<Separator> I<string>
5538 Any character of I<string> is interpreted as a delimiter between the different
5539 columns of the table. A sequence of two or more contiguous delimiters in the
5540 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
5541 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
5542 of a table - see its documentation for more details. This option is mandatory.
5544 A horizontal tab, newline and carriage return may be specified by C<\\t>,
5545 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
5546 required because of collectd's config parsing.
5550 The following options are available inside a B<Result> block:
5554 =item B<Type> I<type>
5556 Sets the type used to dispatch the values to the daemon. Detailed information
5557 about types and their configuration can be found in L<types.db(5)>. This
5558 option is mandatory.
5560 =item B<InstancePrefix> I<prefix>
5562 If specified, prepend I<prefix> to the type instance. If omitted, only the
5563 B<InstancesFrom> option is considered for the type instance.
5565 =item B<InstancesFrom> I<column0> [I<column1> ...]
5567 If specified, the content of the given columns (identified by the column
5568 number starting at zero) will be used to create the type instance for each
5569 row. Multiple values (and the instance prefix) will be joined together with
5570 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
5571 option is considered for the type instance.
5573 The plugin itself does not check whether or not all built instances are
5574 different. It’s your responsibility to assure that each is unique. This is
5575 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
5576 sure that the table only contains one row.
5578 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
5581 =item B<ValuesFrom> I<column0> [I<column1> ...]
5583 Specifies the columns (identified by the column numbers starting at zero)
5584 whose content is used as the actual data for the data sets that are dispatched
5585 to the daemon. How many such columns you need is determined by the B<Type>
5586 setting above. If you specify too many or not enough columns, the plugin will
5587 complain about that and no data will be submitted to the daemon. The plugin
5588 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
5589 respectively, so anything supported by those functions is supported by the
5590 plugin as well. This option is mandatory.
5594 =head2 Plugin C<tail>
5596 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
5597 each line and dispatches found values. What is matched can be configured by the
5598 user using (extended) regular expressions, as described in L<regex(7)>.
5601 <File "/var/log/exim4/mainlog">
5605 Regex "S=([1-9][0-9]*)"
5611 Regex "\\<R=local_user\\>"
5612 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
5615 Instance "local_user"
5620 The config consists of one or more B<File> blocks, each of which configures one
5621 logfile to parse. Within each B<File> block, there are one or more B<Match>
5622 blocks, which configure a regular expression to search for.
5624 The B<Instance> option in the B<File> block may be used to set the plugin
5625 instance. So in the above example the plugin name C<tail-foo> would be used.
5626 This plugin instance is for all B<Match> blocks that B<follow> it, until the
5627 next B<Instance> option. This way you can extract several plugin instances from
5628 one logfile, handy when parsing syslog and the like.
5630 The B<Interval> option allows you to define the length of time between reads. If
5631 this is not set, the default Interval will be used.
5633 Each B<Match> block has the following options to describe how the match should
5638 =item B<Regex> I<regex>
5640 Sets the regular expression to use for matching against a line. The first
5641 subexpression has to match something that can be turned into a number by
5642 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
5643 below. Because B<extended> regular expressions are used, you do not need to use
5644 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
5645 collectd's config parsing you need to escape backslashes, though. So if you
5646 want to match literal parentheses you need to do the following:
5648 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
5650 =item B<ExcludeRegex> I<regex>
5652 Sets an optional regular expression to use for excluding lines from the match.
5653 An example which excludes all connections from localhost from the match:
5655 ExcludeRegex "127\\.0\\.0\\.1"
5657 =item B<DSType> I<Type>
5659 Sets how the values are cumulated. I<Type> is one of:
5663 =item B<GaugeAverage>
5665 Calculate the average.
5669 Use the smallest number only.
5673 Use the greatest number only.
5677 Use the last number found.
5683 =item B<AbsoluteSet>
5685 The matched number is a counter. Simply I<sets> the internal counter to this
5686 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
5692 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
5693 matched number may be negative, which will effectively subtract from the
5700 Increase the internal counter by one. These B<DSType> are the only ones that do
5701 not use the matched subexpression, but simply count the number of matched
5702 lines. Thus, you may use a regular expression without submatch in this case.
5706 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
5707 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
5708 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
5709 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
5710 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
5713 =item B<Type> I<Type>
5715 Sets the type used to dispatch this value. Detailed information about types and
5716 their configuration can be found in L<types.db(5)>.
5718 =item B<Instance> I<TypeInstance>
5720 This optional setting sets the type instance to use.
5724 =head2 Plugin C<tail_csv>
5726 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
5727 written by I<Snort>.
5732 <Metric "snort-dropped">
5737 <File "/var/log/snort/snort.stats">
5738 Instance "snort-eth0"
5740 Collect "snort-dropped"
5744 The configuration consists of one or more B<Metric> blocks that define an index
5745 into the line of the CSV file and how this value is mapped to I<collectd's>
5746 internal representation. These are followed by one or more B<Instance> blocks
5747 which configure which file to read, in which interval and which metrics to
5752 =item E<lt>B<Metric> I<Name>E<gt>
5754 The B<Metric> block configures a new metric to be extracted from the statistics
5755 file and how it is mapped on I<collectd's> data model. The string I<Name> is
5756 only used inside the B<Instance> blocks to refer to this block, so you can use
5757 one B<Metric> block for multiple CSV files.
5761 =item B<Type> I<Type>
5763 Configures which I<Type> to use when dispatching this metric. Types are defined
5764 in the L<types.db(5)> file, see the appropriate manual page for more
5765 information on specifying types. Only types with a single I<data source> are
5766 supported by the I<tail_csv plugin>. The information whether the value is an
5767 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
5768 I<Type's> definition.
5770 =item B<Instance> I<TypeInstance>
5772 If set, I<TypeInstance> is used to populate the type instance field of the
5773 created value lists. Otherwise, no type instance is used.
5775 =item B<ValueFrom> I<Index>
5777 Configure to read the value from the field with the zero-based index I<Index>.
5778 If the value is parsed as signed integer, unsigned integer or double depends on
5779 the B<Type> setting, see above.
5783 =item E<lt>B<File> I<Path>E<gt>
5785 Each B<File> block represents one CSV file to read. There must be at least one
5786 I<File> block but there can be multiple if you have multiple CSV files.
5790 =item B<Instance> I<PluginInstance>
5792 Sets the I<plugin instance> used when dispatching the values.
5794 =item B<Collect> I<Metric>
5796 Specifies which I<Metric> to collect. This option must be specified at least
5797 once, and you can use this option multiple times to specify more than one
5798 metric to be extracted from this statistic file.
5800 =item B<Interval> I<Seconds>
5802 Configures the interval in which to read values from this instance / file.
5803 Defaults to the plugin's default interval.
5805 =item B<TimeFrom> I<Index>
5807 Rather than using the local time when dispatching a value, read the timestamp
5808 from the field with the zero-based index I<Index>. The value is interpreted as
5809 seconds since epoch. The value is parsed as a double and may be factional.
5815 =head2 Plugin C<teamspeak2>
5817 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
5818 polls interesting global and virtual server data. The plugin can query only one
5819 physical server but unlimited virtual servers. You can use the following
5820 options to configure it:
5824 =item B<Host> I<hostname/ip>
5826 The hostname or ip which identifies the physical server.
5829 =item B<Port> I<port>
5831 The query port of the physical server. This needs to be a string.
5834 =item B<Server> I<port>
5836 This option has to be added once for every virtual server the plugin should
5837 query. If you want to query the virtual server on port 8767 this is what the
5838 option would look like:
5842 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
5843 use quotes around it! If no such statement is given only global information
5848 =head2 Plugin C<ted>
5850 The I<TED> plugin connects to a device of "The Energy Detective", a device to
5851 measure power consumption. These devices are usually connected to a serial
5852 (RS232) or USB port. The plugin opens a configured device and tries to read the
5853 current energy readings. For more information on TED, visit
5854 L<http://www.theenergydetective.com/>.
5856 Available configuration options:
5860 =item B<Device> I<Path>
5862 Path to the device on which TED is connected. collectd will need read and write
5863 permissions on that file.
5865 Default: B</dev/ttyUSB0>
5867 =item B<Retries> I<Num>
5869 Apparently reading from TED is not that reliable. You can therefore configure a
5870 number of retries here. You only configure the I<retries> here, to if you
5871 specify zero, one reading will be performed (but no retries if that fails); if
5872 you specify three, a maximum of four readings are performed. Negative values
5879 =head2 Plugin C<tcpconns>
5881 The C<tcpconns plugin> counts the number of currently established TCP
5882 connections based on the local port and/or the remote port. Since there may be
5883 a lot of connections the default if to count all connections with a local port,
5884 for which a listening socket is opened. You can use the following options to
5885 fine-tune the ports you are interested in:
5889 =item B<ListeningPorts> I<true>|I<false>
5891 If this option is set to I<true>, statistics for all local ports for which a
5892 listening socket exists are collected. The default depends on B<LocalPort> and
5893 B<RemotePort> (see below): If no port at all is specifically selected, the
5894 default is to collect listening ports. If specific ports (no matter if local or
5895 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
5896 the selected ports will be collected unless this option is set to I<true>
5899 =item B<LocalPort> I<Port>
5901 Count the connections to a specific local port. This can be used to see how
5902 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
5903 You have to specify the port in numeric form, so for the mailserver example
5904 you'd need to set B<25>.
5906 =item B<RemotePort> I<Port>
5908 Count the connections to a specific remote port. This is useful to see how
5909 much a remote service is used. This is most useful if you want to know how many
5910 connections a local service has opened to remote services, e.E<nbsp>g. how many
5911 connections a mail server or news server has to other mail or news servers, or
5912 how many connections a web proxy holds to web servers. You have to give the
5913 port in numeric form.
5917 =head2 Plugin C<thermal>
5921 =item B<ForceUseProcfs> I<true>|I<false>
5923 By default, the I<Thermal plugin> tries to read the statistics from the Linux
5924 C<sysfs> interface. If that is not available, the plugin falls back to the
5925 C<procfs> interface. By setting this option to I<true>, you can force the
5926 plugin to use the latter. This option defaults to I<false>.
5928 =item B<Device> I<Device>
5930 Selects the name of the thermal device that you want to collect or ignore,
5931 depending on the value of the B<IgnoreSelected> option. This option may be
5932 used multiple times to specify a list of devices.
5934 =item B<IgnoreSelected> I<true>|I<false>
5936 Invert the selection: If set to true, all devices B<except> the ones that
5937 match the device names specified by the B<Device> option are collected. By
5938 default only selected devices are collected if a selection is made. If no
5939 selection is configured at all, B<all> devices are selected.
5943 =head2 Plugin C<threshold>
5945 The I<Threshold plugin> checks values collected or received by I<collectd>
5946 against a configurable I<threshold> and issues I<notifications> if values are
5949 Documentation for this plugin is available in the L<collectd-threshold(5)>
5952 =head2 Plugin C<tokyotyrant>
5954 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
5955 couple metrics: number of records, and database size on disk.
5959 =item B<Host> I<Hostname/IP>
5961 The hostname or ip which identifies the server.
5962 Default: B<127.0.0.1>
5964 =item B<Port> I<Service/Port>
5966 The query port of the server. This needs to be a string, even if the port is
5967 given in its numeric form.
5972 =head2 Plugin C<unixsock>
5976 =item B<SocketFile> I<Path>
5978 Sets the socket-file which is to be created.
5980 =item B<SocketGroup> I<Group>
5982 If running as root change the group of the UNIX-socket after it has been
5983 created. Defaults to B<collectd>.
5985 =item B<SocketPerms> I<Permissions>
5987 Change the file permissions of the UNIX-socket after it has been created. The
5988 permissions must be given as a numeric, octal value as you would pass to
5989 L<chmod(1)>. Defaults to B<0770>.
5991 =item B<DeleteSocket> B<false>|B<true>
5993 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
5994 with the given name already exists. If I<collectd> crashes a socket file may be
5995 left over, preventing the daemon from opening a new socket when restarted.
5996 Since this is potentially dangerous, this defaults to B<false>.
6000 =head2 Plugin C<uuid>
6002 This plugin, if loaded, causes the Hostname to be taken from the machine's
6003 UUID. The UUID is a universally unique designation for the machine, usually
6004 taken from the machine's BIOS. This is most useful if the machine is running in
6005 a virtual environment such as Xen, in which case the UUID is preserved across
6006 shutdowns and migration.
6008 The following methods are used to find the machine's UUID, in order:
6014 Check I</etc/uuid> (or I<UUIDFile>).
6018 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
6023 Check for UUID from C<dmidecode> / SMBIOS.
6027 Check for UUID from Xen hypervisor.
6031 If no UUID can be found then the hostname is not modified.
6035 =item B<UUIDFile> I<Path>
6037 Take the UUID from the given file (default I</etc/uuid>).
6041 =head2 Plugin C<varnish>
6043 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
6048 <Instance "example">
6050 CollectConnections true
6060 CollectWorkers false
6064 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
6065 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
6066 will collectd statistics from the default "varnishd" instance (this should work
6067 fine in most cases).
6069 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
6073 =item B<CollectCache> B<true>|B<false>
6075 Cache hits and misses. True by default.
6077 =item B<CollectConnections> B<true>|B<false>
6079 Number of client connections received, accepted and dropped. True by default.
6081 =item B<CollectBackend> B<true>|B<false>
6083 Back-end connection statistics, such as successful, reused,
6084 and closed connections. True by default.
6086 =item B<CollectSHM> B<true>|B<false>
6088 Statistics about the shared memory log, a memory region to store
6089 log messages which is flushed to disk when full. True by default.
6091 =item B<CollectBan> B<true>|B<false>
6093 Statistics about ban operations, such as number of bans added, retired, and
6094 number of objects tested against ban operations. Only available with Varnish
6095 3.x. False by default.
6097 =item B<CollectDirectorDNS> B<true>|B<false>
6099 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
6102 =item B<CollectESI> B<true>|B<false>
6104 Edge Side Includes (ESI) parse statistics. False by default.
6106 =item B<CollectFetch> B<true>|B<false>
6108 Statistics about fetches (HTTP requests sent to the backend). False by default.
6110 =item B<CollectHCB> B<true>|B<false>
6112 Inserts and look-ups in the crit bit tree based hash. Look-ups are
6113 divided into locked and unlocked look-ups. False by default.
6115 =item B<CollectObjects> B<true>|B<false>
6117 Statistics on cached objects: number of objects expired, nuked (prematurely
6118 expired), saved, moved, etc. False by default.
6120 =item B<CollectPurge> B<true>|B<false>
6122 Statistics about purge operations, such as number of purges added, retired, and
6123 number of objects tested against purge operations. Only available with Varnish
6124 2.x. False by default.
6126 =item B<CollectSession> B<true>|B<false>
6128 Client session statistics. Number of past and current sessions, session herd and
6129 linger counters, etc. False by default.
6131 =item B<CollectSMA> B<true>|B<false>
6133 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
6134 component is Solaris specific. Only available with Varnish 2.x. False by
6137 =item B<CollectSMS> B<true>|B<false>
6139 synth (synthetic content) storage statistics. This storage
6140 component is used internally only. False by default.
6142 =item B<CollectSM> B<true>|B<false>
6144 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
6147 =item B<CollectStruct> B<true>|B<false>
6149 Current varnish internal state statistics. Number of current sessions, objects
6150 in cache store, open connections to backends (with Varnish 2.x), etc. False by
6153 =item B<CollectTotals> B<true>|B<false>
6155 Collects overview counters, such as the number of sessions created,
6156 the number of requests and bytes transferred. False by default.
6158 =item B<CollectUptime> B<true>|B<false>
6160 Varnish uptime. False by default.
6162 =item B<CollectVCL> B<true>|B<false>
6164 Number of total (available + discarded) VCL (config files). False by default.
6166 =item B<CollectWorkers> B<true>|B<false>
6168 Collect statistics about worker threads. False by default.
6172 =head2 Plugin C<vmem>
6174 The C<vmem> plugin collects information about the usage of virtual memory.
6175 Since the statistics provided by the Linux kernel are very detailed, they are
6176 collected very detailed. However, to get all the details, you have to switch
6177 them on manually. Most people just want an overview over, such as the number of
6178 pages read from swap space.
6182 =item B<Verbose> B<true>|B<false>
6184 Enables verbose collection of information. This will start collecting page
6185 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
6186 Part of these statistics are collected on a "per zone" basis.
6190 =head2 Plugin C<vserver>
6192 This plugin doesn't have any options. B<VServer> support is only available for
6193 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
6194 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
6195 need to apply the patches and compile your own kernel, which will then provide
6196 the F</proc/virtual> filesystem that is required by this plugin.
6198 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
6200 B<Note>: The traffic collected by this plugin accounts for the amount of
6201 traffic passing a socket which might be a lot less than the actual on-wire
6202 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
6203 collect on-wire traffic you could, for example, use the logging facilities of
6204 iptables to feed data for the guest IPs into the iptables plugin.
6206 =head2 Plugin C<write_graphite>
6208 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
6209 storage and graphing project. The plugin connects to I<Carbon>, the data layer
6210 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
6211 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
6212 of at most 1428 bytes to minimize the number of network packets.
6216 <Plugin write_graphite>
6226 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6227 blocks. Inside the B<Node> blocks, the following options are recognized:
6231 =item B<Host> I<Address>
6233 Hostname or address to connect to. Defaults to C<localhost>.
6235 =item B<Port> I<Service>
6237 Service name or port number to connect to. Defaults to C<2003>.
6239 =item B<Protocol> I<String>
6241 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
6243 =item B<LogSendErrors> B<false>|B<true>
6245 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
6246 If set to B<false>, it will not log the errors. This is especially useful when
6247 using Protocol UDP since many times we want to use the "fire-and-forget"
6248 approach and logging errors fills syslog with unneeded messages.
6250 =item B<Prefix> I<String>
6252 When set, I<String> is added in front of the host name. Dots and whitespace are
6253 I<not> escaped in this string (see B<EscapeCharacter> below).
6255 =item B<Postfix> I<String>
6257 When set, I<String> is appended to the host name. Dots and whitespace are
6258 I<not> escaped in this string (see B<EscapeCharacter> below).
6260 =item B<EscapeCharacter> I<Char>
6262 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
6263 in the identifier. The B<EscapeCharacter> option determines which character
6264 dots, whitespace and control characters are replaced with. Defaults to
6267 =item B<StoreRates> B<false>|B<true>
6269 If set to B<true> (the default), convert counter values to rates. If set to
6270 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6273 =item B<SeparateInstances> B<false>|B<true>
6275 If set to B<true>, the plugin instance and type instance will be in their own
6276 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6277 default), the plugin and plugin instance (and likewise the type and type
6278 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6280 =item B<AlwaysAppendDS> B<false>|B<true>
6282 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
6283 identifier. If set to B<false> (the default), this is only done when there is
6288 =head2 Plugin C<write_mongodb>
6290 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
6295 <Plugin "write_mongodb">
6304 The plugin can send values to multiple instances of I<MongoDB> by specifying
6305 one B<Node> block for each instance. Within the B<Node> blocks, the following
6306 options are available:
6310 =item B<Host> I<Address>
6312 Hostname or address to connect to. Defaults to C<localhost>.
6314 =item B<Port> I<Service>
6316 Service name or port number to connect to. Defaults to C<27017>.
6318 =item B<Timeout> I<Timeout>
6320 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
6321 Setting this option to zero means no timeout, which is the default.
6323 =item B<StoreRates> B<false>|B<true>
6325 If set to B<true> (the default), convert counter values to rates. If set to
6326 B<false> counter values are stored as is, i.e. as an increasing integer
6329 =item B<Database> I<Database>
6331 =item B<User> I<User>
6333 =item B<Password> I<Password>
6335 Sets the information used when authenticating to a I<MongoDB> database. The
6336 fields are optional (in which case no authentication is attempted), but if you
6337 want to use authentication all three fields must be set.
6341 =head2 Plugin C<write_http>
6343 This output plugin submits values to an http server by POST them using the
6344 PUTVAL plain-text protocol. Each destination you want to post data to needs to
6345 have one B<URL> block, within which the destination can be configured further,
6346 for example by specifying authentication data.
6350 <Plugin "write_http">
6351 <URL "http://example.com/post-collectd">
6357 B<URL> blocks need one string argument which is used as the URL to which data
6358 is posted. The following options are understood within B<URL> blocks.
6362 =item B<User> I<Username>
6364 Optional user name needed for authentication.
6366 =item B<Password> I<Password>
6368 Optional password needed for authentication.
6370 =item B<VerifyPeer> B<true>|B<false>
6372 Enable or disable peer SSL certificate verification. See
6373 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
6375 =item B<VerifyHost> B<true|false>
6377 Enable or disable peer host name verification. If enabled, the plugin checks if
6378 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
6379 matches the host name provided by the B<URL> option. If this identity check
6380 fails, the connection is aborted. Obviously, only works when connecting to a
6381 SSL enabled server. Enabled by default.
6383 =item B<CACert> I<File>
6385 File that holds one or more SSL certificates. If you want to use HTTPS you will
6386 possibly need this option. What CA certificates come bundled with C<libcurl>
6387 and are checked by default depends on the distribution you use.
6389 =item B<Format> B<Command>|B<JSON>
6391 Format of the output to generate. If set to B<Command>, will create output that
6392 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
6393 create output in the I<JavaScript Object Notation> (JSON).
6395 Defaults to B<Command>.
6397 =item B<StoreRates> B<true|false>
6399 If set to B<true>, convert counter values to rates. If set to B<false> (the
6400 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
6405 =head2 Plugin C<write_riemann>
6407 The I<write_riemann plugin> will send values to I<Riemann>, a powerfull stream
6408 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
6409 I<Riemann> using UDP packets.
6413 <Plugin "write_riemann">
6419 AlwaysAppendDS false
6423 Attribute "foo" "bar"
6426 The following options are understood by the I<write_riemann plugin>:
6430 =item E<lt>B<Node> I<Name>E<gt>
6432 The plugin's configuration consists of one or more B<Node> blocks. Each block
6433 is given a unique I<Name> and specifies one connection to an instance of
6434 I<Riemann>. Indise the B<Node> block, the following per-connection options are
6439 =item B<Host> I<Address>
6441 Hostname or address to connect to. Defaults to C<localhost>.
6443 =item B<Port> I<Service>
6445 Service name or port number to connect to. Defaults to C<5555>.
6447 =item B<Protocol> B<UDP>|B<TCP>
6449 Specify the protocol to use when communicating with I<Riemann>. Defaults to
6452 =item B<StoreRates> B<true>|B<false>
6454 If set to B<true> (the default), convert counter values to rates. If set to
6455 B<false> counter values are stored as is, i.e. as an increasing integer number.
6457 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
6458 converted values will have "rate" appended to the data source type, e.g.
6459 C<ds_type:derive:rate>.
6461 =item B<AlwaysAppendDS> B<false>|B<true>
6463 If set the B<true>, append the name of the I<Data Source> (DS) to the
6464 "service", i.e. the field that, together with the "host" field, uniquely
6465 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
6466 only done when there is more than one DS.
6468 =item B<TTLFactor> I<Factor>
6470 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
6471 event is considered active. I<collectd> populates this field based on the
6472 metrics interval setting. This setting controls the factor with which the
6473 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
6474 know exactly what you're doing, you should only increase this setting from its
6479 =item B<Tag> I<String>
6481 Add the given string as an additional tag to the metric being sent to
6484 =item B<Attribute> I<String> I<String>
6486 Consider the two given strings to be the key and value of an additional
6487 attribute for each metric being sent out to I<Riemann>.
6491 =head1 THRESHOLD CONFIGURATION
6493 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
6494 we mean that the values are not only stored or sent somewhere, but that they
6495 are judged and, if a problem is recognized, acted upon. The only action
6496 collectd takes itself is to generate and dispatch a "notification". Plugins can
6497 register to receive notifications and perform appropriate further actions.
6499 Since systems and what you expect them to do differ a lot, you can configure
6500 B<thresholds> for your values freely. This gives you a lot of flexibility but
6501 also a lot of responsibility.
6503 Every time a value is out of range a notification is dispatched. This means
6504 that the idle percentage of your CPU needs to be less then the configured
6505 threshold only once for a notification to be generated. There's no such thing
6506 as a moving average or similar - at least not now.
6508 Also, all values that match a threshold are considered to be relevant or
6509 "interesting". As a consequence collectd will issue a notification if they are
6510 not received for B<Timeout> iterations. The B<Timeout> configuration option is
6511 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
6512 "2" (the default) and some hosts sends it's CPU statistics to the server every
6513 60 seconds, a notification will be dispatched after about 120 seconds. It may
6514 take a little longer because the timeout is checked only once each B<Interval>
6517 When a value comes within range again or is received after it was missing, an
6518 "OKAY-notification" is dispatched.
6520 Here is a configuration example to get you started. Read below for more
6533 <Plugin "interface">
6550 WarningMin 100000000
6556 There are basically two types of configuration statements: The C<Host>,
6557 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
6558 configured. The C<Plugin> and C<Type> blocks may be specified further using the
6559 C<Instance> option. You can combine the block by nesting the blocks, though
6560 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
6561 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
6562 C<Type> may not contain other blocks. If multiple blocks apply to the same
6563 value the most specific block is used.
6565 The other statements specify the threshold to configure. They B<must> be
6566 included in a C<Type> block. Currently the following statements are recognized:
6570 =item B<FailureMax> I<Value>
6572 =item B<WarningMax> I<Value>
6574 Sets the upper bound of acceptable values. If unset defaults to positive
6575 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
6576 will be created. If the value is greater than B<WarningMax> but less than (or
6577 equal to) B<FailureMax> a B<WARNING> notification will be created.
6579 =item B<FailureMin> I<Value>
6581 =item B<WarningMin> I<Value>
6583 Sets the lower bound of acceptable values. If unset defaults to negative
6584 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
6585 be created. If the value is less than B<WarningMin> but greater than (or equal
6586 to) B<FailureMin> a B<WARNING> notification will be created.
6588 =item B<DataSource> I<DSName>
6590 Some data sets have more than one "data source". Interesting examples are the
6591 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
6592 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
6593 system load data set, C<load>, even has three data sources: C<shortterm>,
6594 C<midterm>, and C<longterm>.
6596 Normally, all data sources are checked against a configured threshold. If this
6597 is undesirable, or if you want to specify different limits for each data
6598 source, you can use the B<DataSource> option to have a threshold apply only to
6601 =item B<Invert> B<true>|B<false>
6603 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
6604 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
6605 B<WarningMax>) are not okay. Defaults to B<false>.
6607 =item B<Persist> B<true>|B<false>
6609 Sets how often notifications are generated. If set to B<true> one notification
6610 will be generated for each value that is out of the acceptable range. If set to
6611 B<false> (the default) then a notification is only generated if a value is out
6612 of range but the previous value was okay.
6614 This applies to missing values, too: If set to B<true> a notification about a
6615 missing value is generated once every B<Interval> seconds. If set to B<false>
6616 only one such notification is generated until the value appears again.
6618 =item B<Percentage> B<true>|B<false>
6620 If set to B<true>, the minimum and maximum values given are interpreted as
6621 percentage value, relative to the other data sources. This is helpful for
6622 example for the "df" type, where you may want to issue a warning when less than
6623 5E<nbsp>% of the total space is available. Defaults to B<false>.
6625 =item B<Hits> I<Number>
6627 Delay creating the notification until the threshold has been passed I<Number>
6628 times. When a notification has been generated, or when a subsequent value is
6629 inside the threshold, the counter is reset. If, for example, a value is
6630 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
6631 will be dispatched at most once every 30E<nbsp>seconds.
6633 This is useful when short bursts are not a problem. If, for example, 100% CPU
6634 usage for up to a minute is normal (and data is collected every
6635 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
6637 =item B<Hysteresis> I<Number>
6639 When set to non-zero, a hysteresis value is applied when checking minimum and
6640 maximum bounds. This is useful for values that increase slowly and fluctuate a
6641 bit while doing so. When these values come close to the threshold, they may
6642 "flap", i.e. switch between failure / warning case and okay case repeatedly.
6644 If, for example, the threshold is configures as
6649 then a I<Warning> notification is created when the value exceeds I<101> and the
6650 corresponding I<Okay> notification is only created once the value falls below
6651 I<99>, thus avoiding the "flapping".
6655 =head1 FILTER CONFIGURATION
6657 Starting with collectd 4.6 there is a powerful filtering infrastructure
6658 implemented in the daemon. The concept has mostly been copied from
6659 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
6660 terminology, so that users that are familiar with iptables feel right at home.
6664 The following are the terms used in the remainder of the filter configuration
6665 documentation. For an ASCII-art schema of the mechanism, see
6666 L<"General structure"> below.
6672 A I<match> is a criteria to select specific values. Examples are, of course, the
6673 name of the value or it's current value.
6675 Matches are implemented in plugins which you have to load prior to using the
6676 match. The name of such plugins starts with the "match_" prefix.
6680 A I<target> is some action that is to be performed with data. Such actions
6681 could, for example, be to change part of the value's identifier or to ignore
6682 the value completely.
6684 Some of these targets are built into the daemon, see L<"Built-in targets">
6685 below. Other targets are implemented in plugins which you have to load prior to
6686 using the target. The name of such plugins starts with the "target_" prefix.
6690 The combination of any number of matches and at least one target is called a
6691 I<rule>. The target actions will be performed for all values for which B<all>
6692 matches apply. If the rule does not have any matches associated with it, the
6693 target action will be performed for all values.
6697 A I<chain> is a list of rules and possibly default targets. The rules are tried
6698 in order and if one matches, the associated target will be called. If a value
6699 is handled by a rule, it depends on the target whether or not any subsequent
6700 rules are considered or if traversal of the chain is aborted, see
6701 L<"Flow control"> below. After all rules have been checked, the default targets
6706 =head2 General structure
6708 The following shows the resulting structure:
6715 +---------+ +---------+ +---------+ +---------+
6716 ! Rule !->! Match !->! Match !->! Target !
6717 +---------+ +---------+ +---------+ +---------+
6720 +---------+ +---------+ +---------+
6721 ! Rule !->! Target !->! Target !
6722 +---------+ +---------+ +---------+
6729 +---------+ +---------+ +---------+
6730 ! Rule !->! Match !->! Target !
6731 +---------+ +---------+ +---------+
6741 There are four ways to control which way a value takes through the filter
6748 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
6749 process the value with another chain. When the called chain finishes, usually
6750 the next target or rule after the jump is executed.
6754 The stop condition, signaled for example by the built-in target B<stop>, causes
6755 all processing of the value to be stopped immediately.
6759 Causes processing in the current chain to be aborted, but processing of the
6760 value generally will continue. This means that if the chain was called via
6761 B<Jump>, the next target or rule after the jump will be executed. If the chain
6762 was not called by another chain, control will be returned to the daemon and it
6763 may pass the value to another chain.
6767 Most targets will signal the B<continue> condition, meaning that processing
6768 should continue normally. There is no special built-in target for this
6775 The configuration reflects this structure directly:
6777 PostCacheChain "PostCache"
6779 <Rule "ignore_mysql_show">
6782 Type "^mysql_command$"
6783 TypeInstance "^show_"
6793 The above configuration example will ignore all values where the plugin field
6794 is "mysql", the type is "mysql_command" and the type instance begins with
6795 "show_". All other values will be sent to the C<rrdtool> write plugin via the
6796 default target of the chain. Since this chain is run after the value has been
6797 added to the cache, the MySQL C<show_*> command statistics will be available
6798 via the C<unixsock> plugin.
6800 =head2 List of configuration options
6804 =item B<PreCacheChain> I<ChainName>
6806 =item B<PostCacheChain> I<ChainName>
6808 Configure the name of the "pre-cache chain" and the "post-cache chain". The
6809 argument is the name of a I<chain> that should be executed before and/or after
6810 the values have been added to the cache.
6812 To understand the implications, it's important you know what is going on inside
6813 I<collectd>. The following diagram shows how values are passed from the
6814 read-plugins to the write-plugins:
6820 + - - - - V - - - - +
6821 : +---------------+ :
6824 : +-------+-------+ :
6827 : +-------+-------+ : +---------------+
6828 : ! Cache !--->! Value Cache !
6829 : ! insert ! : +---+---+-------+
6830 : +-------+-------+ : ! !
6831 : ! ,------------' !
6833 : +-------+---+---+ : +-------+-------+
6834 : ! Post-Cache +--->! Write-Plugins !
6835 : ! Chain ! : +---------------+
6836 : +---------------+ :
6839 + - - - - - - - - - +
6841 After the values are passed from the "read" plugins to the dispatch functions,
6842 the pre-cache chain is run first. The values are added to the internal cache
6843 afterwards. The post-cache chain is run after the values have been added to the
6844 cache. So why is it such a huge deal if chains are run before or after the
6845 values have been added to this cache?
6847 Targets that change the identifier of a value list should be executed before
6848 the values are added to the cache, so that the name in the cache matches the
6849 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
6850 this cache to receive a list of all available values. If you change the
6851 identifier after the value list has been added to the cache, this may easily
6852 lead to confusion, but it's not forbidden of course.
6854 The cache is also used to convert counter values to rates. These rates are, for
6855 example, used by the C<value> match (see below). If you use the rate stored in
6856 the cache B<before> the new value is added, you will use the old, B<previous>
6857 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
6858 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
6861 Last but not last, the B<stop> target makes a difference: If the pre-cache
6862 chain returns the stop condition, the value will not be added to the cache and
6863 the post-cache chain will not be run.
6865 =item B<Chain> I<Name>
6867 Adds a new chain with a certain name. This name can be used to refer to a
6868 specific chain, for example to jump to it.
6870 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
6872 =item B<Rule> [I<Name>]
6874 Adds a new rule to the current chain. The name of the rule is optional and
6875 currently has no meaning for the daemon.
6877 Within the B<Rule> block, there may be any number of B<Match> blocks and there
6878 must be at least one B<Target> block.
6880 =item B<Match> I<Name>
6882 Adds a match to a B<Rule> block. The name specifies what kind of match should
6883 be performed. Available matches depend on the plugins that have been loaded.
6885 The arguments inside the B<Match> block are passed to the plugin implementing
6886 the match, so which arguments are valid here depends on the plugin being used.
6887 If you do not need any to pass any arguments to a match, you can use the
6892 Which is equivalent to:
6897 =item B<Target> I<Name>
6899 Add a target to a rule or a default target to a chain. The name specifies what
6900 kind of target is to be added. Which targets are available depends on the
6901 plugins being loaded.
6903 The arguments inside the B<Target> block are passed to the plugin implementing
6904 the target, so which arguments are valid here depends on the plugin being used.
6905 If you do not need any to pass any arguments to a target, you can use the
6910 This is the same as writing:
6917 =head2 Built-in targets
6919 The following targets are built into the core daemon and therefore need no
6920 plugins to be loaded:
6926 Signals the "return" condition, see the L<"Flow control"> section above. This
6927 causes the current chain to stop processing the value and returns control to
6928 the calling chain. The calling chain will continue processing targets and rules
6929 just after the B<jump> target (see below). This is very similar to the
6930 B<RETURN> target of iptables, see L<iptables(8)>.
6932 This target does not have any options.
6940 Signals the "stop" condition, see the L<"Flow control"> section above. This
6941 causes processing of the value to be aborted immediately. This is similar to
6942 the B<DROP> target of iptables, see L<iptables(8)>.
6944 This target does not have any options.
6952 Sends the value to "write" plugins.
6958 =item B<Plugin> I<Name>
6960 Name of the write plugin to which the data should be sent. This option may be
6961 given multiple times to send the data to more than one write plugin.
6965 If no plugin is explicitly specified, the values will be sent to all available
6976 Starts processing the rules of another chain, see L<"Flow control"> above. If
6977 the end of that chain is reached, or a stop condition is encountered,
6978 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
6979 next target or the next rule. This is similar to the B<-j> command line option
6980 of iptables, see L<iptables(8)>.
6986 =item B<Chain> I<Name>
6988 Jumps to the chain I<Name>. This argument is required and may appear only once.
7000 =head2 Available matches
7006 Matches a value using regular expressions.
7012 =item B<Host> I<Regex>
7014 =item B<Plugin> I<Regex>
7016 =item B<PluginInstance> I<Regex>
7018 =item B<Type> I<Regex>
7020 =item B<TypeInstance> I<Regex>
7022 Match values where the given regular expressions match the various fields of
7023 the identifier of a value. If multiple regular expressions are given, B<all>
7024 regexen must match for a value to match.
7026 =item B<Invert> B<false>|B<true>
7028 When set to B<true>, the result of the match is inverted, i.e. all value lists
7029 where all regular expressions apply are not matched, all other value lists are
7030 matched. Defaults to B<false>.
7037 Host "customer[0-9]+"
7043 Matches values that have a time which differs from the time on the server.
7045 This match is mainly intended for servers that receive values over the
7046 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
7047 is very sensitive to the timestamp used when updating the RRD files. In
7048 particular, the time must be ever increasing. If a misbehaving client sends one
7049 packet with a timestamp far in the future, all further packets with a correct
7050 time will be ignored because of that one packet. What's worse, such corrupted
7051 RRD files are hard to fix.
7053 This match lets one match all values B<outside> a specified time range
7054 (relative to the server's time), so you can use the B<stop> target (see below)
7055 to ignore the value, for example.
7061 =item B<Future> I<Seconds>
7063 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
7064 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7067 =item B<Past> I<Seconds>
7069 Matches all values that are I<behind> of the server's time by I<Seconds> or
7070 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7082 This example matches all values that are five minutes or more ahead of the
7083 server or one hour (or more) lagging behind.
7087 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
7088 values. If a data-set consists of more than one data-source, all data-sources
7089 must match the specified ranges for a positive match.
7095 =item B<Min> I<Value>
7097 Sets the smallest value which still results in a match. If unset, behaves like
7100 =item B<Max> I<Value>
7102 Sets the largest value which still results in a match. If unset, behaves like
7105 =item B<Invert> B<true>|B<false>
7107 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
7108 no-match is returned and vice versa. Please note that the B<Invert> setting
7109 only effects how B<Min> and B<Max> are applied to a specific value. Especially
7110 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
7112 =item B<DataSource> I<DSName> [I<DSName> ...]
7114 Select one or more of the data sources. If no data source is configured, all
7115 data sources will be checked. If the type handled by the match does not have a
7116 data source of the specified name(s), this will always result in no match
7117 (independent of the B<Invert> setting).
7119 =item B<Satisfy> B<Any>|B<All>
7121 Specifies how checking with several data sources is performed. If set to
7122 B<Any>, the match succeeds if one of the data sources is in the configured
7123 range. If set to B<All> the match only succeeds if all data sources are within
7124 the configured range. Default is B<All>.
7126 Usually B<All> is used for positive matches, B<Any> is used for negative
7127 matches. This means that with B<All> you usually check that all values are in a
7128 "good" range, while with B<Any> you check if any value is within a "bad" range
7129 (or outside the "good" range).
7133 Either B<Min> or B<Max>, but not both, may be unset.
7137 # Match all values smaller than or equal to 100. Matches only if all data
7138 # sources are below 100.
7144 # Match if the value of any data source is outside the range of 0 - 100.
7152 =item B<empty_counter>
7154 Matches all values with one or more data sources of type B<COUNTER> and where
7155 all counter values are zero. These counters usually I<never> increased since
7156 they started existing (and are therefore uninteresting), or got reset recently
7157 or overflowed and you had really, I<really> bad luck.
7159 Please keep in mind that ignoring such counters can result in confusing
7160 behavior: Counters which hardly ever increase will be zero for long periods of
7161 time. If the counter is reset for some reason (machine or service restarted,
7162 usually), the graph will be empty (NAN) for a long time. People may not
7167 Calculates a hash value of the host name and matches values according to that
7168 hash value. This makes it possible to divide all hosts into groups and match
7169 only values that are in a specific group. The intended use is in load
7170 balancing, where you want to handle only part of all data and leave the rest
7173 The hashing function used tries to distribute the hosts evenly. First, it
7174 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
7177 for (i = 0; host[i] != 0; i++)
7178 hash_value = (hash_value * 251) + host[i];
7180 The constant 251 is a prime number which is supposed to make this hash value
7181 more random. The code then checks the group for this host according to the
7182 I<Total> and I<Match> arguments:
7184 if ((hash_value % Total) == Match)
7189 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
7190 groups), then the least significant bit of the hash value will be the XOR of
7191 all least significant bits in the host name. One consequence is that when you
7192 have two hosts, "server0.example.com" and "server1.example.com", where the host
7193 name differs in one digit only and the digits differ by one, those hosts will
7194 never end up in the same group.
7200 =item B<Match> I<Match> I<Total>
7202 Divide the data into I<Total> groups and match all hosts in group I<Match> as
7203 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
7204 be smaller than I<Total>. I<Total> must be at least one, although only values
7205 greater than one really do make any sense.
7207 You can repeat this option to match multiple groups, for example:
7212 The above config will divide the data into seven groups and match groups three
7213 and five. One use would be to keep every value on two hosts so that if one
7214 fails the missing data can later be reconstructed from the second host.
7220 # Operate on the pre-cache chain, so that ignored values are not even in the
7225 # Divide all received hosts in seven groups and accept all hosts in
7229 # If matched: Return and continue.
7232 # If not matched: Return and stop.
7238 =head2 Available targets
7242 =item B<notification>
7244 Creates and dispatches a notification.
7250 =item B<Message> I<String>
7252 This required option sets the message of the notification. The following
7253 placeholders will be replaced by an appropriate value:
7261 =item B<%{plugin_instance}>
7265 =item B<%{type_instance}>
7267 These placeholders are replaced by the identifier field of the same name.
7269 =item B<%{ds:>I<name>B<}>
7271 These placeholders are replaced by a (hopefully) human readable representation
7272 of the current rate of this data source. If you changed the instance name
7273 (using the B<set> or B<replace> targets, see below), it may not be possible to
7274 convert counter values to rates.
7278 Please note that these placeholders are B<case sensitive>!
7280 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
7282 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
7289 <Target "notification">
7290 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
7296 Replaces parts of the identifier using regular expressions.
7302 =item B<Host> I<Regex> I<Replacement>
7304 =item B<Plugin> I<Regex> I<Replacement>
7306 =item B<PluginInstance> I<Regex> I<Replacement>
7308 =item B<TypeInstance> I<Regex> I<Replacement>
7310 Match the appropriate field with the given regular expression I<Regex>. If the
7311 regular expression matches, that part that matches is replaced with
7312 I<Replacement>. If multiple places of the input buffer match a given regular
7313 expression, only the first occurrence will be replaced.
7315 You can specify each option multiple times to use multiple regular expressions
7323 # Replace "example.net" with "example.com"
7324 Host "\\<example.net\\>" "example.com"
7326 # Strip "www." from hostnames
7332 Sets part of the identifier of a value to a given string.
7338 =item B<Host> I<String>
7340 =item B<Plugin> I<String>
7342 =item B<PluginInstance> I<String>
7344 =item B<TypeInstance> I<String>
7346 Set the appropriate field to the given string. The strings for plugin instance
7347 and type instance may be empty, the strings for host and plugin may not be
7348 empty. It's currently not possible to set the type of a value this way.
7355 PluginInstance "coretemp"
7356 TypeInstance "core3"
7361 =head2 Backwards compatibility
7363 If you use collectd with an old configuration, i.E<nbsp>e. one without a
7364 B<Chain> block, it will behave as it used to. This is equivalent to the
7365 following configuration:
7371 If you specify a B<PostCacheChain>, the B<write> target will not be added
7372 anywhere and you will have to make sure that it is called where appropriate. We
7373 suggest to add the above snippet as default target to your "PostCache" chain.
7377 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
7393 L<collectd-exec(5)>,
7394 L<collectd-perl(5)>,
7395 L<collectd-unixsock(5)>,
7408 Florian Forster E<lt>octo@verplant.orgE<gt>