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. By default, CPU usage is reported
1211 as Jiffies, using the C<cpu> type. Two aggregations are available:
1217 Sum, per-state, over all CPUs installed in the system; and
1221 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1225 The two aggregations can be combined, leading to I<collectd> only emitting a
1226 single "active" metric for the entire system. As soon as one of these
1227 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1228 rather than Jiffies. In addition, you can request individual, per-state,
1229 per-CPU metrics to be reported as percentage.
1231 The following configuration options are available:
1235 =item B<ReportByState> B<true>|B<false>
1237 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1239 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1242 =item B<ReportByCpu> B<true>|B<false>
1244 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1245 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1246 global sum of CPU states is emitted.
1248 =item B<ValuesPercentage> B<false>|B<true>
1250 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1251 are set to B<true>. In this case, by default, metrics will be reported as
1252 Jiffies. By setting this option to B<true>, you can request percentage values
1253 in the un-aggregated (per-CPU, per-state) mode as well.
1257 =head2 Plugin C<cpufreq>
1259 This plugin doesn't have any options. It reads
1260 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1261 installed) to get the current CPU frequency. If this file does not exist make
1262 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1263 installed and an "cpu governor" (that's a kernel module) is loaded.
1265 =head2 Plugin C<csv>
1269 =item B<DataDir> I<Directory>
1271 Set the directory to store CSV-files under. Per default CSV-files are generated
1272 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1273 The special strings B<stdout> and B<stderr> can be used to write to the standard
1274 output and standard error channels, respectively. This, of course, only makes
1275 much sense when collectd is running in foreground- or non-daemon-mode.
1277 =item B<StoreRates> B<true|false>
1279 If set to B<true>, convert counter values to rates. If set to B<false> (the
1280 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1285 =head2 Plugin C<curl>
1287 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1288 and the match infrastructure (the same code used by the tail plugin) to use
1289 regular expressions with the received data.
1291 The following example will read the current value of AMD stock from Google's
1292 finance page and dispatch the value to collectd.
1295 <Page "stock_quotes">
1296 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1302 CACert "/path/to/ca.crt"
1303 Header "X-Custom-Header: foobar"
1306 MeasureResponseTime false
1307 MeasureResponseCode false
1310 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1311 DSType "GaugeAverage"
1312 # Note: `stock_value' is not a standard type.
1319 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1320 a web page and one or more "matches" to be performed on the returned data. The
1321 string argument to the B<Page> block is used as plugin instance.
1323 The following options are valid within B<Page> blocks:
1329 URL of the web site to retrieve. Since a regular expression will be used to
1330 extract information from this data, non-binary data is a big plus here ;)
1332 =item B<User> I<Name>
1334 Username to use if authorization is required to read the page.
1336 =item B<Password> I<Password>
1338 Password to use if authorization is required to read the page.
1340 =item B<Digest> B<true>|B<false>
1342 Enable HTTP digest authentication.
1344 =item B<VerifyPeer> B<true>|B<false>
1346 Enable or disable peer SSL certificate verification. See
1347 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1349 =item B<VerifyHost> B<true>|B<false>
1351 Enable or disable peer host name verification. If enabled, the plugin checks if
1352 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1353 matches the host name provided by the B<URL> option. If this identity check
1354 fails, the connection is aborted. Obviously, only works when connecting to a
1355 SSL enabled server. Enabled by default.
1357 =item B<CACert> I<file>
1359 File that holds one or more SSL certificates. If you want to use HTTPS you will
1360 possibly need this option. What CA certificates come bundled with C<libcurl>
1361 and are checked by default depends on the distribution you use.
1363 =item B<Header> I<Header>
1365 A HTTP header to add to the request. Multiple headers are added if this option
1366 is specified more than once.
1368 =item B<Post> I<Body>
1370 Specifies that the HTTP operation should be a POST instead of a GET. The
1371 complete data to be posted is given as the argument. This option will usually
1372 need to be accompanied by a B<Header> option to set an appropriate
1373 C<Content-Type> for the post body (e.g. to
1374 C<application/x-www-form-urlencoded>).
1376 =item B<MeasureResponseTime> B<true>|B<false>
1378 Measure response time for the request. If this setting is enabled, B<Match>
1379 blocks (see below) are optional. Disabled by default.
1381 =item B<MeasureResponseCode> B<true>|B<false>
1383 Measure response code for the request. If this setting is enabled, B<Match>
1384 blocks (see below) are optional. Disabled by default.
1386 =item B<E<lt>MatchE<gt>>
1388 One or more B<Match> blocks that define how to match information in the data
1389 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1390 used by the C<tail> plugin, so please see the documentation of the C<tail>
1391 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1392 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1397 =head2 Plugin C<curl_json>
1399 The B<curl_json plugin> collects values from JSON data to be parsed by
1400 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) retrieved via
1401 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1402 unix socket. The former can be used, for example, to collect values
1403 from CouchDB documents (which are stored JSON notation), and the
1404 latter to collect values from a uWSGI stats socket.
1406 The following example will collect several values from the built-in
1407 C<_stats> runtime statistics module of I<CouchDB>
1408 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1411 <URL "http://localhost:5984/_stats">
1413 <Key "httpd/requests/count">
1414 Type "http_requests"
1417 <Key "httpd_request_methods/*/count">
1418 Type "http_request_methods"
1421 <Key "httpd_status_codes/*/count">
1422 Type "http_response_codes"
1427 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1430 <Sock "/var/run/uwsgi.stats.sock">
1432 <Key "workers/*/requests">
1433 Type "http_requests"
1436 <Key "workers/*/apps/*/requests">
1437 Type "http_requests"
1442 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1443 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1444 blocks defining a unix socket to read JSON from directly. Each of
1445 these blocks may have one or more B<Key> blocks.
1447 The B<Key> string argument must be in a path format. Each component is
1448 used to match the key from a JSON map or the index of an JSON
1449 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1450 values for all map keys or array indices will be collectd.
1452 The following options are valid within B<URL> blocks:
1456 =item B<Instance> I<Instance>
1458 Sets the plugin instance to I<Instance>.
1460 =item B<Interval> I<Interval>
1462 Sets the interval (in seconds) in which the values will be collected from this
1463 URL. By default the global B<Interval> setting will be used.
1465 =item B<User> I<Name>
1467 =item B<Password> I<Password>
1469 =item B<Digest> B<true>|B<false>
1471 =item B<VerifyPeer> B<true>|B<false>
1473 =item B<VerifyHost> B<true>|B<false>
1475 =item B<CACert> I<file>
1477 =item B<Header> I<Header>
1479 =item B<Post> I<Body>
1481 These options behave exactly equivalent to the appropriate options of the
1482 I<cURL> plugin. Please see there for a detailed description.
1486 The following options are valid within B<Key> blocks:
1490 =item B<Type> I<Type>
1492 Sets the type used to dispatch the values to the daemon. Detailed information
1493 about types and their configuration can be found in L<types.db(5)>. This
1494 option is mandatory.
1496 =item B<Instance> I<Instance>
1498 Type-instance to use. Defaults to the current map key or current string array element value.
1502 =head2 Plugin C<curl_xml>
1504 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1505 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1508 <URL "http://localhost/stats.xml">
1510 Instance "some_instance"
1515 CACert "/path/to/ca.crt"
1516 Header "X-Custom-Header: foobar"
1519 <XPath "table[@id=\"magic_level\"]/tr">
1521 #InstancePrefix "prefix-"
1522 InstanceFrom "td[1]"
1523 ValuesFrom "td[2]/span[@class=\"level\"]"
1528 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1529 URL to be fetched using libcurl. Within each B<URL> block there are
1530 options which specify the connection parameters, for example authentication
1531 information, and one or more B<XPath> blocks.
1533 Each B<XPath> block specifies how to get one type of information. The
1534 string argument must be a valid XPath expression which returns a list
1535 of "base elements". One value is dispatched for each "base element". The
1536 I<type instance> and values are looked up using further I<XPath> expressions
1537 that should be relative to the base element.
1539 Within the B<URL> block the following options are accepted:
1543 =item B<Host> I<Name>
1545 Use I<Name> as the host name when submitting values. Defaults to the global
1548 =item B<Instance> I<Instance>
1550 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1551 empty string (no plugin instance).
1553 =item B<Namespace> I<Prefix> I<URL>
1555 If an XPath expression references namespaces, they must be specified
1556 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1557 I<URL> is the "namespace name", an URI reference uniquely identifying the
1558 namespace. The option can be repeated to register multiple namespaces.
1562 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1563 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1565 =item B<User> I<User>
1567 =item B<Password> I<Password>
1569 =item B<Digest> B<true>|B<false>
1571 =item B<VerifyPeer> B<true>|B<false>
1573 =item B<VerifyHost> B<true>|B<false>
1575 =item B<CACert> I<CA Cert File>
1577 =item B<Header> I<Header>
1579 =item B<Post> I<Body>
1581 These options behave exactly equivalent to the appropriate options of the
1582 I<cURL plugin>. Please see there for a detailed description.
1584 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1586 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1587 B<XPath> block specifies how to get one type of information. The string
1588 argument must be a valid XPath expression which returns a list of "base
1589 elements". One value is dispatched for each "base element".
1591 Within the B<XPath> block the following options are accepted:
1595 =item B<Type> I<Type>
1597 Specifies the I<Type> used for submitting patches. This determines the number
1598 of values that are required / expected and whether the strings are parsed as
1599 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1600 This option is required.
1602 =item B<InstancePrefix> I<InstancePrefix>
1604 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1605 concatenated together without any separator.
1606 This option is optional.
1608 =item B<InstanceFrom> I<InstanceFrom>
1610 Specifies a XPath expression to use for determining the I<type instance>. The
1611 XPath expression must return exactly one element. The element's value is then
1612 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1614 This value is required. As a special exception, if the "base XPath expression"
1615 (the argument to the B<XPath> block) returns exactly one argument, then this
1616 option may be omitted.
1618 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1620 Specifies one or more XPath expression to use for reading the values. The
1621 number of XPath expressions must match the number of data sources in the
1622 I<type> specified with B<Type> (see above). Each XPath expression must return
1623 exactly one element. The element's value is then parsed as a number and used as
1624 value for the appropriate value in the value list dispatched to the daemon.
1630 =head2 Plugin C<dbi>
1632 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1633 connect to various databases, execute I<SQL> statements and read back the
1634 results. I<dbi> is an acronym for "database interface" in case you were
1635 wondering about the name. You can configure how each column is to be
1636 interpreted and the plugin will generate one or more data sets from each row
1637 returned according to these rules.
1639 Because the plugin is very generic, the configuration is a little more complex
1640 than those of other plugins. It usually looks something like this:
1643 <Query "out_of_stock">
1644 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1645 # Use with MySQL 5.0.0 or later
1649 InstancePrefix "out_of_stock"
1650 InstancesFrom "category"
1654 <Database "product_information">
1656 DriverOption "host" "localhost"
1657 DriverOption "username" "collectd"
1658 DriverOption "password" "aZo6daiw"
1659 DriverOption "dbname" "prod_info"
1660 SelectDB "prod_info"
1661 Query "out_of_stock"
1665 The configuration above defines one query with one result and one database. The
1666 query is then linked to the database with the B<Query> option I<within> the
1667 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1668 and you can also use the B<Include> statement to split up the configuration
1669 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1670 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1673 The following is a complete list of options:
1675 =head3 B<Query> blocks
1677 Query blocks define I<SQL> statements and how the returned data should be
1678 interpreted. They are identified by the name that is given in the opening line
1679 of the block. Thus the name needs to be unique. Other than that, the name is
1680 not used in collectd.
1682 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1683 define which column holds which value or instance information. You can use
1684 multiple B<Result> blocks to create multiple values from one returned row. This
1685 is especially useful, when queries take a long time and sending almost the same
1686 query again and again is not desirable.
1690 <Query "environment">
1691 Statement "select station, temperature, humidity from environment"
1694 # InstancePrefix "foo"
1695 InstancesFrom "station"
1696 ValuesFrom "temperature"
1700 InstancesFrom "station"
1701 ValuesFrom "humidity"
1705 The following options are accepted:
1709 =item B<Statement> I<SQL>
1711 Sets the statement that should be executed on the server. This is B<not>
1712 interpreted by collectd, but simply passed to the database server. Therefore,
1713 the SQL dialect that's used depends on the server collectd is connected to.
1715 The query has to return at least two columns, one for the instance and one
1716 value. You cannot omit the instance, even if the statement is guaranteed to
1717 always return exactly one line. In that case, you can usually specify something
1720 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1722 (That works with MySQL but may not be valid SQL according to the spec. If you
1723 use a more strict database server, you may have to select from a dummy table or
1726 Please note that some databases, for example B<Oracle>, will fail if you
1727 include a semicolon at the end of the statement.
1729 =item B<MinVersion> I<Version>
1731 =item B<MaxVersion> I<Value>
1733 Only use this query for the specified database version. You can use these
1734 options to provide multiple queries with the same name but with a slightly
1735 different syntax. The plugin will use only those queries, where the specified
1736 minimum and maximum versions fit the version of the database in use.
1738 The database version is determined by C<dbi_conn_get_engine_version>, see the
1739 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1740 for details. Basically, each part of the version is assumed to be in the range
1741 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1742 "40102", version "5.0.42" becomes "50042".
1744 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1745 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1746 happen. Don't to it! A valid example would be something along these lines:
1757 In the above example, there are three ranges that don't overlap. The last one
1758 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1759 before "4.0.0" are not specified.
1761 =item B<Type> I<Type>
1763 The B<type> that's used for each line returned. See L<types.db(5)> for more
1764 details on how types are defined. In short: A type is a predefined layout of
1765 data and the number of values and type of values has to match the type
1768 If you specify "temperature" here, you need exactly one gauge column. If you
1769 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1772 There must be exactly one B<Type> option inside each B<Result> block.
1774 =item B<InstancePrefix> I<prefix>
1776 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1777 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1778 all strings returned in the appropriate columns are concatenated together,
1779 separated by dashes I<("-")>.
1781 =item B<InstancesFrom> I<column0> [I<column1> ...]
1783 Specifies the columns whose values will be used to create the "type-instance"
1784 for each row. If you specify more than one column, the value of all columns
1785 will be joined together with dashes I<("-")> as separation characters.
1787 The plugin itself does not check whether or not all built instances are
1788 different. It's your responsibility to assure that each is unique. This is
1789 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1790 sure that only one row is returned in this case.
1792 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1795 =item B<ValuesFrom> I<column0> [I<column1> ...]
1797 Names the columns whose content is used as the actual data for the data sets
1798 that are dispatched to the daemon. How many such columns you need is determined
1799 by the B<Type> setting above. If you specify too many or not enough columns,
1800 the plugin will complain about that and no data will be submitted to the
1803 The actual data type in the columns is not that important. The plugin will
1804 automatically cast the values to the right type if it know how to do that. So
1805 it should be able to handle integer an floating point types, as well as strings
1806 (if they include a number at the beginning).
1808 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1810 =item B<MetadataFrom> [I<column0> I<column1> ...]
1812 Names the columns whose content is used as metadata for the data sets
1813 that are dispatched to the daemon.
1815 The actual data type in the columns is not that important. The plugin will
1816 automatically cast the values to the right type if it know how to do that. So
1817 it should be able to handle integer an floating point types, as well as strings
1818 (if they include a number at the beginning).
1822 =head3 B<Database> blocks
1824 Database blocks define a connection to a database and which queries should be
1825 sent to that database. Since the used "dbi" library can handle a wide variety
1826 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1827 documentationE<nbsp>- we stick as close to the terminology used there.
1829 Each database needs a "name" as string argument in the starting tag of the
1830 block. This name will be used as "PluginInstance" in the values submitted to
1831 the daemon. Other than that, that name is not used.
1835 =item B<Driver> I<Driver>
1837 Specifies the driver to use to connect to the database. In many cases those
1838 drivers are named after the database they can connect to, but this is not a
1839 technical necessity. These drivers are sometimes referred to as "DBD",
1840 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1841 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1842 project at L<http://libdbi-drivers.sourceforge.net/>.
1844 You need to give the driver name as expected by the "dbi" library here. You
1845 should be able to find that in the documentation for each driver. If you
1846 mistype the driver name, the plugin will dump a list of all known driver names
1849 =item B<DriverOption> I<Key> I<Value>
1851 Sets driver-specific options. What option a driver supports can be found in the
1852 documentation for each driver, somewhere at
1853 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1854 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1856 DBDs can register two types of options: String options and numeric options. The
1857 plugin will use the C<dbi_conn_set_option> function when the configuration
1858 provides a string and the C<dbi_conn_require_option_numeric> function when the
1859 configuration provides a number. So these two lines will actually result in
1860 different calls being used:
1862 DriverOption "Port" 1234 # numeric
1863 DriverOption "Port" "1234" # string
1865 Unfortunately, drivers are not too keen to report errors when an unknown option
1866 is passed to them, so invalid settings here may go unnoticed. This is not the
1867 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1868 the driver. If a driver complains about an option, the plugin will dump a
1869 complete list of all options understood by that driver to the log. There is no
1870 way to programatically find out if an option expects a string or a numeric
1871 argument, so you will have to refer to the appropriate DBD's documentation to
1872 find this out. Sorry.
1874 =item B<SelectDB> I<Database>
1876 In some cases, the database name you connect with is not the database name you
1877 want to use for querying data. If this option is set, the plugin will "select"
1878 (switch to) that database after the connection is established.
1880 =item B<Query> I<QueryName>
1882 Associates the query named I<QueryName> with this database connection. The
1883 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1884 blocks you want to refer to must be placed above the database block you want to
1887 =item B<Host> I<Hostname>
1889 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
1890 values. Defaults to the global hostname setting.
1898 =item B<Device> I<Device>
1900 Select partitions based on the devicename.
1902 =item B<MountPoint> I<Directory>
1904 Select partitions based on the mountpoint.
1906 =item B<FSType> I<FSType>
1908 Select partitions based on the filesystem type.
1910 =item B<IgnoreSelected> B<true>|B<false>
1912 Invert the selection: If set to true, all partitions B<except> the ones that
1913 match any one of the criteria are collected. By default only selected
1914 partitions are collected if a selection is made. If no selection is configured
1915 at all, B<all> partitions are selected.
1917 =item B<ReportByDevice> B<true>|B<false>
1919 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1920 (the default), it will report a disk as "root", but with it I<true>, it will be
1921 "sda1" (or whichever).
1923 =item B<ReportInodes> B<true>|B<false>
1925 Enables or disables reporting of free, reserved and used inodes. Defaults to
1926 inode collection being disabled.
1928 Enable this option if inodes are a scarce resource for you, usually because
1929 many small files are stored on the disk. This is a usual scenario for mail
1930 transfer agents and web caches.
1932 =item B<ValuesAbsolute> B<true>|B<false>
1934 Enables or disables reporting of free and used disk space in 1K-blocks.
1935 Defaults to B<true>.
1937 =item B<ValuesPercentage> B<false>|B<true>
1939 Enables or disables reporting of free and used disk space in percentage.
1940 Defaults to B<false>.
1942 This is useful for deploying I<collectd> on the cloud, where machines with
1943 different disk size may exist. Then it is more practical to configure
1944 thresholds based on relative disk size.
1948 =head2 Plugin C<disk>
1950 The C<disk> plugin collects information about the usage of physical disks and
1951 logical disks (partitions). Values collected are the number of octets written
1952 to and read from a disk or partition, the number of read/write operations
1953 issued to the disk and a rather complex "time" it took for these commands to be
1956 Using the following two options you can ignore some disks or configure the
1957 collection only of specific disks.
1961 =item B<Disk> I<Name>
1963 Select the disk I<Name>. Whether it is collected or ignored depends on the
1964 B<IgnoreSelected> setting, see below. As with other plugins that use the
1965 daemon's ignorelist functionality, a string that starts and ends with a slash
1966 is interpreted as a regular expression. Examples:
1971 =item B<IgnoreSelected> B<true>|B<false>
1973 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1974 statements, are ignored or if all other disks are ignored. The behavior
1975 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1976 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1977 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1978 is set to B<true>, all disks are collected B<except> the ones matched.
1980 =item B<UseBSDName> B<true>|B<false>
1982 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
1983 default major/minor numbers. Requires collectd to be built with Apple's
1986 =item B<UdevNameAttr> I<Attribute>
1988 Attempt to override disk instance name with the value of a specified udev
1989 attribute when built with B<libudev>. If the attribute is not defined for the
1990 given device, the default name is used. Example:
1992 UdevNameAttr "DM_NAME"
1996 =head2 Plugin C<dns>
2000 =item B<Interface> I<Interface>
2002 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2003 option sets the interface that should be used. If this option is not set, or
2004 set to "any", the plugin will try to get packets from B<all> interfaces. This
2005 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2007 =item B<IgnoreSource> I<IP-address>
2009 Ignore packets that originate from this address.
2011 =item B<SelectNumericQueryTypes> B<true>|B<false>
2013 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2017 =head2 Plugin C<email>
2021 =item B<SocketFile> I<Path>
2023 Sets the socket-file which is to be created.
2025 =item B<SocketGroup> I<Group>
2027 If running as root change the group of the UNIX-socket after it has been
2028 created. Defaults to B<collectd>.
2030 =item B<SocketPerms> I<Permissions>
2032 Change the file permissions of the UNIX-socket after it has been created. The
2033 permissions must be given as a numeric, octal value as you would pass to
2034 L<chmod(1)>. Defaults to B<0770>.
2036 =item B<MaxConns> I<Number>
2038 Sets the maximum number of connections that can be handled in parallel. Since
2039 this many threads will be started immediately setting this to a very high
2040 value will waste valuable resources. Defaults to B<5> and will be forced to be
2041 at most B<16384> to prevent typos and dumb mistakes.
2045 =head2 Plugin C<ethstat>
2047 The I<ethstat plugin> collects information about network interface cards (NICs)
2048 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2054 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2055 Map "multicast" "if_multicast"
2062 =item B<Interface> I<Name>
2064 Collect statistical information about interface I<Name>.
2066 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2068 By default, the plugin will submit values as type C<derive> and I<type
2069 instance> set to I<Name>, the name of the metric as reported by the driver. If
2070 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2071 I<TypeInstance> will be used.
2073 =item B<MappedOnly> B<true>|B<false>
2075 When set to B<true>, only metrics that can be mapped to to a I<type> will be
2076 collected, all other metrics will be ignored. Defaults to B<false>.
2080 =head2 Plugin C<exec>
2082 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2083 contains valuable information on when the executable is executed and the
2084 output that is expected from it.
2088 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2090 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2092 Execute the executable I<Executable> as user I<User>. If the user name is
2093 followed by a colon and a group name, the effective group is set to that group.
2094 The real group and saved-set group will be set to the default group of that
2095 user. If no group is given the effective group ID will be the same as the real
2098 Please note that in order to change the user and/or group the daemon needs
2099 superuser privileges. If the daemon is run as an unprivileged user you must
2100 specify the same user/group here. If the daemon is run with superuser
2101 privileges, you must supply a non-root user here.
2103 The executable may be followed by optional arguments that are passed to the
2104 program. Please note that due to the configuration parsing numbers and boolean
2105 values may be changed. If you want to be absolutely sure that something is
2106 passed as-is please enclose it in quotes.
2108 The B<Exec> and B<NotificationExec> statements change the semantics of the
2109 programs executed, i.E<nbsp>e. the data passed to them and the response
2110 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2114 =head2 Plugin C<filecount>
2116 The C<filecount> plugin counts the number of files in a certain directory (and
2117 its subdirectories) and their combined size. The configuration is very straight
2120 <Plugin "filecount">
2121 <Directory "/var/qmail/queue/mess">
2122 Instance "qmail-message"
2124 <Directory "/var/qmail/queue/todo">
2125 Instance "qmail-todo"
2127 <Directory "/var/lib/php5">
2128 Instance "php5-sessions"
2133 The example above counts the number of files in QMail's queue directories and
2134 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2135 QMail has not yet looked at, the "message" queue holds the messages that were
2136 classified into "local" and "remote".
2138 As you can see, the configuration consists of one or more C<Directory> blocks,
2139 each of which specifies a directory in which to count the files. Within those
2140 blocks, the following options are recognized:
2144 =item B<Instance> I<Instance>
2146 Sets the plugin instance to I<Instance>. That instance name must be unique, but
2147 it's your responsibility, the plugin doesn't check for that. If not given, the
2148 instance is set to the directory name with all slashes replaced by underscores
2149 and all leading underscores removed.
2151 =item B<Name> I<Pattern>
2153 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2154 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2155 against the pattern, not the entire path. In case this makes it easier for you:
2156 This option has been named after the B<-name> parameter to L<find(1)>.
2158 =item B<MTime> I<Age>
2160 Count only files of a specific age: If I<Age> is greater than zero, only files
2161 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2162 a negative number, this is inversed. For example, if B<-60> is specified, only
2163 files that have been modified in the last minute will be counted.
2165 The number can also be followed by a "multiplier" to easily specify a larger
2166 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2167 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2168 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2169 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2170 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2173 =item B<Size> I<Size>
2175 Count only files of a specific size. When I<Size> is a positive number, only
2176 files that are at least this big are counted. If I<Size> is a negative number,
2177 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2178 I<Size> are counted.
2180 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2181 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2182 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2183 note that there are 1000 bytes in a kilobyte, not 1024.
2185 =item B<Recursive> I<true>|I<false>
2187 Controls whether or not to recurse into subdirectories. Enabled by default.
2189 =item B<IncludeHidden> I<true>|I<false>
2191 Controls whether or not to include "hidden" files and directories in the count.
2192 "Hidden" files and directories are those, whose name begins with a dot.
2193 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2197 =head2 Plugin C<GenericJMX>
2199 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2200 L<collectd-java(5)>.
2202 =head2 Plugin C<gmond>
2204 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2205 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2206 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2211 MCReceiveFrom "239.2.11.71" "8649"
2212 <Metric "swap_total">
2214 TypeInstance "total"
2217 <Metric "swap_free">
2224 The following metrics are built-in:
2230 load_one, load_five, load_fifteen
2234 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2238 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2250 Available configuration options:
2254 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2256 Sets sets the multicast group and UDP port to which to subscribe.
2258 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2260 =item E<lt>B<Metric> I<Name>E<gt>
2262 These blocks add a new metric conversion to the internal table. I<Name>, the
2263 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2267 =item B<Type> I<Type>
2269 Type to map this metric to. Required.
2271 =item B<TypeInstance> I<Instance>
2273 Type-instance to use. Optional.
2275 =item B<DataSource> I<Name>
2277 Data source to map this metric to. If the configured type has exactly one data
2278 source, this is optional. Otherwise the option is required.
2284 =head2 Plugin C<hddtemp>
2286 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
2287 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
2288 default values, see below. C<hddtemp> has to be running to work correctly. If
2289 C<hddtemp> is not running timeouts may appear which may interfere with other
2292 The B<hddtemp> homepage can be found at
2293 L<http://www.guzu.net/linux/hddtemp.php>.
2297 =item B<Host> I<Hostname>
2299 Hostname to connect to. Defaults to B<127.0.0.1>.
2301 =item B<Port> I<Port>
2303 TCP-Port to connect to. Defaults to B<7634>.
2307 =head2 Plugin C<interface>
2311 =item B<Interface> I<Interface>
2313 Select this interface. By default these interfaces will then be collected. For
2314 a more detailed description see B<IgnoreSelected> below.
2316 =item B<IgnoreSelected> I<true>|I<false>
2318 If no configuration if given, the B<traffic>-plugin will collect data from
2319 all interfaces. This may not be practical, especially for loopback- and
2320 similar interfaces. Thus, you can use the B<Interface>-option to pick the
2321 interfaces you're interested in. Sometimes, however, it's easier/preferred
2322 to collect all interfaces I<except> a few ones. This option enables you to
2323 do that: By setting B<IgnoreSelected> to I<true> the effect of
2324 B<Interface> is inverted: All selected interfaces are ignored and all
2325 other interfaces are collected.
2329 =head2 Plugin C<ipmi>
2333 =item B<Sensor> I<Sensor>
2335 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2337 =item B<IgnoreSelected> I<true>|I<false>
2339 If no configuration if given, the B<ipmi> plugin will collect data from all
2340 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2341 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2342 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2343 all other sensors are collected.
2345 =item B<NotifySensorAdd> I<true>|I<false>
2347 If a sensor appears after initialization time of a minute a notification
2350 =item B<NotifySensorRemove> I<true>|I<false>
2352 If a sensor disappears a notification is sent.
2354 =item B<NotifySensorNotPresent> I<true>|I<false>
2356 If you have for example dual power supply and one of them is (un)plugged then
2357 a notification is sent.
2361 =head2 Plugin C<iptables>
2365 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2367 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
2368 will collect the counters of all rules which have a comment-match. The comment
2369 is then used as type-instance.
2371 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2372 the I<n>th rule will be collected. Again, the comment (or the number) will be
2373 used as the type-instance.
2375 If I<Name> is supplied, it will be used as the type-instance instead of the
2376 comment or the number.
2380 =head2 Plugin C<irq>
2386 Select this irq. By default these irqs will then be collected. For a more
2387 detailed description see B<IgnoreSelected> below.
2389 =item B<IgnoreSelected> I<true>|I<false>
2391 If no configuration if given, the B<irq>-plugin will collect data from all
2392 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2393 can use the B<Irq>-option to pick the interrupt you're interested in.
2394 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2395 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2396 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2397 and all other interrupts are collected.
2401 =head2 Plugin C<java>
2403 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2404 This section only discusses the syntax and semantic of the configuration
2405 options. For more in-depth information on the I<Java> plugin, please read
2406 L<collectd-java(5)>.
2411 JVMArg "-verbose:jni"
2412 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2413 LoadPlugin "org.collectd.java.Foobar"
2414 <Plugin "org.collectd.java.Foobar">
2415 # To be parsed by the plugin
2419 Available configuration options:
2423 =item B<JVMArg> I<Argument>
2425 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2426 exactly the way the arguments to the I<java> binary on the command line work.
2427 Execute C<javaE<nbsp>--help> for details.
2429 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2430 any other options! When another option is found, the JVM will be started and
2431 later options will have to be ignored!
2433 =item B<LoadPlugin> I<JavaClass>
2435 Instantiates a new I<JavaClass> object. The constructor of this object very
2436 likely then registers one or more callback methods with the server.
2438 See L<collectd-java(5)> for details.
2440 When the first such option is found, the virtual machine (JVM) is created. This
2441 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2442 B<LoadPlugin> options!
2444 =item B<Plugin> I<Name>
2446 The entire block is passed to the Java plugin as an
2447 I<org.collectd.api.OConfigItem> object.
2449 For this to work, the plugin has to register a configuration callback first,
2450 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2451 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2452 depends on the (Java) plugin registering the callback and is completely
2453 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2457 =head2 Plugin C<libvirt>
2459 This plugin allows CPU, disk and network load to be collected for virtualized
2460 guests on the machine. This means that these characteristics can be collected
2461 for guest systems without installing any software on them - collectd only runs
2462 on the hosting system. The statistics are collected through libvirt
2463 (L<http://libvirt.org/>).
2465 Only I<Connection> is required.
2469 =item B<Connection> I<uri>
2471 Connect to the hypervisor given by I<uri>. For example if using Xen use:
2473 Connection "xen:///"
2475 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
2477 =item B<RefreshInterval> I<seconds>
2479 Refresh the list of domains and devices every I<seconds>. The default is 60
2480 seconds. Setting this to be the same or smaller than the I<Interval> will cause
2481 the list of domains and devices to be refreshed on every iteration.
2483 Refreshing the devices in particular is quite a costly operation, so if your
2484 virtualization setup is static you might consider increasing this. If this
2485 option is set to 0, refreshing is disabled completely.
2487 =item B<Domain> I<name>
2489 =item B<BlockDevice> I<name:dev>
2491 =item B<InterfaceDevice> I<name:dev>
2493 =item B<IgnoreSelected> I<true>|I<false>
2495 Select which domains and devices are collected.
2497 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
2498 disk/network devices are collected.
2500 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
2501 domains and disk/network devices are ignored, while the rest are collected.
2503 The domain name and device names may use a regular expression, if the name is
2504 surrounded by I</.../> and collectd was compiled with support for regexps.
2506 The default is to collect statistics for all domains and all their devices.
2510 BlockDevice "/:hdb/"
2511 IgnoreSelected "true"
2513 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
2516 =item B<HostnameFormat> B<name|uuid|hostname|...>
2518 When the libvirt plugin logs data, it sets the hostname of the collected data
2519 according to this setting. The default is to use the guest name as provided by
2520 the hypervisor, which is equal to setting B<name>.
2522 B<uuid> means use the guest's UUID. This is useful if you want to track the
2523 same guest across migrations.
2525 B<hostname> means to use the global B<Hostname> setting, which is probably not
2526 useful on its own because all guests will appear to have the same name.
2528 You can also specify combinations of these fields. For example B<name uuid>
2529 means to concatenate the guest name and UUID (with a literal colon character
2530 between, thus I<"foo:1234-1234-1234-1234">).
2532 =item B<InterfaceFormat> B<name>|B<address>
2534 When the libvirt plugin logs interface data, it sets the name of the collected
2535 data according to this setting. The default is to use the path as provided by
2536 the hypervisor (the "dev" property of the target node), which is equal to
2539 B<address> means use the interface's mac address. This is useful since the
2540 interface path might change between reboots of a guest or across migrations.
2542 =item B<PluginInstanceFormat> B<name|uuid>
2544 When the libvirt plugin logs data, it sets the plugin_instance of the collected
2545 data according to this setting. The default is to use the guest name as provided
2546 by the hypervisor, which is equal to setting B<name>.
2548 B<uuid> means use the guest's UUID.
2552 =head2 Plugin C<load>
2554 The I<Load plugin> collects the system load. These numbers give a rough overview
2555 over the utilization of a machine. The system load is defined as the number of
2556 runnable tasks in the run-queue and is provided by many operating systems as a
2557 one, five or fifteen minute average.
2559 The following configuration options are available:
2563 =item B<ReportRelative> B<false>|B<true>
2565 When enabled, system load divided by number of available CPU cores is reported
2566 for intervals 1 min, 5 min and 15 min. Defaults to false.
2571 =head2 Plugin C<logfile>
2575 =item B<LogLevel> B<debug|info|notice|warning|err>
2577 Sets the log-level. If, for example, set to B<notice>, then all events with
2578 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2580 Please note that B<debug> is only available if collectd has been compiled with
2583 =item B<File> I<File>
2585 Sets the file to write log messages to. The special strings B<stdout> and
2586 B<stderr> can be used to write to the standard output and standard error
2587 channels, respectively. This, of course, only makes much sense when I<collectd>
2588 is running in foreground- or non-daemon-mode.
2590 =item B<Timestamp> B<true>|B<false>
2592 Prefix all lines printed by the current time. Defaults to B<true>.
2594 =item B<PrintSeverity> B<true>|B<false>
2596 When enabled, all lines are prefixed by the severity of the log message, for
2597 example "warning". Defaults to B<false>.
2601 B<Note>: There is no need to notify the daemon after moving or removing the
2602 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2603 for each line it writes.
2605 =head2 Plugin C<log_logstash>
2607 The I<log logstash plugin> behaves like the logfile plugin but formats
2608 messages as JSON events for logstash to parse and input.
2612 =item B<LogLevel> B<debug|info|notice|warning|err>
2614 Sets the log-level. If, for example, set to B<notice>, then all events with
2615 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2617 Please note that B<debug> is only available if collectd has been compiled with
2620 =item B<File> I<File>
2622 Sets the file to write log messages to. The special strings B<stdout> and
2623 B<stderr> can be used to write to the standard output and standard error
2624 channels, respectively. This, of course, only makes much sense when I<collectd>
2625 is running in foreground- or non-daemon-mode.
2629 B<Note>: There is no need to notify the daemon after moving or removing the
2630 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2631 for each line it writes.
2633 =head2 Plugin C<lpar>
2635 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2636 virtualization technique for IBM POWER processors. It takes into account CPU
2637 time stolen from or donated to a partition, in addition to the usual user,
2638 system, I/O statistics.
2640 The following configuration options are available:
2644 =item B<CpuPoolStats> B<false>|B<true>
2646 When enabled, statistics about the processor pool are read, too. The partition
2647 needs to have pool authority in order to be able to acquire this information.
2650 =item B<ReportBySerial> B<false>|B<true>
2652 If enabled, the serial of the physical machine the partition is currently
2653 running on is reported as I<hostname> and the logical hostname of the machine
2654 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2655 used (just like other plugins) and the I<plugin instance> will be empty.
2660 =head2 Plugin C<mbmon>
2662 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2664 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2665 B<Host> and B<Port> options can be used to change these values, see below.
2666 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2667 timeouts may appear which may interfere with other statistics..
2669 C<mbmon> must be run with the -r option ("print TAG and Value format");
2670 Debian's F</etc/init.d/mbmon> script already does this, other people
2671 will need to ensure that this is the case.
2675 =item B<Host> I<Hostname>
2677 Hostname to connect to. Defaults to B<127.0.0.1>.
2679 =item B<Port> I<Port>
2681 TCP-Port to connect to. Defaults to B<411>.
2687 The C<md plugin> collects information from Linux Software-RAID devices (md).
2689 All reported values are of the type C<md_disks>. Reported type instances are
2690 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2691 I<missing> (physically absent) disks.
2695 =item B<Device> I<Device>
2697 Select md devices based on device name. The I<device name> is the basename of
2698 the device, i.e. the name of the block device without the leading C</dev/>.
2699 See B<IgnoreSelected> for more details.
2701 =item B<IgnoreSelected> B<true>|B<false>
2703 Invert device selection: If set to B<true>, all md devices B<except> those
2704 listed using B<Device> are collected. If B<false> (the default), only those
2705 listed are collected. If no configuration is given, the B<md> plugin will
2706 collect data from all md devices.
2710 =head2 Plugin C<memcachec>
2712 The C<memcachec plugin> connects to a memcached server, queries one or more
2713 given I<pages> and parses the returned data according to user specification.
2714 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2717 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2718 library. Please note that there is another library with a very similar name,
2719 libmemcache (notice the missing `d'), which is not applicable.
2721 Synopsis of the configuration:
2723 <Plugin "memcachec">
2724 <Page "plugin_instance">
2728 Regex "(\\d+) bytes sent"
2731 Instance "type_instance"
2736 The configuration options are:
2740 =item E<lt>B<Page> I<Name>E<gt>
2742 Each B<Page> block defines one I<page> to be queried from the memcached server.
2743 The block requires one string argument which is used as I<plugin instance>.
2745 =item B<Server> I<Address>
2747 Sets the server address to connect to when querying the page. Must be inside a
2752 When connected to the memcached server, asks for the page I<Key>.
2754 =item E<lt>B<Match>E<gt>
2756 Match blocks define which strings to look for and how matches substrings are
2757 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2761 =head2 Plugin C<memcached>
2763 The B<memcached plugin> connects to a memcached server and queries statistics
2764 about cache utilization, memory and bandwidth used.
2765 L<http://www.danga.com/memcached/>
2767 <Plugin "memcached">
2769 Host "memcache.example.com"
2774 The plugin configuration consists of one or more B<Instance> blocks which
2775 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2776 following options are allowed:
2780 =item B<Host> I<Hostname>
2782 Hostname to connect to. Defaults to B<127.0.0.1>.
2784 =item B<Port> I<Port>
2786 TCP-Port to connect to. Defaults to B<11211>.
2788 =item B<Socket> I<Path>
2790 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2791 setting is given, the B<Host> and B<Port> settings are ignored.
2795 =head2 Plugin C<mic>
2797 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2798 Intel's Many Integrated Core (MIC) systems.
2807 ShowTemperatures true
2810 IgnoreSelectedTemperature true
2815 IgnoreSelectedPower true
2818 The following options are valid inside the B<PluginE<nbsp>mic> block:
2822 =item B<ShowCPU> B<true>|B<false>
2824 If enabled (the default) a sum of the CPU usage across all cores is reported.
2826 =item B<ShowCPUCores> B<true>|B<false>
2828 If enabled (the default) per-core CPU usage is reported.
2830 =item B<ShowMemory> B<true>|B<false>
2832 If enabled (the default) the physical memory usage of the MIC system is
2835 =item B<ShowTemperatures> B<true>|B<false>
2837 If enabled (the default) various temperatures of the MIC system are reported.
2839 =item B<Temperature> I<Name>
2841 This option controls which temperatures are being reported. Whether matching
2842 temperatures are being ignored or I<only> matching temperatures are reported
2843 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2844 temperatures are reported.
2846 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2848 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2849 (the default) only temperatures matching a B<Temperature> option are reported
2850 or, if no B<Temperature> option is specified, all temperatures are reported. If
2851 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2854 Known temperature names are:
2888 =item B<ShowPower> B<true>|B<false>
2890 If enabled (the default) various temperatures of the MIC system are reported.
2892 =item B<Power> I<Name>
2894 This option controls which power readings are being reported. Whether matching
2895 power readings are being ignored or I<only> matching power readings are reported
2896 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
2897 power readings are reported.
2899 =item B<IgnoreSelectedPower> B<false>|B<true>
2901 Controls the behavior of the B<Power> setting above. If set to B<false>
2902 (the default) only power readings matching a B<Power> option are reported
2903 or, if no B<Power> option is specified, all power readings are reported. If
2904 set to B<true>, matching power readings are I<ignored> and all other power readings
2907 Known power names are:
2913 Total power utilization averaged over Time Window 0 (uWatts).
2917 Total power utilization averaged over Time Window 0 (uWatts).
2921 Instantaneous power (uWatts).
2925 Max instantaneous power (uWatts).
2929 PCI-E connector power (uWatts).
2933 2x3 connector power (uWatts).
2937 2x4 connector power (uWatts).
2945 Uncore rail (uVolts).
2949 Memory subsystem rail (uVolts).
2955 =head2 Plugin C<memory>
2957 The I<memory plugin> provides the following configuration options:
2961 =item B<ValuesAbsolute> B<true>|B<false>
2963 Enables or disables reporting of physical memory usage in absolute numbers,
2964 i.e. bytes. Defaults to B<true>.
2966 =item B<ValuesPercentage> B<false>|B<true>
2968 Enables or disables reporting of physical memory usage in percentages, e.g.
2969 percent of physical memory used. Defaults to B<false>.
2971 This is useful for deploying I<collectd> in a heterogeneous environment in
2972 which the sizes of physical memory vary.
2976 =head2 Plugin C<modbus>
2978 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
2979 register values. It supports reading single registers (unsigned 16E<nbsp>bit
2980 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2981 values (two registers interpreted as IEEE floats in big endian notation).
2985 <Data "voltage-input-1">
2992 <Data "voltage-input-2">
2999 <Host "modbus.example.com">
3000 Address "192.168.0.42"
3005 Instance "power-supply"
3006 Collect "voltage-input-1"
3007 Collect "voltage-input-2"
3013 =item E<lt>B<Data> I<Name>E<gt> blocks
3015 Data blocks define a mapping between register numbers and the "types" used by
3018 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
3022 =item B<RegisterBase> I<Number>
3024 Configures the base register to read from the device. If the option
3025 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
3026 register will be read (the register number is increased by one).
3028 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
3030 Specifies what kind of data is returned by the device. If the type is B<Int32>,
3031 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
3032 combined into one value. Defaults to B<Uint16>.
3034 =item B<Type> I<Type>
3036 Specifies the "type" (data set) to use when dispatching the value to
3037 I<collectd>. Currently, only data sets with exactly one data source are
3040 =item B<Instance> I<Instance>
3042 Sets the type instance to use when dispatching the value to I<collectd>. If
3043 unset, an empty string (no type instance) is used.
3047 =item E<lt>B<Host> I<Name>E<gt> blocks
3049 Host blocks are used to specify to which hosts to connect and what data to read
3050 from their "slaves". The string argument I<Name> is used as hostname when
3051 dispatching the values to I<collectd>.
3053 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
3057 =item B<Address> I<Hostname>
3059 Specifies the node name (the actual network address) used to connect to the
3060 host. This may be an IP address or a hostname. Please note that the used
3061 I<libmodbus> library only supports IPv4 at the moment.
3063 =item B<Port> I<Service>
3065 Specifies the port used to connect to the host. The port can either be given as
3066 a number or as a service name. Please note that the I<Service> argument must be
3067 a string, even if ports are given in their numerical form. Defaults to "502".
3069 =item B<Interval> I<Interval>
3071 Sets the interval (in seconds) in which the values will be collected from this
3072 host. By default the global B<Interval> setting will be used.
3074 =item E<lt>B<Slave> I<ID>E<gt>
3076 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
3077 is used to specify which device should be addressed. For each device you want
3078 to query, one B<Slave> block must be given.
3080 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
3084 =item B<Instance> I<Instance>
3086 Specify the plugin instance to use when dispatching the values to I<collectd>.
3087 By default "slave_I<ID>" is used.
3089 =item B<Collect> I<DataName>
3091 Specifies which data to retrieve from the device. I<DataName> must be the same
3092 string as the I<Name> argument passed to a B<Data> block. You can specify this
3093 option multiple times to collect more than one value from a slave. At least one
3094 B<Collect> option is mandatory.
3102 =head2 Plugin C<mysql>
3104 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
3105 one or more databases when started and keeps the connection up as long as
3106 possible. When the connection is interrupted for whatever reason it will try
3107 to re-connect. The plugin will complain loudly in case anything goes wrong.
3109 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
3110 and collects information about MySQL network traffic, executed statements,
3111 requests, the query cache and threads by evaluating the
3112 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
3113 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
3114 Status Variables> for an explanation of these values.
3116 Optionally, master and slave statistics may be collected in a MySQL
3117 replication setup. In that case, information about the synchronization state
3118 of the nodes are collected by evaluating the C<Position> return value of the
3119 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
3120 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
3121 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
3122 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
3123 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
3140 Socket "/var/run/mysql/mysqld.sock"
3142 SlaveNotifications true
3146 A B<Database> block defines one connection to a MySQL database. It accepts a
3147 single argument which specifies the name of the database. None of the other
3148 options are required. MySQL will use default values as documented in the
3149 section "mysql_real_connect()" in the B<MySQL reference manual>.
3153 =item B<Alias> I<Alias>
3155 Alias to use as sender instead of hostname when reporting. This may be useful
3156 when having cryptic hostnames.
3158 =item B<Host> I<Hostname>
3160 Hostname of the database server. Defaults to B<localhost>.
3162 =item B<User> I<Username>
3164 Username to use when connecting to the database. The user does not have to be
3165 granted any privileges (which is synonym to granting the C<USAGE> privilege),
3166 unless you want to collectd replication statistics (see B<MasterStats> and
3167 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
3168 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
3170 =item B<Password> I<Password>
3172 Password needed to log into the database.
3174 =item B<Database> I<Database>
3176 Select this database. Defaults to I<no database> which is a perfectly reasonable
3177 option for what this plugin does.
3179 =item B<Port> I<Port>
3181 TCP-port to connect to. The port must be specified in its numeric form, but it
3182 must be passed as a string nonetheless. For example:
3186 If B<Host> is set to B<localhost> (the default), this setting has no effect.
3187 See the documentation for the C<mysql_real_connect> function for details.
3189 =item B<Socket> I<Socket>
3191 Specifies the path to the UNIX domain socket of the MySQL server. This option
3192 only has any effect, if B<Host> is set to B<localhost> (the default).
3193 Otherwise, use the B<Port> option above. See the documentation for the
3194 C<mysql_real_connect> function for details.
3196 =item B<InnodbStats> I<true|false>
3198 If enabled, metrics about the InnoDB storage engine are collected.
3199 Disabled by default.
3201 =item B<MasterStats> I<true|false>
3203 =item B<SlaveStats> I<true|false>
3205 Enable the collection of master / slave statistics in a replication setup. In
3206 order to be able to get access to these statistics, the user needs special
3207 privileges. See the B<User> documentation above.
3209 =item B<SlaveNotifications> I<true|false>
3211 If enabled, the plugin sends a notification if the replication slave I/O and /
3212 or SQL threads are not running.
3214 =item B<ConnectTimeout> I<Seconds>
3216 Sets the connect timeout for the MySQL client.
3220 =head2 Plugin C<netapp>
3222 The netapp plugin can collect various performance and capacity information
3223 from a NetApp filer using the NetApp API.
3225 Please note that NetApp has a wide line of products and a lot of different
3226 software versions for each of these products. This plugin was developed for a
3227 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
3228 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
3229 model and software version but it is very hard to test this.
3230 If you have used this plugin with other models and/or software version, feel
3231 free to send us a mail to tell us about the results, even if it's just a short
3234 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
3235 basic authentication.
3237 B<Do not use a regular user for this!> Create a special collectd user with just
3238 the minimum of capabilities needed. The user only needs the "login-http-admin"
3239 capability as well as a few more depending on which data will be collected.
3240 Required capabilities are documented below.
3245 <Host "netapp1.example.com">
3269 IgnoreSelectedIO false
3271 IgnoreSelectedOps false
3272 GetLatency "volume0"
3273 IgnoreSelectedLatency false
3280 IgnoreSelectedCapacity false
3283 IgnoreSelectedSnapshot false
3311 The netapp plugin accepts the following configuration options:
3315 =item B<Host> I<Name>
3317 A host block defines one NetApp filer. It will appear in collectd with the name
3318 you specify here which does not have to be its real name nor its hostname (see
3319 the B<Address> option below).
3321 =item B<VFiler> I<Name>
3323 A B<VFiler> block may only be used inside a host block. It accepts all the
3324 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
3325 will execute all NetApp API commands in the context of the specified
3326 VFiler(R). It will appear in collectd with the name you specify here which
3327 does not have to be its real name. The VFiler name may be specified using the
3328 B<VFilerName> option. If this is not specified, it will default to the name
3331 The VFiler block inherits all connection related settings from the surrounding
3332 B<Host> block (which appear before the B<VFiler> block) but they may be
3333 overwritten inside the B<VFiler> block.
3335 This feature is useful, for example, when using a VFiler as SnapVault target
3336 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
3337 available in the host filer (vfiler0) but only in the respective VFiler
3340 =item B<Protocol> B<httpd>|B<http>
3342 The protocol collectd will use to query this host.
3350 Valid options: http, https
3352 =item B<Address> I<Address>
3354 The hostname or IP address of the host.
3360 Default: The "host" block's name.
3362 =item B<Port> I<Port>
3364 The TCP port to connect to on the host.
3370 Default: 80 for protocol "http", 443 for protocol "https"
3372 =item B<User> I<User>
3374 =item B<Password> I<Password>
3376 The username and password to use to login to the NetApp.
3382 =item B<VFilerName> I<Name>
3384 The name of the VFiler in which context to execute API commands. If not
3385 specified, the name provided to the B<VFiler> block will be used instead.
3391 Default: name of the B<VFiler> block
3393 B<Note:> This option may only be used inside B<VFiler> blocks.
3395 =item B<Interval> I<Interval>
3401 The following options decide what kind of data will be collected. You can
3402 either use them as a block and fine tune various parameters inside this block,
3403 use them as a single statement to just accept all default values, or omit it to
3404 not collect any data.
3406 The following options are valid inside all blocks:
3410 =item B<Interval> I<Seconds>
3412 Collect the respective statistics every I<Seconds> seconds. Defaults to the
3413 host specific setting.
3417 =head3 The System block
3419 This will collect various performance data about the whole system.
3421 B<Note:> To get this data the collectd user needs the
3422 "api-perf-object-get-instances" capability.
3426 =item B<Interval> I<Seconds>
3428 Collect disk statistics every I<Seconds> seconds.
3430 =item B<GetCPULoad> B<true>|B<false>
3432 If you set this option to true the current CPU usage will be read. This will be
3433 the average usage between all CPUs in your NetApp without any information about
3436 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3437 returns in the "CPU" field.
3445 Result: Two value lists of type "cpu", and type instances "idle" and "system".
3447 =item B<GetInterfaces> B<true>|B<false>
3449 If you set this option to true the current traffic of the network interfaces
3450 will be read. This will be the total traffic over all interfaces of your NetApp
3451 without any information about individual interfaces.
3453 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3454 in the "Net kB/s" field.
3464 Result: One value list of type "if_octects".
3466 =item B<GetDiskIO> B<true>|B<false>
3468 If you set this option to true the current IO throughput will be read. This
3469 will be the total IO of your NetApp without any information about individual
3470 disks, volumes or aggregates.
3472 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3473 in the "DiskE<nbsp>kB/s" field.
3481 Result: One value list of type "disk_octets".
3483 =item B<GetDiskOps> B<true>|B<false>
3485 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
3486 iSCSI, etc. operations will be read. This will be the total number of
3487 operations on your NetApp without any information about individual volumes or
3490 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3491 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
3499 Result: A variable number of value lists of type "disk_ops_complex". Each type
3500 of operation will result in one value list with the name of the operation as
3505 =head3 The WAFL block
3507 This will collect various performance data about the WAFL file system. At the
3508 moment this just means cache performance.
3510 B<Note:> To get this data the collectd user needs the
3511 "api-perf-object-get-instances" capability.
3513 B<Note:> The interface to get these values is classified as "Diagnostics" by
3514 NetApp. This means that it is not guaranteed to be stable even between minor
3519 =item B<Interval> I<Seconds>
3521 Collect disk statistics every I<Seconds> seconds.
3523 =item B<GetNameCache> B<true>|B<false>
3531 Result: One value list of type "cache_ratio" and type instance
3534 =item B<GetDirCache> B<true>|B<false>
3542 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3544 =item B<GetInodeCache> B<true>|B<false>
3552 Result: One value list of type "cache_ratio" and type instance
3555 =item B<GetBufferCache> B<true>|B<false>
3557 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3558 in the "Cache hit" field.
3566 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3570 =head3 The Disks block
3572 This will collect performance data about the individual disks in the NetApp.
3574 B<Note:> To get this data the collectd user needs the
3575 "api-perf-object-get-instances" capability.
3579 =item B<Interval> I<Seconds>
3581 Collect disk statistics every I<Seconds> seconds.
3583 =item B<GetBusy> B<true>|B<false>
3585 If you set this option to true the busy time of all disks will be calculated
3586 and the value of the busiest disk in the system will be written.
3588 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3589 in the "Disk util" field. Probably.
3597 Result: One value list of type "percent" and type instance "disk_busy".
3601 =head3 The VolumePerf block
3603 This will collect various performance data about the individual volumes.
3605 You can select which data to collect about which volume using the following
3606 options. They follow the standard ignorelist semantic.
3608 B<Note:> To get this data the collectd user needs the
3609 I<api-perf-object-get-instances> capability.
3613 =item B<Interval> I<Seconds>
3615 Collect volume performance data every I<Seconds> seconds.
3617 =item B<GetIO> I<Volume>
3619 =item B<GetOps> I<Volume>
3621 =item B<GetLatency> I<Volume>
3623 Select the given volume for IO, operations or latency statistics collection.
3624 The argument is the name of the volume without the C</vol/> prefix.
3626 Since the standard ignorelist functionality is used here, you can use a string
3627 starting and ending with a slash to specify regular expression matching: To
3628 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3631 GetIO "/^vol[027]$/"
3633 If no regular expression is specified, an exact match is required. Both,
3634 regular and exact matching are case sensitive.
3636 If no volume was specified at all for either of the three options, that data
3637 will be collected for all available volumes.
3639 =item B<IgnoreSelectedIO> B<true>|B<false>
3641 =item B<IgnoreSelectedOps> B<true>|B<false>
3643 =item B<IgnoreSelectedLatency> B<true>|B<false>
3645 When set to B<true>, the volumes selected for IO, operations or latency
3646 statistics collection will be ignored and the data will be collected for all
3649 When set to B<false>, data will only be collected for the specified volumes and
3650 all other volumes will be ignored.
3652 If no volumes have been specified with the above B<Get*> options, all volumes
3653 will be collected regardless of the B<IgnoreSelected*> option.
3655 Defaults to B<false>
3659 =head3 The VolumeUsage block
3661 This will collect capacity data about the individual volumes.
3663 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3668 =item B<Interval> I<Seconds>
3670 Collect volume usage statistics every I<Seconds> seconds.
3672 =item B<GetCapacity> I<VolumeName>
3674 The current capacity of the volume will be collected. This will result in two
3675 to four value lists, depending on the configuration of the volume. All data
3676 sources are of type "df_complex" with the name of the volume as
3679 There will be type_instances "used" and "free" for the number of used and
3680 available bytes on the volume. If the volume has some space reserved for
3681 snapshots, a type_instance "snap_reserved" will be available. If the volume
3682 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3683 number of bytes saved by the SIS feature.
3685 B<Note:> The current NetApp API has a bug that results in this value being
3686 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3687 number which works most of the time. If you see strange values here, bug
3688 NetApp support to fix this.
3690 Repeat this option to specify multiple volumes.
3692 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3694 Specify whether to collect only the volumes selected by the B<GetCapacity>
3695 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3696 B<false>. However, if no B<GetCapacity> option is specified at all, all
3697 capacities will be selected anyway.
3699 =item B<GetSnapshot> I<VolumeName>
3701 Select volumes from which to collect snapshot information.
3703 Usually, the space used for snapshots is included in the space reported as
3704 "used". If snapshot information is collected as well, the space used for
3705 snapshots is subtracted from the used space.
3707 To make things even more interesting, it is possible to reserve space to be
3708 used for snapshots. If the space required for snapshots is less than that
3709 reserved space, there is "reserved free" and "reserved used" space in addition
3710 to "free" and "used". If the space required for snapshots exceeds the reserved
3711 space, that part allocated in the normal space is subtracted from the "used"
3714 Repeat this option to specify multiple volumes.
3716 =item B<IgnoreSelectedSnapshot>
3718 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3719 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3720 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3721 capacities will be selected anyway.
3725 =head3 The Quota block
3727 This will collect (tree) quota statistics (used disk space and number of used
3728 files). This mechanism is useful to get usage information for single qtrees.
3729 In case the quotas are not used for any other purpose, an entry similar to the
3730 following in C</etc/quotas> would be sufficient:
3732 /vol/volA/some_qtree tree - - - - -
3734 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3738 =item B<Interval> I<Seconds>
3740 Collect SnapVault(R) statistics every I<Seconds> seconds.
3744 =head3 The SnapVault block
3746 This will collect statistics about the time and traffic of SnapVault(R)
3751 =item B<Interval> I<Seconds>
3753 Collect SnapVault(R) statistics every I<Seconds> seconds.
3757 =head2 Plugin C<netlink>
3759 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3760 statistics of various interface and routing aspects.
3764 =item B<Interface> I<Interface>
3766 =item B<VerboseInterface> I<Interface>
3768 Instruct the plugin to collect interface statistics. This is basically the same
3769 as the statistics provided by the C<interface> plugin (see above) but
3770 potentially much more detailed.
3772 When configuring with B<Interface> only the basic statistics will be collected,
3773 namely octets, packets, and errors. These statistics are collected by
3774 the C<interface> plugin, too, so using both at the same time is no benefit.
3776 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3777 so that no data needs to be collected twice if you use the C<interface> plugin.
3778 This includes dropped packets, received multicast packets, collisions and a
3779 whole zoo of differentiated RX and TX errors. You can try the following command
3780 to get an idea of what awaits you:
3784 If I<Interface> is B<All>, all interfaces will be selected.
3786 =item B<QDisc> I<Interface> [I<QDisc>]
3788 =item B<Class> I<Interface> [I<Class>]
3790 =item B<Filter> I<Interface> [I<Filter>]
3792 Collect the octets and packets that pass a certain qdisc, class or filter.
3794 QDiscs and classes are identified by their type and handle (or classid).
3795 Filters don't necessarily have a handle, therefore the parent's handle is used.
3796 The notation used in collectd differs from that used in tc(1) in that it
3797 doesn't skip the major or minor number if it's zero and doesn't print special
3798 ids by their name. So, for example, a qdisc may be identified by
3799 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3800 thus not displayed by tc(1).
3802 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3803 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3804 associated with that interface will be collected.
3806 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3807 used. This may lead to problems when more than one filter is attached to a
3808 qdisc or class. This isn't nice, but we don't know how this could be done any
3809 better. If you have a idea, please don't hesitate to tell us.
3811 As with the B<Interface> option you can specify B<All> as the interface,
3812 meaning all interfaces.
3814 Here are some examples to help you understand the above text more easily:
3817 VerboseInterface "All"
3818 QDisc "eth0" "pfifo_fast-1:0"
3820 Class "ppp0" "htb-1:10"
3821 Filter "ppp0" "u32-1:0"
3824 =item B<IgnoreSelected>
3826 The behavior is the same as with all other similar plugins: If nothing is
3827 selected at all, everything is collected. If some things are selected using the
3828 options described above, only these statistics are collected. If you set
3829 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3830 specified statistics will not be collected.
3834 =head2 Plugin C<network>
3836 The Network plugin sends data to a remote instance of collectd, receives data
3837 from a remote instance, or both at the same time. Data which has been received
3838 from the network is usually not transmitted again, but this can be activated, see
3839 the B<Forward> option below.
3841 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3842 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3844 Both, B<Server> and B<Listen> can be used as single option or as block. When
3845 used as block, given options are valid for this socket only. The following
3846 example will export the metrics twice: Once to an "internal" server (without
3847 encryption and signing) and one to an external server (with cryptographic
3851 # Export to an internal server
3852 # (demonstrates usage without additional options)
3853 Server "collectd.internal.tld"
3855 # Export to an external server
3856 # (demonstrates usage with signature options)
3857 <Server "collectd.external.tld">
3858 SecurityLevel "sign"
3859 Username "myhostname"
3866 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3868 The B<Server> statement/block sets the server to send datagrams to. The
3869 statement may occur multiple times to send each datagram to multiple
3872 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3873 optional second argument specifies a port number or a service name. If not
3874 given, the default, B<25826>, is used.
3876 The following options are recognized within B<Server> blocks:
3880 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3882 Set the security you require for network communication. When the security level
3883 has been set to B<Encrypt>, data sent over the network will be encrypted using
3884 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3885 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3886 authentication code. When set to B<None>, data is sent without any security.
3888 This feature is only available if the I<network> plugin was linked with
3891 =item B<Username> I<Username>
3893 Sets the username to transmit. This is used by the server to lookup the
3894 password. See B<AuthFile> below. All security levels except B<None> require
3897 This feature is only available if the I<network> plugin was linked with
3900 =item B<Password> I<Password>
3902 Sets a password (shared secret) for this socket. All security levels except
3903 B<None> require this setting.
3905 This feature is only available if the I<network> plugin was linked with
3908 =item B<Interface> I<Interface name>
3910 Set the outgoing interface for IP packets. This applies at least
3911 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3912 undefined or a non-existent interface name is specified, the default
3913 behavior is to let the kernel choose the appropriate interface. Be warned
3914 that the manual selection of an interface for unicast traffic is only
3915 necessary in rare cases.
3917 =item B<ResolveInterval> I<Seconds>
3919 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
3920 useful to force a regular DNS lookup to support a high availability setup. If
3921 not specified, re-resolves are never attempted.
3925 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
3927 The B<Listen> statement sets the interfaces to bind to. When multiple
3928 statements are found the daemon will bind to multiple interfaces.
3930 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
3931 the argument is a multicast address the daemon will join that multicast group.
3932 The optional second argument specifies a port number or a service name. If not
3933 given, the default, B<25826>, is used.
3935 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
3939 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3941 Set the security you require for network communication. When the security level
3942 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
3943 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
3944 signed and encrypted data is accepted. When set to B<None>, all data will be
3945 accepted. If an B<AuthFile> option was given (see below), encrypted data is
3946 decrypted if possible.
3948 This feature is only available if the I<network> plugin was linked with
3951 =item B<AuthFile> I<Filename>
3953 Sets a file in which usernames are mapped to passwords. These passwords are
3954 used to verify signatures and to decrypt encrypted network packets. If
3955 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
3956 verified and encrypted packets are decrypted. Otherwise, signed data is
3957 accepted without checking the signature and encrypted data cannot be decrypted.
3958 For the other security levels this option is mandatory.
3960 The file format is very simple: Each line consists of a username followed by a
3961 colon and any number of spaces followed by the password. To demonstrate, an
3962 example file could look like this:
3967 Each time a packet is received, the modification time of the file is checked
3968 using L<stat(2)>. If the file has been changed, the contents is re-read. While
3969 the file is being read, it is locked using L<fcntl(2)>.
3971 =item B<Interface> I<Interface name>
3973 Set the incoming interface for IP packets explicitly. This applies at least
3974 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3975 undefined or a non-existent interface name is specified, the default
3976 behavior is, to let the kernel choose the appropriate interface. Thus incoming
3977 traffic gets only accepted, if it arrives on the given interface.
3981 =item B<TimeToLive> I<1-255>
3983 Set the time-to-live of sent packets. This applies to all, unicast and
3984 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
3985 That means that multicast packets will be sent with a TTL of C<1> (one) on most
3988 =item B<MaxPacketSize> I<1024-65535>
3990 Set the maximum size for datagrams received over the network. Packets larger
3991 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
3992 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
3995 On the server side, this limit should be set to the largest value used on
3996 I<any> client. Likewise, the value on the client must not be larger than the
3997 value on the server, or data will be lost.
3999 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
4000 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
4001 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
4004 =item B<Forward> I<true|false>
4006 If set to I<true>, write packets that were received via the network plugin to
4007 the sending sockets. This should only be activated when the B<Listen>- and
4008 B<Server>-statements differ. Otherwise packets may be send multiple times to
4009 the same multicast group. While this results in more network traffic than
4010 necessary it's not a huge problem since the plugin has a duplicate detection,
4011 so the values will not loop.
4013 =item B<ReportStats> B<true>|B<false>
4015 The network plugin cannot only receive and send statistics, it can also create
4016 statistics about itself. Collected data included the number of received and
4017 sent octets and packets, the length of the receive queue and the number of
4018 values handled. When set to B<true>, the I<Network plugin> will make these
4019 statistics available. Defaults to B<false>.
4023 =head2 Plugin C<nginx>
4025 This plugin collects the number of connections and requests handled by the
4026 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
4027 queries the page provided by the C<ngx_http_stub_status_module> module, which
4028 isn't compiled by default. Please refer to
4029 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
4030 how to compile and configure nginx and this module.
4032 The following options are accepted by the C<nginx plugin>:
4036 =item B<URL> I<http://host/nginx_status>
4038 Sets the URL of the C<ngx_http_stub_status_module> output.
4040 =item B<User> I<Username>
4042 Optional user name needed for authentication.
4044 =item B<Password> I<Password>
4046 Optional password needed for authentication.
4048 =item B<VerifyPeer> B<true|false>
4050 Enable or disable peer SSL certificate verification. See
4051 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
4053 =item B<VerifyHost> B<true|false>
4055 Enable or disable peer host name verification. If enabled, the plugin checks
4056 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4057 certificate matches the host name provided by the B<URL> option. If this
4058 identity check fails, the connection is aborted. Obviously, only works when
4059 connecting to a SSL enabled server. Enabled by default.
4061 =item B<CACert> I<File>
4063 File that holds one or more SSL certificates. If you want to use HTTPS you will
4064 possibly need this option. What CA certificates come bundled with C<libcurl>
4065 and are checked by default depends on the distribution you use.
4069 =head2 Plugin C<notify_desktop>
4071 This plugin sends a desktop notification to a notification daemon, as defined
4072 in the Desktop Notification Specification. To actually display the
4073 notifications, B<notification-daemon> is required and B<collectd> has to be
4074 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
4075 environment variables have to be set correctly) and the D-Bus message bus.
4077 The Desktop Notification Specification can be found at
4078 L<http://www.galago-project.org/specs/notification/>.
4082 =item B<OkayTimeout> I<timeout>
4084 =item B<WarningTimeout> I<timeout>
4086 =item B<FailureTimeout> I<timeout>
4088 Set the I<timeout>, in milliseconds, after which to expire the notification
4089 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
4090 been specified, the displayed notification will not be closed at all - the
4091 user has to do so herself. These options default to 5000. If a negative number
4092 has been specified, the default is used as well.
4096 =head2 Plugin C<notify_email>
4098 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
4099 configured email address.
4101 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
4103 Available configuration options:
4107 =item B<From> I<Address>
4109 Email address from which the emails should appear to come from.
4111 Default: C<root@localhost>
4113 =item B<Recipient> I<Address>
4115 Configures the email address(es) to which the notifications should be mailed.
4116 May be repeated to send notifications to multiple addresses.
4118 At least one B<Recipient> must be present for the plugin to work correctly.
4120 =item B<SMTPServer> I<Hostname>
4122 Hostname of the SMTP server to connect to.
4124 Default: C<localhost>
4126 =item B<SMTPPort> I<Port>
4128 TCP port to connect to.
4132 =item B<SMTPUser> I<Username>
4134 Username for ASMTP authentication. Optional.
4136 =item B<SMTPPassword> I<Password>
4138 Password for ASMTP authentication. Optional.
4140 =item B<Subject> I<Subject>
4142 Subject-template to use when sending emails. There must be exactly two
4143 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
4144 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
4147 Default: C<Collectd notify: %s@%s>
4151 =head2 Plugin C<ntpd>
4155 =item B<Host> I<Hostname>
4157 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
4159 =item B<Port> I<Port>
4161 UDP-Port to connect to. Defaults to B<123>.
4163 =item B<ReverseLookups> B<true>|B<false>
4165 Sets whether or not to perform reverse lookups on peers. Since the name or
4166 IP-address may be used in a filename it is recommended to disable reverse
4167 lookups. The default is to do reverse lookups to preserve backwards
4168 compatibility, though.
4170 =item B<IncludeUnitID> B<true>|B<false>
4172 When a peer is a refclock, include the unit ID in the I<type instance>.
4173 Defaults to B<false> for backward compatibility.
4175 If two refclock peers use the same driver and this is B<false>, the plugin will
4176 try to write simultaneous measurements from both to the same type instance.
4177 This will result in error messages in the log and only one set of measurements
4182 =head2 Plugin C<nut>
4186 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
4188 Add a UPS to collect data from. The format is identical to the one accepted by
4193 =head2 Plugin C<olsrd>
4195 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
4196 the Optimized Link State Routing daemon and reads information about the current
4197 state of the meshed network.
4199 The following configuration options are understood:
4203 =item B<Host> I<Host>
4205 Connect to I<Host>. Defaults to B<"localhost">.
4207 =item B<Port> I<Port>
4209 Specifies the port to connect to. This must be a string, even if you give the
4210 port as a number rather than a service name. Defaults to B<"2006">.
4212 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
4214 Specifies what information to collect about links, i.E<nbsp>e. direct
4215 connections of the daemon queried. If set to B<No>, no information is
4216 collected. If set to B<Summary>, the number of links and the average of all
4217 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
4218 If set to B<Detail> LQ and NLQ are collected per link.
4220 Defaults to B<Detail>.
4222 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
4224 Specifies what information to collect about routes of the daemon queried. If
4225 set to B<No>, no information is collected. If set to B<Summary>, the number of
4226 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
4227 metric and ETX are collected per route.
4229 Defaults to B<Summary>.
4231 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
4233 Specifies what information to collect about the global topology. If set to
4234 B<No>, no information is collected. If set to B<Summary>, the number of links
4235 in the entire topology and the average I<link quality> (LQ) is calculated.
4236 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
4238 Defaults to B<Summary>.
4242 =head2 Plugin C<onewire>
4244 B<EXPERIMENTAL!> See notes below.
4246 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
4247 L<http://owfs.org/> to read sensors connected via the onewire bus.
4249 It can be used in two possible modes - standard or advanced.
4251 In the standard mode only temperature sensors (sensors with the family code
4252 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
4253 other sensors you would like to have included, please send a sort request to
4254 the mailing list. You can select sensors to be read or to be ignored depending
4255 on the option B<IgnoreSelected>). When no list is provided the whole bus is
4256 walked and all sensors are read.
4258 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
4259 experimental, below.
4261 In the advanced mode you can configure any sensor to be read (only numerical
4262 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
4263 In this mode you have to list all the sensors. Neither default bus walk nor
4264 B<IgnoreSelected> are used here. Address and type (file) is extracted from
4265 the path automatically and should produce compatible structure with the "standard"
4266 mode (basically the path is expected as for example
4267 "/uncached/10.F10FCA000800/temperature" where it would extract address part
4268 "F10FCA000800" and the rest after the slash is considered the type - here
4270 There are two advantages to this mode - you can access virtually any sensor
4271 (not just temperature), select whether to use cached or directly read values
4272 and it is slighlty faster. The downside is more complex configuration.
4274 The two modes are distinguished automatically by the format of the address.
4275 It is not possible to mix the two modes. Once a full path is detected in any
4276 B<Sensor> then the whole addressing (all sensors) is considered to be this way
4277 (and as standard addresses will fail parsing they will be ignored).
4281 =item B<Device> I<Device>
4283 Sets the device to read the values from. This can either be a "real" hardware
4284 device, such as a serial port or an USB port, or the address of the
4285 L<owserver(1)> socket, usually B<localhost:4304>.
4287 Though the documentation claims to automatically recognize the given address
4288 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
4289 with that version, the following configuration worked for us:
4292 Device "-s localhost:4304"
4295 This directive is B<required> and does not have a default value.
4297 =item B<Sensor> I<Sensor>
4299 In the standard mode selects sensors to collect or to ignore
4300 (depending on B<IgnoreSelected>, see below). Sensors are specified without
4301 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
4302 and B<not> include the leading C<10.> family byte and point.
4303 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
4304 sensors (see above) are read.
4306 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
4307 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
4308 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
4310 As there can be multiple devices on the bus you can list multiple sensor (use
4311 multiple B<Sensor> elements).
4313 =item B<IgnoreSelected> I<true>|I<false>
4315 If no configuration is given, the B<onewire> plugin will collect data from all
4316 sensors found. This may not be practical, especially if sensors are added and
4317 removed regularly. Sometimes, however, it's easier/preferred to collect only
4318 specific sensors or all sensors I<except> a few specified ones. This option
4319 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
4320 B<Sensor> is inverted: All selected interfaces are ignored and all other
4321 interfaces are collected.
4323 Used only in the standard mode - see above.
4325 =item B<Interval> I<Seconds>
4327 Sets the interval in which all sensors should be read. If not specified, the
4328 global B<Interval> setting is used.
4332 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
4333 work with big setups. It works with one sensor being attached to one
4334 controller, but as soon as you throw in a couple more senors and maybe a hub
4335 or two, reading all values will take more than ten seconds (the default
4336 interval). We will probably add some separate thread for reading the sensors
4337 and some cache or something like that, but it's not done yet. We will try to
4338 maintain backwards compatibility in the future, but we can't promise. So in
4339 short: If it works for you: Great! But keep in mind that the config I<might>
4340 change, though this is unlikely. Oh, and if you want to help improving this
4341 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
4343 =head2 Plugin C<openvpn>
4345 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
4346 traffic statistics about connected clients.
4348 To set up OpenVPN to write to the status file periodically, use the
4349 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
4350 you need to set the required format, too. This is done by setting
4351 B<--status-version> to B<2>.
4353 So, in a nutshell you need:
4355 openvpn $OTHER_OPTIONS \
4356 --status "/var/run/openvpn-status" 10 \
4363 =item B<StatusFile> I<File>
4365 Specifies the location of the status file.
4367 =item B<ImprovedNamingSchema> B<true>|B<false>
4369 When enabled, the filename of the status file will be used as plugin instance
4370 and the client's "common name" will be used as type instance. This is required
4371 when reading multiple status files. Enabling this option is recommended, but to
4372 maintain backwards compatibility this option is disabled by default.
4374 =item B<CollectCompression> B<true>|B<false>
4376 Sets whether or not statistics about the compression used by OpenVPN should be
4377 collected. This information is only available in I<single> mode. Enabled by
4380 =item B<CollectIndividualUsers> B<true>|B<false>
4382 Sets whether or not traffic information is collected for each connected client
4383 individually. If set to false, currently no traffic data is collected at all
4384 because aggregating this data in a save manner is tricky. Defaults to B<true>.
4386 =item B<CollectUserCount> B<true>|B<false>
4388 When enabled, the number of currently connected clients or users is collected.
4389 This is especially interesting when B<CollectIndividualUsers> is disabled, but
4390 can be configured independently from that option. Defaults to B<false>.
4394 =head2 Plugin C<oracle>
4396 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
4397 Oracle® Database and lets you execute SQL statements there. It is very similar
4398 to the "dbi" plugin, because it was written around the same time. See the "dbi"
4399 plugin's documentation above for details.
4402 <Query "out_of_stock">
4403 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
4406 # InstancePrefix "foo"
4407 InstancesFrom "category"
4411 <Database "product_information">
4415 Query "out_of_stock"
4419 =head3 B<Query> blocks
4421 The Query blocks are handled identically to the Query blocks of the "dbi"
4422 plugin. Please see its documentation above for details on how to specify
4425 =head3 B<Database> blocks
4427 Database blocks define a connection to a database and which queries should be
4428 sent to that database. Each database needs a "name" as string argument in the
4429 starting tag of the block. This name will be used as "PluginInstance" in the
4430 values submitted to the daemon. Other than that, that name is not used.
4434 =item B<ConnectID> I<ID>
4436 Defines the "database alias" or "service name" to connect to. Usually, these
4437 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
4439 =item B<Host> I<Host>
4441 Hostname to use when dispatching values for this database. Defaults to using
4442 the global hostname of the I<collectd> instance.
4444 =item B<Username> I<Username>
4446 Username used for authentication.
4448 =item B<Password> I<Password>
4450 Password used for authentication.
4452 =item B<Query> I<QueryName>
4454 Associates the query named I<QueryName> with this database connection. The
4455 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
4456 blocks you want to refer to must be placed above the database block you want to
4461 =head2 Plugin C<perl>
4463 This plugin embeds a Perl-interpreter into collectd and provides an interface
4464 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
4466 =head2 Plugin C<pinba>
4468 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
4469 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
4470 PHP-based webpage has been delivered, the extension will send a UDP packet
4471 containing timing information, peak memory usage and so on. The plugin will
4472 wait for such packets, parse them and account the provided information, which
4473 is then dispatched to the daemon once per interval.
4480 # Overall statistics for the website.
4482 Server "www.example.com"
4484 # Statistics for www-a only
4486 Host "www-a.example.com"
4487 Server "www.example.com"
4489 # Statistics for www-b only
4491 Host "www-b.example.com"
4492 Server "www.example.com"
4496 The plugin provides the following configuration options:
4500 =item B<Address> I<Node>
4502 Configures the address used to open a listening socket. By default, plugin will
4503 bind to the I<any> address C<::0>.
4505 =item B<Port> I<Service>
4507 Configures the port (service) to bind to. By default the default Pinba port
4508 "30002" will be used. The option accepts service names in addition to port
4509 numbers and thus requires a I<string> argument.
4511 =item E<lt>B<View> I<Name>E<gt> block
4513 The packets sent by the Pinba extension include the hostname of the server, the
4514 server name (the name of the virtual host) and the script that was executed.
4515 Using B<View> blocks it is possible to separate the data into multiple groups
4516 to get more meaningful statistics. Each packet is added to all matching groups,
4517 so that a packet may be accounted for more than once.
4521 =item B<Host> I<Host>
4523 Matches the hostname of the system the webserver / script is running on. This
4524 will contain the result of the L<gethostname(2)> system call. If not
4525 configured, all hostnames will be accepted.
4527 =item B<Server> I<Server>
4529 Matches the name of the I<virtual host>, i.e. the contents of the
4530 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
4531 server names will be accepted.
4533 =item B<Script> I<Script>
4535 Matches the name of the I<script name>, i.e. the contents of the
4536 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
4537 script names will be accepted.
4543 =head2 Plugin C<ping>
4545 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
4546 configured hosts periodically and measures the network latency. Whenever the
4547 C<read> function of the plugin is called, it submits the average latency, the
4548 standard deviation and the drop rate for each host.
4550 Available configuration options:
4554 =item B<Host> I<IP-address>
4556 Host to ping periodically. This option may be repeated several times to ping
4559 =item B<Interval> I<Seconds>
4561 Sets the interval in which to send ICMP echo packets to the configured hosts.
4562 This is B<not> the interval in which statistics are queries from the plugin but
4563 the interval in which the hosts are "pinged". Therefore, the setting here
4564 should be smaller than or equal to the global B<Interval> setting. Fractional
4565 times, such as "1.24" are allowed.
4569 =item B<Timeout> I<Seconds>
4571 Time to wait for a response from the host to which an ICMP packet had been
4572 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
4573 to be down or the packet to be dropped. This setting must be smaller than the
4574 B<Interval> setting above for the plugin to work correctly. Fractional
4575 arguments are accepted.
4579 =item B<TTL> I<0-255>
4581 Sets the Time-To-Live of generated ICMP packets.
4583 =item B<SourceAddress> I<host>
4585 Sets the source address to use. I<host> may either be a numerical network
4586 address or a network hostname.
4588 =item B<Device> I<name>
4590 Sets the outgoing network device to be used. I<name> has to specify an
4591 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
4594 =item B<MaxMissed> I<Packets>
4596 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
4597 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
4599 Default: B<-1> (disabled)
4603 =head2 Plugin C<postgresql>
4605 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
4606 keeps a persistent connection to all configured databases and tries to
4607 reconnect if the connection has been interrupted. A database is configured by
4608 specifying a B<Database> block as described below. The default statistics are
4609 collected from PostgreSQL's B<statistics collector> which thus has to be
4610 enabled for this plugin to work correctly. This should usually be the case by
4611 default. See the section "The Statistics Collector" of the B<PostgreSQL
4612 Documentation> for details.
4614 By specifying custom database queries using a B<Query> block as described
4615 below, you may collect any data that is available from some PostgreSQL
4616 database. This way, you are able to access statistics of external daemons
4617 which are available in a PostgreSQL database or use future or special
4618 statistics provided by PostgreSQL without the need to upgrade your collectd
4621 Starting with version 5.2, the C<postgresql> plugin supports writing data to
4622 PostgreSQL databases as well. This has been implemented in a generic way. You
4623 need to specify an SQL statement which will then be executed by collectd in
4624 order to write the data (see below for details). The benefit of that approach
4625 is that there is no fixed database layout. Rather, the layout may be optimized
4626 for the current setup.
4628 The B<PostgreSQL Documentation> manual can be found at
4629 L<http://www.postgresql.org/docs/manuals/>.
4633 Statement "SELECT magic FROM wizard WHERE host = $1;"
4637 InstancePrefix "magic"
4642 <Query rt36_tickets>
4643 Statement "SELECT COUNT(type) AS count, type \
4645 WHEN resolved = 'epoch' THEN 'open' \
4646 ELSE 'resolved' END AS type \
4647 FROM tickets) type \
4651 InstancePrefix "rt36_tickets"
4652 InstancesFrom "type"
4658 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
4668 KRBSrvName "kerberos_service_name"
4674 Service "service_name"
4675 Query backend # predefined
4686 The B<Query> block defines one database query which may later be used by a
4687 database definition. It accepts a single mandatory argument which specifies
4688 the name of the query. The names of all queries have to be unique (see the
4689 B<MinVersion> and B<MaxVersion> options below for an exception to this
4690 rule). The following configuration options are available to define the query:
4692 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
4693 blocks define how to handle the values returned from the query. They define
4694 which column holds which value and how to dispatch that value to the daemon.
4695 Multiple B<Result> blocks may be used to extract multiple values from a single
4700 =item B<Statement> I<sql query statement>
4702 Specify the I<sql query statement> which the plugin should execute. The string
4703 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
4704 first, second, etc. parameter. The value of the parameters is specified by the
4705 B<Param> configuration option - see below for details. To include a literal
4706 B<$> character followed by a number, surround it with single quotes (B<'>).
4708 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
4709 allowed. Note, however, that only a single command may be used. Semicolons are
4710 allowed as long as a single non-empty command has been specified only.
4712 The returned lines will be handled separately one after another.
4714 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4716 Specify the parameters which should be passed to the SQL query. The parameters
4717 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4718 they appear in the configuration file. The value of the parameter is
4719 determined depending on the value of the B<Param> option as follows:
4725 The configured hostname of the database connection. If a UNIX domain socket is
4726 used, the parameter expands to "localhost".
4730 The name of the database of the current connection.
4734 The name of the database plugin instance. See the B<Instance> option of the
4735 database specification below for details.
4739 The username used to connect to the database.
4743 The interval with which this database is queried (as specified by the database
4744 specific or global B<Interval> options).
4748 Please note that parameters are only supported by PostgreSQL's protocol
4749 version 3 and above which was introduced in version 7.4 of PostgreSQL.
4751 =item B<Type> I<type>
4753 The I<type> name to be used when dispatching the values. The type describes
4754 how to handle the data and where to store it. See L<types.db(5)> for more
4755 details on types and their configuration. The number and type of values (as
4756 selected by the B<ValuesFrom> option) has to match the type of the given name.
4758 This option is required inside a B<Result> block.
4760 =item B<InstancePrefix> I<prefix>
4762 =item B<InstancesFrom> I<column0> [I<column1> ...]
4764 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
4765 B<InstancePrefix> defines a static prefix that will be prepended to all type
4766 instances. B<InstancesFrom> defines the column names whose values will be used
4767 to create the type instance. Multiple values will be joined together using the
4768 hyphen (C<->) as separation character.
4770 The plugin itself does not check whether or not all built instances are
4771 different. It is your responsibility to assure that each is unique.
4773 Both options are optional. If none is specified, the type instance will be
4776 =item B<ValuesFrom> I<column0> [I<column1> ...]
4778 Names the columns whose content is used as the actual data for the data sets
4779 that are dispatched to the daemon. How many such columns you need is
4780 determined by the B<Type> setting as explained above. If you specify too many
4781 or not enough columns, the plugin will complain about that and no data will be
4782 submitted to the daemon.
4784 The actual data type, as seen by PostgreSQL, is not that important as long as
4785 it represents numbers. The plugin will automatically cast the values to the
4786 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
4787 L<strtod(3)> functions, so anything supported by those functions is supported
4788 by the plugin as well.
4790 This option is required inside a B<Result> block and may be specified multiple
4791 times. If multiple B<ValuesFrom> options are specified, the columns are read
4794 =item B<MinVersion> I<version>
4796 =item B<MaxVersion> I<version>
4798 Specify the minimum or maximum version of PostgreSQL that this query should be
4799 used with. Some statistics might only be available with certain versions of
4800 PostgreSQL. This allows you to specify multiple queries with the same name but
4801 which apply to different versions, thus allowing you to use the same
4802 configuration in a heterogeneous environment.
4804 The I<version> has to be specified as the concatenation of the major, minor
4805 and patch-level versions, each represented as two-decimal-digit numbers. For
4806 example, version 8.2.3 will become 80203.
4810 The following predefined queries are available (the definitions can be found
4811 in the F<postgresql_default.conf> file which, by default, is available at
4812 C<I<prefix>/share/collectd/>):
4818 This query collects the number of backends, i.E<nbsp>e. the number of
4821 =item B<transactions>
4823 This query collects the numbers of committed and rolled-back transactions of
4828 This query collects the numbers of various table modifications (i.E<nbsp>e.
4829 insertions, updates, deletions) of the user tables.
4831 =item B<query_plans>
4833 This query collects the numbers of various table scans and returned tuples of
4836 =item B<table_states>
4838 This query collects the numbers of live and dead rows in the user tables.
4842 This query collects disk block access counts for user tables.
4846 This query collects the on-disk size of the database in bytes.
4850 In addition, the following detailed queries are available by default. Please
4851 note that each of those queries collects information B<by table>, thus,
4852 potentially producing B<a lot> of data. For details see the description of the
4853 non-by_table queries above.
4857 =item B<queries_by_table>
4859 =item B<query_plans_by_table>
4861 =item B<table_states_by_table>
4863 =item B<disk_io_by_table>
4867 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
4868 mandatory argument specifying the name of the writer. This will then be used
4869 in the B<Database> specification in order to activate the writer instance. The
4870 names of all writers have to be unique. The following options may be
4875 =item B<Statement> I<sql statement>
4877 This mandatory option specifies the SQL statement that will be executed for
4878 each submitted value. A single SQL statement is allowed only. Anything after
4879 the first semicolon will be ignored.
4881 Nine parameters will be passed to the statement and should be specified as
4882 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
4883 values are made available through those parameters:
4889 The timestamp of the queried value as a floating point number.
4893 The hostname of the queried value.
4897 The plugin name of the queried value.
4901 The plugin instance of the queried value. This value may be B<NULL> if there
4902 is no plugin instance.
4906 The type of the queried value (cf. L<types.db(5)>).
4910 The type instance of the queried value. This value may be B<NULL> if there is
4915 An array of names for the submitted values (i.E<nbsp>e., the name of the data
4916 sources of the submitted value-list).
4920 An array of types for the submitted values (i.E<nbsp>e., the type of the data
4921 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
4922 B<StoreRates> is enabled (which is the default, see below), all types will be
4927 An array of the submitted values. The dimensions of the value name and value
4932 In general, it is advisable to create and call a custom function in the
4933 PostgreSQL database for this purpose. Any procedural language supported by
4934 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
4937 =item B<StoreRates> B<false>|B<true>
4939 If set to B<true> (the default), convert counter values to rates. If set to
4940 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
4945 The B<Database> block defines one PostgreSQL database for which to collect
4946 statistics. It accepts a single mandatory argument which specifies the
4947 database name. None of the other options are required. PostgreSQL will use
4948 default values as documented in the section "CONNECTING TO A DATABASE" in the
4949 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
4950 the user collectd is run as and special environment variables. See the manpage
4955 =item B<Interval> I<seconds>
4957 Specify the interval with which the database should be queried. The default is
4958 to use the global B<Interval> setting.
4960 =item B<CommitInterval> I<seconds>
4962 This option may be used for database connections which have "writers" assigned
4963 (see above). If specified, it causes a writer to put several updates into a
4964 single transaction. This transaction will last for the specified amount of
4965 time. By default, each update will be executed in a separate transaction. Each
4966 transaction generates a fair amount of overhead which can, thus, be reduced by
4967 activating this option. The draw-back is, that data covering the specified
4968 amount of time will be lost, for example, if a single statement within the
4969 transaction fails or if the database server crashes.
4971 =item B<Host> I<hostname>
4973 Specify the hostname or IP of the PostgreSQL server to connect to. If the
4974 value begins with a slash, it is interpreted as the directory name in which to
4975 look for the UNIX domain socket.
4977 This option is also used to determine the hostname that is associated with a
4978 collected data set. If it has been omitted or either begins with with a slash
4979 or equals B<localhost> it will be replaced with the global hostname definition
4980 of collectd. Any other value will be passed literally to collectd when
4981 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
4983 =item B<Port> I<port>
4985 Specify the TCP port or the local UNIX domain socket file extension of the
4988 =item B<User> I<username>
4990 Specify the username to be used when connecting to the server.
4992 =item B<Password> I<password>
4994 Specify the password to be used when connecting to the server.
4996 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
4998 Specify whether to use an SSL connection when contacting the server. The
4999 following modes are supported:
5005 Do not use SSL at all.
5009 First, try to connect without using SSL. If that fails, try using SSL.
5011 =item I<prefer> (default)
5013 First, try to connect using SSL. If that fails, try without using SSL.
5021 =item B<Instance> I<name>
5023 Specify the plugin instance name that should be used instead of the database
5024 name (which is the default, if this option has not been specified). This
5025 allows to query multiple databases of the same name on the same host (e.g.
5026 when running multiple database server versions in parallel).
5028 =item B<KRBSrvName> I<kerberos_service_name>
5030 Specify the Kerberos service name to use when authenticating with Kerberos 5
5031 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
5032 B<PostgreSQL Documentation> for details.
5034 =item B<Service> I<service_name>
5036 Specify the PostgreSQL service name to use for additional parameters. That
5037 service has to be defined in F<pg_service.conf> and holds additional
5038 connection parameters. See the section "The Connection Service File" in the
5039 B<PostgreSQL Documentation> for details.
5041 =item B<Query> I<query>
5043 Specifies a I<query> which should be executed in the context of the database
5044 connection. This may be any of the predefined or user-defined queries. If no
5045 such option is given, it defaults to "backends", "transactions", "queries",
5046 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
5047 has been specified). Else, the specified queries are used only.
5049 =item B<Writer> I<writer>
5051 Assigns the specified I<writer> backend to the database connection. This
5052 causes all collected data to be send to the database using the settings
5053 defined in the writer configuration (see the section "FILTER CONFIGURATION"
5054 below for details on how to selectively send data to certain plugins).
5056 Each writer will register a flush callback which may be used when having long
5057 transactions enabled (see the B<CommitInterval> option above). When issuing
5058 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
5059 transaction will be committed right away. Two different kinds of flush
5060 callbacks are available with the C<postgresql> plugin:
5066 Flush all writer backends.
5068 =item B<postgresql->I<database>
5070 Flush all writers of the specified I<database> only.
5076 =head2 Plugin C<powerdns>
5078 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
5079 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
5080 values, many of which are probably meaningless to most users, but may be useful
5081 for some. So you may chose which values to collect, but if you don't, some
5082 reasonable defaults will be collected.
5085 <Server "server_name">
5087 Collect "udp-answers" "udp-queries"
5088 Socket "/var/run/pdns.controlsocket"
5090 <Recursor "recursor_name">
5092 Collect "cache-hits" "cache-misses"
5093 Socket "/var/run/pdns_recursor.controlsocket"
5095 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
5100 =item B<Server> and B<Recursor> block
5102 The B<Server> block defines one authoritative server to query, the B<Recursor>
5103 does the same for an recursing server. The possible options in both blocks are
5104 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
5109 =item B<Collect> I<Field>
5111 Using the B<Collect> statement you can select which values to collect. Here,
5112 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
5113 C<dlg-only-drops>, C<answers10-100>.
5115 The method of getting the values differs for B<Server> and B<Recursor> blocks:
5116 When querying the server a C<SHOW *> command is issued in any case, because
5117 that's the only way of getting multiple values out of the server at once.
5118 collectd then picks out the values you have selected. When querying the
5119 recursor, a command is generated to query exactly these values. So if you
5120 specify invalid fields when querying the recursor, a syntax error may be
5121 returned by the daemon and collectd may not collect any values at all.
5123 If no B<Collect> statement is given, the following B<Server> values will be
5130 =item packetcache-hit
5132 =item packetcache-miss
5134 =item packetcache-size
5136 =item query-cache-hit
5138 =item query-cache-miss
5140 =item recursing-answers
5142 =item recursing-questions
5154 The following B<Recursor> values will be collected by default:
5158 =item noerror-answers
5160 =item nxdomain-answers
5162 =item servfail-answers
5180 Please note that up to that point collectd doesn't know what values are
5181 available on the server and values that are added do not need a change of the
5182 mechanism so far. However, the values must be mapped to collectd's naming
5183 scheme, which is done using a lookup table that lists all known values. If
5184 values are added in the future and collectd does not know about them, you will
5185 get an error much like this:
5187 powerdns plugin: submit: Not found in lookup table: foobar = 42
5189 In this case please file a bug report with the collectd team.
5191 =item B<Socket> I<Path>
5193 Configures the path to the UNIX domain socket to be used when connecting to the
5194 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
5195 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
5196 will be used for the recursor.
5200 =item B<LocalSocket> I<Path>
5202 Querying the recursor is done using UDP. When using UDP over UNIX domain
5203 sockets, the client socket needs a name in the file system, too. You can set
5204 this local name to I<Path> using the B<LocalSocket> option. The default is
5205 C<I<prefix>/var/run/collectd-powerdns>.
5209 =head2 Plugin C<processes>
5213 =item B<Process> I<Name>
5215 Select more detailed statistics of processes matching this name. The statistics
5216 collected for these selected processes are size of the resident segment size
5217 (RSS), user- and system-time used, number of processes and number of threads,
5218 io data (where available) and minor and major pagefaults.
5220 =item B<ProcessMatch> I<name> I<regex>
5222 Similar to the B<Process> option this allows to select more detailed
5223 statistics of processes matching the specified I<regex> (see L<regex(7)> for
5224 details). The statistics of all matching processes are summed up and
5225 dispatched to the daemon using the specified I<name> as an identifier. This
5226 allows to "group" several processes together. I<name> must not contain
5231 =head2 Plugin C<protocols>
5233 Collects a lot of information about various network protocols, such as I<IP>,
5234 I<TCP>, I<UDP>, etc.
5236 Available configuration options:
5240 =item B<Value> I<Selector>
5242 Selects whether or not to select a specific value. The string being matched is
5243 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
5244 plugin instance and I<ValueName> will be used as type instance. An example of
5245 the string being used would be C<Tcp:RetransSegs>.
5247 You can use regular expressions to match a large number of values with just one
5248 configuration option. To select all "extended" I<TCP> values, you could use the
5249 following statement:
5253 Whether only matched values are selected or all matched values are ignored
5254 depends on the B<IgnoreSelected>. By default, only matched values are selected.
5255 If no value is configured at all, all values will be selected.
5257 =item B<IgnoreSelected> B<true>|B<false>
5259 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
5260 matching values will be ignored.
5264 =head2 Plugin C<python>
5266 This plugin embeds a Python-interpreter into collectd and provides an interface
5267 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
5269 =head2 Plugin C<routeros>
5271 The C<routeros> plugin connects to a device running I<RouterOS>, the
5272 Linux-based operating system for routers by I<MikroTik>. The plugin uses
5273 I<librouteros> to connect and reads information about the interfaces and
5274 wireless connections of the device. The configuration supports querying
5279 Host "router0.example.com"
5282 CollectInterface true
5287 Host "router1.example.com"
5290 CollectInterface true
5291 CollectRegistrationTable true
5297 As you can see above, the configuration of the I<routeros> plugin consists of
5298 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
5299 options are understood:
5303 =item B<Host> I<Host>
5305 Hostname or IP-address of the router to connect to.
5307 =item B<Port> I<Port>
5309 Port name or port number used when connecting. If left unspecified, the default
5310 will be chosen by I<librouteros>, currently "8728". This option expects a
5311 string argument, even when a numeric port number is given.
5313 =item B<User> I<User>
5315 Use the user name I<User> to authenticate. Defaults to "admin".
5317 =item B<Password> I<Password>
5319 Set the password used to authenticate.
5321 =item B<CollectInterface> B<true>|B<false>
5323 When set to B<true>, interface statistics will be collected for all interfaces
5324 present on the device. Defaults to B<false>.
5326 =item B<CollectRegistrationTable> B<true>|B<false>
5328 When set to B<true>, information about wireless LAN connections will be
5329 collected. Defaults to B<false>.
5331 =item B<CollectCPULoad> B<true>|B<false>
5333 When set to B<true>, information about the CPU usage will be collected. The
5334 number is a dimensionless value where zero indicates no CPU usage at all.
5335 Defaults to B<false>.
5337 =item B<CollectMemory> B<true>|B<false>
5339 When enabled, the amount of used and free memory will be collected. How used
5340 memory is calculated is unknown, for example whether or not caches are counted
5342 Defaults to B<false>.
5344 =item B<CollectDF> B<true>|B<false>
5346 When enabled, the amount of used and free disk space will be collected.
5347 Defaults to B<false>.
5349 =item B<CollectDisk> B<true>|B<false>
5351 When enabled, the number of sectors written and bad blocks will be collected.
5352 Defaults to B<false>.
5356 =head2 Plugin C<redis>
5358 The I<Redis plugin> connects to one or more Redis servers and gathers
5359 information about each server's state. For each server there is a I<Node> block
5360 which configures the connection parameters for this node.
5370 The information shown in the synopsis above is the I<default configuration>
5371 which is used by the plugin if no configuration is present.
5375 =item B<Node> I<Nodename>
5377 The B<Node> block identifies a new Redis node, that is a new Redis instance
5378 running in an specified host and port. The name for node is a canonical
5379 identifier which is used as I<plugin instance>. It is limited to
5380 64E<nbsp>characters in length.
5382 =item B<Host> I<Hostname>
5384 The B<Host> option is the hostname or IP-address where the Redis instance is
5387 =item B<Port> I<Port>
5389 The B<Port> option is the TCP port on which the Redis instance accepts
5390 connections. Either a service name of a port number may be given. Please note
5391 that numerical port numbers must be given as a string, too.
5393 =item B<Password> I<Password>
5395 Use I<Password> to authenticate when connecting to I<Redis>.
5397 =item B<Timeout> I<Timeout in miliseconds>
5399 The B<Timeout> option set the socket timeout for node response. Since the Redis
5400 read function is blocking, you should keep this value as low as possible. Keep
5401 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
5402 than B<Interval> defined globally.
5406 =head2 Plugin C<rrdcached>
5408 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
5409 to store values to RRD files in an efficient manner. The combination of the
5410 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
5411 way the C<rrdtool> plugin works (see below). The added abstraction layer
5412 provides a number of benefits, though: Because the cache is not within
5413 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
5414 restarted. This results in much shorter (if any) gaps in graphs, especially
5415 under heavy load. Also, the C<rrdtool> command line utility is aware of the
5416 daemon so that it can flush values to disk automatically when needed. This
5417 allows to integrate automated flushing of values into graphing solutions much
5420 There are disadvantages, though: The daemon may reside on a different host, so
5421 it may not be possible for C<collectd> to create the appropriate RRD files
5422 anymore. And even if C<rrdcached> runs on the same host, it may run in a
5423 different base directory, so relative paths may do weird stuff if you're not
5426 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
5427 on the same host, communicating via a UNIX domain socket. The B<DataDir>
5428 setting should be set to an absolute path, so that a changed base directory
5429 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
5433 =item B<DaemonAddress> I<Address>
5435 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
5436 library. See L<rrdcached(1)> for details. Example:
5438 <Plugin "rrdcached">
5439 DaemonAddress "unix:/var/run/rrdcached.sock"
5442 =item B<DataDir> I<Directory>
5444 Set the base directory in which the RRD files reside. If this is a relative
5445 path, it is relative to the working base directory of the C<rrdcached> daemon!
5446 Use of an absolute path is recommended.
5448 =item B<CreateFiles> B<true>|B<false>
5450 Enables or disables the creation of RRD files. If the daemon is not running
5451 locally, or B<DataDir> is set to a relative path, this will not work as
5452 expected. Default is B<true>.
5454 =item B<CreateFilesAsync> B<false>|B<true>
5456 When enabled, new RRD files are enabled asynchronously, using a separate thread
5457 that runs in the background. This prevents writes to block, which is a problem
5458 especially when many hundreds of files need to be created at once. However,
5459 since the purpose of creating the files asynchronously is I<not> to block until
5460 the file is available, values before the file is available will be discarded.
5461 When disabled (the default) files are created synchronously, blocking for a
5462 short while, while the file is being written.
5464 =item B<StepSize> I<Seconds>
5466 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5467 this setting is unset and the stepsize is set to the interval in which the data
5468 is collected. Do not use this option unless you absolutely have to for some
5469 reason. Setting this option may cause problems with the C<snmp plugin>, the
5470 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5472 =item B<HeartBeat> I<Seconds>
5474 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5475 in which case the heartbeat is set to twice the B<StepSize> which should equal
5476 the interval in which data is collected. Do not set this option unless you have
5477 a very good reason to do so.
5479 =item B<RRARows> I<NumRows>
5481 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5482 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5483 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5484 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5485 week, one month, and one year.
5487 So for each timespan, it calculates how many PDPs need to be consolidated into
5488 one CDP by calculating:
5489 number of PDPs = timespan / (stepsize * rrarows)
5491 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5494 =item B<RRATimespan> I<Seconds>
5496 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5497 more then one RRA. If this option is never used, the built-in default of (3600,
5498 86400, 604800, 2678400, 31622400) is used.
5500 For more information on how RRA-sizes are calculated see B<RRARows> above.
5502 =item B<XFF> I<Factor>
5504 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5505 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5510 =head2 Plugin C<rrdtool>
5512 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
5513 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
5514 using these settings. If you don't want to dive into the depths of RRDtool, you
5515 can safely ignore these settings.
5519 =item B<DataDir> I<Directory>
5521 Set the directory to store RRD files under. By default RRD files are generated
5522 beneath the daemon's working directory, i.e. the B<BaseDir>.
5524 =item B<CreateFilesAsync> B<false>|B<true>
5526 When enabled, new RRD files are enabled asynchronously, using a separate thread
5527 that runs in the background. This prevents writes to block, which is a problem
5528 especially when many hundreds of files need to be created at once. However,
5529 since the purpose of creating the files asynchronously is I<not> to block until
5530 the file is available, values before the file is available will be discarded.
5531 When disabled (the default) files are created synchronously, blocking for a
5532 short while, while the file is being written.
5534 =item B<StepSize> I<Seconds>
5536 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5537 this setting is unset and the stepsize is set to the interval in which the data
5538 is collected. Do not use this option unless you absolutely have to for some
5539 reason. Setting this option may cause problems with the C<snmp plugin>, the
5540 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5542 =item B<HeartBeat> I<Seconds>
5544 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5545 in which case the heartbeat is set to twice the B<StepSize> which should equal
5546 the interval in which data is collected. Do not set this option unless you have
5547 a very good reason to do so.
5549 =item B<RRARows> I<NumRows>
5551 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5552 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5553 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5554 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5555 week, one month, and one year.
5557 So for each timespan, it calculates how many PDPs need to be consolidated into
5558 one CDP by calculating:
5559 number of PDPs = timespan / (stepsize * rrarows)
5561 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5564 =item B<RRATimespan> I<Seconds>
5566 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5567 more then one RRA. If this option is never used, the built-in default of (3600,
5568 86400, 604800, 2678400, 31622400) is used.
5570 For more information on how RRA-sizes are calculated see B<RRARows> above.
5572 =item B<XFF> I<Factor>
5574 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5575 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5578 =item B<CacheFlush> I<Seconds>
5580 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
5581 it writes all values for a certain RRD-file if the oldest value is older than
5582 (or equal to) the number of seconds specified. If some RRD-file is not updated
5583 anymore for some reason (the computer was shut down, the network is broken,
5584 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
5585 entire cache is searched for entries older than B<CacheTimeout> seconds and
5586 written to disk every I<Seconds> seconds. Since this is kind of expensive and
5587 does nothing under normal circumstances, this value should not be too small.
5588 900 seconds might be a good value, though setting this to 7200 seconds doesn't
5589 normally do much harm either.
5591 =item B<CacheTimeout> I<Seconds>
5593 If this option is set to a value greater than zero, the C<rrdtool plugin> will
5594 save values in a cache, as described above. Writing multiple values at once
5595 reduces IO-operations and thus lessens the load produced by updating the files.
5596 The trade off is that the graphs kind of "drag behind" and that more memory is
5599 =item B<WritesPerSecond> I<Updates>
5601 When collecting many statistics with collectd and the C<rrdtool> plugin, you
5602 will run serious performance problems. The B<CacheFlush> setting and the
5603 internal update queue assert that collectd continues to work just fine even
5604 under heavy load, but the system may become very unresponsive and slow. This is
5605 a problem especially if you create graphs from the RRD files on the same
5606 machine, for example using the C<graph.cgi> script included in the
5607 C<contrib/collection3/> directory.
5609 This setting is designed for very large setups. Setting this option to a value
5610 between 25 and 80 updates per second, depending on your hardware, will leave
5611 the server responsive enough to draw graphs even while all the cached values
5612 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
5613 by the B<FLUSH> command, are B<not> effected by this limit. They are still
5614 written as fast as possible, so that web frontends have up to date data when
5617 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
5618 updates per second, writing all values to disk will take approximately
5619 56E<nbsp>minutes. Together with the flushing ability that's integrated into
5620 "collection3" you'll end up with a responsive and fast system, up to date
5621 graphs and basically a "backup" of your values every hour.
5623 =item B<RandomTimeout> I<Seconds>
5625 When set, the actual timeout for each value is chosen randomly between
5626 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
5627 intention is to avoid high load situations that appear when many values timeout
5628 at the same time. This is especially a problem shortly after the daemon starts,
5629 because all values were added to the internal cache at roughly the same time.
5633 =head2 Plugin C<sensors>
5635 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
5636 that all the needed modules have to be loaded and lm_sensors has to be
5637 configured (most likely by editing F</etc/sensors.conf>. Read
5638 L<sensors.conf(5)> for details.
5640 The B<lm_sensors> homepage can be found at
5641 L<http://secure.netroedge.com/~lm78/>.
5645 =item B<SensorConfigFile> I<File>
5647 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
5648 the library's default will be used.
5650 =item B<Sensor> I<chip-bus-address/type-feature>
5652 Selects the name of the sensor which you want to collect or ignore, depending
5653 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
5654 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
5655 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
5657 =item B<IgnoreSelected> I<true>|I<false>
5659 If no configuration if given, the B<sensors>-plugin will collect data from all
5660 sensors. This may not be practical, especially for uninteresting sensors.
5661 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
5662 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
5663 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
5664 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
5665 and all other sensors are collected.
5669 =head2 Plugin C<sigrok>
5671 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
5672 supported by the L<sigrok|http://sigrok.org/> project.
5678 <Device "AC Voltage">
5683 <Device "Sound Level">
5684 Driver "cem-dt-885x"
5691 =item B<LogLevel> B<0-5>
5693 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
5694 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
5695 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
5696 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
5697 their level, are always submitted to I<collectd> at its INFO log level.
5699 =item E<lt>B<Device> I<Name>E<gt>
5701 A sigrok-supported device, uniquely identified by this section's options. The
5702 I<Name> is passed to I<collectd> as the I<plugin instance>.
5704 =item B<Driver> I<DriverName>
5706 The sigrok driver to use for this device.
5708 =item B<Conn> I<ConnectionSpec>
5710 If the device cannot be auto-discovered, or more than one might be discovered
5711 by the driver, I<ConnectionSpec> specifies the connection string to the device.
5712 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
5713 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
5714 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
5715 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
5717 =item B<SerialComm> I<SerialSpec>
5719 For serial devices with non-standard port settings, this option can be used
5720 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
5721 This should not be necessary; drivers know how to communicate with devices they
5724 =item B<MinimumInterval> I<Seconds>
5726 Specifies the minimum time between measurement dispatches to I<collectd>, in
5727 seconds. Since some I<sigrok> supported devices can acquire measurements many
5728 times per second, it may be necessary to throttle these. For example, the
5729 I<RRD plugin> cannot process writes more than once per second.
5731 The default B<MinimumInterval> is B<0>, meaning measurements received from the
5732 device are always dispatched to I<collectd>. When throttled, unused
5733 measurements are discarded.
5737 =head2 Plugin C<snmp>
5739 Since the configuration of the C<snmp plugin> is a little more complicated than
5740 other plugins, its documentation has been moved to an own manpage,
5741 L<collectd-snmp(5)>. Please see there for details.
5743 =head2 Plugin C<statsd>
5745 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
5746 protocol and dispatches rates or other aggregates of these numbers
5749 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
5750 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
5751 C<objects> respectively.
5753 The following configuration options are valid:
5757 =item B<Host> I<Host>
5759 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
5760 "any" address, i.e. accept packets sent to any of the hosts addresses.
5762 =item B<Port> I<Port>
5764 UDP port to listen to. This can be either a service name or a port number.
5765 Defaults to C<8125>.
5767 =item B<DeleteCounters> B<false>|B<true>
5769 =item B<DeleteTimers> B<false>|B<true>
5771 =item B<DeleteGauges> B<false>|B<true>
5773 =item B<DeleteSets> B<false>|B<true>
5775 These options control what happens if metrics are not updated in an interval.
5776 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
5777 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
5778 are unchanged. If set to B<True>, the such metrics are not dispatched and
5779 removed from the internal cache.
5781 =item B<TimerPercentile> I<Percent>
5783 Calculate and dispatch the configured percentile, i.e. compute the latency, so
5784 that I<Percent> of all reported timers are smaller than or equal to the
5785 computed latency. This is useful for cutting off the long tail latency, as it's
5786 often done in I<Service Level Agreements> (SLAs).
5788 If not specified, no percentile is calculated / dispatched.
5792 =head2 Plugin C<swap>
5794 The I<Swap plugin> collects information about used and available swap space. On
5795 I<Linux> and I<Solaris>, the following options are available:
5799 =item B<ReportByDevice> B<false>|B<true>
5801 Configures how to report physical swap devices. If set to B<false> (the
5802 default), the summary over all swap devices is reported only, i.e. the globally
5803 used and available space over all devices. If B<true> is configured, the used
5804 and available space of each device will be reported separately.
5806 This option is only available if the I<Swap plugin> can read C</proc/swaps>
5807 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
5809 =item B<ReportBytes> B<false>|B<true>
5811 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
5812 I<swap I/O> is reported in pages. This option is available under Linux only.
5814 =item B<ValuesAbsolute> B<true>|B<false>
5816 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
5817 available and used. Defaults to B<true>.
5819 =item B<ValuesPercentage> B<false>|B<true>
5821 Enables or disables reporting of relative swap metrics, i.e. I<percent>
5822 available and free. Defaults to B<false>.
5824 This is useful for deploying I<collectd> in a heterogeneous environment, where
5825 swap sizes differ and you want to specify generic thresholds or similar.
5829 =head2 Plugin C<syslog>
5833 =item B<LogLevel> B<debug|info|notice|warning|err>
5835 Sets the log-level. If, for example, set to B<notice>, then all events with
5836 severity B<notice>, B<warning>, or B<err> will be submitted to the
5839 Please note that B<debug> is only available if collectd has been compiled with
5842 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
5844 Controls which notifications should be sent to syslog. The default behaviour is
5845 not to send any. Less severe notifications always imply logging more severe
5846 notifications: Setting this to B<OKAY> means all notifications will be sent to
5847 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
5848 notifications but will dismiss B<OKAY> notifications. Setting this option to
5849 B<FAILURE> will only send failures to syslog.
5853 =head2 Plugin C<table>
5855 The C<table plugin> provides generic means to parse tabular data and dispatch
5856 user specified values. Values are selected based on column numbers. For
5857 example, this plugin may be used to get values from the Linux L<proc(5)>
5858 filesystem or CSV (comma separated values) files.
5861 <Table "/proc/slabinfo">
5866 InstancePrefix "active_objs"
5872 InstancePrefix "objperslab"
5879 The configuration consists of one or more B<Table> blocks, each of which
5880 configures one file to parse. Within each B<Table> block, there are one or
5881 more B<Result> blocks, which configure which data to select and how to
5884 The following options are available inside a B<Table> block:
5888 =item B<Instance> I<instance>
5890 If specified, I<instance> is used as the plugin instance. So, in the above
5891 example, the plugin name C<table-slabinfo> would be used. If omitted, the
5892 filename of the table is used instead, with all special characters replaced
5893 with an underscore (C<_>).
5895 =item B<Separator> I<string>
5897 Any character of I<string> is interpreted as a delimiter between the different
5898 columns of the table. A sequence of two or more contiguous delimiters in the
5899 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
5900 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
5901 of a table - see its documentation for more details. This option is mandatory.
5903 A horizontal tab, newline and carriage return may be specified by C<\\t>,
5904 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
5905 required because of collectd's config parsing.
5909 The following options are available inside a B<Result> block:
5913 =item B<Type> I<type>
5915 Sets the type used to dispatch the values to the daemon. Detailed information
5916 about types and their configuration can be found in L<types.db(5)>. This
5917 option is mandatory.
5919 =item B<InstancePrefix> I<prefix>
5921 If specified, prepend I<prefix> to the type instance. If omitted, only the
5922 B<InstancesFrom> option is considered for the type instance.
5924 =item B<InstancesFrom> I<column0> [I<column1> ...]
5926 If specified, the content of the given columns (identified by the column
5927 number starting at zero) will be used to create the type instance for each
5928 row. Multiple values (and the instance prefix) will be joined together with
5929 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
5930 option is considered for the type instance.
5932 The plugin itself does not check whether or not all built instances are
5933 different. It’s your responsibility to assure that each is unique. This is
5934 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
5935 sure that the table only contains one row.
5937 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
5940 =item B<ValuesFrom> I<column0> [I<column1> ...]
5942 Specifies the columns (identified by the column numbers starting at zero)
5943 whose content is used as the actual data for the data sets that are dispatched
5944 to the daemon. How many such columns you need is determined by the B<Type>
5945 setting above. If you specify too many or not enough columns, the plugin will
5946 complain about that and no data will be submitted to the daemon. The plugin
5947 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
5948 respectively, so anything supported by those functions is supported by the
5949 plugin as well. This option is mandatory.
5953 =head2 Plugin C<tail>
5955 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
5956 each line and dispatches found values. What is matched can be configured by the
5957 user using (extended) regular expressions, as described in L<regex(7)>.
5960 <File "/var/log/exim4/mainlog">
5964 Regex "S=([1-9][0-9]*)"
5970 Regex "\\<R=local_user\\>"
5971 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
5974 Instance "local_user"
5979 The config consists of one or more B<File> blocks, each of which configures one
5980 logfile to parse. Within each B<File> block, there are one or more B<Match>
5981 blocks, which configure a regular expression to search for.
5983 The B<Instance> option in the B<File> block may be used to set the plugin
5984 instance. So in the above example the plugin name C<tail-foo> would be used.
5985 This plugin instance is for all B<Match> blocks that B<follow> it, until the
5986 next B<Instance> option. This way you can extract several plugin instances from
5987 one logfile, handy when parsing syslog and the like.
5989 The B<Interval> option allows you to define the length of time between reads. If
5990 this is not set, the default Interval will be used.
5992 Each B<Match> block has the following options to describe how the match should
5997 =item B<Regex> I<regex>
5999 Sets the regular expression to use for matching against a line. The first
6000 subexpression has to match something that can be turned into a number by
6001 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
6002 below. Because B<extended> regular expressions are used, you do not need to use
6003 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
6004 collectd's config parsing you need to escape backslashes, though. So if you
6005 want to match literal parentheses you need to do the following:
6007 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
6009 =item B<ExcludeRegex> I<regex>
6011 Sets an optional regular expression to use for excluding lines from the match.
6012 An example which excludes all connections from localhost from the match:
6014 ExcludeRegex "127\\.0\\.0\\.1"
6016 =item B<DSType> I<Type>
6018 Sets how the values are cumulated. I<Type> is one of:
6022 =item B<GaugeAverage>
6024 Calculate the average.
6028 Use the smallest number only.
6032 Use the greatest number only.
6036 Use the last number found.
6042 =item B<AbsoluteSet>
6044 The matched number is a counter. Simply I<sets> the internal counter to this
6045 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
6051 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
6052 matched number may be negative, which will effectively subtract from the
6059 Increase the internal counter by one. These B<DSType> are the only ones that do
6060 not use the matched subexpression, but simply count the number of matched
6061 lines. Thus, you may use a regular expression without submatch in this case.
6065 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
6066 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
6067 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
6068 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
6069 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
6072 =item B<Type> I<Type>
6074 Sets the type used to dispatch this value. Detailed information about types and
6075 their configuration can be found in L<types.db(5)>.
6077 =item B<Instance> I<TypeInstance>
6079 This optional setting sets the type instance to use.
6083 =head2 Plugin C<tail_csv>
6085 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
6086 written by I<Snort>.
6091 <Metric "snort-dropped">
6096 <File "/var/log/snort/snort.stats">
6097 Instance "snort-eth0"
6099 Collect "snort-dropped"
6103 The configuration consists of one or more B<Metric> blocks that define an index
6104 into the line of the CSV file and how this value is mapped to I<collectd's>
6105 internal representation. These are followed by one or more B<Instance> blocks
6106 which configure which file to read, in which interval and which metrics to
6111 =item E<lt>B<Metric> I<Name>E<gt>
6113 The B<Metric> block configures a new metric to be extracted from the statistics
6114 file and how it is mapped on I<collectd's> data model. The string I<Name> is
6115 only used inside the B<Instance> blocks to refer to this block, so you can use
6116 one B<Metric> block for multiple CSV files.
6120 =item B<Type> I<Type>
6122 Configures which I<Type> to use when dispatching this metric. Types are defined
6123 in the L<types.db(5)> file, see the appropriate manual page for more
6124 information on specifying types. Only types with a single I<data source> are
6125 supported by the I<tail_csv plugin>. The information whether the value is an
6126 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
6127 I<Type's> definition.
6129 =item B<Instance> I<TypeInstance>
6131 If set, I<TypeInstance> is used to populate the type instance field of the
6132 created value lists. Otherwise, no type instance is used.
6134 =item B<ValueFrom> I<Index>
6136 Configure to read the value from the field with the zero-based index I<Index>.
6137 If the value is parsed as signed integer, unsigned integer or double depends on
6138 the B<Type> setting, see above.
6142 =item E<lt>B<File> I<Path>E<gt>
6144 Each B<File> block represents one CSV file to read. There must be at least one
6145 I<File> block but there can be multiple if you have multiple CSV files.
6149 =item B<Instance> I<PluginInstance>
6151 Sets the I<plugin instance> used when dispatching the values.
6153 =item B<Collect> I<Metric>
6155 Specifies which I<Metric> to collect. This option must be specified at least
6156 once, and you can use this option multiple times to specify more than one
6157 metric to be extracted from this statistic file.
6159 =item B<Interval> I<Seconds>
6161 Configures the interval in which to read values from this instance / file.
6162 Defaults to the plugin's default interval.
6164 =item B<TimeFrom> I<Index>
6166 Rather than using the local time when dispatching a value, read the timestamp
6167 from the field with the zero-based index I<Index>. The value is interpreted as
6168 seconds since epoch. The value is parsed as a double and may be factional.
6174 =head2 Plugin C<teamspeak2>
6176 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
6177 polls interesting global and virtual server data. The plugin can query only one
6178 physical server but unlimited virtual servers. You can use the following
6179 options to configure it:
6183 =item B<Host> I<hostname/ip>
6185 The hostname or ip which identifies the physical server.
6188 =item B<Port> I<port>
6190 The query port of the physical server. This needs to be a string.
6193 =item B<Server> I<port>
6195 This option has to be added once for every virtual server the plugin should
6196 query. If you want to query the virtual server on port 8767 this is what the
6197 option would look like:
6201 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
6202 use quotes around it! If no such statement is given only global information
6207 =head2 Plugin C<ted>
6209 The I<TED> plugin connects to a device of "The Energy Detective", a device to
6210 measure power consumption. These devices are usually connected to a serial
6211 (RS232) or USB port. The plugin opens a configured device and tries to read the
6212 current energy readings. For more information on TED, visit
6213 L<http://www.theenergydetective.com/>.
6215 Available configuration options:
6219 =item B<Device> I<Path>
6221 Path to the device on which TED is connected. collectd will need read and write
6222 permissions on that file.
6224 Default: B</dev/ttyUSB0>
6226 =item B<Retries> I<Num>
6228 Apparently reading from TED is not that reliable. You can therefore configure a
6229 number of retries here. You only configure the I<retries> here, to if you
6230 specify zero, one reading will be performed (but no retries if that fails); if
6231 you specify three, a maximum of four readings are performed. Negative values
6238 =head2 Plugin C<tcpconns>
6240 The C<tcpconns plugin> counts the number of currently established TCP
6241 connections based on the local port and/or the remote port. Since there may be
6242 a lot of connections the default if to count all connections with a local port,
6243 for which a listening socket is opened. You can use the following options to
6244 fine-tune the ports you are interested in:
6248 =item B<ListeningPorts> I<true>|I<false>
6250 If this option is set to I<true>, statistics for all local ports for which a
6251 listening socket exists are collected. The default depends on B<LocalPort> and
6252 B<RemotePort> (see below): If no port at all is specifically selected, the
6253 default is to collect listening ports. If specific ports (no matter if local or
6254 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
6255 the selected ports will be collected unless this option is set to I<true>
6258 =item B<LocalPort> I<Port>
6260 Count the connections to a specific local port. This can be used to see how
6261 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
6262 You have to specify the port in numeric form, so for the mailserver example
6263 you'd need to set B<25>.
6265 =item B<RemotePort> I<Port>
6267 Count the connections to a specific remote port. This is useful to see how
6268 much a remote service is used. This is most useful if you want to know how many
6269 connections a local service has opened to remote services, e.E<nbsp>g. how many
6270 connections a mail server or news server has to other mail or news servers, or
6271 how many connections a web proxy holds to web servers. You have to give the
6272 port in numeric form.
6276 =head2 Plugin C<thermal>
6280 =item B<ForceUseProcfs> I<true>|I<false>
6282 By default, the I<Thermal plugin> tries to read the statistics from the Linux
6283 C<sysfs> interface. If that is not available, the plugin falls back to the
6284 C<procfs> interface. By setting this option to I<true>, you can force the
6285 plugin to use the latter. This option defaults to I<false>.
6287 =item B<Device> I<Device>
6289 Selects the name of the thermal device that you want to collect or ignore,
6290 depending on the value of the B<IgnoreSelected> option. This option may be
6291 used multiple times to specify a list of devices.
6293 =item B<IgnoreSelected> I<true>|I<false>
6295 Invert the selection: If set to true, all devices B<except> the ones that
6296 match the device names specified by the B<Device> option are collected. By
6297 default only selected devices are collected if a selection is made. If no
6298 selection is configured at all, B<all> devices are selected.
6302 =head2 Plugin C<threshold>
6304 The I<Threshold plugin> checks values collected or received by I<collectd>
6305 against a configurable I<threshold> and issues I<notifications> if values are
6308 Documentation for this plugin is available in the L<collectd-threshold(5)>
6311 =head2 Plugin C<tokyotyrant>
6313 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
6314 couple metrics: number of records, and database size on disk.
6318 =item B<Host> I<Hostname/IP>
6320 The hostname or ip which identifies the server.
6321 Default: B<127.0.0.1>
6323 =item B<Port> I<Service/Port>
6325 The query port of the server. This needs to be a string, even if the port is
6326 given in its numeric form.
6331 =head2 Plugin C<unixsock>
6335 =item B<SocketFile> I<Path>
6337 Sets the socket-file which is to be created.
6339 =item B<SocketGroup> I<Group>
6341 If running as root change the group of the UNIX-socket after it has been
6342 created. Defaults to B<collectd>.
6344 =item B<SocketPerms> I<Permissions>
6346 Change the file permissions of the UNIX-socket after it has been created. The
6347 permissions must be given as a numeric, octal value as you would pass to
6348 L<chmod(1)>. Defaults to B<0770>.
6350 =item B<DeleteSocket> B<false>|B<true>
6352 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
6353 with the given name already exists. If I<collectd> crashes a socket file may be
6354 left over, preventing the daemon from opening a new socket when restarted.
6355 Since this is potentially dangerous, this defaults to B<false>.
6359 =head2 Plugin C<uuid>
6361 This plugin, if loaded, causes the Hostname to be taken from the machine's
6362 UUID. The UUID is a universally unique designation for the machine, usually
6363 taken from the machine's BIOS. This is most useful if the machine is running in
6364 a virtual environment such as Xen, in which case the UUID is preserved across
6365 shutdowns and migration.
6367 The following methods are used to find the machine's UUID, in order:
6373 Check I</etc/uuid> (or I<UUIDFile>).
6377 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
6382 Check for UUID from C<dmidecode> / SMBIOS.
6386 Check for UUID from Xen hypervisor.
6390 If no UUID can be found then the hostname is not modified.
6394 =item B<UUIDFile> I<Path>
6396 Take the UUID from the given file (default I</etc/uuid>).
6400 =head2 Plugin C<varnish>
6402 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
6407 <Instance "example">
6409 CollectConnections true
6419 CollectWorkers false
6423 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
6424 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
6425 will collectd statistics from the default "varnishd" instance (this should work
6426 fine in most cases).
6428 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
6432 =item B<CollectCache> B<true>|B<false>
6434 Cache hits and misses. True by default.
6436 =item B<CollectConnections> B<true>|B<false>
6438 Number of client connections received, accepted and dropped. True by default.
6440 =item B<CollectBackend> B<true>|B<false>
6442 Back-end connection statistics, such as successful, reused,
6443 and closed connections. True by default.
6445 =item B<CollectSHM> B<true>|B<false>
6447 Statistics about the shared memory log, a memory region to store
6448 log messages which is flushed to disk when full. True by default.
6450 =item B<CollectBan> B<true>|B<false>
6452 Statistics about ban operations, such as number of bans added, retired, and
6453 number of objects tested against ban operations. Only available with Varnish
6454 3.x. False by default.
6456 =item B<CollectDirectorDNS> B<true>|B<false>
6458 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
6461 =item B<CollectESI> B<true>|B<false>
6463 Edge Side Includes (ESI) parse statistics. False by default.
6465 =item B<CollectFetch> B<true>|B<false>
6467 Statistics about fetches (HTTP requests sent to the backend). False by default.
6469 =item B<CollectHCB> B<true>|B<false>
6471 Inserts and look-ups in the crit bit tree based hash. Look-ups are
6472 divided into locked and unlocked look-ups. False by default.
6474 =item B<CollectObjects> B<true>|B<false>
6476 Statistics on cached objects: number of objects expired, nuked (prematurely
6477 expired), saved, moved, etc. False by default.
6479 =item B<CollectPurge> B<true>|B<false>
6481 Statistics about purge operations, such as number of purges added, retired, and
6482 number of objects tested against purge operations. Only available with Varnish
6483 2.x. False by default.
6485 =item B<CollectSession> B<true>|B<false>
6487 Client session statistics. Number of past and current sessions, session herd and
6488 linger counters, etc. False by default.
6490 =item B<CollectSMA> B<true>|B<false>
6492 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
6493 component is Solaris specific. Only available with Varnish 2.x. False by
6496 =item B<CollectSMS> B<true>|B<false>
6498 synth (synthetic content) storage statistics. This storage
6499 component is used internally only. False by default.
6501 =item B<CollectSM> B<true>|B<false>
6503 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
6506 =item B<CollectStruct> B<true>|B<false>
6508 Current varnish internal state statistics. Number of current sessions, objects
6509 in cache store, open connections to backends (with Varnish 2.x), etc. False by
6512 =item B<CollectTotals> B<true>|B<false>
6514 Collects overview counters, such as the number of sessions created,
6515 the number of requests and bytes transferred. False by default.
6517 =item B<CollectUptime> B<true>|B<false>
6519 Varnish uptime. False by default.
6521 =item B<CollectVCL> B<true>|B<false>
6523 Number of total (available + discarded) VCL (config files). False by default.
6525 =item B<CollectWorkers> B<true>|B<false>
6527 Collect statistics about worker threads. False by default.
6531 =head2 Plugin C<vmem>
6533 The C<vmem> plugin collects information about the usage of virtual memory.
6534 Since the statistics provided by the Linux kernel are very detailed, they are
6535 collected very detailed. However, to get all the details, you have to switch
6536 them on manually. Most people just want an overview over, such as the number of
6537 pages read from swap space.
6541 =item B<Verbose> B<true>|B<false>
6543 Enables verbose collection of information. This will start collecting page
6544 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
6545 Part of these statistics are collected on a "per zone" basis.
6549 =head2 Plugin C<vserver>
6551 This plugin doesn't have any options. B<VServer> support is only available for
6552 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
6553 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
6554 need to apply the patches and compile your own kernel, which will then provide
6555 the F</proc/virtual> filesystem that is required by this plugin.
6557 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
6559 B<Note>: The traffic collected by this plugin accounts for the amount of
6560 traffic passing a socket which might be a lot less than the actual on-wire
6561 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
6562 collect on-wire traffic you could, for example, use the logging facilities of
6563 iptables to feed data for the guest IPs into the iptables plugin.
6565 =head2 Plugin C<write_graphite>
6567 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
6568 storage and graphing project. The plugin connects to I<Carbon>, the data layer
6569 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
6570 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
6571 of at most 1428 bytes to minimize the number of network packets.
6575 <Plugin write_graphite>
6585 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6586 blocks. Inside the B<Node> blocks, the following options are recognized:
6590 =item B<Host> I<Address>
6592 Hostname or address to connect to. Defaults to C<localhost>.
6594 =item B<Port> I<Service>
6596 Service name or port number to connect to. Defaults to C<2003>.
6598 =item B<Protocol> I<String>
6600 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
6602 =item B<LogSendErrors> B<false>|B<true>
6604 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
6605 If set to B<false>, it will not log the errors. This is especially useful when
6606 using Protocol UDP since many times we want to use the "fire-and-forget"
6607 approach and logging errors fills syslog with unneeded messages.
6609 =item B<Prefix> I<String>
6611 When set, I<String> is added in front of the host name. Dots and whitespace are
6612 I<not> escaped in this string (see B<EscapeCharacter> below).
6614 =item B<Postfix> I<String>
6616 When set, I<String> is appended to the host name. Dots and whitespace are
6617 I<not> escaped in this string (see B<EscapeCharacter> below).
6619 =item B<EscapeCharacter> I<Char>
6621 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
6622 in the identifier. The B<EscapeCharacter> option determines which character
6623 dots, whitespace and control characters are replaced with. Defaults to
6626 =item B<StoreRates> B<false>|B<true>
6628 If set to B<true> (the default), convert counter values to rates. If set to
6629 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6632 =item B<SeparateInstances> B<false>|B<true>
6634 If set to B<true>, the plugin instance and type instance will be in their own
6635 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6636 default), the plugin and plugin instance (and likewise the type and type
6637 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6639 =item B<AlwaysAppendDS> B<false>|B<true>
6641 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
6642 identifier. If set to B<false> (the default), this is only done when there is
6647 =head2 Plugin C<write_tsdb>
6649 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
6650 time series database. The plugin connects to a I<TSD>, a masterless, no shared
6651 state daemon that ingests metrics and stores them in HBase. The plugin uses
6652 I<TCP> over the "line based" protocol with a default port 4242. The data will
6653 be sent in blocks of at most 1428 bytes to minimize the number of network
6660 Host "tsd-1.my.domain"
6662 HostTags "status=production"
6666 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6667 blocks. Inside the B<Node> blocks, the following options are recognized:
6671 =item B<Host> I<Address>
6673 Hostname or address to connect to. Defaults to C<localhost>.
6675 =item B<Port> I<Service>
6677 Service name or port number to connect to. Defaults to C<4242>.
6680 =item B<HostTags> I<String>
6682 When set, I<HostTags> is added to the end of the metric. It is intended to be
6683 used for name=value pairs that the TSD will tag the metric with. Dots and
6684 whitespace are I<not> escaped in this string.
6686 =item B<StoreRates> B<false>|B<true>
6688 If set to B<true>, convert counter values to rates. If set to B<false>
6689 (the default) counter values are stored as is, as an increasing
6692 =item B<AlwaysAppendDS> B<false>|B<true>
6694 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
6695 identifier. If set to B<false> (the default), this is only done when there is
6700 =head2 Plugin C<write_mongodb>
6702 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
6707 <Plugin "write_mongodb">
6716 The plugin can send values to multiple instances of I<MongoDB> by specifying
6717 one B<Node> block for each instance. Within the B<Node> blocks, the following
6718 options are available:
6722 =item B<Host> I<Address>
6724 Hostname or address to connect to. Defaults to C<localhost>.
6726 =item B<Port> I<Service>
6728 Service name or port number to connect to. Defaults to C<27017>.
6730 =item B<Timeout> I<Timeout>
6732 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
6733 Setting this option to zero means no timeout, which is the default.
6735 =item B<StoreRates> B<false>|B<true>
6737 If set to B<true> (the default), convert counter values to rates. If set to
6738 B<false> counter values are stored as is, i.e. as an increasing integer
6741 =item B<Database> I<Database>
6743 =item B<User> I<User>
6745 =item B<Password> I<Password>
6747 Sets the information used when authenticating to a I<MongoDB> database. The
6748 fields are optional (in which case no authentication is attempted), but if you
6749 want to use authentication all three fields must be set.
6753 =head2 Plugin C<write_http>
6755 This output plugin submits values to an HTTP server using POST requests and
6756 encoding metrics with JSON or using the C<PUTVAL> command described in
6757 L<collectd-unixsock(5)>. Each destination you want to post data to needs to
6758 have one B<URL> block, within which the destination can be configured further,
6759 for example by specifying authentication data.
6763 <Plugin "write_http">
6764 <URL "http://example.com/post-collectd">
6771 B<URL> blocks need one string argument which is used as the URL to which data
6772 is posted. The following options are understood within B<URL> blocks.
6776 =item B<User> I<Username>
6778 Optional user name needed for authentication.
6780 =item B<Password> I<Password>
6782 Optional password needed for authentication.
6784 =item B<VerifyPeer> B<true>|B<false>
6786 Enable or disable peer SSL certificate verification. See
6787 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
6789 =item B<VerifyHost> B<true|false>
6791 Enable or disable peer host name verification. If enabled, the plugin checks if
6792 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
6793 matches the host name provided by the B<URL> option. If this identity check
6794 fails, the connection is aborted. Obviously, only works when connecting to a
6795 SSL enabled server. Enabled by default.
6797 =item B<CACert> I<File>
6799 File that holds one or more SSL certificates. If you want to use HTTPS you will
6800 possibly need this option. What CA certificates come bundled with C<libcurl>
6801 and are checked by default depends on the distribution you use.
6803 =item B<CAPath> I<Directory>
6805 Directory holding one or more CA certificate files. You can use this if for
6806 some reason all the needed CA certificates aren't in the same file and can't be
6807 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
6810 =item B<ClientKey> I<File>
6812 File that holds the private key in PEM format to be used for certificate-based
6815 =item B<ClientCert> I<File>
6817 File that holds the SSL certificate to be used for certificate-based
6820 =item B<ClientKeyPass> I<Password>
6822 Password required to load the private key in B<ClientKey>.
6824 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
6826 Define which SSL protocol version must be used. By default C<libcurl> will
6827 attempt to figure out the remote SSL protocol version. See
6828 L<curl_easy_setopt(3)> for more details.
6830 =item B<Format> B<Command>|B<JSON>
6832 Format of the output to generate. If set to B<Command>, will create output that
6833 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
6834 create output in the I<JavaScript Object Notation> (JSON).
6836 Defaults to B<Command>.
6838 =item B<StoreRates> B<true|false>
6840 If set to B<true>, convert counter values to rates. If set to B<false> (the
6841 default) counter values are stored as is, i.e. as an increasing integer number.
6843 =item B<BufferSize> I<Bytes>
6845 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
6846 requests will be generated, but more metrics will be batched / metrics are
6847 cached for longer before being sent, introducing additional delay until they
6848 are available on the server side. I<Bytes> must be at least 1024 and cannot
6849 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
6850 Defaults to C<4096>.
6854 =head2 Plugin C<write_kafka>
6856 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
6860 <Plugin "write_kafka">
6861 Property "metadata.broker.list" "broker1:9092,broker2:9092"
6867 The following options are understood by the I<write_kafka plugin>:
6871 =item E<lt>B<Topic> I<Name>E<gt>
6873 The plugin's configuration consists of one or more B<Topic> blocks. Each block
6874 is given a unique I<Name> and specifies one kafka producer.
6875 Inside the B<Topic> block, the following per-topic options are
6880 =item B<Property> I<String> I<String>
6882 Configure the named property for the current topic. Properties are
6883 forwarded to the kafka producer library B<librdkafka>.
6885 =item B<Key> I<String>
6887 Use the specified string as a partioning key for the topic. Kafka breaks
6888 topic into partitions and guarantees that for a given topology, the same
6889 consumer will be used for a specific key. The special (case insensitive)
6890 string B<Random> can be used to specify that an arbitrary partition should
6893 =item B<Format> B<Command>|B<JSON>|B<Graphite>
6895 Selects the format in which messages are sent to the broker. If set to
6896 B<Command> (the default), values are sent as C<PUTVAL> commands which are
6897 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
6899 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
6900 an easy and straight forward exchange format.
6902 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
6903 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
6905 =item B<StoreRates> B<true>|B<false>
6907 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
6908 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
6909 default), no conversion is performed. Otherwise the conversion is performed
6910 using the internal value cache.
6912 Please note that currently this option is only used if the B<Format> option has
6913 been set to B<JSON>.
6915 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
6917 A prefix can be added in the metric name when outputting in the I<Graphite>
6918 format. It's added before the I<Host> name.
6920 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>>
6922 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
6924 A postfix can be added in the metric name when outputting in the I<Graphite>
6925 format. It's added after the I<Host> name.
6927 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>>
6929 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
6931 Specify a character to replace dots (.) in the host part of the metric name.
6932 In I<Graphite> metric name, dots are used as separators between different
6933 metric parts (host, plugin, type).
6934 Default is C<_> (I<Underscore>).
6936 =item B<GraphiteSeparateInstances> B<false>|B<true>
6938 If set to B<true>, the plugin instance and type instance will be in their own
6939 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6940 default), the plugin and plugin instance (and likewise the type and type
6941 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6943 =item B<StoreRates> B<true>|B<false>
6945 If set to B<true> (the default), convert counter values to rates. If set to
6946 B<false> counter values are stored as is, i.e. as an increasing integer number.
6948 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
6949 converted values will have "rate" appended to the data source type, e.g.
6950 C<ds_type:derive:rate>.
6954 =item B<Property> I<String> I<String>
6956 Configure the kafka producer through properties, you almost always will
6957 want to set B<metadata.broker.list> to your Kafka broker list.
6961 =head2 Plugin C<write_riemann>
6963 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
6964 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
6965 I<Riemann> using UDP packets.
6969 <Plugin "write_riemann">
6975 AlwaysAppendDS false
6979 Attribute "foo" "bar"
6982 The following options are understood by the I<write_riemann plugin>:
6986 =item E<lt>B<Node> I<Name>E<gt>
6988 The plugin's configuration consists of one or more B<Node> blocks. Each block
6989 is given a unique I<Name> and specifies one connection to an instance of
6990 I<Riemann>. Indise the B<Node> block, the following per-connection options are
6995 =item B<Host> I<Address>
6997 Hostname or address to connect to. Defaults to C<localhost>.
6999 =item B<Port> I<Service>
7001 Service name or port number to connect to. Defaults to C<5555>.
7003 =item B<Protocol> B<UDP>|B<TCP>
7005 Specify the protocol to use when communicating with I<Riemann>. Defaults to
7008 =item B<StoreRates> B<true>|B<false>
7010 If set to B<true> (the default), convert counter values to rates. If set to
7011 B<false> counter values are stored as is, i.e. as an increasing integer number.
7013 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
7014 converted values will have "rate" appended to the data source type, e.g.
7015 C<ds_type:derive:rate>.
7017 =item B<AlwaysAppendDS> B<false>|B<true>
7019 If set the B<true>, append the name of the I<Data Source> (DS) to the
7020 "service", i.e. the field that, together with the "host" field, uniquely
7021 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
7022 only done when there is more than one DS.
7024 =item B<TTLFactor> I<Factor>
7026 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
7027 event is considered active. I<collectd> populates this field based on the
7028 metrics interval setting. This setting controls the factor with which the
7029 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
7030 know exactly what you're doing, you should only increase this setting from its
7033 =item B<Notifications> B<false>|B<true>
7035 If set to B<true>, create riemann events for notifications. This is B<true>
7036 by default. When processing thresholds from write_riemann, it might prove
7037 useful to avoid getting notification events.
7039 =item B<CheckThresholds> B<false>|B<true>
7041 If set to B<true>, attach state to events based on thresholds defined
7042 in the B<Threshold> plugin. Defaults to B<false>.
7044 =item B<EventServicePrefix> I<String>
7046 Add the given string as a prefix to the event service name.
7047 If B<EventServicePrefix> not set or set to an empty string (""),
7048 no prefix will be used.
7052 =item B<Tag> I<String>
7054 Add the given string as an additional tag to the metric being sent to
7057 =item B<Attribute> I<String> I<String>
7059 Consider the two given strings to be the key and value of an additional
7060 attribute for each metric being sent out to I<Riemann>.
7064 =head1 THRESHOLD CONFIGURATION
7066 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
7067 we mean that the values are not only stored or sent somewhere, but that they
7068 are judged and, if a problem is recognized, acted upon. The only action
7069 collectd takes itself is to generate and dispatch a "notification". Plugins can
7070 register to receive notifications and perform appropriate further actions.
7072 Since systems and what you expect them to do differ a lot, you can configure
7073 B<thresholds> for your values freely. This gives you a lot of flexibility but
7074 also a lot of responsibility.
7076 Every time a value is out of range a notification is dispatched. This means
7077 that the idle percentage of your CPU needs to be less then the configured
7078 threshold only once for a notification to be generated. There's no such thing
7079 as a moving average or similar - at least not now.
7081 Also, all values that match a threshold are considered to be relevant or
7082 "interesting". As a consequence collectd will issue a notification if they are
7083 not received for B<Timeout> iterations. The B<Timeout> configuration option is
7084 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
7085 "2" (the default) and some hosts sends it's CPU statistics to the server every
7086 60 seconds, a notification will be dispatched after about 120 seconds. It may
7087 take a little longer because the timeout is checked only once each B<Interval>
7090 When a value comes within range again or is received after it was missing, an
7091 "OKAY-notification" is dispatched.
7093 Here is a configuration example to get you started. Read below for more
7106 <Plugin "interface">
7123 WarningMin 100000000
7129 There are basically two types of configuration statements: The C<Host>,
7130 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
7131 configured. The C<Plugin> and C<Type> blocks may be specified further using the
7132 C<Instance> option. You can combine the block by nesting the blocks, though
7133 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
7134 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
7135 C<Type> may not contain other blocks. If multiple blocks apply to the same
7136 value the most specific block is used.
7138 The other statements specify the threshold to configure. They B<must> be
7139 included in a C<Type> block. Currently the following statements are recognized:
7143 =item B<FailureMax> I<Value>
7145 =item B<WarningMax> I<Value>
7147 Sets the upper bound of acceptable values. If unset defaults to positive
7148 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
7149 will be created. If the value is greater than B<WarningMax> but less than (or
7150 equal to) B<FailureMax> a B<WARNING> notification will be created.
7152 =item B<FailureMin> I<Value>
7154 =item B<WarningMin> I<Value>
7156 Sets the lower bound of acceptable values. If unset defaults to negative
7157 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
7158 be created. If the value is less than B<WarningMin> but greater than (or equal
7159 to) B<FailureMin> a B<WARNING> notification will be created.
7161 =item B<DataSource> I<DSName>
7163 Some data sets have more than one "data source". Interesting examples are the
7164 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
7165 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
7166 system load data set, C<load>, even has three data sources: C<shortterm>,
7167 C<midterm>, and C<longterm>.
7169 Normally, all data sources are checked against a configured threshold. If this
7170 is undesirable, or if you want to specify different limits for each data
7171 source, you can use the B<DataSource> option to have a threshold apply only to
7174 =item B<Invert> B<true>|B<false>
7176 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
7177 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
7178 B<WarningMax>) are not okay. Defaults to B<false>.
7180 =item B<Persist> B<true>|B<false>
7182 Sets how often notifications are generated. If set to B<true> one notification
7183 will be generated for each value that is out of the acceptable range. If set to
7184 B<false> (the default) then a notification is only generated if a value is out
7185 of range but the previous value was okay.
7187 This applies to missing values, too: If set to B<true> a notification about a
7188 missing value is generated once every B<Interval> seconds. If set to B<false>
7189 only one such notification is generated until the value appears again.
7191 =item B<Percentage> B<true>|B<false>
7193 If set to B<true>, the minimum and maximum values given are interpreted as
7194 percentage value, relative to the other data sources. This is helpful for
7195 example for the "df" type, where you may want to issue a warning when less than
7196 5E<nbsp>% of the total space is available. Defaults to B<false>.
7198 =item B<Hits> I<Number>
7200 Delay creating the notification until the threshold has been passed I<Number>
7201 times. When a notification has been generated, or when a subsequent value is
7202 inside the threshold, the counter is reset. If, for example, a value is
7203 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
7204 will be dispatched at most once every 30E<nbsp>seconds.
7206 This is useful when short bursts are not a problem. If, for example, 100% CPU
7207 usage for up to a minute is normal (and data is collected every
7208 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
7210 =item B<Hysteresis> I<Number>
7212 When set to non-zero, a hysteresis value is applied when checking minimum and
7213 maximum bounds. This is useful for values that increase slowly and fluctuate a
7214 bit while doing so. When these values come close to the threshold, they may
7215 "flap", i.e. switch between failure / warning case and okay case repeatedly.
7217 If, for example, the threshold is configures as
7222 then a I<Warning> notification is created when the value exceeds I<101> and the
7223 corresponding I<Okay> notification is only created once the value falls below
7224 I<99>, thus avoiding the "flapping".
7228 =head1 FILTER CONFIGURATION
7230 Starting with collectd 4.6 there is a powerful filtering infrastructure
7231 implemented in the daemon. The concept has mostly been copied from
7232 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
7233 terminology, so that users that are familiar with iptables feel right at home.
7237 The following are the terms used in the remainder of the filter configuration
7238 documentation. For an ASCII-art schema of the mechanism, see
7239 L<"General structure"> below.
7245 A I<match> is a criteria to select specific values. Examples are, of course, the
7246 name of the value or it's current value.
7248 Matches are implemented in plugins which you have to load prior to using the
7249 match. The name of such plugins starts with the "match_" prefix.
7253 A I<target> is some action that is to be performed with data. Such actions
7254 could, for example, be to change part of the value's identifier or to ignore
7255 the value completely.
7257 Some of these targets are built into the daemon, see L<"Built-in targets">
7258 below. Other targets are implemented in plugins which you have to load prior to
7259 using the target. The name of such plugins starts with the "target_" prefix.
7263 The combination of any number of matches and at least one target is called a
7264 I<rule>. The target actions will be performed for all values for which B<all>
7265 matches apply. If the rule does not have any matches associated with it, the
7266 target action will be performed for all values.
7270 A I<chain> is a list of rules and possibly default targets. The rules are tried
7271 in order and if one matches, the associated target will be called. If a value
7272 is handled by a rule, it depends on the target whether or not any subsequent
7273 rules are considered or if traversal of the chain is aborted, see
7274 L<"Flow control"> below. After all rules have been checked, the default targets
7279 =head2 General structure
7281 The following shows the resulting structure:
7288 +---------+ +---------+ +---------+ +---------+
7289 ! Rule !->! Match !->! Match !->! Target !
7290 +---------+ +---------+ +---------+ +---------+
7293 +---------+ +---------+ +---------+
7294 ! Rule !->! Target !->! Target !
7295 +---------+ +---------+ +---------+
7302 +---------+ +---------+ +---------+
7303 ! Rule !->! Match !->! Target !
7304 +---------+ +---------+ +---------+
7314 There are four ways to control which way a value takes through the filter
7321 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
7322 process the value with another chain. When the called chain finishes, usually
7323 the next target or rule after the jump is executed.
7327 The stop condition, signaled for example by the built-in target B<stop>, causes
7328 all processing of the value to be stopped immediately.
7332 Causes processing in the current chain to be aborted, but processing of the
7333 value generally will continue. This means that if the chain was called via
7334 B<Jump>, the next target or rule after the jump will be executed. If the chain
7335 was not called by another chain, control will be returned to the daemon and it
7336 may pass the value to another chain.
7340 Most targets will signal the B<continue> condition, meaning that processing
7341 should continue normally. There is no special built-in target for this
7348 The configuration reflects this structure directly:
7350 PostCacheChain "PostCache"
7352 <Rule "ignore_mysql_show">
7355 Type "^mysql_command$"
7356 TypeInstance "^show_"
7366 The above configuration example will ignore all values where the plugin field
7367 is "mysql", the type is "mysql_command" and the type instance begins with
7368 "show_". All other values will be sent to the C<rrdtool> write plugin via the
7369 default target of the chain. Since this chain is run after the value has been
7370 added to the cache, the MySQL C<show_*> command statistics will be available
7371 via the C<unixsock> plugin.
7373 =head2 List of configuration options
7377 =item B<PreCacheChain> I<ChainName>
7379 =item B<PostCacheChain> I<ChainName>
7381 Configure the name of the "pre-cache chain" and the "post-cache chain". The
7382 argument is the name of a I<chain> that should be executed before and/or after
7383 the values have been added to the cache.
7385 To understand the implications, it's important you know what is going on inside
7386 I<collectd>. The following diagram shows how values are passed from the
7387 read-plugins to the write-plugins:
7393 + - - - - V - - - - +
7394 : +---------------+ :
7397 : +-------+-------+ :
7400 : +-------+-------+ : +---------------+
7401 : ! Cache !--->! Value Cache !
7402 : ! insert ! : +---+---+-------+
7403 : +-------+-------+ : ! !
7404 : ! ,------------' !
7406 : +-------+---+---+ : +-------+-------+
7407 : ! Post-Cache +--->! Write-Plugins !
7408 : ! Chain ! : +---------------+
7409 : +---------------+ :
7412 + - - - - - - - - - +
7414 After the values are passed from the "read" plugins to the dispatch functions,
7415 the pre-cache chain is run first. The values are added to the internal cache
7416 afterwards. The post-cache chain is run after the values have been added to the
7417 cache. So why is it such a huge deal if chains are run before or after the
7418 values have been added to this cache?
7420 Targets that change the identifier of a value list should be executed before
7421 the values are added to the cache, so that the name in the cache matches the
7422 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
7423 this cache to receive a list of all available values. If you change the
7424 identifier after the value list has been added to the cache, this may easily
7425 lead to confusion, but it's not forbidden of course.
7427 The cache is also used to convert counter values to rates. These rates are, for
7428 example, used by the C<value> match (see below). If you use the rate stored in
7429 the cache B<before> the new value is added, you will use the old, B<previous>
7430 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
7431 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
7434 Last but not last, the B<stop> target makes a difference: If the pre-cache
7435 chain returns the stop condition, the value will not be added to the cache and
7436 the post-cache chain will not be run.
7438 =item B<Chain> I<Name>
7440 Adds a new chain with a certain name. This name can be used to refer to a
7441 specific chain, for example to jump to it.
7443 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
7445 =item B<Rule> [I<Name>]
7447 Adds a new rule to the current chain. The name of the rule is optional and
7448 currently has no meaning for the daemon.
7450 Within the B<Rule> block, there may be any number of B<Match> blocks and there
7451 must be at least one B<Target> block.
7453 =item B<Match> I<Name>
7455 Adds a match to a B<Rule> block. The name specifies what kind of match should
7456 be performed. Available matches depend on the plugins that have been loaded.
7458 The arguments inside the B<Match> block are passed to the plugin implementing
7459 the match, so which arguments are valid here depends on the plugin being used.
7460 If you do not need any to pass any arguments to a match, you can use the
7465 Which is equivalent to:
7470 =item B<Target> I<Name>
7472 Add a target to a rule or a default target to a chain. The name specifies what
7473 kind of target is to be added. Which targets are available depends on the
7474 plugins being loaded.
7476 The arguments inside the B<Target> block are passed to the plugin implementing
7477 the target, so which arguments are valid here depends on the plugin being used.
7478 If you do not need any to pass any arguments to a target, you can use the
7483 This is the same as writing:
7490 =head2 Built-in targets
7492 The following targets are built into the core daemon and therefore need no
7493 plugins to be loaded:
7499 Signals the "return" condition, see the L<"Flow control"> section above. This
7500 causes the current chain to stop processing the value and returns control to
7501 the calling chain. The calling chain will continue processing targets and rules
7502 just after the B<jump> target (see below). This is very similar to the
7503 B<RETURN> target of iptables, see L<iptables(8)>.
7505 This target does not have any options.
7513 Signals the "stop" condition, see the L<"Flow control"> section above. This
7514 causes processing of the value to be aborted immediately. This is similar to
7515 the B<DROP> target of iptables, see L<iptables(8)>.
7517 This target does not have any options.
7525 Sends the value to "write" plugins.
7531 =item B<Plugin> I<Name>
7533 Name of the write plugin to which the data should be sent. This option may be
7534 given multiple times to send the data to more than one write plugin. If the
7535 plugin supports multiple instances, the plugin's instance(s) must also be
7540 If no plugin is explicitly specified, the values will be sent to all available
7543 Single-instance plugin example:
7549 Multi-instance plugin example:
7551 <Plugin "write_graphite">
7561 Plugin "write_graphite/foo"
7566 Starts processing the rules of another chain, see L<"Flow control"> above. If
7567 the end of that chain is reached, or a stop condition is encountered,
7568 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
7569 next target or the next rule. This is similar to the B<-j> command line option
7570 of iptables, see L<iptables(8)>.
7576 =item B<Chain> I<Name>
7578 Jumps to the chain I<Name>. This argument is required and may appear only once.
7590 =head2 Available matches
7596 Matches a value using regular expressions.
7602 =item B<Host> I<Regex>
7604 =item B<Plugin> I<Regex>
7606 =item B<PluginInstance> I<Regex>
7608 =item B<Type> I<Regex>
7610 =item B<TypeInstance> I<Regex>
7612 Match values where the given regular expressions match the various fields of
7613 the identifier of a value. If multiple regular expressions are given, B<all>
7614 regexen must match for a value to match.
7616 =item B<Invert> B<false>|B<true>
7618 When set to B<true>, the result of the match is inverted, i.e. all value lists
7619 where all regular expressions apply are not matched, all other value lists are
7620 matched. Defaults to B<false>.
7627 Host "customer[0-9]+"
7633 Matches values that have a time which differs from the time on the server.
7635 This match is mainly intended for servers that receive values over the
7636 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
7637 is very sensitive to the timestamp used when updating the RRD files. In
7638 particular, the time must be ever increasing. If a misbehaving client sends one
7639 packet with a timestamp far in the future, all further packets with a correct
7640 time will be ignored because of that one packet. What's worse, such corrupted
7641 RRD files are hard to fix.
7643 This match lets one match all values B<outside> a specified time range
7644 (relative to the server's time), so you can use the B<stop> target (see below)
7645 to ignore the value, for example.
7651 =item B<Future> I<Seconds>
7653 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
7654 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7657 =item B<Past> I<Seconds>
7659 Matches all values that are I<behind> of the server's time by I<Seconds> or
7660 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7672 This example matches all values that are five minutes or more ahead of the
7673 server or one hour (or more) lagging behind.
7677 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
7678 values. If a data-set consists of more than one data-source, all data-sources
7679 must match the specified ranges for a positive match.
7685 =item B<Min> I<Value>
7687 Sets the smallest value which still results in a match. If unset, behaves like
7690 =item B<Max> I<Value>
7692 Sets the largest value which still results in a match. If unset, behaves like
7695 =item B<Invert> B<true>|B<false>
7697 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
7698 no-match is returned and vice versa. Please note that the B<Invert> setting
7699 only effects how B<Min> and B<Max> are applied to a specific value. Especially
7700 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
7702 =item B<DataSource> I<DSName> [I<DSName> ...]
7704 Select one or more of the data sources. If no data source is configured, all
7705 data sources will be checked. If the type handled by the match does not have a
7706 data source of the specified name(s), this will always result in no match
7707 (independent of the B<Invert> setting).
7709 =item B<Satisfy> B<Any>|B<All>
7711 Specifies how checking with several data sources is performed. If set to
7712 B<Any>, the match succeeds if one of the data sources is in the configured
7713 range. If set to B<All> the match only succeeds if all data sources are within
7714 the configured range. Default is B<All>.
7716 Usually B<All> is used for positive matches, B<Any> is used for negative
7717 matches. This means that with B<All> you usually check that all values are in a
7718 "good" range, while with B<Any> you check if any value is within a "bad" range
7719 (or outside the "good" range).
7723 Either B<Min> or B<Max>, but not both, may be unset.
7727 # Match all values smaller than or equal to 100. Matches only if all data
7728 # sources are below 100.
7734 # Match if the value of any data source is outside the range of 0 - 100.
7742 =item B<empty_counter>
7744 Matches all values with one or more data sources of type B<COUNTER> and where
7745 all counter values are zero. These counters usually I<never> increased since
7746 they started existing (and are therefore uninteresting), or got reset recently
7747 or overflowed and you had really, I<really> bad luck.
7749 Please keep in mind that ignoring such counters can result in confusing
7750 behavior: Counters which hardly ever increase will be zero for long periods of
7751 time. If the counter is reset for some reason (machine or service restarted,
7752 usually), the graph will be empty (NAN) for a long time. People may not
7757 Calculates a hash value of the host name and matches values according to that
7758 hash value. This makes it possible to divide all hosts into groups and match
7759 only values that are in a specific group. The intended use is in load
7760 balancing, where you want to handle only part of all data and leave the rest
7763 The hashing function used tries to distribute the hosts evenly. First, it
7764 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
7767 for (i = 0; host[i] != 0; i++)
7768 hash_value = (hash_value * 251) + host[i];
7770 The constant 251 is a prime number which is supposed to make this hash value
7771 more random. The code then checks the group for this host according to the
7772 I<Total> and I<Match> arguments:
7774 if ((hash_value % Total) == Match)
7779 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
7780 groups), then the least significant bit of the hash value will be the XOR of
7781 all least significant bits in the host name. One consequence is that when you
7782 have two hosts, "server0.example.com" and "server1.example.com", where the host
7783 name differs in one digit only and the digits differ by one, those hosts will
7784 never end up in the same group.
7790 =item B<Match> I<Match> I<Total>
7792 Divide the data into I<Total> groups and match all hosts in group I<Match> as
7793 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
7794 be smaller than I<Total>. I<Total> must be at least one, although only values
7795 greater than one really do make any sense.
7797 You can repeat this option to match multiple groups, for example:
7802 The above config will divide the data into seven groups and match groups three
7803 and five. One use would be to keep every value on two hosts so that if one
7804 fails the missing data can later be reconstructed from the second host.
7810 # Operate on the pre-cache chain, so that ignored values are not even in the
7815 # Divide all received hosts in seven groups and accept all hosts in
7819 # If matched: Return and continue.
7822 # If not matched: Return and stop.
7828 =head2 Available targets
7832 =item B<notification>
7834 Creates and dispatches a notification.
7840 =item B<Message> I<String>
7842 This required option sets the message of the notification. The following
7843 placeholders will be replaced by an appropriate value:
7851 =item B<%{plugin_instance}>
7855 =item B<%{type_instance}>
7857 These placeholders are replaced by the identifier field of the same name.
7859 =item B<%{ds:>I<name>B<}>
7861 These placeholders are replaced by a (hopefully) human readable representation
7862 of the current rate of this data source. If you changed the instance name
7863 (using the B<set> or B<replace> targets, see below), it may not be possible to
7864 convert counter values to rates.
7868 Please note that these placeholders are B<case sensitive>!
7870 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
7872 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
7879 <Target "notification">
7880 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
7886 Replaces parts of the identifier using regular expressions.
7892 =item B<Host> I<Regex> I<Replacement>
7894 =item B<Plugin> I<Regex> I<Replacement>
7896 =item B<PluginInstance> I<Regex> I<Replacement>
7898 =item B<TypeInstance> I<Regex> I<Replacement>
7900 Match the appropriate field with the given regular expression I<Regex>. If the
7901 regular expression matches, that part that matches is replaced with
7902 I<Replacement>. If multiple places of the input buffer match a given regular
7903 expression, only the first occurrence will be replaced.
7905 You can specify each option multiple times to use multiple regular expressions
7913 # Replace "example.net" with "example.com"
7914 Host "\\<example.net\\>" "example.com"
7916 # Strip "www." from hostnames
7922 Sets part of the identifier of a value to a given string.
7928 =item B<Host> I<String>
7930 =item B<Plugin> I<String>
7932 =item B<PluginInstance> I<String>
7934 =item B<TypeInstance> I<String>
7936 Set the appropriate field to the given string. The strings for plugin instance
7937 and type instance may be empty, the strings for host and plugin may not be
7938 empty. It's currently not possible to set the type of a value this way.
7945 PluginInstance "coretemp"
7946 TypeInstance "core3"
7951 =head2 Backwards compatibility
7953 If you use collectd with an old configuration, i.E<nbsp>e. one without a
7954 B<Chain> block, it will behave as it used to. This is equivalent to the
7955 following configuration:
7961 If you specify a B<PostCacheChain>, the B<write> target will not be added
7962 anywhere and you will have to make sure that it is called where appropriate. We
7963 suggest to add the above snippet as default target to your "PostCache" chain.
7967 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
7983 L<collectd-exec(5)>,
7984 L<collectd-perl(5)>,
7985 L<collectd-unixsock(5)>,
7998 Florian Forster E<lt>octo@collectd.orgE<gt>