5 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
9 BaseDir "/path/to/data/"
10 PIDFile "/path/to/pidfile/collectd.pid"
11 Server "123.123.123.123" 12345
28 This config file controls how the system statistics collection daemon
29 B<collectd> behaves. The most significant option is B<LoadPlugin>, which
30 controls which plugins to load. These plugins ultimately define collectd's
33 The syntax of this config file is similar to the config file of the famous
34 I<Apache> webserver. Each line contains either an option (a key and a list of
35 one or more values) or a section-start or -end. Empty lines and everything
36 after a non-quoted hash-symbol (C<#>) is ignored. I<Keys> are unquoted
37 strings, consisting only of alphanumeric characters and the underscore (C<_>)
38 character. Keys are handled case insensitive by I<collectd> itself and all
39 plugins included with it. I<Values> can either be an I<unquoted string>, a
40 I<quoted string> (enclosed in double-quotes) a I<number> or a I<boolean>
41 expression. I<Unquoted strings> consist of only alphanumeric characters and
42 underscores (C<_>) and do not need to be quoted. I<Quoted strings> are
43 enclosed in double quotes (C<">). You can use the backslash character (C<\>)
44 to include double quotes as part of the string. I<Numbers> can be specified in
45 decimal and floating point format (using a dot C<.> as decimal separator),
46 hexadecimal when using the C<0x> prefix and octal with a leading zero (C<0>).
47 I<Boolean> values are either B<true> or B<false>.
49 Lines may be wrapped by using C<\> as the last character before the newline.
50 This allows long lines to be split into multiple lines. Quoted strings may be
51 wrapped as well. However, those are treated special in that whitespace at the
52 beginning of the following lines will be ignored, which allows for nicely
53 indenting the wrapped lines.
55 The configuration is read and processed in order, i.e. from top to bottom. So
56 the plugins are loaded in the order listed in this config file. It is a good
57 idea to load any logging plugins first in order to catch messages from plugins
58 during configuration. Also, the C<LoadPlugin> option B<must> occur B<before>
59 the appropriate C<E<lt>Plugin ...E<gt>> block.
65 =item B<BaseDir> I<Directory>
67 Sets the base directory. This is the directory beneath all RRD-files are
68 created. Possibly more subdirectories are created. This is also the working
69 directory for the daemon.
71 =item B<LoadPlugin> I<Plugin>
73 Loads the plugin I<Plugin>. This is required to load plugins, unless the
74 B<AutoLoadPlugin> option is enabled (see below). Without any loaded plugins,
75 I<collectd> will be mostly useless.
77 Only the first B<LoadPlugin> statement or block for a given plugin name has any
78 effect. This is useful when you want to split up the configuration into smaller
79 files and want each file to be "self contained", i.e. it contains a B<Plugin>
80 block I<and> then appropriate B<LoadPlugin> statement. The downside is that if
81 you have multiple conflicting B<LoadPlugin> blocks, e.g. when they specify
82 different intervals, only one of them (the first one encountered) will take
83 effect and all others will be silently ignored.
85 B<LoadPlugin> may either be a simple configuration I<statement> or a I<block>
86 with additional options, affecting the behavior of B<LoadPlugin>. A simple
87 statement looks like this:
91 Options inside a B<LoadPlugin> block can override default settings and
92 influence the way plugins are loaded, e.g.:
99 The following options are valid inside B<LoadPlugin> blocks:
103 =item B<Globals> B<true|false>
105 If enabled, collectd will export all global symbols of the plugin (and of all
106 libraries loaded as dependencies of the plugin) and, thus, makes those symbols
107 available for resolving unresolved symbols in subsequently loaded plugins if
108 that is supported by your system.
110 This is useful (or possibly even required), e.g., when loading a plugin that
111 embeds some scripting language into the daemon (e.g. the I<Perl> and
112 I<Python plugins>). Scripting languages usually provide means to load
113 extensions written in C. Those extensions require symbols provided by the
114 interpreter, which is loaded as a dependency of the respective collectd plugin.
115 See the documentation of those plugins (e.g., L<collectd-perl(5)> or
116 L<collectd-python(5)>) for details.
118 By default, this is disabled. As a special exception, if the plugin name is
119 either C<perl> or C<python>, the default is changed to enabled in order to keep
120 the average user from ever having to deal with this low level linking stuff.
122 =item B<Interval> I<Seconds>
124 Sets a plugin-specific interval for collecting metrics. This overrides the
125 global B<Interval> setting. If a plugin provides own support for specifying an
126 interval, that setting will take precedence.
130 =item B<AutoLoadPlugin> B<false>|B<true>
132 When set to B<false> (the default), each plugin needs to be loaded explicitly,
133 using the B<LoadPlugin> statement documented above. If a
134 B<E<lt>PluginE<nbsp>...E<gt>> block is encountered and no configuration
135 handling callback for this plugin has been registered, a warning is logged and
136 the block is ignored.
138 When set to B<true>, explicit B<LoadPlugin> statements are not required. Each
139 B<E<lt>PluginE<nbsp>...E<gt>> block acts as if it was immediately preceded by a
140 B<LoadPlugin> statement. B<LoadPlugin> statements are still required for
141 plugins that don't provide any configuration, e.g. the I<Load plugin>.
143 =item B<Include> I<Path> [I<pattern>]
145 If I<Path> points to a file, includes that file. If I<Path> points to a
146 directory, recursively includes all files within that directory and its
147 subdirectories. If the C<wordexp> function is available on your system,
148 shell-like wildcards are expanded before files are included. This means you can
149 use statements like the following:
151 Include "/etc/collectd.d/*.conf"
153 Starting with version 5.3, this may also be a block in which further options
154 affecting the behavior of B<Include> may be specified. The following option is
157 <Include "/etc/collectd.d">
163 =item B<Filter> I<pattern>
165 If the C<fnmatch> function is available on your system, a shell-like wildcard
166 I<pattern> may be specified to filter which files to include. This may be used
167 in combination with recursively including a directory to easily be able to
168 arbitrarily mix configuration files and other documents (e.g. README files).
169 The given example is similar to the first example above but includes all files
170 matching C<*.conf> in any subdirectory of C</etc/collectd.d>:
172 Include "/etc/collectd.d" "*.conf"
176 If more than one files are included by a single B<Include> option, the files
177 will be included in lexicographical order (as defined by the C<strcmp>
178 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
179 order in which the files are loaded.
181 To prevent loops and shooting yourself in the foot in interesting ways the
182 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
183 most uses. Since symlinks are followed it is still possible to crash the daemon
184 by looping symlinks. In our opinion significant stupidity should result in an
185 appropriate amount of pain.
187 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
188 file, but you cannot include files from within blocks.
190 =item B<PIDFile> I<File>
192 Sets where to write the PID file to. This file is overwritten when it exists
193 and deleted when the program is stopped. Some init-scripts might override this
194 setting using the B<-P> command-line option.
196 =item B<PluginDir> I<Directory>
198 Path to the plugins (shared objects) of collectd.
200 =item B<TypesDB> I<File> [I<File> ...]
202 Set one or more files that contain the data-set descriptions. See
203 L<types.db(5)> for a description of the format of this file.
205 =item B<Interval> I<Seconds>
207 Configures the interval in which to query the read plugins. Obviously smaller
208 values lead to a higher system load produced by collectd, while higher values
209 lead to more coarse statistics.
211 B<Warning:> You should set this once and then never touch it again. If you do,
212 I<you will have to delete all your RRD files> or know some serious RRDtool
213 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
215 =item B<Timeout> I<Iterations>
217 Consider a value list "missing" when no update has been read or received for
218 I<Iterations> iterations. By default, I<collectd> considers a value list
219 missing when no update has been received for twice the update interval. Since
220 this setting uses iterations, the maximum allowed time without update depends
221 on the I<Interval> information contained in each value list. This is used in
222 the I<Threshold> configuration to dispatch notifications about missing values,
223 see L<collectd-threshold(5)> for details.
225 =item B<ReadThreads> I<Num>
227 Number of threads to start for reading plugins. The default value is B<5>, but
228 you may want to increase this if you have more than five plugins that take a
229 long time to read. Mostly those are plugins that do network-IO. Setting this to
230 a value higher than the number of registered read callbacks is not recommended.
232 =item B<WriteThreads> I<Num>
234 Number of threads to start for dispatching value lists to write plugins. The
235 default value is B<5>, but you may want to increase this if you have more than
236 five plugins that may take relatively long to write to.
238 =item B<WriteQueueLimitHigh> I<HighNum>
240 =item B<WriteQueueLimitLow> I<LowNum>
242 Metrics are read by the I<read threads> and then put into a queue to be handled
243 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
244 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
245 running into memory issues in such a case, you can limit the size of this
248 By default, there is no limit and memory may grow indefinitely. This is most
249 likely not an issue for clients, i.e. instances that only handle the local
250 metrics. For servers it is recommended to set this to a non-zero value, though.
252 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
253 Each of them takes a numerical argument which is the number of metrics in the
254 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
255 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
256 I<will> be enqueued. If the number of metrics currently in the queue is between
257 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
258 proportional to the number of metrics in the queue (i.e. it increases linearly
259 until it reaches 100%.)
261 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
262 unset, the latter will default to half of B<WriteQueueLimitHigh>.
264 If you do not want to randomly drop values when the queue size is between
265 I<LowNum> and I<HighNum>, set If B<WriteQueueLimitHigh> and
266 B<WriteQueueLimitLow> to same value.
268 =item B<Hostname> I<Name>
270 Sets the hostname that identifies a host. If you omit this setting, the
271 hostname will be determined using the L<gethostname(2)> system call.
273 =item B<FQDNLookup> B<true|false>
275 If B<Hostname> is determined automatically this setting controls whether or not
276 the daemon should try to figure out the "fully qualified domain name", FQDN.
277 This is done using a lookup of the name returned by C<gethostname>. This option
278 is enabled by default.
280 =item B<PreCacheChain> I<ChainName>
282 =item B<PostCacheChain> I<ChainName>
284 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
285 see L<FILTER CONFIGURATION> below on information on chains and how these
286 setting change the daemon's behavior.
290 =head1 PLUGIN OPTIONS
292 Some plugins may register own options. These options must be enclosed in a
293 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
294 require external configuration, too. The C<apache plugin>, for example,
295 required C<mod_status> to be configured in the webserver you're going to
296 collect data from. These plugins are listed below as well, even if they don't
297 require any configuration within collectd's configuration file.
299 A list of all plugins and a short summary for each plugin can be found in the
300 F<README> file shipped with the sourcecode and hopefully binary packets as
303 =head2 Plugin C<aggregation>
305 The I<Aggregation plugin> makes it possible to aggregate several values into
306 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
307 This can be put to a wide variety of uses, e.g. average and total CPU
308 statistics for your entire fleet.
310 The grouping is powerful but, as with many powerful tools, may be a bit
311 difficult to wrap your head around. The grouping will therefore be
312 demonstrated using an example: The average and sum of the CPU usage across
313 all CPUs of each host is to be calculated.
315 To select all the affected values for our example, set C<Plugin cpu> and
316 C<Type cpu>. The other values are left unspecified, meaning "all values". The
317 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
318 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
324 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...) and
325 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
326 example, the intention is to have a new value for each host / type instance
327 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
328 It can be specified multiple times to group by more than one field.
331 GroupBy "TypeInstance"
333 We do neither specify nor group by I<plugin instance> (the CPU number), so all
334 metrics that differ in the CPU number only will be aggregated. Each
335 aggregation needs I<at least one> such field, otherwise no aggregation would
338 The full example configuration looks like this:
340 <Plugin "aggregation">
346 GroupBy "TypeInstance"
349 CalculateAverage true
353 There are a couple of limitations you should be aware of:
359 The I<Type> cannot be left unspecified, because it is not reasonable to add
360 apples to oranges. Also, the internal lookup structure won't work if you try
365 There must be at least one unspecified, ungrouped field. Otherwise nothing
370 As you can see in the example above, each aggregation has its own
371 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
372 blocks may match the same values, i.e. one value list can update multiple
373 aggregations. The following options are valid inside B<Aggregation> blocks:
377 =item B<Host> I<Host>
379 =item B<Plugin> I<Plugin>
381 =item B<PluginInstance> I<PluginInstance>
383 =item B<Type> I<Type>
385 =item B<TypeInstance> I<TypeInstance>
387 Selects the value lists to be added to this aggregation. B<Type> must be a
388 valid data set name, see L<types.db(5)> for details.
390 If the string starts with and ends with a slash (C</>), the string is
391 interpreted as a I<regular expression>. The regex flavor used are POSIX
392 extended regular expressions as described in L<regex(7)>. Example usage:
394 Host "/^db[0-9]\\.example\\.com$/"
396 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
398 Group valued by the specified field. The B<GroupBy> option may be repeated to
399 group by multiple fields.
401 =item B<SetHost> I<Host>
403 =item B<SetPlugin> I<Plugin>
405 =item B<SetPluginInstance> I<PluginInstance>
407 =item B<SetTypeInstance> I<TypeInstance>
409 Sets the appropriate part of the identifier to the provided string.
411 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
412 will be replaced with the aggregation function, e.g. "average". Not including
413 the placeholder will result in duplication warnings and/or messed up values if
414 more than one aggregation function are enabled.
416 The following example calculates the average usage of all "even" CPUs:
418 <Plugin "aggregation">
421 PluginInstance "/[0,2,4,6,8]$/"
425 SetPluginInstance "even-%{aggregation}"
428 GroupBy "TypeInstance"
430 CalculateAverage true
434 This will create the files:
440 foo.example.com/cpu-even-average/cpu-idle
444 foo.example.com/cpu-even-average/cpu-system
448 foo.example.com/cpu-even-average/cpu-user
456 =item B<CalculateNum> B<true>|B<false>
458 =item B<CalculateSum> B<true>|B<false>
460 =item B<CalculateAverage> B<true>|B<false>
462 =item B<CalculateMinimum> B<true>|B<false>
464 =item B<CalculateMaximum> B<true>|B<false>
466 =item B<CalculateStddev> B<true>|B<false>
468 Boolean options for enabling calculation of the number of value lists, their
469 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
470 are disabled by default.
474 =head2 Plugin C<amqp>
476 The I<AMQMP plugin> can be used to communicate with other instances of
477 I<collectd> or third party applications using an AMQP message broker. Values
478 are sent to or received from the broker, which handles routing, queueing and
479 possibly filtering or messages.
482 # Send values to an AMQP broker
483 <Publish "some_name">
489 Exchange "amq.fanout"
490 # ExchangeType "fanout"
491 # RoutingKey "collectd"
495 # GraphitePrefix "collectd."
496 # GraphiteEscapeChar "_"
499 # Receive values from an AMQP broker
500 <Subscribe "some_name">
506 Exchange "amq.fanout"
507 # ExchangeType "fanout"
509 # RoutingKey "collectd.#"
513 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
514 blocks, which configure sending and receiving of values respectively. The two
515 blocks are very similar, so unless otherwise noted, an option can be used in
516 either block. The name given in the blocks starting tag is only used for
517 reporting messages, but may be used to support I<flushing> of certain
518 I<Publish> blocks in the future.
522 =item B<Host> I<Host>
524 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
525 the underlying communications library, I<rabbitmq-c>, which is "localhost".
527 =item B<Port> I<Port>
529 Service name or port number on which the AMQP broker accepts connections. This
530 argument must be a string, even if the numeric form is used. Defaults to
533 =item B<VHost> I<VHost>
535 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
537 =item B<User> I<User>
539 =item B<Password> I<Password>
541 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
544 =item B<Exchange> I<Exchange>
546 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
547 By default, "amq.fanout" will be used.
549 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
550 the given exchange and the I<queue> is created, using the I<routing key> if
551 configured. See the B<Queue> and B<RoutingKey> options below.
553 =item B<ExchangeType> I<Type>
555 If given, the plugin will try to create the configured I<exchange> with this
556 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
557 be bound to this exchange.
559 =item B<Queue> I<Queue> (Subscribe only)
561 Configures the I<queue> name to subscribe to. If no queue name was configures
562 explicitly, a unique queue name will be created by the broker.
564 =item B<RoutingKey> I<Key>
566 In I<Publish> blocks, this configures the routing key to set on all outgoing
567 messages. If not given, the routing key will be computed from the I<identifier>
568 of the value. The host, plugin, type and the two instances are concatenated
569 together using dots as the separator and all containing dots replaced with
570 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
571 possible to receive only specific values using a "topic" exchange.
573 In I<Subscribe> blocks, configures the I<routing key> used when creating a
574 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
575 used to filter messages when using a "topic" exchange. If you're only
576 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
579 =item B<Persistent> B<true>|B<false> (Publish only)
581 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
582 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
583 default), the I<transient> delivery mode will be used, i.e. messages may be
584 lost due to high load, overflowing queues or similar issues.
586 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
588 Selects the format in which messages are sent to the broker. If set to
589 B<Command> (the default), values are sent as C<PUTVAL> commands which are
590 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
591 case, the C<Content-Type> header field will be set to C<text/collectd>.
593 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
594 an easy and straight forward exchange format. The C<Content-Type> header field
595 will be set to C<application/json>.
597 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
598 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
601 A subscribing client I<should> use the C<Content-Type> header field to
602 determine how to decode the values. Currently, the I<AMQP plugin> itself can
603 only decode the B<Command> format.
605 =item B<StoreRates> B<true>|B<false> (Publish only)
607 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
608 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
609 default), no conversion is performed. Otherwise the conversion is performed
610 using the internal value cache.
612 Please note that currently this option is only used if the B<Format> option has
615 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
617 A prefix can be added in the metric name when outputting in the I<Graphite> format.
618 It's added before the I<Host> name.
619 Metric name will be "<prefix><host><postfix><plugin><type><name>"
621 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
623 A postfix can be added in the metric name when outputting in the I<Graphite> format.
624 It's added after the I<Host> name.
625 Metric name will be "<prefix><host><postfix><plugin><type><name>"
627 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
629 Specify a character to replace dots (.) in the host part of the metric name.
630 In I<Graphite> metric name, dots are used as separators between different
631 metric parts (host, plugin, type).
632 Default is "_" (I<Underscore>).
636 =head2 Plugin C<apache>
638 To configure the C<apache>-plugin you first need to configure the Apache
639 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
640 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
641 the following snipped to base your Apache config upon:
644 <IfModule mod_status.c>
645 <Location /mod_status>
646 SetHandler server-status
650 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
651 also supported. It introduces a new field, called C<BusyServers>, to count the
652 number of currently connected clients. This field is also supported.
654 The configuration of the I<Apache> plugin consists of one or more
655 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
656 as the instance name. For example:
660 URL "http://www1.example.com/mod_status?auto"
663 URL "http://www2.example.com/mod_status?auto"
667 The instance name will be used as the I<plugin instance>. To emulate the old
668 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
669 plugin to work correctly, each instance name must be unique. This is not
670 enforced by the plugin and it is your responsibility to ensure it.
672 The following options are accepted within each I<Instance> block:
676 =item B<URL> I<http://host/mod_status?auto>
678 Sets the URL of the C<mod_status> output. This needs to be the output generated
679 by C<ExtendedStatus on> and it needs to be the machine readable output
680 generated by appending the C<?auto> argument. This option is I<mandatory>.
682 =item B<User> I<Username>
684 Optional user name needed for authentication.
686 =item B<Password> I<Password>
688 Optional password needed for authentication.
690 =item B<VerifyPeer> B<true|false>
692 Enable or disable peer SSL certificate verification. See
693 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
695 =item B<VerifyHost> B<true|false>
697 Enable or disable peer host name verification. If enabled, the plugin checks
698 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
699 certificate matches the host name provided by the B<URL> option. If this
700 identity check fails, the connection is aborted. Obviously, only works when
701 connecting to a SSL enabled server. Enabled by default.
703 =item B<CACert> I<File>
705 File that holds one or more SSL certificates. If you want to use HTTPS you will
706 possibly need this option. What CA certificates come bundled with C<libcurl>
707 and are checked by default depends on the distribution you use.
711 =head2 Plugin C<apcups>
715 =item B<Host> I<Hostname>
717 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
718 that IPv6 support has been disabled unless someone can confirm or decline that
719 B<apcupsd> can handle it.
721 =item B<Port> I<Port>
723 TCP-Port to connect to. Defaults to B<3551>.
725 =item B<ReportSeconds> B<true|false>
727 If set to B<true>, the time reported in the C<timeleft> metric will be
728 converted to seconds. This is the recommended setting. If set to B<false>, the
729 default for backwards compatibility, the time will be reported in minutes.
733 =head2 Plugin C<aquaero>
735 This plugin collects the value of the available sensors in an
736 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
737 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
738 connection for monitoring and configuration. The board can handle multiple
739 temperature sensors, fans, water pumps and water level sensors and adjust the
740 output settings such as fan voltage or power used by the water pump based on
741 the available inputs using a configurable controller included in the board.
742 This plugin collects all the available inputs as well as some of the output
743 values chosen by this controller. The plugin is based on the I<libaquaero5>
744 library provided by I<aquatools-ng>.
748 =item B<Device> I<DevicePath>
750 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
751 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
752 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
756 =head2 Plugin C<ascent>
758 This plugin collects information about an Ascent server, a free server for the
759 "World of Warcraft" game. This plugin gathers the information by fetching the
760 XML status page using C<libcurl> and parses it using C<libxml2>.
762 The configuration options are the same as for the C<apache> plugin above:
766 =item B<URL> I<http://localhost/ascent/status/>
768 Sets the URL of the XML status output.
770 =item B<User> I<Username>
772 Optional user name needed for authentication.
774 =item B<Password> I<Password>
776 Optional password needed for authentication.
778 =item B<VerifyPeer> B<true|false>
780 Enable or disable peer SSL certificate verification. See
781 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
783 =item B<VerifyHost> B<true|false>
785 Enable or disable peer host name verification. If enabled, the plugin checks
786 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
787 certificate matches the host name provided by the B<URL> option. If this
788 identity check fails, the connection is aborted. Obviously, only works when
789 connecting to a SSL enabled server. Enabled by default.
791 =item B<CACert> I<File>
793 File that holds one or more SSL certificates. If you want to use HTTPS you will
794 possibly need this option. What CA certificates come bundled with C<libcurl>
795 and are checked by default depends on the distribution you use.
799 =head2 Plugin C<bind>
801 Starting with BIND 9.5.0, the most widely used DNS server software provides
802 extensive statistics about queries, responses and lots of other information.
803 The bind plugin retrieves this information that's encoded in XML and provided
804 via HTTP and submits the values to collectd.
806 To use this plugin, you first need to tell BIND to make this information
807 available. This is done with the C<statistics-channels> configuration option:
809 statistics-channels {
810 inet localhost port 8053;
813 The configuration follows the grouping that can be seen when looking at the
814 data with an XSLT compatible viewer, such as a modern web browser. It's
815 probably a good idea to make yourself familiar with the provided values, so you
816 can understand what the collected statistics actually mean.
821 URL "http://localhost:8053/"
836 Zone "127.in-addr.arpa/IN"
840 The bind plugin accepts the following configuration options:
846 URL from which to retrieve the XML data. If not specified,
847 C<http://localhost:8053/> will be used.
849 =item B<ParseTime> B<true>|B<false>
851 When set to B<true>, the time provided by BIND will be parsed and used to
852 dispatch the values. When set to B<false>, the local time source is queried.
854 This setting is set to B<true> by default for backwards compatibility; setting
855 this to B<false> is I<recommended> to avoid problems with timezones and
858 =item B<OpCodes> B<true>|B<false>
860 When enabled, statistics about the I<"OpCodes">, for example the number of
861 C<QUERY> packets, are collected.
865 =item B<QTypes> B<true>|B<false>
867 When enabled, the number of I<incoming> queries by query types (for example
868 C<A>, C<MX>, C<AAAA>) is collected.
872 =item B<ServerStats> B<true>|B<false>
874 Collect global server statistics, such as requests received over IPv4 and IPv6,
875 successful queries, and failed updates.
879 =item B<ZoneMaintStats> B<true>|B<false>
881 Collect zone maintenance statistics, mostly information about notifications
882 (zone updates) and zone transfers.
886 =item B<ResolverStats> B<true>|B<false>
888 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
889 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
890 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
891 default. Use the B<ResolverStats> option within a B<View "_default"> block
892 instead for the same functionality.
898 Collect global memory statistics.
902 =item B<View> I<Name>
904 Collect statistics about a specific I<"view">. BIND can behave different,
905 mostly depending on the source IP-address of the request. These different
906 configurations are called "views". If you don't use this feature, you most
907 likely are only interested in the C<_default> view.
909 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
910 information you want to collect about a view. If no B<View> block is
911 configured, no detailed view statistics will be collected.
915 =item B<QTypes> B<true>|B<false>
917 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
922 =item B<ResolverStats> B<true>|B<false>
924 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
925 (e.E<nbsp>g. queries over IPv4, lame servers).
929 =item B<CacheRRSets> B<true>|B<false>
931 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
932 type is collected. Negative entries (queries which resulted in an error, for
933 example names that do not exist) are reported with a leading exclamation mark,
938 =item B<Zone> I<Name>
940 When given, collect detailed information about the given zone in the view. The
941 information collected if very similar to the global B<ServerStats> information
944 You can repeat this option to collect detailed information about multiple
947 By default no detailed zone information is collected.
953 =head2 Plugin C<cgroups>
955 This plugin collects the CPU user/system time for each I<cgroup> by reading the
956 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
957 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
961 =item B<CGroup> I<Directory>
963 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
964 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
967 =item B<IgnoreSelected> B<true>|B<false>
969 Invert the selection: If set to true, all cgroups I<except> the ones that
970 match any one of the criteria are collected. By default only selected
971 cgroups are collected if a selection is made. If no selection is configured
972 at all, B<all> cgroups are selected.
976 =head2 Plugin C<cpufreq>
978 This plugin doesn't have any options. It reads
979 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
980 installed) to get the current CPU frequency. If this file does not exist make
981 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
982 installed and an "cpu governor" (that's a kernel module) is loaded.
988 =item B<DataDir> I<Directory>
990 Set the directory to store CSV-files under. Per default CSV-files are generated
991 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
992 The special strings B<stdout> and B<stderr> can be used to write to the standard
993 output and standard error channels, respectively. This, of course, only makes
994 much sense when collectd is running in foreground- or non-daemon-mode.
996 =item B<StoreRates> B<true|false>
998 If set to B<true>, convert counter values to rates. If set to B<false> (the
999 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1004 =head2 Plugin C<curl>
1006 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1007 and the match infrastructure (the same code used by the tail plugin) to use
1008 regular expressions with the received data.
1010 The following example will read the current value of AMD stock from Google's
1011 finance page and dispatch the value to collectd.
1014 <Page "stock_quotes">
1015 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1019 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1020 DSType "GaugeAverage"
1021 # Note: `stock_value' is not a standard type.
1028 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1029 a web page and one or more "matches" to be performed on the returned data. The
1030 string argument to the B<Page> block is used as plugin instance.
1032 The following options are valid within B<Page> blocks:
1038 URL of the web site to retrieve. Since a regular expression will be used to
1039 extract information from this data, non-binary data is a big plus here ;)
1041 =item B<User> I<Name>
1043 Username to use if authorization is required to read the page.
1045 =item B<Password> I<Password>
1047 Password to use if authorization is required to read the page.
1049 =item B<Digest> B<true>|B<false>
1051 Enable HTTP digest authentication.
1053 =item B<VerifyPeer> B<true>|B<false>
1055 Enable or disable peer SSL certificate verification. See
1056 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1058 =item B<VerifyHost> B<true>|B<false>
1060 Enable or disable peer host name verification. If enabled, the plugin checks if
1061 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1062 matches the host name provided by the B<URL> option. If this identity check
1063 fails, the connection is aborted. Obviously, only works when connecting to a
1064 SSL enabled server. Enabled by default.
1066 =item B<CACert> I<file>
1068 File that holds one or more SSL certificates. If you want to use HTTPS you will
1069 possibly need this option. What CA certificates come bundled with C<libcurl>
1070 and are checked by default depends on the distribution you use.
1072 =item B<Header> I<Header>
1074 A HTTP header to add to the request. Multiple headers are added if this option
1075 is specified more than once.
1077 =item B<Post> I<Body>
1079 Specifies that the HTTP operation should be a POST instead of a GET. The
1080 complete data to be posted is given as the argument. This option will usually
1081 need to be accompanied by a B<Header> option to set an appropriate
1082 C<Content-Type> for the post body (e.g. to
1083 C<application/x-www-form-urlencoded>).
1085 =item B<MeasureResponseTime> B<true>|B<false>
1087 Measure response time for the request. If this setting is enabled, B<Match>
1088 blocks (see below) are optional. Disabled by default.
1090 =item B<E<lt>MatchE<gt>>
1092 One or more B<Match> blocks that define how to match information in the data
1093 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1094 used by the C<tail> plugin, so please see the documentation of the C<tail>
1095 plugin below on how matches are defined. If the B<MeasureResponseTime> option
1096 is set to B<true>, B<Match> blocks are optional.
1100 =head2 Plugin C<curl_json>
1102 The B<curl_json plugin> collects values from JSON data to be parsed by
1103 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) retrieved via
1104 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1105 unix socket. The former can be used, for example, to collect values
1106 from CouchDB documents (which are stored JSON notation), and the
1107 latter to collect values from a uWSGI stats socket.
1109 The following example will collect several values from the built-in
1110 C<_stats> runtime statistics module of I<CouchDB>
1111 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1114 <URL "http://localhost:5984/_stats">
1116 <Key "httpd/requests/count">
1117 Type "http_requests"
1120 <Key "httpd_request_methods/*/count">
1121 Type "http_request_methods"
1124 <Key "httpd_status_codes/*/count">
1125 Type "http_response_codes"
1130 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1133 <Sock "/var/run/uwsgi.stats.sock">
1135 <Key "workers/*/requests">
1136 Type "http_requests"
1139 <Key "workers/*/apps/*/requests">
1140 Type "http_requests"
1145 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1146 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1147 blocks defining a unix socket to read JSON from directly. Each of
1148 these blocks may have one or more B<Key> blocks.
1150 The B<Key> string argument must be in a path format. Each component is
1151 used to match the key from a JSON map or the index of an JSON
1152 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1153 values for all map keys or array indices will be collectd.
1155 The following options are valid within B<URL> blocks:
1159 =item B<Instance> I<Instance>
1161 Sets the plugin instance to I<Instance>.
1163 =item B<User> I<Name>
1165 =item B<Password> I<Password>
1167 =item B<Digest> B<true>|B<false>
1169 =item B<VerifyPeer> B<true>|B<false>
1171 =item B<VerifyHost> B<true>|B<false>
1173 =item B<CACert> I<file>
1175 =item B<Header> I<Header>
1177 =item B<Post> I<Body>
1179 These options behave exactly equivalent to the appropriate options of the
1180 I<cURL> plugin. Please see there for a detailed description.
1184 The following options are valid within B<Key> blocks:
1188 =item B<Type> I<Type>
1190 Sets the type used to dispatch the values to the daemon. Detailed information
1191 about types and their configuration can be found in L<types.db(5)>. This
1192 option is mandatory.
1194 =item B<Instance> I<Instance>
1196 Type-instance to use. Defaults to the current map key or current string array element value.
1200 =head2 Plugin C<curl_xml>
1202 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1203 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1206 <URL "http://localhost/stats.xml">
1208 Instance "some_instance"
1213 CACert "/path/to/ca.crt"
1215 <XPath "table[@id=\"magic_level\"]/tr">
1217 #InstancePrefix "prefix-"
1218 InstanceFrom "td[1]"
1219 ValuesFrom "td[2]/span[@class=\"level\"]"
1224 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1225 URL to be fetched using libcurl. Within each B<URL> block there are
1226 options which specify the connection parameters, for example authentication
1227 information, and one or more B<XPath> blocks.
1229 Each B<XPath> block specifies how to get one type of information. The
1230 string argument must be a valid XPath expression which returns a list
1231 of "base elements". One value is dispatched for each "base element". The
1232 I<type instance> and values are looked up using further I<XPath> expressions
1233 that should be relative to the base element.
1235 Within the B<URL> block the following options are accepted:
1239 =item B<Host> I<Name>
1241 Use I<Name> as the host name when submitting values. Defaults to the global
1244 =item B<Instance> I<Instance>
1246 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1247 empty string (no plugin instance).
1249 =item B<Namespace> I<Prefix> I<URL>
1251 If an XPath expression references namespaces, they must be specified
1252 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1253 I<URL> is the "namespace name", an URI reference uniquely identifying the
1254 namespace. The option can be repeated to register multiple namespaces.
1258 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1259 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1261 =item B<User> I<User>
1263 =item B<Password> I<Password>
1265 =item B<Digest> B<true>|B<false>
1267 =item B<VerifyPeer> B<true>|B<false>
1269 =item B<VerifyHost> B<true>|B<false>
1271 =item B<CACert> I<CA Cert File>
1273 =item B<Header> I<Header>
1275 =item B<Post> I<Body>
1277 These options behave exactly equivalent to the appropriate options of the
1278 I<cURL plugin>. Please see there for a detailed description.
1280 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1282 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1283 B<XPath> block specifies how to get one type of information. The string
1284 argument must be a valid XPath expression which returns a list of "base
1285 elements". One value is dispatched for each "base element".
1287 Within the B<XPath> block the following options are accepted:
1291 =item B<Type> I<Type>
1293 Specifies the I<Type> used for submitting patches. This determines the number
1294 of values that are required / expected and whether the strings are parsed as
1295 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1296 This option is required.
1298 =item B<InstancePrefix> I<InstancePrefix>
1300 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1301 concatenated together without any separator.
1302 This option is optional.
1304 =item B<InstanceFrom> I<InstanceFrom>
1306 Specifies a XPath expression to use for determining the I<type instance>. The
1307 XPath expression must return exactly one element. The element's value is then
1308 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1310 This value is required. As a special exception, if the "base XPath expression"
1311 (the argument to the B<XPath> block) returns exactly one argument, then this
1312 option may be omitted.
1314 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1316 Specifies one or more XPath expression to use for reading the values. The
1317 number of XPath expressions must match the number of data sources in the
1318 I<type> specified with B<Type> (see above). Each XPath expression must return
1319 exactly one element. The element's value is then parsed as a number and used as
1320 value for the appropriate value in the value list dispatched to the daemon.
1326 =head2 Plugin C<dbi>
1328 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1329 connect to various databases, execute I<SQL> statements and read back the
1330 results. I<dbi> is an acronym for "database interface" in case you were
1331 wondering about the name. You can configure how each column is to be
1332 interpreted and the plugin will generate one or more data sets from each row
1333 returned according to these rules.
1335 Because the plugin is very generic, the configuration is a little more complex
1336 than those of other plugins. It usually looks something like this:
1339 <Query "out_of_stock">
1340 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1341 # Use with MySQL 5.0.0 or later
1345 InstancePrefix "out_of_stock"
1346 InstancesFrom "category"
1350 <Database "product_information">
1352 DriverOption "host" "localhost"
1353 DriverOption "username" "collectd"
1354 DriverOption "password" "aZo6daiw"
1355 DriverOption "dbname" "prod_info"
1356 SelectDB "prod_info"
1357 Query "out_of_stock"
1361 The configuration above defines one query with one result and one database. The
1362 query is then linked to the database with the B<Query> option I<within> the
1363 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1364 and you can also use the B<Include> statement to split up the configuration
1365 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1366 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1369 The following is a complete list of options:
1371 =head3 B<Query> blocks
1373 Query blocks define I<SQL> statements and how the returned data should be
1374 interpreted. They are identified by the name that is given in the opening line
1375 of the block. Thus the name needs to be unique. Other than that, the name is
1376 not used in collectd.
1378 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1379 define which column holds which value or instance information. You can use
1380 multiple B<Result> blocks to create multiple values from one returned row. This
1381 is especially useful, when queries take a long time and sending almost the same
1382 query again and again is not desirable.
1386 <Query "environment">
1387 Statement "select station, temperature, humidity from environment"
1390 # InstancePrefix "foo"
1391 InstancesFrom "station"
1392 ValuesFrom "temperature"
1396 InstancesFrom "station"
1397 ValuesFrom "humidity"
1401 The following options are accepted:
1405 =item B<Statement> I<SQL>
1407 Sets the statement that should be executed on the server. This is B<not>
1408 interpreted by collectd, but simply passed to the database server. Therefore,
1409 the SQL dialect that's used depends on the server collectd is connected to.
1411 The query has to return at least two columns, one for the instance and one
1412 value. You cannot omit the instance, even if the statement is guaranteed to
1413 always return exactly one line. In that case, you can usually specify something
1416 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1418 (That works with MySQL but may not be valid SQL according to the spec. If you
1419 use a more strict database server, you may have to select from a dummy table or
1422 Please note that some databases, for example B<Oracle>, will fail if you
1423 include a semicolon at the end of the statement.
1425 =item B<MinVersion> I<Version>
1427 =item B<MaxVersion> I<Value>
1429 Only use this query for the specified database version. You can use these
1430 options to provide multiple queries with the same name but with a slightly
1431 different syntax. The plugin will use only those queries, where the specified
1432 minimum and maximum versions fit the version of the database in use.
1434 The database version is determined by C<dbi_conn_get_engine_version>, see the
1435 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1436 for details. Basically, each part of the version is assumed to be in the range
1437 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1438 "40102", version "5.0.42" becomes "50042".
1440 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1441 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1442 happen. Don't to it! A valid example would be something along these lines:
1453 In the above example, there are three ranges that don't overlap. The last one
1454 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1455 before "4.0.0" are not specified.
1457 =item B<Type> I<Type>
1459 The B<type> that's used for each line returned. See L<types.db(5)> for more
1460 details on how types are defined. In short: A type is a predefined layout of
1461 data and the number of values and type of values has to match the type
1464 If you specify "temperature" here, you need exactly one gauge column. If you
1465 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1468 There must be exactly one B<Type> option inside each B<Result> block.
1470 =item B<InstancePrefix> I<prefix>
1472 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1473 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1474 all strings returned in the appropriate columns are concatenated together,
1475 separated by dashes I<("-")>.
1477 =item B<InstancesFrom> I<column0> [I<column1> ...]
1479 Specifies the columns whose values will be used to create the "type-instance"
1480 for each row. If you specify more than one column, the value of all columns
1481 will be joined together with dashes I<("-")> as separation characters.
1483 The plugin itself does not check whether or not all built instances are
1484 different. It's your responsibility to assure that each is unique. This is
1485 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1486 sure that only one row is returned in this case.
1488 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1491 =item B<ValuesFrom> I<column0> [I<column1> ...]
1493 Names the columns whose content is used as the actual data for the data sets
1494 that are dispatched to the daemon. How many such columns you need is determined
1495 by the B<Type> setting above. If you specify too many or not enough columns,
1496 the plugin will complain about that and no data will be submitted to the
1499 The actual data type in the columns is not that important. The plugin will
1500 automatically cast the values to the right type if it know how to do that. So
1501 it should be able to handle integer an floating point types, as well as strings
1502 (if they include a number at the beginning).
1504 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1508 =head3 B<Database> blocks
1510 Database blocks define a connection to a database and which queries should be
1511 sent to that database. Since the used "dbi" library can handle a wide variety
1512 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1513 documentationE<nbsp>- we stick as close to the terminology used there.
1515 Each database needs a "name" as string argument in the starting tag of the
1516 block. This name will be used as "PluginInstance" in the values submitted to
1517 the daemon. Other than that, that name is not used.
1521 =item B<Driver> I<Driver>
1523 Specifies the driver to use to connect to the database. In many cases those
1524 drivers are named after the database they can connect to, but this is not a
1525 technical necessity. These drivers are sometimes referred to as "DBD",
1526 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1527 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1528 project at L<http://libdbi-drivers.sourceforge.net/>.
1530 You need to give the driver name as expected by the "dbi" library here. You
1531 should be able to find that in the documentation for each driver. If you
1532 mistype the driver name, the plugin will dump a list of all known driver names
1535 =item B<DriverOption> I<Key> I<Value>
1537 Sets driver-specific options. What option a driver supports can be found in the
1538 documentation for each driver, somewhere at
1539 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1540 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1542 DBDs can register two types of options: String options and numeric options. The
1543 plugin will use the C<dbi_conn_set_option> function when the configuration
1544 provides a string and the C<dbi_conn_require_option_numeric> function when the
1545 configuration provides a number. So these two lines will actually result in
1546 different calls being used:
1548 DriverOption "Port" 1234 # numeric
1549 DriverOption "Port" "1234" # string
1551 Unfortunately, drivers are not too keen to report errors when an unknown option
1552 is passed to them, so invalid settings here may go unnoticed. This is not the
1553 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1554 the driver. If a driver complains about an option, the plugin will dump a
1555 complete list of all options understood by that driver to the log. There is no
1556 way to programatically find out if an option expects a string or a numeric
1557 argument, so you will have to refer to the appropriate DBD's documentation to
1558 find this out. Sorry.
1560 =item B<SelectDB> I<Database>
1562 In some cases, the database name you connect with is not the database name you
1563 want to use for querying data. If this option is set, the plugin will "select"
1564 (switch to) that database after the connection is established.
1566 =item B<Query> I<QueryName>
1568 Associates the query named I<QueryName> with this database connection. The
1569 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1570 blocks you want to refer to must be placed above the database block you want to
1573 =item B<Host> I<Hostname>
1575 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
1576 values. Defaults to the global hostname setting.
1584 =item B<Device> I<Device>
1586 Select partitions based on the devicename.
1588 =item B<MountPoint> I<Directory>
1590 Select partitions based on the mountpoint.
1592 =item B<FSType> I<FSType>
1594 Select partitions based on the filesystem type.
1596 =item B<IgnoreSelected> B<true>|B<false>
1598 Invert the selection: If set to true, all partitions B<except> the ones that
1599 match any one of the criteria are collected. By default only selected
1600 partitions are collected if a selection is made. If no selection is configured
1601 at all, B<all> partitions are selected.
1603 =item B<ReportByDevice> B<true>|B<false>
1605 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1606 (the default), it will report a disk as "root", but with it I<true>, it will be
1607 "sda1" (or whichever).
1609 =item B<ReportInodes> B<true>|B<false>
1611 Enables or disables reporting of free, reserved and used inodes. Defaults to
1612 inode collection being disabled.
1614 Enable this option if inodes are a scarce resource for you, usually because
1615 many small files are stored on the disk. This is a usual scenario for mail
1616 transfer agents and web caches.
1618 =item B<ValuesAbsolute> B<true>|B<false>
1620 Enables or disables reporting of free and used disk space in 1K-blocks.
1621 Defaults to B<true>.
1623 =item B<ValuesPercentage> B<false>|B<true>
1625 Enables or disables reporting of free and used disk space in percentage.
1626 Defaults to B<false>.
1628 This is useful for deploying I<collectd> on the cloud, where machines with
1629 different disk size may exist. Then it is more practical to configure
1630 thresholds based on relative disk size.
1634 =head2 Plugin C<disk>
1636 The C<disk> plugin collects information about the usage of physical disks and
1637 logical disks (partitions). Values collected are the number of octets written
1638 to and read from a disk or partition, the number of read/write operations
1639 issued to the disk and a rather complex "time" it took for these commands to be
1642 Using the following two options you can ignore some disks or configure the
1643 collection only of specific disks.
1647 =item B<Disk> I<Name>
1649 Select the disk I<Name>. Whether it is collected or ignored depends on the
1650 B<IgnoreSelected> setting, see below. As with other plugins that use the
1651 daemon's ignorelist functionality, a string that starts and ends with a slash
1652 is interpreted as a regular expression. Examples:
1657 =item B<IgnoreSelected> B<true>|B<false>
1659 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1660 statements, are ignored or if all other disks are ignored. The behavior
1661 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1662 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1663 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1664 is set to B<true>, all disks are collected B<except> the ones matched.
1668 =head2 Plugin C<dns>
1672 =item B<Interface> I<Interface>
1674 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1675 option sets the interface that should be used. If this option is not set, or
1676 set to "any", the plugin will try to get packets from B<all> interfaces. This
1677 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1679 =item B<IgnoreSource> I<IP-address>
1681 Ignore packets that originate from this address.
1683 =item B<SelectNumericQueryTypes> B<true>|B<false>
1685 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1689 =head2 Plugin C<email>
1693 =item B<SocketFile> I<Path>
1695 Sets the socket-file which is to be created.
1697 =item B<SocketGroup> I<Group>
1699 If running as root change the group of the UNIX-socket after it has been
1700 created. Defaults to B<collectd>.
1702 =item B<SocketPerms> I<Permissions>
1704 Change the file permissions of the UNIX-socket after it has been created. The
1705 permissions must be given as a numeric, octal value as you would pass to
1706 L<chmod(1)>. Defaults to B<0770>.
1708 =item B<MaxConns> I<Number>
1710 Sets the maximum number of connections that can be handled in parallel. Since
1711 this many threads will be started immediately setting this to a very high
1712 value will waste valuable resources. Defaults to B<5> and will be forced to be
1713 at most B<16384> to prevent typos and dumb mistakes.
1717 =head2 Plugin C<ethstat>
1719 The I<ethstat plugin> collects information about network interface cards (NICs)
1720 by talking directly with the underlying kernel driver using L<ioctl(2)>.
1726 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
1727 Map "multicast" "if_multicast"
1734 =item B<Interface> I<Name>
1736 Collect statistical information about interface I<Name>.
1738 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
1740 By default, the plugin will submit values as type C<derive> and I<type
1741 instance> set to I<Name>, the name of the metric as reported by the driver. If
1742 an appropriate B<Map> option exists, the given I<Type> and, optionally,
1743 I<TypeInstance> will be used.
1745 =item B<MappedOnly> B<true>|B<false>
1747 When set to B<true>, only metrics that can be mapped to to a I<type> will be
1748 collected, all other metrics will be ignored. Defaults to B<false>.
1752 =head2 Plugin C<exec>
1754 Please make sure to read L<collectd-exec(5)> before using this plugin. It
1755 contains valuable information on when the executable is executed and the
1756 output that is expected from it.
1760 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1762 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1764 Execute the executable I<Executable> as user I<User>. If the user name is
1765 followed by a colon and a group name, the effective group is set to that group.
1766 The real group and saved-set group will be set to the default group of that
1767 user. If no group is given the effective group ID will be the same as the real
1770 Please note that in order to change the user and/or group the daemon needs
1771 superuser privileges. If the daemon is run as an unprivileged user you must
1772 specify the same user/group here. If the daemon is run with superuser
1773 privileges, you must supply a non-root user here.
1775 The executable may be followed by optional arguments that are passed to the
1776 program. Please note that due to the configuration parsing numbers and boolean
1777 values may be changed. If you want to be absolutely sure that something is
1778 passed as-is please enclose it in quotes.
1780 The B<Exec> and B<NotificationExec> statements change the semantics of the
1781 programs executed, i.E<nbsp>e. the data passed to them and the response
1782 expected from them. This is documented in great detail in L<collectd-exec(5)>.
1786 =head2 Plugin C<filecount>
1788 The C<filecount> plugin counts the number of files in a certain directory (and
1789 its subdirectories) and their combined size. The configuration is very straight
1792 <Plugin "filecount">
1793 <Directory "/var/qmail/queue/mess">
1794 Instance "qmail-message"
1796 <Directory "/var/qmail/queue/todo">
1797 Instance "qmail-todo"
1799 <Directory "/var/lib/php5">
1800 Instance "php5-sessions"
1805 The example above counts the number of files in QMail's queue directories and
1806 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
1807 QMail has not yet looked at, the "message" queue holds the messages that were
1808 classified into "local" and "remote".
1810 As you can see, the configuration consists of one or more C<Directory> blocks,
1811 each of which specifies a directory in which to count the files. Within those
1812 blocks, the following options are recognized:
1816 =item B<Instance> I<Instance>
1818 Sets the plugin instance to I<Instance>. That instance name must be unique, but
1819 it's your responsibility, the plugin doesn't check for that. If not given, the
1820 instance is set to the directory name with all slashes replaced by underscores
1821 and all leading underscores removed.
1823 =item B<Name> I<Pattern>
1825 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
1826 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
1827 against the pattern, not the entire path. In case this makes it easier for you:
1828 This option has been named after the B<-name> parameter to L<find(1)>.
1830 =item B<MTime> I<Age>
1832 Count only files of a specific age: If I<Age> is greater than zero, only files
1833 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
1834 a negative number, this is inversed. For example, if B<-60> is specified, only
1835 files that have been modified in the last minute will be counted.
1837 The number can also be followed by a "multiplier" to easily specify a larger
1838 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
1839 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
1840 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
1841 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
1842 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
1845 =item B<Size> I<Size>
1847 Count only files of a specific size. When I<Size> is a positive number, only
1848 files that are at least this big are counted. If I<Size> is a negative number,
1849 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
1850 I<Size> are counted.
1852 As with the B<MTime> option, a "multiplier" may be added. For a detailed
1853 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
1854 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
1855 note that there are 1000 bytes in a kilobyte, not 1024.
1857 =item B<Recursive> I<true>|I<false>
1859 Controls whether or not to recurse into subdirectories. Enabled by default.
1861 =item B<IncludeHidden> I<true>|I<false>
1863 Controls whether or not to include "hidden" files and directories in the count.
1864 "Hidden" files and directories are those, whose name begins with a dot.
1865 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
1869 =head2 Plugin C<GenericJMX>
1871 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
1872 L<collectd-java(5)>.
1874 =head2 Plugin C<gmond>
1876 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
1877 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
1878 are built-in, custom mappings may be added via B<Metric> blocks, see below.
1883 MCReceiveFrom "239.2.11.71" "8649"
1884 <Metric "swap_total">
1886 TypeInstance "total"
1889 <Metric "swap_free">
1896 The following metrics are built-in:
1902 load_one, load_five, load_fifteen
1906 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
1910 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
1922 Available configuration options:
1926 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
1928 Sets sets the multicast group and UDP port to which to subscribe.
1930 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
1932 =item E<lt>B<Metric> I<Name>E<gt>
1934 These blocks add a new metric conversion to the internal table. I<Name>, the
1935 string argument to the B<Metric> block, is the metric name as used by Ganglia.
1939 =item B<Type> I<Type>
1941 Type to map this metric to. Required.
1943 =item B<TypeInstance> I<Instance>
1945 Type-instance to use. Optional.
1947 =item B<DataSource> I<Name>
1949 Data source to map this metric to. If the configured type has exactly one data
1950 source, this is optional. Otherwise the option is required.
1956 =head2 Plugin C<hddtemp>
1958 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
1959 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
1960 default values, see below. C<hddtemp> has to be running to work correctly. If
1961 C<hddtemp> is not running timeouts may appear which may interfere with other
1964 The B<hddtemp> homepage can be found at
1965 L<http://www.guzu.net/linux/hddtemp.php>.
1969 =item B<Host> I<Hostname>
1971 Hostname to connect to. Defaults to B<127.0.0.1>.
1973 =item B<Port> I<Port>
1975 TCP-Port to connect to. Defaults to B<7634>.
1979 =head2 Plugin C<interface>
1983 =item B<Interface> I<Interface>
1985 Select this interface. By default these interfaces will then be collected. For
1986 a more detailed description see B<IgnoreSelected> below.
1988 =item B<IgnoreSelected> I<true>|I<false>
1990 If no configuration if given, the B<traffic>-plugin will collect data from
1991 all interfaces. This may not be practical, especially for loopback- and
1992 similar interfaces. Thus, you can use the B<Interface>-option to pick the
1993 interfaces you're interested in. Sometimes, however, it's easier/preferred
1994 to collect all interfaces I<except> a few ones. This option enables you to
1995 do that: By setting B<IgnoreSelected> to I<true> the effect of
1996 B<Interface> is inverted: All selected interfaces are ignored and all
1997 other interfaces are collected.
2001 =head2 Plugin C<ipmi>
2005 =item B<Sensor> I<Sensor>
2007 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2009 =item B<IgnoreSelected> I<true>|I<false>
2011 If no configuration if given, the B<ipmi> plugin will collect data from all
2012 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2013 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2014 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2015 all other sensors are collected.
2017 =item B<NotifySensorAdd> I<true>|I<false>
2019 If a sensor appears after initialization time of a minute a notification
2022 =item B<NotifySensorRemove> I<true>|I<false>
2024 If a sensor disappears a notification is sent.
2026 =item B<NotifySensorNotPresent> I<true>|I<false>
2028 If you have for example dual power supply and one of them is (un)plugged then
2029 a notification is sent.
2033 =head2 Plugin C<iptables>
2037 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2039 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
2040 will collect the counters of all rules which have a comment-match. The comment
2041 is then used as type-instance.
2043 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2044 the I<n>th rule will be collected. Again, the comment (or the number) will be
2045 used as the type-instance.
2047 If I<Name> is supplied, it will be used as the type-instance instead of the
2048 comment or the number.
2052 =head2 Plugin C<irq>
2058 Select this irq. By default these irqs will then be collected. For a more
2059 detailed description see B<IgnoreSelected> below.
2061 =item B<IgnoreSelected> I<true>|I<false>
2063 If no configuration if given, the B<irq>-plugin will collect data from all
2064 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2065 can use the B<Irq>-option to pick the interrupt you're interested in.
2066 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2067 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2068 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2069 and all other interrupts are collected.
2073 =head2 Plugin C<java>
2075 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2076 This section only discusses the syntax and semantic of the configuration
2077 options. For more in-depth information on the I<Java> plugin, please read
2078 L<collectd-java(5)>.
2083 JVMArg "-verbose:jni"
2084 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2085 LoadPlugin "org.collectd.java.Foobar"
2086 <Plugin "org.collectd.java.Foobar">
2087 # To be parsed by the plugin
2091 Available configuration options:
2095 =item B<JVMArg> I<Argument>
2097 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2098 exactly the way the arguments to the I<java> binary on the command line work.
2099 Execute C<javaE<nbsp>--help> for details.
2101 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2102 any other options! When another option is found, the JVM will be started and
2103 later options will have to be ignored!
2105 =item B<LoadPlugin> I<JavaClass>
2107 Instantiates a new I<JavaClass> object. The constructor of this object very
2108 likely then registers one or more callback methods with the server.
2110 See L<collectd-java(5)> for details.
2112 When the first such option is found, the virtual machine (JVM) is created. This
2113 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2114 B<LoadPlugin> options!
2116 =item B<Plugin> I<Name>
2118 The entire block is passed to the Java plugin as an
2119 I<org.collectd.api.OConfigItem> object.
2121 For this to work, the plugin has to register a configuration callback first,
2122 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2123 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2124 depends on the (Java) plugin registering the callback and is completely
2125 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2129 =head2 Plugin C<libvirt>
2131 This plugin allows CPU, disk and network load to be collected for virtualized
2132 guests on the machine. This means that these characteristics can be collected
2133 for guest systems without installing any software on them - collectd only runs
2134 on the hosting system. The statistics are collected through libvirt
2135 (L<http://libvirt.org/>).
2137 Only I<Connection> is required.
2141 =item B<Connection> I<uri>
2143 Connect to the hypervisor given by I<uri>. For example if using Xen use:
2145 Connection "xen:///"
2147 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
2149 =item B<RefreshInterval> I<seconds>
2151 Refresh the list of domains and devices every I<seconds>. The default is 60
2152 seconds. Setting this to be the same or smaller than the I<Interval> will cause
2153 the list of domains and devices to be refreshed on every iteration.
2155 Refreshing the devices in particular is quite a costly operation, so if your
2156 virtualization setup is static you might consider increasing this. If this
2157 option is set to 0, refreshing is disabled completely.
2159 =item B<Domain> I<name>
2161 =item B<BlockDevice> I<name:dev>
2163 =item B<InterfaceDevice> I<name:dev>
2165 =item B<IgnoreSelected> I<true>|I<false>
2167 Select which domains and devices are collected.
2169 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
2170 disk/network devices are collected.
2172 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
2173 domains and disk/network devices are ignored, while the rest are collected.
2175 The domain name and device names may use a regular expression, if the name is
2176 surrounded by I</.../> and collectd was compiled with support for regexps.
2178 The default is to collect statistics for all domains and all their devices.
2182 BlockDevice "/:hdb/"
2183 IgnoreSelected "true"
2185 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
2188 =item B<HostnameFormat> B<name|uuid|hostname|...>
2190 When the libvirt plugin logs data, it sets the hostname of the collected data
2191 according to this setting. The default is to use the guest name as provided by
2192 the hypervisor, which is equal to setting B<name>.
2194 B<uuid> means use the guest's UUID. This is useful if you want to track the
2195 same guest across migrations.
2197 B<hostname> means to use the global B<Hostname> setting, which is probably not
2198 useful on its own because all guests will appear to have the same name.
2200 You can also specify combinations of these fields. For example B<name uuid>
2201 means to concatenate the guest name and UUID (with a literal colon character
2202 between, thus I<"foo:1234-1234-1234-1234">).
2204 =item B<InterfaceFormat> B<name>|B<address>
2206 When the libvirt plugin logs interface data, it sets the name of the collected
2207 data according to this setting. The default is to use the path as provided by
2208 the hypervisor (the "dev" property of the target node), which is equal to
2211 B<address> means use the interface's mac address. This is useful since the
2212 interface path might change between reboots of a guest or across migrations.
2216 +=head2 Plugin C<load>
2218 The I<Load plugin> collects the system load. These numbers give a rough overview
2219 over the utilization of a machine. The system load is defined as the number of
2220 runnable tasks in the run-queue and is provided by many operating systems as a
2221 one, five or fifteen minute average.
2223 The following configuration options are available:
2227 =item B<ReportRelative> B<false>|B<true>
2229 When enabled, system load divided by number of available CPU cores is reported
2230 for intervals 1 min, 5 min and 15 min. Defaults to false.
2235 =head2 Plugin C<logfile>
2239 =item B<LogLevel> B<debug|info|notice|warning|err>
2241 Sets the log-level. If, for example, set to B<notice>, then all events with
2242 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2244 Please note that B<debug> is only available if collectd has been compiled with
2247 =item B<File> I<File>
2249 Sets the file to write log messages to. The special strings B<stdout> and
2250 B<stderr> can be used to write to the standard output and standard error
2251 channels, respectively. This, of course, only makes much sense when I<collectd>
2252 is running in foreground- or non-daemon-mode.
2254 =item B<Timestamp> B<true>|B<false>
2256 Prefix all lines printed by the current time. Defaults to B<true>.
2258 =item B<PrintSeverity> B<true>|B<false>
2260 When enabled, all lines are prefixed by the severity of the log message, for
2261 example "warning". Defaults to B<false>.
2265 B<Note>: There is no need to notify the daemon after moving or removing the
2266 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2267 for each line it writes.
2269 =head2 Plugin C<lpar>
2271 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2272 virtualization technique for IBM POWER processors. It takes into account CPU
2273 time stolen from or donated to a partition, in addition to the usual user,
2274 system, I/O statistics.
2276 The following configuration options are available:
2280 =item B<CpuPoolStats> B<false>|B<true>
2282 When enabled, statistics about the processor pool are read, too. The partition
2283 needs to have pool authority in order to be able to acquire this information.
2286 =item B<ReportBySerial> B<false>|B<true>
2288 If enabled, the serial of the physical machine the partition is currently
2289 running on is reported as I<hostname> and the logical hostname of the machine
2290 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2291 used (just like other plugins) and the I<plugin instance> will be empty.
2296 =head2 Plugin C<mbmon>
2298 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2300 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2301 B<Host> and B<Port> options can be used to change these values, see below.
2302 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2303 timeouts may appear which may interfere with other statistics..
2305 C<mbmon> must be run with the -r option ("print TAG and Value format");
2306 Debian's F</etc/init.d/mbmon> script already does this, other people
2307 will need to ensure that this is the case.
2311 =item B<Host> I<Hostname>
2313 Hostname to connect to. Defaults to B<127.0.0.1>.
2315 =item B<Port> I<Port>
2317 TCP-Port to connect to. Defaults to B<411>.
2323 The C<md plugin> collects information from Linux Software-RAID devices (md).
2325 All reported values are of the type C<md_disks>. Reported type instances are
2326 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2327 I<missing> (physically absent) disks.
2331 =item B<Device> I<Device>
2333 Select md devices based on device name. The I<device name> is the basename of
2334 the device, i.e. the name of the block device without the leading C</dev/>.
2335 See B<IgnoreSelected> for more details.
2337 =item B<IgnoreSelected> B<true>|B<false>
2339 Invert device selection: If set to B<true>, all md devices B<except> those
2340 listed using B<Device> are collected. If B<false> (the default), only those
2341 listed are collected. If no configuration is given, the B<md> plugin will
2342 collect data from all md devices.
2346 =head2 Plugin C<memcachec>
2348 The C<memcachec plugin> connects to a memcached server, queries one or more
2349 given I<pages> and parses the returned data according to user specification.
2350 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2353 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2354 library. Please note that there is another library with a very similar name,
2355 libmemcache (notice the missing `d'), which is not applicable.
2357 Synopsis of the configuration:
2359 <Plugin "memcachec">
2360 <Page "plugin_instance">
2364 Regex "(\\d+) bytes sent"
2367 Instance "type_instance"
2372 The configuration options are:
2376 =item E<lt>B<Page> I<Name>E<gt>
2378 Each B<Page> block defines one I<page> to be queried from the memcached server.
2379 The block requires one string argument which is used as I<plugin instance>.
2381 =item B<Server> I<Address>
2383 Sets the server address to connect to when querying the page. Must be inside a
2388 When connected to the memcached server, asks for the page I<Key>.
2390 =item E<lt>B<Match>E<gt>
2392 Match blocks define which strings to look for and how matches substrings are
2393 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2397 =head2 Plugin C<memcached>
2399 The B<memcached plugin> connects to a memcached server and queries statistics
2400 about cache utilization, memory and bandwidth used.
2401 L<http://www.danga.com/memcached/>
2403 <Plugin "memcached">
2405 Host "memcache.example.com"
2410 The plugin configuration consists of one or more B<Instance> blocks which
2411 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2412 following options are allowed:
2416 =item B<Host> I<Hostname>
2418 Hostname to connect to. Defaults to B<127.0.0.1>.
2420 =item B<Port> I<Port>
2422 TCP-Port to connect to. Defaults to B<11211>.
2424 =item B<Socket> I<Path>
2426 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2427 setting is given, the B<Host> and B<Port> settings are ignored.
2431 =head2 Plugin C<mic>
2433 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2434 Intel's Many Integrated Core (MIC) systems.
2443 ShowTemperatures true
2446 IgnoreSelectedTemperature true
2451 IgnoreSelectedPower true
2454 The following options are valid inside the B<PluginE<nbsp>mic> block:
2458 =item B<ShowCPU> B<true>|B<false>
2460 If enabled (the default) a sum of the CPU usage accross all cores is reported.
2462 =item B<ShowCPUCores> B<true>|B<false>
2464 If enabled (the default) per-core CPU usage is reported.
2466 =item B<ShowMemory> B<true>|B<false>
2468 If enabled (the default) the physical memory usage of the MIC system is
2471 =item B<ShowTemperatures> B<true>|B<false>
2473 If enabled (the default) various temperatures of the MIC system are reported.
2475 =item B<Temperature> I<Name>
2477 This option controls which temperatures are being reported. Whether matching
2478 temperatures are being ignored or I<only> matching temperatures are reported
2479 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2480 temperatures are reported.
2482 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2484 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2485 (the default) only temperatures matching a B<Temperature> option are reported
2486 or, if no B<Temperature> option is specified, all temperatures are reported. If
2487 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2490 Known temperature names are:
2524 =item B<ShowPower> B<true>|B<false>
2526 If enabled (the default) various temperatures of the MIC system are reported.
2528 =item B<Power> I<Name>
2530 This option controls which power readings are being reported. Whether matching
2531 power readings are being ignored or I<only> matching power readings are reported
2532 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
2533 power readings are reported.
2535 =item B<IgnoreSelectedPower> B<false>|B<true>
2537 Controls the behavior of the B<Power> setting above. If set to B<false>
2538 (the default) only power readings matching a B<Power> option are reported
2539 or, if no B<Power> option is specified, all power readings are reported. If
2540 set to B<true>, matching power readings are I<ignored> and all other power readings
2543 Known power names are:
2549 Total power utilization averaged over Time Window 0 (uWatts).
2553 Total power utilization averaged over Time Window 0 (uWatts).
2557 Instantaneous power (uWatts).
2561 Max instantaneous power (uWatts).
2565 PCI-E connector power (uWatts).
2569 2x3 connector power (uWatts).
2573 2x4 connector power (uWatts).
2581 Uncore rail (uVolts).
2585 Memory subsystem rail (uVolts).
2591 =head2 Plugin C<memory>
2593 The I<memory plugin> provides the following configuration options:
2597 =item B<ValuesAbsolute> B<true>|B<false>
2599 Enables or disables reporting of physical memory usage in absolute numbers,
2600 i.e. bytes. Defaults to B<true>.
2602 =item B<ValuesPercentage> B<false>|B<true>
2604 Enables or disables reporting of physical memory usage in percentages, e.g.
2605 percent of physical memory used. Defaults to B<false>.
2607 This is useful for deploying I<collectd> in a heterogeneous environment in
2608 which the sizes of physical memory vary.
2612 =head2 Plugin C<modbus>
2614 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
2615 register values. It supports reading single registers (unsigned 16E<nbsp>bit
2616 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2617 values (two registers interpreted as IEEE floats in big endian notation).
2621 <Data "voltage-input-1">
2628 <Data "voltage-input-2">
2635 <Host "modbus.example.com">
2636 Address "192.168.0.42"
2641 Instance "power-supply"
2642 Collect "voltage-input-1"
2643 Collect "voltage-input-2"
2649 =item E<lt>B<Data> I<Name>E<gt> blocks
2651 Data blocks define a mapping between register numbers and the "types" used by
2654 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
2658 =item B<RegisterBase> I<Number>
2660 Configures the base register to read from the device. If the option
2661 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
2662 register will be read (the register number is increased by one).
2664 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
2666 Specifies what kind of data is returned by the device. If the type is B<Int32>,
2667 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
2668 combined into one value. Defaults to B<Uint16>.
2670 =item B<Type> I<Type>
2672 Specifies the "type" (data set) to use when dispatching the value to
2673 I<collectd>. Currently, only data sets with exactly one data source are
2676 =item B<Instance> I<Instance>
2678 Sets the type instance to use when dispatching the value to I<collectd>. If
2679 unset, an empty string (no type instance) is used.
2683 =item E<lt>B<Host> I<Name>E<gt> blocks
2685 Host blocks are used to specify to which hosts to connect and what data to read
2686 from their "slaves". The string argument I<Name> is used as hostname when
2687 dispatching the values to I<collectd>.
2689 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
2693 =item B<Address> I<Hostname>
2695 Specifies the node name (the actual network address) used to connect to the
2696 host. This may be an IP address or a hostname. Please note that the used
2697 I<libmodbus> library only supports IPv4 at the moment.
2699 =item B<Port> I<Service>
2701 Specifies the port used to connect to the host. The port can either be given as
2702 a number or as a service name. Please note that the I<Service> argument must be
2703 a string, even if ports are given in their numerical form. Defaults to "502".
2705 =item B<Interval> I<Interval>
2707 Sets the interval (in seconds) in which the values will be collected from this
2708 host. By default the global B<Interval> setting will be used.
2710 =item E<lt>B<Slave> I<ID>E<gt>
2712 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
2713 is used to specify which device should be addressed. For each device you want
2714 to query, one B<Slave> block must be given.
2716 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
2720 =item B<Instance> I<Instance>
2722 Specify the plugin instance to use when dispatching the values to I<collectd>.
2723 By default "slave_I<ID>" is used.
2725 =item B<Collect> I<DataName>
2727 Specifies which data to retrieve from the device. I<DataName> must be the same
2728 string as the I<Name> argument passed to a B<Data> block. You can specify this
2729 option multiple times to collect more than one value from a slave. At least one
2730 B<Collect> option is mandatory.
2738 =head2 Plugin C<mysql>
2740 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
2741 one or more databases when started and keeps the connection up as long as
2742 possible. When the connection is interrupted for whatever reason it will try
2743 to re-connect. The plugin will complain loudly in case anything goes wrong.
2745 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
2746 and collects information about MySQL network traffic, executed statements,
2747 requests, the query cache and threads by evaluating the
2748 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
2749 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
2750 Status Variables> for an explanation of these values.
2752 Optionally, master and slave statistics may be collected in a MySQL
2753 replication setup. In that case, information about the synchronization state
2754 of the nodes are collected by evaluating the C<Position> return value of the
2755 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
2756 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
2757 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
2758 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
2759 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
2774 Socket "/var/run/mysql/mysqld.sock"
2776 SlaveNotifications true
2780 A B<Database> block defines one connection to a MySQL database. It accepts a
2781 single argument which specifies the name of the database. None of the other
2782 options are required. MySQL will use default values as documented in the
2783 section "mysql_real_connect()" in the B<MySQL reference manual>.
2787 =item B<Host> I<Hostname>
2789 Hostname of the database server. Defaults to B<localhost>.
2791 =item B<User> I<Username>
2793 Username to use when connecting to the database. The user does not have to be
2794 granted any privileges (which is synonym to granting the C<USAGE> privilege),
2795 unless you want to collectd replication statistics (see B<MasterStats> and
2796 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
2797 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
2799 =item B<Password> I<Password>
2801 Password needed to log into the database.
2803 =item B<Database> I<Database>
2805 Select this database. Defaults to I<no database> which is a perfectly reasonable
2806 option for what this plugin does.
2808 =item B<Port> I<Port>
2810 TCP-port to connect to. The port must be specified in its numeric form, but it
2811 must be passed as a string nonetheless. For example:
2815 If B<Host> is set to B<localhost> (the default), this setting has no effect.
2816 See the documentation for the C<mysql_real_connect> function for details.
2818 =item B<Socket> I<Socket>
2820 Specifies the path to the UNIX domain socket of the MySQL server. This option
2821 only has any effect, if B<Host> is set to B<localhost> (the default).
2822 Otherwise, use the B<Port> option above. See the documentation for the
2823 C<mysql_real_connect> function for details.
2825 =item B<MasterStats> I<true|false>
2827 =item B<SlaveStats> I<true|false>
2829 Enable the collection of master / slave statistics in a replication setup. In
2830 order to be able to get access to these statistics, the user needs special
2831 privileges. See the B<User> documentation above.
2833 =item B<SlaveNotifications> I<true|false>
2835 If enabled, the plugin sends a notification if the replication slave I/O and /
2836 or SQL threads are not running.
2840 =head2 Plugin C<netapp>
2842 The netapp plugin can collect various performance and capacity information
2843 from a NetApp filer using the NetApp API.
2845 Please note that NetApp has a wide line of products and a lot of different
2846 software versions for each of these products. This plugin was developed for a
2847 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
2848 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
2849 model and software version but it is very hard to test this.
2850 If you have used this plugin with other models and/or software version, feel
2851 free to send us a mail to tell us about the results, even if it's just a short
2854 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
2855 basic authentication.
2857 B<Do not use a regular user for this!> Create a special collectd user with just
2858 the minimum of capabilities needed. The user only needs the "login-http-admin"
2859 capability as well as a few more depending on which data will be collected.
2860 Required capabilities are documented below.
2865 <Host "netapp1.example.com">
2889 IgnoreSelectedIO false
2891 IgnoreSelectedOps false
2892 GetLatency "volume0"
2893 IgnoreSelectedLatency false
2900 IgnoreSelectedCapacity false
2903 IgnoreSelectedSnapshot false
2931 The netapp plugin accepts the following configuration options:
2935 =item B<Host> I<Name>
2937 A host block defines one NetApp filer. It will appear in collectd with the name
2938 you specify here which does not have to be its real name nor its hostname (see
2939 the B<Address> option below).
2941 =item B<VFiler> I<Name>
2943 A B<VFiler> block may only be used inside a host block. It accepts all the
2944 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
2945 will execute all NetApp API commands in the context of the specified
2946 VFiler(R). It will appear in collectd with the name you specify here which
2947 does not have to be its real name. The VFiler name may be specified using the
2948 B<VFilerName> option. If this is not specified, it will default to the name
2951 The VFiler block inherits all connection related settings from the surrounding
2952 B<Host> block (which appear before the B<VFiler> block) but they may be
2953 overwritten inside the B<VFiler> block.
2955 This feature is useful, for example, when using a VFiler as SnapVault target
2956 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
2957 available in the host filer (vfiler0) but only in the respective VFiler
2960 =item B<Protocol> B<httpd>|B<http>
2962 The protocol collectd will use to query this host.
2970 Valid options: http, https
2972 =item B<Address> I<Address>
2974 The hostname or IP address of the host.
2980 Default: The "host" block's name.
2982 =item B<Port> I<Port>
2984 The TCP port to connect to on the host.
2990 Default: 80 for protocol "http", 443 for protocol "https"
2992 =item B<User> I<User>
2994 =item B<Password> I<Password>
2996 The username and password to use to login to the NetApp.
3002 =item B<VFilerName> I<Name>
3004 The name of the VFiler in which context to execute API commands. If not
3005 specified, the name provided to the B<VFiler> block will be used instead.
3011 Default: name of the B<VFiler> block
3013 B<Note:> This option may only be used inside B<VFiler> blocks.
3015 =item B<Interval> I<Interval>
3021 The following options decide what kind of data will be collected. You can
3022 either use them as a block and fine tune various parameters inside this block,
3023 use them as a single statement to just accept all default values, or omit it to
3024 not collect any data.
3026 The following options are valid inside all blocks:
3030 =item B<Interval> I<Seconds>
3032 Collect the respective statistics every I<Seconds> seconds. Defaults to the
3033 host specific setting.
3037 =head3 The System block
3039 This will collect various performance data about the whole system.
3041 B<Note:> To get this data the collectd user needs the
3042 "api-perf-object-get-instances" capability.
3046 =item B<Interval> I<Seconds>
3048 Collect disk statistics every I<Seconds> seconds.
3050 =item B<GetCPULoad> B<true>|B<false>
3052 If you set this option to true the current CPU usage will be read. This will be
3053 the average usage between all CPUs in your NetApp without any information about
3056 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3057 returns in the "CPU" field.
3065 Result: Two value lists of type "cpu", and type instances "idle" and "system".
3067 =item B<GetInterfaces> B<true>|B<false>
3069 If you set this option to true the current traffic of the network interfaces
3070 will be read. This will be the total traffic over all interfaces of your NetApp
3071 without any information about individual interfaces.
3073 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3074 in the "Net kB/s" field.
3084 Result: One value list of type "if_octects".
3086 =item B<GetDiskIO> B<true>|B<false>
3088 If you set this option to true the current IO throughput will be read. This
3089 will be the total IO of your NetApp without any information about individual
3090 disks, volumes or aggregates.
3092 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3093 in the "DiskE<nbsp>kB/s" field.
3101 Result: One value list of type "disk_octets".
3103 =item B<GetDiskOps> B<true>|B<false>
3105 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
3106 iSCSI, etc. operations will be read. This will be the total number of
3107 operations on your NetApp without any information about individual volumes or
3110 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3111 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
3119 Result: A variable number of value lists of type "disk_ops_complex". Each type
3120 of operation will result in one value list with the name of the operation as
3125 =head3 The WAFL block
3127 This will collect various performance data about the WAFL file system. At the
3128 moment this just means cache performance.
3130 B<Note:> To get this data the collectd user needs the
3131 "api-perf-object-get-instances" capability.
3133 B<Note:> The interface to get these values is classified as "Diagnostics" by
3134 NetApp. This means that it is not guaranteed to be stable even between minor
3139 =item B<Interval> I<Seconds>
3141 Collect disk statistics every I<Seconds> seconds.
3143 =item B<GetNameCache> B<true>|B<false>
3151 Result: One value list of type "cache_ratio" and type instance
3154 =item B<GetDirCache> B<true>|B<false>
3162 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3164 =item B<GetInodeCache> B<true>|B<false>
3172 Result: One value list of type "cache_ratio" and type instance
3175 =item B<GetBufferCache> B<true>|B<false>
3177 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3178 in the "Cache hit" field.
3186 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3190 =head3 The Disks block
3192 This will collect performance data about the individual disks in the NetApp.
3194 B<Note:> To get this data the collectd user needs the
3195 "api-perf-object-get-instances" capability.
3199 =item B<Interval> I<Seconds>
3201 Collect disk statistics every I<Seconds> seconds.
3203 =item B<GetBusy> B<true>|B<false>
3205 If you set this option to true the busy time of all disks will be calculated
3206 and the value of the busiest disk in the system will be written.
3208 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3209 in the "Disk util" field. Probably.
3217 Result: One value list of type "percent" and type instance "disk_busy".
3221 =head3 The VolumePerf block
3223 This will collect various performance data about the individual volumes.
3225 You can select which data to collect about which volume using the following
3226 options. They follow the standard ignorelist semantic.
3228 B<Note:> To get this data the collectd user needs the
3229 I<api-perf-object-get-instances> capability.
3233 =item B<Interval> I<Seconds>
3235 Collect volume performance data every I<Seconds> seconds.
3237 =item B<GetIO> I<Volume>
3239 =item B<GetOps> I<Volume>
3241 =item B<GetLatency> I<Volume>
3243 Select the given volume for IO, operations or latency statistics collection.
3244 The argument is the name of the volume without the C</vol/> prefix.
3246 Since the standard ignorelist functionality is used here, you can use a string
3247 starting and ending with a slash to specify regular expression matching: To
3248 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3251 GetIO "/^vol[027]$/"
3253 If no regular expression is specified, an exact match is required. Both,
3254 regular and exact matching are case sensitive.
3256 If no volume was specified at all for either of the three options, that data
3257 will be collected for all available volumes.
3259 =item B<IgnoreSelectedIO> B<true>|B<false>
3261 =item B<IgnoreSelectedOps> B<true>|B<false>
3263 =item B<IgnoreSelectedLatency> B<true>|B<false>
3265 When set to B<true>, the volumes selected for IO, operations or latency
3266 statistics collection will be ignored and the data will be collected for all
3269 When set to B<false>, data will only be collected for the specified volumes and
3270 all other volumes will be ignored.
3272 If no volumes have been specified with the above B<Get*> options, all volumes
3273 will be collected regardless of the B<IgnoreSelected*> option.
3275 Defaults to B<false>
3279 =head3 The VolumeUsage block
3281 This will collect capacity data about the individual volumes.
3283 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3288 =item B<Interval> I<Seconds>
3290 Collect volume usage statistics every I<Seconds> seconds.
3292 =item B<GetCapacity> I<VolumeName>
3294 The current capacity of the volume will be collected. This will result in two
3295 to four value lists, depending on the configuration of the volume. All data
3296 sources are of type "df_complex" with the name of the volume as
3299 There will be type_instances "used" and "free" for the number of used and
3300 available bytes on the volume. If the volume has some space reserved for
3301 snapshots, a type_instance "snap_reserved" will be available. If the volume
3302 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3303 number of bytes saved by the SIS feature.
3305 B<Note:> The current NetApp API has a bug that results in this value being
3306 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3307 number which works most of the time. If you see strange values here, bug
3308 NetApp support to fix this.
3310 Repeat this option to specify multiple volumes.
3312 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3314 Specify whether to collect only the volumes selected by the B<GetCapacity>
3315 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3316 B<false>. However, if no B<GetCapacity> option is specified at all, all
3317 capacities will be selected anyway.
3319 =item B<GetSnapshot> I<VolumeName>
3321 Select volumes from which to collect snapshot information.
3323 Usually, the space used for snapshots is included in the space reported as
3324 "used". If snapshot information is collected as well, the space used for
3325 snapshots is subtracted from the used space.
3327 To make things even more interesting, it is possible to reserve space to be
3328 used for snapshots. If the space required for snapshots is less than that
3329 reserved space, there is "reserved free" and "reserved used" space in addition
3330 to "free" and "used". If the space required for snapshots exceeds the reserved
3331 space, that part allocated in the normal space is subtracted from the "used"
3334 Repeat this option to specify multiple volumes.
3336 =item B<IgnoreSelectedSnapshot>
3338 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3339 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3340 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3341 capacities will be selected anyway.
3345 =head3 The Quota block
3347 This will collect (tree) quota statistics (used disk space and number of used
3348 files). This mechanism is useful to get usage information for single qtrees.
3349 In case the quotas are not used for any other purpose, an entry similar to the
3350 following in C</etc/quotas> would be sufficient:
3352 /vol/volA/some_qtree tree - - - - -
3354 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3358 =item B<Interval> I<Seconds>
3360 Collect SnapVault(R) statistics every I<Seconds> seconds.
3364 =head3 The SnapVault block
3366 This will collect statistics about the time and traffic of SnapVault(R)
3371 =item B<Interval> I<Seconds>
3373 Collect SnapVault(R) statistics every I<Seconds> seconds.
3377 =head2 Plugin C<netlink>
3379 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3380 statistics of various interface and routing aspects.
3384 =item B<Interface> I<Interface>
3386 =item B<VerboseInterface> I<Interface>
3388 Instruct the plugin to collect interface statistics. This is basically the same
3389 as the statistics provided by the C<interface> plugin (see above) but
3390 potentially much more detailed.
3392 When configuring with B<Interface> only the basic statistics will be collected,
3393 namely octets, packets, and errors. These statistics are collected by
3394 the C<interface> plugin, too, so using both at the same time is no benefit.
3396 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3397 so that no data needs to be collected twice if you use the C<interface> plugin.
3398 This includes dropped packets, received multicast packets, collisions and a
3399 whole zoo of differentiated RX and TX errors. You can try the following command
3400 to get an idea of what awaits you:
3404 If I<Interface> is B<All>, all interfaces will be selected.
3406 =item B<QDisc> I<Interface> [I<QDisc>]
3408 =item B<Class> I<Interface> [I<Class>]
3410 =item B<Filter> I<Interface> [I<Filter>]
3412 Collect the octets and packets that pass a certain qdisc, class or filter.
3414 QDiscs and classes are identified by their type and handle (or classid).
3415 Filters don't necessarily have a handle, therefore the parent's handle is used.
3416 The notation used in collectd differs from that used in tc(1) in that it
3417 doesn't skip the major or minor number if it's zero and doesn't print special
3418 ids by their name. So, for example, a qdisc may be identified by
3419 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3420 thus not displayed by tc(1).
3422 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3423 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3424 associated with that interface will be collected.
3426 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3427 used. This may lead to problems when more than one filter is attached to a
3428 qdisc or class. This isn't nice, but we don't know how this could be done any
3429 better. If you have a idea, please don't hesitate to tell us.
3431 As with the B<Interface> option you can specify B<All> as the interface,
3432 meaning all interfaces.
3434 Here are some examples to help you understand the above text more easily:
3437 VerboseInterface "All"
3438 QDisc "eth0" "pfifo_fast-1:0"
3440 Class "ppp0" "htb-1:10"
3441 Filter "ppp0" "u32-1:0"
3444 =item B<IgnoreSelected>
3446 The behavior is the same as with all other similar plugins: If nothing is
3447 selected at all, everything is collected. If some things are selected using the
3448 options described above, only these statistics are collected. If you set
3449 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3450 specified statistics will not be collected.
3454 =head2 Plugin C<network>
3456 The Network plugin sends data to a remote instance of collectd, receives data
3457 from a remote instance, or both at the same time. Data which has been received
3458 from the network is usually not transmitted again, but this can be activated, see
3459 the B<Forward> option below.
3461 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3462 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3464 Both, B<Server> and B<Listen> can be used as single option or as block. When
3465 used as block, given options are valid for this socket only. The following
3466 example will export the metrics twice: Once to an "internal" server (without
3467 encryption and signing) and one to an external server (with cryptographic
3471 # Export to an internal server
3472 # (demonstrates usage without additional options)
3473 Server "collectd.internal.tld"
3475 # Export to an external server
3476 # (demonstrates usage with signature options)
3477 <Server "collectd.external.tld">
3478 SecurityLevel "sign"
3479 Username "myhostname"
3486 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3488 The B<Server> statement/block sets the server to send datagrams to. The
3489 statement may occur multiple times to send each datagram to multiple
3492 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3493 optional second argument specifies a port number or a service name. If not
3494 given, the default, B<25826>, is used.
3496 The following options are recognized within B<Server> blocks:
3500 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3502 Set the security you require for network communication. When the security level
3503 has been set to B<Encrypt>, data sent over the network will be encrypted using
3504 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3505 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3506 authentication code. When set to B<None>, data is sent without any security.
3508 This feature is only available if the I<network> plugin was linked with
3511 =item B<Username> I<Username>
3513 Sets the username to transmit. This is used by the server to lookup the
3514 password. See B<AuthFile> below. All security levels except B<None> require
3517 This feature is only available if the I<network> plugin was linked with
3520 =item B<Password> I<Password>
3522 Sets a password (shared secret) for this socket. All security levels except
3523 B<None> require this setting.
3525 This feature is only available if the I<network> plugin was linked with
3528 =item B<Interface> I<Interface name>
3530 Set the outgoing interface for IP packets. This applies at least
3531 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3532 undefined or a non-existent interface name is specified, the default
3533 behavior is to let the kernel choose the appropriate interface. Be warned
3534 that the manual selection of an interface for unicast traffic is only
3535 necessary in rare cases.
3539 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
3541 The B<Listen> statement sets the interfaces to bind to. When multiple
3542 statements are found the daemon will bind to multiple interfaces.
3544 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
3545 the argument is a multicast address the daemon will join that multicast group.
3546 The optional second argument specifies a port number or a service name. If not
3547 given, the default, B<25826>, is used.
3549 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
3553 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3555 Set the security you require for network communication. When the security level
3556 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
3557 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
3558 signed and encrypted data is accepted. When set to B<None>, all data will be
3559 accepted. If an B<AuthFile> option was given (see below), encrypted data is
3560 decrypted if possible.
3562 This feature is only available if the I<network> plugin was linked with
3565 =item B<AuthFile> I<Filename>
3567 Sets a file in which usernames are mapped to passwords. These passwords are
3568 used to verify signatures and to decrypt encrypted network packets. If
3569 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
3570 verified and encrypted packets are decrypted. Otherwise, signed data is
3571 accepted without checking the signature and encrypted data cannot be decrypted.
3572 For the other security levels this option is mandatory.
3574 The file format is very simple: Each line consists of a username followed by a
3575 colon and any number of spaces followed by the password. To demonstrate, an
3576 example file could look like this:
3581 Each time a packet is received, the modification time of the file is checked
3582 using L<stat(2)>. If the file has been changed, the contents is re-read. While
3583 the file is being read, it is locked using L<fcntl(2)>.
3585 =item B<Interface> I<Interface name>
3587 Set the incoming interface for IP packets explicitly. This applies at least
3588 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3589 undefined or a non-existent interface name is specified, the default
3590 behavior is, to let the kernel choose the appropriate interface. Thus incoming
3591 traffic gets only accepted, if it arrives on the given interface.
3595 =item B<TimeToLive> I<1-255>
3597 Set the time-to-live of sent packets. This applies to all, unicast and
3598 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
3599 That means that multicast packets will be sent with a TTL of C<1> (one) on most
3602 =item B<MaxPacketSize> I<1024-65535>
3604 Set the maximum size for datagrams received over the network. Packets larger
3605 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
3606 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
3609 On the server side, this limit should be set to the largest value used on
3610 I<any> client. Likewise, the value on the client must not be larger than the
3611 value on the server, or data will be lost.
3613 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
3614 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
3615 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
3618 =item B<Forward> I<true|false>
3620 If set to I<true>, write packets that were received via the network plugin to
3621 the sending sockets. This should only be activated when the B<Listen>- and
3622 B<Server>-statements differ. Otherwise packets may be send multiple times to
3623 the same multicast group. While this results in more network traffic than
3624 necessary it's not a huge problem since the plugin has a duplicate detection,
3625 so the values will not loop.
3627 =item B<ReportStats> B<true>|B<false>
3629 The network plugin cannot only receive and send statistics, it can also create
3630 statistics about itself. Collected data included the number of received and
3631 sent octets and packets, the length of the receive queue and the number of
3632 values handled. When set to B<true>, the I<Network plugin> will make these
3633 statistics available. Defaults to B<false>.
3637 =head2 Plugin C<nginx>
3639 This plugin collects the number of connections and requests handled by the
3640 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
3641 queries the page provided by the C<ngx_http_stub_status_module> module, which
3642 isn't compiled by default. Please refer to
3643 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
3644 how to compile and configure nginx and this module.
3646 The following options are accepted by the C<nginx plugin>:
3650 =item B<URL> I<http://host/nginx_status>
3652 Sets the URL of the C<ngx_http_stub_status_module> output.
3654 =item B<User> I<Username>
3656 Optional user name needed for authentication.
3658 =item B<Password> I<Password>
3660 Optional password needed for authentication.
3662 =item B<VerifyPeer> B<true|false>
3664 Enable or disable peer SSL certificate verification. See
3665 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
3667 =item B<VerifyHost> B<true|false>
3669 Enable or disable peer host name verification. If enabled, the plugin checks
3670 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
3671 certificate matches the host name provided by the B<URL> option. If this
3672 identity check fails, the connection is aborted. Obviously, only works when
3673 connecting to a SSL enabled server. Enabled by default.
3675 =item B<CACert> I<File>
3677 File that holds one or more SSL certificates. If you want to use HTTPS you will
3678 possibly need this option. What CA certificates come bundled with C<libcurl>
3679 and are checked by default depends on the distribution you use.
3683 =head2 Plugin C<notify_desktop>
3685 This plugin sends a desktop notification to a notification daemon, as defined
3686 in the Desktop Notification Specification. To actually display the
3687 notifications, B<notification-daemon> is required and B<collectd> has to be
3688 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
3689 environment variables have to be set correctly) and the D-Bus message bus.
3691 The Desktop Notification Specification can be found at
3692 L<http://www.galago-project.org/specs/notification/>.
3696 =item B<OkayTimeout> I<timeout>
3698 =item B<WarningTimeout> I<timeout>
3700 =item B<FailureTimeout> I<timeout>
3702 Set the I<timeout>, in milliseconds, after which to expire the notification
3703 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
3704 been specified, the displayed notification will not be closed at all - the
3705 user has to do so herself. These options default to 5000. If a negative number
3706 has been specified, the default is used as well.
3710 =head2 Plugin C<notify_email>
3712 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
3713 configured email address.
3715 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
3717 Available configuration options:
3721 =item B<From> I<Address>
3723 Email address from which the emails should appear to come from.
3725 Default: C<root@localhost>
3727 =item B<Recipient> I<Address>
3729 Configures the email address(es) to which the notifications should be mailed.
3730 May be repeated to send notifications to multiple addresses.
3732 At least one B<Recipient> must be present for the plugin to work correctly.
3734 =item B<SMTPServer> I<Hostname>
3736 Hostname of the SMTP server to connect to.
3738 Default: C<localhost>
3740 =item B<SMTPPort> I<Port>
3742 TCP port to connect to.
3746 =item B<SMTPUser> I<Username>
3748 Username for ASMTP authentication. Optional.
3750 =item B<SMTPPassword> I<Password>
3752 Password for ASMTP authentication. Optional.
3754 =item B<Subject> I<Subject>
3756 Subject-template to use when sending emails. There must be exactly two
3757 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
3758 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
3761 Default: C<Collectd notify: %s@%s>
3765 =head2 Plugin C<ntpd>
3769 =item B<Host> I<Hostname>
3771 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
3773 =item B<Port> I<Port>
3775 UDP-Port to connect to. Defaults to B<123>.
3777 =item B<ReverseLookups> B<true>|B<false>
3779 Sets whether or not to perform reverse lookups on peers. Since the name or
3780 IP-address may be used in a filename it is recommended to disable reverse
3781 lookups. The default is to do reverse lookups to preserve backwards
3782 compatibility, though.
3784 =item B<IncludeUnitID> B<true>|B<false>
3786 When a peer is a refclock, include the unit ID in the I<type instance>.
3787 Defaults to B<false> for backward compatibility.
3789 If two refclock peers use the same driver and this is B<false>, the plugin will
3790 try to write simultaneous measurements from both to the same type instance.
3791 This will result in error messages in the log and only one set of measurements
3796 =head2 Plugin C<nut>
3800 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
3802 Add a UPS to collect data from. The format is identical to the one accepted by
3807 =head2 Plugin C<olsrd>
3809 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
3810 the Optimized Link State Routing daemon and reads information about the current
3811 state of the meshed network.
3813 The following configuration options are understood:
3817 =item B<Host> I<Host>
3819 Connect to I<Host>. Defaults to B<"localhost">.
3821 =item B<Port> I<Port>
3823 Specifies the port to connect to. This must be a string, even if you give the
3824 port as a number rather than a service name. Defaults to B<"2006">.
3826 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
3828 Specifies what information to collect about links, i.E<nbsp>e. direct
3829 connections of the daemon queried. If set to B<No>, no information is
3830 collected. If set to B<Summary>, the number of links and the average of all
3831 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
3832 If set to B<Detail> LQ and NLQ are collected per link.
3834 Defaults to B<Detail>.
3836 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
3838 Specifies what information to collect about routes of the daemon queried. If
3839 set to B<No>, no information is collected. If set to B<Summary>, the number of
3840 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
3841 metric and ETX are collected per route.
3843 Defaults to B<Summary>.
3845 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
3847 Specifies what information to collect about the global topology. If set to
3848 B<No>, no information is collected. If set to B<Summary>, the number of links
3849 in the entire topology and the average I<link quality> (LQ) is calculated.
3850 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
3852 Defaults to B<Summary>.
3856 =head2 Plugin C<onewire>
3858 B<EXPERIMENTAL!> See notes below.
3860 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
3861 L<http://owfs.org/> to read sensors connected via the onewire bus.
3863 Currently only temperature sensors (sensors with the family code C<10>,
3864 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
3865 would like to have included, please send a sort request to the mailing list.
3867 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
3868 experimental, below.
3872 =item B<Device> I<Device>
3874 Sets the device to read the values from. This can either be a "real" hardware
3875 device, such as a serial port or an USB port, or the address of the
3876 L<owserver(1)> socket, usually B<localhost:4304>.
3878 Though the documentation claims to automatically recognize the given address
3879 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
3880 with that version, the following configuration worked for us:
3883 Device "-s localhost:4304"
3886 This directive is B<required> and does not have a default value.
3888 =item B<Sensor> I<Sensor>
3890 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
3891 below. Sensors are specified without the family byte at the beginning, to you'd
3892 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
3895 =item B<IgnoreSelected> I<true>|I<false>
3897 If no configuration if given, the B<onewire> plugin will collect data from all
3898 sensors found. This may not be practical, especially if sensors are added and
3899 removed regularly. Sometimes, however, it's easier/preferred to collect only
3900 specific sensors or all sensors I<except> a few specified ones. This option
3901 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
3902 B<Sensor> is inverted: All selected interfaces are ignored and all other
3903 interfaces are collected.
3905 =item B<Interval> I<Seconds>
3907 Sets the interval in which all sensors should be read. If not specified, the
3908 global B<Interval> setting is used.
3912 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
3913 work with big setups. It works with one sensor being attached to one
3914 controller, but as soon as you throw in a couple more senors and maybe a hub
3915 or two, reading all values will take more than ten seconds (the default
3916 interval). We will probably add some separate thread for reading the sensors
3917 and some cache or something like that, but it's not done yet. We will try to
3918 maintain backwards compatibility in the future, but we can't promise. So in
3919 short: If it works for you: Great! But keep in mind that the config I<might>
3920 change, though this is unlikely. Oh, and if you want to help improving this
3921 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
3923 =head2 Plugin C<openvpn>
3925 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
3926 traffic statistics about connected clients.
3928 To set up OpenVPN to write to the status file periodically, use the
3929 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
3930 you need to set the required format, too. This is done by setting
3931 B<--status-version> to B<2>.
3933 So, in a nutshell you need:
3935 openvpn $OTHER_OPTIONS \
3936 --status "/var/run/openvpn-status" 10 \
3943 =item B<StatusFile> I<File>
3945 Specifies the location of the status file.
3947 =item B<ImprovedNamingSchema> B<true>|B<false>
3949 When enabled, the filename of the status file will be used as plugin instance
3950 and the client's "common name" will be used as type instance. This is required
3951 when reading multiple status files. Enabling this option is recommended, but to
3952 maintain backwards compatibility this option is disabled by default.
3954 =item B<CollectCompression> B<true>|B<false>
3956 Sets whether or not statistics about the compression used by OpenVPN should be
3957 collected. This information is only available in I<single> mode. Enabled by
3960 =item B<CollectIndividualUsers> B<true>|B<false>
3962 Sets whether or not traffic information is collected for each connected client
3963 individually. If set to false, currently no traffic data is collected at all
3964 because aggregating this data in a save manner is tricky. Defaults to B<true>.
3966 =item B<CollectUserCount> B<true>|B<false>
3968 When enabled, the number of currently connected clients or users is collected.
3969 This is especially interesting when B<CollectIndividualUsers> is disabled, but
3970 can be configured independently from that option. Defaults to B<false>.
3974 =head2 Plugin C<oracle>
3976 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
3977 Oracle® Database and lets you execute SQL statements there. It is very similar
3978 to the "dbi" plugin, because it was written around the same time. See the "dbi"
3979 plugin's documentation above for details.
3982 <Query "out_of_stock">
3983 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
3986 # InstancePrefix "foo"
3987 InstancesFrom "category"
3991 <Database "product_information">
3995 Query "out_of_stock"
3999 =head3 B<Query> blocks
4001 The Query blocks are handled identically to the Query blocks of the "dbi"
4002 plugin. Please see its documentation above for details on how to specify
4005 =head3 B<Database> blocks
4007 Database blocks define a connection to a database and which queries should be
4008 sent to that database. Each database needs a "name" as string argument in the
4009 starting tag of the block. This name will be used as "PluginInstance" in the
4010 values submitted to the daemon. Other than that, that name is not used.
4014 =item B<ConnectID> I<ID>
4016 Defines the "database alias" or "service name" to connect to. Usually, these
4017 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
4019 =item B<Host> I<Host>
4021 Hostname to use when dispatching values for this database. Defaults to using
4022 the global hostname of the I<collectd> instance.
4024 =item B<Username> I<Username>
4026 Username used for authentication.
4028 =item B<Password> I<Password>
4030 Password used for authentication.
4032 =item B<Query> I<QueryName>
4034 Associates the query named I<QueryName> with this database connection. The
4035 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
4036 blocks you want to refer to must be placed above the database block you want to
4041 =head2 Plugin C<perl>
4043 This plugin embeds a Perl-interpreter into collectd and provides an interface
4044 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
4046 =head2 Plugin C<pinba>
4048 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
4049 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
4050 PHP-based webpage has been delivered, the extension will send a UDP packet
4051 containing timing information, peak memory usage and so on. The plugin will
4052 wait for such packets, parse them and account the provided information, which
4053 is then dispatched to the daemon once per interval.
4060 # Overall statistics for the website.
4062 Server "www.example.com"
4064 # Statistics for www-a only
4066 Host "www-a.example.com"
4067 Server "www.example.com"
4069 # Statistics for www-b only
4071 Host "www-b.example.com"
4072 Server "www.example.com"
4076 The plugin provides the following configuration options:
4080 =item B<Address> I<Node>
4082 Configures the address used to open a listening socket. By default, plugin will
4083 bind to the I<any> address C<::0>.
4085 =item B<Port> I<Service>
4087 Configures the port (service) to bind to. By default the default Pinba port
4088 "30002" will be used. The option accepts service names in addition to port
4089 numbers and thus requires a I<string> argument.
4091 =item E<lt>B<View> I<Name>E<gt> block
4093 The packets sent by the Pinba extension include the hostname of the server, the
4094 server name (the name of the virtual host) and the script that was executed.
4095 Using B<View> blocks it is possible to separate the data into multiple groups
4096 to get more meaningful statistics. Each packet is added to all matching groups,
4097 so that a packet may be accounted for more than once.
4101 =item B<Host> I<Host>
4103 Matches the hostname of the system the webserver / script is running on. This
4104 will contain the result of the L<gethostname(2)> system call. If not
4105 configured, all hostnames will be accepted.
4107 =item B<Server> I<Server>
4109 Matches the name of the I<virtual host>, i.e. the contents of the
4110 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
4111 server names will be accepted.
4113 =item B<Script> I<Script>
4115 Matches the name of the I<script name>, i.e. the contents of the
4116 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
4117 script names will be accepted.
4123 =head2 Plugin C<ping>
4125 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
4126 configured hosts periodically and measures the network latency. Whenever the
4127 C<read> function of the plugin is called, it submits the average latency, the
4128 standard deviation and the drop rate for each host.
4130 Available configuration options:
4134 =item B<Host> I<IP-address>
4136 Host to ping periodically. This option may be repeated several times to ping
4139 =item B<Interval> I<Seconds>
4141 Sets the interval in which to send ICMP echo packets to the configured hosts.
4142 This is B<not> the interval in which statistics are queries from the plugin but
4143 the interval in which the hosts are "pinged". Therefore, the setting here
4144 should be smaller than or equal to the global B<Interval> setting. Fractional
4145 times, such as "1.24" are allowed.
4149 =item B<Timeout> I<Seconds>
4151 Time to wait for a response from the host to which an ICMP packet had been
4152 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
4153 to be down or the packet to be dropped. This setting must be smaller than the
4154 B<Interval> setting above for the plugin to work correctly. Fractional
4155 arguments are accepted.
4159 =item B<TTL> I<0-255>
4161 Sets the Time-To-Live of generated ICMP packets.
4163 =item B<SourceAddress> I<host>
4165 Sets the source address to use. I<host> may either be a numerical network
4166 address or a network hostname.
4168 =item B<Device> I<name>
4170 Sets the outgoing network device to be used. I<name> has to specify an
4171 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
4174 =item B<MaxMissed> I<Packets>
4176 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
4177 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
4179 Default: B<-1> (disabled)
4183 =head2 Plugin C<postgresql>
4185 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
4186 keeps a persistent connection to all configured databases and tries to
4187 reconnect if the connection has been interrupted. A database is configured by
4188 specifying a B<Database> block as described below. The default statistics are
4189 collected from PostgreSQL's B<statistics collector> which thus has to be
4190 enabled for this plugin to work correctly. This should usually be the case by
4191 default. See the section "The Statistics Collector" of the B<PostgreSQL
4192 Documentation> for details.
4194 By specifying custom database queries using a B<Query> block as described
4195 below, you may collect any data that is available from some PostgreSQL
4196 database. This way, you are able to access statistics of external daemons
4197 which are available in a PostgreSQL database or use future or special
4198 statistics provided by PostgreSQL without the need to upgrade your collectd
4201 Starting with version 5.2, the C<postgresql> plugin supports writing data to
4202 PostgreSQL databases as well. This has been implemented in a generic way. You
4203 need to specify an SQL statement which will then be executed by collectd in
4204 order to write the data (see below for details). The benefit of that approach
4205 is that there is no fixed database layout. Rather, the layout may be optimized
4206 for the current setup.
4208 The B<PostgreSQL Documentation> manual can be found at
4209 L<http://www.postgresql.org/docs/manuals/>.
4213 Statement "SELECT magic FROM wizard WHERE host = $1;"
4217 InstancePrefix "magic"
4222 <Query rt36_tickets>
4223 Statement "SELECT COUNT(type) AS count, type \
4225 WHEN resolved = 'epoch' THEN 'open' \
4226 ELSE 'resolved' END AS type \
4227 FROM tickets) type \
4231 InstancePrefix "rt36_tickets"
4232 InstancesFrom "type"
4238 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
4248 KRBSrvName "kerberos_service_name"
4254 Service "service_name"
4255 Query backend # predefined
4266 The B<Query> block defines one database query which may later be used by a
4267 database definition. It accepts a single mandatory argument which specifies
4268 the name of the query. The names of all queries have to be unique (see the
4269 B<MinVersion> and B<MaxVersion> options below for an exception to this
4270 rule). The following configuration options are available to define the query:
4272 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
4273 blocks define how to handle the values returned from the query. They define
4274 which column holds which value and how to dispatch that value to the daemon.
4275 Multiple B<Result> blocks may be used to extract multiple values from a single
4280 =item B<Statement> I<sql query statement>
4282 Specify the I<sql query statement> which the plugin should execute. The string
4283 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
4284 first, second, etc. parameter. The value of the parameters is specified by the
4285 B<Param> configuration option - see below for details. To include a literal
4286 B<$> character followed by a number, surround it with single quotes (B<'>).
4288 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
4289 allowed. Note, however, that only a single command may be used. Semicolons are
4290 allowed as long as a single non-empty command has been specified only.
4292 The returned lines will be handled separately one after another.
4294 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4296 Specify the parameters which should be passed to the SQL query. The parameters
4297 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4298 they appear in the configuration file. The value of the parameter is
4299 determined depending on the value of the B<Param> option as follows:
4305 The configured hostname of the database connection. If a UNIX domain socket is
4306 used, the parameter expands to "localhost".
4310 The name of the database of the current connection.
4314 The name of the database plugin instance. See the B<Instance> option of the
4315 database specification below for details.
4319 The username used to connect to the database.
4323 The interval with which this database is queried (as specified by the database
4324 specific or global B<Interval> options).
4328 Please note that parameters are only supported by PostgreSQL's protocol
4329 version 3 and above which was introduced in version 7.4 of PostgreSQL.
4331 =item B<Type> I<type>
4333 The I<type> name to be used when dispatching the values. The type describes
4334 how to handle the data and where to store it. See L<types.db(5)> for more
4335 details on types and their configuration. The number and type of values (as
4336 selected by the B<ValuesFrom> option) has to match the type of the given name.
4338 This option is required inside a B<Result> block.
4340 =item B<InstancePrefix> I<prefix>
4342 =item B<InstancesFrom> I<column0> [I<column1> ...]
4344 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
4345 B<InstancePrefix> defines a static prefix that will be prepended to all type
4346 instances. B<InstancesFrom> defines the column names whose values will be used
4347 to create the type instance. Multiple values will be joined together using the
4348 hyphen (C<->) as separation character.
4350 The plugin itself does not check whether or not all built instances are
4351 different. It is your responsibility to assure that each is unique.
4353 Both options are optional. If none is specified, the type instance will be
4356 =item B<ValuesFrom> I<column0> [I<column1> ...]
4358 Names the columns whose content is used as the actual data for the data sets
4359 that are dispatched to the daemon. How many such columns you need is
4360 determined by the B<Type> setting as explained above. If you specify too many
4361 or not enough columns, the plugin will complain about that and no data will be
4362 submitted to the daemon.
4364 The actual data type, as seen by PostgreSQL, is not that important as long as
4365 it represents numbers. The plugin will automatically cast the values to the
4366 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
4367 L<strtod(3)> functions, so anything supported by those functions is supported
4368 by the plugin as well.
4370 This option is required inside a B<Result> block and may be specified multiple
4371 times. If multiple B<ValuesFrom> options are specified, the columns are read
4374 =item B<MinVersion> I<version>
4376 =item B<MaxVersion> I<version>
4378 Specify the minimum or maximum version of PostgreSQL that this query should be
4379 used with. Some statistics might only be available with certain versions of
4380 PostgreSQL. This allows you to specify multiple queries with the same name but
4381 which apply to different versions, thus allowing you to use the same
4382 configuration in a heterogeneous environment.
4384 The I<version> has to be specified as the concatenation of the major, minor
4385 and patch-level versions, each represented as two-decimal-digit numbers. For
4386 example, version 8.2.3 will become 80203.
4390 The following predefined queries are available (the definitions can be found
4391 in the F<postgresql_default.conf> file which, by default, is available at
4392 C<I<prefix>/share/collectd/>):
4398 This query collects the number of backends, i.E<nbsp>e. the number of
4401 =item B<transactions>
4403 This query collects the numbers of committed and rolled-back transactions of
4408 This query collects the numbers of various table modifications (i.E<nbsp>e.
4409 insertions, updates, deletions) of the user tables.
4411 =item B<query_plans>
4413 This query collects the numbers of various table scans and returned tuples of
4416 =item B<table_states>
4418 This query collects the numbers of live and dead rows in the user tables.
4422 This query collects disk block access counts for user tables.
4426 This query collects the on-disk size of the database in bytes.
4430 In addition, the following detailed queries are available by default. Please
4431 note that each of those queries collects information B<by table>, thus,
4432 potentially producing B<a lot> of data. For details see the description of the
4433 non-by_table queries above.
4437 =item B<queries_by_table>
4439 =item B<query_plans_by_table>
4441 =item B<table_states_by_table>
4443 =item B<disk_io_by_table>
4447 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
4448 mandatory argument specifying the name of the writer. This will then be used
4449 in the B<Database> specification in order to activate the writer instance. The
4450 names of all writers have to be unique. The following options may be
4455 =item B<Statement> I<sql statement>
4457 This mandatory option specifies the SQL statement that will be executed for
4458 each submitted value. A single SQL statement is allowed only. Anything after
4459 the first semicolon will be ignored.
4461 Nine parameters will be passed to the statement and should be specified as
4462 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
4463 values are made available through those parameters:
4469 The timestamp of the queried value as a floating point number.
4473 The hostname of the queried value.
4477 The plugin name of the queried value.
4481 The plugin instance of the queried value. This value may be B<NULL> if there
4482 is no plugin instance.
4486 The type of the queried value (cf. L<types.db(5)>).
4490 The type instance of the queried value. This value may be B<NULL> if there is
4495 An array of names for the submitted values (i.E<nbsp>e., the name of the data
4496 sources of the submitted value-list).
4500 An array of types for the submitted values (i.E<nbsp>e., the type of the data
4501 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
4502 B<StoreRates> is enabled (which is the default, see below), all types will be
4507 An array of the submitted values. The dimensions of the value name and value
4512 In general, it is advisable to create and call a custom function in the
4513 PostgreSQL database for this purpose. Any procedural language supported by
4514 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
4517 =item B<StoreRates> B<false>|B<true>
4519 If set to B<true> (the default), convert counter values to rates. If set to
4520 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
4525 The B<Database> block defines one PostgreSQL database for which to collect
4526 statistics. It accepts a single mandatory argument which specifies the
4527 database name. None of the other options are required. PostgreSQL will use
4528 default values as documented in the section "CONNECTING TO A DATABASE" in the
4529 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
4530 the user collectd is run as and special environment variables. See the manpage
4535 =item B<Interval> I<seconds>
4537 Specify the interval with which the database should be queried. The default is
4538 to use the global B<Interval> setting.
4540 =item B<CommitInterval> I<seconds>
4542 This option may be used for database connections which have "writers" assigned
4543 (see above). If specified, it causes a writer to put several updates into a
4544 single transaction. This transaction will last for the specified amount of
4545 time. By default, each update will be executed in a separate transaction. Each
4546 transaction generates a fair amount of overhead which can, thus, be reduced by
4547 activating this option. The draw-back is, that data covering the specified
4548 amount of time will be lost, for example, if a single statement within the
4549 transaction fails or if the database server crashes.
4551 =item B<Host> I<hostname>
4553 Specify the hostname or IP of the PostgreSQL server to connect to. If the
4554 value begins with a slash, it is interpreted as the directory name in which to
4555 look for the UNIX domain socket.
4557 This option is also used to determine the hostname that is associated with a
4558 collected data set. If it has been omitted or either begins with with a slash
4559 or equals B<localhost> it will be replaced with the global hostname definition
4560 of collectd. Any other value will be passed literally to collectd when
4561 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
4563 =item B<Port> I<port>
4565 Specify the TCP port or the local UNIX domain socket file extension of the
4568 =item B<User> I<username>
4570 Specify the username to be used when connecting to the server.
4572 =item B<Password> I<password>
4574 Specify the password to be used when connecting to the server.
4576 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
4578 Specify whether to use an SSL connection when contacting the server. The
4579 following modes are supported:
4581 =item B<Instance> I<name>
4583 Specify the plugin instance name that should be used instead of the database
4584 name (which is the default, if this option has not been specified). This
4585 allows to query multiple databases of the same name on the same host (e.g.
4586 when running multiple database server versions in parallel).
4592 Do not use SSL at all.
4596 First, try to connect without using SSL. If that fails, try using SSL.
4598 =item I<prefer> (default)
4600 First, try to connect using SSL. If that fails, try without using SSL.
4608 =item B<KRBSrvName> I<kerberos_service_name>
4610 Specify the Kerberos service name to use when authenticating with Kerberos 5
4611 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
4612 B<PostgreSQL Documentation> for details.
4614 =item B<Service> I<service_name>
4616 Specify the PostgreSQL service name to use for additional parameters. That
4617 service has to be defined in F<pg_service.conf> and holds additional
4618 connection parameters. See the section "The Connection Service File" in the
4619 B<PostgreSQL Documentation> for details.
4621 =item B<Query> I<query>
4623 Specifies a I<query> which should be executed in the context of the database
4624 connection. This may be any of the predefined or user-defined queries. If no
4625 such option is given, it defaults to "backends", "transactions", "queries",
4626 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
4627 has been specified). Else, the specified queries are used only.
4629 =item B<Writer> I<writer>
4631 Assigns the specified I<writer> backend to the database connection. This
4632 causes all collected data to be send to the database using the settings
4633 defined in the writer configuration (see the section "FILTER CONFIGURATION"
4634 below for details on how to selectively send data to certain plugins).
4636 Each writer will register a flush callback which may be used when having long
4637 transactions enabled (see the B<CommitInterval> option above). When issuing
4638 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
4639 transaction will be committed right away. Two different kinds of flush
4640 callbacks are available with the C<postgresql> plugin:
4646 Flush all writer backends.
4648 =item B<postgresql->I<database>
4650 Flush all writers of the specified I<database> only.
4656 =head2 Plugin C<powerdns>
4658 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
4659 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
4660 values, many of which are probably meaningless to most users, but may be useful
4661 for some. So you may chose which values to collect, but if you don't, some
4662 reasonable defaults will be collected.
4665 <Server "server_name">
4667 Collect "udp-answers" "udp-queries"
4668 Socket "/var/run/pdns.controlsocket"
4670 <Recursor "recursor_name">
4672 Collect "cache-hits" "cache-misses"
4673 Socket "/var/run/pdns_recursor.controlsocket"
4675 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
4680 =item B<Server> and B<Recursor> block
4682 The B<Server> block defines one authoritative server to query, the B<Recursor>
4683 does the same for an recursing server. The possible options in both blocks are
4684 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
4689 =item B<Collect> I<Field>
4691 Using the B<Collect> statement you can select which values to collect. Here,
4692 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
4693 C<dlg-only-drops>, C<answers10-100>.
4695 The method of getting the values differs for B<Server> and B<Recursor> blocks:
4696 When querying the server a C<SHOW *> command is issued in any case, because
4697 that's the only way of getting multiple values out of the server at once.
4698 collectd then picks out the values you have selected. When querying the
4699 recursor, a command is generated to query exactly these values. So if you
4700 specify invalid fields when querying the recursor, a syntax error may be
4701 returned by the daemon and collectd may not collect any values at all.
4703 If no B<Collect> statement is given, the following B<Server> values will be
4710 =item packetcache-hit
4712 =item packetcache-miss
4714 =item packetcache-size
4716 =item query-cache-hit
4718 =item query-cache-miss
4720 =item recursing-answers
4722 =item recursing-questions
4734 The following B<Recursor> values will be collected by default:
4738 =item noerror-answers
4740 =item nxdomain-answers
4742 =item servfail-answers
4760 Please note that up to that point collectd doesn't know what values are
4761 available on the server and values that are added do not need a change of the
4762 mechanism so far. However, the values must be mapped to collectd's naming
4763 scheme, which is done using a lookup table that lists all known values. If
4764 values are added in the future and collectd does not know about them, you will
4765 get an error much like this:
4767 powerdns plugin: submit: Not found in lookup table: foobar = 42
4769 In this case please file a bug report with the collectd team.
4771 =item B<Socket> I<Path>
4773 Configures the path to the UNIX domain socket to be used when connecting to the
4774 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
4775 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
4776 will be used for the recursor.
4780 =item B<LocalSocket> I<Path>
4782 Querying the recursor is done using UDP. When using UDP over UNIX domain
4783 sockets, the client socket needs a name in the file system, too. You can set
4784 this local name to I<Path> using the B<LocalSocket> option. The default is
4785 C<I<prefix>/var/run/collectd-powerdns>.
4789 =head2 Plugin C<processes>
4793 =item B<Process> I<Name>
4795 Select more detailed statistics of processes matching this name. The statistics
4796 collected for these selected processes are size of the resident segment size
4797 (RSS), user- and system-time used, number of processes and number of threads,
4798 io data (where available) and minor and major pagefaults.
4800 =item B<ProcessMatch> I<name> I<regex>
4802 Similar to the B<Process> option this allows to select more detailed
4803 statistics of processes matching the specified I<regex> (see L<regex(7)> for
4804 details). The statistics of all matching processes are summed up and
4805 dispatched to the daemon using the specified I<name> as an identifier. This
4806 allows to "group" several processes together. I<name> must not contain
4811 =head2 Plugin C<protocols>
4813 Collects a lot of information about various network protocols, such as I<IP>,
4814 I<TCP>, I<UDP>, etc.
4816 Available configuration options:
4820 =item B<Value> I<Selector>
4822 Selects whether or not to select a specific value. The string being matched is
4823 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
4824 plugin instance and I<ValueName> will be used as type instance. An example of
4825 the string being used would be C<Tcp:RetransSegs>.
4827 You can use regular expressions to match a large number of values with just one
4828 configuration option. To select all "extended" I<TCP> values, you could use the
4829 following statement:
4833 Whether only matched values are selected or all matched values are ignored
4834 depends on the B<IgnoreSelected>. By default, only matched values are selected.
4835 If no value is configured at all, all values will be selected.
4837 =item B<IgnoreSelected> B<true>|B<false>
4839 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
4840 matching values will be ignored.
4844 =head2 Plugin C<python>
4846 This plugin embeds a Python-interpreter into collectd and provides an interface
4847 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
4849 =head2 Plugin C<routeros>
4851 The C<routeros> plugin connects to a device running I<RouterOS>, the
4852 Linux-based operating system for routers by I<MikroTik>. The plugin uses
4853 I<librouteros> to connect and reads information about the interfaces and
4854 wireless connections of the device. The configuration supports querying
4859 Host "router0.example.com"
4862 CollectInterface true
4867 Host "router1.example.com"
4870 CollectInterface true
4871 CollectRegistrationTable true
4877 As you can see above, the configuration of the I<routeros> plugin consists of
4878 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
4879 options are understood:
4883 =item B<Host> I<Host>
4885 Hostname or IP-address of the router to connect to.
4887 =item B<Port> I<Port>
4889 Port name or port number used when connecting. If left unspecified, the default
4890 will be chosen by I<librouteros>, currently "8728". This option expects a
4891 string argument, even when a numeric port number is given.
4893 =item B<User> I<User>
4895 Use the user name I<User> to authenticate. Defaults to "admin".
4897 =item B<Password> I<Password>
4899 Set the password used to authenticate.
4901 =item B<CollectInterface> B<true>|B<false>
4903 When set to B<true>, interface statistics will be collected for all interfaces
4904 present on the device. Defaults to B<false>.
4906 =item B<CollectRegistrationTable> B<true>|B<false>
4908 When set to B<true>, information about wireless LAN connections will be
4909 collected. Defaults to B<false>.
4911 =item B<CollectCPULoad> B<true>|B<false>
4913 When set to B<true>, information about the CPU usage will be collected. The
4914 number is a dimensionless value where zero indicates no CPU usage at all.
4915 Defaults to B<false>.
4917 =item B<CollectMemory> B<true>|B<false>
4919 When enabled, the amount of used and free memory will be collected. How used
4920 memory is calculated is unknown, for example whether or not caches are counted
4922 Defaults to B<false>.
4924 =item B<CollectDF> B<true>|B<false>
4926 When enabled, the amount of used and free disk space will be collected.
4927 Defaults to B<false>.
4929 =item B<CollectDisk> B<true>|B<false>
4931 When enabled, the number of sectors written and bad blocks will be collected.
4932 Defaults to B<false>.
4936 =head2 Plugin C<redis>
4938 The I<Redis plugin> connects to one or more Redis servers and gathers
4939 information about each server's state. For each server there is a I<Node> block
4940 which configures the connection parameters for this node.
4950 The information shown in the synopsis above is the I<default configuration>
4951 which is used by the plugin if no configuration is present.
4955 =item B<Node> I<Nodename>
4957 The B<Node> block identifies a new Redis node, that is a new Redis instance
4958 running in an specified host and port. The name for node is a canonical
4959 identifier which is used as I<plugin instance>. It is limited to
4960 64E<nbsp>characters in length.
4962 =item B<Host> I<Hostname>
4964 The B<Host> option is the hostname or IP-address where the Redis instance is
4967 =item B<Port> I<Port>
4969 The B<Port> option is the TCP port on which the Redis instance accepts
4970 connections. Either a service name of a port number may be given. Please note
4971 that numerical port numbers must be given as a string, too.
4973 =item B<Password> I<Password>
4975 Use I<Password> to authenticate when connecting to I<Redis>.
4977 =item B<Timeout> I<Timeout in miliseconds>
4979 The B<Timeout> option set the socket timeout for node response. Since the Redis
4980 read function is blocking, you should keep this value as low as possible. Keep
4981 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
4982 than B<Interval> defined globally.
4986 =head2 Plugin C<rrdcached>
4988 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
4989 to store values to RRD files in an efficient manner. The combination of the
4990 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
4991 way the C<rrdtool> plugin works (see below). The added abstraction layer
4992 provides a number of benefits, though: Because the cache is not within
4993 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
4994 restarted. This results in much shorter (if any) gaps in graphs, especially
4995 under heavy load. Also, the C<rrdtool> command line utility is aware of the
4996 daemon so that it can flush values to disk automatically when needed. This
4997 allows to integrate automated flushing of values into graphing solutions much
5000 There are disadvantages, though: The daemon may reside on a different host, so
5001 it may not be possible for C<collectd> to create the appropriate RRD files
5002 anymore. And even if C<rrdcached> runs on the same host, it may run in a
5003 different base directory, so relative paths may do weird stuff if you're not
5006 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
5007 on the same host, communicating via a UNIX domain socket. The B<DataDir>
5008 setting should be set to an absolute path, so that a changed base directory
5009 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
5013 =item B<DaemonAddress> I<Address>
5015 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
5016 library. See L<rrdcached(1)> for details. Example:
5018 <Plugin "rrdcached">
5019 DaemonAddress "unix:/var/run/rrdcached.sock"
5022 =item B<DataDir> I<Directory>
5024 Set the base directory in which the RRD files reside. If this is a relative
5025 path, it is relative to the working base directory of the C<rrdcached> daemon!
5026 Use of an absolute path is recommended.
5028 =item B<CreateFiles> B<true>|B<false>
5030 Enables or disables the creation of RRD files. If the daemon is not running
5031 locally, or B<DataDir> is set to a relative path, this will not work as
5032 expected. Default is B<true>.
5034 =item B<CreateFilesAsync> B<false>|B<true>
5036 When enabled, new RRD files are enabled asynchronously, using a separate thread
5037 that runs in the background. This prevents writes to block, which is a problem
5038 especially when many hundreds of files need to be created at once. However,
5039 since the purpose of creating the files asynchronously is I<not> to block until
5040 the file is available, values before the file is available will be discarded.
5041 When disabled (the default) files are created synchronously, blocking for a
5042 short while, while the file is being written.
5044 =item B<StepSize> I<Seconds>
5046 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5047 this setting is unset and the stepsize is set to the interval in which the data
5048 is collected. Do not use this option unless you absolutely have to for some
5049 reason. Setting this option may cause problems with the C<snmp plugin>, the
5050 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5052 =item B<HeartBeat> I<Seconds>
5054 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5055 in which case the heartbeat is set to twice the B<StepSize> which should equal
5056 the interval in which data is collected. Do not set this option unless you have
5057 a very good reason to do so.
5059 =item B<RRARows> I<NumRows>
5061 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5062 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5063 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5064 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5065 week, one month, and one year.
5067 So for each timespan, it calculates how many PDPs need to be consolidated into
5068 one CDP by calculating:
5069 number of PDPs = timespan / (stepsize * rrarows)
5071 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5074 =item B<RRATimespan> I<Seconds>
5076 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5077 more then one RRA. If this option is never used, the built-in default of (3600,
5078 86400, 604800, 2678400, 31622400) is used.
5080 For more information on how RRA-sizes are calculated see B<RRARows> above.
5082 =item B<XFF> I<Factor>
5084 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5085 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5090 =head2 Plugin C<rrdtool>
5092 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
5093 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
5094 using these settings. If you don't want to dive into the depths of RRDtool, you
5095 can safely ignore these settings.
5099 =item B<DataDir> I<Directory>
5101 Set the directory to store RRD files under. By default RRD files are generated
5102 beneath the daemon's working directory, i.e. the B<BaseDir>.
5104 =item B<CreateFilesAsync> B<false>|B<true>
5106 When enabled, new RRD files are enabled asynchronously, using a separate thread
5107 that runs in the background. This prevents writes to block, which is a problem
5108 especially when many hundreds of files need to be created at once. However,
5109 since the purpose of creating the files asynchronously is I<not> to block until
5110 the file is available, values before the file is available will be discarded.
5111 When disabled (the default) files are created synchronously, blocking for a
5112 short while, while the file is being written.
5114 =item B<StepSize> I<Seconds>
5116 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5117 this setting is unset and the stepsize is set to the interval in which the data
5118 is collected. Do not use this option unless you absolutely have to for some
5119 reason. Setting this option may cause problems with the C<snmp plugin>, the
5120 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5122 =item B<HeartBeat> I<Seconds>
5124 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5125 in which case the heartbeat is set to twice the B<StepSize> which should equal
5126 the interval in which data is collected. Do not set this option unless you have
5127 a very good reason to do so.
5129 =item B<RRARows> I<NumRows>
5131 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5132 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5133 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5134 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5135 week, one month, and one year.
5137 So for each timespan, it calculates how many PDPs need to be consolidated into
5138 one CDP by calculating:
5139 number of PDPs = timespan / (stepsize * rrarows)
5141 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5144 =item B<RRATimespan> I<Seconds>
5146 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5147 more then one RRA. If this option is never used, the built-in default of (3600,
5148 86400, 604800, 2678400, 31622400) is used.
5150 For more information on how RRA-sizes are calculated see B<RRARows> above.
5152 =item B<XFF> I<Factor>
5154 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5155 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5158 =item B<CacheFlush> I<Seconds>
5160 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
5161 it writes all values for a certain RRD-file if the oldest value is older than
5162 (or equal to) the number of seconds specified. If some RRD-file is not updated
5163 anymore for some reason (the computer was shut down, the network is broken,
5164 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
5165 entire cache is searched for entries older than B<CacheTimeout> seconds and
5166 written to disk every I<Seconds> seconds. Since this is kind of expensive and
5167 does nothing under normal circumstances, this value should not be too small.
5168 900 seconds might be a good value, though setting this to 7200 seconds doesn't
5169 normally do much harm either.
5171 =item B<CacheTimeout> I<Seconds>
5173 If this option is set to a value greater than zero, the C<rrdtool plugin> will
5174 save values in a cache, as described above. Writing multiple values at once
5175 reduces IO-operations and thus lessens the load produced by updating the files.
5176 The trade off is that the graphs kind of "drag behind" and that more memory is
5179 =item B<WritesPerSecond> I<Updates>
5181 When collecting many statistics with collectd and the C<rrdtool> plugin, you
5182 will run serious performance problems. The B<CacheFlush> setting and the
5183 internal update queue assert that collectd continues to work just fine even
5184 under heavy load, but the system may become very unresponsive and slow. This is
5185 a problem especially if you create graphs from the RRD files on the same
5186 machine, for example using the C<graph.cgi> script included in the
5187 C<contrib/collection3/> directory.
5189 This setting is designed for very large setups. Setting this option to a value
5190 between 25 and 80 updates per second, depending on your hardware, will leave
5191 the server responsive enough to draw graphs even while all the cached values
5192 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
5193 by the B<FLUSH> command, are B<not> effected by this limit. They are still
5194 written as fast as possible, so that web frontends have up to date data when
5197 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
5198 updates per second, writing all values to disk will take approximately
5199 56E<nbsp>minutes. Together with the flushing ability that's integrated into
5200 "collection3" you'll end up with a responsive and fast system, up to date
5201 graphs and basically a "backup" of your values every hour.
5203 =item B<RandomTimeout> I<Seconds>
5205 When set, the actual timeout for each value is chosen randomly between
5206 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
5207 intention is to avoid high load situations that appear when many values timeout
5208 at the same time. This is especially a problem shortly after the daemon starts,
5209 because all values were added to the internal cache at roughly the same time.
5213 =head2 Plugin C<sensors>
5215 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
5216 that all the needed modules have to be loaded and lm_sensors has to be
5217 configured (most likely by editing F</etc/sensors.conf>. Read
5218 L<sensors.conf(5)> for details.
5220 The B<lm_sensors> homepage can be found at
5221 L<http://secure.netroedge.com/~lm78/>.
5225 =item B<SensorConfigFile> I<File>
5227 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
5228 the library's default will be used.
5230 =item B<Sensor> I<chip-bus-address/type-feature>
5232 Selects the name of the sensor which you want to collect or ignore, depending
5233 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
5234 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
5235 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
5237 =item B<IgnoreSelected> I<true>|I<false>
5239 If no configuration if given, the B<sensors>-plugin will collect data from all
5240 sensors. This may not be practical, especially for uninteresting sensors.
5241 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
5242 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
5243 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
5244 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
5245 and all other sensors are collected.
5249 =head2 Plugin C<sigrok>
5251 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
5252 supported by the L<sigrok|http://sigrok.org/> project.
5258 <Device "AC Voltage">
5263 <Device "Sound Level">
5264 Driver "cem-dt-885x"
5271 =item B<LogLevel> B<0-5>
5273 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
5274 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
5275 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
5276 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
5277 their level, are always submitted to I<collectd> at its INFO log level.
5279 =item E<lt>B<Device> I<Name>E<gt>
5281 A sigrok-supported device, uniquely identified by this section's options. The
5282 I<Name> is passed to I<collectd> as the I<plugin instance>.
5284 =item B<Driver> I<DriverName>
5286 The sigrok driver to use for this device.
5288 =item B<Conn> I<ConnectionSpec>
5290 If the device cannot be auto-discovered, or more than one might be discovered
5291 by the driver, I<ConnectionSpec> specifies the connection string to the device.
5292 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
5293 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
5294 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
5295 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
5297 =item B<SerialComm> I<SerialSpec>
5299 For serial devices with non-standard port settings, this option can be used
5300 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
5301 This should not be necessary; drivers know how to communicate with devices they
5304 =item B<MinimumInterval> I<Seconds>
5306 Specifies the minimum time between measurement dispatches to I<collectd>, in
5307 seconds. Since some I<sigrok> supported devices can acquire measurements many
5308 times per second, it may be necessary to throttle these. For example, the
5309 I<RRD plugin> cannot process writes more than once per second.
5311 The default B<MinimumInterval> is B<0>, meaning measurements received from the
5312 device are always dispatched to I<collectd>. When throttled, unused
5313 measurements are discarded.
5317 =head2 Plugin C<snmp>
5319 Since the configuration of the C<snmp plugin> is a little more complicated than
5320 other plugins, its documentation has been moved to an own manpage,
5321 L<collectd-snmp(5)>. Please see there for details.
5323 =head2 Plugin C<statsd>
5325 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
5326 protocol and dispatches rates or other aggregates of these numbers
5329 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
5330 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
5331 C<objects> respectively.
5333 The following configuration options are valid:
5337 =item B<Host> I<Host>
5339 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
5340 "any" address, i.e. accept packets sent to any of the hosts addresses.
5342 =item B<Port> I<Port>
5344 UDP port to listen to. This can be either a service name or a port number.
5345 Defaults to C<8125>.
5347 =item B<DeleteCounters> B<false>|B<true>
5349 =item B<DeleteTimers> B<false>|B<true>
5351 =item B<DeleteGauges> B<false>|B<true>
5353 =item B<DeleteSets> B<false>|B<true>
5355 These options control what happens if metrics are not updated in an interval.
5356 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
5357 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
5358 are unchanged. If set to B<True>, the such metrics are not dispatched and
5359 removed from the internal cache.
5361 =item B<TimerPercentile> I<Percent>
5363 Calculate and dispatch the configured percentile, i.e. compute the latency, so
5364 that I<Percent> of all reported timers are smaller than or equal to the
5365 computed latency. This is useful for cutting off the long tail latency, as it's
5366 often done in I<Service Level Agreements> (SLAs).
5368 If not specified, no percentile is calculated / dispatched.
5372 =head2 Plugin C<swap>
5374 The I<Swap plugin> collects information about used and available swap space. On
5375 I<Linux> and I<Solaris>, the following options are available:
5379 =item B<ReportByDevice> B<false>|B<true>
5381 Configures how to report physical swap devices. If set to B<false> (the
5382 default), the summary over all swap devices is reported only, i.e. the globally
5383 used and available space over all devices. If B<true> is configured, the used
5384 and available space of each device will be reported separately.
5386 This option is only available if the I<Swap plugin> can read C</proc/swaps>
5387 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
5389 =item B<ReportBytes> B<false>|B<true>
5391 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
5392 I<swap I/O> is reported in pages. This option is available under Linux only.
5394 =item B<ValuesAbsolute> B<true>|B<false>
5396 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
5397 available and used. Defaults to B<true>.
5399 =item B<ValuesPercentage> B<false>|B<true>
5401 Enables or disables reporting of relative swap metrics, i.e. I<percent>
5402 available and free. Defaults to B<false>.
5404 This is useful for deploying I<collectd> in a heterogeneous environment, where
5405 swap sizes differ and you want to specify generic thresholds or similar.
5409 =head2 Plugin C<syslog>
5413 =item B<LogLevel> B<debug|info|notice|warning|err>
5415 Sets the log-level. If, for example, set to B<notice>, then all events with
5416 severity B<notice>, B<warning>, or B<err> will be submitted to the
5419 Please note that B<debug> is only available if collectd has been compiled with
5422 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
5424 Controls which notifications should be sent to syslog. The default behaviour is
5425 not to send any. Less severe notifications always imply logging more severe
5426 notifications: Setting this to B<OKAY> means all notifications will be sent to
5427 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
5428 notifications but will dismiss B<OKAY> notifications. Setting this option to
5429 B<FAILURE> will only send failures to syslog.
5433 =head2 Plugin C<table>
5435 The C<table plugin> provides generic means to parse tabular data and dispatch
5436 user specified values. Values are selected based on column numbers. For
5437 example, this plugin may be used to get values from the Linux L<proc(5)>
5438 filesystem or CSV (comma separated values) files.
5441 <Table "/proc/slabinfo">
5446 InstancePrefix "active_objs"
5452 InstancePrefix "objperslab"
5459 The configuration consists of one or more B<Table> blocks, each of which
5460 configures one file to parse. Within each B<Table> block, there are one or
5461 more B<Result> blocks, which configure which data to select and how to
5464 The following options are available inside a B<Table> block:
5468 =item B<Instance> I<instance>
5470 If specified, I<instance> is used as the plugin instance. So, in the above
5471 example, the plugin name C<table-slabinfo> would be used. If omitted, the
5472 filename of the table is used instead, with all special characters replaced
5473 with an underscore (C<_>).
5475 =item B<Separator> I<string>
5477 Any character of I<string> is interpreted as a delimiter between the different
5478 columns of the table. A sequence of two or more contiguous delimiters in the
5479 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
5480 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
5481 of a table - see its documentation for more details. This option is mandatory.
5483 A horizontal tab, newline and carriage return may be specified by C<\\t>,
5484 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
5485 required because of collectd's config parsing.
5489 The following options are available inside a B<Result> block:
5493 =item B<Type> I<type>
5495 Sets the type used to dispatch the values to the daemon. Detailed information
5496 about types and their configuration can be found in L<types.db(5)>. This
5497 option is mandatory.
5499 =item B<InstancePrefix> I<prefix>
5501 If specified, prepend I<prefix> to the type instance. If omitted, only the
5502 B<InstancesFrom> option is considered for the type instance.
5504 =item B<InstancesFrom> I<column0> [I<column1> ...]
5506 If specified, the content of the given columns (identified by the column
5507 number starting at zero) will be used to create the type instance for each
5508 row. Multiple values (and the instance prefix) will be joined together with
5509 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
5510 option is considered for the type instance.
5512 The plugin itself does not check whether or not all built instances are
5513 different. It’s your responsibility to assure that each is unique. This is
5514 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
5515 sure that the table only contains one row.
5517 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
5520 =item B<ValuesFrom> I<column0> [I<column1> ...]
5522 Specifies the columns (identified by the column numbers starting at zero)
5523 whose content is used as the actual data for the data sets that are dispatched
5524 to the daemon. How many such columns you need is determined by the B<Type>
5525 setting above. If you specify too many or not enough columns, the plugin will
5526 complain about that and no data will be submitted to the daemon. The plugin
5527 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
5528 respectively, so anything supported by those functions is supported by the
5529 plugin as well. This option is mandatory.
5533 =head2 Plugin C<tail>
5535 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
5536 each line and dispatches found values. What is matched can be configured by the
5537 user using (extended) regular expressions, as described in L<regex(7)>.
5540 <File "/var/log/exim4/mainlog">
5543 Regex "S=([1-9][0-9]*)"
5549 Regex "\\<R=local_user\\>"
5550 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
5553 Instance "local_user"
5558 The config consists of one or more B<File> blocks, each of which configures one
5559 logfile to parse. Within each B<File> block, there are one or more B<Match>
5560 blocks, which configure a regular expression to search for.
5562 The B<Instance> option in the B<File> block may be used to set the plugin
5563 instance. So in the above example the plugin name C<tail-foo> would be used.
5564 This plugin instance is for all B<Match> blocks that B<follow> it, until the
5565 next B<Instance> option. This way you can extract several plugin instances from
5566 one logfile, handy when parsing syslog and the like.
5568 Each B<Match> block has the following options to describe how the match should
5573 =item B<Regex> I<regex>
5575 Sets the regular expression to use for matching against a line. The first
5576 subexpression has to match something that can be turned into a number by
5577 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
5578 below. Because B<extended> regular expressions are used, you do not need to use
5579 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
5580 collectd's config parsing you need to escape backslashes, though. So if you
5581 want to match literal parentheses you need to do the following:
5583 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
5585 =item B<ExcludeRegex> I<regex>
5587 Sets an optional regular expression to use for excluding lines from the match.
5588 An example which excludes all connections from localhost from the match:
5590 ExcludeRegex "127\\.0\\.0\\.1"
5592 =item B<DSType> I<Type>
5594 Sets how the values are cumulated. I<Type> is one of:
5598 =item B<GaugeAverage>
5600 Calculate the average.
5604 Use the smallest number only.
5608 Use the greatest number only.
5612 Use the last number found.
5618 =item B<AbsoluteSet>
5620 The matched number is a counter. Simply I<sets> the internal counter to this
5621 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
5627 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
5628 matched number may be negative, which will effectively subtract from the
5635 Increase the internal counter by one. These B<DSType> are the only ones that do
5636 not use the matched subexpression, but simply count the number of matched
5637 lines. Thus, you may use a regular expression without submatch in this case.
5641 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
5642 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
5643 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
5644 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
5645 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
5648 =item B<Type> I<Type>
5650 Sets the type used to dispatch this value. Detailed information about types and
5651 their configuration can be found in L<types.db(5)>.
5653 =item B<Instance> I<TypeInstance>
5655 This optional setting sets the type instance to use.
5659 =head2 Plugin C<tail_csv>
5661 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
5662 written by I<Snort>.
5667 <Metric "snort-dropped">
5672 <File "/var/log/snort/snort.stats">
5673 Instance "snort-eth0"
5675 Collect "snort-dropped"
5679 The configuration consists of one or more B<Metric> blocks that define an index
5680 into the line of the CSV file and how this value is mapped to I<collectd's>
5681 internal representation. These are followed by one or more B<Instance> blocks
5682 which configure which file to read, in which interval and which metrics to
5687 =item E<lt>B<Metric> I<Name>E<gt>
5689 The B<Metric> block configures a new metric to be extracted from the statistics
5690 file and how it is mapped on I<collectd's> data model. The string I<Name> is
5691 only used inside the B<Instance> blocks to refer to this block, so you can use
5692 one B<Metric> block for multiple CSV files.
5696 =item B<Type> I<Type>
5698 Configures which I<Type> to use when dispatching this metric. Types are defined
5699 in the L<types.db(5)> file, see the appropriate manual page for more
5700 information on specifying types. Only types with a single I<data source> are
5701 supported by the I<tail_csv plugin>. The information whether the value is an
5702 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
5703 I<Type's> definition.
5705 =item B<Instance> I<TypeInstance>
5707 If set, I<TypeInstance> is used to populate the type instance field of the
5708 created value lists. Otherwise, no type instance is used.
5710 =item B<ValueFrom> I<Index>
5712 Configure to read the value from the field with the zero-based index I<Index>.
5713 If the value is parsed as signed integer, unsigned integer or double depends on
5714 the B<Type> setting, see above.
5718 =item E<lt>B<File> I<Path>E<gt>
5720 Each B<File> block represents one CSV file to read. There must be at least one
5721 I<File> block but there can be multiple if you have multiple CSV files.
5725 =item B<Instance> I<PluginInstance>
5727 Sets the I<plugin instance> used when dispatching the values.
5729 =item B<Collect> I<Metric>
5731 Specifies which I<Metric> to collect. This option must be specified at least
5732 once, and you can use this option multiple times to specify more than one
5733 metric to be extracted from this statistic file.
5735 =item B<Interval> I<Seconds>
5737 Configures the interval in which to read values from this instance / file.
5738 Defaults to the plugin's default interval.
5740 =item B<TimeFrom> I<Index>
5742 Rather than using the local time when dispatching a value, read the timestamp
5743 from the field with the zero-based index I<Index>. The value is interpreted as
5744 seconds since epoch. The value is parsed as a double and may be factional.
5750 =head2 Plugin C<teamspeak2>
5752 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
5753 polls interesting global and virtual server data. The plugin can query only one
5754 physical server but unlimited virtual servers. You can use the following
5755 options to configure it:
5759 =item B<Host> I<hostname/ip>
5761 The hostname or ip which identifies the physical server.
5764 =item B<Port> I<port>
5766 The query port of the physical server. This needs to be a string.
5769 =item B<Server> I<port>
5771 This option has to be added once for every virtual server the plugin should
5772 query. If you want to query the virtual server on port 8767 this is what the
5773 option would look like:
5777 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
5778 use quotes around it! If no such statement is given only global information
5783 =head2 Plugin C<ted>
5785 The I<TED> plugin connects to a device of "The Energy Detective", a device to
5786 measure power consumption. These devices are usually connected to a serial
5787 (RS232) or USB port. The plugin opens a configured device and tries to read the
5788 current energy readings. For more information on TED, visit
5789 L<http://www.theenergydetective.com/>.
5791 Available configuration options:
5795 =item B<Device> I<Path>
5797 Path to the device on which TED is connected. collectd will need read and write
5798 permissions on that file.
5800 Default: B</dev/ttyUSB0>
5802 =item B<Retries> I<Num>
5804 Apparently reading from TED is not that reliable. You can therefore configure a
5805 number of retries here. You only configure the I<retries> here, to if you
5806 specify zero, one reading will be performed (but no retries if that fails); if
5807 you specify three, a maximum of four readings are performed. Negative values
5814 =head2 Plugin C<tcpconns>
5816 The C<tcpconns plugin> counts the number of currently established TCP
5817 connections based on the local port and/or the remote port. Since there may be
5818 a lot of connections the default if to count all connections with a local port,
5819 for which a listening socket is opened. You can use the following options to
5820 fine-tune the ports you are interested in:
5824 =item B<ListeningPorts> I<true>|I<false>
5826 If this option is set to I<true>, statistics for all local ports for which a
5827 listening socket exists are collected. The default depends on B<LocalPort> and
5828 B<RemotePort> (see below): If no port at all is specifically selected, the
5829 default is to collect listening ports. If specific ports (no matter if local or
5830 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
5831 the selected ports will be collected unless this option is set to I<true>
5834 =item B<LocalPort> I<Port>
5836 Count the connections to a specific local port. This can be used to see how
5837 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
5838 You have to specify the port in numeric form, so for the mailserver example
5839 you'd need to set B<25>.
5841 =item B<RemotePort> I<Port>
5843 Count the connections to a specific remote port. This is useful to see how
5844 much a remote service is used. This is most useful if you want to know how many
5845 connections a local service has opened to remote services, e.E<nbsp>g. how many
5846 connections a mail server or news server has to other mail or news servers, or
5847 how many connections a web proxy holds to web servers. You have to give the
5848 port in numeric form.
5852 =head2 Plugin C<thermal>
5856 =item B<ForceUseProcfs> I<true>|I<false>
5858 By default, the I<Thermal plugin> tries to read the statistics from the Linux
5859 C<sysfs> interface. If that is not available, the plugin falls back to the
5860 C<procfs> interface. By setting this option to I<true>, you can force the
5861 plugin to use the latter. This option defaults to I<false>.
5863 =item B<Device> I<Device>
5865 Selects the name of the thermal device that you want to collect or ignore,
5866 depending on the value of the B<IgnoreSelected> option. This option may be
5867 used multiple times to specify a list of devices.
5869 =item B<IgnoreSelected> I<true>|I<false>
5871 Invert the selection: If set to true, all devices B<except> the ones that
5872 match the device names specified by the B<Device> option are collected. By
5873 default only selected devices are collected if a selection is made. If no
5874 selection is configured at all, B<all> devices are selected.
5878 =head2 Plugin C<threshold>
5880 The I<Threshold plugin> checks values collected or received by I<collectd>
5881 against a configurable I<threshold> and issues I<notifications> if values are
5884 Documentation for this plugin is available in the L<collectd-threshold(5)>
5887 =head2 Plugin C<tokyotyrant>
5889 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
5890 couple metrics: number of records, and database size on disk.
5894 =item B<Host> I<Hostname/IP>
5896 The hostname or ip which identifies the server.
5897 Default: B<127.0.0.1>
5899 =item B<Port> I<Service/Port>
5901 The query port of the server. This needs to be a string, even if the port is
5902 given in its numeric form.
5907 =head2 Plugin C<unixsock>
5911 =item B<SocketFile> I<Path>
5913 Sets the socket-file which is to be created.
5915 =item B<SocketGroup> I<Group>
5917 If running as root change the group of the UNIX-socket after it has been
5918 created. Defaults to B<collectd>.
5920 =item B<SocketPerms> I<Permissions>
5922 Change the file permissions of the UNIX-socket after it has been created. The
5923 permissions must be given as a numeric, octal value as you would pass to
5924 L<chmod(1)>. Defaults to B<0770>.
5926 =item B<DeleteSocket> B<false>|B<true>
5928 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
5929 with the given name already exists. If I<collectd> crashes a socket file may be
5930 left over, preventing the daemon from opening a new socket when restarted.
5931 Since this is potentially dangerous, this defaults to B<false>.
5935 =head2 Plugin C<uuid>
5937 This plugin, if loaded, causes the Hostname to be taken from the machine's
5938 UUID. The UUID is a universally unique designation for the machine, usually
5939 taken from the machine's BIOS. This is most useful if the machine is running in
5940 a virtual environment such as Xen, in which case the UUID is preserved across
5941 shutdowns and migration.
5943 The following methods are used to find the machine's UUID, in order:
5949 Check I</etc/uuid> (or I<UUIDFile>).
5953 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
5958 Check for UUID from C<dmidecode> / SMBIOS.
5962 Check for UUID from Xen hypervisor.
5966 If no UUID can be found then the hostname is not modified.
5970 =item B<UUIDFile> I<Path>
5972 Take the UUID from the given file (default I</etc/uuid>).
5976 =head2 Plugin C<varnish>
5978 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
5983 <Instance "example">
5985 CollectConnections true
5995 CollectWorkers false
5999 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
6000 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
6001 will collectd statistics from the default "varnishd" instance (this should work
6002 fine in most cases).
6004 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
6008 =item B<CollectCache> B<true>|B<false>
6010 Cache hits and misses. True by default.
6012 =item B<CollectConnections> B<true>|B<false>
6014 Number of client connections received, accepted and dropped. True by default.
6016 =item B<CollectBackend> B<true>|B<false>
6018 Back-end connection statistics, such as successful, reused,
6019 and closed connections. True by default.
6021 =item B<CollectSHM> B<true>|B<false>
6023 Statistics about the shared memory log, a memory region to store
6024 log messages which is flushed to disk when full. True by default.
6026 =item B<CollectBan> B<true>|B<false>
6028 Statistics about ban operations, such as number of bans added, retired, and
6029 number of objects tested against ban operations. Only available with Varnish
6030 3.x. False by default.
6032 =item B<CollectDirectorDNS> B<true>|B<false>
6034 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
6037 =item B<CollectESI> B<true>|B<false>
6039 Edge Side Includes (ESI) parse statistics. False by default.
6041 =item B<CollectFetch> B<true>|B<false>
6043 Statistics about fetches (HTTP requests sent to the backend). False by default.
6045 =item B<CollectHCB> B<true>|B<false>
6047 Inserts and look-ups in the crit bit tree based hash. Look-ups are
6048 divided into locked and unlocked look-ups. False by default.
6050 =item B<CollectObjects> B<true>|B<false>
6052 Statistics on cached objects: number of objects expired, nuked (prematurely
6053 expired), saved, moved, etc. False by default.
6055 =item B<CollectPurge> B<true>|B<false>
6057 Statistics about purge operations, such as number of purges added, retired, and
6058 number of objects tested against purge operations. Only available with Varnish
6059 2.x. False by default.
6061 =item B<CollectSession> B<true>|B<false>
6063 Client session statistics. Number of past and current sessions, session herd and
6064 linger counters, etc. False by default.
6066 =item B<CollectSMA> B<true>|B<false>
6068 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
6069 component is Solaris specific. Only available with Varnish 2.x. False by
6072 =item B<CollectSMS> B<true>|B<false>
6074 synth (synthetic content) storage statistics. This storage
6075 component is used internally only. False by default.
6077 =item B<CollectSM> B<true>|B<false>
6079 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
6082 =item B<CollectStruct> B<true>|B<false>
6084 Current varnish internal state statistics. Number of current sessions, objects
6085 in cache store, open connections to backends (with Varnish 2.x), etc. False by
6088 =item B<CollectTotals> B<true>|B<false>
6090 Collects overview counters, such as the number of sessions created,
6091 the number of requests and bytes transferred. False by default.
6093 =item B<CollectUptime> B<true>|B<false>
6095 Varnish uptime. False by default.
6097 =item B<CollectVCL> B<true>|B<false>
6099 Number of total (available + discarded) VCL (config files). False by default.
6101 =item B<CollectWorkers> B<true>|B<false>
6103 Collect statistics about worker threads. False by default.
6107 =head2 Plugin C<vmem>
6109 The C<vmem> plugin collects information about the usage of virtual memory.
6110 Since the statistics provided by the Linux kernel are very detailed, they are
6111 collected very detailed. However, to get all the details, you have to switch
6112 them on manually. Most people just want an overview over, such as the number of
6113 pages read from swap space.
6117 =item B<Verbose> B<true>|B<false>
6119 Enables verbose collection of information. This will start collecting page
6120 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
6121 Part of these statistics are collected on a "per zone" basis.
6125 =head2 Plugin C<vserver>
6127 This plugin doesn't have any options. B<VServer> support is only available for
6128 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
6129 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
6130 need to apply the patches and compile your own kernel, which will then provide
6131 the F</proc/virtual> filesystem that is required by this plugin.
6133 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
6135 B<Note>: The traffic collected by this plugin accounts for the amount of
6136 traffic passing a socket which might be a lot less than the actual on-wire
6137 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
6138 collect on-wire traffic you could, for example, use the logging facilities of
6139 iptables to feed data for the guest IPs into the iptables plugin.
6141 =head2 Plugin C<write_graphite>
6143 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
6144 storage and graphing project. The plugin connects to I<Carbon>, the data layer
6145 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
6146 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
6147 of at most 1428 bytes to minimize the number of network packets.
6151 <Plugin write_graphite>
6161 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6162 blocks. Inside the B<Node> blocks, the following options are recognized:
6166 =item B<Host> I<Address>
6168 Hostname or address to connect to. Defaults to C<localhost>.
6170 =item B<Port> I<Service>
6172 Service name or port number to connect to. Defaults to C<2003>.
6174 =item B<Protocol> I<String>
6176 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
6178 =item B<LogSendErrors> B<false>|B<true>
6180 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
6181 If set to B<false>, it will not log the errors. This is especially useful when
6182 using Protocol UDP since many times we want to use the "fire-and-forget"
6183 approach and logging errors fills syslog with unneeded messages.
6185 =item B<Prefix> I<String>
6187 When set, I<String> is added in front of the host name. Dots and whitespace are
6188 I<not> escaped in this string (see B<EscapeCharacter> below).
6190 =item B<Postfix> I<String>
6192 When set, I<String> is appended to the host name. Dots and whitespace are
6193 I<not> escaped in this string (see B<EscapeCharacter> below).
6195 =item B<EscapeCharacter> I<Char>
6197 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
6198 in the identifier. The B<EscapeCharacter> option determines which character
6199 dots, whitespace and control characters are replaced with. Defaults to
6202 =item B<StoreRates> B<false>|B<true>
6204 If set to B<true> (the default), convert counter values to rates. If set to
6205 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6208 =item B<SeparateInstances> B<false>|B<true>
6210 If set to B<true>, the plugin instance and type instance will be in their own
6211 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6212 default), the plugin and plugin instance (and likewise the type and type
6213 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6215 =item B<AlwaysAppendDS> B<false>|B<true>
6217 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
6218 identifier. If set to B<false> (the default), this is only done when there is
6223 =head2 Plugin C<write_mongodb>
6225 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
6230 <Plugin "write_mongodb">
6239 The plugin can send values to multiple instances of I<MongoDB> by specifying
6240 one B<Node> block for each instance. Within the B<Node> blocks, the following
6241 options are available:
6245 =item B<Host> I<Address>
6247 Hostname or address to connect to. Defaults to C<localhost>.
6249 =item B<Port> I<Service>
6251 Service name or port number to connect to. Defaults to C<27017>.
6253 =item B<Timeout> I<Timeout>
6255 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
6256 Setting this option to zero means no timeout, which is the default.
6258 =item B<StoreRates> B<false>|B<true>
6260 If set to B<true> (the default), convert counter values to rates. If set to
6261 B<false> counter values are stored as is, i.e. as an increasing integer
6264 =item B<Database> I<Database>
6266 =item B<User> I<User>
6268 =item B<Password> I<Password>
6270 Sets the information used when authenticating to a I<MongoDB> database. The
6271 fields are optional (in which case no authentication is attempted), but if you
6272 want to use authentication all three fields must be set.
6276 =head2 Plugin C<write_http>
6278 This output plugin submits values to an http server by POST them using the
6279 PUTVAL plain-text protocol. Each destination you want to post data to needs to
6280 have one B<URL> block, within which the destination can be configured further,
6281 for example by specifying authentication data.
6285 <Plugin "write_http">
6286 <URL "http://example.com/post-collectd">
6292 B<URL> blocks need one string argument which is used as the URL to which data
6293 is posted. The following options are understood within B<URL> blocks.
6297 =item B<User> I<Username>
6299 Optional user name needed for authentication.
6301 =item B<Password> I<Password>
6303 Optional password needed for authentication.
6305 =item B<VerifyPeer> B<true>|B<false>
6307 Enable or disable peer SSL certificate verification. See
6308 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
6310 =item B<VerifyHost> B<true|false>
6312 Enable or disable peer host name verification. If enabled, the plugin checks if
6313 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
6314 matches the host name provided by the B<URL> option. If this identity check
6315 fails, the connection is aborted. Obviously, only works when connecting to a
6316 SSL enabled server. Enabled by default.
6318 =item B<CACert> I<File>
6320 File that holds one or more SSL certificates. If you want to use HTTPS you will
6321 possibly need this option. What CA certificates come bundled with C<libcurl>
6322 and are checked by default depends on the distribution you use.
6324 =item B<Format> B<Command>|B<JSON>
6326 Format of the output to generate. If set to B<Command>, will create output that
6327 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
6328 create output in the I<JavaScript Object Notation> (JSON).
6330 Defaults to B<Command>.
6332 =item B<StoreRates> B<true|false>
6334 If set to B<true>, convert counter values to rates. If set to B<false> (the
6335 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
6340 =head2 Plugin C<write_riemann>
6342 The I<write_riemann plugin> will send values to I<Riemann>, a powerfull stream
6343 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
6344 I<Riemann> using UDP packets.
6348 <Plugin "write_riemann">
6354 AlwaysAppendDS false
6358 Attribute "foo" "bar"
6361 The following options are understood by the I<write_riemann plugin>:
6365 =item E<lt>B<Node> I<Name>E<gt>
6367 The plugin's configuration consists of one or more B<Node> blocks. Each block
6368 is given a unique I<Name> and specifies one connection to an instance of
6369 I<Riemann>. Indise the B<Node> block, the following per-connection options are
6374 =item B<Host> I<Address>
6376 Hostname or address to connect to. Defaults to C<localhost>.
6378 =item B<Port> I<Service>
6380 Service name or port number to connect to. Defaults to C<5555>.
6382 =item B<Protocol> B<UDP>|B<TCP>
6384 Specify the protocol to use when communicating with I<Riemann>. Defaults to
6387 =item B<StoreRates> B<true>|B<false>
6389 If set to B<true> (the default), convert counter values to rates. If set to
6390 B<false> counter values are stored as is, i.e. as an increasing integer number.
6392 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
6393 converted values will have "rate" appended to the data source type, e.g.
6394 C<ds_type:derive:rate>.
6396 =item B<AlwaysAppendDS> B<false>|B<true>
6398 If set the B<true>, append the name of the I<Data Source> (DS) to the
6399 "service", i.e. the field that, together with the "host" field, uniquely
6400 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
6401 only done when there is more than one DS.
6403 =item B<TTLFactor> I<Factor>
6405 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
6406 event is considered active. I<collectd> populates this field based on the
6407 metrics interval setting. This setting controls the factor with which the
6408 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
6409 know exactly what you're doing, you should only increase this setting from its
6414 =item B<Tag> I<String>
6416 Add the given string as an additional tag to the metric being sent to
6419 =item B<Attribute> I<String> I<String>
6421 Consider the two given strings to be the key and value of an additional
6422 attribute for each metric being sent out to I<Riemann>.
6426 =head1 THRESHOLD CONFIGURATION
6428 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
6429 we mean that the values are not only stored or sent somewhere, but that they
6430 are judged and, if a problem is recognized, acted upon. The only action
6431 collectd takes itself is to generate and dispatch a "notification". Plugins can
6432 register to receive notifications and perform appropriate further actions.
6434 Since systems and what you expect them to do differ a lot, you can configure
6435 B<thresholds> for your values freely. This gives you a lot of flexibility but
6436 also a lot of responsibility.
6438 Every time a value is out of range a notification is dispatched. This means
6439 that the idle percentage of your CPU needs to be less then the configured
6440 threshold only once for a notification to be generated. There's no such thing
6441 as a moving average or similar - at least not now.
6443 Also, all values that match a threshold are considered to be relevant or
6444 "interesting". As a consequence collectd will issue a notification if they are
6445 not received for B<Timeout> iterations. The B<Timeout> configuration option is
6446 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
6447 "2" (the default) and some hosts sends it's CPU statistics to the server every
6448 60 seconds, a notification will be dispatched after about 120 seconds. It may
6449 take a little longer because the timeout is checked only once each B<Interval>
6452 When a value comes within range again or is received after it was missing, an
6453 "OKAY-notification" is dispatched.
6455 Here is a configuration example to get you started. Read below for more
6468 <Plugin "interface">
6485 WarningMin 100000000
6491 There are basically two types of configuration statements: The C<Host>,
6492 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
6493 configured. The C<Plugin> and C<Type> blocks may be specified further using the
6494 C<Instance> option. You can combine the block by nesting the blocks, though
6495 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
6496 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
6497 C<Type> may not contain other blocks. If multiple blocks apply to the same
6498 value the most specific block is used.
6500 The other statements specify the threshold to configure. They B<must> be
6501 included in a C<Type> block. Currently the following statements are recognized:
6505 =item B<FailureMax> I<Value>
6507 =item B<WarningMax> I<Value>
6509 Sets the upper bound of acceptable values. If unset defaults to positive
6510 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
6511 will be created. If the value is greater than B<WarningMax> but less than (or
6512 equal to) B<FailureMax> a B<WARNING> notification will be created.
6514 =item B<FailureMin> I<Value>
6516 =item B<WarningMin> I<Value>
6518 Sets the lower bound of acceptable values. If unset defaults to negative
6519 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
6520 be created. If the value is less than B<WarningMin> but greater than (or equal
6521 to) B<FailureMin> a B<WARNING> notification will be created.
6523 =item B<DataSource> I<DSName>
6525 Some data sets have more than one "data source". Interesting examples are the
6526 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
6527 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
6528 system load data set, C<load>, even has three data sources: C<shortterm>,
6529 C<midterm>, and C<longterm>.
6531 Normally, all data sources are checked against a configured threshold. If this
6532 is undesirable, or if you want to specify different limits for each data
6533 source, you can use the B<DataSource> option to have a threshold apply only to
6536 =item B<Invert> B<true>|B<false>
6538 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
6539 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
6540 B<WarningMax>) are not okay. Defaults to B<false>.
6542 =item B<Persist> B<true>|B<false>
6544 Sets how often notifications are generated. If set to B<true> one notification
6545 will be generated for each value that is out of the acceptable range. If set to
6546 B<false> (the default) then a notification is only generated if a value is out
6547 of range but the previous value was okay.
6549 This applies to missing values, too: If set to B<true> a notification about a
6550 missing value is generated once every B<Interval> seconds. If set to B<false>
6551 only one such notification is generated until the value appears again.
6553 =item B<Percentage> B<true>|B<false>
6555 If set to B<true>, the minimum and maximum values given are interpreted as
6556 percentage value, relative to the other data sources. This is helpful for
6557 example for the "df" type, where you may want to issue a warning when less than
6558 5E<nbsp>% of the total space is available. Defaults to B<false>.
6560 =item B<Hits> I<Number>
6562 Delay creating the notification until the threshold has been passed I<Number>
6563 times. When a notification has been generated, or when a subsequent value is
6564 inside the threshold, the counter is reset. If, for example, a value is
6565 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
6566 will be dispatched at most once every 30E<nbsp>seconds.
6568 This is useful when short bursts are not a problem. If, for example, 100% CPU
6569 usage for up to a minute is normal (and data is collected every
6570 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
6572 =item B<Hysteresis> I<Number>
6574 When set to non-zero, a hysteresis value is applied when checking minimum and
6575 maximum bounds. This is useful for values that increase slowly and fluctuate a
6576 bit while doing so. When these values come close to the threshold, they may
6577 "flap", i.e. switch between failure / warning case and okay case repeatedly.
6579 If, for example, the threshold is configures as
6584 then a I<Warning> notification is created when the value exceeds I<101> and the
6585 corresponding I<Okay> notification is only created once the value falls below
6586 I<99>, thus avoiding the "flapping".
6590 =head1 FILTER CONFIGURATION
6592 Starting with collectd 4.6 there is a powerful filtering infrastructure
6593 implemented in the daemon. The concept has mostly been copied from
6594 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
6595 terminology, so that users that are familiar with iptables feel right at home.
6599 The following are the terms used in the remainder of the filter configuration
6600 documentation. For an ASCII-art schema of the mechanism, see
6601 L<"General structure"> below.
6607 A I<match> is a criteria to select specific values. Examples are, of course, the
6608 name of the value or it's current value.
6610 Matches are implemented in plugins which you have to load prior to using the
6611 match. The name of such plugins starts with the "match_" prefix.
6615 A I<target> is some action that is to be performed with data. Such actions
6616 could, for example, be to change part of the value's identifier or to ignore
6617 the value completely.
6619 Some of these targets are built into the daemon, see L<"Built-in targets">
6620 below. Other targets are implemented in plugins which you have to load prior to
6621 using the target. The name of such plugins starts with the "target_" prefix.
6625 The combination of any number of matches and at least one target is called a
6626 I<rule>. The target actions will be performed for all values for which B<all>
6627 matches apply. If the rule does not have any matches associated with it, the
6628 target action will be performed for all values.
6632 A I<chain> is a list of rules and possibly default targets. The rules are tried
6633 in order and if one matches, the associated target will be called. If a value
6634 is handled by a rule, it depends on the target whether or not any subsequent
6635 rules are considered or if traversal of the chain is aborted, see
6636 L<"Flow control"> below. After all rules have been checked, the default targets
6641 =head2 General structure
6643 The following shows the resulting structure:
6650 +---------+ +---------+ +---------+ +---------+
6651 ! Rule !->! Match !->! Match !->! Target !
6652 +---------+ +---------+ +---------+ +---------+
6655 +---------+ +---------+ +---------+
6656 ! Rule !->! Target !->! Target !
6657 +---------+ +---------+ +---------+
6664 +---------+ +---------+ +---------+
6665 ! Rule !->! Match !->! Target !
6666 +---------+ +---------+ +---------+
6676 There are four ways to control which way a value takes through the filter
6683 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
6684 process the value with another chain. When the called chain finishes, usually
6685 the next target or rule after the jump is executed.
6689 The stop condition, signaled for example by the built-in target B<stop>, causes
6690 all processing of the value to be stopped immediately.
6694 Causes processing in the current chain to be aborted, but processing of the
6695 value generally will continue. This means that if the chain was called via
6696 B<Jump>, the next target or rule after the jump will be executed. If the chain
6697 was not called by another chain, control will be returned to the daemon and it
6698 may pass the value to another chain.
6702 Most targets will signal the B<continue> condition, meaning that processing
6703 should continue normally. There is no special built-in target for this
6710 The configuration reflects this structure directly:
6712 PostCacheChain "PostCache"
6714 <Rule "ignore_mysql_show">
6717 Type "^mysql_command$"
6718 TypeInstance "^show_"
6728 The above configuration example will ignore all values where the plugin field
6729 is "mysql", the type is "mysql_command" and the type instance begins with
6730 "show_". All other values will be sent to the C<rrdtool> write plugin via the
6731 default target of the chain. Since this chain is run after the value has been
6732 added to the cache, the MySQL C<show_*> command statistics will be available
6733 via the C<unixsock> plugin.
6735 =head2 List of configuration options
6739 =item B<PreCacheChain> I<ChainName>
6741 =item B<PostCacheChain> I<ChainName>
6743 Configure the name of the "pre-cache chain" and the "post-cache chain". The
6744 argument is the name of a I<chain> that should be executed before and/or after
6745 the values have been added to the cache.
6747 To understand the implications, it's important you know what is going on inside
6748 I<collectd>. The following diagram shows how values are passed from the
6749 read-plugins to the write-plugins:
6755 + - - - - V - - - - +
6756 : +---------------+ :
6759 : +-------+-------+ :
6762 : +-------+-------+ : +---------------+
6763 : ! Cache !--->! Value Cache !
6764 : ! insert ! : +---+---+-------+
6765 : +-------+-------+ : ! !
6766 : ! ,------------' !
6768 : +-------+---+---+ : +-------+-------+
6769 : ! Post-Cache +--->! Write-Plugins !
6770 : ! Chain ! : +---------------+
6771 : +---------------+ :
6774 + - - - - - - - - - +
6776 After the values are passed from the "read" plugins to the dispatch functions,
6777 the pre-cache chain is run first. The values are added to the internal cache
6778 afterwards. The post-cache chain is run after the values have been added to the
6779 cache. So why is it such a huge deal if chains are run before or after the
6780 values have been added to this cache?
6782 Targets that change the identifier of a value list should be executed before
6783 the values are added to the cache, so that the name in the cache matches the
6784 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
6785 this cache to receive a list of all available values. If you change the
6786 identifier after the value list has been added to the cache, this may easily
6787 lead to confusion, but it's not forbidden of course.
6789 The cache is also used to convert counter values to rates. These rates are, for
6790 example, used by the C<value> match (see below). If you use the rate stored in
6791 the cache B<before> the new value is added, you will use the old, B<previous>
6792 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
6793 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
6796 Last but not last, the B<stop> target makes a difference: If the pre-cache
6797 chain returns the stop condition, the value will not be added to the cache and
6798 the post-cache chain will not be run.
6800 =item B<Chain> I<Name>
6802 Adds a new chain with a certain name. This name can be used to refer to a
6803 specific chain, for example to jump to it.
6805 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
6807 =item B<Rule> [I<Name>]
6809 Adds a new rule to the current chain. The name of the rule is optional and
6810 currently has no meaning for the daemon.
6812 Within the B<Rule> block, there may be any number of B<Match> blocks and there
6813 must be at least one B<Target> block.
6815 =item B<Match> I<Name>
6817 Adds a match to a B<Rule> block. The name specifies what kind of match should
6818 be performed. Available matches depend on the plugins that have been loaded.
6820 The arguments inside the B<Match> block are passed to the plugin implementing
6821 the match, so which arguments are valid here depends on the plugin being used.
6822 If you do not need any to pass any arguments to a match, you can use the
6827 Which is equivalent to:
6832 =item B<Target> I<Name>
6834 Add a target to a rule or a default target to a chain. The name specifies what
6835 kind of target is to be added. Which targets are available depends on the
6836 plugins being loaded.
6838 The arguments inside the B<Target> block are passed to the plugin implementing
6839 the target, so which arguments are valid here depends on the plugin being used.
6840 If you do not need any to pass any arguments to a target, you can use the
6845 This is the same as writing:
6852 =head2 Built-in targets
6854 The following targets are built into the core daemon and therefore need no
6855 plugins to be loaded:
6861 Signals the "return" condition, see the L<"Flow control"> section above. This
6862 causes the current chain to stop processing the value and returns control to
6863 the calling chain. The calling chain will continue processing targets and rules
6864 just after the B<jump> target (see below). This is very similar to the
6865 B<RETURN> target of iptables, see L<iptables(8)>.
6867 This target does not have any options.
6875 Signals the "stop" condition, see the L<"Flow control"> section above. This
6876 causes processing of the value to be aborted immediately. This is similar to
6877 the B<DROP> target of iptables, see L<iptables(8)>.
6879 This target does not have any options.
6887 Sends the value to "write" plugins.
6893 =item B<Plugin> I<Name>
6895 Name of the write plugin to which the data should be sent. This option may be
6896 given multiple times to send the data to more than one write plugin.
6900 If no plugin is explicitly specified, the values will be sent to all available
6911 Starts processing the rules of another chain, see L<"Flow control"> above. If
6912 the end of that chain is reached, or a stop condition is encountered,
6913 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
6914 next target or the next rule. This is similar to the B<-j> command line option
6915 of iptables, see L<iptables(8)>.
6921 =item B<Chain> I<Name>
6923 Jumps to the chain I<Name>. This argument is required and may appear only once.
6935 =head2 Available matches
6941 Matches a value using regular expressions.
6947 =item B<Host> I<Regex>
6949 =item B<Plugin> I<Regex>
6951 =item B<PluginInstance> I<Regex>
6953 =item B<Type> I<Regex>
6955 =item B<TypeInstance> I<Regex>
6957 Match values where the given regular expressions match the various fields of
6958 the identifier of a value. If multiple regular expressions are given, B<all>
6959 regexen must match for a value to match.
6961 =item B<Invert> B<false>|B<true>
6963 When set to B<true>, the result of the match is inverted, i.e. all value lists
6964 where all regular expressions apply are not matched, all other value lists are
6965 matched. Defaults to B<false>.
6972 Host "customer[0-9]+"
6978 Matches values that have a time which differs from the time on the server.
6980 This match is mainly intended for servers that receive values over the
6981 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
6982 is very sensitive to the timestamp used when updating the RRD files. In
6983 particular, the time must be ever increasing. If a misbehaving client sends one
6984 packet with a timestamp far in the future, all further packets with a correct
6985 time will be ignored because of that one packet. What's worse, such corrupted
6986 RRD files are hard to fix.
6988 This match lets one match all values B<outside> a specified time range
6989 (relative to the server's time), so you can use the B<stop> target (see below)
6990 to ignore the value, for example.
6996 =item B<Future> I<Seconds>
6998 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
6999 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7002 =item B<Past> I<Seconds>
7004 Matches all values that are I<behind> of the server's time by I<Seconds> or
7005 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7017 This example matches all values that are five minutes or more ahead of the
7018 server or one hour (or more) lagging behind.
7022 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
7023 values. If a data-set consists of more than one data-source, all data-sources
7024 must match the specified ranges for a positive match.
7030 =item B<Min> I<Value>
7032 Sets the smallest value which still results in a match. If unset, behaves like
7035 =item B<Max> I<Value>
7037 Sets the largest value which still results in a match. If unset, behaves like
7040 =item B<Invert> B<true>|B<false>
7042 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
7043 no-match is returned and vice versa. Please note that the B<Invert> setting
7044 only effects how B<Min> and B<Max> are applied to a specific value. Especially
7045 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
7047 =item B<DataSource> I<DSName> [I<DSName> ...]
7049 Select one or more of the data sources. If no data source is configured, all
7050 data sources will be checked. If the type handled by the match does not have a
7051 data source of the specified name(s), this will always result in no match
7052 (independent of the B<Invert> setting).
7054 =item B<Satisfy> B<Any>|B<All>
7056 Specifies how checking with several data sources is performed. If set to
7057 B<Any>, the match succeeds if one of the data sources is in the configured
7058 range. If set to B<All> the match only succeeds if all data sources are within
7059 the configured range. Default is B<All>.
7061 Usually B<All> is used for positive matches, B<Any> is used for negative
7062 matches. This means that with B<All> you usually check that all values are in a
7063 "good" range, while with B<Any> you check if any value is within a "bad" range
7064 (or outside the "good" range).
7068 Either B<Min> or B<Max>, but not both, may be unset.
7072 # Match all values smaller than or equal to 100. Matches only if all data
7073 # sources are below 100.
7079 # Match if the value of any data source is outside the range of 0 - 100.
7087 =item B<empty_counter>
7089 Matches all values with one or more data sources of type B<COUNTER> and where
7090 all counter values are zero. These counters usually I<never> increased since
7091 they started existing (and are therefore uninteresting), or got reset recently
7092 or overflowed and you had really, I<really> bad luck.
7094 Please keep in mind that ignoring such counters can result in confusing
7095 behavior: Counters which hardly ever increase will be zero for long periods of
7096 time. If the counter is reset for some reason (machine or service restarted,
7097 usually), the graph will be empty (NAN) for a long time. People may not
7102 Calculates a hash value of the host name and matches values according to that
7103 hash value. This makes it possible to divide all hosts into groups and match
7104 only values that are in a specific group. The intended use is in load
7105 balancing, where you want to handle only part of all data and leave the rest
7108 The hashing function used tries to distribute the hosts evenly. First, it
7109 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
7112 for (i = 0; host[i] != 0; i++)
7113 hash_value = (hash_value * 251) + host[i];
7115 The constant 251 is a prime number which is supposed to make this hash value
7116 more random. The code then checks the group for this host according to the
7117 I<Total> and I<Match> arguments:
7119 if ((hash_value % Total) == Match)
7124 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
7125 groups), then the least significant bit of the hash value will be the XOR of
7126 all least significant bits in the host name. One consequence is that when you
7127 have two hosts, "server0.example.com" and "server1.example.com", where the host
7128 name differs in one digit only and the digits differ by one, those hosts will
7129 never end up in the same group.
7135 =item B<Match> I<Match> I<Total>
7137 Divide the data into I<Total> groups and match all hosts in group I<Match> as
7138 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
7139 be smaller than I<Total>. I<Total> must be at least one, although only values
7140 greater than one really do make any sense.
7142 You can repeat this option to match multiple groups, for example:
7147 The above config will divide the data into seven groups and match groups three
7148 and five. One use would be to keep every value on two hosts so that if one
7149 fails the missing data can later be reconstructed from the second host.
7155 # Operate on the pre-cache chain, so that ignored values are not even in the
7160 # Divide all received hosts in seven groups and accept all hosts in
7164 # If matched: Return and continue.
7167 # If not matched: Return and stop.
7173 =head2 Available targets
7177 =item B<notification>
7179 Creates and dispatches a notification.
7185 =item B<Message> I<String>
7187 This required option sets the message of the notification. The following
7188 placeholders will be replaced by an appropriate value:
7196 =item B<%{plugin_instance}>
7200 =item B<%{type_instance}>
7202 These placeholders are replaced by the identifier field of the same name.
7204 =item B<%{ds:>I<name>B<}>
7206 These placeholders are replaced by a (hopefully) human readable representation
7207 of the current rate of this data source. If you changed the instance name
7208 (using the B<set> or B<replace> targets, see below), it may not be possible to
7209 convert counter values to rates.
7213 Please note that these placeholders are B<case sensitive>!
7215 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
7217 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
7224 <Target "notification">
7225 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
7231 Replaces parts of the identifier using regular expressions.
7237 =item B<Host> I<Regex> I<Replacement>
7239 =item B<Plugin> I<Regex> I<Replacement>
7241 =item B<PluginInstance> I<Regex> I<Replacement>
7243 =item B<TypeInstance> I<Regex> I<Replacement>
7245 Match the appropriate field with the given regular expression I<Regex>. If the
7246 regular expression matches, that part that matches is replaced with
7247 I<Replacement>. If multiple places of the input buffer match a given regular
7248 expression, only the first occurrence will be replaced.
7250 You can specify each option multiple times to use multiple regular expressions
7258 # Replace "example.net" with "example.com"
7259 Host "\\<example.net\\>" "example.com"
7261 # Strip "www." from hostnames
7267 Sets part of the identifier of a value to a given string.
7273 =item B<Host> I<String>
7275 =item B<Plugin> I<String>
7277 =item B<PluginInstance> I<String>
7279 =item B<TypeInstance> I<String>
7281 Set the appropriate field to the given string. The strings for plugin instance
7282 and type instance may be empty, the strings for host and plugin may not be
7283 empty. It's currently not possible to set the type of a value this way.
7290 PluginInstance "coretemp"
7291 TypeInstance "core3"
7296 =head2 Backwards compatibility
7298 If you use collectd with an old configuration, i.E<nbsp>e. one without a
7299 B<Chain> block, it will behave as it used to. This is equivalent to the
7300 following configuration:
7306 If you specify a B<PostCacheChain>, the B<write> target will not be added
7307 anywhere and you will have to make sure that it is called where appropriate. We
7308 suggest to add the above snippet as default target to your "PostCache" chain.
7312 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
7328 L<collectd-exec(5)>,
7329 L<collectd-perl(5)>,
7330 L<collectd-unixsock(5)>,
7343 Florian Forster E<lt>octo@verplant.orgE<gt>