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.:
105 The following options are valid inside B<LoadPlugin> blocks:
109 =item B<Globals> B<true|false>
111 If enabled, collectd will export all global symbols of the plugin (and of all
112 libraries loaded as dependencies of the plugin) and, thus, makes those symbols
113 available for resolving unresolved symbols in subsequently loaded plugins if
114 that is supported by your system.
116 This is useful (or possibly even required), e.g., when loading a plugin that
117 embeds some scripting language into the daemon (e.g. the I<Perl> and
118 I<Python plugins>). Scripting languages usually provide means to load
119 extensions written in C. Those extensions require symbols provided by the
120 interpreter, which is loaded as a dependency of the respective collectd plugin.
121 See the documentation of those plugins (e.g., L<collectd-perl(5)> or
122 L<collectd-python(5)>) for details.
124 By default, this is disabled. As a special exception, if the plugin name is
125 either C<perl> or C<python>, the default is changed to enabled in order to keep
126 the average user from ever having to deal with this low level linking stuff.
128 =item B<Interval> I<Seconds>
130 Sets a plugin-specific interval for collecting metrics. This overrides the
131 global B<Interval> setting. If a plugin provides own support for specifying an
132 interval, that setting will take precedence.
136 =item B<AutoLoadPlugin> B<false>|B<true>
138 When set to B<false> (the default), each plugin needs to be loaded explicitly,
139 using the B<LoadPlugin> statement documented above. If a
140 B<E<lt>PluginE<nbsp>...E<gt>> block is encountered and no configuration
141 handling callback for this plugin has been registered, a warning is logged and
142 the block is ignored.
144 When set to B<true>, explicit B<LoadPlugin> statements are not required. Each
145 B<E<lt>PluginE<nbsp>...E<gt>> block acts as if it was immediately preceded by a
146 B<LoadPlugin> statement. B<LoadPlugin> statements are still required for
147 plugins that don't provide any configuration, e.g. the I<Load plugin>.
149 =item B<Include> I<Path> [I<pattern>]
151 If I<Path> points to a file, includes that file. If I<Path> points to a
152 directory, recursively includes all files within that directory and its
153 subdirectories. If the C<wordexp> function is available on your system,
154 shell-like wildcards are expanded before files are included. This means you can
155 use statements like the following:
157 Include "/etc/collectd.d/*.conf"
159 Starting with version 5.3, this may also be a block in which further options
160 affecting the behavior of B<Include> may be specified. The following option is
163 <Include "/etc/collectd.d">
169 =item B<Filter> I<pattern>
171 If the C<fnmatch> function is available on your system, a shell-like wildcard
172 I<pattern> may be specified to filter which files to include. This may be used
173 in combination with recursively including a directory to easily be able to
174 arbitrarily mix configuration files and other documents (e.g. README files).
175 The given example is similar to the first example above but includes all files
176 matching C<*.conf> in any subdirectory of C</etc/collectd.d>:
178 Include "/etc/collectd.d" "*.conf"
182 If more than one files are included by a single B<Include> option, the files
183 will be included in lexicographical order (as defined by the C<strcmp>
184 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
185 order in which the files are loaded.
187 To prevent loops and shooting yourself in the foot in interesting ways the
188 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
189 most uses. Since symlinks are followed it is still possible to crash the daemon
190 by looping symlinks. In our opinion significant stupidity should result in an
191 appropriate amount of pain.
193 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
194 file, but you cannot include files from within blocks.
196 =item B<PIDFile> I<File>
198 Sets where to write the PID file to. This file is overwritten when it exists
199 and deleted when the program is stopped. Some init-scripts might override this
200 setting using the B<-P> command-line option.
202 =item B<PluginDir> I<Directory>
204 Path to the plugins (shared objects) of collectd.
206 =item B<TypesDB> I<File> [I<File> ...]
208 Set one or more files that contain the data-set descriptions. See
209 L<types.db(5)> for a description of the format of this file.
211 =item B<Interval> I<Seconds>
213 Configures the interval in which to query the read plugins. Obviously smaller
214 values lead to a higher system load produced by collectd, while higher values
215 lead to more coarse statistics.
217 B<Warning:> You should set this once and then never touch it again. If you do,
218 I<you will have to delete all your RRD files> or know some serious RRDtool
219 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
221 =item B<MaxReadInterval> I<Seconds>
223 Read plugin doubles interval between queries after each failed attempt
226 This options limits the maximum value of the interval. The default value is
229 =item B<Timeout> I<Iterations>
231 Consider a value list "missing" when no update has been read or received for
232 I<Iterations> iterations. By default, I<collectd> considers a value list
233 missing when no update has been received for twice the update interval. Since
234 this setting uses iterations, the maximum allowed time without update depends
235 on the I<Interval> information contained in each value list. This is used in
236 the I<Threshold> configuration to dispatch notifications about missing values,
237 see L<collectd-threshold(5)> for details.
239 =item B<CollectInternalStats> I<true|false>
241 Some internal statistics can be recorded to monitor Collectd itself.
242 Default value : false.
244 =item B<ReadThreads> I<Num>
246 Number of threads to start for reading plugins. The default value is B<5>, but
247 you may want to increase this if you have more than five plugins that take a
248 long time to read. Mostly those are plugins that do network-IO. Setting this to
249 a value higher than the number of registered read callbacks is not recommended.
251 =item B<WriteThreads> I<Num>
253 Number of threads to start for dispatching value lists to write plugins. The
254 default value is B<5>, but you may want to increase this if you have more than
255 five plugins that may take relatively long to write to.
257 =item B<WriteQueueLimitHigh> I<HighNum>
259 =item B<WriteQueueLimitLow> I<LowNum>
261 Metrics are read by the I<read threads> and then put into a queue to be handled
262 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
263 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
264 running into memory issues in such a case, you can limit the size of this
267 By default, there is no limit and memory may grow indefinitely. This is most
268 likely not an issue for clients, i.e. instances that only handle the local
269 metrics. For servers it is recommended to set this to a non-zero value, though.
271 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
272 Each of them takes a numerical argument which is the number of metrics in the
273 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
274 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
275 I<will> be enqueued. If the number of metrics currently in the queue is between
276 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
277 proportional to the number of metrics in the queue (i.e. it increases linearly
278 until it reaches 100%.)
280 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
281 unset, the latter will default to half of B<WriteQueueLimitHigh>.
283 If you do not want to randomly drop values when the queue size is between
284 I<LowNum> and I<HighNum>, set If B<WriteQueueLimitHigh> and
285 B<WriteQueueLimitLow> to same value.
287 =item B<Hostname> I<Name>
289 Sets the hostname that identifies a host. If you omit this setting, the
290 hostname will be determined using the L<gethostname(2)> system call.
292 =item B<FQDNLookup> B<true|false>
294 If B<Hostname> is determined automatically this setting controls whether or not
295 the daemon should try to figure out the "fully qualified domain name", FQDN.
296 This is done using a lookup of the name returned by C<gethostname>. This option
297 is enabled by default.
299 =item B<PreCacheChain> I<ChainName>
301 =item B<PostCacheChain> I<ChainName>
303 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
304 see L<FILTER CONFIGURATION> below on information on chains and how these
305 setting change the daemon's behavior.
309 =head1 PLUGIN OPTIONS
311 Some plugins may register own options. These options must be enclosed in a
312 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
313 require external configuration, too. The C<apache plugin>, for example,
314 required C<mod_status> to be configured in the webserver you're going to
315 collect data from. These plugins are listed below as well, even if they don't
316 require any configuration within collectd's configuration file.
318 A list of all plugins and a short summary for each plugin can be found in the
319 F<README> file shipped with the sourcecode and hopefully binary packets as
322 =head2 Plugin C<aggregation>
324 The I<Aggregation plugin> makes it possible to aggregate several values into
325 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
326 This can be put to a wide variety of uses, e.g. average and total CPU
327 statistics for your entire fleet.
329 The grouping is powerful but, as with many powerful tools, may be a bit
330 difficult to wrap your head around. The grouping will therefore be
331 demonstrated using an example: The average and sum of the CPU usage across
332 all CPUs of each host is to be calculated.
334 To select all the affected values for our example, set C<Plugin cpu> and
335 C<Type cpu>. The other values are left unspecified, meaning "all values". The
336 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
337 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
343 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...) and
344 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
345 example, the intention is to have a new value for each host / type instance
346 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
347 It can be specified multiple times to group by more than one field.
350 GroupBy "TypeInstance"
352 We do neither specify nor group by I<plugin instance> (the CPU number), so all
353 metrics that differ in the CPU number only will be aggregated. Each
354 aggregation needs I<at least one> such field, otherwise no aggregation would
357 The full example configuration looks like this:
359 <Plugin "aggregation">
365 GroupBy "TypeInstance"
368 CalculateAverage true
372 There are a couple of limitations you should be aware of:
378 The I<Type> cannot be left unspecified, because it is not reasonable to add
379 apples to oranges. Also, the internal lookup structure won't work if you try
384 There must be at least one unspecified, ungrouped field. Otherwise nothing
389 As you can see in the example above, each aggregation has its own
390 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
391 blocks may match the same values, i.e. one value list can update multiple
392 aggregations. The following options are valid inside B<Aggregation> blocks:
396 =item B<Host> I<Host>
398 =item B<Plugin> I<Plugin>
400 =item B<PluginInstance> I<PluginInstance>
402 =item B<Type> I<Type>
404 =item B<TypeInstance> I<TypeInstance>
406 Selects the value lists to be added to this aggregation. B<Type> must be a
407 valid data set name, see L<types.db(5)> for details.
409 If the string starts with and ends with a slash (C</>), the string is
410 interpreted as a I<regular expression>. The regex flavor used are POSIX
411 extended regular expressions as described in L<regex(7)>. Example usage:
413 Host "/^db[0-9]\\.example\\.com$/"
415 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
417 Group valued by the specified field. The B<GroupBy> option may be repeated to
418 group by multiple fields.
420 =item B<SetHost> I<Host>
422 =item B<SetPlugin> I<Plugin>
424 =item B<SetPluginInstance> I<PluginInstance>
426 =item B<SetTypeInstance> I<TypeInstance>
428 Sets the appropriate part of the identifier to the provided string.
430 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
431 will be replaced with the aggregation function, e.g. "average". Not including
432 the placeholder will result in duplication warnings and/or messed up values if
433 more than one aggregation function are enabled.
435 The following example calculates the average usage of all "even" CPUs:
437 <Plugin "aggregation">
440 PluginInstance "/[0,2,4,6,8]$/"
444 SetPluginInstance "even-%{aggregation}"
447 GroupBy "TypeInstance"
449 CalculateAverage true
453 This will create the files:
459 foo.example.com/cpu-even-average/cpu-idle
463 foo.example.com/cpu-even-average/cpu-system
467 foo.example.com/cpu-even-average/cpu-user
475 =item B<CalculateNum> B<true>|B<false>
477 =item B<CalculateSum> B<true>|B<false>
479 =item B<CalculateAverage> B<true>|B<false>
481 =item B<CalculateMinimum> B<true>|B<false>
483 =item B<CalculateMaximum> B<true>|B<false>
485 =item B<CalculateStddev> B<true>|B<false>
487 Boolean options for enabling calculation of the number of value lists, their
488 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
489 are disabled by default.
493 =head2 Plugin C<amqp>
495 The I<AMQMP plugin> can be used to communicate with other instances of
496 I<collectd> or third party applications using an AMQP message broker. Values
497 are sent to or received from the broker, which handles routing, queueing and
498 possibly filtering or messages.
501 # Send values to an AMQP broker
502 <Publish "some_name">
508 Exchange "amq.fanout"
509 # ExchangeType "fanout"
510 # RoutingKey "collectd"
514 # GraphitePrefix "collectd."
515 # GraphiteEscapeChar "_"
516 # GraphiteSeparateInstances false
517 # GraphiteAlwaysAppendDS false
520 # Receive values from an AMQP broker
521 <Subscribe "some_name">
527 Exchange "amq.fanout"
528 # ExchangeType "fanout"
531 # QueueAutoDelete true
532 # RoutingKey "collectd.#"
536 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
537 blocks, which configure sending and receiving of values respectively. The two
538 blocks are very similar, so unless otherwise noted, an option can be used in
539 either block. The name given in the blocks starting tag is only used for
540 reporting messages, but may be used to support I<flushing> of certain
541 I<Publish> blocks in the future.
545 =item B<Host> I<Host>
547 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
548 the underlying communications library, I<rabbitmq-c>, which is "localhost".
550 =item B<Port> I<Port>
552 Service name or port number on which the AMQP broker accepts connections. This
553 argument must be a string, even if the numeric form is used. Defaults to
556 =item B<VHost> I<VHost>
558 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
560 =item B<User> I<User>
562 =item B<Password> I<Password>
564 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
567 =item B<Exchange> I<Exchange>
569 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
570 By default, "amq.fanout" will be used.
572 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
573 the given exchange and the I<queue> is created, using the I<routing key> if
574 configured. See the B<Queue> and B<RoutingKey> options below.
576 =item B<ExchangeType> I<Type>
578 If given, the plugin will try to create the configured I<exchange> with this
579 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
580 be bound to this exchange.
582 =item B<Queue> I<Queue> (Subscribe only)
584 Configures the I<queue> name to subscribe to. If no queue name was configured
585 explicitly, a unique queue name will be created by the broker.
587 =item B<QueueDurable> B<true>|B<false> (Subscribe only)
589 Defines if the I<queue> subscribed to is durable (saved to persistent storage)
590 or transient (will disappear if the AMQP broker is restarted). Defaults to
593 This option should be used in conjunction with the I<Persistent> option on the
596 =item B<QueueAutoDelete> B<true>|B<false> (Subscribe only)
598 Defines if the I<queue> subscribed to will be deleted once the last consumer
599 unsubscribes. Defaults to "true".
601 =item B<RoutingKey> I<Key>
603 In I<Publish> blocks, this configures the routing key to set on all outgoing
604 messages. If not given, the routing key will be computed from the I<identifier>
605 of the value. The host, plugin, type and the two instances are concatenated
606 together using dots as the separator and all containing dots replaced with
607 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
608 possible to receive only specific values using a "topic" exchange.
610 In I<Subscribe> blocks, configures the I<routing key> used when creating a
611 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
612 used to filter messages when using a "topic" exchange. If you're only
613 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
616 =item B<Persistent> B<true>|B<false> (Publish only)
618 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
619 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
620 default), the I<transient> delivery mode will be used, i.e. messages may be
621 lost due to high load, overflowing queues or similar issues.
623 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
625 Selects the format in which messages are sent to the broker. If set to
626 B<Command> (the default), values are sent as C<PUTVAL> commands which are
627 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
628 case, the C<Content-Type> header field will be set to C<text/collectd>.
630 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
631 an easy and straight forward exchange format. The C<Content-Type> header field
632 will be set to C<application/json>.
634 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
635 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
638 A subscribing client I<should> use the C<Content-Type> header field to
639 determine how to decode the values. Currently, the I<AMQP plugin> itself can
640 only decode the B<Command> format.
642 =item B<StoreRates> B<true>|B<false> (Publish only)
644 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
645 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
646 default), no conversion is performed. Otherwise the conversion is performed
647 using the internal value cache.
649 Please note that currently this option is only used if the B<Format> option has
652 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
654 A prefix can be added in the metric name when outputting in the I<Graphite> format.
655 It's added before the I<Host> name.
656 Metric name will be "<prefix><host><postfix><plugin><type><name>"
658 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
660 A postfix can be added in the metric name when outputting in the I<Graphite> format.
661 It's added after the I<Host> name.
662 Metric name will be "<prefix><host><postfix><plugin><type><name>"
664 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
666 Specify a character to replace dots (.) in the host part of the metric name.
667 In I<Graphite> metric name, dots are used as separators between different
668 metric parts (host, plugin, type).
669 Default is "_" (I<Underscore>).
671 =item B<GraphiteSeparateInstances> B<true>|B<false>
673 If set to B<true>, the plugin instance and type instance will be in their own
674 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
675 default), the plugin and plugin instance (and likewise the type and type
676 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
678 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
680 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
681 identifier. If set to B<false> (the default), this is only done when there is
686 =head2 Plugin C<apache>
688 To configure the C<apache>-plugin you first need to configure the Apache
689 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
690 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
691 the following snipped to base your Apache config upon:
694 <IfModule mod_status.c>
695 <Location /mod_status>
696 SetHandler server-status
700 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
701 also supported. It introduces a new field, called C<BusyServers>, to count the
702 number of currently connected clients. This field is also supported.
704 The configuration of the I<Apache> plugin consists of one or more
705 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
706 as the instance name. For example:
710 URL "http://www1.example.com/mod_status?auto"
713 URL "http://www2.example.com/mod_status?auto"
717 The instance name will be used as the I<plugin instance>. To emulate the old
718 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
719 plugin to work correctly, each instance name must be unique. This is not
720 enforced by the plugin and it is your responsibility to ensure it.
722 The following options are accepted within each I<Instance> block:
726 =item B<URL> I<http://host/mod_status?auto>
728 Sets the URL of the C<mod_status> output. This needs to be the output generated
729 by C<ExtendedStatus on> and it needs to be the machine readable output
730 generated by appending the C<?auto> argument. This option is I<mandatory>.
732 =item B<User> I<Username>
734 Optional user name needed for authentication.
736 =item B<Password> I<Password>
738 Optional password needed for authentication.
740 =item B<VerifyPeer> B<true|false>
742 Enable or disable peer SSL certificate verification. See
743 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
745 =item B<VerifyHost> B<true|false>
747 Enable or disable peer host name verification. If enabled, the plugin checks
748 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
749 certificate matches the host name provided by the B<URL> option. If this
750 identity check fails, the connection is aborted. Obviously, only works when
751 connecting to a SSL enabled server. Enabled by default.
753 =item B<CACert> I<File>
755 File that holds one or more SSL certificates. If you want to use HTTPS you will
756 possibly need this option. What CA certificates come bundled with C<libcurl>
757 and are checked by default depends on the distribution you use.
761 =head2 Plugin C<apcups>
765 =item B<Host> I<Hostname>
767 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
768 that IPv6 support has been disabled unless someone can confirm or decline that
769 B<apcupsd> can handle it.
771 =item B<Port> I<Port>
773 TCP-Port to connect to. Defaults to B<3551>.
775 =item B<ReportSeconds> B<true|false>
777 If set to B<true>, the time reported in the C<timeleft> metric will be
778 converted to seconds. This is the recommended setting. If set to B<false>, the
779 default for backwards compatibility, the time will be reported in minutes.
783 =head2 Plugin C<aquaero>
785 This plugin collects the value of the available sensors in an
786 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
787 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
788 connection for monitoring and configuration. The board can handle multiple
789 temperature sensors, fans, water pumps and water level sensors and adjust the
790 output settings such as fan voltage or power used by the water pump based on
791 the available inputs using a configurable controller included in the board.
792 This plugin collects all the available inputs as well as some of the output
793 values chosen by this controller. The plugin is based on the I<libaquaero5>
794 library provided by I<aquatools-ng>.
798 =item B<Device> I<DevicePath>
800 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
801 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
802 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
806 =head2 Plugin C<ascent>
808 This plugin collects information about an Ascent server, a free server for the
809 "World of Warcraft" game. This plugin gathers the information by fetching the
810 XML status page using C<libcurl> and parses it using C<libxml2>.
812 The configuration options are the same as for the C<apache> plugin above:
816 =item B<URL> I<http://localhost/ascent/status/>
818 Sets the URL of the XML status output.
820 =item B<User> I<Username>
822 Optional user name needed for authentication.
824 =item B<Password> I<Password>
826 Optional password needed for authentication.
828 =item B<VerifyPeer> B<true|false>
830 Enable or disable peer SSL certificate verification. See
831 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
833 =item B<VerifyHost> B<true|false>
835 Enable or disable peer host name verification. If enabled, the plugin checks
836 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
837 certificate matches the host name provided by the B<URL> option. If this
838 identity check fails, the connection is aborted. Obviously, only works when
839 connecting to a SSL enabled server. Enabled by default.
841 =item B<CACert> I<File>
843 File that holds one or more SSL certificates. If you want to use HTTPS you will
844 possibly need this option. What CA certificates come bundled with C<libcurl>
845 and are checked by default depends on the distribution you use.
849 =head2 Plugin C<barometer>
851 This plugin reads absolute air pressure using digital barometer sensor MPL115A2
852 or MPL3115 from Freescale (sensor attached to any I2C bus available in
853 the computer, for HW details see
854 I<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A> or
855 I<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>).
856 The sensor type - one fo these two - is detected automatically by the plugin
857 and indicated in the plugin_instance (typically you will see subdirectory
858 "barometer-mpl115" or "barometer-mpl3115").
860 The plugin provides absolute barometric pressure, air pressure reduced to sea
861 level (several possible approximations) and as an auxiliary value also internal
862 sensor temperature. It uses (expects/provides) typical metric units - pressure
863 in [hPa], temperature in [C], altitude in [m].
865 It was developed and tested under Linux only. The only platform dependency is
866 the standard Linux i2c-dev interface (the particular bus driver has to
867 support the SM Bus command subset).
869 The reduction or normalization to mean sea level pressure requires (depedning on
870 selected method/approximation) also altitude and reference to temperature sensor(s).
871 When multiple temperature sensors are configured the minumum of their values is
872 always used (expecting that the warmer ones are affected by e.g. direct sun light
881 TemperatureOffset 0.0
884 TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
889 =item B<Device> I<device>
891 Device name of the I2C bus to which the sensor is connected. Note that typically
892 you need to have loaded the i2c-dev module.
893 Using i2c-tools you can check/list i2c buses available on your system by:
897 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
901 This way you should be able to verify that the pressure sensor (either type) is
902 connected and detected on address 0x60.
904 =item B<Oversampling> I<value>
906 For MPL115 this is the size of the averaging window. To filter out sensor noise
907 a simple averaging using floating window of configurable size is used. The plugin
908 will use average of the last C<value> measurements (value of 1 means no averaging).
909 Minimal size is 1, maximal 1024.
911 For MPL3115 this is the oversampling value. The actual oversampling is performed
912 by the sensor and the higher value the higher accuracy and longer conversion time
913 (although nothing to worry about in the collectd context). Supported values are:
914 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is adjusted by the plugin to
915 the closest supported one. Default is 128.
917 =item B<PressureOffset> I<offset>
919 You can further calibrate the sensor by supplying pressure and/or temperature offsets.
920 This is added to the measured/caclulated value (i.e. if the measured value is too high
921 then use negative offset).
922 In hPa, default is 0.0.
924 =item B<TemperatureOffset> I<offset>
926 You can further calibrate the sensor by supplying pressure and/or temperature offsets.
927 This is added to the measured/caclulated value (i.e. if the measured value is too high
928 then use negative offset).
929 In C, default is 0.0.
931 =item B<Normalization> I<method>
933 Normalization method - what approximation/model is used to compute mean sea
934 level pressure from the air absolute pressure.
936 Supported values of the C<method> (integer between from 0 to 2) are:
940 =item B<0> - no conversion, absolute pressrure is simply copied over. For this method you
941 do not need to configure C<Altitude> or C<TemperatureSensor>.
943 =item B<1> - international formula for conversion ,
944 See I<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
945 For this method you have to configure C<Altitude> but do not need C<TemperatureSensor>
946 (uses fixed global temperature average instead).
948 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
949 Meteorological Service).
950 See I<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
951 For this method you have to configure both C<Altitude> and C<TemperatureSensor>.
956 =item B<Altitude> I<altitude>
958 The altitude (in meters) of the location where you meassure the pressure.
960 =item B<TemperatureSensor> I<reference>
962 Temperature sensor which should be used as a reference when normalizing the pressure.
963 When specified more sensors a minumum is found and uses each time.
964 The temperature reading directly from this pressure sensor/plugin
965 is typically not suitable as the pressure sensor
966 will be probably inside while we want outside temperature.
967 The collectd reference name is something like
968 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
969 (<type_instance> is usually omitted when there is just single value type).
970 Or you can figure it out from the path of the output data files.
974 =head2 Plugin C<bind>
976 Starting with BIND 9.5.0, the most widely used DNS server software provides
977 extensive statistics about queries, responses and lots of other information.
978 The bind plugin retrieves this information that's encoded in XML and provided
979 via HTTP and submits the values to collectd.
981 To use this plugin, you first need to tell BIND to make this information
982 available. This is done with the C<statistics-channels> configuration option:
984 statistics-channels {
985 inet localhost port 8053;
988 The configuration follows the grouping that can be seen when looking at the
989 data with an XSLT compatible viewer, such as a modern web browser. It's
990 probably a good idea to make yourself familiar with the provided values, so you
991 can understand what the collected statistics actually mean.
996 URL "http://localhost:8053/"
1011 Zone "127.in-addr.arpa/IN"
1015 The bind plugin accepts the following configuration options:
1021 URL from which to retrieve the XML data. If not specified,
1022 C<http://localhost:8053/> will be used.
1024 =item B<ParseTime> B<true>|B<false>
1026 When set to B<true>, the time provided by BIND will be parsed and used to
1027 dispatch the values. When set to B<false>, the local time source is queried.
1029 This setting is set to B<true> by default for backwards compatibility; setting
1030 this to B<false> is I<recommended> to avoid problems with timezones and
1033 =item B<OpCodes> B<true>|B<false>
1035 When enabled, statistics about the I<"OpCodes">, for example the number of
1036 C<QUERY> packets, are collected.
1040 =item B<QTypes> B<true>|B<false>
1042 When enabled, the number of I<incoming> queries by query types (for example
1043 C<A>, C<MX>, C<AAAA>) is collected.
1047 =item B<ServerStats> B<true>|B<false>
1049 Collect global server statistics, such as requests received over IPv4 and IPv6,
1050 successful queries, and failed updates.
1054 =item B<ZoneMaintStats> B<true>|B<false>
1056 Collect zone maintenance statistics, mostly information about notifications
1057 (zone updates) and zone transfers.
1061 =item B<ResolverStats> B<true>|B<false>
1063 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1064 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1065 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1066 default. Use the B<ResolverStats> option within a B<View "_default"> block
1067 instead for the same functionality.
1071 =item B<MemoryStats>
1073 Collect global memory statistics.
1077 =item B<View> I<Name>
1079 Collect statistics about a specific I<"view">. BIND can behave different,
1080 mostly depending on the source IP-address of the request. These different
1081 configurations are called "views". If you don't use this feature, you most
1082 likely are only interested in the C<_default> view.
1084 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1085 information you want to collect about a view. If no B<View> block is
1086 configured, no detailed view statistics will be collected.
1090 =item B<QTypes> B<true>|B<false>
1092 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1093 C<MX>) is collected.
1097 =item B<ResolverStats> B<true>|B<false>
1099 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1100 (e.E<nbsp>g. queries over IPv4, lame servers).
1104 =item B<CacheRRSets> B<true>|B<false>
1106 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1107 type is collected. Negative entries (queries which resulted in an error, for
1108 example names that do not exist) are reported with a leading exclamation mark,
1113 =item B<Zone> I<Name>
1115 When given, collect detailed information about the given zone in the view. The
1116 information collected if very similar to the global B<ServerStats> information
1119 You can repeat this option to collect detailed information about multiple
1122 By default no detailed zone information is collected.
1128 =head2 Plugin C<cgroups>
1130 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1131 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1132 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1136 =item B<CGroup> I<Directory>
1138 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1139 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1142 =item B<IgnoreSelected> B<true>|B<false>
1144 Invert the selection: If set to true, all cgroups I<except> the ones that
1145 match any one of the criteria are collected. By default only selected
1146 cgroups are collected if a selection is made. If no selection is configured
1147 at all, B<all> cgroups are selected.
1151 =head2 Plugin C<conntrack>
1153 This plugin collects IP conntrack statistics.
1159 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1160 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1164 =head2 Plugin C<cpu>
1166 The I<CPU plugin> collects CPU usage metrics.
1168 The following configuration options are available:
1172 =item B<ReportActive> B<false>|B<true>
1174 Reports non-idle CPU usage as the "active" value. Defaults to false.
1176 =item B<ReportByCpu> B<false>|B<true>
1178 When true reports usage for all cores. When false, reports cpu usage
1179 aggregated over all cores.
1182 =item B<ValuesPercentage> B<false>|B<true>
1184 When true report percentage usage instead of tick values. Defaults to false.
1189 =head2 Plugin C<cpufreq>
1191 This plugin doesn't have any options. It reads
1192 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1193 installed) to get the current CPU frequency. If this file does not exist make
1194 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1195 installed and an "cpu governor" (that's a kernel module) is loaded.
1197 =head2 Plugin C<csv>
1201 =item B<DataDir> I<Directory>
1203 Set the directory to store CSV-files under. Per default CSV-files are generated
1204 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1205 The special strings B<stdout> and B<stderr> can be used to write to the standard
1206 output and standard error channels, respectively. This, of course, only makes
1207 much sense when collectd is running in foreground- or non-daemon-mode.
1209 =item B<StoreRates> B<true|false>
1211 If set to B<true>, convert counter values to rates. If set to B<false> (the
1212 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1217 =head2 Plugin C<curl>
1219 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1220 and the match infrastructure (the same code used by the tail plugin) to use
1221 regular expressions with the received data.
1223 The following example will read the current value of AMD stock from Google's
1224 finance page and dispatch the value to collectd.
1227 <Page "stock_quotes">
1228 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1234 CACert "/path/to/ca.crt"
1235 Header "X-Custom-Header: foobar"
1238 MeasureResponseTime false
1239 MeasureResponseCode false
1242 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1243 DSType "GaugeAverage"
1244 # Note: `stock_value' is not a standard type.
1251 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1252 a web page and one or more "matches" to be performed on the returned data. The
1253 string argument to the B<Page> block is used as plugin instance.
1255 The following options are valid within B<Page> blocks:
1261 URL of the web site to retrieve. Since a regular expression will be used to
1262 extract information from this data, non-binary data is a big plus here ;)
1264 =item B<User> I<Name>
1266 Username to use if authorization is required to read the page.
1268 =item B<Password> I<Password>
1270 Password to use if authorization is required to read the page.
1272 =item B<Digest> B<true>|B<false>
1274 Enable HTTP digest authentication.
1276 =item B<VerifyPeer> B<true>|B<false>
1278 Enable or disable peer SSL certificate verification. See
1279 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1281 =item B<VerifyHost> B<true>|B<false>
1283 Enable or disable peer host name verification. If enabled, the plugin checks if
1284 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1285 matches the host name provided by the B<URL> option. If this identity check
1286 fails, the connection is aborted. Obviously, only works when connecting to a
1287 SSL enabled server. Enabled by default.
1289 =item B<CACert> I<file>
1291 File that holds one or more SSL certificates. If you want to use HTTPS you will
1292 possibly need this option. What CA certificates come bundled with C<libcurl>
1293 and are checked by default depends on the distribution you use.
1295 =item B<Header> I<Header>
1297 A HTTP header to add to the request. Multiple headers are added if this option
1298 is specified more than once.
1300 =item B<Post> I<Body>
1302 Specifies that the HTTP operation should be a POST instead of a GET. The
1303 complete data to be posted is given as the argument. This option will usually
1304 need to be accompanied by a B<Header> option to set an appropriate
1305 C<Content-Type> for the post body (e.g. to
1306 C<application/x-www-form-urlencoded>).
1308 =item B<MeasureResponseTime> B<true>|B<false>
1310 Measure response time for the request. If this setting is enabled, B<Match>
1311 blocks (see below) are optional. Disabled by default.
1313 =item B<MeasureResponseCode> B<true>|B<false>
1315 Measure response code for the request. If this setting is enabled, B<Match>
1316 blocks (see below) are optional. Disabled by default.
1318 =item B<E<lt>MatchE<gt>>
1320 One or more B<Match> blocks that define how to match information in the data
1321 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1322 used by the C<tail> plugin, so please see the documentation of the C<tail>
1323 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1324 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1329 =head2 Plugin C<curl_json>
1331 The B<curl_json plugin> collects values from JSON data to be parsed by
1332 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) retrieved via
1333 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1334 unix socket. The former can be used, for example, to collect values
1335 from CouchDB documents (which are stored JSON notation), and the
1336 latter to collect values from a uWSGI stats socket.
1338 The following example will collect several values from the built-in
1339 C<_stats> runtime statistics module of I<CouchDB>
1340 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1343 <URL "http://localhost:5984/_stats">
1345 <Key "httpd/requests/count">
1346 Type "http_requests"
1349 <Key "httpd_request_methods/*/count">
1350 Type "http_request_methods"
1353 <Key "httpd_status_codes/*/count">
1354 Type "http_response_codes"
1359 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1362 <Sock "/var/run/uwsgi.stats.sock">
1364 <Key "workers/*/requests">
1365 Type "http_requests"
1368 <Key "workers/*/apps/*/requests">
1369 Type "http_requests"
1374 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1375 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1376 blocks defining a unix socket to read JSON from directly. Each of
1377 these blocks may have one or more B<Key> blocks.
1379 The B<Key> string argument must be in a path format. Each component is
1380 used to match the key from a JSON map or the index of an JSON
1381 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1382 values for all map keys or array indices will be collectd.
1384 The following options are valid within B<URL> blocks:
1388 =item B<Instance> I<Instance>
1390 Sets the plugin instance to I<Instance>.
1392 =item B<Interval> I<Interval>
1394 Sets the interval (in seconds) in which the values will be collected from this
1395 URL. By default the global B<Interval> setting will be used.
1397 =item B<User> I<Name>
1399 =item B<Password> I<Password>
1401 =item B<Digest> B<true>|B<false>
1403 =item B<VerifyPeer> B<true>|B<false>
1405 =item B<VerifyHost> B<true>|B<false>
1407 =item B<CACert> I<file>
1409 =item B<Header> I<Header>
1411 =item B<Post> I<Body>
1413 These options behave exactly equivalent to the appropriate options of the
1414 I<cURL> plugin. Please see there for a detailed description.
1418 The following options are valid within B<Key> blocks:
1422 =item B<Type> I<Type>
1424 Sets the type used to dispatch the values to the daemon. Detailed information
1425 about types and their configuration can be found in L<types.db(5)>. This
1426 option is mandatory.
1428 =item B<Instance> I<Instance>
1430 Type-instance to use. Defaults to the current map key or current string array element value.
1434 =head2 Plugin C<curl_xml>
1436 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1437 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1440 <URL "http://localhost/stats.xml">
1442 Instance "some_instance"
1447 CACert "/path/to/ca.crt"
1448 Header "X-Custom-Header: foobar"
1451 <XPath "table[@id=\"magic_level\"]/tr">
1453 #InstancePrefix "prefix-"
1454 InstanceFrom "td[1]"
1455 ValuesFrom "td[2]/span[@class=\"level\"]"
1460 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1461 URL to be fetched using libcurl. Within each B<URL> block there are
1462 options which specify the connection parameters, for example authentication
1463 information, and one or more B<XPath> blocks.
1465 Each B<XPath> block specifies how to get one type of information. The
1466 string argument must be a valid XPath expression which returns a list
1467 of "base elements". One value is dispatched for each "base element". The
1468 I<type instance> and values are looked up using further I<XPath> expressions
1469 that should be relative to the base element.
1471 Within the B<URL> block the following options are accepted:
1475 =item B<Host> I<Name>
1477 Use I<Name> as the host name when submitting values. Defaults to the global
1480 =item B<Instance> I<Instance>
1482 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1483 empty string (no plugin instance).
1485 =item B<Namespace> I<Prefix> I<URL>
1487 If an XPath expression references namespaces, they must be specified
1488 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1489 I<URL> is the "namespace name", an URI reference uniquely identifying the
1490 namespace. The option can be repeated to register multiple namespaces.
1494 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1495 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1497 =item B<User> I<User>
1499 =item B<Password> I<Password>
1501 =item B<Digest> B<true>|B<false>
1503 =item B<VerifyPeer> B<true>|B<false>
1505 =item B<VerifyHost> B<true>|B<false>
1507 =item B<CACert> I<CA Cert File>
1509 =item B<Header> I<Header>
1511 =item B<Post> I<Body>
1513 These options behave exactly equivalent to the appropriate options of the
1514 I<cURL plugin>. Please see there for a detailed description.
1516 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1518 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1519 B<XPath> block specifies how to get one type of information. The string
1520 argument must be a valid XPath expression which returns a list of "base
1521 elements". One value is dispatched for each "base element".
1523 Within the B<XPath> block the following options are accepted:
1527 =item B<Type> I<Type>
1529 Specifies the I<Type> used for submitting patches. This determines the number
1530 of values that are required / expected and whether the strings are parsed as
1531 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1532 This option is required.
1534 =item B<InstancePrefix> I<InstancePrefix>
1536 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1537 concatenated together without any separator.
1538 This option is optional.
1540 =item B<InstanceFrom> I<InstanceFrom>
1542 Specifies a XPath expression to use for determining the I<type instance>. The
1543 XPath expression must return exactly one element. The element's value is then
1544 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1546 This value is required. As a special exception, if the "base XPath expression"
1547 (the argument to the B<XPath> block) returns exactly one argument, then this
1548 option may be omitted.
1550 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1552 Specifies one or more XPath expression to use for reading the values. The
1553 number of XPath expressions must match the number of data sources in the
1554 I<type> specified with B<Type> (see above). Each XPath expression must return
1555 exactly one element. The element's value is then parsed as a number and used as
1556 value for the appropriate value in the value list dispatched to the daemon.
1562 =head2 Plugin C<dbi>
1564 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1565 connect to various databases, execute I<SQL> statements and read back the
1566 results. I<dbi> is an acronym for "database interface" in case you were
1567 wondering about the name. You can configure how each column is to be
1568 interpreted and the plugin will generate one or more data sets from each row
1569 returned according to these rules.
1571 Because the plugin is very generic, the configuration is a little more complex
1572 than those of other plugins. It usually looks something like this:
1575 <Query "out_of_stock">
1576 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1577 # Use with MySQL 5.0.0 or later
1581 InstancePrefix "out_of_stock"
1582 InstancesFrom "category"
1586 <Database "product_information">
1588 DriverOption "host" "localhost"
1589 DriverOption "username" "collectd"
1590 DriverOption "password" "aZo6daiw"
1591 DriverOption "dbname" "prod_info"
1592 SelectDB "prod_info"
1593 Query "out_of_stock"
1597 The configuration above defines one query with one result and one database. The
1598 query is then linked to the database with the B<Query> option I<within> the
1599 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1600 and you can also use the B<Include> statement to split up the configuration
1601 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1602 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1605 The following is a complete list of options:
1607 =head3 B<Query> blocks
1609 Query blocks define I<SQL> statements and how the returned data should be
1610 interpreted. They are identified by the name that is given in the opening line
1611 of the block. Thus the name needs to be unique. Other than that, the name is
1612 not used in collectd.
1614 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1615 define which column holds which value or instance information. You can use
1616 multiple B<Result> blocks to create multiple values from one returned row. This
1617 is especially useful, when queries take a long time and sending almost the same
1618 query again and again is not desirable.
1622 <Query "environment">
1623 Statement "select station, temperature, humidity from environment"
1626 # InstancePrefix "foo"
1627 InstancesFrom "station"
1628 ValuesFrom "temperature"
1632 InstancesFrom "station"
1633 ValuesFrom "humidity"
1637 The following options are accepted:
1641 =item B<Statement> I<SQL>
1643 Sets the statement that should be executed on the server. This is B<not>
1644 interpreted by collectd, but simply passed to the database server. Therefore,
1645 the SQL dialect that's used depends on the server collectd is connected to.
1647 The query has to return at least two columns, one for the instance and one
1648 value. You cannot omit the instance, even if the statement is guaranteed to
1649 always return exactly one line. In that case, you can usually specify something
1652 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1654 (That works with MySQL but may not be valid SQL according to the spec. If you
1655 use a more strict database server, you may have to select from a dummy table or
1658 Please note that some databases, for example B<Oracle>, will fail if you
1659 include a semicolon at the end of the statement.
1661 =item B<MinVersion> I<Version>
1663 =item B<MaxVersion> I<Value>
1665 Only use this query for the specified database version. You can use these
1666 options to provide multiple queries with the same name but with a slightly
1667 different syntax. The plugin will use only those queries, where the specified
1668 minimum and maximum versions fit the version of the database in use.
1670 The database version is determined by C<dbi_conn_get_engine_version>, see the
1671 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1672 for details. Basically, each part of the version is assumed to be in the range
1673 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1674 "40102", version "5.0.42" becomes "50042".
1676 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1677 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1678 happen. Don't to it! A valid example would be something along these lines:
1689 In the above example, there are three ranges that don't overlap. The last one
1690 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1691 before "4.0.0" are not specified.
1693 =item B<Type> I<Type>
1695 The B<type> that's used for each line returned. See L<types.db(5)> for more
1696 details on how types are defined. In short: A type is a predefined layout of
1697 data and the number of values and type of values has to match the type
1700 If you specify "temperature" here, you need exactly one gauge column. If you
1701 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1704 There must be exactly one B<Type> option inside each B<Result> block.
1706 =item B<InstancePrefix> I<prefix>
1708 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1709 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1710 all strings returned in the appropriate columns are concatenated together,
1711 separated by dashes I<("-")>.
1713 =item B<InstancesFrom> I<column0> [I<column1> ...]
1715 Specifies the columns whose values will be used to create the "type-instance"
1716 for each row. If you specify more than one column, the value of all columns
1717 will be joined together with dashes I<("-")> as separation characters.
1719 The plugin itself does not check whether or not all built instances are
1720 different. It's your responsibility to assure that each is unique. This is
1721 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1722 sure that only one row is returned in this case.
1724 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1727 =item B<ValuesFrom> I<column0> [I<column1> ...]
1729 Names the columns whose content is used as the actual data for the data sets
1730 that are dispatched to the daemon. How many such columns you need is determined
1731 by the B<Type> setting above. If you specify too many or not enough columns,
1732 the plugin will complain about that and no data will be submitted to the
1735 The actual data type in the columns is not that important. The plugin will
1736 automatically cast the values to the right type if it know how to do that. So
1737 it should be able to handle integer an floating point types, as well as strings
1738 (if they include a number at the beginning).
1740 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1742 =item B<MetadataFrom> [I<column0> I<column1> ...]
1744 Names the columns whose content is used as metadata for the data sets
1745 that are dispatched to the daemon.
1747 The actual data type in the columns is not that important. The plugin will
1748 automatically cast the values to the right type if it know how to do that. So
1749 it should be able to handle integer an floating point types, as well as strings
1750 (if they include a number at the beginning).
1754 =head3 B<Database> blocks
1756 Database blocks define a connection to a database and which queries should be
1757 sent to that database. Since the used "dbi" library can handle a wide variety
1758 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1759 documentationE<nbsp>- we stick as close to the terminology used there.
1761 Each database needs a "name" as string argument in the starting tag of the
1762 block. This name will be used as "PluginInstance" in the values submitted to
1763 the daemon. Other than that, that name is not used.
1767 =item B<Driver> I<Driver>
1769 Specifies the driver to use to connect to the database. In many cases those
1770 drivers are named after the database they can connect to, but this is not a
1771 technical necessity. These drivers are sometimes referred to as "DBD",
1772 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1773 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1774 project at L<http://libdbi-drivers.sourceforge.net/>.
1776 You need to give the driver name as expected by the "dbi" library here. You
1777 should be able to find that in the documentation for each driver. If you
1778 mistype the driver name, the plugin will dump a list of all known driver names
1781 =item B<DriverOption> I<Key> I<Value>
1783 Sets driver-specific options. What option a driver supports can be found in the
1784 documentation for each driver, somewhere at
1785 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1786 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1788 DBDs can register two types of options: String options and numeric options. The
1789 plugin will use the C<dbi_conn_set_option> function when the configuration
1790 provides a string and the C<dbi_conn_require_option_numeric> function when the
1791 configuration provides a number. So these two lines will actually result in
1792 different calls being used:
1794 DriverOption "Port" 1234 # numeric
1795 DriverOption "Port" "1234" # string
1797 Unfortunately, drivers are not too keen to report errors when an unknown option
1798 is passed to them, so invalid settings here may go unnoticed. This is not the
1799 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1800 the driver. If a driver complains about an option, the plugin will dump a
1801 complete list of all options understood by that driver to the log. There is no
1802 way to programatically find out if an option expects a string or a numeric
1803 argument, so you will have to refer to the appropriate DBD's documentation to
1804 find this out. Sorry.
1806 =item B<SelectDB> I<Database>
1808 In some cases, the database name you connect with is not the database name you
1809 want to use for querying data. If this option is set, the plugin will "select"
1810 (switch to) that database after the connection is established.
1812 =item B<Query> I<QueryName>
1814 Associates the query named I<QueryName> with this database connection. The
1815 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1816 blocks you want to refer to must be placed above the database block you want to
1819 =item B<Host> I<Hostname>
1821 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
1822 values. Defaults to the global hostname setting.
1830 =item B<Device> I<Device>
1832 Select partitions based on the devicename.
1834 =item B<MountPoint> I<Directory>
1836 Select partitions based on the mountpoint.
1838 =item B<FSType> I<FSType>
1840 Select partitions based on the filesystem type.
1842 =item B<IgnoreSelected> B<true>|B<false>
1844 Invert the selection: If set to true, all partitions B<except> the ones that
1845 match any one of the criteria are collected. By default only selected
1846 partitions are collected if a selection is made. If no selection is configured
1847 at all, B<all> partitions are selected.
1849 =item B<ReportByDevice> B<true>|B<false>
1851 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1852 (the default), it will report a disk as "root", but with it I<true>, it will be
1853 "sda1" (or whichever).
1855 =item B<ReportInodes> B<true>|B<false>
1857 Enables or disables reporting of free, reserved and used inodes. Defaults to
1858 inode collection being disabled.
1860 Enable this option if inodes are a scarce resource for you, usually because
1861 many small files are stored on the disk. This is a usual scenario for mail
1862 transfer agents and web caches.
1864 =item B<ValuesAbsolute> B<true>|B<false>
1866 Enables or disables reporting of free and used disk space in 1K-blocks.
1867 Defaults to B<true>.
1869 =item B<ValuesPercentage> B<false>|B<true>
1871 Enables or disables reporting of free and used disk space in percentage.
1872 Defaults to B<false>.
1874 This is useful for deploying I<collectd> on the cloud, where machines with
1875 different disk size may exist. Then it is more practical to configure
1876 thresholds based on relative disk size.
1880 =head2 Plugin C<disk>
1882 The C<disk> plugin collects information about the usage of physical disks and
1883 logical disks (partitions). Values collected are the number of octets written
1884 to and read from a disk or partition, the number of read/write operations
1885 issued to the disk and a rather complex "time" it took for these commands to be
1888 Using the following two options you can ignore some disks or configure the
1889 collection only of specific disks.
1893 =item B<Disk> I<Name>
1895 Select the disk I<Name>. Whether it is collected or ignored depends on the
1896 B<IgnoreSelected> setting, see below. As with other plugins that use the
1897 daemon's ignorelist functionality, a string that starts and ends with a slash
1898 is interpreted as a regular expression. Examples:
1903 =item B<IgnoreSelected> B<true>|B<false>
1905 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1906 statements, are ignored or if all other disks are ignored. The behavior
1907 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1908 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1909 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1910 is set to B<true>, all disks are collected B<except> the ones matched.
1912 =item B<UseBSDName> B<true>|B<false>
1914 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
1915 default major/minor numbers. Requires collectd to be built with Apple's
1918 =item B<UdevNameAttr> I<Attribute>
1920 Attempt to override disk instance name with the value of a specified udev
1921 attribute when built with B<libudev>. If the attribute is not defined for the
1922 given device, the default name is used. Example:
1924 UdevNameAttr "DM_NAME"
1928 =head2 Plugin C<dns>
1932 =item B<Interface> I<Interface>
1934 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1935 option sets the interface that should be used. If this option is not set, or
1936 set to "any", the plugin will try to get packets from B<all> interfaces. This
1937 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1939 =item B<IgnoreSource> I<IP-address>
1941 Ignore packets that originate from this address.
1943 =item B<SelectNumericQueryTypes> B<true>|B<false>
1945 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1949 =head2 Plugin C<email>
1953 =item B<SocketFile> I<Path>
1955 Sets the socket-file which is to be created.
1957 =item B<SocketGroup> I<Group>
1959 If running as root change the group of the UNIX-socket after it has been
1960 created. Defaults to B<collectd>.
1962 =item B<SocketPerms> I<Permissions>
1964 Change the file permissions of the UNIX-socket after it has been created. The
1965 permissions must be given as a numeric, octal value as you would pass to
1966 L<chmod(1)>. Defaults to B<0770>.
1968 =item B<MaxConns> I<Number>
1970 Sets the maximum number of connections that can be handled in parallel. Since
1971 this many threads will be started immediately setting this to a very high
1972 value will waste valuable resources. Defaults to B<5> and will be forced to be
1973 at most B<16384> to prevent typos and dumb mistakes.
1977 =head2 Plugin C<ethstat>
1979 The I<ethstat plugin> collects information about network interface cards (NICs)
1980 by talking directly with the underlying kernel driver using L<ioctl(2)>.
1986 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
1987 Map "multicast" "if_multicast"
1994 =item B<Interface> I<Name>
1996 Collect statistical information about interface I<Name>.
1998 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2000 By default, the plugin will submit values as type C<derive> and I<type
2001 instance> set to I<Name>, the name of the metric as reported by the driver. If
2002 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2003 I<TypeInstance> will be used.
2005 =item B<MappedOnly> B<true>|B<false>
2007 When set to B<true>, only metrics that can be mapped to to a I<type> will be
2008 collected, all other metrics will be ignored. Defaults to B<false>.
2012 =head2 Plugin C<exec>
2014 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2015 contains valuable information on when the executable is executed and the
2016 output that is expected from it.
2020 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2022 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2024 Execute the executable I<Executable> as user I<User>. If the user name is
2025 followed by a colon and a group name, the effective group is set to that group.
2026 The real group and saved-set group will be set to the default group of that
2027 user. If no group is given the effective group ID will be the same as the real
2030 Please note that in order to change the user and/or group the daemon needs
2031 superuser privileges. If the daemon is run as an unprivileged user you must
2032 specify the same user/group here. If the daemon is run with superuser
2033 privileges, you must supply a non-root user here.
2035 The executable may be followed by optional arguments that are passed to the
2036 program. Please note that due to the configuration parsing numbers and boolean
2037 values may be changed. If you want to be absolutely sure that something is
2038 passed as-is please enclose it in quotes.
2040 The B<Exec> and B<NotificationExec> statements change the semantics of the
2041 programs executed, i.E<nbsp>e. the data passed to them and the response
2042 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2046 =head2 Plugin C<filecount>
2048 The C<filecount> plugin counts the number of files in a certain directory (and
2049 its subdirectories) and their combined size. The configuration is very straight
2052 <Plugin "filecount">
2053 <Directory "/var/qmail/queue/mess">
2054 Instance "qmail-message"
2056 <Directory "/var/qmail/queue/todo">
2057 Instance "qmail-todo"
2059 <Directory "/var/lib/php5">
2060 Instance "php5-sessions"
2065 The example above counts the number of files in QMail's queue directories and
2066 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2067 QMail has not yet looked at, the "message" queue holds the messages that were
2068 classified into "local" and "remote".
2070 As you can see, the configuration consists of one or more C<Directory> blocks,
2071 each of which specifies a directory in which to count the files. Within those
2072 blocks, the following options are recognized:
2076 =item B<Instance> I<Instance>
2078 Sets the plugin instance to I<Instance>. That instance name must be unique, but
2079 it's your responsibility, the plugin doesn't check for that. If not given, the
2080 instance is set to the directory name with all slashes replaced by underscores
2081 and all leading underscores removed.
2083 =item B<Name> I<Pattern>
2085 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2086 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2087 against the pattern, not the entire path. In case this makes it easier for you:
2088 This option has been named after the B<-name> parameter to L<find(1)>.
2090 =item B<MTime> I<Age>
2092 Count only files of a specific age: If I<Age> is greater than zero, only files
2093 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2094 a negative number, this is inversed. For example, if B<-60> is specified, only
2095 files that have been modified in the last minute will be counted.
2097 The number can also be followed by a "multiplier" to easily specify a larger
2098 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2099 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2100 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2101 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2102 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2105 =item B<Size> I<Size>
2107 Count only files of a specific size. When I<Size> is a positive number, only
2108 files that are at least this big are counted. If I<Size> is a negative number,
2109 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2110 I<Size> are counted.
2112 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2113 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2114 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2115 note that there are 1000 bytes in a kilobyte, not 1024.
2117 =item B<Recursive> I<true>|I<false>
2119 Controls whether or not to recurse into subdirectories. Enabled by default.
2121 =item B<IncludeHidden> I<true>|I<false>
2123 Controls whether or not to include "hidden" files and directories in the count.
2124 "Hidden" files and directories are those, whose name begins with a dot.
2125 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2129 =head2 Plugin C<GenericJMX>
2131 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2132 L<collectd-java(5)>.
2134 =head2 Plugin C<gmond>
2136 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2137 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2138 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2143 MCReceiveFrom "239.2.11.71" "8649"
2144 <Metric "swap_total">
2146 TypeInstance "total"
2149 <Metric "swap_free">
2156 The following metrics are built-in:
2162 load_one, load_five, load_fifteen
2166 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2170 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2182 Available configuration options:
2186 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2188 Sets sets the multicast group and UDP port to which to subscribe.
2190 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2192 =item E<lt>B<Metric> I<Name>E<gt>
2194 These blocks add a new metric conversion to the internal table. I<Name>, the
2195 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2199 =item B<Type> I<Type>
2201 Type to map this metric to. Required.
2203 =item B<TypeInstance> I<Instance>
2205 Type-instance to use. Optional.
2207 =item B<DataSource> I<Name>
2209 Data source to map this metric to. If the configured type has exactly one data
2210 source, this is optional. Otherwise the option is required.
2216 =head2 Plugin C<hddtemp>
2218 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
2219 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
2220 default values, see below. C<hddtemp> has to be running to work correctly. If
2221 C<hddtemp> is not running timeouts may appear which may interfere with other
2224 The B<hddtemp> homepage can be found at
2225 L<http://www.guzu.net/linux/hddtemp.php>.
2229 =item B<Host> I<Hostname>
2231 Hostname to connect to. Defaults to B<127.0.0.1>.
2233 =item B<Port> I<Port>
2235 TCP-Port to connect to. Defaults to B<7634>.
2239 =head2 Plugin C<interface>
2243 =item B<Interface> I<Interface>
2245 Select this interface. By default these interfaces will then be collected. For
2246 a more detailed description see B<IgnoreSelected> below.
2248 =item B<IgnoreSelected> I<true>|I<false>
2250 If no configuration if given, the B<traffic>-plugin will collect data from
2251 all interfaces. This may not be practical, especially for loopback- and
2252 similar interfaces. Thus, you can use the B<Interface>-option to pick the
2253 interfaces you're interested in. Sometimes, however, it's easier/preferred
2254 to collect all interfaces I<except> a few ones. This option enables you to
2255 do that: By setting B<IgnoreSelected> to I<true> the effect of
2256 B<Interface> is inverted: All selected interfaces are ignored and all
2257 other interfaces are collected.
2261 =head2 Plugin C<ipmi>
2265 =item B<Sensor> I<Sensor>
2267 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2269 =item B<IgnoreSelected> I<true>|I<false>
2271 If no configuration if given, the B<ipmi> plugin will collect data from all
2272 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2273 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2274 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2275 all other sensors are collected.
2277 =item B<NotifySensorAdd> I<true>|I<false>
2279 If a sensor appears after initialization time of a minute a notification
2282 =item B<NotifySensorRemove> I<true>|I<false>
2284 If a sensor disappears a notification is sent.
2286 =item B<NotifySensorNotPresent> I<true>|I<false>
2288 If you have for example dual power supply and one of them is (un)plugged then
2289 a notification is sent.
2293 =head2 Plugin C<iptables>
2297 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2299 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
2300 will collect the counters of all rules which have a comment-match. The comment
2301 is then used as type-instance.
2303 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2304 the I<n>th rule will be collected. Again, the comment (or the number) will be
2305 used as the type-instance.
2307 If I<Name> is supplied, it will be used as the type-instance instead of the
2308 comment or the number.
2312 =head2 Plugin C<irq>
2318 Select this irq. By default these irqs will then be collected. For a more
2319 detailed description see B<IgnoreSelected> below.
2321 =item B<IgnoreSelected> I<true>|I<false>
2323 If no configuration if given, the B<irq>-plugin will collect data from all
2324 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2325 can use the B<Irq>-option to pick the interrupt you're interested in.
2326 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2327 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2328 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2329 and all other interrupts are collected.
2333 =head2 Plugin C<java>
2335 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2336 This section only discusses the syntax and semantic of the configuration
2337 options. For more in-depth information on the I<Java> plugin, please read
2338 L<collectd-java(5)>.
2343 JVMArg "-verbose:jni"
2344 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2345 LoadPlugin "org.collectd.java.Foobar"
2346 <Plugin "org.collectd.java.Foobar">
2347 # To be parsed by the plugin
2351 Available configuration options:
2355 =item B<JVMArg> I<Argument>
2357 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2358 exactly the way the arguments to the I<java> binary on the command line work.
2359 Execute C<javaE<nbsp>--help> for details.
2361 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2362 any other options! When another option is found, the JVM will be started and
2363 later options will have to be ignored!
2365 =item B<LoadPlugin> I<JavaClass>
2367 Instantiates a new I<JavaClass> object. The constructor of this object very
2368 likely then registers one or more callback methods with the server.
2370 See L<collectd-java(5)> for details.
2372 When the first such option is found, the virtual machine (JVM) is created. This
2373 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2374 B<LoadPlugin> options!
2376 =item B<Plugin> I<Name>
2378 The entire block is passed to the Java plugin as an
2379 I<org.collectd.api.OConfigItem> object.
2381 For this to work, the plugin has to register a configuration callback first,
2382 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2383 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2384 depends on the (Java) plugin registering the callback and is completely
2385 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2389 =head2 Plugin C<libvirt>
2391 This plugin allows CPU, disk and network load to be collected for virtualized
2392 guests on the machine. This means that these characteristics can be collected
2393 for guest systems without installing any software on them - collectd only runs
2394 on the hosting system. The statistics are collected through libvirt
2395 (L<http://libvirt.org/>).
2397 Only I<Connection> is required.
2401 =item B<Connection> I<uri>
2403 Connect to the hypervisor given by I<uri>. For example if using Xen use:
2405 Connection "xen:///"
2407 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
2409 =item B<RefreshInterval> I<seconds>
2411 Refresh the list of domains and devices every I<seconds>. The default is 60
2412 seconds. Setting this to be the same or smaller than the I<Interval> will cause
2413 the list of domains and devices to be refreshed on every iteration.
2415 Refreshing the devices in particular is quite a costly operation, so if your
2416 virtualization setup is static you might consider increasing this. If this
2417 option is set to 0, refreshing is disabled completely.
2419 =item B<Domain> I<name>
2421 =item B<BlockDevice> I<name:dev>
2423 =item B<InterfaceDevice> I<name:dev>
2425 =item B<IgnoreSelected> I<true>|I<false>
2427 Select which domains and devices are collected.
2429 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
2430 disk/network devices are collected.
2432 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
2433 domains and disk/network devices are ignored, while the rest are collected.
2435 The domain name and device names may use a regular expression, if the name is
2436 surrounded by I</.../> and collectd was compiled with support for regexps.
2438 The default is to collect statistics for all domains and all their devices.
2442 BlockDevice "/:hdb/"
2443 IgnoreSelected "true"
2445 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
2448 =item B<HostnameFormat> B<name|uuid|hostname|...>
2450 When the libvirt plugin logs data, it sets the hostname of the collected data
2451 according to this setting. The default is to use the guest name as provided by
2452 the hypervisor, which is equal to setting B<name>.
2454 B<uuid> means use the guest's UUID. This is useful if you want to track the
2455 same guest across migrations.
2457 B<hostname> means to use the global B<Hostname> setting, which is probably not
2458 useful on its own because all guests will appear to have the same name.
2460 You can also specify combinations of these fields. For example B<name uuid>
2461 means to concatenate the guest name and UUID (with a literal colon character
2462 between, thus I<"foo:1234-1234-1234-1234">).
2464 =item B<InterfaceFormat> B<name>|B<address>
2466 When the libvirt plugin logs interface data, it sets the name of the collected
2467 data according to this setting. The default is to use the path as provided by
2468 the hypervisor (the "dev" property of the target node), which is equal to
2471 B<address> means use the interface's mac address. This is useful since the
2472 interface path might change between reboots of a guest or across migrations.
2474 =item B<PluginInstanceFormat> B<name|uuid>
2476 When the libvirt plugin logs data, it sets the plugin_instance of the collected
2477 data according to this setting. The default is to use the guest name as provided
2478 by the hypervisor, which is equal to setting B<name>.
2480 B<uuid> means use the guest's UUID.
2484 =head2 Plugin C<load>
2486 The I<Load plugin> collects the system load. These numbers give a rough overview
2487 over the utilization of a machine. The system load is defined as the number of
2488 runnable tasks in the run-queue and is provided by many operating systems as a
2489 one, five or fifteen minute average.
2491 The following configuration options are available:
2495 =item B<ReportRelative> B<false>|B<true>
2497 When enabled, system load divided by number of available CPU cores is reported
2498 for intervals 1 min, 5 min and 15 min. Defaults to false.
2503 =head2 Plugin C<logfile>
2507 =item B<LogLevel> B<debug|info|notice|warning|err>
2509 Sets the log-level. If, for example, set to B<notice>, then all events with
2510 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2512 Please note that B<debug> is only available if collectd has been compiled with
2515 =item B<File> I<File>
2517 Sets the file to write log messages to. The special strings B<stdout> and
2518 B<stderr> can be used to write to the standard output and standard error
2519 channels, respectively. This, of course, only makes much sense when I<collectd>
2520 is running in foreground- or non-daemon-mode.
2522 =item B<Timestamp> B<true>|B<false>
2524 Prefix all lines printed by the current time. Defaults to B<true>.
2526 =item B<PrintSeverity> B<true>|B<false>
2528 When enabled, all lines are prefixed by the severity of the log message, for
2529 example "warning". Defaults to B<false>.
2533 B<Note>: There is no need to notify the daemon after moving or removing the
2534 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2535 for each line it writes.
2537 =head2 Plugin C<log_logstash>
2539 The I<log logstash plugin> behaves like the logfile plugin but formats
2540 messages as JSON events for logstash to parse and input.
2544 =item B<LogLevel> B<debug|info|notice|warning|err>
2546 Sets the log-level. If, for example, set to B<notice>, then all events with
2547 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2549 Please note that B<debug> is only available if collectd has been compiled with
2552 =item B<File> I<File>
2554 Sets the file to write log messages to. The special strings B<stdout> and
2555 B<stderr> can be used to write to the standard output and standard error
2556 channels, respectively. This, of course, only makes much sense when I<collectd>
2557 is running in foreground- or non-daemon-mode.
2561 B<Note>: There is no need to notify the daemon after moving or removing the
2562 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2563 for each line it writes.
2565 =head2 Plugin C<lpar>
2567 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2568 virtualization technique for IBM POWER processors. It takes into account CPU
2569 time stolen from or donated to a partition, in addition to the usual user,
2570 system, I/O statistics.
2572 The following configuration options are available:
2576 =item B<CpuPoolStats> B<false>|B<true>
2578 When enabled, statistics about the processor pool are read, too. The partition
2579 needs to have pool authority in order to be able to acquire this information.
2582 =item B<ReportBySerial> B<false>|B<true>
2584 If enabled, the serial of the physical machine the partition is currently
2585 running on is reported as I<hostname> and the logical hostname of the machine
2586 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2587 used (just like other plugins) and the I<plugin instance> will be empty.
2592 =head2 Plugin C<mbmon>
2594 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2596 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2597 B<Host> and B<Port> options can be used to change these values, see below.
2598 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2599 timeouts may appear which may interfere with other statistics..
2601 C<mbmon> must be run with the -r option ("print TAG and Value format");
2602 Debian's F</etc/init.d/mbmon> script already does this, other people
2603 will need to ensure that this is the case.
2607 =item B<Host> I<Hostname>
2609 Hostname to connect to. Defaults to B<127.0.0.1>.
2611 =item B<Port> I<Port>
2613 TCP-Port to connect to. Defaults to B<411>.
2619 The C<md plugin> collects information from Linux Software-RAID devices (md).
2621 All reported values are of the type C<md_disks>. Reported type instances are
2622 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2623 I<missing> (physically absent) disks.
2627 =item B<Device> I<Device>
2629 Select md devices based on device name. The I<device name> is the basename of
2630 the device, i.e. the name of the block device without the leading C</dev/>.
2631 See B<IgnoreSelected> for more details.
2633 =item B<IgnoreSelected> B<true>|B<false>
2635 Invert device selection: If set to B<true>, all md devices B<except> those
2636 listed using B<Device> are collected. If B<false> (the default), only those
2637 listed are collected. If no configuration is given, the B<md> plugin will
2638 collect data from all md devices.
2642 =head2 Plugin C<memcachec>
2644 The C<memcachec plugin> connects to a memcached server, queries one or more
2645 given I<pages> and parses the returned data according to user specification.
2646 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2649 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2650 library. Please note that there is another library with a very similar name,
2651 libmemcache (notice the missing `d'), which is not applicable.
2653 Synopsis of the configuration:
2655 <Plugin "memcachec">
2656 <Page "plugin_instance">
2660 Regex "(\\d+) bytes sent"
2663 Instance "type_instance"
2668 The configuration options are:
2672 =item E<lt>B<Page> I<Name>E<gt>
2674 Each B<Page> block defines one I<page> to be queried from the memcached server.
2675 The block requires one string argument which is used as I<plugin instance>.
2677 =item B<Server> I<Address>
2679 Sets the server address to connect to when querying the page. Must be inside a
2684 When connected to the memcached server, asks for the page I<Key>.
2686 =item E<lt>B<Match>E<gt>
2688 Match blocks define which strings to look for and how matches substrings are
2689 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2693 =head2 Plugin C<memcached>
2695 The B<memcached plugin> connects to a memcached server and queries statistics
2696 about cache utilization, memory and bandwidth used.
2697 L<http://www.danga.com/memcached/>
2699 <Plugin "memcached">
2701 Host "memcache.example.com"
2706 The plugin configuration consists of one or more B<Instance> blocks which
2707 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2708 following options are allowed:
2712 =item B<Host> I<Hostname>
2714 Hostname to connect to. Defaults to B<127.0.0.1>.
2716 =item B<Port> I<Port>
2718 TCP-Port to connect to. Defaults to B<11211>.
2720 =item B<Socket> I<Path>
2722 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2723 setting is given, the B<Host> and B<Port> settings are ignored.
2727 =head2 Plugin C<mic>
2729 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2730 Intel's Many Integrated Core (MIC) systems.
2739 ShowTemperatures true
2742 IgnoreSelectedTemperature true
2747 IgnoreSelectedPower true
2750 The following options are valid inside the B<PluginE<nbsp>mic> block:
2754 =item B<ShowCPU> B<true>|B<false>
2756 If enabled (the default) a sum of the CPU usage across all cores is reported.
2758 =item B<ShowCPUCores> B<true>|B<false>
2760 If enabled (the default) per-core CPU usage is reported.
2762 =item B<ShowMemory> B<true>|B<false>
2764 If enabled (the default) the physical memory usage of the MIC system is
2767 =item B<ShowTemperatures> B<true>|B<false>
2769 If enabled (the default) various temperatures of the MIC system are reported.
2771 =item B<Temperature> I<Name>
2773 This option controls which temperatures are being reported. Whether matching
2774 temperatures are being ignored or I<only> matching temperatures are reported
2775 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2776 temperatures are reported.
2778 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2780 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2781 (the default) only temperatures matching a B<Temperature> option are reported
2782 or, if no B<Temperature> option is specified, all temperatures are reported. If
2783 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2786 Known temperature names are:
2820 =item B<ShowPower> B<true>|B<false>
2822 If enabled (the default) various temperatures of the MIC system are reported.
2824 =item B<Power> I<Name>
2826 This option controls which power readings are being reported. Whether matching
2827 power readings are being ignored or I<only> matching power readings are reported
2828 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
2829 power readings are reported.
2831 =item B<IgnoreSelectedPower> B<false>|B<true>
2833 Controls the behavior of the B<Power> setting above. If set to B<false>
2834 (the default) only power readings matching a B<Power> option are reported
2835 or, if no B<Power> option is specified, all power readings are reported. If
2836 set to B<true>, matching power readings are I<ignored> and all other power readings
2839 Known power names are:
2845 Total power utilization averaged over Time Window 0 (uWatts).
2849 Total power utilization averaged over Time Window 0 (uWatts).
2853 Instantaneous power (uWatts).
2857 Max instantaneous power (uWatts).
2861 PCI-E connector power (uWatts).
2865 2x3 connector power (uWatts).
2869 2x4 connector power (uWatts).
2877 Uncore rail (uVolts).
2881 Memory subsystem rail (uVolts).
2887 =head2 Plugin C<memory>
2889 The I<memory plugin> provides the following configuration options:
2893 =item B<ValuesAbsolute> B<true>|B<false>
2895 Enables or disables reporting of physical memory usage in absolute numbers,
2896 i.e. bytes. Defaults to B<true>.
2898 =item B<ValuesPercentage> B<false>|B<true>
2900 Enables or disables reporting of physical memory usage in percentages, e.g.
2901 percent of physical memory used. Defaults to B<false>.
2903 This is useful for deploying I<collectd> in a heterogeneous environment in
2904 which the sizes of physical memory vary.
2908 =head2 Plugin C<modbus>
2910 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
2911 register values. It supports reading single registers (unsigned 16E<nbsp>bit
2912 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2913 values (two registers interpreted as IEEE floats in big endian notation).
2917 <Data "voltage-input-1">
2924 <Data "voltage-input-2">
2931 <Host "modbus.example.com">
2932 Address "192.168.0.42"
2937 Instance "power-supply"
2938 Collect "voltage-input-1"
2939 Collect "voltage-input-2"
2945 =item E<lt>B<Data> I<Name>E<gt> blocks
2947 Data blocks define a mapping between register numbers and the "types" used by
2950 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
2954 =item B<RegisterBase> I<Number>
2956 Configures the base register to read from the device. If the option
2957 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
2958 register will be read (the register number is increased by one).
2960 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
2962 Specifies what kind of data is returned by the device. If the type is B<Int32>,
2963 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
2964 combined into one value. Defaults to B<Uint16>.
2966 =item B<Type> I<Type>
2968 Specifies the "type" (data set) to use when dispatching the value to
2969 I<collectd>. Currently, only data sets with exactly one data source are
2972 =item B<Instance> I<Instance>
2974 Sets the type instance to use when dispatching the value to I<collectd>. If
2975 unset, an empty string (no type instance) is used.
2979 =item E<lt>B<Host> I<Name>E<gt> blocks
2981 Host blocks are used to specify to which hosts to connect and what data to read
2982 from their "slaves". The string argument I<Name> is used as hostname when
2983 dispatching the values to I<collectd>.
2985 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
2989 =item B<Address> I<Hostname>
2991 Specifies the node name (the actual network address) used to connect to the
2992 host. This may be an IP address or a hostname. Please note that the used
2993 I<libmodbus> library only supports IPv4 at the moment.
2995 =item B<Port> I<Service>
2997 Specifies the port used to connect to the host. The port can either be given as
2998 a number or as a service name. Please note that the I<Service> argument must be
2999 a string, even if ports are given in their numerical form. Defaults to "502".
3001 =item B<Interval> I<Interval>
3003 Sets the interval (in seconds) in which the values will be collected from this
3004 host. By default the global B<Interval> setting will be used.
3006 =item E<lt>B<Slave> I<ID>E<gt>
3008 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
3009 is used to specify which device should be addressed. For each device you want
3010 to query, one B<Slave> block must be given.
3012 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
3016 =item B<Instance> I<Instance>
3018 Specify the plugin instance to use when dispatching the values to I<collectd>.
3019 By default "slave_I<ID>" is used.
3021 =item B<Collect> I<DataName>
3023 Specifies which data to retrieve from the device. I<DataName> must be the same
3024 string as the I<Name> argument passed to a B<Data> block. You can specify this
3025 option multiple times to collect more than one value from a slave. At least one
3026 B<Collect> option is mandatory.
3034 =head2 Plugin C<mysql>
3036 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
3037 one or more databases when started and keeps the connection up as long as
3038 possible. When the connection is interrupted for whatever reason it will try
3039 to re-connect. The plugin will complain loudly in case anything goes wrong.
3041 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
3042 and collects information about MySQL network traffic, executed statements,
3043 requests, the query cache and threads by evaluating the
3044 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
3045 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
3046 Status Variables> for an explanation of these values.
3048 Optionally, master and slave statistics may be collected in a MySQL
3049 replication setup. In that case, information about the synchronization state
3050 of the nodes are collected by evaluating the C<Position> return value of the
3051 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
3052 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
3053 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
3054 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
3055 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
3072 Socket "/var/run/mysql/mysqld.sock"
3074 SlaveNotifications true
3078 A B<Database> block defines one connection to a MySQL database. It accepts a
3079 single argument which specifies the name of the database. None of the other
3080 options are required. MySQL will use default values as documented in the
3081 section "mysql_real_connect()" in the B<MySQL reference manual>.
3085 =item B<Alias> I<Alias>
3087 Alias to use as sender instead of hostname when reporting. This may be useful
3088 when having cryptic hostnames.
3090 =item B<Host> I<Hostname>
3092 Hostname of the database server. Defaults to B<localhost>.
3094 =item B<User> I<Username>
3096 Username to use when connecting to the database. The user does not have to be
3097 granted any privileges (which is synonym to granting the C<USAGE> privilege),
3098 unless you want to collectd replication statistics (see B<MasterStats> and
3099 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
3100 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
3102 =item B<Password> I<Password>
3104 Password needed to log into the database.
3106 =item B<Database> I<Database>
3108 Select this database. Defaults to I<no database> which is a perfectly reasonable
3109 option for what this plugin does.
3111 =item B<Port> I<Port>
3113 TCP-port to connect to. The port must be specified in its numeric form, but it
3114 must be passed as a string nonetheless. For example:
3118 If B<Host> is set to B<localhost> (the default), this setting has no effect.
3119 See the documentation for the C<mysql_real_connect> function for details.
3121 =item B<Socket> I<Socket>
3123 Specifies the path to the UNIX domain socket of the MySQL server. This option
3124 only has any effect, if B<Host> is set to B<localhost> (the default).
3125 Otherwise, use the B<Port> option above. See the documentation for the
3126 C<mysql_real_connect> function for details.
3128 =item B<InnodbStats> I<true|false>
3130 If enabled, metrics about the InnoDB storage engine are collected.
3131 Disabled by default.
3133 =item B<MasterStats> I<true|false>
3135 =item B<SlaveStats> I<true|false>
3137 Enable the collection of master / slave statistics in a replication setup. In
3138 order to be able to get access to these statistics, the user needs special
3139 privileges. See the B<User> documentation above.
3141 =item B<SlaveNotifications> I<true|false>
3143 If enabled, the plugin sends a notification if the replication slave I/O and /
3144 or SQL threads are not running.
3146 =item B<ConnectTimeout> I<Seconds>
3148 Sets the connect timeout for the MySQL client.
3152 =head2 Plugin C<netapp>
3154 The netapp plugin can collect various performance and capacity information
3155 from a NetApp filer using the NetApp API.
3157 Please note that NetApp has a wide line of products and a lot of different
3158 software versions for each of these products. This plugin was developed for a
3159 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
3160 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
3161 model and software version but it is very hard to test this.
3162 If you have used this plugin with other models and/or software version, feel
3163 free to send us a mail to tell us about the results, even if it's just a short
3166 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
3167 basic authentication.
3169 B<Do not use a regular user for this!> Create a special collectd user with just
3170 the minimum of capabilities needed. The user only needs the "login-http-admin"
3171 capability as well as a few more depending on which data will be collected.
3172 Required capabilities are documented below.
3177 <Host "netapp1.example.com">
3201 IgnoreSelectedIO false
3203 IgnoreSelectedOps false
3204 GetLatency "volume0"
3205 IgnoreSelectedLatency false
3212 IgnoreSelectedCapacity false
3215 IgnoreSelectedSnapshot false
3243 The netapp plugin accepts the following configuration options:
3247 =item B<Host> I<Name>
3249 A host block defines one NetApp filer. It will appear in collectd with the name
3250 you specify here which does not have to be its real name nor its hostname (see
3251 the B<Address> option below).
3253 =item B<VFiler> I<Name>
3255 A B<VFiler> block may only be used inside a host block. It accepts all the
3256 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
3257 will execute all NetApp API commands in the context of the specified
3258 VFiler(R). It will appear in collectd with the name you specify here which
3259 does not have to be its real name. The VFiler name may be specified using the
3260 B<VFilerName> option. If this is not specified, it will default to the name
3263 The VFiler block inherits all connection related settings from the surrounding
3264 B<Host> block (which appear before the B<VFiler> block) but they may be
3265 overwritten inside the B<VFiler> block.
3267 This feature is useful, for example, when using a VFiler as SnapVault target
3268 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
3269 available in the host filer (vfiler0) but only in the respective VFiler
3272 =item B<Protocol> B<httpd>|B<http>
3274 The protocol collectd will use to query this host.
3282 Valid options: http, https
3284 =item B<Address> I<Address>
3286 The hostname or IP address of the host.
3292 Default: The "host" block's name.
3294 =item B<Port> I<Port>
3296 The TCP port to connect to on the host.
3302 Default: 80 for protocol "http", 443 for protocol "https"
3304 =item B<User> I<User>
3306 =item B<Password> I<Password>
3308 The username and password to use to login to the NetApp.
3314 =item B<VFilerName> I<Name>
3316 The name of the VFiler in which context to execute API commands. If not
3317 specified, the name provided to the B<VFiler> block will be used instead.
3323 Default: name of the B<VFiler> block
3325 B<Note:> This option may only be used inside B<VFiler> blocks.
3327 =item B<Interval> I<Interval>
3333 The following options decide what kind of data will be collected. You can
3334 either use them as a block and fine tune various parameters inside this block,
3335 use them as a single statement to just accept all default values, or omit it to
3336 not collect any data.
3338 The following options are valid inside all blocks:
3342 =item B<Interval> I<Seconds>
3344 Collect the respective statistics every I<Seconds> seconds. Defaults to the
3345 host specific setting.
3349 =head3 The System block
3351 This will collect various performance data about the whole system.
3353 B<Note:> To get this data the collectd user needs the
3354 "api-perf-object-get-instances" capability.
3358 =item B<Interval> I<Seconds>
3360 Collect disk statistics every I<Seconds> seconds.
3362 =item B<GetCPULoad> B<true>|B<false>
3364 If you set this option to true the current CPU usage will be read. This will be
3365 the average usage between all CPUs in your NetApp without any information about
3368 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3369 returns in the "CPU" field.
3377 Result: Two value lists of type "cpu", and type instances "idle" and "system".
3379 =item B<GetInterfaces> B<true>|B<false>
3381 If you set this option to true the current traffic of the network interfaces
3382 will be read. This will be the total traffic over all interfaces of your NetApp
3383 without any information about individual interfaces.
3385 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3386 in the "Net kB/s" field.
3396 Result: One value list of type "if_octects".
3398 =item B<GetDiskIO> B<true>|B<false>
3400 If you set this option to true the current IO throughput will be read. This
3401 will be the total IO of your NetApp without any information about individual
3402 disks, volumes or aggregates.
3404 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3405 in the "DiskE<nbsp>kB/s" field.
3413 Result: One value list of type "disk_octets".
3415 =item B<GetDiskOps> B<true>|B<false>
3417 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
3418 iSCSI, etc. operations will be read. This will be the total number of
3419 operations on your NetApp without any information about individual volumes or
3422 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3423 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
3431 Result: A variable number of value lists of type "disk_ops_complex". Each type
3432 of operation will result in one value list with the name of the operation as
3437 =head3 The WAFL block
3439 This will collect various performance data about the WAFL file system. At the
3440 moment this just means cache performance.
3442 B<Note:> To get this data the collectd user needs the
3443 "api-perf-object-get-instances" capability.
3445 B<Note:> The interface to get these values is classified as "Diagnostics" by
3446 NetApp. This means that it is not guaranteed to be stable even between minor
3451 =item B<Interval> I<Seconds>
3453 Collect disk statistics every I<Seconds> seconds.
3455 =item B<GetNameCache> B<true>|B<false>
3463 Result: One value list of type "cache_ratio" and type instance
3466 =item B<GetDirCache> B<true>|B<false>
3474 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3476 =item B<GetInodeCache> B<true>|B<false>
3484 Result: One value list of type "cache_ratio" and type instance
3487 =item B<GetBufferCache> B<true>|B<false>
3489 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3490 in the "Cache hit" field.
3498 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3502 =head3 The Disks block
3504 This will collect performance data about the individual disks in the NetApp.
3506 B<Note:> To get this data the collectd user needs the
3507 "api-perf-object-get-instances" capability.
3511 =item B<Interval> I<Seconds>
3513 Collect disk statistics every I<Seconds> seconds.
3515 =item B<GetBusy> B<true>|B<false>
3517 If you set this option to true the busy time of all disks will be calculated
3518 and the value of the busiest disk in the system will be written.
3520 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3521 in the "Disk util" field. Probably.
3529 Result: One value list of type "percent" and type instance "disk_busy".
3533 =head3 The VolumePerf block
3535 This will collect various performance data about the individual volumes.
3537 You can select which data to collect about which volume using the following
3538 options. They follow the standard ignorelist semantic.
3540 B<Note:> To get this data the collectd user needs the
3541 I<api-perf-object-get-instances> capability.
3545 =item B<Interval> I<Seconds>
3547 Collect volume performance data every I<Seconds> seconds.
3549 =item B<GetIO> I<Volume>
3551 =item B<GetOps> I<Volume>
3553 =item B<GetLatency> I<Volume>
3555 Select the given volume for IO, operations or latency statistics collection.
3556 The argument is the name of the volume without the C</vol/> prefix.
3558 Since the standard ignorelist functionality is used here, you can use a string
3559 starting and ending with a slash to specify regular expression matching: To
3560 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3563 GetIO "/^vol[027]$/"
3565 If no regular expression is specified, an exact match is required. Both,
3566 regular and exact matching are case sensitive.
3568 If no volume was specified at all for either of the three options, that data
3569 will be collected for all available volumes.
3571 =item B<IgnoreSelectedIO> B<true>|B<false>
3573 =item B<IgnoreSelectedOps> B<true>|B<false>
3575 =item B<IgnoreSelectedLatency> B<true>|B<false>
3577 When set to B<true>, the volumes selected for IO, operations or latency
3578 statistics collection will be ignored and the data will be collected for all
3581 When set to B<false>, data will only be collected for the specified volumes and
3582 all other volumes will be ignored.
3584 If no volumes have been specified with the above B<Get*> options, all volumes
3585 will be collected regardless of the B<IgnoreSelected*> option.
3587 Defaults to B<false>
3591 =head3 The VolumeUsage block
3593 This will collect capacity data about the individual volumes.
3595 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3600 =item B<Interval> I<Seconds>
3602 Collect volume usage statistics every I<Seconds> seconds.
3604 =item B<GetCapacity> I<VolumeName>
3606 The current capacity of the volume will be collected. This will result in two
3607 to four value lists, depending on the configuration of the volume. All data
3608 sources are of type "df_complex" with the name of the volume as
3611 There will be type_instances "used" and "free" for the number of used and
3612 available bytes on the volume. If the volume has some space reserved for
3613 snapshots, a type_instance "snap_reserved" will be available. If the volume
3614 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3615 number of bytes saved by the SIS feature.
3617 B<Note:> The current NetApp API has a bug that results in this value being
3618 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3619 number which works most of the time. If you see strange values here, bug
3620 NetApp support to fix this.
3622 Repeat this option to specify multiple volumes.
3624 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3626 Specify whether to collect only the volumes selected by the B<GetCapacity>
3627 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3628 B<false>. However, if no B<GetCapacity> option is specified at all, all
3629 capacities will be selected anyway.
3631 =item B<GetSnapshot> I<VolumeName>
3633 Select volumes from which to collect snapshot information.
3635 Usually, the space used for snapshots is included in the space reported as
3636 "used". If snapshot information is collected as well, the space used for
3637 snapshots is subtracted from the used space.
3639 To make things even more interesting, it is possible to reserve space to be
3640 used for snapshots. If the space required for snapshots is less than that
3641 reserved space, there is "reserved free" and "reserved used" space in addition
3642 to "free" and "used". If the space required for snapshots exceeds the reserved
3643 space, that part allocated in the normal space is subtracted from the "used"
3646 Repeat this option to specify multiple volumes.
3648 =item B<IgnoreSelectedSnapshot>
3650 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3651 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3652 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3653 capacities will be selected anyway.
3657 =head3 The Quota block
3659 This will collect (tree) quota statistics (used disk space and number of used
3660 files). This mechanism is useful to get usage information for single qtrees.
3661 In case the quotas are not used for any other purpose, an entry similar to the
3662 following in C</etc/quotas> would be sufficient:
3664 /vol/volA/some_qtree tree - - - - -
3666 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3670 =item B<Interval> I<Seconds>
3672 Collect SnapVault(R) statistics every I<Seconds> seconds.
3676 =head3 The SnapVault block
3678 This will collect statistics about the time and traffic of SnapVault(R)
3683 =item B<Interval> I<Seconds>
3685 Collect SnapVault(R) statistics every I<Seconds> seconds.
3689 =head2 Plugin C<netlink>
3691 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3692 statistics of various interface and routing aspects.
3696 =item B<Interface> I<Interface>
3698 =item B<VerboseInterface> I<Interface>
3700 Instruct the plugin to collect interface statistics. This is basically the same
3701 as the statistics provided by the C<interface> plugin (see above) but
3702 potentially much more detailed.
3704 When configuring with B<Interface> only the basic statistics will be collected,
3705 namely octets, packets, and errors. These statistics are collected by
3706 the C<interface> plugin, too, so using both at the same time is no benefit.
3708 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3709 so that no data needs to be collected twice if you use the C<interface> plugin.
3710 This includes dropped packets, received multicast packets, collisions and a
3711 whole zoo of differentiated RX and TX errors. You can try the following command
3712 to get an idea of what awaits you:
3716 If I<Interface> is B<All>, all interfaces will be selected.
3718 =item B<QDisc> I<Interface> [I<QDisc>]
3720 =item B<Class> I<Interface> [I<Class>]
3722 =item B<Filter> I<Interface> [I<Filter>]
3724 Collect the octets and packets that pass a certain qdisc, class or filter.
3726 QDiscs and classes are identified by their type and handle (or classid).
3727 Filters don't necessarily have a handle, therefore the parent's handle is used.
3728 The notation used in collectd differs from that used in tc(1) in that it
3729 doesn't skip the major or minor number if it's zero and doesn't print special
3730 ids by their name. So, for example, a qdisc may be identified by
3731 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3732 thus not displayed by tc(1).
3734 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3735 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3736 associated with that interface will be collected.
3738 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3739 used. This may lead to problems when more than one filter is attached to a
3740 qdisc or class. This isn't nice, but we don't know how this could be done any
3741 better. If you have a idea, please don't hesitate to tell us.
3743 As with the B<Interface> option you can specify B<All> as the interface,
3744 meaning all interfaces.
3746 Here are some examples to help you understand the above text more easily:
3749 VerboseInterface "All"
3750 QDisc "eth0" "pfifo_fast-1:0"
3752 Class "ppp0" "htb-1:10"
3753 Filter "ppp0" "u32-1:0"
3756 =item B<IgnoreSelected>
3758 The behavior is the same as with all other similar plugins: If nothing is
3759 selected at all, everything is collected. If some things are selected using the
3760 options described above, only these statistics are collected. If you set
3761 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3762 specified statistics will not be collected.
3766 =head2 Plugin C<network>
3768 The Network plugin sends data to a remote instance of collectd, receives data
3769 from a remote instance, or both at the same time. Data which has been received
3770 from the network is usually not transmitted again, but this can be activated, see
3771 the B<Forward> option below.
3773 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3774 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3776 Both, B<Server> and B<Listen> can be used as single option or as block. When
3777 used as block, given options are valid for this socket only. The following
3778 example will export the metrics twice: Once to an "internal" server (without
3779 encryption and signing) and one to an external server (with cryptographic
3783 # Export to an internal server
3784 # (demonstrates usage without additional options)
3785 Server "collectd.internal.tld"
3787 # Export to an external server
3788 # (demonstrates usage with signature options)
3789 <Server "collectd.external.tld">
3790 SecurityLevel "sign"
3791 Username "myhostname"
3798 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3800 The B<Server> statement/block sets the server to send datagrams to. The
3801 statement may occur multiple times to send each datagram to multiple
3804 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3805 optional second argument specifies a port number or a service name. If not
3806 given, the default, B<25826>, is used.
3808 The following options are recognized within B<Server> blocks:
3812 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3814 Set the security you require for network communication. When the security level
3815 has been set to B<Encrypt>, data sent over the network will be encrypted using
3816 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3817 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3818 authentication code. When set to B<None>, data is sent without any security.
3820 This feature is only available if the I<network> plugin was linked with
3823 =item B<Username> I<Username>
3825 Sets the username to transmit. This is used by the server to lookup the
3826 password. See B<AuthFile> below. All security levels except B<None> require
3829 This feature is only available if the I<network> plugin was linked with
3832 =item B<Password> I<Password>
3834 Sets a password (shared secret) for this socket. All security levels except
3835 B<None> require this setting.
3837 This feature is only available if the I<network> plugin was linked with
3840 =item B<Interface> I<Interface name>
3842 Set the outgoing interface for IP packets. This applies at least
3843 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3844 undefined or a non-existent interface name is specified, the default
3845 behavior is to let the kernel choose the appropriate interface. Be warned
3846 that the manual selection of an interface for unicast traffic is only
3847 necessary in rare cases.
3851 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
3853 The B<Listen> statement sets the interfaces to bind to. When multiple
3854 statements are found the daemon will bind to multiple interfaces.
3856 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
3857 the argument is a multicast address the daemon will join that multicast group.
3858 The optional second argument specifies a port number or a service name. If not
3859 given, the default, B<25826>, is used.
3861 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
3865 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3867 Set the security you require for network communication. When the security level
3868 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
3869 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
3870 signed and encrypted data is accepted. When set to B<None>, all data will be
3871 accepted. If an B<AuthFile> option was given (see below), encrypted data is
3872 decrypted if possible.
3874 This feature is only available if the I<network> plugin was linked with
3877 =item B<AuthFile> I<Filename>
3879 Sets a file in which usernames are mapped to passwords. These passwords are
3880 used to verify signatures and to decrypt encrypted network packets. If
3881 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
3882 verified and encrypted packets are decrypted. Otherwise, signed data is
3883 accepted without checking the signature and encrypted data cannot be decrypted.
3884 For the other security levels this option is mandatory.
3886 The file format is very simple: Each line consists of a username followed by a
3887 colon and any number of spaces followed by the password. To demonstrate, an
3888 example file could look like this:
3893 Each time a packet is received, the modification time of the file is checked
3894 using L<stat(2)>. If the file has been changed, the contents is re-read. While
3895 the file is being read, it is locked using L<fcntl(2)>.
3897 =item B<Interface> I<Interface name>
3899 Set the incoming interface for IP packets explicitly. This applies at least
3900 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3901 undefined or a non-existent interface name is specified, the default
3902 behavior is, to let the kernel choose the appropriate interface. Thus incoming
3903 traffic gets only accepted, if it arrives on the given interface.
3907 =item B<TimeToLive> I<1-255>
3909 Set the time-to-live of sent packets. This applies to all, unicast and
3910 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
3911 That means that multicast packets will be sent with a TTL of C<1> (one) on most
3914 =item B<MaxPacketSize> I<1024-65535>
3916 Set the maximum size for datagrams received over the network. Packets larger
3917 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
3918 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
3921 On the server side, this limit should be set to the largest value used on
3922 I<any> client. Likewise, the value on the client must not be larger than the
3923 value on the server, or data will be lost.
3925 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
3926 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
3927 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
3930 =item B<Forward> I<true|false>
3932 If set to I<true>, write packets that were received via the network plugin to
3933 the sending sockets. This should only be activated when the B<Listen>- and
3934 B<Server>-statements differ. Otherwise packets may be send multiple times to
3935 the same multicast group. While this results in more network traffic than
3936 necessary it's not a huge problem since the plugin has a duplicate detection,
3937 so the values will not loop.
3939 =item B<ReportStats> B<true>|B<false>
3941 The network plugin cannot only receive and send statistics, it can also create
3942 statistics about itself. Collected data included the number of received and
3943 sent octets and packets, the length of the receive queue and the number of
3944 values handled. When set to B<true>, the I<Network plugin> will make these
3945 statistics available. Defaults to B<false>.
3949 =head2 Plugin C<nginx>
3951 This plugin collects the number of connections and requests handled by the
3952 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
3953 queries the page provided by the C<ngx_http_stub_status_module> module, which
3954 isn't compiled by default. Please refer to
3955 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
3956 how to compile and configure nginx and this module.
3958 The following options are accepted by the C<nginx plugin>:
3962 =item B<URL> I<http://host/nginx_status>
3964 Sets the URL of the C<ngx_http_stub_status_module> output.
3966 =item B<User> I<Username>
3968 Optional user name needed for authentication.
3970 =item B<Password> I<Password>
3972 Optional password needed for authentication.
3974 =item B<VerifyPeer> B<true|false>
3976 Enable or disable peer SSL certificate verification. See
3977 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
3979 =item B<VerifyHost> B<true|false>
3981 Enable or disable peer host name verification. If enabled, the plugin checks
3982 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
3983 certificate matches the host name provided by the B<URL> option. If this
3984 identity check fails, the connection is aborted. Obviously, only works when
3985 connecting to a SSL enabled server. Enabled by default.
3987 =item B<CACert> I<File>
3989 File that holds one or more SSL certificates. If you want to use HTTPS you will
3990 possibly need this option. What CA certificates come bundled with C<libcurl>
3991 and are checked by default depends on the distribution you use.
3995 =head2 Plugin C<notify_desktop>
3997 This plugin sends a desktop notification to a notification daemon, as defined
3998 in the Desktop Notification Specification. To actually display the
3999 notifications, B<notification-daemon> is required and B<collectd> has to be
4000 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
4001 environment variables have to be set correctly) and the D-Bus message bus.
4003 The Desktop Notification Specification can be found at
4004 L<http://www.galago-project.org/specs/notification/>.
4008 =item B<OkayTimeout> I<timeout>
4010 =item B<WarningTimeout> I<timeout>
4012 =item B<FailureTimeout> I<timeout>
4014 Set the I<timeout>, in milliseconds, after which to expire the notification
4015 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
4016 been specified, the displayed notification will not be closed at all - the
4017 user has to do so herself. These options default to 5000. If a negative number
4018 has been specified, the default is used as well.
4022 =head2 Plugin C<notify_email>
4024 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
4025 configured email address.
4027 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
4029 Available configuration options:
4033 =item B<From> I<Address>
4035 Email address from which the emails should appear to come from.
4037 Default: C<root@localhost>
4039 =item B<Recipient> I<Address>
4041 Configures the email address(es) to which the notifications should be mailed.
4042 May be repeated to send notifications to multiple addresses.
4044 At least one B<Recipient> must be present for the plugin to work correctly.
4046 =item B<SMTPServer> I<Hostname>
4048 Hostname of the SMTP server to connect to.
4050 Default: C<localhost>
4052 =item B<SMTPPort> I<Port>
4054 TCP port to connect to.
4058 =item B<SMTPUser> I<Username>
4060 Username for ASMTP authentication. Optional.
4062 =item B<SMTPPassword> I<Password>
4064 Password for ASMTP authentication. Optional.
4066 =item B<Subject> I<Subject>
4068 Subject-template to use when sending emails. There must be exactly two
4069 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
4070 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
4073 Default: C<Collectd notify: %s@%s>
4077 =head2 Plugin C<ntpd>
4081 =item B<Host> I<Hostname>
4083 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
4085 =item B<Port> I<Port>
4087 UDP-Port to connect to. Defaults to B<123>.
4089 =item B<ReverseLookups> B<true>|B<false>
4091 Sets whether or not to perform reverse lookups on peers. Since the name or
4092 IP-address may be used in a filename it is recommended to disable reverse
4093 lookups. The default is to do reverse lookups to preserve backwards
4094 compatibility, though.
4096 =item B<IncludeUnitID> B<true>|B<false>
4098 When a peer is a refclock, include the unit ID in the I<type instance>.
4099 Defaults to B<false> for backward compatibility.
4101 If two refclock peers use the same driver and this is B<false>, the plugin will
4102 try to write simultaneous measurements from both to the same type instance.
4103 This will result in error messages in the log and only one set of measurements
4108 =head2 Plugin C<nut>
4112 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
4114 Add a UPS to collect data from. The format is identical to the one accepted by
4119 =head2 Plugin C<olsrd>
4121 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
4122 the Optimized Link State Routing daemon and reads information about the current
4123 state of the meshed network.
4125 The following configuration options are understood:
4129 =item B<Host> I<Host>
4131 Connect to I<Host>. Defaults to B<"localhost">.
4133 =item B<Port> I<Port>
4135 Specifies the port to connect to. This must be a string, even if you give the
4136 port as a number rather than a service name. Defaults to B<"2006">.
4138 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
4140 Specifies what information to collect about links, i.E<nbsp>e. direct
4141 connections of the daemon queried. If set to B<No>, no information is
4142 collected. If set to B<Summary>, the number of links and the average of all
4143 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
4144 If set to B<Detail> LQ and NLQ are collected per link.
4146 Defaults to B<Detail>.
4148 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
4150 Specifies what information to collect about routes of the daemon queried. If
4151 set to B<No>, no information is collected. If set to B<Summary>, the number of
4152 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
4153 metric and ETX are collected per route.
4155 Defaults to B<Summary>.
4157 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
4159 Specifies what information to collect about the global topology. If set to
4160 B<No>, no information is collected. If set to B<Summary>, the number of links
4161 in the entire topology and the average I<link quality> (LQ) is calculated.
4162 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
4164 Defaults to B<Summary>.
4168 =head2 Plugin C<onewire>
4170 B<EXPERIMENTAL!> See notes below.
4172 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
4173 L<http://owfs.org/> to read sensors connected via the onewire bus.
4175 It can be used in two possible modes - standard or advanced.
4177 In the standard mode only temperature sensors (sensors with the family code
4178 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
4179 other sensors you would like to have included, please send a sort request to
4180 the mailing list. You can select sensors to be read or to be ignored depending
4181 on the option B<IgnoreSelected>). When no list is provided the whole bus is
4182 walked and all sensors are read.
4184 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
4185 experimental, below.
4187 In the advanced mode you can configure any sensor to be read (only numerical
4188 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
4189 In this mode you have to list all the sensors. Neither default bus walk nor
4190 B<IgnoreSelected> are used here. Address and type (file) is extracted from
4191 the path automatically and should produce compatible structure with the "standard"
4192 mode (basically the path is expected as for example
4193 "/uncached/10.F10FCA000800/temperature" where it would extract address part
4194 "F10FCA000800" and the rest after the slash is considered the type - here
4196 There are two advantages to this mode - you can access virtually any sensor
4197 (not just temperature), select whether to use cached or directly read values
4198 and it is slighlty faster. The downside is more complex configuration.
4200 The two modes are distinguished automatically by the format of the address.
4201 It is not possible to mix the two modes. Once a full path is detected in any
4202 B<Sensor> then the whole addressing (all sensors) is considered to be this way
4203 (and as standard addresses will fail parsing they will be ignored).
4207 =item B<Device> I<Device>
4209 Sets the device to read the values from. This can either be a "real" hardware
4210 device, such as a serial port or an USB port, or the address of the
4211 L<owserver(1)> socket, usually B<localhost:4304>.
4213 Though the documentation claims to automatically recognize the given address
4214 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
4215 with that version, the following configuration worked for us:
4218 Device "-s localhost:4304"
4221 This directive is B<required> and does not have a default value.
4223 =item B<Sensor> I<Sensor>
4225 In the standard mode selects sensors to collect or to ignore
4226 (depending on B<IgnoreSelected>, see below). Sensors are specified without
4227 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
4228 and B<not> include the leading C<10.> family byte and point.
4229 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
4230 sensors (see above) are read.
4232 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
4233 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
4234 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
4236 As there can be multiple devices on the bus you can list multiple sensor (use
4237 multiple B<Sensor> elements).
4239 =item B<IgnoreSelected> I<true>|I<false>
4241 If no configuration is given, the B<onewire> plugin will collect data from all
4242 sensors found. This may not be practical, especially if sensors are added and
4243 removed regularly. Sometimes, however, it's easier/preferred to collect only
4244 specific sensors or all sensors I<except> a few specified ones. This option
4245 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
4246 B<Sensor> is inverted: All selected interfaces are ignored and all other
4247 interfaces are collected.
4249 Used only in the standard mode - see above.
4251 =item B<Interval> I<Seconds>
4253 Sets the interval in which all sensors should be read. If not specified, the
4254 global B<Interval> setting is used.
4258 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
4259 work with big setups. It works with one sensor being attached to one
4260 controller, but as soon as you throw in a couple more senors and maybe a hub
4261 or two, reading all values will take more than ten seconds (the default
4262 interval). We will probably add some separate thread for reading the sensors
4263 and some cache or something like that, but it's not done yet. We will try to
4264 maintain backwards compatibility in the future, but we can't promise. So in
4265 short: If it works for you: Great! But keep in mind that the config I<might>
4266 change, though this is unlikely. Oh, and if you want to help improving this
4267 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
4269 =head2 Plugin C<openvpn>
4271 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
4272 traffic statistics about connected clients.
4274 To set up OpenVPN to write to the status file periodically, use the
4275 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
4276 you need to set the required format, too. This is done by setting
4277 B<--status-version> to B<2>.
4279 So, in a nutshell you need:
4281 openvpn $OTHER_OPTIONS \
4282 --status "/var/run/openvpn-status" 10 \
4289 =item B<StatusFile> I<File>
4291 Specifies the location of the status file.
4293 =item B<ImprovedNamingSchema> B<true>|B<false>
4295 When enabled, the filename of the status file will be used as plugin instance
4296 and the client's "common name" will be used as type instance. This is required
4297 when reading multiple status files. Enabling this option is recommended, but to
4298 maintain backwards compatibility this option is disabled by default.
4300 =item B<CollectCompression> B<true>|B<false>
4302 Sets whether or not statistics about the compression used by OpenVPN should be
4303 collected. This information is only available in I<single> mode. Enabled by
4306 =item B<CollectIndividualUsers> B<true>|B<false>
4308 Sets whether or not traffic information is collected for each connected client
4309 individually. If set to false, currently no traffic data is collected at all
4310 because aggregating this data in a save manner is tricky. Defaults to B<true>.
4312 =item B<CollectUserCount> B<true>|B<false>
4314 When enabled, the number of currently connected clients or users is collected.
4315 This is especially interesting when B<CollectIndividualUsers> is disabled, but
4316 can be configured independently from that option. Defaults to B<false>.
4320 =head2 Plugin C<oracle>
4322 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
4323 Oracle® Database and lets you execute SQL statements there. It is very similar
4324 to the "dbi" plugin, because it was written around the same time. See the "dbi"
4325 plugin's documentation above for details.
4328 <Query "out_of_stock">
4329 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
4332 # InstancePrefix "foo"
4333 InstancesFrom "category"
4337 <Database "product_information">
4341 Query "out_of_stock"
4345 =head3 B<Query> blocks
4347 The Query blocks are handled identically to the Query blocks of the "dbi"
4348 plugin. Please see its documentation above for details on how to specify
4351 =head3 B<Database> blocks
4353 Database blocks define a connection to a database and which queries should be
4354 sent to that database. Each database needs a "name" as string argument in the
4355 starting tag of the block. This name will be used as "PluginInstance" in the
4356 values submitted to the daemon. Other than that, that name is not used.
4360 =item B<ConnectID> I<ID>
4362 Defines the "database alias" or "service name" to connect to. Usually, these
4363 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
4365 =item B<Host> I<Host>
4367 Hostname to use when dispatching values for this database. Defaults to using
4368 the global hostname of the I<collectd> instance.
4370 =item B<Username> I<Username>
4372 Username used for authentication.
4374 =item B<Password> I<Password>
4376 Password used for authentication.
4378 =item B<Query> I<QueryName>
4380 Associates the query named I<QueryName> with this database connection. The
4381 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
4382 blocks you want to refer to must be placed above the database block you want to
4387 =head2 Plugin C<perl>
4389 This plugin embeds a Perl-interpreter into collectd and provides an interface
4390 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
4392 =head2 Plugin C<pinba>
4394 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
4395 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
4396 PHP-based webpage has been delivered, the extension will send a UDP packet
4397 containing timing information, peak memory usage and so on. The plugin will
4398 wait for such packets, parse them and account the provided information, which
4399 is then dispatched to the daemon once per interval.
4406 # Overall statistics for the website.
4408 Server "www.example.com"
4410 # Statistics for www-a only
4412 Host "www-a.example.com"
4413 Server "www.example.com"
4415 # Statistics for www-b only
4417 Host "www-b.example.com"
4418 Server "www.example.com"
4422 The plugin provides the following configuration options:
4426 =item B<Address> I<Node>
4428 Configures the address used to open a listening socket. By default, plugin will
4429 bind to the I<any> address C<::0>.
4431 =item B<Port> I<Service>
4433 Configures the port (service) to bind to. By default the default Pinba port
4434 "30002" will be used. The option accepts service names in addition to port
4435 numbers and thus requires a I<string> argument.
4437 =item E<lt>B<View> I<Name>E<gt> block
4439 The packets sent by the Pinba extension include the hostname of the server, the
4440 server name (the name of the virtual host) and the script that was executed.
4441 Using B<View> blocks it is possible to separate the data into multiple groups
4442 to get more meaningful statistics. Each packet is added to all matching groups,
4443 so that a packet may be accounted for more than once.
4447 =item B<Host> I<Host>
4449 Matches the hostname of the system the webserver / script is running on. This
4450 will contain the result of the L<gethostname(2)> system call. If not
4451 configured, all hostnames will be accepted.
4453 =item B<Server> I<Server>
4455 Matches the name of the I<virtual host>, i.e. the contents of the
4456 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
4457 server names will be accepted.
4459 =item B<Script> I<Script>
4461 Matches the name of the I<script name>, i.e. the contents of the
4462 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
4463 script names will be accepted.
4469 =head2 Plugin C<ping>
4471 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
4472 configured hosts periodically and measures the network latency. Whenever the
4473 C<read> function of the plugin is called, it submits the average latency, the
4474 standard deviation and the drop rate for each host.
4476 Available configuration options:
4480 =item B<Host> I<IP-address>
4482 Host to ping periodically. This option may be repeated several times to ping
4485 =item B<Interval> I<Seconds>
4487 Sets the interval in which to send ICMP echo packets to the configured hosts.
4488 This is B<not> the interval in which statistics are queries from the plugin but
4489 the interval in which the hosts are "pinged". Therefore, the setting here
4490 should be smaller than or equal to the global B<Interval> setting. Fractional
4491 times, such as "1.24" are allowed.
4495 =item B<Timeout> I<Seconds>
4497 Time to wait for a response from the host to which an ICMP packet had been
4498 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
4499 to be down or the packet to be dropped. This setting must be smaller than the
4500 B<Interval> setting above for the plugin to work correctly. Fractional
4501 arguments are accepted.
4505 =item B<TTL> I<0-255>
4507 Sets the Time-To-Live of generated ICMP packets.
4509 =item B<SourceAddress> I<host>
4511 Sets the source address to use. I<host> may either be a numerical network
4512 address or a network hostname.
4514 =item B<Device> I<name>
4516 Sets the outgoing network device to be used. I<name> has to specify an
4517 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
4520 =item B<MaxMissed> I<Packets>
4522 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
4523 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
4525 Default: B<-1> (disabled)
4529 =head2 Plugin C<postgresql>
4531 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
4532 keeps a persistent connection to all configured databases and tries to
4533 reconnect if the connection has been interrupted. A database is configured by
4534 specifying a B<Database> block as described below. The default statistics are
4535 collected from PostgreSQL's B<statistics collector> which thus has to be
4536 enabled for this plugin to work correctly. This should usually be the case by
4537 default. See the section "The Statistics Collector" of the B<PostgreSQL
4538 Documentation> for details.
4540 By specifying custom database queries using a B<Query> block as described
4541 below, you may collect any data that is available from some PostgreSQL
4542 database. This way, you are able to access statistics of external daemons
4543 which are available in a PostgreSQL database or use future or special
4544 statistics provided by PostgreSQL without the need to upgrade your collectd
4547 Starting with version 5.2, the C<postgresql> plugin supports writing data to
4548 PostgreSQL databases as well. This has been implemented in a generic way. You
4549 need to specify an SQL statement which will then be executed by collectd in
4550 order to write the data (see below for details). The benefit of that approach
4551 is that there is no fixed database layout. Rather, the layout may be optimized
4552 for the current setup.
4554 The B<PostgreSQL Documentation> manual can be found at
4555 L<http://www.postgresql.org/docs/manuals/>.
4559 Statement "SELECT magic FROM wizard WHERE host = $1;"
4563 InstancePrefix "magic"
4568 <Query rt36_tickets>
4569 Statement "SELECT COUNT(type) AS count, type \
4571 WHEN resolved = 'epoch' THEN 'open' \
4572 ELSE 'resolved' END AS type \
4573 FROM tickets) type \
4577 InstancePrefix "rt36_tickets"
4578 InstancesFrom "type"
4584 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
4594 KRBSrvName "kerberos_service_name"
4600 Service "service_name"
4601 Query backend # predefined
4612 The B<Query> block defines one database query which may later be used by a
4613 database definition. It accepts a single mandatory argument which specifies
4614 the name of the query. The names of all queries have to be unique (see the
4615 B<MinVersion> and B<MaxVersion> options below for an exception to this
4616 rule). The following configuration options are available to define the query:
4618 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
4619 blocks define how to handle the values returned from the query. They define
4620 which column holds which value and how to dispatch that value to the daemon.
4621 Multiple B<Result> blocks may be used to extract multiple values from a single
4626 =item B<Statement> I<sql query statement>
4628 Specify the I<sql query statement> which the plugin should execute. The string
4629 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
4630 first, second, etc. parameter. The value of the parameters is specified by the
4631 B<Param> configuration option - see below for details. To include a literal
4632 B<$> character followed by a number, surround it with single quotes (B<'>).
4634 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
4635 allowed. Note, however, that only a single command may be used. Semicolons are
4636 allowed as long as a single non-empty command has been specified only.
4638 The returned lines will be handled separately one after another.
4640 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4642 Specify the parameters which should be passed to the SQL query. The parameters
4643 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4644 they appear in the configuration file. The value of the parameter is
4645 determined depending on the value of the B<Param> option as follows:
4651 The configured hostname of the database connection. If a UNIX domain socket is
4652 used, the parameter expands to "localhost".
4656 The name of the database of the current connection.
4660 The name of the database plugin instance. See the B<Instance> option of the
4661 database specification below for details.
4665 The username used to connect to the database.
4669 The interval with which this database is queried (as specified by the database
4670 specific or global B<Interval> options).
4674 Please note that parameters are only supported by PostgreSQL's protocol
4675 version 3 and above which was introduced in version 7.4 of PostgreSQL.
4677 =item B<Type> I<type>
4679 The I<type> name to be used when dispatching the values. The type describes
4680 how to handle the data and where to store it. See L<types.db(5)> for more
4681 details on types and their configuration. The number and type of values (as
4682 selected by the B<ValuesFrom> option) has to match the type of the given name.
4684 This option is required inside a B<Result> block.
4686 =item B<InstancePrefix> I<prefix>
4688 =item B<InstancesFrom> I<column0> [I<column1> ...]
4690 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
4691 B<InstancePrefix> defines a static prefix that will be prepended to all type
4692 instances. B<InstancesFrom> defines the column names whose values will be used
4693 to create the type instance. Multiple values will be joined together using the
4694 hyphen (C<->) as separation character.
4696 The plugin itself does not check whether or not all built instances are
4697 different. It is your responsibility to assure that each is unique.
4699 Both options are optional. If none is specified, the type instance will be
4702 =item B<ValuesFrom> I<column0> [I<column1> ...]
4704 Names the columns whose content is used as the actual data for the data sets
4705 that are dispatched to the daemon. How many such columns you need is
4706 determined by the B<Type> setting as explained above. If you specify too many
4707 or not enough columns, the plugin will complain about that and no data will be
4708 submitted to the daemon.
4710 The actual data type, as seen by PostgreSQL, is not that important as long as
4711 it represents numbers. The plugin will automatically cast the values to the
4712 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
4713 L<strtod(3)> functions, so anything supported by those functions is supported
4714 by the plugin as well.
4716 This option is required inside a B<Result> block and may be specified multiple
4717 times. If multiple B<ValuesFrom> options are specified, the columns are read
4720 =item B<MinVersion> I<version>
4722 =item B<MaxVersion> I<version>
4724 Specify the minimum or maximum version of PostgreSQL that this query should be
4725 used with. Some statistics might only be available with certain versions of
4726 PostgreSQL. This allows you to specify multiple queries with the same name but
4727 which apply to different versions, thus allowing you to use the same
4728 configuration in a heterogeneous environment.
4730 The I<version> has to be specified as the concatenation of the major, minor
4731 and patch-level versions, each represented as two-decimal-digit numbers. For
4732 example, version 8.2.3 will become 80203.
4736 The following predefined queries are available (the definitions can be found
4737 in the F<postgresql_default.conf> file which, by default, is available at
4738 C<I<prefix>/share/collectd/>):
4744 This query collects the number of backends, i.E<nbsp>e. the number of
4747 =item B<transactions>
4749 This query collects the numbers of committed and rolled-back transactions of
4754 This query collects the numbers of various table modifications (i.E<nbsp>e.
4755 insertions, updates, deletions) of the user tables.
4757 =item B<query_plans>
4759 This query collects the numbers of various table scans and returned tuples of
4762 =item B<table_states>
4764 This query collects the numbers of live and dead rows in the user tables.
4768 This query collects disk block access counts for user tables.
4772 This query collects the on-disk size of the database in bytes.
4776 In addition, the following detailed queries are available by default. Please
4777 note that each of those queries collects information B<by table>, thus,
4778 potentially producing B<a lot> of data. For details see the description of the
4779 non-by_table queries above.
4783 =item B<queries_by_table>
4785 =item B<query_plans_by_table>
4787 =item B<table_states_by_table>
4789 =item B<disk_io_by_table>
4793 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
4794 mandatory argument specifying the name of the writer. This will then be used
4795 in the B<Database> specification in order to activate the writer instance. The
4796 names of all writers have to be unique. The following options may be
4801 =item B<Statement> I<sql statement>
4803 This mandatory option specifies the SQL statement that will be executed for
4804 each submitted value. A single SQL statement is allowed only. Anything after
4805 the first semicolon will be ignored.
4807 Nine parameters will be passed to the statement and should be specified as
4808 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
4809 values are made available through those parameters:
4815 The timestamp of the queried value as a floating point number.
4819 The hostname of the queried value.
4823 The plugin name of the queried value.
4827 The plugin instance of the queried value. This value may be B<NULL> if there
4828 is no plugin instance.
4832 The type of the queried value (cf. L<types.db(5)>).
4836 The type instance of the queried value. This value may be B<NULL> if there is
4841 An array of names for the submitted values (i.E<nbsp>e., the name of the data
4842 sources of the submitted value-list).
4846 An array of types for the submitted values (i.E<nbsp>e., the type of the data
4847 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
4848 B<StoreRates> is enabled (which is the default, see below), all types will be
4853 An array of the submitted values. The dimensions of the value name and value
4858 In general, it is advisable to create and call a custom function in the
4859 PostgreSQL database for this purpose. Any procedural language supported by
4860 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
4863 =item B<StoreRates> B<false>|B<true>
4865 If set to B<true> (the default), convert counter values to rates. If set to
4866 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
4871 The B<Database> block defines one PostgreSQL database for which to collect
4872 statistics. It accepts a single mandatory argument which specifies the
4873 database name. None of the other options are required. PostgreSQL will use
4874 default values as documented in the section "CONNECTING TO A DATABASE" in the
4875 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
4876 the user collectd is run as and special environment variables. See the manpage
4881 =item B<Interval> I<seconds>
4883 Specify the interval with which the database should be queried. The default is
4884 to use the global B<Interval> setting.
4886 =item B<CommitInterval> I<seconds>
4888 This option may be used for database connections which have "writers" assigned
4889 (see above). If specified, it causes a writer to put several updates into a
4890 single transaction. This transaction will last for the specified amount of
4891 time. By default, each update will be executed in a separate transaction. Each
4892 transaction generates a fair amount of overhead which can, thus, be reduced by
4893 activating this option. The draw-back is, that data covering the specified
4894 amount of time will be lost, for example, if a single statement within the
4895 transaction fails or if the database server crashes.
4897 =item B<Host> I<hostname>
4899 Specify the hostname or IP of the PostgreSQL server to connect to. If the
4900 value begins with a slash, it is interpreted as the directory name in which to
4901 look for the UNIX domain socket.
4903 This option is also used to determine the hostname that is associated with a
4904 collected data set. If it has been omitted or either begins with with a slash
4905 or equals B<localhost> it will be replaced with the global hostname definition
4906 of collectd. Any other value will be passed literally to collectd when
4907 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
4909 =item B<Port> I<port>
4911 Specify the TCP port or the local UNIX domain socket file extension of the
4914 =item B<User> I<username>
4916 Specify the username to be used when connecting to the server.
4918 =item B<Password> I<password>
4920 Specify the password to be used when connecting to the server.
4922 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
4924 Specify whether to use an SSL connection when contacting the server. The
4925 following modes are supported:
4931 Do not use SSL at all.
4935 First, try to connect without using SSL. If that fails, try using SSL.
4937 =item I<prefer> (default)
4939 First, try to connect using SSL. If that fails, try without using SSL.
4947 =item B<Instance> I<name>
4949 Specify the plugin instance name that should be used instead of the database
4950 name (which is the default, if this option has not been specified). This
4951 allows to query multiple databases of the same name on the same host (e.g.
4952 when running multiple database server versions in parallel).
4954 =item B<KRBSrvName> I<kerberos_service_name>
4956 Specify the Kerberos service name to use when authenticating with Kerberos 5
4957 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
4958 B<PostgreSQL Documentation> for details.
4960 =item B<Service> I<service_name>
4962 Specify the PostgreSQL service name to use for additional parameters. That
4963 service has to be defined in F<pg_service.conf> and holds additional
4964 connection parameters. See the section "The Connection Service File" in the
4965 B<PostgreSQL Documentation> for details.
4967 =item B<Query> I<query>
4969 Specifies a I<query> which should be executed in the context of the database
4970 connection. This may be any of the predefined or user-defined queries. If no
4971 such option is given, it defaults to "backends", "transactions", "queries",
4972 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
4973 has been specified). Else, the specified queries are used only.
4975 =item B<Writer> I<writer>
4977 Assigns the specified I<writer> backend to the database connection. This
4978 causes all collected data to be send to the database using the settings
4979 defined in the writer configuration (see the section "FILTER CONFIGURATION"
4980 below for details on how to selectively send data to certain plugins).
4982 Each writer will register a flush callback which may be used when having long
4983 transactions enabled (see the B<CommitInterval> option above). When issuing
4984 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
4985 transaction will be committed right away. Two different kinds of flush
4986 callbacks are available with the C<postgresql> plugin:
4992 Flush all writer backends.
4994 =item B<postgresql->I<database>
4996 Flush all writers of the specified I<database> only.
5002 =head2 Plugin C<powerdns>
5004 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
5005 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
5006 values, many of which are probably meaningless to most users, but may be useful
5007 for some. So you may chose which values to collect, but if you don't, some
5008 reasonable defaults will be collected.
5011 <Server "server_name">
5013 Collect "udp-answers" "udp-queries"
5014 Socket "/var/run/pdns.controlsocket"
5016 <Recursor "recursor_name">
5018 Collect "cache-hits" "cache-misses"
5019 Socket "/var/run/pdns_recursor.controlsocket"
5021 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
5026 =item B<Server> and B<Recursor> block
5028 The B<Server> block defines one authoritative server to query, the B<Recursor>
5029 does the same for an recursing server. The possible options in both blocks are
5030 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
5035 =item B<Collect> I<Field>
5037 Using the B<Collect> statement you can select which values to collect. Here,
5038 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
5039 C<dlg-only-drops>, C<answers10-100>.
5041 The method of getting the values differs for B<Server> and B<Recursor> blocks:
5042 When querying the server a C<SHOW *> command is issued in any case, because
5043 that's the only way of getting multiple values out of the server at once.
5044 collectd then picks out the values you have selected. When querying the
5045 recursor, a command is generated to query exactly these values. So if you
5046 specify invalid fields when querying the recursor, a syntax error may be
5047 returned by the daemon and collectd may not collect any values at all.
5049 If no B<Collect> statement is given, the following B<Server> values will be
5056 =item packetcache-hit
5058 =item packetcache-miss
5060 =item packetcache-size
5062 =item query-cache-hit
5064 =item query-cache-miss
5066 =item recursing-answers
5068 =item recursing-questions
5080 The following B<Recursor> values will be collected by default:
5084 =item noerror-answers
5086 =item nxdomain-answers
5088 =item servfail-answers
5106 Please note that up to that point collectd doesn't know what values are
5107 available on the server and values that are added do not need a change of the
5108 mechanism so far. However, the values must be mapped to collectd's naming
5109 scheme, which is done using a lookup table that lists all known values. If
5110 values are added in the future and collectd does not know about them, you will
5111 get an error much like this:
5113 powerdns plugin: submit: Not found in lookup table: foobar = 42
5115 In this case please file a bug report with the collectd team.
5117 =item B<Socket> I<Path>
5119 Configures the path to the UNIX domain socket to be used when connecting to the
5120 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
5121 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
5122 will be used for the recursor.
5126 =item B<LocalSocket> I<Path>
5128 Querying the recursor is done using UDP. When using UDP over UNIX domain
5129 sockets, the client socket needs a name in the file system, too. You can set
5130 this local name to I<Path> using the B<LocalSocket> option. The default is
5131 C<I<prefix>/var/run/collectd-powerdns>.
5135 =head2 Plugin C<processes>
5139 =item B<Process> I<Name>
5141 Select more detailed statistics of processes matching this name. The statistics
5142 collected for these selected processes are size of the resident segment size
5143 (RSS), user- and system-time used, number of processes and number of threads,
5144 io data (where available) and minor and major pagefaults.
5146 =item B<ProcessMatch> I<name> I<regex>
5148 Similar to the B<Process> option this allows to select more detailed
5149 statistics of processes matching the specified I<regex> (see L<regex(7)> for
5150 details). The statistics of all matching processes are summed up and
5151 dispatched to the daemon using the specified I<name> as an identifier. This
5152 allows to "group" several processes together. I<name> must not contain
5157 =head2 Plugin C<protocols>
5159 Collects a lot of information about various network protocols, such as I<IP>,
5160 I<TCP>, I<UDP>, etc.
5162 Available configuration options:
5166 =item B<Value> I<Selector>
5168 Selects whether or not to select a specific value. The string being matched is
5169 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
5170 plugin instance and I<ValueName> will be used as type instance. An example of
5171 the string being used would be C<Tcp:RetransSegs>.
5173 You can use regular expressions to match a large number of values with just one
5174 configuration option. To select all "extended" I<TCP> values, you could use the
5175 following statement:
5179 Whether only matched values are selected or all matched values are ignored
5180 depends on the B<IgnoreSelected>. By default, only matched values are selected.
5181 If no value is configured at all, all values will be selected.
5183 =item B<IgnoreSelected> B<true>|B<false>
5185 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
5186 matching values will be ignored.
5190 =head2 Plugin C<python>
5192 This plugin embeds a Python-interpreter into collectd and provides an interface
5193 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
5195 =head2 Plugin C<routeros>
5197 The C<routeros> plugin connects to a device running I<RouterOS>, the
5198 Linux-based operating system for routers by I<MikroTik>. The plugin uses
5199 I<librouteros> to connect and reads information about the interfaces and
5200 wireless connections of the device. The configuration supports querying
5205 Host "router0.example.com"
5208 CollectInterface true
5213 Host "router1.example.com"
5216 CollectInterface true
5217 CollectRegistrationTable true
5223 As you can see above, the configuration of the I<routeros> plugin consists of
5224 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
5225 options are understood:
5229 =item B<Host> I<Host>
5231 Hostname or IP-address of the router to connect to.
5233 =item B<Port> I<Port>
5235 Port name or port number used when connecting. If left unspecified, the default
5236 will be chosen by I<librouteros>, currently "8728". This option expects a
5237 string argument, even when a numeric port number is given.
5239 =item B<User> I<User>
5241 Use the user name I<User> to authenticate. Defaults to "admin".
5243 =item B<Password> I<Password>
5245 Set the password used to authenticate.
5247 =item B<CollectInterface> B<true>|B<false>
5249 When set to B<true>, interface statistics will be collected for all interfaces
5250 present on the device. Defaults to B<false>.
5252 =item B<CollectRegistrationTable> B<true>|B<false>
5254 When set to B<true>, information about wireless LAN connections will be
5255 collected. Defaults to B<false>.
5257 =item B<CollectCPULoad> B<true>|B<false>
5259 When set to B<true>, information about the CPU usage will be collected. The
5260 number is a dimensionless value where zero indicates no CPU usage at all.
5261 Defaults to B<false>.
5263 =item B<CollectMemory> B<true>|B<false>
5265 When enabled, the amount of used and free memory will be collected. How used
5266 memory is calculated is unknown, for example whether or not caches are counted
5268 Defaults to B<false>.
5270 =item B<CollectDF> B<true>|B<false>
5272 When enabled, the amount of used and free disk space will be collected.
5273 Defaults to B<false>.
5275 =item B<CollectDisk> B<true>|B<false>
5277 When enabled, the number of sectors written and bad blocks will be collected.
5278 Defaults to B<false>.
5282 =head2 Plugin C<redis>
5284 The I<Redis plugin> connects to one or more Redis servers and gathers
5285 information about each server's state. For each server there is a I<Node> block
5286 which configures the connection parameters for this node.
5296 The information shown in the synopsis above is the I<default configuration>
5297 which is used by the plugin if no configuration is present.
5301 =item B<Node> I<Nodename>
5303 The B<Node> block identifies a new Redis node, that is a new Redis instance
5304 running in an specified host and port. The name for node is a canonical
5305 identifier which is used as I<plugin instance>. It is limited to
5306 64E<nbsp>characters in length.
5308 =item B<Host> I<Hostname>
5310 The B<Host> option is the hostname or IP-address where the Redis instance is
5313 =item B<Port> I<Port>
5315 The B<Port> option is the TCP port on which the Redis instance accepts
5316 connections. Either a service name of a port number may be given. Please note
5317 that numerical port numbers must be given as a string, too.
5319 =item B<Password> I<Password>
5321 Use I<Password> to authenticate when connecting to I<Redis>.
5323 =item B<Timeout> I<Timeout in miliseconds>
5325 The B<Timeout> option set the socket timeout for node response. Since the Redis
5326 read function is blocking, you should keep this value as low as possible. Keep
5327 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
5328 than B<Interval> defined globally.
5332 =head2 Plugin C<rrdcached>
5334 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
5335 to store values to RRD files in an efficient manner. The combination of the
5336 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
5337 way the C<rrdtool> plugin works (see below). The added abstraction layer
5338 provides a number of benefits, though: Because the cache is not within
5339 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
5340 restarted. This results in much shorter (if any) gaps in graphs, especially
5341 under heavy load. Also, the C<rrdtool> command line utility is aware of the
5342 daemon so that it can flush values to disk automatically when needed. This
5343 allows to integrate automated flushing of values into graphing solutions much
5346 There are disadvantages, though: The daemon may reside on a different host, so
5347 it may not be possible for C<collectd> to create the appropriate RRD files
5348 anymore. And even if C<rrdcached> runs on the same host, it may run in a
5349 different base directory, so relative paths may do weird stuff if you're not
5352 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
5353 on the same host, communicating via a UNIX domain socket. The B<DataDir>
5354 setting should be set to an absolute path, so that a changed base directory
5355 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
5359 =item B<DaemonAddress> I<Address>
5361 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
5362 library. See L<rrdcached(1)> for details. Example:
5364 <Plugin "rrdcached">
5365 DaemonAddress "unix:/var/run/rrdcached.sock"
5368 =item B<DataDir> I<Directory>
5370 Set the base directory in which the RRD files reside. If this is a relative
5371 path, it is relative to the working base directory of the C<rrdcached> daemon!
5372 Use of an absolute path is recommended.
5374 =item B<CreateFiles> B<true>|B<false>
5376 Enables or disables the creation of RRD files. If the daemon is not running
5377 locally, or B<DataDir> is set to a relative path, this will not work as
5378 expected. Default is B<true>.
5380 =item B<CreateFilesAsync> B<false>|B<true>
5382 When enabled, new RRD files are enabled asynchronously, using a separate thread
5383 that runs in the background. This prevents writes to block, which is a problem
5384 especially when many hundreds of files need to be created at once. However,
5385 since the purpose of creating the files asynchronously is I<not> to block until
5386 the file is available, values before the file is available will be discarded.
5387 When disabled (the default) files are created synchronously, blocking for a
5388 short while, while the file is being written.
5390 =item B<StepSize> I<Seconds>
5392 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5393 this setting is unset and the stepsize is set to the interval in which the data
5394 is collected. Do not use this option unless you absolutely have to for some
5395 reason. Setting this option may cause problems with the C<snmp plugin>, the
5396 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5398 =item B<HeartBeat> I<Seconds>
5400 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5401 in which case the heartbeat is set to twice the B<StepSize> which should equal
5402 the interval in which data is collected. Do not set this option unless you have
5403 a very good reason to do so.
5405 =item B<RRARows> I<NumRows>
5407 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5408 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5409 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5410 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5411 week, one month, and one year.
5413 So for each timespan, it calculates how many PDPs need to be consolidated into
5414 one CDP by calculating:
5415 number of PDPs = timespan / (stepsize * rrarows)
5417 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5420 =item B<RRATimespan> I<Seconds>
5422 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5423 more then one RRA. If this option is never used, the built-in default of (3600,
5424 86400, 604800, 2678400, 31622400) is used.
5426 For more information on how RRA-sizes are calculated see B<RRARows> above.
5428 =item B<XFF> I<Factor>
5430 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5431 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5436 =head2 Plugin C<rrdtool>
5438 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
5439 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
5440 using these settings. If you don't want to dive into the depths of RRDtool, you
5441 can safely ignore these settings.
5445 =item B<DataDir> I<Directory>
5447 Set the directory to store RRD files under. By default RRD files are generated
5448 beneath the daemon's working directory, i.e. the B<BaseDir>.
5450 =item B<CreateFilesAsync> B<false>|B<true>
5452 When enabled, new RRD files are enabled asynchronously, using a separate thread
5453 that runs in the background. This prevents writes to block, which is a problem
5454 especially when many hundreds of files need to be created at once. However,
5455 since the purpose of creating the files asynchronously is I<not> to block until
5456 the file is available, values before the file is available will be discarded.
5457 When disabled (the default) files are created synchronously, blocking for a
5458 short while, while the file is being written.
5460 =item B<StepSize> I<Seconds>
5462 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5463 this setting is unset and the stepsize is set to the interval in which the data
5464 is collected. Do not use this option unless you absolutely have to for some
5465 reason. Setting this option may cause problems with the C<snmp plugin>, the
5466 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5468 =item B<HeartBeat> I<Seconds>
5470 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5471 in which case the heartbeat is set to twice the B<StepSize> which should equal
5472 the interval in which data is collected. Do not set this option unless you have
5473 a very good reason to do so.
5475 =item B<RRARows> I<NumRows>
5477 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5478 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5479 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5480 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5481 week, one month, and one year.
5483 So for each timespan, it calculates how many PDPs need to be consolidated into
5484 one CDP by calculating:
5485 number of PDPs = timespan / (stepsize * rrarows)
5487 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5490 =item B<RRATimespan> I<Seconds>
5492 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5493 more then one RRA. If this option is never used, the built-in default of (3600,
5494 86400, 604800, 2678400, 31622400) is used.
5496 For more information on how RRA-sizes are calculated see B<RRARows> above.
5498 =item B<XFF> I<Factor>
5500 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5501 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5504 =item B<CacheFlush> I<Seconds>
5506 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
5507 it writes all values for a certain RRD-file if the oldest value is older than
5508 (or equal to) the number of seconds specified. If some RRD-file is not updated
5509 anymore for some reason (the computer was shut down, the network is broken,
5510 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
5511 entire cache is searched for entries older than B<CacheTimeout> seconds and
5512 written to disk every I<Seconds> seconds. Since this is kind of expensive and
5513 does nothing under normal circumstances, this value should not be too small.
5514 900 seconds might be a good value, though setting this to 7200 seconds doesn't
5515 normally do much harm either.
5517 =item B<CacheTimeout> I<Seconds>
5519 If this option is set to a value greater than zero, the C<rrdtool plugin> will
5520 save values in a cache, as described above. Writing multiple values at once
5521 reduces IO-operations and thus lessens the load produced by updating the files.
5522 The trade off is that the graphs kind of "drag behind" and that more memory is
5525 =item B<WritesPerSecond> I<Updates>
5527 When collecting many statistics with collectd and the C<rrdtool> plugin, you
5528 will run serious performance problems. The B<CacheFlush> setting and the
5529 internal update queue assert that collectd continues to work just fine even
5530 under heavy load, but the system may become very unresponsive and slow. This is
5531 a problem especially if you create graphs from the RRD files on the same
5532 machine, for example using the C<graph.cgi> script included in the
5533 C<contrib/collection3/> directory.
5535 This setting is designed for very large setups. Setting this option to a value
5536 between 25 and 80 updates per second, depending on your hardware, will leave
5537 the server responsive enough to draw graphs even while all the cached values
5538 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
5539 by the B<FLUSH> command, are B<not> effected by this limit. They are still
5540 written as fast as possible, so that web frontends have up to date data when
5543 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
5544 updates per second, writing all values to disk will take approximately
5545 56E<nbsp>minutes. Together with the flushing ability that's integrated into
5546 "collection3" you'll end up with a responsive and fast system, up to date
5547 graphs and basically a "backup" of your values every hour.
5549 =item B<RandomTimeout> I<Seconds>
5551 When set, the actual timeout for each value is chosen randomly between
5552 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
5553 intention is to avoid high load situations that appear when many values timeout
5554 at the same time. This is especially a problem shortly after the daemon starts,
5555 because all values were added to the internal cache at roughly the same time.
5559 =head2 Plugin C<sensors>
5561 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
5562 that all the needed modules have to be loaded and lm_sensors has to be
5563 configured (most likely by editing F</etc/sensors.conf>. Read
5564 L<sensors.conf(5)> for details.
5566 The B<lm_sensors> homepage can be found at
5567 L<http://secure.netroedge.com/~lm78/>.
5571 =item B<SensorConfigFile> I<File>
5573 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
5574 the library's default will be used.
5576 =item B<Sensor> I<chip-bus-address/type-feature>
5578 Selects the name of the sensor which you want to collect or ignore, depending
5579 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
5580 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
5581 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
5583 =item B<IgnoreSelected> I<true>|I<false>
5585 If no configuration if given, the B<sensors>-plugin will collect data from all
5586 sensors. This may not be practical, especially for uninteresting sensors.
5587 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
5588 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
5589 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
5590 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
5591 and all other sensors are collected.
5595 =head2 Plugin C<sigrok>
5597 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
5598 supported by the L<sigrok|http://sigrok.org/> project.
5604 <Device "AC Voltage">
5609 <Device "Sound Level">
5610 Driver "cem-dt-885x"
5617 =item B<LogLevel> B<0-5>
5619 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
5620 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
5621 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
5622 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
5623 their level, are always submitted to I<collectd> at its INFO log level.
5625 =item E<lt>B<Device> I<Name>E<gt>
5627 A sigrok-supported device, uniquely identified by this section's options. The
5628 I<Name> is passed to I<collectd> as the I<plugin instance>.
5630 =item B<Driver> I<DriverName>
5632 The sigrok driver to use for this device.
5634 =item B<Conn> I<ConnectionSpec>
5636 If the device cannot be auto-discovered, or more than one might be discovered
5637 by the driver, I<ConnectionSpec> specifies the connection string to the device.
5638 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
5639 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
5640 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
5641 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
5643 =item B<SerialComm> I<SerialSpec>
5645 For serial devices with non-standard port settings, this option can be used
5646 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
5647 This should not be necessary; drivers know how to communicate with devices they
5650 =item B<MinimumInterval> I<Seconds>
5652 Specifies the minimum time between measurement dispatches to I<collectd>, in
5653 seconds. Since some I<sigrok> supported devices can acquire measurements many
5654 times per second, it may be necessary to throttle these. For example, the
5655 I<RRD plugin> cannot process writes more than once per second.
5657 The default B<MinimumInterval> is B<0>, meaning measurements received from the
5658 device are always dispatched to I<collectd>. When throttled, unused
5659 measurements are discarded.
5663 =head2 Plugin C<snmp>
5665 Since the configuration of the C<snmp plugin> is a little more complicated than
5666 other plugins, its documentation has been moved to an own manpage,
5667 L<collectd-snmp(5)>. Please see there for details.
5669 =head2 Plugin C<statsd>
5671 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
5672 protocol and dispatches rates or other aggregates of these numbers
5675 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
5676 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
5677 C<objects> respectively.
5679 The following configuration options are valid:
5683 =item B<Host> I<Host>
5685 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
5686 "any" address, i.e. accept packets sent to any of the hosts addresses.
5688 =item B<Port> I<Port>
5690 UDP port to listen to. This can be either a service name or a port number.
5691 Defaults to C<8125>.
5693 =item B<DeleteCounters> B<false>|B<true>
5695 =item B<DeleteTimers> B<false>|B<true>
5697 =item B<DeleteGauges> B<false>|B<true>
5699 =item B<DeleteSets> B<false>|B<true>
5701 These options control what happens if metrics are not updated in an interval.
5702 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
5703 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
5704 are unchanged. If set to B<True>, the such metrics are not dispatched and
5705 removed from the internal cache.
5707 =item B<TimerPercentile> I<Percent>
5709 Calculate and dispatch the configured percentile, i.e. compute the latency, so
5710 that I<Percent> of all reported timers are smaller than or equal to the
5711 computed latency. This is useful for cutting off the long tail latency, as it's
5712 often done in I<Service Level Agreements> (SLAs).
5714 If not specified, no percentile is calculated / dispatched.
5718 =head2 Plugin C<swap>
5720 The I<Swap plugin> collects information about used and available swap space. On
5721 I<Linux> and I<Solaris>, the following options are available:
5725 =item B<ReportByDevice> B<false>|B<true>
5727 Configures how to report physical swap devices. If set to B<false> (the
5728 default), the summary over all swap devices is reported only, i.e. the globally
5729 used and available space over all devices. If B<true> is configured, the used
5730 and available space of each device will be reported separately.
5732 This option is only available if the I<Swap plugin> can read C</proc/swaps>
5733 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
5735 =item B<ReportBytes> B<false>|B<true>
5737 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
5738 I<swap I/O> is reported in pages. This option is available under Linux only.
5740 =item B<ValuesAbsolute> B<true>|B<false>
5742 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
5743 available and used. Defaults to B<true>.
5745 =item B<ValuesPercentage> B<false>|B<true>
5747 Enables or disables reporting of relative swap metrics, i.e. I<percent>
5748 available and free. Defaults to B<false>.
5750 This is useful for deploying I<collectd> in a heterogeneous environment, where
5751 swap sizes differ and you want to specify generic thresholds or similar.
5755 =head2 Plugin C<syslog>
5759 =item B<LogLevel> B<debug|info|notice|warning|err>
5761 Sets the log-level. If, for example, set to B<notice>, then all events with
5762 severity B<notice>, B<warning>, or B<err> will be submitted to the
5765 Please note that B<debug> is only available if collectd has been compiled with
5768 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
5770 Controls which notifications should be sent to syslog. The default behaviour is
5771 not to send any. Less severe notifications always imply logging more severe
5772 notifications: Setting this to B<OKAY> means all notifications will be sent to
5773 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
5774 notifications but will dismiss B<OKAY> notifications. Setting this option to
5775 B<FAILURE> will only send failures to syslog.
5779 =head2 Plugin C<table>
5781 The C<table plugin> provides generic means to parse tabular data and dispatch
5782 user specified values. Values are selected based on column numbers. For
5783 example, this plugin may be used to get values from the Linux L<proc(5)>
5784 filesystem or CSV (comma separated values) files.
5787 <Table "/proc/slabinfo">
5792 InstancePrefix "active_objs"
5798 InstancePrefix "objperslab"
5805 The configuration consists of one or more B<Table> blocks, each of which
5806 configures one file to parse. Within each B<Table> block, there are one or
5807 more B<Result> blocks, which configure which data to select and how to
5810 The following options are available inside a B<Table> block:
5814 =item B<Instance> I<instance>
5816 If specified, I<instance> is used as the plugin instance. So, in the above
5817 example, the plugin name C<table-slabinfo> would be used. If omitted, the
5818 filename of the table is used instead, with all special characters replaced
5819 with an underscore (C<_>).
5821 =item B<Separator> I<string>
5823 Any character of I<string> is interpreted as a delimiter between the different
5824 columns of the table. A sequence of two or more contiguous delimiters in the
5825 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
5826 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
5827 of a table - see its documentation for more details. This option is mandatory.
5829 A horizontal tab, newline and carriage return may be specified by C<\\t>,
5830 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
5831 required because of collectd's config parsing.
5835 The following options are available inside a B<Result> block:
5839 =item B<Type> I<type>
5841 Sets the type used to dispatch the values to the daemon. Detailed information
5842 about types and their configuration can be found in L<types.db(5)>. This
5843 option is mandatory.
5845 =item B<InstancePrefix> I<prefix>
5847 If specified, prepend I<prefix> to the type instance. If omitted, only the
5848 B<InstancesFrom> option is considered for the type instance.
5850 =item B<InstancesFrom> I<column0> [I<column1> ...]
5852 If specified, the content of the given columns (identified by the column
5853 number starting at zero) will be used to create the type instance for each
5854 row. Multiple values (and the instance prefix) will be joined together with
5855 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
5856 option is considered for the type instance.
5858 The plugin itself does not check whether or not all built instances are
5859 different. It’s your responsibility to assure that each is unique. This is
5860 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
5861 sure that the table only contains one row.
5863 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
5866 =item B<ValuesFrom> I<column0> [I<column1> ...]
5868 Specifies the columns (identified by the column numbers starting at zero)
5869 whose content is used as the actual data for the data sets that are dispatched
5870 to the daemon. How many such columns you need is determined by the B<Type>
5871 setting above. If you specify too many or not enough columns, the plugin will
5872 complain about that and no data will be submitted to the daemon. The plugin
5873 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
5874 respectively, so anything supported by those functions is supported by the
5875 plugin as well. This option is mandatory.
5879 =head2 Plugin C<tail>
5881 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
5882 each line and dispatches found values. What is matched can be configured by the
5883 user using (extended) regular expressions, as described in L<regex(7)>.
5886 <File "/var/log/exim4/mainlog">
5890 Regex "S=([1-9][0-9]*)"
5896 Regex "\\<R=local_user\\>"
5897 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
5900 Instance "local_user"
5905 The config consists of one or more B<File> blocks, each of which configures one
5906 logfile to parse. Within each B<File> block, there are one or more B<Match>
5907 blocks, which configure a regular expression to search for.
5909 The B<Instance> option in the B<File> block may be used to set the plugin
5910 instance. So in the above example the plugin name C<tail-foo> would be used.
5911 This plugin instance is for all B<Match> blocks that B<follow> it, until the
5912 next B<Instance> option. This way you can extract several plugin instances from
5913 one logfile, handy when parsing syslog and the like.
5915 The B<Interval> option allows you to define the length of time between reads. If
5916 this is not set, the default Interval will be used.
5918 Each B<Match> block has the following options to describe how the match should
5923 =item B<Regex> I<regex>
5925 Sets the regular expression to use for matching against a line. The first
5926 subexpression has to match something that can be turned into a number by
5927 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
5928 below. Because B<extended> regular expressions are used, you do not need to use
5929 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
5930 collectd's config parsing you need to escape backslashes, though. So if you
5931 want to match literal parentheses you need to do the following:
5933 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
5935 =item B<ExcludeRegex> I<regex>
5937 Sets an optional regular expression to use for excluding lines from the match.
5938 An example which excludes all connections from localhost from the match:
5940 ExcludeRegex "127\\.0\\.0\\.1"
5942 =item B<DSType> I<Type>
5944 Sets how the values are cumulated. I<Type> is one of:
5948 =item B<GaugeAverage>
5950 Calculate the average.
5954 Use the smallest number only.
5958 Use the greatest number only.
5962 Use the last number found.
5968 =item B<AbsoluteSet>
5970 The matched number is a counter. Simply I<sets> the internal counter to this
5971 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
5977 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
5978 matched number may be negative, which will effectively subtract from the
5985 Increase the internal counter by one. These B<DSType> are the only ones that do
5986 not use the matched subexpression, but simply count the number of matched
5987 lines. Thus, you may use a regular expression without submatch in this case.
5991 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
5992 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
5993 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
5994 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
5995 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
5998 =item B<Type> I<Type>
6000 Sets the type used to dispatch this value. Detailed information about types and
6001 their configuration can be found in L<types.db(5)>.
6003 =item B<Instance> I<TypeInstance>
6005 This optional setting sets the type instance to use.
6009 =head2 Plugin C<tail_csv>
6011 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
6012 written by I<Snort>.
6017 <Metric "snort-dropped">
6022 <File "/var/log/snort/snort.stats">
6023 Instance "snort-eth0"
6025 Collect "snort-dropped"
6029 The configuration consists of one or more B<Metric> blocks that define an index
6030 into the line of the CSV file and how this value is mapped to I<collectd's>
6031 internal representation. These are followed by one or more B<Instance> blocks
6032 which configure which file to read, in which interval and which metrics to
6037 =item E<lt>B<Metric> I<Name>E<gt>
6039 The B<Metric> block configures a new metric to be extracted from the statistics
6040 file and how it is mapped on I<collectd's> data model. The string I<Name> is
6041 only used inside the B<Instance> blocks to refer to this block, so you can use
6042 one B<Metric> block for multiple CSV files.
6046 =item B<Type> I<Type>
6048 Configures which I<Type> to use when dispatching this metric. Types are defined
6049 in the L<types.db(5)> file, see the appropriate manual page for more
6050 information on specifying types. Only types with a single I<data source> are
6051 supported by the I<tail_csv plugin>. The information whether the value is an
6052 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
6053 I<Type's> definition.
6055 =item B<Instance> I<TypeInstance>
6057 If set, I<TypeInstance> is used to populate the type instance field of the
6058 created value lists. Otherwise, no type instance is used.
6060 =item B<ValueFrom> I<Index>
6062 Configure to read the value from the field with the zero-based index I<Index>.
6063 If the value is parsed as signed integer, unsigned integer or double depends on
6064 the B<Type> setting, see above.
6068 =item E<lt>B<File> I<Path>E<gt>
6070 Each B<File> block represents one CSV file to read. There must be at least one
6071 I<File> block but there can be multiple if you have multiple CSV files.
6075 =item B<Instance> I<PluginInstance>
6077 Sets the I<plugin instance> used when dispatching the values.
6079 =item B<Collect> I<Metric>
6081 Specifies which I<Metric> to collect. This option must be specified at least
6082 once, and you can use this option multiple times to specify more than one
6083 metric to be extracted from this statistic file.
6085 =item B<Interval> I<Seconds>
6087 Configures the interval in which to read values from this instance / file.
6088 Defaults to the plugin's default interval.
6090 =item B<TimeFrom> I<Index>
6092 Rather than using the local time when dispatching a value, read the timestamp
6093 from the field with the zero-based index I<Index>. The value is interpreted as
6094 seconds since epoch. The value is parsed as a double and may be factional.
6100 =head2 Plugin C<teamspeak2>
6102 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
6103 polls interesting global and virtual server data. The plugin can query only one
6104 physical server but unlimited virtual servers. You can use the following
6105 options to configure it:
6109 =item B<Host> I<hostname/ip>
6111 The hostname or ip which identifies the physical server.
6114 =item B<Port> I<port>
6116 The query port of the physical server. This needs to be a string.
6119 =item B<Server> I<port>
6121 This option has to be added once for every virtual server the plugin should
6122 query. If you want to query the virtual server on port 8767 this is what the
6123 option would look like:
6127 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
6128 use quotes around it! If no such statement is given only global information
6133 =head2 Plugin C<ted>
6135 The I<TED> plugin connects to a device of "The Energy Detective", a device to
6136 measure power consumption. These devices are usually connected to a serial
6137 (RS232) or USB port. The plugin opens a configured device and tries to read the
6138 current energy readings. For more information on TED, visit
6139 L<http://www.theenergydetective.com/>.
6141 Available configuration options:
6145 =item B<Device> I<Path>
6147 Path to the device on which TED is connected. collectd will need read and write
6148 permissions on that file.
6150 Default: B</dev/ttyUSB0>
6152 =item B<Retries> I<Num>
6154 Apparently reading from TED is not that reliable. You can therefore configure a
6155 number of retries here. You only configure the I<retries> here, to if you
6156 specify zero, one reading will be performed (but no retries if that fails); if
6157 you specify three, a maximum of four readings are performed. Negative values
6164 =head2 Plugin C<tcpconns>
6166 The C<tcpconns plugin> counts the number of currently established TCP
6167 connections based on the local port and/or the remote port. Since there may be
6168 a lot of connections the default if to count all connections with a local port,
6169 for which a listening socket is opened. You can use the following options to
6170 fine-tune the ports you are interested in:
6174 =item B<ListeningPorts> I<true>|I<false>
6176 If this option is set to I<true>, statistics for all local ports for which a
6177 listening socket exists are collected. The default depends on B<LocalPort> and
6178 B<RemotePort> (see below): If no port at all is specifically selected, the
6179 default is to collect listening ports. If specific ports (no matter if local or
6180 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
6181 the selected ports will be collected unless this option is set to I<true>
6184 =item B<LocalPort> I<Port>
6186 Count the connections to a specific local port. This can be used to see how
6187 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
6188 You have to specify the port in numeric form, so for the mailserver example
6189 you'd need to set B<25>.
6191 =item B<RemotePort> I<Port>
6193 Count the connections to a specific remote port. This is useful to see how
6194 much a remote service is used. This is most useful if you want to know how many
6195 connections a local service has opened to remote services, e.E<nbsp>g. how many
6196 connections a mail server or news server has to other mail or news servers, or
6197 how many connections a web proxy holds to web servers. You have to give the
6198 port in numeric form.
6202 =head2 Plugin C<thermal>
6206 =item B<ForceUseProcfs> I<true>|I<false>
6208 By default, the I<Thermal plugin> tries to read the statistics from the Linux
6209 C<sysfs> interface. If that is not available, the plugin falls back to the
6210 C<procfs> interface. By setting this option to I<true>, you can force the
6211 plugin to use the latter. This option defaults to I<false>.
6213 =item B<Device> I<Device>
6215 Selects the name of the thermal device that you want to collect or ignore,
6216 depending on the value of the B<IgnoreSelected> option. This option may be
6217 used multiple times to specify a list of devices.
6219 =item B<IgnoreSelected> I<true>|I<false>
6221 Invert the selection: If set to true, all devices B<except> the ones that
6222 match the device names specified by the B<Device> option are collected. By
6223 default only selected devices are collected if a selection is made. If no
6224 selection is configured at all, B<all> devices are selected.
6228 =head2 Plugin C<threshold>
6230 The I<Threshold plugin> checks values collected or received by I<collectd>
6231 against a configurable I<threshold> and issues I<notifications> if values are
6234 Documentation for this plugin is available in the L<collectd-threshold(5)>
6237 =head2 Plugin C<tokyotyrant>
6239 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
6240 couple metrics: number of records, and database size on disk.
6244 =item B<Host> I<Hostname/IP>
6246 The hostname or ip which identifies the server.
6247 Default: B<127.0.0.1>
6249 =item B<Port> I<Service/Port>
6251 The query port of the server. This needs to be a string, even if the port is
6252 given in its numeric form.
6257 =head2 Plugin C<unixsock>
6261 =item B<SocketFile> I<Path>
6263 Sets the socket-file which is to be created.
6265 =item B<SocketGroup> I<Group>
6267 If running as root change the group of the UNIX-socket after it has been
6268 created. Defaults to B<collectd>.
6270 =item B<SocketPerms> I<Permissions>
6272 Change the file permissions of the UNIX-socket after it has been created. The
6273 permissions must be given as a numeric, octal value as you would pass to
6274 L<chmod(1)>. Defaults to B<0770>.
6276 =item B<DeleteSocket> B<false>|B<true>
6278 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
6279 with the given name already exists. If I<collectd> crashes a socket file may be
6280 left over, preventing the daemon from opening a new socket when restarted.
6281 Since this is potentially dangerous, this defaults to B<false>.
6285 =head2 Plugin C<uuid>
6287 This plugin, if loaded, causes the Hostname to be taken from the machine's
6288 UUID. The UUID is a universally unique designation for the machine, usually
6289 taken from the machine's BIOS. This is most useful if the machine is running in
6290 a virtual environment such as Xen, in which case the UUID is preserved across
6291 shutdowns and migration.
6293 The following methods are used to find the machine's UUID, in order:
6299 Check I</etc/uuid> (or I<UUIDFile>).
6303 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
6308 Check for UUID from C<dmidecode> / SMBIOS.
6312 Check for UUID from Xen hypervisor.
6316 If no UUID can be found then the hostname is not modified.
6320 =item B<UUIDFile> I<Path>
6322 Take the UUID from the given file (default I</etc/uuid>).
6326 =head2 Plugin C<varnish>
6328 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
6333 <Instance "example">
6335 CollectConnections true
6345 CollectWorkers false
6349 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
6350 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
6351 will collectd statistics from the default "varnishd" instance (this should work
6352 fine in most cases).
6354 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
6358 =item B<CollectCache> B<true>|B<false>
6360 Cache hits and misses. True by default.
6362 =item B<CollectConnections> B<true>|B<false>
6364 Number of client connections received, accepted and dropped. True by default.
6366 =item B<CollectBackend> B<true>|B<false>
6368 Back-end connection statistics, such as successful, reused,
6369 and closed connections. True by default.
6371 =item B<CollectSHM> B<true>|B<false>
6373 Statistics about the shared memory log, a memory region to store
6374 log messages which is flushed to disk when full. True by default.
6376 =item B<CollectBan> B<true>|B<false>
6378 Statistics about ban operations, such as number of bans added, retired, and
6379 number of objects tested against ban operations. Only available with Varnish
6380 3.x. False by default.
6382 =item B<CollectDirectorDNS> B<true>|B<false>
6384 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
6387 =item B<CollectESI> B<true>|B<false>
6389 Edge Side Includes (ESI) parse statistics. False by default.
6391 =item B<CollectFetch> B<true>|B<false>
6393 Statistics about fetches (HTTP requests sent to the backend). False by default.
6395 =item B<CollectHCB> B<true>|B<false>
6397 Inserts and look-ups in the crit bit tree based hash. Look-ups are
6398 divided into locked and unlocked look-ups. False by default.
6400 =item B<CollectObjects> B<true>|B<false>
6402 Statistics on cached objects: number of objects expired, nuked (prematurely
6403 expired), saved, moved, etc. False by default.
6405 =item B<CollectPurge> B<true>|B<false>
6407 Statistics about purge operations, such as number of purges added, retired, and
6408 number of objects tested against purge operations. Only available with Varnish
6409 2.x. False by default.
6411 =item B<CollectSession> B<true>|B<false>
6413 Client session statistics. Number of past and current sessions, session herd and
6414 linger counters, etc. False by default.
6416 =item B<CollectSMA> B<true>|B<false>
6418 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
6419 component is Solaris specific. Only available with Varnish 2.x. False by
6422 =item B<CollectSMS> B<true>|B<false>
6424 synth (synthetic content) storage statistics. This storage
6425 component is used internally only. False by default.
6427 =item B<CollectSM> B<true>|B<false>
6429 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
6432 =item B<CollectStruct> B<true>|B<false>
6434 Current varnish internal state statistics. Number of current sessions, objects
6435 in cache store, open connections to backends (with Varnish 2.x), etc. False by
6438 =item B<CollectTotals> B<true>|B<false>
6440 Collects overview counters, such as the number of sessions created,
6441 the number of requests and bytes transferred. False by default.
6443 =item B<CollectUptime> B<true>|B<false>
6445 Varnish uptime. False by default.
6447 =item B<CollectVCL> B<true>|B<false>
6449 Number of total (available + discarded) VCL (config files). False by default.
6451 =item B<CollectWorkers> B<true>|B<false>
6453 Collect statistics about worker threads. False by default.
6457 =head2 Plugin C<vmem>
6459 The C<vmem> plugin collects information about the usage of virtual memory.
6460 Since the statistics provided by the Linux kernel are very detailed, they are
6461 collected very detailed. However, to get all the details, you have to switch
6462 them on manually. Most people just want an overview over, such as the number of
6463 pages read from swap space.
6467 =item B<Verbose> B<true>|B<false>
6469 Enables verbose collection of information. This will start collecting page
6470 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
6471 Part of these statistics are collected on a "per zone" basis.
6475 =head2 Plugin C<vserver>
6477 This plugin doesn't have any options. B<VServer> support is only available for
6478 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
6479 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
6480 need to apply the patches and compile your own kernel, which will then provide
6481 the F</proc/virtual> filesystem that is required by this plugin.
6483 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
6485 B<Note>: The traffic collected by this plugin accounts for the amount of
6486 traffic passing a socket which might be a lot less than the actual on-wire
6487 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
6488 collect on-wire traffic you could, for example, use the logging facilities of
6489 iptables to feed data for the guest IPs into the iptables plugin.
6491 =head2 Plugin C<write_graphite>
6493 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
6494 storage and graphing project. The plugin connects to I<Carbon>, the data layer
6495 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
6496 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
6497 of at most 1428 bytes to minimize the number of network packets.
6501 <Plugin write_graphite>
6511 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6512 blocks. Inside the B<Node> blocks, the following options are recognized:
6516 =item B<Host> I<Address>
6518 Hostname or address to connect to. Defaults to C<localhost>.
6520 =item B<Port> I<Service>
6522 Service name or port number to connect to. Defaults to C<2003>.
6524 =item B<Protocol> I<String>
6526 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
6528 =item B<LogSendErrors> B<false>|B<true>
6530 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
6531 If set to B<false>, it will not log the errors. This is especially useful when
6532 using Protocol UDP since many times we want to use the "fire-and-forget"
6533 approach and logging errors fills syslog with unneeded messages.
6535 =item B<Prefix> I<String>
6537 When set, I<String> is added in front of the host name. Dots and whitespace are
6538 I<not> escaped in this string (see B<EscapeCharacter> below).
6540 =item B<Postfix> I<String>
6542 When set, I<String> is appended to the host name. Dots and whitespace are
6543 I<not> escaped in this string (see B<EscapeCharacter> below).
6545 =item B<EscapeCharacter> I<Char>
6547 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
6548 in the identifier. The B<EscapeCharacter> option determines which character
6549 dots, whitespace and control characters are replaced with. Defaults to
6552 =item B<StoreRates> B<false>|B<true>
6554 If set to B<true> (the default), convert counter values to rates. If set to
6555 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6558 =item B<SeparateInstances> B<false>|B<true>
6560 If set to B<true>, the plugin instance and type instance will be in their own
6561 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6562 default), the plugin and plugin instance (and likewise the type and type
6563 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6565 =item B<AlwaysAppendDS> B<false>|B<true>
6567 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
6568 identifier. If set to B<false> (the default), this is only done when there is
6573 =head2 Plugin C<write_tsdb>
6575 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
6576 time series database. The plugin connects to a I<TSD>, a masterless, no shared
6577 state daemon that ingests metrics and stores them in HBase. The plugin uses
6578 I<TCP> over the "line based" protocol with a default port 4242. The data will
6579 be sent in blocks of at most 1428 bytes to minimize the number of network
6586 Host "tsd-1.my.domain"
6588 HostTags "status=production"
6592 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6593 blocks. Inside the B<Node> blocks, the following options are recognized:
6597 =item B<Host> I<Address>
6599 Hostname or address to connect to. Defaults to C<localhost>.
6601 =item B<Port> I<Service>
6603 Service name or port number to connect to. Defaults to C<4242>.
6606 =item B<HostTags> I<String>
6608 When set, I<HostTags> is added to the end of the metric. It is intended to be
6609 used for name=value pairs that the TSD will tag the metric with. Dots and
6610 whitespace are I<not> escaped in this string.
6612 =item B<StoreRates> B<false>|B<true>
6614 If set to B<true>, convert counter values to rates. If set to B<false>
6615 (the default) counter values are stored as is, as an increasing
6618 =item B<AlwaysAppendDS> B<false>|B<true>
6620 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
6621 identifier. If set to B<false> (the default), this is only done when there is
6626 =head2 Plugin C<write_mongodb>
6628 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
6633 <Plugin "write_mongodb">
6642 The plugin can send values to multiple instances of I<MongoDB> by specifying
6643 one B<Node> block for each instance. Within the B<Node> blocks, the following
6644 options are available:
6648 =item B<Host> I<Address>
6650 Hostname or address to connect to. Defaults to C<localhost>.
6652 =item B<Port> I<Service>
6654 Service name or port number to connect to. Defaults to C<27017>.
6656 =item B<Timeout> I<Timeout>
6658 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
6659 Setting this option to zero means no timeout, which is the default.
6661 =item B<StoreRates> B<false>|B<true>
6663 If set to B<true> (the default), convert counter values to rates. If set to
6664 B<false> counter values are stored as is, i.e. as an increasing integer
6667 =item B<Database> I<Database>
6669 =item B<User> I<User>
6671 =item B<Password> I<Password>
6673 Sets the information used when authenticating to a I<MongoDB> database. The
6674 fields are optional (in which case no authentication is attempted), but if you
6675 want to use authentication all three fields must be set.
6679 =head2 Plugin C<write_http>
6681 This output plugin submits values to an HTTP server using POST requests and
6682 encoding metrics with JSON or using the C<PUTVAL> command described in
6683 L<collectd-unixsock(5)>. Each destination you want to post data to needs to
6684 have one B<URL> block, within which the destination can be configured further,
6685 for example by specifying authentication data.
6689 <Plugin "write_http">
6690 <URL "http://example.com/post-collectd">
6697 B<URL> blocks need one string argument which is used as the URL to which data
6698 is posted. The following options are understood within B<URL> blocks.
6702 =item B<User> I<Username>
6704 Optional user name needed for authentication.
6706 =item B<Password> I<Password>
6708 Optional password needed for authentication.
6710 =item B<VerifyPeer> B<true>|B<false>
6712 Enable or disable peer SSL certificate verification. See
6713 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
6715 =item B<VerifyHost> B<true|false>
6717 Enable or disable peer host name verification. If enabled, the plugin checks if
6718 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
6719 matches the host name provided by the B<URL> option. If this identity check
6720 fails, the connection is aborted. Obviously, only works when connecting to a
6721 SSL enabled server. Enabled by default.
6723 =item B<CACert> I<File>
6725 File that holds one or more SSL certificates. If you want to use HTTPS you will
6726 possibly need this option. What CA certificates come bundled with C<libcurl>
6727 and are checked by default depends on the distribution you use.
6729 =item B<CAPath> I<Directory>
6731 Directory holding one or more CA certificate files. You can use this if for
6732 some reason all the needed CA certificates aren't in the same file and can't be
6733 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
6736 =item B<ClientKey> I<File>
6738 File that holds the private key in PEM format to be used for certificate-based
6741 =item B<ClientCert> I<File>
6743 File that holds the SSL certificate to be used for certificate-based
6746 =item B<ClientKeyPass> I<Password>
6748 Password required to load the private key in B<ClientKey>.
6750 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
6752 Define which SSL protocol version must be used. By default C<libcurl> will
6753 attempt to figure out the remote SSL protocol version. See
6754 L<curl_easy_setopt(3)> for more details.
6756 =item B<Format> B<Command>|B<JSON>
6758 Format of the output to generate. If set to B<Command>, will create output that
6759 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
6760 create output in the I<JavaScript Object Notation> (JSON).
6762 Defaults to B<Command>.
6764 =item B<StoreRates> B<true|false>
6766 If set to B<true>, convert counter values to rates. If set to B<false> (the
6767 default) counter values are stored as is, i.e. as an increasing integer number.
6769 =item B<BufferSize> I<Bytes>
6771 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
6772 requests will be generated, but more metrics will be batched / metrics are
6773 cached for longer before being sent, introducing additional delay until they
6774 are available on the server side. I<Bytes> must be at least 1024 and cannot
6775 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
6776 Defaults to C<4096>.
6780 =head2 Plugin C<write_kafka>
6782 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
6786 <Plugin "write_kafka">
6787 Property "metadata.broker.list" "broker1:9092,broker2:9092"
6793 The following options are understood by the I<write_kafka plugin>:
6797 =item E<lt>B<Topic> I<Name>E<gt>
6799 The plugin's configuration consists of one or more B<Topic> blocks. Each block
6800 is given a unique I<Name> and specifies one kafka producer.
6801 Inside the B<Topic> block, the following per-topic options are
6806 =item B<Property> I<String> I<String>
6808 Configure the named property for the current topic. Properties are
6809 forwarded to the kafka producer library B<librdkafka>.
6811 =item B<Key> I<String>
6813 Use the specified string as a partioning key for the topic. Kafka breaks
6814 topic into partitions and guarantees that for a given topology, the same
6815 consumer will be used for a specific key. The special (case insensitive)
6816 string B<Random> can be used to specify that an arbitrary partition should
6819 =item B<Format> B<Command>|B<JSON>|B<Graphite>
6821 Selects the format in which messages are sent to the broker. If set to
6822 B<Command> (the default), values are sent as C<PUTVAL> commands which are
6823 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
6825 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
6826 an easy and straight forward exchange format.
6828 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
6829 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
6831 =item B<StoreRates> B<true>|B<false>
6833 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
6834 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
6835 default), no conversion is performed. Otherwise the conversion is performed
6836 using the internal value cache.
6838 Please note that currently this option is only used if the B<Format> option has
6839 been set to B<JSON>.
6841 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
6843 A prefix can be added in the metric name when outputting in the I<Graphite>
6844 format. It's added before the I<Host> name.
6846 C<E<lt>prefixE<gt>E<lt>hostE<gt>E<lt>postfixE<gt>E<lt>pluginE<gt>E<lt>typeE<gt>E<lt>nameE<gt>>
6848 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
6850 A postfix can be added in the metric name when outputting in the I<Graphite>
6851 format. It's added after the I<Host> name.
6853 C<E<lt>prefixE<gt>E<lt>hostE<gt>E<lt>postfixE<gt>E<lt>pluginE<gt>E<lt>typeE<gt>E<lt>nameE<gt>>
6855 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
6857 Specify a character to replace dots (.) in the host part of the metric name.
6858 In I<Graphite> metric name, dots are used as separators between different
6859 metric parts (host, plugin, type).
6860 Default is C<_> (I<Underscore>).
6862 =item B<GraphiteSeparateInstances> B<false>|B<true>
6864 If set to B<true>, the plugin instance and type instance will be in their own
6865 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6866 default), the plugin and plugin instance (and likewise the type and type
6867 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6869 =item B<StoreRates> B<true>|B<false>
6871 If set to B<true> (the default), convert counter values to rates. If set to
6872 B<false> counter values are stored as is, i.e. as an increasing integer number.
6874 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
6875 converted values will have "rate" appended to the data source type, e.g.
6876 C<ds_type:derive:rate>.
6880 =item B<Property> I<String> I<String>
6882 Configure the kafka producer through properties, you almost always will
6883 want to set B<metadata.broker.list> to your Kafka broker list.
6887 =head2 Plugin C<write_riemann>
6889 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
6890 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
6891 I<Riemann> using UDP packets.
6895 <Plugin "write_riemann">
6901 AlwaysAppendDS false
6905 Attribute "foo" "bar"
6908 The following options are understood by the I<write_riemann plugin>:
6912 =item E<lt>B<Node> I<Name>E<gt>
6914 The plugin's configuration consists of one or more B<Node> blocks. Each block
6915 is given a unique I<Name> and specifies one connection to an instance of
6916 I<Riemann>. Indise the B<Node> block, the following per-connection options are
6921 =item B<Host> I<Address>
6923 Hostname or address to connect to. Defaults to C<localhost>.
6925 =item B<Port> I<Service>
6927 Service name or port number to connect to. Defaults to C<5555>.
6929 =item B<Protocol> B<UDP>|B<TCP>
6931 Specify the protocol to use when communicating with I<Riemann>. Defaults to
6934 =item B<StoreRates> B<true>|B<false>
6936 If set to B<true> (the default), convert counter values to rates. If set to
6937 B<false> counter values are stored as is, i.e. as an increasing integer number.
6939 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
6940 converted values will have "rate" appended to the data source type, e.g.
6941 C<ds_type:derive:rate>.
6943 =item B<AlwaysAppendDS> B<false>|B<true>
6945 If set the B<true>, append the name of the I<Data Source> (DS) to the
6946 "service", i.e. the field that, together with the "host" field, uniquely
6947 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
6948 only done when there is more than one DS.
6950 =item B<TTLFactor> I<Factor>
6952 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
6953 event is considered active. I<collectd> populates this field based on the
6954 metrics interval setting. This setting controls the factor with which the
6955 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
6956 know exactly what you're doing, you should only increase this setting from its
6959 =item B<Notifications> B<false>|B<true>
6961 If set to B<true>, create riemann events for notifications. This is B<true>
6962 by default. When processing thresholds from write_riemann, it might prove
6963 useful to avoid getting notification events.
6965 =item B<CheckThresholds> B<false>|B<true>
6967 If set to B<true>, attach state to events based on thresholds defined
6968 in the B<Threshold> plugin. Defaults to B<false>.
6970 =item B<EventServicePrefix> I<String>
6972 Add the given string as a prefix to the event service name.
6973 If B<EventServicePrefix> not set or set to an empty string (""),
6974 no prefix will be used.
6978 =item B<Tag> I<String>
6980 Add the given string as an additional tag to the metric being sent to
6983 =item B<Attribute> I<String> I<String>
6985 Consider the two given strings to be the key and value of an additional
6986 attribute for each metric being sent out to I<Riemann>.
6990 =head1 THRESHOLD CONFIGURATION
6992 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
6993 we mean that the values are not only stored or sent somewhere, but that they
6994 are judged and, if a problem is recognized, acted upon. The only action
6995 collectd takes itself is to generate and dispatch a "notification". Plugins can
6996 register to receive notifications and perform appropriate further actions.
6998 Since systems and what you expect them to do differ a lot, you can configure
6999 B<thresholds> for your values freely. This gives you a lot of flexibility but
7000 also a lot of responsibility.
7002 Every time a value is out of range a notification is dispatched. This means
7003 that the idle percentage of your CPU needs to be less then the configured
7004 threshold only once for a notification to be generated. There's no such thing
7005 as a moving average or similar - at least not now.
7007 Also, all values that match a threshold are considered to be relevant or
7008 "interesting". As a consequence collectd will issue a notification if they are
7009 not received for B<Timeout> iterations. The B<Timeout> configuration option is
7010 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
7011 "2" (the default) and some hosts sends it's CPU statistics to the server every
7012 60 seconds, a notification will be dispatched after about 120 seconds. It may
7013 take a little longer because the timeout is checked only once each B<Interval>
7016 When a value comes within range again or is received after it was missing, an
7017 "OKAY-notification" is dispatched.
7019 Here is a configuration example to get you started. Read below for more
7032 <Plugin "interface">
7049 WarningMin 100000000
7055 There are basically two types of configuration statements: The C<Host>,
7056 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
7057 configured. The C<Plugin> and C<Type> blocks may be specified further using the
7058 C<Instance> option. You can combine the block by nesting the blocks, though
7059 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
7060 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
7061 C<Type> may not contain other blocks. If multiple blocks apply to the same
7062 value the most specific block is used.
7064 The other statements specify the threshold to configure. They B<must> be
7065 included in a C<Type> block. Currently the following statements are recognized:
7069 =item B<FailureMax> I<Value>
7071 =item B<WarningMax> I<Value>
7073 Sets the upper bound of acceptable values. If unset defaults to positive
7074 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
7075 will be created. If the value is greater than B<WarningMax> but less than (or
7076 equal to) B<FailureMax> a B<WARNING> notification will be created.
7078 =item B<FailureMin> I<Value>
7080 =item B<WarningMin> I<Value>
7082 Sets the lower bound of acceptable values. If unset defaults to negative
7083 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
7084 be created. If the value is less than B<WarningMin> but greater than (or equal
7085 to) B<FailureMin> a B<WARNING> notification will be created.
7087 =item B<DataSource> I<DSName>
7089 Some data sets have more than one "data source". Interesting examples are the
7090 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
7091 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
7092 system load data set, C<load>, even has three data sources: C<shortterm>,
7093 C<midterm>, and C<longterm>.
7095 Normally, all data sources are checked against a configured threshold. If this
7096 is undesirable, or if you want to specify different limits for each data
7097 source, you can use the B<DataSource> option to have a threshold apply only to
7100 =item B<Invert> B<true>|B<false>
7102 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
7103 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
7104 B<WarningMax>) are not okay. Defaults to B<false>.
7106 =item B<Persist> B<true>|B<false>
7108 Sets how often notifications are generated. If set to B<true> one notification
7109 will be generated for each value that is out of the acceptable range. If set to
7110 B<false> (the default) then a notification is only generated if a value is out
7111 of range but the previous value was okay.
7113 This applies to missing values, too: If set to B<true> a notification about a
7114 missing value is generated once every B<Interval> seconds. If set to B<false>
7115 only one such notification is generated until the value appears again.
7117 =item B<Percentage> B<true>|B<false>
7119 If set to B<true>, the minimum and maximum values given are interpreted as
7120 percentage value, relative to the other data sources. This is helpful for
7121 example for the "df" type, where you may want to issue a warning when less than
7122 5E<nbsp>% of the total space is available. Defaults to B<false>.
7124 =item B<Hits> I<Number>
7126 Delay creating the notification until the threshold has been passed I<Number>
7127 times. When a notification has been generated, or when a subsequent value is
7128 inside the threshold, the counter is reset. If, for example, a value is
7129 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
7130 will be dispatched at most once every 30E<nbsp>seconds.
7132 This is useful when short bursts are not a problem. If, for example, 100% CPU
7133 usage for up to a minute is normal (and data is collected every
7134 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
7136 =item B<Hysteresis> I<Number>
7138 When set to non-zero, a hysteresis value is applied when checking minimum and
7139 maximum bounds. This is useful for values that increase slowly and fluctuate a
7140 bit while doing so. When these values come close to the threshold, they may
7141 "flap", i.e. switch between failure / warning case and okay case repeatedly.
7143 If, for example, the threshold is configures as
7148 then a I<Warning> notification is created when the value exceeds I<101> and the
7149 corresponding I<Okay> notification is only created once the value falls below
7150 I<99>, thus avoiding the "flapping".
7154 =head1 FILTER CONFIGURATION
7156 Starting with collectd 4.6 there is a powerful filtering infrastructure
7157 implemented in the daemon. The concept has mostly been copied from
7158 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
7159 terminology, so that users that are familiar with iptables feel right at home.
7163 The following are the terms used in the remainder of the filter configuration
7164 documentation. For an ASCII-art schema of the mechanism, see
7165 L<"General structure"> below.
7171 A I<match> is a criteria to select specific values. Examples are, of course, the
7172 name of the value or it's current value.
7174 Matches are implemented in plugins which you have to load prior to using the
7175 match. The name of such plugins starts with the "match_" prefix.
7179 A I<target> is some action that is to be performed with data. Such actions
7180 could, for example, be to change part of the value's identifier or to ignore
7181 the value completely.
7183 Some of these targets are built into the daemon, see L<"Built-in targets">
7184 below. Other targets are implemented in plugins which you have to load prior to
7185 using the target. The name of such plugins starts with the "target_" prefix.
7189 The combination of any number of matches and at least one target is called a
7190 I<rule>. The target actions will be performed for all values for which B<all>
7191 matches apply. If the rule does not have any matches associated with it, the
7192 target action will be performed for all values.
7196 A I<chain> is a list of rules and possibly default targets. The rules are tried
7197 in order and if one matches, the associated target will be called. If a value
7198 is handled by a rule, it depends on the target whether or not any subsequent
7199 rules are considered or if traversal of the chain is aborted, see
7200 L<"Flow control"> below. After all rules have been checked, the default targets
7205 =head2 General structure
7207 The following shows the resulting structure:
7214 +---------+ +---------+ +---------+ +---------+
7215 ! Rule !->! Match !->! Match !->! Target !
7216 +---------+ +---------+ +---------+ +---------+
7219 +---------+ +---------+ +---------+
7220 ! Rule !->! Target !->! Target !
7221 +---------+ +---------+ +---------+
7228 +---------+ +---------+ +---------+
7229 ! Rule !->! Match !->! Target !
7230 +---------+ +---------+ +---------+
7240 There are four ways to control which way a value takes through the filter
7247 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
7248 process the value with another chain. When the called chain finishes, usually
7249 the next target or rule after the jump is executed.
7253 The stop condition, signaled for example by the built-in target B<stop>, causes
7254 all processing of the value to be stopped immediately.
7258 Causes processing in the current chain to be aborted, but processing of the
7259 value generally will continue. This means that if the chain was called via
7260 B<Jump>, the next target or rule after the jump will be executed. If the chain
7261 was not called by another chain, control will be returned to the daemon and it
7262 may pass the value to another chain.
7266 Most targets will signal the B<continue> condition, meaning that processing
7267 should continue normally. There is no special built-in target for this
7274 The configuration reflects this structure directly:
7276 PostCacheChain "PostCache"
7278 <Rule "ignore_mysql_show">
7281 Type "^mysql_command$"
7282 TypeInstance "^show_"
7292 The above configuration example will ignore all values where the plugin field
7293 is "mysql", the type is "mysql_command" and the type instance begins with
7294 "show_". All other values will be sent to the C<rrdtool> write plugin via the
7295 default target of the chain. Since this chain is run after the value has been
7296 added to the cache, the MySQL C<show_*> command statistics will be available
7297 via the C<unixsock> plugin.
7299 =head2 List of configuration options
7303 =item B<PreCacheChain> I<ChainName>
7305 =item B<PostCacheChain> I<ChainName>
7307 Configure the name of the "pre-cache chain" and the "post-cache chain". The
7308 argument is the name of a I<chain> that should be executed before and/or after
7309 the values have been added to the cache.
7311 To understand the implications, it's important you know what is going on inside
7312 I<collectd>. The following diagram shows how values are passed from the
7313 read-plugins to the write-plugins:
7319 + - - - - V - - - - +
7320 : +---------------+ :
7323 : +-------+-------+ :
7326 : +-------+-------+ : +---------------+
7327 : ! Cache !--->! Value Cache !
7328 : ! insert ! : +---+---+-------+
7329 : +-------+-------+ : ! !
7330 : ! ,------------' !
7332 : +-------+---+---+ : +-------+-------+
7333 : ! Post-Cache +--->! Write-Plugins !
7334 : ! Chain ! : +---------------+
7335 : +---------------+ :
7338 + - - - - - - - - - +
7340 After the values are passed from the "read" plugins to the dispatch functions,
7341 the pre-cache chain is run first. The values are added to the internal cache
7342 afterwards. The post-cache chain is run after the values have been added to the
7343 cache. So why is it such a huge deal if chains are run before or after the
7344 values have been added to this cache?
7346 Targets that change the identifier of a value list should be executed before
7347 the values are added to the cache, so that the name in the cache matches the
7348 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
7349 this cache to receive a list of all available values. If you change the
7350 identifier after the value list has been added to the cache, this may easily
7351 lead to confusion, but it's not forbidden of course.
7353 The cache is also used to convert counter values to rates. These rates are, for
7354 example, used by the C<value> match (see below). If you use the rate stored in
7355 the cache B<before> the new value is added, you will use the old, B<previous>
7356 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
7357 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
7360 Last but not last, the B<stop> target makes a difference: If the pre-cache
7361 chain returns the stop condition, the value will not be added to the cache and
7362 the post-cache chain will not be run.
7364 =item B<Chain> I<Name>
7366 Adds a new chain with a certain name. This name can be used to refer to a
7367 specific chain, for example to jump to it.
7369 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
7371 =item B<Rule> [I<Name>]
7373 Adds a new rule to the current chain. The name of the rule is optional and
7374 currently has no meaning for the daemon.
7376 Within the B<Rule> block, there may be any number of B<Match> blocks and there
7377 must be at least one B<Target> block.
7379 =item B<Match> I<Name>
7381 Adds a match to a B<Rule> block. The name specifies what kind of match should
7382 be performed. Available matches depend on the plugins that have been loaded.
7384 The arguments inside the B<Match> block are passed to the plugin implementing
7385 the match, so which arguments are valid here depends on the plugin being used.
7386 If you do not need any to pass any arguments to a match, you can use the
7391 Which is equivalent to:
7396 =item B<Target> I<Name>
7398 Add a target to a rule or a default target to a chain. The name specifies what
7399 kind of target is to be added. Which targets are available depends on the
7400 plugins being loaded.
7402 The arguments inside the B<Target> block are passed to the plugin implementing
7403 the target, so which arguments are valid here depends on the plugin being used.
7404 If you do not need any to pass any arguments to a target, you can use the
7409 This is the same as writing:
7416 =head2 Built-in targets
7418 The following targets are built into the core daemon and therefore need no
7419 plugins to be loaded:
7425 Signals the "return" condition, see the L<"Flow control"> section above. This
7426 causes the current chain to stop processing the value and returns control to
7427 the calling chain. The calling chain will continue processing targets and rules
7428 just after the B<jump> target (see below). This is very similar to the
7429 B<RETURN> target of iptables, see L<iptables(8)>.
7431 This target does not have any options.
7439 Signals the "stop" condition, see the L<"Flow control"> section above. This
7440 causes processing of the value to be aborted immediately. This is similar to
7441 the B<DROP> target of iptables, see L<iptables(8)>.
7443 This target does not have any options.
7451 Sends the value to "write" plugins.
7457 =item B<Plugin> I<Name>
7459 Name of the write plugin to which the data should be sent. This option may be
7460 given multiple times to send the data to more than one write plugin. If the
7461 plugin supports multiple instances, the plugin's instance(s) must also be
7466 If no plugin is explicitly specified, the values will be sent to all available
7469 Single-instance plugin example:
7475 Multi-instance plugin example:
7477 <Plugin "write_graphite">
7487 Plugin "write_graphite/foo"
7492 Starts processing the rules of another chain, see L<"Flow control"> above. If
7493 the end of that chain is reached, or a stop condition is encountered,
7494 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
7495 next target or the next rule. This is similar to the B<-j> command line option
7496 of iptables, see L<iptables(8)>.
7502 =item B<Chain> I<Name>
7504 Jumps to the chain I<Name>. This argument is required and may appear only once.
7516 =head2 Available matches
7522 Matches a value using regular expressions.
7528 =item B<Host> I<Regex>
7530 =item B<Plugin> I<Regex>
7532 =item B<PluginInstance> I<Regex>
7534 =item B<Type> I<Regex>
7536 =item B<TypeInstance> I<Regex>
7538 Match values where the given regular expressions match the various fields of
7539 the identifier of a value. If multiple regular expressions are given, B<all>
7540 regexen must match for a value to match.
7542 =item B<Invert> B<false>|B<true>
7544 When set to B<true>, the result of the match is inverted, i.e. all value lists
7545 where all regular expressions apply are not matched, all other value lists are
7546 matched. Defaults to B<false>.
7553 Host "customer[0-9]+"
7559 Matches values that have a time which differs from the time on the server.
7561 This match is mainly intended for servers that receive values over the
7562 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
7563 is very sensitive to the timestamp used when updating the RRD files. In
7564 particular, the time must be ever increasing. If a misbehaving client sends one
7565 packet with a timestamp far in the future, all further packets with a correct
7566 time will be ignored because of that one packet. What's worse, such corrupted
7567 RRD files are hard to fix.
7569 This match lets one match all values B<outside> a specified time range
7570 (relative to the server's time), so you can use the B<stop> target (see below)
7571 to ignore the value, for example.
7577 =item B<Future> I<Seconds>
7579 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
7580 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7583 =item B<Past> I<Seconds>
7585 Matches all values that are I<behind> of the server's time by I<Seconds> or
7586 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7598 This example matches all values that are five minutes or more ahead of the
7599 server or one hour (or more) lagging behind.
7603 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
7604 values. If a data-set consists of more than one data-source, all data-sources
7605 must match the specified ranges for a positive match.
7611 =item B<Min> I<Value>
7613 Sets the smallest value which still results in a match. If unset, behaves like
7616 =item B<Max> I<Value>
7618 Sets the largest value which still results in a match. If unset, behaves like
7621 =item B<Invert> B<true>|B<false>
7623 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
7624 no-match is returned and vice versa. Please note that the B<Invert> setting
7625 only effects how B<Min> and B<Max> are applied to a specific value. Especially
7626 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
7628 =item B<DataSource> I<DSName> [I<DSName> ...]
7630 Select one or more of the data sources. If no data source is configured, all
7631 data sources will be checked. If the type handled by the match does not have a
7632 data source of the specified name(s), this will always result in no match
7633 (independent of the B<Invert> setting).
7635 =item B<Satisfy> B<Any>|B<All>
7637 Specifies how checking with several data sources is performed. If set to
7638 B<Any>, the match succeeds if one of the data sources is in the configured
7639 range. If set to B<All> the match only succeeds if all data sources are within
7640 the configured range. Default is B<All>.
7642 Usually B<All> is used for positive matches, B<Any> is used for negative
7643 matches. This means that with B<All> you usually check that all values are in a
7644 "good" range, while with B<Any> you check if any value is within a "bad" range
7645 (or outside the "good" range).
7649 Either B<Min> or B<Max>, but not both, may be unset.
7653 # Match all values smaller than or equal to 100. Matches only if all data
7654 # sources are below 100.
7660 # Match if the value of any data source is outside the range of 0 - 100.
7668 =item B<empty_counter>
7670 Matches all values with one or more data sources of type B<COUNTER> and where
7671 all counter values are zero. These counters usually I<never> increased since
7672 they started existing (and are therefore uninteresting), or got reset recently
7673 or overflowed and you had really, I<really> bad luck.
7675 Please keep in mind that ignoring such counters can result in confusing
7676 behavior: Counters which hardly ever increase will be zero for long periods of
7677 time. If the counter is reset for some reason (machine or service restarted,
7678 usually), the graph will be empty (NAN) for a long time. People may not
7683 Calculates a hash value of the host name and matches values according to that
7684 hash value. This makes it possible to divide all hosts into groups and match
7685 only values that are in a specific group. The intended use is in load
7686 balancing, where you want to handle only part of all data and leave the rest
7689 The hashing function used tries to distribute the hosts evenly. First, it
7690 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
7693 for (i = 0; host[i] != 0; i++)
7694 hash_value = (hash_value * 251) + host[i];
7696 The constant 251 is a prime number which is supposed to make this hash value
7697 more random. The code then checks the group for this host according to the
7698 I<Total> and I<Match> arguments:
7700 if ((hash_value % Total) == Match)
7705 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
7706 groups), then the least significant bit of the hash value will be the XOR of
7707 all least significant bits in the host name. One consequence is that when you
7708 have two hosts, "server0.example.com" and "server1.example.com", where the host
7709 name differs in one digit only and the digits differ by one, those hosts will
7710 never end up in the same group.
7716 =item B<Match> I<Match> I<Total>
7718 Divide the data into I<Total> groups and match all hosts in group I<Match> as
7719 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
7720 be smaller than I<Total>. I<Total> must be at least one, although only values
7721 greater than one really do make any sense.
7723 You can repeat this option to match multiple groups, for example:
7728 The above config will divide the data into seven groups and match groups three
7729 and five. One use would be to keep every value on two hosts so that if one
7730 fails the missing data can later be reconstructed from the second host.
7736 # Operate on the pre-cache chain, so that ignored values are not even in the
7741 # Divide all received hosts in seven groups and accept all hosts in
7745 # If matched: Return and continue.
7748 # If not matched: Return and stop.
7754 =head2 Available targets
7758 =item B<notification>
7760 Creates and dispatches a notification.
7766 =item B<Message> I<String>
7768 This required option sets the message of the notification. The following
7769 placeholders will be replaced by an appropriate value:
7777 =item B<%{plugin_instance}>
7781 =item B<%{type_instance}>
7783 These placeholders are replaced by the identifier field of the same name.
7785 =item B<%{ds:>I<name>B<}>
7787 These placeholders are replaced by a (hopefully) human readable representation
7788 of the current rate of this data source. If you changed the instance name
7789 (using the B<set> or B<replace> targets, see below), it may not be possible to
7790 convert counter values to rates.
7794 Please note that these placeholders are B<case sensitive>!
7796 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
7798 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
7805 <Target "notification">
7806 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
7812 Replaces parts of the identifier using regular expressions.
7818 =item B<Host> I<Regex> I<Replacement>
7820 =item B<Plugin> I<Regex> I<Replacement>
7822 =item B<PluginInstance> I<Regex> I<Replacement>
7824 =item B<TypeInstance> I<Regex> I<Replacement>
7826 Match the appropriate field with the given regular expression I<Regex>. If the
7827 regular expression matches, that part that matches is replaced with
7828 I<Replacement>. If multiple places of the input buffer match a given regular
7829 expression, only the first occurrence will be replaced.
7831 You can specify each option multiple times to use multiple regular expressions
7839 # Replace "example.net" with "example.com"
7840 Host "\\<example.net\\>" "example.com"
7842 # Strip "www." from hostnames
7848 Sets part of the identifier of a value to a given string.
7854 =item B<Host> I<String>
7856 =item B<Plugin> I<String>
7858 =item B<PluginInstance> I<String>
7860 =item B<TypeInstance> I<String>
7862 Set the appropriate field to the given string. The strings for plugin instance
7863 and type instance may be empty, the strings for host and plugin may not be
7864 empty. It's currently not possible to set the type of a value this way.
7871 PluginInstance "coretemp"
7872 TypeInstance "core3"
7877 =head2 Backwards compatibility
7879 If you use collectd with an old configuration, i.E<nbsp>e. one without a
7880 B<Chain> block, it will behave as it used to. This is equivalent to the
7881 following configuration:
7887 If you specify a B<PostCacheChain>, the B<write> target will not be added
7888 anywhere and you will have to make sure that it is called where appropriate. We
7889 suggest to add the above snippet as default target to your "PostCache" chain.
7893 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
7909 L<collectd-exec(5)>,
7910 L<collectd-perl(5)>,
7911 L<collectd-unixsock(5)>,
7924 Florian Forster E<lt>octo@collectd.orgE<gt>