5 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
9 BaseDir "/var/lib/collectd"
10 PIDFile "/run/collectd.pid"
31 This config file controls how the system statistics collection daemon
32 B<collectd> behaves. The most significant option is B<LoadPlugin>, which
33 controls which plugins to load. These plugins ultimately define collectd's
34 behavior. If the B<AutoLoadPlugin> option has been enabled, the explicit
35 B<LoadPlugin> lines may be omitted for all plugins with a configuration block,
36 i.e. a C<E<lt>PluginE<nbsp>...E<gt>> block.
38 The syntax of this config file is similar to the config file of the famous
39 I<Apache> webserver. Each line contains either an option (a key and a list of
40 one or more values) or a section-start or -end. Empty lines and everything
41 after a non-quoted hash-symbol (C<#>) is ignored. I<Keys> are unquoted
42 strings, consisting only of alphanumeric characters and the underscore (C<_>)
43 character. Keys are handled case insensitive by I<collectd> itself and all
44 plugins included with it. I<Values> can either be an I<unquoted string>, a
45 I<quoted string> (enclosed in double-quotes) a I<number> or a I<boolean>
46 expression. I<Unquoted strings> consist of only alphanumeric characters and
47 underscores (C<_>) and do not need to be quoted. I<Quoted strings> are
48 enclosed in double quotes (C<">). You can use the backslash character (C<\>)
49 to include double quotes as part of the string. I<Numbers> can be specified in
50 decimal and floating point format (using a dot C<.> as decimal separator),
51 hexadecimal when using the C<0x> prefix and octal with a leading zero (C<0>).
52 I<Boolean> values are either B<true> or B<false>.
54 Lines may be wrapped by using C<\> as the last character before the newline.
55 This allows long lines to be split into multiple lines. Quoted strings may be
56 wrapped as well. However, those are treated special in that whitespace at the
57 beginning of the following lines will be ignored, which allows for nicely
58 indenting the wrapped lines.
60 The configuration is read and processed in order, i.e. from top to bottom. So
61 the plugins are loaded in the order listed in this config file. It is a good
62 idea to load any logging plugins first in order to catch messages from plugins
63 during configuration. Also, unless B<AutoLoadPlugin> is enabled, the
64 B<LoadPlugin> option I<must> occur I<before> the appropriate
65 C<E<lt>B<Plugin> ...E<gt>> block.
71 =item B<BaseDir> I<Directory>
73 Sets the base directory. This is the directory beneath all RRD-files are
74 created. Possibly more subdirectories are created. This is also the working
75 directory for the daemon.
77 =item B<LoadPlugin> I<Plugin>
79 Loads the plugin I<Plugin>. This is required to load plugins, unless the
80 B<AutoLoadPlugin> option is enabled (see below). Without any loaded plugins,
81 I<collectd> will be mostly useless.
83 Only the first B<LoadPlugin> statement or block for a given plugin name has any
84 effect. This is useful when you want to split up the configuration into smaller
85 files and want each file to be "self contained", i.e. it contains a B<Plugin>
86 block I<and> then appropriate B<LoadPlugin> statement. The downside is that if
87 you have multiple conflicting B<LoadPlugin> blocks, e.g. when they specify
88 different intervals, only one of them (the first one encountered) will take
89 effect and all others will be silently ignored.
91 B<LoadPlugin> may either be a simple configuration I<statement> or a I<block>
92 with additional options, affecting the behavior of B<LoadPlugin>. A simple
93 statement looks like this:
97 Options inside a B<LoadPlugin> block can override default settings and
98 influence the way plugins are loaded, e.g.:
104 The following options are valid inside B<LoadPlugin> blocks:
108 =item B<Globals> B<true|false>
110 If enabled, collectd will export all global symbols of the plugin (and of all
111 libraries loaded as dependencies of the plugin) and, thus, makes those symbols
112 available for resolving unresolved symbols in subsequently loaded plugins if
113 that is supported by your system.
115 This is useful (or possibly even required), e.g., when loading a plugin that
116 embeds some scripting language into the daemon (e.g. the I<Perl> and
117 I<Python plugins>). Scripting languages usually provide means to load
118 extensions written in C. Those extensions require symbols provided by the
119 interpreter, which is loaded as a dependency of the respective collectd plugin.
120 See the documentation of those plugins (e.g., L<collectd-perl(5)> or
121 L<collectd-python(5)>) for details.
123 By default, this is disabled. As a special exception, if the plugin name is
124 either C<perl> or C<python>, the default is changed to enabled in order to keep
125 the average user from ever having to deal with this low level linking stuff.
127 =item B<Interval> I<Seconds>
129 Sets a plugin-specific interval for collecting metrics. This overrides the
130 global B<Interval> setting. If a plugin provides own support for specifying an
131 interval, that setting will take precedence.
135 =item B<AutoLoadPlugin> B<false>|B<true>
137 When set to B<false> (the default), each plugin needs to be loaded explicitly,
138 using the B<LoadPlugin> statement documented above. If a
139 B<E<lt>PluginE<nbsp>...E<gt>> block is encountered and no configuration
140 handling callback for this plugin has been registered, a warning is logged and
141 the block is ignored.
143 When set to B<true>, explicit B<LoadPlugin> statements are not required. Each
144 B<E<lt>PluginE<nbsp>...E<gt>> block acts as if it was immediately preceded by a
145 B<LoadPlugin> statement. B<LoadPlugin> statements are still required for
146 plugins that don't provide any configuration, e.g. the I<Load plugin>.
148 =item B<Include> I<Path> [I<pattern>]
150 If I<Path> points to a file, includes that file. If I<Path> points to a
151 directory, recursively includes all files within that directory and its
152 subdirectories. If the C<wordexp> function is available on your system,
153 shell-like wildcards are expanded before files are included. This means you can
154 use statements like the following:
156 Include "/etc/collectd.d/*.conf"
158 Starting with version 5.3, this may also be a block in which further options
159 affecting the behavior of B<Include> may be specified. The following option is
162 <Include "/etc/collectd.d">
168 =item B<Filter> I<pattern>
170 If the C<fnmatch> function is available on your system, a shell-like wildcard
171 I<pattern> may be specified to filter which files to include. This may be used
172 in combination with recursively including a directory to easily be able to
173 arbitrarily mix configuration files and other documents (e.g. README files).
174 The given example is similar to the first example above but includes all files
175 matching C<*.conf> in any subdirectory of C</etc/collectd.d>:
177 Include "/etc/collectd.d" "*.conf"
181 If more than one files are included by a single B<Include> option, the files
182 will be included in lexicographical order (as defined by the C<strcmp>
183 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
184 order in which the files are loaded.
186 To prevent loops and shooting yourself in the foot in interesting ways the
187 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
188 most uses. Since symlinks are followed it is still possible to crash the daemon
189 by looping symlinks. In our opinion significant stupidity should result in an
190 appropriate amount of pain.
192 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
193 file, but you cannot include files from within blocks.
195 =item B<PIDFile> I<File>
197 Sets where to write the PID file to. This file is overwritten when it exists
198 and deleted when the program is stopped. Some init-scripts might override this
199 setting using the B<-P> command-line option.
201 =item B<PluginDir> I<Directory>
203 Path to the plugins (shared objects) of collectd.
205 =item B<TypesDB> I<File> [I<File> ...]
207 Set one or more files that contain the data-set descriptions. See
208 L<types.db(5)> for a description of the format of this file.
210 =item B<Interval> I<Seconds>
212 Configures the interval in which to query the read plugins. Obviously smaller
213 values lead to a higher system load produced by collectd, while higher values
214 lead to more coarse statistics.
216 B<Warning:> You should set this once and then never touch it again. If you do,
217 I<you will have to delete all your RRD files> or know some serious RRDtool
218 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
220 =item B<Timeout> I<Iterations>
222 Consider a value list "missing" when no update has been read or received for
223 I<Iterations> iterations. By default, I<collectd> considers a value list
224 missing when no update has been received for twice the update interval. Since
225 this setting uses iterations, the maximum allowed time without update depends
226 on the I<Interval> information contained in each value list. This is used in
227 the I<Threshold> configuration to dispatch notifications about missing values,
228 see L<collectd-threshold(5)> for details.
230 =item B<ReadThreads> I<Num>
232 Number of threads to start for reading plugins. The default value is B<5>, but
233 you may want to increase this if you have more than five plugins that take a
234 long time to read. Mostly those are plugins that do network-IO. Setting this to
235 a value higher than the number of registered read callbacks is not recommended.
237 =item B<WriteThreads> I<Num>
239 Number of threads to start for dispatching value lists to write plugins. The
240 default value is B<5>, but you may want to increase this if you have more than
241 five plugins that may take relatively long to write to.
243 =item B<WriteQueueLimitHigh> I<HighNum>
245 =item B<WriteQueueLimitLow> I<LowNum>
247 Metrics are read by the I<read threads> and then put into a queue to be handled
248 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
249 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
250 running into memory issues in such a case, you can limit the size of this
253 By default, there is no limit and memory may grow indefinitely. This is most
254 likely not an issue for clients, i.e. instances that only handle the local
255 metrics. For servers it is recommended to set this to a non-zero value, though.
257 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
258 Each of them takes a numerical argument which is the number of metrics in the
259 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
260 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
261 I<will> be enqueued. If the number of metrics currently in the queue is between
262 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
263 proportional to the number of metrics in the queue (i.e. it increases linearly
264 until it reaches 100%.)
266 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
267 unset, the latter will default to half of B<WriteQueueLimitHigh>.
269 If you do not want to randomly drop values when the queue size is between
270 I<LowNum> and I<HighNum>, set If B<WriteQueueLimitHigh> and
271 B<WriteQueueLimitLow> to same value.
273 =item B<Hostname> I<Name>
275 Sets the hostname that identifies a host. If you omit this setting, the
276 hostname will be determined using the L<gethostname(2)> system call.
278 =item B<FQDNLookup> B<true|false>
280 If B<Hostname> is determined automatically this setting controls whether or not
281 the daemon should try to figure out the "fully qualified domain name", FQDN.
282 This is done using a lookup of the name returned by C<gethostname>. This option
283 is enabled by default.
285 =item B<PreCacheChain> I<ChainName>
287 =item B<PostCacheChain> I<ChainName>
289 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
290 see L<FILTER CONFIGURATION> below on information on chains and how these
291 setting change the daemon's behavior.
295 =head1 PLUGIN OPTIONS
297 Some plugins may register own options. These options must be enclosed in a
298 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
299 require external configuration, too. The C<apache plugin>, for example,
300 required C<mod_status> to be configured in the webserver you're going to
301 collect data from. These plugins are listed below as well, even if they don't
302 require any configuration within collectd's configuration file.
304 A list of all plugins and a short summary for each plugin can be found in the
305 F<README> file shipped with the sourcecode and hopefully binary packets as
308 =head2 Plugin C<aggregation>
310 The I<Aggregation plugin> makes it possible to aggregate several values into
311 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
312 This can be put to a wide variety of uses, e.g. average and total CPU
313 statistics for your entire fleet.
315 The grouping is powerful but, as with many powerful tools, may be a bit
316 difficult to wrap your head around. The grouping will therefore be
317 demonstrated using an example: The average and sum of the CPU usage across
318 all CPUs of each host is to be calculated.
320 To select all the affected values for our example, set C<Plugin cpu> and
321 C<Type cpu>. The other values are left unspecified, meaning "all values". The
322 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
323 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
329 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...) and
330 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
331 example, the intention is to have a new value for each host / type instance
332 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
333 It can be specified multiple times to group by more than one field.
336 GroupBy "TypeInstance"
338 We do neither specify nor group by I<plugin instance> (the CPU number), so all
339 metrics that differ in the CPU number only will be aggregated. Each
340 aggregation needs I<at least one> such field, otherwise no aggregation would
343 The full example configuration looks like this:
345 <Plugin "aggregation">
351 GroupBy "TypeInstance"
354 CalculateAverage true
358 There are a couple of limitations you should be aware of:
364 The I<Type> cannot be left unspecified, because it is not reasonable to add
365 apples to oranges. Also, the internal lookup structure won't work if you try
370 There must be at least one unspecified, ungrouped field. Otherwise nothing
375 As you can see in the example above, each aggregation has its own
376 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
377 blocks may match the same values, i.e. one value list can update multiple
378 aggregations. The following options are valid inside B<Aggregation> blocks:
382 =item B<Host> I<Host>
384 =item B<Plugin> I<Plugin>
386 =item B<PluginInstance> I<PluginInstance>
388 =item B<Type> I<Type>
390 =item B<TypeInstance> I<TypeInstance>
392 Selects the value lists to be added to this aggregation. B<Type> must be a
393 valid data set name, see L<types.db(5)> for details.
395 If the string starts with and ends with a slash (C</>), the string is
396 interpreted as a I<regular expression>. The regex flavor used are POSIX
397 extended regular expressions as described in L<regex(7)>. Example usage:
399 Host "/^db[0-9]\\.example\\.com$/"
401 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
403 Group valued by the specified field. The B<GroupBy> option may be repeated to
404 group by multiple fields.
406 =item B<SetHost> I<Host>
408 =item B<SetPlugin> I<Plugin>
410 =item B<SetPluginInstance> I<PluginInstance>
412 =item B<SetTypeInstance> I<TypeInstance>
414 Sets the appropriate part of the identifier to the provided string.
416 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
417 will be replaced with the aggregation function, e.g. "average". Not including
418 the placeholder will result in duplication warnings and/or messed up values if
419 more than one aggregation function are enabled.
421 The following example calculates the average usage of all "even" CPUs:
423 <Plugin "aggregation">
426 PluginInstance "/[0,2,4,6,8]$/"
430 SetPluginInstance "even-%{aggregation}"
433 GroupBy "TypeInstance"
435 CalculateAverage true
439 This will create the files:
445 foo.example.com/cpu-even-average/cpu-idle
449 foo.example.com/cpu-even-average/cpu-system
453 foo.example.com/cpu-even-average/cpu-user
461 =item B<CalculateNum> B<true>|B<false>
463 =item B<CalculateSum> B<true>|B<false>
465 =item B<CalculateAverage> B<true>|B<false>
467 =item B<CalculateMinimum> B<true>|B<false>
469 =item B<CalculateMaximum> B<true>|B<false>
471 =item B<CalculateStddev> B<true>|B<false>
473 Boolean options for enabling calculation of the number of value lists, their
474 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
475 are disabled by default.
479 =head2 Plugin C<amqp>
481 The I<AMQP plugin> can be used to communicate with other instances of
482 I<collectd> or third party applications using an AMQP message broker. Values
483 are sent to or received from the broker, which handles routing, queueing and
484 possibly filtering or messages.
487 # Send values to an AMQP broker
488 <Publish "some_name">
494 Exchange "amq.fanout"
495 # ExchangeType "fanout"
496 # RoutingKey "collectd"
500 # GraphitePrefix "collectd."
501 # GraphiteEscapeChar "_"
502 # GraphiteSeparateInstances false
503 # GraphiteAlwaysAppendDS false
506 # Receive values from an AMQP broker
507 <Subscribe "some_name">
513 Exchange "amq.fanout"
514 # ExchangeType "fanout"
516 # RoutingKey "collectd.#"
520 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
521 blocks, which configure sending and receiving of values respectively. The two
522 blocks are very similar, so unless otherwise noted, an option can be used in
523 either block. The name given in the blocks starting tag is only used for
524 reporting messages, but may be used to support I<flushing> of certain
525 I<Publish> blocks in the future.
529 =item B<Host> I<Host>
531 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
532 the underlying communications library, I<rabbitmq-c>, which is "localhost".
534 =item B<Port> I<Port>
536 Service name or port number on which the AMQP broker accepts connections. This
537 argument must be a string, even if the numeric form is used. Defaults to
540 =item B<VHost> I<VHost>
542 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
544 =item B<User> I<User>
546 =item B<Password> I<Password>
548 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
551 =item B<Exchange> I<Exchange>
553 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
554 By default, "amq.fanout" will be used.
556 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
557 the given exchange and the I<queue> is created, using the I<routing key> if
558 configured. See the B<Queue> and B<RoutingKey> options below.
560 =item B<ExchangeType> I<Type>
562 If given, the plugin will try to create the configured I<exchange> with this
563 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
564 be bound to this exchange.
566 =item B<Queue> I<Queue> (Subscribe only)
568 Configures the I<queue> name to subscribe to. If no queue name was configures
569 explicitly, a unique queue name will be created by the broker.
571 =item B<RoutingKey> I<Key>
573 In I<Publish> blocks, this configures the routing key to set on all outgoing
574 messages. If not given, the routing key will be computed from the I<identifier>
575 of the value. The host, plugin, type and the two instances are concatenated
576 together using dots as the separator and all containing dots replaced with
577 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
578 possible to receive only specific values using a "topic" exchange.
580 In I<Subscribe> blocks, configures the I<routing key> used when creating a
581 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
582 used to filter messages when using a "topic" exchange. If you're only
583 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
586 =item B<Persistent> B<true>|B<false> (Publish only)
588 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
589 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
590 default), the I<transient> delivery mode will be used, i.e. messages may be
591 lost due to high load, overflowing queues or similar issues.
593 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
595 Selects the format in which messages are sent to the broker. If set to
596 B<Command> (the default), values are sent as C<PUTVAL> commands which are
597 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
598 case, the C<Content-Type> header field will be set to C<text/collectd>.
600 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
601 an easy and straight forward exchange format. The C<Content-Type> header field
602 will be set to C<application/json>.
604 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
605 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
608 A subscribing client I<should> use the C<Content-Type> header field to
609 determine how to decode the values. Currently, the I<AMQP plugin> itself can
610 only decode the B<Command> format.
612 =item B<StoreRates> B<true>|B<false> (Publish only)
614 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
615 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
616 default), no conversion is performed. Otherwise the conversion is performed
617 using the internal value cache.
619 Please note that currently this option is only used if the B<Format> option has
622 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
624 A prefix can be added in the metric name when outputting in the I<Graphite> format.
625 It's added before the I<Host> name.
626 Metric name will be "<prefix><host><postfix><plugin><type><name>"
628 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
630 A postfix can be added in the metric name when outputting in the I<Graphite> format.
631 It's added after the I<Host> name.
632 Metric name will be "<prefix><host><postfix><plugin><type><name>"
634 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
636 Specify a character to replace dots (.) in the host part of the metric name.
637 In I<Graphite> metric name, dots are used as separators between different
638 metric parts (host, plugin, type).
639 Default is "_" (I<Underscore>).
641 =item B<GraphiteSeparateInstances> B<true>|B<false>
643 If set to B<true>, the plugin instance and type instance will be in their own
644 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
645 default), the plugin and plugin instance (and likewise the type and type
646 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
648 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
650 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
651 identifier. If set to B<false> (the default), this is only done when there is
656 =head2 Plugin C<apache>
658 To configure the C<apache>-plugin you first need to configure the Apache
659 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
660 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
661 the following snipped to base your Apache config upon:
664 <IfModule mod_status.c>
665 <Location /mod_status>
666 SetHandler server-status
670 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
671 also supported. It introduces a new field, called C<BusyServers>, to count the
672 number of currently connected clients. This field is also supported.
674 The configuration of the I<Apache> plugin consists of one or more
675 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
676 as the instance name. For example:
680 URL "http://www1.example.com/mod_status?auto"
683 URL "http://www2.example.com/mod_status?auto"
687 The instance name will be used as the I<plugin instance>. To emulate the old
688 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
689 plugin to work correctly, each instance name must be unique. This is not
690 enforced by the plugin and it is your responsibility to ensure it.
692 The following options are accepted within each I<Instance> block:
696 =item B<URL> I<http://host/mod_status?auto>
698 Sets the URL of the C<mod_status> output. This needs to be the output generated
699 by C<ExtendedStatus on> and it needs to be the machine readable output
700 generated by appending the C<?auto> argument. This option is I<mandatory>.
702 =item B<User> I<Username>
704 Optional user name needed for authentication.
706 =item B<Password> I<Password>
708 Optional password needed for authentication.
710 =item B<VerifyPeer> B<true|false>
712 Enable or disable peer SSL certificate verification. See
713 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
715 =item B<VerifyHost> B<true|false>
717 Enable or disable peer host name verification. If enabled, the plugin checks
718 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
719 certificate matches the host name provided by the B<URL> option. If this
720 identity check fails, the connection is aborted. Obviously, only works when
721 connecting to a SSL enabled server. Enabled by default.
723 =item B<CACert> I<File>
725 File that holds one or more SSL certificates. If you want to use HTTPS you will
726 possibly need this option. What CA certificates come bundled with C<libcurl>
727 and are checked by default depends on the distribution you use.
731 =head2 Plugin C<apcups>
735 =item B<Host> I<Hostname>
737 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
738 that IPv6 support has been disabled unless someone can confirm or decline that
739 B<apcupsd> can handle it.
741 =item B<Port> I<Port>
743 TCP-Port to connect to. Defaults to B<3551>.
745 =item B<ReportSeconds> B<true|false>
747 If set to B<true>, the time reported in the C<timeleft> metric will be
748 converted to seconds. This is the recommended setting. If set to B<false>, the
749 default for backwards compatibility, the time will be reported in minutes.
753 =head2 Plugin C<aquaero>
755 This plugin collects the value of the available sensors in an
756 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
757 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
758 connection for monitoring and configuration. The board can handle multiple
759 temperature sensors, fans, water pumps and water level sensors and adjust the
760 output settings such as fan voltage or power used by the water pump based on
761 the available inputs using a configurable controller included in the board.
762 This plugin collects all the available inputs as well as some of the output
763 values chosen by this controller. The plugin is based on the I<libaquaero5>
764 library provided by I<aquatools-ng>.
768 =item B<Device> I<DevicePath>
770 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
771 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
772 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
776 =head2 Plugin C<ascent>
778 This plugin collects information about an Ascent server, a free server for the
779 "World of Warcraft" game. This plugin gathers the information by fetching the
780 XML status page using C<libcurl> and parses it using C<libxml2>.
782 The configuration options are the same as for the C<apache> plugin above:
786 =item B<URL> I<http://localhost/ascent/status/>
788 Sets the URL of the XML status output.
790 =item B<User> I<Username>
792 Optional user name needed for authentication.
794 =item B<Password> I<Password>
796 Optional password needed for authentication.
798 =item B<VerifyPeer> B<true|false>
800 Enable or disable peer SSL certificate verification. See
801 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
803 =item B<VerifyHost> B<true|false>
805 Enable or disable peer host name verification. If enabled, the plugin checks
806 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
807 certificate matches the host name provided by the B<URL> option. If this
808 identity check fails, the connection is aborted. Obviously, only works when
809 connecting to a SSL enabled server. Enabled by default.
811 =item B<CACert> I<File>
813 File that holds one or more SSL certificates. If you want to use HTTPS you will
814 possibly need this option. What CA certificates come bundled with C<libcurl>
815 and are checked by default depends on the distribution you use.
819 =head2 Plugin C<bind>
821 Starting with BIND 9.5.0, the most widely used DNS server software provides
822 extensive statistics about queries, responses and lots of other information.
823 The bind plugin retrieves this information that's encoded in XML and provided
824 via HTTP and submits the values to collectd.
826 To use this plugin, you first need to tell BIND to make this information
827 available. This is done with the C<statistics-channels> configuration option:
829 statistics-channels {
830 inet localhost port 8053;
833 The configuration follows the grouping that can be seen when looking at the
834 data with an XSLT compatible viewer, such as a modern web browser. It's
835 probably a good idea to make yourself familiar with the provided values, so you
836 can understand what the collected statistics actually mean.
841 URL "http://localhost:8053/"
856 Zone "127.in-addr.arpa/IN"
860 The bind plugin accepts the following configuration options:
866 URL from which to retrieve the XML data. If not specified,
867 C<http://localhost:8053/> will be used.
869 =item B<ParseTime> B<true>|B<false>
871 When set to B<true>, the time provided by BIND will be parsed and used to
872 dispatch the values. When set to B<false>, the local time source is queried.
874 This setting is set to B<true> by default for backwards compatibility; setting
875 this to B<false> is I<recommended> to avoid problems with timezones and
878 =item B<OpCodes> B<true>|B<false>
880 When enabled, statistics about the I<"OpCodes">, for example the number of
881 C<QUERY> packets, are collected.
885 =item B<QTypes> B<true>|B<false>
887 When enabled, the number of I<incoming> queries by query types (for example
888 C<A>, C<MX>, C<AAAA>) is collected.
892 =item B<ServerStats> B<true>|B<false>
894 Collect global server statistics, such as requests received over IPv4 and IPv6,
895 successful queries, and failed updates.
899 =item B<ZoneMaintStats> B<true>|B<false>
901 Collect zone maintenance statistics, mostly information about notifications
902 (zone updates) and zone transfers.
906 =item B<ResolverStats> B<true>|B<false>
908 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
909 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
910 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
911 default. Use the B<ResolverStats> option within a B<View "_default"> block
912 instead for the same functionality.
918 Collect global memory statistics.
922 =item B<View> I<Name>
924 Collect statistics about a specific I<"view">. BIND can behave different,
925 mostly depending on the source IP-address of the request. These different
926 configurations are called "views". If you don't use this feature, you most
927 likely are only interested in the C<_default> view.
929 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
930 information you want to collect about a view. If no B<View> block is
931 configured, no detailed view statistics will be collected.
935 =item B<QTypes> B<true>|B<false>
937 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
942 =item B<ResolverStats> B<true>|B<false>
944 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
945 (e.E<nbsp>g. queries over IPv4, lame servers).
949 =item B<CacheRRSets> B<true>|B<false>
951 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
952 type is collected. Negative entries (queries which resulted in an error, for
953 example names that do not exist) are reported with a leading exclamation mark,
958 =item B<Zone> I<Name>
960 When given, collect detailed information about the given zone in the view. The
961 information collected if very similar to the global B<ServerStats> information
964 You can repeat this option to collect detailed information about multiple
967 By default no detailed zone information is collected.
973 =head2 Plugin C<cgroups>
975 This plugin collects the CPU user/system time for each I<cgroup> by reading the
976 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
977 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
981 =item B<CGroup> I<Directory>
983 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
984 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
987 =item B<IgnoreSelected> B<true>|B<false>
989 Invert the selection: If set to true, all cgroups I<except> the ones that
990 match any one of the criteria are collected. By default only selected
991 cgroups are collected if a selection is made. If no selection is configured
992 at all, B<all> cgroups are selected.
996 =head2 Plugin C<cpufreq>
998 This plugin doesn't have any options. It reads
999 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1000 installed) to get the current CPU frequency. If this file does not exist make
1001 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1002 installed and an "cpu governor" (that's a kernel module) is loaded.
1004 =head2 Plugin C<csv>
1008 =item B<DataDir> I<Directory>
1010 Set the directory to store CSV-files under. Per default CSV-files are generated
1011 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1012 The special strings B<stdout> and B<stderr> can be used to write to the standard
1013 output and standard error channels, respectively. This, of course, only makes
1014 much sense when collectd is running in foreground- or non-daemon-mode.
1016 =item B<StoreRates> B<true|false>
1018 If set to B<true>, convert counter values to rates. If set to B<false> (the
1019 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1024 =head2 Plugin C<curl>
1026 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1027 and the match infrastructure (the same code used by the tail plugin) to use
1028 regular expressions with the received data.
1030 The following example will read the current value of AMD stock from Google's
1031 finance page and dispatch the value to collectd.
1034 <Page "stock_quotes">
1035 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1039 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1040 DSType "GaugeAverage"
1041 # Note: `stock_value' is not a standard type.
1048 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1049 a web page and one or more "matches" to be performed on the returned data. The
1050 string argument to the B<Page> block is used as plugin instance.
1052 The following options are valid within B<Page> blocks:
1058 URL of the web site to retrieve. Since a regular expression will be used to
1059 extract information from this data, non-binary data is a big plus here ;)
1061 =item B<User> I<Name>
1063 Username to use if authorization is required to read the page.
1065 =item B<Password> I<Password>
1067 Password to use if authorization is required to read the page.
1069 =item B<VerifyPeer> B<true>|B<false>
1071 Enable or disable peer SSL certificate verification. See
1072 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1074 =item B<VerifyHost> B<true>|B<false>
1076 Enable or disable peer host name verification. If enabled, the plugin checks if
1077 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1078 matches the host name provided by the B<URL> option. If this identity check
1079 fails, the connection is aborted. Obviously, only works when connecting to a
1080 SSL enabled server. Enabled by default.
1082 =item B<CACert> I<file>
1084 File that holds one or more SSL certificates. If you want to use HTTPS you will
1085 possibly need this option. What CA certificates come bundled with C<libcurl>
1086 and are checked by default depends on the distribution you use.
1088 =item B<Header> I<Header>
1090 A HTTP header to add to the request. Multiple headers are added if this option
1091 is specified more than once.
1093 =item B<Post> I<Body>
1095 Specifies that the HTTP operation should be a POST instead of a GET. The
1096 complete data to be posted is given as the argument. This option will usually
1097 need to be accompanied by a B<Header> option to set an appropriate
1098 C<Content-Type> for the post body (e.g. to
1099 C<application/x-www-form-urlencoded>).
1101 =item B<MeasureResponseTime> B<true>|B<false>
1103 Measure response time for the request. If this setting is enabled, B<Match>
1104 blocks (see below) are optional. Disabled by default.
1106 =item B<E<lt>MatchE<gt>>
1108 One or more B<Match> blocks that define how to match information in the data
1109 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1110 used by the C<tail> plugin, so please see the documentation of the C<tail>
1111 plugin below on how matches are defined. If the B<MeasureResponseTime> option
1112 is set to B<true>, B<Match> blocks are optional.
1116 =head2 Plugin C<curl_json>
1118 The B<curl_json plugin> collects values from JSON data to be parsed by
1119 B<libyajl> (L<https://lloyd.github.io/yajl/>) retrieved via
1120 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1121 unix socket. The former can be used, for example, to collect values
1122 from CouchDB documents (which are stored JSON notation), and the
1123 latter to collect values from a uWSGI stats socket.
1125 The following example will collect several values from the built-in
1126 C<_stats> runtime statistics module of I<CouchDB>
1127 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1130 <URL "http://localhost:5984/_stats">
1132 <Key "httpd/requests/count">
1133 Type "http_requests"
1136 <Key "httpd_request_methods/*/count">
1137 Type "http_request_methods"
1140 <Key "httpd_status_codes/*/count">
1141 Type "http_response_codes"
1146 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1149 <Sock "/var/run/uwsgi.stats.sock">
1151 <Key "workers/*/requests">
1152 Type "http_requests"
1155 <Key "workers/*/apps/*/requests">
1156 Type "http_requests"
1161 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1162 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1163 blocks defining a unix socket to read JSON from directly. Each of
1164 these blocks may have one or more B<Key> blocks.
1166 The B<Key> string argument must be in a path format. Each component is
1167 used to match the key from a JSON map or the index of an JSON
1168 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1169 values for all map keys or array indices will be collectd.
1171 The following options are valid within B<URL> blocks:
1175 =item B<Instance> I<Instance>
1177 Sets the plugin instance to I<Instance>.
1179 =item B<User> I<Name>
1180 =item B<Password> I<Password>
1181 =item B<VerifyPeer> B<true>|B<false>
1182 =item B<VerifyHost> B<true>|B<false>
1183 =item B<CACert> I<file>
1184 =item B<Header> I<Header>
1185 =item B<Post> I<Body>
1187 These options behave exactly equivalent to the appropriate options of the
1188 I<cURL> plugin. Please see there for a detailed description.
1192 The following options are valid within B<Key> blocks:
1196 =item B<Type> I<Type>
1198 Sets the type used to dispatch the values to the daemon. Detailed information
1199 about types and their configuration can be found in L<types.db(5)>. This
1200 option is mandatory.
1202 =item B<Instance> I<Instance>
1204 Type-instance to use. Defaults to the current map key or current string array element value.
1208 =head2 Plugin C<curl_xml>
1210 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1211 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1214 <URL "http://localhost/stats.xml">
1216 Instance "some_instance"
1221 CACert "/path/to/ca.crt"
1223 <XPath "table[@id=\"magic_level\"]/tr">
1225 #InstancePrefix "prefix-"
1226 InstanceFrom "td[1]"
1227 ValuesFrom "td[2]/span[@class=\"level\"]"
1232 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1233 URL to be fetched using libcurl. Within each B<URL> block there are
1234 options which specify the connection parameters, for example authentication
1235 information, and one or more B<XPath> blocks.
1237 Each B<XPath> block specifies how to get one type of information. The
1238 string argument must be a valid XPath expression which returns a list
1239 of "base elements". One value is dispatched for each "base element". The
1240 I<type instance> and values are looked up using further I<XPath> expressions
1241 that should be relative to the base element.
1243 Within the B<URL> block the following options are accepted:
1247 =item B<Host> I<Name>
1249 Use I<Name> as the host name when submitting values. Defaults to the global
1252 =item B<Instance> I<Instance>
1254 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1255 empty string (no plugin instance).
1257 =item B<Namespace> I<Prefix> I<URL>
1259 If an XPath expression references namespaces, they must be specified
1260 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1261 I<URL> is the "namespace name", an URI reference uniquely identifying the
1262 namespace. The option can be repeated to register multiple namespaces.
1266 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1267 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1269 =item B<User> I<User>
1271 =item B<Password> I<Password>
1273 =item B<VerifyPeer> B<true>|B<false>
1275 =item B<VerifyHost> B<true>|B<false>
1277 =item B<CACert> I<CA Cert File>
1279 =item B<Header> I<Header>
1281 =item B<Post> I<Body>
1283 These options behave exactly equivalent to the appropriate options of the
1284 I<cURL plugin>. Please see there for a detailed description.
1286 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1288 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1289 B<XPath> block specifies how to get one type of information. The string
1290 argument must be a valid XPath expression which returns a list of "base
1291 elements". One value is dispatched for each "base element".
1293 Within the B<XPath> block the following options are accepted:
1297 =item B<Type> I<Type>
1299 Specifies the I<Type> used for submitting patches. This determines the number
1300 of values that are required / expected and whether the strings are parsed as
1301 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1302 This option is required.
1304 =item B<InstancePrefix> I<InstancePrefix>
1306 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1307 concatenated together without any separator.
1308 This option is optional.
1310 =item B<InstanceFrom> I<InstanceFrom>
1312 Specifies a XPath expression to use for determining the I<type instance>. The
1313 XPath expression must return exactly one element. The element's value is then
1314 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1316 This value is required. As a special exception, if the "base XPath expression"
1317 (the argument to the B<XPath> block) returns exactly one argument, then this
1318 option may be omitted.
1320 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1322 Specifies one or more XPath expression to use for reading the values. The
1323 number of XPath expressions must match the number of data sources in the
1324 I<type> specified with B<Type> (see above). Each XPath expression must return
1325 exactly one element. The element's value is then parsed as a number and used as
1326 value for the appropriate value in the value list dispatched to the daemon.
1332 =head2 Plugin C<dbi>
1334 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1335 connect to various databases, execute I<SQL> statements and read back the
1336 results. I<dbi> is an acronym for "database interface" in case you were
1337 wondering about the name. You can configure how each column is to be
1338 interpreted and the plugin will generate one or more data sets from each row
1339 returned according to these rules.
1341 Because the plugin is very generic, the configuration is a little more complex
1342 than those of other plugins. It usually looks something like this:
1345 <Query "out_of_stock">
1346 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1347 # Use with MySQL 5.0.0 or later
1351 InstancePrefix "out_of_stock"
1352 InstancesFrom "category"
1356 <Database "product_information">
1358 DriverOption "host" "localhost"
1359 DriverOption "username" "collectd"
1360 DriverOption "password" "aZo6daiw"
1361 DriverOption "dbname" "prod_info"
1362 SelectDB "prod_info"
1363 Query "out_of_stock"
1367 The configuration above defines one query with one result and one database. The
1368 query is then linked to the database with the B<Query> option I<within> the
1369 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1370 and you can also use the B<Include> statement to split up the configuration
1371 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1372 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1375 The following is a complete list of options:
1377 =head3 B<Query> blocks
1379 Query blocks define I<SQL> statements and how the returned data should be
1380 interpreted. They are identified by the name that is given in the opening line
1381 of the block. Thus the name needs to be unique. Other than that, the name is
1382 not used in collectd.
1384 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1385 define which column holds which value or instance information. You can use
1386 multiple B<Result> blocks to create multiple values from one returned row. This
1387 is especially useful, when queries take a long time and sending almost the same
1388 query again and again is not desirable.
1392 <Query "environment">
1393 Statement "select station, temperature, humidity from environment"
1396 # InstancePrefix "foo"
1397 InstancesFrom "station"
1398 ValuesFrom "temperature"
1402 InstancesFrom "station"
1403 ValuesFrom "humidity"
1407 The following options are accepted:
1411 =item B<Statement> I<SQL>
1413 Sets the statement that should be executed on the server. This is B<not>
1414 interpreted by collectd, but simply passed to the database server. Therefore,
1415 the SQL dialect that's used depends on the server collectd is connected to.
1417 The query has to return at least two columns, one for the instance and one
1418 value. You cannot omit the instance, even if the statement is guaranteed to
1419 always return exactly one line. In that case, you can usually specify something
1422 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1424 (That works with MySQL but may not be valid SQL according to the spec. If you
1425 use a more strict database server, you may have to select from a dummy table or
1428 Please note that some databases, for example B<Oracle>, will fail if you
1429 include a semicolon at the end of the statement.
1431 =item B<MinVersion> I<Version>
1433 =item B<MaxVersion> I<Value>
1435 Only use this query for the specified database version. You can use these
1436 options to provide multiple queries with the same name but with a slightly
1437 different syntax. The plugin will use only those queries, where the specified
1438 minimum and maximum versions fit the version of the database in use.
1440 The database version is determined by C<dbi_conn_get_engine_version>, see the
1441 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1442 for details. Basically, each part of the version is assumed to be in the range
1443 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1444 "40102", version "5.0.42" becomes "50042".
1446 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1447 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1448 happen. Don't to it! A valid example would be something along these lines:
1459 In the above example, there are three ranges that don't overlap. The last one
1460 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1461 before "4.0.0" are not specified.
1463 =item B<Type> I<Type>
1465 The B<type> that's used for each line returned. See L<types.db(5)> for more
1466 details on how types are defined. In short: A type is a predefined layout of
1467 data and the number of values and type of values has to match the type
1470 If you specify "temperature" here, you need exactly one gauge column. If you
1471 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1474 There must be exactly one B<Type> option inside each B<Result> block.
1476 =item B<InstancePrefix> I<prefix>
1478 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1479 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1480 all strings returned in the appropriate columns are concatenated together,
1481 separated by dashes I<("-")>.
1483 =item B<InstancesFrom> I<column0> [I<column1> ...]
1485 Specifies the columns whose values will be used to create the "type-instance"
1486 for each row. If you specify more than one column, the value of all columns
1487 will be joined together with dashes I<("-")> as separation characters.
1489 The plugin itself does not check whether or not all built instances are
1490 different. It's your responsibility to assure that each is unique. This is
1491 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1492 sure that only one row is returned in this case.
1494 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1497 =item B<ValuesFrom> I<column0> [I<column1> ...]
1499 Names the columns whose content is used as the actual data for the data sets
1500 that are dispatched to the daemon. How many such columns you need is determined
1501 by the B<Type> setting above. If you specify too many or not enough columns,
1502 the plugin will complain about that and no data will be submitted to the
1505 The actual data type in the columns is not that important. The plugin will
1506 automatically cast the values to the right type if it know how to do that. So
1507 it should be able to handle integer an floating point types, as well as strings
1508 (if they include a number at the beginning).
1510 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1514 =head3 B<Database> blocks
1516 Database blocks define a connection to a database and which queries should be
1517 sent to that database. Since the used "dbi" library can handle a wide variety
1518 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1519 documentationE<nbsp>- we stick as close to the terminology used there.
1521 Each database needs a "name" as string argument in the starting tag of the
1522 block. This name will be used as "PluginInstance" in the values submitted to
1523 the daemon. Other than that, that name is not used.
1527 =item B<Driver> I<Driver>
1529 Specifies the driver to use to connect to the database. In many cases those
1530 drivers are named after the database they can connect to, but this is not a
1531 technical necessity. These drivers are sometimes referred to as "DBD",
1532 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1533 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1534 project at L<http://libdbi-drivers.sourceforge.net/>.
1536 You need to give the driver name as expected by the "dbi" library here. You
1537 should be able to find that in the documentation for each driver. If you
1538 mistype the driver name, the plugin will dump a list of all known driver names
1541 =item B<DriverOption> I<Key> I<Value>
1543 Sets driver-specific options. What option a driver supports can be found in the
1544 documentation for each driver, somewhere at
1545 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1546 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1548 DBDs can register two types of options: String options and numeric options. The
1549 plugin will use the C<dbi_conn_set_option> function when the configuration
1550 provides a string and the C<dbi_conn_require_option_numeric> function when the
1551 configuration provides a number. So these two lines will actually result in
1552 different calls being used:
1554 DriverOption "Port" 1234 # numeric
1555 DriverOption "Port" "1234" # string
1557 Unfortunately, drivers are not too keen to report errors when an unknown option
1558 is passed to them, so invalid settings here may go unnoticed. This is not the
1559 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1560 the driver. If a driver complains about an option, the plugin will dump a
1561 complete list of all options understood by that driver to the log. There is no
1562 way to programatically find out if an option expects a string or a numeric
1563 argument, so you will have to refer to the appropriate DBD's documentation to
1564 find this out. Sorry.
1566 =item B<SelectDB> I<Database>
1568 In some cases, the database name you connect with is not the database name you
1569 want to use for querying data. If this option is set, the plugin will "select"
1570 (switch to) that database after the connection is established.
1572 =item B<Query> I<QueryName>
1574 Associates the query named I<QueryName> with this database connection. The
1575 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1576 blocks you want to refer to must be placed above the database block you want to
1579 =item B<Host> I<Hostname>
1581 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
1582 values. Defaults to the global hostname setting.
1590 =item B<Device> I<Device>
1592 Select partitions based on the devicename.
1594 =item B<MountPoint> I<Directory>
1596 Select partitions based on the mountpoint.
1598 =item B<FSType> I<FSType>
1600 Select partitions based on the filesystem type.
1602 =item B<IgnoreSelected> B<true>|B<false>
1604 Invert the selection: If set to true, all partitions B<except> the ones that
1605 match any one of the criteria are collected. By default only selected
1606 partitions are collected if a selection is made. If no selection is configured
1607 at all, B<all> partitions are selected.
1609 =item B<ReportByDevice> B<true>|B<false>
1611 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1612 (the default), it will report a disk as "root", but with it I<true>, it will be
1613 "sda1" (or whichever).
1615 =item B<ReportInodes> B<true>|B<false>
1617 Enables or disables reporting of free, reserved and used inodes. Defaults to
1618 inode collection being disabled.
1620 Enable this option if inodes are a scarce resource for you, usually because
1621 many small files are stored on the disk. This is a usual scenario for mail
1622 transfer agents and web caches.
1624 =item B<ValuesAbsolute> B<true>|B<false>
1626 Enables or disables reporting of free, used and used disk space in 1K-blocks.
1629 =item B<ValuesPercentage> B<true>|B<false>
1631 Enables or disables reporting of free, used and used disk space in percentage.
1634 This is useful for deploying collectd on the cloud, where machines with
1635 different disk size may exist. Then it is more practical to configure thresholds
1636 based on relative disk size.
1640 =head2 Plugin C<disk>
1642 The C<disk> plugin collects information about the usage of physical disks and
1643 logical disks (partitions). Values collected are the number of octets written
1644 to and read from a disk or partition, the number of read/write operations
1645 issued to the disk and a rather complex "time" it took for these commands to be
1648 Using the following two options you can ignore some disks or configure the
1649 collection only of specific disks.
1653 =item B<Disk> I<Name>
1655 Select the disk I<Name>. Whether it is collected or ignored depends on the
1656 B<IgnoreSelected> setting, see below. As with other plugins that use the
1657 daemon's ignorelist functionality, a string that starts and ends with a slash
1658 is interpreted as a regular expression. Examples:
1663 =item B<IgnoreSelected> B<true>|B<false>
1665 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1666 statements, are ignored or if all other disks are ignored. The behavior
1667 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1668 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1669 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1670 is set to B<true>, all disks are collected B<except> the ones matched.
1674 =head2 Plugin C<dns>
1678 =item B<Interface> I<Interface>
1680 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1681 option sets the interface that should be used. If this option is not set, or
1682 set to "any", the plugin will try to get packets from B<all> interfaces. This
1683 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1685 =item B<IgnoreSource> I<IP-address>
1687 Ignore packets that originate from this address.
1689 =item B<SelectNumericQueryTypes> B<true>|B<false>
1691 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1695 =head2 Plugin C<email>
1699 =item B<SocketFile> I<Path>
1701 Sets the socket-file which is to be created.
1703 =item B<SocketGroup> I<Group>
1705 If running as root change the group of the UNIX-socket after it has been
1706 created. Defaults to B<collectd>.
1708 =item B<SocketPerms> I<Permissions>
1710 Change the file permissions of the UNIX-socket after it has been created. The
1711 permissions must be given as a numeric, octal value as you would pass to
1712 L<chmod(1)>. Defaults to B<0770>.
1714 =item B<MaxConns> I<Number>
1716 Sets the maximum number of connections that can be handled in parallel. Since
1717 this many threads will be started immediately setting this to a very high
1718 value will waste valuable resources. Defaults to B<5> and will be forced to be
1719 at most B<16384> to prevent typos and dumb mistakes.
1723 =head2 Plugin C<ethstat>
1725 The I<ethstat plugin> collects information about network interface cards (NICs)
1726 by talking directly with the underlying kernel driver using L<ioctl(2)>.
1732 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
1733 Map "multicast" "if_multicast"
1740 =item B<Interface> I<Name>
1742 Collect statistical information about interface I<Name>.
1744 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
1746 By default, the plugin will submit values as type C<derive> and I<type
1747 instance> set to I<Name>, the name of the metric as reported by the driver. If
1748 an appropriate B<Map> option exists, the given I<Type> and, optionally,
1749 I<TypeInstance> will be used.
1751 =item B<MappedOnly> B<true>|B<false>
1753 When set to B<true>, only metrics that can be mapped to to a I<type> will be
1754 collected, all other metrics will be ignored. Defaults to B<false>.
1758 =head2 Plugin C<exec>
1760 Please make sure to read L<collectd-exec(5)> before using this plugin. It
1761 contains valuable information on when the executable is executed and the
1762 output that is expected from it.
1766 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1768 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1770 Execute the executable I<Executable> as user I<User>. If the user name is
1771 followed by a colon and a group name, the effective group is set to that group.
1772 The real group and saved-set group will be set to the default group of that
1773 user. If no group is given the effective group ID will be the same as the real
1776 Please note that in order to change the user and/or group the daemon needs
1777 superuser privileges. If the daemon is run as an unprivileged user you must
1778 specify the same user/group here. If the daemon is run with superuser
1779 privileges, you must supply a non-root user here.
1781 The executable may be followed by optional arguments that are passed to the
1782 program. Please note that due to the configuration parsing numbers and boolean
1783 values may be changed. If you want to be absolutely sure that something is
1784 passed as-is please enclose it in quotes.
1786 The B<Exec> and B<NotificationExec> statements change the semantics of the
1787 programs executed, i.E<nbsp>e. the data passed to them and the response
1788 expected from them. This is documented in great detail in L<collectd-exec(5)>.
1792 =head2 Plugin C<filecount>
1794 The C<filecount> plugin counts the number of files in a certain directory (and
1795 its subdirectories) and their combined size. The configuration is very straight
1798 <Plugin "filecount">
1799 <Directory "/var/qmail/queue/mess">
1800 Instance "qmail-message"
1802 <Directory "/var/qmail/queue/todo">
1803 Instance "qmail-todo"
1805 <Directory "/var/lib/php5">
1806 Instance "php5-sessions"
1811 The example above counts the number of files in QMail's queue directories and
1812 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
1813 QMail has not yet looked at, the "message" queue holds the messages that were
1814 classified into "local" and "remote".
1816 As you can see, the configuration consists of one or more C<Directory> blocks,
1817 each of which specifies a directory in which to count the files. Within those
1818 blocks, the following options are recognized:
1822 =item B<Instance> I<Instance>
1824 Sets the plugin instance to I<Instance>. That instance name must be unique, but
1825 it's your responsibility, the plugin doesn't check for that. If not given, the
1826 instance is set to the directory name with all slashes replaced by underscores
1827 and all leading underscores removed.
1829 =item B<Name> I<Pattern>
1831 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
1832 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
1833 against the pattern, not the entire path. In case this makes it easier for you:
1834 This option has been named after the B<-name> parameter to L<find(1)>.
1836 =item B<MTime> I<Age>
1838 Count only files of a specific age: If I<Age> is greater than zero, only files
1839 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
1840 a negative number, this is inversed. For example, if B<-60> is specified, only
1841 files that have been modified in the last minute will be counted.
1843 The number can also be followed by a "multiplier" to easily specify a larger
1844 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
1845 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
1846 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
1847 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
1848 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
1851 =item B<Size> I<Size>
1853 Count only files of a specific size. When I<Size> is a positive number, only
1854 files that are at least this big are counted. If I<Size> is a negative number,
1855 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
1856 I<Size> are counted.
1858 As with the B<MTime> option, a "multiplier" may be added. For a detailed
1859 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
1860 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
1861 note that there are 1000 bytes in a kilobyte, not 1024.
1863 =item B<Recursive> I<true>|I<false>
1865 Controls whether or not to recurse into subdirectories. Enabled by default.
1867 =item B<IncludeHidden> I<true>|I<false>
1869 Controls whether or not to include "hidden" files and directories in the count.
1870 "Hidden" files and directories are those, whose name begins with a dot.
1871 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
1875 =head2 Plugin C<GenericJMX>
1877 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
1878 L<collectd-java(5)>.
1880 =head2 Plugin C<gmond>
1882 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
1883 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
1884 are built-in, custom mappings may be added via B<Metric> blocks, see below.
1889 MCReceiveFrom "239.2.11.71" "8649"
1890 <Metric "swap_total">
1892 TypeInstance "total"
1895 <Metric "swap_free">
1902 The following metrics are built-in:
1908 load_one, load_five, load_fifteen
1912 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
1916 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
1928 Available configuration options:
1932 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
1934 Sets sets the multicast group and UDP port to which to subscribe.
1936 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
1938 =item E<lt>B<Metric> I<Name>E<gt>
1940 These blocks add a new metric conversion to the internal table. I<Name>, the
1941 string argument to the B<Metric> block, is the metric name as used by Ganglia.
1945 =item B<Type> I<Type>
1947 Type to map this metric to. Required.
1949 =item B<TypeInstance> I<Instance>
1951 Type-instance to use. Optional.
1953 =item B<DataSource> I<Name>
1955 Data source to map this metric to. If the configured type has exactly one data
1956 source, this is optional. Otherwise the option is required.
1962 =head2 Plugin C<hddtemp>
1964 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
1965 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
1966 default values, see below. C<hddtemp> has to be running to work correctly. If
1967 C<hddtemp> is not running timeouts may appear which may interfere with other
1970 The B<hddtemp> homepage can be found at
1971 L<http://www.guzu.net/linux/hddtemp.php>.
1975 =item B<Host> I<Hostname>
1977 Hostname to connect to. Defaults to B<127.0.0.1>.
1979 =item B<Port> I<Port>
1981 TCP-Port to connect to. Defaults to B<7634>.
1985 =head2 Plugin C<interface>
1989 =item B<Interface> I<Interface>
1991 Select this interface. By default these interfaces will then be collected. For
1992 a more detailed description see B<IgnoreSelected> below.
1994 =item B<IgnoreSelected> I<true>|I<false>
1996 If no configuration if given, the B<traffic>-plugin will collect data from
1997 all interfaces. This may not be practical, especially for loopback- and
1998 similar interfaces. Thus, you can use the B<Interface>-option to pick the
1999 interfaces you're interested in. Sometimes, however, it's easier/preferred
2000 to collect all interfaces I<except> a few ones. This option enables you to
2001 do that: By setting B<IgnoreSelected> to I<true> the effect of
2002 B<Interface> is inverted: All selected interfaces are ignored and all
2003 other interfaces are collected.
2005 It is possible to use regular expressions to match interface names, if the
2006 name is surrounded by I</.../> and collectd was compiled with support for
2007 regexps. This is useful if there's a need to collect (or ignore) data
2008 for a group of interfaces that are similarly named, without the need to
2009 explicitly list all of them (especially useful if the list is dynamic).
2014 Interface "/^tun[0-9]+/"
2015 IgnoreSelected "true"
2017 This will ignore the loopback interface, all interfaces with names starting
2018 with I<veth> and all interfaces with names starting with I<tun> followed by
2024 =head2 Plugin C<ipmi>
2028 =item B<Sensor> I<Sensor>
2030 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2032 =item B<IgnoreSelected> I<true>|I<false>
2034 If no configuration if given, the B<ipmi> plugin will collect data from all
2035 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2036 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2037 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2038 all other sensors are collected.
2040 =item B<NotifySensorAdd> I<true>|I<false>
2042 If a sensor appears after initialization time of a minute a notification
2045 =item B<NotifySensorRemove> I<true>|I<false>
2047 If a sensor disappears a notification is sent.
2049 =item B<NotifySensorNotPresent> I<true>|I<false>
2051 If you have for example dual power supply and one of them is (un)plugged then
2052 a notification is sent.
2056 =head2 Plugin C<iptables>
2060 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2062 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2064 Select the iptables/ip6tables filter rules to count packets and bytes from.
2066 If only I<Table> and I<Chain> are given, this plugin will collect the counters
2067 of all rules which have a comment-match. The comment is then used as
2070 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2071 the I<n>th rule will be collected. Again, the comment (or the number) will be
2072 used as the type-instance.
2074 If I<Name> is supplied, it will be used as the type-instance instead of the
2075 comment or the number.
2079 =head2 Plugin C<irq>
2085 Select this irq. By default these irqs will then be collected. For a more
2086 detailed description see B<IgnoreSelected> below.
2088 =item B<IgnoreSelected> I<true>|I<false>
2090 If no configuration if given, the B<irq>-plugin will collect data from all
2091 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2092 can use the B<Irq>-option to pick the interrupt you're interested in.
2093 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2094 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2095 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2096 and all other interrupts are collected.
2100 =head2 Plugin C<java>
2102 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2103 This section only discusses the syntax and semantic of the configuration
2104 options. For more in-depth information on the I<Java> plugin, please read
2105 L<collectd-java(5)>.
2110 JVMArg "-verbose:jni"
2111 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2112 LoadPlugin "org.collectd.java.Foobar"
2113 <Plugin "org.collectd.java.Foobar">
2114 # To be parsed by the plugin
2118 Available configuration options:
2122 =item B<JVMArg> I<Argument>
2124 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2125 exactly the way the arguments to the I<java> binary on the command line work.
2126 Execute C<javaE<nbsp>--help> for details.
2128 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2129 any other options! When another option is found, the JVM will be started and
2130 later options will have to be ignored!
2132 =item B<LoadPlugin> I<JavaClass>
2134 Instantiates a new I<JavaClass> object. The constructor of this object very
2135 likely then registers one or more callback methods with the server.
2137 See L<collectd-java(5)> for details.
2139 When the first such option is found, the virtual machine (JVM) is created. This
2140 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2141 B<LoadPlugin> options!
2143 =item B<Plugin> I<Name>
2145 The entire block is passed to the Java plugin as an
2146 I<org.collectd.api.OConfigItem> object.
2148 For this to work, the plugin has to register a configuration callback first,
2149 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2150 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2151 depends on the (Java) plugin registering the callback and is completely
2152 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2156 =head2 Plugin C<libvirt>
2158 This plugin allows CPU, disk and network load to be collected for virtualized
2159 guests on the machine. This means that these characteristics can be collected
2160 for guest systems without installing any software on them - collectd only runs
2161 on the hosting system. The statistics are collected through libvirt
2162 (L<http://libvirt.org/>).
2164 Only I<Connection> is required.
2168 =item B<Connection> I<uri>
2170 Connect to the hypervisor given by I<uri>. For example if using Xen use:
2172 Connection "xen:///"
2174 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
2176 =item B<RefreshInterval> I<seconds>
2178 Refresh the list of domains and devices every I<seconds>. The default is 60
2179 seconds. Setting this to be the same or smaller than the I<Interval> will cause
2180 the list of domains and devices to be refreshed on every iteration.
2182 Refreshing the devices in particular is quite a costly operation, so if your
2183 virtualization setup is static you might consider increasing this. If this
2184 option is set to 0, refreshing is disabled completely.
2186 =item B<Domain> I<name>
2188 =item B<BlockDevice> I<name:dev>
2190 =item B<InterfaceDevice> I<name:dev>
2192 =item B<IgnoreSelected> I<true>|I<false>
2194 Select which domains and devices are collected.
2196 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
2197 disk/network devices are collected.
2199 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
2200 domains and disk/network devices are ignored, while the rest are collected.
2202 The domain name and device names may use a regular expression, if the name is
2203 surrounded by I</.../> and collectd was compiled with support for regexps.
2205 The default is to collect statistics for all domains and all their devices.
2209 BlockDevice "/:hdb/"
2210 IgnoreSelected "true"
2212 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
2215 =item B<HostnameFormat> B<name|uuid|hostname|...>
2217 When the libvirt plugin logs data, it sets the hostname of the collected data
2218 according to this setting. The default is to use the guest name as provided by
2219 the hypervisor, which is equal to setting B<name>.
2221 B<uuid> means use the guest's UUID. This is useful if you want to track the
2222 same guest across migrations.
2224 B<hostname> means to use the global B<Hostname> setting, which is probably not
2225 useful on its own because all guests will appear to have the same name.
2227 You can also specify combinations of these fields. For example B<name uuid>
2228 means to concatenate the guest name and UUID (with a literal colon character
2229 between, thus I<"foo:1234-1234-1234-1234">).
2231 =item B<InterfaceFormat> B<name>|B<address>
2233 When the libvirt plugin logs interface data, it sets the name of the collected
2234 data according to this setting. The default is to use the path as provided by
2235 the hypervisor (the "dev" property of the target node), which is equal to
2238 B<address> means use the interface's mac address. This is useful since the
2239 interface path might change between reboots of a guest or across migrations.
2243 =head2 Plugin C<logfile>
2247 =item B<LogLevel> B<debug|info|notice|warning|err>
2249 Sets the log-level. If, for example, set to B<notice>, then all events with
2250 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2252 Please note that B<debug> is only available if collectd has been compiled with
2255 =item B<File> I<File>
2257 Sets the file to write log messages to. The special strings B<stdout> and
2258 B<stderr> can be used to write to the standard output and standard error
2259 channels, respectively. This, of course, only makes much sense when I<collectd>
2260 is running in foreground- or non-daemon-mode.
2262 =item B<Timestamp> B<true>|B<false>
2264 Prefix all lines printed by the current time. Defaults to B<true>.
2266 =item B<PrintSeverity> B<true>|B<false>
2268 When enabled, all lines are prefixed by the severity of the log message, for
2269 example "warning". Defaults to B<false>.
2273 B<Note>: There is no need to notify the daemon after moving or removing the
2274 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2275 for each line it writes.
2277 =head2 Plugin C<lpar>
2279 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2280 virtualization technique for IBM POWER processors. It takes into account CPU
2281 time stolen from or donated to a partition, in addition to the usual user,
2282 system, I/O statistics.
2284 The following configuration options are available:
2288 =item B<CpuPoolStats> B<false>|B<true>
2290 When enabled, statistics about the processor pool are read, too. The partition
2291 needs to have pool authority in order to be able to acquire this information.
2294 =item B<ReportBySerial> B<false>|B<true>
2296 If enabled, the serial of the physical machine the partition is currently
2297 running on is reported as I<hostname> and the logical hostname of the machine
2298 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2299 used (just like other plugins) and the I<plugin instance> will be empty.
2304 =head2 Plugin C<mbmon>
2306 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2308 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2309 B<Host> and B<Port> options can be used to change these values, see below.
2310 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2311 timeouts may appear which may interfere with other statistics..
2313 C<mbmon> must be run with the -r option ("print TAG and Value format");
2314 Debian's F</etc/init.d/mbmon> script already does this, other people
2315 will need to ensure that this is the case.
2319 =item B<Host> I<Hostname>
2321 Hostname to connect to. Defaults to B<127.0.0.1>.
2323 =item B<Port> I<Port>
2325 TCP-Port to connect to. Defaults to B<411>.
2331 The C<md plugin> collects information from Linux Software-RAID devices (md).
2333 All reported values are of the type C<md_disks>. Reported type instances are
2334 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2335 I<missing> (physically absent) disks.
2339 =item B<Device> I<Device>
2341 Select md devices based on device name. The I<device name> is the basename of
2342 the device, i.e. the name of the block device without the leading C</dev/>.
2343 See B<IgnoreSelected> for more details.
2345 =item B<IgnoreSelected> B<true>|B<false>
2347 Invert device selection: If set to B<true>, all md devices B<except> those
2348 listed using B<Device> are collected. If B<false> (the default), only those
2349 listed are collected. If no configuration is given, the B<md> plugin will
2350 collect data from all md devices.
2354 =head2 Plugin C<memcachec>
2356 The C<memcachec plugin> connects to a memcached server, queries one or more
2357 given I<pages> and parses the returned data according to user specification.
2358 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2361 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2362 library. Please note that there is another library with a very similar name,
2363 libmemcache (notice the missing `d'), which is not applicable.
2365 Synopsis of the configuration:
2367 <Plugin "memcachec">
2368 <Page "plugin_instance">
2372 Regex "(\\d+) bytes sent"
2375 Instance "type_instance"
2380 The configuration options are:
2384 =item E<lt>B<Page> I<Name>E<gt>
2386 Each B<Page> block defines one I<page> to be queried from the memcached server.
2387 The block requires one string argument which is used as I<plugin instance>.
2389 =item B<Server> I<Address>
2391 Sets the server address to connect to when querying the page. Must be inside a
2396 When connected to the memcached server, asks for the page I<Key>.
2398 =item E<lt>B<Match>E<gt>
2400 Match blocks define which strings to look for and how matches substrings are
2401 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2405 =head2 Plugin C<memcached>
2407 The B<memcached plugin> connects to a memcached server and queries statistics
2408 about cache utilization, memory and bandwidth used.
2409 L<http://www.danga.com/memcached/>
2411 <Plugin "memcached">
2413 Host "memcache.example.com"
2418 The plugin configuration consists of one or more B<Instance> blocks which
2419 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2420 following options are allowed:
2424 =item B<Host> I<Hostname>
2426 Hostname to connect to. Defaults to B<127.0.0.1>.
2428 =item B<Port> I<Port>
2430 TCP-Port to connect to. Defaults to B<11211>.
2432 =item B<Socket> I<Path>
2434 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2435 setting is given, the B<Host> and B<Port> settings are ignored.
2439 =head2 Plugin C<mic>
2441 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2442 Intel's Many Integrated Core (MIC) systems.
2451 ShowTemperatures true
2454 IgnoreSelectedTemperature true
2459 IgnoreSelectedPower true
2462 The following options are valid inside the B<PluginE<nbsp>mic> block:
2466 =item B<ShowCPU> B<true>|B<false>
2468 If enabled (the default) a sum of the CPU usage accross all cores is reported.
2470 =item B<ShowCPUCores> B<true>|B<false>
2472 If enabled (the default) per-core CPU usage is reported.
2474 =item B<ShowMemory> B<true>|B<false>
2476 If enabled (the default) the physical memory usage of the MIC system is
2479 =item B<ShowTemperatures> B<true>|B<false>
2481 If enabled (the default) various temperatures of the MIC system are reported.
2483 =item B<Temperature> I<Name>
2485 This option controls which temperatures are being reported. Whether matching
2486 temperatures are being ignored or I<only> matching temperatures are reported
2487 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2488 temperatures are reported.
2490 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2492 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2493 (the default) only temperatures matching a B<Temperature> option are reported
2494 or, if no B<Temperature> option is specified, all temperatures are reported. If
2495 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2498 Known temperature names are:
2532 =item B<ShowPower> B<true>|B<false>
2534 If enabled (the default) various temperatures of the MIC system are reported.
2536 =item B<Power> I<Name>
2538 This option controls which power readings are being reported. Whether matching
2539 power readings are being ignored or I<only> matching power readings are reported
2540 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
2541 power readings are reported.
2543 =item B<IgnoreSelectedPower> B<false>|B<true>
2545 Controls the behavior of the B<Power> setting above. If set to B<false>
2546 (the default) only power readings matching a B<Power> option are reported
2547 or, if no B<Power> option is specified, all power readings are reported. If
2548 set to B<true>, matching power readings are I<ignored> and all other power readings
2551 Known power names are:
2557 Total power utilization averaged over Time Window 0 (uWatts).
2561 Total power utilization averaged over Time Window 0 (uWatts).
2565 Instantaneous power (uWatts).
2569 Max instantaneous power (uWatts).
2573 PCI-E connector power (uWatts).
2577 2x3 connector power (uWatts).
2581 2x4 connector power (uWatts).
2589 Uncore rail (uVolts).
2593 Memory subsystem rail (uVolts).
2599 =head2 Plugin C<modbus>
2601 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
2602 register values. It supports reading single registers (unsigned 16E<nbsp>bit
2603 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2604 values (two registers interpreted as IEEE floats in big endian notation).
2608 <Data "voltage-input-1">
2615 <Data "voltage-input-2">
2622 <Host "modbus.example.com">
2623 Address "192.168.0.42"
2628 Instance "power-supply"
2629 Collect "voltage-input-1"
2630 Collect "voltage-input-2"
2636 =item E<lt>B<Data> I<Name>E<gt> blocks
2638 Data blocks define a mapping between register numbers and the "types" used by
2641 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
2645 =item B<RegisterBase> I<Number>
2647 Configures the base register to read from the device. If the option
2648 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
2649 register will be read (the register number is increased by one).
2651 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
2653 Specifies what kind of data is returned by the device. If the type is B<Int32>,
2654 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
2655 combined into one value. Defaults to B<Uint16>.
2657 =item B<Type> I<Type>
2659 Specifies the "type" (data set) to use when dispatching the value to
2660 I<collectd>. Currently, only data sets with exactly one data source are
2663 =item B<Instance> I<Instance>
2665 Sets the type instance to use when dispatching the value to I<collectd>. If
2666 unset, an empty string (no type instance) is used.
2670 =item E<lt>B<Host> I<Name>E<gt> blocks
2672 Host blocks are used to specify to which hosts to connect and what data to read
2673 from their "slaves". The string argument I<Name> is used as hostname when
2674 dispatching the values to I<collectd>.
2676 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
2680 =item B<Address> I<Hostname>
2682 Specifies the node name (the actual network address) used to connect to the
2683 host. This may be an IP address or a hostname. Please note that the used
2684 I<libmodbus> library only supports IPv4 at the moment.
2686 =item B<Port> I<Service>
2688 Specifies the port used to connect to the host. The port can either be given as
2689 a number or as a service name. Please note that the I<Service> argument must be
2690 a string, even if ports are given in their numerical form. Defaults to "502".
2692 =item B<Interval> I<Interval>
2694 Sets the interval (in seconds) in which the values will be collected from this
2695 host. By default the global B<Interval> setting will be used.
2697 =item E<lt>B<Slave> I<ID>E<gt>
2699 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
2700 is used to specify which device should be addressed. For each device you want
2701 to query, one B<Slave> block must be given.
2703 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
2707 =item B<Instance> I<Instance>
2709 Specify the plugin instance to use when dispatching the values to I<collectd>.
2710 By default "slave_I<ID>" is used.
2712 =item B<Collect> I<DataName>
2714 Specifies which data to retrieve from the device. I<DataName> must be the same
2715 string as the I<Name> argument passed to a B<Data> block. You can specify this
2716 option multiple times to collect more than one value from a slave. At least one
2717 B<Collect> option is mandatory.
2725 =head2 Plugin C<mysql>
2727 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
2728 one or more databases when started and keeps the connection up as long as
2729 possible. When the connection is interrupted for whatever reason it will try
2730 to re-connect. The plugin will complain loudly in case anything goes wrong.
2732 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
2733 and collects information about MySQL network traffic, executed statements,
2734 requests, the query cache and threads by evaluating the
2735 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
2736 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
2737 Status Variables> for an explanation of these values.
2739 Optionally, master and slave statistics may be collected in a MySQL
2740 replication setup. In that case, information about the synchronization state
2741 of the nodes are collected by evaluating the C<Position> return value of the
2742 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
2743 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
2744 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
2745 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
2746 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
2761 Socket "/var/run/mysql/mysqld.sock"
2763 SlaveNotifications true
2767 A B<Database> block defines one connection to a MySQL database. It accepts a
2768 single argument which specifies the name of the database. None of the other
2769 options are required. MySQL will use default values as documented in the
2770 section "mysql_real_connect()" in the B<MySQL reference manual>.
2774 =item B<Host> I<Hostname>
2776 Hostname of the database server. Defaults to B<localhost>.
2778 =item B<User> I<Username>
2780 Username to use when connecting to the database. The user does not have to be
2781 granted any privileges (which is synonym to granting the C<USAGE> privilege),
2782 unless you want to collectd replication statistics (see B<MasterStats> and
2783 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
2784 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
2786 =item B<Password> I<Password>
2788 Password needed to log into the database.
2790 =item B<Database> I<Database>
2792 Select this database. Defaults to I<no database> which is a perfectly reasonable
2793 option for what this plugin does.
2795 =item B<Port> I<Port>
2797 TCP-port to connect to. The port must be specified in its numeric form, but it
2798 must be passed as a string nonetheless. For example:
2802 If B<Host> is set to B<localhost> (the default), this setting has no effect.
2803 See the documentation for the C<mysql_real_connect> function for details.
2805 =item B<Socket> I<Socket>
2807 Specifies the path to the UNIX domain socket of the MySQL server. This option
2808 only has any effect, if B<Host> is set to B<localhost> (the default).
2809 Otherwise, use the B<Port> option above. See the documentation for the
2810 C<mysql_real_connect> function for details.
2812 =item B<MasterStats> I<true|false>
2814 =item B<SlaveStats> I<true|false>
2816 Enable the collection of master / slave statistics in a replication setup. In
2817 order to be able to get access to these statistics, the user needs special
2818 privileges. See the B<User> documentation above. Defaults to B<false>.
2820 =item B<SlaveNotifications> I<true|false>
2822 If enabled, the plugin sends a notification if the replication slave I/O and /
2823 or SQL threads are not running. Defaults to B<false>.
2827 =head2 Plugin C<netapp>
2829 The netapp plugin can collect various performance and capacity information
2830 from a NetApp filer using the NetApp API.
2832 Please note that NetApp has a wide line of products and a lot of different
2833 software versions for each of these products. This plugin was developed for a
2834 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
2835 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
2836 model and software version but it is very hard to test this.
2837 If you have used this plugin with other models and/or software version, feel
2838 free to send us a mail to tell us about the results, even if it's just a short
2841 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
2842 basic authentication.
2844 B<Do not use a regular user for this!> Create a special collectd user with just
2845 the minimum of capabilities needed. The user only needs the "login-http-admin"
2846 capability as well as a few more depending on which data will be collected.
2847 Required capabilities are documented below.
2852 <Host "netapp1.example.com">
2876 IgnoreSelectedIO false
2878 IgnoreSelectedOps false
2879 GetLatency "volume0"
2880 IgnoreSelectedLatency false
2887 IgnoreSelectedCapacity false
2890 IgnoreSelectedSnapshot false
2918 The netapp plugin accepts the following configuration options:
2922 =item B<Host> I<Name>
2924 A host block defines one NetApp filer. It will appear in collectd with the name
2925 you specify here which does not have to be its real name nor its hostname (see
2926 the B<Address> option below).
2928 =item B<VFiler> I<Name>
2930 A B<VFiler> block may only be used inside a host block. It accepts all the
2931 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
2932 will execute all NetApp API commands in the context of the specified
2933 VFiler(R). It will appear in collectd with the name you specify here which
2934 does not have to be its real name. The VFiler name may be specified using the
2935 B<VFilerName> option. If this is not specified, it will default to the name
2938 The VFiler block inherits all connection related settings from the surrounding
2939 B<Host> block (which appear before the B<VFiler> block) but they may be
2940 overwritten inside the B<VFiler> block.
2942 This feature is useful, for example, when using a VFiler as SnapVault target
2943 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
2944 available in the host filer (vfiler0) but only in the respective VFiler
2947 =item B<Protocol> B<httpd>|B<http>
2949 The protocol collectd will use to query this host.
2957 Valid options: http, https
2959 =item B<Address> I<Address>
2961 The hostname or IP address of the host.
2967 Default: The "host" block's name.
2969 =item B<Port> I<Port>
2971 The TCP port to connect to on the host.
2977 Default: 80 for protocol "http", 443 for protocol "https"
2979 =item B<User> I<User>
2981 =item B<Password> I<Password>
2983 The username and password to use to login to the NetApp.
2989 =item B<VFilerName> I<Name>
2991 The name of the VFiler in which context to execute API commands. If not
2992 specified, the name provided to the B<VFiler> block will be used instead.
2998 Default: name of the B<VFiler> block
3000 B<Note:> This option may only be used inside B<VFiler> blocks.
3002 =item B<Interval> I<Interval>
3008 The following options decide what kind of data will be collected. You can
3009 either use them as a block and fine tune various parameters inside this block,
3010 use them as a single statement to just accept all default values, or omit it to
3011 not collect any data.
3013 The following options are valid inside all blocks:
3017 =item B<Interval> I<Seconds>
3019 Collect the respective statistics every I<Seconds> seconds. Defaults to the
3020 host specific setting.
3024 =head3 The System block
3026 This will collect various performance data about the whole system.
3028 B<Note:> To get this data the collectd user needs the
3029 "api-perf-object-get-instances" capability.
3033 =item B<Interval> I<Seconds>
3035 Collect disk statistics every I<Seconds> seconds.
3037 =item B<GetCPULoad> B<true>|B<false>
3039 If you set this option to true the current CPU usage will be read. This will be
3040 the average usage between all CPUs in your NetApp without any information about
3043 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3044 returns in the "CPU" field.
3052 Result: Two value lists of type "cpu", and type instances "idle" and "system".
3054 =item B<GetInterfaces> B<true>|B<false>
3056 If you set this option to true the current traffic of the network interfaces
3057 will be read. This will be the total traffic over all interfaces of your NetApp
3058 without any information about individual interfaces.
3060 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3061 in the "Net kB/s" field.
3071 Result: One value list of type "if_octects".
3073 =item B<GetDiskIO> B<true>|B<false>
3075 If you set this option to true the current IO throughput will be read. This
3076 will be the total IO of your NetApp without any information about individual
3077 disks, volumes or aggregates.
3079 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3080 in the "DiskE<nbsp>kB/s" field.
3088 Result: One value list of type "disk_octets".
3090 =item B<GetDiskOps> B<true>|B<false>
3092 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
3093 iSCSI, etc. operations will be read. This will be the total number of
3094 operations on your NetApp without any information about individual volumes or
3097 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3098 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
3106 Result: A variable number of value lists of type "disk_ops_complex". Each type
3107 of operation will result in one value list with the name of the operation as
3112 =head3 The WAFL block
3114 This will collect various performance data about the WAFL file system. At the
3115 moment this just means cache performance.
3117 B<Note:> To get this data the collectd user needs the
3118 "api-perf-object-get-instances" capability.
3120 B<Note:> The interface to get these values is classified as "Diagnostics" by
3121 NetApp. This means that it is not guaranteed to be stable even between minor
3126 =item B<Interval> I<Seconds>
3128 Collect disk statistics every I<Seconds> seconds.
3130 =item B<GetNameCache> B<true>|B<false>
3138 Result: One value list of type "cache_ratio" and type instance
3141 =item B<GetDirCache> B<true>|B<false>
3149 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3151 =item B<GetInodeCache> B<true>|B<false>
3159 Result: One value list of type "cache_ratio" and type instance
3162 =item B<GetBufferCache> B<true>|B<false>
3164 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3165 in the "Cache hit" field.
3173 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3177 =head3 The Disks block
3179 This will collect performance data about the individual disks in the NetApp.
3181 B<Note:> To get this data the collectd user needs the
3182 "api-perf-object-get-instances" capability.
3186 =item B<Interval> I<Seconds>
3188 Collect disk statistics every I<Seconds> seconds.
3190 =item B<GetBusy> B<true>|B<false>
3192 If you set this option to true the busy time of all disks will be calculated
3193 and the value of the busiest disk in the system will be written.
3195 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3196 in the "Disk util" field. Probably.
3204 Result: One value list of type "percent" and type instance "disk_busy".
3208 =head3 The VolumePerf block
3210 This will collect various performance data about the individual volumes.
3212 You can select which data to collect about which volume using the following
3213 options. They follow the standard ignorelist semantic.
3215 B<Note:> To get this data the collectd user needs the
3216 I<api-perf-object-get-instances> capability.
3220 =item B<Interval> I<Seconds>
3222 Collect volume performance data every I<Seconds> seconds.
3224 =item B<GetIO> I<Volume>
3226 =item B<GetOps> I<Volume>
3228 =item B<GetLatency> I<Volume>
3230 Select the given volume for IO, operations or latency statistics collection.
3231 The argument is the name of the volume without the C</vol/> prefix.
3233 Since the standard ignorelist functionality is used here, you can use a string
3234 starting and ending with a slash to specify regular expression matching: To
3235 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3238 GetIO "/^vol[027]$/"
3240 If no regular expression is specified, an exact match is required. Both,
3241 regular and exact matching are case sensitive.
3243 If no volume was specified at all for either of the three options, that data
3244 will be collected for all available volumes.
3246 =item B<IgnoreSelectedIO> B<true>|B<false>
3248 =item B<IgnoreSelectedOps> B<true>|B<false>
3250 =item B<IgnoreSelectedLatency> B<true>|B<false>
3252 When set to B<true>, the volumes selected for IO, operations or latency
3253 statistics collection will be ignored and the data will be collected for all
3256 When set to B<false>, data will only be collected for the specified volumes and
3257 all other volumes will be ignored.
3259 If no volumes have been specified with the above B<Get*> options, all volumes
3260 will be collected regardless of the B<IgnoreSelected*> option.
3262 Defaults to B<false>
3266 =head3 The VolumeUsage block
3268 This will collect capacity data about the individual volumes.
3270 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3275 =item B<Interval> I<Seconds>
3277 Collect volume usage statistics every I<Seconds> seconds.
3279 =item B<GetCapacity> I<VolumeName>
3281 The current capacity of the volume will be collected. This will result in two
3282 to four value lists, depending on the configuration of the volume. All data
3283 sources are of type "df_complex" with the name of the volume as
3286 There will be type_instances "used" and "free" for the number of used and
3287 available bytes on the volume. If the volume has some space reserved for
3288 snapshots, a type_instance "snap_reserved" will be available. If the volume
3289 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3290 number of bytes saved by the SIS feature.
3292 B<Note:> The current NetApp API has a bug that results in this value being
3293 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3294 number which works most of the time. If you see strange values here, bug
3295 NetApp support to fix this.
3297 Repeat this option to specify multiple volumes.
3299 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3301 Specify whether to collect only the volumes selected by the B<GetCapacity>
3302 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3303 B<false>. However, if no B<GetCapacity> option is specified at all, all
3304 capacities will be selected anyway.
3306 =item B<GetSnapshot> I<VolumeName>
3308 Select volumes from which to collect snapshot information.
3310 Usually, the space used for snapshots is included in the space reported as
3311 "used". If snapshot information is collected as well, the space used for
3312 snapshots is subtracted from the used space.
3314 To make things even more interesting, it is possible to reserve space to be
3315 used for snapshots. If the space required for snapshots is less than that
3316 reserved space, there is "reserved free" and "reserved used" space in addition
3317 to "free" and "used". If the space required for snapshots exceeds the reserved
3318 space, that part allocated in the normal space is subtracted from the "used"
3321 Repeat this option to specify multiple volumes.
3323 =item B<IgnoreSelectedSnapshot>
3325 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3326 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3327 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3328 capacities will be selected anyway.
3332 =head3 The Quota block
3334 This will collect (tree) quota statistics (used disk space and number of used
3335 files). This mechanism is useful to get usage information for single qtrees.
3336 In case the quotas are not used for any other purpose, an entry similar to the
3337 following in C</etc/quotas> would be sufficient:
3339 /vol/volA/some_qtree tree - - - - -
3341 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3345 =item B<Interval> I<Seconds>
3347 Collect SnapVault(R) statistics every I<Seconds> seconds.
3351 =head3 The SnapVault block
3353 This will collect statistics about the time and traffic of SnapVault(R)
3358 =item B<Interval> I<Seconds>
3360 Collect SnapVault(R) statistics every I<Seconds> seconds.
3364 =head2 Plugin C<netlink>
3366 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3367 statistics of various interface and routing aspects.
3371 =item B<Interface> I<Interface>
3373 =item B<VerboseInterface> I<Interface>
3375 Instruct the plugin to collect interface statistics. This is basically the same
3376 as the statistics provided by the C<interface> plugin (see above) but
3377 potentially much more detailed.
3379 When configuring with B<Interface> only the basic statistics will be collected,
3380 namely octets, packets, and errors. These statistics are collected by
3381 the C<interface> plugin, too, so using both at the same time is no benefit.
3383 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3384 so that no data needs to be collected twice if you use the C<interface> plugin.
3385 This includes dropped packets, received multicast packets, collisions and a
3386 whole zoo of differentiated RX and TX errors. You can try the following command
3387 to get an idea of what awaits you:
3391 If I<Interface> is B<All>, all interfaces will be selected.
3393 =item B<QDisc> I<Interface> [I<QDisc>]
3395 =item B<Class> I<Interface> [I<Class>]
3397 =item B<Filter> I<Interface> [I<Filter>]
3399 Collect the octets and packets that pass a certain qdisc, class or filter.
3401 QDiscs and classes are identified by their type and handle (or classid).
3402 Filters don't necessarily have a handle, therefore the parent's handle is used.
3403 The notation used in collectd differs from that used in tc(1) in that it
3404 doesn't skip the major or minor number if it's zero and doesn't print special
3405 ids by their name. So, for example, a qdisc may be identified by
3406 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3407 thus not displayed by tc(1).
3409 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3410 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3411 associated with that interface will be collected.
3413 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3414 used. This may lead to problems when more than one filter is attached to a
3415 qdisc or class. This isn't nice, but we don't know how this could be done any
3416 better. If you have a idea, please don't hesitate to tell us.
3418 As with the B<Interface> option you can specify B<All> as the interface,
3419 meaning all interfaces.
3421 Here are some examples to help you understand the above text more easily:
3424 VerboseInterface "All"
3425 QDisc "eth0" "pfifo_fast-1:0"
3427 Class "ppp0" "htb-1:10"
3428 Filter "ppp0" "u32-1:0"
3431 =item B<IgnoreSelected>
3433 The behavior is the same as with all other similar plugins: If nothing is
3434 selected at all, everything is collected. If some things are selected using the
3435 options described above, only these statistics are collected. If you set
3436 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3437 specified statistics will not be collected.
3441 =head2 Plugin C<network>
3443 The Network plugin sends data to a remote instance of collectd, receives data
3444 from a remote instance, or both at the same time. Data which has been received
3445 from the network is usually not transmitted again, but this can be activated, see
3446 the B<Forward> option below.
3448 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3449 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3451 Both, B<Server> and B<Listen> can be used as single option or as block. When
3452 used as block, given options are valid for this socket only. The following
3453 example will export the metrics twice: Once to an "internal" server (without
3454 encryption and signing) and one to an external server (with cryptographic
3458 # Export to an internal server
3459 # (demonstrates usage without additional options)
3460 Server "collectd.internal.tld"
3462 # Export to an external server
3463 # (demonstrates usage with signature options)
3464 <Server "collectd.external.tld">
3465 SecurityLevel "sign"
3466 Username "myhostname"
3473 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3475 The B<Server> statement/block sets the server to send datagrams to. The
3476 statement may occur multiple times to send each datagram to multiple
3479 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3480 optional second argument specifies a port number or a service name. If not
3481 given, the default, B<25826>, is used.
3483 The following options are recognized within B<Server> blocks:
3487 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3489 Set the security you require for network communication. When the security level
3490 has been set to B<Encrypt>, data sent over the network will be encrypted using
3491 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3492 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3493 authentication code. When set to B<None>, data is sent without any security.
3495 This feature is only available if the I<network> plugin was linked with
3498 =item B<Username> I<Username>
3500 Sets the username to transmit. This is used by the server to lookup the
3501 password. See B<AuthFile> below. All security levels except B<None> require
3504 This feature is only available if the I<network> plugin was linked with
3507 =item B<Password> I<Password>
3509 Sets a password (shared secret) for this socket. All security levels except
3510 B<None> require this setting.
3512 This feature is only available if the I<network> plugin was linked with
3515 =item B<Interface> I<Interface name>
3517 Set the outgoing interface for IP packets. This applies at least
3518 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3519 undefined or a non-existent interface name is specified, the default
3520 behavior is to let the kernel choose the appropriate interface. Be warned
3521 that the manual selection of an interface for unicast traffic is only
3522 necessary in rare cases.
3526 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
3528 The B<Listen> statement sets the interfaces to bind to. When multiple
3529 statements are found the daemon will bind to multiple interfaces.
3531 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
3532 the argument is a multicast address the daemon will join that multicast group.
3533 The optional second argument specifies a port number or a service name. If not
3534 given, the default, B<25826>, is used.
3536 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
3540 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3542 Set the security you require for network communication. When the security level
3543 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
3544 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
3545 signed and encrypted data is accepted. When set to B<None>, all data will be
3546 accepted. If an B<AuthFile> option was given (see below), encrypted data is
3547 decrypted if possible.
3549 This feature is only available if the I<network> plugin was linked with
3552 =item B<AuthFile> I<Filename>
3554 Sets a file in which usernames are mapped to passwords. These passwords are
3555 used to verify signatures and to decrypt encrypted network packets. If
3556 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
3557 verified and encrypted packets are decrypted. Otherwise, signed data is
3558 accepted without checking the signature and encrypted data cannot be decrypted.
3559 For the other security levels this option is mandatory.
3561 The file format is very simple: Each line consists of a username followed by a
3562 colon and any number of spaces followed by the password. To demonstrate, an
3563 example file could look like this:
3568 Each time a packet is received, the modification time of the file is checked
3569 using L<stat(2)>. If the file has been changed, the contents is re-read. While
3570 the file is being read, it is locked using L<fcntl(2)>.
3572 =item B<Interface> I<Interface name>
3574 Set the incoming interface for IP packets explicitly. This applies at least
3575 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3576 undefined or a non-existent interface name is specified, the default
3577 behavior is, to let the kernel choose the appropriate interface. Thus incoming
3578 traffic gets only accepted, if it arrives on the given interface.
3582 =item B<TimeToLive> I<1-255>
3584 Set the time-to-live of sent packets. This applies to all, unicast and
3585 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
3586 That means that multicast packets will be sent with a TTL of C<1> (one) on most
3589 =item B<MaxPacketSize> I<1024-65535>
3591 Set the maximum size for datagrams received over the network. Packets larger
3592 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
3593 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
3596 On the server side, this limit should be set to the largest value used on
3597 I<any> client. Likewise, the value on the client must not be larger than the
3598 value on the server, or data will be lost.
3600 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
3601 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
3602 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
3605 =item B<Forward> I<true|false>
3607 If set to I<true>, write packets that were received via the network plugin to
3608 the sending sockets. This should only be activated when the B<Listen>- and
3609 B<Server>-statements differ. Otherwise packets may be send multiple times to
3610 the same multicast group. While this results in more network traffic than
3611 necessary it's not a huge problem since the plugin has a duplicate detection,
3612 so the values will not loop.
3614 =item B<ReportStats> B<true>|B<false>
3616 The network plugin cannot only receive and send statistics, it can also create
3617 statistics about itself. Collected data included the number of received and
3618 sent octets and packets, the length of the receive queue and the number of
3619 values handled. When set to B<true>, the I<Network plugin> will make these
3620 statistics available. Defaults to B<false>.
3624 =head2 Plugin C<nginx>
3626 This plugin collects the number of connections and requests handled by the
3627 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
3628 queries the page provided by the C<ngx_http_stub_status_module> module, which
3629 isn't compiled by default. Please refer to
3630 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
3631 how to compile and configure nginx and this module.
3633 The following options are accepted by the C<nginx plugin>:
3637 =item B<URL> I<http://host/nginx_status>
3639 Sets the URL of the C<ngx_http_stub_status_module> output.
3641 =item B<User> I<Username>
3643 Optional user name needed for authentication.
3645 =item B<Password> I<Password>
3647 Optional password needed for authentication.
3649 =item B<VerifyPeer> B<true|false>
3651 Enable or disable peer SSL certificate verification. See
3652 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
3654 =item B<VerifyHost> B<true|false>
3656 Enable or disable peer host name verification. If enabled, the plugin checks
3657 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
3658 certificate matches the host name provided by the B<URL> option. If this
3659 identity check fails, the connection is aborted. Obviously, only works when
3660 connecting to a SSL enabled server. Enabled by default.
3662 =item B<CACert> I<File>
3664 File that holds one or more SSL certificates. If you want to use HTTPS you will
3665 possibly need this option. What CA certificates come bundled with C<libcurl>
3666 and are checked by default depends on the distribution you use.
3670 =head2 Plugin C<notify_desktop>
3672 This plugin sends a desktop notification to a notification daemon, as defined
3673 in the Desktop Notification Specification. To actually display the
3674 notifications, B<notification-daemon> is required and B<collectd> has to be
3675 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
3676 environment variables have to be set correctly) and the D-Bus message bus.
3678 The Desktop Notification Specification can be found at
3679 L<http://www.galago-project.org/specs/notification/>.
3683 =item B<OkayTimeout> I<timeout>
3685 =item B<WarningTimeout> I<timeout>
3687 =item B<FailureTimeout> I<timeout>
3689 Set the I<timeout>, in milliseconds, after which to expire the notification
3690 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
3691 been specified, the displayed notification will not be closed at all - the
3692 user has to do so herself. These options default to 5000. If a negative number
3693 has been specified, the default is used as well.
3697 =head2 Plugin C<notify_email>
3699 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
3700 configured email address.
3702 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
3704 Available configuration options:
3708 =item B<From> I<Address>
3710 Email address from which the emails should appear to come from.
3712 Default: C<root@localhost>
3714 =item B<Recipient> I<Address>
3716 Configures the email address(es) to which the notifications should be mailed.
3717 May be repeated to send notifications to multiple addresses.
3719 At least one B<Recipient> must be present for the plugin to work correctly.
3721 =item B<SMTPServer> I<Hostname>
3723 Hostname of the SMTP server to connect to.
3725 Default: C<localhost>
3727 =item B<SMTPPort> I<Port>
3729 TCP port to connect to.
3733 =item B<SMTPUser> I<Username>
3735 Username for ASMTP authentication. Optional.
3737 =item B<SMTPPassword> I<Password>
3739 Password for ASMTP authentication. Optional.
3741 =item B<Subject> I<Subject>
3743 Subject-template to use when sending emails. There must be exactly two
3744 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
3745 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
3748 Default: C<Collectd notify: %s@%s>
3752 =head2 Plugin C<ntpd>
3756 =item B<Host> I<Hostname>
3758 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
3760 =item B<Port> I<Port>
3762 UDP-Port to connect to. Defaults to B<123>.
3764 =item B<ReverseLookups> B<true>|B<false>
3766 Sets whether or not to perform reverse lookups on peers. Since the name or
3767 IP-address may be used in a filename it is recommended to disable reverse
3768 lookups. The default is to do reverse lookups to preserve backwards
3769 compatibility, though.
3771 =item B<IncludeUnitID> B<true>|B<false>
3773 When a peer is a refclock, include the unit ID in the I<type instance>.
3774 Defaults to B<false> for backward compatibility.
3776 If two refclock peers use the same driver and this is B<false>, the plugin will
3777 try to write simultaneous measurements from both to the same type instance.
3778 This will result in error messages in the log and only one set of measurements
3783 =head2 Plugin C<nut>
3787 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
3789 Add a UPS to collect data from. The format is identical to the one accepted by
3794 =head2 Plugin C<olsrd>
3796 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
3797 the Optimized Link State Routing daemon and reads information about the current
3798 state of the meshed network.
3800 The following configuration options are understood:
3804 =item B<Host> I<Host>
3806 Connect to I<Host>. Defaults to B<"localhost">.
3808 =item B<Port> I<Port>
3810 Specifies the port to connect to. This must be a string, even if you give the
3811 port as a number rather than a service name. Defaults to B<"2006">.
3813 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
3815 Specifies what information to collect about links, i.E<nbsp>e. direct
3816 connections of the daemon queried. If set to B<No>, no information is
3817 collected. If set to B<Summary>, the number of links and the average of all
3818 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
3819 If set to B<Detail> LQ and NLQ are collected per link.
3821 Defaults to B<Detail>.
3823 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
3825 Specifies what information to collect about routes of the daemon queried. If
3826 set to B<No>, no information is collected. If set to B<Summary>, the number of
3827 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
3828 metric and ETX are collected per route.
3830 Defaults to B<Summary>.
3832 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
3834 Specifies what information to collect about the global topology. If set to
3835 B<No>, no information is collected. If set to B<Summary>, the number of links
3836 in the entire topology and the average I<link quality> (LQ) is calculated.
3837 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
3839 Defaults to B<Summary>.
3843 =head2 Plugin C<onewire>
3845 B<EXPERIMENTAL!> See notes below.
3847 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
3848 L<http://owfs.org/> to read sensors connected via the onewire bus.
3850 Currently only temperature sensors (sensors with the family code C<10>,
3851 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
3852 would like to have included, please send a sort request to the mailing list.
3854 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
3855 experimental, below.
3859 =item B<Device> I<Device>
3861 Sets the device to read the values from. This can either be a "real" hardware
3862 device, such as a serial port or an USB port, or the address of the
3863 L<owserver(1)> socket, usually B<localhost:4304>.
3865 Though the documentation claims to automatically recognize the given address
3866 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
3867 with that version, the following configuration worked for us:
3870 Device "-s localhost:4304"
3873 This directive is B<required> and does not have a default value.
3875 =item B<Sensor> I<Sensor>
3877 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
3878 below. Sensors are specified without the family byte at the beginning, to you'd
3879 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
3882 =item B<IgnoreSelected> I<true>|I<false>
3884 If no configuration if given, the B<onewire> plugin will collect data from all
3885 sensors found. This may not be practical, especially if sensors are added and
3886 removed regularly. Sometimes, however, it's easier/preferred to collect only
3887 specific sensors or all sensors I<except> a few specified ones. This option
3888 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
3889 B<Sensor> is inverted: All selected interfaces are ignored and all other
3890 interfaces are collected.
3892 =item B<Interval> I<Seconds>
3894 Sets the interval in which all sensors should be read. If not specified, the
3895 global B<Interval> setting is used.
3899 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
3900 work with big setups. It works with one sensor being attached to one
3901 controller, but as soon as you throw in a couple more senors and maybe a hub
3902 or two, reading all values will take more than ten seconds (the default
3903 interval). We will probably add some separate thread for reading the sensors
3904 and some cache or something like that, but it's not done yet. We will try to
3905 maintain backwards compatibility in the future, but we can't promise. So in
3906 short: If it works for you: Great! But keep in mind that the config I<might>
3907 change, though this is unlikely. Oh, and if you want to help improving this
3908 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
3910 =head2 Plugin C<openvpn>
3912 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
3913 traffic statistics about connected clients.
3915 To set up OpenVPN to write to the status file periodically, use the
3916 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
3917 you need to set the required format, too. This is done by setting
3918 B<--status-version> to B<2>.
3920 So, in a nutshell you need:
3922 openvpn $OTHER_OPTIONS \
3923 --status "/var/run/openvpn-status" 10 \
3930 =item B<StatusFile> I<File>
3932 Specifies the location of the status file.
3934 =item B<ImprovedNamingSchema> B<true>|B<false>
3936 When enabled, the filename of the status file will be used as plugin instance
3937 and the client's "common name" will be used as type instance. This is required
3938 when reading multiple status files. Enabling this option is recommended, but to
3939 maintain backwards compatibility this option is disabled by default.
3941 =item B<CollectCompression> B<true>|B<false>
3943 Sets whether or not statistics about the compression used by OpenVPN should be
3944 collected. This information is only available in I<single> mode. Enabled by
3947 =item B<CollectIndividualUsers> B<true>|B<false>
3949 Sets whether or not traffic information is collected for each connected client
3950 individually. If set to false, currently no traffic data is collected at all
3951 because aggregating this data in a save manner is tricky. Defaults to B<true>.
3953 =item B<CollectUserCount> B<true>|B<false>
3955 When enabled, the number of currently connected clients or users is collected.
3956 This is especially interesting when B<CollectIndividualUsers> is disabled, but
3957 can be configured independently from that option. Defaults to B<false>.
3961 =head2 Plugin C<oracle>
3963 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
3964 Oracle® Database and lets you execute SQL statements there. It is very similar
3965 to the "dbi" plugin, because it was written around the same time. See the "dbi"
3966 plugin's documentation above for details.
3969 <Query "out_of_stock">
3970 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
3973 # InstancePrefix "foo"
3974 InstancesFrom "category"
3978 <Database "product_information">
3982 Query "out_of_stock"
3986 =head3 B<Query> blocks
3988 The Query blocks are handled identically to the Query blocks of the "dbi"
3989 plugin. Please see its documentation above for details on how to specify
3992 =head3 B<Database> blocks
3994 Database blocks define a connection to a database and which queries should be
3995 sent to that database. Each database needs a "name" as string argument in the
3996 starting tag of the block. This name will be used as "PluginInstance" in the
3997 values submitted to the daemon. Other than that, that name is not used.
4001 =item B<ConnectID> I<ID>
4003 Defines the "database alias" or "service name" to connect to. Usually, these
4004 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
4006 =item B<Host> I<Host>
4008 Hostname to use when dispatching values for this database. Defaults to using
4009 the global hostname of the I<collectd> instance.
4011 =item B<Username> I<Username>
4013 Username used for authentication.
4015 =item B<Password> I<Password>
4017 Password used for authentication.
4019 =item B<Query> I<QueryName>
4021 Associates the query named I<QueryName> with this database connection. The
4022 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
4023 blocks you want to refer to must be placed above the database block you want to
4028 =head2 Plugin C<perl>
4030 This plugin embeds a Perl-interpreter into collectd and provides an interface
4031 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
4033 =head2 Plugin C<pinba>
4035 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
4036 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
4037 PHP-based webpage has been delivered, the extension will send a UDP packet
4038 containing timing information, peak memory usage and so on. The plugin will
4039 wait for such packets, parse them and account the provided information, which
4040 is then dispatched to the daemon once per interval.
4047 # Overall statistics for the website.
4049 Server "www.example.com"
4051 # Statistics for www-a only
4053 Host "www-a.example.com"
4054 Server "www.example.com"
4056 # Statistics for www-b only
4058 Host "www-b.example.com"
4059 Server "www.example.com"
4063 The plugin provides the following configuration options:
4067 =item B<Address> I<Node>
4069 Configures the address used to open a listening socket. By default, plugin will
4070 bind to the I<any> address C<::0>.
4072 =item B<Port> I<Service>
4074 Configures the port (service) to bind to. By default the default Pinba port
4075 "30002" will be used. The option accepts service names in addition to port
4076 numbers and thus requires a I<string> argument.
4078 =item E<lt>B<View> I<Name>E<gt> block
4080 The packets sent by the Pinba extension include the hostname of the server, the
4081 server name (the name of the virtual host) and the script that was executed.
4082 Using B<View> blocks it is possible to separate the data into multiple groups
4083 to get more meaningful statistics. Each packet is added to all matching groups,
4084 so that a packet may be accounted for more than once.
4088 =item B<Host> I<Host>
4090 Matches the hostname of the system the webserver / script is running on. This
4091 will contain the result of the L<gethostname(2)> system call. If not
4092 configured, all hostnames will be accepted.
4094 =item B<Server> I<Server>
4096 Matches the name of the I<virtual host>, i.e. the contents of the
4097 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
4098 server names will be accepted.
4100 =item B<Script> I<Script>
4102 Matches the name of the I<script name>, i.e. the contents of the
4103 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
4104 script names will be accepted.
4110 =head2 Plugin C<ping>
4112 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
4113 configured hosts periodically and measures the network latency. Whenever the
4114 C<read> function of the plugin is called, it submits the average latency, the
4115 standard deviation and the drop rate for each host.
4117 Available configuration options:
4121 =item B<Host> I<IP-address>
4123 Host to ping periodically. This option may be repeated several times to ping
4126 =item B<Interval> I<Seconds>
4128 Sets the interval in which to send ICMP echo packets to the configured hosts.
4129 This is B<not> the interval in which statistics are queries from the plugin but
4130 the interval in which the hosts are "pinged". Therefore, the setting here
4131 should be smaller than or equal to the global B<Interval> setting. Fractional
4132 times, such as "1.24" are allowed.
4136 =item B<Timeout> I<Seconds>
4138 Time to wait for a response from the host to which an ICMP packet had been
4139 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
4140 to be down or the packet to be dropped. This setting must be smaller than the
4141 B<Interval> setting above for the plugin to work correctly. Fractional
4142 arguments are accepted.
4146 =item B<TTL> I<0-255>
4148 Sets the Time-To-Live of generated ICMP packets.
4150 =item B<SourceAddress> I<host>
4152 Sets the source address to use. I<host> may either be a numerical network
4153 address or a network hostname.
4155 =item B<Device> I<name>
4157 Sets the outgoing network device to be used. I<name> has to specify an
4158 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
4161 =item B<MaxMissed> I<Packets>
4163 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
4164 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
4166 Default: B<-1> (disabled)
4170 =head2 Plugin C<postgresql>
4172 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
4173 keeps a persistent connection to all configured databases and tries to
4174 reconnect if the connection has been interrupted. A database is configured by
4175 specifying a B<Database> block as described below. The default statistics are
4176 collected from PostgreSQL's B<statistics collector> which thus has to be
4177 enabled for this plugin to work correctly. This should usually be the case by
4178 default. See the section "The Statistics Collector" of the B<PostgreSQL
4179 Documentation> for details.
4181 By specifying custom database queries using a B<Query> block as described
4182 below, you may collect any data that is available from some PostgreSQL
4183 database. This way, you are able to access statistics of external daemons
4184 which are available in a PostgreSQL database or use future or special
4185 statistics provided by PostgreSQL without the need to upgrade your collectd
4188 Starting with version 5.2, the C<postgresql> plugin supports writing data to
4189 PostgreSQL databases as well. This has been implemented in a generic way. You
4190 need to specify an SQL statement which will then be executed by collectd in
4191 order to write the data (see below for details). The benefit of that approach
4192 is that there is no fixed database layout. Rather, the layout may be optimized
4193 for the current setup.
4195 The B<PostgreSQL Documentation> manual can be found at
4196 L<http://www.postgresql.org/docs/manuals/>.
4200 Statement "SELECT magic FROM wizard WHERE host = $1;"
4204 InstancePrefix "magic"
4209 <Query rt36_tickets>
4210 Statement "SELECT COUNT(type) AS count, type \
4212 WHEN resolved = 'epoch' THEN 'open' \
4213 ELSE 'resolved' END AS type \
4214 FROM tickets) type \
4218 InstancePrefix "rt36_tickets"
4219 InstancesFrom "type"
4225 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
4235 KRBSrvName "kerberos_service_name"
4241 Service "service_name"
4242 Query backend # predefined
4253 The B<Query> block defines one database query which may later be used by a
4254 database definition. It accepts a single mandatory argument which specifies
4255 the name of the query. The names of all queries have to be unique (see the
4256 B<MinVersion> and B<MaxVersion> options below for an exception to this
4257 rule). The following configuration options are available to define the query:
4259 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
4260 blocks define how to handle the values returned from the query. They define
4261 which column holds which value and how to dispatch that value to the daemon.
4262 Multiple B<Result> blocks may be used to extract multiple values from a single
4267 =item B<Statement> I<sql query statement>
4269 Specify the I<sql query statement> which the plugin should execute. The string
4270 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
4271 first, second, etc. parameter. The value of the parameters is specified by the
4272 B<Param> configuration option - see below for details. To include a literal
4273 B<$> character followed by a number, surround it with single quotes (B<'>).
4275 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
4276 allowed. Note, however, that only a single command may be used. Semicolons are
4277 allowed as long as a single non-empty command has been specified only.
4279 The returned lines will be handled separately one after another.
4281 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4283 Specify the parameters which should be passed to the SQL query. The parameters
4284 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4285 they appear in the configuration file. The value of the parameter is
4286 determined depending on the value of the B<Param> option as follows:
4292 The configured hostname of the database connection. If a UNIX domain socket is
4293 used, the parameter expands to "localhost".
4297 The name of the database of the current connection.
4301 The name of the database plugin instance. See the B<Instance> option of the
4302 database specification below for details.
4306 The username used to connect to the database.
4310 The interval with which this database is queried (as specified by the database
4311 specific or global B<Interval> options).
4315 Please note that parameters are only supported by PostgreSQL's protocol
4316 version 3 and above which was introduced in version 7.4 of PostgreSQL.
4318 =item B<Type> I<type>
4320 The I<type> name to be used when dispatching the values. The type describes
4321 how to handle the data and where to store it. See L<types.db(5)> for more
4322 details on types and their configuration. The number and type of values (as
4323 selected by the B<ValuesFrom> option) has to match the type of the given name.
4325 This option is required inside a B<Result> block.
4327 =item B<InstancePrefix> I<prefix>
4329 =item B<InstancesFrom> I<column0> [I<column1> ...]
4331 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
4332 B<InstancePrefix> defines a static prefix that will be prepended to all type
4333 instances. B<InstancesFrom> defines the column names whose values will be used
4334 to create the type instance. Multiple values will be joined together using the
4335 hyphen (C<->) as separation character.
4337 The plugin itself does not check whether or not all built instances are
4338 different. It is your responsibility to assure that each is unique.
4340 Both options are optional. If none is specified, the type instance will be
4343 =item B<ValuesFrom> I<column0> [I<column1> ...]
4345 Names the columns whose content is used as the actual data for the data sets
4346 that are dispatched to the daemon. How many such columns you need is
4347 determined by the B<Type> setting as explained above. If you specify too many
4348 or not enough columns, the plugin will complain about that and no data will be
4349 submitted to the daemon.
4351 The actual data type, as seen by PostgreSQL, is not that important as long as
4352 it represents numbers. The plugin will automatically cast the values to the
4353 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
4354 L<strtod(3)> functions, so anything supported by those functions is supported
4355 by the plugin as well.
4357 This option is required inside a B<Result> block and may be specified multiple
4358 times. If multiple B<ValuesFrom> options are specified, the columns are read
4361 =item B<MinVersion> I<version>
4363 =item B<MaxVersion> I<version>
4365 Specify the minimum or maximum version of PostgreSQL that this query should be
4366 used with. Some statistics might only be available with certain versions of
4367 PostgreSQL. This allows you to specify multiple queries with the same name but
4368 which apply to different versions, thus allowing you to use the same
4369 configuration in a heterogeneous environment.
4371 The I<version> has to be specified as the concatenation of the major, minor
4372 and patch-level versions, each represented as two-decimal-digit numbers. For
4373 example, version 8.2.3 will become 80203.
4377 The following predefined queries are available (the definitions can be found
4378 in the F<postgresql_default.conf> file which, by default, is available at
4379 C<I<prefix>/share/collectd/>):
4385 This query collects the number of backends, i.E<nbsp>e. the number of
4388 =item B<transactions>
4390 This query collects the numbers of committed and rolled-back transactions of
4395 This query collects the numbers of various table modifications (i.E<nbsp>e.
4396 insertions, updates, deletions) of the user tables.
4398 =item B<query_plans>
4400 This query collects the numbers of various table scans and returned tuples of
4403 =item B<table_states>
4405 This query collects the numbers of live and dead rows in the user tables.
4409 This query collects disk block access counts for user tables.
4413 This query collects the on-disk size of the database in bytes.
4417 In addition, the following detailed queries are available by default. Please
4418 note that each of those queries collects information B<by table>, thus,
4419 potentially producing B<a lot> of data. For details see the description of the
4420 non-by_table queries above.
4424 =item B<queries_by_table>
4426 =item B<query_plans_by_table>
4428 =item B<table_states_by_table>
4430 =item B<disk_io_by_table>
4434 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
4435 mandatory argument specifying the name of the writer. This will then be used
4436 in the B<Database> specification in order to activate the writer instance. The
4437 names of all writers have to be unique. The following options may be
4442 =item B<Statement> I<sql statement>
4444 This mandatory option specifies the SQL statement that will be executed for
4445 each submitted value. A single SQL statement is allowed only. Anything after
4446 the first semicolon will be ignored.
4448 Nine parameters will be passed to the statement and should be specified as
4449 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
4450 values are made available through those parameters:
4456 The timestamp of the queried value as a floating point number.
4460 The hostname of the queried value.
4464 The plugin name of the queried value.
4468 The plugin instance of the queried value. This value may be B<NULL> if there
4469 is no plugin instance.
4473 The type of the queried value (cf. L<types.db(5)>).
4477 The type instance of the queried value. This value may be B<NULL> if there is
4482 An array of names for the submitted values (i.E<nbsp>e., the name of the data
4483 sources of the submitted value-list).
4487 An array of types for the submitted values (i.E<nbsp>e., the type of the data
4488 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
4489 B<StoreRates> is enabled (which is the default, see below), all types will be
4494 An array of the submitted values. The dimensions of the value name and value
4499 In general, it is advisable to create and call a custom function in the
4500 PostgreSQL database for this purpose. Any procedural language supported by
4501 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
4504 =item B<StoreRates> B<false>|B<true>
4506 If set to B<true> (the default), convert counter values to rates. If set to
4507 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
4512 The B<Database> block defines one PostgreSQL database for which to collect
4513 statistics. It accepts a single mandatory argument which specifies the
4514 database name. None of the other options are required. PostgreSQL will use
4515 default values as documented in the section "CONNECTING TO A DATABASE" in the
4516 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
4517 the user collectd is run as and special environment variables. See the manpage
4522 =item B<Interval> I<seconds>
4524 Specify the interval with which the database should be queried. The default is
4525 to use the global B<Interval> setting.
4527 =item B<CommitInterval> I<seconds>
4529 This option may be used for database connections which have "writers" assigned
4530 (see above). If specified, it causes a writer to put several updates into a
4531 single transaction. This transaction will last for the specified amount of
4532 time. By default, each update will be executed in a separate transaction. Each
4533 transaction generates a fair amount of overhead which can, thus, be reduced by
4534 activating this option. The draw-back is, that data covering the specified
4535 amount of time will be lost, for example, if a single statement within the
4536 transaction fails or if the database server crashes.
4538 =item B<Instance> I<name>
4540 Specify the plugin instance name that should be used instead of the database
4541 name (which is the default, if this option has not been specified). This
4542 allows to query multiple databases of the same name on the same host (e.g.
4543 when running multiple database server versions in parallel).
4545 =item B<Host> I<hostname>
4547 Specify the hostname or IP of the PostgreSQL server to connect to. If the
4548 value begins with a slash, it is interpreted as the directory name in which to
4549 look for the UNIX domain socket.
4551 This option is also used to determine the hostname that is associated with a
4552 collected data set. If it has been omitted or either begins with with a slash
4553 or equals B<localhost> it will be replaced with the global hostname definition
4554 of collectd. Any other value will be passed literally to collectd when
4555 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
4557 =item B<Port> I<port>
4559 Specify the TCP port or the local UNIX domain socket file extension of the
4562 =item B<User> I<username>
4564 Specify the username to be used when connecting to the server.
4566 =item B<Password> I<password>
4568 Specify the password to be used when connecting to the server.
4570 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
4572 Specify whether to use an SSL connection when contacting the server. The
4573 following modes are supported:
4579 Do not use SSL at all.
4583 First, try to connect without using SSL. If that fails, try using SSL.
4585 =item I<prefer> (default)
4587 First, try to connect using SSL. If that fails, try without using SSL.
4595 =item B<KRBSrvName> I<kerberos_service_name>
4597 Specify the Kerberos service name to use when authenticating with Kerberos 5
4598 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
4599 B<PostgreSQL Documentation> for details.
4601 =item B<Service> I<service_name>
4603 Specify the PostgreSQL service name to use for additional parameters. That
4604 service has to be defined in F<pg_service.conf> and holds additional
4605 connection parameters. See the section "The Connection Service File" in the
4606 B<PostgreSQL Documentation> for details.
4608 =item B<Query> I<query>
4610 Specifies a I<query> which should be executed in the context of the database
4611 connection. This may be any of the predefined or user-defined queries. If no
4612 such option is given, it defaults to "backends", "transactions", "queries",
4613 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
4614 has been specified). Else, the specified queries are used only.
4616 =item B<Writer> I<writer>
4618 Assigns the specified I<writer> backend to the database connection. This
4619 causes all collected data to be send to the database using the settings
4620 defined in the writer configuration (see the section "FILTER CONFIGURATION"
4621 below for details on how to selectively send data to certain plugins).
4623 Each writer will register a flush callback which may be used when having long
4624 transactions enabled (see the B<CommitInterval> option above). When issuing
4625 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
4626 transaction will be committed right away. Two different kinds of flush
4627 callbacks are available with the C<postgresql> plugin:
4633 Flush all writer backends.
4635 =item B<postgresql->I<database>
4637 Flush all writers of the specified I<database> only.
4643 =head2 Plugin C<powerdns>
4645 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
4646 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
4647 values, many of which are probably meaningless to most users, but may be useful
4648 for some. So you may chose which values to collect, but if you don't, some
4649 reasonable defaults will be collected.
4652 <Server "server_name">
4654 Collect "udp-answers" "udp-queries"
4655 Socket "/var/run/pdns.controlsocket"
4657 <Recursor "recursor_name">
4659 Collect "cache-hits" "cache-misses"
4660 Socket "/var/run/pdns_recursor.controlsocket"
4662 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
4667 =item B<Server> and B<Recursor> block
4669 The B<Server> block defines one authoritative server to query, the B<Recursor>
4670 does the same for an recursing server. The possible options in both blocks are
4671 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
4676 =item B<Collect> I<Field>
4678 Using the B<Collect> statement you can select which values to collect. Here,
4679 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
4680 C<dlg-only-drops>, C<answers10-100>.
4682 The method of getting the values differs for B<Server> and B<Recursor> blocks:
4683 When querying the server a C<SHOW *> command is issued in any case, because
4684 that's the only way of getting multiple values out of the server at once.
4685 collectd then picks out the values you have selected. When querying the
4686 recursor, a command is generated to query exactly these values. So if you
4687 specify invalid fields when querying the recursor, a syntax error may be
4688 returned by the daemon and collectd may not collect any values at all.
4690 If no B<Collect> statement is given, the following B<Server> values will be
4697 =item packetcache-hit
4699 =item packetcache-miss
4701 =item packetcache-size
4703 =item query-cache-hit
4705 =item query-cache-miss
4707 =item recursing-answers
4709 =item recursing-questions
4721 The following B<Recursor> values will be collected by default:
4725 =item noerror-answers
4727 =item nxdomain-answers
4729 =item servfail-answers
4747 Please note that up to that point collectd doesn't know what values are
4748 available on the server and values that are added do not need a change of the
4749 mechanism so far. However, the values must be mapped to collectd's naming
4750 scheme, which is done using a lookup table that lists all known values. If
4751 values are added in the future and collectd does not know about them, you will
4752 get an error much like this:
4754 powerdns plugin: submit: Not found in lookup table: foobar = 42
4756 In this case please file a bug report with the collectd team.
4758 =item B<Socket> I<Path>
4760 Configures the path to the UNIX domain socket to be used when connecting to the
4761 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
4762 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
4763 will be used for the recursor.
4767 =item B<LocalSocket> I<Path>
4769 Querying the recursor is done using UDP. When using UDP over UNIX domain
4770 sockets, the client socket needs a name in the file system, too. You can set
4771 this local name to I<Path> using the B<LocalSocket> option. The default is
4772 C<I<prefix>/var/run/collectd-powerdns>.
4776 =head2 Plugin C<processes>
4780 =item B<Process> I<Name>
4782 Select more detailed statistics of processes matching this name. The statistics
4783 collected for these selected processes are size of the resident segment size
4784 (RSS), user- and system-time used, number of processes and number of threads,
4785 io data (where available) and minor and major pagefaults.
4787 =item B<ProcessMatch> I<name> I<regex>
4789 Similar to the B<Process> option this allows to select more detailed
4790 statistics of processes matching the specified I<regex> (see L<regex(7)> for
4791 details). The statistics of all matching processes are summed up and
4792 dispatched to the daemon using the specified I<name> as an identifier. This
4793 allows to "group" several processes together. I<name> must not contain
4798 =head2 Plugin C<protocols>
4800 Collects a lot of information about various network protocols, such as I<IP>,
4801 I<TCP>, I<UDP>, etc.
4803 Available configuration options:
4807 =item B<Value> I<Selector>
4809 Selects whether or not to select a specific value. The string being matched is
4810 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
4811 plugin instance and I<ValueName> will be used as type instance. An example of
4812 the string being used would be C<Tcp:RetransSegs>.
4814 You can use regular expressions to match a large number of values with just one
4815 configuration option. To select all "extended" I<TCP> values, you could use the
4816 following statement:
4820 Whether only matched values are selected or all matched values are ignored
4821 depends on the B<IgnoreSelected>. By default, only matched values are selected.
4822 If no value is configured at all, all values will be selected.
4824 =item B<IgnoreSelected> B<true>|B<false>
4826 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
4827 matching values will be ignored.
4831 =head2 Plugin C<python>
4833 This plugin embeds a Python-interpreter into collectd and provides an interface
4834 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
4836 =head2 Plugin C<routeros>
4838 The C<routeros> plugin connects to a device running I<RouterOS>, the
4839 Linux-based operating system for routers by I<MikroTik>. The plugin uses
4840 I<librouteros> to connect and reads information about the interfaces and
4841 wireless connections of the device. The configuration supports querying
4846 Host "router0.example.com"
4849 CollectInterface true
4854 Host "router1.example.com"
4857 CollectInterface true
4858 CollectRegistrationTable true
4864 As you can see above, the configuration of the I<routeros> plugin consists of
4865 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
4866 options are understood:
4870 =item B<Host> I<Host>
4872 Hostname or IP-address of the router to connect to.
4874 =item B<Port> I<Port>
4876 Port name or port number used when connecting. If left unspecified, the default
4877 will be chosen by I<librouteros>, currently "8728". This option expects a
4878 string argument, even when a numeric port number is given.
4880 =item B<User> I<User>
4882 Use the user name I<User> to authenticate. Defaults to "admin".
4884 =item B<Password> I<Password>
4886 Set the password used to authenticate.
4888 =item B<CollectInterface> B<true>|B<false>
4890 When set to B<true>, interface statistics will be collected for all interfaces
4891 present on the device. Defaults to B<false>.
4893 =item B<CollectRegistrationTable> B<true>|B<false>
4895 When set to B<true>, information about wireless LAN connections will be
4896 collected. Defaults to B<false>.
4898 =item B<CollectCPULoad> B<true>|B<false>
4900 When set to B<true>, information about the CPU usage will be collected. The
4901 number is a dimensionless value where zero indicates no CPU usage at all.
4902 Defaults to B<false>.
4904 =item B<CollectMemory> B<true>|B<false>
4906 When enabled, the amount of used and free memory will be collected. How used
4907 memory is calculated is unknown, for example whether or not caches are counted
4909 Defaults to B<false>.
4911 =item B<CollectDF> B<true>|B<false>
4913 When enabled, the amount of used and free disk space will be collected.
4914 Defaults to B<false>.
4916 =item B<CollectDisk> B<true>|B<false>
4918 When enabled, the number of sectors written and bad blocks will be collected.
4919 Defaults to B<false>.
4923 =head2 Plugin C<redis>
4925 The I<Redis plugin> connects to one or more Redis servers and gathers
4926 information about each server's state. For each server there is a I<Node> block
4927 which configures the connection parameters for this node.
4937 The information shown in the synopsis above is the I<default configuration>
4938 which is used by the plugin if no configuration is present.
4942 =item B<Node> I<Nodename>
4944 The B<Node> block identifies a new Redis node, that is a new Redis instance
4945 running in an specified host and port. The name for node is a canonical
4946 identifier which is used as I<plugin instance>. It is limited to
4947 64E<nbsp>characters in length.
4949 =item B<Host> I<Hostname>
4951 The B<Host> option is the hostname or IP-address where the Redis instance is
4954 =item B<Port> I<Port>
4956 The B<Port> option is the TCP port on which the Redis instance accepts
4957 connections. Either a service name of a port number may be given. Please note
4958 that numerical port numbers must be given as a string, too.
4960 =item B<Password> I<Password>
4962 Use I<Password> to authenticate when connecting to I<Redis>.
4964 =item B<Timeout> I<Milliseconds>
4966 The B<Timeout> option set the socket timeout for node response. Since the Redis
4967 read function is blocking, you should keep this value as low as possible. Keep
4968 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
4969 than B<Interval> defined globally.
4973 =head2 Plugin C<rrdcached>
4975 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
4976 to store values to RRD files in an efficient manner. The combination of the
4977 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
4978 way the C<rrdtool> plugin works (see below). The added abstraction layer
4979 provides a number of benefits, though: Because the cache is not within
4980 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
4981 restarted. This results in much shorter (if any) gaps in graphs, especially
4982 under heavy load. Also, the C<rrdtool> command line utility is aware of the
4983 daemon so that it can flush values to disk automatically when needed. This
4984 allows to integrate automated flushing of values into graphing solutions much
4987 There are disadvantages, though: The daemon may reside on a different host, so
4988 it may not be possible for C<collectd> to create the appropriate RRD files
4989 anymore. And even if C<rrdcached> runs on the same host, it may run in a
4990 different base directory, so relative paths may do weird stuff if you're not
4993 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
4994 on the same host, communicating via a UNIX domain socket. The B<DataDir>
4995 setting should be set to an absolute path, so that a changed base directory
4996 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
5000 =item B<DaemonAddress> I<Address>
5002 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
5003 library. See L<rrdcached(1)> for details. Example:
5005 <Plugin "rrdcached">
5006 DaemonAddress "unix:/var/run/rrdcached.sock"
5009 =item B<DataDir> I<Directory>
5011 Set the base directory in which the RRD files reside. If this is a relative
5012 path, it is relative to the working base directory of the C<rrdcached> daemon!
5013 Use of an absolute path is recommended.
5015 =item B<CreateFiles> B<true>|B<false>
5017 Enables or disables the creation of RRD files. If the daemon is not running
5018 locally, or B<DataDir> is set to a relative path, this will not work as
5019 expected. Default is B<true>.
5021 =item B<CreateFilesAsync> B<false>|B<true>
5023 When enabled, new RRD files are enabled asynchronously, using a separate thread
5024 that runs in the background. This prevents writes to block, which is a problem
5025 especially when many hundreds of files need to be created at once. However,
5026 since the purpose of creating the files asynchronously is I<not> to block until
5027 the file is available, values before the file is available will be discarded.
5028 When disabled (the default) files are created synchronously, blocking for a
5029 short while, while the file is being written.
5031 =item B<StepSize> I<Seconds>
5033 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5034 this setting is unset and the stepsize is set to the interval in which the data
5035 is collected. Do not use this option unless you absolutely have to for some
5036 reason. Setting this option may cause problems with the C<snmp plugin>, the
5037 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5039 =item B<HeartBeat> I<Seconds>
5041 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5042 in which case the heartbeat is set to twice the B<StepSize> which should equal
5043 the interval in which data is collected. Do not set this option unless you have
5044 a very good reason to do so.
5046 =item B<RRARows> I<NumRows>
5048 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5049 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5050 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5051 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5052 week, one month, and one year.
5054 So for each timespan, it calculates how many PDPs need to be consolidated into
5055 one CDP by calculating:
5056 number of PDPs = timespan / (stepsize * rrarows)
5058 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5061 =item B<RRATimespan> I<Seconds>
5063 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5064 more then one RRA. If this option is never used, the built-in default of (3600,
5065 86400, 604800, 2678400, 31622400) is used.
5067 For more information on how RRA-sizes are calculated see B<RRARows> above.
5069 =item B<XFF> I<Factor>
5071 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5072 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5075 =item B<CollectStatistics> B<false>|B<true>
5077 When set to B<true>, various statistics about the I<rrdcached> daemon will be
5078 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
5080 Statistics are read via I<rrdcached>s socket using the STATS command.
5081 See L<rrdcached(1)> for details.
5085 =head2 Plugin C<rrdtool>
5087 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
5088 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
5089 using these settings. If you don't want to dive into the depths of RRDtool, you
5090 can safely ignore these settings.
5094 =item B<DataDir> I<Directory>
5096 Set the directory to store RRD files under. By default RRD files are generated
5097 beneath the daemon's working directory, i.e. the B<BaseDir>.
5099 =item B<CreateFilesAsync> B<false>|B<true>
5101 When enabled, new RRD files are enabled asynchronously, using a separate thread
5102 that runs in the background. This prevents writes to block, which is a problem
5103 especially when many hundreds of files need to be created at once. However,
5104 since the purpose of creating the files asynchronously is I<not> to block until
5105 the file is available, values before the file is available will be discarded.
5106 When disabled (the default) files are created synchronously, blocking for a
5107 short while, while the file is being written.
5109 =item B<StepSize> I<Seconds>
5111 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5112 this setting is unset and the stepsize is set to the interval in which the data
5113 is collected. Do not use this option unless you absolutely have to for some
5114 reason. Setting this option may cause problems with the C<snmp plugin>, the
5115 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5117 =item B<HeartBeat> I<Seconds>
5119 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5120 in which case the heartbeat is set to twice the B<StepSize> which should equal
5121 the interval in which data is collected. Do not set this option unless you have
5122 a very good reason to do so.
5124 =item B<RRARows> I<NumRows>
5126 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5127 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5128 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5129 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5130 week, one month, and one year.
5132 So for each timespan, it calculates how many PDPs need to be consolidated into
5133 one CDP by calculating:
5134 number of PDPs = timespan / (stepsize * rrarows)
5136 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5139 =item B<RRATimespan> I<Seconds>
5141 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5142 more then one RRA. If this option is never used, the built-in default of (3600,
5143 86400, 604800, 2678400, 31622400) is used.
5145 For more information on how RRA-sizes are calculated see B<RRARows> above.
5147 =item B<XFF> I<Factor>
5149 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5150 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5153 =item B<CacheFlush> I<Seconds>
5155 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
5156 it writes all values for a certain RRD-file if the oldest value is older than
5157 (or equal to) the number of seconds specified. If some RRD-file is not updated
5158 anymore for some reason (the computer was shut down, the network is broken,
5159 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
5160 entire cache is searched for entries older than B<CacheTimeout> seconds and
5161 written to disk every I<Seconds> seconds. Since this is kind of expensive and
5162 does nothing under normal circumstances, this value should not be too small.
5163 900 seconds might be a good value, though setting this to 7200 seconds doesn't
5164 normally do much harm either.
5166 =item B<CacheTimeout> I<Seconds>
5168 If this option is set to a value greater than zero, the C<rrdtool plugin> will
5169 save values in a cache, as described above. Writing multiple values at once
5170 reduces IO-operations and thus lessens the load produced by updating the files.
5171 The trade off is that the graphs kind of "drag behind" and that more memory is
5174 =item B<WritesPerSecond> I<Updates>
5176 When collecting many statistics with collectd and the C<rrdtool> plugin, you
5177 will run serious performance problems. The B<CacheFlush> setting and the
5178 internal update queue assert that collectd continues to work just fine even
5179 under heavy load, but the system may become very unresponsive and slow. This is
5180 a problem especially if you create graphs from the RRD files on the same
5181 machine, for example using the C<graph.cgi> script included in the
5182 C<contrib/collection3/> directory.
5184 This setting is designed for very large setups. Setting this option to a value
5185 between 25 and 80 updates per second, depending on your hardware, will leave
5186 the server responsive enough to draw graphs even while all the cached values
5187 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
5188 by the B<FLUSH> command, are B<not> effected by this limit. They are still
5189 written as fast as possible, so that web frontends have up to date data when
5192 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
5193 updates per second, writing all values to disk will take approximately
5194 56E<nbsp>minutes. Together with the flushing ability that's integrated into
5195 "collection3" you'll end up with a responsive and fast system, up to date
5196 graphs and basically a "backup" of your values every hour.
5198 =item B<RandomTimeout> I<Seconds>
5200 When set, the actual timeout for each value is chosen randomly between
5201 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
5202 intention is to avoid high load situations that appear when many values timeout
5203 at the same time. This is especially a problem shortly after the daemon starts,
5204 because all values were added to the internal cache at roughly the same time.
5208 =head2 Plugin C<sensors>
5210 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
5211 that all the needed modules have to be loaded and lm_sensors has to be
5212 configured (most likely by editing F</etc/sensors.conf>. Read
5213 L<sensors.conf(5)> for details.
5215 The B<lm_sensors> homepage can be found at
5216 L<http://secure.netroedge.com/~lm78/>.
5220 =item B<SensorConfigFile> I<File>
5222 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
5223 the library's default will be used.
5225 =item B<Sensor> I<chip-bus-address/type-feature>
5227 Selects the name of the sensor which you want to collect or ignore, depending
5228 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
5229 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
5230 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
5232 =item B<IgnoreSelected> I<true>|I<false>
5234 If no configuration if given, the B<sensors>-plugin will collect data from all
5235 sensors. This may not be practical, especially for uninteresting sensors.
5236 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
5237 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
5238 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
5239 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
5240 and all other sensors are collected.
5244 =head2 Plugin C<sigrok>
5246 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
5247 supported by the L<sigrok|http://sigrok.org/> project.
5253 <Device "AC Voltage">
5258 <Device "Sound Level">
5259 Driver "cem-dt-885x"
5266 =item B<LogLevel> B<0-5>
5268 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
5269 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
5270 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
5271 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
5272 their level, are always submitted to I<collectd> at its INFO log level.
5274 =item E<lt>B<Device> I<Name>E<gt>
5276 A sigrok-supported device, uniquely identified by this section's options. The
5277 I<Name> is passed to I<collectd> as the I<plugin instance>.
5279 =item B<Driver> I<DriverName>
5281 The sigrok driver to use for this device.
5283 =item B<Conn> I<ConnectionSpec>
5285 If the device cannot be auto-discovered, or more than one might be discovered
5286 by the driver, I<ConnectionSpec> specifies the connection string to the device.
5287 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
5288 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
5289 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
5290 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
5292 =item B<SerialComm> I<SerialSpec>
5294 For serial devices with non-standard port settings, this option can be used
5295 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
5296 This should not be necessary; drivers know how to communicate with devices they
5299 =item B<MinimumInterval> I<Seconds>
5301 Specifies the minimum time between measurement dispatches to I<collectd>, in
5302 seconds. Since some I<sigrok> supported devices can acquire measurements many
5303 times per second, it may be necessary to throttle these. For example, the
5304 I<RRD plugin> cannot process writes more than once per second.
5306 The default B<MinimumInterval> is B<0>, meaning measurements received from the
5307 device are always dispatched to I<collectd>. When throttled, unused
5308 measurements are discarded.
5312 =head2 Plugin C<snmp>
5314 Since the configuration of the C<snmp plugin> is a little more complicated than
5315 other plugins, its documentation has been moved to an own manpage,
5316 L<collectd-snmp(5)>. Please see there for details.
5318 =head2 Plugin C<statsd>
5320 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
5321 protocol and dispatches rates or other aggregates of these numbers
5324 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
5325 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
5326 C<objects> respectively.
5328 The following configuration options are valid:
5332 =item B<Host> I<Host>
5334 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
5335 "any" address, i.e. accept packets sent to any of the hosts addresses.
5337 =item B<Port> I<Port>
5339 UDP port to listen to. This can be either a service name or a port number.
5340 Defaults to C<8125>.
5342 =item B<DeleteCounters> B<false>|B<true>
5344 =item B<DeleteTimers> B<false>|B<true>
5346 =item B<DeleteGauges> B<false>|B<true>
5348 =item B<DeleteSets> B<false>|B<true>
5350 These options control what happens if metrics are not updated in an interval.
5351 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
5352 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
5353 are unchanged. If set to B<True>, the such metrics are not dispatched and
5354 removed from the internal cache.
5356 =item B<TimerPercentile> I<Percent>
5358 Calculate and dispatch the configured percentile, i.e. compute the latency, so
5359 that I<Percent> of all reported timers are smaller than or equal to the
5360 computed latency. This is useful for cutting off the long tail latency, as it's
5361 often done in I<Service Level Agreements> (SLAs).
5363 Different percentiles can be calculated by setting this option several times.
5364 If none are specified, no percentiles are calculated / dispatched.
5366 =item B<TimerLower> B<false>|B<true>
5368 =item B<TimerUpper> B<false>|B<true>
5370 =item B<TimerSum> B<false>|B<true>
5372 =item B<TimerCount> B<false>|B<true>
5374 Calculate and dispatch various values out of I<Timer> metrics received during
5375 an interval. If set to B<False>, the default, these values aren't calculated /
5380 =head2 Plugin C<swap>
5382 The I<Swap plugin> collects information about used and available swap space. On
5383 I<Linux> and I<Solaris>, the following options are available:
5387 =item B<ReportByDevice> B<false>|B<true>
5389 Configures how to report physical swap devices. If set to B<false> (the
5390 default), the summary over all swap devices is reported only, i.e. the globally
5391 used and available space over all devices. If B<true> is configured, the used
5392 and available space of each device will be reported separately.
5394 This option is only available if the I<Swap plugin> can read C</proc/swaps>
5395 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
5397 =item B<ReportBytes> B<false>|B<true>
5399 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
5400 I<swap I/O> is reported in pages. This option is available under Linux only.
5404 =head2 Plugin C<syslog>
5408 =item B<LogLevel> B<debug|info|notice|warning|err>
5410 Sets the log-level. If, for example, set to B<notice>, then all events with
5411 severity B<notice>, B<warning>, or B<err> will be submitted to the
5414 Please note that B<debug> is only available if collectd has been compiled with
5417 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
5419 Controls which notifications should be sent to syslog. The default behaviour is
5420 not to send any. Less severe notifications always imply logging more severe
5421 notifications: Setting this to B<OKAY> means all notifications will be sent to
5422 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
5423 notifications but will dismiss B<OKAY> notifications. Setting this option to
5424 B<FAILURE> will only send failures to syslog.
5428 =head2 Plugin C<table>
5430 The C<table plugin> provides generic means to parse tabular data and dispatch
5431 user specified values. Values are selected based on column numbers. For
5432 example, this plugin may be used to get values from the Linux L<proc(5)>
5433 filesystem or CSV (comma separated values) files.
5436 <Table "/proc/slabinfo">
5441 InstancePrefix "active_objs"
5447 InstancePrefix "objperslab"
5454 The configuration consists of one or more B<Table> blocks, each of which
5455 configures one file to parse. Within each B<Table> block, there are one or
5456 more B<Result> blocks, which configure which data to select and how to
5459 The following options are available inside a B<Table> block:
5463 =item B<Instance> I<instance>
5465 If specified, I<instance> is used as the plugin instance. So, in the above
5466 example, the plugin name C<table-slabinfo> would be used. If omitted, the
5467 filename of the table is used instead, with all special characters replaced
5468 with an underscore (C<_>).
5470 =item B<Separator> I<string>
5472 Any character of I<string> is interpreted as a delimiter between the different
5473 columns of the table. A sequence of two or more contiguous delimiters in the
5474 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
5475 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
5476 of a table - see its documentation for more details. This option is mandatory.
5478 A horizontal tab, newline and carriage return may be specified by C<\\t>,
5479 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
5480 required because of collectd's config parsing.
5484 The following options are available inside a B<Result> block:
5488 =item B<Type> I<type>
5490 Sets the type used to dispatch the values to the daemon. Detailed information
5491 about types and their configuration can be found in L<types.db(5)>. This
5492 option is mandatory.
5494 =item B<InstancePrefix> I<prefix>
5496 If specified, prepend I<prefix> to the type instance. If omitted, only the
5497 B<InstancesFrom> option is considered for the type instance.
5499 =item B<InstancesFrom> I<column0> [I<column1> ...]
5501 If specified, the content of the given columns (identified by the column
5502 number starting at zero) will be used to create the type instance for each
5503 row. Multiple values (and the instance prefix) will be joined together with
5504 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
5505 option is considered for the type instance.
5507 The plugin itself does not check whether or not all built instances are
5508 different. It’s your responsibility to assure that each is unique. This is
5509 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
5510 sure that the table only contains one row.
5512 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
5515 =item B<ValuesFrom> I<column0> [I<column1> ...]
5517 Specifies the columns (identified by the column numbers starting at zero)
5518 whose content is used as the actual data for the data sets that are dispatched
5519 to the daemon. How many such columns you need is determined by the B<Type>
5520 setting above. If you specify too many or not enough columns, the plugin will
5521 complain about that and no data will be submitted to the daemon. The plugin
5522 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
5523 respectively, so anything supported by those functions is supported by the
5524 plugin as well. This option is mandatory.
5528 =head2 Plugin C<tail>
5530 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
5531 each line and dispatches found values. What is matched can be configured by the
5532 user using (extended) regular expressions, as described in L<regex(7)>.
5535 <File "/var/log/exim4/mainlog">
5538 Regex "S=([1-9][0-9]*)"
5544 Regex "\\<R=local_user\\>"
5545 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
5548 Instance "local_user"
5553 The config consists of one or more B<File> blocks, each of which configures one
5554 logfile to parse. Within each B<File> block, there are one or more B<Match>
5555 blocks, which configure a regular expression to search for.
5557 The B<Instance> option in the B<File> block may be used to set the plugin
5558 instance. So in the above example the plugin name C<tail-foo> would be used.
5559 This plugin instance is for all B<Match> blocks that B<follow> it, until the
5560 next B<Instance> option. This way you can extract several plugin instances from
5561 one logfile, handy when parsing syslog and the like.
5563 Each B<Match> block has the following options to describe how the match should
5568 =item B<Regex> I<regex>
5570 Sets the regular expression to use for matching against a line. The first
5571 subexpression has to match something that can be turned into a number by
5572 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
5573 below. Because B<extended> regular expressions are used, you do not need to use
5574 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
5575 collectd's config parsing you need to escape backslashes, though. So if you
5576 want to match literal parentheses you need to do the following:
5578 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
5580 =item B<ExcludeRegex> I<regex>
5582 Sets an optional regular expression to use for excluding lines from the match.
5583 An example which excludes all connections from localhost from the match:
5585 ExcludeRegex "127\\.0\\.0\\.1"
5587 =item B<DSType> I<Type>
5589 Sets how the values are cumulated. I<Type> is one of:
5593 =item B<GaugeAverage>
5595 Calculate the average.
5599 Use the smallest number only.
5603 Use the greatest number only.
5607 Use the last number found.
5613 =item B<AbsoluteSet>
5615 The matched number is a counter. Simply I<sets> the internal counter to this
5616 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
5622 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
5623 matched number may be negative, which will effectively subtract from the
5630 Increase the internal counter by one. These B<DSType> are the only ones that do
5631 not use the matched subexpression, but simply count the number of matched
5632 lines. Thus, you may use a regular expression without submatch in this case.
5636 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
5637 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
5638 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
5639 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
5640 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
5643 =item B<Type> I<Type>
5645 Sets the type used to dispatch this value. Detailed information about types and
5646 their configuration can be found in L<types.db(5)>.
5648 =item B<Instance> I<TypeInstance>
5650 This optional setting sets the type instance to use.
5654 =head2 Plugin C<tail_csv>
5656 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
5657 written by I<Snort>.
5662 <Metric "snort-dropped">
5667 <File "/var/log/snort/snort.stats">
5668 Instance "snort-eth0"
5670 Collect "snort-dropped"
5674 The configuration consists of one or more B<Metric> blocks that define an index
5675 into the line of the CSV file and how this value is mapped to I<collectd's>
5676 internal representation. These are followed by one or more B<Instance> blocks
5677 which configure which file to read, in which interval and which metrics to
5682 =item E<lt>B<Metric> I<Name>E<gt>
5684 The B<Metric> block configures a new metric to be extracted from the statistics
5685 file and how it is mapped on I<collectd's> data model. The string I<Name> is
5686 only used inside the B<Instance> blocks to refer to this block, so you can use
5687 one B<Metric> block for multiple CSV files.
5691 =item B<Type> I<Type>
5693 Configures which I<Type> to use when dispatching this metric. Types are defined
5694 in the L<types.db(5)> file, see the appropriate manual page for more
5695 information on specifying types. Only types with a single I<data source> are
5696 supported by the I<tail_csv plugin>. The information whether the value is an
5697 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
5698 I<Type's> definition.
5700 =item B<Instance> I<TypeInstance>
5702 If set, I<TypeInstance> is used to populate the type instance field of the
5703 created value lists. Otherwise, no type instance is used.
5705 =item B<ValueFrom> I<Index>
5707 Configure to read the value from the field with the zero-based index I<Index>.
5708 If the value is parsed as signed integer, unsigned integer or double depends on
5709 the B<Type> setting, see above.
5713 =item E<lt>B<File> I<Path>E<gt>
5715 Each B<File> block represents one CSV file to read. There must be at least one
5716 I<File> block but there can be multiple if you have multiple CSV files.
5720 =item B<Instance> I<PluginInstance>
5722 Sets the I<plugin instance> used when dispatching the values.
5724 =item B<Collect> I<Metric>
5726 Specifies which I<Metric> to collect. This option must be specified at least
5727 once, and you can use this option multiple times to specify more than one
5728 metric to be extracted from this statistic file.
5730 =item B<Interval> I<Seconds>
5732 Configures the interval in which to read values from this instance / file.
5733 Defaults to the plugin's default interval.
5735 =item B<TimeFrom> I<Index>
5737 Rather than using the local time when dispatching a value, read the timestamp
5738 from the field with the zero-based index I<Index>. The value is interpreted as
5739 seconds since epoch. The value is parsed as a double and may be factional.
5745 =head2 Plugin C<teamspeak2>
5747 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
5748 polls interesting global and virtual server data. The plugin can query only one
5749 physical server but unlimited virtual servers. You can use the following
5750 options to configure it:
5754 =item B<Host> I<hostname/ip>
5756 The hostname or ip which identifies the physical server.
5759 =item B<Port> I<port>
5761 The query port of the physical server. This needs to be a string.
5764 =item B<Server> I<port>
5766 This option has to be added once for every virtual server the plugin should
5767 query. If you want to query the virtual server on port 8767 this is what the
5768 option would look like:
5772 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
5773 use quotes around it! If no such statement is given only global information
5778 =head2 Plugin C<ted>
5780 The I<TED> plugin connects to a device of "The Energy Detective", a device to
5781 measure power consumption. These devices are usually connected to a serial
5782 (RS232) or USB port. The plugin opens a configured device and tries to read the
5783 current energy readings. For more information on TED, visit
5784 L<http://www.theenergydetective.com/>.
5786 Available configuration options:
5790 =item B<Device> I<Path>
5792 Path to the device on which TED is connected. collectd will need read and write
5793 permissions on that file.
5795 Default: B</dev/ttyUSB0>
5797 =item B<Retries> I<Num>
5799 Apparently reading from TED is not that reliable. You can therefore configure a
5800 number of retries here. You only configure the I<retries> here, to if you
5801 specify zero, one reading will be performed (but no retries if that fails); if
5802 you specify three, a maximum of four readings are performed. Negative values
5809 =head2 Plugin C<tcpconns>
5811 The C<tcpconns plugin> counts the number of currently established TCP
5812 connections based on the local port and/or the remote port. Since there may be
5813 a lot of connections the default if to count all connections with a local port,
5814 for which a listening socket is opened. You can use the following options to
5815 fine-tune the ports you are interested in:
5819 =item B<ListeningPorts> I<true>|I<false>
5821 If this option is set to I<true>, statistics for all local ports for which a
5822 listening socket exists are collected. The default depends on B<LocalPort> and
5823 B<RemotePort> (see below): If no port at all is specifically selected, the
5824 default is to collect listening ports. If specific ports (no matter if local or
5825 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
5826 the selected ports will be collected unless this option is set to I<true>
5829 =item B<LocalPort> I<Port>
5831 Count the connections to a specific local port. This can be used to see how
5832 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
5833 You have to specify the port in numeric form, so for the mailserver example
5834 you'd need to set B<25>.
5836 =item B<RemotePort> I<Port>
5838 Count the connections to a specific remote port. This is useful to see how
5839 much a remote service is used. This is most useful if you want to know how many
5840 connections a local service has opened to remote services, e.E<nbsp>g. how many
5841 connections a mail server or news server has to other mail or news servers, or
5842 how many connections a web proxy holds to web servers. You have to give the
5843 port in numeric form.
5847 =head2 Plugin C<thermal>
5851 =item B<ForceUseProcfs> I<true>|I<false>
5853 By default, the I<Thermal plugin> tries to read the statistics from the Linux
5854 C<sysfs> interface. If that is not available, the plugin falls back to the
5855 C<procfs> interface. By setting this option to I<true>, you can force the
5856 plugin to use the latter. This option defaults to I<false>.
5858 =item B<Device> I<Device>
5860 Selects the name of the thermal device that you want to collect or ignore,
5861 depending on the value of the B<IgnoreSelected> option. This option may be
5862 used multiple times to specify a list of devices.
5864 =item B<IgnoreSelected> I<true>|I<false>
5866 Invert the selection: If set to true, all devices B<except> the ones that
5867 match the device names specified by the B<Device> option are collected. By
5868 default only selected devices are collected if a selection is made. If no
5869 selection is configured at all, B<all> devices are selected.
5873 =head2 Plugin C<threshold>
5875 The I<Threshold plugin> checks values collected or received by I<collectd>
5876 against a configurable I<threshold> and issues I<notifications> if values are
5879 Documentation for this plugin is available in the L<collectd-threshold(5)>
5882 =head2 Plugin C<tokyotyrant>
5884 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
5885 couple metrics: number of records, and database size on disk.
5889 =item B<Host> I<Hostname/IP>
5891 The hostname or ip which identifies the server.
5892 Default: B<127.0.0.1>
5894 =item B<Port> I<Service/Port>
5896 The query port of the server. This needs to be a string, even if the port is
5897 given in its numeric form.
5902 =head2 Plugin C<unixsock>
5906 =item B<SocketFile> I<Path>
5908 Sets the socket-file which is to be created.
5910 =item B<SocketGroup> I<Group>
5912 If running as root change the group of the UNIX-socket after it has been
5913 created. Defaults to B<collectd>.
5915 =item B<SocketPerms> I<Permissions>
5917 Change the file permissions of the UNIX-socket after it has been created. The
5918 permissions must be given as a numeric, octal value as you would pass to
5919 L<chmod(1)>. Defaults to B<0770>.
5921 =item B<DeleteSocket> B<false>|B<true>
5923 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
5924 with the given name already exists. If I<collectd> crashes a socket file may be
5925 left over, preventing the daemon from opening a new socket when restarted.
5926 Since this is potentially dangerous, this defaults to B<false>.
5930 =head2 Plugin C<uuid>
5932 This plugin, if loaded, causes the Hostname to be taken from the machine's
5933 UUID. The UUID is a universally unique designation for the machine, usually
5934 taken from the machine's BIOS. This is most useful if the machine is running in
5935 a virtual environment such as Xen, in which case the UUID is preserved across
5936 shutdowns and migration.
5938 The following methods are used to find the machine's UUID, in order:
5944 Check I</etc/uuid> (or I<UUIDFile>).
5948 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
5953 Check for UUID from C<dmidecode> / SMBIOS.
5957 Check for UUID from Xen hypervisor.
5961 If no UUID can be found then the hostname is not modified.
5965 =item B<UUIDFile> I<Path>
5967 Take the UUID from the given file (default I</etc/uuid>).
5971 =head2 Plugin C<varnish>
5973 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
5978 <Instance "example">
5980 CollectConnections true
5990 CollectWorkers false
5994 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
5995 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
5996 will collectd statistics from the default "varnishd" instance (this should work
5997 fine in most cases).
5999 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
6003 =item B<CollectCache> B<true>|B<false>
6005 Cache hits and misses. True by default.
6007 =item B<CollectConnections> B<true>|B<false>
6009 Number of client connections received, accepted and dropped. True by default.
6011 =item B<CollectBackend> B<true>|B<false>
6013 Back-end connection statistics, such as successful, reused,
6014 and closed connections. True by default.
6016 =item B<CollectSHM> B<true>|B<false>
6018 Statistics about the shared memory log, a memory region to store
6019 log messages which is flushed to disk when full. True by default.
6021 =item B<CollectBan> B<true>|B<false>
6023 Statistics about ban operations, such as number of bans added, retired, and
6024 number of objects tested against ban operations. Only available with Varnish
6025 3.x. False by default.
6027 =item B<CollectDirectorDNS> B<true>|B<false>
6029 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
6032 =item B<CollectESI> B<true>|B<false>
6034 Edge Side Includes (ESI) parse statistics. False by default.
6036 =item B<CollectFetch> B<true>|B<false>
6038 Statistics about fetches (HTTP requests sent to the backend). False by default.
6040 =item B<CollectHCB> B<true>|B<false>
6042 Inserts and look-ups in the crit bit tree based hash. Look-ups are
6043 divided into locked and unlocked look-ups. False by default.
6045 =item B<CollectObjects> B<true>|B<false>
6047 Statistics on cached objects: number of objects expired, nuked (prematurely
6048 expired), saved, moved, etc. False by default.
6050 =item B<CollectPurge> B<true>|B<false>
6052 Statistics about purge operations, such as number of purges added, retired, and
6053 number of objects tested against purge operations. Only available with Varnish
6054 2.x. False by default.
6056 =item B<CollectSession> B<true>|B<false>
6058 Client session statistics. Number of past and current sessions, session herd and
6059 linger counters, etc. False by default.
6061 =item B<CollectSMA> B<true>|B<false>
6063 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
6064 component is Solaris specific. Only available with Varnish 2.x. False by
6067 =item B<CollectSMS> B<true>|B<false>
6069 synth (synthetic content) storage statistics. This storage
6070 component is used internally only. False by default.
6072 =item B<CollectSM> B<true>|B<false>
6074 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
6077 =item B<CollectStruct> B<true>|B<false>
6079 Current varnish internal state statistics. Number of current sessions, objects
6080 in cache store, open connections to backends (with Varnish 2.x), etc. False by
6083 =item B<CollectTotals> B<true>|B<false>
6085 Collects overview counters, such as the number of sessions created,
6086 the number of requests and bytes transferred. False by default.
6088 =item B<CollectUptime> B<true>|B<false>
6090 Varnish uptime. False by default.
6092 =item B<CollectVCL> B<true>|B<false>
6094 Number of total (available + discarded) VCL (config files). False by default.
6096 =item B<CollectWorkers> B<true>|B<false>
6098 Collect statistics about worker threads. False by default.
6102 =head2 Plugin C<vmem>
6104 The C<vmem> plugin collects information about the usage of virtual memory.
6105 Since the statistics provided by the Linux kernel are very detailed, they are
6106 collected very detailed. However, to get all the details, you have to switch
6107 them on manually. Most people just want an overview over, such as the number of
6108 pages read from swap space.
6112 =item B<Verbose> B<true>|B<false>
6114 Enables verbose collection of information. This will start collecting page
6115 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
6116 Part of these statistics are collected on a "per zone" basis.
6120 =head2 Plugin C<vserver>
6122 This plugin doesn't have any options. B<VServer> support is only available for
6123 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
6124 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
6125 need to apply the patches and compile your own kernel, which will then provide
6126 the F</proc/virtual> filesystem that is required by this plugin.
6128 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
6130 B<Note>: The traffic collected by this plugin accounts for the amount of
6131 traffic passing a socket which might be a lot less than the actual on-wire
6132 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
6133 collect on-wire traffic you could, for example, use the logging facilities of
6134 iptables to feed data for the guest IPs into the iptables plugin.
6136 =head2 Plugin C<write_graphite>
6138 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
6139 storage and graphing project. The plugin connects to I<Carbon>, the data layer
6140 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
6141 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
6142 of at most 1428 bytes to minimize the number of network packets.
6146 <Plugin write_graphite>
6156 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6157 blocks. Inside the B<Node> blocks, the following options are recognized:
6161 =item B<Host> I<Address>
6163 Hostname or address to connect to. Defaults to C<localhost>.
6165 =item B<Port> I<Service>
6167 Service name or port number to connect to. Defaults to C<2003>.
6169 =item B<Protocol> I<String>
6171 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
6173 =item B<LogSendErrors> B<false>|B<true>
6175 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
6176 If set to B<false>, it will not log the errors. This is especially useful when
6177 using Protocol UDP since many times we want to use the "fire-and-forget"
6178 approach and logging errors fills syslog with unneeded messages.
6180 =item B<Prefix> I<String>
6182 When set, I<String> is added in front of the host name. Dots and whitespace are
6183 I<not> escaped in this string (see B<EscapeCharacter> below).
6185 =item B<Postfix> I<String>
6187 When set, I<String> is appended to the host name. Dots and whitespace are
6188 I<not> escaped in this string (see B<EscapeCharacter> below).
6190 =item B<EscapeCharacter> I<Char>
6192 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
6193 in the identifier. The B<EscapeCharacter> option determines which character
6194 dots, whitespace and control characters are replaced with. Defaults to
6197 =item B<StoreRates> B<false>|B<true>
6199 If set to B<true> (the default), convert counter values to rates. If set to
6200 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6203 =item B<SeparateInstances> B<false>|B<true>
6205 If set to B<true>, the plugin instance and type instance will be in their own
6206 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6207 default), the plugin and plugin instance (and likewise the type and type
6208 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6210 =item B<AlwaysAppendDS> B<false>|B<true>
6212 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
6213 identifier. If set to B<false> (the default), this is only done when there is
6218 =head2 Plugin C<write_mongodb>
6220 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
6225 <Plugin "write_mongodb">
6234 The plugin can send values to multiple instances of I<MongoDB> by specifying
6235 one B<Node> block for each instance. Within the B<Node> blocks, the following
6236 options are available:
6240 =item B<Host> I<Address>
6242 Hostname or address to connect to. Defaults to C<localhost>.
6244 =item B<Port> I<Service>
6246 Service name or port number to connect to. Defaults to C<27017>.
6248 =item B<Timeout> I<Milliseconds>
6250 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
6251 Setting this option to zero means no timeout, which is the default.
6253 =item B<StoreRates> B<false>|B<true>
6255 If set to B<true> (the default), convert counter values to rates. If set to
6256 B<false> counter values are stored as is, i.e. as an increasing integer
6259 =item B<Database> I<Database>
6261 =item B<User> I<User>
6263 =item B<Password> I<Password>
6265 Sets the information used when authenticating to a I<MongoDB> database. The
6266 fields are optional (in which case no authentication is attempted), but if you
6267 want to use authentication all three fields must be set.
6271 =head2 Plugin C<write_http>
6273 This output plugin submits values to an http server by POST them using the
6274 PUTVAL plain-text protocol. Each destination you want to post data to needs to
6275 have one B<URL> block, within which the destination can be configured further,
6276 for example by specifying authentication data.
6280 <Plugin "write_http">
6281 <URL "http://example.com/post-collectd">
6287 B<URL> blocks need one string argument which is used as the URL to which data
6288 is posted. The following options are understood within B<URL> blocks.
6292 =item B<User> I<Username>
6294 Optional user name needed for authentication.
6296 =item B<Password> I<Password>
6298 Optional password needed for authentication.
6300 =item B<VerifyPeer> B<true>|B<false>
6302 Enable or disable peer SSL certificate verification. See
6303 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
6305 =item B<VerifyHost> B<true|false>
6307 Enable or disable peer host name verification. If enabled, the plugin checks if
6308 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
6309 matches the host name provided by the B<URL> option. If this identity check
6310 fails, the connection is aborted. Obviously, only works when connecting to a
6311 SSL enabled server. Enabled by default.
6313 =item B<CACert> I<File>
6315 File that holds one or more SSL certificates. If you want to use HTTPS you will
6316 possibly need this option. What CA certificates come bundled with C<libcurl>
6317 and are checked by default depends on the distribution you use.
6319 =item B<Format> B<Command>|B<JSON>
6321 Format of the output to generate. If set to B<Command>, will create output that
6322 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
6323 create output in the I<JavaScript Object Notation> (JSON).
6325 Defaults to B<Command>.
6327 =item B<StoreRates> B<true|false>
6329 If set to B<true>, convert counter values to rates. If set to B<false> (the
6330 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
6335 =head2 Plugin C<write_redis>
6337 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
6341 <Plugin "write_redis">
6349 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
6350 the timestamp as the score. Retrieving a date range can then be done using the
6351 C<ZRANGEBYSCORE> I<Redis> command. Additionnally, all the identifiers of these
6352 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> and can be
6353 retrieved using the C<SMEMBERS> I<Redis> command. See
6354 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
6357 The information shown in the synopsis above is the I<default configuration>
6358 which is used by the plugin if no configuration is present.
6360 The plugin can send values to multiple instances of I<Redis> by specifying
6361 one B<Node> block for each instance. Within the B<Node> blocks, the following
6362 options are available:
6366 =item B<Node> I<Nodename>
6368 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
6369 instance running in an specified host and port. The name for node is a
6370 canonical identifier which is used as I<plugin instance>. It is limited to
6371 64E<nbsp>characters in length.
6373 =item B<Host> I<Hostname>
6375 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
6378 =item B<Port> I<Port>
6380 The B<Port> option is the TCP port on which the Redis instance accepts
6381 connections. Either a service name of a port number may be given. Please note
6382 that numerical port numbers must be given as a string, too.
6384 =item B<Timeout> I<Milliseconds>
6386 The B<Timeout> option sets the socket connection timeout, in milliseconds.
6390 =head2 Plugin C<write_riemann>
6392 The I<write_riemann plugin> will send values to I<Riemann>, a powerfull stream
6393 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
6394 I<Riemann> using UDP packets.
6398 <Plugin "write_riemann">
6404 AlwaysAppendDS false
6410 The following options are understood by the I<write_riemann plugin>:
6414 =item E<lt>B<Node> I<Name>E<gt>
6416 The plugin's configuration consists of one or more B<Node> blocks. Each block
6417 is given a unique I<Name> and specifies one connection to an instance of
6418 I<Riemann>. Indise the B<Node> block, the following per-connection options are
6423 =item B<Host> I<Address>
6425 Hostname or address to connect to. Defaults to C<localhost>.
6427 =item B<Port> I<Service>
6429 Service name or port number to connect to. Defaults to C<5555>.
6431 =item B<Protocol> B<UDP>|B<TCP>
6433 Specify the protocol to use when communicating with I<Riemann>. Defaults to
6436 =item B<StoreRates> B<true>|B<false>
6438 If set to B<true> (the default), convert counter values to rates. If set to
6439 B<false> counter values are stored as is, i.e. as an increasing integer number.
6441 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
6442 converted values will have "rate" appended to the data source type, e.g.
6443 C<ds_type:derive:rate>.
6445 =item B<AlwaysAppendDS> B<false>|B<true>
6447 If set to B<true>, append the name of the I<Data Source> (DS) to the
6448 "service", i.e. the field that, together with the "host" field, uniquely
6449 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
6450 only done when there is more than one DS.
6452 =item B<TTLFactor> I<Factor>
6454 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
6455 event is considered active. I<collectd> populates this field based on the
6456 metrics interval setting. This setting controls the factor with which the
6457 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
6458 know exactly what you're doing, you should only increase this setting from its
6463 =item B<Tag> I<String>
6465 Add the given string as an additional tag to the metric being sent to
6470 =head1 THRESHOLD CONFIGURATION
6472 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
6473 we mean that the values are not only stored or sent somewhere, but that they
6474 are judged and, if a problem is recognized, acted upon. The only action
6475 collectd takes itself is to generate and dispatch a "notification". Plugins can
6476 register to receive notifications and perform appropriate further actions.
6478 Since systems and what you expect them to do differ a lot, you can configure
6479 B<thresholds> for your values freely. This gives you a lot of flexibility but
6480 also a lot of responsibility.
6482 Every time a value is out of range a notification is dispatched. This means
6483 that the idle percentage of your CPU needs to be less then the configured
6484 threshold only once for a notification to be generated. There's no such thing
6485 as a moving average or similar - at least not now.
6487 Also, all values that match a threshold are considered to be relevant or
6488 "interesting". As a consequence collectd will issue a notification if they are
6489 not received for B<Timeout> iterations. The B<Timeout> configuration option is
6490 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
6491 "2" (the default) and some hosts sends it's CPU statistics to the server every
6492 60 seconds, a notification will be dispatched after about 120 seconds. It may
6493 take a little longer because the timeout is checked only once each B<Interval>
6496 When a value comes within range again or is received after it was missing, an
6497 "OKAY-notification" is dispatched.
6499 Here is a configuration example to get you started. Read below for more
6512 <Plugin "interface">
6529 WarningMin 100000000
6535 There are basically two types of configuration statements: The C<Host>,
6536 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
6537 configured. The C<Plugin> and C<Type> blocks may be specified further using the
6538 C<Instance> option. You can combine the block by nesting the blocks, though
6539 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
6540 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
6541 C<Type> may not contain other blocks. If multiple blocks apply to the same
6542 value the most specific block is used.
6544 The other statements specify the threshold to configure. They B<must> be
6545 included in a C<Type> block. Currently the following statements are recognized:
6549 =item B<FailureMax> I<Value>
6551 =item B<WarningMax> I<Value>
6553 Sets the upper bound of acceptable values. If unset defaults to positive
6554 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
6555 will be created. If the value is greater than B<WarningMax> but less than (or
6556 equal to) B<FailureMax> a B<WARNING> notification will be created.
6558 =item B<FailureMin> I<Value>
6560 =item B<WarningMin> I<Value>
6562 Sets the lower bound of acceptable values. If unset defaults to negative
6563 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
6564 be created. If the value is less than B<WarningMin> but greater than (or equal
6565 to) B<FailureMin> a B<WARNING> notification will be created.
6567 =item B<DataSource> I<DSName>
6569 Some data sets have more than one "data source". Interesting examples are the
6570 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
6571 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
6572 system load data set, C<load>, even has three data sources: C<shortterm>,
6573 C<midterm>, and C<longterm>.
6575 Normally, all data sources are checked against a configured threshold. If this
6576 is undesirable, or if you want to specify different limits for each data
6577 source, you can use the B<DataSource> option to have a threshold apply only to
6580 =item B<Invert> B<true>|B<false>
6582 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
6583 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
6584 B<WarningMax>) are not okay. Defaults to B<false>.
6586 =item B<Persist> B<true>|B<false>
6588 Sets how often notifications are generated. If set to B<true> one notification
6589 will be generated for each value that is out of the acceptable range. If set to
6590 B<false> (the default) then a notification is only generated if a value is out
6591 of range but the previous value was okay.
6593 This applies to missing values, too: If set to B<true> a notification about a
6594 missing value is generated once every B<Interval> seconds. If set to B<false>
6595 only one such notification is generated until the value appears again.
6597 =item B<Percentage> B<true>|B<false>
6599 If set to B<true>, the minimum and maximum values given are interpreted as
6600 percentage value, relative to the other data sources. This is helpful for
6601 example for the "df" type, where you may want to issue a warning when less than
6602 5E<nbsp>% of the total space is available. Defaults to B<false>.
6604 =item B<Hits> I<Number>
6606 Delay creating the notification until the threshold has been passed I<Number>
6607 times. When a notification has been generated, or when a subsequent value is
6608 inside the threshold, the counter is reset. If, for example, a value is
6609 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
6610 will be dispatched at most once every 30E<nbsp>seconds.
6612 This is useful when short bursts are not a problem. If, for example, 100% CPU
6613 usage for up to a minute is normal (and data is collected every
6614 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
6616 =item B<Hysteresis> I<Number>
6618 When set to non-zero, a hysteresis value is applied when checking minimum and
6619 maximum bounds. This is useful for values that increase slowly and fluctuate a
6620 bit while doing so. When these values come close to the threshold, they may
6621 "flap", i.e. switch between failure / warning case and okay case repeatedly.
6623 If, for example, the threshold is configures as
6628 then a I<Warning> notification is created when the value exceeds I<101> and the
6629 corresponding I<Okay> notification is only created once the value falls below
6630 I<99>, thus avoiding the "flapping".
6634 =head1 FILTER CONFIGURATION
6636 Starting with collectd 4.6 there is a powerful filtering infrastructure
6637 implemented in the daemon. The concept has mostly been copied from
6638 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
6639 terminology, so that users that are familiar with iptables feel right at home.
6643 The following are the terms used in the remainder of the filter configuration
6644 documentation. For an ASCII-art schema of the mechanism, see
6645 L<"General structure"> below.
6651 A I<match> is a criteria to select specific values. Examples are, of course, the
6652 name of the value or it's current value.
6654 Matches are implemented in plugins which you have to load prior to using the
6655 match. The name of such plugins starts with the "match_" prefix.
6659 A I<target> is some action that is to be performed with data. Such actions
6660 could, for example, be to change part of the value's identifier or to ignore
6661 the value completely.
6663 Some of these targets are built into the daemon, see L<"Built-in targets">
6664 below. Other targets are implemented in plugins which you have to load prior to
6665 using the target. The name of such plugins starts with the "target_" prefix.
6669 The combination of any number of matches and at least one target is called a
6670 I<rule>. The target actions will be performed for all values for which B<all>
6671 matches apply. If the rule does not have any matches associated with it, the
6672 target action will be performed for all values.
6676 A I<chain> is a list of rules and possibly default targets. The rules are tried
6677 in order and if one matches, the associated target will be called. If a value
6678 is handled by a rule, it depends on the target whether or not any subsequent
6679 rules are considered or if traversal of the chain is aborted, see
6680 L<"Flow control"> below. After all rules have been checked, the default targets
6685 =head2 General structure
6687 The following shows the resulting structure:
6694 +---------+ +---------+ +---------+ +---------+
6695 ! Rule !->! Match !->! Match !->! Target !
6696 +---------+ +---------+ +---------+ +---------+
6699 +---------+ +---------+ +---------+
6700 ! Rule !->! Target !->! Target !
6701 +---------+ +---------+ +---------+
6708 +---------+ +---------+ +---------+
6709 ! Rule !->! Match !->! Target !
6710 +---------+ +---------+ +---------+
6720 There are four ways to control which way a value takes through the filter
6727 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
6728 process the value with another chain. When the called chain finishes, usually
6729 the next target or rule after the jump is executed.
6733 The stop condition, signaled for example by the built-in target B<stop>, causes
6734 all processing of the value to be stopped immediately.
6738 Causes processing in the current chain to be aborted, but processing of the
6739 value generally will continue. This means that if the chain was called via
6740 B<Jump>, the next target or rule after the jump will be executed. If the chain
6741 was not called by another chain, control will be returned to the daemon and it
6742 may pass the value to another chain.
6746 Most targets will signal the B<continue> condition, meaning that processing
6747 should continue normally. There is no special built-in target for this
6754 The configuration reflects this structure directly:
6756 PostCacheChain "PostCache"
6758 <Rule "ignore_mysql_show">
6761 Type "^mysql_command$"
6762 TypeInstance "^show_"
6772 The above configuration example will ignore all values where the plugin field
6773 is "mysql", the type is "mysql_command" and the type instance begins with
6774 "show_". All other values will be sent to the C<rrdtool> write plugin via the
6775 default target of the chain. Since this chain is run after the value has been
6776 added to the cache, the MySQL C<show_*> command statistics will be available
6777 via the C<unixsock> plugin.
6779 =head2 List of configuration options
6783 =item B<PreCacheChain> I<ChainName>
6785 =item B<PostCacheChain> I<ChainName>
6787 Configure the name of the "pre-cache chain" and the "post-cache chain". The
6788 argument is the name of a I<chain> that should be executed before and/or after
6789 the values have been added to the cache.
6791 To understand the implications, it's important you know what is going on inside
6792 I<collectd>. The following diagram shows how values are passed from the
6793 read-plugins to the write-plugins:
6799 + - - - - V - - - - +
6800 : +---------------+ :
6803 : +-------+-------+ :
6806 : +-------+-------+ : +---------------+
6807 : ! Cache !--->! Value Cache !
6808 : ! insert ! : +---+---+-------+
6809 : +-------+-------+ : ! !
6810 : ! ,------------' !
6812 : +-------+---+---+ : +-------+-------+
6813 : ! Post-Cache +--->! Write-Plugins !
6814 : ! Chain ! : +---------------+
6815 : +---------------+ :
6818 + - - - - - - - - - +
6820 After the values are passed from the "read" plugins to the dispatch functions,
6821 the pre-cache chain is run first. The values are added to the internal cache
6822 afterwards. The post-cache chain is run after the values have been added to the
6823 cache. So why is it such a huge deal if chains are run before or after the
6824 values have been added to this cache?
6826 Targets that change the identifier of a value list should be executed before
6827 the values are added to the cache, so that the name in the cache matches the
6828 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
6829 this cache to receive a list of all available values. If you change the
6830 identifier after the value list has been added to the cache, this may easily
6831 lead to confusion, but it's not forbidden of course.
6833 The cache is also used to convert counter values to rates. These rates are, for
6834 example, used by the C<value> match (see below). If you use the rate stored in
6835 the cache B<before> the new value is added, you will use the old, B<previous>
6836 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
6837 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
6840 Last but not last, the B<stop> target makes a difference: If the pre-cache
6841 chain returns the stop condition, the value will not be added to the cache and
6842 the post-cache chain will not be run.
6844 =item B<Chain> I<Name>
6846 Adds a new chain with a certain name. This name can be used to refer to a
6847 specific chain, for example to jump to it.
6849 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
6851 =item B<Rule> [I<Name>]
6853 Adds a new rule to the current chain. The name of the rule is optional and
6854 currently has no meaning for the daemon.
6856 Within the B<Rule> block, there may be any number of B<Match> blocks and there
6857 must be at least one B<Target> block.
6859 =item B<Match> I<Name>
6861 Adds a match to a B<Rule> block. The name specifies what kind of match should
6862 be performed. Available matches depend on the plugins that have been loaded.
6864 The arguments inside the B<Match> block are passed to the plugin implementing
6865 the match, so which arguments are valid here depends on the plugin being used.
6866 If you do not need any to pass any arguments to a match, you can use the
6871 Which is equivalent to:
6876 =item B<Target> I<Name>
6878 Add a target to a rule or a default target to a chain. The name specifies what
6879 kind of target is to be added. Which targets are available depends on the
6880 plugins being loaded.
6882 The arguments inside the B<Target> block are passed to the plugin implementing
6883 the target, so which arguments are valid here depends on the plugin being used.
6884 If you do not need any to pass any arguments to a target, you can use the
6889 This is the same as writing:
6896 =head2 Built-in targets
6898 The following targets are built into the core daemon and therefore need no
6899 plugins to be loaded:
6905 Signals the "return" condition, see the L<"Flow control"> section above. This
6906 causes the current chain to stop processing the value and returns control to
6907 the calling chain. The calling chain will continue processing targets and rules
6908 just after the B<jump> target (see below). This is very similar to the
6909 B<RETURN> target of iptables, see L<iptables(8)>.
6911 This target does not have any options.
6919 Signals the "stop" condition, see the L<"Flow control"> section above. This
6920 causes processing of the value to be aborted immediately. This is similar to
6921 the B<DROP> target of iptables, see L<iptables(8)>.
6923 This target does not have any options.
6931 Sends the value to "write" plugins.
6937 =item B<Plugin> I<Name>
6939 Name of the write plugin to which the data should be sent. This option may be
6940 given multiple times to send the data to more than one write plugin. If the
6941 plugin supports multiple instances, the plugin's instance(s) must also be
6946 If no plugin is explicitly specified, the values will be sent to all available
6949 Single-instance plugin example:
6955 Multi-instance plugin example:
6957 <Plugin "write_graphite">
6967 Plugin "write_graphite/foo"
6972 Starts processing the rules of another chain, see L<"Flow control"> above. If
6973 the end of that chain is reached, or a stop condition is encountered,
6974 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
6975 next target or the next rule. This is similar to the B<-j> command line option
6976 of iptables, see L<iptables(8)>.
6982 =item B<Chain> I<Name>
6984 Jumps to the chain I<Name>. This argument is required and may appear only once.
6996 =head2 Available matches
7002 Matches a value using regular expressions.
7008 =item B<Host> I<Regex>
7010 =item B<Plugin> I<Regex>
7012 =item B<PluginInstance> I<Regex>
7014 =item B<Type> I<Regex>
7016 =item B<TypeInstance> I<Regex>
7018 Match values where the given regular expressions match the various fields of
7019 the identifier of a value. If multiple regular expressions are given, B<all>
7020 regexen must match for a value to match.
7022 =item B<Invert> B<false>|B<true>
7024 When set to B<true>, the result of the match is inverted, i.e. all value lists
7025 where all regular expressions apply are not matched, all other value lists are
7026 matched. Defaults to B<false>.
7033 Host "customer[0-9]+"
7039 Matches values that have a time which differs from the time on the server.
7041 This match is mainly intended for servers that receive values over the
7042 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
7043 is very sensitive to the timestamp used when updating the RRD files. In
7044 particular, the time must be ever increasing. If a misbehaving client sends one
7045 packet with a timestamp far in the future, all further packets with a correct
7046 time will be ignored because of that one packet. What's worse, such corrupted
7047 RRD files are hard to fix.
7049 This match lets one match all values B<outside> a specified time range
7050 (relative to the server's time), so you can use the B<stop> target (see below)
7051 to ignore the value, for example.
7057 =item B<Future> I<Seconds>
7059 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
7060 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7063 =item B<Past> I<Seconds>
7065 Matches all values that are I<behind> of the server's time by I<Seconds> or
7066 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7078 This example matches all values that are five minutes or more ahead of the
7079 server or one hour (or more) lagging behind.
7083 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
7084 values. If a data-set consists of more than one data-source, all data-sources
7085 must match the specified ranges for a positive match.
7091 =item B<Min> I<Value>
7093 Sets the smallest value which still results in a match. If unset, behaves like
7096 =item B<Max> I<Value>
7098 Sets the largest value which still results in a match. If unset, behaves like
7101 =item B<Invert> B<true>|B<false>
7103 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
7104 no-match is returned and vice versa. Please note that the B<Invert> setting
7105 only effects how B<Min> and B<Max> are applied to a specific value. Especially
7106 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
7108 =item B<DataSource> I<DSName> [I<DSName> ...]
7110 Select one or more of the data sources. If no data source is configured, all
7111 data sources will be checked. If the type handled by the match does not have a
7112 data source of the specified name(s), this will always result in no match
7113 (independent of the B<Invert> setting).
7115 =item B<Satisfy> B<Any>|B<All>
7117 Specifies how checking with several data sources is performed. If set to
7118 B<Any>, the match succeeds if one of the data sources is in the configured
7119 range. If set to B<All> the match only succeeds if all data sources are within
7120 the configured range. Default is B<All>.
7122 Usually B<All> is used for positive matches, B<Any> is used for negative
7123 matches. This means that with B<All> you usually check that all values are in a
7124 "good" range, while with B<Any> you check if any value is within a "bad" range
7125 (or outside the "good" range).
7129 Either B<Min> or B<Max>, but not both, may be unset.
7133 # Match all values smaller than or equal to 100. Matches only if all data
7134 # sources are below 100.
7140 # Match if the value of any data source is outside the range of 0 - 100.
7148 =item B<empty_counter>
7150 Matches all values with one or more data sources of type B<COUNTER> and where
7151 all counter values are zero. These counters usually I<never> increased since
7152 they started existing (and are therefore uninteresting), or got reset recently
7153 or overflowed and you had really, I<really> bad luck.
7155 Please keep in mind that ignoring such counters can result in confusing
7156 behavior: Counters which hardly ever increase will be zero for long periods of
7157 time. If the counter is reset for some reason (machine or service restarted,
7158 usually), the graph will be empty (NAN) for a long time. People may not
7163 Calculates a hash value of the host name and matches values according to that
7164 hash value. This makes it possible to divide all hosts into groups and match
7165 only values that are in a specific group. The intended use is in load
7166 balancing, where you want to handle only part of all data and leave the rest
7169 The hashing function used tries to distribute the hosts evenly. First, it
7170 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
7173 for (i = 0; host[i] != 0; i++)
7174 hash_value = (hash_value * 251) + host[i];
7176 The constant 251 is a prime number which is supposed to make this hash value
7177 more random. The code then checks the group for this host according to the
7178 I<Total> and I<Match> arguments:
7180 if ((hash_value % Total) == Match)
7185 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
7186 groups), then the least significant bit of the hash value will be the XOR of
7187 all least significant bits in the host name. One consequence is that when you
7188 have two hosts, "server0.example.com" and "server1.example.com", where the host
7189 name differs in one digit only and the digits differ by one, those hosts will
7190 never end up in the same group.
7196 =item B<Match> I<Match> I<Total>
7198 Divide the data into I<Total> groups and match all hosts in group I<Match> as
7199 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
7200 be smaller than I<Total>. I<Total> must be at least one, although only values
7201 greater than one really do make any sense.
7203 You can repeat this option to match multiple groups, for example:
7208 The above config will divide the data into seven groups and match groups three
7209 and five. One use would be to keep every value on two hosts so that if one
7210 fails the missing data can later be reconstructed from the second host.
7216 # Operate on the pre-cache chain, so that ignored values are not even in the
7221 # Divide all received hosts in seven groups and accept all hosts in
7225 # If matched: Return and continue.
7228 # If not matched: Return and stop.
7234 =head2 Available targets
7238 =item B<notification>
7240 Creates and dispatches a notification.
7246 =item B<Message> I<String>
7248 This required option sets the message of the notification. The following
7249 placeholders will be replaced by an appropriate value:
7257 =item B<%{plugin_instance}>
7261 =item B<%{type_instance}>
7263 These placeholders are replaced by the identifier field of the same name.
7265 =item B<%{ds:>I<name>B<}>
7267 These placeholders are replaced by a (hopefully) human readable representation
7268 of the current rate of this data source. If you changed the instance name
7269 (using the B<set> or B<replace> targets, see below), it may not be possible to
7270 convert counter values to rates.
7274 Please note that these placeholders are B<case sensitive>!
7276 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
7278 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
7285 <Target "notification">
7286 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
7292 Replaces parts of the identifier using regular expressions.
7298 =item B<Host> I<Regex> I<Replacement>
7300 =item B<Plugin> I<Regex> I<Replacement>
7302 =item B<PluginInstance> I<Regex> I<Replacement>
7304 =item B<TypeInstance> I<Regex> I<Replacement>
7306 Match the appropriate field with the given regular expression I<Regex>. If the
7307 regular expression matches, that part that matches is replaced with
7308 I<Replacement>. If multiple places of the input buffer match a given regular
7309 expression, only the first occurrence will be replaced.
7311 You can specify each option multiple times to use multiple regular expressions
7319 # Replace "example.net" with "example.com"
7320 Host "\\<example.net\\>" "example.com"
7322 # Strip "www." from hostnames
7328 Sets part of the identifier of a value to a given string.
7334 =item B<Host> I<String>
7336 =item B<Plugin> I<String>
7338 =item B<PluginInstance> I<String>
7340 =item B<TypeInstance> I<String>
7342 Set the appropriate field to the given string. The strings for plugin instance
7343 and type instance may be empty, the strings for host and plugin may not be
7344 empty. It's currently not possible to set the type of a value this way.
7351 PluginInstance "coretemp"
7352 TypeInstance "core3"
7357 =head2 Backwards compatibility
7359 If you use collectd with an old configuration, i.E<nbsp>e. one without a
7360 B<Chain> block, it will behave as it used to. This is equivalent to the
7361 following configuration:
7367 If you specify a B<PostCacheChain>, the B<write> target will not be added
7368 anywhere and you will have to make sure that it is called where appropriate. We
7369 suggest to add the above snippet as default target to your "PostCache" chain.
7373 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
7389 L<collectd-exec(5)>,
7390 L<collectd-perl(5)>,
7391 L<collectd-unixsock(5)>,
7404 Florian Forster E<lt>octo@verplant.orgE<gt>