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<ceph>
1174 The ceph plugin collects values from JSON data to be parsed by B<libyajl>
1175 (L<https://lloyd.github.io/yajl/>) retrieved from ceph daemon admin sockets.
1177 A separate B<Daemon> block must be configured for each ceph daemon to be
1178 monitored. The following example will read daemon statistics from four
1179 separate ceph daemons running on the same device (two OSDs, one MON, one MDS) :
1182 LongRunAvgLatency false
1183 ConvertSpecialMetricTypes true
1185 SocketPath "/var/run/ceph/ceph-osd.0.asok"
1188 SocketPath "/var/run/ceph/ceph-osd.1.asok"
1191 SocketPath "/var/run/ceph/ceph-mon.ceph1.asok"
1194 SocketPath "/var/run/ceph/ceph-mds.ceph1.asok"
1198 The ceph plugin accepts the following configuration options:
1202 =item B<LongRunAvgLatency> B<true>|B<false>
1204 If enabled, latency values(sum,count pairs) are calculated as the long run
1205 average - average since the ceph daemon was started = (sum / count).
1206 When disabled, latency values are calculated as the average since the last
1207 collection = (sum_now - sum_last) / (count_now - count_last).
1211 =item B<ConvertSpecialMetricTypes> B<true>|B<false>
1213 If enabled, special metrics (metrics that differ in type from similar counters)
1214 are converted to the type of those similar counters. This currently only
1215 applies to filestore.journal_wr_bytes which is a counter for OSD daemons. The
1216 ceph schema reports this metric type as a sum,count pair while similar counters
1217 are treated as derive types. When converted, the sum is used as the counter
1218 value and is treated as a derive type.
1219 When disabled, all metrics are treated as the types received from the ceph schema.
1225 Each B<Daemon> block must have a string argument for the plugin instance name.
1226 A B<SocketPath> is also required for each B<Daemon> block:
1230 =item B<Daemon> I<DaemonName>
1232 Name to be used as the instance name for this daemon.
1234 =item B<SocketPath> I<SocketPath>
1236 Specifies the path to the UNIX admin socket of the ceph daemon.
1240 =head2 Plugin C<cgroups>
1242 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1243 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1244 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1248 =item B<CGroup> I<Directory>
1250 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1251 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1254 =item B<IgnoreSelected> B<true>|B<false>
1256 Invert the selection: If set to true, all cgroups I<except> the ones that
1257 match any one of the criteria are collected. By default only selected
1258 cgroups are collected if a selection is made. If no selection is configured
1259 at all, B<all> cgroups are selected.
1263 =head2 Plugin C<conntrack>
1265 This plugin collects IP conntrack statistics.
1271 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1272 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1276 =head2 Plugin C<cpu>
1278 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1279 as Jiffies, using the C<cpu> type. Two aggregations are available:
1285 Sum, per-state, over all CPUs installed in the system; and
1289 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1293 The two aggregations can be combined, leading to I<collectd> only emitting a
1294 single "active" metric for the entire system. As soon as one of these
1295 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1296 rather than Jiffies. In addition, you can request individual, per-state,
1297 per-CPU metrics to be reported as percentage.
1299 The following configuration options are available:
1303 =item B<ReportByState> B<true>|B<false>
1305 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1307 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1310 =item B<ReportByCpu> B<true>|B<false>
1312 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1313 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1314 global sum of CPU states is emitted.
1316 =item B<ValuesPercentage> B<false>|B<true>
1318 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1319 are set to B<true>. In this case, by default, metrics will be reported as
1320 Jiffies. By setting this option to B<true>, you can request percentage values
1321 in the un-aggregated (per-CPU, per-state) mode as well.
1325 =head2 Plugin C<cpufreq>
1327 This plugin doesn't have any options. It reads
1328 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1329 installed) to get the current CPU frequency. If this file does not exist make
1330 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1331 installed and an "cpu governor" (that's a kernel module) is loaded.
1333 =head2 Plugin C<csv>
1337 =item B<DataDir> I<Directory>
1339 Set the directory to store CSV-files under. Per default CSV-files are generated
1340 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1341 The special strings B<stdout> and B<stderr> can be used to write to the standard
1342 output and standard error channels, respectively. This, of course, only makes
1343 much sense when collectd is running in foreground- or non-daemon-mode.
1345 =item B<StoreRates> B<true|false>
1347 If set to B<true>, convert counter values to rates. If set to B<false> (the
1348 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1353 =head2 Plugin C<curl>
1355 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1356 and the match infrastructure (the same code used by the tail plugin) to use
1357 regular expressions with the received data.
1359 The following example will read the current value of AMD stock from Google's
1360 finance page and dispatch the value to collectd.
1363 <Page "stock_quotes">
1364 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1370 CACert "/path/to/ca.crt"
1371 Header "X-Custom-Header: foobar"
1374 MeasureResponseTime false
1375 MeasureResponseCode false
1378 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1379 DSType "GaugeAverage"
1380 # Note: `stock_value' is not a standard type.
1387 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1388 a web page and one or more "matches" to be performed on the returned data. The
1389 string argument to the B<Page> block is used as plugin instance.
1391 The following options are valid within B<Page> blocks:
1397 URL of the web site to retrieve. Since a regular expression will be used to
1398 extract information from this data, non-binary data is a big plus here ;)
1400 =item B<User> I<Name>
1402 Username to use if authorization is required to read the page.
1404 =item B<Password> I<Password>
1406 Password to use if authorization is required to read the page.
1408 =item B<Digest> B<true>|B<false>
1410 Enable HTTP digest authentication.
1412 =item B<VerifyPeer> B<true>|B<false>
1414 Enable or disable peer SSL certificate verification. See
1415 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1417 =item B<VerifyHost> B<true>|B<false>
1419 Enable or disable peer host name verification. If enabled, the plugin checks if
1420 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1421 matches the host name provided by the B<URL> option. If this identity check
1422 fails, the connection is aborted. Obviously, only works when connecting to a
1423 SSL enabled server. Enabled by default.
1425 =item B<CACert> I<file>
1427 File that holds one or more SSL certificates. If you want to use HTTPS you will
1428 possibly need this option. What CA certificates come bundled with C<libcurl>
1429 and are checked by default depends on the distribution you use.
1431 =item B<Header> I<Header>
1433 A HTTP header to add to the request. Multiple headers are added if this option
1434 is specified more than once.
1436 =item B<Post> I<Body>
1438 Specifies that the HTTP operation should be a POST instead of a GET. The
1439 complete data to be posted is given as the argument. This option will usually
1440 need to be accompanied by a B<Header> option to set an appropriate
1441 C<Content-Type> for the post body (e.g. to
1442 C<application/x-www-form-urlencoded>).
1444 =item B<MeasureResponseTime> B<true>|B<false>
1446 Measure response time for the request. If this setting is enabled, B<Match>
1447 blocks (see below) are optional. Disabled by default.
1449 =item B<MeasureResponseCode> B<true>|B<false>
1451 Measure response code for the request. If this setting is enabled, B<Match>
1452 blocks (see below) are optional. Disabled by default.
1454 =item B<E<lt>MatchE<gt>>
1456 One or more B<Match> blocks that define how to match information in the data
1457 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1458 used by the C<tail> plugin, so please see the documentation of the C<tail>
1459 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1460 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1465 =head2 Plugin C<curl_json>
1467 The B<curl_json plugin> collects values from JSON data to be parsed by
1468 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) retrieved via
1469 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1470 unix socket. The former can be used, for example, to collect values
1471 from CouchDB documents (which are stored JSON notation), and the
1472 latter to collect values from a uWSGI stats socket.
1474 The following example will collect several values from the built-in
1475 C<_stats> runtime statistics module of I<CouchDB>
1476 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1479 <URL "http://localhost:5984/_stats">
1481 <Key "httpd/requests/count">
1482 Type "http_requests"
1485 <Key "httpd_request_methods/*/count">
1486 Type "http_request_methods"
1489 <Key "httpd_status_codes/*/count">
1490 Type "http_response_codes"
1495 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1498 <Sock "/var/run/uwsgi.stats.sock">
1500 <Key "workers/*/requests">
1501 Type "http_requests"
1504 <Key "workers/*/apps/*/requests">
1505 Type "http_requests"
1510 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1511 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1512 blocks defining a unix socket to read JSON from directly. Each of
1513 these blocks may have one or more B<Key> blocks.
1515 The B<Key> string argument must be in a path format. Each component is
1516 used to match the key from a JSON map or the index of an JSON
1517 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1518 values for all map keys or array indices will be collectd.
1520 The following options are valid within B<URL> blocks:
1524 =item B<Instance> I<Instance>
1526 Sets the plugin instance to I<Instance>.
1528 =item B<Interval> I<Interval>
1530 Sets the interval (in seconds) in which the values will be collected from this
1531 URL. By default the global B<Interval> setting will be used.
1533 =item B<User> I<Name>
1535 =item B<Password> I<Password>
1537 =item B<Digest> B<true>|B<false>
1539 =item B<VerifyPeer> B<true>|B<false>
1541 =item B<VerifyHost> B<true>|B<false>
1543 =item B<CACert> I<file>
1545 =item B<Header> I<Header>
1547 =item B<Post> I<Body>
1549 These options behave exactly equivalent to the appropriate options of the
1550 I<cURL> plugin. Please see there for a detailed description.
1554 The following options are valid within B<Key> blocks:
1558 =item B<Type> I<Type>
1560 Sets the type used to dispatch the values to the daemon. Detailed information
1561 about types and their configuration can be found in L<types.db(5)>. This
1562 option is mandatory.
1564 =item B<Instance> I<Instance>
1566 Type-instance to use. Defaults to the current map key or current string array element value.
1570 =head2 Plugin C<curl_xml>
1572 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1573 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1576 <URL "http://localhost/stats.xml">
1578 Instance "some_instance"
1583 CACert "/path/to/ca.crt"
1584 Header "X-Custom-Header: foobar"
1587 <XPath "table[@id=\"magic_level\"]/tr">
1589 #InstancePrefix "prefix-"
1590 InstanceFrom "td[1]"
1591 ValuesFrom "td[2]/span[@class=\"level\"]"
1596 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1597 URL to be fetched using libcurl. Within each B<URL> block there are
1598 options which specify the connection parameters, for example authentication
1599 information, and one or more B<XPath> blocks.
1601 Each B<XPath> block specifies how to get one type of information. The
1602 string argument must be a valid XPath expression which returns a list
1603 of "base elements". One value is dispatched for each "base element". The
1604 I<type instance> and values are looked up using further I<XPath> expressions
1605 that should be relative to the base element.
1607 Within the B<URL> block the following options are accepted:
1611 =item B<Host> I<Name>
1613 Use I<Name> as the host name when submitting values. Defaults to the global
1616 =item B<Instance> I<Instance>
1618 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1619 empty string (no plugin instance).
1621 =item B<Namespace> I<Prefix> I<URL>
1623 If an XPath expression references namespaces, they must be specified
1624 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1625 I<URL> is the "namespace name", an URI reference uniquely identifying the
1626 namespace. The option can be repeated to register multiple namespaces.
1630 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1631 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1633 =item B<User> I<User>
1635 =item B<Password> I<Password>
1637 =item B<Digest> B<true>|B<false>
1639 =item B<VerifyPeer> B<true>|B<false>
1641 =item B<VerifyHost> B<true>|B<false>
1643 =item B<CACert> I<CA Cert File>
1645 =item B<Header> I<Header>
1647 =item B<Post> I<Body>
1649 These options behave exactly equivalent to the appropriate options of the
1650 I<cURL plugin>. Please see there for a detailed description.
1652 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1654 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1655 B<XPath> block specifies how to get one type of information. The string
1656 argument must be a valid XPath expression which returns a list of "base
1657 elements". One value is dispatched for each "base element".
1659 Within the B<XPath> block the following options are accepted:
1663 =item B<Type> I<Type>
1665 Specifies the I<Type> used for submitting patches. This determines the number
1666 of values that are required / expected and whether the strings are parsed as
1667 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1668 This option is required.
1670 =item B<InstancePrefix> I<InstancePrefix>
1672 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1673 concatenated together without any separator.
1674 This option is optional.
1676 =item B<InstanceFrom> I<InstanceFrom>
1678 Specifies a XPath expression to use for determining the I<type instance>. The
1679 XPath expression must return exactly one element. The element's value is then
1680 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1682 This value is required. As a special exception, if the "base XPath expression"
1683 (the argument to the B<XPath> block) returns exactly one argument, then this
1684 option may be omitted.
1686 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1688 Specifies one or more XPath expression to use for reading the values. The
1689 number of XPath expressions must match the number of data sources in the
1690 I<type> specified with B<Type> (see above). Each XPath expression must return
1691 exactly one element. The element's value is then parsed as a number and used as
1692 value for the appropriate value in the value list dispatched to the daemon.
1698 =head2 Plugin C<dbi>
1700 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1701 connect to various databases, execute I<SQL> statements and read back the
1702 results. I<dbi> is an acronym for "database interface" in case you were
1703 wondering about the name. You can configure how each column is to be
1704 interpreted and the plugin will generate one or more data sets from each row
1705 returned according to these rules.
1707 Because the plugin is very generic, the configuration is a little more complex
1708 than those of other plugins. It usually looks something like this:
1711 <Query "out_of_stock">
1712 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1713 # Use with MySQL 5.0.0 or later
1717 InstancePrefix "out_of_stock"
1718 InstancesFrom "category"
1722 <Database "product_information">
1724 DriverOption "host" "localhost"
1725 DriverOption "username" "collectd"
1726 DriverOption "password" "aZo6daiw"
1727 DriverOption "dbname" "prod_info"
1728 SelectDB "prod_info"
1729 Query "out_of_stock"
1733 The configuration above defines one query with one result and one database. The
1734 query is then linked to the database with the B<Query> option I<within> the
1735 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1736 and you can also use the B<Include> statement to split up the configuration
1737 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1738 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1741 The following is a complete list of options:
1743 =head3 B<Query> blocks
1745 Query blocks define I<SQL> statements and how the returned data should be
1746 interpreted. They are identified by the name that is given in the opening line
1747 of the block. Thus the name needs to be unique. Other than that, the name is
1748 not used in collectd.
1750 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1751 define which column holds which value or instance information. You can use
1752 multiple B<Result> blocks to create multiple values from one returned row. This
1753 is especially useful, when queries take a long time and sending almost the same
1754 query again and again is not desirable.
1758 <Query "environment">
1759 Statement "select station, temperature, humidity from environment"
1762 # InstancePrefix "foo"
1763 InstancesFrom "station"
1764 ValuesFrom "temperature"
1768 InstancesFrom "station"
1769 ValuesFrom "humidity"
1773 The following options are accepted:
1777 =item B<Statement> I<SQL>
1779 Sets the statement that should be executed on the server. This is B<not>
1780 interpreted by collectd, but simply passed to the database server. Therefore,
1781 the SQL dialect that's used depends on the server collectd is connected to.
1783 The query has to return at least two columns, one for the instance and one
1784 value. You cannot omit the instance, even if the statement is guaranteed to
1785 always return exactly one line. In that case, you can usually specify something
1788 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1790 (That works with MySQL but may not be valid SQL according to the spec. If you
1791 use a more strict database server, you may have to select from a dummy table or
1794 Please note that some databases, for example B<Oracle>, will fail if you
1795 include a semicolon at the end of the statement.
1797 =item B<MinVersion> I<Version>
1799 =item B<MaxVersion> I<Value>
1801 Only use this query for the specified database version. You can use these
1802 options to provide multiple queries with the same name but with a slightly
1803 different syntax. The plugin will use only those queries, where the specified
1804 minimum and maximum versions fit the version of the database in use.
1806 The database version is determined by C<dbi_conn_get_engine_version>, see the
1807 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1808 for details. Basically, each part of the version is assumed to be in the range
1809 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1810 "40102", version "5.0.42" becomes "50042".
1812 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1813 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1814 happen. Don't to it! A valid example would be something along these lines:
1825 In the above example, there are three ranges that don't overlap. The last one
1826 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1827 before "4.0.0" are not specified.
1829 =item B<Type> I<Type>
1831 The B<type> that's used for each line returned. See L<types.db(5)> for more
1832 details on how types are defined. In short: A type is a predefined layout of
1833 data and the number of values and type of values has to match the type
1836 If you specify "temperature" here, you need exactly one gauge column. If you
1837 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1840 There must be exactly one B<Type> option inside each B<Result> block.
1842 =item B<InstancePrefix> I<prefix>
1844 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1845 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1846 all strings returned in the appropriate columns are concatenated together,
1847 separated by dashes I<("-")>.
1849 =item B<InstancesFrom> I<column0> [I<column1> ...]
1851 Specifies the columns whose values will be used to create the "type-instance"
1852 for each row. If you specify more than one column, the value of all columns
1853 will be joined together with dashes I<("-")> as separation characters.
1855 The plugin itself does not check whether or not all built instances are
1856 different. It's your responsibility to assure that each is unique. This is
1857 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1858 sure that only one row is returned in this case.
1860 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1863 =item B<ValuesFrom> I<column0> [I<column1> ...]
1865 Names the columns whose content is used as the actual data for the data sets
1866 that are dispatched to the daemon. How many such columns you need is determined
1867 by the B<Type> setting above. If you specify too many or not enough columns,
1868 the plugin will complain about that and no data will be submitted to the
1871 The actual data type in the columns is not that important. The plugin will
1872 automatically cast the values to the right type if it know how to do that. So
1873 it should be able to handle integer an floating point types, as well as strings
1874 (if they include a number at the beginning).
1876 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1878 =item B<MetadataFrom> [I<column0> I<column1> ...]
1880 Names the columns whose content is used as metadata for the data sets
1881 that are dispatched to the daemon.
1883 The actual data type in the columns is not that important. The plugin will
1884 automatically cast the values to the right type if it know how to do that. So
1885 it should be able to handle integer an floating point types, as well as strings
1886 (if they include a number at the beginning).
1890 =head3 B<Database> blocks
1892 Database blocks define a connection to a database and which queries should be
1893 sent to that database. Since the used "dbi" library can handle a wide variety
1894 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1895 documentationE<nbsp>- we stick as close to the terminology used there.
1897 Each database needs a "name" as string argument in the starting tag of the
1898 block. This name will be used as "PluginInstance" in the values submitted to
1899 the daemon. Other than that, that name is not used.
1903 =item B<Driver> I<Driver>
1905 Specifies the driver to use to connect to the database. In many cases those
1906 drivers are named after the database they can connect to, but this is not a
1907 technical necessity. These drivers are sometimes referred to as "DBD",
1908 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1909 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1910 project at L<http://libdbi-drivers.sourceforge.net/>.
1912 You need to give the driver name as expected by the "dbi" library here. You
1913 should be able to find that in the documentation for each driver. If you
1914 mistype the driver name, the plugin will dump a list of all known driver names
1917 =item B<DriverOption> I<Key> I<Value>
1919 Sets driver-specific options. What option a driver supports can be found in the
1920 documentation for each driver, somewhere at
1921 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1922 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1924 DBDs can register two types of options: String options and numeric options. The
1925 plugin will use the C<dbi_conn_set_option> function when the configuration
1926 provides a string and the C<dbi_conn_require_option_numeric> function when the
1927 configuration provides a number. So these two lines will actually result in
1928 different calls being used:
1930 DriverOption "Port" 1234 # numeric
1931 DriverOption "Port" "1234" # string
1933 Unfortunately, drivers are not too keen to report errors when an unknown option
1934 is passed to them, so invalid settings here may go unnoticed. This is not the
1935 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1936 the driver. If a driver complains about an option, the plugin will dump a
1937 complete list of all options understood by that driver to the log. There is no
1938 way to programatically find out if an option expects a string or a numeric
1939 argument, so you will have to refer to the appropriate DBD's documentation to
1940 find this out. Sorry.
1942 =item B<SelectDB> I<Database>
1944 In some cases, the database name you connect with is not the database name you
1945 want to use for querying data. If this option is set, the plugin will "select"
1946 (switch to) that database after the connection is established.
1948 =item B<Query> I<QueryName>
1950 Associates the query named I<QueryName> with this database connection. The
1951 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1952 blocks you want to refer to must be placed above the database block you want to
1955 =item B<Host> I<Hostname>
1957 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
1958 values. Defaults to the global hostname setting.
1966 =item B<Device> I<Device>
1968 Select partitions based on the devicename.
1970 =item B<MountPoint> I<Directory>
1972 Select partitions based on the mountpoint.
1974 =item B<FSType> I<FSType>
1976 Select partitions based on the filesystem type.
1978 =item B<IgnoreSelected> B<true>|B<false>
1980 Invert the selection: If set to true, all partitions B<except> the ones that
1981 match any one of the criteria are collected. By default only selected
1982 partitions are collected if a selection is made. If no selection is configured
1983 at all, B<all> partitions are selected.
1985 =item B<ReportByDevice> B<true>|B<false>
1987 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1988 (the default), it will report a disk as "root", but with it I<true>, it will be
1989 "sda1" (or whichever).
1991 =item B<ReportInodes> B<true>|B<false>
1993 Enables or disables reporting of free, reserved and used inodes. Defaults to
1994 inode collection being disabled.
1996 Enable this option if inodes are a scarce resource for you, usually because
1997 many small files are stored on the disk. This is a usual scenario for mail
1998 transfer agents and web caches.
2000 =item B<ValuesAbsolute> B<true>|B<false>
2002 Enables or disables reporting of free and used disk space in 1K-blocks.
2003 Defaults to B<true>.
2005 =item B<ValuesPercentage> B<false>|B<true>
2007 Enables or disables reporting of free and used disk space in percentage.
2008 Defaults to B<false>.
2010 This is useful for deploying I<collectd> on the cloud, where machines with
2011 different disk size may exist. Then it is more practical to configure
2012 thresholds based on relative disk size.
2016 =head2 Plugin C<disk>
2018 The C<disk> plugin collects information about the usage of physical disks and
2019 logical disks (partitions). Values collected are the number of octets written
2020 to and read from a disk or partition, the number of read/write operations
2021 issued to the disk and a rather complex "time" it took for these commands to be
2024 Using the following two options you can ignore some disks or configure the
2025 collection only of specific disks.
2029 =item B<Disk> I<Name>
2031 Select the disk I<Name>. Whether it is collected or ignored depends on the
2032 B<IgnoreSelected> setting, see below. As with other plugins that use the
2033 daemon's ignorelist functionality, a string that starts and ends with a slash
2034 is interpreted as a regular expression. Examples:
2039 =item B<IgnoreSelected> B<true>|B<false>
2041 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2042 statements, are ignored or if all other disks are ignored. The behavior
2043 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2044 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2045 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2046 is set to B<true>, all disks are collected B<except> the ones matched.
2048 =item B<UseBSDName> B<true>|B<false>
2050 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2051 default major/minor numbers. Requires collectd to be built with Apple's
2054 =item B<UdevNameAttr> I<Attribute>
2056 Attempt to override disk instance name with the value of a specified udev
2057 attribute when built with B<libudev>. If the attribute is not defined for the
2058 given device, the default name is used. Example:
2060 UdevNameAttr "DM_NAME"
2064 =head2 Plugin C<dns>
2068 =item B<Interface> I<Interface>
2070 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2071 option sets the interface that should be used. If this option is not set, or
2072 set to "any", the plugin will try to get packets from B<all> interfaces. This
2073 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2075 =item B<IgnoreSource> I<IP-address>
2077 Ignore packets that originate from this address.
2079 =item B<SelectNumericQueryTypes> B<true>|B<false>
2081 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2085 =head2 Plugin C<email>
2089 =item B<SocketFile> I<Path>
2091 Sets the socket-file which is to be created.
2093 =item B<SocketGroup> I<Group>
2095 If running as root change the group of the UNIX-socket after it has been
2096 created. Defaults to B<collectd>.
2098 =item B<SocketPerms> I<Permissions>
2100 Change the file permissions of the UNIX-socket after it has been created. The
2101 permissions must be given as a numeric, octal value as you would pass to
2102 L<chmod(1)>. Defaults to B<0770>.
2104 =item B<MaxConns> I<Number>
2106 Sets the maximum number of connections that can be handled in parallel. Since
2107 this many threads will be started immediately setting this to a very high
2108 value will waste valuable resources. Defaults to B<5> and will be forced to be
2109 at most B<16384> to prevent typos and dumb mistakes.
2113 =head2 Plugin C<ethstat>
2115 The I<ethstat plugin> collects information about network interface cards (NICs)
2116 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2122 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2123 Map "multicast" "if_multicast"
2130 =item B<Interface> I<Name>
2132 Collect statistical information about interface I<Name>.
2134 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2136 By default, the plugin will submit values as type C<derive> and I<type
2137 instance> set to I<Name>, the name of the metric as reported by the driver. If
2138 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2139 I<TypeInstance> will be used.
2141 =item B<MappedOnly> B<true>|B<false>
2143 When set to B<true>, only metrics that can be mapped to to a I<type> will be
2144 collected, all other metrics will be ignored. Defaults to B<false>.
2148 =head2 Plugin C<exec>
2150 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2151 contains valuable information on when the executable is executed and the
2152 output that is expected from it.
2156 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2158 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2160 Execute the executable I<Executable> as user I<User>. If the user name is
2161 followed by a colon and a group name, the effective group is set to that group.
2162 The real group and saved-set group will be set to the default group of that
2163 user. If no group is given the effective group ID will be the same as the real
2166 Please note that in order to change the user and/or group the daemon needs
2167 superuser privileges. If the daemon is run as an unprivileged user you must
2168 specify the same user/group here. If the daemon is run with superuser
2169 privileges, you must supply a non-root user here.
2171 The executable may be followed by optional arguments that are passed to the
2172 program. Please note that due to the configuration parsing numbers and boolean
2173 values may be changed. If you want to be absolutely sure that something is
2174 passed as-is please enclose it in quotes.
2176 The B<Exec> and B<NotificationExec> statements change the semantics of the
2177 programs executed, i.E<nbsp>e. the data passed to them and the response
2178 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2182 =head2 Plugin C<filecount>
2184 The C<filecount> plugin counts the number of files in a certain directory (and
2185 its subdirectories) and their combined size. The configuration is very straight
2188 <Plugin "filecount">
2189 <Directory "/var/qmail/queue/mess">
2190 Instance "qmail-message"
2192 <Directory "/var/qmail/queue/todo">
2193 Instance "qmail-todo"
2195 <Directory "/var/lib/php5">
2196 Instance "php5-sessions"
2201 The example above counts the number of files in QMail's queue directories and
2202 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2203 QMail has not yet looked at, the "message" queue holds the messages that were
2204 classified into "local" and "remote".
2206 As you can see, the configuration consists of one or more C<Directory> blocks,
2207 each of which specifies a directory in which to count the files. Within those
2208 blocks, the following options are recognized:
2212 =item B<Instance> I<Instance>
2214 Sets the plugin instance to I<Instance>. That instance name must be unique, but
2215 it's your responsibility, the plugin doesn't check for that. If not given, the
2216 instance is set to the directory name with all slashes replaced by underscores
2217 and all leading underscores removed.
2219 =item B<Name> I<Pattern>
2221 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2222 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2223 against the pattern, not the entire path. In case this makes it easier for you:
2224 This option has been named after the B<-name> parameter to L<find(1)>.
2226 =item B<MTime> I<Age>
2228 Count only files of a specific age: If I<Age> is greater than zero, only files
2229 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2230 a negative number, this is inversed. For example, if B<-60> is specified, only
2231 files that have been modified in the last minute will be counted.
2233 The number can also be followed by a "multiplier" to easily specify a larger
2234 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2235 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2236 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2237 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2238 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2241 =item B<Size> I<Size>
2243 Count only files of a specific size. When I<Size> is a positive number, only
2244 files that are at least this big are counted. If I<Size> is a negative number,
2245 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2246 I<Size> are counted.
2248 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2249 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2250 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2251 note that there are 1000 bytes in a kilobyte, not 1024.
2253 =item B<Recursive> I<true>|I<false>
2255 Controls whether or not to recurse into subdirectories. Enabled by default.
2257 =item B<IncludeHidden> I<true>|I<false>
2259 Controls whether or not to include "hidden" files and directories in the count.
2260 "Hidden" files and directories are those, whose name begins with a dot.
2261 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2265 =head2 Plugin C<GenericJMX>
2267 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2268 L<collectd-java(5)>.
2270 =head2 Plugin C<gmond>
2272 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2273 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2274 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2279 MCReceiveFrom "239.2.11.71" "8649"
2280 <Metric "swap_total">
2282 TypeInstance "total"
2285 <Metric "swap_free">
2292 The following metrics are built-in:
2298 load_one, load_five, load_fifteen
2302 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2306 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2318 Available configuration options:
2322 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2324 Sets sets the multicast group and UDP port to which to subscribe.
2326 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2328 =item E<lt>B<Metric> I<Name>E<gt>
2330 These blocks add a new metric conversion to the internal table. I<Name>, the
2331 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2335 =item B<Type> I<Type>
2337 Type to map this metric to. Required.
2339 =item B<TypeInstance> I<Instance>
2341 Type-instance to use. Optional.
2343 =item B<DataSource> I<Name>
2345 Data source to map this metric to. If the configured type has exactly one data
2346 source, this is optional. Otherwise the option is required.
2352 =head2 Plugin C<hddtemp>
2354 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
2355 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
2356 default values, see below. C<hddtemp> has to be running to work correctly. If
2357 C<hddtemp> is not running timeouts may appear which may interfere with other
2360 The B<hddtemp> homepage can be found at
2361 L<http://www.guzu.net/linux/hddtemp.php>.
2365 =item B<Host> I<Hostname>
2367 Hostname to connect to. Defaults to B<127.0.0.1>.
2369 =item B<Port> I<Port>
2371 TCP-Port to connect to. Defaults to B<7634>.
2375 =head2 Plugin C<interface>
2379 =item B<Interface> I<Interface>
2381 Select this interface. By default these interfaces will then be collected. For
2382 a more detailed description see B<IgnoreSelected> below.
2384 =item B<IgnoreSelected> I<true>|I<false>
2386 If no configuration if given, the B<traffic>-plugin will collect data from
2387 all interfaces. This may not be practical, especially for loopback- and
2388 similar interfaces. Thus, you can use the B<Interface>-option to pick the
2389 interfaces you're interested in. Sometimes, however, it's easier/preferred
2390 to collect all interfaces I<except> a few ones. This option enables you to
2391 do that: By setting B<IgnoreSelected> to I<true> the effect of
2392 B<Interface> is inverted: All selected interfaces are ignored and all
2393 other interfaces are collected.
2397 =head2 Plugin C<ipmi>
2401 =item B<Sensor> I<Sensor>
2403 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2405 =item B<IgnoreSelected> I<true>|I<false>
2407 If no configuration if given, the B<ipmi> plugin will collect data from all
2408 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2409 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2410 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2411 all other sensors are collected.
2413 =item B<NotifySensorAdd> I<true>|I<false>
2415 If a sensor appears after initialization time of a minute a notification
2418 =item B<NotifySensorRemove> I<true>|I<false>
2420 If a sensor disappears a notification is sent.
2422 =item B<NotifySensorNotPresent> I<true>|I<false>
2424 If you have for example dual power supply and one of them is (un)plugged then
2425 a notification is sent.
2429 =head2 Plugin C<iptables>
2433 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2435 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
2436 will collect the counters of all rules which have a comment-match. The comment
2437 is then used as type-instance.
2439 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2440 the I<n>th rule will be collected. Again, the comment (or the number) will be
2441 used as the type-instance.
2443 If I<Name> is supplied, it will be used as the type-instance instead of the
2444 comment or the number.
2448 =head2 Plugin C<irq>
2454 Select this irq. By default these irqs will then be collected. For a more
2455 detailed description see B<IgnoreSelected> below.
2457 =item B<IgnoreSelected> I<true>|I<false>
2459 If no configuration if given, the B<irq>-plugin will collect data from all
2460 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2461 can use the B<Irq>-option to pick the interrupt you're interested in.
2462 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2463 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2464 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2465 and all other interrupts are collected.
2469 =head2 Plugin C<java>
2471 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2472 This section only discusses the syntax and semantic of the configuration
2473 options. For more in-depth information on the I<Java> plugin, please read
2474 L<collectd-java(5)>.
2479 JVMArg "-verbose:jni"
2480 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2481 LoadPlugin "org.collectd.java.Foobar"
2482 <Plugin "org.collectd.java.Foobar">
2483 # To be parsed by the plugin
2487 Available configuration options:
2491 =item B<JVMArg> I<Argument>
2493 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2494 exactly the way the arguments to the I<java> binary on the command line work.
2495 Execute C<javaE<nbsp>--help> for details.
2497 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2498 any other options! When another option is found, the JVM will be started and
2499 later options will have to be ignored!
2501 =item B<LoadPlugin> I<JavaClass>
2503 Instantiates a new I<JavaClass> object. The constructor of this object very
2504 likely then registers one or more callback methods with the server.
2506 See L<collectd-java(5)> for details.
2508 When the first such option is found, the virtual machine (JVM) is created. This
2509 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2510 B<LoadPlugin> options!
2512 =item B<Plugin> I<Name>
2514 The entire block is passed to the Java plugin as an
2515 I<org.collectd.api.OConfigItem> object.
2517 For this to work, the plugin has to register a configuration callback first,
2518 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2519 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2520 depends on the (Java) plugin registering the callback and is completely
2521 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2525 =head2 Plugin C<load>
2527 The I<Load plugin> collects the system load. These numbers give a rough overview
2528 over the utilization of a machine. The system load is defined as the number of
2529 runnable tasks in the run-queue and is provided by many operating systems as a
2530 one, five or fifteen minute average.
2532 The following configuration options are available:
2536 =item B<ReportRelative> B<false>|B<true>
2538 When enabled, system load divided by number of available CPU cores is reported
2539 for intervals 1 min, 5 min and 15 min. Defaults to false.
2544 =head2 Plugin C<logfile>
2548 =item B<LogLevel> B<debug|info|notice|warning|err>
2550 Sets the log-level. If, for example, set to B<notice>, then all events with
2551 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2553 Please note that B<debug> is only available if collectd has been compiled with
2556 =item B<File> I<File>
2558 Sets the file to write log messages to. The special strings B<stdout> and
2559 B<stderr> can be used to write to the standard output and standard error
2560 channels, respectively. This, of course, only makes much sense when I<collectd>
2561 is running in foreground- or non-daemon-mode.
2563 =item B<Timestamp> B<true>|B<false>
2565 Prefix all lines printed by the current time. Defaults to B<true>.
2567 =item B<PrintSeverity> B<true>|B<false>
2569 When enabled, all lines are prefixed by the severity of the log message, for
2570 example "warning". Defaults to B<false>.
2574 B<Note>: There is no need to notify the daemon after moving or removing the
2575 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2576 for each line it writes.
2578 =head2 Plugin C<log_logstash>
2580 The I<log logstash plugin> behaves like the logfile plugin but formats
2581 messages as JSON events for logstash to parse and input.
2585 =item B<LogLevel> B<debug|info|notice|warning|err>
2587 Sets the log-level. If, for example, set to B<notice>, then all events with
2588 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2590 Please note that B<debug> is only available if collectd has been compiled with
2593 =item B<File> I<File>
2595 Sets the file to write log messages to. The special strings B<stdout> and
2596 B<stderr> can be used to write to the standard output and standard error
2597 channels, respectively. This, of course, only makes much sense when I<collectd>
2598 is running in foreground- or non-daemon-mode.
2602 B<Note>: There is no need to notify the daemon after moving or removing the
2603 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2604 for each line it writes.
2606 =head2 Plugin C<lpar>
2608 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2609 virtualization technique for IBM POWER processors. It takes into account CPU
2610 time stolen from or donated to a partition, in addition to the usual user,
2611 system, I/O statistics.
2613 The following configuration options are available:
2617 =item B<CpuPoolStats> B<false>|B<true>
2619 When enabled, statistics about the processor pool are read, too. The partition
2620 needs to have pool authority in order to be able to acquire this information.
2623 =item B<ReportBySerial> B<false>|B<true>
2625 If enabled, the serial of the physical machine the partition is currently
2626 running on is reported as I<hostname> and the logical hostname of the machine
2627 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2628 used (just like other plugins) and the I<plugin instance> will be empty.
2633 =head2 Plugin C<mbmon>
2635 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2637 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2638 B<Host> and B<Port> options can be used to change these values, see below.
2639 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2640 timeouts may appear which may interfere with other statistics..
2642 C<mbmon> must be run with the -r option ("print TAG and Value format");
2643 Debian's F</etc/init.d/mbmon> script already does this, other people
2644 will need to ensure that this is the case.
2648 =item B<Host> I<Hostname>
2650 Hostname to connect to. Defaults to B<127.0.0.1>.
2652 =item B<Port> I<Port>
2654 TCP-Port to connect to. Defaults to B<411>.
2660 The C<md plugin> collects information from Linux Software-RAID devices (md).
2662 All reported values are of the type C<md_disks>. Reported type instances are
2663 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2664 I<missing> (physically absent) disks.
2668 =item B<Device> I<Device>
2670 Select md devices based on device name. The I<device name> is the basename of
2671 the device, i.e. the name of the block device without the leading C</dev/>.
2672 See B<IgnoreSelected> for more details.
2674 =item B<IgnoreSelected> B<true>|B<false>
2676 Invert device selection: If set to B<true>, all md devices B<except> those
2677 listed using B<Device> are collected. If B<false> (the default), only those
2678 listed are collected. If no configuration is given, the B<md> plugin will
2679 collect data from all md devices.
2683 =head2 Plugin C<memcachec>
2685 The C<memcachec plugin> connects to a memcached server, queries one or more
2686 given I<pages> and parses the returned data according to user specification.
2687 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2690 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2691 library. Please note that there is another library with a very similar name,
2692 libmemcache (notice the missing `d'), which is not applicable.
2694 Synopsis of the configuration:
2696 <Plugin "memcachec">
2697 <Page "plugin_instance">
2701 Regex "(\\d+) bytes sent"
2704 Instance "type_instance"
2709 The configuration options are:
2713 =item E<lt>B<Page> I<Name>E<gt>
2715 Each B<Page> block defines one I<page> to be queried from the memcached server.
2716 The block requires one string argument which is used as I<plugin instance>.
2718 =item B<Server> I<Address>
2720 Sets the server address to connect to when querying the page. Must be inside a
2725 When connected to the memcached server, asks for the page I<Key>.
2727 =item E<lt>B<Match>E<gt>
2729 Match blocks define which strings to look for and how matches substrings are
2730 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2734 =head2 Plugin C<memcached>
2736 The B<memcached plugin> connects to a memcached server and queries statistics
2737 about cache utilization, memory and bandwidth used.
2738 L<http://www.danga.com/memcached/>
2740 <Plugin "memcached">
2742 Host "memcache.example.com"
2747 The plugin configuration consists of one or more B<Instance> blocks which
2748 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2749 following options are allowed:
2753 =item B<Host> I<Hostname>
2755 Hostname to connect to. Defaults to B<127.0.0.1>.
2757 =item B<Port> I<Port>
2759 TCP-Port to connect to. Defaults to B<11211>.
2761 =item B<Socket> I<Path>
2763 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2764 setting is given, the B<Host> and B<Port> settings are ignored.
2768 =head2 Plugin C<mic>
2770 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2771 Intel's Many Integrated Core (MIC) systems.
2780 ShowTemperatures true
2783 IgnoreSelectedTemperature true
2788 IgnoreSelectedPower true
2791 The following options are valid inside the B<PluginE<nbsp>mic> block:
2795 =item B<ShowCPU> B<true>|B<false>
2797 If enabled (the default) a sum of the CPU usage across all cores is reported.
2799 =item B<ShowCPUCores> B<true>|B<false>
2801 If enabled (the default) per-core CPU usage is reported.
2803 =item B<ShowMemory> B<true>|B<false>
2805 If enabled (the default) the physical memory usage of the MIC system is
2808 =item B<ShowTemperatures> B<true>|B<false>
2810 If enabled (the default) various temperatures of the MIC system are reported.
2812 =item B<Temperature> I<Name>
2814 This option controls which temperatures are being reported. Whether matching
2815 temperatures are being ignored or I<only> matching temperatures are reported
2816 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2817 temperatures are reported.
2819 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2821 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2822 (the default) only temperatures matching a B<Temperature> option are reported
2823 or, if no B<Temperature> option is specified, all temperatures are reported. If
2824 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2827 Known temperature names are:
2861 =item B<ShowPower> B<true>|B<false>
2863 If enabled (the default) various temperatures of the MIC system are reported.
2865 =item B<Power> I<Name>
2867 This option controls which power readings are being reported. Whether matching
2868 power readings are being ignored or I<only> matching power readings are reported
2869 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
2870 power readings are reported.
2872 =item B<IgnoreSelectedPower> B<false>|B<true>
2874 Controls the behavior of the B<Power> setting above. If set to B<false>
2875 (the default) only power readings matching a B<Power> option are reported
2876 or, if no B<Power> option is specified, all power readings are reported. If
2877 set to B<true>, matching power readings are I<ignored> and all other power readings
2880 Known power names are:
2886 Total power utilization averaged over Time Window 0 (uWatts).
2890 Total power utilization averaged over Time Window 0 (uWatts).
2894 Instantaneous power (uWatts).
2898 Max instantaneous power (uWatts).
2902 PCI-E connector power (uWatts).
2906 2x3 connector power (uWatts).
2910 2x4 connector power (uWatts).
2918 Uncore rail (uVolts).
2922 Memory subsystem rail (uVolts).
2928 =head2 Plugin C<memory>
2930 The I<memory plugin> provides the following configuration options:
2934 =item B<ValuesAbsolute> B<true>|B<false>
2936 Enables or disables reporting of physical memory usage in absolute numbers,
2937 i.e. bytes. Defaults to B<true>.
2939 =item B<ValuesPercentage> B<false>|B<true>
2941 Enables or disables reporting of physical memory usage in percentages, e.g.
2942 percent of physical memory used. Defaults to B<false>.
2944 This is useful for deploying I<collectd> in a heterogeneous environment in
2945 which the sizes of physical memory vary.
2949 =head2 Plugin C<modbus>
2951 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
2952 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
2953 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2954 values (two registers interpreted as IEEE floats in big endian notation).
2958 <Data "voltage-input-1">
2961 RegisterCmd ReadHolding
2966 <Data "voltage-input-2">
2969 RegisterCmd ReadHolding
2974 <Data "supply-temperature-1">
2977 RegisterCmd ReadHolding
2982 <Host "modbus.example.com">
2983 Address "192.168.0.42"
2988 Instance "power-supply"
2989 Collect "voltage-input-1"
2990 Collect "voltage-input-2"
2995 Device "/dev/ttyUSB0"
3000 Instance "temperature"
3001 Collect "supply-temperature-1"
3007 =item E<lt>B<Data> I<Name>E<gt> blocks
3009 Data blocks define a mapping between register numbers and the "types" used by
3012 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
3016 =item B<RegisterBase> I<Number>
3018 Configures the base register to read from the device. If the option
3019 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
3020 register will be read (the register number is increased by one).
3022 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
3024 Specifies what kind of data is returned by the device. If the type is B<Int32>,
3025 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
3026 combined into one value. Defaults to B<Uint16>.
3028 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
3030 Specifies register type to be collected from device. Works only with libmodbus
3031 2.9.2 or higher. Defaults to B<ReadHolding>.
3033 =item B<Type> I<Type>
3035 Specifies the "type" (data set) to use when dispatching the value to
3036 I<collectd>. Currently, only data sets with exactly one data source are
3039 =item B<Instance> I<Instance>
3041 Sets the type instance to use when dispatching the value to I<collectd>. If
3042 unset, an empty string (no type instance) is used.
3046 =item E<lt>B<Host> I<Name>E<gt> blocks
3048 Host blocks are used to specify to which hosts to connect and what data to read
3049 from their "slaves". The string argument I<Name> is used as hostname when
3050 dispatching the values to I<collectd>.
3052 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
3056 =item B<Address> I<Hostname>
3058 For Modbus/TCP, specifies the node name (the actual network address) used to
3059 connect to the host. This may be an IP address or a hostname. Please note that
3060 the used I<libmodbus> library only supports IPv4 at the moment.
3062 =item B<Port> I<Service>
3064 for Modbus/TCP, specifies the port used to connect to the host. The port can
3065 either be given as a number or as a service name. Please note that the
3066 I<Service> argument must be a string, even if ports are given in their numerical
3067 form. Defaults to "502".
3069 =item B<Device> I<Devicenode>
3071 For Modbus/RTU, specifies the path to the serial device being used.
3073 =item B<Baudrate> I<Baudrate>
3075 For Modbus/RTU, specifies the baud rate of the serial device.
3076 Note, connections currently support only 8/N/1.
3078 =item B<Interval> I<Interval>
3080 Sets the interval (in seconds) in which the values will be collected from this
3081 host. By default the global B<Interval> setting will be used.
3083 =item E<lt>B<Slave> I<ID>E<gt>
3085 Over each connection, multiple Modbus devices may be reached. The slave ID
3086 is used to specify which device should be addressed. For each device you want
3087 to query, one B<Slave> block must be given.
3089 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
3093 =item B<Instance> I<Instance>
3095 Specify the plugin instance to use when dispatching the values to I<collectd>.
3096 By default "slave_I<ID>" is used.
3098 =item B<Collect> I<DataName>
3100 Specifies which data to retrieve from the device. I<DataName> must be the same
3101 string as the I<Name> argument passed to a B<Data> block. You can specify this
3102 option multiple times to collect more than one value from a slave. At least one
3103 B<Collect> option is mandatory.
3111 =head2 Plugin C<mysql>
3113 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
3114 one or more databases when started and keeps the connection up as long as
3115 possible. When the connection is interrupted for whatever reason it will try
3116 to re-connect. The plugin will complain loudly in case anything goes wrong.
3118 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
3119 and collects information about MySQL network traffic, executed statements,
3120 requests, the query cache and threads by evaluating the
3121 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
3122 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
3123 Status Variables> for an explanation of these values.
3125 Optionally, master and slave statistics may be collected in a MySQL
3126 replication setup. In that case, information about the synchronization state
3127 of the nodes are collected by evaluating the C<Position> return value of the
3128 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
3129 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
3130 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
3131 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
3132 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
3149 Socket "/var/run/mysql/mysqld.sock"
3151 SlaveNotifications true
3155 A B<Database> block defines one connection to a MySQL database. It accepts a
3156 single argument which specifies the name of the database. None of the other
3157 options are required. MySQL will use default values as documented in the
3158 section "mysql_real_connect()" in the B<MySQL reference manual>.
3162 =item B<Alias> I<Alias>
3164 Alias to use as sender instead of hostname when reporting. This may be useful
3165 when having cryptic hostnames.
3167 =item B<Host> I<Hostname>
3169 Hostname of the database server. Defaults to B<localhost>.
3171 =item B<User> I<Username>
3173 Username to use when connecting to the database. The user does not have to be
3174 granted any privileges (which is synonym to granting the C<USAGE> privilege),
3175 unless you want to collectd replication statistics (see B<MasterStats> and
3176 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
3177 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
3179 =item B<Password> I<Password>
3181 Password needed to log into the database.
3183 =item B<Database> I<Database>
3185 Select this database. Defaults to I<no database> which is a perfectly reasonable
3186 option for what this plugin does.
3188 =item B<Port> I<Port>
3190 TCP-port to connect to. The port must be specified in its numeric form, but it
3191 must be passed as a string nonetheless. For example:
3195 If B<Host> is set to B<localhost> (the default), this setting has no effect.
3196 See the documentation for the C<mysql_real_connect> function for details.
3198 =item B<Socket> I<Socket>
3200 Specifies the path to the UNIX domain socket of the MySQL server. This option
3201 only has any effect, if B<Host> is set to B<localhost> (the default).
3202 Otherwise, use the B<Port> option above. See the documentation for the
3203 C<mysql_real_connect> function for details.
3205 =item B<InnodbStats> I<true|false>
3207 If enabled, metrics about the InnoDB storage engine are collected.
3208 Disabled by default.
3210 =item B<MasterStats> I<true|false>
3212 =item B<SlaveStats> I<true|false>
3214 Enable the collection of master / slave statistics in a replication setup. In
3215 order to be able to get access to these statistics, the user needs special
3216 privileges. See the B<User> documentation above. Defaults to B<false>.
3218 =item B<SlaveNotifications> I<true|false>
3220 If enabled, the plugin sends a notification if the replication slave I/O and /
3221 or SQL threads are not running. Defaults to B<false>.
3223 =item B<ConnectTimeout> I<Seconds>
3225 Sets the connect timeout for the MySQL client.
3229 =head2 Plugin C<netapp>
3231 The netapp plugin can collect various performance and capacity information
3232 from a NetApp filer using the NetApp API.
3234 Please note that NetApp has a wide line of products and a lot of different
3235 software versions for each of these products. This plugin was developed for a
3236 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
3237 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
3238 model and software version but it is very hard to test this.
3239 If you have used this plugin with other models and/or software version, feel
3240 free to send us a mail to tell us about the results, even if it's just a short
3243 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
3244 basic authentication.
3246 B<Do not use a regular user for this!> Create a special collectd user with just
3247 the minimum of capabilities needed. The user only needs the "login-http-admin"
3248 capability as well as a few more depending on which data will be collected.
3249 Required capabilities are documented below.
3254 <Host "netapp1.example.com">
3278 IgnoreSelectedIO false
3280 IgnoreSelectedOps false
3281 GetLatency "volume0"
3282 IgnoreSelectedLatency false
3289 IgnoreSelectedCapacity false
3292 IgnoreSelectedSnapshot false
3320 The netapp plugin accepts the following configuration options:
3324 =item B<Host> I<Name>
3326 A host block defines one NetApp filer. It will appear in collectd with the name
3327 you specify here which does not have to be its real name nor its hostname (see
3328 the B<Address> option below).
3330 =item B<VFiler> I<Name>
3332 A B<VFiler> block may only be used inside a host block. It accepts all the
3333 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
3334 will execute all NetApp API commands in the context of the specified
3335 VFiler(R). It will appear in collectd with the name you specify here which
3336 does not have to be its real name. The VFiler name may be specified using the
3337 B<VFilerName> option. If this is not specified, it will default to the name
3340 The VFiler block inherits all connection related settings from the surrounding
3341 B<Host> block (which appear before the B<VFiler> block) but they may be
3342 overwritten inside the B<VFiler> block.
3344 This feature is useful, for example, when using a VFiler as SnapVault target
3345 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
3346 available in the host filer (vfiler0) but only in the respective VFiler
3349 =item B<Protocol> B<httpd>|B<http>
3351 The protocol collectd will use to query this host.
3359 Valid options: http, https
3361 =item B<Address> I<Address>
3363 The hostname or IP address of the host.
3369 Default: The "host" block's name.
3371 =item B<Port> I<Port>
3373 The TCP port to connect to on the host.
3379 Default: 80 for protocol "http", 443 for protocol "https"
3381 =item B<User> I<User>
3383 =item B<Password> I<Password>
3385 The username and password to use to login to the NetApp.
3391 =item B<VFilerName> I<Name>
3393 The name of the VFiler in which context to execute API commands. If not
3394 specified, the name provided to the B<VFiler> block will be used instead.
3400 Default: name of the B<VFiler> block
3402 B<Note:> This option may only be used inside B<VFiler> blocks.
3404 =item B<Interval> I<Interval>
3410 The following options decide what kind of data will be collected. You can
3411 either use them as a block and fine tune various parameters inside this block,
3412 use them as a single statement to just accept all default values, or omit it to
3413 not collect any data.
3415 The following options are valid inside all blocks:
3419 =item B<Interval> I<Seconds>
3421 Collect the respective statistics every I<Seconds> seconds. Defaults to the
3422 host specific setting.
3426 =head3 The System block
3428 This will collect various performance data about the whole system.
3430 B<Note:> To get this data the collectd user needs the
3431 "api-perf-object-get-instances" capability.
3435 =item B<Interval> I<Seconds>
3437 Collect disk statistics every I<Seconds> seconds.
3439 =item B<GetCPULoad> B<true>|B<false>
3441 If you set this option to true the current CPU usage will be read. This will be
3442 the average usage between all CPUs in your NetApp without any information about
3445 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3446 returns in the "CPU" field.
3454 Result: Two value lists of type "cpu", and type instances "idle" and "system".
3456 =item B<GetInterfaces> B<true>|B<false>
3458 If you set this option to true the current traffic of the network interfaces
3459 will be read. This will be the total traffic over all interfaces of your NetApp
3460 without any information about individual interfaces.
3462 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3463 in the "Net kB/s" field.
3473 Result: One value list of type "if_octects".
3475 =item B<GetDiskIO> B<true>|B<false>
3477 If you set this option to true the current IO throughput will be read. This
3478 will be the total IO of your NetApp without any information about individual
3479 disks, volumes or aggregates.
3481 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3482 in the "DiskE<nbsp>kB/s" field.
3490 Result: One value list of type "disk_octets".
3492 =item B<GetDiskOps> B<true>|B<false>
3494 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
3495 iSCSI, etc. operations will be read. This will be the total number of
3496 operations on your NetApp without any information about individual volumes or
3499 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3500 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
3508 Result: A variable number of value lists of type "disk_ops_complex". Each type
3509 of operation will result in one value list with the name of the operation as
3514 =head3 The WAFL block
3516 This will collect various performance data about the WAFL file system. At the
3517 moment this just means cache performance.
3519 B<Note:> To get this data the collectd user needs the
3520 "api-perf-object-get-instances" capability.
3522 B<Note:> The interface to get these values is classified as "Diagnostics" by
3523 NetApp. This means that it is not guaranteed to be stable even between minor
3528 =item B<Interval> I<Seconds>
3530 Collect disk statistics every I<Seconds> seconds.
3532 =item B<GetNameCache> B<true>|B<false>
3540 Result: One value list of type "cache_ratio" and type instance
3543 =item B<GetDirCache> B<true>|B<false>
3551 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3553 =item B<GetInodeCache> B<true>|B<false>
3561 Result: One value list of type "cache_ratio" and type instance
3564 =item B<GetBufferCache> B<true>|B<false>
3566 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3567 in the "Cache hit" field.
3575 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3579 =head3 The Disks block
3581 This will collect performance data about the individual disks in the NetApp.
3583 B<Note:> To get this data the collectd user needs the
3584 "api-perf-object-get-instances" capability.
3588 =item B<Interval> I<Seconds>
3590 Collect disk statistics every I<Seconds> seconds.
3592 =item B<GetBusy> B<true>|B<false>
3594 If you set this option to true the busy time of all disks will be calculated
3595 and the value of the busiest disk in the system will be written.
3597 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3598 in the "Disk util" field. Probably.
3606 Result: One value list of type "percent" and type instance "disk_busy".
3610 =head3 The VolumePerf block
3612 This will collect various performance data about the individual volumes.
3614 You can select which data to collect about which volume using the following
3615 options. They follow the standard ignorelist semantic.
3617 B<Note:> To get this data the collectd user needs the
3618 I<api-perf-object-get-instances> capability.
3622 =item B<Interval> I<Seconds>
3624 Collect volume performance data every I<Seconds> seconds.
3626 =item B<GetIO> I<Volume>
3628 =item B<GetOps> I<Volume>
3630 =item B<GetLatency> I<Volume>
3632 Select the given volume for IO, operations or latency statistics collection.
3633 The argument is the name of the volume without the C</vol/> prefix.
3635 Since the standard ignorelist functionality is used here, you can use a string
3636 starting and ending with a slash to specify regular expression matching: To
3637 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3640 GetIO "/^vol[027]$/"
3642 If no regular expression is specified, an exact match is required. Both,
3643 regular and exact matching are case sensitive.
3645 If no volume was specified at all for either of the three options, that data
3646 will be collected for all available volumes.
3648 =item B<IgnoreSelectedIO> B<true>|B<false>
3650 =item B<IgnoreSelectedOps> B<true>|B<false>
3652 =item B<IgnoreSelectedLatency> B<true>|B<false>
3654 When set to B<true>, the volumes selected for IO, operations or latency
3655 statistics collection will be ignored and the data will be collected for all
3658 When set to B<false>, data will only be collected for the specified volumes and
3659 all other volumes will be ignored.
3661 If no volumes have been specified with the above B<Get*> options, all volumes
3662 will be collected regardless of the B<IgnoreSelected*> option.
3664 Defaults to B<false>
3668 =head3 The VolumeUsage block
3670 This will collect capacity data about the individual volumes.
3672 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3677 =item B<Interval> I<Seconds>
3679 Collect volume usage statistics every I<Seconds> seconds.
3681 =item B<GetCapacity> I<VolumeName>
3683 The current capacity of the volume will be collected. This will result in two
3684 to four value lists, depending on the configuration of the volume. All data
3685 sources are of type "df_complex" with the name of the volume as
3688 There will be type_instances "used" and "free" for the number of used and
3689 available bytes on the volume. If the volume has some space reserved for
3690 snapshots, a type_instance "snap_reserved" will be available. If the volume
3691 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3692 number of bytes saved by the SIS feature.
3694 B<Note:> The current NetApp API has a bug that results in this value being
3695 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3696 number which works most of the time. If you see strange values here, bug
3697 NetApp support to fix this.
3699 Repeat this option to specify multiple volumes.
3701 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3703 Specify whether to collect only the volumes selected by the B<GetCapacity>
3704 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3705 B<false>. However, if no B<GetCapacity> option is specified at all, all
3706 capacities will be selected anyway.
3708 =item B<GetSnapshot> I<VolumeName>
3710 Select volumes from which to collect snapshot information.
3712 Usually, the space used for snapshots is included in the space reported as
3713 "used". If snapshot information is collected as well, the space used for
3714 snapshots is subtracted from the used space.
3716 To make things even more interesting, it is possible to reserve space to be
3717 used for snapshots. If the space required for snapshots is less than that
3718 reserved space, there is "reserved free" and "reserved used" space in addition
3719 to "free" and "used". If the space required for snapshots exceeds the reserved
3720 space, that part allocated in the normal space is subtracted from the "used"
3723 Repeat this option to specify multiple volumes.
3725 =item B<IgnoreSelectedSnapshot>
3727 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3728 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3729 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3730 capacities will be selected anyway.
3734 =head3 The Quota block
3736 This will collect (tree) quota statistics (used disk space and number of used
3737 files). This mechanism is useful to get usage information for single qtrees.
3738 In case the quotas are not used for any other purpose, an entry similar to the
3739 following in C</etc/quotas> would be sufficient:
3741 /vol/volA/some_qtree tree - - - - -
3743 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3747 =item B<Interval> I<Seconds>
3749 Collect SnapVault(R) statistics every I<Seconds> seconds.
3753 =head3 The SnapVault block
3755 This will collect statistics about the time and traffic of SnapVault(R)
3760 =item B<Interval> I<Seconds>
3762 Collect SnapVault(R) statistics every I<Seconds> seconds.
3766 =head2 Plugin C<netlink>
3768 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3769 statistics of various interface and routing aspects.
3773 =item B<Interface> I<Interface>
3775 =item B<VerboseInterface> I<Interface>
3777 Instruct the plugin to collect interface statistics. This is basically the same
3778 as the statistics provided by the C<interface> plugin (see above) but
3779 potentially much more detailed.
3781 When configuring with B<Interface> only the basic statistics will be collected,
3782 namely octets, packets, and errors. These statistics are collected by
3783 the C<interface> plugin, too, so using both at the same time is no benefit.
3785 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3786 so that no data needs to be collected twice if you use the C<interface> plugin.
3787 This includes dropped packets, received multicast packets, collisions and a
3788 whole zoo of differentiated RX and TX errors. You can try the following command
3789 to get an idea of what awaits you:
3793 If I<Interface> is B<All>, all interfaces will be selected.
3795 =item B<QDisc> I<Interface> [I<QDisc>]
3797 =item B<Class> I<Interface> [I<Class>]
3799 =item B<Filter> I<Interface> [I<Filter>]
3801 Collect the octets and packets that pass a certain qdisc, class or filter.
3803 QDiscs and classes are identified by their type and handle (or classid).
3804 Filters don't necessarily have a handle, therefore the parent's handle is used.
3805 The notation used in collectd differs from that used in tc(1) in that it
3806 doesn't skip the major or minor number if it's zero and doesn't print special
3807 ids by their name. So, for example, a qdisc may be identified by
3808 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3809 thus not displayed by tc(1).
3811 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3812 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3813 associated with that interface will be collected.
3815 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3816 used. This may lead to problems when more than one filter is attached to a
3817 qdisc or class. This isn't nice, but we don't know how this could be done any
3818 better. If you have a idea, please don't hesitate to tell us.
3820 As with the B<Interface> option you can specify B<All> as the interface,
3821 meaning all interfaces.
3823 Here are some examples to help you understand the above text more easily:
3826 VerboseInterface "All"
3827 QDisc "eth0" "pfifo_fast-1:0"
3829 Class "ppp0" "htb-1:10"
3830 Filter "ppp0" "u32-1:0"
3833 =item B<IgnoreSelected>
3835 The behavior is the same as with all other similar plugins: If nothing is
3836 selected at all, everything is collected. If some things are selected using the
3837 options described above, only these statistics are collected. If you set
3838 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3839 specified statistics will not be collected.
3843 =head2 Plugin C<network>
3845 The Network plugin sends data to a remote instance of collectd, receives data
3846 from a remote instance, or both at the same time. Data which has been received
3847 from the network is usually not transmitted again, but this can be activated, see
3848 the B<Forward> option below.
3850 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3851 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3853 Both, B<Server> and B<Listen> can be used as single option or as block. When
3854 used as block, given options are valid for this socket only. The following
3855 example will export the metrics twice: Once to an "internal" server (without
3856 encryption and signing) and one to an external server (with cryptographic
3860 # Export to an internal server
3861 # (demonstrates usage without additional options)
3862 Server "collectd.internal.tld"
3864 # Export to an external server
3865 # (demonstrates usage with signature options)
3866 <Server "collectd.external.tld">
3867 SecurityLevel "sign"
3868 Username "myhostname"
3875 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3877 The B<Server> statement/block sets the server to send datagrams to. The
3878 statement may occur multiple times to send each datagram to multiple
3881 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3882 optional second argument specifies a port number or a service name. If not
3883 given, the default, B<25826>, is used.
3885 The following options are recognized within B<Server> blocks:
3889 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3891 Set the security you require for network communication. When the security level
3892 has been set to B<Encrypt>, data sent over the network will be encrypted using
3893 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3894 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3895 authentication code. When set to B<None>, data is sent without any security.
3897 This feature is only available if the I<network> plugin was linked with
3900 =item B<Username> I<Username>
3902 Sets the username to transmit. This is used by the server to lookup the
3903 password. See B<AuthFile> below. All security levels except B<None> require
3906 This feature is only available if the I<network> plugin was linked with
3909 =item B<Password> I<Password>
3911 Sets a password (shared secret) for this socket. All security levels except
3912 B<None> require this setting.
3914 This feature is only available if the I<network> plugin was linked with
3917 =item B<Interface> I<Interface name>
3919 Set the outgoing interface for IP packets. This applies at least
3920 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3921 undefined or a non-existent interface name is specified, the default
3922 behavior is to let the kernel choose the appropriate interface. Be warned
3923 that the manual selection of an interface for unicast traffic is only
3924 necessary in rare cases.
3926 =item B<ResolveInterval> I<Seconds>
3928 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
3929 useful to force a regular DNS lookup to support a high availability setup. If
3930 not specified, re-resolves are never attempted.
3934 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
3936 The B<Listen> statement sets the interfaces to bind to. When multiple
3937 statements are found the daemon will bind to multiple interfaces.
3939 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
3940 the argument is a multicast address the daemon will join that multicast group.
3941 The optional second argument specifies a port number or a service name. If not
3942 given, the default, B<25826>, is used.
3944 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
3948 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3950 Set the security you require for network communication. When the security level
3951 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
3952 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
3953 signed and encrypted data is accepted. When set to B<None>, all data will be
3954 accepted. If an B<AuthFile> option was given (see below), encrypted data is
3955 decrypted if possible.
3957 This feature is only available if the I<network> plugin was linked with
3960 =item B<AuthFile> I<Filename>
3962 Sets a file in which usernames are mapped to passwords. These passwords are
3963 used to verify signatures and to decrypt encrypted network packets. If
3964 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
3965 verified and encrypted packets are decrypted. Otherwise, signed data is
3966 accepted without checking the signature and encrypted data cannot be decrypted.
3967 For the other security levels this option is mandatory.
3969 The file format is very simple: Each line consists of a username followed by a
3970 colon and any number of spaces followed by the password. To demonstrate, an
3971 example file could look like this:
3976 Each time a packet is received, the modification time of the file is checked
3977 using L<stat(2)>. If the file has been changed, the contents is re-read. While
3978 the file is being read, it is locked using L<fcntl(2)>.
3980 =item B<Interface> I<Interface name>
3982 Set the incoming interface for IP packets explicitly. This applies at least
3983 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3984 undefined or a non-existent interface name is specified, the default
3985 behavior is, to let the kernel choose the appropriate interface. Thus incoming
3986 traffic gets only accepted, if it arrives on the given interface.
3990 =item B<TimeToLive> I<1-255>
3992 Set the time-to-live of sent packets. This applies to all, unicast and
3993 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
3994 That means that multicast packets will be sent with a TTL of C<1> (one) on most
3997 =item B<MaxPacketSize> I<1024-65535>
3999 Set the maximum size for datagrams received over the network. Packets larger
4000 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
4001 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
4004 On the server side, this limit should be set to the largest value used on
4005 I<any> client. Likewise, the value on the client must not be larger than the
4006 value on the server, or data will be lost.
4008 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
4009 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
4010 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
4013 =item B<Forward> I<true|false>
4015 If set to I<true>, write packets that were received via the network plugin to
4016 the sending sockets. This should only be activated when the B<Listen>- and
4017 B<Server>-statements differ. Otherwise packets may be send multiple times to
4018 the same multicast group. While this results in more network traffic than
4019 necessary it's not a huge problem since the plugin has a duplicate detection,
4020 so the values will not loop.
4022 =item B<ReportStats> B<true>|B<false>
4024 The network plugin cannot only receive and send statistics, it can also create
4025 statistics about itself. Collected data included the number of received and
4026 sent octets and packets, the length of the receive queue and the number of
4027 values handled. When set to B<true>, the I<Network plugin> will make these
4028 statistics available. Defaults to B<false>.
4032 =head2 Plugin C<nginx>
4034 This plugin collects the number of connections and requests handled by the
4035 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
4036 queries the page provided by the C<ngx_http_stub_status_module> module, which
4037 isn't compiled by default. Please refer to
4038 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
4039 how to compile and configure nginx and this module.
4041 The following options are accepted by the C<nginx plugin>:
4045 =item B<URL> I<http://host/nginx_status>
4047 Sets the URL of the C<ngx_http_stub_status_module> output.
4049 =item B<User> I<Username>
4051 Optional user name needed for authentication.
4053 =item B<Password> I<Password>
4055 Optional password needed for authentication.
4057 =item B<VerifyPeer> B<true|false>
4059 Enable or disable peer SSL certificate verification. See
4060 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
4062 =item B<VerifyHost> B<true|false>
4064 Enable or disable peer host name verification. If enabled, the plugin checks
4065 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4066 certificate matches the host name provided by the B<URL> option. If this
4067 identity check fails, the connection is aborted. Obviously, only works when
4068 connecting to a SSL enabled server. Enabled by default.
4070 =item B<CACert> I<File>
4072 File that holds one or more SSL certificates. If you want to use HTTPS you will
4073 possibly need this option. What CA certificates come bundled with C<libcurl>
4074 and are checked by default depends on the distribution you use.
4078 =head2 Plugin C<notify_desktop>
4080 This plugin sends a desktop notification to a notification daemon, as defined
4081 in the Desktop Notification Specification. To actually display the
4082 notifications, B<notification-daemon> is required and B<collectd> has to be
4083 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
4084 environment variables have to be set correctly) and the D-Bus message bus.
4086 The Desktop Notification Specification can be found at
4087 L<http://www.galago-project.org/specs/notification/>.
4091 =item B<OkayTimeout> I<timeout>
4093 =item B<WarningTimeout> I<timeout>
4095 =item B<FailureTimeout> I<timeout>
4097 Set the I<timeout>, in milliseconds, after which to expire the notification
4098 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
4099 been specified, the displayed notification will not be closed at all - the
4100 user has to do so herself. These options default to 5000. If a negative number
4101 has been specified, the default is used as well.
4105 =head2 Plugin C<notify_email>
4107 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
4108 configured email address.
4110 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
4112 Available configuration options:
4116 =item B<From> I<Address>
4118 Email address from which the emails should appear to come from.
4120 Default: C<root@localhost>
4122 =item B<Recipient> I<Address>
4124 Configures the email address(es) to which the notifications should be mailed.
4125 May be repeated to send notifications to multiple addresses.
4127 At least one B<Recipient> must be present for the plugin to work correctly.
4129 =item B<SMTPServer> I<Hostname>
4131 Hostname of the SMTP server to connect to.
4133 Default: C<localhost>
4135 =item B<SMTPPort> I<Port>
4137 TCP port to connect to.
4141 =item B<SMTPUser> I<Username>
4143 Username for ASMTP authentication. Optional.
4145 =item B<SMTPPassword> I<Password>
4147 Password for ASMTP authentication. Optional.
4149 =item B<Subject> I<Subject>
4151 Subject-template to use when sending emails. There must be exactly two
4152 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
4153 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
4156 Default: C<Collectd notify: %s@%s>
4160 =head2 Plugin C<ntpd>
4164 =item B<Host> I<Hostname>
4166 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
4168 =item B<Port> I<Port>
4170 UDP-Port to connect to. Defaults to B<123>.
4172 =item B<ReverseLookups> B<true>|B<false>
4174 Sets whether or not to perform reverse lookups on peers. Since the name or
4175 IP-address may be used in a filename it is recommended to disable reverse
4176 lookups. The default is to do reverse lookups to preserve backwards
4177 compatibility, though.
4179 =item B<IncludeUnitID> B<true>|B<false>
4181 When a peer is a refclock, include the unit ID in the I<type instance>.
4182 Defaults to B<false> for backward compatibility.
4184 If two refclock peers use the same driver and this is B<false>, the plugin will
4185 try to write simultaneous measurements from both to the same type instance.
4186 This will result in error messages in the log and only one set of measurements
4191 =head2 Plugin C<nut>
4195 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
4197 Add a UPS to collect data from. The format is identical to the one accepted by
4202 =head2 Plugin C<olsrd>
4204 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
4205 the Optimized Link State Routing daemon and reads information about the current
4206 state of the meshed network.
4208 The following configuration options are understood:
4212 =item B<Host> I<Host>
4214 Connect to I<Host>. Defaults to B<"localhost">.
4216 =item B<Port> I<Port>
4218 Specifies the port to connect to. This must be a string, even if you give the
4219 port as a number rather than a service name. Defaults to B<"2006">.
4221 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
4223 Specifies what information to collect about links, i.E<nbsp>e. direct
4224 connections of the daemon queried. If set to B<No>, no information is
4225 collected. If set to B<Summary>, the number of links and the average of all
4226 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
4227 If set to B<Detail> LQ and NLQ are collected per link.
4229 Defaults to B<Detail>.
4231 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
4233 Specifies what information to collect about routes of the daemon queried. If
4234 set to B<No>, no information is collected. If set to B<Summary>, the number of
4235 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
4236 metric and ETX are collected per route.
4238 Defaults to B<Summary>.
4240 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
4242 Specifies what information to collect about the global topology. If set to
4243 B<No>, no information is collected. If set to B<Summary>, the number of links
4244 in the entire topology and the average I<link quality> (LQ) is calculated.
4245 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
4247 Defaults to B<Summary>.
4251 =head2 Plugin C<onewire>
4253 B<EXPERIMENTAL!> See notes below.
4255 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
4256 L<http://owfs.org/> to read sensors connected via the onewire bus.
4258 It can be used in two possible modes - standard or advanced.
4260 In the standard mode only temperature sensors (sensors with the family code
4261 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
4262 other sensors you would like to have included, please send a sort request to
4263 the mailing list. You can select sensors to be read or to be ignored depending
4264 on the option B<IgnoreSelected>). When no list is provided the whole bus is
4265 walked and all sensors are read.
4267 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
4268 experimental, below.
4270 In the advanced mode you can configure any sensor to be read (only numerical
4271 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
4272 In this mode you have to list all the sensors. Neither default bus walk nor
4273 B<IgnoreSelected> are used here. Address and type (file) is extracted from
4274 the path automatically and should produce compatible structure with the "standard"
4275 mode (basically the path is expected as for example
4276 "/uncached/10.F10FCA000800/temperature" where it would extract address part
4277 "F10FCA000800" and the rest after the slash is considered the type - here
4279 There are two advantages to this mode - you can access virtually any sensor
4280 (not just temperature), select whether to use cached or directly read values
4281 and it is slighlty faster. The downside is more complex configuration.
4283 The two modes are distinguished automatically by the format of the address.
4284 It is not possible to mix the two modes. Once a full path is detected in any
4285 B<Sensor> then the whole addressing (all sensors) is considered to be this way
4286 (and as standard addresses will fail parsing they will be ignored).
4290 =item B<Device> I<Device>
4292 Sets the device to read the values from. This can either be a "real" hardware
4293 device, such as a serial port or an USB port, or the address of the
4294 L<owserver(1)> socket, usually B<localhost:4304>.
4296 Though the documentation claims to automatically recognize the given address
4297 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
4298 with that version, the following configuration worked for us:
4301 Device "-s localhost:4304"
4304 This directive is B<required> and does not have a default value.
4306 =item B<Sensor> I<Sensor>
4308 In the standard mode selects sensors to collect or to ignore
4309 (depending on B<IgnoreSelected>, see below). Sensors are specified without
4310 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
4311 and B<not> include the leading C<10.> family byte and point.
4312 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
4313 sensors (see above) are read.
4315 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
4316 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
4317 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
4319 As there can be multiple devices on the bus you can list multiple sensor (use
4320 multiple B<Sensor> elements).
4322 =item B<IgnoreSelected> I<true>|I<false>
4324 If no configuration is given, the B<onewire> plugin will collect data from all
4325 sensors found. This may not be practical, especially if sensors are added and
4326 removed regularly. Sometimes, however, it's easier/preferred to collect only
4327 specific sensors or all sensors I<except> a few specified ones. This option
4328 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
4329 B<Sensor> is inverted: All selected interfaces are ignored and all other
4330 interfaces are collected.
4332 Used only in the standard mode - see above.
4334 =item B<Interval> I<Seconds>
4336 Sets the interval in which all sensors should be read. If not specified, the
4337 global B<Interval> setting is used.
4341 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
4342 work with big setups. It works with one sensor being attached to one
4343 controller, but as soon as you throw in a couple more senors and maybe a hub
4344 or two, reading all values will take more than ten seconds (the default
4345 interval). We will probably add some separate thread for reading the sensors
4346 and some cache or something like that, but it's not done yet. We will try to
4347 maintain backwards compatibility in the future, but we can't promise. So in
4348 short: If it works for you: Great! But keep in mind that the config I<might>
4349 change, though this is unlikely. Oh, and if you want to help improving this
4350 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
4352 =head2 Plugin C<openldap>
4354 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
4355 server correctly. The backend database C<monitor> needs to be loaded and
4356 working. See slapd-monitor(5) for the details.
4358 The configuration of the C<openldap> plugin consists of one or more B<Instance>
4359 blocks. Each block requires one string argument as the instance name. For
4364 URL "ldap://localhost/"
4367 URL "ldaps://localhost/"
4371 The instance name will be used as the I<plugin instance>. To emulate the old
4372 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
4373 plugin to work correctly, each instance name must be unique. This is not
4374 enforced by the plugin and it is your responsibility to ensure it is.
4376 The following options are accepted within each B<Instance> block:
4380 =item B<URL> I<ldap://host/binddn>
4382 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
4385 =item B<StartTLS> B<true|false>
4387 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
4388 Disabled by default.
4390 =item B<VerifyHost> B<true|false>
4392 Enables or disables peer host name verification. If enabled, the plugin checks
4393 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4394 certificate matches the host name provided by the B<URL> option. If this
4395 identity check fails, the connection is aborted. Enabled by default.
4397 =item B<CACert> I<File>
4399 File that holds one or more SSL certificates. If you want to use TLS/SSL you
4400 may possibly need this option. What CA certificates are checked by default
4401 depends on the distribution you use and can be changed with the usual ldap
4402 client configuration mechanisms. See ldap.conf(5) for the details.
4404 =item B<Timeout> I<Seconds>
4406 Sets the timeout value for ldap operations. Defaults to B<-1> which results in
4407 an infinite timeout.
4409 =item B<Version> I<Version>
4411 An integer which sets the LDAP protocol version number to use when connecting
4412 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
4416 =head2 Plugin C<openvpn>
4418 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
4419 traffic statistics about connected clients.
4421 To set up OpenVPN to write to the status file periodically, use the
4422 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
4423 you need to set the required format, too. This is done by setting
4424 B<--status-version> to B<2>.
4426 So, in a nutshell you need:
4428 openvpn $OTHER_OPTIONS \
4429 --status "/var/run/openvpn-status" 10 \
4436 =item B<StatusFile> I<File>
4438 Specifies the location of the status file.
4440 =item B<ImprovedNamingSchema> B<true>|B<false>
4442 When enabled, the filename of the status file will be used as plugin instance
4443 and the client's "common name" will be used as type instance. This is required
4444 when reading multiple status files. Enabling this option is recommended, but to
4445 maintain backwards compatibility this option is disabled by default.
4447 =item B<CollectCompression> B<true>|B<false>
4449 Sets whether or not statistics about the compression used by OpenVPN should be
4450 collected. This information is only available in I<single> mode. Enabled by
4453 =item B<CollectIndividualUsers> B<true>|B<false>
4455 Sets whether or not traffic information is collected for each connected client
4456 individually. If set to false, currently no traffic data is collected at all
4457 because aggregating this data in a save manner is tricky. Defaults to B<true>.
4459 =item B<CollectUserCount> B<true>|B<false>
4461 When enabled, the number of currently connected clients or users is collected.
4462 This is especially interesting when B<CollectIndividualUsers> is disabled, but
4463 can be configured independently from that option. Defaults to B<false>.
4467 =head2 Plugin C<oracle>
4469 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
4470 Oracle® Database and lets you execute SQL statements there. It is very similar
4471 to the "dbi" plugin, because it was written around the same time. See the "dbi"
4472 plugin's documentation above for details.
4475 <Query "out_of_stock">
4476 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
4479 # InstancePrefix "foo"
4480 InstancesFrom "category"
4484 <Database "product_information">
4488 Query "out_of_stock"
4492 =head3 B<Query> blocks
4494 The Query blocks are handled identically to the Query blocks of the "dbi"
4495 plugin. Please see its documentation above for details on how to specify
4498 =head3 B<Database> blocks
4500 Database blocks define a connection to a database and which queries should be
4501 sent to that database. Each database needs a "name" as string argument in the
4502 starting tag of the block. This name will be used as "PluginInstance" in the
4503 values submitted to the daemon. Other than that, that name is not used.
4507 =item B<ConnectID> I<ID>
4509 Defines the "database alias" or "service name" to connect to. Usually, these
4510 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
4512 =item B<Host> I<Host>
4514 Hostname to use when dispatching values for this database. Defaults to using
4515 the global hostname of the I<collectd> instance.
4517 =item B<Username> I<Username>
4519 Username used for authentication.
4521 =item B<Password> I<Password>
4523 Password used for authentication.
4525 =item B<Query> I<QueryName>
4527 Associates the query named I<QueryName> with this database connection. The
4528 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
4529 blocks you want to refer to must be placed above the database block you want to
4534 =head2 Plugin C<perl>
4536 This plugin embeds a Perl-interpreter into collectd and provides an interface
4537 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
4539 =head2 Plugin C<pinba>
4541 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
4542 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
4543 PHP-based webpage has been delivered, the extension will send a UDP packet
4544 containing timing information, peak memory usage and so on. The plugin will
4545 wait for such packets, parse them and account the provided information, which
4546 is then dispatched to the daemon once per interval.
4553 # Overall statistics for the website.
4555 Server "www.example.com"
4557 # Statistics for www-a only
4559 Host "www-a.example.com"
4560 Server "www.example.com"
4562 # Statistics for www-b only
4564 Host "www-b.example.com"
4565 Server "www.example.com"
4569 The plugin provides the following configuration options:
4573 =item B<Address> I<Node>
4575 Configures the address used to open a listening socket. By default, plugin will
4576 bind to the I<any> address C<::0>.
4578 =item B<Port> I<Service>
4580 Configures the port (service) to bind to. By default the default Pinba port
4581 "30002" will be used. The option accepts service names in addition to port
4582 numbers and thus requires a I<string> argument.
4584 =item E<lt>B<View> I<Name>E<gt> block
4586 The packets sent by the Pinba extension include the hostname of the server, the
4587 server name (the name of the virtual host) and the script that was executed.
4588 Using B<View> blocks it is possible to separate the data into multiple groups
4589 to get more meaningful statistics. Each packet is added to all matching groups,
4590 so that a packet may be accounted for more than once.
4594 =item B<Host> I<Host>
4596 Matches the hostname of the system the webserver / script is running on. This
4597 will contain the result of the L<gethostname(2)> system call. If not
4598 configured, all hostnames will be accepted.
4600 =item B<Server> I<Server>
4602 Matches the name of the I<virtual host>, i.e. the contents of the
4603 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
4604 server names will be accepted.
4606 =item B<Script> I<Script>
4608 Matches the name of the I<script name>, i.e. the contents of the
4609 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
4610 script names will be accepted.
4616 =head2 Plugin C<ping>
4618 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
4619 configured hosts periodically and measures the network latency. Whenever the
4620 C<read> function of the plugin is called, it submits the average latency, the
4621 standard deviation and the drop rate for each host.
4623 Available configuration options:
4627 =item B<Host> I<IP-address>
4629 Host to ping periodically. This option may be repeated several times to ping
4632 =item B<Interval> I<Seconds>
4634 Sets the interval in which to send ICMP echo packets to the configured hosts.
4635 This is B<not> the interval in which statistics are queries from the plugin but
4636 the interval in which the hosts are "pinged". Therefore, the setting here
4637 should be smaller than or equal to the global B<Interval> setting. Fractional
4638 times, such as "1.24" are allowed.
4642 =item B<Timeout> I<Seconds>
4644 Time to wait for a response from the host to which an ICMP packet had been
4645 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
4646 to be down or the packet to be dropped. This setting must be smaller than the
4647 B<Interval> setting above for the plugin to work correctly. Fractional
4648 arguments are accepted.
4652 =item B<TTL> I<0-255>
4654 Sets the Time-To-Live of generated ICMP packets.
4656 =item B<SourceAddress> I<host>
4658 Sets the source address to use. I<host> may either be a numerical network
4659 address or a network hostname.
4661 =item B<Device> I<name>
4663 Sets the outgoing network device to be used. I<name> has to specify an
4664 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
4667 =item B<MaxMissed> I<Packets>
4669 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
4670 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
4672 Default: B<-1> (disabled)
4676 =head2 Plugin C<postgresql>
4678 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
4679 keeps a persistent connection to all configured databases and tries to
4680 reconnect if the connection has been interrupted. A database is configured by
4681 specifying a B<Database> block as described below. The default statistics are
4682 collected from PostgreSQL's B<statistics collector> which thus has to be
4683 enabled for this plugin to work correctly. This should usually be the case by
4684 default. See the section "The Statistics Collector" of the B<PostgreSQL
4685 Documentation> for details.
4687 By specifying custom database queries using a B<Query> block as described
4688 below, you may collect any data that is available from some PostgreSQL
4689 database. This way, you are able to access statistics of external daemons
4690 which are available in a PostgreSQL database or use future or special
4691 statistics provided by PostgreSQL without the need to upgrade your collectd
4694 Starting with version 5.2, the C<postgresql> plugin supports writing data to
4695 PostgreSQL databases as well. This has been implemented in a generic way. You
4696 need to specify an SQL statement which will then be executed by collectd in
4697 order to write the data (see below for details). The benefit of that approach
4698 is that there is no fixed database layout. Rather, the layout may be optimized
4699 for the current setup.
4701 The B<PostgreSQL Documentation> manual can be found at
4702 L<http://www.postgresql.org/docs/manuals/>.
4706 Statement "SELECT magic FROM wizard WHERE host = $1;"
4710 InstancePrefix "magic"
4715 <Query rt36_tickets>
4716 Statement "SELECT COUNT(type) AS count, type \
4718 WHEN resolved = 'epoch' THEN 'open' \
4719 ELSE 'resolved' END AS type \
4720 FROM tickets) type \
4724 InstancePrefix "rt36_tickets"
4725 InstancesFrom "type"
4731 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
4741 KRBSrvName "kerberos_service_name"
4747 Service "service_name"
4748 Query backend # predefined
4759 The B<Query> block defines one database query which may later be used by a
4760 database definition. It accepts a single mandatory argument which specifies
4761 the name of the query. The names of all queries have to be unique (see the
4762 B<MinVersion> and B<MaxVersion> options below for an exception to this
4763 rule). The following configuration options are available to define the query:
4765 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
4766 blocks define how to handle the values returned from the query. They define
4767 which column holds which value and how to dispatch that value to the daemon.
4768 Multiple B<Result> blocks may be used to extract multiple values from a single
4773 =item B<Statement> I<sql query statement>
4775 Specify the I<sql query statement> which the plugin should execute. The string
4776 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
4777 first, second, etc. parameter. The value of the parameters is specified by the
4778 B<Param> configuration option - see below for details. To include a literal
4779 B<$> character followed by a number, surround it with single quotes (B<'>).
4781 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
4782 allowed. Note, however, that only a single command may be used. Semicolons are
4783 allowed as long as a single non-empty command has been specified only.
4785 The returned lines will be handled separately one after another.
4787 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4789 Specify the parameters which should be passed to the SQL query. The parameters
4790 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4791 they appear in the configuration file. The value of the parameter is
4792 determined depending on the value of the B<Param> option as follows:
4798 The configured hostname of the database connection. If a UNIX domain socket is
4799 used, the parameter expands to "localhost".
4803 The name of the database of the current connection.
4807 The name of the database plugin instance. See the B<Instance> option of the
4808 database specification below for details.
4812 The username used to connect to the database.
4816 The interval with which this database is queried (as specified by the database
4817 specific or global B<Interval> options).
4821 Please note that parameters are only supported by PostgreSQL's protocol
4822 version 3 and above which was introduced in version 7.4 of PostgreSQL.
4824 =item B<Type> I<type>
4826 The I<type> name to be used when dispatching the values. The type describes
4827 how to handle the data and where to store it. See L<types.db(5)> for more
4828 details on types and their configuration. The number and type of values (as
4829 selected by the B<ValuesFrom> option) has to match the type of the given name.
4831 This option is required inside a B<Result> block.
4833 =item B<InstancePrefix> I<prefix>
4835 =item B<InstancesFrom> I<column0> [I<column1> ...]
4837 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
4838 B<InstancePrefix> defines a static prefix that will be prepended to all type
4839 instances. B<InstancesFrom> defines the column names whose values will be used
4840 to create the type instance. Multiple values will be joined together using the
4841 hyphen (C<->) as separation character.
4843 The plugin itself does not check whether or not all built instances are
4844 different. It is your responsibility to assure that each is unique.
4846 Both options are optional. If none is specified, the type instance will be
4849 =item B<ValuesFrom> I<column0> [I<column1> ...]
4851 Names the columns whose content is used as the actual data for the data sets
4852 that are dispatched to the daemon. How many such columns you need is
4853 determined by the B<Type> setting as explained above. If you specify too many
4854 or not enough columns, the plugin will complain about that and no data will be
4855 submitted to the daemon.
4857 The actual data type, as seen by PostgreSQL, is not that important as long as
4858 it represents numbers. The plugin will automatically cast the values to the
4859 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
4860 L<strtod(3)> functions, so anything supported by those functions is supported
4861 by the plugin as well.
4863 This option is required inside a B<Result> block and may be specified multiple
4864 times. If multiple B<ValuesFrom> options are specified, the columns are read
4867 =item B<MinVersion> I<version>
4869 =item B<MaxVersion> I<version>
4871 Specify the minimum or maximum version of PostgreSQL that this query should be
4872 used with. Some statistics might only be available with certain versions of
4873 PostgreSQL. This allows you to specify multiple queries with the same name but
4874 which apply to different versions, thus allowing you to use the same
4875 configuration in a heterogeneous environment.
4877 The I<version> has to be specified as the concatenation of the major, minor
4878 and patch-level versions, each represented as two-decimal-digit numbers. For
4879 example, version 8.2.3 will become 80203.
4883 The following predefined queries are available (the definitions can be found
4884 in the F<postgresql_default.conf> file which, by default, is available at
4885 C<I<prefix>/share/collectd/>):
4891 This query collects the number of backends, i.E<nbsp>e. the number of
4894 =item B<transactions>
4896 This query collects the numbers of committed and rolled-back transactions of
4901 This query collects the numbers of various table modifications (i.E<nbsp>e.
4902 insertions, updates, deletions) of the user tables.
4904 =item B<query_plans>
4906 This query collects the numbers of various table scans and returned tuples of
4909 =item B<table_states>
4911 This query collects the numbers of live and dead rows in the user tables.
4915 This query collects disk block access counts for user tables.
4919 This query collects the on-disk size of the database in bytes.
4923 In addition, the following detailed queries are available by default. Please
4924 note that each of those queries collects information B<by table>, thus,
4925 potentially producing B<a lot> of data. For details see the description of the
4926 non-by_table queries above.
4930 =item B<queries_by_table>
4932 =item B<query_plans_by_table>
4934 =item B<table_states_by_table>
4936 =item B<disk_io_by_table>
4940 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
4941 mandatory argument specifying the name of the writer. This will then be used
4942 in the B<Database> specification in order to activate the writer instance. The
4943 names of all writers have to be unique. The following options may be
4948 =item B<Statement> I<sql statement>
4950 This mandatory option specifies the SQL statement that will be executed for
4951 each submitted value. A single SQL statement is allowed only. Anything after
4952 the first semicolon will be ignored.
4954 Nine parameters will be passed to the statement and should be specified as
4955 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
4956 values are made available through those parameters:
4962 The timestamp of the queried value as a floating point number.
4966 The hostname of the queried value.
4970 The plugin name of the queried value.
4974 The plugin instance of the queried value. This value may be B<NULL> if there
4975 is no plugin instance.
4979 The type of the queried value (cf. L<types.db(5)>).
4983 The type instance of the queried value. This value may be B<NULL> if there is
4988 An array of names for the submitted values (i.E<nbsp>e., the name of the data
4989 sources of the submitted value-list).
4993 An array of types for the submitted values (i.E<nbsp>e., the type of the data
4994 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
4995 B<StoreRates> is enabled (which is the default, see below), all types will be
5000 An array of the submitted values. The dimensions of the value name and value
5005 In general, it is advisable to create and call a custom function in the
5006 PostgreSQL database for this purpose. Any procedural language supported by
5007 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
5010 =item B<StoreRates> B<false>|B<true>
5012 If set to B<true> (the default), convert counter values to rates. If set to
5013 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
5018 The B<Database> block defines one PostgreSQL database for which to collect
5019 statistics. It accepts a single mandatory argument which specifies the
5020 database name. None of the other options are required. PostgreSQL will use
5021 default values as documented in the section "CONNECTING TO A DATABASE" in the
5022 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
5023 the user collectd is run as and special environment variables. See the manpage
5028 =item B<Interval> I<seconds>
5030 Specify the interval with which the database should be queried. The default is
5031 to use the global B<Interval> setting.
5033 =item B<CommitInterval> I<seconds>
5035 This option may be used for database connections which have "writers" assigned
5036 (see above). If specified, it causes a writer to put several updates into a
5037 single transaction. This transaction will last for the specified amount of
5038 time. By default, each update will be executed in a separate transaction. Each
5039 transaction generates a fair amount of overhead which can, thus, be reduced by
5040 activating this option. The draw-back is, that data covering the specified
5041 amount of time will be lost, for example, if a single statement within the
5042 transaction fails or if the database server crashes.
5044 =item B<Host> I<hostname>
5046 Specify the hostname or IP of the PostgreSQL server to connect to. If the
5047 value begins with a slash, it is interpreted as the directory name in which to
5048 look for the UNIX domain socket.
5050 This option is also used to determine the hostname that is associated with a
5051 collected data set. If it has been omitted or either begins with with a slash
5052 or equals B<localhost> it will be replaced with the global hostname definition
5053 of collectd. Any other value will be passed literally to collectd when
5054 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
5056 =item B<Port> I<port>
5058 Specify the TCP port or the local UNIX domain socket file extension of the
5061 =item B<User> I<username>
5063 Specify the username to be used when connecting to the server.
5065 =item B<Password> I<password>
5067 Specify the password to be used when connecting to the server.
5069 =item B<ExpireDelay> I<delay>
5071 Skip expired values in query output.
5073 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
5075 Specify whether to use an SSL connection when contacting the server. The
5076 following modes are supported:
5082 Do not use SSL at all.
5086 First, try to connect without using SSL. If that fails, try using SSL.
5088 =item I<prefer> (default)
5090 First, try to connect using SSL. If that fails, try without using SSL.
5098 =item B<Instance> I<name>
5100 Specify the plugin instance name that should be used instead of the database
5101 name (which is the default, if this option has not been specified). This
5102 allows to query multiple databases of the same name on the same host (e.g.
5103 when running multiple database server versions in parallel).
5105 =item B<KRBSrvName> I<kerberos_service_name>
5107 Specify the Kerberos service name to use when authenticating with Kerberos 5
5108 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
5109 B<PostgreSQL Documentation> for details.
5111 =item B<Service> I<service_name>
5113 Specify the PostgreSQL service name to use for additional parameters. That
5114 service has to be defined in F<pg_service.conf> and holds additional
5115 connection parameters. See the section "The Connection Service File" in the
5116 B<PostgreSQL Documentation> for details.
5118 =item B<Query> I<query>
5120 Specifies a I<query> which should be executed in the context of the database
5121 connection. This may be any of the predefined or user-defined queries. If no
5122 such option is given, it defaults to "backends", "transactions", "queries",
5123 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
5124 has been specified). Else, the specified queries are used only.
5126 =item B<Writer> I<writer>
5128 Assigns the specified I<writer> backend to the database connection. This
5129 causes all collected data to be send to the database using the settings
5130 defined in the writer configuration (see the section "FILTER CONFIGURATION"
5131 below for details on how to selectively send data to certain plugins).
5133 Each writer will register a flush callback which may be used when having long
5134 transactions enabled (see the B<CommitInterval> option above). When issuing
5135 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
5136 transaction will be committed right away. Two different kinds of flush
5137 callbacks are available with the C<postgresql> plugin:
5143 Flush all writer backends.
5145 =item B<postgresql->I<database>
5147 Flush all writers of the specified I<database> only.
5153 =head2 Plugin C<powerdns>
5155 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
5156 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
5157 values, many of which are probably meaningless to most users, but may be useful
5158 for some. So you may chose which values to collect, but if you don't, some
5159 reasonable defaults will be collected.
5162 <Server "server_name">
5164 Collect "udp-answers" "udp-queries"
5165 Socket "/var/run/pdns.controlsocket"
5167 <Recursor "recursor_name">
5169 Collect "cache-hits" "cache-misses"
5170 Socket "/var/run/pdns_recursor.controlsocket"
5172 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
5177 =item B<Server> and B<Recursor> block
5179 The B<Server> block defines one authoritative server to query, the B<Recursor>
5180 does the same for an recursing server. The possible options in both blocks are
5181 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
5186 =item B<Collect> I<Field>
5188 Using the B<Collect> statement you can select which values to collect. Here,
5189 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
5190 C<dlg-only-drops>, C<answers10-100>.
5192 The method of getting the values differs for B<Server> and B<Recursor> blocks:
5193 When querying the server a C<SHOW *> command is issued in any case, because
5194 that's the only way of getting multiple values out of the server at once.
5195 collectd then picks out the values you have selected. When querying the
5196 recursor, a command is generated to query exactly these values. So if you
5197 specify invalid fields when querying the recursor, a syntax error may be
5198 returned by the daemon and collectd may not collect any values at all.
5200 If no B<Collect> statement is given, the following B<Server> values will be
5207 =item packetcache-hit
5209 =item packetcache-miss
5211 =item packetcache-size
5213 =item query-cache-hit
5215 =item query-cache-miss
5217 =item recursing-answers
5219 =item recursing-questions
5231 The following B<Recursor> values will be collected by default:
5235 =item noerror-answers
5237 =item nxdomain-answers
5239 =item servfail-answers
5257 Please note that up to that point collectd doesn't know what values are
5258 available on the server and values that are added do not need a change of the
5259 mechanism so far. However, the values must be mapped to collectd's naming
5260 scheme, which is done using a lookup table that lists all known values. If
5261 values are added in the future and collectd does not know about them, you will
5262 get an error much like this:
5264 powerdns plugin: submit: Not found in lookup table: foobar = 42
5266 In this case please file a bug report with the collectd team.
5268 =item B<Socket> I<Path>
5270 Configures the path to the UNIX domain socket to be used when connecting to the
5271 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
5272 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
5273 will be used for the recursor.
5277 =item B<LocalSocket> I<Path>
5279 Querying the recursor is done using UDP. When using UDP over UNIX domain
5280 sockets, the client socket needs a name in the file system, too. You can set
5281 this local name to I<Path> using the B<LocalSocket> option. The default is
5282 C<I<prefix>/var/run/collectd-powerdns>.
5286 =head2 Plugin C<processes>
5290 =item B<Process> I<Name>
5292 Select more detailed statistics of processes matching this name. The statistics
5293 collected for these selected processes are size of the resident segment size
5294 (RSS), user- and system-time used, number of processes and number of threads,
5295 io data (where available) and minor and major pagefaults.
5297 =item B<ProcessMatch> I<name> I<regex>
5299 Similar to the B<Process> option this allows to select more detailed
5300 statistics of processes matching the specified I<regex> (see L<regex(7)> for
5301 details). The statistics of all matching processes are summed up and
5302 dispatched to the daemon using the specified I<name> as an identifier. This
5303 allows to "group" several processes together. I<name> must not contain
5308 =head2 Plugin C<protocols>
5310 Collects a lot of information about various network protocols, such as I<IP>,
5311 I<TCP>, I<UDP>, etc.
5313 Available configuration options:
5317 =item B<Value> I<Selector>
5319 Selects whether or not to select a specific value. The string being matched is
5320 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
5321 plugin instance and I<ValueName> will be used as type instance. An example of
5322 the string being used would be C<Tcp:RetransSegs>.
5324 You can use regular expressions to match a large number of values with just one
5325 configuration option. To select all "extended" I<TCP> values, you could use the
5326 following statement:
5330 Whether only matched values are selected or all matched values are ignored
5331 depends on the B<IgnoreSelected>. By default, only matched values are selected.
5332 If no value is configured at all, all values will be selected.
5334 =item B<IgnoreSelected> B<true>|B<false>
5336 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
5337 matching values will be ignored.
5341 =head2 Plugin C<python>
5343 This plugin embeds a Python-interpreter into collectd and provides an interface
5344 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
5346 =head2 Plugin C<routeros>
5348 The C<routeros> plugin connects to a device running I<RouterOS>, the
5349 Linux-based operating system for routers by I<MikroTik>. The plugin uses
5350 I<librouteros> to connect and reads information about the interfaces and
5351 wireless connections of the device. The configuration supports querying
5356 Host "router0.example.com"
5359 CollectInterface true
5364 Host "router1.example.com"
5367 CollectInterface true
5368 CollectRegistrationTable true
5374 As you can see above, the configuration of the I<routeros> plugin consists of
5375 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
5376 options are understood:
5380 =item B<Host> I<Host>
5382 Hostname or IP-address of the router to connect to.
5384 =item B<Port> I<Port>
5386 Port name or port number used when connecting. If left unspecified, the default
5387 will be chosen by I<librouteros>, currently "8728". This option expects a
5388 string argument, even when a numeric port number is given.
5390 =item B<User> I<User>
5392 Use the user name I<User> to authenticate. Defaults to "admin".
5394 =item B<Password> I<Password>
5396 Set the password used to authenticate.
5398 =item B<CollectInterface> B<true>|B<false>
5400 When set to B<true>, interface statistics will be collected for all interfaces
5401 present on the device. Defaults to B<false>.
5403 =item B<CollectRegistrationTable> B<true>|B<false>
5405 When set to B<true>, information about wireless LAN connections will be
5406 collected. Defaults to B<false>.
5408 =item B<CollectCPULoad> B<true>|B<false>
5410 When set to B<true>, information about the CPU usage will be collected. The
5411 number is a dimensionless value where zero indicates no CPU usage at all.
5412 Defaults to B<false>.
5414 =item B<CollectMemory> B<true>|B<false>
5416 When enabled, the amount of used and free memory will be collected. How used
5417 memory is calculated is unknown, for example whether or not caches are counted
5419 Defaults to B<false>.
5421 =item B<CollectDF> B<true>|B<false>
5423 When enabled, the amount of used and free disk space will be collected.
5424 Defaults to B<false>.
5426 =item B<CollectDisk> B<true>|B<false>
5428 When enabled, the number of sectors written and bad blocks will be collected.
5429 Defaults to B<false>.
5433 =head2 Plugin C<redis>
5435 The I<Redis plugin> connects to one or more Redis servers and gathers
5436 information about each server's state. For each server there is a I<Node> block
5437 which configures the connection parameters for this node.
5444 <Query "LLEN myqueue">
5451 The information shown in the synopsis above is the I<default configuration>
5452 which is used by the plugin if no configuration is present.
5456 =item B<Node> I<Nodename>
5458 The B<Node> block identifies a new Redis node, that is a new Redis instance
5459 running in an specified host and port. The name for node is a canonical
5460 identifier which is used as I<plugin instance>. It is limited to
5461 64E<nbsp>characters in length.
5463 =item B<Host> I<Hostname>
5465 The B<Host> option is the hostname or IP-address where the Redis instance is
5468 =item B<Port> I<Port>
5470 The B<Port> option is the TCP port on which the Redis instance accepts
5471 connections. Either a service name of a port number may be given. Please note
5472 that numerical port numbers must be given as a string, too.
5474 =item B<Password> I<Password>
5476 Use I<Password> to authenticate when connecting to I<Redis>.
5478 =item B<Timeout> I<Timeout in miliseconds>
5480 The B<Timeout> option set the socket timeout for node response. Since the Redis
5481 read function is blocking, you should keep this value as low as possible. Keep
5482 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
5483 than B<Interval> defined globally.
5485 =item B<Query> I<Querystring>
5487 The B<Query> block identifies a query to execute against the redis server.
5488 There may be an arbitrary number of queries to execute.
5490 =item B<Type> I<Collectd type>
5492 Within a query definition, a valid collectd type to use as when submitting
5493 the result of the query. When not supplied, will default to B<gauge>.
5495 =item B<Instance> I<Type instance>
5497 Within a query definition, an optional type instance to use when submitting
5498 the result of the query. When not supplied will default to the escaped
5499 command, up to 64 chars.
5503 =head2 Plugin C<rrdcached>
5505 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
5506 to store values to RRD files in an efficient manner. The combination of the
5507 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
5508 way the C<rrdtool> plugin works (see below). The added abstraction layer
5509 provides a number of benefits, though: Because the cache is not within
5510 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
5511 restarted. This results in much shorter (if any) gaps in graphs, especially
5512 under heavy load. Also, the C<rrdtool> command line utility is aware of the
5513 daemon so that it can flush values to disk automatically when needed. This
5514 allows to integrate automated flushing of values into graphing solutions much
5517 There are disadvantages, though: The daemon may reside on a different host, so
5518 it may not be possible for C<collectd> to create the appropriate RRD files
5519 anymore. And even if C<rrdcached> runs on the same host, it may run in a
5520 different base directory, so relative paths may do weird stuff if you're not
5523 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
5524 on the same host, communicating via a UNIX domain socket. The B<DataDir>
5525 setting should be set to an absolute path, so that a changed base directory
5526 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
5530 =item B<DaemonAddress> I<Address>
5532 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
5533 library. See L<rrdcached(1)> for details. Example:
5535 <Plugin "rrdcached">
5536 DaemonAddress "unix:/var/run/rrdcached.sock"
5539 =item B<DataDir> I<Directory>
5541 Set the base directory in which the RRD files reside. If this is a relative
5542 path, it is relative to the working base directory of the C<rrdcached> daemon!
5543 Use of an absolute path is recommended.
5545 =item B<CreateFiles> B<true>|B<false>
5547 Enables or disables the creation of RRD files. If the daemon is not running
5548 locally, or B<DataDir> is set to a relative path, this will not work as
5549 expected. Default is B<true>.
5551 =item B<CreateFilesAsync> B<false>|B<true>
5553 When enabled, new RRD files are enabled asynchronously, using a separate thread
5554 that runs in the background. This prevents writes to block, which is a problem
5555 especially when many hundreds of files need to be created at once. However,
5556 since the purpose of creating the files asynchronously is I<not> to block until
5557 the file is available, values before the file is available will be discarded.
5558 When disabled (the default) files are created synchronously, blocking for a
5559 short while, while the file is being written.
5561 =item B<StepSize> I<Seconds>
5563 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5564 this setting is unset and the stepsize is set to the interval in which the data
5565 is collected. Do not use this option unless you absolutely have to for some
5566 reason. Setting this option may cause problems with the C<snmp plugin>, the
5567 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5569 =item B<HeartBeat> I<Seconds>
5571 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5572 in which case the heartbeat is set to twice the B<StepSize> which should equal
5573 the interval in which data is collected. Do not set this option unless you have
5574 a very good reason to do so.
5576 =item B<RRARows> I<NumRows>
5578 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5579 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5580 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5581 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5582 week, one month, and one year.
5584 So for each timespan, it calculates how many PDPs need to be consolidated into
5585 one CDP by calculating:
5586 number of PDPs = timespan / (stepsize * rrarows)
5588 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5591 =item B<RRATimespan> I<Seconds>
5593 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5594 more then one RRA. If this option is never used, the built-in default of (3600,
5595 86400, 604800, 2678400, 31622400) is used.
5597 For more information on how RRA-sizes are calculated see B<RRARows> above.
5599 =item B<XFF> I<Factor>
5601 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5602 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5605 =item B<CollectStatistics> B<false>|B<true>
5607 When set to B<true>, various statistics about the I<rrdcached> daemon will be
5608 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
5610 Statistics are read via I<rrdcached>s socket using the STATS command.
5611 See L<rrdcached(1)> for details.
5615 =head2 Plugin C<rrdtool>
5617 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
5618 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
5619 using these settings. If you don't want to dive into the depths of RRDtool, you
5620 can safely ignore these settings.
5624 =item B<DataDir> I<Directory>
5626 Set the directory to store RRD files under. By default RRD files are generated
5627 beneath the daemon's working directory, i.e. the B<BaseDir>.
5629 =item B<CreateFilesAsync> B<false>|B<true>
5631 When enabled, new RRD files are enabled asynchronously, using a separate thread
5632 that runs in the background. This prevents writes to block, which is a problem
5633 especially when many hundreds of files need to be created at once. However,
5634 since the purpose of creating the files asynchronously is I<not> to block until
5635 the file is available, values before the file is available will be discarded.
5636 When disabled (the default) files are created synchronously, blocking for a
5637 short while, while the file is being written.
5639 =item B<StepSize> I<Seconds>
5641 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5642 this setting is unset and the stepsize is set to the interval in which the data
5643 is collected. Do not use this option unless you absolutely have to for some
5644 reason. Setting this option may cause problems with the C<snmp plugin>, the
5645 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5647 =item B<HeartBeat> I<Seconds>
5649 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5650 in which case the heartbeat is set to twice the B<StepSize> which should equal
5651 the interval in which data is collected. Do not set this option unless you have
5652 a very good reason to do so.
5654 =item B<RRARows> I<NumRows>
5656 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5657 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5658 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5659 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5660 week, one month, and one year.
5662 So for each timespan, it calculates how many PDPs need to be consolidated into
5663 one CDP by calculating:
5664 number of PDPs = timespan / (stepsize * rrarows)
5666 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5669 =item B<RRATimespan> I<Seconds>
5671 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5672 more then one RRA. If this option is never used, the built-in default of (3600,
5673 86400, 604800, 2678400, 31622400) is used.
5675 For more information on how RRA-sizes are calculated see B<RRARows> above.
5677 =item B<XFF> I<Factor>
5679 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5680 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5683 =item B<CacheFlush> I<Seconds>
5685 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
5686 it writes all values for a certain RRD-file if the oldest value is older than
5687 (or equal to) the number of seconds specified. If some RRD-file is not updated
5688 anymore for some reason (the computer was shut down, the network is broken,
5689 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
5690 entire cache is searched for entries older than B<CacheTimeout> seconds and
5691 written to disk every I<Seconds> seconds. Since this is kind of expensive and
5692 does nothing under normal circumstances, this value should not be too small.
5693 900 seconds might be a good value, though setting this to 7200 seconds doesn't
5694 normally do much harm either.
5696 =item B<CacheTimeout> I<Seconds>
5698 If this option is set to a value greater than zero, the C<rrdtool plugin> will
5699 save values in a cache, as described above. Writing multiple values at once
5700 reduces IO-operations and thus lessens the load produced by updating the files.
5701 The trade off is that the graphs kind of "drag behind" and that more memory is
5704 =item B<WritesPerSecond> I<Updates>
5706 When collecting many statistics with collectd and the C<rrdtool> plugin, you
5707 will run serious performance problems. The B<CacheFlush> setting and the
5708 internal update queue assert that collectd continues to work just fine even
5709 under heavy load, but the system may become very unresponsive and slow. This is
5710 a problem especially if you create graphs from the RRD files on the same
5711 machine, for example using the C<graph.cgi> script included in the
5712 C<contrib/collection3/> directory.
5714 This setting is designed for very large setups. Setting this option to a value
5715 between 25 and 80 updates per second, depending on your hardware, will leave
5716 the server responsive enough to draw graphs even while all the cached values
5717 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
5718 by the B<FLUSH> command, are B<not> effected by this limit. They are still
5719 written as fast as possible, so that web frontends have up to date data when
5722 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
5723 updates per second, writing all values to disk will take approximately
5724 56E<nbsp>minutes. Together with the flushing ability that's integrated into
5725 "collection3" you'll end up with a responsive and fast system, up to date
5726 graphs and basically a "backup" of your values every hour.
5728 =item B<RandomTimeout> I<Seconds>
5730 When set, the actual timeout for each value is chosen randomly between
5731 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
5732 intention is to avoid high load situations that appear when many values timeout
5733 at the same time. This is especially a problem shortly after the daemon starts,
5734 because all values were added to the internal cache at roughly the same time.
5738 =head2 Plugin C<sensors>
5740 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
5741 that all the needed modules have to be loaded and lm_sensors has to be
5742 configured (most likely by editing F</etc/sensors.conf>. Read
5743 L<sensors.conf(5)> for details.
5745 The B<lm_sensors> homepage can be found at
5746 L<http://secure.netroedge.com/~lm78/>.
5750 =item B<SensorConfigFile> I<File>
5752 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
5753 the library's default will be used.
5755 =item B<Sensor> I<chip-bus-address/type-feature>
5757 Selects the name of the sensor which you want to collect or ignore, depending
5758 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
5759 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
5760 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
5762 =item B<IgnoreSelected> I<true>|I<false>
5764 If no configuration if given, the B<sensors>-plugin will collect data from all
5765 sensors. This may not be practical, especially for uninteresting sensors.
5766 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
5767 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
5768 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
5769 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
5770 and all other sensors are collected.
5774 =head2 Plugin C<sigrok>
5776 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
5777 supported by the L<sigrok|http://sigrok.org/> project.
5783 <Device "AC Voltage">
5788 <Device "Sound Level">
5789 Driver "cem-dt-885x"
5796 =item B<LogLevel> B<0-5>
5798 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
5799 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
5800 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
5801 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
5802 their level, are always submitted to I<collectd> at its INFO log level.
5804 =item E<lt>B<Device> I<Name>E<gt>
5806 A sigrok-supported device, uniquely identified by this section's options. The
5807 I<Name> is passed to I<collectd> as the I<plugin instance>.
5809 =item B<Driver> I<DriverName>
5811 The sigrok driver to use for this device.
5813 =item B<Conn> I<ConnectionSpec>
5815 If the device cannot be auto-discovered, or more than one might be discovered
5816 by the driver, I<ConnectionSpec> specifies the connection string to the device.
5817 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
5818 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
5819 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
5820 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
5822 =item B<SerialComm> I<SerialSpec>
5824 For serial devices with non-standard port settings, this option can be used
5825 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
5826 This should not be necessary; drivers know how to communicate with devices they
5829 =item B<MinimumInterval> I<Seconds>
5831 Specifies the minimum time between measurement dispatches to I<collectd>, in
5832 seconds. Since some I<sigrok> supported devices can acquire measurements many
5833 times per second, it may be necessary to throttle these. For example, the
5834 I<RRD plugin> cannot process writes more than once per second.
5836 The default B<MinimumInterval> is B<0>, meaning measurements received from the
5837 device are always dispatched to I<collectd>. When throttled, unused
5838 measurements are discarded.
5842 =head2 Plugin C<smart>
5844 The C<smart> plugin collects SMART information from physical
5845 disks. Values collectd include temperature, power cycle count, poweron
5846 time and bad sectors. Also, all SMART attributes are collected along
5847 with the normalized current value, the worst value, the threshold and
5848 a human readable value.
5850 Using the following two options you can ignore some disks or configure the
5851 collection only of specific disks.
5855 =item B<Disk> I<Name>
5857 Select the disk I<Name>. Whether it is collected or ignored depends on the
5858 B<IgnoreSelected> setting, see below. As with other plugins that use the
5859 daemon's ignorelist functionality, a string that starts and ends with a slash
5860 is interpreted as a regular expression. Examples:
5865 =item B<IgnoreSelected> B<true>|B<false>
5867 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
5868 statements, are ignored or if all other disks are ignored. The behavior
5869 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
5870 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
5871 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
5872 is set to B<true>, all disks are collected B<except> the ones matched.
5876 =head2 Plugin C<snmp>
5878 Since the configuration of the C<snmp plugin> is a little more complicated than
5879 other plugins, its documentation has been moved to an own manpage,
5880 L<collectd-snmp(5)>. Please see there for details.
5882 =head2 Plugin C<statsd>
5884 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
5885 protocol and dispatches rates or other aggregates of these numbers
5888 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
5889 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
5890 C<objects> respectively.
5892 The following configuration options are valid:
5896 =item B<Host> I<Host>
5898 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
5899 "any" address, i.e. accept packets sent to any of the hosts addresses.
5901 =item B<Port> I<Port>
5903 UDP port to listen to. This can be either a service name or a port number.
5904 Defaults to C<8125>.
5906 =item B<DeleteCounters> B<false>|B<true>
5908 =item B<DeleteTimers> B<false>|B<true>
5910 =item B<DeleteGauges> B<false>|B<true>
5912 =item B<DeleteSets> B<false>|B<true>
5914 These options control what happens if metrics are not updated in an interval.
5915 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
5916 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
5917 are unchanged. If set to B<True>, the such metrics are not dispatched and
5918 removed from the internal cache.
5920 =item B<TimerPercentile> I<Percent>
5922 Calculate and dispatch the configured percentile, i.e. compute the latency, so
5923 that I<Percent> of all reported timers are smaller than or equal to the
5924 computed latency. This is useful for cutting off the long tail latency, as it's
5925 often done in I<Service Level Agreements> (SLAs).
5927 Different percentiles can be calculated by setting this option several times.
5928 If none are specified, no percentiles are calculated / dispatched.
5930 =item B<TimerLower> B<false>|B<true>
5932 =item B<TimerUpper> B<false>|B<true>
5934 =item B<TimerSum> B<false>|B<true>
5936 =item B<TimerCount> B<false>|B<true>
5938 Calculate and dispatch various values out of I<Timer> metrics received during
5939 an interval. If set to B<False>, the default, these values aren't calculated /
5944 =head2 Plugin C<swap>
5946 The I<Swap plugin> collects information about used and available swap space. On
5947 I<Linux> and I<Solaris>, the following options are available:
5951 =item B<ReportByDevice> B<false>|B<true>
5953 Configures how to report physical swap devices. If set to B<false> (the
5954 default), the summary over all swap devices is reported only, i.e. the globally
5955 used and available space over all devices. If B<true> is configured, the used
5956 and available space of each device will be reported separately.
5958 This option is only available if the I<Swap plugin> can read C</proc/swaps>
5959 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
5961 =item B<ReportBytes> B<false>|B<true>
5963 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
5964 I<swap I/O> is reported in pages. This option is available under Linux only.
5966 =item B<ValuesAbsolute> B<true>|B<false>
5968 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
5969 available and used. Defaults to B<true>.
5971 =item B<ValuesPercentage> B<false>|B<true>
5973 Enables or disables reporting of relative swap metrics, i.e. I<percent>
5974 available and free. Defaults to B<false>.
5976 This is useful for deploying I<collectd> in a heterogeneous environment, where
5977 swap sizes differ and you want to specify generic thresholds or similar.
5981 =head2 Plugin C<syslog>
5985 =item B<LogLevel> B<debug|info|notice|warning|err>
5987 Sets the log-level. If, for example, set to B<notice>, then all events with
5988 severity B<notice>, B<warning>, or B<err> will be submitted to the
5991 Please note that B<debug> is only available if collectd has been compiled with
5994 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
5996 Controls which notifications should be sent to syslog. The default behaviour is
5997 not to send any. Less severe notifications always imply logging more severe
5998 notifications: Setting this to B<OKAY> means all notifications will be sent to
5999 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
6000 notifications but will dismiss B<OKAY> notifications. Setting this option to
6001 B<FAILURE> will only send failures to syslog.
6005 =head2 Plugin C<table>
6007 The C<table plugin> provides generic means to parse tabular data and dispatch
6008 user specified values. Values are selected based on column numbers. For
6009 example, this plugin may be used to get values from the Linux L<proc(5)>
6010 filesystem or CSV (comma separated values) files.
6013 <Table "/proc/slabinfo">
6018 InstancePrefix "active_objs"
6024 InstancePrefix "objperslab"
6031 The configuration consists of one or more B<Table> blocks, each of which
6032 configures one file to parse. Within each B<Table> block, there are one or
6033 more B<Result> blocks, which configure which data to select and how to
6036 The following options are available inside a B<Table> block:
6040 =item B<Instance> I<instance>
6042 If specified, I<instance> is used as the plugin instance. So, in the above
6043 example, the plugin name C<table-slabinfo> would be used. If omitted, the
6044 filename of the table is used instead, with all special characters replaced
6045 with an underscore (C<_>).
6047 =item B<Separator> I<string>
6049 Any character of I<string> is interpreted as a delimiter between the different
6050 columns of the table. A sequence of two or more contiguous delimiters in the
6051 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
6052 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
6053 of a table - see its documentation for more details. This option is mandatory.
6055 A horizontal tab, newline and carriage return may be specified by C<\\t>,
6056 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
6057 required because of collectd's config parsing.
6061 The following options are available inside a B<Result> block:
6065 =item B<Type> I<type>
6067 Sets the type used to dispatch the values to the daemon. Detailed information
6068 about types and their configuration can be found in L<types.db(5)>. This
6069 option is mandatory.
6071 =item B<InstancePrefix> I<prefix>
6073 If specified, prepend I<prefix> to the type instance. If omitted, only the
6074 B<InstancesFrom> option is considered for the type instance.
6076 =item B<InstancesFrom> I<column0> [I<column1> ...]
6078 If specified, the content of the given columns (identified by the column
6079 number starting at zero) will be used to create the type instance for each
6080 row. Multiple values (and the instance prefix) will be joined together with
6081 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
6082 option is considered for the type instance.
6084 The plugin itself does not check whether or not all built instances are
6085 different. It’s your responsibility to assure that each is unique. This is
6086 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
6087 sure that the table only contains one row.
6089 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
6092 =item B<ValuesFrom> I<column0> [I<column1> ...]
6094 Specifies the columns (identified by the column numbers starting at zero)
6095 whose content is used as the actual data for the data sets that are dispatched
6096 to the daemon. How many such columns you need is determined by the B<Type>
6097 setting above. If you specify too many or not enough columns, the plugin will
6098 complain about that and no data will be submitted to the daemon. The plugin
6099 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
6100 respectively, so anything supported by those functions is supported by the
6101 plugin as well. This option is mandatory.
6105 =head2 Plugin C<tail>
6107 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
6108 each line and dispatches found values. What is matched can be configured by the
6109 user using (extended) regular expressions, as described in L<regex(7)>.
6112 <File "/var/log/exim4/mainlog">
6116 Regex "S=([1-9][0-9]*)"
6122 Regex "\\<R=local_user\\>"
6123 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
6126 Instance "local_user"
6131 The config consists of one or more B<File> blocks, each of which configures one
6132 logfile to parse. Within each B<File> block, there are one or more B<Match>
6133 blocks, which configure a regular expression to search for.
6135 The B<Instance> option in the B<File> block may be used to set the plugin
6136 instance. So in the above example the plugin name C<tail-foo> would be used.
6137 This plugin instance is for all B<Match> blocks that B<follow> it, until the
6138 next B<Instance> option. This way you can extract several plugin instances from
6139 one logfile, handy when parsing syslog and the like.
6141 The B<Interval> option allows you to define the length of time between reads. If
6142 this is not set, the default Interval will be used.
6144 Each B<Match> block has the following options to describe how the match should
6149 =item B<Regex> I<regex>
6151 Sets the regular expression to use for matching against a line. The first
6152 subexpression has to match something that can be turned into a number by
6153 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
6154 below. Because B<extended> regular expressions are used, you do not need to use
6155 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
6156 collectd's config parsing you need to escape backslashes, though. So if you
6157 want to match literal parentheses you need to do the following:
6159 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
6161 =item B<ExcludeRegex> I<regex>
6163 Sets an optional regular expression to use for excluding lines from the match.
6164 An example which excludes all connections from localhost from the match:
6166 ExcludeRegex "127\\.0\\.0\\.1"
6168 =item B<DSType> I<Type>
6170 Sets how the values are cumulated. I<Type> is one of:
6174 =item B<GaugeAverage>
6176 Calculate the average.
6180 Use the smallest number only.
6184 Use the greatest number only.
6188 Use the last number found.
6194 =item B<AbsoluteSet>
6196 The matched number is a counter. Simply I<sets> the internal counter to this
6197 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
6205 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
6206 matched number may be negative, which will effectively subtract from the
6215 Increase the internal counter by one. These B<DSType> are the only ones that do
6216 not use the matched subexpression, but simply count the number of matched
6217 lines. Thus, you may use a regular expression without submatch in this case.
6221 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
6222 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
6223 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
6224 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
6225 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
6228 =item B<Type> I<Type>
6230 Sets the type used to dispatch this value. Detailed information about types and
6231 their configuration can be found in L<types.db(5)>.
6233 =item B<Instance> I<TypeInstance>
6235 This optional setting sets the type instance to use.
6239 =head2 Plugin C<tail_csv>
6241 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
6242 written by I<Snort>.
6247 <Metric "snort-dropped">
6252 <File "/var/log/snort/snort.stats">
6253 Instance "snort-eth0"
6255 Collect "snort-dropped"
6259 The configuration consists of one or more B<Metric> blocks that define an index
6260 into the line of the CSV file and how this value is mapped to I<collectd's>
6261 internal representation. These are followed by one or more B<Instance> blocks
6262 which configure which file to read, in which interval and which metrics to
6267 =item E<lt>B<Metric> I<Name>E<gt>
6269 The B<Metric> block configures a new metric to be extracted from the statistics
6270 file and how it is mapped on I<collectd's> data model. The string I<Name> is
6271 only used inside the B<Instance> blocks to refer to this block, so you can use
6272 one B<Metric> block for multiple CSV files.
6276 =item B<Type> I<Type>
6278 Configures which I<Type> to use when dispatching this metric. Types are defined
6279 in the L<types.db(5)> file, see the appropriate manual page for more
6280 information on specifying types. Only types with a single I<data source> are
6281 supported by the I<tail_csv plugin>. The information whether the value is an
6282 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
6283 I<Type's> definition.
6285 =item B<Instance> I<TypeInstance>
6287 If set, I<TypeInstance> is used to populate the type instance field of the
6288 created value lists. Otherwise, no type instance is used.
6290 =item B<ValueFrom> I<Index>
6292 Configure to read the value from the field with the zero-based index I<Index>.
6293 If the value is parsed as signed integer, unsigned integer or double depends on
6294 the B<Type> setting, see above.
6298 =item E<lt>B<File> I<Path>E<gt>
6300 Each B<File> block represents one CSV file to read. There must be at least one
6301 I<File> block but there can be multiple if you have multiple CSV files.
6305 =item B<Instance> I<PluginInstance>
6307 Sets the I<plugin instance> used when dispatching the values.
6309 =item B<Collect> I<Metric>
6311 Specifies which I<Metric> to collect. This option must be specified at least
6312 once, and you can use this option multiple times to specify more than one
6313 metric to be extracted from this statistic file.
6315 =item B<Interval> I<Seconds>
6317 Configures the interval in which to read values from this instance / file.
6318 Defaults to the plugin's default interval.
6320 =item B<TimeFrom> I<Index>
6322 Rather than using the local time when dispatching a value, read the timestamp
6323 from the field with the zero-based index I<Index>. The value is interpreted as
6324 seconds since epoch. The value is parsed as a double and may be factional.
6330 =head2 Plugin C<teamspeak2>
6332 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
6333 polls interesting global and virtual server data. The plugin can query only one
6334 physical server but unlimited virtual servers. You can use the following
6335 options to configure it:
6339 =item B<Host> I<hostname/ip>
6341 The hostname or ip which identifies the physical server.
6344 =item B<Port> I<port>
6346 The query port of the physical server. This needs to be a string.
6349 =item B<Server> I<port>
6351 This option has to be added once for every virtual server the plugin should
6352 query. If you want to query the virtual server on port 8767 this is what the
6353 option would look like:
6357 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
6358 use quotes around it! If no such statement is given only global information
6363 =head2 Plugin C<ted>
6365 The I<TED> plugin connects to a device of "The Energy Detective", a device to
6366 measure power consumption. These devices are usually connected to a serial
6367 (RS232) or USB port. The plugin opens a configured device and tries to read the
6368 current energy readings. For more information on TED, visit
6369 L<http://www.theenergydetective.com/>.
6371 Available configuration options:
6375 =item B<Device> I<Path>
6377 Path to the device on which TED is connected. collectd will need read and write
6378 permissions on that file.
6380 Default: B</dev/ttyUSB0>
6382 =item B<Retries> I<Num>
6384 Apparently reading from TED is not that reliable. You can therefore configure a
6385 number of retries here. You only configure the I<retries> here, to if you
6386 specify zero, one reading will be performed (but no retries if that fails); if
6387 you specify three, a maximum of four readings are performed. Negative values
6394 =head2 Plugin C<tcpconns>
6396 The C<tcpconns plugin> counts the number of currently established TCP
6397 connections based on the local port and/or the remote port. Since there may be
6398 a lot of connections the default if to count all connections with a local port,
6399 for which a listening socket is opened. You can use the following options to
6400 fine-tune the ports you are interested in:
6404 =item B<ListeningPorts> I<true>|I<false>
6406 If this option is set to I<true>, statistics for all local ports for which a
6407 listening socket exists are collected. The default depends on B<LocalPort> and
6408 B<RemotePort> (see below): If no port at all is specifically selected, the
6409 default is to collect listening ports. If specific ports (no matter if local or
6410 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
6411 the selected ports will be collected unless this option is set to I<true>
6414 =item B<LocalPort> I<Port>
6416 Count the connections to a specific local port. This can be used to see how
6417 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
6418 You have to specify the port in numeric form, so for the mailserver example
6419 you'd need to set B<25>.
6421 =item B<RemotePort> I<Port>
6423 Count the connections to a specific remote port. This is useful to see how
6424 much a remote service is used. This is most useful if you want to know how many
6425 connections a local service has opened to remote services, e.E<nbsp>g. how many
6426 connections a mail server or news server has to other mail or news servers, or
6427 how many connections a web proxy holds to web servers. You have to give the
6428 port in numeric form.
6430 =item B<AllPortsSummary> I<true>|I<false>
6432 If this option is set to I<true> a summary of statistics from all connections
6433 are collectd. This option defaults to I<false>.
6437 =head2 Plugin C<thermal>
6441 =item B<ForceUseProcfs> I<true>|I<false>
6443 By default, the I<Thermal plugin> tries to read the statistics from the Linux
6444 C<sysfs> interface. If that is not available, the plugin falls back to the
6445 C<procfs> interface. By setting this option to I<true>, you can force the
6446 plugin to use the latter. This option defaults to I<false>.
6448 =item B<Device> I<Device>
6450 Selects the name of the thermal device that you want to collect or ignore,
6451 depending on the value of the B<IgnoreSelected> option. This option may be
6452 used multiple times to specify a list of devices.
6454 =item B<IgnoreSelected> I<true>|I<false>
6456 Invert the selection: If set to true, all devices B<except> the ones that
6457 match the device names specified by the B<Device> option are collected. By
6458 default only selected devices are collected if a selection is made. If no
6459 selection is configured at all, B<all> devices are selected.
6463 =head2 Plugin C<threshold>
6465 The I<Threshold plugin> checks values collected or received by I<collectd>
6466 against a configurable I<threshold> and issues I<notifications> if values are
6469 Documentation for this plugin is available in the L<collectd-threshold(5)>
6472 =head2 Plugin C<tokyotyrant>
6474 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
6475 couple metrics: number of records, and database size on disk.
6479 =item B<Host> I<Hostname/IP>
6481 The hostname or ip which identifies the server.
6482 Default: B<127.0.0.1>
6484 =item B<Port> I<Service/Port>
6486 The query port of the server. This needs to be a string, even if the port is
6487 given in its numeric form.
6492 =head2 Plugin C<unixsock>
6496 =item B<SocketFile> I<Path>
6498 Sets the socket-file which is to be created.
6500 =item B<SocketGroup> I<Group>
6502 If running as root change the group of the UNIX-socket after it has been
6503 created. Defaults to B<collectd>.
6505 =item B<SocketPerms> I<Permissions>
6507 Change the file permissions of the UNIX-socket after it has been created. The
6508 permissions must be given as a numeric, octal value as you would pass to
6509 L<chmod(1)>. Defaults to B<0770>.
6511 =item B<DeleteSocket> B<false>|B<true>
6513 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
6514 with the given name already exists. If I<collectd> crashes a socket file may be
6515 left over, preventing the daemon from opening a new socket when restarted.
6516 Since this is potentially dangerous, this defaults to B<false>.
6520 =head2 Plugin C<uuid>
6522 This plugin, if loaded, causes the Hostname to be taken from the machine's
6523 UUID. The UUID is a universally unique designation for the machine, usually
6524 taken from the machine's BIOS. This is most useful if the machine is running in
6525 a virtual environment such as Xen, in which case the UUID is preserved across
6526 shutdowns and migration.
6528 The following methods are used to find the machine's UUID, in order:
6534 Check I</etc/uuid> (or I<UUIDFile>).
6538 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
6543 Check for UUID from C<dmidecode> / SMBIOS.
6547 Check for UUID from Xen hypervisor.
6551 If no UUID can be found then the hostname is not modified.
6555 =item B<UUIDFile> I<Path>
6557 Take the UUID from the given file (default I</etc/uuid>).
6561 =head2 Plugin C<varnish>
6563 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
6564 It collects a subset of the values displayed by L<varnishstat(1)>, and
6565 organizes them in categories which can be enabled or disabled. Currently only
6566 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
6567 meaning of each metric can be found in L<varnish-counters(7)>.
6572 <Instance "example">
6576 CollectConnections true
6577 CollectDirectorDNS false
6581 CollectObjects false
6583 CollectSession false
6593 CollectWorkers false
6597 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
6598 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
6599 will collectd statistics from the default "varnishd" instance (this should work
6600 fine in most cases).
6602 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
6606 =item B<CollectBackend> B<true>|B<false>
6608 Back-end connection statistics, such as successful, reused,
6609 and closed connections. True by default.
6611 =item B<CollectBan> B<true>|B<false>
6613 Statistics about ban operations, such as number of bans added, retired, and
6614 number of objects tested against ban operations. Only available with Varnish
6615 3.x and above. False by default.
6617 =item B<CollectCache> B<true>|B<false>
6619 Cache hits and misses. True by default.
6621 =item B<CollectConnections> B<true>|B<false>
6623 Number of client connections received, accepted and dropped. True by default.
6625 =item B<CollectDirectorDNS> B<true>|B<false>
6627 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
6630 =item B<CollectESI> B<true>|B<false>
6632 Edge Side Includes (ESI) parse statistics. False by default.
6634 =item B<CollectFetch> B<true>|B<false>
6636 Statistics about fetches (HTTP requests sent to the backend). False by default.
6638 =item B<CollectHCB> B<true>|B<false>
6640 Inserts and look-ups in the crit bit tree based hash. Look-ups are
6641 divided into locked and unlocked look-ups. False by default.
6643 =item B<CollectObjects> B<true>|B<false>
6645 Statistics on cached objects: number of objects expired, nuked (prematurely
6646 expired), saved, moved, etc. False by default.
6648 =item B<CollectPurge> B<true>|B<false>
6650 Statistics about purge operations, such as number of purges added, retired, and
6651 number of objects tested against purge operations. Only available with Varnish
6652 2.x. False by default.
6654 =item B<CollectSession> B<true>|B<false>
6656 Client session statistics. Number of past and current sessions, session herd and
6657 linger counters, etc. False by default. Note that if using Varnish 4.x, some
6658 metrics found in the Connections and Threads sections with previous versions of
6659 Varnish have been moved here.
6661 =item B<CollectSHM> B<true>|B<false>
6663 Statistics about the shared memory log, a memory region to store
6664 log messages which is flushed to disk when full. True by default.
6666 =item B<CollectSMA> B<true>|B<false>
6668 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
6669 component is Solaris specific. Only available with Varnish 2.x. False by
6672 =item B<CollectSMS> B<true>|B<false>
6674 synth (synthetic content) storage statistics. This storage
6675 component is used internally only. False by default.
6677 =item B<CollectSM> B<true>|B<false>
6679 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
6682 =item B<CollectStruct> B<true>|B<false>
6684 Current varnish internal state statistics. Number of current sessions, objects
6685 in cache store, open connections to backends (with Varnish 2.x), etc. False by
6688 =item B<CollectTotals> B<true>|B<false>
6690 Collects overview counters, such as the number of sessions created,
6691 the number of requests and bytes transferred. False by default.
6693 =item B<CollectUptime> B<true>|B<false>
6695 Varnish uptime. Only available with Varnish 3.x and above. False by default.
6697 =item B<CollectVCL> B<true>|B<false>
6699 Number of total (available + discarded) VCL (config files). False by default.
6701 =item B<CollectVSM> B<true>|B<false>
6703 Collect statistics about Varnish's shared memory usage (used by the logging and
6704 statistics subsystems). Only available with Varnish 4.x. False by default.
6706 =item B<CollectWorkers> B<true>|B<false>
6708 Collect statistics about worker threads. False by default.
6712 =head2 Plugin C<virt>
6714 This plugin allows CPU, disk and network load to be collected for virtualized
6715 guests on the machine. This means that these metrics can be collected for guest
6716 systems without installing any software on them - I<collectd> only runs on the
6717 host system. The statistics are collected through libvirt
6718 (L<http://libvirt.org/>).
6720 Only I<Connection> is required.
6724 =item B<Connection> I<uri>
6726 Connect to the hypervisor given by I<uri>. For example if using Xen use:
6728 Connection "xen:///"
6730 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
6732 =item B<RefreshInterval> I<seconds>
6734 Refresh the list of domains and devices every I<seconds>. The default is 60
6735 seconds. Setting this to be the same or smaller than the I<Interval> will cause
6736 the list of domains and devices to be refreshed on every iteration.
6738 Refreshing the devices in particular is quite a costly operation, so if your
6739 virtualization setup is static you might consider increasing this. If this
6740 option is set to 0, refreshing is disabled completely.
6742 =item B<Domain> I<name>
6744 =item B<BlockDevice> I<name:dev>
6746 =item B<InterfaceDevice> I<name:dev>
6748 =item B<IgnoreSelected> B<true>|B<false>
6750 Select which domains and devices are collected.
6752 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
6753 disk/network devices are collected.
6755 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
6756 domains and disk/network devices are ignored, while the rest are collected.
6758 The domain name and device names may use a regular expression, if the name is
6759 surrounded by I</.../> and collectd was compiled with support for regexps.
6761 The default is to collect statistics for all domains and all their devices.
6765 BlockDevice "/:hdb/"
6766 IgnoreSelected "true"
6768 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
6771 =item B<HostnameFormat> B<name|uuid|hostname|...>
6773 When the virt plugin logs data, it sets the hostname of the collected data
6774 according to this setting. The default is to use the guest name as provided by
6775 the hypervisor, which is equal to setting B<name>.
6777 B<uuid> means use the guest's UUID. This is useful if you want to track the
6778 same guest across migrations.
6780 B<hostname> means to use the global B<Hostname> setting, which is probably not
6781 useful on its own because all guests will appear to have the same name.
6783 You can also specify combinations of these fields. For example B<name uuid>
6784 means to concatenate the guest name and UUID (with a literal colon character
6785 between, thus I<"foo:1234-1234-1234-1234">).
6787 =item B<InterfaceFormat> B<name>|B<address>
6789 When the virt plugin logs interface data, it sets the name of the collected
6790 data according to this setting. The default is to use the path as provided by
6791 the hypervisor (the "dev" property of the target node), which is equal to
6794 B<address> means use the interface's mac address. This is useful since the
6795 interface path might change between reboots of a guest or across migrations.
6797 =item B<PluginInstanceFormat> B<name|uuid>
6799 When the virt plugin logs data, it sets the plugin_instance of the collected
6800 data according to this setting. The default is to use the guest name as provided
6801 by the hypervisor, which is equal to setting B<name>.
6803 B<uuid> means use the guest's UUID.
6807 =head2 Plugin C<vmem>
6809 The C<vmem> plugin collects information about the usage of virtual memory.
6810 Since the statistics provided by the Linux kernel are very detailed, they are
6811 collected very detailed. However, to get all the details, you have to switch
6812 them on manually. Most people just want an overview over, such as the number of
6813 pages read from swap space.
6817 =item B<Verbose> B<true>|B<false>
6819 Enables verbose collection of information. This will start collecting page
6820 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
6821 Part of these statistics are collected on a "per zone" basis.
6825 =head2 Plugin C<vserver>
6827 This plugin doesn't have any options. B<VServer> support is only available for
6828 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
6829 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
6830 need to apply the patches and compile your own kernel, which will then provide
6831 the F</proc/virtual> filesystem that is required by this plugin.
6833 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
6835 B<Note>: The traffic collected by this plugin accounts for the amount of
6836 traffic passing a socket which might be a lot less than the actual on-wire
6837 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
6838 collect on-wire traffic you could, for example, use the logging facilities of
6839 iptables to feed data for the guest IPs into the iptables plugin.
6841 =head2 Plugin C<write_graphite>
6843 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
6844 storage and graphing project. The plugin connects to I<Carbon>, the data layer
6845 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
6846 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
6847 of at most 1428 bytes to minimize the number of network packets.
6851 <Plugin write_graphite>
6861 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6862 blocks. Inside the B<Node> blocks, the following options are recognized:
6866 =item B<Host> I<Address>
6868 Hostname or address to connect to. Defaults to C<localhost>.
6870 =item B<Port> I<Service>
6872 Service name or port number to connect to. Defaults to C<2003>.
6874 =item B<Protocol> I<String>
6876 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
6878 =item B<LogSendErrors> B<false>|B<true>
6880 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
6881 If set to B<false>, it will not log the errors. This is especially useful when
6882 using Protocol UDP since many times we want to use the "fire-and-forget"
6883 approach and logging errors fills syslog with unneeded messages.
6885 =item B<Prefix> I<String>
6887 When set, I<String> is added in front of the host name. Dots and whitespace are
6888 I<not> escaped in this string (see B<EscapeCharacter> below).
6890 =item B<Postfix> I<String>
6892 When set, I<String> is appended to the host name. Dots and whitespace are
6893 I<not> escaped in this string (see B<EscapeCharacter> below).
6895 =item B<EscapeCharacter> I<Char>
6897 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
6898 in the identifier. The B<EscapeCharacter> option determines which character
6899 dots, whitespace and control characters are replaced with. Defaults to
6902 =item B<StoreRates> B<false>|B<true>
6904 If set to B<true> (the default), convert counter values to rates. If set to
6905 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6908 =item B<SeparateInstances> B<false>|B<true>
6910 If set to B<true>, the plugin instance and type instance will be in their own
6911 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6912 default), the plugin and plugin instance (and likewise the type and type
6913 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6915 =item B<AlwaysAppendDS> B<false>|B<true>
6917 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
6918 identifier. If set to B<false> (the default), this is only done when there is
6923 =head2 Plugin C<write_tsdb>
6925 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
6926 time series database. The plugin connects to a I<TSD>, a masterless, no shared
6927 state daemon that ingests metrics and stores them in HBase. The plugin uses
6928 I<TCP> over the "line based" protocol with a default port 4242. The data will
6929 be sent in blocks of at most 1428 bytes to minimize the number of network
6936 Host "tsd-1.my.domain"
6938 HostTags "status=production"
6942 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6943 blocks. Inside the B<Node> blocks, the following options are recognized:
6947 =item B<Host> I<Address>
6949 Hostname or address to connect to. Defaults to C<localhost>.
6951 =item B<Port> I<Service>
6953 Service name or port number to connect to. Defaults to C<4242>.
6956 =item B<HostTags> I<String>
6958 When set, I<HostTags> is added to the end of the metric. It is intended to be
6959 used for name=value pairs that the TSD will tag the metric with. Dots and
6960 whitespace are I<not> escaped in this string.
6962 =item B<StoreRates> B<false>|B<true>
6964 If set to B<true>, convert counter values to rates. If set to B<false>
6965 (the default) counter values are stored as is, as an increasing
6968 =item B<AlwaysAppendDS> B<false>|B<true>
6970 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
6971 identifier. If set to B<false> (the default), this is only done when there is
6976 =head2 Plugin C<write_mongodb>
6978 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
6983 <Plugin "write_mongodb">
6992 The plugin can send values to multiple instances of I<MongoDB> by specifying
6993 one B<Node> block for each instance. Within the B<Node> blocks, the following
6994 options are available:
6998 =item B<Host> I<Address>
7000 Hostname or address to connect to. Defaults to C<localhost>.
7002 =item B<Port> I<Service>
7004 Service name or port number to connect to. Defaults to C<27017>.
7006 =item B<Timeout> I<Timeout>
7008 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
7009 Setting this option to zero means no timeout, which is the default.
7011 =item B<StoreRates> B<false>|B<true>
7013 If set to B<true> (the default), convert counter values to rates. If set to
7014 B<false> counter values are stored as is, i.e. as an increasing integer
7017 =item B<Database> I<Database>
7019 =item B<User> I<User>
7021 =item B<Password> I<Password>
7023 Sets the information used when authenticating to a I<MongoDB> database. The
7024 fields are optional (in which case no authentication is attempted), but if you
7025 want to use authentication all three fields must be set.
7029 =head2 Plugin C<write_http>
7031 This output plugin submits values to an HTTP server using POST requests and
7032 encoding metrics with JSON or using the C<PUTVAL> command described in
7033 L<collectd-unixsock(5)>.
7037 <Plugin "write_http">
7039 URL "http://example.com/post-collectd"
7046 The plugin can send values to multiple HTTP servers by specifying one
7047 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
7048 block, the following options are available:
7054 URL to which the values are submitted to. Mandatory.
7056 =item B<User> I<Username>
7058 Optional user name needed for authentication.
7060 =item B<Password> I<Password>
7062 Optional password needed for authentication.
7064 =item B<VerifyPeer> B<true>|B<false>
7066 Enable or disable peer SSL certificate verification. See
7067 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
7069 =item B<VerifyHost> B<true|false>
7071 Enable or disable peer host name verification. If enabled, the plugin checks if
7072 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
7073 matches the host name provided by the B<URL> option. If this identity check
7074 fails, the connection is aborted. Obviously, only works when connecting to a
7075 SSL enabled server. Enabled by default.
7077 =item B<CACert> I<File>
7079 File that holds one or more SSL certificates. If you want to use HTTPS you will
7080 possibly need this option. What CA certificates come bundled with C<libcurl>
7081 and are checked by default depends on the distribution you use.
7083 =item B<CAPath> I<Directory>
7085 Directory holding one or more CA certificate files. You can use this if for
7086 some reason all the needed CA certificates aren't in the same file and can't be
7087 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
7090 =item B<ClientKey> I<File>
7092 File that holds the private key in PEM format to be used for certificate-based
7095 =item B<ClientCert> I<File>
7097 File that holds the SSL certificate to be used for certificate-based
7100 =item B<ClientKeyPass> I<Password>
7102 Password required to load the private key in B<ClientKey>.
7104 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
7106 Define which SSL protocol version must be used. By default C<libcurl> will
7107 attempt to figure out the remote SSL protocol version. See
7108 L<curl_easy_setopt(3)> for more details.
7110 =item B<Format> B<Command>|B<JSON>
7112 Format of the output to generate. If set to B<Command>, will create output that
7113 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
7114 create output in the I<JavaScript Object Notation> (JSON).
7116 Defaults to B<Command>.
7118 =item B<StoreRates> B<true|false>
7120 If set to B<true>, convert counter values to rates. If set to B<false> (the
7121 default) counter values are stored as is, i.e. as an increasing integer number.
7123 =item B<BufferSize> I<Bytes>
7125 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
7126 requests will be generated, but more metrics will be batched / metrics are
7127 cached for longer before being sent, introducing additional delay until they
7128 are available on the server side. I<Bytes> must be at least 1024 and cannot
7129 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
7130 Defaults to C<4096>.
7134 =head2 Plugin C<write_kafka>
7136 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
7140 <Plugin "write_kafka">
7141 Property "metadata.broker.list" "broker1:9092,broker2:9092"
7147 The following options are understood by the I<write_kafka plugin>:
7151 =item E<lt>B<Topic> I<Name>E<gt>
7153 The plugin's configuration consists of one or more B<Topic> blocks. Each block
7154 is given a unique I<Name> and specifies one kafka producer.
7155 Inside the B<Topic> block, the following per-topic options are
7160 =item B<Property> I<String> I<String>
7162 Configure the named property for the current topic. Properties are
7163 forwarded to the kafka producer library B<librdkafka>.
7165 =item B<Key> I<String>
7167 Use the specified string as a partioning key for the topic. Kafka breaks
7168 topic into partitions and guarantees that for a given topology, the same
7169 consumer will be used for a specific key. The special (case insensitive)
7170 string B<Random> can be used to specify that an arbitrary partition should
7173 =item B<Format> B<Command>|B<JSON>|B<Graphite>
7175 Selects the format in which messages are sent to the broker. If set to
7176 B<Command> (the default), values are sent as C<PUTVAL> commands which are
7177 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
7179 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
7180 an easy and straight forward exchange format.
7182 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
7183 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
7185 =item B<StoreRates> B<true>|B<false>
7187 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
7188 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
7189 default), no conversion is performed. Otherwise the conversion is performed
7190 using the internal value cache.
7192 Please note that currently this option is only used if the B<Format> option has
7193 been set to B<JSON>.
7195 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
7197 A prefix can be added in the metric name when outputting in the I<Graphite>
7198 format. It's added before the I<Host> name.
7200 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>>
7202 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
7204 A postfix can be added in the metric name when outputting in the I<Graphite>
7205 format. It's added after the I<Host> name.
7207 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>>
7209 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
7211 Specify a character to replace dots (.) in the host part of the metric name.
7212 In I<Graphite> metric name, dots are used as separators between different
7213 metric parts (host, plugin, type).
7214 Default is C<_> (I<Underscore>).
7216 =item B<GraphiteSeparateInstances> B<false>|B<true>
7218 If set to B<true>, the plugin instance and type instance will be in their own
7219 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
7220 default), the plugin and plugin instance (and likewise the type and type
7221 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
7223 =item B<StoreRates> B<true>|B<false>
7225 If set to B<true> (the default), convert counter values to rates. If set to
7226 B<false> counter values are stored as is, i.e. as an increasing integer number.
7228 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
7229 converted values will have "rate" appended to the data source type, e.g.
7230 C<ds_type:derive:rate>.
7234 =item B<Property> I<String> I<String>
7236 Configure the kafka producer through properties, you almost always will
7237 want to set B<metadata.broker.list> to your Kafka broker list.
7241 =head2 Plugin C<write_redis>
7243 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
7247 <Plugin "write_redis">
7255 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
7256 the timestamp as the score. Retrieving a date range can then be done using the
7257 C<ZRANGEBYSCORE> I<Redis> command. Additionnally, all the identifiers of these
7258 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> and can be
7259 retrieved using the C<SMEMBERS> I<Redis> command. See
7260 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
7263 The information shown in the synopsis above is the I<default configuration>
7264 which is used by the plugin if no configuration is present.
7266 The plugin can send values to multiple instances of I<Redis> by specifying
7267 one B<Node> block for each instance. Within the B<Node> blocks, the following
7268 options are available:
7272 =item B<Node> I<Nodename>
7274 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
7275 instance running in an specified host and port. The name for node is a
7276 canonical identifier which is used as I<plugin instance>. It is limited to
7277 64E<nbsp>characters in length.
7279 =item B<Host> I<Hostname>
7281 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
7284 =item B<Port> I<Port>
7286 The B<Port> option is the TCP port on which the Redis instance accepts
7287 connections. Either a service name of a port number may be given. Please note
7288 that numerical port numbers must be given as a string, too.
7290 =item B<Timeout> I<Timeout in miliseconds>
7292 The B<Timeout> option sets the socket connection timeout, in milliseconds.
7296 =head2 Plugin C<write_riemann>
7298 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
7299 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
7300 I<Riemann> using UDP packets.
7304 <Plugin "write_riemann">
7310 AlwaysAppendDS false
7314 Attribute "foo" "bar"
7317 The following options are understood by the I<write_riemann plugin>:
7321 =item E<lt>B<Node> I<Name>E<gt>
7323 The plugin's configuration consists of one or more B<Node> blocks. Each block
7324 is given a unique I<Name> and specifies one connection to an instance of
7325 I<Riemann>. Indise the B<Node> block, the following per-connection options are
7330 =item B<Host> I<Address>
7332 Hostname or address to connect to. Defaults to C<localhost>.
7334 =item B<Port> I<Service>
7336 Service name or port number to connect to. Defaults to C<5555>.
7338 =item B<Protocol> B<UDP>|B<TCP>
7340 Specify the protocol to use when communicating with I<Riemann>. Defaults to
7343 =item B<Batch> B<true>|B<false>
7345 If set to B<true> and B<Protocol> is set to B<TCP>,
7346 events will be batched in memory and flushed at
7347 regular intervals or when B<BatchMaxSize> is exceeded.
7349 Notifications are not batched and sent as soon as possible.
7351 When enabled, it can occur that events get processed by the Riemann server
7352 close to or after their expiration time. Tune the B<TTLFactor> and
7353 B<BatchMaxSize> settings according to the amount of values collected, if this
7358 =item B<BatchMaxSize> I<size>
7360 Maximum payload size for a riemann packet. Defaults to 8192
7362 =item B<StoreRates> B<true>|B<false>
7364 If set to B<true> (the default), convert counter values to rates. If set to
7365 B<false> counter values are stored as is, i.e. as an increasing integer number.
7367 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
7368 converted values will have "rate" appended to the data source type, e.g.
7369 C<ds_type:derive:rate>.
7371 =item B<AlwaysAppendDS> B<false>|B<true>
7373 If set the B<true>, append the name of the I<Data Source> (DS) to the
7374 "service", i.e. the field that, together with the "host" field, uniquely
7375 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
7376 only done when there is more than one DS.
7378 =item B<TTLFactor> I<Factor>
7380 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
7381 event is considered active. I<collectd> populates this field based on the
7382 metrics interval setting. This setting controls the factor with which the
7383 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
7384 know exactly what you're doing, you should only increase this setting from its
7387 =item B<Notifications> B<false>|B<true>
7389 If set to B<true>, create riemann events for notifications. This is B<true>
7390 by default. When processing thresholds from write_riemann, it might prove
7391 useful to avoid getting notification events.
7393 =item B<CheckThresholds> B<false>|B<true>
7395 If set to B<true>, attach state to events based on thresholds defined
7396 in the B<Threshold> plugin. Defaults to B<false>.
7398 =item B<EventServicePrefix> I<String>
7400 Add the given string as a prefix to the event service name.
7401 If B<EventServicePrefix> not set or set to an empty string (""),
7402 no prefix will be used.
7406 =item B<Tag> I<String>
7408 Add the given string as an additional tag to the metric being sent to
7411 =item B<Attribute> I<String> I<String>
7413 Consider the two given strings to be the key and value of an additional
7414 attribute for each metric being sent out to I<Riemann>.
7418 =head2 Plugin C<zookeeper>
7420 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
7421 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
7426 <Plugin "zookeeper">
7433 =item B<Host> I<Address>
7435 Hostname or address to connect to. Defaults to C<localhost>.
7437 =item B<Port> I<Service>
7439 Service name or port number to connect to. Defaults to C<2181>.
7443 =head1 THRESHOLD CONFIGURATION
7445 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
7446 we mean that the values are not only stored or sent somewhere, but that they
7447 are judged and, if a problem is recognized, acted upon. The only action
7448 collectd takes itself is to generate and dispatch a "notification". Plugins can
7449 register to receive notifications and perform appropriate further actions.
7451 Since systems and what you expect them to do differ a lot, you can configure
7452 B<thresholds> for your values freely. This gives you a lot of flexibility but
7453 also a lot of responsibility.
7455 Every time a value is out of range a notification is dispatched. This means
7456 that the idle percentage of your CPU needs to be less then the configured
7457 threshold only once for a notification to be generated. There's no such thing
7458 as a moving average or similar - at least not now.
7460 Also, all values that match a threshold are considered to be relevant or
7461 "interesting". As a consequence collectd will issue a notification if they are
7462 not received for B<Timeout> iterations. The B<Timeout> configuration option is
7463 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
7464 "2" (the default) and some hosts sends it's CPU statistics to the server every
7465 60 seconds, a notification will be dispatched after about 120 seconds. It may
7466 take a little longer because the timeout is checked only once each B<Interval>
7469 When a value comes within range again or is received after it was missing, an
7470 "OKAY-notification" is dispatched.
7472 Here is a configuration example to get you started. Read below for more
7485 <Plugin "interface">
7502 WarningMin 100000000
7508 There are basically two types of configuration statements: The C<Host>,
7509 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
7510 configured. The C<Plugin> and C<Type> blocks may be specified further using the
7511 C<Instance> option. You can combine the block by nesting the blocks, though
7512 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
7513 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
7514 C<Type> may not contain other blocks. If multiple blocks apply to the same
7515 value the most specific block is used.
7517 The other statements specify the threshold to configure. They B<must> be
7518 included in a C<Type> block. Currently the following statements are recognized:
7522 =item B<FailureMax> I<Value>
7524 =item B<WarningMax> I<Value>
7526 Sets the upper bound of acceptable values. If unset defaults to positive
7527 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
7528 will be created. If the value is greater than B<WarningMax> but less than (or
7529 equal to) B<FailureMax> a B<WARNING> notification will be created.
7531 =item B<FailureMin> I<Value>
7533 =item B<WarningMin> I<Value>
7535 Sets the lower bound of acceptable values. If unset defaults to negative
7536 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
7537 be created. If the value is less than B<WarningMin> but greater than (or equal
7538 to) B<FailureMin> a B<WARNING> notification will be created.
7540 =item B<DataSource> I<DSName>
7542 Some data sets have more than one "data source". Interesting examples are the
7543 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
7544 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
7545 system load data set, C<load>, even has three data sources: C<shortterm>,
7546 C<midterm>, and C<longterm>.
7548 Normally, all data sources are checked against a configured threshold. If this
7549 is undesirable, or if you want to specify different limits for each data
7550 source, you can use the B<DataSource> option to have a threshold apply only to
7553 =item B<Invert> B<true>|B<false>
7555 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
7556 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
7557 B<WarningMax>) are not okay. Defaults to B<false>.
7559 =item B<Persist> B<true>|B<false>
7561 Sets how often notifications are generated. If set to B<true> one notification
7562 will be generated for each value that is out of the acceptable range. If set to
7563 B<false> (the default) then a notification is only generated if a value is out
7564 of range but the previous value was okay.
7566 This applies to missing values, too: If set to B<true> a notification about a
7567 missing value is generated once every B<Interval> seconds. If set to B<false>
7568 only one such notification is generated until the value appears again.
7570 =item B<Percentage> B<true>|B<false>
7572 If set to B<true>, the minimum and maximum values given are interpreted as
7573 percentage value, relative to the other data sources. This is helpful for
7574 example for the "df" type, where you may want to issue a warning when less than
7575 5E<nbsp>% of the total space is available. Defaults to B<false>.
7577 =item B<Hits> I<Number>
7579 Delay creating the notification until the threshold has been passed I<Number>
7580 times. When a notification has been generated, or when a subsequent value is
7581 inside the threshold, the counter is reset. If, for example, a value is
7582 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
7583 will be dispatched at most once every 30E<nbsp>seconds.
7585 This is useful when short bursts are not a problem. If, for example, 100% CPU
7586 usage for up to a minute is normal (and data is collected every
7587 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
7589 =item B<Hysteresis> I<Number>
7591 When set to non-zero, a hysteresis value is applied when checking minimum and
7592 maximum bounds. This is useful for values that increase slowly and fluctuate a
7593 bit while doing so. When these values come close to the threshold, they may
7594 "flap", i.e. switch between failure / warning case and okay case repeatedly.
7596 If, for example, the threshold is configures as
7601 then a I<Warning> notification is created when the value exceeds I<101> and the
7602 corresponding I<Okay> notification is only created once the value falls below
7603 I<99>, thus avoiding the "flapping".
7607 =head1 FILTER CONFIGURATION
7609 Starting with collectd 4.6 there is a powerful filtering infrastructure
7610 implemented in the daemon. The concept has mostly been copied from
7611 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
7612 terminology, so that users that are familiar with iptables feel right at home.
7616 The following are the terms used in the remainder of the filter configuration
7617 documentation. For an ASCII-art schema of the mechanism, see
7618 L<"General structure"> below.
7624 A I<match> is a criteria to select specific values. Examples are, of course, the
7625 name of the value or it's current value.
7627 Matches are implemented in plugins which you have to load prior to using the
7628 match. The name of such plugins starts with the "match_" prefix.
7632 A I<target> is some action that is to be performed with data. Such actions
7633 could, for example, be to change part of the value's identifier or to ignore
7634 the value completely.
7636 Some of these targets are built into the daemon, see L<"Built-in targets">
7637 below. Other targets are implemented in plugins which you have to load prior to
7638 using the target. The name of such plugins starts with the "target_" prefix.
7642 The combination of any number of matches and at least one target is called a
7643 I<rule>. The target actions will be performed for all values for which B<all>
7644 matches apply. If the rule does not have any matches associated with it, the
7645 target action will be performed for all values.
7649 A I<chain> is a list of rules and possibly default targets. The rules are tried
7650 in order and if one matches, the associated target will be called. If a value
7651 is handled by a rule, it depends on the target whether or not any subsequent
7652 rules are considered or if traversal of the chain is aborted, see
7653 L<"Flow control"> below. After all rules have been checked, the default targets
7658 =head2 General structure
7660 The following shows the resulting structure:
7667 +---------+ +---------+ +---------+ +---------+
7668 ! Rule !->! Match !->! Match !->! Target !
7669 +---------+ +---------+ +---------+ +---------+
7672 +---------+ +---------+ +---------+
7673 ! Rule !->! Target !->! Target !
7674 +---------+ +---------+ +---------+
7681 +---------+ +---------+ +---------+
7682 ! Rule !->! Match !->! Target !
7683 +---------+ +---------+ +---------+
7693 There are four ways to control which way a value takes through the filter
7700 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
7701 process the value with another chain. When the called chain finishes, usually
7702 the next target or rule after the jump is executed.
7706 The stop condition, signaled for example by the built-in target B<stop>, causes
7707 all processing of the value to be stopped immediately.
7711 Causes processing in the current chain to be aborted, but processing of the
7712 value generally will continue. This means that if the chain was called via
7713 B<Jump>, the next target or rule after the jump will be executed. If the chain
7714 was not called by another chain, control will be returned to the daemon and it
7715 may pass the value to another chain.
7719 Most targets will signal the B<continue> condition, meaning that processing
7720 should continue normally. There is no special built-in target for this
7727 The configuration reflects this structure directly:
7729 PostCacheChain "PostCache"
7731 <Rule "ignore_mysql_show">
7734 Type "^mysql_command$"
7735 TypeInstance "^show_"
7745 The above configuration example will ignore all values where the plugin field
7746 is "mysql", the type is "mysql_command" and the type instance begins with
7747 "show_". All other values will be sent to the C<rrdtool> write plugin via the
7748 default target of the chain. Since this chain is run after the value has been
7749 added to the cache, the MySQL C<show_*> command statistics will be available
7750 via the C<unixsock> plugin.
7752 =head2 List of configuration options
7756 =item B<PreCacheChain> I<ChainName>
7758 =item B<PostCacheChain> I<ChainName>
7760 Configure the name of the "pre-cache chain" and the "post-cache chain". The
7761 argument is the name of a I<chain> that should be executed before and/or after
7762 the values have been added to the cache.
7764 To understand the implications, it's important you know what is going on inside
7765 I<collectd>. The following diagram shows how values are passed from the
7766 read-plugins to the write-plugins:
7772 + - - - - V - - - - +
7773 : +---------------+ :
7776 : +-------+-------+ :
7779 : +-------+-------+ : +---------------+
7780 : ! Cache !--->! Value Cache !
7781 : ! insert ! : +---+---+-------+
7782 : +-------+-------+ : ! !
7783 : ! ,------------' !
7785 : +-------+---+---+ : +-------+-------+
7786 : ! Post-Cache +--->! Write-Plugins !
7787 : ! Chain ! : +---------------+
7788 : +---------------+ :
7791 + - - - - - - - - - +
7793 After the values are passed from the "read" plugins to the dispatch functions,
7794 the pre-cache chain is run first. The values are added to the internal cache
7795 afterwards. The post-cache chain is run after the values have been added to the
7796 cache. So why is it such a huge deal if chains are run before or after the
7797 values have been added to this cache?
7799 Targets that change the identifier of a value list should be executed before
7800 the values are added to the cache, so that the name in the cache matches the
7801 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
7802 this cache to receive a list of all available values. If you change the
7803 identifier after the value list has been added to the cache, this may easily
7804 lead to confusion, but it's not forbidden of course.
7806 The cache is also used to convert counter values to rates. These rates are, for
7807 example, used by the C<value> match (see below). If you use the rate stored in
7808 the cache B<before> the new value is added, you will use the old, B<previous>
7809 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
7810 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
7813 Last but not last, the B<stop> target makes a difference: If the pre-cache
7814 chain returns the stop condition, the value will not be added to the cache and
7815 the post-cache chain will not be run.
7817 =item B<Chain> I<Name>
7819 Adds a new chain with a certain name. This name can be used to refer to a
7820 specific chain, for example to jump to it.
7822 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
7824 =item B<Rule> [I<Name>]
7826 Adds a new rule to the current chain. The name of the rule is optional and
7827 currently has no meaning for the daemon.
7829 Within the B<Rule> block, there may be any number of B<Match> blocks and there
7830 must be at least one B<Target> block.
7832 =item B<Match> I<Name>
7834 Adds a match to a B<Rule> block. The name specifies what kind of match should
7835 be performed. Available matches depend on the plugins that have been loaded.
7837 The arguments inside the B<Match> block are passed to the plugin implementing
7838 the match, so which arguments are valid here depends on the plugin being used.
7839 If you do not need any to pass any arguments to a match, you can use the
7844 Which is equivalent to:
7849 =item B<Target> I<Name>
7851 Add a target to a rule or a default target to a chain. The name specifies what
7852 kind of target is to be added. Which targets are available depends on the
7853 plugins being loaded.
7855 The arguments inside the B<Target> block are passed to the plugin implementing
7856 the target, so which arguments are valid here depends on the plugin being used.
7857 If you do not need any to pass any arguments to a target, you can use the
7862 This is the same as writing:
7869 =head2 Built-in targets
7871 The following targets are built into the core daemon and therefore need no
7872 plugins to be loaded:
7878 Signals the "return" condition, see the L<"Flow control"> section above. This
7879 causes the current chain to stop processing the value and returns control to
7880 the calling chain. The calling chain will continue processing targets and rules
7881 just after the B<jump> target (see below). This is very similar to the
7882 B<RETURN> target of iptables, see L<iptables(8)>.
7884 This target does not have any options.
7892 Signals the "stop" condition, see the L<"Flow control"> section above. This
7893 causes processing of the value to be aborted immediately. This is similar to
7894 the B<DROP> target of iptables, see L<iptables(8)>.
7896 This target does not have any options.
7904 Sends the value to "write" plugins.
7910 =item B<Plugin> I<Name>
7912 Name of the write plugin to which the data should be sent. This option may be
7913 given multiple times to send the data to more than one write plugin. If the
7914 plugin supports multiple instances, the plugin's instance(s) must also be
7919 If no plugin is explicitly specified, the values will be sent to all available
7922 Single-instance plugin example:
7928 Multi-instance plugin example:
7930 <Plugin "write_graphite">
7940 Plugin "write_graphite/foo"
7945 Starts processing the rules of another chain, see L<"Flow control"> above. If
7946 the end of that chain is reached, or a stop condition is encountered,
7947 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
7948 next target or the next rule. This is similar to the B<-j> command line option
7949 of iptables, see L<iptables(8)>.
7955 =item B<Chain> I<Name>
7957 Jumps to the chain I<Name>. This argument is required and may appear only once.
7969 =head2 Available matches
7975 Matches a value using regular expressions.
7981 =item B<Host> I<Regex>
7983 =item B<Plugin> I<Regex>
7985 =item B<PluginInstance> I<Regex>
7987 =item B<Type> I<Regex>
7989 =item B<TypeInstance> I<Regex>
7991 Match values where the given regular expressions match the various fields of
7992 the identifier of a value. If multiple regular expressions are given, B<all>
7993 regexen must match for a value to match.
7995 =item B<Invert> B<false>|B<true>
7997 When set to B<true>, the result of the match is inverted, i.e. all value lists
7998 where all regular expressions apply are not matched, all other value lists are
7999 matched. Defaults to B<false>.
8006 Host "customer[0-9]+"
8012 Matches values that have a time which differs from the time on the server.
8014 This match is mainly intended for servers that receive values over the
8015 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
8016 is very sensitive to the timestamp used when updating the RRD files. In
8017 particular, the time must be ever increasing. If a misbehaving client sends one
8018 packet with a timestamp far in the future, all further packets with a correct
8019 time will be ignored because of that one packet. What's worse, such corrupted
8020 RRD files are hard to fix.
8022 This match lets one match all values B<outside> a specified time range
8023 (relative to the server's time), so you can use the B<stop> target (see below)
8024 to ignore the value, for example.
8030 =item B<Future> I<Seconds>
8032 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
8033 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
8036 =item B<Past> I<Seconds>
8038 Matches all values that are I<behind> of the server's time by I<Seconds> or
8039 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
8051 This example matches all values that are five minutes or more ahead of the
8052 server or one hour (or more) lagging behind.
8056 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
8057 values. If a data-set consists of more than one data-source, all data-sources
8058 must match the specified ranges for a positive match.
8064 =item B<Min> I<Value>
8066 Sets the smallest value which still results in a match. If unset, behaves like
8069 =item B<Max> I<Value>
8071 Sets the largest value which still results in a match. If unset, behaves like
8074 =item B<Invert> B<true>|B<false>
8076 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
8077 no-match is returned and vice versa. Please note that the B<Invert> setting
8078 only effects how B<Min> and B<Max> are applied to a specific value. Especially
8079 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
8081 =item B<DataSource> I<DSName> [I<DSName> ...]
8083 Select one or more of the data sources. If no data source is configured, all
8084 data sources will be checked. If the type handled by the match does not have a
8085 data source of the specified name(s), this will always result in no match
8086 (independent of the B<Invert> setting).
8088 =item B<Satisfy> B<Any>|B<All>
8090 Specifies how checking with several data sources is performed. If set to
8091 B<Any>, the match succeeds if one of the data sources is in the configured
8092 range. If set to B<All> the match only succeeds if all data sources are within
8093 the configured range. Default is B<All>.
8095 Usually B<All> is used for positive matches, B<Any> is used for negative
8096 matches. This means that with B<All> you usually check that all values are in a
8097 "good" range, while with B<Any> you check if any value is within a "bad" range
8098 (or outside the "good" range).
8102 Either B<Min> or B<Max>, but not both, may be unset.
8106 # Match all values smaller than or equal to 100. Matches only if all data
8107 # sources are below 100.
8113 # Match if the value of any data source is outside the range of 0 - 100.
8121 =item B<empty_counter>
8123 Matches all values with one or more data sources of type B<COUNTER> and where
8124 all counter values are zero. These counters usually I<never> increased since
8125 they started existing (and are therefore uninteresting), or got reset recently
8126 or overflowed and you had really, I<really> bad luck.
8128 Please keep in mind that ignoring such counters can result in confusing
8129 behavior: Counters which hardly ever increase will be zero for long periods of
8130 time. If the counter is reset for some reason (machine or service restarted,
8131 usually), the graph will be empty (NAN) for a long time. People may not
8136 Calculates a hash value of the host name and matches values according to that
8137 hash value. This makes it possible to divide all hosts into groups and match
8138 only values that are in a specific group. The intended use is in load
8139 balancing, where you want to handle only part of all data and leave the rest
8142 The hashing function used tries to distribute the hosts evenly. First, it
8143 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
8146 for (i = 0; host[i] != 0; i++)
8147 hash_value = (hash_value * 251) + host[i];
8149 The constant 251 is a prime number which is supposed to make this hash value
8150 more random. The code then checks the group for this host according to the
8151 I<Total> and I<Match> arguments:
8153 if ((hash_value % Total) == Match)
8158 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
8159 groups), then the least significant bit of the hash value will be the XOR of
8160 all least significant bits in the host name. One consequence is that when you
8161 have two hosts, "server0.example.com" and "server1.example.com", where the host
8162 name differs in one digit only and the digits differ by one, those hosts will
8163 never end up in the same group.
8169 =item B<Match> I<Match> I<Total>
8171 Divide the data into I<Total> groups and match all hosts in group I<Match> as
8172 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
8173 be smaller than I<Total>. I<Total> must be at least one, although only values
8174 greater than one really do make any sense.
8176 You can repeat this option to match multiple groups, for example:
8181 The above config will divide the data into seven groups and match groups three
8182 and five. One use would be to keep every value on two hosts so that if one
8183 fails the missing data can later be reconstructed from the second host.
8189 # Operate on the pre-cache chain, so that ignored values are not even in the
8194 # Divide all received hosts in seven groups and accept all hosts in
8198 # If matched: Return and continue.
8201 # If not matched: Return and stop.
8207 =head2 Available targets
8211 =item B<notification>
8213 Creates and dispatches a notification.
8219 =item B<Message> I<String>
8221 This required option sets the message of the notification. The following
8222 placeholders will be replaced by an appropriate value:
8230 =item B<%{plugin_instance}>
8234 =item B<%{type_instance}>
8236 These placeholders are replaced by the identifier field of the same name.
8238 =item B<%{ds:>I<name>B<}>
8240 These placeholders are replaced by a (hopefully) human readable representation
8241 of the current rate of this data source. If you changed the instance name
8242 (using the B<set> or B<replace> targets, see below), it may not be possible to
8243 convert counter values to rates.
8247 Please note that these placeholders are B<case sensitive>!
8249 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
8251 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
8258 <Target "notification">
8259 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
8265 Replaces parts of the identifier using regular expressions.
8271 =item B<Host> I<Regex> I<Replacement>
8273 =item B<Plugin> I<Regex> I<Replacement>
8275 =item B<PluginInstance> I<Regex> I<Replacement>
8277 =item B<TypeInstance> I<Regex> I<Replacement>
8279 Match the appropriate field with the given regular expression I<Regex>. If the
8280 regular expression matches, that part that matches is replaced with
8281 I<Replacement>. If multiple places of the input buffer match a given regular
8282 expression, only the first occurrence will be replaced.
8284 You can specify each option multiple times to use multiple regular expressions
8292 # Replace "example.net" with "example.com"
8293 Host "\\<example.net\\>" "example.com"
8295 # Strip "www." from hostnames
8301 Sets part of the identifier of a value to a given string.
8307 =item B<Host> I<String>
8309 =item B<Plugin> I<String>
8311 =item B<PluginInstance> I<String>
8313 =item B<TypeInstance> I<String>
8315 Set the appropriate field to the given string. The strings for plugin instance
8316 and type instance may be empty, the strings for host and plugin may not be
8317 empty. It's currently not possible to set the type of a value this way.
8324 PluginInstance "coretemp"
8325 TypeInstance "core3"
8330 =head2 Backwards compatibility
8332 If you use collectd with an old configuration, i.E<nbsp>e. one without a
8333 B<Chain> block, it will behave as it used to. This is equivalent to the
8334 following configuration:
8340 If you specify a B<PostCacheChain>, the B<write> target will not be added
8341 anywhere and you will have to make sure that it is called where appropriate. We
8342 suggest to add the above snippet as default target to your "PostCache" chain.
8346 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
8362 L<collectd-exec(5)>,
8363 L<collectd-perl(5)>,
8364 L<collectd-unixsock(5)>,
8377 Florian Forster E<lt>octo@collectd.orgE<gt>