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<CollectInternalStats> B<false>|B<true>
151 When set to B<true>, various statistics about the I<collectd> daemon will be
152 collected, with "collectd" as the I<plugin name>. Defaults to B<false>.
154 The "write_queue" I<plugin instance> reports the number of elements currently
155 queued and the number of elements dropped off the queue by the
156 B<WriteQueueLimitLow>/B<WriteQueueLimitHigh> mechanism.
158 The "cache" I<plugin instance> reports the number of elements in the value list
159 cache (the cache you can interact with using L<collectd-unixsock(5)>).
161 =item B<Include> I<Path> [I<pattern>]
163 If I<Path> points to a file, includes that file. If I<Path> points to a
164 directory, recursively includes all files within that directory and its
165 subdirectories. If the C<wordexp> function is available on your system,
166 shell-like wildcards are expanded before files are included. This means you can
167 use statements like the following:
169 Include "/etc/collectd.d/*.conf"
171 Starting with version 5.3, this may also be a block in which further options
172 affecting the behavior of B<Include> may be specified. The following option is
175 <Include "/etc/collectd.d">
181 =item B<Filter> I<pattern>
183 If the C<fnmatch> function is available on your system, a shell-like wildcard
184 I<pattern> may be specified to filter which files to include. This may be used
185 in combination with recursively including a directory to easily be able to
186 arbitrarily mix configuration files and other documents (e.g. README files).
187 The given example is similar to the first example above but includes all files
188 matching C<*.conf> in any subdirectory of C</etc/collectd.d>:
190 Include "/etc/collectd.d" "*.conf"
194 If more than one files are included by a single B<Include> option, the files
195 will be included in lexicographical order (as defined by the C<strcmp>
196 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
197 order in which the files are loaded.
199 To prevent loops and shooting yourself in the foot in interesting ways the
200 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
201 most uses. Since symlinks are followed it is still possible to crash the daemon
202 by looping symlinks. In our opinion significant stupidity should result in an
203 appropriate amount of pain.
205 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
206 file, but you cannot include files from within blocks.
208 =item B<PIDFile> I<File>
210 Sets where to write the PID file to. This file is overwritten when it exists
211 and deleted when the program is stopped. Some init-scripts might override this
212 setting using the B<-P> command-line option.
214 =item B<PluginDir> I<Directory>
216 Path to the plugins (shared objects) of collectd.
218 =item B<TypesDB> I<File> [I<File> ...]
220 Set one or more files that contain the data-set descriptions. See
221 L<types.db(5)> for a description of the format of this file.
223 =item B<Interval> I<Seconds>
225 Configures the interval in which to query the read plugins. Obviously smaller
226 values lead to a higher system load produced by collectd, while higher values
227 lead to more coarse statistics.
229 B<Warning:> You should set this once and then never touch it again. If you do,
230 I<you will have to delete all your RRD files> or know some serious RRDtool
231 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
233 =item B<MaxReadInterval> I<Seconds>
235 Read plugin doubles interval between queries after each failed attempt
238 This options limits the maximum value of the interval. The default value is
241 =item B<Timeout> I<Iterations>
243 Consider a value list "missing" when no update has been read or received for
244 I<Iterations> iterations. By default, I<collectd> considers a value list
245 missing when no update has been received for twice the update interval. Since
246 this setting uses iterations, the maximum allowed time without update depends
247 on the I<Interval> information contained in each value list. This is used in
248 the I<Threshold> configuration to dispatch notifications about missing values,
249 see L<collectd-threshold(5)> for details.
251 =item B<ReadThreads> I<Num>
253 Number of threads to start for reading plugins. The default value is B<5>, but
254 you may want to increase this if you have more than five plugins that take a
255 long time to read. Mostly those are plugins that do network-IO. Setting this to
256 a value higher than the number of registered read callbacks is not recommended.
258 =item B<WriteThreads> I<Num>
260 Number of threads to start for dispatching value lists to write plugins. The
261 default value is B<5>, but you may want to increase this if you have more than
262 five plugins that may take relatively long to write to.
264 =item B<WriteQueueLimitHigh> I<HighNum>
266 =item B<WriteQueueLimitLow> I<LowNum>
268 Metrics are read by the I<read threads> and then put into a queue to be handled
269 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
270 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
271 running into memory issues in such a case, you can limit the size of this
274 By default, there is no limit and memory may grow indefinitely. This is most
275 likely not an issue for clients, i.e. instances that only handle the local
276 metrics. For servers it is recommended to set this to a non-zero value, though.
278 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
279 Each of them takes a numerical argument which is the number of metrics in the
280 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
281 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
282 I<will> be enqueued. If the number of metrics currently in the queue is between
283 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
284 proportional to the number of metrics in the queue (i.e. it increases linearly
285 until it reaches 100%.)
287 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
288 unset, the latter will default to half of B<WriteQueueLimitHigh>.
290 If you do not want to randomly drop values when the queue size is between
291 I<LowNum> and I<HighNum>, set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>
294 Enabling the B<CollectInternalStats> option is of great help to figure out the
295 values to set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow> to.
297 =item B<Hostname> I<Name>
299 Sets the hostname that identifies a host. If you omit this setting, the
300 hostname will be determined using the L<gethostname(2)> system call.
302 =item B<FQDNLookup> B<true|false>
304 If B<Hostname> is determined automatically this setting controls whether or not
305 the daemon should try to figure out the "fully qualified domain name", FQDN.
306 This is done using a lookup of the name returned by C<gethostname>. This option
307 is enabled by default.
309 =item B<PreCacheChain> I<ChainName>
311 =item B<PostCacheChain> I<ChainName>
313 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
314 see L<FILTER CONFIGURATION> below on information on chains and how these
315 setting change the daemon's behavior.
319 =head1 PLUGIN OPTIONS
321 Some plugins may register own options. These options must be enclosed in a
322 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
323 require external configuration, too. The C<apache plugin>, for example,
324 required C<mod_status> to be configured in the webserver you're going to
325 collect data from. These plugins are listed below as well, even if they don't
326 require any configuration within collectd's configuration file.
328 A list of all plugins and a short summary for each plugin can be found in the
329 F<README> file shipped with the sourcecode and hopefully binary packets as
332 =head2 Plugin C<aggregation>
334 The I<Aggregation plugin> makes it possible to aggregate several values into
335 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
336 This can be put to a wide variety of uses, e.g. average and total CPU
337 statistics for your entire fleet.
339 The grouping is powerful but, as with many powerful tools, may be a bit
340 difficult to wrap your head around. The grouping will therefore be
341 demonstrated using an example: The average and sum of the CPU usage across
342 all CPUs of each host is to be calculated.
344 To select all the affected values for our example, set C<Plugin cpu> and
345 C<Type cpu>. The other values are left unspecified, meaning "all values". The
346 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
347 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
353 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...) and
354 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
355 example, the intention is to have a new value for each host / type instance
356 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
357 It can be specified multiple times to group by more than one field.
360 GroupBy "TypeInstance"
362 We do neither specify nor group by I<plugin instance> (the CPU number), so all
363 metrics that differ in the CPU number only will be aggregated. Each
364 aggregation needs I<at least one> such field, otherwise no aggregation would
367 The full example configuration looks like this:
369 <Plugin "aggregation">
375 GroupBy "TypeInstance"
378 CalculateAverage true
382 There are a couple of limitations you should be aware of:
388 The I<Type> cannot be left unspecified, because it is not reasonable to add
389 apples to oranges. Also, the internal lookup structure won't work if you try
394 There must be at least one unspecified, ungrouped field. Otherwise nothing
399 As you can see in the example above, each aggregation has its own
400 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
401 blocks may match the same values, i.e. one value list can update multiple
402 aggregations. The following options are valid inside B<Aggregation> blocks:
406 =item B<Host> I<Host>
408 =item B<Plugin> I<Plugin>
410 =item B<PluginInstance> I<PluginInstance>
412 =item B<Type> I<Type>
414 =item B<TypeInstance> I<TypeInstance>
416 Selects the value lists to be added to this aggregation. B<Type> must be a
417 valid data set name, see L<types.db(5)> for details.
419 If the string starts with and ends with a slash (C</>), the string is
420 interpreted as a I<regular expression>. The regex flavor used are POSIX
421 extended regular expressions as described in L<regex(7)>. Example usage:
423 Host "/^db[0-9]\\.example\\.com$/"
425 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
427 Group valued by the specified field. The B<GroupBy> option may be repeated to
428 group by multiple fields.
430 =item B<SetHost> I<Host>
432 =item B<SetPlugin> I<Plugin>
434 =item B<SetPluginInstance> I<PluginInstance>
436 =item B<SetTypeInstance> I<TypeInstance>
438 Sets the appropriate part of the identifier to the provided string.
440 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
441 will be replaced with the aggregation function, e.g. "average". Not including
442 the placeholder will result in duplication warnings and/or messed up values if
443 more than one aggregation function are enabled.
445 The following example calculates the average usage of all "even" CPUs:
447 <Plugin "aggregation">
450 PluginInstance "/[0,2,4,6,8]$/"
454 SetPluginInstance "even-%{aggregation}"
457 GroupBy "TypeInstance"
459 CalculateAverage true
463 This will create the files:
469 foo.example.com/cpu-even-average/cpu-idle
473 foo.example.com/cpu-even-average/cpu-system
477 foo.example.com/cpu-even-average/cpu-user
485 =item B<CalculateNum> B<true>|B<false>
487 =item B<CalculateSum> B<true>|B<false>
489 =item B<CalculateAverage> B<true>|B<false>
491 =item B<CalculateMinimum> B<true>|B<false>
493 =item B<CalculateMaximum> B<true>|B<false>
495 =item B<CalculateStddev> B<true>|B<false>
497 Boolean options for enabling calculation of the number of value lists, their
498 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
499 are disabled by default.
503 =head2 Plugin C<amqp>
505 The I<AMQMP plugin> can be used to communicate with other instances of
506 I<collectd> or third party applications using an AMQP message broker. Values
507 are sent to or received from the broker, which handles routing, queueing and
508 possibly filtering or messages.
511 # Send values to an AMQP broker
512 <Publish "some_name">
518 Exchange "amq.fanout"
519 # ExchangeType "fanout"
520 # RoutingKey "collectd"
524 # GraphitePrefix "collectd."
525 # GraphiteEscapeChar "_"
526 # GraphiteSeparateInstances false
527 # GraphiteAlwaysAppendDS false
530 # Receive values from an AMQP broker
531 <Subscribe "some_name">
537 Exchange "amq.fanout"
538 # ExchangeType "fanout"
541 # QueueAutoDelete true
542 # RoutingKey "collectd.#"
546 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
547 blocks, which configure sending and receiving of values respectively. The two
548 blocks are very similar, so unless otherwise noted, an option can be used in
549 either block. The name given in the blocks starting tag is only used for
550 reporting messages, but may be used to support I<flushing> of certain
551 I<Publish> blocks in the future.
555 =item B<Host> I<Host>
557 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
558 the underlying communications library, I<rabbitmq-c>, which is "localhost".
560 =item B<Port> I<Port>
562 Service name or port number on which the AMQP broker accepts connections. This
563 argument must be a string, even if the numeric form is used. Defaults to
566 =item B<VHost> I<VHost>
568 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
570 =item B<User> I<User>
572 =item B<Password> I<Password>
574 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
577 =item B<Exchange> I<Exchange>
579 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
580 By default, "amq.fanout" will be used.
582 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
583 the given exchange and the I<queue> is created, using the I<routing key> if
584 configured. See the B<Queue> and B<RoutingKey> options below.
586 =item B<ExchangeType> I<Type>
588 If given, the plugin will try to create the configured I<exchange> with this
589 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
590 be bound to this exchange.
592 =item B<Queue> I<Queue> (Subscribe only)
594 Configures the I<queue> name to subscribe to. If no queue name was configured
595 explicitly, a unique queue name will be created by the broker.
597 =item B<QueueDurable> B<true>|B<false> (Subscribe only)
599 Defines if the I<queue> subscribed to is durable (saved to persistent storage)
600 or transient (will disappear if the AMQP broker is restarted). Defaults to
603 This option should be used in conjunction with the I<Persistent> option on the
606 =item B<QueueAutoDelete> B<true>|B<false> (Subscribe only)
608 Defines if the I<queue> subscribed to will be deleted once the last consumer
609 unsubscribes. Defaults to "true".
611 =item B<RoutingKey> I<Key>
613 In I<Publish> blocks, this configures the routing key to set on all outgoing
614 messages. If not given, the routing key will be computed from the I<identifier>
615 of the value. The host, plugin, type and the two instances are concatenated
616 together using dots as the separator and all containing dots replaced with
617 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
618 possible to receive only specific values using a "topic" exchange.
620 In I<Subscribe> blocks, configures the I<routing key> used when creating a
621 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
622 used to filter messages when using a "topic" exchange. If you're only
623 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
626 =item B<Persistent> B<true>|B<false> (Publish only)
628 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
629 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
630 default), the I<transient> delivery mode will be used, i.e. messages may be
631 lost due to high load, overflowing queues or similar issues.
633 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
635 Selects the format in which messages are sent to the broker. If set to
636 B<Command> (the default), values are sent as C<PUTVAL> commands which are
637 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
638 case, the C<Content-Type> header field will be set to C<text/collectd>.
640 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
641 an easy and straight forward exchange format. The C<Content-Type> header field
642 will be set to C<application/json>.
644 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
645 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
648 A subscribing client I<should> use the C<Content-Type> header field to
649 determine how to decode the values. Currently, the I<AMQP plugin> itself can
650 only decode the B<Command> format.
652 =item B<StoreRates> B<true>|B<false> (Publish only)
654 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
655 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
656 default), no conversion is performed. Otherwise the conversion is performed
657 using the internal value cache.
659 Please note that currently this option is only used if the B<Format> option has
662 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
664 A prefix can be added in the metric name when outputting in the I<Graphite> format.
665 It's added before the I<Host> name.
666 Metric name will be "<prefix><host><postfix><plugin><type><name>"
668 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
670 A postfix can be added in the metric name when outputting in the I<Graphite> format.
671 It's added after the I<Host> name.
672 Metric name will be "<prefix><host><postfix><plugin><type><name>"
674 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
676 Specify a character to replace dots (.) in the host part of the metric name.
677 In I<Graphite> metric name, dots are used as separators between different
678 metric parts (host, plugin, type).
679 Default is "_" (I<Underscore>).
681 =item B<GraphiteSeparateInstances> B<true>|B<false>
683 If set to B<true>, the plugin instance and type instance will be in their own
684 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
685 default), the plugin and plugin instance (and likewise the type and type
686 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
688 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
690 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
691 identifier. If set to B<false> (the default), this is only done when there is
696 =head2 Plugin C<apache>
698 To configure the C<apache>-plugin you first need to configure the Apache
699 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
700 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
701 the following snipped to base your Apache config upon:
704 <IfModule mod_status.c>
705 <Location /mod_status>
706 SetHandler server-status
710 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
711 also supported. It introduces a new field, called C<BusyServers>, to count the
712 number of currently connected clients. This field is also supported.
714 The configuration of the I<Apache> plugin consists of one or more
715 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
716 as the instance name. For example:
720 URL "http://www1.example.com/mod_status?auto"
723 URL "http://www2.example.com/mod_status?auto"
727 The instance name will be used as the I<plugin instance>. To emulate the old
728 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
729 plugin to work correctly, each instance name must be unique. This is not
730 enforced by the plugin and it is your responsibility to ensure it.
732 The following options are accepted within each I<Instance> block:
736 =item B<URL> I<http://host/mod_status?auto>
738 Sets the URL of the C<mod_status> output. This needs to be the output generated
739 by C<ExtendedStatus on> and it needs to be the machine readable output
740 generated by appending the C<?auto> argument. This option is I<mandatory>.
742 =item B<User> I<Username>
744 Optional user name needed for authentication.
746 =item B<Password> I<Password>
748 Optional password needed for authentication.
750 =item B<VerifyPeer> B<true|false>
752 Enable or disable peer SSL certificate verification. See
753 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
755 =item B<VerifyHost> B<true|false>
757 Enable or disable peer host name verification. If enabled, the plugin checks
758 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
759 certificate matches the host name provided by the B<URL> option. If this
760 identity check fails, the connection is aborted. Obviously, only works when
761 connecting to a SSL enabled server. Enabled by default.
763 =item B<CACert> I<File>
765 File that holds one or more SSL certificates. If you want to use HTTPS you will
766 possibly need this option. What CA certificates come bundled with C<libcurl>
767 and are checked by default depends on the distribution you use.
771 =head2 Plugin C<apcups>
775 =item B<Host> I<Hostname>
777 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
778 that IPv6 support has been disabled unless someone can confirm or decline that
779 B<apcupsd> can handle it.
781 =item B<Port> I<Port>
783 TCP-Port to connect to. Defaults to B<3551>.
785 =item B<ReportSeconds> B<true|false>
787 If set to B<true>, the time reported in the C<timeleft> metric will be
788 converted to seconds. This is the recommended setting. If set to B<false>, the
789 default for backwards compatibility, the time will be reported in minutes.
793 =head2 Plugin C<aquaero>
795 This plugin collects the value of the available sensors in an
796 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
797 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
798 connection for monitoring and configuration. The board can handle multiple
799 temperature sensors, fans, water pumps and water level sensors and adjust the
800 output settings such as fan voltage or power used by the water pump based on
801 the available inputs using a configurable controller included in the board.
802 This plugin collects all the available inputs as well as some of the output
803 values chosen by this controller. The plugin is based on the I<libaquaero5>
804 library provided by I<aquatools-ng>.
808 =item B<Device> I<DevicePath>
810 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
811 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
812 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
816 =head2 Plugin C<ascent>
818 This plugin collects information about an Ascent server, a free server for the
819 "World of Warcraft" game. This plugin gathers the information by fetching the
820 XML status page using C<libcurl> and parses it using C<libxml2>.
822 The configuration options are the same as for the C<apache> plugin above:
826 =item B<URL> I<http://localhost/ascent/status/>
828 Sets the URL of the XML status output.
830 =item B<User> I<Username>
832 Optional user name needed for authentication.
834 =item B<Password> I<Password>
836 Optional password needed for authentication.
838 =item B<VerifyPeer> B<true|false>
840 Enable or disable peer SSL certificate verification. See
841 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
843 =item B<VerifyHost> B<true|false>
845 Enable or disable peer host name verification. If enabled, the plugin checks
846 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
847 certificate matches the host name provided by the B<URL> option. If this
848 identity check fails, the connection is aborted. Obviously, only works when
849 connecting to a SSL enabled server. Enabled by default.
851 =item B<CACert> I<File>
853 File that holds one or more SSL certificates. If you want to use HTTPS you will
854 possibly need this option. What CA certificates come bundled with C<libcurl>
855 and are checked by default depends on the distribution you use.
859 =head2 Plugin C<barometer>
861 This plugin reads absolute air pressure using digital barometer sensor MPL115A2
862 or MPL3115 from Freescale (sensor attached to any I2C bus available in
863 the computer, for HW details see
864 I<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A> or
865 I<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>).
866 The sensor type - one fo these two - is detected automatically by the plugin
867 and indicated in the plugin_instance (typically you will see subdirectory
868 "barometer-mpl115" or "barometer-mpl3115").
870 The plugin provides absolute barometric pressure, air pressure reduced to sea
871 level (several possible approximations) and as an auxiliary value also internal
872 sensor temperature. It uses (expects/provides) typical metric units - pressure
873 in [hPa], temperature in [C], altitude in [m].
875 It was developed and tested under Linux only. The only platform dependency is
876 the standard Linux i2c-dev interface (the particular bus driver has to
877 support the SM Bus command subset).
879 The reduction or normalization to mean sea level pressure requires (depedning on
880 selected method/approximation) also altitude and reference to temperature sensor(s).
881 When multiple temperature sensors are configured the minumum of their values is
882 always used (expecting that the warmer ones are affected by e.g. direct sun light
891 TemperatureOffset 0.0
894 TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
899 =item B<Device> I<device>
901 Device name of the I2C bus to which the sensor is connected. Note that typically
902 you need to have loaded the i2c-dev module.
903 Using i2c-tools you can check/list i2c buses available on your system by:
907 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
911 This way you should be able to verify that the pressure sensor (either type) is
912 connected and detected on address 0x60.
914 =item B<Oversampling> I<value>
916 For MPL115 this is the size of the averaging window. To filter out sensor noise
917 a simple averaging using floating window of configurable size is used. The plugin
918 will use average of the last C<value> measurements (value of 1 means no averaging).
919 Minimal size is 1, maximal 1024.
921 For MPL3115 this is the oversampling value. The actual oversampling is performed
922 by the sensor and the higher value the higher accuracy and longer conversion time
923 (although nothing to worry about in the collectd context). Supported values are:
924 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is adjusted by the plugin to
925 the closest supported one. Default is 128.
927 =item B<PressureOffset> I<offset>
929 You can further calibrate the sensor by supplying pressure and/or temperature offsets.
930 This is added to the measured/caclulated value (i.e. if the measured value is too high
931 then use negative offset).
932 In hPa, default is 0.0.
934 =item B<TemperatureOffset> I<offset>
936 You can further calibrate the sensor by supplying pressure and/or temperature offsets.
937 This is added to the measured/caclulated value (i.e. if the measured value is too high
938 then use negative offset).
939 In C, default is 0.0.
941 =item B<Normalization> I<method>
943 Normalization method - what approximation/model is used to compute mean sea
944 level pressure from the air absolute pressure.
946 Supported values of the C<method> (integer between from 0 to 2) are:
950 =item B<0> - no conversion, absolute pressrure is simply copied over. For this method you
951 do not need to configure C<Altitude> or C<TemperatureSensor>.
953 =item B<1> - international formula for conversion ,
954 See I<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
955 For this method you have to configure C<Altitude> but do not need C<TemperatureSensor>
956 (uses fixed global temperature average instead).
958 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
959 Meteorological Service).
960 See I<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
961 For this method you have to configure both C<Altitude> and C<TemperatureSensor>.
966 =item B<Altitude> I<altitude>
968 The altitude (in meters) of the location where you meassure the pressure.
970 =item B<TemperatureSensor> I<reference>
972 Temperature sensor which should be used as a reference when normalizing the pressure.
973 When specified more sensors a minumum is found and uses each time.
974 The temperature reading directly from this pressure sensor/plugin
975 is typically not suitable as the pressure sensor
976 will be probably inside while we want outside temperature.
977 The collectd reference name is something like
978 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
979 (<type_instance> is usually omitted when there is just single value type).
980 Or you can figure it out from the path of the output data files.
984 =head2 Plugin C<battery>
986 The I<battery plugin> reports the remaining capacity, power and voltage of
991 =item B<ValuesPercentage> B<false>|B<true>
993 When enabled, remaining capacity is reported as a percentage, e.g. "42%
994 capacity remaining". Otherwise the capacity is stored as reported by the
995 battery, most likely in "Wh". This option does not work with all input methods,
996 in particular when only C</proc/pmu> is available on an old Linux system.
997 Defaults to B<false>.
999 =item B<ReportDegraded> B<false>|B<true>
1001 Typical laptop batteries degrade over time, meaning the capacity decreases with
1002 recharge cycles. The maximum charge of the previous charge cycle is tracked as
1003 "last full capacity" and used to determine that a battery is "fully charged".
1005 When this option is set to B<false>, the default, the I<battery plugin> will
1006 only report the remaining capacity. If the B<ValuesPercentage> option is
1007 enabled, the relative remaining capacity is calculated as the ratio of the
1008 "remaining capacity" and the "last full capacity". This is what most tools,
1009 such as the status bar of desktop environments, also do.
1011 When set to B<true>, the battery plugin will report three values: B<charged>
1012 (remaining capacity), B<discharged> (difference between "last full capacity"
1013 and "remaining capacity") and B<degraded> (difference between "design capacity"
1014 and "last full capacity").
1018 =head2 Plugin C<bind>
1020 Starting with BIND 9.5.0, the most widely used DNS server software provides
1021 extensive statistics about queries, responses and lots of other information.
1022 The bind plugin retrieves this information that's encoded in XML and provided
1023 via HTTP and submits the values to collectd.
1025 To use this plugin, you first need to tell BIND to make this information
1026 available. This is done with the C<statistics-channels> configuration option:
1028 statistics-channels {
1029 inet localhost port 8053;
1032 The configuration follows the grouping that can be seen when looking at the
1033 data with an XSLT compatible viewer, such as a modern web browser. It's
1034 probably a good idea to make yourself familiar with the provided values, so you
1035 can understand what the collected statistics actually mean.
1040 URL "http://localhost:8053/"
1055 Zone "127.in-addr.arpa/IN"
1059 The bind plugin accepts the following configuration options:
1065 URL from which to retrieve the XML data. If not specified,
1066 C<http://localhost:8053/> will be used.
1068 =item B<ParseTime> B<true>|B<false>
1070 When set to B<true>, the time provided by BIND will be parsed and used to
1071 dispatch the values. When set to B<false>, the local time source is queried.
1073 This setting is set to B<true> by default for backwards compatibility; setting
1074 this to B<false> is I<recommended> to avoid problems with timezones and
1077 =item B<OpCodes> B<true>|B<false>
1079 When enabled, statistics about the I<"OpCodes">, for example the number of
1080 C<QUERY> packets, are collected.
1084 =item B<QTypes> B<true>|B<false>
1086 When enabled, the number of I<incoming> queries by query types (for example
1087 C<A>, C<MX>, C<AAAA>) is collected.
1091 =item B<ServerStats> B<true>|B<false>
1093 Collect global server statistics, such as requests received over IPv4 and IPv6,
1094 successful queries, and failed updates.
1098 =item B<ZoneMaintStats> B<true>|B<false>
1100 Collect zone maintenance statistics, mostly information about notifications
1101 (zone updates) and zone transfers.
1105 =item B<ResolverStats> B<true>|B<false>
1107 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1108 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1109 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1110 default. Use the B<ResolverStats> option within a B<View "_default"> block
1111 instead for the same functionality.
1115 =item B<MemoryStats>
1117 Collect global memory statistics.
1121 =item B<View> I<Name>
1123 Collect statistics about a specific I<"view">. BIND can behave different,
1124 mostly depending on the source IP-address of the request. These different
1125 configurations are called "views". If you don't use this feature, you most
1126 likely are only interested in the C<_default> view.
1128 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1129 information you want to collect about a view. If no B<View> block is
1130 configured, no detailed view statistics will be collected.
1134 =item B<QTypes> B<true>|B<false>
1136 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1137 C<MX>) is collected.
1141 =item B<ResolverStats> B<true>|B<false>
1143 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1144 (e.E<nbsp>g. queries over IPv4, lame servers).
1148 =item B<CacheRRSets> B<true>|B<false>
1150 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1151 type is collected. Negative entries (queries which resulted in an error, for
1152 example names that do not exist) are reported with a leading exclamation mark,
1157 =item B<Zone> I<Name>
1159 When given, collect detailed information about the given zone in the view. The
1160 information collected if very similar to the global B<ServerStats> information
1163 You can repeat this option to collect detailed information about multiple
1166 By default no detailed zone information is collected.
1172 =head2 Plugin C<cgroups>
1174 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1175 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1176 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1180 =item B<CGroup> I<Directory>
1182 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1183 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1186 =item B<IgnoreSelected> B<true>|B<false>
1188 Invert the selection: If set to true, all cgroups I<except> the ones that
1189 match any one of the criteria are collected. By default only selected
1190 cgroups are collected if a selection is made. If no selection is configured
1191 at all, B<all> cgroups are selected.
1195 =head2 Plugin C<conntrack>
1197 This plugin collects IP conntrack statistics.
1203 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1204 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1208 =head2 Plugin C<cpu>
1210 The I<CPU plugin> collects CPU usage metrics.
1212 The following configuration options are available:
1216 =item B<ReportActive> B<false>|B<true>
1218 Reports non-idle CPU usage as the "active" value. Defaults to false.
1220 =item B<ReportByCpu> B<false>|B<true>
1222 When true reports usage for all cores. When false, reports cpu usage
1223 aggregated over all cores.
1226 =item B<ValuesPercentage> B<false>|B<true>
1228 When true report percentage usage instead of tick values. Defaults to false.
1233 =head2 Plugin C<cpufreq>
1235 This plugin doesn't have any options. It reads
1236 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1237 installed) to get the current CPU frequency. If this file does not exist make
1238 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1239 installed and an "cpu governor" (that's a kernel module) is loaded.
1241 =head2 Plugin C<csv>
1245 =item B<DataDir> I<Directory>
1247 Set the directory to store CSV-files under. Per default CSV-files are generated
1248 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1249 The special strings B<stdout> and B<stderr> can be used to write to the standard
1250 output and standard error channels, respectively. This, of course, only makes
1251 much sense when collectd is running in foreground- or non-daemon-mode.
1253 =item B<StoreRates> B<true|false>
1255 If set to B<true>, convert counter values to rates. If set to B<false> (the
1256 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1261 =head2 Plugin C<curl>
1263 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1264 and the match infrastructure (the same code used by the tail plugin) to use
1265 regular expressions with the received data.
1267 The following example will read the current value of AMD stock from Google's
1268 finance page and dispatch the value to collectd.
1271 <Page "stock_quotes">
1272 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1278 CACert "/path/to/ca.crt"
1279 Header "X-Custom-Header: foobar"
1282 MeasureResponseTime false
1283 MeasureResponseCode false
1286 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1287 DSType "GaugeAverage"
1288 # Note: `stock_value' is not a standard type.
1295 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1296 a web page and one or more "matches" to be performed on the returned data. The
1297 string argument to the B<Page> block is used as plugin instance.
1299 The following options are valid within B<Page> blocks:
1305 URL of the web site to retrieve. Since a regular expression will be used to
1306 extract information from this data, non-binary data is a big plus here ;)
1308 =item B<User> I<Name>
1310 Username to use if authorization is required to read the page.
1312 =item B<Password> I<Password>
1314 Password to use if authorization is required to read the page.
1316 =item B<Digest> B<true>|B<false>
1318 Enable HTTP digest authentication.
1320 =item B<VerifyPeer> B<true>|B<false>
1322 Enable or disable peer SSL certificate verification. See
1323 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1325 =item B<VerifyHost> B<true>|B<false>
1327 Enable or disable peer host name verification. If enabled, the plugin checks if
1328 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1329 matches the host name provided by the B<URL> option. If this identity check
1330 fails, the connection is aborted. Obviously, only works when connecting to a
1331 SSL enabled server. Enabled by default.
1333 =item B<CACert> I<file>
1335 File that holds one or more SSL certificates. If you want to use HTTPS you will
1336 possibly need this option. What CA certificates come bundled with C<libcurl>
1337 and are checked by default depends on the distribution you use.
1339 =item B<Header> I<Header>
1341 A HTTP header to add to the request. Multiple headers are added if this option
1342 is specified more than once.
1344 =item B<Post> I<Body>
1346 Specifies that the HTTP operation should be a POST instead of a GET. The
1347 complete data to be posted is given as the argument. This option will usually
1348 need to be accompanied by a B<Header> option to set an appropriate
1349 C<Content-Type> for the post body (e.g. to
1350 C<application/x-www-form-urlencoded>).
1352 =item B<MeasureResponseTime> B<true>|B<false>
1354 Measure response time for the request. If this setting is enabled, B<Match>
1355 blocks (see below) are optional. Disabled by default.
1357 =item B<MeasureResponseCode> B<true>|B<false>
1359 Measure response code for the request. If this setting is enabled, B<Match>
1360 blocks (see below) are optional. Disabled by default.
1362 =item B<E<lt>MatchE<gt>>
1364 One or more B<Match> blocks that define how to match information in the data
1365 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1366 used by the C<tail> plugin, so please see the documentation of the C<tail>
1367 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1368 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1373 =head2 Plugin C<curl_json>
1375 The B<curl_json plugin> collects values from JSON data to be parsed by
1376 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) retrieved via
1377 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1378 unix socket. The former can be used, for example, to collect values
1379 from CouchDB documents (which are stored JSON notation), and the
1380 latter to collect values from a uWSGI stats socket.
1382 The following example will collect several values from the built-in
1383 C<_stats> runtime statistics module of I<CouchDB>
1384 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1387 <URL "http://localhost:5984/_stats">
1389 <Key "httpd/requests/count">
1390 Type "http_requests"
1393 <Key "httpd_request_methods/*/count">
1394 Type "http_request_methods"
1397 <Key "httpd_status_codes/*/count">
1398 Type "http_response_codes"
1403 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1406 <Sock "/var/run/uwsgi.stats.sock">
1408 <Key "workers/*/requests">
1409 Type "http_requests"
1412 <Key "workers/*/apps/*/requests">
1413 Type "http_requests"
1418 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1419 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1420 blocks defining a unix socket to read JSON from directly. Each of
1421 these blocks may have one or more B<Key> blocks.
1423 The B<Key> string argument must be in a path format. Each component is
1424 used to match the key from a JSON map or the index of an JSON
1425 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1426 values for all map keys or array indices will be collectd.
1428 The following options are valid within B<URL> blocks:
1432 =item B<Instance> I<Instance>
1434 Sets the plugin instance to I<Instance>.
1436 =item B<Interval> I<Interval>
1438 Sets the interval (in seconds) in which the values will be collected from this
1439 URL. By default the global B<Interval> setting will be used.
1441 =item B<User> I<Name>
1443 =item B<Password> I<Password>
1445 =item B<Digest> B<true>|B<false>
1447 =item B<VerifyPeer> B<true>|B<false>
1449 =item B<VerifyHost> B<true>|B<false>
1451 =item B<CACert> I<file>
1453 =item B<Header> I<Header>
1455 =item B<Post> I<Body>
1457 These options behave exactly equivalent to the appropriate options of the
1458 I<cURL> plugin. Please see there for a detailed description.
1462 The following options are valid within B<Key> blocks:
1466 =item B<Type> I<Type>
1468 Sets the type used to dispatch the values to the daemon. Detailed information
1469 about types and their configuration can be found in L<types.db(5)>. This
1470 option is mandatory.
1472 =item B<Instance> I<Instance>
1474 Type-instance to use. Defaults to the current map key or current string array element value.
1478 =head2 Plugin C<curl_xml>
1480 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1481 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1484 <URL "http://localhost/stats.xml">
1486 Instance "some_instance"
1491 CACert "/path/to/ca.crt"
1492 Header "X-Custom-Header: foobar"
1495 <XPath "table[@id=\"magic_level\"]/tr">
1497 #InstancePrefix "prefix-"
1498 InstanceFrom "td[1]"
1499 ValuesFrom "td[2]/span[@class=\"level\"]"
1504 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1505 URL to be fetched using libcurl. Within each B<URL> block there are
1506 options which specify the connection parameters, for example authentication
1507 information, and one or more B<XPath> blocks.
1509 Each B<XPath> block specifies how to get one type of information. The
1510 string argument must be a valid XPath expression which returns a list
1511 of "base elements". One value is dispatched for each "base element". The
1512 I<type instance> and values are looked up using further I<XPath> expressions
1513 that should be relative to the base element.
1515 Within the B<URL> block the following options are accepted:
1519 =item B<Host> I<Name>
1521 Use I<Name> as the host name when submitting values. Defaults to the global
1524 =item B<Instance> I<Instance>
1526 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1527 empty string (no plugin instance).
1529 =item B<Namespace> I<Prefix> I<URL>
1531 If an XPath expression references namespaces, they must be specified
1532 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1533 I<URL> is the "namespace name", an URI reference uniquely identifying the
1534 namespace. The option can be repeated to register multiple namespaces.
1538 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1539 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1541 =item B<User> I<User>
1543 =item B<Password> I<Password>
1545 =item B<Digest> B<true>|B<false>
1547 =item B<VerifyPeer> B<true>|B<false>
1549 =item B<VerifyHost> B<true>|B<false>
1551 =item B<CACert> I<CA Cert File>
1553 =item B<Header> I<Header>
1555 =item B<Post> I<Body>
1557 These options behave exactly equivalent to the appropriate options of the
1558 I<cURL plugin>. Please see there for a detailed description.
1560 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1562 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1563 B<XPath> block specifies how to get one type of information. The string
1564 argument must be a valid XPath expression which returns a list of "base
1565 elements". One value is dispatched for each "base element".
1567 Within the B<XPath> block the following options are accepted:
1571 =item B<Type> I<Type>
1573 Specifies the I<Type> used for submitting patches. This determines the number
1574 of values that are required / expected and whether the strings are parsed as
1575 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1576 This option is required.
1578 =item B<InstancePrefix> I<InstancePrefix>
1580 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1581 concatenated together without any separator.
1582 This option is optional.
1584 =item B<InstanceFrom> I<InstanceFrom>
1586 Specifies a XPath expression to use for determining the I<type instance>. The
1587 XPath expression must return exactly one element. The element's value is then
1588 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1590 This value is required. As a special exception, if the "base XPath expression"
1591 (the argument to the B<XPath> block) returns exactly one argument, then this
1592 option may be omitted.
1594 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1596 Specifies one or more XPath expression to use for reading the values. The
1597 number of XPath expressions must match the number of data sources in the
1598 I<type> specified with B<Type> (see above). Each XPath expression must return
1599 exactly one element. The element's value is then parsed as a number and used as
1600 value for the appropriate value in the value list dispatched to the daemon.
1606 =head2 Plugin C<dbi>
1608 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1609 connect to various databases, execute I<SQL> statements and read back the
1610 results. I<dbi> is an acronym for "database interface" in case you were
1611 wondering about the name. You can configure how each column is to be
1612 interpreted and the plugin will generate one or more data sets from each row
1613 returned according to these rules.
1615 Because the plugin is very generic, the configuration is a little more complex
1616 than those of other plugins. It usually looks something like this:
1619 <Query "out_of_stock">
1620 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1621 # Use with MySQL 5.0.0 or later
1625 InstancePrefix "out_of_stock"
1626 InstancesFrom "category"
1630 <Database "product_information">
1632 DriverOption "host" "localhost"
1633 DriverOption "username" "collectd"
1634 DriverOption "password" "aZo6daiw"
1635 DriverOption "dbname" "prod_info"
1636 SelectDB "prod_info"
1637 Query "out_of_stock"
1641 The configuration above defines one query with one result and one database. The
1642 query is then linked to the database with the B<Query> option I<within> the
1643 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1644 and you can also use the B<Include> statement to split up the configuration
1645 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1646 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1649 The following is a complete list of options:
1651 =head3 B<Query> blocks
1653 Query blocks define I<SQL> statements and how the returned data should be
1654 interpreted. They are identified by the name that is given in the opening line
1655 of the block. Thus the name needs to be unique. Other than that, the name is
1656 not used in collectd.
1658 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1659 define which column holds which value or instance information. You can use
1660 multiple B<Result> blocks to create multiple values from one returned row. This
1661 is especially useful, when queries take a long time and sending almost the same
1662 query again and again is not desirable.
1666 <Query "environment">
1667 Statement "select station, temperature, humidity from environment"
1670 # InstancePrefix "foo"
1671 InstancesFrom "station"
1672 ValuesFrom "temperature"
1676 InstancesFrom "station"
1677 ValuesFrom "humidity"
1681 The following options are accepted:
1685 =item B<Statement> I<SQL>
1687 Sets the statement that should be executed on the server. This is B<not>
1688 interpreted by collectd, but simply passed to the database server. Therefore,
1689 the SQL dialect that's used depends on the server collectd is connected to.
1691 The query has to return at least two columns, one for the instance and one
1692 value. You cannot omit the instance, even if the statement is guaranteed to
1693 always return exactly one line. In that case, you can usually specify something
1696 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1698 (That works with MySQL but may not be valid SQL according to the spec. If you
1699 use a more strict database server, you may have to select from a dummy table or
1702 Please note that some databases, for example B<Oracle>, will fail if you
1703 include a semicolon at the end of the statement.
1705 =item B<MinVersion> I<Version>
1707 =item B<MaxVersion> I<Value>
1709 Only use this query for the specified database version. You can use these
1710 options to provide multiple queries with the same name but with a slightly
1711 different syntax. The plugin will use only those queries, where the specified
1712 minimum and maximum versions fit the version of the database in use.
1714 The database version is determined by C<dbi_conn_get_engine_version>, see the
1715 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1716 for details. Basically, each part of the version is assumed to be in the range
1717 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1718 "40102", version "5.0.42" becomes "50042".
1720 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1721 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1722 happen. Don't to it! A valid example would be something along these lines:
1733 In the above example, there are three ranges that don't overlap. The last one
1734 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1735 before "4.0.0" are not specified.
1737 =item B<Type> I<Type>
1739 The B<type> that's used for each line returned. See L<types.db(5)> for more
1740 details on how types are defined. In short: A type is a predefined layout of
1741 data and the number of values and type of values has to match the type
1744 If you specify "temperature" here, you need exactly one gauge column. If you
1745 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1748 There must be exactly one B<Type> option inside each B<Result> block.
1750 =item B<InstancePrefix> I<prefix>
1752 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1753 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1754 all strings returned in the appropriate columns are concatenated together,
1755 separated by dashes I<("-")>.
1757 =item B<InstancesFrom> I<column0> [I<column1> ...]
1759 Specifies the columns whose values will be used to create the "type-instance"
1760 for each row. If you specify more than one column, the value of all columns
1761 will be joined together with dashes I<("-")> as separation characters.
1763 The plugin itself does not check whether or not all built instances are
1764 different. It's your responsibility to assure that each is unique. This is
1765 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1766 sure that only one row is returned in this case.
1768 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1771 =item B<ValuesFrom> I<column0> [I<column1> ...]
1773 Names the columns whose content is used as the actual data for the data sets
1774 that are dispatched to the daemon. How many such columns you need is determined
1775 by the B<Type> setting above. If you specify too many or not enough columns,
1776 the plugin will complain about that and no data will be submitted to the
1779 The actual data type in the columns is not that important. The plugin will
1780 automatically cast the values to the right type if it know how to do that. So
1781 it should be able to handle integer an floating point types, as well as strings
1782 (if they include a number at the beginning).
1784 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1786 =item B<MetadataFrom> [I<column0> I<column1> ...]
1788 Names the columns whose content is used as metadata for the data sets
1789 that are dispatched to the daemon.
1791 The actual data type in the columns is not that important. The plugin will
1792 automatically cast the values to the right type if it know how to do that. So
1793 it should be able to handle integer an floating point types, as well as strings
1794 (if they include a number at the beginning).
1798 =head3 B<Database> blocks
1800 Database blocks define a connection to a database and which queries should be
1801 sent to that database. Since the used "dbi" library can handle a wide variety
1802 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1803 documentationE<nbsp>- we stick as close to the terminology used there.
1805 Each database needs a "name" as string argument in the starting tag of the
1806 block. This name will be used as "PluginInstance" in the values submitted to
1807 the daemon. Other than that, that name is not used.
1811 =item B<Driver> I<Driver>
1813 Specifies the driver to use to connect to the database. In many cases those
1814 drivers are named after the database they can connect to, but this is not a
1815 technical necessity. These drivers are sometimes referred to as "DBD",
1816 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1817 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1818 project at L<http://libdbi-drivers.sourceforge.net/>.
1820 You need to give the driver name as expected by the "dbi" library here. You
1821 should be able to find that in the documentation for each driver. If you
1822 mistype the driver name, the plugin will dump a list of all known driver names
1825 =item B<DriverOption> I<Key> I<Value>
1827 Sets driver-specific options. What option a driver supports can be found in the
1828 documentation for each driver, somewhere at
1829 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1830 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1832 DBDs can register two types of options: String options and numeric options. The
1833 plugin will use the C<dbi_conn_set_option> function when the configuration
1834 provides a string and the C<dbi_conn_require_option_numeric> function when the
1835 configuration provides a number. So these two lines will actually result in
1836 different calls being used:
1838 DriverOption "Port" 1234 # numeric
1839 DriverOption "Port" "1234" # string
1841 Unfortunately, drivers are not too keen to report errors when an unknown option
1842 is passed to them, so invalid settings here may go unnoticed. This is not the
1843 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1844 the driver. If a driver complains about an option, the plugin will dump a
1845 complete list of all options understood by that driver to the log. There is no
1846 way to programatically find out if an option expects a string or a numeric
1847 argument, so you will have to refer to the appropriate DBD's documentation to
1848 find this out. Sorry.
1850 =item B<SelectDB> I<Database>
1852 In some cases, the database name you connect with is not the database name you
1853 want to use for querying data. If this option is set, the plugin will "select"
1854 (switch to) that database after the connection is established.
1856 =item B<Query> I<QueryName>
1858 Associates the query named I<QueryName> with this database connection. The
1859 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1860 blocks you want to refer to must be placed above the database block you want to
1863 =item B<Host> I<Hostname>
1865 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
1866 values. Defaults to the global hostname setting.
1874 =item B<Device> I<Device>
1876 Select partitions based on the devicename.
1878 =item B<MountPoint> I<Directory>
1880 Select partitions based on the mountpoint.
1882 =item B<FSType> I<FSType>
1884 Select partitions based on the filesystem type.
1886 =item B<IgnoreSelected> B<true>|B<false>
1888 Invert the selection: If set to true, all partitions B<except> the ones that
1889 match any one of the criteria are collected. By default only selected
1890 partitions are collected if a selection is made. If no selection is configured
1891 at all, B<all> partitions are selected.
1893 =item B<ReportByDevice> B<true>|B<false>
1895 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1896 (the default), it will report a disk as "root", but with it I<true>, it will be
1897 "sda1" (or whichever).
1899 =item B<ReportInodes> B<true>|B<false>
1901 Enables or disables reporting of free, reserved and used inodes. Defaults to
1902 inode collection being disabled.
1904 Enable this option if inodes are a scarce resource for you, usually because
1905 many small files are stored on the disk. This is a usual scenario for mail
1906 transfer agents and web caches.
1908 =item B<ValuesAbsolute> B<true>|B<false>
1910 Enables or disables reporting of free and used disk space in 1K-blocks.
1911 Defaults to B<true>.
1913 =item B<ValuesPercentage> B<false>|B<true>
1915 Enables or disables reporting of free and used disk space in percentage.
1916 Defaults to B<false>.
1918 This is useful for deploying I<collectd> on the cloud, where machines with
1919 different disk size may exist. Then it is more practical to configure
1920 thresholds based on relative disk size.
1924 =head2 Plugin C<disk>
1926 The C<disk> plugin collects information about the usage of physical disks and
1927 logical disks (partitions). Values collected are the number of octets written
1928 to and read from a disk or partition, the number of read/write operations
1929 issued to the disk and a rather complex "time" it took for these commands to be
1932 Using the following two options you can ignore some disks or configure the
1933 collection only of specific disks.
1937 =item B<Disk> I<Name>
1939 Select the disk I<Name>. Whether it is collected or ignored depends on the
1940 B<IgnoreSelected> setting, see below. As with other plugins that use the
1941 daemon's ignorelist functionality, a string that starts and ends with a slash
1942 is interpreted as a regular expression. Examples:
1947 =item B<IgnoreSelected> B<true>|B<false>
1949 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1950 statements, are ignored or if all other disks are ignored. The behavior
1951 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1952 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1953 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1954 is set to B<true>, all disks are collected B<except> the ones matched.
1956 =item B<UseBSDName> B<true>|B<false>
1958 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
1959 default major/minor numbers. Requires collectd to be built with Apple's
1962 =item B<UdevNameAttr> I<Attribute>
1964 Attempt to override disk instance name with the value of a specified udev
1965 attribute when built with B<libudev>. If the attribute is not defined for the
1966 given device, the default name is used. Example:
1968 UdevNameAttr "DM_NAME"
1972 =head2 Plugin C<dns>
1976 =item B<Interface> I<Interface>
1978 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1979 option sets the interface that should be used. If this option is not set, or
1980 set to "any", the plugin will try to get packets from B<all> interfaces. This
1981 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1983 =item B<IgnoreSource> I<IP-address>
1985 Ignore packets that originate from this address.
1987 =item B<SelectNumericQueryTypes> B<true>|B<false>
1989 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1993 =head2 Plugin C<email>
1997 =item B<SocketFile> I<Path>
1999 Sets the socket-file which is to be created.
2001 =item B<SocketGroup> I<Group>
2003 If running as root change the group of the UNIX-socket after it has been
2004 created. Defaults to B<collectd>.
2006 =item B<SocketPerms> I<Permissions>
2008 Change the file permissions of the UNIX-socket after it has been created. The
2009 permissions must be given as a numeric, octal value as you would pass to
2010 L<chmod(1)>. Defaults to B<0770>.
2012 =item B<MaxConns> I<Number>
2014 Sets the maximum number of connections that can be handled in parallel. Since
2015 this many threads will be started immediately setting this to a very high
2016 value will waste valuable resources. Defaults to B<5> and will be forced to be
2017 at most B<16384> to prevent typos and dumb mistakes.
2021 =head2 Plugin C<ethstat>
2023 The I<ethstat plugin> collects information about network interface cards (NICs)
2024 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2030 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2031 Map "multicast" "if_multicast"
2038 =item B<Interface> I<Name>
2040 Collect statistical information about interface I<Name>.
2042 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2044 By default, the plugin will submit values as type C<derive> and I<type
2045 instance> set to I<Name>, the name of the metric as reported by the driver. If
2046 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2047 I<TypeInstance> will be used.
2049 =item B<MappedOnly> B<true>|B<false>
2051 When set to B<true>, only metrics that can be mapped to to a I<type> will be
2052 collected, all other metrics will be ignored. Defaults to B<false>.
2056 =head2 Plugin C<exec>
2058 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2059 contains valuable information on when the executable is executed and the
2060 output that is expected from it.
2064 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2066 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2068 Execute the executable I<Executable> as user I<User>. If the user name is
2069 followed by a colon and a group name, the effective group is set to that group.
2070 The real group and saved-set group will be set to the default group of that
2071 user. If no group is given the effective group ID will be the same as the real
2074 Please note that in order to change the user and/or group the daemon needs
2075 superuser privileges. If the daemon is run as an unprivileged user you must
2076 specify the same user/group here. If the daemon is run with superuser
2077 privileges, you must supply a non-root user here.
2079 The executable may be followed by optional arguments that are passed to the
2080 program. Please note that due to the configuration parsing numbers and boolean
2081 values may be changed. If you want to be absolutely sure that something is
2082 passed as-is please enclose it in quotes.
2084 The B<Exec> and B<NotificationExec> statements change the semantics of the
2085 programs executed, i.E<nbsp>e. the data passed to them and the response
2086 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2090 =head2 Plugin C<filecount>
2092 The C<filecount> plugin counts the number of files in a certain directory (and
2093 its subdirectories) and their combined size. The configuration is very straight
2096 <Plugin "filecount">
2097 <Directory "/var/qmail/queue/mess">
2098 Instance "qmail-message"
2100 <Directory "/var/qmail/queue/todo">
2101 Instance "qmail-todo"
2103 <Directory "/var/lib/php5">
2104 Instance "php5-sessions"
2109 The example above counts the number of files in QMail's queue directories and
2110 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2111 QMail has not yet looked at, the "message" queue holds the messages that were
2112 classified into "local" and "remote".
2114 As you can see, the configuration consists of one or more C<Directory> blocks,
2115 each of which specifies a directory in which to count the files. Within those
2116 blocks, the following options are recognized:
2120 =item B<Instance> I<Instance>
2122 Sets the plugin instance to I<Instance>. That instance name must be unique, but
2123 it's your responsibility, the plugin doesn't check for that. If not given, the
2124 instance is set to the directory name with all slashes replaced by underscores
2125 and all leading underscores removed.
2127 =item B<Name> I<Pattern>
2129 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2130 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2131 against the pattern, not the entire path. In case this makes it easier for you:
2132 This option has been named after the B<-name> parameter to L<find(1)>.
2134 =item B<MTime> I<Age>
2136 Count only files of a specific age: If I<Age> is greater than zero, only files
2137 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2138 a negative number, this is inversed. For example, if B<-60> is specified, only
2139 files that have been modified in the last minute will be counted.
2141 The number can also be followed by a "multiplier" to easily specify a larger
2142 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2143 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2144 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2145 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2146 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2149 =item B<Size> I<Size>
2151 Count only files of a specific size. When I<Size> is a positive number, only
2152 files that are at least this big are counted. If I<Size> is a negative number,
2153 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2154 I<Size> are counted.
2156 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2157 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2158 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2159 note that there are 1000 bytes in a kilobyte, not 1024.
2161 =item B<Recursive> I<true>|I<false>
2163 Controls whether or not to recurse into subdirectories. Enabled by default.
2165 =item B<IncludeHidden> I<true>|I<false>
2167 Controls whether or not to include "hidden" files and directories in the count.
2168 "Hidden" files and directories are those, whose name begins with a dot.
2169 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2173 =head2 Plugin C<GenericJMX>
2175 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2176 L<collectd-java(5)>.
2178 =head2 Plugin C<gmond>
2180 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2181 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2182 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2187 MCReceiveFrom "239.2.11.71" "8649"
2188 <Metric "swap_total">
2190 TypeInstance "total"
2193 <Metric "swap_free">
2200 The following metrics are built-in:
2206 load_one, load_five, load_fifteen
2210 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2214 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2226 Available configuration options:
2230 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2232 Sets sets the multicast group and UDP port to which to subscribe.
2234 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2236 =item E<lt>B<Metric> I<Name>E<gt>
2238 These blocks add a new metric conversion to the internal table. I<Name>, the
2239 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2243 =item B<Type> I<Type>
2245 Type to map this metric to. Required.
2247 =item B<TypeInstance> I<Instance>
2249 Type-instance to use. Optional.
2251 =item B<DataSource> I<Name>
2253 Data source to map this metric to. If the configured type has exactly one data
2254 source, this is optional. Otherwise the option is required.
2260 =head2 Plugin C<hddtemp>
2262 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
2263 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
2264 default values, see below. C<hddtemp> has to be running to work correctly. If
2265 C<hddtemp> is not running timeouts may appear which may interfere with other
2268 The B<hddtemp> homepage can be found at
2269 L<http://www.guzu.net/linux/hddtemp.php>.
2273 =item B<Host> I<Hostname>
2275 Hostname to connect to. Defaults to B<127.0.0.1>.
2277 =item B<Port> I<Port>
2279 TCP-Port to connect to. Defaults to B<7634>.
2283 =head2 Plugin C<interface>
2287 =item B<Interface> I<Interface>
2289 Select this interface. By default these interfaces will then be collected. For
2290 a more detailed description see B<IgnoreSelected> below.
2292 =item B<IgnoreSelected> I<true>|I<false>
2294 If no configuration if given, the B<traffic>-plugin will collect data from
2295 all interfaces. This may not be practical, especially for loopback- and
2296 similar interfaces. Thus, you can use the B<Interface>-option to pick the
2297 interfaces you're interested in. Sometimes, however, it's easier/preferred
2298 to collect all interfaces I<except> a few ones. This option enables you to
2299 do that: By setting B<IgnoreSelected> to I<true> the effect of
2300 B<Interface> is inverted: All selected interfaces are ignored and all
2301 other interfaces are collected.
2305 =head2 Plugin C<ipmi>
2309 =item B<Sensor> I<Sensor>
2311 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2313 =item B<IgnoreSelected> I<true>|I<false>
2315 If no configuration if given, the B<ipmi> plugin will collect data from all
2316 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2317 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2318 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2319 all other sensors are collected.
2321 =item B<NotifySensorAdd> I<true>|I<false>
2323 If a sensor appears after initialization time of a minute a notification
2326 =item B<NotifySensorRemove> I<true>|I<false>
2328 If a sensor disappears a notification is sent.
2330 =item B<NotifySensorNotPresent> I<true>|I<false>
2332 If you have for example dual power supply and one of them is (un)plugged then
2333 a notification is sent.
2337 =head2 Plugin C<iptables>
2341 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2343 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
2344 will collect the counters of all rules which have a comment-match. The comment
2345 is then used as type-instance.
2347 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2348 the I<n>th rule will be collected. Again, the comment (or the number) will be
2349 used as the type-instance.
2351 If I<Name> is supplied, it will be used as the type-instance instead of the
2352 comment or the number.
2356 =head2 Plugin C<irq>
2362 Select this irq. By default these irqs will then be collected. For a more
2363 detailed description see B<IgnoreSelected> below.
2365 =item B<IgnoreSelected> I<true>|I<false>
2367 If no configuration if given, the B<irq>-plugin will collect data from all
2368 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2369 can use the B<Irq>-option to pick the interrupt you're interested in.
2370 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2371 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2372 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2373 and all other interrupts are collected.
2377 =head2 Plugin C<java>
2379 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2380 This section only discusses the syntax and semantic of the configuration
2381 options. For more in-depth information on the I<Java> plugin, please read
2382 L<collectd-java(5)>.
2387 JVMArg "-verbose:jni"
2388 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2389 LoadPlugin "org.collectd.java.Foobar"
2390 <Plugin "org.collectd.java.Foobar">
2391 # To be parsed by the plugin
2395 Available configuration options:
2399 =item B<JVMArg> I<Argument>
2401 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2402 exactly the way the arguments to the I<java> binary on the command line work.
2403 Execute C<javaE<nbsp>--help> for details.
2405 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2406 any other options! When another option is found, the JVM will be started and
2407 later options will have to be ignored!
2409 =item B<LoadPlugin> I<JavaClass>
2411 Instantiates a new I<JavaClass> object. The constructor of this object very
2412 likely then registers one or more callback methods with the server.
2414 See L<collectd-java(5)> for details.
2416 When the first such option is found, the virtual machine (JVM) is created. This
2417 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2418 B<LoadPlugin> options!
2420 =item B<Plugin> I<Name>
2422 The entire block is passed to the Java plugin as an
2423 I<org.collectd.api.OConfigItem> object.
2425 For this to work, the plugin has to register a configuration callback first,
2426 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2427 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2428 depends on the (Java) plugin registering the callback and is completely
2429 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2433 =head2 Plugin C<load>
2435 The I<Load plugin> collects the system load. These numbers give a rough overview
2436 over the utilization of a machine. The system load is defined as the number of
2437 runnable tasks in the run-queue and is provided by many operating systems as a
2438 one, five or fifteen minute average.
2440 The following configuration options are available:
2444 =item B<ReportRelative> B<false>|B<true>
2446 When enabled, system load divided by number of available CPU cores is reported
2447 for intervals 1 min, 5 min and 15 min. Defaults to false.
2452 =head2 Plugin C<logfile>
2456 =item B<LogLevel> B<debug|info|notice|warning|err>
2458 Sets the log-level. If, for example, set to B<notice>, then all events with
2459 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2461 Please note that B<debug> is only available if collectd has been compiled with
2464 =item B<File> I<File>
2466 Sets the file to write log messages to. The special strings B<stdout> and
2467 B<stderr> can be used to write to the standard output and standard error
2468 channels, respectively. This, of course, only makes much sense when I<collectd>
2469 is running in foreground- or non-daemon-mode.
2471 =item B<Timestamp> B<true>|B<false>
2473 Prefix all lines printed by the current time. Defaults to B<true>.
2475 =item B<PrintSeverity> B<true>|B<false>
2477 When enabled, all lines are prefixed by the severity of the log message, for
2478 example "warning". Defaults to B<false>.
2482 B<Note>: There is no need to notify the daemon after moving or removing the
2483 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2484 for each line it writes.
2486 =head2 Plugin C<log_logstash>
2488 The I<log logstash plugin> behaves like the logfile plugin but formats
2489 messages as JSON events for logstash to parse and input.
2493 =item B<LogLevel> B<debug|info|notice|warning|err>
2495 Sets the log-level. If, for example, set to B<notice>, then all events with
2496 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2498 Please note that B<debug> is only available if collectd has been compiled with
2501 =item B<File> I<File>
2503 Sets the file to write log messages to. The special strings B<stdout> and
2504 B<stderr> can be used to write to the standard output and standard error
2505 channels, respectively. This, of course, only makes much sense when I<collectd>
2506 is running in foreground- or non-daemon-mode.
2510 B<Note>: There is no need to notify the daemon after moving or removing the
2511 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2512 for each line it writes.
2514 =head2 Plugin C<lpar>
2516 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2517 virtualization technique for IBM POWER processors. It takes into account CPU
2518 time stolen from or donated to a partition, in addition to the usual user,
2519 system, I/O statistics.
2521 The following configuration options are available:
2525 =item B<CpuPoolStats> B<false>|B<true>
2527 When enabled, statistics about the processor pool are read, too. The partition
2528 needs to have pool authority in order to be able to acquire this information.
2531 =item B<ReportBySerial> B<false>|B<true>
2533 If enabled, the serial of the physical machine the partition is currently
2534 running on is reported as I<hostname> and the logical hostname of the machine
2535 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2536 used (just like other plugins) and the I<plugin instance> will be empty.
2541 =head2 Plugin C<mbmon>
2543 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2545 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2546 B<Host> and B<Port> options can be used to change these values, see below.
2547 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2548 timeouts may appear which may interfere with other statistics..
2550 C<mbmon> must be run with the -r option ("print TAG and Value format");
2551 Debian's F</etc/init.d/mbmon> script already does this, other people
2552 will need to ensure that this is the case.
2556 =item B<Host> I<Hostname>
2558 Hostname to connect to. Defaults to B<127.0.0.1>.
2560 =item B<Port> I<Port>
2562 TCP-Port to connect to. Defaults to B<411>.
2568 The C<md plugin> collects information from Linux Software-RAID devices (md).
2570 All reported values are of the type C<md_disks>. Reported type instances are
2571 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2572 I<missing> (physically absent) disks.
2576 =item B<Device> I<Device>
2578 Select md devices based on device name. The I<device name> is the basename of
2579 the device, i.e. the name of the block device without the leading C</dev/>.
2580 See B<IgnoreSelected> for more details.
2582 =item B<IgnoreSelected> B<true>|B<false>
2584 Invert device selection: If set to B<true>, all md devices B<except> those
2585 listed using B<Device> are collected. If B<false> (the default), only those
2586 listed are collected. If no configuration is given, the B<md> plugin will
2587 collect data from all md devices.
2591 =head2 Plugin C<memcachec>
2593 The C<memcachec plugin> connects to a memcached server, queries one or more
2594 given I<pages> and parses the returned data according to user specification.
2595 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2598 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2599 library. Please note that there is another library with a very similar name,
2600 libmemcache (notice the missing `d'), which is not applicable.
2602 Synopsis of the configuration:
2604 <Plugin "memcachec">
2605 <Page "plugin_instance">
2609 Regex "(\\d+) bytes sent"
2612 Instance "type_instance"
2617 The configuration options are:
2621 =item E<lt>B<Page> I<Name>E<gt>
2623 Each B<Page> block defines one I<page> to be queried from the memcached server.
2624 The block requires one string argument which is used as I<plugin instance>.
2626 =item B<Server> I<Address>
2628 Sets the server address to connect to when querying the page. Must be inside a
2633 When connected to the memcached server, asks for the page I<Key>.
2635 =item E<lt>B<Match>E<gt>
2637 Match blocks define which strings to look for and how matches substrings are
2638 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2642 =head2 Plugin C<memcached>
2644 The B<memcached plugin> connects to a memcached server and queries statistics
2645 about cache utilization, memory and bandwidth used.
2646 L<http://www.danga.com/memcached/>
2648 <Plugin "memcached">
2650 Host "memcache.example.com"
2655 The plugin configuration consists of one or more B<Instance> blocks which
2656 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2657 following options are allowed:
2661 =item B<Host> I<Hostname>
2663 Hostname to connect to. Defaults to B<127.0.0.1>.
2665 =item B<Port> I<Port>
2667 TCP-Port to connect to. Defaults to B<11211>.
2669 =item B<Socket> I<Path>
2671 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2672 setting is given, the B<Host> and B<Port> settings are ignored.
2676 =head2 Plugin C<mic>
2678 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2679 Intel's Many Integrated Core (MIC) systems.
2688 ShowTemperatures true
2691 IgnoreSelectedTemperature true
2696 IgnoreSelectedPower true
2699 The following options are valid inside the B<PluginE<nbsp>mic> block:
2703 =item B<ShowCPU> B<true>|B<false>
2705 If enabled (the default) a sum of the CPU usage across all cores is reported.
2707 =item B<ShowCPUCores> B<true>|B<false>
2709 If enabled (the default) per-core CPU usage is reported.
2711 =item B<ShowMemory> B<true>|B<false>
2713 If enabled (the default) the physical memory usage of the MIC system is
2716 =item B<ShowTemperatures> B<true>|B<false>
2718 If enabled (the default) various temperatures of the MIC system are reported.
2720 =item B<Temperature> I<Name>
2722 This option controls which temperatures are being reported. Whether matching
2723 temperatures are being ignored or I<only> matching temperatures are reported
2724 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2725 temperatures are reported.
2727 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2729 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2730 (the default) only temperatures matching a B<Temperature> option are reported
2731 or, if no B<Temperature> option is specified, all temperatures are reported. If
2732 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2735 Known temperature names are:
2769 =item B<ShowPower> B<true>|B<false>
2771 If enabled (the default) various temperatures of the MIC system are reported.
2773 =item B<Power> I<Name>
2775 This option controls which power readings are being reported. Whether matching
2776 power readings are being ignored or I<only> matching power readings are reported
2777 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
2778 power readings are reported.
2780 =item B<IgnoreSelectedPower> B<false>|B<true>
2782 Controls the behavior of the B<Power> setting above. If set to B<false>
2783 (the default) only power readings matching a B<Power> option are reported
2784 or, if no B<Power> option is specified, all power readings are reported. If
2785 set to B<true>, matching power readings are I<ignored> and all other power readings
2788 Known power names are:
2794 Total power utilization averaged over Time Window 0 (uWatts).
2798 Total power utilization averaged over Time Window 0 (uWatts).
2802 Instantaneous power (uWatts).
2806 Max instantaneous power (uWatts).
2810 PCI-E connector power (uWatts).
2814 2x3 connector power (uWatts).
2818 2x4 connector power (uWatts).
2826 Uncore rail (uVolts).
2830 Memory subsystem rail (uVolts).
2836 =head2 Plugin C<memory>
2838 The I<memory plugin> provides the following configuration options:
2842 =item B<ValuesAbsolute> B<true>|B<false>
2844 Enables or disables reporting of physical memory usage in absolute numbers,
2845 i.e. bytes. Defaults to B<true>.
2847 =item B<ValuesPercentage> B<false>|B<true>
2849 Enables or disables reporting of physical memory usage in percentages, e.g.
2850 percent of physical memory used. Defaults to B<false>.
2852 This is useful for deploying I<collectd> in a heterogeneous environment in
2853 which the sizes of physical memory vary.
2857 =head2 Plugin C<modbus>
2859 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
2860 register values. It supports reading single registers (unsigned 16E<nbsp>bit
2861 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2862 values (two registers interpreted as IEEE floats in big endian notation).
2866 <Data "voltage-input-1">
2873 <Data "voltage-input-2">
2880 <Host "modbus.example.com">
2881 Address "192.168.0.42"
2886 Instance "power-supply"
2887 Collect "voltage-input-1"
2888 Collect "voltage-input-2"
2894 =item E<lt>B<Data> I<Name>E<gt> blocks
2896 Data blocks define a mapping between register numbers and the "types" used by
2899 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
2903 =item B<RegisterBase> I<Number>
2905 Configures the base register to read from the device. If the option
2906 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
2907 register will be read (the register number is increased by one).
2909 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
2911 Specifies what kind of data is returned by the device. If the type is B<Int32>,
2912 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
2913 combined into one value. Defaults to B<Uint16>.
2915 =item B<Type> I<Type>
2917 Specifies the "type" (data set) to use when dispatching the value to
2918 I<collectd>. Currently, only data sets with exactly one data source are
2921 =item B<Instance> I<Instance>
2923 Sets the type instance to use when dispatching the value to I<collectd>. If
2924 unset, an empty string (no type instance) is used.
2928 =item E<lt>B<Host> I<Name>E<gt> blocks
2930 Host blocks are used to specify to which hosts to connect and what data to read
2931 from their "slaves". The string argument I<Name> is used as hostname when
2932 dispatching the values to I<collectd>.
2934 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
2938 =item B<Address> I<Hostname>
2940 Specifies the node name (the actual network address) used to connect to the
2941 host. This may be an IP address or a hostname. Please note that the used
2942 I<libmodbus> library only supports IPv4 at the moment.
2944 =item B<Port> I<Service>
2946 Specifies the port used to connect to the host. The port can either be given as
2947 a number or as a service name. Please note that the I<Service> argument must be
2948 a string, even if ports are given in their numerical form. Defaults to "502".
2950 =item B<Interval> I<Interval>
2952 Sets the interval (in seconds) in which the values will be collected from this
2953 host. By default the global B<Interval> setting will be used.
2955 =item E<lt>B<Slave> I<ID>E<gt>
2957 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
2958 is used to specify which device should be addressed. For each device you want
2959 to query, one B<Slave> block must be given.
2961 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
2965 =item B<Instance> I<Instance>
2967 Specify the plugin instance to use when dispatching the values to I<collectd>.
2968 By default "slave_I<ID>" is used.
2970 =item B<Collect> I<DataName>
2972 Specifies which data to retrieve from the device. I<DataName> must be the same
2973 string as the I<Name> argument passed to a B<Data> block. You can specify this
2974 option multiple times to collect more than one value from a slave. At least one
2975 B<Collect> option is mandatory.
2983 =head2 Plugin C<mysql>
2985 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
2986 one or more databases when started and keeps the connection up as long as
2987 possible. When the connection is interrupted for whatever reason it will try
2988 to re-connect. The plugin will complain loudly in case anything goes wrong.
2990 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
2991 and collects information about MySQL network traffic, executed statements,
2992 requests, the query cache and threads by evaluating the
2993 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
2994 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
2995 Status Variables> for an explanation of these values.
2997 Optionally, master and slave statistics may be collected in a MySQL
2998 replication setup. In that case, information about the synchronization state
2999 of the nodes are collected by evaluating the C<Position> return value of the
3000 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
3001 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
3002 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
3003 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
3004 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
3021 Socket "/var/run/mysql/mysqld.sock"
3023 SlaveNotifications true
3027 A B<Database> block defines one connection to a MySQL database. It accepts a
3028 single argument which specifies the name of the database. None of the other
3029 options are required. MySQL will use default values as documented in the
3030 section "mysql_real_connect()" in the B<MySQL reference manual>.
3034 =item B<Alias> I<Alias>
3036 Alias to use as sender instead of hostname when reporting. This may be useful
3037 when having cryptic hostnames.
3039 =item B<Host> I<Hostname>
3041 Hostname of the database server. Defaults to B<localhost>.
3043 =item B<User> I<Username>
3045 Username to use when connecting to the database. The user does not have to be
3046 granted any privileges (which is synonym to granting the C<USAGE> privilege),
3047 unless you want to collectd replication statistics (see B<MasterStats> and
3048 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
3049 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
3051 =item B<Password> I<Password>
3053 Password needed to log into the database.
3055 =item B<Database> I<Database>
3057 Select this database. Defaults to I<no database> which is a perfectly reasonable
3058 option for what this plugin does.
3060 =item B<Port> I<Port>
3062 TCP-port to connect to. The port must be specified in its numeric form, but it
3063 must be passed as a string nonetheless. For example:
3067 If B<Host> is set to B<localhost> (the default), this setting has no effect.
3068 See the documentation for the C<mysql_real_connect> function for details.
3070 =item B<Socket> I<Socket>
3072 Specifies the path to the UNIX domain socket of the MySQL server. This option
3073 only has any effect, if B<Host> is set to B<localhost> (the default).
3074 Otherwise, use the B<Port> option above. See the documentation for the
3075 C<mysql_real_connect> function for details.
3077 =item B<InnodbStats> I<true|false>
3079 If enabled, metrics about the InnoDB storage engine are collected.
3080 Disabled by default.
3082 =item B<MasterStats> I<true|false>
3084 =item B<SlaveStats> I<true|false>
3086 Enable the collection of master / slave statistics in a replication setup. In
3087 order to be able to get access to these statistics, the user needs special
3088 privileges. See the B<User> documentation above.
3090 =item B<SlaveNotifications> I<true|false>
3092 If enabled, the plugin sends a notification if the replication slave I/O and /
3093 or SQL threads are not running.
3095 =item B<ConnectTimeout> I<Seconds>
3097 Sets the connect timeout for the MySQL client.
3101 =head2 Plugin C<netapp>
3103 The netapp plugin can collect various performance and capacity information
3104 from a NetApp filer using the NetApp API.
3106 Please note that NetApp has a wide line of products and a lot of different
3107 software versions for each of these products. This plugin was developed for a
3108 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
3109 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
3110 model and software version but it is very hard to test this.
3111 If you have used this plugin with other models and/or software version, feel
3112 free to send us a mail to tell us about the results, even if it's just a short
3115 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
3116 basic authentication.
3118 B<Do not use a regular user for this!> Create a special collectd user with just
3119 the minimum of capabilities needed. The user only needs the "login-http-admin"
3120 capability as well as a few more depending on which data will be collected.
3121 Required capabilities are documented below.
3126 <Host "netapp1.example.com">
3150 IgnoreSelectedIO false
3152 IgnoreSelectedOps false
3153 GetLatency "volume0"
3154 IgnoreSelectedLatency false
3161 IgnoreSelectedCapacity false
3164 IgnoreSelectedSnapshot false
3192 The netapp plugin accepts the following configuration options:
3196 =item B<Host> I<Name>
3198 A host block defines one NetApp filer. It will appear in collectd with the name
3199 you specify here which does not have to be its real name nor its hostname (see
3200 the B<Address> option below).
3202 =item B<VFiler> I<Name>
3204 A B<VFiler> block may only be used inside a host block. It accepts all the
3205 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
3206 will execute all NetApp API commands in the context of the specified
3207 VFiler(R). It will appear in collectd with the name you specify here which
3208 does not have to be its real name. The VFiler name may be specified using the
3209 B<VFilerName> option. If this is not specified, it will default to the name
3212 The VFiler block inherits all connection related settings from the surrounding
3213 B<Host> block (which appear before the B<VFiler> block) but they may be
3214 overwritten inside the B<VFiler> block.
3216 This feature is useful, for example, when using a VFiler as SnapVault target
3217 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
3218 available in the host filer (vfiler0) but only in the respective VFiler
3221 =item B<Protocol> B<httpd>|B<http>
3223 The protocol collectd will use to query this host.
3231 Valid options: http, https
3233 =item B<Address> I<Address>
3235 The hostname or IP address of the host.
3241 Default: The "host" block's name.
3243 =item B<Port> I<Port>
3245 The TCP port to connect to on the host.
3251 Default: 80 for protocol "http", 443 for protocol "https"
3253 =item B<User> I<User>
3255 =item B<Password> I<Password>
3257 The username and password to use to login to the NetApp.
3263 =item B<VFilerName> I<Name>
3265 The name of the VFiler in which context to execute API commands. If not
3266 specified, the name provided to the B<VFiler> block will be used instead.
3272 Default: name of the B<VFiler> block
3274 B<Note:> This option may only be used inside B<VFiler> blocks.
3276 =item B<Interval> I<Interval>
3282 The following options decide what kind of data will be collected. You can
3283 either use them as a block and fine tune various parameters inside this block,
3284 use them as a single statement to just accept all default values, or omit it to
3285 not collect any data.
3287 The following options are valid inside all blocks:
3291 =item B<Interval> I<Seconds>
3293 Collect the respective statistics every I<Seconds> seconds. Defaults to the
3294 host specific setting.
3298 =head3 The System block
3300 This will collect various performance data about the whole system.
3302 B<Note:> To get this data the collectd user needs the
3303 "api-perf-object-get-instances" capability.
3307 =item B<Interval> I<Seconds>
3309 Collect disk statistics every I<Seconds> seconds.
3311 =item B<GetCPULoad> B<true>|B<false>
3313 If you set this option to true the current CPU usage will be read. This will be
3314 the average usage between all CPUs in your NetApp without any information about
3317 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3318 returns in the "CPU" field.
3326 Result: Two value lists of type "cpu", and type instances "idle" and "system".
3328 =item B<GetInterfaces> B<true>|B<false>
3330 If you set this option to true the current traffic of the network interfaces
3331 will be read. This will be the total traffic over all interfaces of your NetApp
3332 without any information about individual interfaces.
3334 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3335 in the "Net kB/s" field.
3345 Result: One value list of type "if_octects".
3347 =item B<GetDiskIO> B<true>|B<false>
3349 If you set this option to true the current IO throughput will be read. This
3350 will be the total IO of your NetApp without any information about individual
3351 disks, volumes or aggregates.
3353 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3354 in the "DiskE<nbsp>kB/s" field.
3362 Result: One value list of type "disk_octets".
3364 =item B<GetDiskOps> B<true>|B<false>
3366 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
3367 iSCSI, etc. operations will be read. This will be the total number of
3368 operations on your NetApp without any information about individual volumes or
3371 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3372 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
3380 Result: A variable number of value lists of type "disk_ops_complex". Each type
3381 of operation will result in one value list with the name of the operation as
3386 =head3 The WAFL block
3388 This will collect various performance data about the WAFL file system. At the
3389 moment this just means cache performance.
3391 B<Note:> To get this data the collectd user needs the
3392 "api-perf-object-get-instances" capability.
3394 B<Note:> The interface to get these values is classified as "Diagnostics" by
3395 NetApp. This means that it is not guaranteed to be stable even between minor
3400 =item B<Interval> I<Seconds>
3402 Collect disk statistics every I<Seconds> seconds.
3404 =item B<GetNameCache> B<true>|B<false>
3412 Result: One value list of type "cache_ratio" and type instance
3415 =item B<GetDirCache> B<true>|B<false>
3423 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3425 =item B<GetInodeCache> B<true>|B<false>
3433 Result: One value list of type "cache_ratio" and type instance
3436 =item B<GetBufferCache> B<true>|B<false>
3438 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3439 in the "Cache hit" field.
3447 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3451 =head3 The Disks block
3453 This will collect performance data about the individual disks in the NetApp.
3455 B<Note:> To get this data the collectd user needs the
3456 "api-perf-object-get-instances" capability.
3460 =item B<Interval> I<Seconds>
3462 Collect disk statistics every I<Seconds> seconds.
3464 =item B<GetBusy> B<true>|B<false>
3466 If you set this option to true the busy time of all disks will be calculated
3467 and the value of the busiest disk in the system will be written.
3469 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3470 in the "Disk util" field. Probably.
3478 Result: One value list of type "percent" and type instance "disk_busy".
3482 =head3 The VolumePerf block
3484 This will collect various performance data about the individual volumes.
3486 You can select which data to collect about which volume using the following
3487 options. They follow the standard ignorelist semantic.
3489 B<Note:> To get this data the collectd user needs the
3490 I<api-perf-object-get-instances> capability.
3494 =item B<Interval> I<Seconds>
3496 Collect volume performance data every I<Seconds> seconds.
3498 =item B<GetIO> I<Volume>
3500 =item B<GetOps> I<Volume>
3502 =item B<GetLatency> I<Volume>
3504 Select the given volume for IO, operations or latency statistics collection.
3505 The argument is the name of the volume without the C</vol/> prefix.
3507 Since the standard ignorelist functionality is used here, you can use a string
3508 starting and ending with a slash to specify regular expression matching: To
3509 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3512 GetIO "/^vol[027]$/"
3514 If no regular expression is specified, an exact match is required. Both,
3515 regular and exact matching are case sensitive.
3517 If no volume was specified at all for either of the three options, that data
3518 will be collected for all available volumes.
3520 =item B<IgnoreSelectedIO> B<true>|B<false>
3522 =item B<IgnoreSelectedOps> B<true>|B<false>
3524 =item B<IgnoreSelectedLatency> B<true>|B<false>
3526 When set to B<true>, the volumes selected for IO, operations or latency
3527 statistics collection will be ignored and the data will be collected for all
3530 When set to B<false>, data will only be collected for the specified volumes and
3531 all other volumes will be ignored.
3533 If no volumes have been specified with the above B<Get*> options, all volumes
3534 will be collected regardless of the B<IgnoreSelected*> option.
3536 Defaults to B<false>
3540 =head3 The VolumeUsage block
3542 This will collect capacity data about the individual volumes.
3544 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3549 =item B<Interval> I<Seconds>
3551 Collect volume usage statistics every I<Seconds> seconds.
3553 =item B<GetCapacity> I<VolumeName>
3555 The current capacity of the volume will be collected. This will result in two
3556 to four value lists, depending on the configuration of the volume. All data
3557 sources are of type "df_complex" with the name of the volume as
3560 There will be type_instances "used" and "free" for the number of used and
3561 available bytes on the volume. If the volume has some space reserved for
3562 snapshots, a type_instance "snap_reserved" will be available. If the volume
3563 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3564 number of bytes saved by the SIS feature.
3566 B<Note:> The current NetApp API has a bug that results in this value being
3567 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3568 number which works most of the time. If you see strange values here, bug
3569 NetApp support to fix this.
3571 Repeat this option to specify multiple volumes.
3573 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3575 Specify whether to collect only the volumes selected by the B<GetCapacity>
3576 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3577 B<false>. However, if no B<GetCapacity> option is specified at all, all
3578 capacities will be selected anyway.
3580 =item B<GetSnapshot> I<VolumeName>
3582 Select volumes from which to collect snapshot information.
3584 Usually, the space used for snapshots is included in the space reported as
3585 "used". If snapshot information is collected as well, the space used for
3586 snapshots is subtracted from the used space.
3588 To make things even more interesting, it is possible to reserve space to be
3589 used for snapshots. If the space required for snapshots is less than that
3590 reserved space, there is "reserved free" and "reserved used" space in addition
3591 to "free" and "used". If the space required for snapshots exceeds the reserved
3592 space, that part allocated in the normal space is subtracted from the "used"
3595 Repeat this option to specify multiple volumes.
3597 =item B<IgnoreSelectedSnapshot>
3599 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3600 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3601 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3602 capacities will be selected anyway.
3606 =head3 The Quota block
3608 This will collect (tree) quota statistics (used disk space and number of used
3609 files). This mechanism is useful to get usage information for single qtrees.
3610 In case the quotas are not used for any other purpose, an entry similar to the
3611 following in C</etc/quotas> would be sufficient:
3613 /vol/volA/some_qtree tree - - - - -
3615 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3619 =item B<Interval> I<Seconds>
3621 Collect SnapVault(R) statistics every I<Seconds> seconds.
3625 =head3 The SnapVault block
3627 This will collect statistics about the time and traffic of SnapVault(R)
3632 =item B<Interval> I<Seconds>
3634 Collect SnapVault(R) statistics every I<Seconds> seconds.
3638 =head2 Plugin C<netlink>
3640 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3641 statistics of various interface and routing aspects.
3645 =item B<Interface> I<Interface>
3647 =item B<VerboseInterface> I<Interface>
3649 Instruct the plugin to collect interface statistics. This is basically the same
3650 as the statistics provided by the C<interface> plugin (see above) but
3651 potentially much more detailed.
3653 When configuring with B<Interface> only the basic statistics will be collected,
3654 namely octets, packets, and errors. These statistics are collected by
3655 the C<interface> plugin, too, so using both at the same time is no benefit.
3657 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3658 so that no data needs to be collected twice if you use the C<interface> plugin.
3659 This includes dropped packets, received multicast packets, collisions and a
3660 whole zoo of differentiated RX and TX errors. You can try the following command
3661 to get an idea of what awaits you:
3665 If I<Interface> is B<All>, all interfaces will be selected.
3667 =item B<QDisc> I<Interface> [I<QDisc>]
3669 =item B<Class> I<Interface> [I<Class>]
3671 =item B<Filter> I<Interface> [I<Filter>]
3673 Collect the octets and packets that pass a certain qdisc, class or filter.
3675 QDiscs and classes are identified by their type and handle (or classid).
3676 Filters don't necessarily have a handle, therefore the parent's handle is used.
3677 The notation used in collectd differs from that used in tc(1) in that it
3678 doesn't skip the major or minor number if it's zero and doesn't print special
3679 ids by their name. So, for example, a qdisc may be identified by
3680 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3681 thus not displayed by tc(1).
3683 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3684 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3685 associated with that interface will be collected.
3687 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3688 used. This may lead to problems when more than one filter is attached to a
3689 qdisc or class. This isn't nice, but we don't know how this could be done any
3690 better. If you have a idea, please don't hesitate to tell us.
3692 As with the B<Interface> option you can specify B<All> as the interface,
3693 meaning all interfaces.
3695 Here are some examples to help you understand the above text more easily:
3698 VerboseInterface "All"
3699 QDisc "eth0" "pfifo_fast-1:0"
3701 Class "ppp0" "htb-1:10"
3702 Filter "ppp0" "u32-1:0"
3705 =item B<IgnoreSelected>
3707 The behavior is the same as with all other similar plugins: If nothing is
3708 selected at all, everything is collected. If some things are selected using the
3709 options described above, only these statistics are collected. If you set
3710 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3711 specified statistics will not be collected.
3715 =head2 Plugin C<network>
3717 The Network plugin sends data to a remote instance of collectd, receives data
3718 from a remote instance, or both at the same time. Data which has been received
3719 from the network is usually not transmitted again, but this can be activated, see
3720 the B<Forward> option below.
3722 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3723 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3725 Both, B<Server> and B<Listen> can be used as single option or as block. When
3726 used as block, given options are valid for this socket only. The following
3727 example will export the metrics twice: Once to an "internal" server (without
3728 encryption and signing) and one to an external server (with cryptographic
3732 # Export to an internal server
3733 # (demonstrates usage without additional options)
3734 Server "collectd.internal.tld"
3736 # Export to an external server
3737 # (demonstrates usage with signature options)
3738 <Server "collectd.external.tld">
3739 SecurityLevel "sign"
3740 Username "myhostname"
3747 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3749 The B<Server> statement/block sets the server to send datagrams to. The
3750 statement may occur multiple times to send each datagram to multiple
3753 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3754 optional second argument specifies a port number or a service name. If not
3755 given, the default, B<25826>, is used.
3757 The following options are recognized within B<Server> blocks:
3761 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3763 Set the security you require for network communication. When the security level
3764 has been set to B<Encrypt>, data sent over the network will be encrypted using
3765 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3766 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3767 authentication code. When set to B<None>, data is sent without any security.
3769 This feature is only available if the I<network> plugin was linked with
3772 =item B<Username> I<Username>
3774 Sets the username to transmit. This is used by the server to lookup the
3775 password. See B<AuthFile> below. All security levels except B<None> require
3778 This feature is only available if the I<network> plugin was linked with
3781 =item B<Password> I<Password>
3783 Sets a password (shared secret) for this socket. All security levels except
3784 B<None> require this setting.
3786 This feature is only available if the I<network> plugin was linked with
3789 =item B<Interface> I<Interface name>
3791 Set the outgoing interface for IP packets. This applies at least
3792 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3793 undefined or a non-existent interface name is specified, the default
3794 behavior is to let the kernel choose the appropriate interface. Be warned
3795 that the manual selection of an interface for unicast traffic is only
3796 necessary in rare cases.
3798 =item B<ResolveInterval> I<Seconds>
3800 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
3801 useful to force a regular DNS lookup to support a high availability setup. If
3802 not specified, re-resolves are never attempted.
3806 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
3808 The B<Listen> statement sets the interfaces to bind to. When multiple
3809 statements are found the daemon will bind to multiple interfaces.
3811 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
3812 the argument is a multicast address the daemon will join that multicast group.
3813 The optional second argument specifies a port number or a service name. If not
3814 given, the default, B<25826>, is used.
3816 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
3820 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3822 Set the security you require for network communication. When the security level
3823 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
3824 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
3825 signed and encrypted data is accepted. When set to B<None>, all data will be
3826 accepted. If an B<AuthFile> option was given (see below), encrypted data is
3827 decrypted if possible.
3829 This feature is only available if the I<network> plugin was linked with
3832 =item B<AuthFile> I<Filename>
3834 Sets a file in which usernames are mapped to passwords. These passwords are
3835 used to verify signatures and to decrypt encrypted network packets. If
3836 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
3837 verified and encrypted packets are decrypted. Otherwise, signed data is
3838 accepted without checking the signature and encrypted data cannot be decrypted.
3839 For the other security levels this option is mandatory.
3841 The file format is very simple: Each line consists of a username followed by a
3842 colon and any number of spaces followed by the password. To demonstrate, an
3843 example file could look like this:
3848 Each time a packet is received, the modification time of the file is checked
3849 using L<stat(2)>. If the file has been changed, the contents is re-read. While
3850 the file is being read, it is locked using L<fcntl(2)>.
3852 =item B<Interface> I<Interface name>
3854 Set the incoming interface for IP packets explicitly. This applies at least
3855 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3856 undefined or a non-existent interface name is specified, the default
3857 behavior is, to let the kernel choose the appropriate interface. Thus incoming
3858 traffic gets only accepted, if it arrives on the given interface.
3862 =item B<TimeToLive> I<1-255>
3864 Set the time-to-live of sent packets. This applies to all, unicast and
3865 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
3866 That means that multicast packets will be sent with a TTL of C<1> (one) on most
3869 =item B<MaxPacketSize> I<1024-65535>
3871 Set the maximum size for datagrams received over the network. Packets larger
3872 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
3873 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
3876 On the server side, this limit should be set to the largest value used on
3877 I<any> client. Likewise, the value on the client must not be larger than the
3878 value on the server, or data will be lost.
3880 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
3881 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
3882 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
3885 =item B<Forward> I<true|false>
3887 If set to I<true>, write packets that were received via the network plugin to
3888 the sending sockets. This should only be activated when the B<Listen>- and
3889 B<Server>-statements differ. Otherwise packets may be send multiple times to
3890 the same multicast group. While this results in more network traffic than
3891 necessary it's not a huge problem since the plugin has a duplicate detection,
3892 so the values will not loop.
3894 =item B<ReportStats> B<true>|B<false>
3896 The network plugin cannot only receive and send statistics, it can also create
3897 statistics about itself. Collected data included the number of received and
3898 sent octets and packets, the length of the receive queue and the number of
3899 values handled. When set to B<true>, the I<Network plugin> will make these
3900 statistics available. Defaults to B<false>.
3904 =head2 Plugin C<nginx>
3906 This plugin collects the number of connections and requests handled by the
3907 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
3908 queries the page provided by the C<ngx_http_stub_status_module> module, which
3909 isn't compiled by default. Please refer to
3910 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
3911 how to compile and configure nginx and this module.
3913 The following options are accepted by the C<nginx plugin>:
3917 =item B<URL> I<http://host/nginx_status>
3919 Sets the URL of the C<ngx_http_stub_status_module> output.
3921 =item B<User> I<Username>
3923 Optional user name needed for authentication.
3925 =item B<Password> I<Password>
3927 Optional password needed for authentication.
3929 =item B<VerifyPeer> B<true|false>
3931 Enable or disable peer SSL certificate verification. See
3932 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
3934 =item B<VerifyHost> B<true|false>
3936 Enable or disable peer host name verification. If enabled, the plugin checks
3937 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
3938 certificate matches the host name provided by the B<URL> option. If this
3939 identity check fails, the connection is aborted. Obviously, only works when
3940 connecting to a SSL enabled server. Enabled by default.
3942 =item B<CACert> I<File>
3944 File that holds one or more SSL certificates. If you want to use HTTPS you will
3945 possibly need this option. What CA certificates come bundled with C<libcurl>
3946 and are checked by default depends on the distribution you use.
3950 =head2 Plugin C<notify_desktop>
3952 This plugin sends a desktop notification to a notification daemon, as defined
3953 in the Desktop Notification Specification. To actually display the
3954 notifications, B<notification-daemon> is required and B<collectd> has to be
3955 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
3956 environment variables have to be set correctly) and the D-Bus message bus.
3958 The Desktop Notification Specification can be found at
3959 L<http://www.galago-project.org/specs/notification/>.
3963 =item B<OkayTimeout> I<timeout>
3965 =item B<WarningTimeout> I<timeout>
3967 =item B<FailureTimeout> I<timeout>
3969 Set the I<timeout>, in milliseconds, after which to expire the notification
3970 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
3971 been specified, the displayed notification will not be closed at all - the
3972 user has to do so herself. These options default to 5000. If a negative number
3973 has been specified, the default is used as well.
3977 =head2 Plugin C<notify_email>
3979 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
3980 configured email address.
3982 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
3984 Available configuration options:
3988 =item B<From> I<Address>
3990 Email address from which the emails should appear to come from.
3992 Default: C<root@localhost>
3994 =item B<Recipient> I<Address>
3996 Configures the email address(es) to which the notifications should be mailed.
3997 May be repeated to send notifications to multiple addresses.
3999 At least one B<Recipient> must be present for the plugin to work correctly.
4001 =item B<SMTPServer> I<Hostname>
4003 Hostname of the SMTP server to connect to.
4005 Default: C<localhost>
4007 =item B<SMTPPort> I<Port>
4009 TCP port to connect to.
4013 =item B<SMTPUser> I<Username>
4015 Username for ASMTP authentication. Optional.
4017 =item B<SMTPPassword> I<Password>
4019 Password for ASMTP authentication. Optional.
4021 =item B<Subject> I<Subject>
4023 Subject-template to use when sending emails. There must be exactly two
4024 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
4025 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
4028 Default: C<Collectd notify: %s@%s>
4032 =head2 Plugin C<ntpd>
4036 =item B<Host> I<Hostname>
4038 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
4040 =item B<Port> I<Port>
4042 UDP-Port to connect to. Defaults to B<123>.
4044 =item B<ReverseLookups> B<true>|B<false>
4046 Sets whether or not to perform reverse lookups on peers. Since the name or
4047 IP-address may be used in a filename it is recommended to disable reverse
4048 lookups. The default is to do reverse lookups to preserve backwards
4049 compatibility, though.
4051 =item B<IncludeUnitID> B<true>|B<false>
4053 When a peer is a refclock, include the unit ID in the I<type instance>.
4054 Defaults to B<false> for backward compatibility.
4056 If two refclock peers use the same driver and this is B<false>, the plugin will
4057 try to write simultaneous measurements from both to the same type instance.
4058 This will result in error messages in the log and only one set of measurements
4063 =head2 Plugin C<nut>
4067 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
4069 Add a UPS to collect data from. The format is identical to the one accepted by
4074 =head2 Plugin C<olsrd>
4076 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
4077 the Optimized Link State Routing daemon and reads information about the current
4078 state of the meshed network.
4080 The following configuration options are understood:
4084 =item B<Host> I<Host>
4086 Connect to I<Host>. Defaults to B<"localhost">.
4088 =item B<Port> I<Port>
4090 Specifies the port to connect to. This must be a string, even if you give the
4091 port as a number rather than a service name. Defaults to B<"2006">.
4093 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
4095 Specifies what information to collect about links, i.E<nbsp>e. direct
4096 connections of the daemon queried. If set to B<No>, no information is
4097 collected. If set to B<Summary>, the number of links and the average of all
4098 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
4099 If set to B<Detail> LQ and NLQ are collected per link.
4101 Defaults to B<Detail>.
4103 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
4105 Specifies what information to collect about routes of the daemon queried. If
4106 set to B<No>, no information is collected. If set to B<Summary>, the number of
4107 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
4108 metric and ETX are collected per route.
4110 Defaults to B<Summary>.
4112 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
4114 Specifies what information to collect about the global topology. If set to
4115 B<No>, no information is collected. If set to B<Summary>, the number of links
4116 in the entire topology and the average I<link quality> (LQ) is calculated.
4117 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
4119 Defaults to B<Summary>.
4123 =head2 Plugin C<onewire>
4125 B<EXPERIMENTAL!> See notes below.
4127 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
4128 L<http://owfs.org/> to read sensors connected via the onewire bus.
4130 It can be used in two possible modes - standard or advanced.
4132 In the standard mode only temperature sensors (sensors with the family code
4133 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
4134 other sensors you would like to have included, please send a sort request to
4135 the mailing list. You can select sensors to be read or to be ignored depending
4136 on the option B<IgnoreSelected>). When no list is provided the whole bus is
4137 walked and all sensors are read.
4139 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
4140 experimental, below.
4142 In the advanced mode you can configure any sensor to be read (only numerical
4143 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
4144 In this mode you have to list all the sensors. Neither default bus walk nor
4145 B<IgnoreSelected> are used here. Address and type (file) is extracted from
4146 the path automatically and should produce compatible structure with the "standard"
4147 mode (basically the path is expected as for example
4148 "/uncached/10.F10FCA000800/temperature" where it would extract address part
4149 "F10FCA000800" and the rest after the slash is considered the type - here
4151 There are two advantages to this mode - you can access virtually any sensor
4152 (not just temperature), select whether to use cached or directly read values
4153 and it is slighlty faster. The downside is more complex configuration.
4155 The two modes are distinguished automatically by the format of the address.
4156 It is not possible to mix the two modes. Once a full path is detected in any
4157 B<Sensor> then the whole addressing (all sensors) is considered to be this way
4158 (and as standard addresses will fail parsing they will be ignored).
4162 =item B<Device> I<Device>
4164 Sets the device to read the values from. This can either be a "real" hardware
4165 device, such as a serial port or an USB port, or the address of the
4166 L<owserver(1)> socket, usually B<localhost:4304>.
4168 Though the documentation claims to automatically recognize the given address
4169 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
4170 with that version, the following configuration worked for us:
4173 Device "-s localhost:4304"
4176 This directive is B<required> and does not have a default value.
4178 =item B<Sensor> I<Sensor>
4180 In the standard mode selects sensors to collect or to ignore
4181 (depending on B<IgnoreSelected>, see below). Sensors are specified without
4182 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
4183 and B<not> include the leading C<10.> family byte and point.
4184 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
4185 sensors (see above) are read.
4187 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
4188 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
4189 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
4191 As there can be multiple devices on the bus you can list multiple sensor (use
4192 multiple B<Sensor> elements).
4194 =item B<IgnoreSelected> I<true>|I<false>
4196 If no configuration is given, the B<onewire> plugin will collect data from all
4197 sensors found. This may not be practical, especially if sensors are added and
4198 removed regularly. Sometimes, however, it's easier/preferred to collect only
4199 specific sensors or all sensors I<except> a few specified ones. This option
4200 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
4201 B<Sensor> is inverted: All selected interfaces are ignored and all other
4202 interfaces are collected.
4204 Used only in the standard mode - see above.
4206 =item B<Interval> I<Seconds>
4208 Sets the interval in which all sensors should be read. If not specified, the
4209 global B<Interval> setting is used.
4213 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
4214 work with big setups. It works with one sensor being attached to one
4215 controller, but as soon as you throw in a couple more senors and maybe a hub
4216 or two, reading all values will take more than ten seconds (the default
4217 interval). We will probably add some separate thread for reading the sensors
4218 and some cache or something like that, but it's not done yet. We will try to
4219 maintain backwards compatibility in the future, but we can't promise. So in
4220 short: If it works for you: Great! But keep in mind that the config I<might>
4221 change, though this is unlikely. Oh, and if you want to help improving this
4222 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
4224 =head2 Plugin C<openvpn>
4226 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
4227 traffic statistics about connected clients.
4229 To set up OpenVPN to write to the status file periodically, use the
4230 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
4231 you need to set the required format, too. This is done by setting
4232 B<--status-version> to B<2>.
4234 So, in a nutshell you need:
4236 openvpn $OTHER_OPTIONS \
4237 --status "/var/run/openvpn-status" 10 \
4244 =item B<StatusFile> I<File>
4246 Specifies the location of the status file.
4248 =item B<ImprovedNamingSchema> B<true>|B<false>
4250 When enabled, the filename of the status file will be used as plugin instance
4251 and the client's "common name" will be used as type instance. This is required
4252 when reading multiple status files. Enabling this option is recommended, but to
4253 maintain backwards compatibility this option is disabled by default.
4255 =item B<CollectCompression> B<true>|B<false>
4257 Sets whether or not statistics about the compression used by OpenVPN should be
4258 collected. This information is only available in I<single> mode. Enabled by
4261 =item B<CollectIndividualUsers> B<true>|B<false>
4263 Sets whether or not traffic information is collected for each connected client
4264 individually. If set to false, currently no traffic data is collected at all
4265 because aggregating this data in a save manner is tricky. Defaults to B<true>.
4267 =item B<CollectUserCount> B<true>|B<false>
4269 When enabled, the number of currently connected clients or users is collected.
4270 This is especially interesting when B<CollectIndividualUsers> is disabled, but
4271 can be configured independently from that option. Defaults to B<false>.
4275 =head2 Plugin C<oracle>
4277 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
4278 Oracle® Database and lets you execute SQL statements there. It is very similar
4279 to the "dbi" plugin, because it was written around the same time. See the "dbi"
4280 plugin's documentation above for details.
4283 <Query "out_of_stock">
4284 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
4287 # InstancePrefix "foo"
4288 InstancesFrom "category"
4292 <Database "product_information">
4296 Query "out_of_stock"
4300 =head3 B<Query> blocks
4302 The Query blocks are handled identically to the Query blocks of the "dbi"
4303 plugin. Please see its documentation above for details on how to specify
4306 =head3 B<Database> blocks
4308 Database blocks define a connection to a database and which queries should be
4309 sent to that database. Each database needs a "name" as string argument in the
4310 starting tag of the block. This name will be used as "PluginInstance" in the
4311 values submitted to the daemon. Other than that, that name is not used.
4315 =item B<ConnectID> I<ID>
4317 Defines the "database alias" or "service name" to connect to. Usually, these
4318 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
4320 =item B<Host> I<Host>
4322 Hostname to use when dispatching values for this database. Defaults to using
4323 the global hostname of the I<collectd> instance.
4325 =item B<Username> I<Username>
4327 Username used for authentication.
4329 =item B<Password> I<Password>
4331 Password used for authentication.
4333 =item B<Query> I<QueryName>
4335 Associates the query named I<QueryName> with this database connection. The
4336 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
4337 blocks you want to refer to must be placed above the database block you want to
4342 =head2 Plugin C<perl>
4344 This plugin embeds a Perl-interpreter into collectd and provides an interface
4345 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
4347 =head2 Plugin C<pinba>
4349 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
4350 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
4351 PHP-based webpage has been delivered, the extension will send a UDP packet
4352 containing timing information, peak memory usage and so on. The plugin will
4353 wait for such packets, parse them and account the provided information, which
4354 is then dispatched to the daemon once per interval.
4361 # Overall statistics for the website.
4363 Server "www.example.com"
4365 # Statistics for www-a only
4367 Host "www-a.example.com"
4368 Server "www.example.com"
4370 # Statistics for www-b only
4372 Host "www-b.example.com"
4373 Server "www.example.com"
4377 The plugin provides the following configuration options:
4381 =item B<Address> I<Node>
4383 Configures the address used to open a listening socket. By default, plugin will
4384 bind to the I<any> address C<::0>.
4386 =item B<Port> I<Service>
4388 Configures the port (service) to bind to. By default the default Pinba port
4389 "30002" will be used. The option accepts service names in addition to port
4390 numbers and thus requires a I<string> argument.
4392 =item E<lt>B<View> I<Name>E<gt> block
4394 The packets sent by the Pinba extension include the hostname of the server, the
4395 server name (the name of the virtual host) and the script that was executed.
4396 Using B<View> blocks it is possible to separate the data into multiple groups
4397 to get more meaningful statistics. Each packet is added to all matching groups,
4398 so that a packet may be accounted for more than once.
4402 =item B<Host> I<Host>
4404 Matches the hostname of the system the webserver / script is running on. This
4405 will contain the result of the L<gethostname(2)> system call. If not
4406 configured, all hostnames will be accepted.
4408 =item B<Server> I<Server>
4410 Matches the name of the I<virtual host>, i.e. the contents of the
4411 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
4412 server names will be accepted.
4414 =item B<Script> I<Script>
4416 Matches the name of the I<script name>, i.e. the contents of the
4417 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
4418 script names will be accepted.
4424 =head2 Plugin C<ping>
4426 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
4427 configured hosts periodically and measures the network latency. Whenever the
4428 C<read> function of the plugin is called, it submits the average latency, the
4429 standard deviation and the drop rate for each host.
4431 Available configuration options:
4435 =item B<Host> I<IP-address>
4437 Host to ping periodically. This option may be repeated several times to ping
4440 =item B<Interval> I<Seconds>
4442 Sets the interval in which to send ICMP echo packets to the configured hosts.
4443 This is B<not> the interval in which statistics are queries from the plugin but
4444 the interval in which the hosts are "pinged". Therefore, the setting here
4445 should be smaller than or equal to the global B<Interval> setting. Fractional
4446 times, such as "1.24" are allowed.
4450 =item B<Timeout> I<Seconds>
4452 Time to wait for a response from the host to which an ICMP packet had been
4453 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
4454 to be down or the packet to be dropped. This setting must be smaller than the
4455 B<Interval> setting above for the plugin to work correctly. Fractional
4456 arguments are accepted.
4460 =item B<TTL> I<0-255>
4462 Sets the Time-To-Live of generated ICMP packets.
4464 =item B<SourceAddress> I<host>
4466 Sets the source address to use. I<host> may either be a numerical network
4467 address or a network hostname.
4469 =item B<Device> I<name>
4471 Sets the outgoing network device to be used. I<name> has to specify an
4472 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
4475 =item B<MaxMissed> I<Packets>
4477 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
4478 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
4480 Default: B<-1> (disabled)
4484 =head2 Plugin C<postgresql>
4486 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
4487 keeps a persistent connection to all configured databases and tries to
4488 reconnect if the connection has been interrupted. A database is configured by
4489 specifying a B<Database> block as described below. The default statistics are
4490 collected from PostgreSQL's B<statistics collector> which thus has to be
4491 enabled for this plugin to work correctly. This should usually be the case by
4492 default. See the section "The Statistics Collector" of the B<PostgreSQL
4493 Documentation> for details.
4495 By specifying custom database queries using a B<Query> block as described
4496 below, you may collect any data that is available from some PostgreSQL
4497 database. This way, you are able to access statistics of external daemons
4498 which are available in a PostgreSQL database or use future or special
4499 statistics provided by PostgreSQL without the need to upgrade your collectd
4502 Starting with version 5.2, the C<postgresql> plugin supports writing data to
4503 PostgreSQL databases as well. This has been implemented in a generic way. You
4504 need to specify an SQL statement which will then be executed by collectd in
4505 order to write the data (see below for details). The benefit of that approach
4506 is that there is no fixed database layout. Rather, the layout may be optimized
4507 for the current setup.
4509 The B<PostgreSQL Documentation> manual can be found at
4510 L<http://www.postgresql.org/docs/manuals/>.
4514 Statement "SELECT magic FROM wizard WHERE host = $1;"
4518 InstancePrefix "magic"
4523 <Query rt36_tickets>
4524 Statement "SELECT COUNT(type) AS count, type \
4526 WHEN resolved = 'epoch' THEN 'open' \
4527 ELSE 'resolved' END AS type \
4528 FROM tickets) type \
4532 InstancePrefix "rt36_tickets"
4533 InstancesFrom "type"
4539 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
4549 KRBSrvName "kerberos_service_name"
4555 Service "service_name"
4556 Query backend # predefined
4567 The B<Query> block defines one database query which may later be used by a
4568 database definition. It accepts a single mandatory argument which specifies
4569 the name of the query. The names of all queries have to be unique (see the
4570 B<MinVersion> and B<MaxVersion> options below for an exception to this
4571 rule). The following configuration options are available to define the query:
4573 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
4574 blocks define how to handle the values returned from the query. They define
4575 which column holds which value and how to dispatch that value to the daemon.
4576 Multiple B<Result> blocks may be used to extract multiple values from a single
4581 =item B<Statement> I<sql query statement>
4583 Specify the I<sql query statement> which the plugin should execute. The string
4584 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
4585 first, second, etc. parameter. The value of the parameters is specified by the
4586 B<Param> configuration option - see below for details. To include a literal
4587 B<$> character followed by a number, surround it with single quotes (B<'>).
4589 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
4590 allowed. Note, however, that only a single command may be used. Semicolons are
4591 allowed as long as a single non-empty command has been specified only.
4593 The returned lines will be handled separately one after another.
4595 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4597 Specify the parameters which should be passed to the SQL query. The parameters
4598 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4599 they appear in the configuration file. The value of the parameter is
4600 determined depending on the value of the B<Param> option as follows:
4606 The configured hostname of the database connection. If a UNIX domain socket is
4607 used, the parameter expands to "localhost".
4611 The name of the database of the current connection.
4615 The name of the database plugin instance. See the B<Instance> option of the
4616 database specification below for details.
4620 The username used to connect to the database.
4624 The interval with which this database is queried (as specified by the database
4625 specific or global B<Interval> options).
4629 Please note that parameters are only supported by PostgreSQL's protocol
4630 version 3 and above which was introduced in version 7.4 of PostgreSQL.
4632 =item B<Type> I<type>
4634 The I<type> name to be used when dispatching the values. The type describes
4635 how to handle the data and where to store it. See L<types.db(5)> for more
4636 details on types and their configuration. The number and type of values (as
4637 selected by the B<ValuesFrom> option) has to match the type of the given name.
4639 This option is required inside a B<Result> block.
4641 =item B<InstancePrefix> I<prefix>
4643 =item B<InstancesFrom> I<column0> [I<column1> ...]
4645 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
4646 B<InstancePrefix> defines a static prefix that will be prepended to all type
4647 instances. B<InstancesFrom> defines the column names whose values will be used
4648 to create the type instance. Multiple values will be joined together using the
4649 hyphen (C<->) as separation character.
4651 The plugin itself does not check whether or not all built instances are
4652 different. It is your responsibility to assure that each is unique.
4654 Both options are optional. If none is specified, the type instance will be
4657 =item B<ValuesFrom> I<column0> [I<column1> ...]
4659 Names the columns whose content is used as the actual data for the data sets
4660 that are dispatched to the daemon. How many such columns you need is
4661 determined by the B<Type> setting as explained above. If you specify too many
4662 or not enough columns, the plugin will complain about that and no data will be
4663 submitted to the daemon.
4665 The actual data type, as seen by PostgreSQL, is not that important as long as
4666 it represents numbers. The plugin will automatically cast the values to the
4667 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
4668 L<strtod(3)> functions, so anything supported by those functions is supported
4669 by the plugin as well.
4671 This option is required inside a B<Result> block and may be specified multiple
4672 times. If multiple B<ValuesFrom> options are specified, the columns are read
4675 =item B<MinVersion> I<version>
4677 =item B<MaxVersion> I<version>
4679 Specify the minimum or maximum version of PostgreSQL that this query should be
4680 used with. Some statistics might only be available with certain versions of
4681 PostgreSQL. This allows you to specify multiple queries with the same name but
4682 which apply to different versions, thus allowing you to use the same
4683 configuration in a heterogeneous environment.
4685 The I<version> has to be specified as the concatenation of the major, minor
4686 and patch-level versions, each represented as two-decimal-digit numbers. For
4687 example, version 8.2.3 will become 80203.
4691 The following predefined queries are available (the definitions can be found
4692 in the F<postgresql_default.conf> file which, by default, is available at
4693 C<I<prefix>/share/collectd/>):
4699 This query collects the number of backends, i.E<nbsp>e. the number of
4702 =item B<transactions>
4704 This query collects the numbers of committed and rolled-back transactions of
4709 This query collects the numbers of various table modifications (i.E<nbsp>e.
4710 insertions, updates, deletions) of the user tables.
4712 =item B<query_plans>
4714 This query collects the numbers of various table scans and returned tuples of
4717 =item B<table_states>
4719 This query collects the numbers of live and dead rows in the user tables.
4723 This query collects disk block access counts for user tables.
4727 This query collects the on-disk size of the database in bytes.
4731 In addition, the following detailed queries are available by default. Please
4732 note that each of those queries collects information B<by table>, thus,
4733 potentially producing B<a lot> of data. For details see the description of the
4734 non-by_table queries above.
4738 =item B<queries_by_table>
4740 =item B<query_plans_by_table>
4742 =item B<table_states_by_table>
4744 =item B<disk_io_by_table>
4748 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
4749 mandatory argument specifying the name of the writer. This will then be used
4750 in the B<Database> specification in order to activate the writer instance. The
4751 names of all writers have to be unique. The following options may be
4756 =item B<Statement> I<sql statement>
4758 This mandatory option specifies the SQL statement that will be executed for
4759 each submitted value. A single SQL statement is allowed only. Anything after
4760 the first semicolon will be ignored.
4762 Nine parameters will be passed to the statement and should be specified as
4763 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
4764 values are made available through those parameters:
4770 The timestamp of the queried value as a floating point number.
4774 The hostname of the queried value.
4778 The plugin name of the queried value.
4782 The plugin instance of the queried value. This value may be B<NULL> if there
4783 is no plugin instance.
4787 The type of the queried value (cf. L<types.db(5)>).
4791 The type instance of the queried value. This value may be B<NULL> if there is
4796 An array of names for the submitted values (i.E<nbsp>e., the name of the data
4797 sources of the submitted value-list).
4801 An array of types for the submitted values (i.E<nbsp>e., the type of the data
4802 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
4803 B<StoreRates> is enabled (which is the default, see below), all types will be
4808 An array of the submitted values. The dimensions of the value name and value
4813 In general, it is advisable to create and call a custom function in the
4814 PostgreSQL database for this purpose. Any procedural language supported by
4815 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
4818 =item B<StoreRates> B<false>|B<true>
4820 If set to B<true> (the default), convert counter values to rates. If set to
4821 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
4826 The B<Database> block defines one PostgreSQL database for which to collect
4827 statistics. It accepts a single mandatory argument which specifies the
4828 database name. None of the other options are required. PostgreSQL will use
4829 default values as documented in the section "CONNECTING TO A DATABASE" in the
4830 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
4831 the user collectd is run as and special environment variables. See the manpage
4836 =item B<Interval> I<seconds>
4838 Specify the interval with which the database should be queried. The default is
4839 to use the global B<Interval> setting.
4841 =item B<CommitInterval> I<seconds>
4843 This option may be used for database connections which have "writers" assigned
4844 (see above). If specified, it causes a writer to put several updates into a
4845 single transaction. This transaction will last for the specified amount of
4846 time. By default, each update will be executed in a separate transaction. Each
4847 transaction generates a fair amount of overhead which can, thus, be reduced by
4848 activating this option. The draw-back is, that data covering the specified
4849 amount of time will be lost, for example, if a single statement within the
4850 transaction fails or if the database server crashes.
4852 =item B<Host> I<hostname>
4854 Specify the hostname or IP of the PostgreSQL server to connect to. If the
4855 value begins with a slash, it is interpreted as the directory name in which to
4856 look for the UNIX domain socket.
4858 This option is also used to determine the hostname that is associated with a
4859 collected data set. If it has been omitted or either begins with with a slash
4860 or equals B<localhost> it will be replaced with the global hostname definition
4861 of collectd. Any other value will be passed literally to collectd when
4862 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
4864 =item B<Port> I<port>
4866 Specify the TCP port or the local UNIX domain socket file extension of the
4869 =item B<User> I<username>
4871 Specify the username to be used when connecting to the server.
4873 =item B<Password> I<password>
4875 Specify the password to be used when connecting to the server.
4877 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
4879 Specify whether to use an SSL connection when contacting the server. The
4880 following modes are supported:
4886 Do not use SSL at all.
4890 First, try to connect without using SSL. If that fails, try using SSL.
4892 =item I<prefer> (default)
4894 First, try to connect using SSL. If that fails, try without using SSL.
4902 =item B<Instance> I<name>
4904 Specify the plugin instance name that should be used instead of the database
4905 name (which is the default, if this option has not been specified). This
4906 allows to query multiple databases of the same name on the same host (e.g.
4907 when running multiple database server versions in parallel).
4909 =item B<KRBSrvName> I<kerberos_service_name>
4911 Specify the Kerberos service name to use when authenticating with Kerberos 5
4912 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
4913 B<PostgreSQL Documentation> for details.
4915 =item B<Service> I<service_name>
4917 Specify the PostgreSQL service name to use for additional parameters. That
4918 service has to be defined in F<pg_service.conf> and holds additional
4919 connection parameters. See the section "The Connection Service File" in the
4920 B<PostgreSQL Documentation> for details.
4922 =item B<Query> I<query>
4924 Specifies a I<query> which should be executed in the context of the database
4925 connection. This may be any of the predefined or user-defined queries. If no
4926 such option is given, it defaults to "backends", "transactions", "queries",
4927 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
4928 has been specified). Else, the specified queries are used only.
4930 =item B<Writer> I<writer>
4932 Assigns the specified I<writer> backend to the database connection. This
4933 causes all collected data to be send to the database using the settings
4934 defined in the writer configuration (see the section "FILTER CONFIGURATION"
4935 below for details on how to selectively send data to certain plugins).
4937 Each writer will register a flush callback which may be used when having long
4938 transactions enabled (see the B<CommitInterval> option above). When issuing
4939 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
4940 transaction will be committed right away. Two different kinds of flush
4941 callbacks are available with the C<postgresql> plugin:
4947 Flush all writer backends.
4949 =item B<postgresql->I<database>
4951 Flush all writers of the specified I<database> only.
4957 =head2 Plugin C<powerdns>
4959 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
4960 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
4961 values, many of which are probably meaningless to most users, but may be useful
4962 for some. So you may chose which values to collect, but if you don't, some
4963 reasonable defaults will be collected.
4966 <Server "server_name">
4968 Collect "udp-answers" "udp-queries"
4969 Socket "/var/run/pdns.controlsocket"
4971 <Recursor "recursor_name">
4973 Collect "cache-hits" "cache-misses"
4974 Socket "/var/run/pdns_recursor.controlsocket"
4976 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
4981 =item B<Server> and B<Recursor> block
4983 The B<Server> block defines one authoritative server to query, the B<Recursor>
4984 does the same for an recursing server. The possible options in both blocks are
4985 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
4990 =item B<Collect> I<Field>
4992 Using the B<Collect> statement you can select which values to collect. Here,
4993 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
4994 C<dlg-only-drops>, C<answers10-100>.
4996 The method of getting the values differs for B<Server> and B<Recursor> blocks:
4997 When querying the server a C<SHOW *> command is issued in any case, because
4998 that's the only way of getting multiple values out of the server at once.
4999 collectd then picks out the values you have selected. When querying the
5000 recursor, a command is generated to query exactly these values. So if you
5001 specify invalid fields when querying the recursor, a syntax error may be
5002 returned by the daemon and collectd may not collect any values at all.
5004 If no B<Collect> statement is given, the following B<Server> values will be
5011 =item packetcache-hit
5013 =item packetcache-miss
5015 =item packetcache-size
5017 =item query-cache-hit
5019 =item query-cache-miss
5021 =item recursing-answers
5023 =item recursing-questions
5035 The following B<Recursor> values will be collected by default:
5039 =item noerror-answers
5041 =item nxdomain-answers
5043 =item servfail-answers
5061 Please note that up to that point collectd doesn't know what values are
5062 available on the server and values that are added do not need a change of the
5063 mechanism so far. However, the values must be mapped to collectd's naming
5064 scheme, which is done using a lookup table that lists all known values. If
5065 values are added in the future and collectd does not know about them, you will
5066 get an error much like this:
5068 powerdns plugin: submit: Not found in lookup table: foobar = 42
5070 In this case please file a bug report with the collectd team.
5072 =item B<Socket> I<Path>
5074 Configures the path to the UNIX domain socket to be used when connecting to the
5075 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
5076 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
5077 will be used for the recursor.
5081 =item B<LocalSocket> I<Path>
5083 Querying the recursor is done using UDP. When using UDP over UNIX domain
5084 sockets, the client socket needs a name in the file system, too. You can set
5085 this local name to I<Path> using the B<LocalSocket> option. The default is
5086 C<I<prefix>/var/run/collectd-powerdns>.
5090 =head2 Plugin C<processes>
5094 =item B<Process> I<Name>
5096 Select more detailed statistics of processes matching this name. The statistics
5097 collected for these selected processes are size of the resident segment size
5098 (RSS), user- and system-time used, number of processes and number of threads,
5099 io data (where available) and minor and major pagefaults.
5101 =item B<ProcessMatch> I<name> I<regex>
5103 Similar to the B<Process> option this allows to select more detailed
5104 statistics of processes matching the specified I<regex> (see L<regex(7)> for
5105 details). The statistics of all matching processes are summed up and
5106 dispatched to the daemon using the specified I<name> as an identifier. This
5107 allows to "group" several processes together. I<name> must not contain
5112 =head2 Plugin C<protocols>
5114 Collects a lot of information about various network protocols, such as I<IP>,
5115 I<TCP>, I<UDP>, etc.
5117 Available configuration options:
5121 =item B<Value> I<Selector>
5123 Selects whether or not to select a specific value. The string being matched is
5124 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
5125 plugin instance and I<ValueName> will be used as type instance. An example of
5126 the string being used would be C<Tcp:RetransSegs>.
5128 You can use regular expressions to match a large number of values with just one
5129 configuration option. To select all "extended" I<TCP> values, you could use the
5130 following statement:
5134 Whether only matched values are selected or all matched values are ignored
5135 depends on the B<IgnoreSelected>. By default, only matched values are selected.
5136 If no value is configured at all, all values will be selected.
5138 =item B<IgnoreSelected> B<true>|B<false>
5140 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
5141 matching values will be ignored.
5145 =head2 Plugin C<python>
5147 This plugin embeds a Python-interpreter into collectd and provides an interface
5148 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
5150 =head2 Plugin C<routeros>
5152 The C<routeros> plugin connects to a device running I<RouterOS>, the
5153 Linux-based operating system for routers by I<MikroTik>. The plugin uses
5154 I<librouteros> to connect and reads information about the interfaces and
5155 wireless connections of the device. The configuration supports querying
5160 Host "router0.example.com"
5163 CollectInterface true
5168 Host "router1.example.com"
5171 CollectInterface true
5172 CollectRegistrationTable true
5178 As you can see above, the configuration of the I<routeros> plugin consists of
5179 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
5180 options are understood:
5184 =item B<Host> I<Host>
5186 Hostname or IP-address of the router to connect to.
5188 =item B<Port> I<Port>
5190 Port name or port number used when connecting. If left unspecified, the default
5191 will be chosen by I<librouteros>, currently "8728". This option expects a
5192 string argument, even when a numeric port number is given.
5194 =item B<User> I<User>
5196 Use the user name I<User> to authenticate. Defaults to "admin".
5198 =item B<Password> I<Password>
5200 Set the password used to authenticate.
5202 =item B<CollectInterface> B<true>|B<false>
5204 When set to B<true>, interface statistics will be collected for all interfaces
5205 present on the device. Defaults to B<false>.
5207 =item B<CollectRegistrationTable> B<true>|B<false>
5209 When set to B<true>, information about wireless LAN connections will be
5210 collected. Defaults to B<false>.
5212 =item B<CollectCPULoad> B<true>|B<false>
5214 When set to B<true>, information about the CPU usage will be collected. The
5215 number is a dimensionless value where zero indicates no CPU usage at all.
5216 Defaults to B<false>.
5218 =item B<CollectMemory> B<true>|B<false>
5220 When enabled, the amount of used and free memory will be collected. How used
5221 memory is calculated is unknown, for example whether or not caches are counted
5223 Defaults to B<false>.
5225 =item B<CollectDF> B<true>|B<false>
5227 When enabled, the amount of used and free disk space will be collected.
5228 Defaults to B<false>.
5230 =item B<CollectDisk> B<true>|B<false>
5232 When enabled, the number of sectors written and bad blocks will be collected.
5233 Defaults to B<false>.
5237 =head2 Plugin C<redis>
5239 The I<Redis plugin> connects to one or more Redis servers and gathers
5240 information about each server's state. For each server there is a I<Node> block
5241 which configures the connection parameters for this node.
5251 The information shown in the synopsis above is the I<default configuration>
5252 which is used by the plugin if no configuration is present.
5256 =item B<Node> I<Nodename>
5258 The B<Node> block identifies a new Redis node, that is a new Redis instance
5259 running in an specified host and port. The name for node is a canonical
5260 identifier which is used as I<plugin instance>. It is limited to
5261 64E<nbsp>characters in length.
5263 =item B<Host> I<Hostname>
5265 The B<Host> option is the hostname or IP-address where the Redis instance is
5268 =item B<Port> I<Port>
5270 The B<Port> option is the TCP port on which the Redis instance accepts
5271 connections. Either a service name of a port number may be given. Please note
5272 that numerical port numbers must be given as a string, too.
5274 =item B<Password> I<Password>
5276 Use I<Password> to authenticate when connecting to I<Redis>.
5278 =item B<Timeout> I<Timeout in miliseconds>
5280 The B<Timeout> option set the socket timeout for node response. Since the Redis
5281 read function is blocking, you should keep this value as low as possible. Keep
5282 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
5283 than B<Interval> defined globally.
5287 =head2 Plugin C<rrdcached>
5289 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
5290 to store values to RRD files in an efficient manner. The combination of the
5291 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
5292 way the C<rrdtool> plugin works (see below). The added abstraction layer
5293 provides a number of benefits, though: Because the cache is not within
5294 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
5295 restarted. This results in much shorter (if any) gaps in graphs, especially
5296 under heavy load. Also, the C<rrdtool> command line utility is aware of the
5297 daemon so that it can flush values to disk automatically when needed. This
5298 allows to integrate automated flushing of values into graphing solutions much
5301 There are disadvantages, though: The daemon may reside on a different host, so
5302 it may not be possible for C<collectd> to create the appropriate RRD files
5303 anymore. And even if C<rrdcached> runs on the same host, it may run in a
5304 different base directory, so relative paths may do weird stuff if you're not
5307 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
5308 on the same host, communicating via a UNIX domain socket. The B<DataDir>
5309 setting should be set to an absolute path, so that a changed base directory
5310 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
5314 =item B<DaemonAddress> I<Address>
5316 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
5317 library. See L<rrdcached(1)> for details. Example:
5319 <Plugin "rrdcached">
5320 DaemonAddress "unix:/var/run/rrdcached.sock"
5323 =item B<DataDir> I<Directory>
5325 Set the base directory in which the RRD files reside. If this is a relative
5326 path, it is relative to the working base directory of the C<rrdcached> daemon!
5327 Use of an absolute path is recommended.
5329 =item B<CreateFiles> B<true>|B<false>
5331 Enables or disables the creation of RRD files. If the daemon is not running
5332 locally, or B<DataDir> is set to a relative path, this will not work as
5333 expected. Default is B<true>.
5335 =item B<CreateFilesAsync> B<false>|B<true>
5337 When enabled, new RRD files are enabled asynchronously, using a separate thread
5338 that runs in the background. This prevents writes to block, which is a problem
5339 especially when many hundreds of files need to be created at once. However,
5340 since the purpose of creating the files asynchronously is I<not> to block until
5341 the file is available, values before the file is available will be discarded.
5342 When disabled (the default) files are created synchronously, blocking for a
5343 short while, while the file is being written.
5345 =item B<StepSize> I<Seconds>
5347 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5348 this setting is unset and the stepsize is set to the interval in which the data
5349 is collected. Do not use this option unless you absolutely have to for some
5350 reason. Setting this option may cause problems with the C<snmp plugin>, the
5351 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5353 =item B<HeartBeat> I<Seconds>
5355 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5356 in which case the heartbeat is set to twice the B<StepSize> which should equal
5357 the interval in which data is collected. Do not set this option unless you have
5358 a very good reason to do so.
5360 =item B<RRARows> I<NumRows>
5362 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5363 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5364 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5365 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5366 week, one month, and one year.
5368 So for each timespan, it calculates how many PDPs need to be consolidated into
5369 one CDP by calculating:
5370 number of PDPs = timespan / (stepsize * rrarows)
5372 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5375 =item B<RRATimespan> I<Seconds>
5377 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5378 more then one RRA. If this option is never used, the built-in default of (3600,
5379 86400, 604800, 2678400, 31622400) is used.
5381 For more information on how RRA-sizes are calculated see B<RRARows> above.
5383 =item B<XFF> I<Factor>
5385 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5386 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5391 =head2 Plugin C<rrdtool>
5393 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
5394 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
5395 using these settings. If you don't want to dive into the depths of RRDtool, you
5396 can safely ignore these settings.
5400 =item B<DataDir> I<Directory>
5402 Set the directory to store RRD files under. By default RRD files are generated
5403 beneath the daemon's working directory, i.e. the B<BaseDir>.
5405 =item B<CreateFilesAsync> B<false>|B<true>
5407 When enabled, new RRD files are enabled asynchronously, using a separate thread
5408 that runs in the background. This prevents writes to block, which is a problem
5409 especially when many hundreds of files need to be created at once. However,
5410 since the purpose of creating the files asynchronously is I<not> to block until
5411 the file is available, values before the file is available will be discarded.
5412 When disabled (the default) files are created synchronously, blocking for a
5413 short while, while the file is being written.
5415 =item B<StepSize> I<Seconds>
5417 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5418 this setting is unset and the stepsize is set to the interval in which the data
5419 is collected. Do not use this option unless you absolutely have to for some
5420 reason. Setting this option may cause problems with the C<snmp plugin>, the
5421 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5423 =item B<HeartBeat> I<Seconds>
5425 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5426 in which case the heartbeat is set to twice the B<StepSize> which should equal
5427 the interval in which data is collected. Do not set this option unless you have
5428 a very good reason to do so.
5430 =item B<RRARows> I<NumRows>
5432 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5433 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5434 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5435 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5436 week, one month, and one year.
5438 So for each timespan, it calculates how many PDPs need to be consolidated into
5439 one CDP by calculating:
5440 number of PDPs = timespan / (stepsize * rrarows)
5442 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5445 =item B<RRATimespan> I<Seconds>
5447 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5448 more then one RRA. If this option is never used, the built-in default of (3600,
5449 86400, 604800, 2678400, 31622400) is used.
5451 For more information on how RRA-sizes are calculated see B<RRARows> above.
5453 =item B<XFF> I<Factor>
5455 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5456 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5459 =item B<CacheFlush> I<Seconds>
5461 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
5462 it writes all values for a certain RRD-file if the oldest value is older than
5463 (or equal to) the number of seconds specified. If some RRD-file is not updated
5464 anymore for some reason (the computer was shut down, the network is broken,
5465 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
5466 entire cache is searched for entries older than B<CacheTimeout> seconds and
5467 written to disk every I<Seconds> seconds. Since this is kind of expensive and
5468 does nothing under normal circumstances, this value should not be too small.
5469 900 seconds might be a good value, though setting this to 7200 seconds doesn't
5470 normally do much harm either.
5472 =item B<CacheTimeout> I<Seconds>
5474 If this option is set to a value greater than zero, the C<rrdtool plugin> will
5475 save values in a cache, as described above. Writing multiple values at once
5476 reduces IO-operations and thus lessens the load produced by updating the files.
5477 The trade off is that the graphs kind of "drag behind" and that more memory is
5480 =item B<WritesPerSecond> I<Updates>
5482 When collecting many statistics with collectd and the C<rrdtool> plugin, you
5483 will run serious performance problems. The B<CacheFlush> setting and the
5484 internal update queue assert that collectd continues to work just fine even
5485 under heavy load, but the system may become very unresponsive and slow. This is
5486 a problem especially if you create graphs from the RRD files on the same
5487 machine, for example using the C<graph.cgi> script included in the
5488 C<contrib/collection3/> directory.
5490 This setting is designed for very large setups. Setting this option to a value
5491 between 25 and 80 updates per second, depending on your hardware, will leave
5492 the server responsive enough to draw graphs even while all the cached values
5493 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
5494 by the B<FLUSH> command, are B<not> effected by this limit. They are still
5495 written as fast as possible, so that web frontends have up to date data when
5498 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
5499 updates per second, writing all values to disk will take approximately
5500 56E<nbsp>minutes. Together with the flushing ability that's integrated into
5501 "collection3" you'll end up with a responsive and fast system, up to date
5502 graphs and basically a "backup" of your values every hour.
5504 =item B<RandomTimeout> I<Seconds>
5506 When set, the actual timeout for each value is chosen randomly between
5507 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
5508 intention is to avoid high load situations that appear when many values timeout
5509 at the same time. This is especially a problem shortly after the daemon starts,
5510 because all values were added to the internal cache at roughly the same time.
5514 =head2 Plugin C<sensors>
5516 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
5517 that all the needed modules have to be loaded and lm_sensors has to be
5518 configured (most likely by editing F</etc/sensors.conf>. Read
5519 L<sensors.conf(5)> for details.
5521 The B<lm_sensors> homepage can be found at
5522 L<http://secure.netroedge.com/~lm78/>.
5526 =item B<SensorConfigFile> I<File>
5528 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
5529 the library's default will be used.
5531 =item B<Sensor> I<chip-bus-address/type-feature>
5533 Selects the name of the sensor which you want to collect or ignore, depending
5534 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
5535 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
5536 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
5538 =item B<IgnoreSelected> I<true>|I<false>
5540 If no configuration if given, the B<sensors>-plugin will collect data from all
5541 sensors. This may not be practical, especially for uninteresting sensors.
5542 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
5543 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
5544 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
5545 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
5546 and all other sensors are collected.
5550 =head2 Plugin C<sigrok>
5552 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
5553 supported by the L<sigrok|http://sigrok.org/> project.
5559 <Device "AC Voltage">
5564 <Device "Sound Level">
5565 Driver "cem-dt-885x"
5572 =item B<LogLevel> B<0-5>
5574 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
5575 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
5576 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
5577 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
5578 their level, are always submitted to I<collectd> at its INFO log level.
5580 =item E<lt>B<Device> I<Name>E<gt>
5582 A sigrok-supported device, uniquely identified by this section's options. The
5583 I<Name> is passed to I<collectd> as the I<plugin instance>.
5585 =item B<Driver> I<DriverName>
5587 The sigrok driver to use for this device.
5589 =item B<Conn> I<ConnectionSpec>
5591 If the device cannot be auto-discovered, or more than one might be discovered
5592 by the driver, I<ConnectionSpec> specifies the connection string to the device.
5593 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
5594 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
5595 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
5596 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
5598 =item B<SerialComm> I<SerialSpec>
5600 For serial devices with non-standard port settings, this option can be used
5601 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
5602 This should not be necessary; drivers know how to communicate with devices they
5605 =item B<MinimumInterval> I<Seconds>
5607 Specifies the minimum time between measurement dispatches to I<collectd>, in
5608 seconds. Since some I<sigrok> supported devices can acquire measurements many
5609 times per second, it may be necessary to throttle these. For example, the
5610 I<RRD plugin> cannot process writes more than once per second.
5612 The default B<MinimumInterval> is B<0>, meaning measurements received from the
5613 device are always dispatched to I<collectd>. When throttled, unused
5614 measurements are discarded.
5618 =head2 Plugin C<snmp>
5620 Since the configuration of the C<snmp plugin> is a little more complicated than
5621 other plugins, its documentation has been moved to an own manpage,
5622 L<collectd-snmp(5)>. Please see there for details.
5624 =head2 Plugin C<statsd>
5626 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
5627 protocol and dispatches rates or other aggregates of these numbers
5630 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
5631 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
5632 C<objects> respectively.
5634 The following configuration options are valid:
5638 =item B<Host> I<Host>
5640 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
5641 "any" address, i.e. accept packets sent to any of the hosts addresses.
5643 =item B<Port> I<Port>
5645 UDP port to listen to. This can be either a service name or a port number.
5646 Defaults to C<8125>.
5648 =item B<DeleteCounters> B<false>|B<true>
5650 =item B<DeleteTimers> B<false>|B<true>
5652 =item B<DeleteGauges> B<false>|B<true>
5654 =item B<DeleteSets> B<false>|B<true>
5656 These options control what happens if metrics are not updated in an interval.
5657 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
5658 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
5659 are unchanged. If set to B<True>, the such metrics are not dispatched and
5660 removed from the internal cache.
5662 =item B<TimerPercentile> I<Percent>
5664 Calculate and dispatch the configured percentile, i.e. compute the latency, so
5665 that I<Percent> of all reported timers are smaller than or equal to the
5666 computed latency. This is useful for cutting off the long tail latency, as it's
5667 often done in I<Service Level Agreements> (SLAs).
5669 If not specified, no percentile is calculated / dispatched.
5673 =head2 Plugin C<swap>
5675 The I<Swap plugin> collects information about used and available swap space. On
5676 I<Linux> and I<Solaris>, the following options are available:
5680 =item B<ReportByDevice> B<false>|B<true>
5682 Configures how to report physical swap devices. If set to B<false> (the
5683 default), the summary over all swap devices is reported only, i.e. the globally
5684 used and available space over all devices. If B<true> is configured, the used
5685 and available space of each device will be reported separately.
5687 This option is only available if the I<Swap plugin> can read C</proc/swaps>
5688 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
5690 =item B<ReportBytes> B<false>|B<true>
5692 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
5693 I<swap I/O> is reported in pages. This option is available under Linux only.
5695 =item B<ValuesAbsolute> B<true>|B<false>
5697 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
5698 available and used. Defaults to B<true>.
5700 =item B<ValuesPercentage> B<false>|B<true>
5702 Enables or disables reporting of relative swap metrics, i.e. I<percent>
5703 available and free. Defaults to B<false>.
5705 This is useful for deploying I<collectd> in a heterogeneous environment, where
5706 swap sizes differ and you want to specify generic thresholds or similar.
5710 =head2 Plugin C<syslog>
5714 =item B<LogLevel> B<debug|info|notice|warning|err>
5716 Sets the log-level. If, for example, set to B<notice>, then all events with
5717 severity B<notice>, B<warning>, or B<err> will be submitted to the
5720 Please note that B<debug> is only available if collectd has been compiled with
5723 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
5725 Controls which notifications should be sent to syslog. The default behaviour is
5726 not to send any. Less severe notifications always imply logging more severe
5727 notifications: Setting this to B<OKAY> means all notifications will be sent to
5728 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
5729 notifications but will dismiss B<OKAY> notifications. Setting this option to
5730 B<FAILURE> will only send failures to syslog.
5734 =head2 Plugin C<table>
5736 The C<table plugin> provides generic means to parse tabular data and dispatch
5737 user specified values. Values are selected based on column numbers. For
5738 example, this plugin may be used to get values from the Linux L<proc(5)>
5739 filesystem or CSV (comma separated values) files.
5742 <Table "/proc/slabinfo">
5747 InstancePrefix "active_objs"
5753 InstancePrefix "objperslab"
5760 The configuration consists of one or more B<Table> blocks, each of which
5761 configures one file to parse. Within each B<Table> block, there are one or
5762 more B<Result> blocks, which configure which data to select and how to
5765 The following options are available inside a B<Table> block:
5769 =item B<Instance> I<instance>
5771 If specified, I<instance> is used as the plugin instance. So, in the above
5772 example, the plugin name C<table-slabinfo> would be used. If omitted, the
5773 filename of the table is used instead, with all special characters replaced
5774 with an underscore (C<_>).
5776 =item B<Separator> I<string>
5778 Any character of I<string> is interpreted as a delimiter between the different
5779 columns of the table. A sequence of two or more contiguous delimiters in the
5780 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
5781 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
5782 of a table - see its documentation for more details. This option is mandatory.
5784 A horizontal tab, newline and carriage return may be specified by C<\\t>,
5785 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
5786 required because of collectd's config parsing.
5790 The following options are available inside a B<Result> block:
5794 =item B<Type> I<type>
5796 Sets the type used to dispatch the values to the daemon. Detailed information
5797 about types and their configuration can be found in L<types.db(5)>. This
5798 option is mandatory.
5800 =item B<InstancePrefix> I<prefix>
5802 If specified, prepend I<prefix> to the type instance. If omitted, only the
5803 B<InstancesFrom> option is considered for the type instance.
5805 =item B<InstancesFrom> I<column0> [I<column1> ...]
5807 If specified, the content of the given columns (identified by the column
5808 number starting at zero) will be used to create the type instance for each
5809 row. Multiple values (and the instance prefix) will be joined together with
5810 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
5811 option is considered for the type instance.
5813 The plugin itself does not check whether or not all built instances are
5814 different. It’s your responsibility to assure that each is unique. This is
5815 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
5816 sure that the table only contains one row.
5818 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
5821 =item B<ValuesFrom> I<column0> [I<column1> ...]
5823 Specifies the columns (identified by the column numbers starting at zero)
5824 whose content is used as the actual data for the data sets that are dispatched
5825 to the daemon. How many such columns you need is determined by the B<Type>
5826 setting above. If you specify too many or not enough columns, the plugin will
5827 complain about that and no data will be submitted to the daemon. The plugin
5828 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
5829 respectively, so anything supported by those functions is supported by the
5830 plugin as well. This option is mandatory.
5834 =head2 Plugin C<tail>
5836 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
5837 each line and dispatches found values. What is matched can be configured by the
5838 user using (extended) regular expressions, as described in L<regex(7)>.
5841 <File "/var/log/exim4/mainlog">
5845 Regex "S=([1-9][0-9]*)"
5851 Regex "\\<R=local_user\\>"
5852 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
5855 Instance "local_user"
5860 The config consists of one or more B<File> blocks, each of which configures one
5861 logfile to parse. Within each B<File> block, there are one or more B<Match>
5862 blocks, which configure a regular expression to search for.
5864 The B<Instance> option in the B<File> block may be used to set the plugin
5865 instance. So in the above example the plugin name C<tail-foo> would be used.
5866 This plugin instance is for all B<Match> blocks that B<follow> it, until the
5867 next B<Instance> option. This way you can extract several plugin instances from
5868 one logfile, handy when parsing syslog and the like.
5870 The B<Interval> option allows you to define the length of time between reads. If
5871 this is not set, the default Interval will be used.
5873 Each B<Match> block has the following options to describe how the match should
5878 =item B<Regex> I<regex>
5880 Sets the regular expression to use for matching against a line. The first
5881 subexpression has to match something that can be turned into a number by
5882 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
5883 below. Because B<extended> regular expressions are used, you do not need to use
5884 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
5885 collectd's config parsing you need to escape backslashes, though. So if you
5886 want to match literal parentheses you need to do the following:
5888 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
5890 =item B<ExcludeRegex> I<regex>
5892 Sets an optional regular expression to use for excluding lines from the match.
5893 An example which excludes all connections from localhost from the match:
5895 ExcludeRegex "127\\.0\\.0\\.1"
5897 =item B<DSType> I<Type>
5899 Sets how the values are cumulated. I<Type> is one of:
5903 =item B<GaugeAverage>
5905 Calculate the average.
5909 Use the smallest number only.
5913 Use the greatest number only.
5917 Use the last number found.
5923 =item B<AbsoluteSet>
5925 The matched number is a counter. Simply I<sets> the internal counter to this
5926 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
5932 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
5933 matched number may be negative, which will effectively subtract from the
5940 Increase the internal counter by one. These B<DSType> are the only ones that do
5941 not use the matched subexpression, but simply count the number of matched
5942 lines. Thus, you may use a regular expression without submatch in this case.
5946 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
5947 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
5948 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
5949 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
5950 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
5953 =item B<Type> I<Type>
5955 Sets the type used to dispatch this value. Detailed information about types and
5956 their configuration can be found in L<types.db(5)>.
5958 =item B<Instance> I<TypeInstance>
5960 This optional setting sets the type instance to use.
5964 =head2 Plugin C<tail_csv>
5966 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
5967 written by I<Snort>.
5972 <Metric "snort-dropped">
5977 <File "/var/log/snort/snort.stats">
5978 Instance "snort-eth0"
5980 Collect "snort-dropped"
5984 The configuration consists of one or more B<Metric> blocks that define an index
5985 into the line of the CSV file and how this value is mapped to I<collectd's>
5986 internal representation. These are followed by one or more B<Instance> blocks
5987 which configure which file to read, in which interval and which metrics to
5992 =item E<lt>B<Metric> I<Name>E<gt>
5994 The B<Metric> block configures a new metric to be extracted from the statistics
5995 file and how it is mapped on I<collectd's> data model. The string I<Name> is
5996 only used inside the B<Instance> blocks to refer to this block, so you can use
5997 one B<Metric> block for multiple CSV files.
6001 =item B<Type> I<Type>
6003 Configures which I<Type> to use when dispatching this metric. Types are defined
6004 in the L<types.db(5)> file, see the appropriate manual page for more
6005 information on specifying types. Only types with a single I<data source> are
6006 supported by the I<tail_csv plugin>. The information whether the value is an
6007 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
6008 I<Type's> definition.
6010 =item B<Instance> I<TypeInstance>
6012 If set, I<TypeInstance> is used to populate the type instance field of the
6013 created value lists. Otherwise, no type instance is used.
6015 =item B<ValueFrom> I<Index>
6017 Configure to read the value from the field with the zero-based index I<Index>.
6018 If the value is parsed as signed integer, unsigned integer or double depends on
6019 the B<Type> setting, see above.
6023 =item E<lt>B<File> I<Path>E<gt>
6025 Each B<File> block represents one CSV file to read. There must be at least one
6026 I<File> block but there can be multiple if you have multiple CSV files.
6030 =item B<Instance> I<PluginInstance>
6032 Sets the I<plugin instance> used when dispatching the values.
6034 =item B<Collect> I<Metric>
6036 Specifies which I<Metric> to collect. This option must be specified at least
6037 once, and you can use this option multiple times to specify more than one
6038 metric to be extracted from this statistic file.
6040 =item B<Interval> I<Seconds>
6042 Configures the interval in which to read values from this instance / file.
6043 Defaults to the plugin's default interval.
6045 =item B<TimeFrom> I<Index>
6047 Rather than using the local time when dispatching a value, read the timestamp
6048 from the field with the zero-based index I<Index>. The value is interpreted as
6049 seconds since epoch. The value is parsed as a double and may be factional.
6055 =head2 Plugin C<teamspeak2>
6057 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
6058 polls interesting global and virtual server data. The plugin can query only one
6059 physical server but unlimited virtual servers. You can use the following
6060 options to configure it:
6064 =item B<Host> I<hostname/ip>
6066 The hostname or ip which identifies the physical server.
6069 =item B<Port> I<port>
6071 The query port of the physical server. This needs to be a string.
6074 =item B<Server> I<port>
6076 This option has to be added once for every virtual server the plugin should
6077 query. If you want to query the virtual server on port 8767 this is what the
6078 option would look like:
6082 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
6083 use quotes around it! If no such statement is given only global information
6088 =head2 Plugin C<ted>
6090 The I<TED> plugin connects to a device of "The Energy Detective", a device to
6091 measure power consumption. These devices are usually connected to a serial
6092 (RS232) or USB port. The plugin opens a configured device and tries to read the
6093 current energy readings. For more information on TED, visit
6094 L<http://www.theenergydetective.com/>.
6096 Available configuration options:
6100 =item B<Device> I<Path>
6102 Path to the device on which TED is connected. collectd will need read and write
6103 permissions on that file.
6105 Default: B</dev/ttyUSB0>
6107 =item B<Retries> I<Num>
6109 Apparently reading from TED is not that reliable. You can therefore configure a
6110 number of retries here. You only configure the I<retries> here, to if you
6111 specify zero, one reading will be performed (but no retries if that fails); if
6112 you specify three, a maximum of four readings are performed. Negative values
6119 =head2 Plugin C<tcpconns>
6121 The C<tcpconns plugin> counts the number of currently established TCP
6122 connections based on the local port and/or the remote port. Since there may be
6123 a lot of connections the default if to count all connections with a local port,
6124 for which a listening socket is opened. You can use the following options to
6125 fine-tune the ports you are interested in:
6129 =item B<ListeningPorts> I<true>|I<false>
6131 If this option is set to I<true>, statistics for all local ports for which a
6132 listening socket exists are collected. The default depends on B<LocalPort> and
6133 B<RemotePort> (see below): If no port at all is specifically selected, the
6134 default is to collect listening ports. If specific ports (no matter if local or
6135 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
6136 the selected ports will be collected unless this option is set to I<true>
6139 =item B<LocalPort> I<Port>
6141 Count the connections to a specific local port. This can be used to see how
6142 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
6143 You have to specify the port in numeric form, so for the mailserver example
6144 you'd need to set B<25>.
6146 =item B<RemotePort> I<Port>
6148 Count the connections to a specific remote port. This is useful to see how
6149 much a remote service is used. This is most useful if you want to know how many
6150 connections a local service has opened to remote services, e.E<nbsp>g. how many
6151 connections a mail server or news server has to other mail or news servers, or
6152 how many connections a web proxy holds to web servers. You have to give the
6153 port in numeric form.
6157 =head2 Plugin C<thermal>
6161 =item B<ForceUseProcfs> I<true>|I<false>
6163 By default, the I<Thermal plugin> tries to read the statistics from the Linux
6164 C<sysfs> interface. If that is not available, the plugin falls back to the
6165 C<procfs> interface. By setting this option to I<true>, you can force the
6166 plugin to use the latter. This option defaults to I<false>.
6168 =item B<Device> I<Device>
6170 Selects the name of the thermal device that you want to collect or ignore,
6171 depending on the value of the B<IgnoreSelected> option. This option may be
6172 used multiple times to specify a list of devices.
6174 =item B<IgnoreSelected> I<true>|I<false>
6176 Invert the selection: If set to true, all devices B<except> the ones that
6177 match the device names specified by the B<Device> option are collected. By
6178 default only selected devices are collected if a selection is made. If no
6179 selection is configured at all, B<all> devices are selected.
6183 =head2 Plugin C<threshold>
6185 The I<Threshold plugin> checks values collected or received by I<collectd>
6186 against a configurable I<threshold> and issues I<notifications> if values are
6189 Documentation for this plugin is available in the L<collectd-threshold(5)>
6192 =head2 Plugin C<tokyotyrant>
6194 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
6195 couple metrics: number of records, and database size on disk.
6199 =item B<Host> I<Hostname/IP>
6201 The hostname or ip which identifies the server.
6202 Default: B<127.0.0.1>
6204 =item B<Port> I<Service/Port>
6206 The query port of the server. This needs to be a string, even if the port is
6207 given in its numeric form.
6212 =head2 Plugin C<unixsock>
6216 =item B<SocketFile> I<Path>
6218 Sets the socket-file which is to be created.
6220 =item B<SocketGroup> I<Group>
6222 If running as root change the group of the UNIX-socket after it has been
6223 created. Defaults to B<collectd>.
6225 =item B<SocketPerms> I<Permissions>
6227 Change the file permissions of the UNIX-socket after it has been created. The
6228 permissions must be given as a numeric, octal value as you would pass to
6229 L<chmod(1)>. Defaults to B<0770>.
6231 =item B<DeleteSocket> B<false>|B<true>
6233 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
6234 with the given name already exists. If I<collectd> crashes a socket file may be
6235 left over, preventing the daemon from opening a new socket when restarted.
6236 Since this is potentially dangerous, this defaults to B<false>.
6240 =head2 Plugin C<uuid>
6242 This plugin, if loaded, causes the Hostname to be taken from the machine's
6243 UUID. The UUID is a universally unique designation for the machine, usually
6244 taken from the machine's BIOS. This is most useful if the machine is running in
6245 a virtual environment such as Xen, in which case the UUID is preserved across
6246 shutdowns and migration.
6248 The following methods are used to find the machine's UUID, in order:
6254 Check I</etc/uuid> (or I<UUIDFile>).
6258 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
6263 Check for UUID from C<dmidecode> / SMBIOS.
6267 Check for UUID from Xen hypervisor.
6271 If no UUID can be found then the hostname is not modified.
6275 =item B<UUIDFile> I<Path>
6277 Take the UUID from the given file (default I</etc/uuid>).
6281 =head2 Plugin C<varnish>
6283 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
6288 <Instance "example">
6290 CollectConnections true
6300 CollectWorkers false
6304 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
6305 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
6306 will collectd statistics from the default "varnishd" instance (this should work
6307 fine in most cases).
6309 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
6313 =item B<CollectCache> B<true>|B<false>
6315 Cache hits and misses. True by default.
6317 =item B<CollectConnections> B<true>|B<false>
6319 Number of client connections received, accepted and dropped. True by default.
6321 =item B<CollectBackend> B<true>|B<false>
6323 Back-end connection statistics, such as successful, reused,
6324 and closed connections. True by default.
6326 =item B<CollectSHM> B<true>|B<false>
6328 Statistics about the shared memory log, a memory region to store
6329 log messages which is flushed to disk when full. True by default.
6331 =item B<CollectBan> B<true>|B<false>
6333 Statistics about ban operations, such as number of bans added, retired, and
6334 number of objects tested against ban operations. Only available with Varnish
6335 3.x. False by default.
6337 =item B<CollectDirectorDNS> B<true>|B<false>
6339 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
6342 =item B<CollectESI> B<true>|B<false>
6344 Edge Side Includes (ESI) parse statistics. False by default.
6346 =item B<CollectFetch> B<true>|B<false>
6348 Statistics about fetches (HTTP requests sent to the backend). False by default.
6350 =item B<CollectHCB> B<true>|B<false>
6352 Inserts and look-ups in the crit bit tree based hash. Look-ups are
6353 divided into locked and unlocked look-ups. False by default.
6355 =item B<CollectObjects> B<true>|B<false>
6357 Statistics on cached objects: number of objects expired, nuked (prematurely
6358 expired), saved, moved, etc. False by default.
6360 =item B<CollectPurge> B<true>|B<false>
6362 Statistics about purge operations, such as number of purges added, retired, and
6363 number of objects tested against purge operations. Only available with Varnish
6364 2.x. False by default.
6366 =item B<CollectSession> B<true>|B<false>
6368 Client session statistics. Number of past and current sessions, session herd and
6369 linger counters, etc. False by default.
6371 =item B<CollectSMA> B<true>|B<false>
6373 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
6374 component is Solaris specific. Only available with Varnish 2.x. False by
6377 =item B<CollectSMS> B<true>|B<false>
6379 synth (synthetic content) storage statistics. This storage
6380 component is used internally only. False by default.
6382 =item B<CollectSM> B<true>|B<false>
6384 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
6387 =item B<CollectStruct> B<true>|B<false>
6389 Current varnish internal state statistics. Number of current sessions, objects
6390 in cache store, open connections to backends (with Varnish 2.x), etc. False by
6393 =item B<CollectTotals> B<true>|B<false>
6395 Collects overview counters, such as the number of sessions created,
6396 the number of requests and bytes transferred. False by default.
6398 =item B<CollectUptime> B<true>|B<false>
6400 Varnish uptime. False by default.
6402 =item B<CollectVCL> B<true>|B<false>
6404 Number of total (available + discarded) VCL (config files). False by default.
6406 =item B<CollectWorkers> B<true>|B<false>
6408 Collect statistics about worker threads. False by default.
6412 =head2 Plugin C<virt>
6414 This plugin allows CPU, disk and network load to be collected for virtualized
6415 guests on the machine. This means that these metrics can be collected for guest
6416 systems without installing any software on them - I<collectd> only runs on the
6417 host system. The statistics are collected through libvirt
6418 (L<http://libvirt.org/>).
6420 Only I<Connection> is required.
6424 =item B<Connection> I<uri>
6426 Connect to the hypervisor given by I<uri>. For example if using Xen use:
6428 Connection "xen:///"
6430 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
6432 =item B<RefreshInterval> I<seconds>
6434 Refresh the list of domains and devices every I<seconds>. The default is 60
6435 seconds. Setting this to be the same or smaller than the I<Interval> will cause
6436 the list of domains and devices to be refreshed on every iteration.
6438 Refreshing the devices in particular is quite a costly operation, so if your
6439 virtualization setup is static you might consider increasing this. If this
6440 option is set to 0, refreshing is disabled completely.
6442 =item B<Domain> I<name>
6444 =item B<BlockDevice> I<name:dev>
6446 =item B<InterfaceDevice> I<name:dev>
6448 =item B<IgnoreSelected> B<true>|B<false>
6450 Select which domains and devices are collected.
6452 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
6453 disk/network devices are collected.
6455 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
6456 domains and disk/network devices are ignored, while the rest are collected.
6458 The domain name and device names may use a regular expression, if the name is
6459 surrounded by I</.../> and collectd was compiled with support for regexps.
6461 The default is to collect statistics for all domains and all their devices.
6465 BlockDevice "/:hdb/"
6466 IgnoreSelected "true"
6468 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
6471 =item B<HostnameFormat> B<name|uuid|hostname|...>
6473 When the libvirt plugin logs data, it sets the hostname of the collected data
6474 according to this setting. The default is to use the guest name as provided by
6475 the hypervisor, which is equal to setting B<name>.
6477 B<uuid> means use the guest's UUID. This is useful if you want to track the
6478 same guest across migrations.
6480 B<hostname> means to use the global B<Hostname> setting, which is probably not
6481 useful on its own because all guests will appear to have the same name.
6483 You can also specify combinations of these fields. For example B<name uuid>
6484 means to concatenate the guest name and UUID (with a literal colon character
6485 between, thus I<"foo:1234-1234-1234-1234">).
6487 =item B<InterfaceFormat> B<name>|B<address>
6489 When the libvirt plugin logs interface data, it sets the name of the collected
6490 data according to this setting. The default is to use the path as provided by
6491 the hypervisor (the "dev" property of the target node), which is equal to
6494 B<address> means use the interface's mac address. This is useful since the
6495 interface path might change between reboots of a guest or across migrations.
6497 =item B<PluginInstanceFormat> B<name|uuid>
6499 When the libvirt plugin logs data, it sets the plugin_instance of the collected
6500 data according to this setting. The default is to use the guest name as provided
6501 by the hypervisor, which is equal to setting B<name>.
6503 B<uuid> means use the guest's UUID.
6507 =head2 Plugin C<vmem>
6509 The C<vmem> plugin collects information about the usage of virtual memory.
6510 Since the statistics provided by the Linux kernel are very detailed, they are
6511 collected very detailed. However, to get all the details, you have to switch
6512 them on manually. Most people just want an overview over, such as the number of
6513 pages read from swap space.
6517 =item B<Verbose> B<true>|B<false>
6519 Enables verbose collection of information. This will start collecting page
6520 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
6521 Part of these statistics are collected on a "per zone" basis.
6525 =head2 Plugin C<vserver>
6527 This plugin doesn't have any options. B<VServer> support is only available for
6528 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
6529 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
6530 need to apply the patches and compile your own kernel, which will then provide
6531 the F</proc/virtual> filesystem that is required by this plugin.
6533 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
6535 B<Note>: The traffic collected by this plugin accounts for the amount of
6536 traffic passing a socket which might be a lot less than the actual on-wire
6537 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
6538 collect on-wire traffic you could, for example, use the logging facilities of
6539 iptables to feed data for the guest IPs into the iptables plugin.
6541 =head2 Plugin C<write_graphite>
6543 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
6544 storage and graphing project. The plugin connects to I<Carbon>, the data layer
6545 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
6546 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
6547 of at most 1428 bytes to minimize the number of network packets.
6551 <Plugin write_graphite>
6561 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6562 blocks. Inside the B<Node> blocks, the following options are recognized:
6566 =item B<Host> I<Address>
6568 Hostname or address to connect to. Defaults to C<localhost>.
6570 =item B<Port> I<Service>
6572 Service name or port number to connect to. Defaults to C<2003>.
6574 =item B<Protocol> I<String>
6576 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
6578 =item B<LogSendErrors> B<false>|B<true>
6580 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
6581 If set to B<false>, it will not log the errors. This is especially useful when
6582 using Protocol UDP since many times we want to use the "fire-and-forget"
6583 approach and logging errors fills syslog with unneeded messages.
6585 =item B<Prefix> I<String>
6587 When set, I<String> is added in front of the host name. Dots and whitespace are
6588 I<not> escaped in this string (see B<EscapeCharacter> below).
6590 =item B<Postfix> I<String>
6592 When set, I<String> is appended to the host name. Dots and whitespace are
6593 I<not> escaped in this string (see B<EscapeCharacter> below).
6595 =item B<EscapeCharacter> I<Char>
6597 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
6598 in the identifier. The B<EscapeCharacter> option determines which character
6599 dots, whitespace and control characters are replaced with. Defaults to
6602 =item B<StoreRates> B<false>|B<true>
6604 If set to B<true> (the default), convert counter values to rates. If set to
6605 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6608 =item B<SeparateInstances> B<false>|B<true>
6610 If set to B<true>, the plugin instance and type instance will be in their own
6611 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6612 default), the plugin and plugin instance (and likewise the type and type
6613 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6615 =item B<AlwaysAppendDS> B<false>|B<true>
6617 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
6618 identifier. If set to B<false> (the default), this is only done when there is
6623 =head2 Plugin C<write_tsdb>
6625 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
6626 time series database. The plugin connects to a I<TSD>, a masterless, no shared
6627 state daemon that ingests metrics and stores them in HBase. The plugin uses
6628 I<TCP> over the "line based" protocol with a default port 4242. The data will
6629 be sent in blocks of at most 1428 bytes to minimize the number of network
6636 Host "tsd-1.my.domain"
6638 HostTags "status=production"
6642 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6643 blocks. Inside the B<Node> blocks, the following options are recognized:
6647 =item B<Host> I<Address>
6649 Hostname or address to connect to. Defaults to C<localhost>.
6651 =item B<Port> I<Service>
6653 Service name or port number to connect to. Defaults to C<4242>.
6656 =item B<HostTags> I<String>
6658 When set, I<HostTags> is added to the end of the metric. It is intended to be
6659 used for name=value pairs that the TSD will tag the metric with. Dots and
6660 whitespace are I<not> escaped in this string.
6662 =item B<StoreRates> B<false>|B<true>
6664 If set to B<true>, convert counter values to rates. If set to B<false>
6665 (the default) counter values are stored as is, as an increasing
6668 =item B<AlwaysAppendDS> B<false>|B<true>
6670 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
6671 identifier. If set to B<false> (the default), this is only done when there is
6676 =head2 Plugin C<write_mongodb>
6678 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
6683 <Plugin "write_mongodb">
6692 The plugin can send values to multiple instances of I<MongoDB> by specifying
6693 one B<Node> block for each instance. Within the B<Node> blocks, the following
6694 options are available:
6698 =item B<Host> I<Address>
6700 Hostname or address to connect to. Defaults to C<localhost>.
6702 =item B<Port> I<Service>
6704 Service name or port number to connect to. Defaults to C<27017>.
6706 =item B<Timeout> I<Timeout>
6708 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
6709 Setting this option to zero means no timeout, which is the default.
6711 =item B<StoreRates> B<false>|B<true>
6713 If set to B<true> (the default), convert counter values to rates. If set to
6714 B<false> counter values are stored as is, i.e. as an increasing integer
6717 =item B<Database> I<Database>
6719 =item B<User> I<User>
6721 =item B<Password> I<Password>
6723 Sets the information used when authenticating to a I<MongoDB> database. The
6724 fields are optional (in which case no authentication is attempted), but if you
6725 want to use authentication all three fields must be set.
6729 =head2 Plugin C<write_http>
6731 This output plugin submits values to an HTTP server using POST requests and
6732 encoding metrics with JSON or using the C<PUTVAL> command described in
6733 L<collectd-unixsock(5)>. Each destination you want to post data to needs to
6734 have one B<URL> block, within which the destination can be configured further,
6735 for example by specifying authentication data.
6739 <Plugin "write_http">
6740 <URL "http://example.com/post-collectd">
6747 B<URL> blocks need one string argument which is used as the URL to which data
6748 is posted. The following options are understood within B<URL> blocks.
6752 =item B<User> I<Username>
6754 Optional user name needed for authentication.
6756 =item B<Password> I<Password>
6758 Optional password needed for authentication.
6760 =item B<VerifyPeer> B<true>|B<false>
6762 Enable or disable peer SSL certificate verification. See
6763 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
6765 =item B<VerifyHost> B<true|false>
6767 Enable or disable peer host name verification. If enabled, the plugin checks if
6768 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
6769 matches the host name provided by the B<URL> option. If this identity check
6770 fails, the connection is aborted. Obviously, only works when connecting to a
6771 SSL enabled server. Enabled by default.
6773 =item B<CACert> I<File>
6775 File that holds one or more SSL certificates. If you want to use HTTPS you will
6776 possibly need this option. What CA certificates come bundled with C<libcurl>
6777 and are checked by default depends on the distribution you use.
6779 =item B<CAPath> I<Directory>
6781 Directory holding one or more CA certificate files. You can use this if for
6782 some reason all the needed CA certificates aren't in the same file and can't be
6783 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
6786 =item B<ClientKey> I<File>
6788 File that holds the private key in PEM format to be used for certificate-based
6791 =item B<ClientCert> I<File>
6793 File that holds the SSL certificate to be used for certificate-based
6796 =item B<ClientKeyPass> I<Password>
6798 Password required to load the private key in B<ClientKey>.
6800 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
6802 Define which SSL protocol version must be used. By default C<libcurl> will
6803 attempt to figure out the remote SSL protocol version. See
6804 L<curl_easy_setopt(3)> for more details.
6806 =item B<Format> B<Command>|B<JSON>
6808 Format of the output to generate. If set to B<Command>, will create output that
6809 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
6810 create output in the I<JavaScript Object Notation> (JSON).
6812 Defaults to B<Command>.
6814 =item B<StoreRates> B<true|false>
6816 If set to B<true>, convert counter values to rates. If set to B<false> (the
6817 default) counter values are stored as is, i.e. as an increasing integer number.
6819 =item B<BufferSize> I<Bytes>
6821 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
6822 requests will be generated, but more metrics will be batched / metrics are
6823 cached for longer before being sent, introducing additional delay until they
6824 are available on the server side. I<Bytes> must be at least 1024 and cannot
6825 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
6826 Defaults to C<4096>.
6830 =head2 Plugin C<write_kafka>
6832 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
6836 <Plugin "write_kafka">
6837 Property "metadata.broker.list" "broker1:9092,broker2:9092"
6843 The following options are understood by the I<write_kafka plugin>:
6847 =item E<lt>B<Topic> I<Name>E<gt>
6849 The plugin's configuration consists of one or more B<Topic> blocks. Each block
6850 is given a unique I<Name> and specifies one kafka producer.
6851 Inside the B<Topic> block, the following per-topic options are
6856 =item B<Property> I<String> I<String>
6858 Configure the named property for the current topic. Properties are
6859 forwarded to the kafka producer library B<librdkafka>.
6861 =item B<Key> I<String>
6863 Use the specified string as a partioning key for the topic. Kafka breaks
6864 topic into partitions and guarantees that for a given topology, the same
6865 consumer will be used for a specific key. The special (case insensitive)
6866 string B<Random> can be used to specify that an arbitrary partition should
6869 =item B<Format> B<Command>|B<JSON>|B<Graphite>
6871 Selects the format in which messages are sent to the broker. If set to
6872 B<Command> (the default), values are sent as C<PUTVAL> commands which are
6873 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
6875 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
6876 an easy and straight forward exchange format.
6878 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
6879 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
6881 =item B<StoreRates> B<true>|B<false>
6883 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
6884 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
6885 default), no conversion is performed. Otherwise the conversion is performed
6886 using the internal value cache.
6888 Please note that currently this option is only used if the B<Format> option has
6889 been set to B<JSON>.
6891 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
6893 A prefix can be added in the metric name when outputting in the I<Graphite>
6894 format. It's added before the I<Host> name.
6896 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>>
6898 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
6900 A postfix can be added in the metric name when outputting in the I<Graphite>
6901 format. It's added after the I<Host> name.
6903 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>>
6905 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
6907 Specify a character to replace dots (.) in the host part of the metric name.
6908 In I<Graphite> metric name, dots are used as separators between different
6909 metric parts (host, plugin, type).
6910 Default is C<_> (I<Underscore>).
6912 =item B<GraphiteSeparateInstances> B<false>|B<true>
6914 If set to B<true>, the plugin instance and type instance will be in their own
6915 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6916 default), the plugin and plugin instance (and likewise the type and type
6917 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6919 =item B<StoreRates> B<true>|B<false>
6921 If set to B<true> (the default), convert counter values to rates. If set to
6922 B<false> counter values are stored as is, i.e. as an increasing integer number.
6924 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
6925 converted values will have "rate" appended to the data source type, e.g.
6926 C<ds_type:derive:rate>.
6930 =item B<Property> I<String> I<String>
6932 Configure the kafka producer through properties, you almost always will
6933 want to set B<metadata.broker.list> to your Kafka broker list.
6937 =head2 Plugin C<write_riemann>
6939 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
6940 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
6941 I<Riemann> using UDP packets.
6945 <Plugin "write_riemann">
6951 AlwaysAppendDS false
6955 Attribute "foo" "bar"
6958 The following options are understood by the I<write_riemann plugin>:
6962 =item E<lt>B<Node> I<Name>E<gt>
6964 The plugin's configuration consists of one or more B<Node> blocks. Each block
6965 is given a unique I<Name> and specifies one connection to an instance of
6966 I<Riemann>. Indise the B<Node> block, the following per-connection options are
6971 =item B<Host> I<Address>
6973 Hostname or address to connect to. Defaults to C<localhost>.
6975 =item B<Port> I<Service>
6977 Service name or port number to connect to. Defaults to C<5555>.
6979 =item B<Protocol> B<UDP>|B<TCP>
6981 Specify the protocol to use when communicating with I<Riemann>. Defaults to
6984 =item B<StoreRates> B<true>|B<false>
6986 If set to B<true> (the default), convert counter values to rates. If set to
6987 B<false> counter values are stored as is, i.e. as an increasing integer number.
6989 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
6990 converted values will have "rate" appended to the data source type, e.g.
6991 C<ds_type:derive:rate>.
6993 =item B<AlwaysAppendDS> B<false>|B<true>
6995 If set the B<true>, append the name of the I<Data Source> (DS) to the
6996 "service", i.e. the field that, together with the "host" field, uniquely
6997 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
6998 only done when there is more than one DS.
7000 =item B<TTLFactor> I<Factor>
7002 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
7003 event is considered active. I<collectd> populates this field based on the
7004 metrics interval setting. This setting controls the factor with which the
7005 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
7006 know exactly what you're doing, you should only increase this setting from its
7009 =item B<Notifications> B<false>|B<true>
7011 If set to B<true>, create riemann events for notifications. This is B<true>
7012 by default. When processing thresholds from write_riemann, it might prove
7013 useful to avoid getting notification events.
7015 =item B<CheckThresholds> B<false>|B<true>
7017 If set to B<true>, attach state to events based on thresholds defined
7018 in the B<Threshold> plugin. Defaults to B<false>.
7020 =item B<EventServicePrefix> I<String>
7022 Add the given string as a prefix to the event service name.
7023 If B<EventServicePrefix> not set or set to an empty string (""),
7024 no prefix will be used.
7028 =item B<Tag> I<String>
7030 Add the given string as an additional tag to the metric being sent to
7033 =item B<Attribute> I<String> I<String>
7035 Consider the two given strings to be the key and value of an additional
7036 attribute for each metric being sent out to I<Riemann>.
7040 =head1 THRESHOLD CONFIGURATION
7042 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
7043 we mean that the values are not only stored or sent somewhere, but that they
7044 are judged and, if a problem is recognized, acted upon. The only action
7045 collectd takes itself is to generate and dispatch a "notification". Plugins can
7046 register to receive notifications and perform appropriate further actions.
7048 Since systems and what you expect them to do differ a lot, you can configure
7049 B<thresholds> for your values freely. This gives you a lot of flexibility but
7050 also a lot of responsibility.
7052 Every time a value is out of range a notification is dispatched. This means
7053 that the idle percentage of your CPU needs to be less then the configured
7054 threshold only once for a notification to be generated. There's no such thing
7055 as a moving average or similar - at least not now.
7057 Also, all values that match a threshold are considered to be relevant or
7058 "interesting". As a consequence collectd will issue a notification if they are
7059 not received for B<Timeout> iterations. The B<Timeout> configuration option is
7060 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
7061 "2" (the default) and some hosts sends it's CPU statistics to the server every
7062 60 seconds, a notification will be dispatched after about 120 seconds. It may
7063 take a little longer because the timeout is checked only once each B<Interval>
7066 When a value comes within range again or is received after it was missing, an
7067 "OKAY-notification" is dispatched.
7069 Here is a configuration example to get you started. Read below for more
7082 <Plugin "interface">
7099 WarningMin 100000000
7105 There are basically two types of configuration statements: The C<Host>,
7106 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
7107 configured. The C<Plugin> and C<Type> blocks may be specified further using the
7108 C<Instance> option. You can combine the block by nesting the blocks, though
7109 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
7110 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
7111 C<Type> may not contain other blocks. If multiple blocks apply to the same
7112 value the most specific block is used.
7114 The other statements specify the threshold to configure. They B<must> be
7115 included in a C<Type> block. Currently the following statements are recognized:
7119 =item B<FailureMax> I<Value>
7121 =item B<WarningMax> I<Value>
7123 Sets the upper bound of acceptable values. If unset defaults to positive
7124 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
7125 will be created. If the value is greater than B<WarningMax> but less than (or
7126 equal to) B<FailureMax> a B<WARNING> notification will be created.
7128 =item B<FailureMin> I<Value>
7130 =item B<WarningMin> I<Value>
7132 Sets the lower bound of acceptable values. If unset defaults to negative
7133 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
7134 be created. If the value is less than B<WarningMin> but greater than (or equal
7135 to) B<FailureMin> a B<WARNING> notification will be created.
7137 =item B<DataSource> I<DSName>
7139 Some data sets have more than one "data source". Interesting examples are the
7140 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
7141 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
7142 system load data set, C<load>, even has three data sources: C<shortterm>,
7143 C<midterm>, and C<longterm>.
7145 Normally, all data sources are checked against a configured threshold. If this
7146 is undesirable, or if you want to specify different limits for each data
7147 source, you can use the B<DataSource> option to have a threshold apply only to
7150 =item B<Invert> B<true>|B<false>
7152 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
7153 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
7154 B<WarningMax>) are not okay. Defaults to B<false>.
7156 =item B<Persist> B<true>|B<false>
7158 Sets how often notifications are generated. If set to B<true> one notification
7159 will be generated for each value that is out of the acceptable range. If set to
7160 B<false> (the default) then a notification is only generated if a value is out
7161 of range but the previous value was okay.
7163 This applies to missing values, too: If set to B<true> a notification about a
7164 missing value is generated once every B<Interval> seconds. If set to B<false>
7165 only one such notification is generated until the value appears again.
7167 =item B<Percentage> B<true>|B<false>
7169 If set to B<true>, the minimum and maximum values given are interpreted as
7170 percentage value, relative to the other data sources. This is helpful for
7171 example for the "df" type, where you may want to issue a warning when less than
7172 5E<nbsp>% of the total space is available. Defaults to B<false>.
7174 =item B<Hits> I<Number>
7176 Delay creating the notification until the threshold has been passed I<Number>
7177 times. When a notification has been generated, or when a subsequent value is
7178 inside the threshold, the counter is reset. If, for example, a value is
7179 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
7180 will be dispatched at most once every 30E<nbsp>seconds.
7182 This is useful when short bursts are not a problem. If, for example, 100% CPU
7183 usage for up to a minute is normal (and data is collected every
7184 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
7186 =item B<Hysteresis> I<Number>
7188 When set to non-zero, a hysteresis value is applied when checking minimum and
7189 maximum bounds. This is useful for values that increase slowly and fluctuate a
7190 bit while doing so. When these values come close to the threshold, they may
7191 "flap", i.e. switch between failure / warning case and okay case repeatedly.
7193 If, for example, the threshold is configures as
7198 then a I<Warning> notification is created when the value exceeds I<101> and the
7199 corresponding I<Okay> notification is only created once the value falls below
7200 I<99>, thus avoiding the "flapping".
7204 =head1 FILTER CONFIGURATION
7206 Starting with collectd 4.6 there is a powerful filtering infrastructure
7207 implemented in the daemon. The concept has mostly been copied from
7208 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
7209 terminology, so that users that are familiar with iptables feel right at home.
7213 The following are the terms used in the remainder of the filter configuration
7214 documentation. For an ASCII-art schema of the mechanism, see
7215 L<"General structure"> below.
7221 A I<match> is a criteria to select specific values. Examples are, of course, the
7222 name of the value or it's current value.
7224 Matches are implemented in plugins which you have to load prior to using the
7225 match. The name of such plugins starts with the "match_" prefix.
7229 A I<target> is some action that is to be performed with data. Such actions
7230 could, for example, be to change part of the value's identifier or to ignore
7231 the value completely.
7233 Some of these targets are built into the daemon, see L<"Built-in targets">
7234 below. Other targets are implemented in plugins which you have to load prior to
7235 using the target. The name of such plugins starts with the "target_" prefix.
7239 The combination of any number of matches and at least one target is called a
7240 I<rule>. The target actions will be performed for all values for which B<all>
7241 matches apply. If the rule does not have any matches associated with it, the
7242 target action will be performed for all values.
7246 A I<chain> is a list of rules and possibly default targets. The rules are tried
7247 in order and if one matches, the associated target will be called. If a value
7248 is handled by a rule, it depends on the target whether or not any subsequent
7249 rules are considered or if traversal of the chain is aborted, see
7250 L<"Flow control"> below. After all rules have been checked, the default targets
7255 =head2 General structure
7257 The following shows the resulting structure:
7264 +---------+ +---------+ +---------+ +---------+
7265 ! Rule !->! Match !->! Match !->! Target !
7266 +---------+ +---------+ +---------+ +---------+
7269 +---------+ +---------+ +---------+
7270 ! Rule !->! Target !->! Target !
7271 +---------+ +---------+ +---------+
7278 +---------+ +---------+ +---------+
7279 ! Rule !->! Match !->! Target !
7280 +---------+ +---------+ +---------+
7290 There are four ways to control which way a value takes through the filter
7297 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
7298 process the value with another chain. When the called chain finishes, usually
7299 the next target or rule after the jump is executed.
7303 The stop condition, signaled for example by the built-in target B<stop>, causes
7304 all processing of the value to be stopped immediately.
7308 Causes processing in the current chain to be aborted, but processing of the
7309 value generally will continue. This means that if the chain was called via
7310 B<Jump>, the next target or rule after the jump will be executed. If the chain
7311 was not called by another chain, control will be returned to the daemon and it
7312 may pass the value to another chain.
7316 Most targets will signal the B<continue> condition, meaning that processing
7317 should continue normally. There is no special built-in target for this
7324 The configuration reflects this structure directly:
7326 PostCacheChain "PostCache"
7328 <Rule "ignore_mysql_show">
7331 Type "^mysql_command$"
7332 TypeInstance "^show_"
7342 The above configuration example will ignore all values where the plugin field
7343 is "mysql", the type is "mysql_command" and the type instance begins with
7344 "show_". All other values will be sent to the C<rrdtool> write plugin via the
7345 default target of the chain. Since this chain is run after the value has been
7346 added to the cache, the MySQL C<show_*> command statistics will be available
7347 via the C<unixsock> plugin.
7349 =head2 List of configuration options
7353 =item B<PreCacheChain> I<ChainName>
7355 =item B<PostCacheChain> I<ChainName>
7357 Configure the name of the "pre-cache chain" and the "post-cache chain". The
7358 argument is the name of a I<chain> that should be executed before and/or after
7359 the values have been added to the cache.
7361 To understand the implications, it's important you know what is going on inside
7362 I<collectd>. The following diagram shows how values are passed from the
7363 read-plugins to the write-plugins:
7369 + - - - - V - - - - +
7370 : +---------------+ :
7373 : +-------+-------+ :
7376 : +-------+-------+ : +---------------+
7377 : ! Cache !--->! Value Cache !
7378 : ! insert ! : +---+---+-------+
7379 : +-------+-------+ : ! !
7380 : ! ,------------' !
7382 : +-------+---+---+ : +-------+-------+
7383 : ! Post-Cache +--->! Write-Plugins !
7384 : ! Chain ! : +---------------+
7385 : +---------------+ :
7388 + - - - - - - - - - +
7390 After the values are passed from the "read" plugins to the dispatch functions,
7391 the pre-cache chain is run first. The values are added to the internal cache
7392 afterwards. The post-cache chain is run after the values have been added to the
7393 cache. So why is it such a huge deal if chains are run before or after the
7394 values have been added to this cache?
7396 Targets that change the identifier of a value list should be executed before
7397 the values are added to the cache, so that the name in the cache matches the
7398 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
7399 this cache to receive a list of all available values. If you change the
7400 identifier after the value list has been added to the cache, this may easily
7401 lead to confusion, but it's not forbidden of course.
7403 The cache is also used to convert counter values to rates. These rates are, for
7404 example, used by the C<value> match (see below). If you use the rate stored in
7405 the cache B<before> the new value is added, you will use the old, B<previous>
7406 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
7407 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
7410 Last but not last, the B<stop> target makes a difference: If the pre-cache
7411 chain returns the stop condition, the value will not be added to the cache and
7412 the post-cache chain will not be run.
7414 =item B<Chain> I<Name>
7416 Adds a new chain with a certain name. This name can be used to refer to a
7417 specific chain, for example to jump to it.
7419 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
7421 =item B<Rule> [I<Name>]
7423 Adds a new rule to the current chain. The name of the rule is optional and
7424 currently has no meaning for the daemon.
7426 Within the B<Rule> block, there may be any number of B<Match> blocks and there
7427 must be at least one B<Target> block.
7429 =item B<Match> I<Name>
7431 Adds a match to a B<Rule> block. The name specifies what kind of match should
7432 be performed. Available matches depend on the plugins that have been loaded.
7434 The arguments inside the B<Match> block are passed to the plugin implementing
7435 the match, so which arguments are valid here depends on the plugin being used.
7436 If you do not need any to pass any arguments to a match, you can use the
7441 Which is equivalent to:
7446 =item B<Target> I<Name>
7448 Add a target to a rule or a default target to a chain. The name specifies what
7449 kind of target is to be added. Which targets are available depends on the
7450 plugins being loaded.
7452 The arguments inside the B<Target> block are passed to the plugin implementing
7453 the target, so which arguments are valid here depends on the plugin being used.
7454 If you do not need any to pass any arguments to a target, you can use the
7459 This is the same as writing:
7466 =head2 Built-in targets
7468 The following targets are built into the core daemon and therefore need no
7469 plugins to be loaded:
7475 Signals the "return" condition, see the L<"Flow control"> section above. This
7476 causes the current chain to stop processing the value and returns control to
7477 the calling chain. The calling chain will continue processing targets and rules
7478 just after the B<jump> target (see below). This is very similar to the
7479 B<RETURN> target of iptables, see L<iptables(8)>.
7481 This target does not have any options.
7489 Signals the "stop" condition, see the L<"Flow control"> section above. This
7490 causes processing of the value to be aborted immediately. This is similar to
7491 the B<DROP> target of iptables, see L<iptables(8)>.
7493 This target does not have any options.
7501 Sends the value to "write" plugins.
7507 =item B<Plugin> I<Name>
7509 Name of the write plugin to which the data should be sent. This option may be
7510 given multiple times to send the data to more than one write plugin. If the
7511 plugin supports multiple instances, the plugin's instance(s) must also be
7516 If no plugin is explicitly specified, the values will be sent to all available
7519 Single-instance plugin example:
7525 Multi-instance plugin example:
7527 <Plugin "write_graphite">
7537 Plugin "write_graphite/foo"
7542 Starts processing the rules of another chain, see L<"Flow control"> above. If
7543 the end of that chain is reached, or a stop condition is encountered,
7544 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
7545 next target or the next rule. This is similar to the B<-j> command line option
7546 of iptables, see L<iptables(8)>.
7552 =item B<Chain> I<Name>
7554 Jumps to the chain I<Name>. This argument is required and may appear only once.
7566 =head2 Available matches
7572 Matches a value using regular expressions.
7578 =item B<Host> I<Regex>
7580 =item B<Plugin> I<Regex>
7582 =item B<PluginInstance> I<Regex>
7584 =item B<Type> I<Regex>
7586 =item B<TypeInstance> I<Regex>
7588 Match values where the given regular expressions match the various fields of
7589 the identifier of a value. If multiple regular expressions are given, B<all>
7590 regexen must match for a value to match.
7592 =item B<Invert> B<false>|B<true>
7594 When set to B<true>, the result of the match is inverted, i.e. all value lists
7595 where all regular expressions apply are not matched, all other value lists are
7596 matched. Defaults to B<false>.
7603 Host "customer[0-9]+"
7609 Matches values that have a time which differs from the time on the server.
7611 This match is mainly intended for servers that receive values over the
7612 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
7613 is very sensitive to the timestamp used when updating the RRD files. In
7614 particular, the time must be ever increasing. If a misbehaving client sends one
7615 packet with a timestamp far in the future, all further packets with a correct
7616 time will be ignored because of that one packet. What's worse, such corrupted
7617 RRD files are hard to fix.
7619 This match lets one match all values B<outside> a specified time range
7620 (relative to the server's time), so you can use the B<stop> target (see below)
7621 to ignore the value, for example.
7627 =item B<Future> I<Seconds>
7629 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
7630 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7633 =item B<Past> I<Seconds>
7635 Matches all values that are I<behind> of the server's time by I<Seconds> or
7636 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7648 This example matches all values that are five minutes or more ahead of the
7649 server or one hour (or more) lagging behind.
7653 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
7654 values. If a data-set consists of more than one data-source, all data-sources
7655 must match the specified ranges for a positive match.
7661 =item B<Min> I<Value>
7663 Sets the smallest value which still results in a match. If unset, behaves like
7666 =item B<Max> I<Value>
7668 Sets the largest value which still results in a match. If unset, behaves like
7671 =item B<Invert> B<true>|B<false>
7673 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
7674 no-match is returned and vice versa. Please note that the B<Invert> setting
7675 only effects how B<Min> and B<Max> are applied to a specific value. Especially
7676 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
7678 =item B<DataSource> I<DSName> [I<DSName> ...]
7680 Select one or more of the data sources. If no data source is configured, all
7681 data sources will be checked. If the type handled by the match does not have a
7682 data source of the specified name(s), this will always result in no match
7683 (independent of the B<Invert> setting).
7685 =item B<Satisfy> B<Any>|B<All>
7687 Specifies how checking with several data sources is performed. If set to
7688 B<Any>, the match succeeds if one of the data sources is in the configured
7689 range. If set to B<All> the match only succeeds if all data sources are within
7690 the configured range. Default is B<All>.
7692 Usually B<All> is used for positive matches, B<Any> is used for negative
7693 matches. This means that with B<All> you usually check that all values are in a
7694 "good" range, while with B<Any> you check if any value is within a "bad" range
7695 (or outside the "good" range).
7699 Either B<Min> or B<Max>, but not both, may be unset.
7703 # Match all values smaller than or equal to 100. Matches only if all data
7704 # sources are below 100.
7710 # Match if the value of any data source is outside the range of 0 - 100.
7718 =item B<empty_counter>
7720 Matches all values with one or more data sources of type B<COUNTER> and where
7721 all counter values are zero. These counters usually I<never> increased since
7722 they started existing (and are therefore uninteresting), or got reset recently
7723 or overflowed and you had really, I<really> bad luck.
7725 Please keep in mind that ignoring such counters can result in confusing
7726 behavior: Counters which hardly ever increase will be zero for long periods of
7727 time. If the counter is reset for some reason (machine or service restarted,
7728 usually), the graph will be empty (NAN) for a long time. People may not
7733 Calculates a hash value of the host name and matches values according to that
7734 hash value. This makes it possible to divide all hosts into groups and match
7735 only values that are in a specific group. The intended use is in load
7736 balancing, where you want to handle only part of all data and leave the rest
7739 The hashing function used tries to distribute the hosts evenly. First, it
7740 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
7743 for (i = 0; host[i] != 0; i++)
7744 hash_value = (hash_value * 251) + host[i];
7746 The constant 251 is a prime number which is supposed to make this hash value
7747 more random. The code then checks the group for this host according to the
7748 I<Total> and I<Match> arguments:
7750 if ((hash_value % Total) == Match)
7755 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
7756 groups), then the least significant bit of the hash value will be the XOR of
7757 all least significant bits in the host name. One consequence is that when you
7758 have two hosts, "server0.example.com" and "server1.example.com", where the host
7759 name differs in one digit only and the digits differ by one, those hosts will
7760 never end up in the same group.
7766 =item B<Match> I<Match> I<Total>
7768 Divide the data into I<Total> groups and match all hosts in group I<Match> as
7769 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
7770 be smaller than I<Total>. I<Total> must be at least one, although only values
7771 greater than one really do make any sense.
7773 You can repeat this option to match multiple groups, for example:
7778 The above config will divide the data into seven groups and match groups three
7779 and five. One use would be to keep every value on two hosts so that if one
7780 fails the missing data can later be reconstructed from the second host.
7786 # Operate on the pre-cache chain, so that ignored values are not even in the
7791 # Divide all received hosts in seven groups and accept all hosts in
7795 # If matched: Return and continue.
7798 # If not matched: Return and stop.
7804 =head2 Available targets
7808 =item B<notification>
7810 Creates and dispatches a notification.
7816 =item B<Message> I<String>
7818 This required option sets the message of the notification. The following
7819 placeholders will be replaced by an appropriate value:
7827 =item B<%{plugin_instance}>
7831 =item B<%{type_instance}>
7833 These placeholders are replaced by the identifier field of the same name.
7835 =item B<%{ds:>I<name>B<}>
7837 These placeholders are replaced by a (hopefully) human readable representation
7838 of the current rate of this data source. If you changed the instance name
7839 (using the B<set> or B<replace> targets, see below), it may not be possible to
7840 convert counter values to rates.
7844 Please note that these placeholders are B<case sensitive>!
7846 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
7848 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
7855 <Target "notification">
7856 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
7862 Replaces parts of the identifier using regular expressions.
7868 =item B<Host> I<Regex> I<Replacement>
7870 =item B<Plugin> I<Regex> I<Replacement>
7872 =item B<PluginInstance> I<Regex> I<Replacement>
7874 =item B<TypeInstance> I<Regex> I<Replacement>
7876 Match the appropriate field with the given regular expression I<Regex>. If the
7877 regular expression matches, that part that matches is replaced with
7878 I<Replacement>. If multiple places of the input buffer match a given regular
7879 expression, only the first occurrence will be replaced.
7881 You can specify each option multiple times to use multiple regular expressions
7889 # Replace "example.net" with "example.com"
7890 Host "\\<example.net\\>" "example.com"
7892 # Strip "www." from hostnames
7898 Sets part of the identifier of a value to a given string.
7904 =item B<Host> I<String>
7906 =item B<Plugin> I<String>
7908 =item B<PluginInstance> I<String>
7910 =item B<TypeInstance> I<String>
7912 Set the appropriate field to the given string. The strings for plugin instance
7913 and type instance may be empty, the strings for host and plugin may not be
7914 empty. It's currently not possible to set the type of a value this way.
7921 PluginInstance "coretemp"
7922 TypeInstance "core3"
7927 =head2 Backwards compatibility
7929 If you use collectd with an old configuration, i.E<nbsp>e. one without a
7930 B<Chain> block, it will behave as it used to. This is equivalent to the
7931 following configuration:
7937 If you specify a B<PostCacheChain>, the B<write> target will not be added
7938 anywhere and you will have to make sure that it is called where appropriate. We
7939 suggest to add the above snippet as default target to your "PostCache" chain.
7943 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
7959 L<collectd-exec(5)>,
7960 L<collectd-perl(5)>,
7961 L<collectd-unixsock(5)>,
7974 Florian Forster E<lt>octo@collectd.orgE<gt>