5 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
9 BaseDir "/path/to/data/"
10 PIDFile "/path/to/pidfile/collectd.pid"
11 Server "123.123.123.123" 12345
28 This config file controls how the system statistics collection daemon
29 B<collectd> behaves. The most significant option is B<LoadPlugin>, which
30 controls which plugins to load. These plugins ultimately define collectd's
33 The syntax of this config file is similar to the config file of the famous
34 I<Apache> webserver. Each line contains either an option (a key and a list of
35 one or more values) or a section-start or -end. Empty lines and everything
36 after a non-quoted hash-symbol (C<#>) is ignored. I<Keys> are unquoted
37 strings, consisting only of alphanumeric characters and the underscore (C<_>)
38 character. Keys are handled case insensitive by I<collectd> itself and all
39 plugins included with it. I<Values> can either be an I<unquoted string>, a
40 I<quoted string> (enclosed in double-quotes) a I<number> or a I<boolean>
41 expression. I<Unquoted strings> consist of only alphanumeric characters and
42 underscores (C<_>) and do not need to be quoted. I<Quoted strings> are
43 enclosed in double quotes (C<">). You can use the backslash character (C<\>)
44 to include double quotes as part of the string. I<Numbers> can be specified in
45 decimal and floating point format (using a dot C<.> as decimal separator),
46 hexadecimal when using the C<0x> prefix and octal with a leading zero (C<0>).
47 I<Boolean> values are either B<true> or B<false>.
49 Lines may be wrapped by using C<\> as the last character before the newline.
50 This allows long lines to be split into multiple lines. Quoted strings may be
51 wrapped as well. However, those are treated special in that whitespace at the
52 beginning of the following lines will be ignored, which allows for nicely
53 indenting the wrapped lines.
55 The configuration is read and processed in order, i.e. from top to bottom. So
56 the plugins are loaded in the order listed in this config file. It is a good
57 idea to load any logging plugins first in order to catch messages from plugins
58 during configuration. Also, the C<LoadPlugin> option B<must> occur B<before>
59 the appropriate C<E<lt>Plugin ...E<gt>> block.
65 =item B<BaseDir> I<Directory>
67 Sets the base directory. This is the directory beneath all RRD-files are
68 created. Possibly more subdirectories are created. This is also the working
69 directory for the daemon.
71 =item B<LoadPlugin> I<Plugin>
73 Loads the plugin I<Plugin>. This is required to load plugins, unless the
74 B<AutoLoadPlugin> option is enabled (see below). Without any loaded plugins,
75 I<collectd> will be mostly useless.
77 Only the first B<LoadPlugin> statement or block for a given plugin name has any
78 effect. This is useful when you want to split up the configuration into smaller
79 files and want each file to be "self contained", i.e. it contains a B<Plugin>
80 block I<and> then appropriate B<LoadPlugin> statement. The downside is that if
81 you have multiple conflicting B<LoadPlugin> blocks, e.g. when they specify
82 different intervals, only one of them (the first one encountered) will take
83 effect and all others will be silently ignored.
85 B<LoadPlugin> may either be a simple configuration I<statement> or a I<block>
86 with additional options, affecting the behavior of B<LoadPlugin>. A simple
87 statement looks like this:
91 Options inside a B<LoadPlugin> block can override default settings and
92 influence the way plugins are loaded, e.g.:
99 The following options are valid inside B<LoadPlugin> blocks:
103 =item B<Globals> B<true|false>
105 If enabled, collectd will export all global symbols of the plugin (and of all
106 libraries loaded as dependencies of the plugin) and, thus, makes those symbols
107 available for resolving unresolved symbols in subsequently loaded plugins if
108 that is supported by your system.
110 This is useful (or possibly even required), e.g., when loading a plugin that
111 embeds some scripting language into the daemon (e.g. the I<Perl> and
112 I<Python plugins>). Scripting languages usually provide means to load
113 extensions written in C. Those extensions require symbols provided by the
114 interpreter, which is loaded as a dependency of the respective collectd plugin.
115 See the documentation of those plugins (e.g., L<collectd-perl(5)> or
116 L<collectd-python(5)>) for details.
118 By default, this is disabled. As a special exception, if the plugin name is
119 either C<perl> or C<python>, the default is changed to enabled in order to keep
120 the average user from ever having to deal with this low level linking stuff.
122 =item B<Interval> I<Seconds>
124 Sets a plugin-specific interval for collecting metrics. This overrides the
125 global B<Interval> setting. If a plugin provides own support for specifying an
126 interval, that setting will take precedence.
130 =item B<AutoLoadPlugin> B<false>|B<true>
132 When set to B<false> (the default), each plugin needs to be loaded explicitly,
133 using the B<LoadPlugin> statement documented above. If a
134 B<E<lt>PluginE<nbsp>...E<gt>> block is encountered and no configuration
135 handling callback for this plugin has been registered, a warning is logged and
136 the block is ignored.
138 When set to B<true>, explicit B<LoadPlugin> statements are not required. Each
139 B<E<lt>PluginE<nbsp>...E<gt>> block acts as if it was immediately preceded by a
140 B<LoadPlugin> statement. B<LoadPlugin> statements are still required for
141 plugins that don't provide any configuration, e.g. the I<Load plugin>.
143 =item B<Include> I<Path> [I<pattern>]
145 If I<Path> points to a file, includes that file. If I<Path> points to a
146 directory, recursively includes all files within that directory and its
147 subdirectories. If the C<wordexp> function is available on your system,
148 shell-like wildcards are expanded before files are included. This means you can
149 use statements like the following:
151 Include "/etc/collectd.d/*.conf"
153 Starting with version 5.3, this may also be a block in which further options
154 affecting the behavior of B<Include> may be specified. The following option is
157 <Include "/etc/collectd.d">
163 =item B<Filter> I<pattern>
165 If the C<fnmatch> function is available on your system, a shell-like wildcard
166 I<pattern> may be specified to filter which files to include. This may be used
167 in combination with recursively including a directory to easily be able to
168 arbitrarily mix configuration files and other documents (e.g. README files).
169 The given example is similar to the first example above but includes all files
170 matching C<*.conf> in any subdirectory of C</etc/collectd.d>:
172 Include "/etc/collectd.d" "*.conf"
176 If more than one files are included by a single B<Include> option, the files
177 will be included in lexicographical order (as defined by the C<strcmp>
178 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
179 order in which the files are loaded.
181 To prevent loops and shooting yourself in the foot in interesting ways the
182 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
183 most uses. Since symlinks are followed it is still possible to crash the daemon
184 by looping symlinks. In our opinion significant stupidity should result in an
185 appropriate amount of pain.
187 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
188 file, but you cannot include files from within blocks.
190 =item B<PIDFile> I<File>
192 Sets where to write the PID file to. This file is overwritten when it exists
193 and deleted when the program is stopped. Some init-scripts might override this
194 setting using the B<-P> command-line option.
196 =item B<PluginDir> I<Directory>
198 Path to the plugins (shared objects) of collectd.
200 =item B<TypesDB> I<File> [I<File> ...]
202 Set one or more files that contain the data-set descriptions. See
203 L<types.db(5)> for a description of the format of this file.
205 =item B<Interval> I<Seconds>
207 Configures the interval in which to query the read plugins. Obviously smaller
208 values lead to a higher system load produced by collectd, while higher values
209 lead to more coarse statistics.
211 B<Warning:> You should set this once and then never touch it again. If you do,
212 I<you will have to delete all your RRD files> or know some serious RRDtool
213 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
215 =item B<Timeout> I<Iterations>
217 Consider a value list "missing" when no update has been read or received for
218 I<Iterations> iterations. By default, I<collectd> considers a value list
219 missing when no update has been received for twice the update interval. Since
220 this setting uses iterations, the maximum allowed time without update depends
221 on the I<Interval> information contained in each value list. This is used in
222 the I<Threshold> configuration to dispatch notifications about missing values,
223 see L<collectd-threshold(5)> for details.
225 =item B<ReadThreads> I<Num>
227 Number of threads to start for reading plugins. The default value is B<5>, but
228 you may want to increase this if you have more than five plugins that take a
229 long time to read. Mostly those are plugins that do network-IO. Setting this to
230 a value higher than the number of registered read callbacks is not recommended.
232 =item B<WriteThreads> I<Num>
234 Number of threads to start for dispatching value lists to write plugins. The
235 default value is B<5>, but you may want to increase this if you have more than
236 five plugins that may take relatively long to write to.
238 =item B<WriteQueueLimitHigh> I<HighNum>
240 =item B<WriteQueueLimitLow> I<LowNum>
242 Metrics are read by the I<read threads> and then put into a queue to be handled
243 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
244 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
245 running into memory issues in such a case, you can limit the size of this
248 By default, there is no limit and memory may grow indefinitely. This is most
249 likely not an issue for clients, i.e. instances that only handle the local
250 metrics. For servers it is recommended to set this to a non-zero value, though.
252 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
253 Each of them takes a numerical argument which is the number of metrics in the
254 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
255 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
256 I<will> be enqueued. If the number of metrics currently in the queue is between
257 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
258 proportional to the number of metrics in the queue (i.e. it increases linearly
259 until it reaches 100%.)
261 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
262 unset, the latter will default to half of B<WriteQueueLimitHigh>.
264 If you do not want to randomly drop values when the queue size is between
265 I<LowNum> and I<HighNum>, set If B<WriteQueueLimitHigh> and
266 B<WriteQueueLimitLow> to same value.
268 =item B<Hostname> I<Name>
270 Sets the hostname that identifies a host. If you omit this setting, the
271 hostname will be determined using the L<gethostname(2)> system call.
273 =item B<FQDNLookup> B<true|false>
275 If B<Hostname> is determined automatically this setting controls whether or not
276 the daemon should try to figure out the "fully qualified domain name", FQDN.
277 This is done using a lookup of the name returned by C<gethostname>. This option
278 is enabled by default.
280 =item B<PreCacheChain> I<ChainName>
282 =item B<PostCacheChain> I<ChainName>
284 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
285 see L<FILTER CONFIGURATION> below on information on chains and how these
286 setting change the daemon's behavior.
290 =head1 PLUGIN OPTIONS
292 Some plugins may register own options. These options must be enclosed in a
293 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
294 require external configuration, too. The C<apache plugin>, for example,
295 required C<mod_status> to be configured in the webserver you're going to
296 collect data from. These plugins are listed below as well, even if they don't
297 require any configuration within collectd's configuration file.
299 A list of all plugins and a short summary for each plugin can be found in the
300 F<README> file shipped with the sourcecode and hopefully binary packets as
303 =head2 Plugin C<aggregation>
305 The I<Aggregation plugin> makes it possible to aggregate several values into
306 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
307 This can be put to a wide variety of uses, e.g. average and total CPU
308 statistics for your entire fleet.
310 The grouping is powerful but, as with many powerful tools, may be a bit
311 difficult to wrap your head around. The grouping will therefore be
312 demonstrated using an example: The average and sum of the CPU usage across
313 all CPUs of each host is to be calculated.
315 To select all the affected values for our example, set C<Plugin cpu> and
316 C<Type cpu>. The other values are left unspecified, meaning "all values". The
317 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
318 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
324 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...) and
325 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
326 example, the intention is to have a new value for each host / type instance
327 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
328 It can be specified multiple times to group by more than one field.
331 GroupBy "TypeInstance"
333 We do neither specify nor group by I<plugin instance> (the CPU number), so all
334 metrics that differ in the CPU number only will be aggregated. Each
335 aggregation needs I<at least one> such field, otherwise no aggregation would
338 The full example configuration looks like this:
340 <Plugin "aggregation">
346 GroupBy "TypeInstance"
349 CalculateAverage true
353 There are a couple of limitations you should be aware of:
359 The I<Type> cannot be left unspecified, because it is not reasonable to add
360 apples to oranges. Also, the internal lookup structure won't work if you try
365 There must be at least one unspecified, ungrouped field. Otherwise nothing
370 As you can see in the example above, each aggregation has its own
371 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
372 blocks may match the same values, i.e. one value list can update multiple
373 aggregations. The following options are valid inside B<Aggregation> blocks:
377 =item B<Host> I<Host>
379 =item B<Plugin> I<Plugin>
381 =item B<PluginInstance> I<PluginInstance>
383 =item B<Type> I<Type>
385 =item B<TypeInstance> I<TypeInstance>
387 Selects the value lists to be added to this aggregation. B<Type> must be a
388 valid data set name, see L<types.db(5)> for details.
390 If the string starts with and ends with a slash (C</>), the string is
391 interpreted as a I<regular expression>. The regex flavor used are POSIX
392 extended regular expressions as described in L<regex(7)>. Example usage:
394 Host "/^db[0-9]\\.example\\.com$/"
396 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
398 Group valued by the specified field. The B<GroupBy> option may be repeated to
399 group by multiple fields.
401 =item B<SetHost> I<Host>
403 =item B<SetPlugin> I<Plugin>
405 =item B<SetPluginInstance> I<PluginInstance>
407 =item B<SetTypeInstance> I<TypeInstance>
409 Sets the appropriate part of the identifier to the provided string.
411 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
412 will be replaced with the aggregation function, e.g. "average". Not including
413 the placeholder will result in duplication warnings and/or messed up values if
414 more than one aggregation function are enabled.
416 The following example calculates the average usage of all "even" CPUs:
418 <Plugin "aggregation">
421 PluginInstance "/[0,2,4,6,8]$/"
425 SetPluginInstance "even-%{aggregation}"
428 GroupBy "TypeInstance"
430 CalculateAverage true
434 This will create the files:
440 foo.example.com/cpu-even-average/cpu-idle
444 foo.example.com/cpu-even-average/cpu-system
448 foo.example.com/cpu-even-average/cpu-user
456 =item B<CalculateNum> B<true>|B<false>
458 =item B<CalculateSum> B<true>|B<false>
460 =item B<CalculateAverage> B<true>|B<false>
462 =item B<CalculateMinimum> B<true>|B<false>
464 =item B<CalculateMaximum> B<true>|B<false>
466 =item B<CalculateStddev> B<true>|B<false>
468 Boolean options for enabling calculation of the number of value lists, their
469 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
470 are disabled by default.
474 =head2 Plugin C<amqp>
476 The I<AMQMP plugin> can be used to communicate with other instances of
477 I<collectd> or third party applications using an AMQP message broker. Values
478 are sent to or received from the broker, which handles routing, queueing and
479 possibly filtering or messages.
482 # Send values to an AMQP broker
483 <Publish "some_name">
489 Exchange "amq.fanout"
490 # ExchangeType "fanout"
491 # RoutingKey "collectd"
495 # GraphitePrefix "collectd."
496 # GraphiteEscapeChar "_"
499 # Receive values from an AMQP broker
500 <Subscribe "some_name">
506 Exchange "amq.fanout"
507 # ExchangeType "fanout"
510 # QueueAutoDelete true
511 # RoutingKey "collectd.#"
515 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
516 blocks, which configure sending and receiving of values respectively. The two
517 blocks are very similar, so unless otherwise noted, an option can be used in
518 either block. The name given in the blocks starting tag is only used for
519 reporting messages, but may be used to support I<flushing> of certain
520 I<Publish> blocks in the future.
524 =item B<Host> I<Host>
526 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
527 the underlying communications library, I<rabbitmq-c>, which is "localhost".
529 =item B<Port> I<Port>
531 Service name or port number on which the AMQP broker accepts connections. This
532 argument must be a string, even if the numeric form is used. Defaults to
535 =item B<VHost> I<VHost>
537 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
539 =item B<User> I<User>
541 =item B<Password> I<Password>
543 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
546 =item B<Exchange> I<Exchange>
548 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
549 By default, "amq.fanout" will be used.
551 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
552 the given exchange and the I<queue> is created, using the I<routing key> if
553 configured. See the B<Queue> and B<RoutingKey> options below.
555 =item B<ExchangeType> I<Type>
557 If given, the plugin will try to create the configured I<exchange> with this
558 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
559 be bound to this exchange.
561 =item B<Queue> I<Queue> (Subscribe only)
563 Configures the I<queue> name to subscribe to. If no queue name was configured
564 explicitly, a unique queue name will be created by the broker.
566 =item B<QueueDurable> B<true>|B<false> (Subscribe only)
568 Defines if the I<queue> subscribed to is durable (saved to persistent storage)
569 or transient (will disappear if the AMQP broker is restarted). Defaults to
572 This option should be used in conjunction with the I<Persistent> option on the
575 =item B<QueueAutoDelete> B<true>|B<false> (Subscribe only)
577 Defines if the I<queue> subscribed to will be deleted once the last consumer
578 unsubscribes. Defaults to "true".
580 =item B<RoutingKey> I<Key>
582 In I<Publish> blocks, this configures the routing key to set on all outgoing
583 messages. If not given, the routing key will be computed from the I<identifier>
584 of the value. The host, plugin, type and the two instances are concatenated
585 together using dots as the separator and all containing dots replaced with
586 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
587 possible to receive only specific values using a "topic" exchange.
589 In I<Subscribe> blocks, configures the I<routing key> used when creating a
590 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
591 used to filter messages when using a "topic" exchange. If you're only
592 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
595 =item B<Persistent> B<true>|B<false> (Publish only)
597 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
598 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
599 default), the I<transient> delivery mode will be used, i.e. messages may be
600 lost due to high load, overflowing queues or similar issues.
602 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
604 Selects the format in which messages are sent to the broker. If set to
605 B<Command> (the default), values are sent as C<PUTVAL> commands which are
606 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
607 case, the C<Content-Type> header field will be set to C<text/collectd>.
609 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
610 an easy and straight forward exchange format. The C<Content-Type> header field
611 will be set to C<application/json>.
613 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
614 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
617 A subscribing client I<should> use the C<Content-Type> header field to
618 determine how to decode the values. Currently, the I<AMQP plugin> itself can
619 only decode the B<Command> format.
621 =item B<StoreRates> B<true>|B<false> (Publish only)
623 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
624 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
625 default), no conversion is performed. Otherwise the conversion is performed
626 using the internal value cache.
628 Please note that currently this option is only used if the B<Format> option has
631 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
633 A prefix can be added in the metric name when outputting in the I<Graphite> format.
634 It's added before the I<Host> name.
635 Metric name will be "<prefix><host><postfix><plugin><type><name>"
637 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
639 A postfix can be added in the metric name when outputting in the I<Graphite> format.
640 It's added after the I<Host> name.
641 Metric name will be "<prefix><host><postfix><plugin><type><name>"
643 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
645 Specify a character to replace dots (.) in the host part of the metric name.
646 In I<Graphite> metric name, dots are used as separators between different
647 metric parts (host, plugin, type).
648 Default is "_" (I<Underscore>).
652 =head2 Plugin C<apache>
654 To configure the C<apache>-plugin you first need to configure the Apache
655 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
656 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
657 the following snipped to base your Apache config upon:
660 <IfModule mod_status.c>
661 <Location /mod_status>
662 SetHandler server-status
666 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
667 also supported. It introduces a new field, called C<BusyServers>, to count the
668 number of currently connected clients. This field is also supported.
670 The configuration of the I<Apache> plugin consists of one or more
671 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
672 as the instance name. For example:
676 URL "http://www1.example.com/mod_status?auto"
679 URL "http://www2.example.com/mod_status?auto"
683 The instance name will be used as the I<plugin instance>. To emulate the old
684 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
685 plugin to work correctly, each instance name must be unique. This is not
686 enforced by the plugin and it is your responsibility to ensure it.
688 The following options are accepted within each I<Instance> block:
692 =item B<URL> I<http://host/mod_status?auto>
694 Sets the URL of the C<mod_status> output. This needs to be the output generated
695 by C<ExtendedStatus on> and it needs to be the machine readable output
696 generated by appending the C<?auto> argument. This option is I<mandatory>.
698 =item B<User> I<Username>
700 Optional user name needed for authentication.
702 =item B<Password> I<Password>
704 Optional password needed for authentication.
706 =item B<VerifyPeer> B<true|false>
708 Enable or disable peer SSL certificate verification. See
709 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
711 =item B<VerifyHost> B<true|false>
713 Enable or disable peer host name verification. If enabled, the plugin checks
714 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
715 certificate matches the host name provided by the B<URL> option. If this
716 identity check fails, the connection is aborted. Obviously, only works when
717 connecting to a SSL enabled server. Enabled by default.
719 =item B<CACert> I<File>
721 File that holds one or more SSL certificates. If you want to use HTTPS you will
722 possibly need this option. What CA certificates come bundled with C<libcurl>
723 and are checked by default depends on the distribution you use.
727 =head2 Plugin C<apcups>
731 =item B<Host> I<Hostname>
733 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
734 that IPv6 support has been disabled unless someone can confirm or decline that
735 B<apcupsd> can handle it.
737 =item B<Port> I<Port>
739 TCP-Port to connect to. Defaults to B<3551>.
741 =item B<ReportSeconds> B<true|false>
743 If set to B<true>, the time reported in the C<timeleft> metric will be
744 converted to seconds. This is the recommended setting. If set to B<false>, the
745 default for backwards compatibility, the time will be reported in minutes.
749 =head2 Plugin C<aquaero>
751 This plugin collects the value of the available sensors in an
752 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
753 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
754 connection for monitoring and configuration. The board can handle multiple
755 temperature sensors, fans, water pumps and water level sensors and adjust the
756 output settings such as fan voltage or power used by the water pump based on
757 the available inputs using a configurable controller included in the board.
758 This plugin collects all the available inputs as well as some of the output
759 values chosen by this controller. The plugin is based on the I<libaquaero5>
760 library provided by I<aquatools-ng>.
764 =item B<Device> I<DevicePath>
766 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
767 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
768 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
772 =head2 Plugin C<ascent>
774 This plugin collects information about an Ascent server, a free server for the
775 "World of Warcraft" game. This plugin gathers the information by fetching the
776 XML status page using C<libcurl> and parses it using C<libxml2>.
778 The configuration options are the same as for the C<apache> plugin above:
782 =item B<URL> I<http://localhost/ascent/status/>
784 Sets the URL of the XML status output.
786 =item B<User> I<Username>
788 Optional user name needed for authentication.
790 =item B<Password> I<Password>
792 Optional password needed for authentication.
794 =item B<VerifyPeer> B<true|false>
796 Enable or disable peer SSL certificate verification. See
797 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
799 =item B<VerifyHost> B<true|false>
801 Enable or disable peer host name verification. If enabled, the plugin checks
802 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
803 certificate matches the host name provided by the B<URL> option. If this
804 identity check fails, the connection is aborted. Obviously, only works when
805 connecting to a SSL enabled server. Enabled by default.
807 =item B<CACert> I<File>
809 File that holds one or more SSL certificates. If you want to use HTTPS you will
810 possibly need this option. What CA certificates come bundled with C<libcurl>
811 and are checked by default depends on the distribution you use.
815 =head2 Plugin C<barometer>
817 This plugin reads absolute air pressure using digital barometer sensor MPL115A2
818 or MPL3115 from Freescale (sensor attached to any I2C bus available in
819 the computer, for HW details see
820 I<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A> or
821 I<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>).
822 The sensor type - one fo these two - is detected automatically by the plugin
823 and indicated in the plugin_instance (typically you will see subdirectory
824 "barometer-mpl115" or "barometer-mpl3115").
826 The plugin provides absolute barometric pressure, air pressure reduced to sea
827 level (several possible approximations) and as an auxiliary value also internal
828 sensor temperature. It uses (expects/provides) typical metric units - pressure
829 in [hPa], temperature in [C], altitude in [m].
831 It was developed and tested under Linux only. The only platform dependency is
832 the standard Linux i2c-dev interface (the particular bus driver has to
833 support the SM Bus command subset).
835 The reduction or normalization to mean sea level pressure requires (depedning on
836 selected method/approximation) also altitude and reference to temperature sensor(s).
837 When multiple temperature sensors are configured the minumum of their values is
838 always used (expecting that the warmer ones are affected by e.g. direct sun light
847 TemperatureOffset 0.0
850 TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
855 =item B<Device> I<device>
857 Device name of the I2C bus to which the sensor is connected. Note that typically
858 you need to have loaded the i2c-dev module.
859 Using i2c-tools you can check/list i2c buses available on your system by:
863 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
867 This way you should be able to verify that the pressure sensor (either type) is
868 connected and detected on address 0x60.
870 =item B<Oversampling> I<value>
872 For MPL115 this is the size of the averaging window. To filter out sensor noise
873 a simple averaging using floating window of configurable size is used. The plugin
874 will use average of the last C<value> measurements (value of 1 means no averaging).
875 Minimal size is 1, maximal 1024.
877 For MPL3115 this is the oversampling value. The actual oversampling is performed
878 by the sensor and the higher value the higher accuracy and longer conversion time
879 (although nothing to worry about in the collectd context). Supported values are:
880 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is adjusted by the plugin to
881 the closest supported one. Default is 128.
883 =item B<PressureOffset> I<offset>
885 You can further calibrate the sensor by supplying pressure and/or temperature offsets.
886 This is added to the measured/caclulated value (i.e. if the measured value is too high
887 then use negative offset).
888 In hPa, default is 0.0.
890 =item B<TemperatureOffset> I<offset>
892 You can further calibrate the sensor by supplying pressure and/or temperature offsets.
893 This is added to the measured/caclulated value (i.e. if the measured value is too high
894 then use negative offset).
895 In C, default is 0.0.
897 =item B<Normalization> I<method>
899 Normalization method - what approximation/model is used to compute mean sea
900 level pressure from the air absolute pressure.
902 Supported values of the C<method> (integer between from 0 to 2) are:
906 =item B<0> - no conversion, absolute pressrure is simply copied over. For this method you
907 do not need to configure C<Altitude> or C<TemperatureSensor>.
909 =item B<1> - international formula for conversion ,
910 See I<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
911 For this method you have to configure C<Altitude> but do not need C<TemperatureSensor>
912 (uses fixed global temperature average instead).
914 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
915 Meteorological Service).
916 See I<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
917 For this method you have to configure both C<Altitude> and C<TemperatureSensor>.
922 =item B<Altitude> I<altitude>
924 The altitude (in meters) of the location where you meassure the pressure.
926 =item B<TemperatureSensor> I<reference>
928 Temperature sensor which should be used as a reference when normalizing the pressure.
929 When specified more sensors a minumum is found and uses each time.
930 The temperature reading directly from this pressure sensor/plugin
931 is typically not suitable as the pressure sensor
932 will be probably inside while we want outside temperature.
933 The collectd reference name is something like
934 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
935 (<type_instance> is usually omitted when there is just single value type).
936 Or you can figure it out from the path of the output data files.
940 =head2 Plugin C<bind>
942 Starting with BIND 9.5.0, the most widely used DNS server software provides
943 extensive statistics about queries, responses and lots of other information.
944 The bind plugin retrieves this information that's encoded in XML and provided
945 via HTTP and submits the values to collectd.
947 To use this plugin, you first need to tell BIND to make this information
948 available. This is done with the C<statistics-channels> configuration option:
950 statistics-channels {
951 inet localhost port 8053;
954 The configuration follows the grouping that can be seen when looking at the
955 data with an XSLT compatible viewer, such as a modern web browser. It's
956 probably a good idea to make yourself familiar with the provided values, so you
957 can understand what the collected statistics actually mean.
962 URL "http://localhost:8053/"
977 Zone "127.in-addr.arpa/IN"
981 The bind plugin accepts the following configuration options:
987 URL from which to retrieve the XML data. If not specified,
988 C<http://localhost:8053/> will be used.
990 =item B<ParseTime> B<true>|B<false>
992 When set to B<true>, the time provided by BIND will be parsed and used to
993 dispatch the values. When set to B<false>, the local time source is queried.
995 This setting is set to B<true> by default for backwards compatibility; setting
996 this to B<false> is I<recommended> to avoid problems with timezones and
999 =item B<OpCodes> B<true>|B<false>
1001 When enabled, statistics about the I<"OpCodes">, for example the number of
1002 C<QUERY> packets, are collected.
1006 =item B<QTypes> B<true>|B<false>
1008 When enabled, the number of I<incoming> queries by query types (for example
1009 C<A>, C<MX>, C<AAAA>) is collected.
1013 =item B<ServerStats> B<true>|B<false>
1015 Collect global server statistics, such as requests received over IPv4 and IPv6,
1016 successful queries, and failed updates.
1020 =item B<ZoneMaintStats> B<true>|B<false>
1022 Collect zone maintenance statistics, mostly information about notifications
1023 (zone updates) and zone transfers.
1027 =item B<ResolverStats> B<true>|B<false>
1029 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1030 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1031 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1032 default. Use the B<ResolverStats> option within a B<View "_default"> block
1033 instead for the same functionality.
1037 =item B<MemoryStats>
1039 Collect global memory statistics.
1043 =item B<View> I<Name>
1045 Collect statistics about a specific I<"view">. BIND can behave different,
1046 mostly depending on the source IP-address of the request. These different
1047 configurations are called "views". If you don't use this feature, you most
1048 likely are only interested in the C<_default> view.
1050 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1051 information you want to collect about a view. If no B<View> block is
1052 configured, no detailed view statistics will be collected.
1056 =item B<QTypes> B<true>|B<false>
1058 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1059 C<MX>) is collected.
1063 =item B<ResolverStats> B<true>|B<false>
1065 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1066 (e.E<nbsp>g. queries over IPv4, lame servers).
1070 =item B<CacheRRSets> B<true>|B<false>
1072 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1073 type is collected. Negative entries (queries which resulted in an error, for
1074 example names that do not exist) are reported with a leading exclamation mark,
1079 =item B<Zone> I<Name>
1081 When given, collect detailed information about the given zone in the view. The
1082 information collected if very similar to the global B<ServerStats> information
1085 You can repeat this option to collect detailed information about multiple
1088 By default no detailed zone information is collected.
1094 =head2 Plugin C<cgroups>
1096 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1097 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1098 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1102 =item B<CGroup> I<Directory>
1104 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1105 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1108 =item B<IgnoreSelected> B<true>|B<false>
1110 Invert the selection: If set to true, all cgroups I<except> the ones that
1111 match any one of the criteria are collected. By default only selected
1112 cgroups are collected if a selection is made. If no selection is configured
1113 at all, B<all> cgroups are selected.
1117 =head2 Plugin C<conntrack>
1119 This plugin collects IP conntrack statistics.
1125 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1126 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1130 =head2 Plugin C<cpu>
1132 The I<CPU plugin> collects CPU usage metrics.
1134 The following configuration options are available:
1138 =item B<ReportActive> B<false>|B<true>
1140 Reports non-idle CPU usage as the "active" value. Defaults to false.
1142 =item B<ReportByCpu> B<false>|B<true>
1144 When true reports usage for all cores. When false, reports cpu usage
1145 aggregated over all cores.
1148 =item B<ValuesPercentage> B<false>|B<true>
1150 When true report percentage usage instead of tick values. Defaults to false.
1155 =head2 Plugin C<cpufreq>
1157 This plugin doesn't have any options. It reads
1158 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1159 installed) to get the current CPU frequency. If this file does not exist make
1160 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1161 installed and an "cpu governor" (that's a kernel module) is loaded.
1163 =head2 Plugin C<csv>
1167 =item B<DataDir> I<Directory>
1169 Set the directory to store CSV-files under. Per default CSV-files are generated
1170 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1171 The special strings B<stdout> and B<stderr> can be used to write to the standard
1172 output and standard error channels, respectively. This, of course, only makes
1173 much sense when collectd is running in foreground- or non-daemon-mode.
1175 =item B<StoreRates> B<true|false>
1177 If set to B<true>, convert counter values to rates. If set to B<false> (the
1178 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1183 =head2 Plugin C<curl>
1185 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1186 and the match infrastructure (the same code used by the tail plugin) to use
1187 regular expressions with the received data.
1189 The following example will read the current value of AMD stock from Google's
1190 finance page and dispatch the value to collectd.
1193 <Page "stock_quotes">
1194 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1198 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1199 DSType "GaugeAverage"
1200 # Note: `stock_value' is not a standard type.
1207 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1208 a web page and one or more "matches" to be performed on the returned data. The
1209 string argument to the B<Page> block is used as plugin instance.
1211 The following options are valid within B<Page> blocks:
1217 URL of the web site to retrieve. Since a regular expression will be used to
1218 extract information from this data, non-binary data is a big plus here ;)
1220 =item B<User> I<Name>
1222 Username to use if authorization is required to read the page.
1224 =item B<Password> I<Password>
1226 Password to use if authorization is required to read the page.
1228 =item B<Digest> B<true>|B<false>
1230 Enable HTTP digest authentication.
1232 =item B<VerifyPeer> B<true>|B<false>
1234 Enable or disable peer SSL certificate verification. See
1235 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1237 =item B<VerifyHost> B<true>|B<false>
1239 Enable or disable peer host name verification. If enabled, the plugin checks if
1240 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1241 matches the host name provided by the B<URL> option. If this identity check
1242 fails, the connection is aborted. Obviously, only works when connecting to a
1243 SSL enabled server. Enabled by default.
1245 =item B<CACert> I<file>
1247 File that holds one or more SSL certificates. If you want to use HTTPS you will
1248 possibly need this option. What CA certificates come bundled with C<libcurl>
1249 and are checked by default depends on the distribution you use.
1251 =item B<Header> I<Header>
1253 A HTTP header to add to the request. Multiple headers are added if this option
1254 is specified more than once.
1256 =item B<Post> I<Body>
1258 Specifies that the HTTP operation should be a POST instead of a GET. The
1259 complete data to be posted is given as the argument. This option will usually
1260 need to be accompanied by a B<Header> option to set an appropriate
1261 C<Content-Type> for the post body (e.g. to
1262 C<application/x-www-form-urlencoded>).
1264 =item B<MeasureResponseTime> B<true>|B<false>
1266 Measure response time for the request. If this setting is enabled, B<Match>
1267 blocks (see below) are optional. Disabled by default.
1269 =item B<E<lt>MatchE<gt>>
1271 One or more B<Match> blocks that define how to match information in the data
1272 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1273 used by the C<tail> plugin, so please see the documentation of the C<tail>
1274 plugin below on how matches are defined. If the B<MeasureResponseTime> option
1275 is set to B<true>, B<Match> blocks are optional.
1279 =head2 Plugin C<curl_json>
1281 The B<curl_json plugin> collects values from JSON data to be parsed by
1282 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) retrieved via
1283 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1284 unix socket. The former can be used, for example, to collect values
1285 from CouchDB documents (which are stored JSON notation), and the
1286 latter to collect values from a uWSGI stats socket.
1288 The following example will collect several values from the built-in
1289 C<_stats> runtime statistics module of I<CouchDB>
1290 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1293 <URL "http://localhost:5984/_stats">
1295 <Key "httpd/requests/count">
1296 Type "http_requests"
1299 <Key "httpd_request_methods/*/count">
1300 Type "http_request_methods"
1303 <Key "httpd_status_codes/*/count">
1304 Type "http_response_codes"
1309 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1312 <Sock "/var/run/uwsgi.stats.sock">
1314 <Key "workers/*/requests">
1315 Type "http_requests"
1318 <Key "workers/*/apps/*/requests">
1319 Type "http_requests"
1324 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1325 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1326 blocks defining a unix socket to read JSON from directly. Each of
1327 these blocks may have one or more B<Key> blocks.
1329 The B<Key> string argument must be in a path format. Each component is
1330 used to match the key from a JSON map or the index of an JSON
1331 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1332 values for all map keys or array indices will be collectd.
1334 The following options are valid within B<URL> blocks:
1338 =item B<Instance> I<Instance>
1340 Sets the plugin instance to I<Instance>.
1342 =item B<User> I<Name>
1344 =item B<Password> I<Password>
1346 =item B<Digest> B<true>|B<false>
1348 =item B<VerifyPeer> B<true>|B<false>
1350 =item B<VerifyHost> B<true>|B<false>
1352 =item B<CACert> I<file>
1354 =item B<Header> I<Header>
1356 =item B<Post> I<Body>
1358 These options behave exactly equivalent to the appropriate options of the
1359 I<cURL> plugin. Please see there for a detailed description.
1363 The following options are valid within B<Key> blocks:
1367 =item B<Type> I<Type>
1369 Sets the type used to dispatch the values to the daemon. Detailed information
1370 about types and their configuration can be found in L<types.db(5)>. This
1371 option is mandatory.
1373 =item B<Instance> I<Instance>
1375 Type-instance to use. Defaults to the current map key or current string array element value.
1379 =head2 Plugin C<curl_xml>
1381 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1382 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1385 <URL "http://localhost/stats.xml">
1387 Instance "some_instance"
1392 CACert "/path/to/ca.crt"
1394 <XPath "table[@id=\"magic_level\"]/tr">
1396 #InstancePrefix "prefix-"
1397 InstanceFrom "td[1]"
1398 ValuesFrom "td[2]/span[@class=\"level\"]"
1403 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1404 URL to be fetched using libcurl. Within each B<URL> block there are
1405 options which specify the connection parameters, for example authentication
1406 information, and one or more B<XPath> blocks.
1408 Each B<XPath> block specifies how to get one type of information. The
1409 string argument must be a valid XPath expression which returns a list
1410 of "base elements". One value is dispatched for each "base element". The
1411 I<type instance> and values are looked up using further I<XPath> expressions
1412 that should be relative to the base element.
1414 Within the B<URL> block the following options are accepted:
1418 =item B<Host> I<Name>
1420 Use I<Name> as the host name when submitting values. Defaults to the global
1423 =item B<Instance> I<Instance>
1425 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1426 empty string (no plugin instance).
1428 =item B<Namespace> I<Prefix> I<URL>
1430 If an XPath expression references namespaces, they must be specified
1431 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1432 I<URL> is the "namespace name", an URI reference uniquely identifying the
1433 namespace. The option can be repeated to register multiple namespaces.
1437 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1438 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1440 =item B<User> I<User>
1442 =item B<Password> I<Password>
1444 =item B<Digest> B<true>|B<false>
1446 =item B<VerifyPeer> B<true>|B<false>
1448 =item B<VerifyHost> B<true>|B<false>
1450 =item B<CACert> I<CA Cert File>
1452 =item B<Header> I<Header>
1454 =item B<Post> I<Body>
1456 These options behave exactly equivalent to the appropriate options of the
1457 I<cURL plugin>. Please see there for a detailed description.
1459 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1461 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1462 B<XPath> block specifies how to get one type of information. The string
1463 argument must be a valid XPath expression which returns a list of "base
1464 elements". One value is dispatched for each "base element".
1466 Within the B<XPath> block the following options are accepted:
1470 =item B<Type> I<Type>
1472 Specifies the I<Type> used for submitting patches. This determines the number
1473 of values that are required / expected and whether the strings are parsed as
1474 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1475 This option is required.
1477 =item B<InstancePrefix> I<InstancePrefix>
1479 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1480 concatenated together without any separator.
1481 This option is optional.
1483 =item B<InstanceFrom> I<InstanceFrom>
1485 Specifies a XPath expression to use for determining the I<type instance>. The
1486 XPath expression must return exactly one element. The element's value is then
1487 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1489 This value is required. As a special exception, if the "base XPath expression"
1490 (the argument to the B<XPath> block) returns exactly one argument, then this
1491 option may be omitted.
1493 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1495 Specifies one or more XPath expression to use for reading the values. The
1496 number of XPath expressions must match the number of data sources in the
1497 I<type> specified with B<Type> (see above). Each XPath expression must return
1498 exactly one element. The element's value is then parsed as a number and used as
1499 value for the appropriate value in the value list dispatched to the daemon.
1505 =head2 Plugin C<dbi>
1507 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1508 connect to various databases, execute I<SQL> statements and read back the
1509 results. I<dbi> is an acronym for "database interface" in case you were
1510 wondering about the name. You can configure how each column is to be
1511 interpreted and the plugin will generate one or more data sets from each row
1512 returned according to these rules.
1514 Because the plugin is very generic, the configuration is a little more complex
1515 than those of other plugins. It usually looks something like this:
1518 <Query "out_of_stock">
1519 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1520 # Use with MySQL 5.0.0 or later
1524 InstancePrefix "out_of_stock"
1525 InstancesFrom "category"
1529 <Database "product_information">
1531 DriverOption "host" "localhost"
1532 DriverOption "username" "collectd"
1533 DriverOption "password" "aZo6daiw"
1534 DriverOption "dbname" "prod_info"
1535 SelectDB "prod_info"
1536 Query "out_of_stock"
1540 The configuration above defines one query with one result and one database. The
1541 query is then linked to the database with the B<Query> option I<within> the
1542 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1543 and you can also use the B<Include> statement to split up the configuration
1544 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1545 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1548 The following is a complete list of options:
1550 =head3 B<Query> blocks
1552 Query blocks define I<SQL> statements and how the returned data should be
1553 interpreted. They are identified by the name that is given in the opening line
1554 of the block. Thus the name needs to be unique. Other than that, the name is
1555 not used in collectd.
1557 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1558 define which column holds which value or instance information. You can use
1559 multiple B<Result> blocks to create multiple values from one returned row. This
1560 is especially useful, when queries take a long time and sending almost the same
1561 query again and again is not desirable.
1565 <Query "environment">
1566 Statement "select station, temperature, humidity from environment"
1569 # InstancePrefix "foo"
1570 InstancesFrom "station"
1571 ValuesFrom "temperature"
1575 InstancesFrom "station"
1576 ValuesFrom "humidity"
1580 The following options are accepted:
1584 =item B<Statement> I<SQL>
1586 Sets the statement that should be executed on the server. This is B<not>
1587 interpreted by collectd, but simply passed to the database server. Therefore,
1588 the SQL dialect that's used depends on the server collectd is connected to.
1590 The query has to return at least two columns, one for the instance and one
1591 value. You cannot omit the instance, even if the statement is guaranteed to
1592 always return exactly one line. In that case, you can usually specify something
1595 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1597 (That works with MySQL but may not be valid SQL according to the spec. If you
1598 use a more strict database server, you may have to select from a dummy table or
1601 Please note that some databases, for example B<Oracle>, will fail if you
1602 include a semicolon at the end of the statement.
1604 =item B<MinVersion> I<Version>
1606 =item B<MaxVersion> I<Value>
1608 Only use this query for the specified database version. You can use these
1609 options to provide multiple queries with the same name but with a slightly
1610 different syntax. The plugin will use only those queries, where the specified
1611 minimum and maximum versions fit the version of the database in use.
1613 The database version is determined by C<dbi_conn_get_engine_version>, see the
1614 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1615 for details. Basically, each part of the version is assumed to be in the range
1616 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1617 "40102", version "5.0.42" becomes "50042".
1619 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1620 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1621 happen. Don't to it! A valid example would be something along these lines:
1632 In the above example, there are three ranges that don't overlap. The last one
1633 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1634 before "4.0.0" are not specified.
1636 =item B<Type> I<Type>
1638 The B<type> that's used for each line returned. See L<types.db(5)> for more
1639 details on how types are defined. In short: A type is a predefined layout of
1640 data and the number of values and type of values has to match the type
1643 If you specify "temperature" here, you need exactly one gauge column. If you
1644 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1647 There must be exactly one B<Type> option inside each B<Result> block.
1649 =item B<InstancePrefix> I<prefix>
1651 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1652 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1653 all strings returned in the appropriate columns are concatenated together,
1654 separated by dashes I<("-")>.
1656 =item B<InstancesFrom> I<column0> [I<column1> ...]
1658 Specifies the columns whose values will be used to create the "type-instance"
1659 for each row. If you specify more than one column, the value of all columns
1660 will be joined together with dashes I<("-")> as separation characters.
1662 The plugin itself does not check whether or not all built instances are
1663 different. It's your responsibility to assure that each is unique. This is
1664 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1665 sure that only one row is returned in this case.
1667 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1670 =item B<ValuesFrom> I<column0> [I<column1> ...]
1672 Names the columns whose content is used as the actual data for the data sets
1673 that are dispatched to the daemon. How many such columns you need is determined
1674 by the B<Type> setting above. If you specify too many or not enough columns,
1675 the plugin will complain about that and no data will be submitted to the
1678 The actual data type in the columns is not that important. The plugin will
1679 automatically cast the values to the right type if it know how to do that. So
1680 it should be able to handle integer an floating point types, as well as strings
1681 (if they include a number at the beginning).
1683 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1685 =item B<MetadataFrom> [I<column0> I<column1> ...]
1687 Names the columns whose content is used as metadata for the data sets
1688 that are dispatched to the daemon.
1690 The actual data type in the columns is not that important. The plugin will
1691 automatically cast the values to the right type if it know how to do that. So
1692 it should be able to handle integer an floating point types, as well as strings
1693 (if they include a number at the beginning).
1697 =head3 B<Database> blocks
1699 Database blocks define a connection to a database and which queries should be
1700 sent to that database. Since the used "dbi" library can handle a wide variety
1701 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1702 documentationE<nbsp>- we stick as close to the terminology used there.
1704 Each database needs a "name" as string argument in the starting tag of the
1705 block. This name will be used as "PluginInstance" in the values submitted to
1706 the daemon. Other than that, that name is not used.
1710 =item B<Driver> I<Driver>
1712 Specifies the driver to use to connect to the database. In many cases those
1713 drivers are named after the database they can connect to, but this is not a
1714 technical necessity. These drivers are sometimes referred to as "DBD",
1715 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1716 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1717 project at L<http://libdbi-drivers.sourceforge.net/>.
1719 You need to give the driver name as expected by the "dbi" library here. You
1720 should be able to find that in the documentation for each driver. If you
1721 mistype the driver name, the plugin will dump a list of all known driver names
1724 =item B<DriverOption> I<Key> I<Value>
1726 Sets driver-specific options. What option a driver supports can be found in the
1727 documentation for each driver, somewhere at
1728 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1729 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1731 DBDs can register two types of options: String options and numeric options. The
1732 plugin will use the C<dbi_conn_set_option> function when the configuration
1733 provides a string and the C<dbi_conn_require_option_numeric> function when the
1734 configuration provides a number. So these two lines will actually result in
1735 different calls being used:
1737 DriverOption "Port" 1234 # numeric
1738 DriverOption "Port" "1234" # string
1740 Unfortunately, drivers are not too keen to report errors when an unknown option
1741 is passed to them, so invalid settings here may go unnoticed. This is not the
1742 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1743 the driver. If a driver complains about an option, the plugin will dump a
1744 complete list of all options understood by that driver to the log. There is no
1745 way to programatically find out if an option expects a string or a numeric
1746 argument, so you will have to refer to the appropriate DBD's documentation to
1747 find this out. Sorry.
1749 =item B<SelectDB> I<Database>
1751 In some cases, the database name you connect with is not the database name you
1752 want to use for querying data. If this option is set, the plugin will "select"
1753 (switch to) that database after the connection is established.
1755 =item B<Query> I<QueryName>
1757 Associates the query named I<QueryName> with this database connection. The
1758 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1759 blocks you want to refer to must be placed above the database block you want to
1762 =item B<Host> I<Hostname>
1764 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
1765 values. Defaults to the global hostname setting.
1773 =item B<Device> I<Device>
1775 Select partitions based on the devicename.
1777 =item B<MountPoint> I<Directory>
1779 Select partitions based on the mountpoint.
1781 =item B<FSType> I<FSType>
1783 Select partitions based on the filesystem type.
1785 =item B<IgnoreSelected> B<true>|B<false>
1787 Invert the selection: If set to true, all partitions B<except> the ones that
1788 match any one of the criteria are collected. By default only selected
1789 partitions are collected if a selection is made. If no selection is configured
1790 at all, B<all> partitions are selected.
1792 =item B<ReportByDevice> B<true>|B<false>
1794 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1795 (the default), it will report a disk as "root", but with it I<true>, it will be
1796 "sda1" (or whichever).
1798 =item B<ReportInodes> B<true>|B<false>
1800 Enables or disables reporting of free, reserved and used inodes. Defaults to
1801 inode collection being disabled.
1803 Enable this option if inodes are a scarce resource for you, usually because
1804 many small files are stored on the disk. This is a usual scenario for mail
1805 transfer agents and web caches.
1807 =item B<ValuesAbsolute> B<true>|B<false>
1809 Enables or disables reporting of free and used disk space in 1K-blocks.
1810 Defaults to B<true>.
1812 =item B<ValuesPercentage> B<false>|B<true>
1814 Enables or disables reporting of free and used disk space in percentage.
1815 Defaults to B<false>.
1817 This is useful for deploying I<collectd> on the cloud, where machines with
1818 different disk size may exist. Then it is more practical to configure
1819 thresholds based on relative disk size.
1823 =head2 Plugin C<disk>
1825 The C<disk> plugin collects information about the usage of physical disks and
1826 logical disks (partitions). Values collected are the number of octets written
1827 to and read from a disk or partition, the number of read/write operations
1828 issued to the disk and a rather complex "time" it took for these commands to be
1831 Using the following two options you can ignore some disks or configure the
1832 collection only of specific disks.
1836 =item B<Disk> I<Name>
1838 Select the disk I<Name>. Whether it is collected or ignored depends on the
1839 B<IgnoreSelected> setting, see below. As with other plugins that use the
1840 daemon's ignorelist functionality, a string that starts and ends with a slash
1841 is interpreted as a regular expression. Examples:
1846 =item B<IgnoreSelected> B<true>|B<false>
1848 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1849 statements, are ignored or if all other disks are ignored. The behavior
1850 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1851 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1852 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1853 is set to B<true>, all disks are collected B<except> the ones matched.
1855 =item B<UseBSDName> B<true>|B<false>
1857 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
1858 default major/minor numbers. Requires collectd to be built with Apple's
1861 =item B<UdevNameAttr> I<Attribute>
1863 Attempt to override disk instance name with the value of a specified udev
1864 attribute when built with B<libudev>. If the attribute is not defined for the
1865 given device, the default name is used. Example:
1867 UdevNameAttr "DM_NAME"
1871 =head2 Plugin C<dns>
1875 =item B<Interface> I<Interface>
1877 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1878 option sets the interface that should be used. If this option is not set, or
1879 set to "any", the plugin will try to get packets from B<all> interfaces. This
1880 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1882 =item B<IgnoreSource> I<IP-address>
1884 Ignore packets that originate from this address.
1886 =item B<SelectNumericQueryTypes> B<true>|B<false>
1888 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1892 =head2 Plugin C<email>
1896 =item B<SocketFile> I<Path>
1898 Sets the socket-file which is to be created.
1900 =item B<SocketGroup> I<Group>
1902 If running as root change the group of the UNIX-socket after it has been
1903 created. Defaults to B<collectd>.
1905 =item B<SocketPerms> I<Permissions>
1907 Change the file permissions of the UNIX-socket after it has been created. The
1908 permissions must be given as a numeric, octal value as you would pass to
1909 L<chmod(1)>. Defaults to B<0770>.
1911 =item B<MaxConns> I<Number>
1913 Sets the maximum number of connections that can be handled in parallel. Since
1914 this many threads will be started immediately setting this to a very high
1915 value will waste valuable resources. Defaults to B<5> and will be forced to be
1916 at most B<16384> to prevent typos and dumb mistakes.
1920 =head2 Plugin C<ethstat>
1922 The I<ethstat plugin> collects information about network interface cards (NICs)
1923 by talking directly with the underlying kernel driver using L<ioctl(2)>.
1929 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
1930 Map "multicast" "if_multicast"
1937 =item B<Interface> I<Name>
1939 Collect statistical information about interface I<Name>.
1941 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
1943 By default, the plugin will submit values as type C<derive> and I<type
1944 instance> set to I<Name>, the name of the metric as reported by the driver. If
1945 an appropriate B<Map> option exists, the given I<Type> and, optionally,
1946 I<TypeInstance> will be used.
1948 =item B<MappedOnly> B<true>|B<false>
1950 When set to B<true>, only metrics that can be mapped to to a I<type> will be
1951 collected, all other metrics will be ignored. Defaults to B<false>.
1955 =head2 Plugin C<exec>
1957 Please make sure to read L<collectd-exec(5)> before using this plugin. It
1958 contains valuable information on when the executable is executed and the
1959 output that is expected from it.
1963 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1965 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1967 Execute the executable I<Executable> as user I<User>. If the user name is
1968 followed by a colon and a group name, the effective group is set to that group.
1969 The real group and saved-set group will be set to the default group of that
1970 user. If no group is given the effective group ID will be the same as the real
1973 Please note that in order to change the user and/or group the daemon needs
1974 superuser privileges. If the daemon is run as an unprivileged user you must
1975 specify the same user/group here. If the daemon is run with superuser
1976 privileges, you must supply a non-root user here.
1978 The executable may be followed by optional arguments that are passed to the
1979 program. Please note that due to the configuration parsing numbers and boolean
1980 values may be changed. If you want to be absolutely sure that something is
1981 passed as-is please enclose it in quotes.
1983 The B<Exec> and B<NotificationExec> statements change the semantics of the
1984 programs executed, i.E<nbsp>e. the data passed to them and the response
1985 expected from them. This is documented in great detail in L<collectd-exec(5)>.
1989 =head2 Plugin C<filecount>
1991 The C<filecount> plugin counts the number of files in a certain directory (and
1992 its subdirectories) and their combined size. The configuration is very straight
1995 <Plugin "filecount">
1996 <Directory "/var/qmail/queue/mess">
1997 Instance "qmail-message"
1999 <Directory "/var/qmail/queue/todo">
2000 Instance "qmail-todo"
2002 <Directory "/var/lib/php5">
2003 Instance "php5-sessions"
2008 The example above counts the number of files in QMail's queue directories and
2009 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2010 QMail has not yet looked at, the "message" queue holds the messages that were
2011 classified into "local" and "remote".
2013 As you can see, the configuration consists of one or more C<Directory> blocks,
2014 each of which specifies a directory in which to count the files. Within those
2015 blocks, the following options are recognized:
2019 =item B<Instance> I<Instance>
2021 Sets the plugin instance to I<Instance>. That instance name must be unique, but
2022 it's your responsibility, the plugin doesn't check for that. If not given, the
2023 instance is set to the directory name with all slashes replaced by underscores
2024 and all leading underscores removed.
2026 =item B<Name> I<Pattern>
2028 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2029 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2030 against the pattern, not the entire path. In case this makes it easier for you:
2031 This option has been named after the B<-name> parameter to L<find(1)>.
2033 =item B<MTime> I<Age>
2035 Count only files of a specific age: If I<Age> is greater than zero, only files
2036 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2037 a negative number, this is inversed. For example, if B<-60> is specified, only
2038 files that have been modified in the last minute will be counted.
2040 The number can also be followed by a "multiplier" to easily specify a larger
2041 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2042 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2043 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2044 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2045 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2048 =item B<Size> I<Size>
2050 Count only files of a specific size. When I<Size> is a positive number, only
2051 files that are at least this big are counted. If I<Size> is a negative number,
2052 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2053 I<Size> are counted.
2055 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2056 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2057 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2058 note that there are 1000 bytes in a kilobyte, not 1024.
2060 =item B<Recursive> I<true>|I<false>
2062 Controls whether or not to recurse into subdirectories. Enabled by default.
2064 =item B<IncludeHidden> I<true>|I<false>
2066 Controls whether or not to include "hidden" files and directories in the count.
2067 "Hidden" files and directories are those, whose name begins with a dot.
2068 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2072 =head2 Plugin C<GenericJMX>
2074 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2075 L<collectd-java(5)>.
2077 =head2 Plugin C<gmond>
2079 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2080 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2081 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2086 MCReceiveFrom "239.2.11.71" "8649"
2087 <Metric "swap_total">
2089 TypeInstance "total"
2092 <Metric "swap_free">
2099 The following metrics are built-in:
2105 load_one, load_five, load_fifteen
2109 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2113 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2125 Available configuration options:
2129 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2131 Sets sets the multicast group and UDP port to which to subscribe.
2133 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2135 =item E<lt>B<Metric> I<Name>E<gt>
2137 These blocks add a new metric conversion to the internal table. I<Name>, the
2138 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2142 =item B<Type> I<Type>
2144 Type to map this metric to. Required.
2146 =item B<TypeInstance> I<Instance>
2148 Type-instance to use. Optional.
2150 =item B<DataSource> I<Name>
2152 Data source to map this metric to. If the configured type has exactly one data
2153 source, this is optional. Otherwise the option is required.
2159 =head2 Plugin C<hddtemp>
2161 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
2162 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
2163 default values, see below. C<hddtemp> has to be running to work correctly. If
2164 C<hddtemp> is not running timeouts may appear which may interfere with other
2167 The B<hddtemp> homepage can be found at
2168 L<http://www.guzu.net/linux/hddtemp.php>.
2172 =item B<Host> I<Hostname>
2174 Hostname to connect to. Defaults to B<127.0.0.1>.
2176 =item B<Port> I<Port>
2178 TCP-Port to connect to. Defaults to B<7634>.
2182 =head2 Plugin C<interface>
2186 =item B<Interface> I<Interface>
2188 Select this interface. By default these interfaces will then be collected. For
2189 a more detailed description see B<IgnoreSelected> below.
2191 =item B<IgnoreSelected> I<true>|I<false>
2193 If no configuration if given, the B<traffic>-plugin will collect data from
2194 all interfaces. This may not be practical, especially for loopback- and
2195 similar interfaces. Thus, you can use the B<Interface>-option to pick the
2196 interfaces you're interested in. Sometimes, however, it's easier/preferred
2197 to collect all interfaces I<except> a few ones. This option enables you to
2198 do that: By setting B<IgnoreSelected> to I<true> the effect of
2199 B<Interface> is inverted: All selected interfaces are ignored and all
2200 other interfaces are collected.
2204 =head2 Plugin C<ipmi>
2208 =item B<Sensor> I<Sensor>
2210 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2212 =item B<IgnoreSelected> I<true>|I<false>
2214 If no configuration if given, the B<ipmi> plugin will collect data from all
2215 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2216 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2217 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2218 all other sensors are collected.
2220 =item B<NotifySensorAdd> I<true>|I<false>
2222 If a sensor appears after initialization time of a minute a notification
2225 =item B<NotifySensorRemove> I<true>|I<false>
2227 If a sensor disappears a notification is sent.
2229 =item B<NotifySensorNotPresent> I<true>|I<false>
2231 If you have for example dual power supply and one of them is (un)plugged then
2232 a notification is sent.
2236 =head2 Plugin C<iptables>
2240 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2242 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
2243 will collect the counters of all rules which have a comment-match. The comment
2244 is then used as type-instance.
2246 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2247 the I<n>th rule will be collected. Again, the comment (or the number) will be
2248 used as the type-instance.
2250 If I<Name> is supplied, it will be used as the type-instance instead of the
2251 comment or the number.
2255 =head2 Plugin C<irq>
2261 Select this irq. By default these irqs will then be collected. For a more
2262 detailed description see B<IgnoreSelected> below.
2264 =item B<IgnoreSelected> I<true>|I<false>
2266 If no configuration if given, the B<irq>-plugin will collect data from all
2267 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2268 can use the B<Irq>-option to pick the interrupt you're interested in.
2269 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2270 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2271 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2272 and all other interrupts are collected.
2276 =head2 Plugin C<java>
2278 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2279 This section only discusses the syntax and semantic of the configuration
2280 options. For more in-depth information on the I<Java> plugin, please read
2281 L<collectd-java(5)>.
2286 JVMArg "-verbose:jni"
2287 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2288 LoadPlugin "org.collectd.java.Foobar"
2289 <Plugin "org.collectd.java.Foobar">
2290 # To be parsed by the plugin
2294 Available configuration options:
2298 =item B<JVMArg> I<Argument>
2300 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2301 exactly the way the arguments to the I<java> binary on the command line work.
2302 Execute C<javaE<nbsp>--help> for details.
2304 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2305 any other options! When another option is found, the JVM will be started and
2306 later options will have to be ignored!
2308 =item B<LoadPlugin> I<JavaClass>
2310 Instantiates a new I<JavaClass> object. The constructor of this object very
2311 likely then registers one or more callback methods with the server.
2313 See L<collectd-java(5)> for details.
2315 When the first such option is found, the virtual machine (JVM) is created. This
2316 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2317 B<LoadPlugin> options!
2319 =item B<Plugin> I<Name>
2321 The entire block is passed to the Java plugin as an
2322 I<org.collectd.api.OConfigItem> object.
2324 For this to work, the plugin has to register a configuration callback first,
2325 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2326 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2327 depends on the (Java) plugin registering the callback and is completely
2328 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2332 =head2 Plugin C<libvirt>
2334 This plugin allows CPU, disk and network load to be collected for virtualized
2335 guests on the machine. This means that these characteristics can be collected
2336 for guest systems without installing any software on them - collectd only runs
2337 on the hosting system. The statistics are collected through libvirt
2338 (L<http://libvirt.org/>).
2340 Only I<Connection> is required.
2344 =item B<Connection> I<uri>
2346 Connect to the hypervisor given by I<uri>. For example if using Xen use:
2348 Connection "xen:///"
2350 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
2352 =item B<RefreshInterval> I<seconds>
2354 Refresh the list of domains and devices every I<seconds>. The default is 60
2355 seconds. Setting this to be the same or smaller than the I<Interval> will cause
2356 the list of domains and devices to be refreshed on every iteration.
2358 Refreshing the devices in particular is quite a costly operation, so if your
2359 virtualization setup is static you might consider increasing this. If this
2360 option is set to 0, refreshing is disabled completely.
2362 =item B<Domain> I<name>
2364 =item B<BlockDevice> I<name:dev>
2366 =item B<InterfaceDevice> I<name:dev>
2368 =item B<IgnoreSelected> I<true>|I<false>
2370 Select which domains and devices are collected.
2372 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
2373 disk/network devices are collected.
2375 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
2376 domains and disk/network devices are ignored, while the rest are collected.
2378 The domain name and device names may use a regular expression, if the name is
2379 surrounded by I</.../> and collectd was compiled with support for regexps.
2381 The default is to collect statistics for all domains and all their devices.
2385 BlockDevice "/:hdb/"
2386 IgnoreSelected "true"
2388 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
2391 =item B<HostnameFormat> B<name|uuid|hostname|...>
2393 When the libvirt plugin logs data, it sets the hostname of the collected data
2394 according to this setting. The default is to use the guest name as provided by
2395 the hypervisor, which is equal to setting B<name>.
2397 B<uuid> means use the guest's UUID. This is useful if you want to track the
2398 same guest across migrations.
2400 B<hostname> means to use the global B<Hostname> setting, which is probably not
2401 useful on its own because all guests will appear to have the same name.
2403 You can also specify combinations of these fields. For example B<name uuid>
2404 means to concatenate the guest name and UUID (with a literal colon character
2405 between, thus I<"foo:1234-1234-1234-1234">).
2407 =item B<InterfaceFormat> B<name>|B<address>
2409 When the libvirt plugin logs interface data, it sets the name of the collected
2410 data according to this setting. The default is to use the path as provided by
2411 the hypervisor (the "dev" property of the target node), which is equal to
2414 B<address> means use the interface's mac address. This is useful since the
2415 interface path might change between reboots of a guest or across migrations.
2417 =item B<PluginInstanceFormat> B<name|uuid>
2419 When the libvirt plugin logs data, it sets the plugin_instance of the collected
2420 data according to this setting. The default is to use the guest name as provided
2421 by the hypervisor, which is equal to setting B<name>.
2423 B<uuid> means use the guest's UUID.
2427 +=head2 Plugin C<load>
2429 The I<Load plugin> collects the system load. These numbers give a rough overview
2430 over the utilization of a machine. The system load is defined as the number of
2431 runnable tasks in the run-queue and is provided by many operating systems as a
2432 one, five or fifteen minute average.
2434 The following configuration options are available:
2438 =item B<ReportRelative> B<false>|B<true>
2440 When enabled, system load divided by number of available CPU cores is reported
2441 for intervals 1 min, 5 min and 15 min. Defaults to false.
2446 =head2 Plugin C<logfile>
2450 =item B<LogLevel> B<debug|info|notice|warning|err>
2452 Sets the log-level. If, for example, set to B<notice>, then all events with
2453 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2455 Please note that B<debug> is only available if collectd has been compiled with
2458 =item B<File> I<File>
2460 Sets the file to write log messages to. The special strings B<stdout> and
2461 B<stderr> can be used to write to the standard output and standard error
2462 channels, respectively. This, of course, only makes much sense when I<collectd>
2463 is running in foreground- or non-daemon-mode.
2465 =item B<Timestamp> B<true>|B<false>
2467 Prefix all lines printed by the current time. Defaults to B<true>.
2469 =item B<PrintSeverity> B<true>|B<false>
2471 When enabled, all lines are prefixed by the severity of the log message, for
2472 example "warning". Defaults to B<false>.
2476 B<Note>: There is no need to notify the daemon after moving or removing the
2477 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2478 for each line it writes.
2480 =head2 Plugin C<log_logstash>
2482 The I<log logstash plugin> behaves like the logfile plugin but formats
2483 messages as JSON events for logstash to parse and input.
2487 =item B<LogLevel> B<debug|info|notice|warning|err>
2489 Sets the log-level. If, for example, set to B<notice>, then all events with
2490 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2492 Please note that B<debug> is only available if collectd has been compiled with
2495 =item B<File> I<File>
2497 Sets the file to write log messages to. The special strings B<stdout> and
2498 B<stderr> can be used to write to the standard output and standard error
2499 channels, respectively. This, of course, only makes much sense when I<collectd>
2500 is running in foreground- or non-daemon-mode.
2504 B<Note>: There is no need to notify the daemon after moving or removing the
2505 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2506 for each line it writes.
2508 =head2 Plugin C<lpar>
2510 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2511 virtualization technique for IBM POWER processors. It takes into account CPU
2512 time stolen from or donated to a partition, in addition to the usual user,
2513 system, I/O statistics.
2515 The following configuration options are available:
2519 =item B<CpuPoolStats> B<false>|B<true>
2521 When enabled, statistics about the processor pool are read, too. The partition
2522 needs to have pool authority in order to be able to acquire this information.
2525 =item B<ReportBySerial> B<false>|B<true>
2527 If enabled, the serial of the physical machine the partition is currently
2528 running on is reported as I<hostname> and the logical hostname of the machine
2529 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2530 used (just like other plugins) and the I<plugin instance> will be empty.
2535 =head2 Plugin C<mbmon>
2537 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2539 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2540 B<Host> and B<Port> options can be used to change these values, see below.
2541 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2542 timeouts may appear which may interfere with other statistics..
2544 C<mbmon> must be run with the -r option ("print TAG and Value format");
2545 Debian's F</etc/init.d/mbmon> script already does this, other people
2546 will need to ensure that this is the case.
2550 =item B<Host> I<Hostname>
2552 Hostname to connect to. Defaults to B<127.0.0.1>.
2554 =item B<Port> I<Port>
2556 TCP-Port to connect to. Defaults to B<411>.
2562 The C<md plugin> collects information from Linux Software-RAID devices (md).
2564 All reported values are of the type C<md_disks>. Reported type instances are
2565 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2566 I<missing> (physically absent) disks.
2570 =item B<Device> I<Device>
2572 Select md devices based on device name. The I<device name> is the basename of
2573 the device, i.e. the name of the block device without the leading C</dev/>.
2574 See B<IgnoreSelected> for more details.
2576 =item B<IgnoreSelected> B<true>|B<false>
2578 Invert device selection: If set to B<true>, all md devices B<except> those
2579 listed using B<Device> are collected. If B<false> (the default), only those
2580 listed are collected. If no configuration is given, the B<md> plugin will
2581 collect data from all md devices.
2585 =head2 Plugin C<memcachec>
2587 The C<memcachec plugin> connects to a memcached server, queries one or more
2588 given I<pages> and parses the returned data according to user specification.
2589 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2592 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2593 library. Please note that there is another library with a very similar name,
2594 libmemcache (notice the missing `d'), which is not applicable.
2596 Synopsis of the configuration:
2598 <Plugin "memcachec">
2599 <Page "plugin_instance">
2603 Regex "(\\d+) bytes sent"
2606 Instance "type_instance"
2611 The configuration options are:
2615 =item E<lt>B<Page> I<Name>E<gt>
2617 Each B<Page> block defines one I<page> to be queried from the memcached server.
2618 The block requires one string argument which is used as I<plugin instance>.
2620 =item B<Server> I<Address>
2622 Sets the server address to connect to when querying the page. Must be inside a
2627 When connected to the memcached server, asks for the page I<Key>.
2629 =item E<lt>B<Match>E<gt>
2631 Match blocks define which strings to look for and how matches substrings are
2632 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2636 =head2 Plugin C<memcached>
2638 The B<memcached plugin> connects to a memcached server and queries statistics
2639 about cache utilization, memory and bandwidth used.
2640 L<http://www.danga.com/memcached/>
2642 <Plugin "memcached">
2644 Host "memcache.example.com"
2649 The plugin configuration consists of one or more B<Instance> blocks which
2650 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2651 following options are allowed:
2655 =item B<Host> I<Hostname>
2657 Hostname to connect to. Defaults to B<127.0.0.1>.
2659 =item B<Port> I<Port>
2661 TCP-Port to connect to. Defaults to B<11211>.
2663 =item B<Socket> I<Path>
2665 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2666 setting is given, the B<Host> and B<Port> settings are ignored.
2670 =head2 Plugin C<mic>
2672 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2673 Intel's Many Integrated Core (MIC) systems.
2682 ShowTemperatures true
2685 IgnoreSelectedTemperature true
2690 IgnoreSelectedPower true
2693 The following options are valid inside the B<PluginE<nbsp>mic> block:
2697 =item B<ShowCPU> B<true>|B<false>
2699 If enabled (the default) a sum of the CPU usage across all cores is reported.
2701 =item B<ShowCPUCores> B<true>|B<false>
2703 If enabled (the default) per-core CPU usage is reported.
2705 =item B<ShowMemory> B<true>|B<false>
2707 If enabled (the default) the physical memory usage of the MIC system is
2710 =item B<ShowTemperatures> B<true>|B<false>
2712 If enabled (the default) various temperatures of the MIC system are reported.
2714 =item B<Temperature> I<Name>
2716 This option controls which temperatures are being reported. Whether matching
2717 temperatures are being ignored or I<only> matching temperatures are reported
2718 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2719 temperatures are reported.
2721 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2723 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2724 (the default) only temperatures matching a B<Temperature> option are reported
2725 or, if no B<Temperature> option is specified, all temperatures are reported. If
2726 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2729 Known temperature names are:
2763 =item B<ShowPower> B<true>|B<false>
2765 If enabled (the default) various temperatures of the MIC system are reported.
2767 =item B<Power> I<Name>
2769 This option controls which power readings are being reported. Whether matching
2770 power readings are being ignored or I<only> matching power readings are reported
2771 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
2772 power readings are reported.
2774 =item B<IgnoreSelectedPower> B<false>|B<true>
2776 Controls the behavior of the B<Power> setting above. If set to B<false>
2777 (the default) only power readings matching a B<Power> option are reported
2778 or, if no B<Power> option is specified, all power readings are reported. If
2779 set to B<true>, matching power readings are I<ignored> and all other power readings
2782 Known power names are:
2788 Total power utilization averaged over Time Window 0 (uWatts).
2792 Total power utilization averaged over Time Window 0 (uWatts).
2796 Instantaneous power (uWatts).
2800 Max instantaneous power (uWatts).
2804 PCI-E connector power (uWatts).
2808 2x3 connector power (uWatts).
2812 2x4 connector power (uWatts).
2820 Uncore rail (uVolts).
2824 Memory subsystem rail (uVolts).
2830 =head2 Plugin C<memory>
2832 The I<memory plugin> provides the following configuration options:
2836 =item B<ValuesAbsolute> B<true>|B<false>
2838 Enables or disables reporting of physical memory usage in absolute numbers,
2839 i.e. bytes. Defaults to B<true>.
2841 =item B<ValuesPercentage> B<false>|B<true>
2843 Enables or disables reporting of physical memory usage in percentages, e.g.
2844 percent of physical memory used. Defaults to B<false>.
2846 This is useful for deploying I<collectd> in a heterogeneous environment in
2847 which the sizes of physical memory vary.
2851 =head2 Plugin C<modbus>
2853 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
2854 register values. It supports reading single registers (unsigned 16E<nbsp>bit
2855 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2856 values (two registers interpreted as IEEE floats in big endian notation).
2860 <Data "voltage-input-1">
2867 <Data "voltage-input-2">
2874 <Host "modbus.example.com">
2875 Address "192.168.0.42"
2880 Instance "power-supply"
2881 Collect "voltage-input-1"
2882 Collect "voltage-input-2"
2888 =item E<lt>B<Data> I<Name>E<gt> blocks
2890 Data blocks define a mapping between register numbers and the "types" used by
2893 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
2897 =item B<RegisterBase> I<Number>
2899 Configures the base register to read from the device. If the option
2900 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
2901 register will be read (the register number is increased by one).
2903 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
2905 Specifies what kind of data is returned by the device. If the type is B<Int32>,
2906 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
2907 combined into one value. Defaults to B<Uint16>.
2909 =item B<Type> I<Type>
2911 Specifies the "type" (data set) to use when dispatching the value to
2912 I<collectd>. Currently, only data sets with exactly one data source are
2915 =item B<Instance> I<Instance>
2917 Sets the type instance to use when dispatching the value to I<collectd>. If
2918 unset, an empty string (no type instance) is used.
2922 =item E<lt>B<Host> I<Name>E<gt> blocks
2924 Host blocks are used to specify to which hosts to connect and what data to read
2925 from their "slaves". The string argument I<Name> is used as hostname when
2926 dispatching the values to I<collectd>.
2928 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
2932 =item B<Address> I<Hostname>
2934 Specifies the node name (the actual network address) used to connect to the
2935 host. This may be an IP address or a hostname. Please note that the used
2936 I<libmodbus> library only supports IPv4 at the moment.
2938 =item B<Port> I<Service>
2940 Specifies the port used to connect to the host. The port can either be given as
2941 a number or as a service name. Please note that the I<Service> argument must be
2942 a string, even if ports are given in their numerical form. Defaults to "502".
2944 =item B<Interval> I<Interval>
2946 Sets the interval (in seconds) in which the values will be collected from this
2947 host. By default the global B<Interval> setting will be used.
2949 =item E<lt>B<Slave> I<ID>E<gt>
2951 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
2952 is used to specify which device should be addressed. For each device you want
2953 to query, one B<Slave> block must be given.
2955 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
2959 =item B<Instance> I<Instance>
2961 Specify the plugin instance to use when dispatching the values to I<collectd>.
2962 By default "slave_I<ID>" is used.
2964 =item B<Collect> I<DataName>
2966 Specifies which data to retrieve from the device. I<DataName> must be the same
2967 string as the I<Name> argument passed to a B<Data> block. You can specify this
2968 option multiple times to collect more than one value from a slave. At least one
2969 B<Collect> option is mandatory.
2977 =head2 Plugin C<mysql>
2979 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
2980 one or more databases when started and keeps the connection up as long as
2981 possible. When the connection is interrupted for whatever reason it will try
2982 to re-connect. The plugin will complain loudly in case anything goes wrong.
2984 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
2985 and collects information about MySQL network traffic, executed statements,
2986 requests, the query cache and threads by evaluating the
2987 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
2988 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
2989 Status Variables> for an explanation of these values.
2991 Optionally, master and slave statistics may be collected in a MySQL
2992 replication setup. In that case, information about the synchronization state
2993 of the nodes are collected by evaluating the C<Position> return value of the
2994 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
2995 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
2996 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
2997 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
2998 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
3015 Socket "/var/run/mysql/mysqld.sock"
3017 SlaveNotifications true
3021 A B<Database> block defines one connection to a MySQL database. It accepts a
3022 single argument which specifies the name of the database. None of the other
3023 options are required. MySQL will use default values as documented in the
3024 section "mysql_real_connect()" in the B<MySQL reference manual>.
3028 =item B<Alias> I<Alias>
3030 Alias to use as sender instead of hostname when reporting. This may be useful
3031 when having cryptic hostnames.
3033 =item B<Host> I<Hostname>
3035 Hostname of the database server. Defaults to B<localhost>.
3037 =item B<User> I<Username>
3039 Username to use when connecting to the database. The user does not have to be
3040 granted any privileges (which is synonym to granting the C<USAGE> privilege),
3041 unless you want to collectd replication statistics (see B<MasterStats> and
3042 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
3043 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
3045 =item B<Password> I<Password>
3047 Password needed to log into the database.
3049 =item B<Database> I<Database>
3051 Select this database. Defaults to I<no database> which is a perfectly reasonable
3052 option for what this plugin does.
3054 =item B<Port> I<Port>
3056 TCP-port to connect to. The port must be specified in its numeric form, but it
3057 must be passed as a string nonetheless. For example:
3061 If B<Host> is set to B<localhost> (the default), this setting has no effect.
3062 See the documentation for the C<mysql_real_connect> function for details.
3064 =item B<Socket> I<Socket>
3066 Specifies the path to the UNIX domain socket of the MySQL server. This option
3067 only has any effect, if B<Host> is set to B<localhost> (the default).
3068 Otherwise, use the B<Port> option above. See the documentation for the
3069 C<mysql_real_connect> function for details.
3071 =item B<MasterStats> I<true|false>
3073 =item B<SlaveStats> I<true|false>
3075 Enable the collection of master / slave statistics in a replication setup. In
3076 order to be able to get access to these statistics, the user needs special
3077 privileges. See the B<User> documentation above.
3079 =item B<SlaveNotifications> I<true|false>
3081 If enabled, the plugin sends a notification if the replication slave I/O and /
3082 or SQL threads are not running.
3084 =item B<ConnectTimeout> I<Seconds>
3086 Sets the connect timeout for the MySQL client.
3090 =head2 Plugin C<netapp>
3092 The netapp plugin can collect various performance and capacity information
3093 from a NetApp filer using the NetApp API.
3095 Please note that NetApp has a wide line of products and a lot of different
3096 software versions for each of these products. This plugin was developed for a
3097 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
3098 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
3099 model and software version but it is very hard to test this.
3100 If you have used this plugin with other models and/or software version, feel
3101 free to send us a mail to tell us about the results, even if it's just a short
3104 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
3105 basic authentication.
3107 B<Do not use a regular user for this!> Create a special collectd user with just
3108 the minimum of capabilities needed. The user only needs the "login-http-admin"
3109 capability as well as a few more depending on which data will be collected.
3110 Required capabilities are documented below.
3115 <Host "netapp1.example.com">
3139 IgnoreSelectedIO false
3141 IgnoreSelectedOps false
3142 GetLatency "volume0"
3143 IgnoreSelectedLatency false
3150 IgnoreSelectedCapacity false
3153 IgnoreSelectedSnapshot false
3181 The netapp plugin accepts the following configuration options:
3185 =item B<Host> I<Name>
3187 A host block defines one NetApp filer. It will appear in collectd with the name
3188 you specify here which does not have to be its real name nor its hostname (see
3189 the B<Address> option below).
3191 =item B<VFiler> I<Name>
3193 A B<VFiler> block may only be used inside a host block. It accepts all the
3194 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
3195 will execute all NetApp API commands in the context of the specified
3196 VFiler(R). It will appear in collectd with the name you specify here which
3197 does not have to be its real name. The VFiler name may be specified using the
3198 B<VFilerName> option. If this is not specified, it will default to the name
3201 The VFiler block inherits all connection related settings from the surrounding
3202 B<Host> block (which appear before the B<VFiler> block) but they may be
3203 overwritten inside the B<VFiler> block.
3205 This feature is useful, for example, when using a VFiler as SnapVault target
3206 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
3207 available in the host filer (vfiler0) but only in the respective VFiler
3210 =item B<Protocol> B<httpd>|B<http>
3212 The protocol collectd will use to query this host.
3220 Valid options: http, https
3222 =item B<Address> I<Address>
3224 The hostname or IP address of the host.
3230 Default: The "host" block's name.
3232 =item B<Port> I<Port>
3234 The TCP port to connect to on the host.
3240 Default: 80 for protocol "http", 443 for protocol "https"
3242 =item B<User> I<User>
3244 =item B<Password> I<Password>
3246 The username and password to use to login to the NetApp.
3252 =item B<VFilerName> I<Name>
3254 The name of the VFiler in which context to execute API commands. If not
3255 specified, the name provided to the B<VFiler> block will be used instead.
3261 Default: name of the B<VFiler> block
3263 B<Note:> This option may only be used inside B<VFiler> blocks.
3265 =item B<Interval> I<Interval>
3271 The following options decide what kind of data will be collected. You can
3272 either use them as a block and fine tune various parameters inside this block,
3273 use them as a single statement to just accept all default values, or omit it to
3274 not collect any data.
3276 The following options are valid inside all blocks:
3280 =item B<Interval> I<Seconds>
3282 Collect the respective statistics every I<Seconds> seconds. Defaults to the
3283 host specific setting.
3287 =head3 The System block
3289 This will collect various performance data about the whole system.
3291 B<Note:> To get this data the collectd user needs the
3292 "api-perf-object-get-instances" capability.
3296 =item B<Interval> I<Seconds>
3298 Collect disk statistics every I<Seconds> seconds.
3300 =item B<GetCPULoad> B<true>|B<false>
3302 If you set this option to true the current CPU usage will be read. This will be
3303 the average usage between all CPUs in your NetApp without any information about
3306 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3307 returns in the "CPU" field.
3315 Result: Two value lists of type "cpu", and type instances "idle" and "system".
3317 =item B<GetInterfaces> B<true>|B<false>
3319 If you set this option to true the current traffic of the network interfaces
3320 will be read. This will be the total traffic over all interfaces of your NetApp
3321 without any information about individual interfaces.
3323 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3324 in the "Net kB/s" field.
3334 Result: One value list of type "if_octects".
3336 =item B<GetDiskIO> B<true>|B<false>
3338 If you set this option to true the current IO throughput will be read. This
3339 will be the total IO of your NetApp without any information about individual
3340 disks, volumes or aggregates.
3342 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3343 in the "DiskE<nbsp>kB/s" field.
3351 Result: One value list of type "disk_octets".
3353 =item B<GetDiskOps> B<true>|B<false>
3355 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
3356 iSCSI, etc. operations will be read. This will be the total number of
3357 operations on your NetApp without any information about individual volumes or
3360 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3361 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
3369 Result: A variable number of value lists of type "disk_ops_complex". Each type
3370 of operation will result in one value list with the name of the operation as
3375 =head3 The WAFL block
3377 This will collect various performance data about the WAFL file system. At the
3378 moment this just means cache performance.
3380 B<Note:> To get this data the collectd user needs the
3381 "api-perf-object-get-instances" capability.
3383 B<Note:> The interface to get these values is classified as "Diagnostics" by
3384 NetApp. This means that it is not guaranteed to be stable even between minor
3389 =item B<Interval> I<Seconds>
3391 Collect disk statistics every I<Seconds> seconds.
3393 =item B<GetNameCache> B<true>|B<false>
3401 Result: One value list of type "cache_ratio" and type instance
3404 =item B<GetDirCache> B<true>|B<false>
3412 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3414 =item B<GetInodeCache> B<true>|B<false>
3422 Result: One value list of type "cache_ratio" and type instance
3425 =item B<GetBufferCache> B<true>|B<false>
3427 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3428 in the "Cache hit" field.
3436 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3440 =head3 The Disks block
3442 This will collect performance data about the individual disks in the NetApp.
3444 B<Note:> To get this data the collectd user needs the
3445 "api-perf-object-get-instances" capability.
3449 =item B<Interval> I<Seconds>
3451 Collect disk statistics every I<Seconds> seconds.
3453 =item B<GetBusy> B<true>|B<false>
3455 If you set this option to true the busy time of all disks will be calculated
3456 and the value of the busiest disk in the system will be written.
3458 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3459 in the "Disk util" field. Probably.
3467 Result: One value list of type "percent" and type instance "disk_busy".
3471 =head3 The VolumePerf block
3473 This will collect various performance data about the individual volumes.
3475 You can select which data to collect about which volume using the following
3476 options. They follow the standard ignorelist semantic.
3478 B<Note:> To get this data the collectd user needs the
3479 I<api-perf-object-get-instances> capability.
3483 =item B<Interval> I<Seconds>
3485 Collect volume performance data every I<Seconds> seconds.
3487 =item B<GetIO> I<Volume>
3489 =item B<GetOps> I<Volume>
3491 =item B<GetLatency> I<Volume>
3493 Select the given volume for IO, operations or latency statistics collection.
3494 The argument is the name of the volume without the C</vol/> prefix.
3496 Since the standard ignorelist functionality is used here, you can use a string
3497 starting and ending with a slash to specify regular expression matching: To
3498 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3501 GetIO "/^vol[027]$/"
3503 If no regular expression is specified, an exact match is required. Both,
3504 regular and exact matching are case sensitive.
3506 If no volume was specified at all for either of the three options, that data
3507 will be collected for all available volumes.
3509 =item B<IgnoreSelectedIO> B<true>|B<false>
3511 =item B<IgnoreSelectedOps> B<true>|B<false>
3513 =item B<IgnoreSelectedLatency> B<true>|B<false>
3515 When set to B<true>, the volumes selected for IO, operations or latency
3516 statistics collection will be ignored and the data will be collected for all
3519 When set to B<false>, data will only be collected for the specified volumes and
3520 all other volumes will be ignored.
3522 If no volumes have been specified with the above B<Get*> options, all volumes
3523 will be collected regardless of the B<IgnoreSelected*> option.
3525 Defaults to B<false>
3529 =head3 The VolumeUsage block
3531 This will collect capacity data about the individual volumes.
3533 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3538 =item B<Interval> I<Seconds>
3540 Collect volume usage statistics every I<Seconds> seconds.
3542 =item B<GetCapacity> I<VolumeName>
3544 The current capacity of the volume will be collected. This will result in two
3545 to four value lists, depending on the configuration of the volume. All data
3546 sources are of type "df_complex" with the name of the volume as
3549 There will be type_instances "used" and "free" for the number of used and
3550 available bytes on the volume. If the volume has some space reserved for
3551 snapshots, a type_instance "snap_reserved" will be available. If the volume
3552 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3553 number of bytes saved by the SIS feature.
3555 B<Note:> The current NetApp API has a bug that results in this value being
3556 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3557 number which works most of the time. If you see strange values here, bug
3558 NetApp support to fix this.
3560 Repeat this option to specify multiple volumes.
3562 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3564 Specify whether to collect only the volumes selected by the B<GetCapacity>
3565 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3566 B<false>. However, if no B<GetCapacity> option is specified at all, all
3567 capacities will be selected anyway.
3569 =item B<GetSnapshot> I<VolumeName>
3571 Select volumes from which to collect snapshot information.
3573 Usually, the space used for snapshots is included in the space reported as
3574 "used". If snapshot information is collected as well, the space used for
3575 snapshots is subtracted from the used space.
3577 To make things even more interesting, it is possible to reserve space to be
3578 used for snapshots. If the space required for snapshots is less than that
3579 reserved space, there is "reserved free" and "reserved used" space in addition
3580 to "free" and "used". If the space required for snapshots exceeds the reserved
3581 space, that part allocated in the normal space is subtracted from the "used"
3584 Repeat this option to specify multiple volumes.
3586 =item B<IgnoreSelectedSnapshot>
3588 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3589 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3590 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3591 capacities will be selected anyway.
3595 =head3 The Quota block
3597 This will collect (tree) quota statistics (used disk space and number of used
3598 files). This mechanism is useful to get usage information for single qtrees.
3599 In case the quotas are not used for any other purpose, an entry similar to the
3600 following in C</etc/quotas> would be sufficient:
3602 /vol/volA/some_qtree tree - - - - -
3604 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3608 =item B<Interval> I<Seconds>
3610 Collect SnapVault(R) statistics every I<Seconds> seconds.
3614 =head3 The SnapVault block
3616 This will collect statistics about the time and traffic of SnapVault(R)
3621 =item B<Interval> I<Seconds>
3623 Collect SnapVault(R) statistics every I<Seconds> seconds.
3627 =head2 Plugin C<netlink>
3629 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3630 statistics of various interface and routing aspects.
3634 =item B<Interface> I<Interface>
3636 =item B<VerboseInterface> I<Interface>
3638 Instruct the plugin to collect interface statistics. This is basically the same
3639 as the statistics provided by the C<interface> plugin (see above) but
3640 potentially much more detailed.
3642 When configuring with B<Interface> only the basic statistics will be collected,
3643 namely octets, packets, and errors. These statistics are collected by
3644 the C<interface> plugin, too, so using both at the same time is no benefit.
3646 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3647 so that no data needs to be collected twice if you use the C<interface> plugin.
3648 This includes dropped packets, received multicast packets, collisions and a
3649 whole zoo of differentiated RX and TX errors. You can try the following command
3650 to get an idea of what awaits you:
3654 If I<Interface> is B<All>, all interfaces will be selected.
3656 =item B<QDisc> I<Interface> [I<QDisc>]
3658 =item B<Class> I<Interface> [I<Class>]
3660 =item B<Filter> I<Interface> [I<Filter>]
3662 Collect the octets and packets that pass a certain qdisc, class or filter.
3664 QDiscs and classes are identified by their type and handle (or classid).
3665 Filters don't necessarily have a handle, therefore the parent's handle is used.
3666 The notation used in collectd differs from that used in tc(1) in that it
3667 doesn't skip the major or minor number if it's zero and doesn't print special
3668 ids by their name. So, for example, a qdisc may be identified by
3669 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3670 thus not displayed by tc(1).
3672 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3673 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3674 associated with that interface will be collected.
3676 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3677 used. This may lead to problems when more than one filter is attached to a
3678 qdisc or class. This isn't nice, but we don't know how this could be done any
3679 better. If you have a idea, please don't hesitate to tell us.
3681 As with the B<Interface> option you can specify B<All> as the interface,
3682 meaning all interfaces.
3684 Here are some examples to help you understand the above text more easily:
3687 VerboseInterface "All"
3688 QDisc "eth0" "pfifo_fast-1:0"
3690 Class "ppp0" "htb-1:10"
3691 Filter "ppp0" "u32-1:0"
3694 =item B<IgnoreSelected>
3696 The behavior is the same as with all other similar plugins: If nothing is
3697 selected at all, everything is collected. If some things are selected using the
3698 options described above, only these statistics are collected. If you set
3699 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3700 specified statistics will not be collected.
3704 =head2 Plugin C<network>
3706 The Network plugin sends data to a remote instance of collectd, receives data
3707 from a remote instance, or both at the same time. Data which has been received
3708 from the network is usually not transmitted again, but this can be activated, see
3709 the B<Forward> option below.
3711 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3712 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3714 Both, B<Server> and B<Listen> can be used as single option or as block. When
3715 used as block, given options are valid for this socket only. The following
3716 example will export the metrics twice: Once to an "internal" server (without
3717 encryption and signing) and one to an external server (with cryptographic
3721 # Export to an internal server
3722 # (demonstrates usage without additional options)
3723 Server "collectd.internal.tld"
3725 # Export to an external server
3726 # (demonstrates usage with signature options)
3727 <Server "collectd.external.tld">
3728 SecurityLevel "sign"
3729 Username "myhostname"
3736 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3738 The B<Server> statement/block sets the server to send datagrams to. The
3739 statement may occur multiple times to send each datagram to multiple
3742 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3743 optional second argument specifies a port number or a service name. If not
3744 given, the default, B<25826>, is used.
3746 The following options are recognized within B<Server> blocks:
3750 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3752 Set the security you require for network communication. When the security level
3753 has been set to B<Encrypt>, data sent over the network will be encrypted using
3754 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3755 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3756 authentication code. When set to B<None>, data is sent without any security.
3758 This feature is only available if the I<network> plugin was linked with
3761 =item B<Username> I<Username>
3763 Sets the username to transmit. This is used by the server to lookup the
3764 password. See B<AuthFile> below. All security levels except B<None> require
3767 This feature is only available if the I<network> plugin was linked with
3770 =item B<Password> I<Password>
3772 Sets a password (shared secret) for this socket. All security levels except
3773 B<None> require this setting.
3775 This feature is only available if the I<network> plugin was linked with
3778 =item B<Interface> I<Interface name>
3780 Set the outgoing interface for IP packets. This applies at least
3781 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3782 undefined or a non-existent interface name is specified, the default
3783 behavior is to let the kernel choose the appropriate interface. Be warned
3784 that the manual selection of an interface for unicast traffic is only
3785 necessary in rare cases.
3789 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
3791 The B<Listen> statement sets the interfaces to bind to. When multiple
3792 statements are found the daemon will bind to multiple interfaces.
3794 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
3795 the argument is a multicast address the daemon will join that multicast group.
3796 The optional second argument specifies a port number or a service name. If not
3797 given, the default, B<25826>, is used.
3799 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
3803 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3805 Set the security you require for network communication. When the security level
3806 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
3807 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
3808 signed and encrypted data is accepted. When set to B<None>, all data will be
3809 accepted. If an B<AuthFile> option was given (see below), encrypted data is
3810 decrypted if possible.
3812 This feature is only available if the I<network> plugin was linked with
3815 =item B<AuthFile> I<Filename>
3817 Sets a file in which usernames are mapped to passwords. These passwords are
3818 used to verify signatures and to decrypt encrypted network packets. If
3819 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
3820 verified and encrypted packets are decrypted. Otherwise, signed data is
3821 accepted without checking the signature and encrypted data cannot be decrypted.
3822 For the other security levels this option is mandatory.
3824 The file format is very simple: Each line consists of a username followed by a
3825 colon and any number of spaces followed by the password. To demonstrate, an
3826 example file could look like this:
3831 Each time a packet is received, the modification time of the file is checked
3832 using L<stat(2)>. If the file has been changed, the contents is re-read. While
3833 the file is being read, it is locked using L<fcntl(2)>.
3835 =item B<Interface> I<Interface name>
3837 Set the incoming interface for IP packets explicitly. This applies at least
3838 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3839 undefined or a non-existent interface name is specified, the default
3840 behavior is, to let the kernel choose the appropriate interface. Thus incoming
3841 traffic gets only accepted, if it arrives on the given interface.
3845 =item B<TimeToLive> I<1-255>
3847 Set the time-to-live of sent packets. This applies to all, unicast and
3848 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
3849 That means that multicast packets will be sent with a TTL of C<1> (one) on most
3852 =item B<MaxPacketSize> I<1024-65535>
3854 Set the maximum size for datagrams received over the network. Packets larger
3855 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
3856 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
3859 On the server side, this limit should be set to the largest value used on
3860 I<any> client. Likewise, the value on the client must not be larger than the
3861 value on the server, or data will be lost.
3863 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
3864 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
3865 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
3868 =item B<Forward> I<true|false>
3870 If set to I<true>, write packets that were received via the network plugin to
3871 the sending sockets. This should only be activated when the B<Listen>- and
3872 B<Server>-statements differ. Otherwise packets may be send multiple times to
3873 the same multicast group. While this results in more network traffic than
3874 necessary it's not a huge problem since the plugin has a duplicate detection,
3875 so the values will not loop.
3877 =item B<ReportStats> B<true>|B<false>
3879 The network plugin cannot only receive and send statistics, it can also create
3880 statistics about itself. Collected data included the number of received and
3881 sent octets and packets, the length of the receive queue and the number of
3882 values handled. When set to B<true>, the I<Network plugin> will make these
3883 statistics available. Defaults to B<false>.
3887 =head2 Plugin C<nginx>
3889 This plugin collects the number of connections and requests handled by the
3890 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
3891 queries the page provided by the C<ngx_http_stub_status_module> module, which
3892 isn't compiled by default. Please refer to
3893 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
3894 how to compile and configure nginx and this module.
3896 The following options are accepted by the C<nginx plugin>:
3900 =item B<URL> I<http://host/nginx_status>
3902 Sets the URL of the C<ngx_http_stub_status_module> output.
3904 =item B<User> I<Username>
3906 Optional user name needed for authentication.
3908 =item B<Password> I<Password>
3910 Optional password needed for authentication.
3912 =item B<VerifyPeer> B<true|false>
3914 Enable or disable peer SSL certificate verification. See
3915 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
3917 =item B<VerifyHost> B<true|false>
3919 Enable or disable peer host name verification. If enabled, the plugin checks
3920 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
3921 certificate matches the host name provided by the B<URL> option. If this
3922 identity check fails, the connection is aborted. Obviously, only works when
3923 connecting to a SSL enabled server. Enabled by default.
3925 =item B<CACert> I<File>
3927 File that holds one or more SSL certificates. If you want to use HTTPS you will
3928 possibly need this option. What CA certificates come bundled with C<libcurl>
3929 and are checked by default depends on the distribution you use.
3933 =head2 Plugin C<notify_desktop>
3935 This plugin sends a desktop notification to a notification daemon, as defined
3936 in the Desktop Notification Specification. To actually display the
3937 notifications, B<notification-daemon> is required and B<collectd> has to be
3938 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
3939 environment variables have to be set correctly) and the D-Bus message bus.
3941 The Desktop Notification Specification can be found at
3942 L<http://www.galago-project.org/specs/notification/>.
3946 =item B<OkayTimeout> I<timeout>
3948 =item B<WarningTimeout> I<timeout>
3950 =item B<FailureTimeout> I<timeout>
3952 Set the I<timeout>, in milliseconds, after which to expire the notification
3953 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
3954 been specified, the displayed notification will not be closed at all - the
3955 user has to do so herself. These options default to 5000. If a negative number
3956 has been specified, the default is used as well.
3960 =head2 Plugin C<notify_email>
3962 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
3963 configured email address.
3965 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
3967 Available configuration options:
3971 =item B<From> I<Address>
3973 Email address from which the emails should appear to come from.
3975 Default: C<root@localhost>
3977 =item B<Recipient> I<Address>
3979 Configures the email address(es) to which the notifications should be mailed.
3980 May be repeated to send notifications to multiple addresses.
3982 At least one B<Recipient> must be present for the plugin to work correctly.
3984 =item B<SMTPServer> I<Hostname>
3986 Hostname of the SMTP server to connect to.
3988 Default: C<localhost>
3990 =item B<SMTPPort> I<Port>
3992 TCP port to connect to.
3996 =item B<SMTPUser> I<Username>
3998 Username for ASMTP authentication. Optional.
4000 =item B<SMTPPassword> I<Password>
4002 Password for ASMTP authentication. Optional.
4004 =item B<Subject> I<Subject>
4006 Subject-template to use when sending emails. There must be exactly two
4007 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
4008 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
4011 Default: C<Collectd notify: %s@%s>
4015 =head2 Plugin C<ntpd>
4019 =item B<Host> I<Hostname>
4021 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
4023 =item B<Port> I<Port>
4025 UDP-Port to connect to. Defaults to B<123>.
4027 =item B<ReverseLookups> B<true>|B<false>
4029 Sets whether or not to perform reverse lookups on peers. Since the name or
4030 IP-address may be used in a filename it is recommended to disable reverse
4031 lookups. The default is to do reverse lookups to preserve backwards
4032 compatibility, though.
4034 =item B<IncludeUnitID> B<true>|B<false>
4036 When a peer is a refclock, include the unit ID in the I<type instance>.
4037 Defaults to B<false> for backward compatibility.
4039 If two refclock peers use the same driver and this is B<false>, the plugin will
4040 try to write simultaneous measurements from both to the same type instance.
4041 This will result in error messages in the log and only one set of measurements
4046 =head2 Plugin C<nut>
4050 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
4052 Add a UPS to collect data from. The format is identical to the one accepted by
4057 =head2 Plugin C<olsrd>
4059 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
4060 the Optimized Link State Routing daemon and reads information about the current
4061 state of the meshed network.
4063 The following configuration options are understood:
4067 =item B<Host> I<Host>
4069 Connect to I<Host>. Defaults to B<"localhost">.
4071 =item B<Port> I<Port>
4073 Specifies the port to connect to. This must be a string, even if you give the
4074 port as a number rather than a service name. Defaults to B<"2006">.
4076 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
4078 Specifies what information to collect about links, i.E<nbsp>e. direct
4079 connections of the daemon queried. If set to B<No>, no information is
4080 collected. If set to B<Summary>, the number of links and the average of all
4081 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
4082 If set to B<Detail> LQ and NLQ are collected per link.
4084 Defaults to B<Detail>.
4086 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
4088 Specifies what information to collect about routes of the daemon queried. If
4089 set to B<No>, no information is collected. If set to B<Summary>, the number of
4090 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
4091 metric and ETX are collected per route.
4093 Defaults to B<Summary>.
4095 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
4097 Specifies what information to collect about the global topology. If set to
4098 B<No>, no information is collected. If set to B<Summary>, the number of links
4099 in the entire topology and the average I<link quality> (LQ) is calculated.
4100 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
4102 Defaults to B<Summary>.
4106 =head2 Plugin C<onewire>
4108 B<EXPERIMENTAL!> See notes below.
4110 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
4111 L<http://owfs.org/> to read sensors connected via the onewire bus.
4113 It can be used in two possible modes - standard or advanced.
4115 In the standard mode only temperature sensors (sensors with the family code
4116 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
4117 other sensors you would like to have included, please send a sort request to
4118 the mailing list. You can select sensors to be read or to be ignored depending
4119 on the option B<IgnoreSelected>). When no list is provided the whole bus is
4120 walked and all sensors are read.
4122 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
4123 experimental, below.
4125 In the advanced mode you can configure any sensor to be read (only numerical
4126 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
4127 In this mode you have to list all the sensors. Neither default bus walk nor
4128 B<IgnoreSelected> are used here. Address and type (file) is extracted from
4129 the path automatically and should produce compatible structure with the "standard"
4130 mode (basically the path is expected as for example
4131 "/uncached/10.F10FCA000800/temperature" where it would extract address part
4132 "F10FCA000800" and the rest after the slash is considered the type - here
4134 There are two advantages to this mode - you can access virtually any sensor
4135 (not just temperature), select whether to use cached or directly read values
4136 and it is slighlty faster. The downside is more complex configuration.
4138 The two modes are distinguished automatically by the format of the address.
4139 It is not possible to mix the two modes. Once a full path is detected in any
4140 B<Sensor> then the whole addressing (all sensors) is considered to be this way
4141 (and as standard addresses will fail parsing they will be ignored).
4145 =item B<Device> I<Device>
4147 Sets the device to read the values from. This can either be a "real" hardware
4148 device, such as a serial port or an USB port, or the address of the
4149 L<owserver(1)> socket, usually B<localhost:4304>.
4151 Though the documentation claims to automatically recognize the given address
4152 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
4153 with that version, the following configuration worked for us:
4156 Device "-s localhost:4304"
4159 This directive is B<required> and does not have a default value.
4161 =item B<Sensor> I<Sensor>
4163 In the standard mode selects sensors to collect or to ignore
4164 (depending on B<IgnoreSelected>, see below). Sensors are specified without
4165 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
4166 and B<not> include the leading C<10.> family byte and point.
4167 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
4168 sensors (see above) are read.
4170 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
4171 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
4172 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
4174 As there can be multiple devices on the bus you can list multiple sensor (use
4175 multiple B<Sensor> elements).
4177 =item B<IgnoreSelected> I<true>|I<false>
4179 If no configuration is given, the B<onewire> plugin will collect data from all
4180 sensors found. This may not be practical, especially if sensors are added and
4181 removed regularly. Sometimes, however, it's easier/preferred to collect only
4182 specific sensors or all sensors I<except> a few specified ones. This option
4183 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
4184 B<Sensor> is inverted: All selected interfaces are ignored and all other
4185 interfaces are collected.
4187 Used only in the standard mode - see above.
4189 =item B<Interval> I<Seconds>
4191 Sets the interval in which all sensors should be read. If not specified, the
4192 global B<Interval> setting is used.
4196 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
4197 work with big setups. It works with one sensor being attached to one
4198 controller, but as soon as you throw in a couple more senors and maybe a hub
4199 or two, reading all values will take more than ten seconds (the default
4200 interval). We will probably add some separate thread for reading the sensors
4201 and some cache or something like that, but it's not done yet. We will try to
4202 maintain backwards compatibility in the future, but we can't promise. So in
4203 short: If it works for you: Great! But keep in mind that the config I<might>
4204 change, though this is unlikely. Oh, and if you want to help improving this
4205 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
4207 =head2 Plugin C<openvpn>
4209 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
4210 traffic statistics about connected clients.
4212 To set up OpenVPN to write to the status file periodically, use the
4213 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
4214 you need to set the required format, too. This is done by setting
4215 B<--status-version> to B<2>.
4217 So, in a nutshell you need:
4219 openvpn $OTHER_OPTIONS \
4220 --status "/var/run/openvpn-status" 10 \
4227 =item B<StatusFile> I<File>
4229 Specifies the location of the status file.
4231 =item B<ImprovedNamingSchema> B<true>|B<false>
4233 When enabled, the filename of the status file will be used as plugin instance
4234 and the client's "common name" will be used as type instance. This is required
4235 when reading multiple status files. Enabling this option is recommended, but to
4236 maintain backwards compatibility this option is disabled by default.
4238 =item B<CollectCompression> B<true>|B<false>
4240 Sets whether or not statistics about the compression used by OpenVPN should be
4241 collected. This information is only available in I<single> mode. Enabled by
4244 =item B<CollectIndividualUsers> B<true>|B<false>
4246 Sets whether or not traffic information is collected for each connected client
4247 individually. If set to false, currently no traffic data is collected at all
4248 because aggregating this data in a save manner is tricky. Defaults to B<true>.
4250 =item B<CollectUserCount> B<true>|B<false>
4252 When enabled, the number of currently connected clients or users is collected.
4253 This is especially interesting when B<CollectIndividualUsers> is disabled, but
4254 can be configured independently from that option. Defaults to B<false>.
4258 =head2 Plugin C<oracle>
4260 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
4261 Oracle® Database and lets you execute SQL statements there. It is very similar
4262 to the "dbi" plugin, because it was written around the same time. See the "dbi"
4263 plugin's documentation above for details.
4266 <Query "out_of_stock">
4267 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
4270 # InstancePrefix "foo"
4271 InstancesFrom "category"
4275 <Database "product_information">
4279 Query "out_of_stock"
4283 =head3 B<Query> blocks
4285 The Query blocks are handled identically to the Query blocks of the "dbi"
4286 plugin. Please see its documentation above for details on how to specify
4289 =head3 B<Database> blocks
4291 Database blocks define a connection to a database and which queries should be
4292 sent to that database. Each database needs a "name" as string argument in the
4293 starting tag of the block. This name will be used as "PluginInstance" in the
4294 values submitted to the daemon. Other than that, that name is not used.
4298 =item B<ConnectID> I<ID>
4300 Defines the "database alias" or "service name" to connect to. Usually, these
4301 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
4303 =item B<Host> I<Host>
4305 Hostname to use when dispatching values for this database. Defaults to using
4306 the global hostname of the I<collectd> instance.
4308 =item B<Username> I<Username>
4310 Username used for authentication.
4312 =item B<Password> I<Password>
4314 Password used for authentication.
4316 =item B<Query> I<QueryName>
4318 Associates the query named I<QueryName> with this database connection. The
4319 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
4320 blocks you want to refer to must be placed above the database block you want to
4325 =head2 Plugin C<perl>
4327 This plugin embeds a Perl-interpreter into collectd and provides an interface
4328 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
4330 =head2 Plugin C<pinba>
4332 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
4333 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
4334 PHP-based webpage has been delivered, the extension will send a UDP packet
4335 containing timing information, peak memory usage and so on. The plugin will
4336 wait for such packets, parse them and account the provided information, which
4337 is then dispatched to the daemon once per interval.
4344 # Overall statistics for the website.
4346 Server "www.example.com"
4348 # Statistics for www-a only
4350 Host "www-a.example.com"
4351 Server "www.example.com"
4353 # Statistics for www-b only
4355 Host "www-b.example.com"
4356 Server "www.example.com"
4360 The plugin provides the following configuration options:
4364 =item B<Address> I<Node>
4366 Configures the address used to open a listening socket. By default, plugin will
4367 bind to the I<any> address C<::0>.
4369 =item B<Port> I<Service>
4371 Configures the port (service) to bind to. By default the default Pinba port
4372 "30002" will be used. The option accepts service names in addition to port
4373 numbers and thus requires a I<string> argument.
4375 =item E<lt>B<View> I<Name>E<gt> block
4377 The packets sent by the Pinba extension include the hostname of the server, the
4378 server name (the name of the virtual host) and the script that was executed.
4379 Using B<View> blocks it is possible to separate the data into multiple groups
4380 to get more meaningful statistics. Each packet is added to all matching groups,
4381 so that a packet may be accounted for more than once.
4385 =item B<Host> I<Host>
4387 Matches the hostname of the system the webserver / script is running on. This
4388 will contain the result of the L<gethostname(2)> system call. If not
4389 configured, all hostnames will be accepted.
4391 =item B<Server> I<Server>
4393 Matches the name of the I<virtual host>, i.e. the contents of the
4394 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
4395 server names will be accepted.
4397 =item B<Script> I<Script>
4399 Matches the name of the I<script name>, i.e. the contents of the
4400 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
4401 script names will be accepted.
4407 =head2 Plugin C<ping>
4409 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
4410 configured hosts periodically and measures the network latency. Whenever the
4411 C<read> function of the plugin is called, it submits the average latency, the
4412 standard deviation and the drop rate for each host.
4414 Available configuration options:
4418 =item B<Host> I<IP-address>
4420 Host to ping periodically. This option may be repeated several times to ping
4423 =item B<Interval> I<Seconds>
4425 Sets the interval in which to send ICMP echo packets to the configured hosts.
4426 This is B<not> the interval in which statistics are queries from the plugin but
4427 the interval in which the hosts are "pinged". Therefore, the setting here
4428 should be smaller than or equal to the global B<Interval> setting. Fractional
4429 times, such as "1.24" are allowed.
4433 =item B<Timeout> I<Seconds>
4435 Time to wait for a response from the host to which an ICMP packet had been
4436 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
4437 to be down or the packet to be dropped. This setting must be smaller than the
4438 B<Interval> setting above for the plugin to work correctly. Fractional
4439 arguments are accepted.
4443 =item B<TTL> I<0-255>
4445 Sets the Time-To-Live of generated ICMP packets.
4447 =item B<SourceAddress> I<host>
4449 Sets the source address to use. I<host> may either be a numerical network
4450 address or a network hostname.
4452 =item B<Device> I<name>
4454 Sets the outgoing network device to be used. I<name> has to specify an
4455 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
4458 =item B<MaxMissed> I<Packets>
4460 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
4461 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
4463 Default: B<-1> (disabled)
4467 =head2 Plugin C<postgresql>
4469 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
4470 keeps a persistent connection to all configured databases and tries to
4471 reconnect if the connection has been interrupted. A database is configured by
4472 specifying a B<Database> block as described below. The default statistics are
4473 collected from PostgreSQL's B<statistics collector> which thus has to be
4474 enabled for this plugin to work correctly. This should usually be the case by
4475 default. See the section "The Statistics Collector" of the B<PostgreSQL
4476 Documentation> for details.
4478 By specifying custom database queries using a B<Query> block as described
4479 below, you may collect any data that is available from some PostgreSQL
4480 database. This way, you are able to access statistics of external daemons
4481 which are available in a PostgreSQL database or use future or special
4482 statistics provided by PostgreSQL without the need to upgrade your collectd
4485 Starting with version 5.2, the C<postgresql> plugin supports writing data to
4486 PostgreSQL databases as well. This has been implemented in a generic way. You
4487 need to specify an SQL statement which will then be executed by collectd in
4488 order to write the data (see below for details). The benefit of that approach
4489 is that there is no fixed database layout. Rather, the layout may be optimized
4490 for the current setup.
4492 The B<PostgreSQL Documentation> manual can be found at
4493 L<http://www.postgresql.org/docs/manuals/>.
4497 Statement "SELECT magic FROM wizard WHERE host = $1;"
4501 InstancePrefix "magic"
4506 <Query rt36_tickets>
4507 Statement "SELECT COUNT(type) AS count, type \
4509 WHEN resolved = 'epoch' THEN 'open' \
4510 ELSE 'resolved' END AS type \
4511 FROM tickets) type \
4515 InstancePrefix "rt36_tickets"
4516 InstancesFrom "type"
4522 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
4532 KRBSrvName "kerberos_service_name"
4538 Service "service_name"
4539 Query backend # predefined
4550 The B<Query> block defines one database query which may later be used by a
4551 database definition. It accepts a single mandatory argument which specifies
4552 the name of the query. The names of all queries have to be unique (see the
4553 B<MinVersion> and B<MaxVersion> options below for an exception to this
4554 rule). The following configuration options are available to define the query:
4556 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
4557 blocks define how to handle the values returned from the query. They define
4558 which column holds which value and how to dispatch that value to the daemon.
4559 Multiple B<Result> blocks may be used to extract multiple values from a single
4564 =item B<Statement> I<sql query statement>
4566 Specify the I<sql query statement> which the plugin should execute. The string
4567 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
4568 first, second, etc. parameter. The value of the parameters is specified by the
4569 B<Param> configuration option - see below for details. To include a literal
4570 B<$> character followed by a number, surround it with single quotes (B<'>).
4572 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
4573 allowed. Note, however, that only a single command may be used. Semicolons are
4574 allowed as long as a single non-empty command has been specified only.
4576 The returned lines will be handled separately one after another.
4578 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4580 Specify the parameters which should be passed to the SQL query. The parameters
4581 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4582 they appear in the configuration file. The value of the parameter is
4583 determined depending on the value of the B<Param> option as follows:
4589 The configured hostname of the database connection. If a UNIX domain socket is
4590 used, the parameter expands to "localhost".
4594 The name of the database of the current connection.
4598 The name of the database plugin instance. See the B<Instance> option of the
4599 database specification below for details.
4603 The username used to connect to the database.
4607 The interval with which this database is queried (as specified by the database
4608 specific or global B<Interval> options).
4612 Please note that parameters are only supported by PostgreSQL's protocol
4613 version 3 and above which was introduced in version 7.4 of PostgreSQL.
4615 =item B<Type> I<type>
4617 The I<type> name to be used when dispatching the values. The type describes
4618 how to handle the data and where to store it. See L<types.db(5)> for more
4619 details on types and their configuration. The number and type of values (as
4620 selected by the B<ValuesFrom> option) has to match the type of the given name.
4622 This option is required inside a B<Result> block.
4624 =item B<InstancePrefix> I<prefix>
4626 =item B<InstancesFrom> I<column0> [I<column1> ...]
4628 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
4629 B<InstancePrefix> defines a static prefix that will be prepended to all type
4630 instances. B<InstancesFrom> defines the column names whose values will be used
4631 to create the type instance. Multiple values will be joined together using the
4632 hyphen (C<->) as separation character.
4634 The plugin itself does not check whether or not all built instances are
4635 different. It is your responsibility to assure that each is unique.
4637 Both options are optional. If none is specified, the type instance will be
4640 =item B<ValuesFrom> I<column0> [I<column1> ...]
4642 Names the columns whose content is used as the actual data for the data sets
4643 that are dispatched to the daemon. How many such columns you need is
4644 determined by the B<Type> setting as explained above. If you specify too many
4645 or not enough columns, the plugin will complain about that and no data will be
4646 submitted to the daemon.
4648 The actual data type, as seen by PostgreSQL, is not that important as long as
4649 it represents numbers. The plugin will automatically cast the values to the
4650 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
4651 L<strtod(3)> functions, so anything supported by those functions is supported
4652 by the plugin as well.
4654 This option is required inside a B<Result> block and may be specified multiple
4655 times. If multiple B<ValuesFrom> options are specified, the columns are read
4658 =item B<MinVersion> I<version>
4660 =item B<MaxVersion> I<version>
4662 Specify the minimum or maximum version of PostgreSQL that this query should be
4663 used with. Some statistics might only be available with certain versions of
4664 PostgreSQL. This allows you to specify multiple queries with the same name but
4665 which apply to different versions, thus allowing you to use the same
4666 configuration in a heterogeneous environment.
4668 The I<version> has to be specified as the concatenation of the major, minor
4669 and patch-level versions, each represented as two-decimal-digit numbers. For
4670 example, version 8.2.3 will become 80203.
4674 The following predefined queries are available (the definitions can be found
4675 in the F<postgresql_default.conf> file which, by default, is available at
4676 C<I<prefix>/share/collectd/>):
4682 This query collects the number of backends, i.E<nbsp>e. the number of
4685 =item B<transactions>
4687 This query collects the numbers of committed and rolled-back transactions of
4692 This query collects the numbers of various table modifications (i.E<nbsp>e.
4693 insertions, updates, deletions) of the user tables.
4695 =item B<query_plans>
4697 This query collects the numbers of various table scans and returned tuples of
4700 =item B<table_states>
4702 This query collects the numbers of live and dead rows in the user tables.
4706 This query collects disk block access counts for user tables.
4710 This query collects the on-disk size of the database in bytes.
4714 In addition, the following detailed queries are available by default. Please
4715 note that each of those queries collects information B<by table>, thus,
4716 potentially producing B<a lot> of data. For details see the description of the
4717 non-by_table queries above.
4721 =item B<queries_by_table>
4723 =item B<query_plans_by_table>
4725 =item B<table_states_by_table>
4727 =item B<disk_io_by_table>
4731 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
4732 mandatory argument specifying the name of the writer. This will then be used
4733 in the B<Database> specification in order to activate the writer instance. The
4734 names of all writers have to be unique. The following options may be
4739 =item B<Statement> I<sql statement>
4741 This mandatory option specifies the SQL statement that will be executed for
4742 each submitted value. A single SQL statement is allowed only. Anything after
4743 the first semicolon will be ignored.
4745 Nine parameters will be passed to the statement and should be specified as
4746 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
4747 values are made available through those parameters:
4753 The timestamp of the queried value as a floating point number.
4757 The hostname of the queried value.
4761 The plugin name of the queried value.
4765 The plugin instance of the queried value. This value may be B<NULL> if there
4766 is no plugin instance.
4770 The type of the queried value (cf. L<types.db(5)>).
4774 The type instance of the queried value. This value may be B<NULL> if there is
4779 An array of names for the submitted values (i.E<nbsp>e., the name of the data
4780 sources of the submitted value-list).
4784 An array of types for the submitted values (i.E<nbsp>e., the type of the data
4785 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
4786 B<StoreRates> is enabled (which is the default, see below), all types will be
4791 An array of the submitted values. The dimensions of the value name and value
4796 In general, it is advisable to create and call a custom function in the
4797 PostgreSQL database for this purpose. Any procedural language supported by
4798 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
4801 =item B<StoreRates> B<false>|B<true>
4803 If set to B<true> (the default), convert counter values to rates. If set to
4804 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
4809 The B<Database> block defines one PostgreSQL database for which to collect
4810 statistics. It accepts a single mandatory argument which specifies the
4811 database name. None of the other options are required. PostgreSQL will use
4812 default values as documented in the section "CONNECTING TO A DATABASE" in the
4813 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
4814 the user collectd is run as and special environment variables. See the manpage
4819 =item B<Interval> I<seconds>
4821 Specify the interval with which the database should be queried. The default is
4822 to use the global B<Interval> setting.
4824 =item B<CommitInterval> I<seconds>
4826 This option may be used for database connections which have "writers" assigned
4827 (see above). If specified, it causes a writer to put several updates into a
4828 single transaction. This transaction will last for the specified amount of
4829 time. By default, each update will be executed in a separate transaction. Each
4830 transaction generates a fair amount of overhead which can, thus, be reduced by
4831 activating this option. The draw-back is, that data covering the specified
4832 amount of time will be lost, for example, if a single statement within the
4833 transaction fails or if the database server crashes.
4835 =item B<Host> I<hostname>
4837 Specify the hostname or IP of the PostgreSQL server to connect to. If the
4838 value begins with a slash, it is interpreted as the directory name in which to
4839 look for the UNIX domain socket.
4841 This option is also used to determine the hostname that is associated with a
4842 collected data set. If it has been omitted or either begins with with a slash
4843 or equals B<localhost> it will be replaced with the global hostname definition
4844 of collectd. Any other value will be passed literally to collectd when
4845 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
4847 =item B<Port> I<port>
4849 Specify the TCP port or the local UNIX domain socket file extension of the
4852 =item B<User> I<username>
4854 Specify the username to be used when connecting to the server.
4856 =item B<Password> I<password>
4858 Specify the password to be used when connecting to the server.
4860 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
4862 Specify whether to use an SSL connection when contacting the server. The
4863 following modes are supported:
4869 Do not use SSL at all.
4873 First, try to connect without using SSL. If that fails, try using SSL.
4875 =item I<prefer> (default)
4877 First, try to connect using SSL. If that fails, try without using SSL.
4885 =item B<Instance> I<name>
4887 Specify the plugin instance name that should be used instead of the database
4888 name (which is the default, if this option has not been specified). This
4889 allows to query multiple databases of the same name on the same host (e.g.
4890 when running multiple database server versions in parallel).
4892 =item B<KRBSrvName> I<kerberos_service_name>
4894 Specify the Kerberos service name to use when authenticating with Kerberos 5
4895 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
4896 B<PostgreSQL Documentation> for details.
4898 =item B<Service> I<service_name>
4900 Specify the PostgreSQL service name to use for additional parameters. That
4901 service has to be defined in F<pg_service.conf> and holds additional
4902 connection parameters. See the section "The Connection Service File" in the
4903 B<PostgreSQL Documentation> for details.
4905 =item B<Query> I<query>
4907 Specifies a I<query> which should be executed in the context of the database
4908 connection. This may be any of the predefined or user-defined queries. If no
4909 such option is given, it defaults to "backends", "transactions", "queries",
4910 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
4911 has been specified). Else, the specified queries are used only.
4913 =item B<Writer> I<writer>
4915 Assigns the specified I<writer> backend to the database connection. This
4916 causes all collected data to be send to the database using the settings
4917 defined in the writer configuration (see the section "FILTER CONFIGURATION"
4918 below for details on how to selectively send data to certain plugins).
4920 Each writer will register a flush callback which may be used when having long
4921 transactions enabled (see the B<CommitInterval> option above). When issuing
4922 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
4923 transaction will be committed right away. Two different kinds of flush
4924 callbacks are available with the C<postgresql> plugin:
4930 Flush all writer backends.
4932 =item B<postgresql->I<database>
4934 Flush all writers of the specified I<database> only.
4940 =head2 Plugin C<powerdns>
4942 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
4943 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
4944 values, many of which are probably meaningless to most users, but may be useful
4945 for some. So you may chose which values to collect, but if you don't, some
4946 reasonable defaults will be collected.
4949 <Server "server_name">
4951 Collect "udp-answers" "udp-queries"
4952 Socket "/var/run/pdns.controlsocket"
4954 <Recursor "recursor_name">
4956 Collect "cache-hits" "cache-misses"
4957 Socket "/var/run/pdns_recursor.controlsocket"
4959 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
4964 =item B<Server> and B<Recursor> block
4966 The B<Server> block defines one authoritative server to query, the B<Recursor>
4967 does the same for an recursing server. The possible options in both blocks are
4968 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
4973 =item B<Collect> I<Field>
4975 Using the B<Collect> statement you can select which values to collect. Here,
4976 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
4977 C<dlg-only-drops>, C<answers10-100>.
4979 The method of getting the values differs for B<Server> and B<Recursor> blocks:
4980 When querying the server a C<SHOW *> command is issued in any case, because
4981 that's the only way of getting multiple values out of the server at once.
4982 collectd then picks out the values you have selected. When querying the
4983 recursor, a command is generated to query exactly these values. So if you
4984 specify invalid fields when querying the recursor, a syntax error may be
4985 returned by the daemon and collectd may not collect any values at all.
4987 If no B<Collect> statement is given, the following B<Server> values will be
4994 =item packetcache-hit
4996 =item packetcache-miss
4998 =item packetcache-size
5000 =item query-cache-hit
5002 =item query-cache-miss
5004 =item recursing-answers
5006 =item recursing-questions
5018 The following B<Recursor> values will be collected by default:
5022 =item noerror-answers
5024 =item nxdomain-answers
5026 =item servfail-answers
5044 Please note that up to that point collectd doesn't know what values are
5045 available on the server and values that are added do not need a change of the
5046 mechanism so far. However, the values must be mapped to collectd's naming
5047 scheme, which is done using a lookup table that lists all known values. If
5048 values are added in the future and collectd does not know about them, you will
5049 get an error much like this:
5051 powerdns plugin: submit: Not found in lookup table: foobar = 42
5053 In this case please file a bug report with the collectd team.
5055 =item B<Socket> I<Path>
5057 Configures the path to the UNIX domain socket to be used when connecting to the
5058 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
5059 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
5060 will be used for the recursor.
5064 =item B<LocalSocket> I<Path>
5066 Querying the recursor is done using UDP. When using UDP over UNIX domain
5067 sockets, the client socket needs a name in the file system, too. You can set
5068 this local name to I<Path> using the B<LocalSocket> option. The default is
5069 C<I<prefix>/var/run/collectd-powerdns>.
5073 =head2 Plugin C<processes>
5077 =item B<Process> I<Name>
5079 Select more detailed statistics of processes matching this name. The statistics
5080 collected for these selected processes are size of the resident segment size
5081 (RSS), user- and system-time used, number of processes and number of threads,
5082 io data (where available) and minor and major pagefaults.
5084 =item B<ProcessMatch> I<name> I<regex>
5086 Similar to the B<Process> option this allows to select more detailed
5087 statistics of processes matching the specified I<regex> (see L<regex(7)> for
5088 details). The statistics of all matching processes are summed up and
5089 dispatched to the daemon using the specified I<name> as an identifier. This
5090 allows to "group" several processes together. I<name> must not contain
5095 =head2 Plugin C<protocols>
5097 Collects a lot of information about various network protocols, such as I<IP>,
5098 I<TCP>, I<UDP>, etc.
5100 Available configuration options:
5104 =item B<Value> I<Selector>
5106 Selects whether or not to select a specific value. The string being matched is
5107 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
5108 plugin instance and I<ValueName> will be used as type instance. An example of
5109 the string being used would be C<Tcp:RetransSegs>.
5111 You can use regular expressions to match a large number of values with just one
5112 configuration option. To select all "extended" I<TCP> values, you could use the
5113 following statement:
5117 Whether only matched values are selected or all matched values are ignored
5118 depends on the B<IgnoreSelected>. By default, only matched values are selected.
5119 If no value is configured at all, all values will be selected.
5121 =item B<IgnoreSelected> B<true>|B<false>
5123 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
5124 matching values will be ignored.
5128 =head2 Plugin C<python>
5130 This plugin embeds a Python-interpreter into collectd and provides an interface
5131 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
5133 =head2 Plugin C<routeros>
5135 The C<routeros> plugin connects to a device running I<RouterOS>, the
5136 Linux-based operating system for routers by I<MikroTik>. The plugin uses
5137 I<librouteros> to connect and reads information about the interfaces and
5138 wireless connections of the device. The configuration supports querying
5143 Host "router0.example.com"
5146 CollectInterface true
5151 Host "router1.example.com"
5154 CollectInterface true
5155 CollectRegistrationTable true
5161 As you can see above, the configuration of the I<routeros> plugin consists of
5162 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
5163 options are understood:
5167 =item B<Host> I<Host>
5169 Hostname or IP-address of the router to connect to.
5171 =item B<Port> I<Port>
5173 Port name or port number used when connecting. If left unspecified, the default
5174 will be chosen by I<librouteros>, currently "8728". This option expects a
5175 string argument, even when a numeric port number is given.
5177 =item B<User> I<User>
5179 Use the user name I<User> to authenticate. Defaults to "admin".
5181 =item B<Password> I<Password>
5183 Set the password used to authenticate.
5185 =item B<CollectInterface> B<true>|B<false>
5187 When set to B<true>, interface statistics will be collected for all interfaces
5188 present on the device. Defaults to B<false>.
5190 =item B<CollectRegistrationTable> B<true>|B<false>
5192 When set to B<true>, information about wireless LAN connections will be
5193 collected. Defaults to B<false>.
5195 =item B<CollectCPULoad> B<true>|B<false>
5197 When set to B<true>, information about the CPU usage will be collected. The
5198 number is a dimensionless value where zero indicates no CPU usage at all.
5199 Defaults to B<false>.
5201 =item B<CollectMemory> B<true>|B<false>
5203 When enabled, the amount of used and free memory will be collected. How used
5204 memory is calculated is unknown, for example whether or not caches are counted
5206 Defaults to B<false>.
5208 =item B<CollectDF> B<true>|B<false>
5210 When enabled, the amount of used and free disk space will be collected.
5211 Defaults to B<false>.
5213 =item B<CollectDisk> B<true>|B<false>
5215 When enabled, the number of sectors written and bad blocks will be collected.
5216 Defaults to B<false>.
5220 =head2 Plugin C<redis>
5222 The I<Redis plugin> connects to one or more Redis servers and gathers
5223 information about each server's state. For each server there is a I<Node> block
5224 which configures the connection parameters for this node.
5234 The information shown in the synopsis above is the I<default configuration>
5235 which is used by the plugin if no configuration is present.
5239 =item B<Node> I<Nodename>
5241 The B<Node> block identifies a new Redis node, that is a new Redis instance
5242 running in an specified host and port. The name for node is a canonical
5243 identifier which is used as I<plugin instance>. It is limited to
5244 64E<nbsp>characters in length.
5246 =item B<Host> I<Hostname>
5248 The B<Host> option is the hostname or IP-address where the Redis instance is
5251 =item B<Port> I<Port>
5253 The B<Port> option is the TCP port on which the Redis instance accepts
5254 connections. Either a service name of a port number may be given. Please note
5255 that numerical port numbers must be given as a string, too.
5257 =item B<Password> I<Password>
5259 Use I<Password> to authenticate when connecting to I<Redis>.
5261 =item B<Timeout> I<Timeout in miliseconds>
5263 The B<Timeout> option set the socket timeout for node response. Since the Redis
5264 read function is blocking, you should keep this value as low as possible. Keep
5265 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
5266 than B<Interval> defined globally.
5270 =head2 Plugin C<rrdcached>
5272 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
5273 to store values to RRD files in an efficient manner. The combination of the
5274 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
5275 way the C<rrdtool> plugin works (see below). The added abstraction layer
5276 provides a number of benefits, though: Because the cache is not within
5277 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
5278 restarted. This results in much shorter (if any) gaps in graphs, especially
5279 under heavy load. Also, the C<rrdtool> command line utility is aware of the
5280 daemon so that it can flush values to disk automatically when needed. This
5281 allows to integrate automated flushing of values into graphing solutions much
5284 There are disadvantages, though: The daemon may reside on a different host, so
5285 it may not be possible for C<collectd> to create the appropriate RRD files
5286 anymore. And even if C<rrdcached> runs on the same host, it may run in a
5287 different base directory, so relative paths may do weird stuff if you're not
5290 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
5291 on the same host, communicating via a UNIX domain socket. The B<DataDir>
5292 setting should be set to an absolute path, so that a changed base directory
5293 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
5297 =item B<DaemonAddress> I<Address>
5299 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
5300 library. See L<rrdcached(1)> for details. Example:
5302 <Plugin "rrdcached">
5303 DaemonAddress "unix:/var/run/rrdcached.sock"
5306 =item B<DataDir> I<Directory>
5308 Set the base directory in which the RRD files reside. If this is a relative
5309 path, it is relative to the working base directory of the C<rrdcached> daemon!
5310 Use of an absolute path is recommended.
5312 =item B<CreateFiles> B<true>|B<false>
5314 Enables or disables the creation of RRD files. If the daemon is not running
5315 locally, or B<DataDir> is set to a relative path, this will not work as
5316 expected. Default is B<true>.
5318 =item B<CreateFilesAsync> B<false>|B<true>
5320 When enabled, new RRD files are enabled asynchronously, using a separate thread
5321 that runs in the background. This prevents writes to block, which is a problem
5322 especially when many hundreds of files need to be created at once. However,
5323 since the purpose of creating the files asynchronously is I<not> to block until
5324 the file is available, values before the file is available will be discarded.
5325 When disabled (the default) files are created synchronously, blocking for a
5326 short while, while the file is being written.
5328 =item B<StepSize> I<Seconds>
5330 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5331 this setting is unset and the stepsize is set to the interval in which the data
5332 is collected. Do not use this option unless you absolutely have to for some
5333 reason. Setting this option may cause problems with the C<snmp plugin>, the
5334 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5336 =item B<HeartBeat> I<Seconds>
5338 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5339 in which case the heartbeat is set to twice the B<StepSize> which should equal
5340 the interval in which data is collected. Do not set this option unless you have
5341 a very good reason to do so.
5343 =item B<RRARows> I<NumRows>
5345 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5346 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5347 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5348 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5349 week, one month, and one year.
5351 So for each timespan, it calculates how many PDPs need to be consolidated into
5352 one CDP by calculating:
5353 number of PDPs = timespan / (stepsize * rrarows)
5355 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5358 =item B<RRATimespan> I<Seconds>
5360 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5361 more then one RRA. If this option is never used, the built-in default of (3600,
5362 86400, 604800, 2678400, 31622400) is used.
5364 For more information on how RRA-sizes are calculated see B<RRARows> above.
5366 =item B<XFF> I<Factor>
5368 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5369 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5374 =head2 Plugin C<rrdtool>
5376 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
5377 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
5378 using these settings. If you don't want to dive into the depths of RRDtool, you
5379 can safely ignore these settings.
5383 =item B<DataDir> I<Directory>
5385 Set the directory to store RRD files under. By default RRD files are generated
5386 beneath the daemon's working directory, i.e. the B<BaseDir>.
5388 =item B<CreateFilesAsync> B<false>|B<true>
5390 When enabled, new RRD files are enabled asynchronously, using a separate thread
5391 that runs in the background. This prevents writes to block, which is a problem
5392 especially when many hundreds of files need to be created at once. However,
5393 since the purpose of creating the files asynchronously is I<not> to block until
5394 the file is available, values before the file is available will be discarded.
5395 When disabled (the default) files are created synchronously, blocking for a
5396 short while, while the file is being written.
5398 =item B<StepSize> I<Seconds>
5400 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5401 this setting is unset and the stepsize is set to the interval in which the data
5402 is collected. Do not use this option unless you absolutely have to for some
5403 reason. Setting this option may cause problems with the C<snmp plugin>, the
5404 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5406 =item B<HeartBeat> I<Seconds>
5408 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5409 in which case the heartbeat is set to twice the B<StepSize> which should equal
5410 the interval in which data is collected. Do not set this option unless you have
5411 a very good reason to do so.
5413 =item B<RRARows> I<NumRows>
5415 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5416 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5417 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5418 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5419 week, one month, and one year.
5421 So for each timespan, it calculates how many PDPs need to be consolidated into
5422 one CDP by calculating:
5423 number of PDPs = timespan / (stepsize * rrarows)
5425 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5428 =item B<RRATimespan> I<Seconds>
5430 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5431 more then one RRA. If this option is never used, the built-in default of (3600,
5432 86400, 604800, 2678400, 31622400) is used.
5434 For more information on how RRA-sizes are calculated see B<RRARows> above.
5436 =item B<XFF> I<Factor>
5438 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5439 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5442 =item B<CacheFlush> I<Seconds>
5444 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
5445 it writes all values for a certain RRD-file if the oldest value is older than
5446 (or equal to) the number of seconds specified. If some RRD-file is not updated
5447 anymore for some reason (the computer was shut down, the network is broken,
5448 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
5449 entire cache is searched for entries older than B<CacheTimeout> seconds and
5450 written to disk every I<Seconds> seconds. Since this is kind of expensive and
5451 does nothing under normal circumstances, this value should not be too small.
5452 900 seconds might be a good value, though setting this to 7200 seconds doesn't
5453 normally do much harm either.
5455 =item B<CacheTimeout> I<Seconds>
5457 If this option is set to a value greater than zero, the C<rrdtool plugin> will
5458 save values in a cache, as described above. Writing multiple values at once
5459 reduces IO-operations and thus lessens the load produced by updating the files.
5460 The trade off is that the graphs kind of "drag behind" and that more memory is
5463 =item B<WritesPerSecond> I<Updates>
5465 When collecting many statistics with collectd and the C<rrdtool> plugin, you
5466 will run serious performance problems. The B<CacheFlush> setting and the
5467 internal update queue assert that collectd continues to work just fine even
5468 under heavy load, but the system may become very unresponsive and slow. This is
5469 a problem especially if you create graphs from the RRD files on the same
5470 machine, for example using the C<graph.cgi> script included in the
5471 C<contrib/collection3/> directory.
5473 This setting is designed for very large setups. Setting this option to a value
5474 between 25 and 80 updates per second, depending on your hardware, will leave
5475 the server responsive enough to draw graphs even while all the cached values
5476 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
5477 by the B<FLUSH> command, are B<not> effected by this limit. They are still
5478 written as fast as possible, so that web frontends have up to date data when
5481 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
5482 updates per second, writing all values to disk will take approximately
5483 56E<nbsp>minutes. Together with the flushing ability that's integrated into
5484 "collection3" you'll end up with a responsive and fast system, up to date
5485 graphs and basically a "backup" of your values every hour.
5487 =item B<RandomTimeout> I<Seconds>
5489 When set, the actual timeout for each value is chosen randomly between
5490 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
5491 intention is to avoid high load situations that appear when many values timeout
5492 at the same time. This is especially a problem shortly after the daemon starts,
5493 because all values were added to the internal cache at roughly the same time.
5497 =head2 Plugin C<sensors>
5499 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
5500 that all the needed modules have to be loaded and lm_sensors has to be
5501 configured (most likely by editing F</etc/sensors.conf>. Read
5502 L<sensors.conf(5)> for details.
5504 The B<lm_sensors> homepage can be found at
5505 L<http://secure.netroedge.com/~lm78/>.
5509 =item B<SensorConfigFile> I<File>
5511 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
5512 the library's default will be used.
5514 =item B<Sensor> I<chip-bus-address/type-feature>
5516 Selects the name of the sensor which you want to collect or ignore, depending
5517 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
5518 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
5519 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
5521 =item B<IgnoreSelected> I<true>|I<false>
5523 If no configuration if given, the B<sensors>-plugin will collect data from all
5524 sensors. This may not be practical, especially for uninteresting sensors.
5525 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
5526 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
5527 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
5528 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
5529 and all other sensors are collected.
5533 =head2 Plugin C<sigrok>
5535 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
5536 supported by the L<sigrok|http://sigrok.org/> project.
5542 <Device "AC Voltage">
5547 <Device "Sound Level">
5548 Driver "cem-dt-885x"
5555 =item B<LogLevel> B<0-5>
5557 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
5558 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
5559 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
5560 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
5561 their level, are always submitted to I<collectd> at its INFO log level.
5563 =item E<lt>B<Device> I<Name>E<gt>
5565 A sigrok-supported device, uniquely identified by this section's options. The
5566 I<Name> is passed to I<collectd> as the I<plugin instance>.
5568 =item B<Driver> I<DriverName>
5570 The sigrok driver to use for this device.
5572 =item B<Conn> I<ConnectionSpec>
5574 If the device cannot be auto-discovered, or more than one might be discovered
5575 by the driver, I<ConnectionSpec> specifies the connection string to the device.
5576 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
5577 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
5578 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
5579 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
5581 =item B<SerialComm> I<SerialSpec>
5583 For serial devices with non-standard port settings, this option can be used
5584 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
5585 This should not be necessary; drivers know how to communicate with devices they
5588 =item B<MinimumInterval> I<Seconds>
5590 Specifies the minimum time between measurement dispatches to I<collectd>, in
5591 seconds. Since some I<sigrok> supported devices can acquire measurements many
5592 times per second, it may be necessary to throttle these. For example, the
5593 I<RRD plugin> cannot process writes more than once per second.
5595 The default B<MinimumInterval> is B<0>, meaning measurements received from the
5596 device are always dispatched to I<collectd>. When throttled, unused
5597 measurements are discarded.
5601 =head2 Plugin C<snmp>
5603 Since the configuration of the C<snmp plugin> is a little more complicated than
5604 other plugins, its documentation has been moved to an own manpage,
5605 L<collectd-snmp(5)>. Please see there for details.
5607 =head2 Plugin C<statsd>
5609 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
5610 protocol and dispatches rates or other aggregates of these numbers
5613 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
5614 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
5615 C<objects> respectively.
5617 The following configuration options are valid:
5621 =item B<Host> I<Host>
5623 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
5624 "any" address, i.e. accept packets sent to any of the hosts addresses.
5626 =item B<Port> I<Port>
5628 UDP port to listen to. This can be either a service name or a port number.
5629 Defaults to C<8125>.
5631 =item B<DeleteCounters> B<false>|B<true>
5633 =item B<DeleteTimers> B<false>|B<true>
5635 =item B<DeleteGauges> B<false>|B<true>
5637 =item B<DeleteSets> B<false>|B<true>
5639 These options control what happens if metrics are not updated in an interval.
5640 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
5641 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
5642 are unchanged. If set to B<True>, the such metrics are not dispatched and
5643 removed from the internal cache.
5645 =item B<TimerPercentile> I<Percent>
5647 Calculate and dispatch the configured percentile, i.e. compute the latency, so
5648 that I<Percent> of all reported timers are smaller than or equal to the
5649 computed latency. This is useful for cutting off the long tail latency, as it's
5650 often done in I<Service Level Agreements> (SLAs).
5652 If not specified, no percentile is calculated / dispatched.
5656 =head2 Plugin C<swap>
5658 The I<Swap plugin> collects information about used and available swap space. On
5659 I<Linux> and I<Solaris>, the following options are available:
5663 =item B<ReportByDevice> B<false>|B<true>
5665 Configures how to report physical swap devices. If set to B<false> (the
5666 default), the summary over all swap devices is reported only, i.e. the globally
5667 used and available space over all devices. If B<true> is configured, the used
5668 and available space of each device will be reported separately.
5670 This option is only available if the I<Swap plugin> can read C</proc/swaps>
5671 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
5673 =item B<ReportBytes> B<false>|B<true>
5675 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
5676 I<swap I/O> is reported in pages. This option is available under Linux only.
5678 =item B<ValuesAbsolute> B<true>|B<false>
5680 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
5681 available and used. Defaults to B<true>.
5683 =item B<ValuesPercentage> B<false>|B<true>
5685 Enables or disables reporting of relative swap metrics, i.e. I<percent>
5686 available and free. Defaults to B<false>.
5688 This is useful for deploying I<collectd> in a heterogeneous environment, where
5689 swap sizes differ and you want to specify generic thresholds or similar.
5693 =head2 Plugin C<syslog>
5697 =item B<LogLevel> B<debug|info|notice|warning|err>
5699 Sets the log-level. If, for example, set to B<notice>, then all events with
5700 severity B<notice>, B<warning>, or B<err> will be submitted to the
5703 Please note that B<debug> is only available if collectd has been compiled with
5706 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
5708 Controls which notifications should be sent to syslog. The default behaviour is
5709 not to send any. Less severe notifications always imply logging more severe
5710 notifications: Setting this to B<OKAY> means all notifications will be sent to
5711 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
5712 notifications but will dismiss B<OKAY> notifications. Setting this option to
5713 B<FAILURE> will only send failures to syslog.
5717 =head2 Plugin C<table>
5719 The C<table plugin> provides generic means to parse tabular data and dispatch
5720 user specified values. Values are selected based on column numbers. For
5721 example, this plugin may be used to get values from the Linux L<proc(5)>
5722 filesystem or CSV (comma separated values) files.
5725 <Table "/proc/slabinfo">
5730 InstancePrefix "active_objs"
5736 InstancePrefix "objperslab"
5743 The configuration consists of one or more B<Table> blocks, each of which
5744 configures one file to parse. Within each B<Table> block, there are one or
5745 more B<Result> blocks, which configure which data to select and how to
5748 The following options are available inside a B<Table> block:
5752 =item B<Instance> I<instance>
5754 If specified, I<instance> is used as the plugin instance. So, in the above
5755 example, the plugin name C<table-slabinfo> would be used. If omitted, the
5756 filename of the table is used instead, with all special characters replaced
5757 with an underscore (C<_>).
5759 =item B<Separator> I<string>
5761 Any character of I<string> is interpreted as a delimiter between the different
5762 columns of the table. A sequence of two or more contiguous delimiters in the
5763 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
5764 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
5765 of a table - see its documentation for more details. This option is mandatory.
5767 A horizontal tab, newline and carriage return may be specified by C<\\t>,
5768 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
5769 required because of collectd's config parsing.
5773 The following options are available inside a B<Result> block:
5777 =item B<Type> I<type>
5779 Sets the type used to dispatch the values to the daemon. Detailed information
5780 about types and their configuration can be found in L<types.db(5)>. This
5781 option is mandatory.
5783 =item B<InstancePrefix> I<prefix>
5785 If specified, prepend I<prefix> to the type instance. If omitted, only the
5786 B<InstancesFrom> option is considered for the type instance.
5788 =item B<InstancesFrom> I<column0> [I<column1> ...]
5790 If specified, the content of the given columns (identified by the column
5791 number starting at zero) will be used to create the type instance for each
5792 row. Multiple values (and the instance prefix) will be joined together with
5793 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
5794 option is considered for the type instance.
5796 The plugin itself does not check whether or not all built instances are
5797 different. It’s your responsibility to assure that each is unique. This is
5798 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
5799 sure that the table only contains one row.
5801 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
5804 =item B<ValuesFrom> I<column0> [I<column1> ...]
5806 Specifies the columns (identified by the column numbers starting at zero)
5807 whose content is used as the actual data for the data sets that are dispatched
5808 to the daemon. How many such columns you need is determined by the B<Type>
5809 setting above. If you specify too many or not enough columns, the plugin will
5810 complain about that and no data will be submitted to the daemon. The plugin
5811 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
5812 respectively, so anything supported by those functions is supported by the
5813 plugin as well. This option is mandatory.
5817 =head2 Plugin C<tail>
5819 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
5820 each line and dispatches found values. What is matched can be configured by the
5821 user using (extended) regular expressions, as described in L<regex(7)>.
5824 <File "/var/log/exim4/mainlog">
5828 Regex "S=([1-9][0-9]*)"
5834 Regex "\\<R=local_user\\>"
5835 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
5838 Instance "local_user"
5843 The config consists of one or more B<File> blocks, each of which configures one
5844 logfile to parse. Within each B<File> block, there are one or more B<Match>
5845 blocks, which configure a regular expression to search for.
5847 The B<Instance> option in the B<File> block may be used to set the plugin
5848 instance. So in the above example the plugin name C<tail-foo> would be used.
5849 This plugin instance is for all B<Match> blocks that B<follow> it, until the
5850 next B<Instance> option. This way you can extract several plugin instances from
5851 one logfile, handy when parsing syslog and the like.
5853 The B<Interval> option allows you to define the length of time between reads. If
5854 this is not set, the default Interval will be used.
5856 Each B<Match> block has the following options to describe how the match should
5861 =item B<Regex> I<regex>
5863 Sets the regular expression to use for matching against a line. The first
5864 subexpression has to match something that can be turned into a number by
5865 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
5866 below. Because B<extended> regular expressions are used, you do not need to use
5867 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
5868 collectd's config parsing you need to escape backslashes, though. So if you
5869 want to match literal parentheses you need to do the following:
5871 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
5873 =item B<ExcludeRegex> I<regex>
5875 Sets an optional regular expression to use for excluding lines from the match.
5876 An example which excludes all connections from localhost from the match:
5878 ExcludeRegex "127\\.0\\.0\\.1"
5880 =item B<DSType> I<Type>
5882 Sets how the values are cumulated. I<Type> is one of:
5886 =item B<GaugeAverage>
5888 Calculate the average.
5892 Use the smallest number only.
5896 Use the greatest number only.
5900 Use the last number found.
5906 =item B<AbsoluteSet>
5908 The matched number is a counter. Simply I<sets> the internal counter to this
5909 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
5915 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
5916 matched number may be negative, which will effectively subtract from the
5923 Increase the internal counter by one. These B<DSType> are the only ones that do
5924 not use the matched subexpression, but simply count the number of matched
5925 lines. Thus, you may use a regular expression without submatch in this case.
5929 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
5930 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
5931 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
5932 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
5933 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
5936 =item B<Type> I<Type>
5938 Sets the type used to dispatch this value. Detailed information about types and
5939 their configuration can be found in L<types.db(5)>.
5941 =item B<Instance> I<TypeInstance>
5943 This optional setting sets the type instance to use.
5947 =head2 Plugin C<tail_csv>
5949 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
5950 written by I<Snort>.
5955 <Metric "snort-dropped">
5960 <File "/var/log/snort/snort.stats">
5961 Instance "snort-eth0"
5963 Collect "snort-dropped"
5967 The configuration consists of one or more B<Metric> blocks that define an index
5968 into the line of the CSV file and how this value is mapped to I<collectd's>
5969 internal representation. These are followed by one or more B<Instance> blocks
5970 which configure which file to read, in which interval and which metrics to
5975 =item E<lt>B<Metric> I<Name>E<gt>
5977 The B<Metric> block configures a new metric to be extracted from the statistics
5978 file and how it is mapped on I<collectd's> data model. The string I<Name> is
5979 only used inside the B<Instance> blocks to refer to this block, so you can use
5980 one B<Metric> block for multiple CSV files.
5984 =item B<Type> I<Type>
5986 Configures which I<Type> to use when dispatching this metric. Types are defined
5987 in the L<types.db(5)> file, see the appropriate manual page for more
5988 information on specifying types. Only types with a single I<data source> are
5989 supported by the I<tail_csv plugin>. The information whether the value is an
5990 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
5991 I<Type's> definition.
5993 =item B<Instance> I<TypeInstance>
5995 If set, I<TypeInstance> is used to populate the type instance field of the
5996 created value lists. Otherwise, no type instance is used.
5998 =item B<ValueFrom> I<Index>
6000 Configure to read the value from the field with the zero-based index I<Index>.
6001 If the value is parsed as signed integer, unsigned integer or double depends on
6002 the B<Type> setting, see above.
6006 =item E<lt>B<File> I<Path>E<gt>
6008 Each B<File> block represents one CSV file to read. There must be at least one
6009 I<File> block but there can be multiple if you have multiple CSV files.
6013 =item B<Instance> I<PluginInstance>
6015 Sets the I<plugin instance> used when dispatching the values.
6017 =item B<Collect> I<Metric>
6019 Specifies which I<Metric> to collect. This option must be specified at least
6020 once, and you can use this option multiple times to specify more than one
6021 metric to be extracted from this statistic file.
6023 =item B<Interval> I<Seconds>
6025 Configures the interval in which to read values from this instance / file.
6026 Defaults to the plugin's default interval.
6028 =item B<TimeFrom> I<Index>
6030 Rather than using the local time when dispatching a value, read the timestamp
6031 from the field with the zero-based index I<Index>. The value is interpreted as
6032 seconds since epoch. The value is parsed as a double and may be factional.
6038 =head2 Plugin C<teamspeak2>
6040 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
6041 polls interesting global and virtual server data. The plugin can query only one
6042 physical server but unlimited virtual servers. You can use the following
6043 options to configure it:
6047 =item B<Host> I<hostname/ip>
6049 The hostname or ip which identifies the physical server.
6052 =item B<Port> I<port>
6054 The query port of the physical server. This needs to be a string.
6057 =item B<Server> I<port>
6059 This option has to be added once for every virtual server the plugin should
6060 query. If you want to query the virtual server on port 8767 this is what the
6061 option would look like:
6065 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
6066 use quotes around it! If no such statement is given only global information
6071 =head2 Plugin C<ted>
6073 The I<TED> plugin connects to a device of "The Energy Detective", a device to
6074 measure power consumption. These devices are usually connected to a serial
6075 (RS232) or USB port. The plugin opens a configured device and tries to read the
6076 current energy readings. For more information on TED, visit
6077 L<http://www.theenergydetective.com/>.
6079 Available configuration options:
6083 =item B<Device> I<Path>
6085 Path to the device on which TED is connected. collectd will need read and write
6086 permissions on that file.
6088 Default: B</dev/ttyUSB0>
6090 =item B<Retries> I<Num>
6092 Apparently reading from TED is not that reliable. You can therefore configure a
6093 number of retries here. You only configure the I<retries> here, to if you
6094 specify zero, one reading will be performed (but no retries if that fails); if
6095 you specify three, a maximum of four readings are performed. Negative values
6102 =head2 Plugin C<tcpconns>
6104 The C<tcpconns plugin> counts the number of currently established TCP
6105 connections based on the local port and/or the remote port. Since there may be
6106 a lot of connections the default if to count all connections with a local port,
6107 for which a listening socket is opened. You can use the following options to
6108 fine-tune the ports you are interested in:
6112 =item B<ListeningPorts> I<true>|I<false>
6114 If this option is set to I<true>, statistics for all local ports for which a
6115 listening socket exists are collected. The default depends on B<LocalPort> and
6116 B<RemotePort> (see below): If no port at all is specifically selected, the
6117 default is to collect listening ports. If specific ports (no matter if local or
6118 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
6119 the selected ports will be collected unless this option is set to I<true>
6122 =item B<LocalPort> I<Port>
6124 Count the connections to a specific local port. This can be used to see how
6125 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
6126 You have to specify the port in numeric form, so for the mailserver example
6127 you'd need to set B<25>.
6129 =item B<RemotePort> I<Port>
6131 Count the connections to a specific remote port. This is useful to see how
6132 much a remote service is used. This is most useful if you want to know how many
6133 connections a local service has opened to remote services, e.E<nbsp>g. how many
6134 connections a mail server or news server has to other mail or news servers, or
6135 how many connections a web proxy holds to web servers. You have to give the
6136 port in numeric form.
6140 =head2 Plugin C<thermal>
6144 =item B<ForceUseProcfs> I<true>|I<false>
6146 By default, the I<Thermal plugin> tries to read the statistics from the Linux
6147 C<sysfs> interface. If that is not available, the plugin falls back to the
6148 C<procfs> interface. By setting this option to I<true>, you can force the
6149 plugin to use the latter. This option defaults to I<false>.
6151 =item B<Device> I<Device>
6153 Selects the name of the thermal device that you want to collect or ignore,
6154 depending on the value of the B<IgnoreSelected> option. This option may be
6155 used multiple times to specify a list of devices.
6157 =item B<IgnoreSelected> I<true>|I<false>
6159 Invert the selection: If set to true, all devices B<except> the ones that
6160 match the device names specified by the B<Device> option are collected. By
6161 default only selected devices are collected if a selection is made. If no
6162 selection is configured at all, B<all> devices are selected.
6166 =head2 Plugin C<threshold>
6168 The I<Threshold plugin> checks values collected or received by I<collectd>
6169 against a configurable I<threshold> and issues I<notifications> if values are
6172 Documentation for this plugin is available in the L<collectd-threshold(5)>
6175 =head2 Plugin C<tokyotyrant>
6177 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
6178 couple metrics: number of records, and database size on disk.
6182 =item B<Host> I<Hostname/IP>
6184 The hostname or ip which identifies the server.
6185 Default: B<127.0.0.1>
6187 =item B<Port> I<Service/Port>
6189 The query port of the server. This needs to be a string, even if the port is
6190 given in its numeric form.
6195 =head2 Plugin C<unixsock>
6199 =item B<SocketFile> I<Path>
6201 Sets the socket-file which is to be created.
6203 =item B<SocketGroup> I<Group>
6205 If running as root change the group of the UNIX-socket after it has been
6206 created. Defaults to B<collectd>.
6208 =item B<SocketPerms> I<Permissions>
6210 Change the file permissions of the UNIX-socket after it has been created. The
6211 permissions must be given as a numeric, octal value as you would pass to
6212 L<chmod(1)>. Defaults to B<0770>.
6214 =item B<DeleteSocket> B<false>|B<true>
6216 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
6217 with the given name already exists. If I<collectd> crashes a socket file may be
6218 left over, preventing the daemon from opening a new socket when restarted.
6219 Since this is potentially dangerous, this defaults to B<false>.
6223 =head2 Plugin C<uuid>
6225 This plugin, if loaded, causes the Hostname to be taken from the machine's
6226 UUID. The UUID is a universally unique designation for the machine, usually
6227 taken from the machine's BIOS. This is most useful if the machine is running in
6228 a virtual environment such as Xen, in which case the UUID is preserved across
6229 shutdowns and migration.
6231 The following methods are used to find the machine's UUID, in order:
6237 Check I</etc/uuid> (or I<UUIDFile>).
6241 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
6246 Check for UUID from C<dmidecode> / SMBIOS.
6250 Check for UUID from Xen hypervisor.
6254 If no UUID can be found then the hostname is not modified.
6258 =item B<UUIDFile> I<Path>
6260 Take the UUID from the given file (default I</etc/uuid>).
6264 =head2 Plugin C<varnish>
6266 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
6271 <Instance "example">
6273 CollectConnections true
6283 CollectWorkers false
6287 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
6288 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
6289 will collectd statistics from the default "varnishd" instance (this should work
6290 fine in most cases).
6292 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
6296 =item B<CollectCache> B<true>|B<false>
6298 Cache hits and misses. True by default.
6300 =item B<CollectConnections> B<true>|B<false>
6302 Number of client connections received, accepted and dropped. True by default.
6304 =item B<CollectBackend> B<true>|B<false>
6306 Back-end connection statistics, such as successful, reused,
6307 and closed connections. True by default.
6309 =item B<CollectSHM> B<true>|B<false>
6311 Statistics about the shared memory log, a memory region to store
6312 log messages which is flushed to disk when full. True by default.
6314 =item B<CollectBan> B<true>|B<false>
6316 Statistics about ban operations, such as number of bans added, retired, and
6317 number of objects tested against ban operations. Only available with Varnish
6318 3.x. False by default.
6320 =item B<CollectDirectorDNS> B<true>|B<false>
6322 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
6325 =item B<CollectESI> B<true>|B<false>
6327 Edge Side Includes (ESI) parse statistics. False by default.
6329 =item B<CollectFetch> B<true>|B<false>
6331 Statistics about fetches (HTTP requests sent to the backend). False by default.
6333 =item B<CollectHCB> B<true>|B<false>
6335 Inserts and look-ups in the crit bit tree based hash. Look-ups are
6336 divided into locked and unlocked look-ups. False by default.
6338 =item B<CollectObjects> B<true>|B<false>
6340 Statistics on cached objects: number of objects expired, nuked (prematurely
6341 expired), saved, moved, etc. False by default.
6343 =item B<CollectPurge> B<true>|B<false>
6345 Statistics about purge operations, such as number of purges added, retired, and
6346 number of objects tested against purge operations. Only available with Varnish
6347 2.x. False by default.
6349 =item B<CollectSession> B<true>|B<false>
6351 Client session statistics. Number of past and current sessions, session herd and
6352 linger counters, etc. False by default.
6354 =item B<CollectSMA> B<true>|B<false>
6356 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
6357 component is Solaris specific. Only available with Varnish 2.x. False by
6360 =item B<CollectSMS> B<true>|B<false>
6362 synth (synthetic content) storage statistics. This storage
6363 component is used internally only. False by default.
6365 =item B<CollectSM> B<true>|B<false>
6367 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
6370 =item B<CollectStruct> B<true>|B<false>
6372 Current varnish internal state statistics. Number of current sessions, objects
6373 in cache store, open connections to backends (with Varnish 2.x), etc. False by
6376 =item B<CollectTotals> B<true>|B<false>
6378 Collects overview counters, such as the number of sessions created,
6379 the number of requests and bytes transferred. False by default.
6381 =item B<CollectUptime> B<true>|B<false>
6383 Varnish uptime. False by default.
6385 =item B<CollectVCL> B<true>|B<false>
6387 Number of total (available + discarded) VCL (config files). False by default.
6389 =item B<CollectWorkers> B<true>|B<false>
6391 Collect statistics about worker threads. False by default.
6395 =head2 Plugin C<vmem>
6397 The C<vmem> plugin collects information about the usage of virtual memory.
6398 Since the statistics provided by the Linux kernel are very detailed, they are
6399 collected very detailed. However, to get all the details, you have to switch
6400 them on manually. Most people just want an overview over, such as the number of
6401 pages read from swap space.
6405 =item B<Verbose> B<true>|B<false>
6407 Enables verbose collection of information. This will start collecting page
6408 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
6409 Part of these statistics are collected on a "per zone" basis.
6413 =head2 Plugin C<vserver>
6415 This plugin doesn't have any options. B<VServer> support is only available for
6416 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
6417 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
6418 need to apply the patches and compile your own kernel, which will then provide
6419 the F</proc/virtual> filesystem that is required by this plugin.
6421 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
6423 B<Note>: The traffic collected by this plugin accounts for the amount of
6424 traffic passing a socket which might be a lot less than the actual on-wire
6425 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
6426 collect on-wire traffic you could, for example, use the logging facilities of
6427 iptables to feed data for the guest IPs into the iptables plugin.
6429 =head2 Plugin C<write_graphite>
6431 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
6432 storage and graphing project. The plugin connects to I<Carbon>, the data layer
6433 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
6434 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
6435 of at most 1428 bytes to minimize the number of network packets.
6439 <Plugin write_graphite>
6449 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6450 blocks. Inside the B<Node> blocks, the following options are recognized:
6454 =item B<Host> I<Address>
6456 Hostname or address to connect to. Defaults to C<localhost>.
6458 =item B<Port> I<Service>
6460 Service name or port number to connect to. Defaults to C<2003>.
6462 =item B<Protocol> I<String>
6464 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
6466 =item B<LogSendErrors> B<false>|B<true>
6468 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
6469 If set to B<false>, it will not log the errors. This is especially useful when
6470 using Protocol UDP since many times we want to use the "fire-and-forget"
6471 approach and logging errors fills syslog with unneeded messages.
6473 =item B<Prefix> I<String>
6475 When set, I<String> is added in front of the host name. Dots and whitespace are
6476 I<not> escaped in this string (see B<EscapeCharacter> below).
6478 =item B<Postfix> I<String>
6480 When set, I<String> is appended to the host name. Dots and whitespace are
6481 I<not> escaped in this string (see B<EscapeCharacter> below).
6483 =item B<EscapeCharacter> I<Char>
6485 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
6486 in the identifier. The B<EscapeCharacter> option determines which character
6487 dots, whitespace and control characters are replaced with. Defaults to
6490 =item B<StoreRates> B<false>|B<true>
6492 If set to B<true> (the default), convert counter values to rates. If set to
6493 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6496 =item B<SeparateInstances> B<false>|B<true>
6498 If set to B<true>, the plugin instance and type instance will be in their own
6499 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6500 default), the plugin and plugin instance (and likewise the type and type
6501 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6503 =item B<AlwaysAppendDS> B<false>|B<true>
6505 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
6506 identifier. If set to B<false> (the default), this is only done when there is
6511 =head2 Plugin C<write_mongodb>
6513 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
6518 <Plugin "write_mongodb">
6527 The plugin can send values to multiple instances of I<MongoDB> by specifying
6528 one B<Node> block for each instance. Within the B<Node> blocks, the following
6529 options are available:
6533 =item B<Host> I<Address>
6535 Hostname or address to connect to. Defaults to C<localhost>.
6537 =item B<Port> I<Service>
6539 Service name or port number to connect to. Defaults to C<27017>.
6541 =item B<Timeout> I<Timeout>
6543 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
6544 Setting this option to zero means no timeout, which is the default.
6546 =item B<StoreRates> B<false>|B<true>
6548 If set to B<true> (the default), convert counter values to rates. If set to
6549 B<false> counter values are stored as is, i.e. as an increasing integer
6552 =item B<Database> I<Database>
6554 =item B<User> I<User>
6556 =item B<Password> I<Password>
6558 Sets the information used when authenticating to a I<MongoDB> database. The
6559 fields are optional (in which case no authentication is attempted), but if you
6560 want to use authentication all three fields must be set.
6564 =head2 Plugin C<write_http>
6566 This output plugin submits values to an http server by POST them using the
6567 PUTVAL plain-text protocol. Each destination you want to post data to needs to
6568 have one B<URL> block, within which the destination can be configured further,
6569 for example by specifying authentication data.
6573 <Plugin "write_http">
6574 <URL "http://example.com/post-collectd">
6580 B<URL> blocks need one string argument which is used as the URL to which data
6581 is posted. The following options are understood within B<URL> blocks.
6585 =item B<User> I<Username>
6587 Optional user name needed for authentication.
6589 =item B<Password> I<Password>
6591 Optional password needed for authentication.
6593 =item B<VerifyPeer> B<true>|B<false>
6595 Enable or disable peer SSL certificate verification. See
6596 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
6598 =item B<VerifyHost> B<true|false>
6600 Enable or disable peer host name verification. If enabled, the plugin checks if
6601 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
6602 matches the host name provided by the B<URL> option. If this identity check
6603 fails, the connection is aborted. Obviously, only works when connecting to a
6604 SSL enabled server. Enabled by default.
6606 =item B<CACert> I<File>
6608 File that holds one or more SSL certificates. If you want to use HTTPS you will
6609 possibly need this option. What CA certificates come bundled with C<libcurl>
6610 and are checked by default depends on the distribution you use.
6612 =item B<CAPath> I<Directory>
6614 Directory holding one or more CA certificate files. You can use this if for
6615 some reason all the needed CA certificates aren't in the same file and can't be
6616 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
6619 =item B<ClientKey> I<File>
6621 File that holds the private key in PEM format to be used for certificate-based
6624 =item B<ClientCert> I<File>
6626 File that holds the SSL certificate to be used for certificate-based
6629 =item B<ClientKeyPass> I<Password>
6631 Password required to load the private key in B<ClientKey>.
6633 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
6635 Define which SSL protocol version must be used. By default C<libcurl> will
6636 attempt to figure out the remote SSL protocol version. See
6637 L<curl_easy_setopt(3)> for more details.
6639 =item B<Format> B<Command>|B<JSON>
6641 Format of the output to generate. If set to B<Command>, will create output that
6642 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
6643 create output in the I<JavaScript Object Notation> (JSON).
6645 Defaults to B<Command>.
6647 =item B<StoreRates> B<true|false>
6649 If set to B<true>, convert counter values to rates. If set to B<false> (the
6650 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
6655 =head2 Plugin C<write_kafka>
6657 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
6661 <Plugin "write_kafka">
6662 Property "metadata.broker.list" "broker1:9092,broker2:9092"
6668 The following options are understood by the I<write_kafka plugin>:
6672 =item E<lt>B<Topic> I<Name>E<gt>
6674 The plugin's configuration consists of one or more B<Topic> blocks. Each block
6675 is given a unique I<Name> and specifies one kafka producer.
6676 Inside the B<Topic> block, the following per-topic options are
6681 =item B<Property> I<String> I<String>
6683 Configure the named property for the current topic. Properties are
6684 forwarded to the kafka producer library B<librdkafka>.
6686 =item B<Key> I<String>
6688 Use the specified string as a partioning key for the topic. Kafka breaks
6689 topic into partitions and guarantees that for a given topology, the same
6690 consumer will be used for a specific key. The special (case insensitive)
6691 string B<Random> can be used to specify that an arbitrary partition should
6694 =item B<Format> B<Command>|B<JSON>|B<Graphite>
6696 Selects the format in which messages are sent to the broker. If set to
6697 B<Command> (the default), values are sent as C<PUTVAL> commands which are
6698 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
6700 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
6701 an easy and straight forward exchange format.
6703 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
6704 "<metric> <value> <timestamp>\n".
6706 =item B<StoreRates> B<true>|B<false>
6708 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
6709 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
6710 default), no conversion is performed. Otherwise the conversion is performed
6711 using the internal value cache.
6713 Please note that currently this option is only used if the B<Format> option has
6714 been set to B<JSON>.
6716 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
6718 A prefix can be added in the metric name when outputting in the I<Graphite> format.
6719 It's added before the I<Host> name.
6720 Metric name will be "<prefix><host><postfix><plugin><type><name>"
6722 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
6724 A postfix can be added in the metric name when outputting in the I<Graphite> format.
6725 It's added after the I<Host> name.
6726 Metric name will be "<prefix><host><postfix><plugin><type><name>"
6728 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
6730 Specify a character to replace dots (.) in the host part of the metric name.
6731 In I<Graphite> metric name, dots are used as separators between different
6732 metric parts (host, plugin, type).
6733 Default is "_" (I<Underscore>).
6735 =item B<GraphiteSeparateInstances> B<false>|B<true>
6737 If set to B<true>, the plugin instance and type instance will be in their own
6738 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6739 default), the plugin and plugin instance (and likewise the type and type
6740 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6742 =item B<StoreRates> B<true>|B<false>
6744 If set to B<true> (the default), convert counter values to rates. If set to
6745 B<false> counter values are stored as is, i.e. as an increasing integer number.
6747 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
6748 converted values will have "rate" appended to the data source type, e.g.
6749 C<ds_type:derive:rate>.
6753 =item B<Property> I<String> I<String>
6755 Configure the kafka producer through properties, you almost always will
6756 want to set B<metadata.broker.list> to your Kafka broker list.
6760 =head2 Plugin C<write_riemann>
6762 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
6763 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
6764 I<Riemann> using UDP packets.
6768 <Plugin "write_riemann">
6774 AlwaysAppendDS false
6778 Attribute "foo" "bar"
6781 The following options are understood by the I<write_riemann plugin>:
6785 =item E<lt>B<Node> I<Name>E<gt>
6787 The plugin's configuration consists of one or more B<Node> blocks. Each block
6788 is given a unique I<Name> and specifies one connection to an instance of
6789 I<Riemann>. Indise the B<Node> block, the following per-connection options are
6794 =item B<Host> I<Address>
6796 Hostname or address to connect to. Defaults to C<localhost>.
6798 =item B<Port> I<Service>
6800 Service name or port number to connect to. Defaults to C<5555>.
6802 =item B<Protocol> B<UDP>|B<TCP>
6804 Specify the protocol to use when communicating with I<Riemann>. Defaults to
6807 =item B<StoreRates> B<true>|B<false>
6809 If set to B<true> (the default), convert counter values to rates. If set to
6810 B<false> counter values are stored as is, i.e. as an increasing integer number.
6812 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
6813 converted values will have "rate" appended to the data source type, e.g.
6814 C<ds_type:derive:rate>.
6816 =item B<AlwaysAppendDS> B<false>|B<true>
6818 If set the B<true>, append the name of the I<Data Source> (DS) to the
6819 "service", i.e. the field that, together with the "host" field, uniquely
6820 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
6821 only done when there is more than one DS.
6823 =item B<TTLFactor> I<Factor>
6825 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
6826 event is considered active. I<collectd> populates this field based on the
6827 metrics interval setting. This setting controls the factor with which the
6828 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
6829 know exactly what you're doing, you should only increase this setting from its
6832 =item B<Notifications> B<false>|B<true>
6834 If set to B<true>, create riemann events for notifications. This is B<true>
6835 by default. When processing thresholds from write_riemann, it might prove
6836 useful to avoid getting notification events.
6838 =item B<CheckThresholds> B<false>|B<true>
6840 If set to B<true>, attach state to events based on thresholds defined
6841 in the B<Threshold> plugin. Defaults to B<false>.
6845 =item B<Tag> I<String>
6847 Add the given string as an additional tag to the metric being sent to
6850 =item B<Attribute> I<String> I<String>
6852 Consider the two given strings to be the key and value of an additional
6853 attribute for each metric being sent out to I<Riemann>.
6857 =head1 THRESHOLD CONFIGURATION
6859 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
6860 we mean that the values are not only stored or sent somewhere, but that they
6861 are judged and, if a problem is recognized, acted upon. The only action
6862 collectd takes itself is to generate and dispatch a "notification". Plugins can
6863 register to receive notifications and perform appropriate further actions.
6865 Since systems and what you expect them to do differ a lot, you can configure
6866 B<thresholds> for your values freely. This gives you a lot of flexibility but
6867 also a lot of responsibility.
6869 Every time a value is out of range a notification is dispatched. This means
6870 that the idle percentage of your CPU needs to be less then the configured
6871 threshold only once for a notification to be generated. There's no such thing
6872 as a moving average or similar - at least not now.
6874 Also, all values that match a threshold are considered to be relevant or
6875 "interesting". As a consequence collectd will issue a notification if they are
6876 not received for B<Timeout> iterations. The B<Timeout> configuration option is
6877 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
6878 "2" (the default) and some hosts sends it's CPU statistics to the server every
6879 60 seconds, a notification will be dispatched after about 120 seconds. It may
6880 take a little longer because the timeout is checked only once each B<Interval>
6883 When a value comes within range again or is received after it was missing, an
6884 "OKAY-notification" is dispatched.
6886 Here is a configuration example to get you started. Read below for more
6899 <Plugin "interface">
6916 WarningMin 100000000
6922 There are basically two types of configuration statements: The C<Host>,
6923 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
6924 configured. The C<Plugin> and C<Type> blocks may be specified further using the
6925 C<Instance> option. You can combine the block by nesting the blocks, though
6926 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
6927 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
6928 C<Type> may not contain other blocks. If multiple blocks apply to the same
6929 value the most specific block is used.
6931 The other statements specify the threshold to configure. They B<must> be
6932 included in a C<Type> block. Currently the following statements are recognized:
6936 =item B<FailureMax> I<Value>
6938 =item B<WarningMax> I<Value>
6940 Sets the upper bound of acceptable values. If unset defaults to positive
6941 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
6942 will be created. If the value is greater than B<WarningMax> but less than (or
6943 equal to) B<FailureMax> a B<WARNING> notification will be created.
6945 =item B<FailureMin> I<Value>
6947 =item B<WarningMin> I<Value>
6949 Sets the lower bound of acceptable values. If unset defaults to negative
6950 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
6951 be created. If the value is less than B<WarningMin> but greater than (or equal
6952 to) B<FailureMin> a B<WARNING> notification will be created.
6954 =item B<DataSource> I<DSName>
6956 Some data sets have more than one "data source". Interesting examples are the
6957 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
6958 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
6959 system load data set, C<load>, even has three data sources: C<shortterm>,
6960 C<midterm>, and C<longterm>.
6962 Normally, all data sources are checked against a configured threshold. If this
6963 is undesirable, or if you want to specify different limits for each data
6964 source, you can use the B<DataSource> option to have a threshold apply only to
6967 =item B<Invert> B<true>|B<false>
6969 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
6970 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
6971 B<WarningMax>) are not okay. Defaults to B<false>.
6973 =item B<Persist> B<true>|B<false>
6975 Sets how often notifications are generated. If set to B<true> one notification
6976 will be generated for each value that is out of the acceptable range. If set to
6977 B<false> (the default) then a notification is only generated if a value is out
6978 of range but the previous value was okay.
6980 This applies to missing values, too: If set to B<true> a notification about a
6981 missing value is generated once every B<Interval> seconds. If set to B<false>
6982 only one such notification is generated until the value appears again.
6984 =item B<Percentage> B<true>|B<false>
6986 If set to B<true>, the minimum and maximum values given are interpreted as
6987 percentage value, relative to the other data sources. This is helpful for
6988 example for the "df" type, where you may want to issue a warning when less than
6989 5E<nbsp>% of the total space is available. Defaults to B<false>.
6991 =item B<Hits> I<Number>
6993 Delay creating the notification until the threshold has been passed I<Number>
6994 times. When a notification has been generated, or when a subsequent value is
6995 inside the threshold, the counter is reset. If, for example, a value is
6996 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
6997 will be dispatched at most once every 30E<nbsp>seconds.
6999 This is useful when short bursts are not a problem. If, for example, 100% CPU
7000 usage for up to a minute is normal (and data is collected every
7001 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
7003 =item B<Hysteresis> I<Number>
7005 When set to non-zero, a hysteresis value is applied when checking minimum and
7006 maximum bounds. This is useful for values that increase slowly and fluctuate a
7007 bit while doing so. When these values come close to the threshold, they may
7008 "flap", i.e. switch between failure / warning case and okay case repeatedly.
7010 If, for example, the threshold is configures as
7015 then a I<Warning> notification is created when the value exceeds I<101> and the
7016 corresponding I<Okay> notification is only created once the value falls below
7017 I<99>, thus avoiding the "flapping".
7021 =head1 FILTER CONFIGURATION
7023 Starting with collectd 4.6 there is a powerful filtering infrastructure
7024 implemented in the daemon. The concept has mostly been copied from
7025 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
7026 terminology, so that users that are familiar with iptables feel right at home.
7030 The following are the terms used in the remainder of the filter configuration
7031 documentation. For an ASCII-art schema of the mechanism, see
7032 L<"General structure"> below.
7038 A I<match> is a criteria to select specific values. Examples are, of course, the
7039 name of the value or it's current value.
7041 Matches are implemented in plugins which you have to load prior to using the
7042 match. The name of such plugins starts with the "match_" prefix.
7046 A I<target> is some action that is to be performed with data. Such actions
7047 could, for example, be to change part of the value's identifier or to ignore
7048 the value completely.
7050 Some of these targets are built into the daemon, see L<"Built-in targets">
7051 below. Other targets are implemented in plugins which you have to load prior to
7052 using the target. The name of such plugins starts with the "target_" prefix.
7056 The combination of any number of matches and at least one target is called a
7057 I<rule>. The target actions will be performed for all values for which B<all>
7058 matches apply. If the rule does not have any matches associated with it, the
7059 target action will be performed for all values.
7063 A I<chain> is a list of rules and possibly default targets. The rules are tried
7064 in order and if one matches, the associated target will be called. If a value
7065 is handled by a rule, it depends on the target whether or not any subsequent
7066 rules are considered or if traversal of the chain is aborted, see
7067 L<"Flow control"> below. After all rules have been checked, the default targets
7072 =head2 General structure
7074 The following shows the resulting structure:
7081 +---------+ +---------+ +---------+ +---------+
7082 ! Rule !->! Match !->! Match !->! Target !
7083 +---------+ +---------+ +---------+ +---------+
7086 +---------+ +---------+ +---------+
7087 ! Rule !->! Target !->! Target !
7088 +---------+ +---------+ +---------+
7095 +---------+ +---------+ +---------+
7096 ! Rule !->! Match !->! Target !
7097 +---------+ +---------+ +---------+
7107 There are four ways to control which way a value takes through the filter
7114 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
7115 process the value with another chain. When the called chain finishes, usually
7116 the next target or rule after the jump is executed.
7120 The stop condition, signaled for example by the built-in target B<stop>, causes
7121 all processing of the value to be stopped immediately.
7125 Causes processing in the current chain to be aborted, but processing of the
7126 value generally will continue. This means that if the chain was called via
7127 B<Jump>, the next target or rule after the jump will be executed. If the chain
7128 was not called by another chain, control will be returned to the daemon and it
7129 may pass the value to another chain.
7133 Most targets will signal the B<continue> condition, meaning that processing
7134 should continue normally. There is no special built-in target for this
7141 The configuration reflects this structure directly:
7143 PostCacheChain "PostCache"
7145 <Rule "ignore_mysql_show">
7148 Type "^mysql_command$"
7149 TypeInstance "^show_"
7159 The above configuration example will ignore all values where the plugin field
7160 is "mysql", the type is "mysql_command" and the type instance begins with
7161 "show_". All other values will be sent to the C<rrdtool> write plugin via the
7162 default target of the chain. Since this chain is run after the value has been
7163 added to the cache, the MySQL C<show_*> command statistics will be available
7164 via the C<unixsock> plugin.
7166 =head2 List of configuration options
7170 =item B<PreCacheChain> I<ChainName>
7172 =item B<PostCacheChain> I<ChainName>
7174 Configure the name of the "pre-cache chain" and the "post-cache chain". The
7175 argument is the name of a I<chain> that should be executed before and/or after
7176 the values have been added to the cache.
7178 To understand the implications, it's important you know what is going on inside
7179 I<collectd>. The following diagram shows how values are passed from the
7180 read-plugins to the write-plugins:
7186 + - - - - V - - - - +
7187 : +---------------+ :
7190 : +-------+-------+ :
7193 : +-------+-------+ : +---------------+
7194 : ! Cache !--->! Value Cache !
7195 : ! insert ! : +---+---+-------+
7196 : +-------+-------+ : ! !
7197 : ! ,------------' !
7199 : +-------+---+---+ : +-------+-------+
7200 : ! Post-Cache +--->! Write-Plugins !
7201 : ! Chain ! : +---------------+
7202 : +---------------+ :
7205 + - - - - - - - - - +
7207 After the values are passed from the "read" plugins to the dispatch functions,
7208 the pre-cache chain is run first. The values are added to the internal cache
7209 afterwards. The post-cache chain is run after the values have been added to the
7210 cache. So why is it such a huge deal if chains are run before or after the
7211 values have been added to this cache?
7213 Targets that change the identifier of a value list should be executed before
7214 the values are added to the cache, so that the name in the cache matches the
7215 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
7216 this cache to receive a list of all available values. If you change the
7217 identifier after the value list has been added to the cache, this may easily
7218 lead to confusion, but it's not forbidden of course.
7220 The cache is also used to convert counter values to rates. These rates are, for
7221 example, used by the C<value> match (see below). If you use the rate stored in
7222 the cache B<before> the new value is added, you will use the old, B<previous>
7223 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
7224 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
7227 Last but not last, the B<stop> target makes a difference: If the pre-cache
7228 chain returns the stop condition, the value will not be added to the cache and
7229 the post-cache chain will not be run.
7231 =item B<Chain> I<Name>
7233 Adds a new chain with a certain name. This name can be used to refer to a
7234 specific chain, for example to jump to it.
7236 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
7238 =item B<Rule> [I<Name>]
7240 Adds a new rule to the current chain. The name of the rule is optional and
7241 currently has no meaning for the daemon.
7243 Within the B<Rule> block, there may be any number of B<Match> blocks and there
7244 must be at least one B<Target> block.
7246 =item B<Match> I<Name>
7248 Adds a match to a B<Rule> block. The name specifies what kind of match should
7249 be performed. Available matches depend on the plugins that have been loaded.
7251 The arguments inside the B<Match> block are passed to the plugin implementing
7252 the match, so which arguments are valid here depends on the plugin being used.
7253 If you do not need any to pass any arguments to a match, you can use the
7258 Which is equivalent to:
7263 =item B<Target> I<Name>
7265 Add a target to a rule or a default target to a chain. The name specifies what
7266 kind of target is to be added. Which targets are available depends on the
7267 plugins being loaded.
7269 The arguments inside the B<Target> block are passed to the plugin implementing
7270 the target, so which arguments are valid here depends on the plugin being used.
7271 If you do not need any to pass any arguments to a target, you can use the
7276 This is the same as writing:
7283 =head2 Built-in targets
7285 The following targets are built into the core daemon and therefore need no
7286 plugins to be loaded:
7292 Signals the "return" condition, see the L<"Flow control"> section above. This
7293 causes the current chain to stop processing the value and returns control to
7294 the calling chain. The calling chain will continue processing targets and rules
7295 just after the B<jump> target (see below). This is very similar to the
7296 B<RETURN> target of iptables, see L<iptables(8)>.
7298 This target does not have any options.
7306 Signals the "stop" condition, see the L<"Flow control"> section above. This
7307 causes processing of the value to be aborted immediately. This is similar to
7308 the B<DROP> target of iptables, see L<iptables(8)>.
7310 This target does not have any options.
7318 Sends the value to "write" plugins.
7324 =item B<Plugin> I<Name>
7326 Name of the write plugin to which the data should be sent. This option may be
7327 given multiple times to send the data to more than one write plugin.
7331 If no plugin is explicitly specified, the values will be sent to all available
7342 Starts processing the rules of another chain, see L<"Flow control"> above. If
7343 the end of that chain is reached, or a stop condition is encountered,
7344 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
7345 next target or the next rule. This is similar to the B<-j> command line option
7346 of iptables, see L<iptables(8)>.
7352 =item B<Chain> I<Name>
7354 Jumps to the chain I<Name>. This argument is required and may appear only once.
7366 =head2 Available matches
7372 Matches a value using regular expressions.
7378 =item B<Host> I<Regex>
7380 =item B<Plugin> I<Regex>
7382 =item B<PluginInstance> I<Regex>
7384 =item B<Type> I<Regex>
7386 =item B<TypeInstance> I<Regex>
7388 Match values where the given regular expressions match the various fields of
7389 the identifier of a value. If multiple regular expressions are given, B<all>
7390 regexen must match for a value to match.
7392 =item B<Invert> B<false>|B<true>
7394 When set to B<true>, the result of the match is inverted, i.e. all value lists
7395 where all regular expressions apply are not matched, all other value lists are
7396 matched. Defaults to B<false>.
7403 Host "customer[0-9]+"
7409 Matches values that have a time which differs from the time on the server.
7411 This match is mainly intended for servers that receive values over the
7412 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
7413 is very sensitive to the timestamp used when updating the RRD files. In
7414 particular, the time must be ever increasing. If a misbehaving client sends one
7415 packet with a timestamp far in the future, all further packets with a correct
7416 time will be ignored because of that one packet. What's worse, such corrupted
7417 RRD files are hard to fix.
7419 This match lets one match all values B<outside> a specified time range
7420 (relative to the server's time), so you can use the B<stop> target (see below)
7421 to ignore the value, for example.
7427 =item B<Future> I<Seconds>
7429 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
7430 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7433 =item B<Past> I<Seconds>
7435 Matches all values that are I<behind> of the server's time by I<Seconds> or
7436 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7448 This example matches all values that are five minutes or more ahead of the
7449 server or one hour (or more) lagging behind.
7453 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
7454 values. If a data-set consists of more than one data-source, all data-sources
7455 must match the specified ranges for a positive match.
7461 =item B<Min> I<Value>
7463 Sets the smallest value which still results in a match. If unset, behaves like
7466 =item B<Max> I<Value>
7468 Sets the largest value which still results in a match. If unset, behaves like
7471 =item B<Invert> B<true>|B<false>
7473 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
7474 no-match is returned and vice versa. Please note that the B<Invert> setting
7475 only effects how B<Min> and B<Max> are applied to a specific value. Especially
7476 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
7478 =item B<DataSource> I<DSName> [I<DSName> ...]
7480 Select one or more of the data sources. If no data source is configured, all
7481 data sources will be checked. If the type handled by the match does not have a
7482 data source of the specified name(s), this will always result in no match
7483 (independent of the B<Invert> setting).
7485 =item B<Satisfy> B<Any>|B<All>
7487 Specifies how checking with several data sources is performed. If set to
7488 B<Any>, the match succeeds if one of the data sources is in the configured
7489 range. If set to B<All> the match only succeeds if all data sources are within
7490 the configured range. Default is B<All>.
7492 Usually B<All> is used for positive matches, B<Any> is used for negative
7493 matches. This means that with B<All> you usually check that all values are in a
7494 "good" range, while with B<Any> you check if any value is within a "bad" range
7495 (or outside the "good" range).
7499 Either B<Min> or B<Max>, but not both, may be unset.
7503 # Match all values smaller than or equal to 100. Matches only if all data
7504 # sources are below 100.
7510 # Match if the value of any data source is outside the range of 0 - 100.
7518 =item B<empty_counter>
7520 Matches all values with one or more data sources of type B<COUNTER> and where
7521 all counter values are zero. These counters usually I<never> increased since
7522 they started existing (and are therefore uninteresting), or got reset recently
7523 or overflowed and you had really, I<really> bad luck.
7525 Please keep in mind that ignoring such counters can result in confusing
7526 behavior: Counters which hardly ever increase will be zero for long periods of
7527 time. If the counter is reset for some reason (machine or service restarted,
7528 usually), the graph will be empty (NAN) for a long time. People may not
7533 Calculates a hash value of the host name and matches values according to that
7534 hash value. This makes it possible to divide all hosts into groups and match
7535 only values that are in a specific group. The intended use is in load
7536 balancing, where you want to handle only part of all data and leave the rest
7539 The hashing function used tries to distribute the hosts evenly. First, it
7540 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
7543 for (i = 0; host[i] != 0; i++)
7544 hash_value = (hash_value * 251) + host[i];
7546 The constant 251 is a prime number which is supposed to make this hash value
7547 more random. The code then checks the group for this host according to the
7548 I<Total> and I<Match> arguments:
7550 if ((hash_value % Total) == Match)
7555 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
7556 groups), then the least significant bit of the hash value will be the XOR of
7557 all least significant bits in the host name. One consequence is that when you
7558 have two hosts, "server0.example.com" and "server1.example.com", where the host
7559 name differs in one digit only and the digits differ by one, those hosts will
7560 never end up in the same group.
7566 =item B<Match> I<Match> I<Total>
7568 Divide the data into I<Total> groups and match all hosts in group I<Match> as
7569 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
7570 be smaller than I<Total>. I<Total> must be at least one, although only values
7571 greater than one really do make any sense.
7573 You can repeat this option to match multiple groups, for example:
7578 The above config will divide the data into seven groups and match groups three
7579 and five. One use would be to keep every value on two hosts so that if one
7580 fails the missing data can later be reconstructed from the second host.
7586 # Operate on the pre-cache chain, so that ignored values are not even in the
7591 # Divide all received hosts in seven groups and accept all hosts in
7595 # If matched: Return and continue.
7598 # If not matched: Return and stop.
7604 =head2 Available targets
7608 =item B<notification>
7610 Creates and dispatches a notification.
7616 =item B<Message> I<String>
7618 This required option sets the message of the notification. The following
7619 placeholders will be replaced by an appropriate value:
7627 =item B<%{plugin_instance}>
7631 =item B<%{type_instance}>
7633 These placeholders are replaced by the identifier field of the same name.
7635 =item B<%{ds:>I<name>B<}>
7637 These placeholders are replaced by a (hopefully) human readable representation
7638 of the current rate of this data source. If you changed the instance name
7639 (using the B<set> or B<replace> targets, see below), it may not be possible to
7640 convert counter values to rates.
7644 Please note that these placeholders are B<case sensitive>!
7646 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
7648 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
7655 <Target "notification">
7656 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
7662 Replaces parts of the identifier using regular expressions.
7668 =item B<Host> I<Regex> I<Replacement>
7670 =item B<Plugin> I<Regex> I<Replacement>
7672 =item B<PluginInstance> I<Regex> I<Replacement>
7674 =item B<TypeInstance> I<Regex> I<Replacement>
7676 Match the appropriate field with the given regular expression I<Regex>. If the
7677 regular expression matches, that part that matches is replaced with
7678 I<Replacement>. If multiple places of the input buffer match a given regular
7679 expression, only the first occurrence will be replaced.
7681 You can specify each option multiple times to use multiple regular expressions
7689 # Replace "example.net" with "example.com"
7690 Host "\\<example.net\\>" "example.com"
7692 # Strip "www." from hostnames
7698 Sets part of the identifier of a value to a given string.
7704 =item B<Host> I<String>
7706 =item B<Plugin> I<String>
7708 =item B<PluginInstance> I<String>
7710 =item B<TypeInstance> I<String>
7712 Set the appropriate field to the given string. The strings for plugin instance
7713 and type instance may be empty, the strings for host and plugin may not be
7714 empty. It's currently not possible to set the type of a value this way.
7721 PluginInstance "coretemp"
7722 TypeInstance "core3"
7727 =head2 Backwards compatibility
7729 If you use collectd with an old configuration, i.E<nbsp>e. one without a
7730 B<Chain> block, it will behave as it used to. This is equivalent to the
7731 following configuration:
7737 If you specify a B<PostCacheChain>, the B<write> target will not be added
7738 anywhere and you will have to make sure that it is called where appropriate. We
7739 suggest to add the above snippet as default target to your "PostCache" chain.
7743 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
7759 L<collectd-exec(5)>,
7760 L<collectd-perl(5)>,
7761 L<collectd-unixsock(5)>,
7774 Florian Forster E<lt>octo@collectd.orgE<gt>