5 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
9 BaseDir "/path/to/data/"
10 PIDFile "/path/to/pidfile/collectd.pid"
11 Server "123.123.123.123" 12345
28 This config file controls how the system statistics collection daemon
29 B<collectd> behaves. The most significant option is B<LoadPlugin>, which
30 controls which plugins to load. These plugins ultimately define collectd's
33 The syntax of this config file is similar to the config file of the famous
34 I<Apache> webserver. Each line contains either an option (a key and a list of
35 one or more values) or a section-start or -end. Empty lines and everything
36 after a non-quoted hash-symbol (C<#>) is ignored. I<Keys> are unquoted
37 strings, consisting only of alphanumeric characters and the underscore (C<_>)
38 character. Keys are handled case insensitive by I<collectd> itself and all
39 plugins included with it. I<Values> can either be an I<unquoted string>, a
40 I<quoted string> (enclosed in double-quotes) a I<number> or a I<boolean>
41 expression. I<Unquoted strings> consist of only alphanumeric characters and
42 underscores (C<_>) and do not need to be quoted. I<Quoted strings> are
43 enclosed in double quotes (C<">). You can use the backslash character (C<\>)
44 to include double quotes as part of the string. I<Numbers> can be specified in
45 decimal and floating point format (using a dot C<.> as decimal separator),
46 hexadecimal when using the C<0x> prefix and octal with a leading zero (C<0>).
47 I<Boolean> values are either B<true> or B<false>.
49 Lines may be wrapped by using C<\> as the last character before the newline.
50 This allows long lines to be split into multiple lines. Quoted strings may be
51 wrapped as well. However, those are treated special in that whitespace at the
52 beginning of the following lines will be ignored, which allows for nicely
53 indenting the wrapped lines.
55 The configuration is read and processed in order, i.e. from top to bottom. So
56 the plugins are loaded in the order listed in this config file. It is a good
57 idea to load any logging plugins first in order to catch messages from plugins
58 during configuration. Also, the C<LoadPlugin> option B<must> occur B<before>
59 the appropriate C<E<lt>Plugin ...E<gt>> block.
65 =item B<BaseDir> I<Directory>
67 Sets the base directory. This is the directory beneath all RRD-files are
68 created. Possibly more subdirectories are created. This is also the working
69 directory for the daemon.
71 =item B<LoadPlugin> I<Plugin>
73 Loads the plugin I<Plugin>. This is required to load plugins, unless the
74 B<AutoLoadPlugin> option is enabled (see below). Without any loaded plugins,
75 I<collectd> will be mostly useless.
77 Only the first B<LoadPlugin> statement or block for a given plugin name has any
78 effect. This is useful when you want to split up the configuration into smaller
79 files and want each file to be "self contained", i.e. it contains a B<Plugin>
80 block I<and> then appropriate B<LoadPlugin> statement. The downside is that if
81 you have multiple conflicting B<LoadPlugin> blocks, e.g. when they specify
82 different intervals, only one of them (the first one encountered) will take
83 effect and all others will be silently ignored.
85 B<LoadPlugin> may either be a simple configuration I<statement> or a I<block>
86 with additional options, affecting the behavior of B<LoadPlugin>. A simple
87 statement looks like this:
91 Options inside a B<LoadPlugin> block can override default settings and
92 influence the way plugins are loaded, e.g.:
99 The following options are valid inside B<LoadPlugin> blocks:
103 =item B<Globals> B<true|false>
105 If enabled, collectd will export all global symbols of the plugin (and of all
106 libraries loaded as dependencies of the plugin) and, thus, makes those symbols
107 available for resolving unresolved symbols in subsequently loaded plugins if
108 that is supported by your system.
110 This is useful (or possibly even required), e.g., when loading a plugin that
111 embeds some scripting language into the daemon (e.g. the I<Perl> and
112 I<Python plugins>). Scripting languages usually provide means to load
113 extensions written in C. Those extensions require symbols provided by the
114 interpreter, which is loaded as a dependency of the respective collectd plugin.
115 See the documentation of those plugins (e.g., L<collectd-perl(5)> or
116 L<collectd-python(5)>) for details.
118 By default, this is disabled. As a special exception, if the plugin name is
119 either C<perl> or C<python>, the default is changed to enabled in order to keep
120 the average user from ever having to deal with this low level linking stuff.
122 =item B<Interval> I<Seconds>
124 Sets a plugin-specific interval for collecting metrics. This overrides the
125 global B<Interval> setting. If a plugin provides own support for specifying an
126 interval, that setting will take precedence.
130 =item B<AutoLoadPlugin> B<false>|B<true>
132 When set to B<false> (the default), each plugin needs to be loaded explicitly,
133 using the B<LoadPlugin> statement documented above. If a
134 B<E<lt>PluginE<nbsp>...E<gt>> block is encountered and no configuration
135 handling callback for this plugin has been registered, a warning is logged and
136 the block is ignored.
138 When set to B<true>, explicit B<LoadPlugin> statements are not required. Each
139 B<E<lt>PluginE<nbsp>...E<gt>> block acts as if it was immediately preceded by a
140 B<LoadPlugin> statement. B<LoadPlugin> statements are still required for
141 plugins that don't provide any configuration, e.g. the I<Load plugin>.
143 =item B<Include> I<Path> [I<pattern>]
145 If I<Path> points to a file, includes that file. If I<Path> points to a
146 directory, recursively includes all files within that directory and its
147 subdirectories. If the C<wordexp> function is available on your system,
148 shell-like wildcards are expanded before files are included. This means you can
149 use statements like the following:
151 Include "/etc/collectd.d/*.conf"
153 Starting with version 5.3, this may also be a block in which further options
154 affecting the behavior of B<Include> may be specified. The following option is
157 <Include "/etc/collectd.d">
163 =item B<Filter> I<pattern>
165 If the C<fnmatch> function is available on your system, a shell-like wildcard
166 I<pattern> may be specified to filter which files to include. This may be used
167 in combination with recursively including a directory to easily be able to
168 arbitrarily mix configuration files and other documents (e.g. README files).
169 The given example is similar to the first example above but includes all files
170 matching C<*.conf> in any subdirectory of C</etc/collectd.d>:
172 Include "/etc/collectd.d" "*.conf"
176 If more than one files are included by a single B<Include> option, the files
177 will be included in lexicographical order (as defined by the C<strcmp>
178 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
179 order in which the files are loaded.
181 To prevent loops and shooting yourself in the foot in interesting ways the
182 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
183 most uses. Since symlinks are followed it is still possible to crash the daemon
184 by looping symlinks. In our opinion significant stupidity should result in an
185 appropriate amount of pain.
187 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
188 file, but you cannot include files from within blocks.
190 =item B<PIDFile> I<File>
192 Sets where to write the PID file to. This file is overwritten when it exists
193 and deleted when the program is stopped. Some init-scripts might override this
194 setting using the B<-P> command-line option.
196 =item B<PluginDir> I<Directory>
198 Path to the plugins (shared objects) of collectd.
200 =item B<TypesDB> I<File> [I<File> ...]
202 Set one or more files that contain the data-set descriptions. See
203 L<types.db(5)> for a description of the format of this file.
205 =item B<Interval> I<Seconds>
207 Configures the interval in which to query the read plugins. Obviously smaller
208 values lead to a higher system load produced by collectd, while higher values
209 lead to more coarse statistics.
211 B<Warning:> You should set this once and then never touch it again. If you do,
212 I<you will have to delete all your RRD files> or know some serious RRDtool
213 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
215 =item B<Timeout> I<Iterations>
217 Consider a value list "missing" when no update has been read or received for
218 I<Iterations> iterations. By default, I<collectd> considers a value list
219 missing when no update has been received for twice the update interval. Since
220 this setting uses iterations, the maximum allowed time without update depends
221 on the I<Interval> information contained in each value list. This is used in
222 the I<Threshold> configuration to dispatch notifications about missing values,
223 see L<collectd-threshold(5)> for details.
225 =item B<ReadThreads> I<Num>
227 Number of threads to start for reading plugins. The default value is B<5>, but
228 you may want to increase this if you have more than five plugins that take a
229 long time to read. Mostly those are plugins that do network-IO. Setting this to
230 a value higher than the number of registered read callbacks is not recommended.
232 =item B<WriteThreads> I<Num>
234 Number of threads to start for dispatching value lists to write plugins. The
235 default value is B<5>, but you may want to increase this if you have more than
236 five plugins that may take relatively long to write to.
238 =item B<WriteQueueLimitHigh> I<HighNum>
240 =item B<WriteQueueLimitLow> I<LowNum>
242 Metrics are read by the I<read threads> and then put into a queue to be handled
243 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
244 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
245 running into memory issues in such a case, you can limit the size of this
248 By default, there is no limit and memory may grow indefinitely. This is most
249 likely not an issue for clients, i.e. instances that only handle the local
250 metrics. For servers it is recommended to set this to a non-zero value, though.
252 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
253 Each of them takes a numerical argument which is the number of metrics in the
254 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
255 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
256 I<will> be enqueued. If the number of metrics currently in the queue is between
257 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
258 proportional to the number of metrics in the queue (i.e. it increases linearly
259 until it reaches 100%.)
261 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
262 unset, the latter will default to half of B<WriteQueueLimitHigh>.
264 If you do not want to randomly drop values when the queue size is between
265 I<LowNum> and I<HighNum>, set If B<WriteQueueLimitHigh> and
266 B<WriteQueueLimitLow> to same value.
268 =item B<Hostname> I<Name>
270 Sets the hostname that identifies a host. If you omit this setting, the
271 hostname will be determined using the L<gethostname(2)> system call.
273 =item B<FQDNLookup> B<true|false>
275 If B<Hostname> is determined automatically this setting controls whether or not
276 the daemon should try to figure out the "fully qualified domain name", FQDN.
277 This is done using a lookup of the name returned by C<gethostname>. This option
278 is enabled by default.
280 =item B<PreCacheChain> I<ChainName>
282 =item B<PostCacheChain> I<ChainName>
284 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
285 see L<FILTER CONFIGURATION> below on information on chains and how these
286 setting change the daemon's behavior.
290 =head1 PLUGIN OPTIONS
292 Some plugins may register own options. These options must be enclosed in a
293 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
294 require external configuration, too. The C<apache plugin>, for example,
295 required C<mod_status> to be configured in the webserver you're going to
296 collect data from. These plugins are listed below as well, even if they don't
297 require any configuration within collectd's configuration file.
299 A list of all plugins and a short summary for each plugin can be found in the
300 F<README> file shipped with the sourcecode and hopefully binary packets as
303 =head2 Plugin C<aggregation>
305 The I<Aggregation plugin> makes it possible to aggregate several values into
306 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
307 This can be put to a wide variety of uses, e.g. average and total CPU
308 statistics for your entire fleet.
310 The grouping is powerful but, as with many powerful tools, may be a bit
311 difficult to wrap your head around. The grouping will therefore be
312 demonstrated using an example: The average and sum of the CPU usage across
313 all CPUs of each host is to be calculated.
315 To select all the affected values for our example, set C<Plugin cpu> and
316 C<Type cpu>. The other values are left unspecified, meaning "all values". The
317 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
318 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
324 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...) and
325 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
326 example, the intention is to have a new value for each host / type instance
327 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
328 It can be specified multiple times to group by more than one field.
331 GroupBy "TypeInstance"
333 We do neither specify nor group by I<plugin instance> (the CPU number), so all
334 metrics that differ in the CPU number only will be aggregated. Each
335 aggregation needs I<at least one> such field, otherwise no aggregation would
338 The full example configuration looks like this:
340 <Plugin "aggregation">
346 GroupBy "TypeInstance"
349 CalculateAverage true
353 There are a couple of limitations you should be aware of:
359 The I<Type> cannot be left unspecified, because it is not reasonable to add
360 apples to oranges. Also, the internal lookup structure won't work if you try
365 There must be at least one unspecified, ungrouped field. Otherwise nothing
370 As you can see in the example above, each aggregation has its own
371 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
372 blocks may match the same values, i.e. one value list can update multiple
373 aggregations. The following options are valid inside B<Aggregation> blocks:
377 =item B<Host> I<Host>
379 =item B<Plugin> I<Plugin>
381 =item B<PluginInstance> I<PluginInstance>
383 =item B<Type> I<Type>
385 =item B<TypeInstance> I<TypeInstance>
387 Selects the value lists to be added to this aggregation. B<Type> must be a
388 valid data set name, see L<types.db(5)> for details.
390 If the string starts with and ends with a slash (C</>), the string is
391 interpreted as a I<regular expression>. The regex flavor used are POSIX
392 extended regular expressions as described in L<regex(7)>. Example usage:
394 Host "/^db[0-9]\\.example\\.com$/"
396 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
398 Group valued by the specified field. The B<GroupBy> option may be repeated to
399 group by multiple fields.
401 =item B<SetHost> I<Host>
403 =item B<SetPlugin> I<Plugin>
405 =item B<SetPluginInstance> I<PluginInstance>
407 =item B<SetTypeInstance> I<TypeInstance>
409 Sets the appropriate part of the identifier to the provided string.
411 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
412 will be replaced with the aggregation function, e.g. "average". Not including
413 the placeholder will result in duplication warnings and/or messed up values if
414 more than one aggregation function are enabled.
416 The following example calculates the average usage of all "even" CPUs:
418 <Plugin "aggregation">
421 PluginInstance "/[0,2,4,6,8]$/"
425 SetPluginInstance "even-%{aggregation}"
428 GroupBy "TypeInstance"
430 CalculateAverage true
434 This will create the files:
440 foo.example.com/cpu-even-average/cpu-idle
444 foo.example.com/cpu-even-average/cpu-system
448 foo.example.com/cpu-even-average/cpu-user
456 =item B<CalculateNum> B<true>|B<false>
458 =item B<CalculateSum> B<true>|B<false>
460 =item B<CalculateAverage> B<true>|B<false>
462 =item B<CalculateMinimum> B<true>|B<false>
464 =item B<CalculateMaximum> B<true>|B<false>
466 =item B<CalculateStddev> B<true>|B<false>
468 Boolean options for enabling calculation of the number of value lists, their
469 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
470 are disabled by default.
474 =head2 Plugin C<amqp>
476 The I<AMQMP plugin> can be used to communicate with other instances of
477 I<collectd> or third party applications using an AMQP message broker. Values
478 are sent to or received from the broker, which handles routing, queueing and
479 possibly filtering or messages.
482 # Send values to an AMQP broker
483 <Publish "some_name">
489 Exchange "amq.fanout"
490 # ExchangeType "fanout"
491 # RoutingKey "collectd"
495 # GraphitePrefix "collectd."
496 # GraphiteEscapeChar "_"
499 # Receive values from an AMQP broker
500 <Subscribe "some_name">
506 Exchange "amq.fanout"
507 # ExchangeType "fanout"
509 # RoutingKey "collectd.#"
513 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
514 blocks, which configure sending and receiving of values respectively. The two
515 blocks are very similar, so unless otherwise noted, an option can be used in
516 either block. The name given in the blocks starting tag is only used for
517 reporting messages, but may be used to support I<flushing> of certain
518 I<Publish> blocks in the future.
522 =item B<Host> I<Host>
524 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
525 the underlying communications library, I<rabbitmq-c>, which is "localhost".
527 =item B<Port> I<Port>
529 Service name or port number on which the AMQP broker accepts connections. This
530 argument must be a string, even if the numeric form is used. Defaults to
533 =item B<VHost> I<VHost>
535 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
537 =item B<User> I<User>
539 =item B<Password> I<Password>
541 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
544 =item B<Exchange> I<Exchange>
546 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
547 By default, "amq.fanout" will be used.
549 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
550 the given exchange and the I<queue> is created, using the I<routing key> if
551 configured. See the B<Queue> and B<RoutingKey> options below.
553 =item B<ExchangeType> I<Type>
555 If given, the plugin will try to create the configured I<exchange> with this
556 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
557 be bound to this exchange.
559 =item B<Queue> I<Queue> (Subscribe only)
561 Configures the I<queue> name to subscribe to. If no queue name was configures
562 explicitly, a unique queue name will be created by the broker.
564 =item B<RoutingKey> I<Key>
566 In I<Publish> blocks, this configures the routing key to set on all outgoing
567 messages. If not given, the routing key will be computed from the I<identifier>
568 of the value. The host, plugin, type and the two instances are concatenated
569 together using dots as the separator and all containing dots replaced with
570 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
571 possible to receive only specific values using a "topic" exchange.
573 In I<Subscribe> blocks, configures the I<routing key> used when creating a
574 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
575 used to filter messages when using a "topic" exchange. If you're only
576 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
579 =item B<Persistent> B<true>|B<false> (Publish only)
581 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
582 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
583 default), the I<transient> delivery mode will be used, i.e. messages may be
584 lost due to high load, overflowing queues or similar issues.
586 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
588 Selects the format in which messages are sent to the broker. If set to
589 B<Command> (the default), values are sent as C<PUTVAL> commands which are
590 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
591 case, the C<Content-Type> header field will be set to C<text/collectd>.
593 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
594 an easy and straight forward exchange format. The C<Content-Type> header field
595 will be set to C<application/json>.
597 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
598 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
601 A subscribing client I<should> use the C<Content-Type> header field to
602 determine how to decode the values. Currently, the I<AMQP plugin> itself can
603 only decode the B<Command> format.
605 =item B<StoreRates> B<true>|B<false> (Publish only)
607 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
608 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
609 default), no conversion is performed. Otherwise the conversion is performed
610 using the internal value cache.
612 Please note that currently this option is only used if the B<Format> option has
615 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
617 A prefix can be added in the metric name when outputting in the I<Graphite> format.
618 It's added before the I<Host> name.
619 Metric name will be "<prefix><host><postfix><plugin><type><name>"
621 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
623 A postfix can be added in the metric name when outputting in the I<Graphite> format.
624 It's added after the I<Host> name.
625 Metric name will be "<prefix><host><postfix><plugin><type><name>"
627 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
629 Specify a character to replace dots (.) in the host part of the metric name.
630 In I<Graphite> metric name, dots are used as separators between different
631 metric parts (host, plugin, type).
632 Default is "_" (I<Underscore>).
636 =head2 Plugin C<apache>
638 To configure the C<apache>-plugin you first need to configure the Apache
639 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
640 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
641 the following snipped to base your Apache config upon:
644 <IfModule mod_status.c>
645 <Location /mod_status>
646 SetHandler server-status
650 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
651 also supported. It introduces a new field, called C<BusyServers>, to count the
652 number of currently connected clients. This field is also supported.
654 The configuration of the I<Apache> plugin consists of one or more
655 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
656 as the instance name. For example:
660 URL "http://www1.example.com/mod_status?auto"
663 URL "http://www2.example.com/mod_status?auto"
667 The instance name will be used as the I<plugin instance>. To emulate the old
668 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
669 plugin to work correctly, each instance name must be unique. This is not
670 enforced by the plugin and it is your responsibility to ensure it.
672 The following options are accepted within each I<Instance> block:
676 =item B<URL> I<http://host/mod_status?auto>
678 Sets the URL of the C<mod_status> output. This needs to be the output generated
679 by C<ExtendedStatus on> and it needs to be the machine readable output
680 generated by appending the C<?auto> argument. This option is I<mandatory>.
682 =item B<User> I<Username>
684 Optional user name needed for authentication.
686 =item B<Password> I<Password>
688 Optional password needed for authentication.
690 =item B<VerifyPeer> B<true|false>
692 Enable or disable peer SSL certificate verification. See
693 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
695 =item B<VerifyHost> B<true|false>
697 Enable or disable peer host name verification. If enabled, the plugin checks
698 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
699 certificate matches the host name provided by the B<URL> option. If this
700 identity check fails, the connection is aborted. Obviously, only works when
701 connecting to a SSL enabled server. Enabled by default.
703 =item B<CACert> I<File>
705 File that holds one or more SSL certificates. If you want to use HTTPS you will
706 possibly need this option. What CA certificates come bundled with C<libcurl>
707 and are checked by default depends on the distribution you use.
711 =head2 Plugin C<apcups>
715 =item B<Host> I<Hostname>
717 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
718 that IPv6 support has been disabled unless someone can confirm or decline that
719 B<apcupsd> can handle it.
721 =item B<Port> I<Port>
723 TCP-Port to connect to. Defaults to B<3551>.
725 =item B<ReportSeconds> B<true|false>
727 If set to B<true>, the time reported in the C<timeleft> metric will be
728 converted to seconds. This is the recommended setting. If set to B<false>, the
729 default for backwards compatibility, the time will be reported in minutes.
733 =head2 Plugin C<aquaero>
735 This plugin collects the value of the available sensors in an
736 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
737 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
738 connection for monitoring and configuration. The board can handle multiple
739 temperature sensors, fans, water pumps and water level sensors and adjust the
740 output settings such as fan voltage or power used by the water pump based on
741 the available inputs using a configurable controller included in the board.
742 This plugin collects all the available inputs as well as some of the output
743 values chosen by this controller. The plugin is based on the I<libaquaero5>
744 library provided by I<aquatools-ng>.
748 =item B<Device> I<DevicePath>
750 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
751 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
752 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
756 =head2 Plugin C<ascent>
758 This plugin collects information about an Ascent server, a free server for the
759 "World of Warcraft" game. This plugin gathers the information by fetching the
760 XML status page using C<libcurl> and parses it using C<libxml2>.
762 The configuration options are the same as for the C<apache> plugin above:
766 =item B<URL> I<http://localhost/ascent/status/>
768 Sets the URL of the XML status output.
770 =item B<User> I<Username>
772 Optional user name needed for authentication.
774 =item B<Password> I<Password>
776 Optional password needed for authentication.
778 =item B<VerifyPeer> B<true|false>
780 Enable or disable peer SSL certificate verification. See
781 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
783 =item B<VerifyHost> B<true|false>
785 Enable or disable peer host name verification. If enabled, the plugin checks
786 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
787 certificate matches the host name provided by the B<URL> option. If this
788 identity check fails, the connection is aborted. Obviously, only works when
789 connecting to a SSL enabled server. Enabled by default.
791 =item B<CACert> I<File>
793 File that holds one or more SSL certificates. If you want to use HTTPS you will
794 possibly need this option. What CA certificates come bundled with C<libcurl>
795 and are checked by default depends on the distribution you use.
799 =head2 Plugin C<bind>
801 Starting with BIND 9.5.0, the most widely used DNS server software provides
802 extensive statistics about queries, responses and lots of other information.
803 The bind plugin retrieves this information that's encoded in XML and provided
804 via HTTP and submits the values to collectd.
806 To use this plugin, you first need to tell BIND to make this information
807 available. This is done with the C<statistics-channels> configuration option:
809 statistics-channels {
810 inet localhost port 8053;
813 The configuration follows the grouping that can be seen when looking at the
814 data with an XSLT compatible viewer, such as a modern web browser. It's
815 probably a good idea to make yourself familiar with the provided values, so you
816 can understand what the collected statistics actually mean.
821 URL "http://localhost:8053/"
836 Zone "127.in-addr.arpa/IN"
840 The bind plugin accepts the following configuration options:
846 URL from which to retrieve the XML data. If not specified,
847 C<http://localhost:8053/> will be used.
849 =item B<ParseTime> B<true>|B<false>
851 When set to B<true>, the time provided by BIND will be parsed and used to
852 dispatch the values. When set to B<false>, the local time source is queried.
854 This setting is set to B<true> by default for backwards compatibility; setting
855 this to B<false> is I<recommended> to avoid problems with timezones and
858 =item B<OpCodes> B<true>|B<false>
860 When enabled, statistics about the I<"OpCodes">, for example the number of
861 C<QUERY> packets, are collected.
865 =item B<QTypes> B<true>|B<false>
867 When enabled, the number of I<incoming> queries by query types (for example
868 C<A>, C<MX>, C<AAAA>) is collected.
872 =item B<ServerStats> B<true>|B<false>
874 Collect global server statistics, such as requests received over IPv4 and IPv6,
875 successful queries, and failed updates.
879 =item B<ZoneMaintStats> B<true>|B<false>
881 Collect zone maintenance statistics, mostly information about notifications
882 (zone updates) and zone transfers.
886 =item B<ResolverStats> B<true>|B<false>
888 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
889 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
890 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
891 default. Use the B<ResolverStats> option within a B<View "_default"> block
892 instead for the same functionality.
898 Collect global memory statistics.
902 =item B<View> I<Name>
904 Collect statistics about a specific I<"view">. BIND can behave different,
905 mostly depending on the source IP-address of the request. These different
906 configurations are called "views". If you don't use this feature, you most
907 likely are only interested in the C<_default> view.
909 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
910 information you want to collect about a view. If no B<View> block is
911 configured, no detailed view statistics will be collected.
915 =item B<QTypes> B<true>|B<false>
917 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
922 =item B<ResolverStats> B<true>|B<false>
924 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
925 (e.E<nbsp>g. queries over IPv4, lame servers).
929 =item B<CacheRRSets> B<true>|B<false>
931 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
932 type is collected. Negative entries (queries which resulted in an error, for
933 example names that do not exist) are reported with a leading exclamation mark,
938 =item B<Zone> I<Name>
940 When given, collect detailed information about the given zone in the view. The
941 information collected if very similar to the global B<ServerStats> information
944 You can repeat this option to collect detailed information about multiple
947 By default no detailed zone information is collected.
953 =head2 Plugin C<cgroups>
955 This plugin collects the CPU user/system time for each I<cgroup> by reading the
956 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
957 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
961 =item B<CGroup> I<Directory>
963 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
964 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
967 =item B<IgnoreSelected> B<true>|B<false>
969 Invert the selection: If set to true, all cgroups I<except> the ones that
970 match any one of the criteria are collected. By default only selected
971 cgroups are collected if a selection is made. If no selection is configured
972 at all, B<all> cgroups are selected.
978 The I<CPU plugin> collects CPU usage metrics.
980 The following configuration options are available:
984 =item B<ReportActive> B<false>|B<true>
986 Reports non-idle CPU usage as the "active" value. Defaults to false.
988 =item B<ReportByCpu> B<false>|B<true>
990 When true reports usage for all cores. When false, reports cpu usage
991 aggregated over all cores. Implies ValuesPercentage when false.
994 =item B<ValuesPercentage> B<false>|B<true>
996 When true report percentage usage instead of tick values. Defaults to false.
1001 =head2 Plugin C<cpufreq>
1003 This plugin doesn't have any options. It reads
1004 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1005 installed) to get the current CPU frequency. If this file does not exist make
1006 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1007 installed and an "cpu governor" (that's a kernel module) is loaded.
1009 =head2 Plugin C<csv>
1013 =item B<DataDir> I<Directory>
1015 Set the directory to store CSV-files under. Per default CSV-files are generated
1016 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1017 The special strings B<stdout> and B<stderr> can be used to write to the standard
1018 output and standard error channels, respectively. This, of course, only makes
1019 much sense when collectd is running in foreground- or non-daemon-mode.
1021 =item B<StoreRates> B<true|false>
1023 If set to B<true>, convert counter values to rates. If set to B<false> (the
1024 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1029 =head2 Plugin C<curl>
1031 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1032 and the match infrastructure (the same code used by the tail plugin) to use
1033 regular expressions with the received data.
1035 The following example will read the current value of AMD stock from Google's
1036 finance page and dispatch the value to collectd.
1039 <Page "stock_quotes">
1040 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1044 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1045 DSType "GaugeAverage"
1046 # Note: `stock_value' is not a standard type.
1053 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1054 a web page and one or more "matches" to be performed on the returned data. The
1055 string argument to the B<Page> block is used as plugin instance.
1057 The following options are valid within B<Page> blocks:
1063 URL of the web site to retrieve. Since a regular expression will be used to
1064 extract information from this data, non-binary data is a big plus here ;)
1066 =item B<User> I<Name>
1068 Username to use if authorization is required to read the page.
1070 =item B<Password> I<Password>
1072 Password to use if authorization is required to read the page.
1074 =item B<Digest> B<true>|B<false>
1076 Enable HTTP digest authentication.
1078 =item B<VerifyPeer> B<true>|B<false>
1080 Enable or disable peer SSL certificate verification. See
1081 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1083 =item B<VerifyHost> B<true>|B<false>
1085 Enable or disable peer host name verification. If enabled, the plugin checks if
1086 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1087 matches the host name provided by the B<URL> option. If this identity check
1088 fails, the connection is aborted. Obviously, only works when connecting to a
1089 SSL enabled server. Enabled by default.
1091 =item B<CACert> I<file>
1093 File that holds one or more SSL certificates. If you want to use HTTPS you will
1094 possibly need this option. What CA certificates come bundled with C<libcurl>
1095 and are checked by default depends on the distribution you use.
1097 =item B<Header> I<Header>
1099 A HTTP header to add to the request. Multiple headers are added if this option
1100 is specified more than once.
1102 =item B<Post> I<Body>
1104 Specifies that the HTTP operation should be a POST instead of a GET. The
1105 complete data to be posted is given as the argument. This option will usually
1106 need to be accompanied by a B<Header> option to set an appropriate
1107 C<Content-Type> for the post body (e.g. to
1108 C<application/x-www-form-urlencoded>).
1110 =item B<MeasureResponseTime> B<true>|B<false>
1112 Measure response time for the request. If this setting is enabled, B<Match>
1113 blocks (see below) are optional. Disabled by default.
1115 =item B<E<lt>MatchE<gt>>
1117 One or more B<Match> blocks that define how to match information in the data
1118 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1119 used by the C<tail> plugin, so please see the documentation of the C<tail>
1120 plugin below on how matches are defined. If the B<MeasureResponseTime> option
1121 is set to B<true>, B<Match> blocks are optional.
1125 =head2 Plugin C<curl_json>
1127 The B<curl_json plugin> collects values from JSON data to be parsed by
1128 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) retrieved via
1129 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1130 unix socket. The former can be used, for example, to collect values
1131 from CouchDB documents (which are stored JSON notation), and the
1132 latter to collect values from a uWSGI stats socket.
1134 The following example will collect several values from the built-in
1135 C<_stats> runtime statistics module of I<CouchDB>
1136 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1139 <URL "http://localhost:5984/_stats">
1141 <Key "httpd/requests/count">
1142 Type "http_requests"
1145 <Key "httpd_request_methods/*/count">
1146 Type "http_request_methods"
1149 <Key "httpd_status_codes/*/count">
1150 Type "http_response_codes"
1155 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1158 <Sock "/var/run/uwsgi.stats.sock">
1160 <Key "workers/*/requests">
1161 Type "http_requests"
1164 <Key "workers/*/apps/*/requests">
1165 Type "http_requests"
1170 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1171 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1172 blocks defining a unix socket to read JSON from directly. Each of
1173 these blocks may have one or more B<Key> blocks.
1175 The B<Key> string argument must be in a path format. Each component is
1176 used to match the key from a JSON map or the index of an JSON
1177 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1178 values for all map keys or array indices will be collectd.
1180 The following options are valid within B<URL> blocks:
1184 =item B<Instance> I<Instance>
1186 Sets the plugin instance to I<Instance>.
1188 =item B<User> I<Name>
1190 =item B<Password> I<Password>
1192 =item B<Digest> B<true>|B<false>
1194 =item B<VerifyPeer> B<true>|B<false>
1196 =item B<VerifyHost> B<true>|B<false>
1198 =item B<CACert> I<file>
1200 =item B<Header> I<Header>
1202 =item B<Post> I<Body>
1204 These options behave exactly equivalent to the appropriate options of the
1205 I<cURL> plugin. Please see there for a detailed description.
1209 The following options are valid within B<Key> blocks:
1213 =item B<Type> I<Type>
1215 Sets the type used to dispatch the values to the daemon. Detailed information
1216 about types and their configuration can be found in L<types.db(5)>. This
1217 option is mandatory.
1219 =item B<Instance> I<Instance>
1221 Type-instance to use. Defaults to the current map key or current string array element value.
1225 =head2 Plugin C<curl_xml>
1227 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1228 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1231 <URL "http://localhost/stats.xml">
1233 Instance "some_instance"
1238 CACert "/path/to/ca.crt"
1240 <XPath "table[@id=\"magic_level\"]/tr">
1242 #InstancePrefix "prefix-"
1243 InstanceFrom "td[1]"
1244 ValuesFrom "td[2]/span[@class=\"level\"]"
1249 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1250 URL to be fetched using libcurl. Within each B<URL> block there are
1251 options which specify the connection parameters, for example authentication
1252 information, and one or more B<XPath> blocks.
1254 Each B<XPath> block specifies how to get one type of information. The
1255 string argument must be a valid XPath expression which returns a list
1256 of "base elements". One value is dispatched for each "base element". The
1257 I<type instance> and values are looked up using further I<XPath> expressions
1258 that should be relative to the base element.
1260 Within the B<URL> block the following options are accepted:
1264 =item B<Host> I<Name>
1266 Use I<Name> as the host name when submitting values. Defaults to the global
1269 =item B<Instance> I<Instance>
1271 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1272 empty string (no plugin instance).
1274 =item B<Namespace> I<Prefix> I<URL>
1276 If an XPath expression references namespaces, they must be specified
1277 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1278 I<URL> is the "namespace name", an URI reference uniquely identifying the
1279 namespace. The option can be repeated to register multiple namespaces.
1283 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1284 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1286 =item B<User> I<User>
1288 =item B<Password> I<Password>
1290 =item B<Digest> B<true>|B<false>
1292 =item B<VerifyPeer> B<true>|B<false>
1294 =item B<VerifyHost> B<true>|B<false>
1296 =item B<CACert> I<CA Cert File>
1298 =item B<Header> I<Header>
1300 =item B<Post> I<Body>
1302 These options behave exactly equivalent to the appropriate options of the
1303 I<cURL plugin>. Please see there for a detailed description.
1305 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1307 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1308 B<XPath> block specifies how to get one type of information. The string
1309 argument must be a valid XPath expression which returns a list of "base
1310 elements". One value is dispatched for each "base element".
1312 Within the B<XPath> block the following options are accepted:
1316 =item B<Type> I<Type>
1318 Specifies the I<Type> used for submitting patches. This determines the number
1319 of values that are required / expected and whether the strings are parsed as
1320 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1321 This option is required.
1323 =item B<InstancePrefix> I<InstancePrefix>
1325 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1326 concatenated together without any separator.
1327 This option is optional.
1329 =item B<InstanceFrom> I<InstanceFrom>
1331 Specifies a XPath expression to use for determining the I<type instance>. The
1332 XPath expression must return exactly one element. The element's value is then
1333 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1335 This value is required. As a special exception, if the "base XPath expression"
1336 (the argument to the B<XPath> block) returns exactly one argument, then this
1337 option may be omitted.
1339 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1341 Specifies one or more XPath expression to use for reading the values. The
1342 number of XPath expressions must match the number of data sources in the
1343 I<type> specified with B<Type> (see above). Each XPath expression must return
1344 exactly one element. The element's value is then parsed as a number and used as
1345 value for the appropriate value in the value list dispatched to the daemon.
1351 =head2 Plugin C<dbi>
1353 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1354 connect to various databases, execute I<SQL> statements and read back the
1355 results. I<dbi> is an acronym for "database interface" in case you were
1356 wondering about the name. You can configure how each column is to be
1357 interpreted and the plugin will generate one or more data sets from each row
1358 returned according to these rules.
1360 Because the plugin is very generic, the configuration is a little more complex
1361 than those of other plugins. It usually looks something like this:
1364 <Query "out_of_stock">
1365 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1366 # Use with MySQL 5.0.0 or later
1370 InstancePrefix "out_of_stock"
1371 InstancesFrom "category"
1375 <Database "product_information">
1377 DriverOption "host" "localhost"
1378 DriverOption "username" "collectd"
1379 DriverOption "password" "aZo6daiw"
1380 DriverOption "dbname" "prod_info"
1381 SelectDB "prod_info"
1382 Query "out_of_stock"
1386 The configuration above defines one query with one result and one database. The
1387 query is then linked to the database with the B<Query> option I<within> the
1388 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1389 and you can also use the B<Include> statement to split up the configuration
1390 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1391 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1394 The following is a complete list of options:
1396 =head3 B<Query> blocks
1398 Query blocks define I<SQL> statements and how the returned data should be
1399 interpreted. They are identified by the name that is given in the opening line
1400 of the block. Thus the name needs to be unique. Other than that, the name is
1401 not used in collectd.
1403 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1404 define which column holds which value or instance information. You can use
1405 multiple B<Result> blocks to create multiple values from one returned row. This
1406 is especially useful, when queries take a long time and sending almost the same
1407 query again and again is not desirable.
1411 <Query "environment">
1412 Statement "select station, temperature, humidity from environment"
1415 # InstancePrefix "foo"
1416 InstancesFrom "station"
1417 ValuesFrom "temperature"
1421 InstancesFrom "station"
1422 ValuesFrom "humidity"
1426 The following options are accepted:
1430 =item B<Statement> I<SQL>
1432 Sets the statement that should be executed on the server. This is B<not>
1433 interpreted by collectd, but simply passed to the database server. Therefore,
1434 the SQL dialect that's used depends on the server collectd is connected to.
1436 The query has to return at least two columns, one for the instance and one
1437 value. You cannot omit the instance, even if the statement is guaranteed to
1438 always return exactly one line. In that case, you can usually specify something
1441 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1443 (That works with MySQL but may not be valid SQL according to the spec. If you
1444 use a more strict database server, you may have to select from a dummy table or
1447 Please note that some databases, for example B<Oracle>, will fail if you
1448 include a semicolon at the end of the statement.
1450 =item B<MinVersion> I<Version>
1452 =item B<MaxVersion> I<Value>
1454 Only use this query for the specified database version. You can use these
1455 options to provide multiple queries with the same name but with a slightly
1456 different syntax. The plugin will use only those queries, where the specified
1457 minimum and maximum versions fit the version of the database in use.
1459 The database version is determined by C<dbi_conn_get_engine_version>, see the
1460 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1461 for details. Basically, each part of the version is assumed to be in the range
1462 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1463 "40102", version "5.0.42" becomes "50042".
1465 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1466 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1467 happen. Don't to it! A valid example would be something along these lines:
1478 In the above example, there are three ranges that don't overlap. The last one
1479 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1480 before "4.0.0" are not specified.
1482 =item B<Type> I<Type>
1484 The B<type> that's used for each line returned. See L<types.db(5)> for more
1485 details on how types are defined. In short: A type is a predefined layout of
1486 data and the number of values and type of values has to match the type
1489 If you specify "temperature" here, you need exactly one gauge column. If you
1490 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1493 There must be exactly one B<Type> option inside each B<Result> block.
1495 =item B<InstancePrefix> I<prefix>
1497 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1498 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1499 all strings returned in the appropriate columns are concatenated together,
1500 separated by dashes I<("-")>.
1502 =item B<InstancesFrom> I<column0> [I<column1> ...]
1504 Specifies the columns whose values will be used to create the "type-instance"
1505 for each row. If you specify more than one column, the value of all columns
1506 will be joined together with dashes I<("-")> as separation characters.
1508 The plugin itself does not check whether or not all built instances are
1509 different. It's your responsibility to assure that each is unique. This is
1510 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1511 sure that only one row is returned in this case.
1513 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1516 =item B<ValuesFrom> I<column0> [I<column1> ...]
1518 Names the columns whose content is used as the actual data for the data sets
1519 that are dispatched to the daemon. How many such columns you need is determined
1520 by the B<Type> setting above. If you specify too many or not enough columns,
1521 the plugin will complain about that and no data will be submitted to the
1524 The actual data type in the columns is not that important. The plugin will
1525 automatically cast the values to the right type if it know how to do that. So
1526 it should be able to handle integer an floating point types, as well as strings
1527 (if they include a number at the beginning).
1529 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1533 =head3 B<Database> blocks
1535 Database blocks define a connection to a database and which queries should be
1536 sent to that database. Since the used "dbi" library can handle a wide variety
1537 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1538 documentationE<nbsp>- we stick as close to the terminology used there.
1540 Each database needs a "name" as string argument in the starting tag of the
1541 block. This name will be used as "PluginInstance" in the values submitted to
1542 the daemon. Other than that, that name is not used.
1546 =item B<Driver> I<Driver>
1548 Specifies the driver to use to connect to the database. In many cases those
1549 drivers are named after the database they can connect to, but this is not a
1550 technical necessity. These drivers are sometimes referred to as "DBD",
1551 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1552 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1553 project at L<http://libdbi-drivers.sourceforge.net/>.
1555 You need to give the driver name as expected by the "dbi" library here. You
1556 should be able to find that in the documentation for each driver. If you
1557 mistype the driver name, the plugin will dump a list of all known driver names
1560 =item B<DriverOption> I<Key> I<Value>
1562 Sets driver-specific options. What option a driver supports can be found in the
1563 documentation for each driver, somewhere at
1564 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1565 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1567 DBDs can register two types of options: String options and numeric options. The
1568 plugin will use the C<dbi_conn_set_option> function when the configuration
1569 provides a string and the C<dbi_conn_require_option_numeric> function when the
1570 configuration provides a number. So these two lines will actually result in
1571 different calls being used:
1573 DriverOption "Port" 1234 # numeric
1574 DriverOption "Port" "1234" # string
1576 Unfortunately, drivers are not too keen to report errors when an unknown option
1577 is passed to them, so invalid settings here may go unnoticed. This is not the
1578 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1579 the driver. If a driver complains about an option, the plugin will dump a
1580 complete list of all options understood by that driver to the log. There is no
1581 way to programatically find out if an option expects a string or a numeric
1582 argument, so you will have to refer to the appropriate DBD's documentation to
1583 find this out. Sorry.
1585 =item B<SelectDB> I<Database>
1587 In some cases, the database name you connect with is not the database name you
1588 want to use for querying data. If this option is set, the plugin will "select"
1589 (switch to) that database after the connection is established.
1591 =item B<Query> I<QueryName>
1593 Associates the query named I<QueryName> with this database connection. The
1594 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1595 blocks you want to refer to must be placed above the database block you want to
1598 =item B<Host> I<Hostname>
1600 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
1601 values. Defaults to the global hostname setting.
1609 =item B<Device> I<Device>
1611 Select partitions based on the devicename.
1613 =item B<MountPoint> I<Directory>
1615 Select partitions based on the mountpoint.
1617 =item B<FSType> I<FSType>
1619 Select partitions based on the filesystem type.
1621 =item B<IgnoreSelected> B<true>|B<false>
1623 Invert the selection: If set to true, all partitions B<except> the ones that
1624 match any one of the criteria are collected. By default only selected
1625 partitions are collected if a selection is made. If no selection is configured
1626 at all, B<all> partitions are selected.
1628 =item B<ReportByDevice> B<true>|B<false>
1630 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1631 (the default), it will report a disk as "root", but with it I<true>, it will be
1632 "sda1" (or whichever).
1634 =item B<ReportInodes> B<true>|B<false>
1636 Enables or disables reporting of free, reserved and used inodes. Defaults to
1637 inode collection being disabled.
1639 Enable this option if inodes are a scarce resource for you, usually because
1640 many small files are stored on the disk. This is a usual scenario for mail
1641 transfer agents and web caches.
1643 =item B<ValuesAbsolute> B<true>|B<false>
1645 Enables or disables reporting of free and used disk space in 1K-blocks.
1646 Defaults to B<true>.
1648 =item B<ValuesPercentage> B<false>|B<true>
1650 Enables or disables reporting of free and used disk space in percentage.
1651 Defaults to B<false>.
1653 This is useful for deploying I<collectd> on the cloud, where machines with
1654 different disk size may exist. Then it is more practical to configure
1655 thresholds based on relative disk size.
1659 =head2 Plugin C<disk>
1661 The C<disk> plugin collects information about the usage of physical disks and
1662 logical disks (partitions). Values collected are the number of octets written
1663 to and read from a disk or partition, the number of read/write operations
1664 issued to the disk and a rather complex "time" it took for these commands to be
1667 Using the following two options you can ignore some disks or configure the
1668 collection only of specific disks.
1672 =item B<Disk> I<Name>
1674 Select the disk I<Name>. Whether it is collected or ignored depends on the
1675 B<IgnoreSelected> setting, see below. As with other plugins that use the
1676 daemon's ignorelist functionality, a string that starts and ends with a slash
1677 is interpreted as a regular expression. Examples:
1682 =item B<IgnoreSelected> B<true>|B<false>
1684 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1685 statements, are ignored or if all other disks are ignored. The behavior
1686 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1687 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1688 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1689 is set to B<true>, all disks are collected B<except> the ones matched.
1691 =item B<UseBSDName> B<true>|B<false>
1693 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
1694 default major/minor numbers. Requires collectd to be built with Apple's
1697 =item B<UdevNameAttr> I<Attribute>
1699 Attempt to override disk instance name with the value of a specified udev
1700 attribute when built with B<libudev>. If the attribute is not defined for the
1701 given device, the default name is used. Example:
1703 UdevNameAttr "DM_NAME"
1707 =head2 Plugin C<dns>
1711 =item B<Interface> I<Interface>
1713 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1714 option sets the interface that should be used. If this option is not set, or
1715 set to "any", the plugin will try to get packets from B<all> interfaces. This
1716 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1718 =item B<IgnoreSource> I<IP-address>
1720 Ignore packets that originate from this address.
1722 =item B<SelectNumericQueryTypes> B<true>|B<false>
1724 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1728 =head2 Plugin C<email>
1732 =item B<SocketFile> I<Path>
1734 Sets the socket-file which is to be created.
1736 =item B<SocketGroup> I<Group>
1738 If running as root change the group of the UNIX-socket after it has been
1739 created. Defaults to B<collectd>.
1741 =item B<SocketPerms> I<Permissions>
1743 Change the file permissions of the UNIX-socket after it has been created. The
1744 permissions must be given as a numeric, octal value as you would pass to
1745 L<chmod(1)>. Defaults to B<0770>.
1747 =item B<MaxConns> I<Number>
1749 Sets the maximum number of connections that can be handled in parallel. Since
1750 this many threads will be started immediately setting this to a very high
1751 value will waste valuable resources. Defaults to B<5> and will be forced to be
1752 at most B<16384> to prevent typos and dumb mistakes.
1756 =head2 Plugin C<ethstat>
1758 The I<ethstat plugin> collects information about network interface cards (NICs)
1759 by talking directly with the underlying kernel driver using L<ioctl(2)>.
1765 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
1766 Map "multicast" "if_multicast"
1773 =item B<Interface> I<Name>
1775 Collect statistical information about interface I<Name>.
1777 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
1779 By default, the plugin will submit values as type C<derive> and I<type
1780 instance> set to I<Name>, the name of the metric as reported by the driver. If
1781 an appropriate B<Map> option exists, the given I<Type> and, optionally,
1782 I<TypeInstance> will be used.
1784 =item B<MappedOnly> B<true>|B<false>
1786 When set to B<true>, only metrics that can be mapped to to a I<type> will be
1787 collected, all other metrics will be ignored. Defaults to B<false>.
1791 =head2 Plugin C<exec>
1793 Please make sure to read L<collectd-exec(5)> before using this plugin. It
1794 contains valuable information on when the executable is executed and the
1795 output that is expected from it.
1799 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1801 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1803 Execute the executable I<Executable> as user I<User>. If the user name is
1804 followed by a colon and a group name, the effective group is set to that group.
1805 The real group and saved-set group will be set to the default group of that
1806 user. If no group is given the effective group ID will be the same as the real
1809 Please note that in order to change the user and/or group the daemon needs
1810 superuser privileges. If the daemon is run as an unprivileged user you must
1811 specify the same user/group here. If the daemon is run with superuser
1812 privileges, you must supply a non-root user here.
1814 The executable may be followed by optional arguments that are passed to the
1815 program. Please note that due to the configuration parsing numbers and boolean
1816 values may be changed. If you want to be absolutely sure that something is
1817 passed as-is please enclose it in quotes.
1819 The B<Exec> and B<NotificationExec> statements change the semantics of the
1820 programs executed, i.E<nbsp>e. the data passed to them and the response
1821 expected from them. This is documented in great detail in L<collectd-exec(5)>.
1825 =head2 Plugin C<filecount>
1827 The C<filecount> plugin counts the number of files in a certain directory (and
1828 its subdirectories) and their combined size. The configuration is very straight
1831 <Plugin "filecount">
1832 <Directory "/var/qmail/queue/mess">
1833 Instance "qmail-message"
1835 <Directory "/var/qmail/queue/todo">
1836 Instance "qmail-todo"
1838 <Directory "/var/lib/php5">
1839 Instance "php5-sessions"
1844 The example above counts the number of files in QMail's queue directories and
1845 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
1846 QMail has not yet looked at, the "message" queue holds the messages that were
1847 classified into "local" and "remote".
1849 As you can see, the configuration consists of one or more C<Directory> blocks,
1850 each of which specifies a directory in which to count the files. Within those
1851 blocks, the following options are recognized:
1855 =item B<Instance> I<Instance>
1857 Sets the plugin instance to I<Instance>. That instance name must be unique, but
1858 it's your responsibility, the plugin doesn't check for that. If not given, the
1859 instance is set to the directory name with all slashes replaced by underscores
1860 and all leading underscores removed.
1862 =item B<Name> I<Pattern>
1864 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
1865 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
1866 against the pattern, not the entire path. In case this makes it easier for you:
1867 This option has been named after the B<-name> parameter to L<find(1)>.
1869 =item B<MTime> I<Age>
1871 Count only files of a specific age: If I<Age> is greater than zero, only files
1872 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
1873 a negative number, this is inversed. For example, if B<-60> is specified, only
1874 files that have been modified in the last minute will be counted.
1876 The number can also be followed by a "multiplier" to easily specify a larger
1877 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
1878 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
1879 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
1880 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
1881 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
1884 =item B<Size> I<Size>
1886 Count only files of a specific size. When I<Size> is a positive number, only
1887 files that are at least this big are counted. If I<Size> is a negative number,
1888 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
1889 I<Size> are counted.
1891 As with the B<MTime> option, a "multiplier" may be added. For a detailed
1892 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
1893 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
1894 note that there are 1000 bytes in a kilobyte, not 1024.
1896 =item B<Recursive> I<true>|I<false>
1898 Controls whether or not to recurse into subdirectories. Enabled by default.
1900 =item B<IncludeHidden> I<true>|I<false>
1902 Controls whether or not to include "hidden" files and directories in the count.
1903 "Hidden" files and directories are those, whose name begins with a dot.
1904 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
1908 =head2 Plugin C<GenericJMX>
1910 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
1911 L<collectd-java(5)>.
1913 =head2 Plugin C<gmond>
1915 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
1916 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
1917 are built-in, custom mappings may be added via B<Metric> blocks, see below.
1922 MCReceiveFrom "239.2.11.71" "8649"
1923 <Metric "swap_total">
1925 TypeInstance "total"
1928 <Metric "swap_free">
1935 The following metrics are built-in:
1941 load_one, load_five, load_fifteen
1945 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
1949 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
1961 Available configuration options:
1965 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
1967 Sets sets the multicast group and UDP port to which to subscribe.
1969 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
1971 =item E<lt>B<Metric> I<Name>E<gt>
1973 These blocks add a new metric conversion to the internal table. I<Name>, the
1974 string argument to the B<Metric> block, is the metric name as used by Ganglia.
1978 =item B<Type> I<Type>
1980 Type to map this metric to. Required.
1982 =item B<TypeInstance> I<Instance>
1984 Type-instance to use. Optional.
1986 =item B<DataSource> I<Name>
1988 Data source to map this metric to. If the configured type has exactly one data
1989 source, this is optional. Otherwise the option is required.
1995 =head2 Plugin C<hddtemp>
1997 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
1998 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
1999 default values, see below. C<hddtemp> has to be running to work correctly. If
2000 C<hddtemp> is not running timeouts may appear which may interfere with other
2003 The B<hddtemp> homepage can be found at
2004 L<http://www.guzu.net/linux/hddtemp.php>.
2008 =item B<Host> I<Hostname>
2010 Hostname to connect to. Defaults to B<127.0.0.1>.
2012 =item B<Port> I<Port>
2014 TCP-Port to connect to. Defaults to B<7634>.
2018 =head2 Plugin C<interface>
2022 =item B<Interface> I<Interface>
2024 Select this interface. By default these interfaces will then be collected. For
2025 a more detailed description see B<IgnoreSelected> below.
2027 =item B<IgnoreSelected> I<true>|I<false>
2029 If no configuration if given, the B<traffic>-plugin will collect data from
2030 all interfaces. This may not be practical, especially for loopback- and
2031 similar interfaces. Thus, you can use the B<Interface>-option to pick the
2032 interfaces you're interested in. Sometimes, however, it's easier/preferred
2033 to collect all interfaces I<except> a few ones. This option enables you to
2034 do that: By setting B<IgnoreSelected> to I<true> the effect of
2035 B<Interface> is inverted: All selected interfaces are ignored and all
2036 other interfaces are collected.
2040 =head2 Plugin C<ipmi>
2044 =item B<Sensor> I<Sensor>
2046 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2048 =item B<IgnoreSelected> I<true>|I<false>
2050 If no configuration if given, the B<ipmi> plugin will collect data from all
2051 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2052 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2053 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2054 all other sensors are collected.
2056 =item B<NotifySensorAdd> I<true>|I<false>
2058 If a sensor appears after initialization time of a minute a notification
2061 =item B<NotifySensorRemove> I<true>|I<false>
2063 If a sensor disappears a notification is sent.
2065 =item B<NotifySensorNotPresent> I<true>|I<false>
2067 If you have for example dual power supply and one of them is (un)plugged then
2068 a notification is sent.
2072 =head2 Plugin C<iptables>
2076 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2078 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
2079 will collect the counters of all rules which have a comment-match. The comment
2080 is then used as type-instance.
2082 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2083 the I<n>th rule will be collected. Again, the comment (or the number) will be
2084 used as the type-instance.
2086 If I<Name> is supplied, it will be used as the type-instance instead of the
2087 comment or the number.
2091 =head2 Plugin C<irq>
2097 Select this irq. By default these irqs will then be collected. For a more
2098 detailed description see B<IgnoreSelected> below.
2100 =item B<IgnoreSelected> I<true>|I<false>
2102 If no configuration if given, the B<irq>-plugin will collect data from all
2103 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2104 can use the B<Irq>-option to pick the interrupt you're interested in.
2105 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2106 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2107 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2108 and all other interrupts are collected.
2112 =head2 Plugin C<java>
2114 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2115 This section only discusses the syntax and semantic of the configuration
2116 options. For more in-depth information on the I<Java> plugin, please read
2117 L<collectd-java(5)>.
2122 JVMArg "-verbose:jni"
2123 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2124 LoadPlugin "org.collectd.java.Foobar"
2125 <Plugin "org.collectd.java.Foobar">
2126 # To be parsed by the plugin
2130 Available configuration options:
2134 =item B<JVMArg> I<Argument>
2136 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2137 exactly the way the arguments to the I<java> binary on the command line work.
2138 Execute C<javaE<nbsp>--help> for details.
2140 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2141 any other options! When another option is found, the JVM will be started and
2142 later options will have to be ignored!
2144 =item B<LoadPlugin> I<JavaClass>
2146 Instantiates a new I<JavaClass> object. The constructor of this object very
2147 likely then registers one or more callback methods with the server.
2149 See L<collectd-java(5)> for details.
2151 When the first such option is found, the virtual machine (JVM) is created. This
2152 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2153 B<LoadPlugin> options!
2155 =item B<Plugin> I<Name>
2157 The entire block is passed to the Java plugin as an
2158 I<org.collectd.api.OConfigItem> object.
2160 For this to work, the plugin has to register a configuration callback first,
2161 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2162 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2163 depends on the (Java) plugin registering the callback and is completely
2164 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2168 =head2 Plugin C<libvirt>
2170 This plugin allows CPU, disk and network load to be collected for virtualized
2171 guests on the machine. This means that these characteristics can be collected
2172 for guest systems without installing any software on them - collectd only runs
2173 on the hosting system. The statistics are collected through libvirt
2174 (L<http://libvirt.org/>).
2176 Only I<Connection> is required.
2180 =item B<Connection> I<uri>
2182 Connect to the hypervisor given by I<uri>. For example if using Xen use:
2184 Connection "xen:///"
2186 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
2188 =item B<RefreshInterval> I<seconds>
2190 Refresh the list of domains and devices every I<seconds>. The default is 60
2191 seconds. Setting this to be the same or smaller than the I<Interval> will cause
2192 the list of domains and devices to be refreshed on every iteration.
2194 Refreshing the devices in particular is quite a costly operation, so if your
2195 virtualization setup is static you might consider increasing this. If this
2196 option is set to 0, refreshing is disabled completely.
2198 =item B<Domain> I<name>
2200 =item B<BlockDevice> I<name:dev>
2202 =item B<InterfaceDevice> I<name:dev>
2204 =item B<IgnoreSelected> I<true>|I<false>
2206 Select which domains and devices are collected.
2208 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
2209 disk/network devices are collected.
2211 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
2212 domains and disk/network devices are ignored, while the rest are collected.
2214 The domain name and device names may use a regular expression, if the name is
2215 surrounded by I</.../> and collectd was compiled with support for regexps.
2217 The default is to collect statistics for all domains and all their devices.
2221 BlockDevice "/:hdb/"
2222 IgnoreSelected "true"
2224 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
2227 =item B<HostnameFormat> B<name|uuid|hostname|...>
2229 When the libvirt plugin logs data, it sets the hostname of the collected data
2230 according to this setting. The default is to use the guest name as provided by
2231 the hypervisor, which is equal to setting B<name>.
2233 B<uuid> means use the guest's UUID. This is useful if you want to track the
2234 same guest across migrations.
2236 B<hostname> means to use the global B<Hostname> setting, which is probably not
2237 useful on its own because all guests will appear to have the same name.
2239 You can also specify combinations of these fields. For example B<name uuid>
2240 means to concatenate the guest name and UUID (with a literal colon character
2241 between, thus I<"foo:1234-1234-1234-1234">).
2243 =item B<InterfaceFormat> B<name>|B<address>
2245 When the libvirt plugin logs interface data, it sets the name of the collected
2246 data according to this setting. The default is to use the path as provided by
2247 the hypervisor (the "dev" property of the target node), which is equal to
2250 B<address> means use the interface's mac address. This is useful since the
2251 interface path might change between reboots of a guest or across migrations.
2255 +=head2 Plugin C<load>
2257 The I<Load plugin> collects the system load. These numbers give a rough overview
2258 over the utilization of a machine. The system load is defined as the number of
2259 runnable tasks in the run-queue and is provided by many operating systems as a
2260 one, five or fifteen minute average.
2262 The following configuration options are available:
2266 =item B<ReportRelative> B<false>|B<true>
2268 When enabled, system load divided by number of available CPU cores is reported
2269 for intervals 1 min, 5 min and 15 min. Defaults to false.
2274 =head2 Plugin C<logfile>
2278 =item B<LogLevel> B<debug|info|notice|warning|err>
2280 Sets the log-level. If, for example, set to B<notice>, then all events with
2281 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2283 Please note that B<debug> is only available if collectd has been compiled with
2286 =item B<File> I<File>
2288 Sets the file to write log messages to. The special strings B<stdout> and
2289 B<stderr> can be used to write to the standard output and standard error
2290 channels, respectively. This, of course, only makes much sense when I<collectd>
2291 is running in foreground- or non-daemon-mode.
2293 =item B<Timestamp> B<true>|B<false>
2295 Prefix all lines printed by the current time. Defaults to B<true>.
2297 =item B<PrintSeverity> B<true>|B<false>
2299 When enabled, all lines are prefixed by the severity of the log message, for
2300 example "warning". Defaults to B<false>.
2304 B<Note>: There is no need to notify the daemon after moving or removing the
2305 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2306 for each line it writes.
2308 =head2 Plugin C<log_logstash>
2310 The I<log logstash plugin> behaves like the logfile plugin but formats
2311 messages as JSON events for logstash to parse and input.
2315 =item B<LogLevel> B<debug|info|notice|warning|err>
2317 Sets the log-level. If, for example, set to B<notice>, then all events with
2318 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2320 Please note that B<debug> is only available if collectd has been compiled with
2323 =item B<File> I<File>
2325 Sets the file to write log messages to. The special strings B<stdout> and
2326 B<stderr> can be used to write to the standard output and standard error
2327 channels, respectively. This, of course, only makes much sense when I<collectd>
2328 is running in foreground- or non-daemon-mode.
2332 B<Note>: There is no need to notify the daemon after moving or removing the
2333 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2334 for each line it writes.
2336 =head2 Plugin C<lpar>
2338 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2339 virtualization technique for IBM POWER processors. It takes into account CPU
2340 time stolen from or donated to a partition, in addition to the usual user,
2341 system, I/O statistics.
2343 The following configuration options are available:
2347 =item B<CpuPoolStats> B<false>|B<true>
2349 When enabled, statistics about the processor pool are read, too. The partition
2350 needs to have pool authority in order to be able to acquire this information.
2353 =item B<ReportBySerial> B<false>|B<true>
2355 If enabled, the serial of the physical machine the partition is currently
2356 running on is reported as I<hostname> and the logical hostname of the machine
2357 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2358 used (just like other plugins) and the I<plugin instance> will be empty.
2363 =head2 Plugin C<mbmon>
2365 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2367 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2368 B<Host> and B<Port> options can be used to change these values, see below.
2369 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2370 timeouts may appear which may interfere with other statistics..
2372 C<mbmon> must be run with the -r option ("print TAG and Value format");
2373 Debian's F</etc/init.d/mbmon> script already does this, other people
2374 will need to ensure that this is the case.
2378 =item B<Host> I<Hostname>
2380 Hostname to connect to. Defaults to B<127.0.0.1>.
2382 =item B<Port> I<Port>
2384 TCP-Port to connect to. Defaults to B<411>.
2390 The C<md plugin> collects information from Linux Software-RAID devices (md).
2392 All reported values are of the type C<md_disks>. Reported type instances are
2393 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2394 I<missing> (physically absent) disks.
2398 =item B<Device> I<Device>
2400 Select md devices based on device name. The I<device name> is the basename of
2401 the device, i.e. the name of the block device without the leading C</dev/>.
2402 See B<IgnoreSelected> for more details.
2404 =item B<IgnoreSelected> B<true>|B<false>
2406 Invert device selection: If set to B<true>, all md devices B<except> those
2407 listed using B<Device> are collected. If B<false> (the default), only those
2408 listed are collected. If no configuration is given, the B<md> plugin will
2409 collect data from all md devices.
2413 =head2 Plugin C<memcachec>
2415 The C<memcachec plugin> connects to a memcached server, queries one or more
2416 given I<pages> and parses the returned data according to user specification.
2417 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2420 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2421 library. Please note that there is another library with a very similar name,
2422 libmemcache (notice the missing `d'), which is not applicable.
2424 Synopsis of the configuration:
2426 <Plugin "memcachec">
2427 <Page "plugin_instance">
2431 Regex "(\\d+) bytes sent"
2434 Instance "type_instance"
2439 The configuration options are:
2443 =item E<lt>B<Page> I<Name>E<gt>
2445 Each B<Page> block defines one I<page> to be queried from the memcached server.
2446 The block requires one string argument which is used as I<plugin instance>.
2448 =item B<Server> I<Address>
2450 Sets the server address to connect to when querying the page. Must be inside a
2455 When connected to the memcached server, asks for the page I<Key>.
2457 =item E<lt>B<Match>E<gt>
2459 Match blocks define which strings to look for and how matches substrings are
2460 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2464 =head2 Plugin C<memcached>
2466 The B<memcached plugin> connects to a memcached server and queries statistics
2467 about cache utilization, memory and bandwidth used.
2468 L<http://www.danga.com/memcached/>
2470 <Plugin "memcached">
2472 Host "memcache.example.com"
2477 The plugin configuration consists of one or more B<Instance> blocks which
2478 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2479 following options are allowed:
2483 =item B<Host> I<Hostname>
2485 Hostname to connect to. Defaults to B<127.0.0.1>.
2487 =item B<Port> I<Port>
2489 TCP-Port to connect to. Defaults to B<11211>.
2491 =item B<Socket> I<Path>
2493 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2494 setting is given, the B<Host> and B<Port> settings are ignored.
2498 =head2 Plugin C<mic>
2500 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2501 Intel's Many Integrated Core (MIC) systems.
2510 ShowTemperatures true
2513 IgnoreSelectedTemperature true
2518 IgnoreSelectedPower true
2521 The following options are valid inside the B<PluginE<nbsp>mic> block:
2525 =item B<ShowCPU> B<true>|B<false>
2527 If enabled (the default) a sum of the CPU usage accross all cores is reported.
2529 =item B<ShowCPUCores> B<true>|B<false>
2531 If enabled (the default) per-core CPU usage is reported.
2533 =item B<ShowMemory> B<true>|B<false>
2535 If enabled (the default) the physical memory usage of the MIC system is
2538 =item B<ShowTemperatures> B<true>|B<false>
2540 If enabled (the default) various temperatures of the MIC system are reported.
2542 =item B<Temperature> I<Name>
2544 This option controls which temperatures are being reported. Whether matching
2545 temperatures are being ignored or I<only> matching temperatures are reported
2546 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2547 temperatures are reported.
2549 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2551 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2552 (the default) only temperatures matching a B<Temperature> option are reported
2553 or, if no B<Temperature> option is specified, all temperatures are reported. If
2554 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2557 Known temperature names are:
2591 =item B<ShowPower> B<true>|B<false>
2593 If enabled (the default) various temperatures of the MIC system are reported.
2595 =item B<Power> I<Name>
2597 This option controls which power readings are being reported. Whether matching
2598 power readings are being ignored or I<only> matching power readings are reported
2599 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
2600 power readings are reported.
2602 =item B<IgnoreSelectedPower> B<false>|B<true>
2604 Controls the behavior of the B<Power> setting above. If set to B<false>
2605 (the default) only power readings matching a B<Power> option are reported
2606 or, if no B<Power> option is specified, all power readings are reported. If
2607 set to B<true>, matching power readings are I<ignored> and all other power readings
2610 Known power names are:
2616 Total power utilization averaged over Time Window 0 (uWatts).
2620 Total power utilization averaged over Time Window 0 (uWatts).
2624 Instantaneous power (uWatts).
2628 Max instantaneous power (uWatts).
2632 PCI-E connector power (uWatts).
2636 2x3 connector power (uWatts).
2640 2x4 connector power (uWatts).
2648 Uncore rail (uVolts).
2652 Memory subsystem rail (uVolts).
2658 =head2 Plugin C<memory>
2660 The I<memory plugin> provides the following configuration options:
2664 =item B<ValuesAbsolute> B<true>|B<false>
2666 Enables or disables reporting of physical memory usage in absolute numbers,
2667 i.e. bytes. Defaults to B<true>.
2669 =item B<ValuesPercentage> B<false>|B<true>
2671 Enables or disables reporting of physical memory usage in percentages, e.g.
2672 percent of physical memory used. Defaults to B<false>.
2674 This is useful for deploying I<collectd> in a heterogeneous environment in
2675 which the sizes of physical memory vary.
2679 =head2 Plugin C<modbus>
2681 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
2682 register values. It supports reading single registers (unsigned 16E<nbsp>bit
2683 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2684 values (two registers interpreted as IEEE floats in big endian notation).
2688 <Data "voltage-input-1">
2695 <Data "voltage-input-2">
2702 <Host "modbus.example.com">
2703 Address "192.168.0.42"
2708 Instance "power-supply"
2709 Collect "voltage-input-1"
2710 Collect "voltage-input-2"
2716 =item E<lt>B<Data> I<Name>E<gt> blocks
2718 Data blocks define a mapping between register numbers and the "types" used by
2721 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
2725 =item B<RegisterBase> I<Number>
2727 Configures the base register to read from the device. If the option
2728 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
2729 register will be read (the register number is increased by one).
2731 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
2733 Specifies what kind of data is returned by the device. If the type is B<Int32>,
2734 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
2735 combined into one value. Defaults to B<Uint16>.
2737 =item B<Type> I<Type>
2739 Specifies the "type" (data set) to use when dispatching the value to
2740 I<collectd>. Currently, only data sets with exactly one data source are
2743 =item B<Instance> I<Instance>
2745 Sets the type instance to use when dispatching the value to I<collectd>. If
2746 unset, an empty string (no type instance) is used.
2750 =item E<lt>B<Host> I<Name>E<gt> blocks
2752 Host blocks are used to specify to which hosts to connect and what data to read
2753 from their "slaves". The string argument I<Name> is used as hostname when
2754 dispatching the values to I<collectd>.
2756 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
2760 =item B<Address> I<Hostname>
2762 Specifies the node name (the actual network address) used to connect to the
2763 host. This may be an IP address or a hostname. Please note that the used
2764 I<libmodbus> library only supports IPv4 at the moment.
2766 =item B<Port> I<Service>
2768 Specifies the port used to connect to the host. The port can either be given as
2769 a number or as a service name. Please note that the I<Service> argument must be
2770 a string, even if ports are given in their numerical form. Defaults to "502".
2772 =item B<Interval> I<Interval>
2774 Sets the interval (in seconds) in which the values will be collected from this
2775 host. By default the global B<Interval> setting will be used.
2777 =item E<lt>B<Slave> I<ID>E<gt>
2779 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
2780 is used to specify which device should be addressed. For each device you want
2781 to query, one B<Slave> block must be given.
2783 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
2787 =item B<Instance> I<Instance>
2789 Specify the plugin instance to use when dispatching the values to I<collectd>.
2790 By default "slave_I<ID>" is used.
2792 =item B<Collect> I<DataName>
2794 Specifies which data to retrieve from the device. I<DataName> must be the same
2795 string as the I<Name> argument passed to a B<Data> block. You can specify this
2796 option multiple times to collect more than one value from a slave. At least one
2797 B<Collect> option is mandatory.
2805 =head2 Plugin C<mysql>
2807 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
2808 one or more databases when started and keeps the connection up as long as
2809 possible. When the connection is interrupted for whatever reason it will try
2810 to re-connect. The plugin will complain loudly in case anything goes wrong.
2812 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
2813 and collects information about MySQL network traffic, executed statements,
2814 requests, the query cache and threads by evaluating the
2815 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
2816 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
2817 Status Variables> for an explanation of these values.
2819 Optionally, master and slave statistics may be collected in a MySQL
2820 replication setup. In that case, information about the synchronization state
2821 of the nodes are collected by evaluating the C<Position> return value of the
2822 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
2823 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
2824 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
2825 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
2826 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
2841 Socket "/var/run/mysql/mysqld.sock"
2843 SlaveNotifications true
2847 A B<Database> block defines one connection to a MySQL database. It accepts a
2848 single argument which specifies the name of the database. None of the other
2849 options are required. MySQL will use default values as documented in the
2850 section "mysql_real_connect()" in the B<MySQL reference manual>.
2854 =item B<Host> I<Hostname>
2856 Hostname of the database server. Defaults to B<localhost>.
2858 =item B<User> I<Username>
2860 Username to use when connecting to the database. The user does not have to be
2861 granted any privileges (which is synonym to granting the C<USAGE> privilege),
2862 unless you want to collectd replication statistics (see B<MasterStats> and
2863 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
2864 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
2866 =item B<Password> I<Password>
2868 Password needed to log into the database.
2870 =item B<Database> I<Database>
2872 Select this database. Defaults to I<no database> which is a perfectly reasonable
2873 option for what this plugin does.
2875 =item B<Port> I<Port>
2877 TCP-port to connect to. The port must be specified in its numeric form, but it
2878 must be passed as a string nonetheless. For example:
2882 If B<Host> is set to B<localhost> (the default), this setting has no effect.
2883 See the documentation for the C<mysql_real_connect> function for details.
2885 =item B<Socket> I<Socket>
2887 Specifies the path to the UNIX domain socket of the MySQL server. This option
2888 only has any effect, if B<Host> is set to B<localhost> (the default).
2889 Otherwise, use the B<Port> option above. See the documentation for the
2890 C<mysql_real_connect> function for details.
2892 =item B<MasterStats> I<true|false>
2894 =item B<SlaveStats> I<true|false>
2896 Enable the collection of master / slave statistics in a replication setup. In
2897 order to be able to get access to these statistics, the user needs special
2898 privileges. See the B<User> documentation above.
2900 =item B<SlaveNotifications> I<true|false>
2902 If enabled, the plugin sends a notification if the replication slave I/O and /
2903 or SQL threads are not running.
2907 =head2 Plugin C<netapp>
2909 The netapp plugin can collect various performance and capacity information
2910 from a NetApp filer using the NetApp API.
2912 Please note that NetApp has a wide line of products and a lot of different
2913 software versions for each of these products. This plugin was developed for a
2914 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
2915 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
2916 model and software version but it is very hard to test this.
2917 If you have used this plugin with other models and/or software version, feel
2918 free to send us a mail to tell us about the results, even if it's just a short
2921 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
2922 basic authentication.
2924 B<Do not use a regular user for this!> Create a special collectd user with just
2925 the minimum of capabilities needed. The user only needs the "login-http-admin"
2926 capability as well as a few more depending on which data will be collected.
2927 Required capabilities are documented below.
2932 <Host "netapp1.example.com">
2956 IgnoreSelectedIO false
2958 IgnoreSelectedOps false
2959 GetLatency "volume0"
2960 IgnoreSelectedLatency false
2967 IgnoreSelectedCapacity false
2970 IgnoreSelectedSnapshot false
2998 The netapp plugin accepts the following configuration options:
3002 =item B<Host> I<Name>
3004 A host block defines one NetApp filer. It will appear in collectd with the name
3005 you specify here which does not have to be its real name nor its hostname (see
3006 the B<Address> option below).
3008 =item B<VFiler> I<Name>
3010 A B<VFiler> block may only be used inside a host block. It accepts all the
3011 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
3012 will execute all NetApp API commands in the context of the specified
3013 VFiler(R). It will appear in collectd with the name you specify here which
3014 does not have to be its real name. The VFiler name may be specified using the
3015 B<VFilerName> option. If this is not specified, it will default to the name
3018 The VFiler block inherits all connection related settings from the surrounding
3019 B<Host> block (which appear before the B<VFiler> block) but they may be
3020 overwritten inside the B<VFiler> block.
3022 This feature is useful, for example, when using a VFiler as SnapVault target
3023 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
3024 available in the host filer (vfiler0) but only in the respective VFiler
3027 =item B<Protocol> B<httpd>|B<http>
3029 The protocol collectd will use to query this host.
3037 Valid options: http, https
3039 =item B<Address> I<Address>
3041 The hostname or IP address of the host.
3047 Default: The "host" block's name.
3049 =item B<Port> I<Port>
3051 The TCP port to connect to on the host.
3057 Default: 80 for protocol "http", 443 for protocol "https"
3059 =item B<User> I<User>
3061 =item B<Password> I<Password>
3063 The username and password to use to login to the NetApp.
3069 =item B<VFilerName> I<Name>
3071 The name of the VFiler in which context to execute API commands. If not
3072 specified, the name provided to the B<VFiler> block will be used instead.
3078 Default: name of the B<VFiler> block
3080 B<Note:> This option may only be used inside B<VFiler> blocks.
3082 =item B<Interval> I<Interval>
3088 The following options decide what kind of data will be collected. You can
3089 either use them as a block and fine tune various parameters inside this block,
3090 use them as a single statement to just accept all default values, or omit it to
3091 not collect any data.
3093 The following options are valid inside all blocks:
3097 =item B<Interval> I<Seconds>
3099 Collect the respective statistics every I<Seconds> seconds. Defaults to the
3100 host specific setting.
3104 =head3 The System block
3106 This will collect various performance data about the whole system.
3108 B<Note:> To get this data the collectd user needs the
3109 "api-perf-object-get-instances" capability.
3113 =item B<Interval> I<Seconds>
3115 Collect disk statistics every I<Seconds> seconds.
3117 =item B<GetCPULoad> B<true>|B<false>
3119 If you set this option to true the current CPU usage will be read. This will be
3120 the average usage between all CPUs in your NetApp without any information about
3123 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3124 returns in the "CPU" field.
3132 Result: Two value lists of type "cpu", and type instances "idle" and "system".
3134 =item B<GetInterfaces> B<true>|B<false>
3136 If you set this option to true the current traffic of the network interfaces
3137 will be read. This will be the total traffic over all interfaces of your NetApp
3138 without any information about individual interfaces.
3140 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3141 in the "Net kB/s" field.
3151 Result: One value list of type "if_octects".
3153 =item B<GetDiskIO> B<true>|B<false>
3155 If you set this option to true the current IO throughput will be read. This
3156 will be the total IO of your NetApp without any information about individual
3157 disks, volumes or aggregates.
3159 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3160 in the "DiskE<nbsp>kB/s" field.
3168 Result: One value list of type "disk_octets".
3170 =item B<GetDiskOps> B<true>|B<false>
3172 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
3173 iSCSI, etc. operations will be read. This will be the total number of
3174 operations on your NetApp without any information about individual volumes or
3177 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3178 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
3186 Result: A variable number of value lists of type "disk_ops_complex". Each type
3187 of operation will result in one value list with the name of the operation as
3192 =head3 The WAFL block
3194 This will collect various performance data about the WAFL file system. At the
3195 moment this just means cache performance.
3197 B<Note:> To get this data the collectd user needs the
3198 "api-perf-object-get-instances" capability.
3200 B<Note:> The interface to get these values is classified as "Diagnostics" by
3201 NetApp. This means that it is not guaranteed to be stable even between minor
3206 =item B<Interval> I<Seconds>
3208 Collect disk statistics every I<Seconds> seconds.
3210 =item B<GetNameCache> B<true>|B<false>
3218 Result: One value list of type "cache_ratio" and type instance
3221 =item B<GetDirCache> B<true>|B<false>
3229 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3231 =item B<GetInodeCache> B<true>|B<false>
3239 Result: One value list of type "cache_ratio" and type instance
3242 =item B<GetBufferCache> B<true>|B<false>
3244 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3245 in the "Cache hit" field.
3253 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3257 =head3 The Disks block
3259 This will collect performance data about the individual disks in the NetApp.
3261 B<Note:> To get this data the collectd user needs the
3262 "api-perf-object-get-instances" capability.
3266 =item B<Interval> I<Seconds>
3268 Collect disk statistics every I<Seconds> seconds.
3270 =item B<GetBusy> B<true>|B<false>
3272 If you set this option to true the busy time of all disks will be calculated
3273 and the value of the busiest disk in the system will be written.
3275 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3276 in the "Disk util" field. Probably.
3284 Result: One value list of type "percent" and type instance "disk_busy".
3288 =head3 The VolumePerf block
3290 This will collect various performance data about the individual volumes.
3292 You can select which data to collect about which volume using the following
3293 options. They follow the standard ignorelist semantic.
3295 B<Note:> To get this data the collectd user needs the
3296 I<api-perf-object-get-instances> capability.
3300 =item B<Interval> I<Seconds>
3302 Collect volume performance data every I<Seconds> seconds.
3304 =item B<GetIO> I<Volume>
3306 =item B<GetOps> I<Volume>
3308 =item B<GetLatency> I<Volume>
3310 Select the given volume for IO, operations or latency statistics collection.
3311 The argument is the name of the volume without the C</vol/> prefix.
3313 Since the standard ignorelist functionality is used here, you can use a string
3314 starting and ending with a slash to specify regular expression matching: To
3315 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3318 GetIO "/^vol[027]$/"
3320 If no regular expression is specified, an exact match is required. Both,
3321 regular and exact matching are case sensitive.
3323 If no volume was specified at all for either of the three options, that data
3324 will be collected for all available volumes.
3326 =item B<IgnoreSelectedIO> B<true>|B<false>
3328 =item B<IgnoreSelectedOps> B<true>|B<false>
3330 =item B<IgnoreSelectedLatency> B<true>|B<false>
3332 When set to B<true>, the volumes selected for IO, operations or latency
3333 statistics collection will be ignored and the data will be collected for all
3336 When set to B<false>, data will only be collected for the specified volumes and
3337 all other volumes will be ignored.
3339 If no volumes have been specified with the above B<Get*> options, all volumes
3340 will be collected regardless of the B<IgnoreSelected*> option.
3342 Defaults to B<false>
3346 =head3 The VolumeUsage block
3348 This will collect capacity data about the individual volumes.
3350 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3355 =item B<Interval> I<Seconds>
3357 Collect volume usage statistics every I<Seconds> seconds.
3359 =item B<GetCapacity> I<VolumeName>
3361 The current capacity of the volume will be collected. This will result in two
3362 to four value lists, depending on the configuration of the volume. All data
3363 sources are of type "df_complex" with the name of the volume as
3366 There will be type_instances "used" and "free" for the number of used and
3367 available bytes on the volume. If the volume has some space reserved for
3368 snapshots, a type_instance "snap_reserved" will be available. If the volume
3369 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3370 number of bytes saved by the SIS feature.
3372 B<Note:> The current NetApp API has a bug that results in this value being
3373 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3374 number which works most of the time. If you see strange values here, bug
3375 NetApp support to fix this.
3377 Repeat this option to specify multiple volumes.
3379 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3381 Specify whether to collect only the volumes selected by the B<GetCapacity>
3382 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3383 B<false>. However, if no B<GetCapacity> option is specified at all, all
3384 capacities will be selected anyway.
3386 =item B<GetSnapshot> I<VolumeName>
3388 Select volumes from which to collect snapshot information.
3390 Usually, the space used for snapshots is included in the space reported as
3391 "used". If snapshot information is collected as well, the space used for
3392 snapshots is subtracted from the used space.
3394 To make things even more interesting, it is possible to reserve space to be
3395 used for snapshots. If the space required for snapshots is less than that
3396 reserved space, there is "reserved free" and "reserved used" space in addition
3397 to "free" and "used". If the space required for snapshots exceeds the reserved
3398 space, that part allocated in the normal space is subtracted from the "used"
3401 Repeat this option to specify multiple volumes.
3403 =item B<IgnoreSelectedSnapshot>
3405 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3406 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3407 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3408 capacities will be selected anyway.
3412 =head3 The Quota block
3414 This will collect (tree) quota statistics (used disk space and number of used
3415 files). This mechanism is useful to get usage information for single qtrees.
3416 In case the quotas are not used for any other purpose, an entry similar to the
3417 following in C</etc/quotas> would be sufficient:
3419 /vol/volA/some_qtree tree - - - - -
3421 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3425 =item B<Interval> I<Seconds>
3427 Collect SnapVault(R) statistics every I<Seconds> seconds.
3431 =head3 The SnapVault block
3433 This will collect statistics about the time and traffic of SnapVault(R)
3438 =item B<Interval> I<Seconds>
3440 Collect SnapVault(R) statistics every I<Seconds> seconds.
3444 =head2 Plugin C<netlink>
3446 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3447 statistics of various interface and routing aspects.
3451 =item B<Interface> I<Interface>
3453 =item B<VerboseInterface> I<Interface>
3455 Instruct the plugin to collect interface statistics. This is basically the same
3456 as the statistics provided by the C<interface> plugin (see above) but
3457 potentially much more detailed.
3459 When configuring with B<Interface> only the basic statistics will be collected,
3460 namely octets, packets, and errors. These statistics are collected by
3461 the C<interface> plugin, too, so using both at the same time is no benefit.
3463 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3464 so that no data needs to be collected twice if you use the C<interface> plugin.
3465 This includes dropped packets, received multicast packets, collisions and a
3466 whole zoo of differentiated RX and TX errors. You can try the following command
3467 to get an idea of what awaits you:
3471 If I<Interface> is B<All>, all interfaces will be selected.
3473 =item B<QDisc> I<Interface> [I<QDisc>]
3475 =item B<Class> I<Interface> [I<Class>]
3477 =item B<Filter> I<Interface> [I<Filter>]
3479 Collect the octets and packets that pass a certain qdisc, class or filter.
3481 QDiscs and classes are identified by their type and handle (or classid).
3482 Filters don't necessarily have a handle, therefore the parent's handle is used.
3483 The notation used in collectd differs from that used in tc(1) in that it
3484 doesn't skip the major or minor number if it's zero and doesn't print special
3485 ids by their name. So, for example, a qdisc may be identified by
3486 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3487 thus not displayed by tc(1).
3489 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3490 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3491 associated with that interface will be collected.
3493 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3494 used. This may lead to problems when more than one filter is attached to a
3495 qdisc or class. This isn't nice, but we don't know how this could be done any
3496 better. If you have a idea, please don't hesitate to tell us.
3498 As with the B<Interface> option you can specify B<All> as the interface,
3499 meaning all interfaces.
3501 Here are some examples to help you understand the above text more easily:
3504 VerboseInterface "All"
3505 QDisc "eth0" "pfifo_fast-1:0"
3507 Class "ppp0" "htb-1:10"
3508 Filter "ppp0" "u32-1:0"
3511 =item B<IgnoreSelected>
3513 The behavior is the same as with all other similar plugins: If nothing is
3514 selected at all, everything is collected. If some things are selected using the
3515 options described above, only these statistics are collected. If you set
3516 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3517 specified statistics will not be collected.
3521 =head2 Plugin C<network>
3523 The Network plugin sends data to a remote instance of collectd, receives data
3524 from a remote instance, or both at the same time. Data which has been received
3525 from the network is usually not transmitted again, but this can be activated, see
3526 the B<Forward> option below.
3528 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3529 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3531 Both, B<Server> and B<Listen> can be used as single option or as block. When
3532 used as block, given options are valid for this socket only. The following
3533 example will export the metrics twice: Once to an "internal" server (without
3534 encryption and signing) and one to an external server (with cryptographic
3538 # Export to an internal server
3539 # (demonstrates usage without additional options)
3540 Server "collectd.internal.tld"
3542 # Export to an external server
3543 # (demonstrates usage with signature options)
3544 <Server "collectd.external.tld">
3545 SecurityLevel "sign"
3546 Username "myhostname"
3553 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3555 The B<Server> statement/block sets the server to send datagrams to. The
3556 statement may occur multiple times to send each datagram to multiple
3559 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3560 optional second argument specifies a port number or a service name. If not
3561 given, the default, B<25826>, is used.
3563 The following options are recognized within B<Server> blocks:
3567 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3569 Set the security you require for network communication. When the security level
3570 has been set to B<Encrypt>, data sent over the network will be encrypted using
3571 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3572 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3573 authentication code. When set to B<None>, data is sent without any security.
3575 This feature is only available if the I<network> plugin was linked with
3578 =item B<Username> I<Username>
3580 Sets the username to transmit. This is used by the server to lookup the
3581 password. See B<AuthFile> below. All security levels except B<None> require
3584 This feature is only available if the I<network> plugin was linked with
3587 =item B<Password> I<Password>
3589 Sets a password (shared secret) for this socket. All security levels except
3590 B<None> require this setting.
3592 This feature is only available if the I<network> plugin was linked with
3595 =item B<Interface> I<Interface name>
3597 Set the outgoing interface for IP packets. This applies at least
3598 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3599 undefined or a non-existent interface name is specified, the default
3600 behavior is to let the kernel choose the appropriate interface. Be warned
3601 that the manual selection of an interface for unicast traffic is only
3602 necessary in rare cases.
3606 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
3608 The B<Listen> statement sets the interfaces to bind to. When multiple
3609 statements are found the daemon will bind to multiple interfaces.
3611 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
3612 the argument is a multicast address the daemon will join that multicast group.
3613 The optional second argument specifies a port number or a service name. If not
3614 given, the default, B<25826>, is used.
3616 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
3620 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3622 Set the security you require for network communication. When the security level
3623 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
3624 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
3625 signed and encrypted data is accepted. When set to B<None>, all data will be
3626 accepted. If an B<AuthFile> option was given (see below), encrypted data is
3627 decrypted if possible.
3629 This feature is only available if the I<network> plugin was linked with
3632 =item B<AuthFile> I<Filename>
3634 Sets a file in which usernames are mapped to passwords. These passwords are
3635 used to verify signatures and to decrypt encrypted network packets. If
3636 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
3637 verified and encrypted packets are decrypted. Otherwise, signed data is
3638 accepted without checking the signature and encrypted data cannot be decrypted.
3639 For the other security levels this option is mandatory.
3641 The file format is very simple: Each line consists of a username followed by a
3642 colon and any number of spaces followed by the password. To demonstrate, an
3643 example file could look like this:
3648 Each time a packet is received, the modification time of the file is checked
3649 using L<stat(2)>. If the file has been changed, the contents is re-read. While
3650 the file is being read, it is locked using L<fcntl(2)>.
3652 =item B<Interface> I<Interface name>
3654 Set the incoming interface for IP packets explicitly. This applies at least
3655 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3656 undefined or a non-existent interface name is specified, the default
3657 behavior is, to let the kernel choose the appropriate interface. Thus incoming
3658 traffic gets only accepted, if it arrives on the given interface.
3662 =item B<TimeToLive> I<1-255>
3664 Set the time-to-live of sent packets. This applies to all, unicast and
3665 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
3666 That means that multicast packets will be sent with a TTL of C<1> (one) on most
3669 =item B<MaxPacketSize> I<1024-65535>
3671 Set the maximum size for datagrams received over the network. Packets larger
3672 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
3673 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
3676 On the server side, this limit should be set to the largest value used on
3677 I<any> client. Likewise, the value on the client must not be larger than the
3678 value on the server, or data will be lost.
3680 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
3681 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
3682 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
3685 =item B<Forward> I<true|false>
3687 If set to I<true>, write packets that were received via the network plugin to
3688 the sending sockets. This should only be activated when the B<Listen>- and
3689 B<Server>-statements differ. Otherwise packets may be send multiple times to
3690 the same multicast group. While this results in more network traffic than
3691 necessary it's not a huge problem since the plugin has a duplicate detection,
3692 so the values will not loop.
3694 =item B<ReportStats> B<true>|B<false>
3696 The network plugin cannot only receive and send statistics, it can also create
3697 statistics about itself. Collected data included the number of received and
3698 sent octets and packets, the length of the receive queue and the number of
3699 values handled. When set to B<true>, the I<Network plugin> will make these
3700 statistics available. Defaults to B<false>.
3704 =head2 Plugin C<nginx>
3706 This plugin collects the number of connections and requests handled by the
3707 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
3708 queries the page provided by the C<ngx_http_stub_status_module> module, which
3709 isn't compiled by default. Please refer to
3710 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
3711 how to compile and configure nginx and this module.
3713 The following options are accepted by the C<nginx plugin>:
3717 =item B<URL> I<http://host/nginx_status>
3719 Sets the URL of the C<ngx_http_stub_status_module> output.
3721 =item B<User> I<Username>
3723 Optional user name needed for authentication.
3725 =item B<Password> I<Password>
3727 Optional password needed for authentication.
3729 =item B<VerifyPeer> B<true|false>
3731 Enable or disable peer SSL certificate verification. See
3732 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
3734 =item B<VerifyHost> B<true|false>
3736 Enable or disable peer host name verification. If enabled, the plugin checks
3737 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
3738 certificate matches the host name provided by the B<URL> option. If this
3739 identity check fails, the connection is aborted. Obviously, only works when
3740 connecting to a SSL enabled server. Enabled by default.
3742 =item B<CACert> I<File>
3744 File that holds one or more SSL certificates. If you want to use HTTPS you will
3745 possibly need this option. What CA certificates come bundled with C<libcurl>
3746 and are checked by default depends on the distribution you use.
3750 =head2 Plugin C<notify_desktop>
3752 This plugin sends a desktop notification to a notification daemon, as defined
3753 in the Desktop Notification Specification. To actually display the
3754 notifications, B<notification-daemon> is required and B<collectd> has to be
3755 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
3756 environment variables have to be set correctly) and the D-Bus message bus.
3758 The Desktop Notification Specification can be found at
3759 L<http://www.galago-project.org/specs/notification/>.
3763 =item B<OkayTimeout> I<timeout>
3765 =item B<WarningTimeout> I<timeout>
3767 =item B<FailureTimeout> I<timeout>
3769 Set the I<timeout>, in milliseconds, after which to expire the notification
3770 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
3771 been specified, the displayed notification will not be closed at all - the
3772 user has to do so herself. These options default to 5000. If a negative number
3773 has been specified, the default is used as well.
3777 =head2 Plugin C<notify_email>
3779 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
3780 configured email address.
3782 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
3784 Available configuration options:
3788 =item B<From> I<Address>
3790 Email address from which the emails should appear to come from.
3792 Default: C<root@localhost>
3794 =item B<Recipient> I<Address>
3796 Configures the email address(es) to which the notifications should be mailed.
3797 May be repeated to send notifications to multiple addresses.
3799 At least one B<Recipient> must be present for the plugin to work correctly.
3801 =item B<SMTPServer> I<Hostname>
3803 Hostname of the SMTP server to connect to.
3805 Default: C<localhost>
3807 =item B<SMTPPort> I<Port>
3809 TCP port to connect to.
3813 =item B<SMTPUser> I<Username>
3815 Username for ASMTP authentication. Optional.
3817 =item B<SMTPPassword> I<Password>
3819 Password for ASMTP authentication. Optional.
3821 =item B<Subject> I<Subject>
3823 Subject-template to use when sending emails. There must be exactly two
3824 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
3825 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
3828 Default: C<Collectd notify: %s@%s>
3832 =head2 Plugin C<ntpd>
3836 =item B<Host> I<Hostname>
3838 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
3840 =item B<Port> I<Port>
3842 UDP-Port to connect to. Defaults to B<123>.
3844 =item B<ReverseLookups> B<true>|B<false>
3846 Sets whether or not to perform reverse lookups on peers. Since the name or
3847 IP-address may be used in a filename it is recommended to disable reverse
3848 lookups. The default is to do reverse lookups to preserve backwards
3849 compatibility, though.
3851 =item B<IncludeUnitID> B<true>|B<false>
3853 When a peer is a refclock, include the unit ID in the I<type instance>.
3854 Defaults to B<false> for backward compatibility.
3856 If two refclock peers use the same driver and this is B<false>, the plugin will
3857 try to write simultaneous measurements from both to the same type instance.
3858 This will result in error messages in the log and only one set of measurements
3863 =head2 Plugin C<nut>
3867 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
3869 Add a UPS to collect data from. The format is identical to the one accepted by
3874 =head2 Plugin C<olsrd>
3876 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
3877 the Optimized Link State Routing daemon and reads information about the current
3878 state of the meshed network.
3880 The following configuration options are understood:
3884 =item B<Host> I<Host>
3886 Connect to I<Host>. Defaults to B<"localhost">.
3888 =item B<Port> I<Port>
3890 Specifies the port to connect to. This must be a string, even if you give the
3891 port as a number rather than a service name. Defaults to B<"2006">.
3893 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
3895 Specifies what information to collect about links, i.E<nbsp>e. direct
3896 connections of the daemon queried. If set to B<No>, no information is
3897 collected. If set to B<Summary>, the number of links and the average of all
3898 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
3899 If set to B<Detail> LQ and NLQ are collected per link.
3901 Defaults to B<Detail>.
3903 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
3905 Specifies what information to collect about routes of the daemon queried. If
3906 set to B<No>, no information is collected. If set to B<Summary>, the number of
3907 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
3908 metric and ETX are collected per route.
3910 Defaults to B<Summary>.
3912 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
3914 Specifies what information to collect about the global topology. If set to
3915 B<No>, no information is collected. If set to B<Summary>, the number of links
3916 in the entire topology and the average I<link quality> (LQ) is calculated.
3917 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
3919 Defaults to B<Summary>.
3923 =head2 Plugin C<onewire>
3925 B<EXPERIMENTAL!> See notes below.
3927 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
3928 L<http://owfs.org/> to read sensors connected via the onewire bus.
3930 Currently only temperature sensors (sensors with the family code C<10>,
3931 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
3932 would like to have included, please send a sort request to the mailing list.
3934 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
3935 experimental, below.
3939 =item B<Device> I<Device>
3941 Sets the device to read the values from. This can either be a "real" hardware
3942 device, such as a serial port or an USB port, or the address of the
3943 L<owserver(1)> socket, usually B<localhost:4304>.
3945 Though the documentation claims to automatically recognize the given address
3946 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
3947 with that version, the following configuration worked for us:
3950 Device "-s localhost:4304"
3953 This directive is B<required> and does not have a default value.
3955 =item B<Sensor> I<Sensor>
3957 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
3958 below. Sensors are specified without the family byte at the beginning, to you'd
3959 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
3962 =item B<IgnoreSelected> I<true>|I<false>
3964 If no configuration if given, the B<onewire> plugin will collect data from all
3965 sensors found. This may not be practical, especially if sensors are added and
3966 removed regularly. Sometimes, however, it's easier/preferred to collect only
3967 specific sensors or all sensors I<except> a few specified ones. This option
3968 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
3969 B<Sensor> is inverted: All selected interfaces are ignored and all other
3970 interfaces are collected.
3972 =item B<Interval> I<Seconds>
3974 Sets the interval in which all sensors should be read. If not specified, the
3975 global B<Interval> setting is used.
3979 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
3980 work with big setups. It works with one sensor being attached to one
3981 controller, but as soon as you throw in a couple more senors and maybe a hub
3982 or two, reading all values will take more than ten seconds (the default
3983 interval). We will probably add some separate thread for reading the sensors
3984 and some cache or something like that, but it's not done yet. We will try to
3985 maintain backwards compatibility in the future, but we can't promise. So in
3986 short: If it works for you: Great! But keep in mind that the config I<might>
3987 change, though this is unlikely. Oh, and if you want to help improving this
3988 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
3990 =head2 Plugin C<openvpn>
3992 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
3993 traffic statistics about connected clients.
3995 To set up OpenVPN to write to the status file periodically, use the
3996 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
3997 you need to set the required format, too. This is done by setting
3998 B<--status-version> to B<2>.
4000 So, in a nutshell you need:
4002 openvpn $OTHER_OPTIONS \
4003 --status "/var/run/openvpn-status" 10 \
4010 =item B<StatusFile> I<File>
4012 Specifies the location of the status file.
4014 =item B<ImprovedNamingSchema> B<true>|B<false>
4016 When enabled, the filename of the status file will be used as plugin instance
4017 and the client's "common name" will be used as type instance. This is required
4018 when reading multiple status files. Enabling this option is recommended, but to
4019 maintain backwards compatibility this option is disabled by default.
4021 =item B<CollectCompression> B<true>|B<false>
4023 Sets whether or not statistics about the compression used by OpenVPN should be
4024 collected. This information is only available in I<single> mode. Enabled by
4027 =item B<CollectIndividualUsers> B<true>|B<false>
4029 Sets whether or not traffic information is collected for each connected client
4030 individually. If set to false, currently no traffic data is collected at all
4031 because aggregating this data in a save manner is tricky. Defaults to B<true>.
4033 =item B<CollectUserCount> B<true>|B<false>
4035 When enabled, the number of currently connected clients or users is collected.
4036 This is especially interesting when B<CollectIndividualUsers> is disabled, but
4037 can be configured independently from that option. Defaults to B<false>.
4041 =head2 Plugin C<oracle>
4043 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
4044 Oracle® Database and lets you execute SQL statements there. It is very similar
4045 to the "dbi" plugin, because it was written around the same time. See the "dbi"
4046 plugin's documentation above for details.
4049 <Query "out_of_stock">
4050 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
4053 # InstancePrefix "foo"
4054 InstancesFrom "category"
4058 <Database "product_information">
4062 Query "out_of_stock"
4066 =head3 B<Query> blocks
4068 The Query blocks are handled identically to the Query blocks of the "dbi"
4069 plugin. Please see its documentation above for details on how to specify
4072 =head3 B<Database> blocks
4074 Database blocks define a connection to a database and which queries should be
4075 sent to that database. Each database needs a "name" as string argument in the
4076 starting tag of the block. This name will be used as "PluginInstance" in the
4077 values submitted to the daemon. Other than that, that name is not used.
4081 =item B<ConnectID> I<ID>
4083 Defines the "database alias" or "service name" to connect to. Usually, these
4084 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
4086 =item B<Host> I<Host>
4088 Hostname to use when dispatching values for this database. Defaults to using
4089 the global hostname of the I<collectd> instance.
4091 =item B<Username> I<Username>
4093 Username used for authentication.
4095 =item B<Password> I<Password>
4097 Password used for authentication.
4099 =item B<Query> I<QueryName>
4101 Associates the query named I<QueryName> with this database connection. The
4102 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
4103 blocks you want to refer to must be placed above the database block you want to
4108 =head2 Plugin C<perl>
4110 This plugin embeds a Perl-interpreter into collectd and provides an interface
4111 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
4113 =head2 Plugin C<pinba>
4115 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
4116 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
4117 PHP-based webpage has been delivered, the extension will send a UDP packet
4118 containing timing information, peak memory usage and so on. The plugin will
4119 wait for such packets, parse them and account the provided information, which
4120 is then dispatched to the daemon once per interval.
4127 # Overall statistics for the website.
4129 Server "www.example.com"
4131 # Statistics for www-a only
4133 Host "www-a.example.com"
4134 Server "www.example.com"
4136 # Statistics for www-b only
4138 Host "www-b.example.com"
4139 Server "www.example.com"
4143 The plugin provides the following configuration options:
4147 =item B<Address> I<Node>
4149 Configures the address used to open a listening socket. By default, plugin will
4150 bind to the I<any> address C<::0>.
4152 =item B<Port> I<Service>
4154 Configures the port (service) to bind to. By default the default Pinba port
4155 "30002" will be used. The option accepts service names in addition to port
4156 numbers and thus requires a I<string> argument.
4158 =item E<lt>B<View> I<Name>E<gt> block
4160 The packets sent by the Pinba extension include the hostname of the server, the
4161 server name (the name of the virtual host) and the script that was executed.
4162 Using B<View> blocks it is possible to separate the data into multiple groups
4163 to get more meaningful statistics. Each packet is added to all matching groups,
4164 so that a packet may be accounted for more than once.
4168 =item B<Host> I<Host>
4170 Matches the hostname of the system the webserver / script is running on. This
4171 will contain the result of the L<gethostname(2)> system call. If not
4172 configured, all hostnames will be accepted.
4174 =item B<Server> I<Server>
4176 Matches the name of the I<virtual host>, i.e. the contents of the
4177 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
4178 server names will be accepted.
4180 =item B<Script> I<Script>
4182 Matches the name of the I<script name>, i.e. the contents of the
4183 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
4184 script names will be accepted.
4190 =head2 Plugin C<ping>
4192 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
4193 configured hosts periodically and measures the network latency. Whenever the
4194 C<read> function of the plugin is called, it submits the average latency, the
4195 standard deviation and the drop rate for each host.
4197 Available configuration options:
4201 =item B<Host> I<IP-address>
4203 Host to ping periodically. This option may be repeated several times to ping
4206 =item B<Interval> I<Seconds>
4208 Sets the interval in which to send ICMP echo packets to the configured hosts.
4209 This is B<not> the interval in which statistics are queries from the plugin but
4210 the interval in which the hosts are "pinged". Therefore, the setting here
4211 should be smaller than or equal to the global B<Interval> setting. Fractional
4212 times, such as "1.24" are allowed.
4216 =item B<Timeout> I<Seconds>
4218 Time to wait for a response from the host to which an ICMP packet had been
4219 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
4220 to be down or the packet to be dropped. This setting must be smaller than the
4221 B<Interval> setting above for the plugin to work correctly. Fractional
4222 arguments are accepted.
4226 =item B<TTL> I<0-255>
4228 Sets the Time-To-Live of generated ICMP packets.
4230 =item B<SourceAddress> I<host>
4232 Sets the source address to use. I<host> may either be a numerical network
4233 address or a network hostname.
4235 =item B<Device> I<name>
4237 Sets the outgoing network device to be used. I<name> has to specify an
4238 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
4241 =item B<MaxMissed> I<Packets>
4243 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
4244 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
4246 Default: B<-1> (disabled)
4250 =head2 Plugin C<postgresql>
4252 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
4253 keeps a persistent connection to all configured databases and tries to
4254 reconnect if the connection has been interrupted. A database is configured by
4255 specifying a B<Database> block as described below. The default statistics are
4256 collected from PostgreSQL's B<statistics collector> which thus has to be
4257 enabled for this plugin to work correctly. This should usually be the case by
4258 default. See the section "The Statistics Collector" of the B<PostgreSQL
4259 Documentation> for details.
4261 By specifying custom database queries using a B<Query> block as described
4262 below, you may collect any data that is available from some PostgreSQL
4263 database. This way, you are able to access statistics of external daemons
4264 which are available in a PostgreSQL database or use future or special
4265 statistics provided by PostgreSQL without the need to upgrade your collectd
4268 Starting with version 5.2, the C<postgresql> plugin supports writing data to
4269 PostgreSQL databases as well. This has been implemented in a generic way. You
4270 need to specify an SQL statement which will then be executed by collectd in
4271 order to write the data (see below for details). The benefit of that approach
4272 is that there is no fixed database layout. Rather, the layout may be optimized
4273 for the current setup.
4275 The B<PostgreSQL Documentation> manual can be found at
4276 L<http://www.postgresql.org/docs/manuals/>.
4280 Statement "SELECT magic FROM wizard WHERE host = $1;"
4284 InstancePrefix "magic"
4289 <Query rt36_tickets>
4290 Statement "SELECT COUNT(type) AS count, type \
4292 WHEN resolved = 'epoch' THEN 'open' \
4293 ELSE 'resolved' END AS type \
4294 FROM tickets) type \
4298 InstancePrefix "rt36_tickets"
4299 InstancesFrom "type"
4305 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
4315 KRBSrvName "kerberos_service_name"
4321 Service "service_name"
4322 Query backend # predefined
4333 The B<Query> block defines one database query which may later be used by a
4334 database definition. It accepts a single mandatory argument which specifies
4335 the name of the query. The names of all queries have to be unique (see the
4336 B<MinVersion> and B<MaxVersion> options below for an exception to this
4337 rule). The following configuration options are available to define the query:
4339 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
4340 blocks define how to handle the values returned from the query. They define
4341 which column holds which value and how to dispatch that value to the daemon.
4342 Multiple B<Result> blocks may be used to extract multiple values from a single
4347 =item B<Statement> I<sql query statement>
4349 Specify the I<sql query statement> which the plugin should execute. The string
4350 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
4351 first, second, etc. parameter. The value of the parameters is specified by the
4352 B<Param> configuration option - see below for details. To include a literal
4353 B<$> character followed by a number, surround it with single quotes (B<'>).
4355 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
4356 allowed. Note, however, that only a single command may be used. Semicolons are
4357 allowed as long as a single non-empty command has been specified only.
4359 The returned lines will be handled separately one after another.
4361 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4363 Specify the parameters which should be passed to the SQL query. The parameters
4364 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4365 they appear in the configuration file. The value of the parameter is
4366 determined depending on the value of the B<Param> option as follows:
4372 The configured hostname of the database connection. If a UNIX domain socket is
4373 used, the parameter expands to "localhost".
4377 The name of the database of the current connection.
4381 The name of the database plugin instance. See the B<Instance> option of the
4382 database specification below for details.
4386 The username used to connect to the database.
4390 The interval with which this database is queried (as specified by the database
4391 specific or global B<Interval> options).
4395 Please note that parameters are only supported by PostgreSQL's protocol
4396 version 3 and above which was introduced in version 7.4 of PostgreSQL.
4398 =item B<Type> I<type>
4400 The I<type> name to be used when dispatching the values. The type describes
4401 how to handle the data and where to store it. See L<types.db(5)> for more
4402 details on types and their configuration. The number and type of values (as
4403 selected by the B<ValuesFrom> option) has to match the type of the given name.
4405 This option is required inside a B<Result> block.
4407 =item B<InstancePrefix> I<prefix>
4409 =item B<InstancesFrom> I<column0> [I<column1> ...]
4411 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
4412 B<InstancePrefix> defines a static prefix that will be prepended to all type
4413 instances. B<InstancesFrom> defines the column names whose values will be used
4414 to create the type instance. Multiple values will be joined together using the
4415 hyphen (C<->) as separation character.
4417 The plugin itself does not check whether or not all built instances are
4418 different. It is your responsibility to assure that each is unique.
4420 Both options are optional. If none is specified, the type instance will be
4423 =item B<ValuesFrom> I<column0> [I<column1> ...]
4425 Names the columns whose content is used as the actual data for the data sets
4426 that are dispatched to the daemon. How many such columns you need is
4427 determined by the B<Type> setting as explained above. If you specify too many
4428 or not enough columns, the plugin will complain about that and no data will be
4429 submitted to the daemon.
4431 The actual data type, as seen by PostgreSQL, is not that important as long as
4432 it represents numbers. The plugin will automatically cast the values to the
4433 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
4434 L<strtod(3)> functions, so anything supported by those functions is supported
4435 by the plugin as well.
4437 This option is required inside a B<Result> block and may be specified multiple
4438 times. If multiple B<ValuesFrom> options are specified, the columns are read
4441 =item B<MinVersion> I<version>
4443 =item B<MaxVersion> I<version>
4445 Specify the minimum or maximum version of PostgreSQL that this query should be
4446 used with. Some statistics might only be available with certain versions of
4447 PostgreSQL. This allows you to specify multiple queries with the same name but
4448 which apply to different versions, thus allowing you to use the same
4449 configuration in a heterogeneous environment.
4451 The I<version> has to be specified as the concatenation of the major, minor
4452 and patch-level versions, each represented as two-decimal-digit numbers. For
4453 example, version 8.2.3 will become 80203.
4457 The following predefined queries are available (the definitions can be found
4458 in the F<postgresql_default.conf> file which, by default, is available at
4459 C<I<prefix>/share/collectd/>):
4465 This query collects the number of backends, i.E<nbsp>e. the number of
4468 =item B<transactions>
4470 This query collects the numbers of committed and rolled-back transactions of
4475 This query collects the numbers of various table modifications (i.E<nbsp>e.
4476 insertions, updates, deletions) of the user tables.
4478 =item B<query_plans>
4480 This query collects the numbers of various table scans and returned tuples of
4483 =item B<table_states>
4485 This query collects the numbers of live and dead rows in the user tables.
4489 This query collects disk block access counts for user tables.
4493 This query collects the on-disk size of the database in bytes.
4497 In addition, the following detailed queries are available by default. Please
4498 note that each of those queries collects information B<by table>, thus,
4499 potentially producing B<a lot> of data. For details see the description of the
4500 non-by_table queries above.
4504 =item B<queries_by_table>
4506 =item B<query_plans_by_table>
4508 =item B<table_states_by_table>
4510 =item B<disk_io_by_table>
4514 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
4515 mandatory argument specifying the name of the writer. This will then be used
4516 in the B<Database> specification in order to activate the writer instance. The
4517 names of all writers have to be unique. The following options may be
4522 =item B<Statement> I<sql statement>
4524 This mandatory option specifies the SQL statement that will be executed for
4525 each submitted value. A single SQL statement is allowed only. Anything after
4526 the first semicolon will be ignored.
4528 Nine parameters will be passed to the statement and should be specified as
4529 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
4530 values are made available through those parameters:
4536 The timestamp of the queried value as a floating point number.
4540 The hostname of the queried value.
4544 The plugin name of the queried value.
4548 The plugin instance of the queried value. This value may be B<NULL> if there
4549 is no plugin instance.
4553 The type of the queried value (cf. L<types.db(5)>).
4557 The type instance of the queried value. This value may be B<NULL> if there is
4562 An array of names for the submitted values (i.E<nbsp>e., the name of the data
4563 sources of the submitted value-list).
4567 An array of types for the submitted values (i.E<nbsp>e., the type of the data
4568 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
4569 B<StoreRates> is enabled (which is the default, see below), all types will be
4574 An array of the submitted values. The dimensions of the value name and value
4579 In general, it is advisable to create and call a custom function in the
4580 PostgreSQL database for this purpose. Any procedural language supported by
4581 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
4584 =item B<StoreRates> B<false>|B<true>
4586 If set to B<true> (the default), convert counter values to rates. If set to
4587 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
4592 The B<Database> block defines one PostgreSQL database for which to collect
4593 statistics. It accepts a single mandatory argument which specifies the
4594 database name. None of the other options are required. PostgreSQL will use
4595 default values as documented in the section "CONNECTING TO A DATABASE" in the
4596 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
4597 the user collectd is run as and special environment variables. See the manpage
4602 =item B<Interval> I<seconds>
4604 Specify the interval with which the database should be queried. The default is
4605 to use the global B<Interval> setting.
4607 =item B<CommitInterval> I<seconds>
4609 This option may be used for database connections which have "writers" assigned
4610 (see above). If specified, it causes a writer to put several updates into a
4611 single transaction. This transaction will last for the specified amount of
4612 time. By default, each update will be executed in a separate transaction. Each
4613 transaction generates a fair amount of overhead which can, thus, be reduced by
4614 activating this option. The draw-back is, that data covering the specified
4615 amount of time will be lost, for example, if a single statement within the
4616 transaction fails or if the database server crashes.
4618 =item B<Host> I<hostname>
4620 Specify the hostname or IP of the PostgreSQL server to connect to. If the
4621 value begins with a slash, it is interpreted as the directory name in which to
4622 look for the UNIX domain socket.
4624 This option is also used to determine the hostname that is associated with a
4625 collected data set. If it has been omitted or either begins with with a slash
4626 or equals B<localhost> it will be replaced with the global hostname definition
4627 of collectd. Any other value will be passed literally to collectd when
4628 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
4630 =item B<Port> I<port>
4632 Specify the TCP port or the local UNIX domain socket file extension of the
4635 =item B<User> I<username>
4637 Specify the username to be used when connecting to the server.
4639 =item B<Password> I<password>
4641 Specify the password to be used when connecting to the server.
4643 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
4645 Specify whether to use an SSL connection when contacting the server. The
4646 following modes are supported:
4648 =item B<Instance> I<name>
4650 Specify the plugin instance name that should be used instead of the database
4651 name (which is the default, if this option has not been specified). This
4652 allows to query multiple databases of the same name on the same host (e.g.
4653 when running multiple database server versions in parallel).
4659 Do not use SSL at all.
4663 First, try to connect without using SSL. If that fails, try using SSL.
4665 =item I<prefer> (default)
4667 First, try to connect using SSL. If that fails, try without using SSL.
4675 =item B<KRBSrvName> I<kerberos_service_name>
4677 Specify the Kerberos service name to use when authenticating with Kerberos 5
4678 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
4679 B<PostgreSQL Documentation> for details.
4681 =item B<Service> I<service_name>
4683 Specify the PostgreSQL service name to use for additional parameters. That
4684 service has to be defined in F<pg_service.conf> and holds additional
4685 connection parameters. See the section "The Connection Service File" in the
4686 B<PostgreSQL Documentation> for details.
4688 =item B<Query> I<query>
4690 Specifies a I<query> which should be executed in the context of the database
4691 connection. This may be any of the predefined or user-defined queries. If no
4692 such option is given, it defaults to "backends", "transactions", "queries",
4693 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
4694 has been specified). Else, the specified queries are used only.
4696 =item B<Writer> I<writer>
4698 Assigns the specified I<writer> backend to the database connection. This
4699 causes all collected data to be send to the database using the settings
4700 defined in the writer configuration (see the section "FILTER CONFIGURATION"
4701 below for details on how to selectively send data to certain plugins).
4703 Each writer will register a flush callback which may be used when having long
4704 transactions enabled (see the B<CommitInterval> option above). When issuing
4705 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
4706 transaction will be committed right away. Two different kinds of flush
4707 callbacks are available with the C<postgresql> plugin:
4713 Flush all writer backends.
4715 =item B<postgresql->I<database>
4717 Flush all writers of the specified I<database> only.
4723 =head2 Plugin C<powerdns>
4725 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
4726 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
4727 values, many of which are probably meaningless to most users, but may be useful
4728 for some. So you may chose which values to collect, but if you don't, some
4729 reasonable defaults will be collected.
4732 <Server "server_name">
4734 Collect "udp-answers" "udp-queries"
4735 Socket "/var/run/pdns.controlsocket"
4737 <Recursor "recursor_name">
4739 Collect "cache-hits" "cache-misses"
4740 Socket "/var/run/pdns_recursor.controlsocket"
4742 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
4747 =item B<Server> and B<Recursor> block
4749 The B<Server> block defines one authoritative server to query, the B<Recursor>
4750 does the same for an recursing server. The possible options in both blocks are
4751 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
4756 =item B<Collect> I<Field>
4758 Using the B<Collect> statement you can select which values to collect. Here,
4759 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
4760 C<dlg-only-drops>, C<answers10-100>.
4762 The method of getting the values differs for B<Server> and B<Recursor> blocks:
4763 When querying the server a C<SHOW *> command is issued in any case, because
4764 that's the only way of getting multiple values out of the server at once.
4765 collectd then picks out the values you have selected. When querying the
4766 recursor, a command is generated to query exactly these values. So if you
4767 specify invalid fields when querying the recursor, a syntax error may be
4768 returned by the daemon and collectd may not collect any values at all.
4770 If no B<Collect> statement is given, the following B<Server> values will be
4777 =item packetcache-hit
4779 =item packetcache-miss
4781 =item packetcache-size
4783 =item query-cache-hit
4785 =item query-cache-miss
4787 =item recursing-answers
4789 =item recursing-questions
4801 The following B<Recursor> values will be collected by default:
4805 =item noerror-answers
4807 =item nxdomain-answers
4809 =item servfail-answers
4827 Please note that up to that point collectd doesn't know what values are
4828 available on the server and values that are added do not need a change of the
4829 mechanism so far. However, the values must be mapped to collectd's naming
4830 scheme, which is done using a lookup table that lists all known values. If
4831 values are added in the future and collectd does not know about them, you will
4832 get an error much like this:
4834 powerdns plugin: submit: Not found in lookup table: foobar = 42
4836 In this case please file a bug report with the collectd team.
4838 =item B<Socket> I<Path>
4840 Configures the path to the UNIX domain socket to be used when connecting to the
4841 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
4842 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
4843 will be used for the recursor.
4847 =item B<LocalSocket> I<Path>
4849 Querying the recursor is done using UDP. When using UDP over UNIX domain
4850 sockets, the client socket needs a name in the file system, too. You can set
4851 this local name to I<Path> using the B<LocalSocket> option. The default is
4852 C<I<prefix>/var/run/collectd-powerdns>.
4856 =head2 Plugin C<processes>
4860 =item B<Process> I<Name>
4862 Select more detailed statistics of processes matching this name. The statistics
4863 collected for these selected processes are size of the resident segment size
4864 (RSS), user- and system-time used, number of processes and number of threads,
4865 io data (where available) and minor and major pagefaults.
4867 =item B<ProcessMatch> I<name> I<regex>
4869 Similar to the B<Process> option this allows to select more detailed
4870 statistics of processes matching the specified I<regex> (see L<regex(7)> for
4871 details). The statistics of all matching processes are summed up and
4872 dispatched to the daemon using the specified I<name> as an identifier. This
4873 allows to "group" several processes together. I<name> must not contain
4878 =head2 Plugin C<protocols>
4880 Collects a lot of information about various network protocols, such as I<IP>,
4881 I<TCP>, I<UDP>, etc.
4883 Available configuration options:
4887 =item B<Value> I<Selector>
4889 Selects whether or not to select a specific value. The string being matched is
4890 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
4891 plugin instance and I<ValueName> will be used as type instance. An example of
4892 the string being used would be C<Tcp:RetransSegs>.
4894 You can use regular expressions to match a large number of values with just one
4895 configuration option. To select all "extended" I<TCP> values, you could use the
4896 following statement:
4900 Whether only matched values are selected or all matched values are ignored
4901 depends on the B<IgnoreSelected>. By default, only matched values are selected.
4902 If no value is configured at all, all values will be selected.
4904 =item B<IgnoreSelected> B<true>|B<false>
4906 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
4907 matching values will be ignored.
4911 =head2 Plugin C<python>
4913 This plugin embeds a Python-interpreter into collectd and provides an interface
4914 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
4916 =head2 Plugin C<routeros>
4918 The C<routeros> plugin connects to a device running I<RouterOS>, the
4919 Linux-based operating system for routers by I<MikroTik>. The plugin uses
4920 I<librouteros> to connect and reads information about the interfaces and
4921 wireless connections of the device. The configuration supports querying
4926 Host "router0.example.com"
4929 CollectInterface true
4934 Host "router1.example.com"
4937 CollectInterface true
4938 CollectRegistrationTable true
4944 As you can see above, the configuration of the I<routeros> plugin consists of
4945 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
4946 options are understood:
4950 =item B<Host> I<Host>
4952 Hostname or IP-address of the router to connect to.
4954 =item B<Port> I<Port>
4956 Port name or port number used when connecting. If left unspecified, the default
4957 will be chosen by I<librouteros>, currently "8728". This option expects a
4958 string argument, even when a numeric port number is given.
4960 =item B<User> I<User>
4962 Use the user name I<User> to authenticate. Defaults to "admin".
4964 =item B<Password> I<Password>
4966 Set the password used to authenticate.
4968 =item B<CollectInterface> B<true>|B<false>
4970 When set to B<true>, interface statistics will be collected for all interfaces
4971 present on the device. Defaults to B<false>.
4973 =item B<CollectRegistrationTable> B<true>|B<false>
4975 When set to B<true>, information about wireless LAN connections will be
4976 collected. Defaults to B<false>.
4978 =item B<CollectCPULoad> B<true>|B<false>
4980 When set to B<true>, information about the CPU usage will be collected. The
4981 number is a dimensionless value where zero indicates no CPU usage at all.
4982 Defaults to B<false>.
4984 =item B<CollectMemory> B<true>|B<false>
4986 When enabled, the amount of used and free memory will be collected. How used
4987 memory is calculated is unknown, for example whether or not caches are counted
4989 Defaults to B<false>.
4991 =item B<CollectDF> B<true>|B<false>
4993 When enabled, the amount of used and free disk space will be collected.
4994 Defaults to B<false>.
4996 =item B<CollectDisk> B<true>|B<false>
4998 When enabled, the number of sectors written and bad blocks will be collected.
4999 Defaults to B<false>.
5003 =head2 Plugin C<redis>
5005 The I<Redis plugin> connects to one or more Redis servers and gathers
5006 information about each server's state. For each server there is a I<Node> block
5007 which configures the connection parameters for this node.
5017 The information shown in the synopsis above is the I<default configuration>
5018 which is used by the plugin if no configuration is present.
5022 =item B<Node> I<Nodename>
5024 The B<Node> block identifies a new Redis node, that is a new Redis instance
5025 running in an specified host and port. The name for node is a canonical
5026 identifier which is used as I<plugin instance>. It is limited to
5027 64E<nbsp>characters in length.
5029 =item B<Host> I<Hostname>
5031 The B<Host> option is the hostname or IP-address where the Redis instance is
5034 =item B<Port> I<Port>
5036 The B<Port> option is the TCP port on which the Redis instance accepts
5037 connections. Either a service name of a port number may be given. Please note
5038 that numerical port numbers must be given as a string, too.
5040 =item B<Password> I<Password>
5042 Use I<Password> to authenticate when connecting to I<Redis>.
5044 =item B<Timeout> I<Timeout in miliseconds>
5046 The B<Timeout> option set the socket timeout for node response. Since the Redis
5047 read function is blocking, you should keep this value as low as possible. Keep
5048 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
5049 than B<Interval> defined globally.
5053 =head2 Plugin C<rrdcached>
5055 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
5056 to store values to RRD files in an efficient manner. The combination of the
5057 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
5058 way the C<rrdtool> plugin works (see below). The added abstraction layer
5059 provides a number of benefits, though: Because the cache is not within
5060 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
5061 restarted. This results in much shorter (if any) gaps in graphs, especially
5062 under heavy load. Also, the C<rrdtool> command line utility is aware of the
5063 daemon so that it can flush values to disk automatically when needed. This
5064 allows to integrate automated flushing of values into graphing solutions much
5067 There are disadvantages, though: The daemon may reside on a different host, so
5068 it may not be possible for C<collectd> to create the appropriate RRD files
5069 anymore. And even if C<rrdcached> runs on the same host, it may run in a
5070 different base directory, so relative paths may do weird stuff if you're not
5073 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
5074 on the same host, communicating via a UNIX domain socket. The B<DataDir>
5075 setting should be set to an absolute path, so that a changed base directory
5076 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
5080 =item B<DaemonAddress> I<Address>
5082 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
5083 library. See L<rrdcached(1)> for details. Example:
5085 <Plugin "rrdcached">
5086 DaemonAddress "unix:/var/run/rrdcached.sock"
5089 =item B<DataDir> I<Directory>
5091 Set the base directory in which the RRD files reside. If this is a relative
5092 path, it is relative to the working base directory of the C<rrdcached> daemon!
5093 Use of an absolute path is recommended.
5095 =item B<CreateFiles> B<true>|B<false>
5097 Enables or disables the creation of RRD files. If the daemon is not running
5098 locally, or B<DataDir> is set to a relative path, this will not work as
5099 expected. Default is B<true>.
5101 =item B<CreateFilesAsync> B<false>|B<true>
5103 When enabled, new RRD files are enabled asynchronously, using a separate thread
5104 that runs in the background. This prevents writes to block, which is a problem
5105 especially when many hundreds of files need to be created at once. However,
5106 since the purpose of creating the files asynchronously is I<not> to block until
5107 the file is available, values before the file is available will be discarded.
5108 When disabled (the default) files are created synchronously, blocking for a
5109 short while, while the file is being written.
5111 =item B<StepSize> I<Seconds>
5113 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5114 this setting is unset and the stepsize is set to the interval in which the data
5115 is collected. Do not use this option unless you absolutely have to for some
5116 reason. Setting this option may cause problems with the C<snmp plugin>, the
5117 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5119 =item B<HeartBeat> I<Seconds>
5121 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5122 in which case the heartbeat is set to twice the B<StepSize> which should equal
5123 the interval in which data is collected. Do not set this option unless you have
5124 a very good reason to do so.
5126 =item B<RRARows> I<NumRows>
5128 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5129 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5130 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5131 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5132 week, one month, and one year.
5134 So for each timespan, it calculates how many PDPs need to be consolidated into
5135 one CDP by calculating:
5136 number of PDPs = timespan / (stepsize * rrarows)
5138 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5141 =item B<RRATimespan> I<Seconds>
5143 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5144 more then one RRA. If this option is never used, the built-in default of (3600,
5145 86400, 604800, 2678400, 31622400) is used.
5147 For more information on how RRA-sizes are calculated see B<RRARows> above.
5149 =item B<XFF> I<Factor>
5151 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5152 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5157 =head2 Plugin C<rrdtool>
5159 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
5160 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
5161 using these settings. If you don't want to dive into the depths of RRDtool, you
5162 can safely ignore these settings.
5166 =item B<DataDir> I<Directory>
5168 Set the directory to store RRD files under. By default RRD files are generated
5169 beneath the daemon's working directory, i.e. the B<BaseDir>.
5171 =item B<CreateFilesAsync> B<false>|B<true>
5173 When enabled, new RRD files are enabled asynchronously, using a separate thread
5174 that runs in the background. This prevents writes to block, which is a problem
5175 especially when many hundreds of files need to be created at once. However,
5176 since the purpose of creating the files asynchronously is I<not> to block until
5177 the file is available, values before the file is available will be discarded.
5178 When disabled (the default) files are created synchronously, blocking for a
5179 short while, while the file is being written.
5181 =item B<StepSize> I<Seconds>
5183 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5184 this setting is unset and the stepsize is set to the interval in which the data
5185 is collected. Do not use this option unless you absolutely have to for some
5186 reason. Setting this option may cause problems with the C<snmp plugin>, the
5187 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5189 =item B<HeartBeat> I<Seconds>
5191 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5192 in which case the heartbeat is set to twice the B<StepSize> which should equal
5193 the interval in which data is collected. Do not set this option unless you have
5194 a very good reason to do so.
5196 =item B<RRARows> I<NumRows>
5198 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5199 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5200 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5201 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5202 week, one month, and one year.
5204 So for each timespan, it calculates how many PDPs need to be consolidated into
5205 one CDP by calculating:
5206 number of PDPs = timespan / (stepsize * rrarows)
5208 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5211 =item B<RRATimespan> I<Seconds>
5213 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5214 more then one RRA. If this option is never used, the built-in default of (3600,
5215 86400, 604800, 2678400, 31622400) is used.
5217 For more information on how RRA-sizes are calculated see B<RRARows> above.
5219 =item B<XFF> I<Factor>
5221 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5222 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5225 =item B<CacheFlush> I<Seconds>
5227 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
5228 it writes all values for a certain RRD-file if the oldest value is older than
5229 (or equal to) the number of seconds specified. If some RRD-file is not updated
5230 anymore for some reason (the computer was shut down, the network is broken,
5231 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
5232 entire cache is searched for entries older than B<CacheTimeout> seconds and
5233 written to disk every I<Seconds> seconds. Since this is kind of expensive and
5234 does nothing under normal circumstances, this value should not be too small.
5235 900 seconds might be a good value, though setting this to 7200 seconds doesn't
5236 normally do much harm either.
5238 =item B<CacheTimeout> I<Seconds>
5240 If this option is set to a value greater than zero, the C<rrdtool plugin> will
5241 save values in a cache, as described above. Writing multiple values at once
5242 reduces IO-operations and thus lessens the load produced by updating the files.
5243 The trade off is that the graphs kind of "drag behind" and that more memory is
5246 =item B<WritesPerSecond> I<Updates>
5248 When collecting many statistics with collectd and the C<rrdtool> plugin, you
5249 will run serious performance problems. The B<CacheFlush> setting and the
5250 internal update queue assert that collectd continues to work just fine even
5251 under heavy load, but the system may become very unresponsive and slow. This is
5252 a problem especially if you create graphs from the RRD files on the same
5253 machine, for example using the C<graph.cgi> script included in the
5254 C<contrib/collection3/> directory.
5256 This setting is designed for very large setups. Setting this option to a value
5257 between 25 and 80 updates per second, depending on your hardware, will leave
5258 the server responsive enough to draw graphs even while all the cached values
5259 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
5260 by the B<FLUSH> command, are B<not> effected by this limit. They are still
5261 written as fast as possible, so that web frontends have up to date data when
5264 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
5265 updates per second, writing all values to disk will take approximately
5266 56E<nbsp>minutes. Together with the flushing ability that's integrated into
5267 "collection3" you'll end up with a responsive and fast system, up to date
5268 graphs and basically a "backup" of your values every hour.
5270 =item B<RandomTimeout> I<Seconds>
5272 When set, the actual timeout for each value is chosen randomly between
5273 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
5274 intention is to avoid high load situations that appear when many values timeout
5275 at the same time. This is especially a problem shortly after the daemon starts,
5276 because all values were added to the internal cache at roughly the same time.
5280 =head2 Plugin C<sensors>
5282 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
5283 that all the needed modules have to be loaded and lm_sensors has to be
5284 configured (most likely by editing F</etc/sensors.conf>. Read
5285 L<sensors.conf(5)> for details.
5287 The B<lm_sensors> homepage can be found at
5288 L<http://secure.netroedge.com/~lm78/>.
5292 =item B<SensorConfigFile> I<File>
5294 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
5295 the library's default will be used.
5297 =item B<Sensor> I<chip-bus-address/type-feature>
5299 Selects the name of the sensor which you want to collect or ignore, depending
5300 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
5301 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
5302 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
5304 =item B<IgnoreSelected> I<true>|I<false>
5306 If no configuration if given, the B<sensors>-plugin will collect data from all
5307 sensors. This may not be practical, especially for uninteresting sensors.
5308 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
5309 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
5310 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
5311 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
5312 and all other sensors are collected.
5316 =head2 Plugin C<sigrok>
5318 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
5319 supported by the L<sigrok|http://sigrok.org/> project.
5325 <Device "AC Voltage">
5330 <Device "Sound Level">
5331 Driver "cem-dt-885x"
5338 =item B<LogLevel> B<0-5>
5340 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
5341 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
5342 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
5343 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
5344 their level, are always submitted to I<collectd> at its INFO log level.
5346 =item E<lt>B<Device> I<Name>E<gt>
5348 A sigrok-supported device, uniquely identified by this section's options. The
5349 I<Name> is passed to I<collectd> as the I<plugin instance>.
5351 =item B<Driver> I<DriverName>
5353 The sigrok driver to use for this device.
5355 =item B<Conn> I<ConnectionSpec>
5357 If the device cannot be auto-discovered, or more than one might be discovered
5358 by the driver, I<ConnectionSpec> specifies the connection string to the device.
5359 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
5360 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
5361 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
5362 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
5364 =item B<SerialComm> I<SerialSpec>
5366 For serial devices with non-standard port settings, this option can be used
5367 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
5368 This should not be necessary; drivers know how to communicate with devices they
5371 =item B<MinimumInterval> I<Seconds>
5373 Specifies the minimum time between measurement dispatches to I<collectd>, in
5374 seconds. Since some I<sigrok> supported devices can acquire measurements many
5375 times per second, it may be necessary to throttle these. For example, the
5376 I<RRD plugin> cannot process writes more than once per second.
5378 The default B<MinimumInterval> is B<0>, meaning measurements received from the
5379 device are always dispatched to I<collectd>. When throttled, unused
5380 measurements are discarded.
5384 =head2 Plugin C<snmp>
5386 Since the configuration of the C<snmp plugin> is a little more complicated than
5387 other plugins, its documentation has been moved to an own manpage,
5388 L<collectd-snmp(5)>. Please see there for details.
5390 =head2 Plugin C<statsd>
5392 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
5393 protocol and dispatches rates or other aggregates of these numbers
5396 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
5397 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
5398 C<objects> respectively.
5400 The following configuration options are valid:
5404 =item B<Host> I<Host>
5406 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
5407 "any" address, i.e. accept packets sent to any of the hosts addresses.
5409 =item B<Port> I<Port>
5411 UDP port to listen to. This can be either a service name or a port number.
5412 Defaults to C<8125>.
5414 =item B<DeleteCounters> B<false>|B<true>
5416 =item B<DeleteTimers> B<false>|B<true>
5418 =item B<DeleteGauges> B<false>|B<true>
5420 =item B<DeleteSets> B<false>|B<true>
5422 These options control what happens if metrics are not updated in an interval.
5423 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
5424 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
5425 are unchanged. If set to B<True>, the such metrics are not dispatched and
5426 removed from the internal cache.
5428 =item B<TimerPercentile> I<Percent>
5430 Calculate and dispatch the configured percentile, i.e. compute the latency, so
5431 that I<Percent> of all reported timers are smaller than or equal to the
5432 computed latency. This is useful for cutting off the long tail latency, as it's
5433 often done in I<Service Level Agreements> (SLAs).
5435 If not specified, no percentile is calculated / dispatched.
5439 =head2 Plugin C<swap>
5441 The I<Swap plugin> collects information about used and available swap space. On
5442 I<Linux> and I<Solaris>, the following options are available:
5446 =item B<ReportByDevice> B<false>|B<true>
5448 Configures how to report physical swap devices. If set to B<false> (the
5449 default), the summary over all swap devices is reported only, i.e. the globally
5450 used and available space over all devices. If B<true> is configured, the used
5451 and available space of each device will be reported separately.
5453 This option is only available if the I<Swap plugin> can read C</proc/swaps>
5454 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
5456 =item B<ReportBytes> B<false>|B<true>
5458 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
5459 I<swap I/O> is reported in pages. This option is available under Linux only.
5461 =item B<ValuesAbsolute> B<true>|B<false>
5463 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
5464 available and used. Defaults to B<true>.
5466 =item B<ValuesPercentage> B<false>|B<true>
5468 Enables or disables reporting of relative swap metrics, i.e. I<percent>
5469 available and free. Defaults to B<false>.
5471 This is useful for deploying I<collectd> in a heterogeneous environment, where
5472 swap sizes differ and you want to specify generic thresholds or similar.
5476 =head2 Plugin C<syslog>
5480 =item B<LogLevel> B<debug|info|notice|warning|err>
5482 Sets the log-level. If, for example, set to B<notice>, then all events with
5483 severity B<notice>, B<warning>, or B<err> will be submitted to the
5486 Please note that B<debug> is only available if collectd has been compiled with
5489 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
5491 Controls which notifications should be sent to syslog. The default behaviour is
5492 not to send any. Less severe notifications always imply logging more severe
5493 notifications: Setting this to B<OKAY> means all notifications will be sent to
5494 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
5495 notifications but will dismiss B<OKAY> notifications. Setting this option to
5496 B<FAILURE> will only send failures to syslog.
5500 =head2 Plugin C<table>
5502 The C<table plugin> provides generic means to parse tabular data and dispatch
5503 user specified values. Values are selected based on column numbers. For
5504 example, this plugin may be used to get values from the Linux L<proc(5)>
5505 filesystem or CSV (comma separated values) files.
5508 <Table "/proc/slabinfo">
5513 InstancePrefix "active_objs"
5519 InstancePrefix "objperslab"
5526 The configuration consists of one or more B<Table> blocks, each of which
5527 configures one file to parse. Within each B<Table> block, there are one or
5528 more B<Result> blocks, which configure which data to select and how to
5531 The following options are available inside a B<Table> block:
5535 =item B<Instance> I<instance>
5537 If specified, I<instance> is used as the plugin instance. So, in the above
5538 example, the plugin name C<table-slabinfo> would be used. If omitted, the
5539 filename of the table is used instead, with all special characters replaced
5540 with an underscore (C<_>).
5542 =item B<Separator> I<string>
5544 Any character of I<string> is interpreted as a delimiter between the different
5545 columns of the table. A sequence of two or more contiguous delimiters in the
5546 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
5547 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
5548 of a table - see its documentation for more details. This option is mandatory.
5550 A horizontal tab, newline and carriage return may be specified by C<\\t>,
5551 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
5552 required because of collectd's config parsing.
5556 The following options are available inside a B<Result> block:
5560 =item B<Type> I<type>
5562 Sets the type used to dispatch the values to the daemon. Detailed information
5563 about types and their configuration can be found in L<types.db(5)>. This
5564 option is mandatory.
5566 =item B<InstancePrefix> I<prefix>
5568 If specified, prepend I<prefix> to the type instance. If omitted, only the
5569 B<InstancesFrom> option is considered for the type instance.
5571 =item B<InstancesFrom> I<column0> [I<column1> ...]
5573 If specified, the content of the given columns (identified by the column
5574 number starting at zero) will be used to create the type instance for each
5575 row. Multiple values (and the instance prefix) will be joined together with
5576 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
5577 option is considered for the type instance.
5579 The plugin itself does not check whether or not all built instances are
5580 different. It’s your responsibility to assure that each is unique. This is
5581 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
5582 sure that the table only contains one row.
5584 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
5587 =item B<ValuesFrom> I<column0> [I<column1> ...]
5589 Specifies the columns (identified by the column numbers starting at zero)
5590 whose content is used as the actual data for the data sets that are dispatched
5591 to the daemon. How many such columns you need is determined by the B<Type>
5592 setting above. If you specify too many or not enough columns, the plugin will
5593 complain about that and no data will be submitted to the daemon. The plugin
5594 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
5595 respectively, so anything supported by those functions is supported by the
5596 plugin as well. This option is mandatory.
5600 =head2 Plugin C<tail>
5602 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
5603 each line and dispatches found values. What is matched can be configured by the
5604 user using (extended) regular expressions, as described in L<regex(7)>.
5607 <File "/var/log/exim4/mainlog">
5611 Regex "S=([1-9][0-9]*)"
5617 Regex "\\<R=local_user\\>"
5618 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
5621 Instance "local_user"
5626 The config consists of one or more B<File> blocks, each of which configures one
5627 logfile to parse. Within each B<File> block, there are one or more B<Match>
5628 blocks, which configure a regular expression to search for.
5630 The B<Instance> option in the B<File> block may be used to set the plugin
5631 instance. So in the above example the plugin name C<tail-foo> would be used.
5632 This plugin instance is for all B<Match> blocks that B<follow> it, until the
5633 next B<Instance> option. This way you can extract several plugin instances from
5634 one logfile, handy when parsing syslog and the like.
5636 The B<Interval> option allows you to define the length of time between reads. If
5637 this is not set, the default Interval will be used.
5639 Each B<Match> block has the following options to describe how the match should
5644 =item B<Regex> I<regex>
5646 Sets the regular expression to use for matching against a line. The first
5647 subexpression has to match something that can be turned into a number by
5648 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
5649 below. Because B<extended> regular expressions are used, you do not need to use
5650 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
5651 collectd's config parsing you need to escape backslashes, though. So if you
5652 want to match literal parentheses you need to do the following:
5654 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
5656 =item B<ExcludeRegex> I<regex>
5658 Sets an optional regular expression to use for excluding lines from the match.
5659 An example which excludes all connections from localhost from the match:
5661 ExcludeRegex "127\\.0\\.0\\.1"
5663 =item B<DSType> I<Type>
5665 Sets how the values are cumulated. I<Type> is one of:
5669 =item B<GaugeAverage>
5671 Calculate the average.
5675 Use the smallest number only.
5679 Use the greatest number only.
5683 Use the last number found.
5689 =item B<AbsoluteSet>
5691 The matched number is a counter. Simply I<sets> the internal counter to this
5692 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
5698 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
5699 matched number may be negative, which will effectively subtract from the
5706 Increase the internal counter by one. These B<DSType> are the only ones that do
5707 not use the matched subexpression, but simply count the number of matched
5708 lines. Thus, you may use a regular expression without submatch in this case.
5712 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
5713 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
5714 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
5715 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
5716 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
5719 =item B<Type> I<Type>
5721 Sets the type used to dispatch this value. Detailed information about types and
5722 their configuration can be found in L<types.db(5)>.
5724 =item B<Instance> I<TypeInstance>
5726 This optional setting sets the type instance to use.
5730 =head2 Plugin C<tail_csv>
5732 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
5733 written by I<Snort>.
5738 <Metric "snort-dropped">
5743 <File "/var/log/snort/snort.stats">
5744 Instance "snort-eth0"
5746 Collect "snort-dropped"
5750 The configuration consists of one or more B<Metric> blocks that define an index
5751 into the line of the CSV file and how this value is mapped to I<collectd's>
5752 internal representation. These are followed by one or more B<Instance> blocks
5753 which configure which file to read, in which interval and which metrics to
5758 =item E<lt>B<Metric> I<Name>E<gt>
5760 The B<Metric> block configures a new metric to be extracted from the statistics
5761 file and how it is mapped on I<collectd's> data model. The string I<Name> is
5762 only used inside the B<Instance> blocks to refer to this block, so you can use
5763 one B<Metric> block for multiple CSV files.
5767 =item B<Type> I<Type>
5769 Configures which I<Type> to use when dispatching this metric. Types are defined
5770 in the L<types.db(5)> file, see the appropriate manual page for more
5771 information on specifying types. Only types with a single I<data source> are
5772 supported by the I<tail_csv plugin>. The information whether the value is an
5773 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
5774 I<Type's> definition.
5776 =item B<Instance> I<TypeInstance>
5778 If set, I<TypeInstance> is used to populate the type instance field of the
5779 created value lists. Otherwise, no type instance is used.
5781 =item B<ValueFrom> I<Index>
5783 Configure to read the value from the field with the zero-based index I<Index>.
5784 If the value is parsed as signed integer, unsigned integer or double depends on
5785 the B<Type> setting, see above.
5789 =item E<lt>B<File> I<Path>E<gt>
5791 Each B<File> block represents one CSV file to read. There must be at least one
5792 I<File> block but there can be multiple if you have multiple CSV files.
5796 =item B<Instance> I<PluginInstance>
5798 Sets the I<plugin instance> used when dispatching the values.
5800 =item B<Collect> I<Metric>
5802 Specifies which I<Metric> to collect. This option must be specified at least
5803 once, and you can use this option multiple times to specify more than one
5804 metric to be extracted from this statistic file.
5806 =item B<Interval> I<Seconds>
5808 Configures the interval in which to read values from this instance / file.
5809 Defaults to the plugin's default interval.
5811 =item B<TimeFrom> I<Index>
5813 Rather than using the local time when dispatching a value, read the timestamp
5814 from the field with the zero-based index I<Index>. The value is interpreted as
5815 seconds since epoch. The value is parsed as a double and may be factional.
5821 =head2 Plugin C<teamspeak2>
5823 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
5824 polls interesting global and virtual server data. The plugin can query only one
5825 physical server but unlimited virtual servers. You can use the following
5826 options to configure it:
5830 =item B<Host> I<hostname/ip>
5832 The hostname or ip which identifies the physical server.
5835 =item B<Port> I<port>
5837 The query port of the physical server. This needs to be a string.
5840 =item B<Server> I<port>
5842 This option has to be added once for every virtual server the plugin should
5843 query. If you want to query the virtual server on port 8767 this is what the
5844 option would look like:
5848 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
5849 use quotes around it! If no such statement is given only global information
5854 =head2 Plugin C<ted>
5856 The I<TED> plugin connects to a device of "The Energy Detective", a device to
5857 measure power consumption. These devices are usually connected to a serial
5858 (RS232) or USB port. The plugin opens a configured device and tries to read the
5859 current energy readings. For more information on TED, visit
5860 L<http://www.theenergydetective.com/>.
5862 Available configuration options:
5866 =item B<Device> I<Path>
5868 Path to the device on which TED is connected. collectd will need read and write
5869 permissions on that file.
5871 Default: B</dev/ttyUSB0>
5873 =item B<Retries> I<Num>
5875 Apparently reading from TED is not that reliable. You can therefore configure a
5876 number of retries here. You only configure the I<retries> here, to if you
5877 specify zero, one reading will be performed (but no retries if that fails); if
5878 you specify three, a maximum of four readings are performed. Negative values
5885 =head2 Plugin C<tcpconns>
5887 The C<tcpconns plugin> counts the number of currently established TCP
5888 connections based on the local port and/or the remote port. Since there may be
5889 a lot of connections the default if to count all connections with a local port,
5890 for which a listening socket is opened. You can use the following options to
5891 fine-tune the ports you are interested in:
5895 =item B<ListeningPorts> I<true>|I<false>
5897 If this option is set to I<true>, statistics for all local ports for which a
5898 listening socket exists are collected. The default depends on B<LocalPort> and
5899 B<RemotePort> (see below): If no port at all is specifically selected, the
5900 default is to collect listening ports. If specific ports (no matter if local or
5901 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
5902 the selected ports will be collected unless this option is set to I<true>
5905 =item B<LocalPort> I<Port>
5907 Count the connections to a specific local port. This can be used to see how
5908 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
5909 You have to specify the port in numeric form, so for the mailserver example
5910 you'd need to set B<25>.
5912 =item B<RemotePort> I<Port>
5914 Count the connections to a specific remote port. This is useful to see how
5915 much a remote service is used. This is most useful if you want to know how many
5916 connections a local service has opened to remote services, e.E<nbsp>g. how many
5917 connections a mail server or news server has to other mail or news servers, or
5918 how many connections a web proxy holds to web servers. You have to give the
5919 port in numeric form.
5923 =head2 Plugin C<thermal>
5927 =item B<ForceUseProcfs> I<true>|I<false>
5929 By default, the I<Thermal plugin> tries to read the statistics from the Linux
5930 C<sysfs> interface. If that is not available, the plugin falls back to the
5931 C<procfs> interface. By setting this option to I<true>, you can force the
5932 plugin to use the latter. This option defaults to I<false>.
5934 =item B<Device> I<Device>
5936 Selects the name of the thermal device that you want to collect or ignore,
5937 depending on the value of the B<IgnoreSelected> option. This option may be
5938 used multiple times to specify a list of devices.
5940 =item B<IgnoreSelected> I<true>|I<false>
5942 Invert the selection: If set to true, all devices B<except> the ones that
5943 match the device names specified by the B<Device> option are collected. By
5944 default only selected devices are collected if a selection is made. If no
5945 selection is configured at all, B<all> devices are selected.
5949 =head2 Plugin C<threshold>
5951 The I<Threshold plugin> checks values collected or received by I<collectd>
5952 against a configurable I<threshold> and issues I<notifications> if values are
5955 Documentation for this plugin is available in the L<collectd-threshold(5)>
5958 =head2 Plugin C<tokyotyrant>
5960 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
5961 couple metrics: number of records, and database size on disk.
5965 =item B<Host> I<Hostname/IP>
5967 The hostname or ip which identifies the server.
5968 Default: B<127.0.0.1>
5970 =item B<Port> I<Service/Port>
5972 The query port of the server. This needs to be a string, even if the port is
5973 given in its numeric form.
5978 =head2 Plugin C<unixsock>
5982 =item B<SocketFile> I<Path>
5984 Sets the socket-file which is to be created.
5986 =item B<SocketGroup> I<Group>
5988 If running as root change the group of the UNIX-socket after it has been
5989 created. Defaults to B<collectd>.
5991 =item B<SocketPerms> I<Permissions>
5993 Change the file permissions of the UNIX-socket after it has been created. The
5994 permissions must be given as a numeric, octal value as you would pass to
5995 L<chmod(1)>. Defaults to B<0770>.
5997 =item B<DeleteSocket> B<false>|B<true>
5999 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
6000 with the given name already exists. If I<collectd> crashes a socket file may be
6001 left over, preventing the daemon from opening a new socket when restarted.
6002 Since this is potentially dangerous, this defaults to B<false>.
6006 =head2 Plugin C<uuid>
6008 This plugin, if loaded, causes the Hostname to be taken from the machine's
6009 UUID. The UUID is a universally unique designation for the machine, usually
6010 taken from the machine's BIOS. This is most useful if the machine is running in
6011 a virtual environment such as Xen, in which case the UUID is preserved across
6012 shutdowns and migration.
6014 The following methods are used to find the machine's UUID, in order:
6020 Check I</etc/uuid> (or I<UUIDFile>).
6024 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
6029 Check for UUID from C<dmidecode> / SMBIOS.
6033 Check for UUID from Xen hypervisor.
6037 If no UUID can be found then the hostname is not modified.
6041 =item B<UUIDFile> I<Path>
6043 Take the UUID from the given file (default I</etc/uuid>).
6047 =head2 Plugin C<varnish>
6049 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
6054 <Instance "example">
6056 CollectConnections true
6066 CollectWorkers false
6070 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
6071 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
6072 will collectd statistics from the default "varnishd" instance (this should work
6073 fine in most cases).
6075 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
6079 =item B<CollectCache> B<true>|B<false>
6081 Cache hits and misses. True by default.
6083 =item B<CollectConnections> B<true>|B<false>
6085 Number of client connections received, accepted and dropped. True by default.
6087 =item B<CollectBackend> B<true>|B<false>
6089 Back-end connection statistics, such as successful, reused,
6090 and closed connections. True by default.
6092 =item B<CollectSHM> B<true>|B<false>
6094 Statistics about the shared memory log, a memory region to store
6095 log messages which is flushed to disk when full. True by default.
6097 =item B<CollectBan> B<true>|B<false>
6099 Statistics about ban operations, such as number of bans added, retired, and
6100 number of objects tested against ban operations. Only available with Varnish
6101 3.x. False by default.
6103 =item B<CollectDirectorDNS> B<true>|B<false>
6105 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
6108 =item B<CollectESI> B<true>|B<false>
6110 Edge Side Includes (ESI) parse statistics. False by default.
6112 =item B<CollectFetch> B<true>|B<false>
6114 Statistics about fetches (HTTP requests sent to the backend). False by default.
6116 =item B<CollectHCB> B<true>|B<false>
6118 Inserts and look-ups in the crit bit tree based hash. Look-ups are
6119 divided into locked and unlocked look-ups. False by default.
6121 =item B<CollectObjects> B<true>|B<false>
6123 Statistics on cached objects: number of objects expired, nuked (prematurely
6124 expired), saved, moved, etc. False by default.
6126 =item B<CollectPurge> B<true>|B<false>
6128 Statistics about purge operations, such as number of purges added, retired, and
6129 number of objects tested against purge operations. Only available with Varnish
6130 2.x. False by default.
6132 =item B<CollectSession> B<true>|B<false>
6134 Client session statistics. Number of past and current sessions, session herd and
6135 linger counters, etc. False by default.
6137 =item B<CollectSMA> B<true>|B<false>
6139 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
6140 component is Solaris specific. Only available with Varnish 2.x. False by
6143 =item B<CollectSMS> B<true>|B<false>
6145 synth (synthetic content) storage statistics. This storage
6146 component is used internally only. False by default.
6148 =item B<CollectSM> B<true>|B<false>
6150 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
6153 =item B<CollectStruct> B<true>|B<false>
6155 Current varnish internal state statistics. Number of current sessions, objects
6156 in cache store, open connections to backends (with Varnish 2.x), etc. False by
6159 =item B<CollectTotals> B<true>|B<false>
6161 Collects overview counters, such as the number of sessions created,
6162 the number of requests and bytes transferred. False by default.
6164 =item B<CollectUptime> B<true>|B<false>
6166 Varnish uptime. False by default.
6168 =item B<CollectVCL> B<true>|B<false>
6170 Number of total (available + discarded) VCL (config files). False by default.
6172 =item B<CollectWorkers> B<true>|B<false>
6174 Collect statistics about worker threads. False by default.
6178 =head2 Plugin C<vmem>
6180 The C<vmem> plugin collects information about the usage of virtual memory.
6181 Since the statistics provided by the Linux kernel are very detailed, they are
6182 collected very detailed. However, to get all the details, you have to switch
6183 them on manually. Most people just want an overview over, such as the number of
6184 pages read from swap space.
6188 =item B<Verbose> B<true>|B<false>
6190 Enables verbose collection of information. This will start collecting page
6191 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
6192 Part of these statistics are collected on a "per zone" basis.
6196 =head2 Plugin C<vserver>
6198 This plugin doesn't have any options. B<VServer> support is only available for
6199 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
6200 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
6201 need to apply the patches and compile your own kernel, which will then provide
6202 the F</proc/virtual> filesystem that is required by this plugin.
6204 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
6206 B<Note>: The traffic collected by this plugin accounts for the amount of
6207 traffic passing a socket which might be a lot less than the actual on-wire
6208 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
6209 collect on-wire traffic you could, for example, use the logging facilities of
6210 iptables to feed data for the guest IPs into the iptables plugin.
6212 =head2 Plugin C<write_graphite>
6214 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
6215 storage and graphing project. The plugin connects to I<Carbon>, the data layer
6216 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
6217 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
6218 of at most 1428 bytes to minimize the number of network packets.
6222 <Plugin write_graphite>
6232 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6233 blocks. Inside the B<Node> blocks, the following options are recognized:
6237 =item B<Host> I<Address>
6239 Hostname or address to connect to. Defaults to C<localhost>.
6241 =item B<Port> I<Service>
6243 Service name or port number to connect to. Defaults to C<2003>.
6245 =item B<Protocol> I<String>
6247 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
6249 =item B<LogSendErrors> B<false>|B<true>
6251 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
6252 If set to B<false>, it will not log the errors. This is especially useful when
6253 using Protocol UDP since many times we want to use the "fire-and-forget"
6254 approach and logging errors fills syslog with unneeded messages.
6256 =item B<Prefix> I<String>
6258 When set, I<String> is added in front of the host name. Dots and whitespace are
6259 I<not> escaped in this string (see B<EscapeCharacter> below).
6261 =item B<Postfix> I<String>
6263 When set, I<String> is appended to the host name. Dots and whitespace are
6264 I<not> escaped in this string (see B<EscapeCharacter> below).
6266 =item B<EscapeCharacter> I<Char>
6268 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
6269 in the identifier. The B<EscapeCharacter> option determines which character
6270 dots, whitespace and control characters are replaced with. Defaults to
6273 =item B<StoreRates> B<false>|B<true>
6275 If set to B<true> (the default), convert counter values to rates. If set to
6276 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6279 =item B<SeparateInstances> B<false>|B<true>
6281 If set to B<true>, the plugin instance and type instance will be in their own
6282 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6283 default), the plugin and plugin instance (and likewise the type and type
6284 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6286 =item B<AlwaysAppendDS> B<false>|B<true>
6288 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
6289 identifier. If set to B<false> (the default), this is only done when there is
6294 =head2 Plugin C<write_mongodb>
6296 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
6301 <Plugin "write_mongodb">
6310 The plugin can send values to multiple instances of I<MongoDB> by specifying
6311 one B<Node> block for each instance. Within the B<Node> blocks, the following
6312 options are available:
6316 =item B<Host> I<Address>
6318 Hostname or address to connect to. Defaults to C<localhost>.
6320 =item B<Port> I<Service>
6322 Service name or port number to connect to. Defaults to C<27017>.
6324 =item B<Timeout> I<Timeout>
6326 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
6327 Setting this option to zero means no timeout, which is the default.
6329 =item B<StoreRates> B<false>|B<true>
6331 If set to B<true> (the default), convert counter values to rates. If set to
6332 B<false> counter values are stored as is, i.e. as an increasing integer
6335 =item B<Database> I<Database>
6337 =item B<User> I<User>
6339 =item B<Password> I<Password>
6341 Sets the information used when authenticating to a I<MongoDB> database. The
6342 fields are optional (in which case no authentication is attempted), but if you
6343 want to use authentication all three fields must be set.
6347 =head2 Plugin C<write_http>
6349 This output plugin submits values to an http server by POST them using the
6350 PUTVAL plain-text protocol. Each destination you want to post data to needs to
6351 have one B<URL> block, within which the destination can be configured further,
6352 for example by specifying authentication data.
6356 <Plugin "write_http">
6357 <URL "http://example.com/post-collectd">
6363 B<URL> blocks need one string argument which is used as the URL to which data
6364 is posted. The following options are understood within B<URL> blocks.
6368 =item B<User> I<Username>
6370 Optional user name needed for authentication.
6372 =item B<Password> I<Password>
6374 Optional password needed for authentication.
6376 =item B<VerifyPeer> B<true>|B<false>
6378 Enable or disable peer SSL certificate verification. See
6379 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
6381 =item B<VerifyHost> B<true|false>
6383 Enable or disable peer host name verification. If enabled, the plugin checks if
6384 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
6385 matches the host name provided by the B<URL> option. If this identity check
6386 fails, the connection is aborted. Obviously, only works when connecting to a
6387 SSL enabled server. Enabled by default.
6389 =item B<CACert> I<File>
6391 File that holds one or more SSL certificates. If you want to use HTTPS you will
6392 possibly need this option. What CA certificates come bundled with C<libcurl>
6393 and are checked by default depends on the distribution you use.
6395 =item B<Format> B<Command>|B<JSON>
6397 Format of the output to generate. If set to B<Command>, will create output that
6398 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
6399 create output in the I<JavaScript Object Notation> (JSON).
6401 Defaults to B<Command>.
6403 =item B<StoreRates> B<true|false>
6405 If set to B<true>, convert counter values to rates. If set to B<false> (the
6406 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
6411 =head2 Plugin C<write_kafka>
6413 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
6417 <Plugin "write_kafka">
6418 Property "metadata.broker.list" "broker1:9092,broker2:9092"
6424 The following options are understood by the I<write_kafka plugin>:
6428 =item E<lt>B<Topic> I<Name>E<gt>
6430 The plugin's configuration consists of one or more B<Topic> blocks. Each block
6431 is given a unique I<Name> and specifies one kafka producer.
6432 Inside the B<Topic> block, the following per-topic options are
6437 =item B<Property> I<String> I<String>
6439 Configure the named property for the current topic. Properties are
6440 forwarded to the kafka producer library B<librdkafka>.
6442 =item B<Key> I<String>
6444 Use the specified string as a partioning key for the topic. Kafka breaks
6445 topic into partitions and guarantees that for a given topology, the same
6446 consumer will be used for a specific key. The special (case insensitive)
6447 string B<Random> can be used to specify that an arbitrary partition should
6450 =item B<Format> B<Command>|B<JSON>|B<Graphite>
6452 Selects the format in which messages are sent to the broker. If set to
6453 B<Command> (the default), values are sent as C<PUTVAL> commands which are
6454 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
6456 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
6457 an easy and straight forward exchange format.
6459 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
6460 "<metric> <value> <timestamp>\n".
6462 =item B<StoreRates> B<true>|B<false>
6464 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
6465 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
6466 default), no conversion is performed. Otherwise the conversion is performed
6467 using the internal value cache.
6469 Please note that currently this option is only used if the B<Format> option has
6470 been set to B<JSON>.
6472 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
6474 A prefix can be added in the metric name when outputting in the I<Graphite> format.
6475 It's added before the I<Host> name.
6476 Metric name will be "<prefix><host><postfix><plugin><type><name>"
6478 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
6480 A postfix can be added in the metric name when outputting in the I<Graphite> format.
6481 It's added after the I<Host> name.
6482 Metric name will be "<prefix><host><postfix><plugin><type><name>"
6484 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
6486 Specify a character to replace dots (.) in the host part of the metric name.
6487 In I<Graphite> metric name, dots are used as separators between different
6488 metric parts (host, plugin, type).
6489 Default is "_" (I<Underscore>).
6491 =item B<GraphiteSeparateInstances> B<false>|B<true>
6493 If set to B<true>, the plugin instance and type instance will be in their own
6494 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6495 default), the plugin and plugin instance (and likewise the type and type
6496 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6498 =item B<StoreRates> B<true>|B<false>
6500 If set to B<true> (the default), convert counter values to rates. If set to
6501 B<false> counter values are stored as is, i.e. as an increasing integer number.
6503 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
6504 converted values will have "rate" appended to the data source type, e.g.
6505 C<ds_type:derive:rate>.
6509 =item B<Property> I<String> I<String>
6511 Configure the kafka producer through properties, you almost always will
6512 want to set B<metadata.broker.list> to your Kafka broker list.
6516 =head2 Plugin C<write_riemann>
6518 The I<write_riemann plugin> will send values to I<Riemann>, a powerfull stream
6519 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
6520 I<Riemann> using UDP packets.
6524 <Plugin "write_riemann">
6530 AlwaysAppendDS false
6534 Attribute "foo" "bar"
6537 The following options are understood by the I<write_riemann plugin>:
6541 =item E<lt>B<Node> I<Name>E<gt>
6543 The plugin's configuration consists of one or more B<Node> blocks. Each block
6544 is given a unique I<Name> and specifies one connection to an instance of
6545 I<Riemann>. Indise the B<Node> block, the following per-connection options are
6550 =item B<Host> I<Address>
6552 Hostname or address to connect to. Defaults to C<localhost>.
6554 =item B<Port> I<Service>
6556 Service name or port number to connect to. Defaults to C<5555>.
6558 =item B<Protocol> B<UDP>|B<TCP>
6560 Specify the protocol to use when communicating with I<Riemann>. Defaults to
6563 =item B<StoreRates> B<true>|B<false>
6565 If set to B<true> (the default), convert counter values to rates. If set to
6566 B<false> counter values are stored as is, i.e. as an increasing integer number.
6568 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
6569 converted values will have "rate" appended to the data source type, e.g.
6570 C<ds_type:derive:rate>.
6572 =item B<AlwaysAppendDS> B<false>|B<true>
6574 If set the B<true>, append the name of the I<Data Source> (DS) to the
6575 "service", i.e. the field that, together with the "host" field, uniquely
6576 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
6577 only done when there is more than one DS.
6579 =item B<TTLFactor> I<Factor>
6581 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
6582 event is considered active. I<collectd> populates this field based on the
6583 metrics interval setting. This setting controls the factor with which the
6584 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
6585 know exactly what you're doing, you should only increase this setting from its
6588 =item B<Notifications> B<false>|B<true>
6590 If set to B<true>, create riemann events for notifications. This is B<true>
6591 by default. When processing thresholds from write_riemann, it might prove
6592 useful to avoid getting notification events.
6594 =item B<CheckThresholds> B<false>|B<true>
6596 If set to B<true>, attach state to events based on thresholds defined
6597 in the B<Threshold> plugin. Defaults to B<false>.
6601 =item B<Tag> I<String>
6603 Add the given string as an additional tag to the metric being sent to
6606 =item B<Attribute> I<String> I<String>
6608 Consider the two given strings to be the key and value of an additional
6609 attribute for each metric being sent out to I<Riemann>.
6613 =head1 THRESHOLD CONFIGURATION
6615 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
6616 we mean that the values are not only stored or sent somewhere, but that they
6617 are judged and, if a problem is recognized, acted upon. The only action
6618 collectd takes itself is to generate and dispatch a "notification". Plugins can
6619 register to receive notifications and perform appropriate further actions.
6621 Since systems and what you expect them to do differ a lot, you can configure
6622 B<thresholds> for your values freely. This gives you a lot of flexibility but
6623 also a lot of responsibility.
6625 Every time a value is out of range a notification is dispatched. This means
6626 that the idle percentage of your CPU needs to be less then the configured
6627 threshold only once for a notification to be generated. There's no such thing
6628 as a moving average or similar - at least not now.
6630 Also, all values that match a threshold are considered to be relevant or
6631 "interesting". As a consequence collectd will issue a notification if they are
6632 not received for B<Timeout> iterations. The B<Timeout> configuration option is
6633 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
6634 "2" (the default) and some hosts sends it's CPU statistics to the server every
6635 60 seconds, a notification will be dispatched after about 120 seconds. It may
6636 take a little longer because the timeout is checked only once each B<Interval>
6639 When a value comes within range again or is received after it was missing, an
6640 "OKAY-notification" is dispatched.
6642 Here is a configuration example to get you started. Read below for more
6655 <Plugin "interface">
6672 WarningMin 100000000
6678 There are basically two types of configuration statements: The C<Host>,
6679 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
6680 configured. The C<Plugin> and C<Type> blocks may be specified further using the
6681 C<Instance> option. You can combine the block by nesting the blocks, though
6682 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
6683 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
6684 C<Type> may not contain other blocks. If multiple blocks apply to the same
6685 value the most specific block is used.
6687 The other statements specify the threshold to configure. They B<must> be
6688 included in a C<Type> block. Currently the following statements are recognized:
6692 =item B<FailureMax> I<Value>
6694 =item B<WarningMax> I<Value>
6696 Sets the upper bound of acceptable values. If unset defaults to positive
6697 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
6698 will be created. If the value is greater than B<WarningMax> but less than (or
6699 equal to) B<FailureMax> a B<WARNING> notification will be created.
6701 =item B<FailureMin> I<Value>
6703 =item B<WarningMin> I<Value>
6705 Sets the lower bound of acceptable values. If unset defaults to negative
6706 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
6707 be created. If the value is less than B<WarningMin> but greater than (or equal
6708 to) B<FailureMin> a B<WARNING> notification will be created.
6710 =item B<DataSource> I<DSName>
6712 Some data sets have more than one "data source". Interesting examples are the
6713 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
6714 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
6715 system load data set, C<load>, even has three data sources: C<shortterm>,
6716 C<midterm>, and C<longterm>.
6718 Normally, all data sources are checked against a configured threshold. If this
6719 is undesirable, or if you want to specify different limits for each data
6720 source, you can use the B<DataSource> option to have a threshold apply only to
6723 =item B<Invert> B<true>|B<false>
6725 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
6726 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
6727 B<WarningMax>) are not okay. Defaults to B<false>.
6729 =item B<Persist> B<true>|B<false>
6731 Sets how often notifications are generated. If set to B<true> one notification
6732 will be generated for each value that is out of the acceptable range. If set to
6733 B<false> (the default) then a notification is only generated if a value is out
6734 of range but the previous value was okay.
6736 This applies to missing values, too: If set to B<true> a notification about a
6737 missing value is generated once every B<Interval> seconds. If set to B<false>
6738 only one such notification is generated until the value appears again.
6740 =item B<Percentage> B<true>|B<false>
6742 If set to B<true>, the minimum and maximum values given are interpreted as
6743 percentage value, relative to the other data sources. This is helpful for
6744 example for the "df" type, where you may want to issue a warning when less than
6745 5E<nbsp>% of the total space is available. Defaults to B<false>.
6747 =item B<Hits> I<Number>
6749 Delay creating the notification until the threshold has been passed I<Number>
6750 times. When a notification has been generated, or when a subsequent value is
6751 inside the threshold, the counter is reset. If, for example, a value is
6752 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
6753 will be dispatched at most once every 30E<nbsp>seconds.
6755 This is useful when short bursts are not a problem. If, for example, 100% CPU
6756 usage for up to a minute is normal (and data is collected every
6757 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
6759 =item B<Hysteresis> I<Number>
6761 When set to non-zero, a hysteresis value is applied when checking minimum and
6762 maximum bounds. This is useful for values that increase slowly and fluctuate a
6763 bit while doing so. When these values come close to the threshold, they may
6764 "flap", i.e. switch between failure / warning case and okay case repeatedly.
6766 If, for example, the threshold is configures as
6771 then a I<Warning> notification is created when the value exceeds I<101> and the
6772 corresponding I<Okay> notification is only created once the value falls below
6773 I<99>, thus avoiding the "flapping".
6777 =head1 FILTER CONFIGURATION
6779 Starting with collectd 4.6 there is a powerful filtering infrastructure
6780 implemented in the daemon. The concept has mostly been copied from
6781 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
6782 terminology, so that users that are familiar with iptables feel right at home.
6786 The following are the terms used in the remainder of the filter configuration
6787 documentation. For an ASCII-art schema of the mechanism, see
6788 L<"General structure"> below.
6794 A I<match> is a criteria to select specific values. Examples are, of course, the
6795 name of the value or it's current value.
6797 Matches are implemented in plugins which you have to load prior to using the
6798 match. The name of such plugins starts with the "match_" prefix.
6802 A I<target> is some action that is to be performed with data. Such actions
6803 could, for example, be to change part of the value's identifier or to ignore
6804 the value completely.
6806 Some of these targets are built into the daemon, see L<"Built-in targets">
6807 below. Other targets are implemented in plugins which you have to load prior to
6808 using the target. The name of such plugins starts with the "target_" prefix.
6812 The combination of any number of matches and at least one target is called a
6813 I<rule>. The target actions will be performed for all values for which B<all>
6814 matches apply. If the rule does not have any matches associated with it, the
6815 target action will be performed for all values.
6819 A I<chain> is a list of rules and possibly default targets. The rules are tried
6820 in order and if one matches, the associated target will be called. If a value
6821 is handled by a rule, it depends on the target whether or not any subsequent
6822 rules are considered or if traversal of the chain is aborted, see
6823 L<"Flow control"> below. After all rules have been checked, the default targets
6828 =head2 General structure
6830 The following shows the resulting structure:
6837 +---------+ +---------+ +---------+ +---------+
6838 ! Rule !->! Match !->! Match !->! Target !
6839 +---------+ +---------+ +---------+ +---------+
6842 +---------+ +---------+ +---------+
6843 ! Rule !->! Target !->! Target !
6844 +---------+ +---------+ +---------+
6851 +---------+ +---------+ +---------+
6852 ! Rule !->! Match !->! Target !
6853 +---------+ +---------+ +---------+
6863 There are four ways to control which way a value takes through the filter
6870 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
6871 process the value with another chain. When the called chain finishes, usually
6872 the next target or rule after the jump is executed.
6876 The stop condition, signaled for example by the built-in target B<stop>, causes
6877 all processing of the value to be stopped immediately.
6881 Causes processing in the current chain to be aborted, but processing of the
6882 value generally will continue. This means that if the chain was called via
6883 B<Jump>, the next target or rule after the jump will be executed. If the chain
6884 was not called by another chain, control will be returned to the daemon and it
6885 may pass the value to another chain.
6889 Most targets will signal the B<continue> condition, meaning that processing
6890 should continue normally. There is no special built-in target for this
6897 The configuration reflects this structure directly:
6899 PostCacheChain "PostCache"
6901 <Rule "ignore_mysql_show">
6904 Type "^mysql_command$"
6905 TypeInstance "^show_"
6915 The above configuration example will ignore all values where the plugin field
6916 is "mysql", the type is "mysql_command" and the type instance begins with
6917 "show_". All other values will be sent to the C<rrdtool> write plugin via the
6918 default target of the chain. Since this chain is run after the value has been
6919 added to the cache, the MySQL C<show_*> command statistics will be available
6920 via the C<unixsock> plugin.
6922 =head2 List of configuration options
6926 =item B<PreCacheChain> I<ChainName>
6928 =item B<PostCacheChain> I<ChainName>
6930 Configure the name of the "pre-cache chain" and the "post-cache chain". The
6931 argument is the name of a I<chain> that should be executed before and/or after
6932 the values have been added to the cache.
6934 To understand the implications, it's important you know what is going on inside
6935 I<collectd>. The following diagram shows how values are passed from the
6936 read-plugins to the write-plugins:
6942 + - - - - V - - - - +
6943 : +---------------+ :
6946 : +-------+-------+ :
6949 : +-------+-------+ : +---------------+
6950 : ! Cache !--->! Value Cache !
6951 : ! insert ! : +---+---+-------+
6952 : +-------+-------+ : ! !
6953 : ! ,------------' !
6955 : +-------+---+---+ : +-------+-------+
6956 : ! Post-Cache +--->! Write-Plugins !
6957 : ! Chain ! : +---------------+
6958 : +---------------+ :
6961 + - - - - - - - - - +
6963 After the values are passed from the "read" plugins to the dispatch functions,
6964 the pre-cache chain is run first. The values are added to the internal cache
6965 afterwards. The post-cache chain is run after the values have been added to the
6966 cache. So why is it such a huge deal if chains are run before or after the
6967 values have been added to this cache?
6969 Targets that change the identifier of a value list should be executed before
6970 the values are added to the cache, so that the name in the cache matches the
6971 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
6972 this cache to receive a list of all available values. If you change the
6973 identifier after the value list has been added to the cache, this may easily
6974 lead to confusion, but it's not forbidden of course.
6976 The cache is also used to convert counter values to rates. These rates are, for
6977 example, used by the C<value> match (see below). If you use the rate stored in
6978 the cache B<before> the new value is added, you will use the old, B<previous>
6979 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
6980 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
6983 Last but not last, the B<stop> target makes a difference: If the pre-cache
6984 chain returns the stop condition, the value will not be added to the cache and
6985 the post-cache chain will not be run.
6987 =item B<Chain> I<Name>
6989 Adds a new chain with a certain name. This name can be used to refer to a
6990 specific chain, for example to jump to it.
6992 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
6994 =item B<Rule> [I<Name>]
6996 Adds a new rule to the current chain. The name of the rule is optional and
6997 currently has no meaning for the daemon.
6999 Within the B<Rule> block, there may be any number of B<Match> blocks and there
7000 must be at least one B<Target> block.
7002 =item B<Match> I<Name>
7004 Adds a match to a B<Rule> block. The name specifies what kind of match should
7005 be performed. Available matches depend on the plugins that have been loaded.
7007 The arguments inside the B<Match> block are passed to the plugin implementing
7008 the match, so which arguments are valid here depends on the plugin being used.
7009 If you do not need any to pass any arguments to a match, you can use the
7014 Which is equivalent to:
7019 =item B<Target> I<Name>
7021 Add a target to a rule or a default target to a chain. The name specifies what
7022 kind of target is to be added. Which targets are available depends on the
7023 plugins being loaded.
7025 The arguments inside the B<Target> block are passed to the plugin implementing
7026 the target, so which arguments are valid here depends on the plugin being used.
7027 If you do not need any to pass any arguments to a target, you can use the
7032 This is the same as writing:
7039 =head2 Built-in targets
7041 The following targets are built into the core daemon and therefore need no
7042 plugins to be loaded:
7048 Signals the "return" condition, see the L<"Flow control"> section above. This
7049 causes the current chain to stop processing the value and returns control to
7050 the calling chain. The calling chain will continue processing targets and rules
7051 just after the B<jump> target (see below). This is very similar to the
7052 B<RETURN> target of iptables, see L<iptables(8)>.
7054 This target does not have any options.
7062 Signals the "stop" condition, see the L<"Flow control"> section above. This
7063 causes processing of the value to be aborted immediately. This is similar to
7064 the B<DROP> target of iptables, see L<iptables(8)>.
7066 This target does not have any options.
7074 Sends the value to "write" plugins.
7080 =item B<Plugin> I<Name>
7082 Name of the write plugin to which the data should be sent. This option may be
7083 given multiple times to send the data to more than one write plugin.
7087 If no plugin is explicitly specified, the values will be sent to all available
7098 Starts processing the rules of another chain, see L<"Flow control"> above. If
7099 the end of that chain is reached, or a stop condition is encountered,
7100 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
7101 next target or the next rule. This is similar to the B<-j> command line option
7102 of iptables, see L<iptables(8)>.
7108 =item B<Chain> I<Name>
7110 Jumps to the chain I<Name>. This argument is required and may appear only once.
7122 =head2 Available matches
7128 Matches a value using regular expressions.
7134 =item B<Host> I<Regex>
7136 =item B<Plugin> I<Regex>
7138 =item B<PluginInstance> I<Regex>
7140 =item B<Type> I<Regex>
7142 =item B<TypeInstance> I<Regex>
7144 Match values where the given regular expressions match the various fields of
7145 the identifier of a value. If multiple regular expressions are given, B<all>
7146 regexen must match for a value to match.
7148 =item B<Invert> B<false>|B<true>
7150 When set to B<true>, the result of the match is inverted, i.e. all value lists
7151 where all regular expressions apply are not matched, all other value lists are
7152 matched. Defaults to B<false>.
7159 Host "customer[0-9]+"
7165 Matches values that have a time which differs from the time on the server.
7167 This match is mainly intended for servers that receive values over the
7168 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
7169 is very sensitive to the timestamp used when updating the RRD files. In
7170 particular, the time must be ever increasing. If a misbehaving client sends one
7171 packet with a timestamp far in the future, all further packets with a correct
7172 time will be ignored because of that one packet. What's worse, such corrupted
7173 RRD files are hard to fix.
7175 This match lets one match all values B<outside> a specified time range
7176 (relative to the server's time), so you can use the B<stop> target (see below)
7177 to ignore the value, for example.
7183 =item B<Future> I<Seconds>
7185 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
7186 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7189 =item B<Past> I<Seconds>
7191 Matches all values that are I<behind> of the server's time by I<Seconds> or
7192 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7204 This example matches all values that are five minutes or more ahead of the
7205 server or one hour (or more) lagging behind.
7209 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
7210 values. If a data-set consists of more than one data-source, all data-sources
7211 must match the specified ranges for a positive match.
7217 =item B<Min> I<Value>
7219 Sets the smallest value which still results in a match. If unset, behaves like
7222 =item B<Max> I<Value>
7224 Sets the largest value which still results in a match. If unset, behaves like
7227 =item B<Invert> B<true>|B<false>
7229 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
7230 no-match is returned and vice versa. Please note that the B<Invert> setting
7231 only effects how B<Min> and B<Max> are applied to a specific value. Especially
7232 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
7234 =item B<DataSource> I<DSName> [I<DSName> ...]
7236 Select one or more of the data sources. If no data source is configured, all
7237 data sources will be checked. If the type handled by the match does not have a
7238 data source of the specified name(s), this will always result in no match
7239 (independent of the B<Invert> setting).
7241 =item B<Satisfy> B<Any>|B<All>
7243 Specifies how checking with several data sources is performed. If set to
7244 B<Any>, the match succeeds if one of the data sources is in the configured
7245 range. If set to B<All> the match only succeeds if all data sources are within
7246 the configured range. Default is B<All>.
7248 Usually B<All> is used for positive matches, B<Any> is used for negative
7249 matches. This means that with B<All> you usually check that all values are in a
7250 "good" range, while with B<Any> you check if any value is within a "bad" range
7251 (or outside the "good" range).
7255 Either B<Min> or B<Max>, but not both, may be unset.
7259 # Match all values smaller than or equal to 100. Matches only if all data
7260 # sources are below 100.
7266 # Match if the value of any data source is outside the range of 0 - 100.
7274 =item B<empty_counter>
7276 Matches all values with one or more data sources of type B<COUNTER> and where
7277 all counter values are zero. These counters usually I<never> increased since
7278 they started existing (and are therefore uninteresting), or got reset recently
7279 or overflowed and you had really, I<really> bad luck.
7281 Please keep in mind that ignoring such counters can result in confusing
7282 behavior: Counters which hardly ever increase will be zero for long periods of
7283 time. If the counter is reset for some reason (machine or service restarted,
7284 usually), the graph will be empty (NAN) for a long time. People may not
7289 Calculates a hash value of the host name and matches values according to that
7290 hash value. This makes it possible to divide all hosts into groups and match
7291 only values that are in a specific group. The intended use is in load
7292 balancing, where you want to handle only part of all data and leave the rest
7295 The hashing function used tries to distribute the hosts evenly. First, it
7296 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
7299 for (i = 0; host[i] != 0; i++)
7300 hash_value = (hash_value * 251) + host[i];
7302 The constant 251 is a prime number which is supposed to make this hash value
7303 more random. The code then checks the group for this host according to the
7304 I<Total> and I<Match> arguments:
7306 if ((hash_value % Total) == Match)
7311 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
7312 groups), then the least significant bit of the hash value will be the XOR of
7313 all least significant bits in the host name. One consequence is that when you
7314 have two hosts, "server0.example.com" and "server1.example.com", where the host
7315 name differs in one digit only and the digits differ by one, those hosts will
7316 never end up in the same group.
7322 =item B<Match> I<Match> I<Total>
7324 Divide the data into I<Total> groups and match all hosts in group I<Match> as
7325 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
7326 be smaller than I<Total>. I<Total> must be at least one, although only values
7327 greater than one really do make any sense.
7329 You can repeat this option to match multiple groups, for example:
7334 The above config will divide the data into seven groups and match groups three
7335 and five. One use would be to keep every value on two hosts so that if one
7336 fails the missing data can later be reconstructed from the second host.
7342 # Operate on the pre-cache chain, so that ignored values are not even in the
7347 # Divide all received hosts in seven groups and accept all hosts in
7351 # If matched: Return and continue.
7354 # If not matched: Return and stop.
7360 =head2 Available targets
7364 =item B<notification>
7366 Creates and dispatches a notification.
7372 =item B<Message> I<String>
7374 This required option sets the message of the notification. The following
7375 placeholders will be replaced by an appropriate value:
7383 =item B<%{plugin_instance}>
7387 =item B<%{type_instance}>
7389 These placeholders are replaced by the identifier field of the same name.
7391 =item B<%{ds:>I<name>B<}>
7393 These placeholders are replaced by a (hopefully) human readable representation
7394 of the current rate of this data source. If you changed the instance name
7395 (using the B<set> or B<replace> targets, see below), it may not be possible to
7396 convert counter values to rates.
7400 Please note that these placeholders are B<case sensitive>!
7402 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
7404 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
7411 <Target "notification">
7412 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
7418 Replaces parts of the identifier using regular expressions.
7424 =item B<Host> I<Regex> I<Replacement>
7426 =item B<Plugin> I<Regex> I<Replacement>
7428 =item B<PluginInstance> I<Regex> I<Replacement>
7430 =item B<TypeInstance> I<Regex> I<Replacement>
7432 Match the appropriate field with the given regular expression I<Regex>. If the
7433 regular expression matches, that part that matches is replaced with
7434 I<Replacement>. If multiple places of the input buffer match a given regular
7435 expression, only the first occurrence will be replaced.
7437 You can specify each option multiple times to use multiple regular expressions
7445 # Replace "example.net" with "example.com"
7446 Host "\\<example.net\\>" "example.com"
7448 # Strip "www." from hostnames
7454 Sets part of the identifier of a value to a given string.
7460 =item B<Host> I<String>
7462 =item B<Plugin> I<String>
7464 =item B<PluginInstance> I<String>
7466 =item B<TypeInstance> I<String>
7468 Set the appropriate field to the given string. The strings for plugin instance
7469 and type instance may be empty, the strings for host and plugin may not be
7470 empty. It's currently not possible to set the type of a value this way.
7477 PluginInstance "coretemp"
7478 TypeInstance "core3"
7483 =head2 Backwards compatibility
7485 If you use collectd with an old configuration, i.E<nbsp>e. one without a
7486 B<Chain> block, it will behave as it used to. This is equivalent to the
7487 following configuration:
7493 If you specify a B<PostCacheChain>, the B<write> target will not be added
7494 anywhere and you will have to make sure that it is called where appropriate. We
7495 suggest to add the above snippet as default target to your "PostCache" chain.
7499 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
7515 L<collectd-exec(5)>,
7516 L<collectd-perl(5)>,
7517 L<collectd-unixsock(5)>,
7530 Florian Forster E<lt>octo@verplant.orgE<gt>