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<#>) are 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 which 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> the appropriate B<LoadPlugin> statement. The downside is that if
87 you have multiple conflicting B<LoadPlugin> blocks, e.g. when they specify
88 different intervals, only one of them (the first one encountered) will take
89 effect and all others will be silently ignored.
91 B<LoadPlugin> may either be a simple configuration I<statement> or a I<block>
92 with additional options, affecting the behavior of B<LoadPlugin>. A simple
93 statement looks like this:
97 Options inside a B<LoadPlugin> block can override default settings and
98 influence the way plugins are loaded, e.g.:
104 The following options are valid inside B<LoadPlugin> blocks:
108 =item B<Globals> B<true|false>
110 If enabled, collectd will export all global symbols of the plugin (and of all
111 libraries loaded as dependencies of the plugin) and, thus, makes those symbols
112 available for resolving unresolved symbols in subsequently loaded plugins if
113 that is supported by your system.
115 This is useful (or possibly even required), e.g., when loading a plugin that
116 embeds some scripting language into the daemon (e.g. the I<Perl> and
117 I<Python plugins>). Scripting languages usually provide means to load
118 extensions written in C. Those extensions require symbols provided by the
119 interpreter, which is loaded as a dependency of the respective collectd plugin.
120 See the documentation of those plugins (e.g., L<collectd-perl(5)> or
121 L<collectd-python(5)>) for details.
123 By default, this is disabled. As a special exception, if the plugin name is
124 either C<perl> or C<python>, the default is changed to enabled in order to keep
125 the average user from ever having to deal with this low level linking stuff.
127 =item B<Interval> I<Seconds>
129 Sets a plugin-specific interval for collecting metrics. This overrides the
130 global B<Interval> setting. If a plugin provides its own support for specifying
131 an interval, that setting will take precedence.
133 =item B<FlushInterval> I<Seconds>
135 Specifies the interval, in seconds, to call the flush callback if it's
136 defined in this plugin. By default, this is disabled.
138 =item B<FlushTimeout> I<Seconds>
140 Specifies the value of the timeout argument of the flush callback.
144 =item B<AutoLoadPlugin> B<false>|B<true>
146 When set to B<false> (the default), each plugin needs to be loaded explicitly,
147 using the B<LoadPlugin> statement documented above. If a
148 B<E<lt>PluginE<nbsp>...E<gt>> block is encountered and no configuration
149 handling callback for this plugin has been registered, a warning is logged and
150 the block is ignored.
152 When set to B<true>, explicit B<LoadPlugin> statements are not required. Each
153 B<E<lt>PluginE<nbsp>...E<gt>> block acts as if it was immediately preceded by a
154 B<LoadPlugin> statement. B<LoadPlugin> statements are still required for
155 plugins that don't provide any configuration, e.g. the I<Load plugin>.
157 =item B<CollectInternalStats> B<false>|B<true>
159 When set to B<true>, various statistics about the I<collectd> daemon will be
160 collected, with "collectd" as the I<plugin name>. Defaults to B<false>.
162 The following metrics are reported:
166 =item C<collectd-write_queue/queue_length>
168 The number of metrics currently in the write queue. You can limit the queue
169 length with the B<WriteQueueLimitLow> and B<WriteQueueLimitHigh> options.
171 =item C<collectd-write_queue/derive-dropped>
173 The number of metrics dropped due to a queue length limitation.
174 If this value is non-zero, your system can't handle all incoming metrics and
175 protects itself against overload by dropping metrics.
177 =item C<collectd-cache/cache_size>
179 The number of elements in the metric cache (the cache you can interact with
180 using L<collectd-unixsock(5)>).
184 =item B<Include> I<Path> [I<pattern>]
186 If I<Path> points to a file, includes that file. If I<Path> points to a
187 directory, recursively includes all files within that directory and its
188 subdirectories. If the C<wordexp> function is available on your system,
189 shell-like wildcards are expanded before files are included. This means you can
190 use statements like the following:
192 Include "/etc/collectd.d/*.conf"
194 Starting with version 5.3, this may also be a block in which further options
195 affecting the behavior of B<Include> may be specified. The following option is
198 <Include "/etc/collectd.d">
204 =item B<Filter> I<pattern>
206 If the C<fnmatch> function is available on your system, a shell-like wildcard
207 I<pattern> may be specified to filter which files to include. This may be used
208 in combination with recursively including a directory to easily be able to
209 arbitrarily mix configuration files and other documents (e.g. README files).
210 The given example is similar to the first example above but includes all files
211 matching C<*.conf> in any subdirectory of C</etc/collectd.d>.
215 If more than one file is included by a single B<Include> option, the files
216 will be included in lexicographical order (as defined by the C<strcmp>
217 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
218 order in which the files are loaded.
220 To prevent loops and shooting yourself in the foot in interesting ways the
221 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
222 most uses. Since symlinks are followed it is still possible to crash the daemon
223 by looping symlinks. In our opinion significant stupidity should result in an
224 appropriate amount of pain.
226 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
227 file, but you cannot include files from within blocks.
229 =item B<PIDFile> I<File>
231 Sets where to write the PID file to. This file is overwritten when it exists
232 and deleted when the program is stopped. Some init-scripts might override this
233 setting using the B<-P> command-line option.
235 =item B<PluginDir> I<Directory>
237 Path to the plugins (shared objects) of collectd.
239 =item B<TypesDB> I<File> [I<File> ...]
241 Set one or more files that contain the data-set descriptions. See
242 L<types.db(5)> for a description of the format of this file.
244 If this option is not specified, a default file is read. If you need to define
245 custom types in addition to the types defined in the default file, you need to
246 explicitly load both. In other words, if the B<TypesDB> option is encountered
247 the default behavior is disabled and if you need the default types you have to
248 also explicitly load them.
250 =item B<Interval> I<Seconds>
252 Configures the interval in which to query the read plugins. Obviously smaller
253 values lead to a higher system load produced by collectd, while higher values
254 lead to more coarse statistics.
256 B<Warning:> You should set this once and then never touch it again. If you do,
257 I<you will have to delete all your RRD files> or know some serious RRDtool
258 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
260 =item B<MaxReadInterval> I<Seconds>
262 A read plugin doubles the interval between queries after each failed attempt
265 This options limits the maximum value of the interval. The default value is
268 =item B<Timeout> I<Iterations>
270 Consider a value list "missing" when no update has been read or received for
271 I<Iterations> iterations. By default, I<collectd> considers a value list
272 missing when no update has been received for twice the update interval. Since
273 this setting uses iterations, the maximum allowed time without update depends
274 on the I<Interval> information contained in each value list. This is used in
275 the I<Threshold> configuration to dispatch notifications about missing values,
276 see L<collectd-threshold(5)> for details.
278 =item B<ReadThreads> I<Num>
280 Number of threads to start for reading plugins. The default value is B<5>, but
281 you may want to increase this if you have more than five plugins that take a
282 long time to read. Mostly those are plugins that do network-IO. Setting this to
283 a value higher than the number of registered read callbacks is not recommended.
285 =item B<WriteThreads> I<Num>
287 Number of threads to start for dispatching value lists to write plugins. The
288 default value is B<5>, but you may want to increase this if you have more than
289 five plugins that may take relatively long to write to.
291 =item B<WriteQueueLimitHigh> I<HighNum>
293 =item B<WriteQueueLimitLow> I<LowNum>
295 Metrics are read by the I<read threads> and then put into a queue to be handled
296 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
297 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
298 running into memory issues in such a case, you can limit the size of this
301 By default, there is no limit and memory may grow indefinitely. This is most
302 likely not an issue for clients, i.e. instances that only handle the local
303 metrics. For servers it is recommended to set this to a non-zero value, though.
305 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
306 Each of them takes a numerical argument which is the number of metrics in the
307 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
308 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
309 I<will> be enqueued. If the number of metrics currently in the queue is between
310 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
311 proportional to the number of metrics in the queue (i.e. it increases linearly
312 until it reaches 100%.)
314 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
315 unset, the latter will default to half of B<WriteQueueLimitHigh>.
317 If you do not want to randomly drop values when the queue size is between
318 I<LowNum> and I<HighNum>, set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>
321 Enabling the B<CollectInternalStats> option is of great help to figure out the
322 values to set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow> to.
324 =item B<Hostname> I<Name>
326 Sets the hostname that identifies a host. If you omit this setting, the
327 hostname will be determined using the L<gethostname(2)> system call.
329 =item B<FQDNLookup> B<true|false>
331 If B<Hostname> is determined automatically this setting controls whether or not
332 the daemon should try to figure out the "fully qualified domain name", FQDN.
333 This is done using a lookup of the name returned by C<gethostname>. This option
334 is enabled by default.
336 =item B<PreCacheChain> I<ChainName>
338 =item B<PostCacheChain> I<ChainName>
340 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
341 see L</"FILTER CONFIGURATION"> below on information on chains and how these
342 setting change the daemon's behavior.
346 =head1 PLUGIN OPTIONS
348 Some plugins may register own options. These options must be enclosed in a
349 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
350 require external configuration, too. The C<apache plugin>, for example,
351 required C<mod_status> to be configured in the webserver you're going to
352 collect data from. These plugins are listed below as well, even if they don't
353 require any configuration within collectd's configuration file.
355 A list of all plugins and a short summary for each plugin can be found in the
356 F<README> file shipped with the sourcecode and hopefully binary packets as
359 =head2 Plugin C<aggregation>
361 The I<Aggregation plugin> makes it possible to aggregate several values into
362 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
363 This can be put to a wide variety of uses, e.g. average and total CPU
364 statistics for your entire fleet.
366 The grouping is powerful but, as with many powerful tools, may be a bit
367 difficult to wrap your head around. The grouping will therefore be
368 demonstrated using an example: The average and sum of the CPU usage across
369 all CPUs of each host is to be calculated.
371 To select all the affected values for our example, set C<Plugin cpu> and
372 C<Type cpu>. The other values are left unspecified, meaning "all values". The
373 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
374 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
380 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...) and
381 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
382 example, the intention is to have a new value for each host / type instance
383 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
384 It can be specified multiple times to group by more than one field.
387 GroupBy "TypeInstance"
389 We do neither specify nor group by I<plugin instance> (the CPU number), so all
390 metrics that differ in the CPU number only will be aggregated. Each
391 aggregation needs I<at least one> such field, otherwise no aggregation would
394 The full example configuration looks like this:
396 <Plugin "aggregation">
402 GroupBy "TypeInstance"
405 CalculateAverage true
409 There are a couple of limitations you should be aware of:
415 The I<Type> cannot be left unspecified, because it is not reasonable to add
416 apples to oranges. Also, the internal lookup structure won't work if you try
421 There must be at least one unspecified, ungrouped field. Otherwise nothing
426 As you can see in the example above, each aggregation has its own
427 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
428 blocks may match the same values, i.e. one value list can update multiple
429 aggregations. The following options are valid inside B<Aggregation> blocks:
433 =item B<Host> I<Host>
435 =item B<Plugin> I<Plugin>
437 =item B<PluginInstance> I<PluginInstance>
439 =item B<Type> I<Type>
441 =item B<TypeInstance> I<TypeInstance>
443 Selects the value lists to be added to this aggregation. B<Type> must be a
444 valid data set name, see L<types.db(5)> for details.
446 If the string starts with and ends with a slash (C</>), the string is
447 interpreted as a I<regular expression>. The regex flavor used are POSIX
448 extended regular expressions as described in L<regex(7)>. Example usage:
450 Host "/^db[0-9]\\.example\\.com$/"
452 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
454 Group valued by the specified field. The B<GroupBy> option may be repeated to
455 group by multiple fields.
457 =item B<SetHost> I<Host>
459 =item B<SetPlugin> I<Plugin>
461 =item B<SetPluginInstance> I<PluginInstance>
463 =item B<SetTypeInstance> I<TypeInstance>
465 Sets the appropriate part of the identifier to the provided string.
467 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
468 will be replaced with the aggregation function, e.g. "average". Not including
469 the placeholder will result in duplication warnings and/or messed up values if
470 more than one aggregation function are enabled.
472 The following example calculates the average usage of all "even" CPUs:
474 <Plugin "aggregation">
477 PluginInstance "/[0,2,4,6,8]$/"
481 SetPluginInstance "even-%{aggregation}"
484 GroupBy "TypeInstance"
486 CalculateAverage true
490 This will create the files:
496 foo.example.com/cpu-even-average/cpu-idle
500 foo.example.com/cpu-even-average/cpu-system
504 foo.example.com/cpu-even-average/cpu-user
512 =item B<CalculateNum> B<true>|B<false>
514 =item B<CalculateSum> B<true>|B<false>
516 =item B<CalculateAverage> B<true>|B<false>
518 =item B<CalculateMinimum> B<true>|B<false>
520 =item B<CalculateMaximum> B<true>|B<false>
522 =item B<CalculateStddev> B<true>|B<false>
524 Boolean options for enabling calculation of the number of value lists, their
525 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
526 are disabled by default.
530 =head2 Plugin C<amqp>
532 The I<AMQP plugin> can be used to communicate with other instances of
533 I<collectd> or third party applications using an AMQP 0.9.1 message broker.
534 Values are sent to or received from the broker, which handles routing,
535 queueing and possibly filtering out messages.
540 # Send values to an AMQP broker
541 <Publish "some_name">
547 Exchange "amq.fanout"
548 # ExchangeType "fanout"
549 # RoutingKey "collectd"
551 # ConnectionRetryDelay 0
554 # GraphitePrefix "collectd."
555 # GraphiteEscapeChar "_"
556 # GraphiteSeparateInstances false
557 # GraphiteAlwaysAppendDS false
558 # GraphitePreserveSeparator false
561 # Receive values from an AMQP broker
562 <Subscribe "some_name">
568 Exchange "amq.fanout"
569 # ExchangeType "fanout"
572 # QueueAutoDelete true
573 # RoutingKey "collectd.#"
574 # ConnectionRetryDelay 0
578 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
579 blocks, which configure sending and receiving of values respectively. The two
580 blocks are very similar, so unless otherwise noted, an option can be used in
581 either block. The name given in the blocks starting tag is only used for
582 reporting messages, but may be used to support I<flushing> of certain
583 I<Publish> blocks in the future.
587 =item B<Host> I<Host>
589 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
590 the underlying communications library, I<rabbitmq-c>, which is "localhost".
592 =item B<Port> I<Port>
594 Service name or port number on which the AMQP broker accepts connections. This
595 argument must be a string, even if the numeric form is used. Defaults to
598 =item B<VHost> I<VHost>
600 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
602 =item B<User> I<User>
604 =item B<Password> I<Password>
606 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
609 =item B<Exchange> I<Exchange>
611 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
612 By default, "amq.fanout" will be used.
614 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
615 the given exchange and the I<queue> is created, using the I<routing key> if
616 configured. See the B<Queue> and B<RoutingKey> options below.
618 =item B<ExchangeType> I<Type>
620 If given, the plugin will try to create the configured I<exchange> with this
621 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
622 be bound to this exchange.
624 =item B<Queue> I<Queue> (Subscribe only)
626 Configures the I<queue> name to subscribe to. If no queue name was configured
627 explicitly, a unique queue name will be created by the broker.
629 =item B<QueueDurable> B<true>|B<false> (Subscribe only)
631 Defines if the I<queue> subscribed to is durable (saved to persistent storage)
632 or transient (will disappear if the AMQP broker is restarted). Defaults to
635 This option should be used in conjunction with the I<Persistent> option on the
638 =item B<QueueAutoDelete> B<true>|B<false> (Subscribe only)
640 Defines if the I<queue> subscribed to will be deleted once the last consumer
641 unsubscribes. Defaults to "true".
643 =item B<RoutingKey> I<Key>
645 In I<Publish> blocks, this configures the routing key to set on all outgoing
646 messages. If not given, the routing key will be computed from the I<identifier>
647 of the value. The host, plugin, type and the two instances are concatenated
648 together using dots as the separator and all containing dots replaced with
649 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
650 possible to receive only specific values using a "topic" exchange.
652 In I<Subscribe> blocks, configures the I<routing key> used when creating a
653 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
654 used to filter messages when using a "topic" exchange. If you're only
655 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
658 =item B<Persistent> B<true>|B<false> (Publish only)
660 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
661 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
662 default), the I<transient> delivery mode will be used, i.e. messages may be
663 lost due to high load, overflowing queues or similar issues.
665 =item B<ConnectionRetryDelay> I<Delay>
667 When the connection to the AMQP broker is lost, defines the time in seconds to
668 wait before attempting to reconnect. Defaults to 0, which implies collectd will
669 attempt to reconnect at each read interval (in Subscribe mode) or each time
670 values are ready for submission (in Publish mode).
672 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
674 Selects the format in which messages are sent to the broker. If set to
675 B<Command> (the default), values are sent as C<PUTVAL> commands which are
676 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
677 case, the C<Content-Type> header field will be set to C<text/collectd>.
679 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
680 an easy and straight forward exchange format. The C<Content-Type> header field
681 will be set to C<application/json>.
683 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
684 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
687 A subscribing client I<should> use the C<Content-Type> header field to
688 determine how to decode the values. Currently, the I<AMQP plugin> itself can
689 only decode the B<Command> format.
691 =item B<StoreRates> B<true>|B<false> (Publish only)
693 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
694 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
695 default), no conversion is performed. Otherwise the conversion is performed
696 using the internal value cache.
698 Please note that currently this option is only used if the B<Format> option has
701 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
703 A prefix can be added in the metric name when outputting in the I<Graphite> format.
704 It's added before the I<Host> name.
705 Metric name will be "<prefix><host><postfix><plugin><type><name>"
707 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
709 A postfix can be added in the metric name when outputting in the I<Graphite> format.
710 It's added after the I<Host> name.
711 Metric name will be "<prefix><host><postfix><plugin><type><name>"
713 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
715 Specify a character to replace dots (.) in the host part of the metric name.
716 In I<Graphite> metric name, dots are used as separators between different
717 metric parts (host, plugin, type).
718 Default is "_" (I<Underscore>).
720 =item B<GraphiteSeparateInstances> B<true>|B<false>
722 If set to B<true>, the plugin instance and type instance will be in their own
723 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
724 default), the plugin and plugin instance (and likewise the type and type
725 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
727 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
729 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
730 identifier. If set to B<false> (the default), this is only done when there is
733 =item B<GraphitePreserveSeparator> B<false>|B<true>
735 If set to B<false> (the default) the C<.> (dot) character is replaced with
736 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
737 is preserved, i.e. passed through.
741 =head2 Plugin C<amqp1>
743 The I<AMQP1 plugin> can be used to communicate with other instances of
744 I<collectd> or third party applications using an AMQP 1.0 message
745 intermediary. Metric values or notifications are sent to the
746 messaging intermediary which may handle direct messaging or
747 queue based transfer.
752 # Send values to an AMQP 1.0 intermediary
760 <Instance "some_name">
765 # GraphitePrefix "collectd."
766 # GraphiteEscapeChar "_"
767 # GraphiteSeparateInstances false
768 # GraphiteAlwaysAppendDS false
769 # GraphitePreserveSeparator false
774 The plugin's configuration consists of a I<Transport> that configures
775 communications to the AMQP 1.0 messaging bus and one or more I<Instance>
776 corresponding to metric or event publishers to the messaging system.
778 The address in the I<Transport> block concatenated with the name given in the
779 I<Instance> block starting tag will be used as the send-to address for
780 communications over the messaging link.
782 The following options are accepted within each I<Transport> block:
786 =item B<Host> I<Host>
788 Hostname or IP-address of the AMQP 1.0 intermediary. Defaults to the
789 default behavior of the underlying communications library,
790 I<libqpid-proton>, which is "localhost".
792 =item B<Port> I<Port>
794 Service name or port number on which the AMQP 1.0 intermediary accepts
795 connections. This argument must be a string, even if the numeric form
796 is used. Defaults to "5672".
798 =item B<User> I<User>
800 =item B<Password> I<Password>
802 Credentials used to authenticate to the AMQP 1.0 intermediary. By
803 default "guest"/"guest" is used.
805 =item B<Address> I<Address>
807 This option specifies the prefix for the send-to value in the message.
808 By default, "collectd" will be used.
810 =item B<RetryDelay> I<RetryDelay>
812 When the AMQP1 connection is lost, defines the time in seconds to wait
813 before attempting to reconnect. Defaults to 1, which implies attempt
814 to reconnect at 1 second intervals.
818 The following options are accepted within each I<Instance> block:
822 =item B<Format> B<Command>|B<JSON>|B<Graphite>
824 Selects the format in which messages are sent to the intermediary. If set to
825 B<Command> (the default), values are sent as C<PUTVAL> commands which are
826 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
827 case, the C<Content-Type> header field will be set to C<text/collectd>.
829 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
830 an easy and straight forward exchange format. The C<Content-Type> header field
831 will be set to C<application/json>.
833 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
834 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
837 A subscribing client I<should> use the C<Content-Type> header field to
838 determine how to decode the values.
840 =item B<PreSettle> B<true>|B<false>
842 If set to B<false> (the default), the plugin will wait for a message
843 acknowledgement from the messaging bus before sending the next
844 message. This indicates transfer of ownership to the messaging
845 system. If set to B<true>, the plugin will not wait for a message
846 acknowledgement and the message may be dropped prior to transfer of
849 =item B<Notify> B<true>|B<false>
851 If set to B<false> (the default), the plugin will service the
852 instance write call back as a value list. If set to B<true> the
853 plugin will service the instance as a write notification callback
854 for alert formatting.
856 =item B<StoreRates> B<true>|B<false>
858 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
859 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
860 default), no conversion is performed. Otherwise the conversion is performed
861 using the internal value cache.
863 Please note that currently this option is only used if the B<Format> option has
866 =item B<GraphitePrefix>
868 A prefix can be added in the metric name when outputting in the I<Graphite> format.
869 It's added before the I<Host> name.
870 Metric name will be "<prefix><host><postfix><plugin><type><name>"
872 =item B<GraphitePostfix>
874 A postfix can be added in the metric name when outputting in the I<Graphite> format.
875 It's added after the I<Host> name.
876 Metric name will be "<prefix><host><postfix><plugin><type><name>"
878 =item B<GraphiteEscapeChar>
880 Specify a character to replace dots (.) in the host part of the metric name.
881 In I<Graphite> metric name, dots are used as separators between different
882 metric parts (host, plugin, type).
883 Default is "_" (I<Underscore>).
885 =item B<GraphiteSeparateInstances> B<true>|B<false>
887 If set to B<true>, the plugin instance and type instance will be in their own
888 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
889 default), the plugin and plugin instance (and likewise the type and type
890 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
892 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
894 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
895 identifier. If set to B<false> (the default), this is only done when there is
898 =item B<GraphitePreserveSeparator> B<false>|B<true>
900 If set to B<false> (the default) the C<.> (dot) character is replaced with
901 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
902 is preserved, i.e. passed through.
906 =head2 Plugin C<apache>
908 To configure the C<apache>-plugin you first need to configure the Apache
909 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
910 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
911 the following snipped to base your Apache config upon:
914 <IfModule mod_status.c>
915 <Location /mod_status>
916 SetHandler server-status
920 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
921 also supported. It introduces a new field, called C<BusyServers>, to count the
922 number of currently connected clients. This field is also supported.
924 The configuration of the I<Apache> plugin consists of one or more
925 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
926 as the instance name. For example:
930 URL "http://www1.example.com/mod_status?auto"
933 URL "http://www2.example.com/mod_status?auto"
937 The instance name will be used as the I<plugin instance>. To emulate the old
938 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
939 plugin to work correctly, each instance name must be unique. This is not
940 enforced by the plugin and it is your responsibility to ensure it.
942 The following options are accepted within each I<Instance> block:
946 =item B<URL> I<http://host/mod_status?auto>
948 Sets the URL of the C<mod_status> output. This needs to be the output generated
949 by C<ExtendedStatus on> and it needs to be the machine readable output
950 generated by appending the C<?auto> argument. This option is I<mandatory>.
952 =item B<User> I<Username>
954 Optional user name needed for authentication.
956 =item B<Password> I<Password>
958 Optional password needed for authentication.
960 =item B<VerifyPeer> B<true|false>
962 Enable or disable peer SSL certificate verification. See
963 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
965 =item B<VerifyHost> B<true|false>
967 Enable or disable peer host name verification. If enabled, the plugin checks
968 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
969 certificate matches the host name provided by the B<URL> option. If this
970 identity check fails, the connection is aborted. Obviously, only works when
971 connecting to a SSL enabled server. Enabled by default.
973 =item B<CACert> I<File>
975 File that holds one or more SSL certificates. If you want to use HTTPS you will
976 possibly need this option. What CA certificates come bundled with C<libcurl>
977 and are checked by default depends on the distribution you use.
979 =item B<SSLCiphers> I<list of ciphers>
981 Specifies which ciphers to use in the connection. The list of ciphers
982 must specify valid ciphers. See
983 L<http://www.openssl.org/docs/apps/ciphers.html> for details.
985 =item B<Timeout> I<Milliseconds>
987 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
988 milliseconds. By default, the configured B<Interval> is used to set the
993 =head2 Plugin C<apcups>
997 =item B<Host> I<Hostname>
999 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
1000 that IPv6 support has been disabled unless someone can confirm or decline that
1001 B<apcupsd> can handle it.
1003 =item B<Port> I<Port>
1005 TCP-Port to connect to. Defaults to B<3551>.
1007 =item B<ReportSeconds> B<true>|B<false>
1009 If set to B<true>, the time reported in the C<timeleft> metric will be
1010 converted to seconds. This is the recommended setting. If set to B<false>, the
1011 default for backwards compatibility, the time will be reported in minutes.
1013 =item B<PersistentConnection> B<true>|B<false>
1015 The plugin is designed to keep the connection to I<apcupsd> open between reads.
1016 If plugin poll interval is greater than 15 seconds (hardcoded socket close
1017 timeout in I<apcupsd> NIS), then this option is B<false> by default.
1019 You can instruct the plugin to close the connection after each read by setting
1020 this option to B<false> or force keeping the connection by setting it to B<true>.
1022 If I<apcupsd> appears to close the connection due to inactivity quite quickly,
1023 the plugin will try to detect this problem and switch to an open-read-close mode.
1027 =head2 Plugin C<aquaero>
1029 This plugin collects the value of the available sensors in an
1030 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
1031 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
1032 connection for monitoring and configuration. The board can handle multiple
1033 temperature sensors, fans, water pumps and water level sensors and adjust the
1034 output settings such as fan voltage or power used by the water pump based on
1035 the available inputs using a configurable controller included in the board.
1036 This plugin collects all the available inputs as well as some of the output
1037 values chosen by this controller. The plugin is based on the I<libaquaero5>
1038 library provided by I<aquatools-ng>.
1042 =item B<Device> I<DevicePath>
1044 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
1045 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
1046 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
1050 =head2 Plugin C<ascent>
1052 This plugin collects information about an Ascent server, a free server for the
1053 "World of Warcraft" game. This plugin gathers the information by fetching the
1054 XML status page using C<libcurl> and parses it using C<libxml2>.
1056 The configuration options are the same as for the C<apache> plugin above:
1060 =item B<URL> I<http://localhost/ascent/status/>
1062 Sets the URL of the XML status output.
1064 =item B<User> I<Username>
1066 Optional user name needed for authentication.
1068 =item B<Password> I<Password>
1070 Optional password needed for authentication.
1072 =item B<VerifyPeer> B<true|false>
1074 Enable or disable peer SSL certificate verification. See
1075 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1077 =item B<VerifyHost> B<true|false>
1079 Enable or disable peer host name verification. If enabled, the plugin checks
1080 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
1081 certificate matches the host name provided by the B<URL> option. If this
1082 identity check fails, the connection is aborted. Obviously, only works when
1083 connecting to a SSL enabled server. Enabled by default.
1085 =item B<CACert> I<File>
1087 File that holds one or more SSL certificates. If you want to use HTTPS you will
1088 possibly need this option. What CA certificates come bundled with C<libcurl>
1089 and are checked by default depends on the distribution you use.
1091 =item B<Timeout> I<Milliseconds>
1093 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1094 milliseconds. By default, the configured B<Interval> is used to set the
1099 =head2 Plugin C<barometer>
1101 This plugin reads absolute air pressure using digital barometer sensor on a I2C
1102 bus. Supported sensors are:
1106 =item I<MPL115A2> from Freescale,
1107 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A>.
1110 =item I<MPL3115> from Freescale
1111 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>.
1114 =item I<BMP085> from Bosch Sensortec
1118 The sensor type - one of the above - is detected automatically by the plugin
1119 and indicated in the plugin_instance (you will see subdirectory
1120 "barometer-mpl115" or "barometer-mpl3115", or "barometer-bmp085"). The order of
1121 detection is BMP085 -> MPL3115 -> MPL115A2, the first one found will be used
1122 (only one sensor can be used by the plugin).
1124 The plugin provides absolute barometric pressure, air pressure reduced to sea
1125 level (several possible approximations) and as an auxiliary value also internal
1126 sensor temperature. It uses (expects/provides) typical metric units - pressure
1127 in [hPa], temperature in [C], altitude in [m].
1129 It was developed and tested under Linux only. The only platform dependency is
1130 the standard Linux i2c-dev interface (the particular bus driver has to
1131 support the SM Bus command subset).
1133 The reduction or normalization to mean sea level pressure requires (depending
1134 on selected method/approximation) also altitude and reference to temperature
1135 sensor(s). When multiple temperature sensors are configured the minimum of
1136 their values is always used (expecting that the warmer ones are affected by
1137 e.g. direct sun light at that moment).
1141 <Plugin "barometer">
1142 Device "/dev/i2c-0";
1145 TemperatureOffset 0.0
1148 TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
1153 =item B<Device> I<device>
1155 The only mandatory configuration parameter.
1157 Device name of the I2C bus to which the sensor is connected. Note that
1158 typically you need to have loaded the i2c-dev module.
1159 Using i2c-tools you can check/list i2c buses available on your system by:
1163 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
1167 This way you should be able to verify that the pressure sensor (either type) is
1168 connected and detected on address 0x60.
1170 =item B<Oversampling> I<value>
1172 Optional parameter controlling the oversampling/accuracy. Default value
1173 is 1 providing fastest and least accurate reading.
1175 For I<MPL115> this is the size of the averaging window. To filter out sensor
1176 noise a simple averaging using floating window of this configurable size is
1177 used. The plugin will use average of the last C<value> measurements (value of 1
1178 means no averaging). Minimal size is 1, maximal 1024.
1180 For I<MPL3115> this is the oversampling value. The actual oversampling is
1181 performed by the sensor and the higher value the higher accuracy and longer
1182 conversion time (although nothing to worry about in the collectd context).
1183 Supported values are: 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is
1184 adjusted by the plugin to the closest supported one.
1186 For I<BMP085> this is the oversampling value. The actual oversampling is
1187 performed by the sensor and the higher value the higher accuracy and longer
1188 conversion time (although nothing to worry about in the collectd context).
1189 Supported values are: 1, 2, 4, 8. Any other value is adjusted by the plugin to
1190 the closest supported one.
1192 =item B<PressureOffset> I<offset>
1194 Optional parameter for MPL3115 only.
1196 You can further calibrate the sensor by supplying pressure and/or temperature
1197 offsets. This is added to the measured/caclulated value (i.e. if the measured
1198 value is too high then use negative offset).
1199 In hPa, default is 0.0.
1201 =item B<TemperatureOffset> I<offset>
1203 Optional parameter for MPL3115 only.
1205 You can further calibrate the sensor by supplying pressure and/or temperature
1206 offsets. This is added to the measured/caclulated value (i.e. if the measured
1207 value is too high then use negative offset).
1208 In C, default is 0.0.
1210 =item B<Normalization> I<method>
1212 Optional parameter, default value is 0.
1214 Normalization method - what approximation/model is used to compute the mean sea
1215 level pressure from the air absolute pressure.
1217 Supported values of the C<method> (integer between from 0 to 2) are:
1221 =item B<0> - no conversion, absolute pressure is simply copied over. For this method you
1222 do not need to configure C<Altitude> or C<TemperatureSensor>.
1224 =item B<1> - international formula for conversion ,
1226 L<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
1227 For this method you have to configure C<Altitude> but do not need
1228 C<TemperatureSensor> (uses fixed global temperature average instead).
1230 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
1231 Meteorological Service).
1232 See L<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
1233 For this method you have to configure both C<Altitude> and
1234 C<TemperatureSensor>.
1239 =item B<Altitude> I<altitude>
1241 The altitude (in meters) of the location where you meassure the pressure.
1243 =item B<TemperatureSensor> I<reference>
1245 Temperature sensor(s) which should be used as a reference when normalizing the
1246 pressure using C<Normalization> method 2.
1247 When specified more sensors a minimum is found and used each time. The
1248 temperature reading directly from this pressure sensor/plugin is typically not
1249 suitable as the pressure sensor will be probably inside while we want outside
1250 temperature. The collectd reference name is something like
1251 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
1252 (<type_instance> is usually omitted when there is just single value type). Or
1253 you can figure it out from the path of the output data files.
1257 =head2 Plugin C<battery>
1259 The I<battery plugin> reports the remaining capacity, power and voltage of
1264 =item B<ValuesPercentage> B<false>|B<true>
1266 When enabled, remaining capacity is reported as a percentage, e.g. "42%
1267 capacity remaining". Otherwise the capacity is stored as reported by the
1268 battery, most likely in "Wh". This option does not work with all input methods,
1269 in particular when only C</proc/pmu> is available on an old Linux system.
1270 Defaults to B<false>.
1272 =item B<ReportDegraded> B<false>|B<true>
1274 Typical laptop batteries degrade over time, meaning the capacity decreases with
1275 recharge cycles. The maximum charge of the previous charge cycle is tracked as
1276 "last full capacity" and used to determine that a battery is "fully charged".
1278 When this option is set to B<false>, the default, the I<battery plugin> will
1279 only report the remaining capacity. If the B<ValuesPercentage> option is
1280 enabled, the relative remaining capacity is calculated as the ratio of the
1281 "remaining capacity" and the "last full capacity". This is what most tools,
1282 such as the status bar of desktop environments, also do.
1284 When set to B<true>, the battery plugin will report three values: B<charged>
1285 (remaining capacity), B<discharged> (difference between "last full capacity"
1286 and "remaining capacity") and B<degraded> (difference between "design capacity"
1287 and "last full capacity").
1289 =item B<QueryStateFS> B<false>|B<true>
1291 When set to B<true>, the battery plugin will only read statistics
1292 related to battery performance as exposed by StateFS at
1293 /run/state. StateFS is used in Mer-based Sailfish OS, for
1298 =head2 Plugin C<bind>
1300 Starting with BIND 9.5.0, the most widely used DNS server software provides
1301 extensive statistics about queries, responses and lots of other information.
1302 The bind plugin retrieves this information that's encoded in XML and provided
1303 via HTTP and submits the values to collectd.
1305 To use this plugin, you first need to tell BIND to make this information
1306 available. This is done with the C<statistics-channels> configuration option:
1308 statistics-channels {
1309 inet localhost port 8053;
1312 The configuration follows the grouping that can be seen when looking at the
1313 data with an XSLT compatible viewer, such as a modern web browser. It's
1314 probably a good idea to make yourself familiar with the provided values, so you
1315 can understand what the collected statistics actually mean.
1320 URL "http://localhost:8053/"
1335 Zone "127.in-addr.arpa/IN"
1339 The bind plugin accepts the following configuration options:
1345 URL from which to retrieve the XML data. If not specified,
1346 C<http://localhost:8053/> will be used.
1348 =item B<ParseTime> B<true>|B<false>
1350 When set to B<true>, the time provided by BIND will be parsed and used to
1351 dispatch the values. When set to B<false>, the local time source is queried.
1353 This setting is set to B<true> by default for backwards compatibility; setting
1354 this to B<false> is I<recommended> to avoid problems with timezones and
1357 =item B<OpCodes> B<true>|B<false>
1359 When enabled, statistics about the I<"OpCodes">, for example the number of
1360 C<QUERY> packets, are collected.
1364 =item B<QTypes> B<true>|B<false>
1366 When enabled, the number of I<incoming> queries by query types (for example
1367 C<A>, C<MX>, C<AAAA>) is collected.
1371 =item B<ServerStats> B<true>|B<false>
1373 Collect global server statistics, such as requests received over IPv4 and IPv6,
1374 successful queries, and failed updates.
1378 =item B<ZoneMaintStats> B<true>|B<false>
1380 Collect zone maintenance statistics, mostly information about notifications
1381 (zone updates) and zone transfers.
1385 =item B<ResolverStats> B<true>|B<false>
1387 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1388 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1389 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1390 default. Use the B<ResolverStats> option within a B<View "_default"> block
1391 instead for the same functionality.
1395 =item B<MemoryStats>
1397 Collect global memory statistics.
1401 =item B<Timeout> I<Milliseconds>
1403 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1404 milliseconds. By default, the configured B<Interval> is used to set the
1407 =item B<View> I<Name>
1409 Collect statistics about a specific I<"view">. BIND can behave different,
1410 mostly depending on the source IP-address of the request. These different
1411 configurations are called "views". If you don't use this feature, you most
1412 likely are only interested in the C<_default> view.
1414 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1415 information you want to collect about a view. If no B<View> block is
1416 configured, no detailed view statistics will be collected.
1420 =item B<QTypes> B<true>|B<false>
1422 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1423 C<MX>) is collected.
1427 =item B<ResolverStats> B<true>|B<false>
1429 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1430 (e.E<nbsp>g. queries over IPv4, lame servers).
1434 =item B<CacheRRSets> B<true>|B<false>
1436 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1437 type is collected. Negative entries (queries which resulted in an error, for
1438 example names that do not exist) are reported with a leading exclamation mark,
1443 =item B<Zone> I<Name>
1445 When given, collect detailed information about the given zone in the view. The
1446 information collected if very similar to the global B<ServerStats> information
1449 You can repeat this option to collect detailed information about multiple
1452 By default no detailed zone information is collected.
1458 =head2 Plugin C<ceph>
1460 The ceph plugin collects values from JSON data to be parsed by B<libyajl>
1461 (L<https://lloyd.github.io/yajl/>) retrieved from ceph daemon admin sockets.
1463 A separate B<Daemon> block must be configured for each ceph daemon to be
1464 monitored. The following example will read daemon statistics from four
1465 separate ceph daemons running on the same device (two OSDs, one MON, one MDS) :
1468 LongRunAvgLatency false
1469 ConvertSpecialMetricTypes true
1471 SocketPath "/var/run/ceph/ceph-osd.0.asok"
1474 SocketPath "/var/run/ceph/ceph-osd.1.asok"
1477 SocketPath "/var/run/ceph/ceph-mon.ceph1.asok"
1480 SocketPath "/var/run/ceph/ceph-mds.ceph1.asok"
1484 The ceph plugin accepts the following configuration options:
1488 =item B<LongRunAvgLatency> B<true>|B<false>
1490 If enabled, latency values(sum,count pairs) are calculated as the long run
1491 average - average since the ceph daemon was started = (sum / count).
1492 When disabled, latency values are calculated as the average since the last
1493 collection = (sum_now - sum_last) / (count_now - count_last).
1497 =item B<ConvertSpecialMetricTypes> B<true>|B<false>
1499 If enabled, special metrics (metrics that differ in type from similar counters)
1500 are converted to the type of those similar counters. This currently only
1501 applies to filestore.journal_wr_bytes which is a counter for OSD daemons. The
1502 ceph schema reports this metric type as a sum,count pair while similar counters
1503 are treated as derive types. When converted, the sum is used as the counter
1504 value and is treated as a derive type.
1505 When disabled, all metrics are treated as the types received from the ceph schema.
1511 Each B<Daemon> block must have a string argument for the plugin instance name.
1512 A B<SocketPath> is also required for each B<Daemon> block:
1516 =item B<Daemon> I<DaemonName>
1518 Name to be used as the instance name for this daemon.
1520 =item B<SocketPath> I<SocketPath>
1522 Specifies the path to the UNIX admin socket of the ceph daemon.
1526 =head2 Plugin C<cgroups>
1528 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1529 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1530 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1534 =item B<CGroup> I<Directory>
1536 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1537 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1540 See F</"IGNORELISTS"> for details.
1542 =item B<IgnoreSelected> B<true>|B<false>
1544 Invert the selection: If set to true, all cgroups I<except> the ones that
1545 match any one of the criteria are collected. By default only selected
1546 cgroups are collected if a selection is made. If no selection is configured
1547 at all, B<all> cgroups are selected.
1551 =head2 Plugin C<chrony>
1553 The C<chrony> plugin collects ntp data from a B<chronyd> server, such as clock
1554 skew and per-peer stratum.
1556 For talking to B<chronyd>, it mimics what the B<chronyc> control program does
1559 Available configuration options for the C<chrony> plugin:
1563 =item B<Host> I<Hostname>
1565 Hostname of the host running B<chronyd>. Defaults to B<localhost>.
1567 =item B<Port> I<Port>
1569 UDP-Port to connect to. Defaults to B<323>.
1571 =item B<Timeout> I<Timeout>
1573 Connection timeout in seconds. Defaults to B<2>.
1577 =head2 Plugin C<conntrack>
1579 This plugin collects IP conntrack statistics.
1585 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1586 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1590 =head2 Plugin C<cpu>
1592 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1593 as Jiffies, using the C<cpu> type. Two aggregations are available:
1599 Sum, per-state, over all CPUs installed in the system; and
1603 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1607 The two aggregations can be combined, leading to I<collectd> only emitting a
1608 single "active" metric for the entire system. As soon as one of these
1609 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1610 rather than Jiffies. In addition, you can request individual, per-state,
1611 per-CPU metrics to be reported as percentage.
1613 The following configuration options are available:
1617 =item B<ReportByState> B<true>|B<false>
1619 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1621 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1624 =item B<ReportByCpu> B<true>|B<false>
1626 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1627 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1628 global sum of CPU states is emitted.
1630 =item B<ValuesPercentage> B<false>|B<true>
1632 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1633 are set to B<true>. In this case, by default, metrics will be reported as
1634 Jiffies. By setting this option to B<true>, you can request percentage values
1635 in the un-aggregated (per-CPU, per-state) mode as well.
1637 =item B<ReportNumCpu> B<false>|B<true>
1639 When set to B<true>, reports the number of available CPUs.
1640 Defaults to B<false>.
1642 =item B<ReportGuestState> B<false>|B<true>
1644 When set to B<true>, reports the "guest" and "guest_nice" CPU states.
1645 Defaults to B<false>.
1647 =item B<SubtractGuestState> B<false>|B<true>
1649 This option is only considered when B<ReportGuestState> is set to B<true>.
1650 "guest" and "guest_nice" are included in respectively "user" and "nice".
1651 If set to B<true>, "guest" will be subtracted from "user" and "guest_nice"
1652 will be subtracted from "nice".
1653 Defaults to B<true>.
1657 =head2 Plugin C<cpufreq>
1659 This plugin doesn't have any options. It reads
1660 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1661 installed) to get the current CPU frequency. If this file does not exist make
1662 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1663 installed and an "cpu governor" (that's a kernel module) is loaded.
1665 =head2 Plugin C<cpusleep>
1667 This plugin doesn't have any options. It reads CLOCK_BOOTTIME and
1668 CLOCK_MONOTONIC and reports the difference between these clocks. Since
1669 BOOTTIME clock increments while device is suspended and MONOTONIC
1670 clock does not, the derivative of the difference between these clocks
1671 gives the relative amount of time the device has spent in suspend
1672 state. The recorded value is in milliseconds of sleep per seconds of
1675 =head2 Plugin C<csv>
1679 =item B<DataDir> I<Directory>
1681 Set the directory to store CSV-files under. Per default CSV-files are generated
1682 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1683 The special strings B<stdout> and B<stderr> can be used to write to the standard
1684 output and standard error channels, respectively. This, of course, only makes
1685 much sense when collectd is running in foreground- or non-daemon-mode.
1687 =item B<StoreRates> B<true|false>
1689 If set to B<true>, convert counter values to rates. If set to B<false> (the
1690 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1695 =head2 cURL Statistics
1697 All cURL-based plugins support collection of generic, request-based
1698 statistics. These are disabled by default and can be enabled selectively for
1699 each page or URL queried from the curl, curl_json, or curl_xml plugins. See
1700 the documentation of those plugins for specific information. This section
1701 describes the available metrics that can be configured for each plugin. All
1702 options are disabled by default.
1704 See L<http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html> for more details.
1708 =item B<TotalTime> B<true|false>
1710 Total time of the transfer, including name resolving, TCP connect, etc.
1712 =item B<NamelookupTime> B<true|false>
1714 Time it took from the start until name resolving was completed.
1716 =item B<ConnectTime> B<true|false>
1718 Time it took from the start until the connect to the remote host (or proxy)
1721 =item B<AppconnectTime> B<true|false>
1723 Time it took from the start until the SSL/SSH connect/handshake to the remote
1726 =item B<PretransferTime> B<true|false>
1728 Time it took from the start until just before the transfer begins.
1730 =item B<StarttransferTime> B<true|false>
1732 Time it took from the start until the first byte was received.
1734 =item B<RedirectTime> B<true|false>
1736 Time it took for all redirection steps include name lookup, connect,
1737 pre-transfer and transfer before final transaction was started.
1739 =item B<RedirectCount> B<true|false>
1741 The total number of redirections that were actually followed.
1743 =item B<SizeUpload> B<true|false>
1745 The total amount of bytes that were uploaded.
1747 =item B<SizeDownload> B<true|false>
1749 The total amount of bytes that were downloaded.
1751 =item B<SpeedDownload> B<true|false>
1753 The average download speed that curl measured for the complete download.
1755 =item B<SpeedUpload> B<true|false>
1757 The average upload speed that curl measured for the complete upload.
1759 =item B<HeaderSize> B<true|false>
1761 The total size of all the headers received.
1763 =item B<RequestSize> B<true|false>
1765 The total size of the issued requests.
1767 =item B<ContentLengthDownload> B<true|false>
1769 The content-length of the download.
1771 =item B<ContentLengthUpload> B<true|false>
1773 The specified size of the upload.
1775 =item B<NumConnects> B<true|false>
1777 The number of new connections that were created to achieve the transfer.
1781 =head2 Plugin C<curl>
1783 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1784 and the match infrastructure (the same code used by the tail plugin) to use
1785 regular expressions with the received data.
1787 The following example will read the current value of AMD stock from Google's
1788 finance page and dispatch the value to collectd.
1791 <Page "stock_quotes">
1793 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1799 CACert "/path/to/ca.crt"
1800 Header "X-Custom-Header: foobar"
1803 MeasureResponseTime false
1804 MeasureResponseCode false
1807 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1808 DSType "GaugeAverage"
1809 # Note: `stock_value' is not a standard type.
1816 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1817 a web page and one or more "matches" to be performed on the returned data. The
1818 string argument to the B<Page> block is used as plugin instance.
1820 The following options are valid within B<Page> blocks:
1824 =item B<Plugin> I<Plugin>
1826 Use I<Plugin> as the plugin name when submitting values.
1827 Defaults to C<curl>.
1831 URL of the web site to retrieve. Since a regular expression will be used to
1832 extract information from this data, non-binary data is a big plus here ;)
1834 =item B<User> I<Name>
1836 Username to use if authorization is required to read the page.
1838 =item B<Password> I<Password>
1840 Password to use if authorization is required to read the page.
1842 =item B<Digest> B<true>|B<false>
1844 Enable HTTP digest authentication.
1846 =item B<VerifyPeer> B<true>|B<false>
1848 Enable or disable peer SSL certificate verification. See
1849 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1851 =item B<VerifyHost> B<true>|B<false>
1853 Enable or disable peer host name verification. If enabled, the plugin checks if
1854 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1855 matches the host name provided by the B<URL> option. If this identity check
1856 fails, the connection is aborted. Obviously, only works when connecting to a
1857 SSL enabled server. Enabled by default.
1859 =item B<CACert> I<file>
1861 File that holds one or more SSL certificates. If you want to use HTTPS you will
1862 possibly need this option. What CA certificates come bundled with C<libcurl>
1863 and are checked by default depends on the distribution you use.
1865 =item B<Header> I<Header>
1867 A HTTP header to add to the request. Multiple headers are added if this option
1868 is specified more than once.
1870 =item B<Post> I<Body>
1872 Specifies that the HTTP operation should be a POST instead of a GET. The
1873 complete data to be posted is given as the argument. This option will usually
1874 need to be accompanied by a B<Header> option to set an appropriate
1875 C<Content-Type> for the post body (e.g. to
1876 C<application/x-www-form-urlencoded>).
1878 =item B<MeasureResponseTime> B<true>|B<false>
1880 Measure response time for the request. If this setting is enabled, B<Match>
1881 blocks (see below) are optional. Disabled by default.
1883 Beware that requests will get aborted if they take too long to complete. Adjust
1884 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1887 This option is similar to enabling the B<TotalTime> statistic but it's
1888 measured by collectd instead of cURL.
1890 =item B<MeasureResponseCode> B<true>|B<false>
1892 Measure response code for the request. If this setting is enabled, B<Match>
1893 blocks (see below) are optional. Disabled by default.
1895 =item B<E<lt>StatisticsE<gt>>
1897 One B<Statistics> block can be used to specify cURL statistics to be collected
1898 for each request to the remote web site. See the section "cURL Statistics"
1899 above for details. If this setting is enabled, B<Match> blocks (see below) are
1902 =item B<E<lt>MatchE<gt>>
1904 One or more B<Match> blocks that define how to match information in the data
1905 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1906 used by the C<tail> plugin, so please see the documentation of the C<tail>
1907 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1908 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1911 =item B<Interval> I<Interval>
1913 Sets the interval (in seconds) in which the values will be collected from this
1914 URL. By default the global B<Interval> setting will be used.
1916 =item B<Timeout> I<Milliseconds>
1918 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1919 milliseconds. By default, the configured B<Interval> is used to set the
1920 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1921 indefinitely. This legacy behaviour can be achieved by setting the value of
1924 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1925 network connection will stall one read thread. Adjust the B<ReadThreads> global
1926 setting accordingly to prevent this from blocking other plugins.
1930 =head2 Plugin C<curl_json>
1932 The B<curl_json plugin> collects values from JSON data to be parsed by
1933 B<libyajl> (L<https://lloyd.github.io/yajl/>) retrieved via
1934 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1935 unix socket. The former can be used, for example, to collect values
1936 from CouchDB documents (which are stored JSON notation), and the
1937 latter to collect values from a uWSGI stats socket.
1939 The following example will collect several values from the built-in
1940 C<_stats> runtime statistics module of I<CouchDB>
1941 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1944 <URL "http://localhost:5984/_stats">
1946 <Key "httpd/requests/count">
1947 Type "http_requests"
1950 <Key "httpd_request_methods/*/count">
1951 Type "http_request_methods"
1954 <Key "httpd_status_codes/*/count">
1955 Type "http_response_codes"
1960 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1963 <Sock "/var/run/uwsgi.stats.sock">
1965 <Key "workers/*/requests">
1966 Type "http_requests"
1969 <Key "workers/*/apps/*/requests">
1970 Type "http_requests"
1975 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1976 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1977 blocks defining a unix socket to read JSON from directly. Each of
1978 these blocks may have one or more B<Key> blocks.
1980 The B<Key> string argument must be in a path format. Each component is
1981 used to match the key from a JSON map or the index of an JSON
1982 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1983 values for all map keys or array indices will be collectd.
1985 The following options are valid within B<URL> blocks:
1989 =item B<Host> I<Name>
1991 Use I<Name> as the host name when submitting values. Defaults to the global
1994 =item B<Plugin> I<Plugin>
1996 Use I<Plugin> as the plugin name when submitting values.
1997 Defaults to C<curl_json>.
1999 =item B<Instance> I<Instance>
2001 Sets the plugin instance to I<Instance>.
2003 =item B<Interval> I<Interval>
2005 Sets the interval (in seconds) in which the values will be collected from this
2006 URL. By default the global B<Interval> setting will be used.
2008 =item B<User> I<Name>
2010 =item B<Password> I<Password>
2012 =item B<Digest> B<true>|B<false>
2014 =item B<VerifyPeer> B<true>|B<false>
2016 =item B<VerifyHost> B<true>|B<false>
2018 =item B<CACert> I<file>
2020 =item B<Header> I<Header>
2022 =item B<Post> I<Body>
2024 =item B<Timeout> I<Milliseconds>
2026 These options behave exactly equivalent to the appropriate options of the
2027 I<cURL> plugin. Please see there for a detailed description.
2029 =item B<E<lt>StatisticsE<gt>>
2031 One B<Statistics> block can be used to specify cURL statistics to be collected
2032 for each request to the remote URL. See the section "cURL Statistics" above
2037 The following options are valid within B<Key> blocks:
2041 =item B<Type> I<Type>
2043 Sets the type used to dispatch the values to the daemon. Detailed information
2044 about types and their configuration can be found in L<types.db(5)>. This
2045 option is mandatory.
2047 =item B<Instance> I<Instance>
2049 Type-instance to use. Defaults to the current map key or current string array element value.
2053 =head2 Plugin C<curl_xml>
2055 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
2056 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
2059 <URL "http://localhost/stats.xml">
2062 Instance "some_instance"
2067 CACert "/path/to/ca.crt"
2068 Header "X-Custom-Header: foobar"
2071 <XPath "table[@id=\"magic_level\"]/tr">
2073 #InstancePrefix "prefix-"
2074 InstanceFrom "td[1]"
2075 #PluginInstanceFrom "td[1]"
2076 ValuesFrom "td[2]/span[@class=\"level\"]"
2081 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
2082 URL to be fetched using libcurl. Within each B<URL> block there are
2083 options which specify the connection parameters, for example authentication
2084 information, and one or more B<XPath> blocks.
2086 Each B<XPath> block specifies how to get one type of information. The
2087 string argument must be a valid XPath expression which returns a list
2088 of "base elements". One value is dispatched for each "base element". The
2089 I<type instance> and values are looked up using further I<XPath> expressions
2090 that should be relative to the base element.
2092 Within the B<URL> block the following options are accepted:
2096 =item B<Host> I<Name>
2098 Use I<Name> as the host name when submitting values. Defaults to the global
2101 =item B<Plugin> I<Plugin>
2103 Use I<Plugin> as the plugin name when submitting values.
2104 Defaults to 'curl_xml'.
2106 =item B<Instance> I<Instance>
2108 Use I<Instance> as the plugin instance when submitting values.
2109 May be overridden by B<PluginInstanceFrom> option inside B<XPath> blocks.
2110 Defaults to an empty string (no plugin instance).
2112 =item B<Interval> I<Interval>
2114 Sets the interval (in seconds) in which the values will be collected from this
2115 URL. By default the global B<Interval> setting will be used.
2117 =item B<Namespace> I<Prefix> I<URL>
2119 If an XPath expression references namespaces, they must be specified
2120 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
2121 I<URL> is the "namespace name", an URI reference uniquely identifying the
2122 namespace. The option can be repeated to register multiple namespaces.
2126 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
2127 Namespace "m" "http://www.w3.org/1998/Math/MathML"
2129 =item B<User> I<User>
2131 =item B<Password> I<Password>
2133 =item B<Digest> B<true>|B<false>
2135 =item B<VerifyPeer> B<true>|B<false>
2137 =item B<VerifyHost> B<true>|B<false>
2139 =item B<CACert> I<CA Cert File>
2141 =item B<Header> I<Header>
2143 =item B<Post> I<Body>
2145 =item B<Timeout> I<Milliseconds>
2147 These options behave exactly equivalent to the appropriate options of the
2148 I<cURL plugin>. Please see there for a detailed description.
2150 =item B<E<lt>StatisticsE<gt>>
2152 One B<Statistics> block can be used to specify cURL statistics to be collected
2153 for each request to the remote URL. See the section "cURL Statistics" above
2156 =item E<lt>B<XPath> I<XPath-expression>E<gt>
2158 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
2159 B<XPath> block specifies how to get one type of information. The string
2160 argument must be a valid XPath expression which returns a list of "base
2161 elements". One value is dispatched for each "base element".
2163 Within the B<XPath> block the following options are accepted:
2167 =item B<Type> I<Type>
2169 Specifies the I<Type> used for submitting patches. This determines the number
2170 of values that are required / expected and whether the strings are parsed as
2171 signed or unsigned integer or as double values. See L<types.db(5)> for details.
2172 This option is required.
2174 =item B<InstancePrefix> I<InstancePrefix>
2176 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
2177 concatenated together without any separator.
2178 This option is optional.
2180 =item B<InstanceFrom> I<InstanceFrom>
2182 Specifies a XPath expression to use for determining the I<type instance>. The
2183 XPath expression must return exactly one element. The element's value is then
2184 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
2186 =item B<PluginInstanceFrom> I<PluginInstanceFrom>
2188 Specifies a XPath expression to use for determining the I<plugin instance>. The
2189 XPath expression must return exactly one element. The element's value is then
2190 used as I<plugin instance>.
2194 If the "base XPath expression" (the argument to the B<XPath> block) returns
2195 exactly one argument, then I<InstanceFrom> and I<PluginInstanceFrom> may be omitted.
2196 Otherwise, at least one of I<InstanceFrom> or I<PluginInstanceFrom> is required.
2200 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
2202 Specifies one or more XPath expression to use for reading the values. The
2203 number of XPath expressions must match the number of data sources in the
2204 I<type> specified with B<Type> (see above). Each XPath expression must return
2205 exactly one element. The element's value is then parsed as a number and used as
2206 value for the appropriate value in the value list dispatched to the daemon.
2207 This option is required.
2213 =head2 Plugin C<dbi>
2215 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
2216 connect to various databases, execute I<SQL> statements and read back the
2217 results. I<dbi> is an acronym for "database interface" in case you were
2218 wondering about the name. You can configure how each column is to be
2219 interpreted and the plugin will generate one or more data sets from each row
2220 returned according to these rules.
2222 Because the plugin is very generic, the configuration is a little more complex
2223 than those of other plugins. It usually looks something like this:
2226 <Query "out_of_stock">
2227 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
2228 # Use with MySQL 5.0.0 or later
2232 InstancePrefix "out_of_stock"
2233 InstancesFrom "category"
2237 <Database "product_information">
2241 DriverOption "host" "localhost"
2242 DriverOption "username" "collectd"
2243 DriverOption "password" "aZo6daiw"
2244 DriverOption "dbname" "prod_info"
2245 SelectDB "prod_info"
2246 Query "out_of_stock"
2250 The configuration above defines one query with one result and one database. The
2251 query is then linked to the database with the B<Query> option I<within> the
2252 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
2253 and you can also use the B<Include> statement to split up the configuration
2254 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
2255 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
2258 The following is a complete list of options:
2260 =head3 B<Query> blocks
2262 Query blocks define I<SQL> statements and how the returned data should be
2263 interpreted. They are identified by the name that is given in the opening line
2264 of the block. Thus the name needs to be unique. Other than that, the name is
2265 not used in collectd.
2267 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
2268 define which column holds which value or instance information. You can use
2269 multiple B<Result> blocks to create multiple values from one returned row. This
2270 is especially useful, when queries take a long time and sending almost the same
2271 query again and again is not desirable.
2275 <Query "environment">
2276 Statement "select station, temperature, humidity from environment"
2279 # InstancePrefix "foo"
2280 InstancesFrom "station"
2281 ValuesFrom "temperature"
2285 InstancesFrom "station"
2286 ValuesFrom "humidity"
2290 The following options are accepted:
2294 =item B<Statement> I<SQL>
2296 Sets the statement that should be executed on the server. This is B<not>
2297 interpreted by collectd, but simply passed to the database server. Therefore,
2298 the SQL dialect that's used depends on the server collectd is connected to.
2300 The query has to return at least two columns, one for the instance and one
2301 value. You cannot omit the instance, even if the statement is guaranteed to
2302 always return exactly one line. In that case, you can usually specify something
2305 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
2307 (That works with MySQL but may not be valid SQL according to the spec. If you
2308 use a more strict database server, you may have to select from a dummy table or
2311 Please note that some databases, for example B<Oracle>, will fail if you
2312 include a semicolon at the end of the statement.
2314 =item B<MinVersion> I<Version>
2316 =item B<MaxVersion> I<Value>
2318 Only use this query for the specified database version. You can use these
2319 options to provide multiple queries with the same name but with a slightly
2320 different syntax. The plugin will use only those queries, where the specified
2321 minimum and maximum versions fit the version of the database in use.
2323 The database version is determined by C<dbi_conn_get_engine_version>, see the
2324 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
2325 for details. Basically, each part of the version is assumed to be in the range
2326 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
2327 "40102", version "5.0.42" becomes "50042".
2329 B<Warning:> The plugin will use B<all> matching queries, so if you specify
2330 multiple queries with the same name and B<overlapping> ranges, weird stuff will
2331 happen. Don't to it! A valid example would be something along these lines:
2342 In the above example, there are three ranges that don't overlap. The last one
2343 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
2344 before "4.0.0" are not specified.
2346 =item B<Type> I<Type>
2348 The B<type> that's used for each line returned. See L<types.db(5)> for more
2349 details on how types are defined. In short: A type is a predefined layout of
2350 data and the number of values and type of values has to match the type
2353 If you specify "temperature" here, you need exactly one gauge column. If you
2354 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
2357 There must be exactly one B<Type> option inside each B<Result> block.
2359 =item B<InstancePrefix> I<prefix>
2361 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
2362 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
2363 all strings returned in the appropriate columns are concatenated together,
2364 separated by dashes I<("-")>.
2366 =item B<InstancesFrom> I<column0> [I<column1> ...]
2368 Specifies the columns whose values will be used to create the "type-instance"
2369 for each row. If you specify more than one column, the value of all columns
2370 will be joined together with dashes I<("-")> as separation characters.
2372 The plugin itself does not check whether or not all built instances are
2373 different. It's your responsibility to assure that each is unique. This is
2374 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
2375 sure that only one row is returned in this case.
2377 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
2380 =item B<ValuesFrom> I<column0> [I<column1> ...]
2382 Names the columns whose content is used as the actual data for the data sets
2383 that are dispatched to the daemon. How many such columns you need is determined
2384 by the B<Type> setting above. If you specify too many or not enough columns,
2385 the plugin will complain about that and no data will be submitted to the
2388 The actual data type in the columns is not that important. The plugin will
2389 automatically cast the values to the right type if it know how to do that. So
2390 it should be able to handle integer an floating point types, as well as strings
2391 (if they include a number at the beginning).
2393 There must be at least one B<ValuesFrom> option inside each B<Result> block.
2395 =item B<MetadataFrom> [I<column0> I<column1> ...]
2397 Names the columns whose content is used as metadata for the data sets
2398 that are dispatched to the daemon.
2400 The actual data type in the columns is not that important. The plugin will
2401 automatically cast the values to the right type if it know how to do that. So
2402 it should be able to handle integer an floating point types, as well as strings
2403 (if they include a number at the beginning).
2407 =head3 B<Database> blocks
2409 Database blocks define a connection to a database and which queries should be
2410 sent to that database. Since the used "dbi" library can handle a wide variety
2411 of databases, the configuration is very generic. If in doubt, refer to libdbi's
2412 documentationE<nbsp>- we stick as close to the terminology used there.
2414 Each database needs a "name" as string argument in the starting tag of the
2415 block. This name will be used as "PluginInstance" in the values submitted to
2416 the daemon. Other than that, that name is not used.
2420 =item B<Plugin> I<Plugin>
2422 Use I<Plugin> as the plugin name when submitting query results from
2423 this B<Database>. Defaults to C<dbi>.
2425 =item B<Interval> I<Interval>
2427 Sets the interval (in seconds) in which the values will be collected from this
2428 database. By default the global B<Interval> setting will be used.
2430 =item B<Driver> I<Driver>
2432 Specifies the driver to use to connect to the database. In many cases those
2433 drivers are named after the database they can connect to, but this is not a
2434 technical necessity. These drivers are sometimes referred to as "DBD",
2435 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2436 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2437 project at L<http://libdbi-drivers.sourceforge.net/>.
2439 You need to give the driver name as expected by the "dbi" library here. You
2440 should be able to find that in the documentation for each driver. If you
2441 mistype the driver name, the plugin will dump a list of all known driver names
2444 =item B<DriverOption> I<Key> I<Value>
2446 Sets driver-specific options. What option a driver supports can be found in the
2447 documentation for each driver, somewhere at
2448 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2449 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2451 DBDs can register two types of options: String options and numeric options. The
2452 plugin will use the C<dbi_conn_set_option> function when the configuration
2453 provides a string and the C<dbi_conn_require_option_numeric> function when the
2454 configuration provides a number. So these two lines will actually result in
2455 different calls being used:
2457 DriverOption "Port" 1234 # numeric
2458 DriverOption "Port" "1234" # string
2460 Unfortunately, drivers are not too keen to report errors when an unknown option
2461 is passed to them, so invalid settings here may go unnoticed. This is not the
2462 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2463 the driver. If a driver complains about an option, the plugin will dump a
2464 complete list of all options understood by that driver to the log. There is no
2465 way to programmatically find out if an option expects a string or a numeric
2466 argument, so you will have to refer to the appropriate DBD's documentation to
2467 find this out. Sorry.
2469 =item B<SelectDB> I<Database>
2471 In some cases, the database name you connect with is not the database name you
2472 want to use for querying data. If this option is set, the plugin will "select"
2473 (switch to) that database after the connection is established.
2475 =item B<Query> I<QueryName>
2477 Associates the query named I<QueryName> with this database connection. The
2478 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2479 blocks you want to refer to must be placed above the database block you want to
2482 =item B<Host> I<Hostname>
2484 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2485 values. Defaults to the global hostname setting.
2493 =item B<Device> I<Device>
2495 Select partitions based on the devicename.
2497 See F</"IGNORELISTS"> for details.
2499 =item B<MountPoint> I<Directory>
2501 Select partitions based on the mountpoint.
2503 See F</"IGNORELISTS"> for details.
2505 =item B<FSType> I<FSType>
2507 Select partitions based on the filesystem type.
2509 See F</"IGNORELISTS"> for details.
2511 =item B<IgnoreSelected> B<true>|B<false>
2513 Invert the selection: If set to true, all partitions B<except> the ones that
2514 match any one of the criteria are collected. By default only selected
2515 partitions are collected if a selection is made. If no selection is configured
2516 at all, B<all> partitions are selected.
2518 =item B<ReportByDevice> B<true>|B<false>
2520 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2521 (the default), it will report a disk as "root", but with it I<true>, it will be
2522 "sda1" (or whichever).
2524 =item B<ReportInodes> B<true>|B<false>
2526 Enables or disables reporting of free, reserved and used inodes. Defaults to
2527 inode collection being disabled.
2529 Enable this option if inodes are a scarce resource for you, usually because
2530 many small files are stored on the disk. This is a usual scenario for mail
2531 transfer agents and web caches.
2533 =item B<ValuesAbsolute> B<true>|B<false>
2535 Enables or disables reporting of free and used disk space in 1K-blocks.
2536 Defaults to B<true>.
2538 =item B<ValuesPercentage> B<false>|B<true>
2540 Enables or disables reporting of free and used disk space in percentage.
2541 Defaults to B<false>.
2543 This is useful for deploying I<collectd> on the cloud, where machines with
2544 different disk size may exist. Then it is more practical to configure
2545 thresholds based on relative disk size.
2549 =head2 Plugin C<disk>
2551 The C<disk> plugin collects information about the usage of physical disks and
2552 logical disks (partitions). Values collected are the number of octets written
2553 to and read from a disk or partition, the number of read/write operations
2554 issued to the disk and a rather complex "time" it took for these commands to be
2557 Using the following two options you can ignore some disks or configure the
2558 collection only of specific disks.
2562 =item B<Disk> I<Name>
2564 Select the disk I<Name>. Whether it is collected or ignored depends on the
2565 B<IgnoreSelected> setting, see below. As with other plugins that use the
2566 daemon's ignorelist functionality, a string that starts and ends with a slash
2567 is interpreted as a regular expression. Examples:
2572 See F</"IGNORELISTS"> for details.
2574 =item B<IgnoreSelected> B<true>|B<false>
2576 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2577 statements, are ignored or if all other disks are ignored. The behavior
2578 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2579 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2580 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2581 is set to B<true>, all disks are collected B<except> the ones matched.
2583 =item B<UseBSDName> B<true>|B<false>
2585 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2586 default major/minor numbers. Requires collectd to be built with Apple's
2589 =item B<UdevNameAttr> I<Attribute>
2591 Attempt to override disk instance name with the value of a specified udev
2592 attribute when built with B<libudev>. If the attribute is not defined for the
2593 given device, the default name is used. Example:
2595 UdevNameAttr "DM_NAME"
2599 =head2 Plugin C<dns>
2603 =item B<Interface> I<Interface>
2605 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2606 option sets the interface that should be used. If this option is not set, or
2607 set to "any", the plugin will try to get packets from B<all> interfaces. This
2608 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2610 =item B<IgnoreSource> I<IP-address>
2612 Ignore packets that originate from this address.
2614 =item B<SelectNumericQueryTypes> B<true>|B<false>
2616 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2620 =head2 Plugin C<dpdkevents>
2622 The I<dpdkevents plugin> collects events from DPDK such as link status of
2623 network ports and Keep Alive status of DPDK logical cores.
2624 In order to get Keep Alive events following requirements must be met:
2626 - support for Keep Alive implemented in DPDK application. More details can
2627 be found here: http://dpdk.org/doc/guides/sample_app_ug/keep_alive.html
2631 <Plugin "dpdkevents">
2637 <Event "link_status">
2638 SendEventsOnUpdate true
2639 EnabledPortMask 0xffff
2640 PortName "interface1"
2641 PortName "interface2"
2642 SendNotification false
2644 <Event "keep_alive">
2645 SendEventsOnUpdate true
2647 KeepAliveShmName "/dpdk_keepalive_shm_name"
2648 SendNotification false
2655 =head3 The EAL block
2659 =item B<Coremask> I<Mask>
2661 =item B<Memorychannels> I<Channels>
2663 Number of memory channels per processor socket.
2665 =item B<FilePrefix> I<File>
2667 The prefix text used for hugepage filenames. The filename will be set to
2668 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2672 =head3 The Event block
2674 The B<Event> block defines configuration for specific event. It accepts a
2675 single argument which specifies the name of the event.
2677 =head4 Link Status event
2681 =item B<SendEventOnUpdate> I<true|false>
2683 If set to true link status value will be dispatched only when it is
2684 different from previously read value. This is an optional argument - default
2687 =item B<EnabledPortMask> I<Mask>
2689 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2690 of 0x0 means that all ports will be disabled. A bitmask of all F's means
2691 that all ports will be enabled. This is an optional argument - by default
2692 all ports are enabled.
2694 =item B<PortName> I<Name>
2696 A string containing an optional name for the enabled DPDK ports. Each PortName
2697 option should contain only one port name; specify as many PortName options as
2698 desired. Default naming convention will be used if PortName is blank. If there
2699 are less PortName options than there are enabled ports, the default naming
2700 convention will be used for the additional ports.
2702 =item B<SendNotification> I<true|false>
2704 If set to true, link status notifications are sent, instead of link status
2705 being collected as a statistic. This is an optional argument - default
2710 =head4 Keep Alive event
2714 =item B<SendEventOnUpdate> I<true|false>
2716 If set to true keep alive value will be dispatched only when it is
2717 different from previously read value. This is an optional argument - default
2720 =item B<LCoreMask> I<Mask>
2722 An hexadecimal bit mask of the logical cores to monitor keep alive state.
2724 =item B<KeepAliveShmName> I<Name>
2726 Shared memory name identifier that is used by secondary process to monitor
2727 the keep alive cores state.
2729 =item B<SendNotification> I<true|false>
2731 If set to true, keep alive notifications are sent, instead of keep alive
2732 information being collected as a statistic. This is an optional
2733 argument - default value is false.
2737 =head2 Plugin C<dpdkstat>
2739 The I<dpdkstat plugin> collects information about DPDK interfaces using the
2740 extended NIC stats API in DPDK.
2751 RteDriverLibPath "/usr/lib/dpdk-pmd"
2753 SharedMemObj "dpdk_collectd_stats_0"
2754 EnabledPortMask 0xffff
2755 PortName "interface1"
2756 PortName "interface2"
2761 =head3 The EAL block
2765 =item B<Coremask> I<Mask>
2767 A string containing an hexadecimal bit mask of the cores to run on. Note that
2768 core numbering can change between platforms and should be determined beforehand.
2770 =item B<Memorychannels> I<Channels>
2772 A string containing a number of memory channels per processor socket.
2774 =item B<FilePrefix> I<File>
2776 The prefix text used for hugepage filenames. The filename will be set to
2777 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2779 =item B<SocketMemory> I<MB>
2781 A string containing amount of Memory to allocate from hugepages on specific
2782 sockets in MB. This is an optional value.
2784 =item B<LogLevel> I<LogLevel_number>
2786 A string containing log level number. This parameter is optional.
2787 If parameter is not present then default value "7" - (INFO) is used.
2788 Value "8" - (DEBUG) can be set to enable debug traces.
2790 =item B<RteDriverLibPath> I<Path>
2792 A string containing path to shared pmd driver lib or path to directory,
2793 where shared pmd driver libs are available. This parameter is optional.
2794 This parameter enable loading of shared pmd driver libs from defined path.
2795 E.g.: "/usr/lib/dpdk-pmd/librte_pmd_i40e.so"
2796 or "/usr/lib/dpdk-pmd"
2802 =item B<SharedMemObj> I<Mask>
2804 A string containing the name of the shared memory object that should be used to
2805 share stats from the DPDK secondary process to the collectd dpdkstat plugin.
2806 Defaults to dpdk_collectd_stats if no other value is configured.
2808 =item B<EnabledPortMask> I<Mask>
2810 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2811 of 0x0 means that all ports will be disabled. A bitmask of all Fs means
2812 that all ports will be enabled. This is an optional argument - default
2813 is all ports enabled.
2815 =item B<PortName> I<Name>
2817 A string containing an optional name for the enabled DPDK ports. Each PortName
2818 option should contain only one port name; specify as many PortName options as
2819 desired. Default naming convention will be used if PortName is blank. If there
2820 are less PortName options than there are enabled ports, the default naming
2821 convention will be used for the additional ports.
2825 =head2 Plugin C<email>
2829 =item B<SocketFile> I<Path>
2831 Sets the socket-file which is to be created.
2833 =item B<SocketGroup> I<Group>
2835 If running as root change the group of the UNIX-socket after it has been
2836 created. Defaults to B<collectd>.
2838 =item B<SocketPerms> I<Permissions>
2840 Change the file permissions of the UNIX-socket after it has been created. The
2841 permissions must be given as a numeric, octal value as you would pass to
2842 L<chmod(1)>. Defaults to B<0770>.
2844 =item B<MaxConns> I<Number>
2846 Sets the maximum number of connections that can be handled in parallel. Since
2847 this many threads will be started immediately setting this to a very high
2848 value will waste valuable resources. Defaults to B<5> and will be forced to be
2849 at most B<16384> to prevent typos and dumb mistakes.
2853 =head2 Plugin C<ethstat>
2855 The I<ethstat plugin> collects information about network interface cards (NICs)
2856 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2862 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2863 Map "multicast" "if_multicast"
2870 =item B<Interface> I<Name>
2872 Collect statistical information about interface I<Name>.
2874 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2876 By default, the plugin will submit values as type C<derive> and I<type
2877 instance> set to I<Name>, the name of the metric as reported by the driver. If
2878 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2879 I<TypeInstance> will be used.
2881 =item B<MappedOnly> B<true>|B<false>
2883 When set to B<true>, only metrics that can be mapped to a I<type> will be
2884 collected, all other metrics will be ignored. Defaults to B<false>.
2888 =head2 Plugin C<exec>
2890 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2891 contains valuable information on when the executable is executed and the
2892 output that is expected from it.
2896 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2898 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2900 Execute the executable I<Executable> as user I<User>. If the user name is
2901 followed by a colon and a group name, the effective group is set to that group.
2902 The real group and saved-set group will be set to the default group of that
2903 user. If no group is given the effective group ID will be the same as the real
2906 Please note that in order to change the user and/or group the daemon needs
2907 superuser privileges. If the daemon is run as an unprivileged user you must
2908 specify the same user/group here. If the daemon is run with superuser
2909 privileges, you must supply a non-root user here.
2911 The executable may be followed by optional arguments that are passed to the
2912 program. Please note that due to the configuration parsing numbers and boolean
2913 values may be changed. If you want to be absolutely sure that something is
2914 passed as-is please enclose it in quotes.
2916 The B<Exec> and B<NotificationExec> statements change the semantics of the
2917 programs executed, i.E<nbsp>e. the data passed to them and the response
2918 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2922 =head2 Plugin C<fhcount>
2924 The C<fhcount> plugin provides statistics about used, unused and total number of
2925 file handles on Linux.
2927 The I<fhcount plugin> provides the following configuration options:
2931 =item B<ValuesAbsolute> B<true>|B<false>
2933 Enables or disables reporting of file handles usage in absolute numbers,
2934 e.g. file handles used. Defaults to B<true>.
2936 =item B<ValuesPercentage> B<false>|B<true>
2938 Enables or disables reporting of file handles usage in percentages, e.g.
2939 percent of file handles used. Defaults to B<false>.
2943 =head2 Plugin C<filecount>
2945 The C<filecount> plugin counts the number of files in a certain directory (and
2946 its subdirectories) and their combined size. The configuration is very straight
2949 <Plugin "filecount">
2950 <Directory "/var/qmail/queue/mess">
2951 Instance "qmail-message"
2953 <Directory "/var/qmail/queue/todo">
2954 Instance "qmail-todo"
2956 <Directory "/var/lib/php5">
2957 Instance "php5-sessions"
2962 The example above counts the number of files in QMail's queue directories and
2963 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2964 QMail has not yet looked at, the "message" queue holds the messages that were
2965 classified into "local" and "remote".
2967 As you can see, the configuration consists of one or more C<Directory> blocks,
2968 each of which specifies a directory in which to count the files. Within those
2969 blocks, the following options are recognized:
2973 =item B<Plugin> I<Plugin>
2975 Use I<Plugin> as the plugin name when submitting values.
2976 Defaults to B<filecount>.
2978 =item B<Instance> I<Instance>
2980 Sets the plugin instance to I<Instance>. If not given, the instance is set to
2981 the directory name with all slashes replaced by underscores and all leading
2982 underscores removed. Empty value is allowed.
2984 =item B<Name> I<Pattern>
2986 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2987 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2988 against the pattern, not the entire path. In case this makes it easier for you:
2989 This option has been named after the B<-name> parameter to L<find(1)>.
2991 =item B<MTime> I<Age>
2993 Count only files of a specific age: If I<Age> is greater than zero, only files
2994 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2995 a negative number, this is inversed. For example, if B<-60> is specified, only
2996 files that have been modified in the last minute will be counted.
2998 The number can also be followed by a "multiplier" to easily specify a larger
2999 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
3000 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
3001 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
3002 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
3003 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
3006 =item B<Size> I<Size>
3008 Count only files of a specific size. When I<Size> is a positive number, only
3009 files that are at least this big are counted. If I<Size> is a negative number,
3010 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
3011 I<Size> are counted.
3013 As with the B<MTime> option, a "multiplier" may be added. For a detailed
3014 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
3015 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
3016 note that there are 1000 bytes in a kilobyte, not 1024.
3018 =item B<Recursive> I<true>|I<false>
3020 Controls whether or not to recurse into subdirectories. Enabled by default.
3022 =item B<IncludeHidden> I<true>|I<false>
3024 Controls whether or not to include "hidden" files and directories in the count.
3025 "Hidden" files and directories are those, whose name begins with a dot.
3026 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
3028 =item B<RegularOnly> I<true>|I<false>
3030 Controls whether or not to include only regular files in the count.
3031 Defaults to I<true>, i.e. by default non regular files are ignored.
3033 =item B<FilesSizeType> I<Type>
3035 Sets the type used to dispatch files combined size. Empty value ("") disables
3036 reporting. Defaults to B<bytes>.
3038 =item B<FilesCountType> I<Type>
3040 Sets the type used to dispatch number of files. Empty value ("") disables
3041 reporting. Defaults to B<files>.
3043 =item B<TypeInstance> I<Instance>
3045 Sets the I<type instance> used to dispatch values. Defaults to an empty string
3046 (no plugin instance).
3050 =head2 Plugin C<GenericJMX>
3052 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
3053 L<collectd-java(5)>.
3055 =head2 Plugin C<gmond>
3057 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
3058 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
3059 are built-in, custom mappings may be added via B<Metric> blocks, see below.
3064 MCReceiveFrom "239.2.11.71" "8649"
3065 <Metric "swap_total">
3067 TypeInstance "total"
3070 <Metric "swap_free">
3077 The following metrics are built-in:
3083 load_one, load_five, load_fifteen
3087 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
3091 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
3103 Available configuration options:
3107 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
3109 Sets sets the multicast group and UDP port to which to subscribe.
3111 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
3113 =item E<lt>B<Metric> I<Name>E<gt>
3115 These blocks add a new metric conversion to the internal table. I<Name>, the
3116 string argument to the B<Metric> block, is the metric name as used by Ganglia.
3120 =item B<Type> I<Type>
3122 Type to map this metric to. Required.
3124 =item B<TypeInstance> I<Instance>
3126 Type-instance to use. Optional.
3128 =item B<DataSource> I<Name>
3130 Data source to map this metric to. If the configured type has exactly one data
3131 source, this is optional. Otherwise the option is required.
3137 =head2 Plugin C<gps>
3139 The C<gps plugin> connects to gpsd on the host machine.
3140 The host, port, timeout and pause are configurable.
3142 This is useful if you run an NTP server using a GPS for source and you want to
3145 Mind your GPS must send $--GSA for having the data reported!
3147 The following elements are collected:
3153 Number of satellites used for fix (type instance "used") and in view (type
3154 instance "visible"). 0 means no GPS satellites are visible.
3156 =item B<dilution_of_precision>
3158 Vertical and horizontal dilution (type instance "horizontal" or "vertical").
3159 It should be between 0 and 3.
3160 Look at the documentation of your GPS to know more.
3168 # Connect to localhost on gpsd regular port:
3173 # PauseConnect of 5 sec. between connection attempts.
3177 Available configuration options:
3181 =item B<Host> I<Host>
3183 The host on which gpsd daemon runs. Defaults to B<localhost>.
3185 =item B<Port> I<Port>
3187 Port to connect to gpsd on the host machine. Defaults to B<2947>.
3189 =item B<Timeout> I<Seconds>
3191 Timeout in seconds (default 0.015 sec).
3193 The GPS data stream is fetch by the plugin form the daemon.
3194 It waits for data to be available, if none arrives it times out
3195 and loop for another reading.
3196 Mind to put a low value gpsd expects value in the micro-seconds area
3197 (recommended is 500 us) since the waiting function is blocking.
3198 Value must be between 500 us and 5 sec., if outside that range the
3199 default value is applied.
3201 This only applies from gpsd release-2.95.
3203 =item B<PauseConnect> I<Seconds>
3205 Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).
3209 =head2 Plugin C<gpu_nvml>
3211 Efficiently collects various statistics from the system's NVIDIA GPUs using the
3212 NVML library. Currently collected are fan speed, core temperature, percent
3213 load, percent memory used, compute and memory frequencies, and power
3220 If one or more of these options is specified, only GPUs at that index (as
3221 determined by nvidia-utils through I<nvidia-smi>) have statistics collected.
3222 If no instance of this option is specified, all GPUs are monitored.
3224 =item B<IgnoreSelected>
3226 If set to true, all detected GPUs B<except> the ones at indices specified by
3227 B<GPUIndex> entries are collected. For greater clarity, setting IgnoreSelected
3228 without any GPUIndex directives will result in B<no> statistics being
3233 =head2 Plugin C<grpc>
3235 The I<grpc> plugin provides an RPC interface to submit values to or query
3236 values from collectd based on the open source gRPC framework. It exposes an
3237 end-point for dispatching values to the daemon.
3239 The B<gRPC> homepage can be found at L<https://grpc.io/>.
3243 =item B<Server> I<Host> I<Port>
3245 The B<Server> statement sets the address of a server to which to send metrics
3246 via the C<DispatchValues> function.
3248 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3250 Optionally, B<Server> may be specified as a configuration block which supports
3251 the following options:
3255 =item B<EnableSSL> B<false>|B<true>
3257 Whether to require SSL for outgoing connections. Default: false.
3259 =item B<SSLCACertificateFile> I<Filename>
3261 =item B<SSLCertificateFile> I<Filename>
3263 =item B<SSLCertificateKeyFile> I<Filename>
3265 Filenames specifying SSL certificate and key material to be used with SSL
3270 =item B<Listen> I<Host> I<Port>
3272 The B<Listen> statement sets the network address to bind to. When multiple
3273 statements are specified, the daemon will bind to all of them. If none are
3274 specified, it defaults to B<0.0.0.0:50051>.
3276 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3278 Optionally, B<Listen> may be specified as a configuration block which
3279 supports the following options:
3283 =item B<EnableSSL> I<true>|I<false>
3285 Whether to enable SSL for incoming connections. Default: false.
3287 =item B<SSLCACertificateFile> I<Filename>
3289 =item B<SSLCertificateFile> I<Filename>
3291 =item B<SSLCertificateKeyFile> I<Filename>
3293 Filenames specifying SSL certificate and key material to be used with SSL
3296 =item B<VerifyPeer> B<true>|B<false>
3298 When enabled, a valid client certificate is required to connect to the server.
3299 When disabled, a client certifiacte is not requested and any unsolicited client
3300 certificate is accepted.
3307 =head2 Plugin C<hddtemp>
3309 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
3310 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
3311 default values, see below. C<hddtemp> has to be running to work correctly. If
3312 C<hddtemp> is not running timeouts may appear which may interfere with other
3315 The B<hddtemp> homepage can be found at
3316 L<http://www.guzu.net/linux/hddtemp.php>.
3320 =item B<Host> I<Hostname>
3322 Hostname to connect to. Defaults to B<127.0.0.1>.
3324 =item B<Port> I<Port>
3326 TCP-Port to connect to. Defaults to B<7634>.
3330 =head2 Plugin C<hugepages>
3332 To collect B<hugepages> information, collectd reads directories
3333 "/sys/devices/system/node/*/hugepages" and
3334 "/sys/kernel/mm/hugepages".
3335 Reading of these directories can be disabled by the following
3336 options (default is enabled).
3340 =item B<ReportPerNodeHP> B<true>|B<false>
3342 If enabled, information will be collected from the hugepage
3343 counters in "/sys/devices/system/node/*/hugepages".
3344 This is used to check the per-node hugepage statistics on
3347 =item B<ReportRootHP> B<true>|B<false>
3349 If enabled, information will be collected from the hugepage
3350 counters in "/sys/kernel/mm/hugepages".
3351 This can be used on both NUMA and non-NUMA systems to check
3352 the overall hugepage statistics.
3354 =item B<ValuesPages> B<true>|B<false>
3356 Whether to report hugepages metrics in number of pages.
3357 Defaults to B<true>.
3359 =item B<ValuesBytes> B<false>|B<true>
3361 Whether to report hugepages metrics in bytes.
3362 Defaults to B<false>.
3364 =item B<ValuesPercentage> B<false>|B<true>
3366 Whether to report hugepages metrics as percentage.
3367 Defaults to B<false>.
3371 =head2 Plugin C<intel_pmu>
3373 The I<intel_pmu> plugin collects performance counters data on Intel CPUs using
3374 Linux perf interface. All events are reported on a per core basis.
3379 ReportHardwareCacheEvents true
3380 ReportKernelPMUEvents true
3381 ReportSoftwareEvents true
3382 EventList "/var/cache/pmu/GenuineIntel-6-2D-core.json"
3383 HardwareEvents "L2_RQSTS.CODE_RD_HIT,L2_RQSTS.CODE_RD_MISS" "L2_RQSTS.ALL_CODE_RD"
3384 Cores "0-3" "4,6" "[12-15]"
3391 =item B<ReportHardwareCacheEvents> B<false>|B<true>
3393 Enable or disable measuring of hardware CPU cache events:
3395 - L1-dcache-load-misses
3397 - L1-dcache-store-misses
3398 - L1-dcache-prefetches
3399 - L1-dcache-prefetch-misses
3401 - L1-icache-load-misses
3402 - L1-icache-prefetches
3403 - L1-icache-prefetch-misses
3409 - LLC-prefetch-misses
3415 - dTLB-prefetch-misses
3419 - branch-load-misses
3421 =item B<ReportKernelPMUEvents> B<false>|B<true>
3423 Enable or disable measuring of the following events:
3432 =item B<ReportSoftwareEvents> B<false>|B<true>
3434 Enable or disable measuring of software events provided by kernel:
3445 =item B<EventList> I<filename>
3447 JSON performance counter event list file name. To be able to monitor all Intel
3448 CPU specific events JSON event list file should be downloaded. Use the pmu-tools
3449 event_download.py script to download event list for current CPU.
3451 =item B<HardwareEvents> I<events>
3453 This field is a list of event names or groups of comma separated event names.
3454 This option requires B<EventList> option to be configured.
3456 =item B<Cores> I<cores groups>
3458 All events are reported on a per core basis. Monitoring of the events can be
3459 configured for a group of cores (aggregated statistics). This field defines
3460 groups of cores on which to monitor supported events. The field is represented
3461 as list of strings with core group values. Each string represents a list of
3462 cores in a group. If a group is enclosed in square brackets each core is added
3463 individually to a separate group (that is statistics are not aggregated).
3464 Allowed formats are:
3470 If an empty string is provided as value for this field default cores
3471 configuration is applied - that is separate group is created for each core.
3475 =head2 Plugin C<intel_rdt>
3477 The I<intel_rdt> plugin collects information provided by monitoring features of
3478 Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
3479 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features provide
3480 information about utilization of shared resources. CMT monitors last level cache
3481 occupancy (LLC). MBM supports two types of events reporting local and remote
3482 memory bandwidth. Local memory bandwidth (MBL) reports the bandwidth of
3483 accessing memory associated with the local socket. Remote memory bandwidth (MBR)
3484 reports the bandwidth of accessing the remote socket. Also this technology
3485 allows to monitor instructions per clock (IPC).
3486 Monitor events are hardware dependant. Monitoring capabilities are detected on
3487 plugin initialization and only supported events are monitored.
3489 B<Note:> I<intel_rdt> plugin is using model-specific registers (MSRs), which
3490 require an additional capability to be enabled if collectd is run as a service.
3491 Please refer to I<contrib/systemd.collectd.service> file for more details.
3495 <Plugin "intel_rdt">
3496 Cores "0-2" "3,4,6" "8-10,15"
3503 =item B<Interval> I<seconds>
3505 The interval within which to retrieve statistics on monitored events in seconds.
3506 For milliseconds divide the time by 1000 for example if the desired interval
3507 is 50ms, set interval to 0.05. Due to limited capacity of counters it is not
3508 recommended to set interval higher than 1 sec.
3510 =item B<Cores> I<cores groups>
3512 All events are reported on a per core basis. Monitoring of the events can be
3513 configured for group of cores (aggregated statistics). This field defines groups
3514 of cores on which to monitor supported events. The field is represented as list
3515 of strings with core group values. Each string represents a list of cores in a
3516 group. Allowed formats are:
3521 If an empty string is provided as value for this field default cores
3522 configuration is applied - a separate group is created for each core.
3526 B<Note:> By default global interval is used to retrieve statistics on monitored
3527 events. To configure a plugin specific interval use B<Interval> option of the
3528 intel_rdt <LoadPlugin> block. For milliseconds divide the time by 1000 for
3529 example if the desired interval is 50ms, set interval to 0.05.
3530 Due to limited capacity of counters it is not recommended to set interval higher
3533 =head2 Plugin C<interface>
3537 =item B<Interface> I<Interface>
3539 Select this interface. By default these interfaces will then be collected. For
3540 a more detailed description see B<IgnoreSelected> below.
3542 See F</"IGNORELISTS"> for details.
3544 =item B<IgnoreSelected> I<true>|I<false>
3546 If no configuration is given, the B<interface>-plugin will collect data from
3547 all interfaces. This may not be practical, especially for loopback- and
3548 similar interfaces. Thus, you can use the B<Interface>-option to pick the
3549 interfaces you're interested in. Sometimes, however, it's easier/preferred
3550 to collect all interfaces I<except> a few ones. This option enables you to
3551 do that: By setting B<IgnoreSelected> to I<true> the effect of
3552 B<Interface> is inverted: All selected interfaces are ignored and all
3553 other interfaces are collected.
3555 It is possible to use regular expressions to match interface names, if the
3556 name is surrounded by I</.../> and collectd was compiled with support for
3557 regexps. This is useful if there's a need to collect (or ignore) data
3558 for a group of interfaces that are similarly named, without the need to
3559 explicitly list all of them (especially useful if the list is dynamic).
3564 Interface "/^tun[0-9]+/"
3565 IgnoreSelected "true"
3567 This will ignore the loopback interface, all interfaces with names starting
3568 with I<veth> and all interfaces with names starting with I<tun> followed by
3571 =item B<ReportInactive> I<true>|I<false>
3573 When set to I<false>, only interfaces with non-zero traffic will be
3574 reported. Note that the check is done by looking into whether a
3575 package was sent at any time from boot and the corresponding counter
3576 is non-zero. So, if the interface has been sending data in the past
3577 since boot, but not during the reported time-interval, it will still
3580 The default value is I<true> and results in collection of the data
3581 from all interfaces that are selected by B<Interface> and
3582 B<IgnoreSelected> options.
3584 =item B<UniqueName> I<true>|I<false>
3586 Interface name is not unique on Solaris (KSTAT), interface name is unique
3587 only within a module/instance. Following tuple is considered unique:
3588 (ks_module, ks_instance, ks_name)
3589 If this option is set to true, interface name contains above three fields
3590 separated by an underscore. For more info on KSTAT, visit
3591 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
3593 This option is only available on Solaris.
3597 =head2 Plugin C<ipmi>
3599 The B<ipmi plugin> allows to monitor server platform status using the Intelligent
3600 Platform Management Interface (IPMI). Local and remote interfaces are supported.
3602 The plugin configuration consists of one or more B<Instance> blocks which
3603 specify one I<ipmi> connection each. Each block requires one unique string
3604 argument as the instance name. If instances are not configured, an instance with
3605 the default option values will be created.
3607 For backwards compatibility, any option other than B<Instance> block will trigger
3608 legacy config handling and it will be treated as an option within B<Instance>
3609 block. This support will go away in the next major version of Collectd.
3611 Within the B<Instance> blocks, the following options are allowed:
3615 =item B<Address> I<Address>
3617 Hostname or IP to connect to. If not specified, plugin will try to connect to
3618 local management controller (BMC).
3620 =item B<Username> I<Username>
3622 =item B<Password> I<Password>
3624 The username and the password to use for the connection to remote BMC.
3626 =item B<AuthType> I<MD5>|I<rmcp+>
3628 Forces the authentication type to use for the connection to remote BMC.
3629 By default most secure type is seleted.
3631 =item B<Host> I<Hostname>
3633 Sets the B<host> field of dispatched values. Defaults to the global hostname
3636 =item B<Sensor> I<Sensor>
3638 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
3640 See F</"IGNORELISTS"> for details.
3642 =item B<IgnoreSelected> I<true>|I<false>
3644 If no configuration if given, the B<ipmi> plugin will collect data from all
3645 sensors found of type "temperature", "voltage", "current" and "fanspeed".
3646 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
3647 the effect of B<Sensor> is inverted: All selected sensors are ignored and
3648 all other sensors are collected.
3650 =item B<NotifySensorAdd> I<true>|I<false>
3652 If a sensor appears after initialization time of a minute a notification
3655 =item B<NotifySensorRemove> I<true>|I<false>
3657 If a sensor disappears a notification is sent.
3659 =item B<NotifySensorNotPresent> I<true>|I<false>
3661 If you have for example dual power supply and one of them is (un)plugged then
3662 a notification is sent.
3664 =item B<NotifyIPMIConnectionState> I<true>|I<false>
3666 If a IPMI connection state changes after initialization time of a minute
3667 a notification is sent. Defaults to B<false>.
3669 =item B<SELEnabled> I<true>|I<false>
3671 If system event log (SEL) is enabled, plugin will listen for sensor threshold
3672 and discrete events. When event is received the notification is sent.
3673 SEL event filtering can be configured using B<SELSensor> and B<SELIgnoreSelected>
3675 Defaults to B<false>.
3677 =item B<SELSensor> I<SELSensor>
3679 Selects sensors to get events from or to ignore, depending on B<SELIgnoreSelected>.
3681 See F</"IGNORELISTS"> for details.
3683 =item B<SELIgnoreSelected> I<true>|I<false>
3685 If no configuration is given, the B<ipmi> plugin will pass events from all
3686 sensors. This option enables you to do that: By setting B<SELIgnoreSelected>
3687 to I<true> the effect of B<SELSensor> is inverted: All events from selected
3688 sensors are ignored and all events from other sensors are passed.
3690 =item B<SELClearEvent> I<true>|I<false>
3692 If SEL clear event is enabled, plugin will delete event from SEL list after
3693 it is received and successfully handled. In this case other tools that are
3694 subscribed for SEL events will receive an empty event.
3695 Defaults to B<false>.
3699 =head2 Plugin C<iptables>
3703 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3705 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3707 Select the iptables/ip6tables filter rules to count packets and bytes from.
3709 If only I<Table> and I<Chain> are given, this plugin will collect the counters
3710 of all rules which have a comment-match. The comment is then used as
3713 If I<Comment> or I<Number> is given, only the rule with the matching comment or
3714 the I<n>th rule will be collected. Again, the comment (or the number) will be
3715 used as the type-instance.
3717 If I<Name> is supplied, it will be used as the type-instance instead of the
3718 comment or the number.
3722 =head2 Plugin C<irq>
3728 Select this irq. By default these irqs will then be collected. For a more
3729 detailed description see B<IgnoreSelected> below.
3731 See F</"IGNORELISTS"> for details.
3733 =item B<IgnoreSelected> I<true>|I<false>
3735 If no configuration if given, the B<irq>-plugin will collect data from all
3736 irqs. This may not be practical, especially if no interrupts happen. Thus, you
3737 can use the B<Irq>-option to pick the interrupt you're interested in.
3738 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
3739 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
3740 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
3741 and all other interrupts are collected.
3745 =head2 Plugin C<java>
3747 The I<Java> plugin makes it possible to write extensions for collectd in Java.
3748 This section only discusses the syntax and semantic of the configuration
3749 options. For more in-depth information on the I<Java> plugin, please read
3750 L<collectd-java(5)>.
3755 JVMArg "-verbose:jni"
3756 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
3757 LoadPlugin "org.collectd.java.Foobar"
3758 <Plugin "org.collectd.java.Foobar">
3759 # To be parsed by the plugin
3763 Available configuration options:
3767 =item B<JVMArg> I<Argument>
3769 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
3770 exactly the way the arguments to the I<java> binary on the command line work.
3771 Execute C<javaE<nbsp>--help> for details.
3773 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
3774 any other options! When another option is found, the JVM will be started and
3775 later options will have to be ignored!
3777 =item B<LoadPlugin> I<JavaClass>
3779 Instantiates a new I<JavaClass> object. The constructor of this object very
3780 likely then registers one or more callback methods with the server.
3782 See L<collectd-java(5)> for details.
3784 When the first such option is found, the virtual machine (JVM) is created. This
3785 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
3786 B<LoadPlugin> options!
3788 =item B<Plugin> I<Name>
3790 The entire block is passed to the Java plugin as an
3791 I<org.collectd.api.OConfigItem> object.
3793 For this to work, the plugin has to register a configuration callback first,
3794 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
3795 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
3796 depends on the (Java) plugin registering the callback and is completely
3797 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
3801 =head2 Plugin C<load>
3803 The I<Load plugin> collects the system load. These numbers give a rough overview
3804 over the utilization of a machine. The system load is defined as the number of
3805 runnable tasks in the run-queue and is provided by many operating systems as a
3806 one, five or fifteen minute average.
3808 The following configuration options are available:
3812 =item B<ReportRelative> B<false>|B<true>
3814 When enabled, system load divided by number of available CPU cores is reported
3815 for intervals 1 min, 5 min and 15 min. Defaults to false.
3820 =head2 Plugin C<logfile>
3824 =item B<LogLevel> B<debug|info|notice|warning|err>
3826 Sets the log-level. If, for example, set to B<notice>, then all events with
3827 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3829 Please note that B<debug> is only available if collectd has been compiled with
3832 =item B<File> I<File>
3834 Sets the file to write log messages to. The special strings B<stdout> and
3835 B<stderr> can be used to write to the standard output and standard error
3836 channels, respectively. This, of course, only makes much sense when I<collectd>
3837 is running in foreground- or non-daemon-mode.
3839 =item B<Timestamp> B<true>|B<false>
3841 Prefix all lines printed by the current time. Defaults to B<true>.
3843 =item B<PrintSeverity> B<true>|B<false>
3845 When enabled, all lines are prefixed by the severity of the log message, for
3846 example "warning". Defaults to B<false>.
3850 B<Note>: There is no need to notify the daemon after moving or removing the
3851 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3852 for each line it writes.
3854 =head2 Plugin C<log_logstash>
3856 The I<log logstash plugin> behaves like the logfile plugin but formats
3857 messages as JSON events for logstash to parse and input.
3861 =item B<LogLevel> B<debug|info|notice|warning|err>
3863 Sets the log-level. If, for example, set to B<notice>, then all events with
3864 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3866 Please note that B<debug> is only available if collectd has been compiled with
3869 =item B<File> I<File>
3871 Sets the file to write log messages to. The special strings B<stdout> and
3872 B<stderr> can be used to write to the standard output and standard error
3873 channels, respectively. This, of course, only makes much sense when I<collectd>
3874 is running in foreground- or non-daemon-mode.
3878 B<Note>: There is no need to notify the daemon after moving or removing the
3879 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3880 for each line it writes.
3882 =head2 Plugin C<lpar>
3884 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
3885 virtualization technique for IBM POWER processors. It takes into account CPU
3886 time stolen from or donated to a partition, in addition to the usual user,
3887 system, I/O statistics.
3889 The following configuration options are available:
3893 =item B<CpuPoolStats> B<false>|B<true>
3895 When enabled, statistics about the processor pool are read, too. The partition
3896 needs to have pool authority in order to be able to acquire this information.
3899 =item B<ReportBySerial> B<false>|B<true>
3901 If enabled, the serial of the physical machine the partition is currently
3902 running on is reported as I<hostname> and the logical hostname of the machine
3903 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
3904 used (just like other plugins) and the I<plugin instance> will be empty.
3909 =head2 Plugin C<lua>
3911 This plugin embeds a Lua interpreter into collectd and provides an interface
3912 to collectd's plugin system. See L<collectd-lua(5)> for its documentation.
3915 =head2 Plugin C<mbmon>
3917 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
3919 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
3920 B<Host> and B<Port> options can be used to change these values, see below.
3921 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
3922 timeouts may appear which may interfere with other statistics..
3924 C<mbmon> must be run with the -r option ("print TAG and Value format");
3925 Debian's F</etc/init.d/mbmon> script already does this, other people
3926 will need to ensure that this is the case.
3930 =item B<Host> I<Hostname>
3932 Hostname to connect to. Defaults to B<127.0.0.1>.
3934 =item B<Port> I<Port>
3936 TCP-Port to connect to. Defaults to B<411>.
3940 =head2 Plugin C<mcelog>
3942 The C<mcelog plugin> uses mcelog to retrieve machine check exceptions.
3944 By default the plugin connects to B<"/var/run/mcelog-client"> to check if the
3945 mcelog server is running. When the server is running, the plugin will tail the
3946 specified logfile to retrieve machine check exception information and send a
3947 notification with the details from the logfile. The plugin will use the mcelog
3948 client protocol to retrieve memory related machine check exceptions. Note that
3949 for memory exceptions, notifications are only sent when there is a change in
3950 the number of corrected/uncorrected memory errors.
3952 =head3 The Memory block
3954 Note: these options cannot be used in conjunction with the logfile options, they are mutually
3959 =item B<McelogClientSocket> I<Path>
3960 Connect to the mcelog client socket using the UNIX domain socket at I<Path>.
3961 Defaults to B<"/var/run/mcelog-client">.
3963 =item B<PersistentNotification> B<true>|B<false>
3964 Override default configuration to only send notifications when sent when there
3965 is a change in the number of corrected/uncorrected memory errors. When set to
3966 true notifications will be sent for every read cycle. Default is false. Does
3967 not affect the stats being dispatched.
3973 =item B<McelogLogfile> I<Path>
3975 The mcelog file to parse. Defaults to B<"/var/log/mcelog">. Note: this option
3976 cannot be used in conjunction with the memory block options, they are mutually
3983 The C<md plugin> collects information from Linux Software-RAID devices (md).
3985 All reported values are of the type C<md_disks>. Reported type instances are
3986 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
3987 I<missing> (physically absent) disks.
3991 =item B<Device> I<Device>
3993 Select md devices based on device name. The I<device name> is the basename of
3994 the device, i.e. the name of the block device without the leading C</dev/>.
3995 See B<IgnoreSelected> for more details.
3997 See F</"IGNORELISTS"> for details.
3999 =item B<IgnoreSelected> B<true>|B<false>
4001 Invert device selection: If set to B<true>, all md devices B<except> those
4002 listed using B<Device> are collected. If B<false> (the default), only those
4003 listed are collected. If no configuration is given, the B<md> plugin will
4004 collect data from all md devices.
4008 =head2 Plugin C<memcachec>
4010 The C<memcachec plugin> connects to a memcached server, queries one or more
4011 given I<pages> and parses the returned data according to user specification.
4012 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
4015 In order to talk to the memcached server, this plugin uses the I<libmemcached>
4016 library. Please note that there is another library with a very similar name,
4017 libmemcache (notice the missing `d'), which is not applicable.
4019 Synopsis of the configuration:
4021 <Plugin "memcachec">
4022 <Page "plugin_instance">
4025 Plugin "plugin_name"
4027 Regex "(\\d+) bytes sent"
4030 Instance "type_instance"
4035 The configuration options are:
4039 =item E<lt>B<Page> I<Name>E<gt>
4041 Each B<Page> block defines one I<page> to be queried from the memcached server.
4042 The block requires one string argument which is used as I<plugin instance>.
4044 =item B<Server> I<Address>
4046 Sets the server address to connect to when querying the page. Must be inside a
4051 When connected to the memcached server, asks for the page I<Key>.
4053 =item B<Plugin> I<Plugin>
4055 Use I<Plugin> as the plugin name when submitting values.
4056 Defaults to C<memcachec>.
4058 =item E<lt>B<Match>E<gt>
4060 Match blocks define which strings to look for and how matches substrings are
4061 interpreted. For a description of match blocks, please see L<"Plugin tail">.
4065 =head2 Plugin C<memcached>
4067 The B<memcached plugin> connects to a memcached server and queries statistics
4068 about cache utilization, memory and bandwidth used.
4069 L<http://memcached.org/>
4071 <Plugin "memcached">
4073 #Host "memcache.example.com"
4079 The plugin configuration consists of one or more B<Instance> blocks which
4080 specify one I<memcached> connection each. Within the B<Instance> blocks, the
4081 following options are allowed:
4085 =item B<Host> I<Hostname>
4087 Sets the B<host> field of dispatched values. Defaults to the global hostname
4089 For backwards compatibility, values are also dispatched with the global
4090 hostname when B<Host> is set to B<127.0.0.1> or B<localhost> and B<Address> is
4093 =item B<Address> I<Address>
4095 Hostname or IP to connect to. For backwards compatibility, defaults to the
4096 value of B<Host> or B<127.0.0.1> if B<Host> is unset.
4098 =item B<Port> I<Port>
4100 TCP port to connect to. Defaults to B<11211>.
4102 =item B<Socket> I<Path>
4104 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
4105 setting is given, the B<Address> and B<Port> settings are ignored.
4109 =head2 Plugin C<mic>
4111 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
4112 Intel's Many Integrated Core (MIC) systems.
4121 ShowTemperatures true
4124 IgnoreSelectedTemperature true
4129 IgnoreSelectedPower true
4132 The following options are valid inside the B<PluginE<nbsp>mic> block:
4136 =item B<ShowCPU> B<true>|B<false>
4138 If enabled (the default) a sum of the CPU usage across all cores is reported.
4140 =item B<ShowCPUCores> B<true>|B<false>
4142 If enabled (the default) per-core CPU usage is reported.
4144 =item B<ShowMemory> B<true>|B<false>
4146 If enabled (the default) the physical memory usage of the MIC system is
4149 =item B<ShowTemperatures> B<true>|B<false>
4151 If enabled (the default) various temperatures of the MIC system are reported.
4153 =item B<Temperature> I<Name>
4155 This option controls which temperatures are being reported. Whether matching
4156 temperatures are being ignored or I<only> matching temperatures are reported
4157 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
4158 temperatures are reported.
4160 =item B<IgnoreSelectedTemperature> B<false>|B<true>
4162 Controls the behavior of the B<Temperature> setting above. If set to B<false>
4163 (the default) only temperatures matching a B<Temperature> option are reported
4164 or, if no B<Temperature> option is specified, all temperatures are reported. If
4165 set to B<true>, matching temperatures are I<ignored> and all other temperatures
4168 Known temperature names are:
4202 =item B<ShowPower> B<true>|B<false>
4204 If enabled (the default) various temperatures of the MIC system are reported.
4206 =item B<Power> I<Name>
4208 This option controls which power readings are being reported. Whether matching
4209 power readings are being ignored or I<only> matching power readings are reported
4210 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
4211 power readings are reported.
4213 =item B<IgnoreSelectedPower> B<false>|B<true>
4215 Controls the behavior of the B<Power> setting above. If set to B<false>
4216 (the default) only power readings matching a B<Power> option are reported
4217 or, if no B<Power> option is specified, all power readings are reported. If
4218 set to B<true>, matching power readings are I<ignored> and all other power readings
4221 Known power names are:
4227 Total power utilization averaged over Time Window 0 (uWatts).
4231 Total power utilization averaged over Time Window 0 (uWatts).
4235 Instantaneous power (uWatts).
4239 Max instantaneous power (uWatts).
4243 PCI-E connector power (uWatts).
4247 2x3 connector power (uWatts).
4251 2x4 connector power (uWatts).
4259 Uncore rail (uVolts).
4263 Memory subsystem rail (uVolts).
4269 =head2 Plugin C<memory>
4271 The I<memory plugin> provides the following configuration options:
4275 =item B<ValuesAbsolute> B<true>|B<false>
4277 Enables or disables reporting of physical memory usage in absolute numbers,
4278 i.e. bytes. Defaults to B<true>.
4280 =item B<ValuesPercentage> B<false>|B<true>
4282 Enables or disables reporting of physical memory usage in percentages, e.g.
4283 percent of physical memory used. Defaults to B<false>.
4285 This is useful for deploying I<collectd> in a heterogeneous environment in
4286 which the sizes of physical memory vary.
4290 =head2 Plugin C<modbus>
4292 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
4293 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
4294 values), large integer values (unsigned 32E<nbsp>bit and 64E<nbsp>bit values) and
4295 floating point values (two registers interpreted as IEEE floats in big endian
4300 <Data "voltage-input-1">
4303 RegisterCmd ReadHolding
4310 <Data "voltage-input-2">
4313 RegisterCmd ReadHolding
4318 <Data "supply-temperature-1">
4321 RegisterCmd ReadHolding
4326 <Host "modbus.example.com">
4327 Address "192.168.0.42"
4332 Instance "power-supply"
4333 Collect "voltage-input-1"
4334 Collect "voltage-input-2"
4339 Device "/dev/ttyUSB0"
4344 Instance "temperature"
4345 Collect "supply-temperature-1"
4351 =item E<lt>B<Data> I<Name>E<gt> blocks
4353 Data blocks define a mapping between register numbers and the "types" used by
4356 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
4360 =item B<RegisterBase> I<Number>
4362 Configures the base register to read from the device. If the option
4363 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
4364 register will be read (the register number is increased by one).
4366 =item B<RegisterType> B<Int16>|B<Int32>|B<Int64>|B<Uint16>|B<Uint32>|B<UInt64>|B<Float>|B<Int32LE>|B<Uint32LE>|B<FloatLE>
4368 Specifies what kind of data is returned by the device. This defaults to
4369 B<Uint16>. If the type is B<Int32>, B<Int32LE>, B<Uint32>, B<Uint32LE>,
4370 B<Float> or B<FloatLE>, two 16E<nbsp>bit registers at B<RegisterBase>
4371 and B<RegisterBase+1> will be read and the data is combined into one
4372 32E<nbsp>value. For B<Int32>, B<Uint32> and B<Float> the most significant
4373 16E<nbsp>bits are in the register at B<RegisterBase> and the least
4374 significant 16E<nbsp>bits are in the register at B<RegisterBase+1>.
4375 For B<Int32LE>, B<Uint32LE>, or B<Float32LE>, the high and low order
4376 registers are swapped with the most significant 16E<nbsp>bits in
4377 the B<RegisterBase+1> and the least significant 16E<nbsp>bits in
4378 B<RegisterBase>. If the type is B<Int64> or B<UInt64>, four 16E<nbsp>bit
4379 registers at B<RegisterBase>, B<RegisterBase+1>, B<RegisterBase+2> and
4380 B<RegisterBase+3> will be read and the data combined into one
4383 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
4385 Specifies register type to be collected from device. Works only with libmodbus
4386 2.9.2 or higher. Defaults to B<ReadHolding>.
4388 =item B<Type> I<Type>
4390 Specifies the "type" (data set) to use when dispatching the value to
4391 I<collectd>. Currently, only data sets with exactly one data source are
4394 =item B<Instance> I<Instance>
4396 Sets the type instance to use when dispatching the value to I<Instance>. If
4397 unset, an empty string (no type instance) is used.
4399 =item B<Scale> I<Value>
4401 The values taken from device are multiplied by I<Value>. The field is optional
4402 and the default is B<1.0>.
4404 =item B<Shift> I<Value>
4406 I<Value> is added to values from device after they have been multiplied by
4407 B<Scale> value. The field is optional and the default value is B<0.0>.
4411 =item E<lt>B<Host> I<Name>E<gt> blocks
4413 Host blocks are used to specify to which hosts to connect and what data to read
4414 from their "slaves". The string argument I<Name> is used as hostname when
4415 dispatching the values to I<collectd>.
4417 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
4421 =item B<Address> I<Hostname>
4423 For Modbus/TCP, specifies the node name (the actual network address) used to
4424 connect to the host. This may be an IP address or a hostname. Please note that
4425 the used I<libmodbus> library only supports IPv4 at the moment.
4427 =item B<Port> I<Service>
4429 for Modbus/TCP, specifies the port used to connect to the host. The port can
4430 either be given as a number or as a service name. Please note that the
4431 I<Service> argument must be a string, even if ports are given in their numerical
4432 form. Defaults to "502".
4434 =item B<Device> I<Devicenode>
4436 For Modbus/RTU, specifies the path to the serial device being used.
4438 =item B<Baudrate> I<Baudrate>
4440 For Modbus/RTU, specifies the baud rate of the serial device.
4441 Note, connections currently support only 8/N/1.
4443 =item B<Interval> I<Interval>
4445 Sets the interval (in seconds) in which the values will be collected from this
4446 host. By default the global B<Interval> setting will be used.
4448 =item E<lt>B<Slave> I<ID>E<gt>
4450 Over each connection, multiple Modbus devices may be reached. The slave ID
4451 is used to specify which device should be addressed. For each device you want
4452 to query, one B<Slave> block must be given.
4454 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
4458 =item B<Instance> I<Instance>
4460 Specify the plugin instance to use when dispatching the values to I<collectd>.
4461 By default "slave_I<ID>" is used.
4463 =item B<Collect> I<DataName>
4465 Specifies which data to retrieve from the device. I<DataName> must be the same
4466 string as the I<Name> argument passed to a B<Data> block. You can specify this
4467 option multiple times to collect more than one value from a slave. At least one
4468 B<Collect> option is mandatory.
4476 =head2 Plugin C<mqtt>
4478 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
4479 values from MQTT (B<Subscribe> blocks).
4485 Host "mqtt.example.com"
4489 Host "mqtt.example.com"
4494 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
4495 configuring the sending and receiving direction respectively. The plugin will
4496 register a write callback named C<mqtt/I<name>> where I<name> is the string
4497 argument given to the B<Publish> block. Both types of blocks share many but not
4498 all of the following options. If an option is valid in only one of the blocks,
4499 it will be mentioned explicitly.
4505 =item B<Host> I<Hostname>
4507 Hostname of the MQTT broker to connect to.
4509 =item B<Port> I<Service>
4511 Port number or service name of the MQTT broker to connect to.
4513 =item B<User> I<UserName>
4515 Username used when authenticating to the MQTT broker.
4517 =item B<Password> I<Password>
4519 Password used when authenticating to the MQTT broker.
4521 =item B<ClientId> I<ClientId>
4523 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
4525 =item B<QoS> [B<0>-B<2>]
4527 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
4545 In B<Publish> blocks, this option determines the QoS flag set on outgoing
4546 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
4547 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
4548 on a message is larger than the maximum accepted QoS of a subscriber, the
4549 message's QoS will be downgraded.
4551 =item B<Prefix> I<Prefix> (Publish only)
4553 This plugin will use one topic per I<value list> which will looks like a path.
4554 I<Prefix> is used as the first path element and defaults to B<collectd>.
4556 An example topic name would be:
4558 collectd/cpu-0/cpu-user
4560 =item B<Retain> B<false>|B<true> (Publish only)
4562 Controls whether the MQTT broker will retain (keep a copy of) the last message
4563 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
4565 =item B<StoreRates> B<true>|B<false> (Publish only)
4567 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
4568 before sending. Defaults to B<true>.
4570 =item B<CleanSession> B<true>|B<false> (Subscribe only)
4572 Controls whether the MQTT "cleans" the session up after the subscriber
4573 disconnects or if it maintains the subscriber's subscriptions and all messages
4574 that arrive while the subscriber is disconnected. Defaults to B<true>.
4576 =item B<Topic> I<TopicName> (Subscribe only)
4578 Configures the topic(s) to subscribe to. You can use the single level C<+> and
4579 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
4580 the B<collectd> branch.
4582 =item B<CACert> I<file>
4584 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
4585 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
4586 port of the MQTT broker.
4587 This option enables the use of TLS.
4589 =item B<CertificateFile> I<file>
4591 Path to the PEM-encoded certificate file to use as client certificate when
4592 connecting to the MQTT broker.
4593 Only valid if B<CACert> and B<CertificateKeyFile> are also set.
4595 =item B<CertificateKeyFile> I<file>
4597 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
4598 Only valid if B<CACert> and B<CertificateFile> are also set.
4600 =item B<TLSProtocol> I<protocol>
4602 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
4603 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
4604 version is used which depends on the version of OpenSSL the Mosquitto library
4606 Only valid if B<CACert> is set.
4608 =item B<CipherSuite> I<ciphersuite>
4610 A string describing the ciphers available for use. See L<ciphers(1)> and the
4611 C<openssl ciphers> utility for more information. If unset, the default ciphers
4613 Only valid if B<CACert> is set.
4617 =head2 Plugin C<mysql>
4619 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
4620 one or more databases when started and keeps the connection up as long as
4621 possible. When the connection is interrupted for whatever reason it will try
4622 to re-connect. The plugin will complain loudly in case anything goes wrong.
4624 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
4625 and collects information about MySQL network traffic, executed statements,
4626 requests, the query cache and threads by evaluating the
4627 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
4628 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
4629 Status Variables> for an explanation of these values.
4631 Optionally, master and slave statistics may be collected in a MySQL
4632 replication setup. In that case, information about the synchronization state
4633 of the nodes are collected by evaluating the C<Position> return value of the
4634 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
4635 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
4636 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
4637 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
4638 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
4650 SSLKey "/path/to/key.pem"
4651 SSLCert "/path/to/cert.pem"
4652 SSLCA "/path/to/ca.pem"
4653 SSLCAPath "/path/to/cas/"
4654 SSLCipher "DHE-RSA-AES256-SHA"
4660 Socket "/var/run/mysql/mysqld.sock"
4662 SlaveNotifications true
4668 Socket "/var/run/mysql/mysqld.sock"
4673 A B<Database> block defines one connection to a MySQL database. It accepts a
4674 single argument which specifies the name of the database. None of the other
4675 options are required. MySQL will use default values as documented in the
4676 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
4677 B<MySQL reference manual>.
4681 =item B<Alias> I<Alias>
4683 Alias to use as sender instead of hostname when reporting. This may be useful
4684 when having cryptic hostnames.
4686 =item B<Host> I<Hostname>
4688 Hostname of the database server. Defaults to B<localhost>.
4690 =item B<User> I<Username>
4692 Username to use when connecting to the database. The user does not have to be
4693 granted any privileges (which is synonym to granting the C<USAGE> privilege),
4694 unless you want to collectd replication statistics (see B<MasterStats> and
4695 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
4696 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
4698 =item B<Password> I<Password>
4700 Password needed to log into the database.
4702 =item B<Database> I<Database>
4704 Select this database. Defaults to I<no database> which is a perfectly reasonable
4705 option for what this plugin does.
4707 =item B<Port> I<Port>
4709 TCP-port to connect to. The port must be specified in its numeric form, but it
4710 must be passed as a string nonetheless. For example:
4714 If B<Host> is set to B<localhost> (the default), this setting has no effect.
4715 See the documentation for the C<mysql_real_connect> function for details.
4717 =item B<Socket> I<Socket>
4719 Specifies the path to the UNIX domain socket of the MySQL server. This option
4720 only has any effect, if B<Host> is set to B<localhost> (the default).
4721 Otherwise, use the B<Port> option above. See the documentation for the
4722 C<mysql_real_connect> function for details.
4724 =item B<InnodbStats> I<true|false>
4726 If enabled, metrics about the InnoDB storage engine are collected.
4727 Disabled by default.
4729 =item B<MasterStats> I<true|false>
4731 =item B<SlaveStats> I<true|false>
4733 Enable the collection of master / slave statistics in a replication setup. In
4734 order to be able to get access to these statistics, the user needs special
4735 privileges. See the B<User> documentation above. Defaults to B<false>.
4737 =item B<SlaveNotifications> I<true|false>
4739 If enabled, the plugin sends a notification if the replication slave I/O and /
4740 or SQL threads are not running. Defaults to B<false>.
4742 =item B<WsrepStats> I<true|false>
4744 Enable the collection of wsrep plugin statistics, used in Master-Master
4745 replication setups like in MySQL Galera/Percona XtraDB Cluster.
4746 User needs only privileges to execute 'SHOW GLOBAL STATUS'
4748 =item B<ConnectTimeout> I<Seconds>
4750 Sets the connect timeout for the MySQL client.
4752 =item B<SSLKey> I<Path>
4754 If provided, the X509 key in PEM format.
4756 =item B<SSLCert> I<Path>
4758 If provided, the X509 cert in PEM format.
4760 =item B<SSLCA> I<Path>
4762 If provided, the CA file in PEM format (check OpenSSL docs).
4764 =item B<SSLCAPath> I<Path>
4766 If provided, the CA directory (check OpenSSL docs).
4768 =item B<SSLCipher> I<String>
4770 If provided, the SSL cipher to use.
4774 =head2 Plugin C<netapp>
4776 The netapp plugin can collect various performance and capacity information
4777 from a NetApp filer using the NetApp API.
4779 Please note that NetApp has a wide line of products and a lot of different
4780 software versions for each of these products. This plugin was developed for a
4781 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
4782 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
4783 model and software version but it is very hard to test this.
4784 If you have used this plugin with other models and/or software version, feel
4785 free to send us a mail to tell us about the results, even if it's just a short
4788 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
4789 basic authentication.
4791 B<Do not use a regular user for this!> Create a special collectd user with just
4792 the minimum of capabilities needed. The user only needs the "login-http-admin"
4793 capability as well as a few more depending on which data will be collected.
4794 Required capabilities are documented below.
4799 <Host "netapp1.example.com">
4823 IgnoreSelectedIO false
4825 IgnoreSelectedOps false
4826 GetLatency "volume0"
4827 IgnoreSelectedLatency false
4834 IgnoreSelectedCapacity false
4837 IgnoreSelectedSnapshot false
4865 The netapp plugin accepts the following configuration options:
4869 =item B<Host> I<Name>
4871 A host block defines one NetApp filer. It will appear in collectd with the name
4872 you specify here which does not have to be its real name nor its hostname (see
4873 the B<Address> option below).
4875 =item B<VFiler> I<Name>
4877 A B<VFiler> block may only be used inside a host block. It accepts all the
4878 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
4879 will execute all NetApp API commands in the context of the specified
4880 VFiler(R). It will appear in collectd with the name you specify here which
4881 does not have to be its real name. The VFiler name may be specified using the
4882 B<VFilerName> option. If this is not specified, it will default to the name
4885 The VFiler block inherits all connection related settings from the surrounding
4886 B<Host> block (which appear before the B<VFiler> block) but they may be
4887 overwritten inside the B<VFiler> block.
4889 This feature is useful, for example, when using a VFiler as SnapVault target
4890 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
4891 available in the host filer (vfiler0) but only in the respective VFiler
4894 =item B<Protocol> B<httpd>|B<http>
4896 The protocol collectd will use to query this host.
4904 Valid options: http, https
4906 =item B<Address> I<Address>
4908 The hostname or IP address of the host.
4914 Default: The "host" block's name.
4916 =item B<Port> I<Port>
4918 The TCP port to connect to on the host.
4924 Default: 80 for protocol "http", 443 for protocol "https"
4926 =item B<User> I<User>
4928 =item B<Password> I<Password>
4930 The username and password to use to login to the NetApp.
4936 =item B<VFilerName> I<Name>
4938 The name of the VFiler in which context to execute API commands. If not
4939 specified, the name provided to the B<VFiler> block will be used instead.
4945 Default: name of the B<VFiler> block
4947 B<Note:> This option may only be used inside B<VFiler> blocks.
4949 =item B<Interval> I<Interval>
4955 The following options decide what kind of data will be collected. You can
4956 either use them as a block and fine tune various parameters inside this block,
4957 use them as a single statement to just accept all default values, or omit it to
4958 not collect any data.
4960 The following options are valid inside all blocks:
4964 =item B<Interval> I<Seconds>
4966 Collect the respective statistics every I<Seconds> seconds. Defaults to the
4967 host specific setting.
4971 =head3 The System block
4973 This will collect various performance data about the whole system.
4975 B<Note:> To get this data the collectd user needs the
4976 "api-perf-object-get-instances" capability.
4980 =item B<Interval> I<Seconds>
4982 Collect disk statistics every I<Seconds> seconds.
4984 =item B<GetCPULoad> B<true>|B<false>
4986 If you set this option to true the current CPU usage will be read. This will be
4987 the average usage between all CPUs in your NetApp without any information about
4990 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4991 returns in the "CPU" field.
4999 Result: Two value lists of type "cpu", and type instances "idle" and "system".
5001 =item B<GetInterfaces> B<true>|B<false>
5003 If you set this option to true the current traffic of the network interfaces
5004 will be read. This will be the total traffic over all interfaces of your NetApp
5005 without any information about individual interfaces.
5007 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5008 in the "Net kB/s" field.
5018 Result: One value list of type "if_octects".
5020 =item B<GetDiskIO> B<true>|B<false>
5022 If you set this option to true the current IO throughput will be read. This
5023 will be the total IO of your NetApp without any information about individual
5024 disks, volumes or aggregates.
5026 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5027 in the "DiskE<nbsp>kB/s" field.
5035 Result: One value list of type "disk_octets".
5037 =item B<GetDiskOps> B<true>|B<false>
5039 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
5040 iSCSI, etc. operations will be read. This will be the total number of
5041 operations on your NetApp without any information about individual volumes or
5044 B<Note:> These are the same values that the NetApp CLI command "sysstat"
5045 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
5053 Result: A variable number of value lists of type "disk_ops_complex". Each type
5054 of operation will result in one value list with the name of the operation as
5059 =head3 The WAFL block
5061 This will collect various performance data about the WAFL file system. At the
5062 moment this just means cache performance.
5064 B<Note:> To get this data the collectd user needs the
5065 "api-perf-object-get-instances" capability.
5067 B<Note:> The interface to get these values is classified as "Diagnostics" by
5068 NetApp. This means that it is not guaranteed to be stable even between minor
5073 =item B<Interval> I<Seconds>
5075 Collect disk statistics every I<Seconds> seconds.
5077 =item B<GetNameCache> B<true>|B<false>
5085 Result: One value list of type "cache_ratio" and type instance
5088 =item B<GetDirCache> B<true>|B<false>
5096 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
5098 =item B<GetInodeCache> B<true>|B<false>
5106 Result: One value list of type "cache_ratio" and type instance
5109 =item B<GetBufferCache> B<true>|B<false>
5111 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
5112 in the "Cache hit" field.
5120 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
5124 =head3 The Disks block
5126 This will collect performance data about the individual disks in the NetApp.
5128 B<Note:> To get this data the collectd user needs the
5129 "api-perf-object-get-instances" capability.
5133 =item B<Interval> I<Seconds>
5135 Collect disk statistics every I<Seconds> seconds.
5137 =item B<GetBusy> B<true>|B<false>
5139 If you set this option to true the busy time of all disks will be calculated
5140 and the value of the busiest disk in the system will be written.
5142 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5143 in the "Disk util" field. Probably.
5151 Result: One value list of type "percent" and type instance "disk_busy".
5155 =head3 The VolumePerf block
5157 This will collect various performance data about the individual volumes.
5159 You can select which data to collect about which volume using the following
5160 options. They follow the standard ignorelist semantic.
5162 B<Note:> To get this data the collectd user needs the
5163 I<api-perf-object-get-instances> capability.
5167 =item B<Interval> I<Seconds>
5169 Collect volume performance data every I<Seconds> seconds.
5171 =item B<GetIO> I<Volume>
5173 =item B<GetOps> I<Volume>
5175 =item B<GetLatency> I<Volume>
5177 Select the given volume for IO, operations or latency statistics collection.
5178 The argument is the name of the volume without the C</vol/> prefix.
5180 Since the standard ignorelist functionality is used here, you can use a string
5181 starting and ending with a slash to specify regular expression matching: To
5182 match the volumes "vol0", "vol2" and "vol7", you can use this regular
5185 GetIO "/^vol[027]$/"
5187 If no regular expression is specified, an exact match is required. Both,
5188 regular and exact matching are case sensitive.
5190 If no volume was specified at all for either of the three options, that data
5191 will be collected for all available volumes.
5193 See F</"IGNORELISTS"> for details.
5195 =item B<IgnoreSelectedIO> B<true>|B<false>
5197 =item B<IgnoreSelectedOps> B<true>|B<false>
5199 =item B<IgnoreSelectedLatency> B<true>|B<false>
5201 When set to B<true>, the volumes selected for IO, operations or latency
5202 statistics collection will be ignored and the data will be collected for all
5205 When set to B<false>, data will only be collected for the specified volumes and
5206 all other volumes will be ignored.
5208 If no volumes have been specified with the above B<Get*> options, all volumes
5209 will be collected regardless of the B<IgnoreSelected*> option.
5211 Defaults to B<false>
5215 =head3 The VolumeUsage block
5217 This will collect capacity data about the individual volumes.
5219 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
5224 =item B<Interval> I<Seconds>
5226 Collect volume usage statistics every I<Seconds> seconds.
5228 =item B<GetCapacity> I<VolumeName>
5230 The current capacity of the volume will be collected. This will result in two
5231 to four value lists, depending on the configuration of the volume. All data
5232 sources are of type "df_complex" with the name of the volume as
5235 There will be type_instances "used" and "free" for the number of used and
5236 available bytes on the volume. If the volume has some space reserved for
5237 snapshots, a type_instance "snap_reserved" will be available. If the volume
5238 has SIS enabled, a type_instance "sis_saved" will be available. This is the
5239 number of bytes saved by the SIS feature.
5241 B<Note:> The current NetApp API has a bug that results in this value being
5242 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
5243 number which works most of the time. If you see strange values here, bug
5244 NetApp support to fix this.
5246 Repeat this option to specify multiple volumes.
5248 =item B<IgnoreSelectedCapacity> B<true>|B<false>
5250 Specify whether to collect only the volumes selected by the B<GetCapacity>
5251 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
5252 B<false>. However, if no B<GetCapacity> option is specified at all, all
5253 capacities will be selected anyway.
5255 =item B<GetSnapshot> I<VolumeName>
5257 Select volumes from which to collect snapshot information.
5259 Usually, the space used for snapshots is included in the space reported as
5260 "used". If snapshot information is collected as well, the space used for
5261 snapshots is subtracted from the used space.
5263 To make things even more interesting, it is possible to reserve space to be
5264 used for snapshots. If the space required for snapshots is less than that
5265 reserved space, there is "reserved free" and "reserved used" space in addition
5266 to "free" and "used". If the space required for snapshots exceeds the reserved
5267 space, that part allocated in the normal space is subtracted from the "used"
5270 Repeat this option to specify multiple volumes.
5272 =item B<IgnoreSelectedSnapshot>
5274 Specify whether to collect only the volumes selected by the B<GetSnapshot>
5275 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
5276 B<false>. However, if no B<GetSnapshot> option is specified at all, all
5277 capacities will be selected anyway.
5281 =head3 The Quota block
5283 This will collect (tree) quota statistics (used disk space and number of used
5284 files). This mechanism is useful to get usage information for single qtrees.
5285 In case the quotas are not used for any other purpose, an entry similar to the
5286 following in C</etc/quotas> would be sufficient:
5288 /vol/volA/some_qtree tree - - - - -
5290 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
5294 =item B<Interval> I<Seconds>
5296 Collect SnapVault(R) statistics every I<Seconds> seconds.
5300 =head3 The SnapVault block
5302 This will collect statistics about the time and traffic of SnapVault(R)
5307 =item B<Interval> I<Seconds>
5309 Collect SnapVault(R) statistics every I<Seconds> seconds.
5313 =head2 Plugin C<netlink>
5315 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
5316 statistics of various interface and routing aspects.
5320 =item B<Interface> I<Interface>
5322 =item B<VerboseInterface> I<Interface>
5324 Instruct the plugin to collect interface statistics. This is basically the same
5325 as the statistics provided by the C<interface> plugin (see above) but
5326 potentially much more detailed.
5328 When configuring with B<Interface> only the basic statistics will be collected,
5329 namely octets, packets, and errors. These statistics are collected by
5330 the C<interface> plugin, too, so using both at the same time is no benefit.
5332 When configured with B<VerboseInterface> all counters B<except> the basic ones,
5333 so that no data needs to be collected twice if you use the C<interface> plugin.
5334 This includes dropped packets, received multicast packets, collisions and a
5335 whole zoo of differentiated RX and TX errors. You can try the following command
5336 to get an idea of what awaits you:
5340 If I<Interface> is B<All>, all interfaces will be selected.
5342 =item B<QDisc> I<Interface> [I<QDisc>]
5344 =item B<Class> I<Interface> [I<Class>]
5346 =item B<Filter> I<Interface> [I<Filter>]
5348 Collect the octets and packets that pass a certain qdisc, class or filter.
5350 QDiscs and classes are identified by their type and handle (or classid).
5351 Filters don't necessarily have a handle, therefore the parent's handle is used.
5352 The notation used in collectd differs from that used in tc(1) in that it
5353 doesn't skip the major or minor number if it's zero and doesn't print special
5354 ids by their name. So, for example, a qdisc may be identified by
5355 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
5356 thus not displayed by tc(1).
5358 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
5359 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
5360 associated with that interface will be collected.
5362 Since a filter itself doesn't necessarily have a handle, the parent's handle is
5363 used. This may lead to problems when more than one filter is attached to a
5364 qdisc or class. This isn't nice, but we don't know how this could be done any
5365 better. If you have a idea, please don't hesitate to tell us.
5367 As with the B<Interface> option you can specify B<All> as the interface,
5368 meaning all interfaces.
5370 Here are some examples to help you understand the above text more easily:
5373 VerboseInterface "All"
5374 QDisc "eth0" "pfifo_fast-1:0"
5376 Class "ppp0" "htb-1:10"
5377 Filter "ppp0" "u32-1:0"
5380 See F</"IGNORELISTS"> for details.
5382 =item B<IgnoreSelected>
5384 The behavior is the same as with all other similar plugins: If nothing is
5385 selected at all, everything is collected. If some things are selected using the
5386 options described above, only these statistics are collected. If you set
5387 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
5388 specified statistics will not be collected.
5392 =head2 Plugin C<network>
5394 The Network plugin sends data to a remote instance of collectd, receives data
5395 from a remote instance, or both at the same time. Data which has been received
5396 from the network is usually not transmitted again, but this can be activated, see
5397 the B<Forward> option below.
5399 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
5400 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
5402 Both, B<Server> and B<Listen> can be used as single option or as block. When
5403 used as block, given options are valid for this socket only. The following
5404 example will export the metrics twice: Once to an "internal" server (without
5405 encryption and signing) and one to an external server (with cryptographic
5409 # Export to an internal server
5410 # (demonstrates usage without additional options)
5411 Server "collectd.internal.tld"
5413 # Export to an external server
5414 # (demonstrates usage with signature options)
5415 <Server "collectd.external.tld">
5416 SecurityLevel "sign"
5417 Username "myhostname"
5424 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
5426 The B<Server> statement/block sets the server to send datagrams to. The
5427 statement may occur multiple times to send each datagram to multiple
5430 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
5431 optional second argument specifies a port number or a service name. If not
5432 given, the default, B<25826>, is used.
5434 The following options are recognized within B<Server> blocks:
5438 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5440 Set the security you require for network communication. When the security level
5441 has been set to B<Encrypt>, data sent over the network will be encrypted using
5442 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
5443 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
5444 authentication code. When set to B<None>, data is sent without any security.
5446 This feature is only available if the I<network> plugin was linked with
5449 =item B<Username> I<Username>
5451 Sets the username to transmit. This is used by the server to lookup the
5452 password. See B<AuthFile> below. All security levels except B<None> require
5455 This feature is only available if the I<network> plugin was linked with
5458 =item B<Password> I<Password>
5460 Sets a password (shared secret) for this socket. All security levels except
5461 B<None> require this setting.
5463 This feature is only available if the I<network> plugin was linked with
5466 =item B<Interface> I<Interface name>
5468 Set the outgoing interface for IP packets. This applies at least
5469 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5470 undefined or a non-existent interface name is specified, the default
5471 behavior is to let the kernel choose the appropriate interface. Be warned
5472 that the manual selection of an interface for unicast traffic is only
5473 necessary in rare cases.
5475 =item B<BindAddress> I<IP Address>
5477 Set the outgoing IP address for IP packets. This option can be used instead of
5478 the I<Interface> option to explicitly define the IP address which will be used
5479 to send Packets to the remote server.
5481 =item B<ResolveInterval> I<Seconds>
5483 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
5484 useful to force a regular DNS lookup to support a high availability setup. If
5485 not specified, re-resolves are never attempted.
5489 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
5491 The B<Listen> statement sets the interfaces to bind to. When multiple
5492 statements are found the daemon will bind to multiple interfaces.
5494 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
5495 the argument is a multicast address the daemon will join that multicast group.
5496 The optional second argument specifies a port number or a service name. If not
5497 given, the default, B<25826>, is used.
5499 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
5503 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5505 Set the security you require for network communication. When the security level
5506 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
5507 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
5508 signed and encrypted data is accepted. When set to B<None>, all data will be
5509 accepted. If an B<AuthFile> option was given (see below), encrypted data is
5510 decrypted if possible.
5512 This feature is only available if the I<network> plugin was linked with
5515 =item B<AuthFile> I<Filename>
5517 Sets a file in which usernames are mapped to passwords. These passwords are
5518 used to verify signatures and to decrypt encrypted network packets. If
5519 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
5520 verified and encrypted packets are decrypted. Otherwise, signed data is
5521 accepted without checking the signature and encrypted data cannot be decrypted.
5522 For the other security levels this option is mandatory.
5524 The file format is very simple: Each line consists of a username followed by a
5525 colon and any number of spaces followed by the password. To demonstrate, an
5526 example file could look like this:
5531 Each time a packet is received, the modification time of the file is checked
5532 using L<stat(2)>. If the file has been changed, the contents is re-read. While
5533 the file is being read, it is locked using L<fcntl(2)>.
5535 =item B<Interface> I<Interface name>
5537 Set the incoming interface for IP packets explicitly. This applies at least
5538 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5539 undefined or a non-existent interface name is specified, the default
5540 behavior is, to let the kernel choose the appropriate interface. Thus incoming
5541 traffic gets only accepted, if it arrives on the given interface.
5545 =item B<TimeToLive> I<1-255>
5547 Set the time-to-live of sent packets. This applies to all, unicast and
5548 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
5549 That means that multicast packets will be sent with a TTL of C<1> (one) on most
5552 =item B<MaxPacketSize> I<1024-65535>
5554 Set the maximum size for datagrams received over the network. Packets larger
5555 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
5556 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
5559 On the server side, this limit should be set to the largest value used on
5560 I<any> client. Likewise, the value on the client must not be larger than the
5561 value on the server, or data will be lost.
5563 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
5564 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
5565 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
5568 =item B<Forward> I<true|false>
5570 If set to I<true>, write packets that were received via the network plugin to
5571 the sending sockets. This should only be activated when the B<Listen>- and
5572 B<Server>-statements differ. Otherwise packets may be send multiple times to
5573 the same multicast group. While this results in more network traffic than
5574 necessary it's not a huge problem since the plugin has a duplicate detection,
5575 so the values will not loop.
5577 =item B<ReportStats> B<true>|B<false>
5579 The network plugin cannot only receive and send statistics, it can also create
5580 statistics about itself. Collectd data included the number of received and
5581 sent octets and packets, the length of the receive queue and the number of
5582 values handled. When set to B<true>, the I<Network plugin> will make these
5583 statistics available. Defaults to B<false>.
5587 =head2 Plugin C<nfs>
5589 The I<nfs plugin> collects information about the usage of the Network File
5590 System (NFS). It counts the number of procedure calls for each procedure,
5591 grouped by version and whether the system runs as server or client.
5593 It is possibly to omit metrics for a specific NFS version by setting one or
5594 more of the following options to B<false> (all of them default to B<true>).
5598 =item B<ReportV2> B<true>|B<false>
5600 =item B<ReportV3> B<true>|B<false>
5602 =item B<ReportV4> B<true>|B<false>
5606 =head2 Plugin C<nginx>
5608 This plugin collects the number of connections and requests handled by the
5609 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
5610 queries the page provided by the C<ngx_http_stub_status_module> module, which
5611 isn't compiled by default. Please refer to
5612 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
5613 how to compile and configure nginx and this module.
5615 The following options are accepted by the C<nginx plugin>:
5619 =item B<URL> I<http://host/nginx_status>
5621 Sets the URL of the C<ngx_http_stub_status_module> output.
5623 =item B<User> I<Username>
5625 Optional user name needed for authentication.
5627 =item B<Password> I<Password>
5629 Optional password needed for authentication.
5631 =item B<VerifyPeer> B<true|false>
5633 Enable or disable peer SSL certificate verification. See
5634 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5636 =item B<VerifyHost> B<true|false>
5638 Enable or disable peer host name verification. If enabled, the plugin checks
5639 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5640 certificate matches the host name provided by the B<URL> option. If this
5641 identity check fails, the connection is aborted. Obviously, only works when
5642 connecting to a SSL enabled server. Enabled by default.
5644 =item B<CACert> I<File>
5646 File that holds one or more SSL certificates. If you want to use HTTPS you will
5647 possibly need this option. What CA certificates come bundled with C<libcurl>
5648 and are checked by default depends on the distribution you use.
5650 =item B<Timeout> I<Milliseconds>
5652 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
5653 milliseconds. By default, the configured B<Interval> is used to set the
5658 =head2 Plugin C<notify_desktop>
5660 This plugin sends a desktop notification to a notification daemon, as defined
5661 in the Desktop Notification Specification. To actually display the
5662 notifications, B<notification-daemon> is required and B<collectd> has to be
5663 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
5664 environment variables have to be set correctly) and the D-Bus message bus.
5666 The Desktop Notification Specification can be found at
5667 L<http://www.galago-project.org/specs/notification/>.
5671 =item B<OkayTimeout> I<timeout>
5673 =item B<WarningTimeout> I<timeout>
5675 =item B<FailureTimeout> I<timeout>
5677 Set the I<timeout>, in milliseconds, after which to expire the notification
5678 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
5679 been specified, the displayed notification will not be closed at all - the
5680 user has to do so herself. These options default to 5000. If a negative number
5681 has been specified, the default is used as well.
5685 =head2 Plugin C<notify_email>
5687 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
5688 configured email address.
5690 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
5692 Available configuration options:
5696 =item B<From> I<Address>
5698 Email address from which the emails should appear to come from.
5700 Default: C<root@localhost>
5702 =item B<Recipient> I<Address>
5704 Configures the email address(es) to which the notifications should be mailed.
5705 May be repeated to send notifications to multiple addresses.
5707 At least one B<Recipient> must be present for the plugin to work correctly.
5709 =item B<SMTPServer> I<Hostname>
5711 Hostname of the SMTP server to connect to.
5713 Default: C<localhost>
5715 =item B<SMTPPort> I<Port>
5717 TCP port to connect to.
5721 =item B<SMTPUser> I<Username>
5723 Username for ASMTP authentication. Optional.
5725 =item B<SMTPPassword> I<Password>
5727 Password for ASMTP authentication. Optional.
5729 =item B<Subject> I<Subject>
5731 Subject-template to use when sending emails. There must be exactly two
5732 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
5733 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
5736 Default: C<Collectd notify: %s@%s>
5740 =head2 Plugin C<notify_nagios>
5742 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
5743 a I<passive service check result>.
5745 Available configuration options:
5749 =item B<CommandFile> I<Path>
5751 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
5755 =head2 Plugin C<ntpd>
5757 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
5760 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
5761 the wire - using B<mode 7> specific requests. This mode is deprecated with
5762 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
5763 correctly with them, the ntp daemon must be explicitly configured to
5764 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
5765 manual page for details.
5767 Available configuration options for the C<ntpd> plugin:
5771 =item B<Host> I<Hostname>
5773 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
5775 =item B<Port> I<Port>
5777 UDP-Port to connect to. Defaults to B<123>.
5779 =item B<ReverseLookups> B<true>|B<false>
5781 Sets whether or not to perform reverse lookups on peers. Since the name or
5782 IP-address may be used in a filename it is recommended to disable reverse
5783 lookups. The default is to do reverse lookups to preserve backwards
5784 compatibility, though.
5786 =item B<IncludeUnitID> B<true>|B<false>
5788 When a peer is a refclock, include the unit ID in the I<type instance>.
5789 Defaults to B<false> for backward compatibility.
5791 If two refclock peers use the same driver and this is B<false>, the plugin will
5792 try to write simultaneous measurements from both to the same type instance.
5793 This will result in error messages in the log and only one set of measurements
5798 =head2 Plugin C<nut>
5802 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
5804 Add a UPS to collect data from. The format is identical to the one accepted by
5807 =item B<ForceSSL> B<true>|B<false>
5809 Stops connections from falling back to unsecured if an SSL connection
5810 cannot be established. Defaults to false if undeclared.
5812 =item B<VerifyPeer> I<true>|I<false>
5814 If set to true, requires a CAPath be provided. Will use the CAPath to find
5815 certificates to use as Trusted Certificates to validate a upsd server certificate.
5816 If validation of the upsd server certificate fails, the connection will not be
5817 established. If ForceSSL is undeclared or set to false, setting VerifyPeer to true
5818 will override and set ForceSSL to true.
5820 =item B<CAPath> I/path/to/certs/folder
5822 If VerifyPeer is set to true, this is required. Otherwise this is ignored.
5823 The folder pointed at must contain certificate(s) named according to their hash.
5824 Ex: XXXXXXXX.Y where X is the hash value of a cert and Y is 0. If name collisions
5825 occur because two different certs have the same hash value, Y can be incremented
5826 in order to avoid conflict. To create a symbolic link to a certificate the following
5827 command can be used from within the directory where the cert resides:
5829 C<ln -s some.crt ./$(openssl x509 -hash -noout -in some.crt).0>
5831 Alternatively, the package openssl-perl provides a command C<c_rehash> that will
5832 generate links like the one described above for ALL certs in a given folder.
5834 C<c_rehash /path/to/certs/folder>
5836 =item B<ConnectTimeout> I<Milliseconds>
5838 The B<ConnectTimeout> option sets the connect timeout, in milliseconds.
5839 By default, the configured B<Interval> is used to set the timeout.
5843 =head2 Plugin C<olsrd>
5845 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
5846 the Optimized Link State Routing daemon and reads information about the current
5847 state of the meshed network.
5849 The following configuration options are understood:
5853 =item B<Host> I<Host>
5855 Connect to I<Host>. Defaults to B<"localhost">.
5857 =item B<Port> I<Port>
5859 Specifies the port to connect to. This must be a string, even if you give the
5860 port as a number rather than a service name. Defaults to B<"2006">.
5862 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
5864 Specifies what information to collect about links, i.E<nbsp>e. direct
5865 connections of the daemon queried. If set to B<No>, no information is
5866 collected. If set to B<Summary>, the number of links and the average of all
5867 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
5868 If set to B<Detail> LQ and NLQ are collected per link.
5870 Defaults to B<Detail>.
5872 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
5874 Specifies what information to collect about routes of the daemon queried. If
5875 set to B<No>, no information is collected. If set to B<Summary>, the number of
5876 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
5877 metric and ETX are collected per route.
5879 Defaults to B<Summary>.
5881 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
5883 Specifies what information to collect about the global topology. If set to
5884 B<No>, no information is collected. If set to B<Summary>, the number of links
5885 in the entire topology and the average I<link quality> (LQ) is calculated.
5886 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
5888 Defaults to B<Summary>.
5892 =head2 Plugin C<onewire>
5894 B<EXPERIMENTAL!> See notes below.
5896 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
5897 L<http://owfs.org/> to read sensors connected via the onewire bus.
5899 It can be used in two possible modes - standard or advanced.
5901 In the standard mode only temperature sensors (sensors with the family code
5902 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
5903 other sensors you would like to have included, please send a sort request to
5904 the mailing list. You can select sensors to be read or to be ignored depending
5905 on the option B<IgnoreSelected>). When no list is provided the whole bus is
5906 walked and all sensors are read.
5908 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
5909 experimental, below.
5911 In the advanced mode you can configure any sensor to be read (only numerical
5912 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
5913 In this mode you have to list all the sensors. Neither default bus walk nor
5914 B<IgnoreSelected> are used here. Address and type (file) is extracted from
5915 the path automatically and should produce compatible structure with the "standard"
5916 mode (basically the path is expected as for example
5917 "/uncached/10.F10FCA000800/temperature" where it would extract address part
5918 "F10FCA000800" and the rest after the slash is considered the type - here
5920 There are two advantages to this mode - you can access virtually any sensor
5921 (not just temperature), select whether to use cached or directly read values
5922 and it is slighlty faster. The downside is more complex configuration.
5924 The two modes are distinguished automatically by the format of the address.
5925 It is not possible to mix the two modes. Once a full path is detected in any
5926 B<Sensor> then the whole addressing (all sensors) is considered to be this way
5927 (and as standard addresses will fail parsing they will be ignored).
5931 =item B<Device> I<Device>
5933 Sets the device to read the values from. This can either be a "real" hardware
5934 device, such as a serial port or an USB port, or the address of the
5935 L<owserver(1)> socket, usually B<localhost:4304>.
5937 Though the documentation claims to automatically recognize the given address
5938 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
5939 with that version, the following configuration worked for us:
5942 Device "-s localhost:4304"
5945 This directive is B<required> and does not have a default value.
5947 =item B<Sensor> I<Sensor>
5949 In the standard mode selects sensors to collect or to ignore
5950 (depending on B<IgnoreSelected>, see below). Sensors are specified without
5951 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
5952 and B<not> include the leading C<10.> family byte and point.
5953 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
5954 sensors (see above) are read.
5956 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
5957 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
5958 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
5960 As there can be multiple devices on the bus you can list multiple sensor (use
5961 multiple B<Sensor> elements).
5963 See F</"IGNORELISTS"> for details.
5965 =item B<IgnoreSelected> I<true>|I<false>
5967 If no configuration is given, the B<onewire> plugin will collect data from all
5968 sensors found. This may not be practical, especially if sensors are added and
5969 removed regularly. Sometimes, however, it's easier/preferred to collect only
5970 specific sensors or all sensors I<except> a few specified ones. This option
5971 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
5972 B<Sensor> is inverted: All selected interfaces are ignored and all other
5973 interfaces are collected.
5975 Used only in the standard mode - see above.
5977 =item B<Interval> I<Seconds>
5979 Sets the interval in which all sensors should be read. If not specified, the
5980 global B<Interval> setting is used.
5984 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
5985 work with big setups. It works with one sensor being attached to one
5986 controller, but as soon as you throw in a couple more senors and maybe a hub
5987 or two, reading all values will take more than ten seconds (the default
5988 interval). We will probably add some separate thread for reading the sensors
5989 and some cache or something like that, but it's not done yet. We will try to
5990 maintain backwards compatibility in the future, but we can't promise. So in
5991 short: If it works for you: Great! But keep in mind that the config I<might>
5992 change, though this is unlikely. Oh, and if you want to help improving this
5993 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
5995 =head2 Plugin C<openldap>
5997 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
5998 server correctly. The backend database C<monitor> needs to be loaded and
5999 working. See slapd-monitor(5) for the details.
6001 The configuration of the C<openldap> plugin consists of one or more B<Instance>
6002 blocks. Each block requires one string argument as the instance name. For
6007 URL "ldap://localhost/"
6010 URL "ldaps://localhost/"
6014 The instance name will be used as the I<plugin instance>. To emulate the old
6015 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
6016 plugin to work correctly, each instance name must be unique. This is not
6017 enforced by the plugin and it is your responsibility to ensure it is.
6019 The following options are accepted within each B<Instance> block:
6023 =item B<URL> I<ldap://host/binddn>
6025 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
6028 =item B<BindDN> I<BindDN>
6030 Name in the form of an LDAP distinguished name intended to be used for
6031 authentication. Defaults to empty string to establish an anonymous authorization.
6033 =item B<Password> I<Password>
6035 Password for simple bind authentication. If this option is not set,
6036 unauthenticated bind operation is used.
6038 =item B<StartTLS> B<true|false>
6040 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
6041 Disabled by default.
6043 =item B<VerifyHost> B<true|false>
6045 Enables or disables peer host name verification. If enabled, the plugin checks
6046 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
6047 certificate matches the host name provided by the B<URL> option. If this
6048 identity check fails, the connection is aborted. Enabled by default.
6050 =item B<CACert> I<File>
6052 File that holds one or more SSL certificates. If you want to use TLS/SSL you
6053 may possibly need this option. What CA certificates are checked by default
6054 depends on the distribution you use and can be changed with the usual ldap
6055 client configuration mechanisms. See ldap.conf(5) for the details.
6057 =item B<Timeout> I<Seconds>
6059 Sets the timeout value for ldap operations, in seconds. By default, the
6060 configured B<Interval> is used to set the timeout. Use B<-1> to disable
6063 =item B<Version> I<Version>
6065 An integer which sets the LDAP protocol version number to use when connecting
6066 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
6070 =head2 Plugin C<openvpn>
6072 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
6073 traffic statistics about connected clients.
6075 To set up OpenVPN to write to the status file periodically, use the
6076 B<--status> option of OpenVPN.
6078 So, in a nutshell you need:
6080 openvpn $OTHER_OPTIONS \
6081 --status "/var/run/openvpn-status" 10
6087 =item B<StatusFile> I<File>
6089 Specifies the location of the status file.
6091 =item B<ImprovedNamingSchema> B<true>|B<false>
6093 When enabled, the filename of the status file will be used as plugin instance
6094 and the client's "common name" will be used as type instance. This is required
6095 when reading multiple status files. Enabling this option is recommended, but to
6096 maintain backwards compatibility this option is disabled by default.
6098 =item B<CollectCompression> B<true>|B<false>
6100 Sets whether or not statistics about the compression used by OpenVPN should be
6101 collected. This information is only available in I<single> mode. Enabled by
6104 =item B<CollectIndividualUsers> B<true>|B<false>
6106 Sets whether or not traffic information is collected for each connected client
6107 individually. If set to false, currently no traffic data is collected at all
6108 because aggregating this data in a save manner is tricky. Defaults to B<true>.
6110 =item B<CollectUserCount> B<true>|B<false>
6112 When enabled, the number of currently connected clients or users is collected.
6113 This is especially interesting when B<CollectIndividualUsers> is disabled, but
6114 can be configured independently from that option. Defaults to B<false>.
6118 =head2 Plugin C<oracle>
6120 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
6121 Oracle® Database and lets you execute SQL statements there. It is very similar
6122 to the "dbi" plugin, because it was written around the same time. See the "dbi"
6123 plugin's documentation above for details.
6126 <Query "out_of_stock">
6127 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
6130 # InstancePrefix "foo"
6131 InstancesFrom "category"
6135 <Database "product_information">
6140 Query "out_of_stock"
6144 =head3 B<Query> blocks
6146 The Query blocks are handled identically to the Query blocks of the "dbi"
6147 plugin. Please see its documentation above for details on how to specify
6150 =head3 B<Database> blocks
6152 Database blocks define a connection to a database and which queries should be
6153 sent to that database. Each database needs a "name" as string argument in the
6154 starting tag of the block. This name will be used as "PluginInstance" in the
6155 values submitted to the daemon. Other than that, that name is not used.
6159 =item B<Plugin> I<Plugin>
6161 Use I<Plugin> as the plugin name when submitting query results from
6162 this B<Database>. Defaults to C<oracle>.
6164 =item B<ConnectID> I<ID>
6166 Defines the "database alias" or "service name" to connect to. Usually, these
6167 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
6169 =item B<Host> I<Host>
6171 Hostname to use when dispatching values for this database. Defaults to using
6172 the global hostname of the I<collectd> instance.
6174 =item B<Username> I<Username>
6176 Username used for authentication.
6178 =item B<Password> I<Password>
6180 Password used for authentication.
6182 =item B<Query> I<QueryName>
6184 Associates the query named I<QueryName> with this database connection. The
6185 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
6186 blocks you want to refer to must be placed above the database block you want to
6191 =head2 Plugin C<ovs_events>
6193 The I<ovs_events> plugin monitors the link status of I<Open vSwitch> (OVS)
6194 connected interfaces, dispatches the values to collectd and sends the
6195 notification whenever the link state change occurs. This plugin uses OVS
6196 database to get a link state change notification.
6200 <Plugin "ovs_events">
6203 Socket "/var/run/openvswitch/db.sock"
6204 Interfaces "br0" "veth0"
6205 SendNotification true
6206 DispatchValues false
6209 The plugin provides the following configuration options:
6213 =item B<Address> I<node>
6215 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6216 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6217 option. See L<ovsdb-server(1)> for more details. The option may be either
6218 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6219 format. Defaults to C<localhost>.
6221 =item B<Port> I<service>
6223 TCP-port to connect to. Either a service name or a port number may be given.
6224 Defaults to B<6640>.
6226 =item B<Socket> I<path>
6228 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6229 plugin. To enable the interface, the OVS DB daemon should be running with
6230 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6231 option is set, B<Address> and B<Port> options are ignored.
6233 =item B<Interfaces> [I<ifname> ...]
6235 List of interface names to be monitored by this plugin. If this option is not
6236 specified or is empty then all OVS connected interfaces on all bridges are
6239 Default: empty (all interfaces on all bridges are monitored)
6241 =item B<SendNotification> I<true|false>
6243 If set to true, OVS link notifications (interface status and OVS DB connection
6244 terminate) are sent to collectd. Default value is true.
6246 =item B<DispatchValues> I<true|false>
6248 Dispatch the OVS DB interface link status value with configured plugin interval.
6249 Defaults to false. Please note, if B<SendNotification> and B<DispatchValues>
6250 options are false, no OVS information will be provided by the plugin.
6254 B<Note:> By default, the global interval setting is used within which to
6255 retrieve the OVS link status. To configure a plugin-specific interval, please
6256 use B<Interval> option of the OVS B<LoadPlugin> block settings. For milliseconds
6257 simple divide the time by 1000 for example if the desired interval is 50ms, set
6260 =head2 Plugin C<ovs_stats>
6262 The I<ovs_stats> plugin collects statistics of OVS connected interfaces.
6263 This plugin uses OVSDB management protocol (RFC7047) monitor mechanism to get
6264 statistics from OVSDB
6268 <Plugin "ovs_stats">
6271 Socket "/var/run/openvswitch/db.sock"
6272 Bridges "br0" "br_ext"
6275 The plugin provides the following configuration options:
6279 =item B<Address> I<node>
6281 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6282 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6283 option. See L<ovsdb-server(1)> for more details. The option may be either
6284 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6285 format. Defaults to C<localhost>.
6287 =item B<Port> I<service>
6289 TCP-port to connect to. Either a service name or a port number may be given.
6290 Defaults to B<6640>.
6292 =item B<Socket> I<path>
6294 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6295 plugin. To enable the interface, the OVS DB daemon should be running with
6296 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6297 option is set, B<Address> and B<Port> options are ignored.
6299 =item B<Bridges> [I<brname> ...]
6301 List of OVS bridge names to be monitored by this plugin. If this option is
6302 omitted or is empty then all OVS bridges will be monitored.
6304 Default: empty (monitor all bridges)
6308 =head2 Plugin C<pcie_errors>
6310 The I<pcie_errors> plugin collects PCI Express errors from Device Status in Capability
6311 structure and from Advanced Error Reporting Extended Capability where available.
6312 At every read it polls config space of PCI Express devices and dispatches
6313 notification for every error that is set. It checks for new errors at every read.
6314 The device is indicated in plugin_instance according to format "domain:bus:dev.fn".
6315 Errors are divided into categories indicated by type_instance: "correctable", and
6316 for uncorrectable errors "non_fatal" or "fatal".
6317 Fatal errors are reported as I<NOTIF_FAILURE> and all others as I<NOTIF_WARNING>.
6321 <Plugin "pcie_errors">
6323 AccessDir "/sys/bus/pci"
6325 PersistentNotifications false
6332 =item B<Source> B<sysfs>|B<proc>
6334 Use B<sysfs> or B<proc> to read data from /sysfs or /proc.
6335 The default value is B<sysfs>.
6337 =item B<AccessDir> I<dir>
6339 Directory used to access device config space. It is optional and defaults to
6340 /sys/bus/pci for B<sysfs> and to /proc/bus/pci for B<proc>.
6342 =item B<ReportMasked> B<false>|B<true>
6344 If true plugin will notify about errors that are set to masked in Error Mask register.
6345 Such errors are not reported to the PCI Express Root Complex. Defaults to B<false>.
6347 =item B<PersistentNotifications> B<false>|B<true>
6349 If false plugin will dispatch notification only on set/clear of error.
6350 The ones already reported will be ignored. Defaults to B<false>.
6354 =head2 Plugin C<perl>
6356 This plugin embeds a Perl-interpreter into collectd and provides an interface
6357 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
6359 =head2 Plugin C<pinba>
6361 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
6362 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
6363 PHP-based webpage has been delivered, the extension will send a UDP packet
6364 containing timing information, peak memory usage and so on. The plugin will
6365 wait for such packets, parse them and account the provided information, which
6366 is then dispatched to the daemon once per interval.
6373 # Overall statistics for the website.
6375 Server "www.example.com"
6377 # Statistics for www-a only
6379 Host "www-a.example.com"
6380 Server "www.example.com"
6382 # Statistics for www-b only
6384 Host "www-b.example.com"
6385 Server "www.example.com"
6389 The plugin provides the following configuration options:
6393 =item B<Address> I<Node>
6395 Configures the address used to open a listening socket. By default, plugin will
6396 bind to the I<any> address C<::0>.
6398 =item B<Port> I<Service>
6400 Configures the port (service) to bind to. By default the default Pinba port
6401 "30002" will be used. The option accepts service names in addition to port
6402 numbers and thus requires a I<string> argument.
6404 =item E<lt>B<View> I<Name>E<gt> block
6406 The packets sent by the Pinba extension include the hostname of the server, the
6407 server name (the name of the virtual host) and the script that was executed.
6408 Using B<View> blocks it is possible to separate the data into multiple groups
6409 to get more meaningful statistics. Each packet is added to all matching groups,
6410 so that a packet may be accounted for more than once.
6414 =item B<Host> I<Host>
6416 Matches the hostname of the system the webserver / script is running on. This
6417 will contain the result of the L<gethostname(2)> system call. If not
6418 configured, all hostnames will be accepted.
6420 =item B<Server> I<Server>
6422 Matches the name of the I<virtual host>, i.e. the contents of the
6423 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
6424 server names will be accepted.
6426 =item B<Script> I<Script>
6428 Matches the name of the I<script name>, i.e. the contents of the
6429 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
6430 script names will be accepted.
6436 =head2 Plugin C<ping>
6438 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
6439 configured hosts periodically and measures the network latency. Whenever the
6440 C<read> function of the plugin is called, it submits the average latency, the
6441 standard deviation and the drop rate for each host.
6443 Available configuration options:
6447 =item B<Host> I<IP-address>
6449 Host to ping periodically. This option may be repeated several times to ping
6452 =item B<Interval> I<Seconds>
6454 Sets the interval in which to send ICMP echo packets to the configured hosts.
6455 This is B<not> the interval in which metrics are read from the plugin but the
6456 interval in which the hosts are "pinged". Therefore, the setting here should be
6457 smaller than or equal to the global B<Interval> setting. Fractional times, such
6458 as "1.24" are allowed.
6462 =item B<Timeout> I<Seconds>
6464 Time to wait for a response from the host to which an ICMP packet had been
6465 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
6466 to be down or the packet to be dropped. This setting must be smaller than the
6467 B<Interval> setting above for the plugin to work correctly. Fractional
6468 arguments are accepted.
6472 =item B<TTL> I<0-255>
6474 Sets the Time-To-Live of generated ICMP packets.
6476 =item B<Size> I<size>
6478 Sets the size of the data payload in ICMP packet to specified I<size> (it
6479 will be filled with regular ASCII pattern). If not set, default 56 byte
6480 long string is used so that the packet size of an ICMPv4 packet is exactly
6481 64 bytes, similar to the behaviour of normal ping(1) command.
6483 =item B<SourceAddress> I<host>
6485 Sets the source address to use. I<host> may either be a numerical network
6486 address or a network hostname.
6488 =item B<AddressFamily> I<af>
6490 Sets the address family to use. I<af> may be "any", "ipv4" or "ipv6". This
6491 option will be ignored if you set a B<SourceAddress>.
6493 =item B<Device> I<name>
6495 Sets the outgoing network device to be used. I<name> has to specify an
6496 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
6499 =item B<MaxMissed> I<Packets>
6501 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
6502 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
6504 Default: B<-1> (disabled)
6508 =head2 Plugin C<postgresql>
6510 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
6511 keeps a persistent connection to all configured databases and tries to
6512 reconnect if the connection has been interrupted. A database is configured by
6513 specifying a B<Database> block as described below. The default statistics are
6514 collected from PostgreSQL's B<statistics collector> which thus has to be
6515 enabled for this plugin to work correctly. This should usually be the case by
6516 default. See the section "The Statistics Collector" of the B<PostgreSQL
6517 Documentation> for details.
6519 By specifying custom database queries using a B<Query> block as described
6520 below, you may collect any data that is available from some PostgreSQL
6521 database. This way, you are able to access statistics of external daemons
6522 which are available in a PostgreSQL database or use future or special
6523 statistics provided by PostgreSQL without the need to upgrade your collectd
6526 Starting with version 5.2, the C<postgresql> plugin supports writing data to
6527 PostgreSQL databases as well. This has been implemented in a generic way. You
6528 need to specify an SQL statement which will then be executed by collectd in
6529 order to write the data (see below for details). The benefit of that approach
6530 is that there is no fixed database layout. Rather, the layout may be optimized
6531 for the current setup.
6533 The B<PostgreSQL Documentation> manual can be found at
6534 L<http://www.postgresql.org/docs/manuals/>.
6538 Statement "SELECT magic FROM wizard WHERE host = $1;"
6542 InstancePrefix "magic"
6547 <Query rt36_tickets>
6548 Statement "SELECT COUNT(type) AS count, type \
6550 WHEN resolved = 'epoch' THEN 'open' \
6551 ELSE 'resolved' END AS type \
6552 FROM tickets) type \
6556 InstancePrefix "rt36_tickets"
6557 InstancesFrom "type"
6563 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
6574 KRBSrvName "kerberos_service_name"
6580 Service "service_name"
6581 Query backends # predefined
6592 The B<Query> block defines one database query which may later be used by a
6593 database definition. It accepts a single mandatory argument which specifies
6594 the name of the query. The names of all queries have to be unique (see the
6595 B<MinVersion> and B<MaxVersion> options below for an exception to this
6598 In each B<Query> block, there is one or more B<Result> blocks. Multiple
6599 B<Result> blocks may be used to extract multiple values from a single query.
6601 The following configuration options are available to define the query:
6605 =item B<Statement> I<sql query statement>
6607 Specify the I<sql query statement> which the plugin should execute. The string
6608 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
6609 first, second, etc. parameter. The value of the parameters is specified by the
6610 B<Param> configuration option - see below for details. To include a literal
6611 B<$> character followed by a number, surround it with single quotes (B<'>).
6613 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
6614 allowed. Note, however, that only a single command may be used. Semicolons are
6615 allowed as long as a single non-empty command has been specified only.
6617 The returned lines will be handled separately one after another.
6619 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
6621 Specify the parameters which should be passed to the SQL query. The parameters
6622 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
6623 they appear in the configuration file. The value of the parameter is
6624 determined depending on the value of the B<Param> option as follows:
6630 The configured hostname of the database connection. If a UNIX domain socket is
6631 used, the parameter expands to "localhost".
6635 The name of the database of the current connection.
6639 The name of the database plugin instance. See the B<Instance> option of the
6640 database specification below for details.
6644 The username used to connect to the database.
6648 The interval with which this database is queried (as specified by the database
6649 specific or global B<Interval> options).
6653 Please note that parameters are only supported by PostgreSQL's protocol
6654 version 3 and above which was introduced in version 7.4 of PostgreSQL.
6656 =item B<PluginInstanceFrom> I<column>
6658 Specify how to create the "PluginInstance" for reporting this query results.
6659 Only one column is supported. You may concatenate fields and string values in
6660 the query statement to get the required results.
6662 =item B<MinVersion> I<version>
6664 =item B<MaxVersion> I<version>
6666 Specify the minimum or maximum version of PostgreSQL that this query should be
6667 used with. Some statistics might only be available with certain versions of
6668 PostgreSQL. This allows you to specify multiple queries with the same name but
6669 which apply to different versions, thus allowing you to use the same
6670 configuration in a heterogeneous environment.
6672 The I<version> has to be specified as the concatenation of the major, minor
6673 and patch-level versions, each represented as two-decimal-digit numbers. For
6674 example, version 8.2.3 will become 80203.
6678 The B<Result> block defines how to handle the values returned from the query.
6679 It defines which column holds which value and how to dispatch that value to
6684 =item B<Type> I<type>
6686 The I<type> name to be used when dispatching the values. The type describes
6687 how to handle the data and where to store it. See L<types.db(5)> for more
6688 details on types and their configuration. The number and type of values (as
6689 selected by the B<ValuesFrom> option) has to match the type of the given name.
6691 This option is mandatory.
6693 =item B<InstancePrefix> I<prefix>
6695 =item B<InstancesFrom> I<column0> [I<column1> ...]
6697 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
6698 B<InstancePrefix> defines a static prefix that will be prepended to all type
6699 instances. B<InstancesFrom> defines the column names whose values will be used
6700 to create the type instance. Multiple values will be joined together using the
6701 hyphen (C<->) as separation character.
6703 The plugin itself does not check whether or not all built instances are
6704 different. It is your responsibility to assure that each is unique.
6706 Both options are optional. If none is specified, the type instance will be
6709 =item B<ValuesFrom> I<column0> [I<column1> ...]
6711 Names the columns whose content is used as the actual data for the data sets
6712 that are dispatched to the daemon. How many such columns you need is
6713 determined by the B<Type> setting as explained above. If you specify too many
6714 or not enough columns, the plugin will complain about that and no data will be
6715 submitted to the daemon.
6717 The actual data type, as seen by PostgreSQL, is not that important as long as
6718 it represents numbers. The plugin will automatically cast the values to the
6719 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
6720 L<strtod(3)> functions, so anything supported by those functions is supported
6721 by the plugin as well.
6723 This option is required inside a B<Result> block and may be specified multiple
6724 times. If multiple B<ValuesFrom> options are specified, the columns are read
6729 The following predefined queries are available (the definitions can be found
6730 in the F<postgresql_default.conf> file which, by default, is available at
6731 C<I<prefix>/share/collectd/>):
6737 This query collects the number of backends, i.E<nbsp>e. the number of
6740 =item B<transactions>
6742 This query collects the numbers of committed and rolled-back transactions of
6747 This query collects the numbers of various table modifications (i.E<nbsp>e.
6748 insertions, updates, deletions) of the user tables.
6750 =item B<query_plans>
6752 This query collects the numbers of various table scans and returned tuples of
6755 =item B<table_states>
6757 This query collects the numbers of live and dead rows in the user tables.
6761 This query collects disk block access counts for user tables.
6765 This query collects the on-disk size of the database in bytes.
6769 In addition, the following detailed queries are available by default. Please
6770 note that each of those queries collects information B<by table>, thus,
6771 potentially producing B<a lot> of data. For details see the description of the
6772 non-by_table queries above.
6776 =item B<queries_by_table>
6778 =item B<query_plans_by_table>
6780 =item B<table_states_by_table>
6782 =item B<disk_io_by_table>
6786 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
6787 mandatory argument specifying the name of the writer. This will then be used
6788 in the B<Database> specification in order to activate the writer instance. The
6789 names of all writers have to be unique. The following options may be
6794 =item B<Statement> I<sql statement>
6796 This mandatory option specifies the SQL statement that will be executed for
6797 each submitted value. A single SQL statement is allowed only. Anything after
6798 the first semicolon will be ignored.
6800 Nine parameters will be passed to the statement and should be specified as
6801 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
6802 values are made available through those parameters:
6808 The timestamp of the queried value as an RFC 3339-formatted local time.
6812 The hostname of the queried value.
6816 The plugin name of the queried value.
6820 The plugin instance of the queried value. This value may be B<NULL> if there
6821 is no plugin instance.
6825 The type of the queried value (cf. L<types.db(5)>).
6829 The type instance of the queried value. This value may be B<NULL> if there is
6834 An array of names for the submitted values (i.E<nbsp>e., the name of the data
6835 sources of the submitted value-list).
6839 An array of types for the submitted values (i.E<nbsp>e., the type of the data
6840 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
6841 B<StoreRates> is enabled (which is the default, see below), all types will be
6846 An array of the submitted values. The dimensions of the value name and value
6851 In general, it is advisable to create and call a custom function in the
6852 PostgreSQL database for this purpose. Any procedural language supported by
6853 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
6856 =item B<StoreRates> B<false>|B<true>
6858 If set to B<true> (the default), convert counter values to rates. If set to
6859 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6864 The B<Database> block defines one PostgreSQL database for which to collect
6865 statistics. It accepts a single mandatory argument which specifies the
6866 database name. None of the other options are required. PostgreSQL will use
6867 default values as documented in the section "CONNECTING TO A DATABASE" in the
6868 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
6869 the user collectd is run as and special environment variables. See the manpage
6874 =item B<Interval> I<seconds>
6876 Specify the interval with which the database should be queried. The default is
6877 to use the global B<Interval> setting.
6879 =item B<CommitInterval> I<seconds>
6881 This option may be used for database connections which have "writers" assigned
6882 (see above). If specified, it causes a writer to put several updates into a
6883 single transaction. This transaction will last for the specified amount of
6884 time. By default, each update will be executed in a separate transaction. Each
6885 transaction generates a fair amount of overhead which can, thus, be reduced by
6886 activating this option. The draw-back is, that data covering the specified
6887 amount of time will be lost, for example, if a single statement within the
6888 transaction fails or if the database server crashes.
6890 =item B<Plugin> I<Plugin>
6892 Use I<Plugin> as the plugin name when submitting query results from
6893 this B<Database>. Defaults to C<postgresql>.
6895 =item B<Instance> I<name>
6897 Specify the plugin instance name that should be used instead of the database
6898 name (which is the default, if this option has not been specified). This
6899 allows one to query multiple databases of the same name on the same host (e.g.
6900 when running multiple database server versions in parallel).
6901 The plugin instance name can also be set from the query result using
6902 the B<PluginInstanceFrom> option in B<Query> block.
6904 =item B<Host> I<hostname>
6906 Specify the hostname or IP of the PostgreSQL server to connect to. If the
6907 value begins with a slash, it is interpreted as the directory name in which to
6908 look for the UNIX domain socket.
6910 This option is also used to determine the hostname that is associated with a
6911 collected data set. If it has been omitted or either begins with with a slash
6912 or equals B<localhost> it will be replaced with the global hostname definition
6913 of collectd. Any other value will be passed literally to collectd when
6914 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
6916 =item B<Port> I<port>
6918 Specify the TCP port or the local UNIX domain socket file extension of the
6921 =item B<User> I<username>
6923 Specify the username to be used when connecting to the server.
6925 =item B<Password> I<password>
6927 Specify the password to be used when connecting to the server.
6929 =item B<ExpireDelay> I<delay>
6931 Skip expired values in query output.
6933 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
6935 Specify whether to use an SSL connection when contacting the server. The
6936 following modes are supported:
6942 Do not use SSL at all.
6946 First, try to connect without using SSL. If that fails, try using SSL.
6948 =item I<prefer> (default)
6950 First, try to connect using SSL. If that fails, try without using SSL.
6958 =item B<Instance> I<name>
6960 Specify the plugin instance name that should be used instead of the database
6961 name (which is the default, if this option has not been specified). This
6962 allows one to query multiple databases of the same name on the same host (e.g.
6963 when running multiple database server versions in parallel).
6965 =item B<KRBSrvName> I<kerberos_service_name>
6967 Specify the Kerberos service name to use when authenticating with Kerberos 5
6968 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
6969 B<PostgreSQL Documentation> for details.
6971 =item B<Service> I<service_name>
6973 Specify the PostgreSQL service name to use for additional parameters. That
6974 service has to be defined in F<pg_service.conf> and holds additional
6975 connection parameters. See the section "The Connection Service File" in the
6976 B<PostgreSQL Documentation> for details.
6978 =item B<Query> I<query>
6980 Specifies a I<query> which should be executed in the context of the database
6981 connection. This may be any of the predefined or user-defined queries. If no
6982 such option is given, it defaults to "backends", "transactions", "queries",
6983 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
6984 has been specified). Else, the specified queries are used only.
6986 =item B<Writer> I<writer>
6988 Assigns the specified I<writer> backend to the database connection. This
6989 causes all collected data to be send to the database using the settings
6990 defined in the writer configuration (see the section "FILTER CONFIGURATION"
6991 below for details on how to selectively send data to certain plugins).
6993 Each writer will register a flush callback which may be used when having long
6994 transactions enabled (see the B<CommitInterval> option above). When issuing
6995 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
6996 transaction will be committed right away. Two different kinds of flush
6997 callbacks are available with the C<postgresql> plugin:
7003 Flush all writer backends.
7005 =item B<postgresql->I<database>
7007 Flush all writers of the specified I<database> only.
7013 =head2 Plugin C<powerdns>
7015 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
7016 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
7017 values, many of which are probably meaningless to most users, but may be useful
7018 for some. So you may chose which values to collect, but if you don't, some
7019 reasonable defaults will be collected.
7022 <Server "server_name">
7024 Collect "udp-answers" "udp-queries"
7025 Socket "/var/run/pdns.controlsocket"
7027 <Recursor "recursor_name">
7029 Collect "cache-hits" "cache-misses"
7030 Socket "/var/run/pdns_recursor.controlsocket"
7032 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
7037 =item B<Server> and B<Recursor> block
7039 The B<Server> block defines one authoritative server to query, the B<Recursor>
7040 does the same for an recursing server. The possible options in both blocks are
7041 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
7046 =item B<Collect> I<Field>
7048 Using the B<Collect> statement you can select which values to collect. Here,
7049 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
7050 C<dlg-only-drops>, C<answers10-100>.
7052 The method of getting the values differs for B<Server> and B<Recursor> blocks:
7053 When querying the server a C<SHOW *> command is issued in any case, because
7054 that's the only way of getting multiple values out of the server at once.
7055 collectd then picks out the values you have selected. When querying the
7056 recursor, a command is generated to query exactly these values. So if you
7057 specify invalid fields when querying the recursor, a syntax error may be
7058 returned by the daemon and collectd may not collect any values at all.
7060 If no B<Collect> statement is given, the following B<Server> values will be
7067 =item packetcache-hit
7069 =item packetcache-miss
7071 =item packetcache-size
7073 =item query-cache-hit
7075 =item query-cache-miss
7077 =item recursing-answers
7079 =item recursing-questions
7091 The following B<Recursor> values will be collected by default:
7095 =item noerror-answers
7097 =item nxdomain-answers
7099 =item servfail-answers
7117 Please note that up to that point collectd doesn't know what values are
7118 available on the server and values that are added do not need a change of the
7119 mechanism so far. However, the values must be mapped to collectd's naming
7120 scheme, which is done using a lookup table that lists all known values. If
7121 values are added in the future and collectd does not know about them, you will
7122 get an error much like this:
7124 powerdns plugin: submit: Not found in lookup table: foobar = 42
7126 In this case please file a bug report with the collectd team.
7128 =item B<Socket> I<Path>
7130 Configures the path to the UNIX domain socket to be used when connecting to the
7131 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
7132 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
7133 will be used for the recursor.
7137 =item B<LocalSocket> I<Path>
7139 Querying the recursor is done using UDP. When using UDP over UNIX domain
7140 sockets, the client socket needs a name in the file system, too. You can set
7141 this local name to I<Path> using the B<LocalSocket> option. The default is
7142 C<I<prefix>/var/run/collectd-powerdns>.
7146 =head2 Plugin C<processes>
7148 Collects information about processes of local system.
7150 By default, with no process matches configured, only general statistics is
7151 collected: the number of processes in each state and fork rate.
7153 Process matches can be configured by B<Process> and B<ProcessMatch> options.
7154 These may also be a block in which further options may be specified.
7156 The statistics collected for matched processes are:
7157 - size of the resident segment size (RSS)
7158 - user- and system-time used
7159 - number of processes
7161 - number of open files (under Linux)
7162 - number of memory mapped files (under Linux)
7163 - io data (where available)
7164 - context switches (under Linux)
7165 - minor and major pagefaults
7166 - Delay Accounting information (Linux only, requires libmnl)
7171 CollectFileDescriptor true
7172 CollectContextSwitch true
7173 CollectDelayAccounting false
7175 ProcessMatch "name" "regex"
7176 <Process "collectd">
7177 CollectFileDescriptor false
7178 CollectContextSwitch false
7179 CollectDelayAccounting true
7181 <ProcessMatch "name" "regex">
7182 CollectFileDescriptor false
7183 CollectContextSwitch true
7189 =item B<Process> I<Name>
7191 Select more detailed statistics of processes matching this name.
7193 Some platforms have a limit on the length of process names.
7194 I<Name> must stay below this limit.
7196 =item B<ProcessMatch> I<name> I<regex>
7198 Select more detailed statistics of processes matching the specified I<regex>
7199 (see L<regex(7)> for details). The statistics of all matching processes are
7200 summed up and dispatched to the daemon using the specified I<name> as an
7201 identifier. This allows one to "group" several processes together.
7202 I<name> must not contain slashes.
7204 =item B<CollectContextSwitch> I<Boolean>
7206 Collect the number of context switches for matched processes.
7207 Disabled by default.
7209 =item B<CollectDelayAccounting> I<Boolean>
7211 If enabled, collect Linux Delay Accounding information for matching processes.
7212 Delay Accounting provides the time processes wait for the CPU to become
7213 available, for I/O operations to finish, for pages to be swapped in and for
7214 freed pages to be reclaimed. The metrics are reported as "seconds per second"
7215 using the C<delay_rate> type, e.g. C<delay_rate-delay-cpu>.
7216 Disabled by default.
7218 This option is only available on Linux, requires the C<libmnl> library and
7219 requires the C<CAP_NET_ADMIN> capability at runtime.
7221 =item B<CollectFileDescriptor> I<Boolean>
7223 Collect number of file descriptors of matched processes.
7224 Disabled by default.
7226 =item B<CollectMemoryMaps> I<Boolean>
7228 Collect the number of memory mapped files of the process.
7229 The limit for this number is configured via F</proc/sys/vm/max_map_count> in
7234 The B<CollectContextSwitch>, B<CollectDelayAccounting>,
7235 B<CollectFileDescriptor> and B<CollectMemoryMaps> options may be used inside
7236 B<Process> and B<ProcessMatch> blocks. When used there, these options affect
7237 reporting the corresponding processes only. Outside of B<Process> and
7238 B<ProcessMatch> blocks these options set the default value for subsequent
7241 =head2 Plugin C<protocols>
7243 Collects a lot of information about various network protocols, such as I<IP>,
7244 I<TCP>, I<UDP>, etc.
7246 Available configuration options:
7250 =item B<Value> I<Selector>
7252 Selects whether or not to select a specific value. The string being matched is
7253 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
7254 plugin instance and I<ValueName> will be used as type instance. An example of
7255 the string being used would be C<Tcp:RetransSegs>.
7257 You can use regular expressions to match a large number of values with just one
7258 configuration option. To select all "extended" I<TCP> values, you could use the
7259 following statement:
7263 Whether only matched values are selected or all matched values are ignored
7264 depends on the B<IgnoreSelected>. By default, only matched values are selected.
7265 If no value is configured at all, all values will be selected.
7267 See F</"IGNORELISTS"> for details.
7269 =item B<IgnoreSelected> B<true>|B<false>
7271 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
7272 matching values will be ignored.
7276 =head2 Plugin C<python>
7278 This plugin embeds a Python-interpreter into collectd and provides an interface
7279 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
7281 =head2 Plugin C<routeros>
7283 The C<routeros> plugin connects to a device running I<RouterOS>, the
7284 Linux-based operating system for routers by I<MikroTik>. The plugin uses
7285 I<librouteros> to connect and reads information about the interfaces and
7286 wireless connections of the device. The configuration supports querying
7291 Host "router0.example.com"
7294 CollectInterface true
7299 Host "router1.example.com"
7302 CollectInterface true
7303 CollectRegistrationTable true
7310 As you can see above, the configuration of the I<routeros> plugin consists of
7311 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
7312 options are understood:
7316 =item B<Host> I<Host>
7318 Hostname or IP-address of the router to connect to.
7320 =item B<Port> I<Port>
7322 Port name or port number used when connecting. If left unspecified, the default
7323 will be chosen by I<librouteros>, currently "8728". This option expects a
7324 string argument, even when a numeric port number is given.
7326 =item B<User> I<User>
7328 Use the user name I<User> to authenticate. Defaults to "admin".
7330 =item B<Password> I<Password>
7332 Set the password used to authenticate.
7334 =item B<CollectInterface> B<true>|B<false>
7336 When set to B<true>, interface statistics will be collected for all interfaces
7337 present on the device. Defaults to B<false>.
7339 =item B<CollectRegistrationTable> B<true>|B<false>
7341 When set to B<true>, information about wireless LAN connections will be
7342 collected. Defaults to B<false>.
7344 =item B<CollectCPULoad> B<true>|B<false>
7346 When set to B<true>, information about the CPU usage will be collected. The
7347 number is a dimensionless value where zero indicates no CPU usage at all.
7348 Defaults to B<false>.
7350 =item B<CollectMemory> B<true>|B<false>
7352 When enabled, the amount of used and free memory will be collected. How used
7353 memory is calculated is unknown, for example whether or not caches are counted
7355 Defaults to B<false>.
7357 =item B<CollectDF> B<true>|B<false>
7359 When enabled, the amount of used and free disk space will be collected.
7360 Defaults to B<false>.
7362 =item B<CollectDisk> B<true>|B<false>
7364 When enabled, the number of sectors written and bad blocks will be collected.
7365 Defaults to B<false>.
7367 =item B<CollectHealth> B<true>|B<false>
7369 When enabled, the health statistics will be collected. This includes the
7370 voltage and temperature on supported hardware.
7371 Defaults to B<false>.
7375 =head2 Plugin C<redis>
7377 The I<Redis plugin> connects to one or more Redis servers, gathers
7378 information about each server's state and executes user-defined queries.
7379 For each server there is a I<Node> block which configures the connection
7380 parameters and set of user-defined queries for this node.
7386 #Socket "/var/run/redis/redis.sock"
7388 ReportCommandStats false
7390 <Query "LLEN myqueue">
7400 =item B<Node> I<Nodename>
7402 The B<Node> block identifies a new Redis node, that is a new Redis instance
7403 running in an specified host and port. The name for node is a canonical
7404 identifier which is used as I<plugin instance>. It is limited to
7405 128E<nbsp>characters in length.
7407 When no B<Node> is configured explicitly, plugin connects to "localhost:6379".
7409 =item B<Host> I<Hostname>
7411 The B<Host> option is the hostname or IP-address where the Redis instance is
7414 =item B<Port> I<Port>
7416 The B<Port> option is the TCP port on which the Redis instance accepts
7417 connections. Either a service name of a port number may be given. Please note
7418 that numerical port numbers must be given as a string, too.
7420 =item B<Socket> I<Path>
7422 Connect to Redis using the UNIX domain socket at I<Path>. If this
7423 setting is given, the B<Hostname> and B<Port> settings are ignored.
7425 =item B<Password> I<Password>
7427 Use I<Password> to authenticate when connecting to I<Redis>.
7429 =item B<Timeout> I<Milliseconds>
7431 The B<Timeout> option set the socket timeout for node response. Since the Redis
7432 read function is blocking, you should keep this value as low as possible.
7433 It is expected what B<Timeout> values should be lower than B<Interval> defined
7436 Defaults to 2000 (2 seconds).
7438 =item B<ReportCommandStats> B<false>|B<true>
7440 Enables or disables reporting of statistics based on the command type, including
7441 rate of command calls and average CPU time consumed by command processing.
7442 Defaults to B<false>.
7444 =item B<ReportCpuUsage> B<true>|B<false>
7446 Enables or disables reporting of CPU consumption statistics.
7447 Defaults to B<true>.
7449 =item B<Query> I<Querystring>
7451 The B<Query> block identifies a query to execute against the redis server.
7452 There may be an arbitrary number of queries to execute. Each query should
7453 return single string or integer.
7455 =item B<Type> I<Collectd type>
7457 Within a query definition, a valid I<collectd type> to use as when submitting
7458 the result of the query. When not supplied, will default to B<gauge>.
7460 Currently only types with one datasource are supported.
7461 See L<types.db(5)> for more details on types and their configuration.
7463 =item B<Instance> I<Type instance>
7465 Within a query definition, an optional type instance to use when submitting
7466 the result of the query. When not supplied will default to the escaped
7467 command, up to 128 chars.
7469 =item B<Database> I<Index>
7471 This index selects the Redis logical database to use for query. Defaults
7476 =head2 Plugin C<rrdcached>
7478 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
7479 to store values to RRD files in an efficient manner. The combination of the
7480 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
7481 way the C<rrdtool> plugin works (see below). The added abstraction layer
7482 provides a number of benefits, though: Because the cache is not within
7483 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
7484 restarted. This results in much shorter (if any) gaps in graphs, especially
7485 under heavy load. Also, the C<rrdtool> command line utility is aware of the
7486 daemon so that it can flush values to disk automatically when needed. This
7487 allows one to integrate automated flushing of values into graphing solutions
7490 There are disadvantages, though: The daemon may reside on a different host, so
7491 it may not be possible for C<collectd> to create the appropriate RRD files
7492 anymore. And even if C<rrdcached> runs on the same host, it may run in a
7493 different base directory, so relative paths may do weird stuff if you're not
7496 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
7497 on the same host, communicating via a UNIX domain socket. The B<DataDir>
7498 setting should be set to an absolute path, so that a changed base directory
7499 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
7503 =item B<DaemonAddress> I<Address>
7505 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
7506 library. See L<rrdcached(1)> for details. Example:
7508 <Plugin "rrdcached">
7509 DaemonAddress "unix:/var/run/rrdcached.sock"
7512 =item B<DataDir> I<Directory>
7514 Set the base directory in which the RRD files reside. If this is a relative
7515 path, it is relative to the working base directory of the C<rrdcached> daemon!
7516 Use of an absolute path is recommended.
7518 =item B<CreateFiles> B<true>|B<false>
7520 Enables or disables the creation of RRD files. If the daemon is not running
7521 locally, or B<DataDir> is set to a relative path, this will not work as
7522 expected. Default is B<true>.
7524 =item B<CreateFilesAsync> B<false>|B<true>
7526 When enabled, new RRD files are enabled asynchronously, using a separate thread
7527 that runs in the background. This prevents writes to block, which is a problem
7528 especially when many hundreds of files need to be created at once. However,
7529 since the purpose of creating the files asynchronously is I<not> to block until
7530 the file is available, values before the file is available will be discarded.
7531 When disabled (the default) files are created synchronously, blocking for a
7532 short while, while the file is being written.
7534 =item B<StepSize> I<Seconds>
7536 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7537 this setting is unset and the stepsize is set to the interval in which the data
7538 is collected. Do not use this option unless you absolutely have to for some
7539 reason. Setting this option may cause problems with the C<snmp plugin>, the
7540 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7542 =item B<HeartBeat> I<Seconds>
7544 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7545 in which case the heartbeat is set to twice the B<StepSize> which should equal
7546 the interval in which data is collected. Do not set this option unless you have
7547 a very good reason to do so.
7549 =item B<RRARows> I<NumRows>
7551 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7552 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7553 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7554 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7555 week, one month, and one year.
7557 So for each timespan, it calculates how many PDPs need to be consolidated into
7558 one CDP by calculating:
7559 number of PDPs = timespan / (stepsize * rrarows)
7561 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7564 =item B<RRATimespan> I<Seconds>
7566 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7567 more then one RRA. If this option is never used, the built-in default of (3600,
7568 86400, 604800, 2678400, 31622400) is used.
7570 For more information on how RRA-sizes are calculated see B<RRARows> above.
7572 =item B<XFF> I<Factor>
7574 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7575 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7578 =item B<CollectStatistics> B<false>|B<true>
7580 When set to B<true>, various statistics about the I<rrdcached> daemon will be
7581 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
7583 Statistics are read via I<rrdcached>s socket using the STATS command.
7584 See L<rrdcached(1)> for details.
7588 =head2 Plugin C<rrdtool>
7590 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
7591 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
7592 using these settings. If you don't want to dive into the depths of RRDtool, you
7593 can safely ignore these settings.
7597 =item B<DataDir> I<Directory>
7599 Set the directory to store RRD files under. By default RRD files are generated
7600 beneath the daemon's working directory, i.e. the B<BaseDir>.
7602 =item B<CreateFilesAsync> B<false>|B<true>
7604 When enabled, new RRD files are enabled asynchronously, using a separate thread
7605 that runs in the background. This prevents writes to block, which is a problem
7606 especially when many hundreds of files need to be created at once. However,
7607 since the purpose of creating the files asynchronously is I<not> to block until
7608 the file is available, values before the file is available will be discarded.
7609 When disabled (the default) files are created synchronously, blocking for a
7610 short while, while the file is being written.
7612 =item B<StepSize> I<Seconds>
7614 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7615 this setting is unset and the stepsize is set to the interval in which the data
7616 is collected. Do not use this option unless you absolutely have to for some
7617 reason. Setting this option may cause problems with the C<snmp plugin>, the
7618 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7620 =item B<HeartBeat> I<Seconds>
7622 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7623 in which case the heartbeat is set to twice the B<StepSize> which should equal
7624 the interval in which data is collected. Do not set this option unless you have
7625 a very good reason to do so.
7627 =item B<RRARows> I<NumRows>
7629 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7630 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7631 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7632 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7633 week, one month, and one year.
7635 So for each timespan, it calculates how many PDPs need to be consolidated into
7636 one CDP by calculating:
7637 number of PDPs = timespan / (stepsize * rrarows)
7639 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7642 =item B<RRATimespan> I<Seconds>
7644 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7645 more then one RRA. If this option is never used, the built-in default of (3600,
7646 86400, 604800, 2678400, 31622400) is used.
7648 For more information on how RRA-sizes are calculated see B<RRARows> above.
7650 =item B<XFF> I<Factor>
7652 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7653 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7656 =item B<CacheFlush> I<Seconds>
7658 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
7659 it writes all values for a certain RRD-file if the oldest value is older than
7660 (or equal to) the number of seconds specified by B<CacheTimeout>.
7661 That check happens on new values arriwal. If some RRD-file is not updated
7662 anymore for some reason (the computer was shut down, the network is broken,
7663 etc.) some values may still be in the cache. If B<CacheFlush> is set, then
7664 every I<Seconds> seconds the entire cache is searched for entries older than
7665 B<CacheTimeout> + B<RandomTimeout> seconds. The entries found are written to
7666 disk. Since scanning the entire cache is kind of expensive and does nothing
7667 under normal circumstances, this value should not be too small. 900 seconds
7668 might be a good value, though setting this to 7200 seconds doesn't normally
7669 do much harm either.
7671 Defaults to 10x B<CacheTimeout>.
7672 B<CacheFlush> must be larger than or equal to B<CacheTimeout>, otherwise the
7673 above default is used.
7675 =item B<CacheTimeout> I<Seconds>
7677 If this option is set to a value greater than zero, the C<rrdtool plugin> will
7678 save values in a cache, as described above. Writing multiple values at once
7679 reduces IO-operations and thus lessens the load produced by updating the files.
7680 The trade off is that the graphs kind of "drag behind" and that more memory is
7683 =item B<WritesPerSecond> I<Updates>
7685 When collecting many statistics with collectd and the C<rrdtool> plugin, you
7686 will run serious performance problems. The B<CacheFlush> setting and the
7687 internal update queue assert that collectd continues to work just fine even
7688 under heavy load, but the system may become very unresponsive and slow. This is
7689 a problem especially if you create graphs from the RRD files on the same
7690 machine, for example using the C<graph.cgi> script included in the
7691 C<contrib/collection3/> directory.
7693 This setting is designed for very large setups. Setting this option to a value
7694 between 25 and 80 updates per second, depending on your hardware, will leave
7695 the server responsive enough to draw graphs even while all the cached values
7696 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
7697 by the B<FLUSH> command, are B<not> effected by this limit. They are still
7698 written as fast as possible, so that web frontends have up to date data when
7701 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
7702 updates per second, writing all values to disk will take approximately
7703 56E<nbsp>minutes. Together with the flushing ability that's integrated into
7704 "collection3" you'll end up with a responsive and fast system, up to date
7705 graphs and basically a "backup" of your values every hour.
7707 =item B<RandomTimeout> I<Seconds>
7709 When set, the actual timeout for each value is chosen randomly between
7710 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
7711 intention is to avoid high load situations that appear when many values timeout
7712 at the same time. This is especially a problem shortly after the daemon starts,
7713 because all values were added to the internal cache at roughly the same time.
7717 =head2 Plugin C<sensors>
7719 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
7720 that all the needed modules have to be loaded and lm_sensors has to be
7721 configured (most likely by editing F</etc/sensors.conf>. Read
7722 L<sensors.conf(5)> for details.
7724 The B<lm_sensors> homepage can be found at
7725 L<http://secure.netroedge.com/~lm78/>.
7729 =item B<SensorConfigFile> I<File>
7731 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
7732 the library's default will be used.
7734 =item B<Sensor> I<chip-bus-address/type-feature>
7736 Selects the name of the sensor which you want to collect or ignore, depending
7737 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
7738 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
7739 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
7741 See F</"IGNORELISTS"> for details.
7743 =item B<IgnoreSelected> I<true>|I<false>
7745 If no configuration if given, the B<sensors>-plugin will collect data from all
7746 sensors. This may not be practical, especially for uninteresting sensors.
7747 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
7748 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
7749 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
7750 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
7751 and all other sensors are collected.
7753 =item B<UseLabels> I<true>|I<false>
7755 Configures how sensor readings are reported. When set to I<true>, sensor
7756 readings are reported using their descriptive label (e.g. "VCore"). When set to
7757 I<false> (the default) the sensor name is used ("in0").
7761 =head2 Plugin C<sigrok>
7763 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
7764 supported by the L<sigrok|http://sigrok.org/> project.
7770 <Device "AC Voltage">
7775 <Device "Sound Level">
7776 Driver "cem-dt-885x"
7783 =item B<LogLevel> B<0-5>
7785 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
7786 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
7787 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
7788 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
7789 their level, are always submitted to I<collectd> at its INFO log level.
7791 =item E<lt>B<Device> I<Name>E<gt>
7793 A sigrok-supported device, uniquely identified by this section's options. The
7794 I<Name> is passed to I<collectd> as the I<plugin instance>.
7796 =item B<Driver> I<DriverName>
7798 The sigrok driver to use for this device.
7800 =item B<Conn> I<ConnectionSpec>
7802 If the device cannot be auto-discovered, or more than one might be discovered
7803 by the driver, I<ConnectionSpec> specifies the connection string to the device.
7804 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
7805 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
7806 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
7807 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
7809 =item B<SerialComm> I<SerialSpec>
7811 For serial devices with non-standard port settings, this option can be used
7812 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
7813 This should not be necessary; drivers know how to communicate with devices they
7816 =item B<MinimumInterval> I<Seconds>
7818 Specifies the minimum time between measurement dispatches to I<collectd>, in
7819 seconds. Since some I<sigrok> supported devices can acquire measurements many
7820 times per second, it may be necessary to throttle these. For example, the
7821 I<RRD plugin> cannot process writes more than once per second.
7823 The default B<MinimumInterval> is B<0>, meaning measurements received from the
7824 device are always dispatched to I<collectd>. When throttled, unused
7825 measurements are discarded.
7829 =head2 Plugin C<smart>
7831 The C<smart> plugin collects SMART information from physical
7832 disks. Values collectd include temperature, power cycle count, poweron
7833 time and bad sectors. Also, all SMART attributes are collected along
7834 with the normalized current value, the worst value, the threshold and
7835 a human readable value.
7837 Using the following two options you can ignore some disks or configure the
7838 collection only of specific disks.
7842 =item B<Disk> I<Name>
7844 Select the disk I<Name>. Whether it is collected or ignored depends on the
7845 B<IgnoreSelected> setting, see below. As with other plugins that use the
7846 daemon's ignorelist functionality, a string that starts and ends with a slash
7847 is interpreted as a regular expression. Examples:
7852 See F</"IGNORELISTS"> for details.
7854 =item B<IgnoreSelected> B<true>|B<false>
7856 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
7857 statements, are ignored or if all other disks are ignored. The behavior
7858 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
7859 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
7860 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
7861 is set to B<true>, all disks are collected B<except> the ones matched.
7863 =item B<IgnoreSleepMode> B<true>|B<false>
7865 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
7866 This option disables the sleep mode check and allows the plugin to collect data
7867 from these disks anyway. This is useful in cases where libatasmart mistakenly
7868 reports disks as asleep because it has not been updated to incorporate support
7869 for newer idle states in the ATA spec.
7871 =item B<UseSerial> B<true>|B<false>
7873 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
7874 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
7875 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
7876 storing data. This ensures that the data for a given disk will be kept together
7877 even if the kernel name changes.
7881 =head2 Plugin C<snmp>
7883 Since the configuration of the C<snmp plugin> is a little more complicated than
7884 other plugins, its documentation has been moved to an own manpage,
7885 L<collectd-snmp(5)>. Please see there for details.
7887 =head2 Plugin C<snmp_agent>
7889 The I<snmp_agent> plugin is an AgentX subagent that receives and handles queries
7890 from SNMP master agent and returns the data collected by read plugins.
7891 The I<snmp_agent> plugin handles requests only for OIDs specified in
7892 configuration file. To handle SNMP queries the plugin gets data from collectd
7893 and translates requested values from collectd's internal format to SNMP format.
7894 This plugin is a generic plugin and cannot work without configuration.
7895 For more details on AgentX subagent see
7896 <http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/>
7901 <Data "memAvailReal">
7903 #PluginInstance "some"
7906 OIDs "1.3.6.1.4.1.2021.4.6.0"
7909 IndexOID "IF-MIB::ifIndex"
7910 SizeOID "IF-MIB::ifNumber"
7913 Source "PluginInstance"
7916 OIDs "IF-MIB::ifDescr"
7922 OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
7925 <Table "CPUAffinityTable">
7928 Source "PluginInstance"
7931 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhAffinityDomainName"
7936 Source "TypeInstance"
7937 Regex "^vcpu_([0-9]{1,3})-cpu_[0-9]{1,3}$"
7940 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhVCPUIndex"
7945 Source "TypeInstance"
7946 Regex "^vcpu_[0-9]{1,3}-cpu_([0-9]{1,3})$"
7949 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhCPUIndex"
7951 <Data "CPUAffinity">
7954 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhCPUAffinity"
7959 There are two types of blocks that can be contained in the
7960 C<E<lt>PluginE<nbsp> snmp_agentE<gt>> block: B<Data> and B<Table>:
7962 =head3 B<Data> block
7964 The B<Data> block defines a list OIDs that are to be handled. This block can
7965 define scalar or table OIDs. If B<Data> block is defined inside of B<Table>
7966 block it reperesents table OIDs.
7967 The following options can be set:
7971 =item B<IndexKey> block
7973 B<IndexKey> block contains all data needed for proper index build of snmp table.
7975 one table B<Data> block has B<IndexKey> block present then multiple key index is
7976 built. If B<Data> block defines scalar data type B<IndexKey> has no effect and can
7981 =item B<Source> I<String>
7983 B<Source> can be set to one of the following values: "Hostname", "Plugin",
7984 "PluginInstance", "Type", "TypeInstance". This value indicates which field of
7985 corresponding collectd metric is taken as a SNMP table index.
7987 =item B<Regex> I<String>
7989 B<Regex> option can also be used to parse strings or numbers out of
7990 specific field. For example: type-instance field which is "vcpu1-cpu2" can be
7991 parsed into two numeric fields CPU = 2 and VCPU = 1 and can be later used
7994 =item B<Group> I<Number>
7996 B<Group> number can be specified in case groups are used in regex.
8000 =item B<Plugin> I<String>
8002 Read plugin name whose collected data will be mapped to specified OIDs.
8004 =item B<PluginInstance> I<String>
8006 Read plugin instance whose collected data will be mapped to specified OIDs.
8007 The field is optional and by default there is no plugin instance check.
8008 Allowed only if B<Data> block defines scalar data type.
8010 =item B<Type> I<String>
8012 Collectd's type that is to be used for specified OID, e.E<nbsp>g. "if_octets"
8013 for example. The types are read from the B<TypesDB> (see L<collectd.conf(5)>).
8015 =item B<TypeInstance> I<String>
8017 Collectd's type-instance that is to be used for specified OID.
8019 =item B<OIDs> I<OID> [I<OID> ...]
8021 Configures the OIDs to be handled by I<snmp_agent> plugin. Values for these OIDs
8022 are taken from collectd data type specified by B<Plugin>, B<PluginInstance>,
8023 B<Type>, B<TypeInstance> fields of this B<Data> block. Number of the OIDs
8024 configured should correspond to number of values in specified B<Type>.
8025 For example two OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" can be mapped to
8026 "rx" and "tx" values of "if_octets" type.
8028 =item B<Scale> I<Value>
8030 The values taken from collectd are multiplied by I<Value>. The field is optional
8031 and the default is B<1.0>.
8033 =item B<Shift> I<Value>
8035 I<Value> is added to values from collectd after they have been multiplied by
8036 B<Scale> value. The field is optional and the default value is B<0.0>.
8040 =head3 The B<Table> block
8042 The B<Table> block defines a collection of B<Data> blocks that belong to one
8043 snmp table. In addition to multiple B<Data> blocks the following options can be
8048 =item B<IndexOID> I<OID>
8050 OID that is handled by the plugin and is mapped to numerical index value that is
8051 generated by the plugin for each table record.
8053 =item B<SizeOID> I<OID>
8055 OID that is handled by the plugin. Returned value is the number of records in
8056 the table. The field is optional.
8060 =head2 Plugin C<statsd>
8062 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
8063 protocol and dispatches rates or other aggregates of these numbers
8066 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
8067 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
8068 C<objects> respectively.
8070 The following configuration options are valid:
8074 =item B<Host> I<Host>
8076 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
8077 "any" address, i.e. accept packets sent to any of the hosts addresses.
8079 =item B<Port> I<Port>
8081 UDP port to listen to. This can be either a service name or a port number.
8082 Defaults to C<8125>.
8084 =item B<DeleteCounters> B<false>|B<true>
8086 =item B<DeleteTimers> B<false>|B<true>
8088 =item B<DeleteGauges> B<false>|B<true>
8090 =item B<DeleteSets> B<false>|B<true>
8092 These options control what happens if metrics are not updated in an interval.
8093 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
8094 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
8095 are unchanged. If set to B<True>, the such metrics are not dispatched and
8096 removed from the internal cache.
8098 =item B<CounterSum> B<false>|B<true>
8100 When enabled, creates a C<count> metric which reports the change since the last
8101 read. This option primarily exists for compatibility with the I<statsd>
8102 implementation by Etsy.
8104 =item B<TimerPercentile> I<Percent>
8106 Calculate and dispatch the configured percentile, i.e. compute the latency, so
8107 that I<Percent> of all reported timers are smaller than or equal to the
8108 computed latency. This is useful for cutting off the long tail latency, as it's
8109 often done in I<Service Level Agreements> (SLAs).
8111 Different percentiles can be calculated by setting this option several times.
8112 If none are specified, no percentiles are calculated / dispatched.
8114 =item B<TimerLower> B<false>|B<true>
8116 =item B<TimerUpper> B<false>|B<true>
8118 =item B<TimerSum> B<false>|B<true>
8120 =item B<TimerCount> B<false>|B<true>
8122 Calculate and dispatch various values out of I<Timer> metrics received during
8123 an interval. If set to B<False>, the default, these values aren't calculated /
8126 Please note what reported timer values less than 0.001 are ignored in all B<Timer*> reports.
8130 =head2 Plugin C<swap>
8132 The I<Swap plugin> collects information about used and available swap space. On
8133 I<Linux> and I<Solaris>, the following options are available:
8137 =item B<ReportByDevice> B<false>|B<true>
8139 Configures how to report physical swap devices. If set to B<false> (the
8140 default), the summary over all swap devices is reported only, i.e. the globally
8141 used and available space over all devices. If B<true> is configured, the used
8142 and available space of each device will be reported separately.
8144 This option is only available if the I<Swap plugin> can read C</proc/swaps>
8145 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
8147 =item B<ReportBytes> B<false>|B<true>
8149 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
8150 I<swap I/O> is reported in pages. This option is available under Linux only.
8152 =item B<ValuesAbsolute> B<true>|B<false>
8154 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
8155 available and used. Defaults to B<true>.
8157 =item B<ValuesPercentage> B<false>|B<true>
8159 Enables or disables reporting of relative swap metrics, i.e. I<percent>
8160 available and free. Defaults to B<false>.
8162 This is useful for deploying I<collectd> in a heterogeneous environment, where
8163 swap sizes differ and you want to specify generic thresholds or similar.
8165 =item B<ReportIO> B<true>|B<false>
8167 Enables or disables reporting swap IO. Defaults to B<true>.
8169 This is useful for the cases when swap IO is not neccessary, is not available,
8174 =head2 Plugin C<syslog>
8178 =item B<LogLevel> B<debug|info|notice|warning|err>
8180 Sets the log-level. If, for example, set to B<notice>, then all events with
8181 severity B<notice>, B<warning>, or B<err> will be submitted to the
8184 Please note that B<debug> is only available if collectd has been compiled with
8187 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
8189 Controls which notifications should be sent to syslog. The default behaviour is
8190 not to send any. Less severe notifications always imply logging more severe
8191 notifications: Setting this to B<OKAY> means all notifications will be sent to
8192 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
8193 notifications but will dismiss B<OKAY> notifications. Setting this option to
8194 B<FAILURE> will only send failures to syslog.
8198 =head2 Plugin C<table>
8200 The C<table plugin> provides generic means to parse tabular data and dispatch
8201 user specified values. Values are selected based on column numbers. For
8202 example, this plugin may be used to get values from the Linux L<proc(5)>
8203 filesystem or CSV (comma separated values) files.
8206 <Table "/proc/slabinfo">
8212 InstancePrefix "active_objs"
8218 InstancePrefix "objperslab"
8225 The configuration consists of one or more B<Table> blocks, each of which
8226 configures one file to parse. Within each B<Table> block, there are one or
8227 more B<Result> blocks, which configure which data to select and how to
8230 The following options are available inside a B<Table> block:
8234 =item B<Plugin> I<Plugin>
8236 If specified, I<Plugin> is used as the plugin name when submitting values.
8237 Defaults to B<table>.
8239 =item B<Instance> I<instance>
8241 If specified, I<instance> is used as the plugin instance. If omitted, the
8242 filename of the table is used instead, with all special characters replaced
8243 with an underscore (C<_>).
8245 =item B<Separator> I<string>
8247 Any character of I<string> is interpreted as a delimiter between the different
8248 columns of the table. A sequence of two or more contiguous delimiters in the
8249 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
8250 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
8251 of a table - see its documentation for more details. This option is mandatory.
8253 A horizontal tab, newline and carriage return may be specified by C<\\t>,
8254 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
8255 required because of collectd's config parsing.
8259 The following options are available inside a B<Result> block:
8263 =item B<Type> I<type>
8265 Sets the type used to dispatch the values to the daemon. Detailed information
8266 about types and their configuration can be found in L<types.db(5)>. This
8267 option is mandatory.
8269 =item B<InstancePrefix> I<prefix>
8271 If specified, prepend I<prefix> to the type instance. If omitted, only the
8272 B<InstancesFrom> option is considered for the type instance.
8274 =item B<InstancesFrom> I<column0> [I<column1> ...]
8276 If specified, the content of the given columns (identified by the column
8277 number starting at zero) will be used to create the type instance for each
8278 row. Multiple values (and the instance prefix) will be joined together with
8279 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
8280 option is considered for the type instance.
8282 The plugin itself does not check whether or not all built instances are
8283 different. It’s your responsibility to assure that each is unique. This is
8284 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
8285 sure that the table only contains one row.
8287 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
8290 =item B<ValuesFrom> I<column0> [I<column1> ...]
8292 Specifies the columns (identified by the column numbers starting at zero)
8293 whose content is used as the actual data for the data sets that are dispatched
8294 to the daemon. How many such columns you need is determined by the B<Type>
8295 setting above. If you specify too many or not enough columns, the plugin will
8296 complain about that and no data will be submitted to the daemon. The plugin
8297 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
8298 respectively, so anything supported by those functions is supported by the
8299 plugin as well. This option is mandatory.
8303 =head2 Plugin C<tail>
8305 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
8306 each line and dispatches found values. What is matched can be configured by the
8307 user using (extended) regular expressions, as described in L<regex(7)>.
8310 <File "/var/log/exim4/mainlog">
8315 Regex "S=([1-9][0-9]*)"
8321 Regex "\\<R=local_user\\>"
8322 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
8325 Instance "local_user"
8328 Regex "l=([0-9]*\\.[0-9]*)"
8329 <DSType "Distribution">
8332 #BucketType "bucket"
8340 The config consists of one or more B<File> blocks, each of which configures one
8341 logfile to parse. Within each B<File> block, there are one or more B<Match>
8342 blocks, which configure a regular expression to search for.
8344 The B<Plugin> and B<Instance> options in the B<File> block may be used to set
8345 the plugin name and instance respectively. So in the above example the plugin name
8346 C<mail-exim> would be used.
8348 These options are applied for all B<Match> blocks that B<follow> it, until the
8349 next B<Plugin> or B<Instance> option. This way you can extract several plugin
8350 instances from one logfile, handy when parsing syslog and the like.
8352 The B<Interval> option allows you to define the length of time between reads. If
8353 this is not set, the default Interval will be used.
8355 Each B<Match> block has the following options to describe how the match should
8360 =item B<Regex> I<regex>
8362 Sets the regular expression to use for matching against a line. The first
8363 subexpression has to match something that can be turned into a number by
8364 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
8365 below. Because B<extended> regular expressions are used, you do not need to use
8366 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
8367 collectd's config parsing you need to escape backslashes, though. So if you
8368 want to match literal parentheses you need to do the following:
8370 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
8372 =item B<ExcludeRegex> I<regex>
8374 Sets an optional regular expression to use for excluding lines from the match.
8375 An example which excludes all connections from localhost from the match:
8377 ExcludeRegex "127\\.0\\.0\\.1"
8379 =item B<DSType> I<Type>
8381 Sets how the values are cumulated. I<Type> is one of:
8385 =item B<GaugeAverage>
8387 Calculate the average.
8391 Use the smallest number only.
8395 Use the greatest number only.
8399 Use the last number found.
8401 =item B<GaugePersist>
8403 Use the last number found. The number is not reset at the end of an interval.
8404 It is continously reported until another number is matched. This is intended
8405 for cases in which only state changes are reported, for example a thermometer
8406 that only reports the temperature when it changes.
8412 =item B<AbsoluteSet>
8414 The matched number is a counter. Simply I<sets> the internal counter to this
8415 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
8423 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
8424 matched number may be negative, which will effectively subtract from the
8433 Increase the internal counter by one. These B<DSType> are the only ones that do
8434 not use the matched subexpression, but simply count the number of matched
8435 lines. Thus, you may use a regular expression without submatch in this case.
8437 =item B<Distribution>
8439 Type to do calculations based on the distribution of values, primarily
8440 calculating percentiles. This is primarily geared towards latency, but can be
8441 used for other metrics as well. The range of values tracked with this setting
8442 must be in the range (0–2^34) and can be fractional. Please note that neither
8443 zero nor 2^34 are inclusive bounds, i.e. zero I<cannot> be handled by a
8446 This option must be used together with the B<Percentile> and/or B<Bucket>
8451 <DSType "Distribution">
8459 =item B<Percentile> I<Percent>
8461 Calculate and dispatch the configured percentile, i.e. compute the value, so
8462 that I<Percent> of all matched values are smaller than or equal to the computed
8465 Metrics are reported with the I<type> B<Type> (the value of the above option)
8466 and the I<type instance> C<[E<lt>InstanceE<gt>-]E<lt>PercentE<gt>>.
8468 This option may be repeated to calculate more than one percentile.
8470 =item B<Bucket> I<lower_bound> I<upper_bound>
8472 Export the number of values (a C<DERIVE>) falling within the given range. Both,
8473 I<lower_bound> and I<upper_bound> may be a fractional number, such as B<0.5>.
8474 Each B<Bucket> option specifies an interval C<(I<lower_bound>,
8475 I<upper_bound>]>, i.e. the range I<excludes> the lower bound and I<includes>
8476 the upper bound. I<lower_bound> and I<upper_bound> may be zero, meaning no
8479 To export the entire (0–inf) range without overlap, use the upper bound of the
8480 previous range as the lower bound of the following range. In other words, use
8481 the following schema:
8491 Metrics are reported with the I<type> set by B<BucketType> option (C<bucket>
8492 by default) and the I<type instance>
8493 C<E<lt>TypeE<gt>[-E<lt>InstanceE<gt>]-E<lt>lower_boundE<gt>_E<lt>upper_boundE<gt>>.
8495 This option may be repeated to calculate more than one rate.
8497 =item B<BucketType> I<Type>
8499 Sets the type used to dispatch B<Bucket> metrics.
8500 Optional, by default C<bucket> will be used.
8506 The B<Gauge*> and B<Distribution> types interpret the submatch as a floating
8507 point number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types
8508 interpret the submatch as an unsigned integer using L<strtoull(3)>. The
8509 B<Derive*> types interpret the submatch as a signed integer using
8510 L<strtoll(3)>. B<CounterInc> and B<DeriveInc> do not use the submatch at all
8511 and it may be omitted in this case.
8513 =item B<Type> I<Type>
8515 Sets the type used to dispatch this value. Detailed information about types and
8516 their configuration can be found in L<types.db(5)>.
8518 =item B<Instance> I<TypeInstance>
8520 This optional setting sets the type instance to use.
8524 =head2 Plugin C<tail_csv>
8526 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
8527 written by I<Snort>.
8532 <Metric "snort-dropped">
8537 <File "/var/log/snort/snort.stats">
8541 Collect "snort-dropped"
8546 The configuration consists of one or more B<Metric> blocks that define an index
8547 into the line of the CSV file and how this value is mapped to I<collectd's>
8548 internal representation. These are followed by one or more B<Instance> blocks
8549 which configure which file to read, in which interval and which metrics to
8554 =item E<lt>B<Metric> I<Name>E<gt>
8556 The B<Metric> block configures a new metric to be extracted from the statistics
8557 file and how it is mapped on I<collectd's> data model. The string I<Name> is
8558 only used inside the B<Instance> blocks to refer to this block, so you can use
8559 one B<Metric> block for multiple CSV files.
8563 =item B<Type> I<Type>
8565 Configures which I<Type> to use when dispatching this metric. Types are defined
8566 in the L<types.db(5)> file, see the appropriate manual page for more
8567 information on specifying types. Only types with a single I<data source> are
8568 supported by the I<tail_csv plugin>. The information whether the value is an
8569 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
8570 I<Type's> definition.
8572 =item B<Instance> I<TypeInstance>
8574 If set, I<TypeInstance> is used to populate the type instance field of the
8575 created value lists. Otherwise, no type instance is used.
8577 =item B<ValueFrom> I<Index>
8579 Configure to read the value from the field with the zero-based index I<Index>.
8580 If the value is parsed as signed integer, unsigned integer or double depends on
8581 the B<Type> setting, see above.
8585 =item E<lt>B<File> I<Path>E<gt>
8587 Each B<File> block represents one CSV file to read. There must be at least one
8588 I<File> block but there can be multiple if you have multiple CSV files.
8592 =item B<Plugin> I<Plugin>
8594 Use I<Plugin> as the plugin name when submitting values.
8595 Defaults to C<tail_csv>.
8597 =item B<Instance> I<PluginInstance>
8599 Sets the I<plugin instance> used when dispatching the values.
8601 =item B<Collect> I<Metric>
8603 Specifies which I<Metric> to collect. This option must be specified at least
8604 once, and you can use this option multiple times to specify more than one
8605 metric to be extracted from this statistic file.
8607 =item B<Interval> I<Seconds>
8609 Configures the interval in which to read values from this instance / file.
8610 Defaults to the plugin's default interval.
8612 =item B<TimeFrom> I<Index>
8614 Rather than using the local time when dispatching a value, read the timestamp
8615 from the field with the zero-based index I<Index>. The value is interpreted as
8616 seconds since epoch. The value is parsed as a double and may be factional.
8622 =head2 Plugin C<teamspeak2>
8624 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
8625 polls interesting global and virtual server data. The plugin can query only one
8626 physical server but unlimited virtual servers. You can use the following
8627 options to configure it:
8631 =item B<Host> I<hostname/ip>
8633 The hostname or ip which identifies the physical server.
8636 =item B<Port> I<port>
8638 The query port of the physical server. This needs to be a string.
8641 =item B<Server> I<port>
8643 This option has to be added once for every virtual server the plugin should
8644 query. If you want to query the virtual server on port 8767 this is what the
8645 option would look like:
8649 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
8650 use quotes around it! If no such statement is given only global information
8655 =head2 Plugin C<ted>
8657 The I<TED> plugin connects to a device of "The Energy Detective", a device to
8658 measure power consumption. These devices are usually connected to a serial
8659 (RS232) or USB port. The plugin opens a configured device and tries to read the
8660 current energy readings. For more information on TED, visit
8661 L<http://www.theenergydetective.com/>.
8663 Available configuration options:
8667 =item B<Device> I<Path>
8669 Path to the device on which TED is connected. collectd will need read and write
8670 permissions on that file.
8672 Default: B</dev/ttyUSB0>
8674 =item B<Retries> I<Num>
8676 Apparently reading from TED is not that reliable. You can therefore configure a
8677 number of retries here. You only configure the I<retries> here, to if you
8678 specify zero, one reading will be performed (but no retries if that fails); if
8679 you specify three, a maximum of four readings are performed. Negative values
8686 =head2 Plugin C<tcpconns>
8688 The C<tcpconns plugin> counts the number of currently established TCP
8689 connections based on the local port and/or the remote port. Since there may be
8690 a lot of connections the default if to count all connections with a local port,
8691 for which a listening socket is opened. You can use the following options to
8692 fine-tune the ports you are interested in:
8696 =item B<ListeningPorts> I<true>|I<false>
8698 If this option is set to I<true>, statistics for all local ports for which a
8699 listening socket exists are collected. The default depends on B<LocalPort> and
8700 B<RemotePort> (see below): If no port at all is specifically selected, the
8701 default is to collect listening ports. If specific ports (no matter if local or
8702 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
8703 the selected ports will be collected unless this option is set to I<true>
8706 =item B<LocalPort> I<Port>
8708 Count the connections to a specific local port. This can be used to see how
8709 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
8710 You have to specify the port in numeric form, so for the mailserver example
8711 you'd need to set B<25>.
8713 =item B<RemotePort> I<Port>
8715 Count the connections to a specific remote port. This is useful to see how
8716 much a remote service is used. This is most useful if you want to know how many
8717 connections a local service has opened to remote services, e.E<nbsp>g. how many
8718 connections a mail server or news server has to other mail or news servers, or
8719 how many connections a web proxy holds to web servers. You have to give the
8720 port in numeric form.
8722 =item B<AllPortsSummary> I<true>|I<false>
8724 If this option is set to I<true> a summary of statistics from all connections
8725 are collected. This option defaults to I<false>.
8729 =head2 Plugin C<thermal>
8733 =item B<ForceUseProcfs> I<true>|I<false>
8735 By default, the I<Thermal plugin> tries to read the statistics from the Linux
8736 C<sysfs> interface. If that is not available, the plugin falls back to the
8737 C<procfs> interface. By setting this option to I<true>, you can force the
8738 plugin to use the latter. This option defaults to I<false>.
8740 =item B<Device> I<Device>
8742 Selects the name of the thermal device that you want to collect or ignore,
8743 depending on the value of the B<IgnoreSelected> option. This option may be
8744 used multiple times to specify a list of devices.
8746 See F</"IGNORELISTS"> for details.
8748 =item B<IgnoreSelected> I<true>|I<false>
8750 Invert the selection: If set to true, all devices B<except> the ones that
8751 match the device names specified by the B<Device> option are collected. By
8752 default only selected devices are collected if a selection is made. If no
8753 selection is configured at all, B<all> devices are selected.
8757 =head2 Plugin C<threshold>
8759 The I<Threshold plugin> checks values collected or received by I<collectd>
8760 against a configurable I<threshold> and issues I<notifications> if values are
8763 Documentation for this plugin is available in the L<collectd-threshold(5)>
8766 =head2 Plugin C<tokyotyrant>
8768 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
8769 couple metrics: number of records, and database size on disk.
8773 =item B<Host> I<Hostname/IP>
8775 The hostname or IP which identifies the server.
8776 Default: B<127.0.0.1>
8778 =item B<Port> I<Service/Port>
8780 The query port of the server. This needs to be a string, even if the port is
8781 given in its numeric form.
8786 =head2 Plugin C<turbostat>
8788 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
8789 Intel processors by using I<Model Specific Registers>.
8793 =item B<CoreCstates> I<Bitmask(Integer)>
8795 Bit mask of the list of core C-states supported by the processor.
8796 This option should only be used if the automated detection fails.
8797 Default value extracted from the CPU model and family.
8799 Currently supported C-states (by this plugin): 3, 6, 7
8803 All states (3, 6 and 7):
8804 (1<<3) + (1<<6) + (1<<7) = 392
8806 =item B<PackageCstates> I<Bitmask(Integer)>
8808 Bit mask of the list of packages C-states supported by the processor. This
8809 option should only be used if the automated detection fails. Default value
8810 extracted from the CPU model and family.
8812 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
8816 States 2, 3, 6 and 7:
8817 (1<<2) + (1<<3) + (1<<6) + (1<<7) = 396
8819 =item B<SystemManagementInterrupt> I<true>|I<false>
8821 Boolean enabling the collection of the I/O System-Management Interrupt counter.
8822 This option should only be used if the automated detection fails or if you want
8823 to disable this feature.
8825 =item B<DigitalTemperatureSensor> I<true>|I<false>
8827 Boolean enabling the collection of the temperature of each core. This option
8828 should only be used if the automated detection fails or if you want to disable
8831 =item B<TCCActivationTemp> I<Temperature>
8833 I<Thermal Control Circuit Activation Temperature> of the installed CPU. This
8834 temperature is used when collecting the temperature of cores or packages. This
8835 option should only be used if the automated detection fails. Default value
8836 extracted from B<MSR_IA32_TEMPERATURE_TARGET>.
8838 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
8840 Bit mask of the list of elements to be thermally monitored. This option should
8841 only be used if the automated detection fails or if you want to disable some
8842 collections. The different bits of this bit mask accepted by this plugin are:
8846 =item 0 ('1'): Package
8850 =item 2 ('4'): Cores
8852 =item 3 ('8'): Embedded graphic device
8856 =item B<LogicalCoreNames> I<true>|I<false>
8858 Boolean enabling the use of logical core numbering for per core statistics.
8859 When enabled, C<cpuE<lt>nE<gt>> is used as plugin instance, where I<n> is a
8860 dynamic number assigned by the kernel. Otherwise, C<coreE<lt>nE<gt>> is used
8861 if there is only one package and C<pkgE<lt>nE<gt>-coreE<lt>mE<gt>> if there is
8862 more than one, where I<n> is the n-th core of package I<m>.
8866 =head2 Plugin C<unixsock>
8870 =item B<SocketFile> I<Path>
8872 Sets the socket-file which is to be created.
8874 =item B<SocketGroup> I<Group>
8876 If running as root change the group of the UNIX-socket after it has been
8877 created. Defaults to B<collectd>.
8879 =item B<SocketPerms> I<Permissions>
8881 Change the file permissions of the UNIX-socket after it has been created. The
8882 permissions must be given as a numeric, octal value as you would pass to
8883 L<chmod(1)>. Defaults to B<0770>.
8885 =item B<DeleteSocket> B<false>|B<true>
8887 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
8888 with the given name already exists. If I<collectd> crashes a socket file may be
8889 left over, preventing the daemon from opening a new socket when restarted.
8890 Since this is potentially dangerous, this defaults to B<false>.
8894 =head2 Plugin C<uuid>
8896 This plugin, if loaded, causes the Hostname to be taken from the machine's
8897 UUID. The UUID is a universally unique designation for the machine, usually
8898 taken from the machine's BIOS. This is most useful if the machine is running in
8899 a virtual environment such as Xen, in which case the UUID is preserved across
8900 shutdowns and migration.
8902 The following methods are used to find the machine's UUID, in order:
8908 Check I</etc/uuid> (or I<UUIDFile>).
8912 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
8917 Check for UUID from C<dmidecode> / SMBIOS.
8921 Check for UUID from Xen hypervisor.
8925 If no UUID can be found then the hostname is not modified.
8929 =item B<UUIDFile> I<Path>
8931 Take the UUID from the given file (default I</etc/uuid>).
8935 =head2 Plugin C<varnish>
8937 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
8938 It collects a subset of the values displayed by L<varnishstat(1)>, and
8939 organizes them in categories which can be enabled or disabled. Currently only
8940 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
8941 meaning of each metric can be found in L<varnish-counters(7)>.
8946 <Instance "example">
8950 CollectConnections true
8951 CollectDirectorDNS false
8955 CollectObjects false
8957 CollectSession false
8967 CollectWorkers false
8969 CollectMempool false
8970 CollectManagement false
8977 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
8978 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
8979 will collectd statistics from the default "varnishd" instance (this should work
8980 fine in most cases).
8982 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
8986 =item B<CollectBackend> B<true>|B<false>
8988 Back-end connection statistics, such as successful, reused,
8989 and closed connections. True by default.
8991 =item B<CollectBan> B<true>|B<false>
8993 Statistics about ban operations, such as number of bans added, retired, and
8994 number of objects tested against ban operations. Only available with Varnish
8995 3.x and above. False by default.
8997 =item B<CollectCache> B<true>|B<false>
8999 Cache hits and misses. True by default.
9001 =item B<CollectConnections> B<true>|B<false>
9003 Number of client connections received, accepted and dropped. True by default.
9005 =item B<CollectDirectorDNS> B<true>|B<false>
9007 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
9010 =item B<CollectESI> B<true>|B<false>
9012 Edge Side Includes (ESI) parse statistics. False by default.
9014 =item B<CollectFetch> B<true>|B<false>
9016 Statistics about fetches (HTTP requests sent to the backend). False by default.
9018 =item B<CollectHCB> B<true>|B<false>
9020 Inserts and look-ups in the crit bit tree based hash. Look-ups are
9021 divided into locked and unlocked look-ups. False by default.
9023 =item B<CollectObjects> B<true>|B<false>
9025 Statistics on cached objects: number of objects expired, nuked (prematurely
9026 expired), saved, moved, etc. False by default.
9028 =item B<CollectPurge> B<true>|B<false>
9030 Statistics about purge operations, such as number of purges added, retired, and
9031 number of objects tested against purge operations. Only available with Varnish
9032 2.x. False by default.
9034 =item B<CollectSession> B<true>|B<false>
9036 Client session statistics. Number of past and current sessions, session herd and
9037 linger counters, etc. False by default. Note that if using Varnish 4.x, some
9038 metrics found in the Connections and Threads sections with previous versions of
9039 Varnish have been moved here.
9041 =item B<CollectSHM> B<true>|B<false>
9043 Statistics about the shared memory log, a memory region to store
9044 log messages which is flushed to disk when full. True by default.
9046 =item B<CollectSMA> B<true>|B<false>
9048 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
9049 component is Solaris specific. Note: SMA, SMF and MSE share counters, enable
9050 only the one used by the Varnish instance. Only available with Varnish 2.x.
9053 =item B<CollectSMS> B<true>|B<false>
9055 synth (synthetic content) storage statistics. This storage
9056 component is used internally only. False by default.
9058 =item B<CollectSM> B<true>|B<false>
9060 file (memory mapped file) storage statistics. Only available with Varnish 2.x.,
9061 in varnish 4.x. use CollectSMF.
9064 =item B<CollectStruct> B<true>|B<false>
9066 Current varnish internal state statistics. Number of current sessions, objects
9067 in cache store, open connections to backends (with Varnish 2.x), etc. False by
9070 =item B<CollectTotals> B<true>|B<false>
9072 Collects overview counters, such as the number of sessions created,
9073 the number of requests and bytes transferred. False by default.
9075 =item B<CollectUptime> B<true>|B<false>
9077 Varnish uptime. Only available with Varnish 3.x and above. False by default.
9079 =item B<CollectVCL> B<true>|B<false>
9081 Number of total (available + discarded) VCL (config files). False by default.
9083 =item B<CollectVSM> B<true>|B<false>
9085 Collect statistics about Varnish's shared memory usage (used by the logging and
9086 statistics subsystems). Only available with Varnish 4.x. False by default.
9088 =item B<CollectWorkers> B<true>|B<false>
9090 Collect statistics about worker threads. False by default.
9092 =item B<CollectVBE> B<true>|B<false>
9094 Backend counters. Only available with Varnish 4.x. False by default.
9096 =item B<CollectSMF> B<true>|B<false>
9098 file (memory mapped file) storage statistics. Only available with Varnish 4.x.
9099 Note: SMA, SMF and MSE share counters, enable only the one used by the Varnish
9100 instance. Used to be called SM in Varnish 2.x. False by default.
9102 =item B<CollectManagement> B<true>|B<false>
9104 Management process counters. Only available with Varnish 4.x. False by default.
9106 =item B<CollectLock> B<true>|B<false>
9108 Lock counters. Only available with Varnish 4.x. False by default.
9110 =item B<CollectMempool> B<true>|B<false>
9112 Memory pool counters. Only available with Varnish 4.x. False by default.
9114 =item B<CollectMSE> B<true>|B<false>
9116 Varnish Massive Storage Engine 2.0 (MSE2) is an improved storage backend for
9117 Varnish, replacing the traditional malloc and file storages. Only available
9118 with Varnish-Plus 4.x. Note: SMA, SMF and MSE share counters, enable only the
9119 one used by the Varnish instance. False by default.
9123 =head2 Plugin C<virt>
9125 This plugin allows CPU, disk, network load and other metrics to be collected for
9126 virtualized guests on the machine. The statistics are collected through libvirt
9127 API (L<http://libvirt.org/>). Majority of metrics can be gathered without
9128 installing any additional software on guests, especially I<collectd>, which runs
9129 only on the host system.
9131 Only I<Connection> is required.
9135 =item B<Connection> I<uri>
9137 Connect to the hypervisor given by I<uri>. For example if using Xen use:
9139 Connection "xen:///"
9141 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
9143 =item B<RefreshInterval> I<seconds>
9145 Refresh the list of domains and devices every I<seconds>. The default is 60
9146 seconds. Setting this to be the same or smaller than the I<Interval> will cause
9147 the list of domains and devices to be refreshed on every iteration.
9149 Refreshing the devices in particular is quite a costly operation, so if your
9150 virtualization setup is static you might consider increasing this. If this
9151 option is set to 0, refreshing is disabled completely.
9153 =item B<Domain> I<name>
9155 =item B<BlockDevice> I<name:dev>
9157 =item B<InterfaceDevice> I<name:dev>
9159 =item B<IgnoreSelected> B<true>|B<false>
9161 Select which domains and devices are collected.
9163 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
9164 disk/network devices are collected.
9166 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
9167 domains and disk/network devices are ignored, while the rest are collected.
9169 The domain name and device names may use a regular expression, if the name is
9170 surrounded by I</.../> and collectd was compiled with support for regexps.
9172 The default is to collect statistics for all domains and all their devices.
9176 BlockDevice "/:hdb/"
9177 IgnoreSelected "true"
9179 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
9182 =item B<BlockDeviceFormat> B<target>|B<source>
9184 If I<BlockDeviceFormat> is set to B<target>, the default, then the device name
9185 seen by the guest will be used for reporting metrics.
9186 This corresponds to the C<E<lt>targetE<gt>> node in the XML definition of the
9189 If I<BlockDeviceFormat> is set to B<source>, then metrics will be reported
9190 using the path of the source, e.g. an image file.
9191 This corresponds to the C<E<lt>sourceE<gt>> node in the XML definition of the
9196 If the domain XML have the following device defined:
9198 <disk type='block' device='disk'>
9199 <driver name='qemu' type='raw' cache='none' io='native' discard='unmap'/>
9200 <source dev='/var/lib/libvirt/images/image1.qcow2'/>
9201 <target dev='sda' bus='scsi'/>
9203 <address type='drive' controller='0' bus='0' target='0' unit='0'/>
9206 Setting C<BlockDeviceFormat target> will cause the I<type instance> to be set
9208 Setting C<BlockDeviceFormat source> will cause the I<type instance> to be set
9209 to C<var_lib_libvirt_images_image1.qcow2>.
9211 =item B<BlockDeviceFormatBasename> B<false>|B<true>
9213 The B<BlockDeviceFormatBasename> controls whether the full path or the
9214 L<basename(1)> of the source is being used as the I<type instance> when
9215 B<BlockDeviceFormat> is set to B<source>. Defaults to B<false>.
9219 Assume the device path (source tag) is C</var/lib/libvirt/images/image1.qcow2>.
9220 Setting C<BlockDeviceFormatBasename false> will cause the I<type instance> to
9221 be set to C<var_lib_libvirt_images_image1.qcow2>.
9222 Setting C<BlockDeviceFormatBasename true> will cause the I<type instance> to be
9223 set to C<image1.qcow2>.
9225 =item B<HostnameFormat> B<name|uuid|hostname|...>
9227 When the virt plugin logs data, it sets the hostname of the collected data
9228 according to this setting. The default is to use the guest name as provided by
9229 the hypervisor, which is equal to setting B<name>.
9231 B<uuid> means use the guest's UUID. This is useful if you want to track the
9232 same guest across migrations.
9234 B<hostname> means to use the global B<Hostname> setting, which is probably not
9235 useful on its own because all guests will appear to have the same name.
9237 You can also specify combinations of these fields. For example B<name uuid>
9238 means to concatenate the guest name and UUID (with a literal colon character
9239 between, thus I<"foo:1234-1234-1234-1234">).
9241 At the moment of writing (collectd-5.5), hostname string is limited to 62
9242 characters. In case when combination of fields exceeds 62 characters,
9243 hostname will be truncated without a warning.
9245 =item B<InterfaceFormat> B<name>|B<address>
9247 When the virt plugin logs interface data, it sets the name of the collected
9248 data according to this setting. The default is to use the path as provided by
9249 the hypervisor (the "dev" property of the target node), which is equal to
9252 B<address> means use the interface's mac address. This is useful since the
9253 interface path might change between reboots of a guest or across migrations.
9255 =item B<PluginInstanceFormat> B<name|uuid|none>
9257 When the virt plugin logs data, it sets the plugin_instance of the collected
9258 data according to this setting. The default is to not set the plugin_instance.
9260 B<name> means use the guest's name as provided by the hypervisor.
9261 B<uuid> means use the guest's UUID.
9263 You can also specify combinations of the B<name> and B<uuid> fields.
9264 For example B<name uuid> means to concatenate the guest name and UUID
9265 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
9267 =item B<Instances> B<integer>
9269 How many read instances you want to use for this plugin. The default is one,
9270 and the sensible setting is a multiple of the B<ReadThreads> value.
9271 If you are not sure, just use the default setting.
9273 =item B<ExtraStats> B<string>
9275 Report additional extra statistics. The default is no extra statistics, preserving
9276 the previous behaviour of the plugin. If unsure, leave the default. If enabled,
9277 allows the plugin to reported more detailed statistics about the behaviour of
9278 Virtual Machines. The argument is a space-separated list of selectors.
9280 Currently supported selectors are:
9284 =item B<cpu_util>: report CPU utilization per domain in percentage.
9286 =item B<disk>: report extra statistics like number of flush operations and total
9287 service time for read, write and flush operations. Requires libvirt API version
9290 =item B<disk_err>: report disk errors if any occured. Requires libvirt API version
9293 =item B<domain_state>: report domain state and reason in human-readable format as
9294 a notification. If libvirt API version I<0.9.2> or later is available, domain
9295 reason will be included in notification.
9297 =item B<fs_info>: report file system information as a notification. Requires
9298 libvirt API version I<1.2.11> or later. Can be collected only if I<Guest Agent>
9299 is installed and configured inside VM. Make sure that installed I<Guest Agent>
9300 version supports retrieving file system information.
9302 =item B<job_stats_background>: report statistics about progress of a background
9303 job on a domain. Only one type of job statistics can be collected at the same time.
9304 Requires libvirt API version I<1.2.9> or later.
9306 =item B<job_stats_completed>: report statistics about a recently completed job on
9307 a domain. Only one type of job statistics can be collected at the same time.
9308 Requires libvirt API version I<1.2.9> or later.
9310 =item B<pcpu>: report the physical user/system cpu time consumed by the hypervisor, per-vm.
9311 Requires libvirt API version I<0.9.11> or later.
9313 =item B<perf>: report performance monitoring events. To collect performance
9314 metrics they must be enabled for domain and supported by the platform. Requires
9315 libvirt API version I<1.3.3> or later.
9316 B<Note>: I<perf> metrics can't be collected if I<intel_rdt> plugin is enabled.
9318 =item B<vcpupin>: report pinning of domain VCPUs to host physical CPUs.
9322 =item B<PersistentNotification> B<true>|B<false>
9323 Override default configuration to only send notifications when there is a change
9324 in the lifecycle state of a domain. When set to true notifications will be sent
9325 for every read cycle. Default is false. Does not affect the stats being
9330 =head2 Plugin C<vmem>
9332 The C<vmem> plugin collects information about the usage of virtual memory.
9333 Since the statistics provided by the Linux kernel are very detailed, they are
9334 collected very detailed. However, to get all the details, you have to switch
9335 them on manually. Most people just want an overview over, such as the number of
9336 pages read from swap space.
9340 =item B<Verbose> B<true>|B<false>
9342 Enables verbose collection of information. This will start collecting page
9343 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
9344 Part of these statistics are collected on a "per zone" basis.
9348 =head2 Plugin C<vserver>
9350 This plugin doesn't have any options. B<VServer> support is only available for
9351 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
9352 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
9353 need to apply the patches and compile your own kernel, which will then provide
9354 the F</proc/virtual> filesystem that is required by this plugin.
9356 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
9358 B<Note>: The traffic collected by this plugin accounts for the amount of
9359 traffic passing a socket which might be a lot less than the actual on-wire
9360 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
9361 collect on-wire traffic you could, for example, use the logging facilities of
9362 iptables to feed data for the guest IPs into the iptables plugin.
9364 =head2 Plugin C<write_graphite>
9366 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
9367 storage and graphing project. The plugin connects to I<Carbon>, the data layer
9368 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
9369 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
9370 of at most 1428 bytes to minimize the number of network packets.
9374 <Plugin write_graphite>
9385 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9386 blocks. Inside the B<Node> blocks, the following options are recognized:
9390 =item B<Host> I<Address>
9392 Hostname or address to connect to. Defaults to C<localhost>.
9394 =item B<Port> I<Service>
9396 Service name or port number to connect to. Defaults to C<2003>.
9398 =item B<Protocol> I<String>
9400 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
9402 =item B<ReconnectInterval> I<Seconds>
9404 When set to non-zero, forces the connection to the Graphite backend to be
9405 closed and re-opend periodically. This behavior is desirable in environments
9406 where the connection to the Graphite backend is done through load balancers,
9407 for example. When set to zero, the default, the connetion is kept open for as
9410 =item B<LogSendErrors> B<false>|B<true>
9412 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
9413 If set to B<false>, it will not log the errors. This is especially useful when
9414 using Protocol UDP since many times we want to use the "fire-and-forget"
9415 approach and logging errors fills syslog with unneeded messages.
9417 =item B<Prefix> I<String>
9419 When B<UseTags> is I<false>, B<Prefix> value is added in front of the host name.
9420 When B<UseTags> is I<true>, B<Prefix> value is added in front of series name.
9422 Dots and whitespace are I<not> escaped in this string (see B<EscapeCharacter>
9425 =item B<Postfix> I<String>
9427 When B<UseTags> is I<false>, B<Postfix> value appended to the host name.
9428 When B<UseTags> is I<true>, B<Postgix> value appended to the end of series name
9429 (before the first ; that separates the name from the tags).
9431 Dots and whitespace are I<not> escaped in this string (see B<EscapeCharacter>
9434 =item B<EscapeCharacter> I<Char>
9436 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
9437 in the identifier. The B<EscapeCharacter> option determines which character
9438 dots, whitespace and control characters are replaced with. Defaults to
9441 =item B<StoreRates> B<false>|B<true>
9443 If set to B<true> (the default), convert counter values to rates. If set to
9444 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
9447 =item B<SeparateInstances> B<false>|B<true>
9449 If set to B<true>, the plugin instance and type instance will be in their own
9450 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9451 default), the plugin and plugin instance (and likewise the type and type
9452 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9454 Option value is not used when B<UseTags> is I<true>.
9456 =item B<AlwaysAppendDS> B<false>|B<true>
9458 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9459 identifier. If set to B<false> (the default), this is only done when there is
9462 =item B<PreserveSeparator> B<false>|B<true>
9464 If set to B<false> (the default) the C<.> (dot) character is replaced with
9465 I<EscapeCharacter>. Otherwise, if set to B<true>, the C<.> (dot) character
9466 is preserved, i.e. passed through.
9468 Option value is not used when B<UseTags> is I<true>.
9470 =item B<DropDuplicateFields> B<false>|B<true>
9472 If set to B<true>, detect and remove duplicate components in Graphite metric
9473 names. For example, the metric name C<host.load.load.shortterm> will
9474 be shortened to C<host.load.shortterm>.
9476 =item B<UseTags> B<false>|B<true>
9478 If set to B<true>, Graphite metric names will be generated as tagged series.
9479 This allows for much more flexibility than the traditional hierarchical layout.
9482 C<test.single;host=example.com;plugin=test;plugin_instance=foo;type=single;type_instance=bar>
9484 You can use B<Postfix> option to add more tags by specifying it like
9485 C<;tag1=value1;tag2=value2>. Note what tagging support was added since Graphite
9488 If set to B<true>, the B<SeparateInstances> and B<PreserveSeparator> settings
9491 Default value: B<false>.
9495 =head2 Plugin C<write_log>
9497 The C<write_log> plugin writes metrics as INFO log messages.
9499 This plugin supports two output formats: I<Graphite> and I<JSON>.
9509 =item B<Format> I<Format>
9511 The output format to use. Can be one of C<Graphite> or C<JSON>.
9515 =head2 Plugin C<write_tsdb>
9517 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
9518 time series database. The plugin connects to a I<TSD>, a masterless, no shared
9519 state daemon that ingests metrics and stores them in HBase. The plugin uses
9520 I<TCP> over the "line based" protocol with a default port 4242. The data will
9521 be sent in blocks of at most 1428 bytes to minimize the number of network
9530 Host "tsd-1.my.domain"
9532 HostTags "status=production"
9536 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9537 blocks and global directives.
9539 Global directives are:
9543 =item B<ResolveInterval> I<seconds>
9545 =item B<ResolveJitter> I<seconds>
9547 When I<collectd> connects to a TSDB node, it will request the hostname from
9548 DNS. This can become a problem if the TSDB node is unavailable or badly
9549 configured because collectd will request DNS in order to reconnect for every
9550 metric, which can flood your DNS. So you can cache the last value for
9551 I<ResolveInterval> seconds.
9552 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9554 You can also define a jitter, a random interval to wait in addition to
9555 I<ResolveInterval>. This prevents all your collectd servers to resolve the
9556 hostname at the same time when the connection fails.
9557 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9559 B<Note:> If the DNS resolution has already been successful when the socket
9560 closes, the plugin will try to reconnect immediately with the cached
9561 information. DNS is queried only when the socket is closed for a longer than
9562 I<ResolveInterval> + I<ResolveJitter> seconds.
9566 Inside the B<Node> blocks, the following options are recognized:
9570 =item B<Host> I<Address>
9572 Hostname or address to connect to. Defaults to C<localhost>.
9574 =item B<Port> I<Service>
9576 Service name or port number to connect to. Defaults to C<4242>.
9579 =item B<HostTags> I<String>
9581 When set, I<HostTags> is added to the end of the metric. It is intended to be
9582 used for name=value pairs that the TSD will tag the metric with. Dots and
9583 whitespace are I<not> escaped in this string.
9585 =item B<StoreRates> B<false>|B<true>
9587 If set to B<true>, convert counter values to rates. If set to B<false>
9588 (the default) counter values are stored as is, as an increasing
9591 =item B<AlwaysAppendDS> B<false>|B<true>
9593 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
9594 identifier. If set to B<false> (the default), this is only done when there is
9599 =head2 Plugin C<write_mongodb>
9601 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
9606 <Plugin "write_mongodb">
9615 The plugin can send values to multiple instances of I<MongoDB> by specifying
9616 one B<Node> block for each instance. Within the B<Node> blocks, the following
9617 options are available:
9621 =item B<Host> I<Address>
9623 Hostname or address to connect to. Defaults to C<localhost>.
9625 =item B<Port> I<Service>
9627 Service name or port number to connect to. Defaults to C<27017>.
9629 =item B<Timeout> I<Milliseconds>
9631 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
9632 Setting this option to zero means no timeout, which is the default.
9634 =item B<StoreRates> B<false>|B<true>
9636 If set to B<true> (the default), convert counter values to rates. If set to
9637 B<false> counter values are stored as is, i.e. as an increasing integer
9640 =item B<Database> I<Database>
9642 =item B<User> I<User>
9644 =item B<Password> I<Password>
9646 Sets the information used when authenticating to a I<MongoDB> database. The
9647 fields are optional (in which case no authentication is attempted), but if you
9648 want to use authentication all three fields must be set.
9652 =head2 Plugin C<write_prometheus>
9654 The I<write_prometheus plugin> implements a tiny webserver that can be scraped
9655 using I<Prometheus>.
9661 =item B<Port> I<Port>
9663 Port the embedded webserver should listen on. Defaults to B<9103>.
9665 =item B<StalenessDelta> I<Seconds>
9667 Time in seconds after which I<Prometheus> considers a metric "stale" if it
9668 hasn't seen any update for it. This value must match the setting in Prometheus.
9669 It defaults to B<300> seconds (5 minutes), same as Prometheus.
9673 I<Prometheus> has a global setting, C<StalenessDelta>, which controls after
9674 which time a metric without updates is considered "stale". This setting
9675 effectively puts an upper limit on the interval in which metrics are reported.
9677 When the I<write_prometheus plugin> encounters a metric with an interval
9678 exceeding this limit, it will inform you, the user, and provide the metric to
9679 I<Prometheus> B<without> a timestamp. That causes I<Prometheus> to consider the
9680 metric "fresh" each time it is scraped, with the time of the scrape being
9681 considered the time of the update. The result is that there appear more
9682 datapoints in I<Prometheus> than were actually created, but at least the metric
9683 doesn't disappear periodically.
9687 =head2 Plugin C<write_http>
9689 This output plugin submits values to an HTTP server using POST requests and
9690 encoding metrics with JSON or using the C<PUTVAL> command described in
9691 L<collectd-unixsock(5)>.
9695 <Plugin "write_http">
9697 URL "http://example.com/post-collectd"
9704 The plugin can send values to multiple HTTP servers by specifying one
9705 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
9706 block, the following options are available:
9712 URL to which the values are submitted to. Mandatory.
9714 =item B<User> I<Username>
9716 Optional user name needed for authentication.
9718 =item B<Password> I<Password>
9720 Optional password needed for authentication.
9722 =item B<VerifyPeer> B<true>|B<false>
9724 Enable or disable peer SSL certificate verification. See
9725 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
9727 =item B<VerifyHost> B<true|false>
9729 Enable or disable peer host name verification. If enabled, the plugin checks if
9730 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
9731 matches the host name provided by the B<URL> option. If this identity check
9732 fails, the connection is aborted. Obviously, only works when connecting to a
9733 SSL enabled server. Enabled by default.
9735 =item B<CACert> I<File>
9737 File that holds one or more SSL certificates. If you want to use HTTPS you will
9738 possibly need this option. What CA certificates come bundled with C<libcurl>
9739 and are checked by default depends on the distribution you use.
9741 =item B<CAPath> I<Directory>
9743 Directory holding one or more CA certificate files. You can use this if for
9744 some reason all the needed CA certificates aren't in the same file and can't be
9745 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
9748 =item B<ClientKey> I<File>
9750 File that holds the private key in PEM format to be used for certificate-based
9753 =item B<ClientCert> I<File>
9755 File that holds the SSL certificate to be used for certificate-based
9758 =item B<ClientKeyPass> I<Password>
9760 Password required to load the private key in B<ClientKey>.
9762 =item B<Header> I<Header>
9764 A HTTP header to add to the request. Multiple headers are added if this option is specified more than once. Example:
9766 Header "X-Custom-Header: custom_value"
9768 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
9770 Define which SSL protocol version must be used. By default C<libcurl> will
9771 attempt to figure out the remote SSL protocol version. See
9772 L<curl_easy_setopt(3)> for more details.
9774 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
9776 Format of the output to generate. If set to B<Command>, will create output that
9777 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
9778 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
9779 , will create output in the KairosDB format.
9781 Defaults to B<Command>.
9783 =item B<Attribute> I<String> I<String>
9785 Only available for the KAIROSDB output format.
9787 Consider the two given strings to be the key and value of an additional tag for
9788 each metric being sent out.
9790 You can add multiple B<Attribute>.
9794 Only available for the KAIROSDB output format.
9796 Sets the Cassandra ttl for the data points.
9798 Please refer to L<http://kairosdb.github.io/docs/build/html/restapi/AddDataPoints.html?highlight=ttl>
9800 =item B<Prefix> I<String>
9802 Only available for the KAIROSDB output format.
9804 Sets the metrics prefix I<string>. Defaults to I<collectd>.
9806 =item B<Metrics> B<true>|B<false>
9808 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
9810 =item B<Notifications> B<false>|B<true>
9812 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
9814 =item B<StoreRates> B<true|false>
9816 If set to B<true>, convert counter values to rates. If set to B<false> (the
9817 default) counter values are stored as is, i.e. as an increasing integer number.
9819 =item B<BufferSize> I<Bytes>
9821 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
9822 requests will be generated, but more metrics will be batched / metrics are
9823 cached for longer before being sent, introducing additional delay until they
9824 are available on the server side. I<Bytes> must be at least 1024 and cannot
9825 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
9826 Defaults to C<4096>.
9828 =item B<LowSpeedLimit> I<Bytes per Second>
9830 Sets the minimal transfer rate in I<Bytes per Second> below which the
9831 connection with the HTTP server will be considered too slow and aborted. All
9832 the data submitted over this connection will probably be lost. Defaults to 0,
9833 which means no minimum transfer rate is enforced.
9835 =item B<Timeout> I<Timeout>
9837 Sets the maximum time in milliseconds given for HTTP POST operations to
9838 complete. When this limit is reached, the POST operation will be aborted, and
9839 all the data in the current send buffer will probably be lost. Defaults to 0,
9840 which means the connection never times out.
9842 =item B<LogHttpError> B<false>|B<true>
9844 Enables printing of HTTP error code to log. Turned off by default.
9846 The C<write_http> plugin regularly submits the collected values to the HTTP
9847 server. How frequently this happens depends on how much data you are collecting
9848 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
9849 slightly below this interval, which you can estimate by monitoring the network
9850 traffic between collectd and the HTTP server.
9854 =head2 Plugin C<write_kafka>
9856 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
9860 <Plugin "write_kafka">
9861 Property "metadata.broker.list" "broker1:9092,broker2:9092"
9867 The following options are understood by the I<write_kafka plugin>:
9871 =item E<lt>B<Topic> I<Name>E<gt>
9873 The plugin's configuration consists of one or more B<Topic> blocks. Each block
9874 is given a unique I<Name> and specifies one kafka producer.
9875 Inside the B<Topic> block, the following per-topic options are
9880 =item B<Property> I<String> I<String>
9882 Configure the named property for the current topic. Properties are
9883 forwarded to the kafka producer library B<librdkafka>.
9885 =item B<Key> I<String>
9887 Use the specified string as a partitioning key for the topic. Kafka breaks
9888 topic into partitions and guarantees that for a given topology, the same
9889 consumer will be used for a specific key. The special (case insensitive)
9890 string B<Random> can be used to specify that an arbitrary partition should
9893 =item B<Format> B<Command>|B<JSON>|B<Graphite>
9895 Selects the format in which messages are sent to the broker. If set to
9896 B<Command> (the default), values are sent as C<PUTVAL> commands which are
9897 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
9899 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
9900 an easy and straight forward exchange format.
9902 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
9903 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
9905 =item B<StoreRates> B<true>|B<false>
9907 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
9908 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
9909 default), no conversion is performed. Otherwise the conversion is performed
9910 using the internal value cache.
9912 Please note that currently this option is only used if the B<Format> option has
9913 been set to B<JSON>.
9915 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
9917 A prefix can be added in the metric name when outputting in the I<Graphite>
9920 When B<GraphiteUseTags> is I<false>, prefix is added before the I<Host> name.
9922 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>>
9924 When B<GraphiteUseTags> is I<true>, prefix is added in front of series name.
9926 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
9928 A postfix can be added in the metric name when outputting in the I<Graphite>
9931 When B<GraphiteUseTags> is I<false>, postfix is added after the I<Host> name.
9933 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>>
9935 When B<GraphiteUseTags> is I<true>, prefix value appended to the end of series
9936 name (before the first ; that separates the name from the tags).
9938 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
9940 Specify a character to replace dots (.) in the host part of the metric name.
9941 In I<Graphite> metric name, dots are used as separators between different
9942 metric parts (host, plugin, type).
9943 Default is C<_> (I<Underscore>).
9945 =item B<GraphiteSeparateInstances> B<false>|B<true>
9947 If set to B<true>, the plugin instance and type instance will be in their own
9948 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9949 default), the plugin and plugin instance (and likewise the type and type
9950 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9952 Option value is not used when B<GraphiteUseTags> is I<true>.
9954 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
9956 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9957 identifier. If set to B<false> (the default), this is only done when there is
9960 =item B<GraphitePreserveSeparator> B<false>|B<true>
9962 If set to B<false> (the default) the C<.> (dot) character is replaced with
9963 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
9964 is preserved, i.e. passed through.
9966 Option value is not used when B<GraphiteUseTags> is I<true>.
9968 =item B<GraphiteUseTags> B<false>|B<true>
9970 If set to B<true> Graphite metric names will be generated as tagged series.
9972 Default value: B<false>.
9974 =item B<StoreRates> B<true>|B<false>
9976 If set to B<true> (the default), convert counter values to rates. If set to
9977 B<false> counter values are stored as is, i.e. as an increasing integer number.
9979 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9980 converted values will have "rate" appended to the data source type, e.g.
9981 C<ds_type:derive:rate>.
9985 =item B<Property> I<String> I<String>
9987 Configure the kafka producer through properties, you almost always will
9988 want to set B<metadata.broker.list> to your Kafka broker list.
9992 =head2 Plugin C<write_redis>
9994 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
9998 <Plugin "write_redis">
10011 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
10012 the timestamp as the score. Retrieving a date range can then be done using the
10013 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
10014 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
10015 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
10016 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
10017 with the B<Database> parameter (default is C<0>). See
10018 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
10021 The information shown in the synopsis above is the I<default configuration>
10022 which is used by the plugin if no configuration is present.
10024 The plugin can send values to multiple instances of I<Redis> by specifying
10025 one B<Node> block for each instance. Within the B<Node> blocks, the following
10026 options are available:
10030 =item B<Node> I<Nodename>
10032 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
10033 instance running on a specified host and port. The node name is a
10034 canonical identifier which is used as I<plugin instance>. It is limited to
10035 51E<nbsp>characters in length.
10037 =item B<Host> I<Hostname>
10039 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
10042 =item B<Port> I<Port>
10044 The B<Port> option is the TCP port on which the Redis instance accepts
10045 connections. Either a service name of a port number may be given. Please note
10046 that numerical port numbers must be given as a string, too.
10048 =item B<Timeout> I<Milliseconds>
10050 The B<Timeout> option sets the socket connection timeout, in milliseconds.
10052 =item B<Prefix> I<Prefix>
10054 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
10055 containing all metrics. Defaults to C<collectd/>, so metrics will have names
10056 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
10057 is recommended but not required to include a trailing slash in I<Prefix>.
10059 =item B<Database> I<Index>
10061 This index selects the redis database to use for writing operations. Defaults
10064 =item B<MaxSetSize> I<Items>
10066 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
10067 hold. Negative values for I<Items> sets no limit, which is the default behavior.
10069 =item B<MaxSetDuration> I<Seconds>
10071 The B<MaxSetDuration> option limits the duration of items that the
10072 I<Sorted Sets> can hold. Negative values for I<Items> sets no duration, which
10073 is the default behavior.
10075 =item B<StoreRates> B<true>|B<false>
10077 If set to B<true> (the default), convert counter values to rates. If set to
10078 B<false> counter values are stored as is, i.e. as an increasing integer number.
10082 =head2 Plugin C<write_riemann>
10084 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
10085 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
10086 I<Riemann> using UDP packets.
10090 <Plugin "write_riemann">
10096 AlwaysAppendDS false
10100 Attribute "foo" "bar"
10103 The following options are understood by the I<write_riemann plugin>:
10107 =item E<lt>B<Node> I<Name>E<gt>
10109 The plugin's configuration consists of one or more B<Node> blocks. Each block
10110 is given a unique I<Name> and specifies one connection to an instance of
10111 I<Riemann>. Indise the B<Node> block, the following per-connection options are
10116 =item B<Host> I<Address>
10118 Hostname or address to connect to. Defaults to C<localhost>.
10120 =item B<Port> I<Service>
10122 Service name or port number to connect to. Defaults to C<5555>.
10124 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
10126 Specify the protocol to use when communicating with I<Riemann>. Defaults to
10129 =item B<TLSCertFile> I<Path>
10131 When using the B<TLS> protocol, path to a PEM certificate to present
10134 =item B<TLSCAFile> I<Path>
10136 When using the B<TLS> protocol, path to a PEM CA certificate to
10137 use to validate the remote hosts's identity.
10139 =item B<TLSKeyFile> I<Path>
10141 When using the B<TLS> protocol, path to a PEM private key associated
10142 with the certificate defined by B<TLSCertFile>.
10144 =item B<Batch> B<true>|B<false>
10146 If set to B<true> and B<Protocol> is set to B<TCP>,
10147 events will be batched in memory and flushed at
10148 regular intervals or when B<BatchMaxSize> is exceeded.
10150 Notifications are not batched and sent as soon as possible.
10152 When enabled, it can occur that events get processed by the Riemann server
10153 close to or after their expiration time. Tune the B<TTLFactor> and
10154 B<BatchMaxSize> settings according to the amount of values collected, if this
10159 =item B<BatchMaxSize> I<size>
10161 Maximum payload size for a riemann packet. Defaults to 8192
10163 =item B<BatchFlushTimeout> I<seconds>
10165 Maximum amount of seconds to wait in between to batch flushes.
10166 No timeout by default.
10168 =item B<StoreRates> B<true>|B<false>
10170 If set to B<true> (the default), convert counter values to rates. If set to
10171 B<false> counter values are stored as is, i.e. as an increasing integer number.
10173 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
10174 converted values will have "rate" appended to the data source type, e.g.
10175 C<ds_type:derive:rate>.
10177 =item B<AlwaysAppendDS> B<false>|B<true>
10179 If set to B<true>, append the name of the I<Data Source> (DS) to the
10180 "service", i.e. the field that, together with the "host" field, uniquely
10181 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
10182 only done when there is more than one DS.
10184 =item B<TTLFactor> I<Factor>
10186 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
10187 event is considered active. I<collectd> populates this field based on the
10188 metrics interval setting. This setting controls the factor with which the
10189 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
10190 know exactly what you're doing, you should only increase this setting from its
10193 =item B<Notifications> B<false>|B<true>
10195 If set to B<true>, create riemann events for notifications. This is B<true>
10196 by default. When processing thresholds from write_riemann, it might prove
10197 useful to avoid getting notification events.
10199 =item B<CheckThresholds> B<false>|B<true>
10201 If set to B<true>, attach state to events based on thresholds defined
10202 in the B<Threshold> plugin. Defaults to B<false>.
10204 =item B<EventServicePrefix> I<String>
10206 Add the given string as a prefix to the event service name.
10207 If B<EventServicePrefix> not set or set to an empty string (""),
10208 no prefix will be used.
10212 =item B<Tag> I<String>
10214 Add the given string as an additional tag to the metric being sent to
10217 =item B<Attribute> I<String> I<String>
10219 Consider the two given strings to be the key and value of an additional
10220 attribute for each metric being sent out to I<Riemann>.
10224 =head2 Plugin C<write_sensu>
10226 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
10227 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
10228 a local I<Sensu> client using a TCP socket.
10230 At the moment, the I<write_sensu plugin> does not send over a collectd_host
10231 parameter so it is not possible to use one collectd instance as a gateway for
10232 others. Each collectd host must pair with one I<Sensu> client.
10236 <Plugin "write_sensu">
10241 AlwaysAppendDS false
10242 MetricHandler "influx"
10243 MetricHandler "default"
10244 NotificationHandler "flapjack"
10245 NotificationHandler "howling_monkey"
10249 Attribute "foo" "bar"
10252 The following options are understood by the I<write_sensu plugin>:
10256 =item E<lt>B<Node> I<Name>E<gt>
10258 The plugin's configuration consists of one or more B<Node> blocks. Each block
10259 is given a unique I<Name> and specifies one connection to an instance of
10260 I<Sensu>. Inside the B<Node> block, the following per-connection options are
10265 =item B<Host> I<Address>
10267 Hostname or address to connect to. Defaults to C<localhost>.
10269 =item B<Port> I<Service>
10271 Service name or port number to connect to. Defaults to C<3030>.
10273 =item B<StoreRates> B<true>|B<false>
10275 If set to B<true> (the default), convert counter values to rates. If set to
10276 B<false> counter values are stored as is, i.e. as an increasing integer number.
10278 This will be reflected in the C<collectd_data_source_type> tag: If
10279 B<StoreRates> is enabled, converted values will have "rate" appended to the
10280 data source type, e.g. C<collectd_data_source_type:derive:rate>.
10282 =item B<AlwaysAppendDS> B<false>|B<true>
10284 If set the B<true>, append the name of the I<Data Source> (DS) to the
10285 "service", i.e. the field that, together with the "host" field, uniquely
10286 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
10287 only done when there is more than one DS.
10289 =item B<Notifications> B<false>|B<true>
10291 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
10292 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10294 =item B<Metrics> B<false>|B<true>
10296 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
10297 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10300 =item B<Separator> I<String>
10302 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
10304 =item B<MetricHandler> I<String>
10306 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
10307 several of them, one per line. Defaults to no handler.
10309 =item B<NotificationHandler> I<String>
10311 Add a handler that will be set when notifications are sent to I<Sensu>. You can
10312 add several of them, one per line. Defaults to no handler.
10314 =item B<EventServicePrefix> I<String>
10316 Add the given string as a prefix to the event service name.
10317 If B<EventServicePrefix> not set or set to an empty string (""),
10318 no prefix will be used.
10322 =item B<Tag> I<String>
10324 Add the given string as an additional tag to the metric being sent to
10327 =item B<Attribute> I<String> I<String>
10329 Consider the two given strings to be the key and value of an additional
10330 attribute for each metric being sent out to I<Sensu>.
10334 =head2 Plugin C<xencpu>
10336 This plugin collects metrics of hardware CPU load for machine running Xen
10337 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
10338 Result is reported using the C<percent> type, for each CPU (core).
10340 This plugin doesn't have any options (yet).
10342 =head2 Plugin C<zookeeper>
10344 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
10345 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
10350 <Plugin "zookeeper">
10357 =item B<Host> I<Address>
10359 Hostname or address to connect to. Defaults to C<localhost>.
10361 =item B<Port> I<Service>
10363 Service name or port number to connect to. Defaults to C<2181>.
10367 =head1 THRESHOLD CONFIGURATION
10369 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
10370 we mean that the values are not only stored or sent somewhere, but that they
10371 are judged and, if a problem is recognized, acted upon. The only action
10372 collectd takes itself is to generate and dispatch a "notification". Plugins can
10373 register to receive notifications and perform appropriate further actions.
10375 Since systems and what you expect them to do differ a lot, you can configure
10376 B<thresholds> for your values freely. This gives you a lot of flexibility but
10377 also a lot of responsibility.
10379 Every time a value is out of range a notification is dispatched. This means
10380 that the idle percentage of your CPU needs to be less then the configured
10381 threshold only once for a notification to be generated. There's no such thing
10382 as a moving average or similar - at least not now.
10384 Also, all values that match a threshold are considered to be relevant or
10385 "interesting". As a consequence collectd will issue a notification if they are
10386 not received for B<Timeout> iterations. The B<Timeout> configuration option is
10387 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
10388 "2" (the default) and some hosts sends it's CPU statistics to the server every
10389 60 seconds, a notification will be dispatched after about 120 seconds. It may
10390 take a little longer because the timeout is checked only once each B<Interval>
10393 When a value comes within range again or is received after it was missing, an
10394 "OKAY-notification" is dispatched.
10396 Here is a configuration example to get you started. Read below for more
10409 <Plugin "interface">
10412 FailureMax 10000000
10426 WarningMin 100000000
10432 There are basically two types of configuration statements: The C<Host>,
10433 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
10434 configured. The C<Plugin> and C<Type> blocks may be specified further using the
10435 C<Instance> option. You can combine the block by nesting the blocks, though
10436 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
10437 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
10438 C<Type> may not contain other blocks. If multiple blocks apply to the same
10439 value the most specific block is used.
10441 The other statements specify the threshold to configure. They B<must> be
10442 included in a C<Type> block. Currently the following statements are recognized:
10446 =item B<FailureMax> I<Value>
10448 =item B<WarningMax> I<Value>
10450 Sets the upper bound of acceptable values. If unset defaults to positive
10451 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
10452 will be created. If the value is greater than B<WarningMax> but less than (or
10453 equal to) B<FailureMax> a B<WARNING> notification will be created.
10455 =item B<FailureMin> I<Value>
10457 =item B<WarningMin> I<Value>
10459 Sets the lower bound of acceptable values. If unset defaults to negative
10460 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
10461 be created. If the value is less than B<WarningMin> but greater than (or equal
10462 to) B<FailureMin> a B<WARNING> notification will be created.
10464 =item B<DataSource> I<DSName>
10466 Some data sets have more than one "data source". Interesting examples are the
10467 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
10468 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
10469 system load data set, C<load>, even has three data sources: C<shortterm>,
10470 C<midterm>, and C<longterm>.
10472 Normally, all data sources are checked against a configured threshold. If this
10473 is undesirable, or if you want to specify different limits for each data
10474 source, you can use the B<DataSource> option to have a threshold apply only to
10477 =item B<Invert> B<true>|B<false>
10479 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
10480 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
10481 B<WarningMax>) are not okay. Defaults to B<false>.
10483 =item B<Persist> B<true>|B<false>
10485 Sets how often notifications are generated. If set to B<true> one notification
10486 will be generated for each value that is out of the acceptable range. If set to
10487 B<false> (the default) then a notification is only generated if a value is out
10488 of range but the previous value was okay.
10490 This applies to missing values, too: If set to B<true> a notification about a
10491 missing value is generated once every B<Interval> seconds. If set to B<false>
10492 only one such notification is generated until the value appears again.
10494 =item B<Percentage> B<true>|B<false>
10496 If set to B<true>, the minimum and maximum values given are interpreted as
10497 percentage value, relative to the other data sources. This is helpful for
10498 example for the "df" type, where you may want to issue a warning when less than
10499 5E<nbsp>% of the total space is available. Defaults to B<false>.
10501 =item B<Hits> I<Number>
10503 Delay creating the notification until the threshold has been passed I<Number>
10504 times. When a notification has been generated, or when a subsequent value is
10505 inside the threshold, the counter is reset. If, for example, a value is
10506 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
10507 will be dispatched at most once every 30E<nbsp>seconds.
10509 This is useful when short bursts are not a problem. If, for example, 100% CPU
10510 usage for up to a minute is normal (and data is collected every
10511 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
10513 =item B<Hysteresis> I<Number>
10515 When set to non-zero, a hysteresis value is applied when checking minimum and
10516 maximum bounds. This is useful for values that increase slowly and fluctuate a
10517 bit while doing so. When these values come close to the threshold, they may
10518 "flap", i.e. switch between failure / warning case and okay case repeatedly.
10520 If, for example, the threshold is configures as
10525 then a I<Warning> notification is created when the value exceeds I<101> and the
10526 corresponding I<Okay> notification is only created once the value falls below
10527 I<99>, thus avoiding the "flapping".
10531 =head1 FILTER CONFIGURATION
10533 Starting with collectd 4.6 there is a powerful filtering infrastructure
10534 implemented in the daemon. The concept has mostly been copied from
10535 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
10536 terminology, so that users that are familiar with iptables feel right at home.
10540 The following are the terms used in the remainder of the filter configuration
10541 documentation. For an ASCII-art schema of the mechanism, see
10542 L<"General structure"> below.
10548 A I<match> is a criteria to select specific values. Examples are, of course, the
10549 name of the value or it's current value.
10551 Matches are implemented in plugins which you have to load prior to using the
10552 match. The name of such plugins starts with the "match_" prefix.
10556 A I<target> is some action that is to be performed with data. Such actions
10557 could, for example, be to change part of the value's identifier or to ignore
10558 the value completely.
10560 Some of these targets are built into the daemon, see L<"Built-in targets">
10561 below. Other targets are implemented in plugins which you have to load prior to
10562 using the target. The name of such plugins starts with the "target_" prefix.
10566 The combination of any number of matches and at least one target is called a
10567 I<rule>. The target actions will be performed for all values for which B<all>
10568 matches apply. If the rule does not have any matches associated with it, the
10569 target action will be performed for all values.
10573 A I<chain> is a list of rules and possibly default targets. The rules are tried
10574 in order and if one matches, the associated target will be called. If a value
10575 is handled by a rule, it depends on the target whether or not any subsequent
10576 rules are considered or if traversal of the chain is aborted, see
10577 L<"Flow control"> below. After all rules have been checked, the default targets
10582 =head2 General structure
10584 The following shows the resulting structure:
10591 +---------+ +---------+ +---------+ +---------+
10592 ! Rule !->! Match !->! Match !->! Target !
10593 +---------+ +---------+ +---------+ +---------+
10596 +---------+ +---------+ +---------+
10597 ! Rule !->! Target !->! Target !
10598 +---------+ +---------+ +---------+
10605 +---------+ +---------+ +---------+
10606 ! Rule !->! Match !->! Target !
10607 +---------+ +---------+ +---------+
10615 =head2 Flow control
10617 There are four ways to control which way a value takes through the filter
10624 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
10625 process the value with another chain. When the called chain finishes, usually
10626 the next target or rule after the jump is executed.
10630 The stop condition, signaled for example by the built-in target B<stop>, causes
10631 all processing of the value to be stopped immediately.
10635 Causes processing in the current chain to be aborted, but processing of the
10636 value generally will continue. This means that if the chain was called via
10637 B<Jump>, the next target or rule after the jump will be executed. If the chain
10638 was not called by another chain, control will be returned to the daemon and it
10639 may pass the value to another chain.
10643 Most targets will signal the B<continue> condition, meaning that processing
10644 should continue normally. There is no special built-in target for this
10651 The configuration reflects this structure directly:
10653 PostCacheChain "PostCache"
10654 <Chain "PostCache">
10655 <Rule "ignore_mysql_show">
10658 Type "^mysql_command$"
10659 TypeInstance "^show_"
10669 The above configuration example will ignore all values where the plugin field
10670 is "mysql", the type is "mysql_command" and the type instance begins with
10671 "show_". All other values will be sent to the C<rrdtool> write plugin via the
10672 default target of the chain. Since this chain is run after the value has been
10673 added to the cache, the MySQL C<show_*> command statistics will be available
10674 via the C<unixsock> plugin.
10676 =head2 List of configuration options
10680 =item B<PreCacheChain> I<ChainName>
10682 =item B<PostCacheChain> I<ChainName>
10684 Configure the name of the "pre-cache chain" and the "post-cache chain". The
10685 argument is the name of a I<chain> that should be executed before and/or after
10686 the values have been added to the cache.
10688 To understand the implications, it's important you know what is going on inside
10689 I<collectd>. The following diagram shows how values are passed from the
10690 read-plugins to the write-plugins:
10696 + - - - - V - - - - +
10697 : +---------------+ :
10700 : +-------+-------+ :
10703 : +-------+-------+ : +---------------+
10704 : ! Cache !--->! Value Cache !
10705 : ! insert ! : +---+---+-------+
10706 : +-------+-------+ : ! !
10707 : ! ,------------' !
10709 : +-------+---+---+ : +-------+-------+
10710 : ! Post-Cache +--->! Write-Plugins !
10711 : ! Chain ! : +---------------+
10712 : +---------------+ :
10714 : dispatch values :
10715 + - - - - - - - - - +
10717 After the values are passed from the "read" plugins to the dispatch functions,
10718 the pre-cache chain is run first. The values are added to the internal cache
10719 afterwards. The post-cache chain is run after the values have been added to the
10720 cache. So why is it such a huge deal if chains are run before or after the
10721 values have been added to this cache?
10723 Targets that change the identifier of a value list should be executed before
10724 the values are added to the cache, so that the name in the cache matches the
10725 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
10726 this cache to receive a list of all available values. If you change the
10727 identifier after the value list has been added to the cache, this may easily
10728 lead to confusion, but it's not forbidden of course.
10730 The cache is also used to convert counter values to rates. These rates are, for
10731 example, used by the C<value> match (see below). If you use the rate stored in
10732 the cache B<before> the new value is added, you will use the old, B<previous>
10733 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
10734 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
10737 Last but not last, the B<stop> target makes a difference: If the pre-cache
10738 chain returns the stop condition, the value will not be added to the cache and
10739 the post-cache chain will not be run.
10741 =item B<Chain> I<Name>
10743 Adds a new chain with a certain name. This name can be used to refer to a
10744 specific chain, for example to jump to it.
10746 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
10748 =item B<Rule> [I<Name>]
10750 Adds a new rule to the current chain. The name of the rule is optional and
10751 currently has no meaning for the daemon.
10753 Within the B<Rule> block, there may be any number of B<Match> blocks and there
10754 must be at least one B<Target> block.
10756 =item B<Match> I<Name>
10758 Adds a match to a B<Rule> block. The name specifies what kind of match should
10759 be performed. Available matches depend on the plugins that have been loaded.
10761 The arguments inside the B<Match> block are passed to the plugin implementing
10762 the match, so which arguments are valid here depends on the plugin being used.
10763 If you do not need any to pass any arguments to a match, you can use the
10768 Which is equivalent to:
10773 =item B<Target> I<Name>
10775 Add a target to a rule or a default target to a chain. The name specifies what
10776 kind of target is to be added. Which targets are available depends on the
10777 plugins being loaded.
10779 The arguments inside the B<Target> block are passed to the plugin implementing
10780 the target, so which arguments are valid here depends on the plugin being used.
10781 If you do not need any to pass any arguments to a target, you can use the
10786 This is the same as writing:
10793 =head2 Built-in targets
10795 The following targets are built into the core daemon and therefore need no
10796 plugins to be loaded:
10802 Signals the "return" condition, see the L<"Flow control"> section above. This
10803 causes the current chain to stop processing the value and returns control to
10804 the calling chain. The calling chain will continue processing targets and rules
10805 just after the B<jump> target (see below). This is very similar to the
10806 B<RETURN> target of iptables, see L<iptables(8)>.
10808 This target does not have any options.
10816 Signals the "stop" condition, see the L<"Flow control"> section above. This
10817 causes processing of the value to be aborted immediately. This is similar to
10818 the B<DROP> target of iptables, see L<iptables(8)>.
10820 This target does not have any options.
10828 Sends the value to "write" plugins.
10834 =item B<Plugin> I<Name>
10836 Name of the write plugin to which the data should be sent. This option may be
10837 given multiple times to send the data to more than one write plugin. If the
10838 plugin supports multiple instances, the plugin's instance(s) must also be
10843 If no plugin is explicitly specified, the values will be sent to all available
10846 Single-instance plugin example:
10852 Multi-instance plugin example:
10854 <Plugin "write_graphite">
10864 Plugin "write_graphite/foo"
10869 Starts processing the rules of another chain, see L<"Flow control"> above. If
10870 the end of that chain is reached, or a stop condition is encountered,
10871 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
10872 next target or the next rule. This is similar to the B<-j> command line option
10873 of iptables, see L<iptables(8)>.
10879 =item B<Chain> I<Name>
10881 Jumps to the chain I<Name>. This argument is required and may appear only once.
10893 =head2 Available matches
10899 Matches a value using regular expressions.
10905 =item B<Host> I<Regex>
10907 =item B<Plugin> I<Regex>
10909 =item B<PluginInstance> I<Regex>
10911 =item B<Type> I<Regex>
10913 =item B<TypeInstance> I<Regex>
10915 =item B<MetaData> I<String> I<Regex>
10917 Match values where the given regular expressions match the various fields of
10918 the identifier of a value. If multiple regular expressions are given, B<all>
10919 regexen must match for a value to match.
10921 =item B<Invert> B<false>|B<true>
10923 When set to B<true>, the result of the match is inverted, i.e. all value lists
10924 where all regular expressions apply are not matched, all other value lists are
10925 matched. Defaults to B<false>.
10932 Host "customer[0-9]+"
10938 Matches values that have a time which differs from the time on the server.
10940 This match is mainly intended for servers that receive values over the
10941 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
10942 is very sensitive to the timestamp used when updating the RRD files. In
10943 particular, the time must be ever increasing. If a misbehaving client sends one
10944 packet with a timestamp far in the future, all further packets with a correct
10945 time will be ignored because of that one packet. What's worse, such corrupted
10946 RRD files are hard to fix.
10948 This match lets one match all values B<outside> a specified time range
10949 (relative to the server's time), so you can use the B<stop> target (see below)
10950 to ignore the value, for example.
10956 =item B<Future> I<Seconds>
10958 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
10959 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10962 =item B<Past> I<Seconds>
10964 Matches all values that are I<behind> of the server's time by I<Seconds> or
10965 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10977 This example matches all values that are five minutes or more ahead of the
10978 server or one hour (or more) lagging behind.
10982 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
10983 values. If a data-set consists of more than one data-source, all data-sources
10984 must match the specified ranges for a positive match.
10990 =item B<Min> I<Value>
10992 Sets the smallest value which still results in a match. If unset, behaves like
10995 =item B<Max> I<Value>
10997 Sets the largest value which still results in a match. If unset, behaves like
11000 =item B<Invert> B<true>|B<false>
11002 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
11003 no-match is returned and vice versa. Please note that the B<Invert> setting
11004 only effects how B<Min> and B<Max> are applied to a specific value. Especially
11005 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
11007 =item B<DataSource> I<DSName> [I<DSName> ...]
11009 Select one or more of the data sources. If no data source is configured, all
11010 data sources will be checked. If the type handled by the match does not have a
11011 data source of the specified name(s), this will always result in no match
11012 (independent of the B<Invert> setting).
11014 =item B<Satisfy> B<Any>|B<All>
11016 Specifies how checking with several data sources is performed. If set to
11017 B<Any>, the match succeeds if one of the data sources is in the configured
11018 range. If set to B<All> the match only succeeds if all data sources are within
11019 the configured range. Default is B<All>.
11021 Usually B<All> is used for positive matches, B<Any> is used for negative
11022 matches. This means that with B<All> you usually check that all values are in a
11023 "good" range, while with B<Any> you check if any value is within a "bad" range
11024 (or outside the "good" range).
11028 Either B<Min> or B<Max>, but not both, may be unset.
11032 # Match all values smaller than or equal to 100. Matches only if all data
11033 # sources are below 100.
11039 # Match if the value of any data source is outside the range of 0 - 100.
11047 =item B<empty_counter>
11049 Matches all values with one or more data sources of type B<COUNTER> and where
11050 all counter values are zero. These counters usually I<never> increased since
11051 they started existing (and are therefore uninteresting), or got reset recently
11052 or overflowed and you had really, I<really> bad luck.
11054 Please keep in mind that ignoring such counters can result in confusing
11055 behavior: Counters which hardly ever increase will be zero for long periods of
11056 time. If the counter is reset for some reason (machine or service restarted,
11057 usually), the graph will be empty (NAN) for a long time. People may not
11062 Calculates a hash value of the host name and matches values according to that
11063 hash value. This makes it possible to divide all hosts into groups and match
11064 only values that are in a specific group. The intended use is in load
11065 balancing, where you want to handle only part of all data and leave the rest
11068 The hashing function used tries to distribute the hosts evenly. First, it
11069 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
11072 for (i = 0; host[i] != 0; i++)
11073 hash_value = (hash_value * 251) + host[i];
11075 The constant 251 is a prime number which is supposed to make this hash value
11076 more random. The code then checks the group for this host according to the
11077 I<Total> and I<Match> arguments:
11079 if ((hash_value % Total) == Match)
11084 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
11085 groups), then the least significant bit of the hash value will be the XOR of
11086 all least significant bits in the host name. One consequence is that when you
11087 have two hosts, "server0.example.com" and "server1.example.com", where the host
11088 name differs in one digit only and the digits differ by one, those hosts will
11089 never end up in the same group.
11095 =item B<Match> I<Match> I<Total>
11097 Divide the data into I<Total> groups and match all hosts in group I<Match> as
11098 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
11099 be smaller than I<Total>. I<Total> must be at least one, although only values
11100 greater than one really do make any sense.
11102 You can repeat this option to match multiple groups, for example:
11107 The above config will divide the data into seven groups and match groups three
11108 and five. One use would be to keep every value on two hosts so that if one
11109 fails the missing data can later be reconstructed from the second host.
11115 # Operate on the pre-cache chain, so that ignored values are not even in the
11120 # Divide all received hosts in seven groups and accept all hosts in
11124 # If matched: Return and continue.
11127 # If not matched: Return and stop.
11133 =head2 Available targets
11137 =item B<notification>
11139 Creates and dispatches a notification.
11145 =item B<Message> I<String>
11147 This required option sets the message of the notification. The following
11148 placeholders will be replaced by an appropriate value:
11156 =item B<%{plugin_instance}>
11160 =item B<%{type_instance}>
11162 These placeholders are replaced by the identifier field of the same name.
11164 =item B<%{ds:>I<name>B<}>
11166 These placeholders are replaced by a (hopefully) human readable representation
11167 of the current rate of this data source. If you changed the instance name
11168 (using the B<set> or B<replace> targets, see below), it may not be possible to
11169 convert counter values to rates.
11173 Please note that these placeholders are B<case sensitive>!
11175 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
11177 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
11184 <Target "notification">
11185 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
11191 Replaces parts of the identifier using regular expressions.
11197 =item B<Host> I<Regex> I<Replacement>
11199 =item B<Plugin> I<Regex> I<Replacement>
11201 =item B<PluginInstance> I<Regex> I<Replacement>
11203 =item B<TypeInstance> I<Regex> I<Replacement>
11205 =item B<MetaData> I<String> I<Regex> I<Replacement>
11207 =item B<DeleteMetaData> I<String> I<Regex>
11209 Match the appropriate field with the given regular expression I<Regex>. If the
11210 regular expression matches, that part that matches is replaced with
11211 I<Replacement>. If multiple places of the input buffer match a given regular
11212 expression, only the first occurrence will be replaced.
11214 You can specify each option multiple times to use multiple regular expressions
11222 # Replace "example.net" with "example.com"
11223 Host "\\<example.net\\>" "example.com"
11225 # Strip "www." from hostnames
11226 Host "\\<www\\." ""
11231 Sets part of the identifier of a value to a given string.
11237 =item B<Host> I<String>
11239 =item B<Plugin> I<String>
11241 =item B<PluginInstance> I<String>
11243 =item B<TypeInstance> I<String>
11245 =item B<MetaData> I<String> I<String>
11247 Set the appropriate field to the given string. The strings for plugin instance,
11248 type instance, and meta data may be empty, the strings for host and plugin may
11249 not be empty. It's currently not possible to set the type of a value this way.
11251 The following placeholders will be replaced by an appropriate value:
11259 =item B<%{plugin_instance}>
11263 =item B<%{type_instance}>
11265 These placeholders are replaced by the identifier field of the same name.
11267 =item B<%{meta:>I<name>B<}>
11269 These placeholders are replaced by the meta data value with the given name.
11273 Please note that these placeholders are B<case sensitive>!
11275 =item B<DeleteMetaData> I<String>
11277 Delete the named meta data field.
11284 PluginInstance "coretemp"
11285 TypeInstance "core3"
11290 =head2 Backwards compatibility
11292 If you use collectd with an old configuration, i.E<nbsp>e. one without a
11293 B<Chain> block, it will behave as it used to. This is equivalent to the
11294 following configuration:
11296 <Chain "PostCache">
11300 If you specify a B<PostCacheChain>, the B<write> target will not be added
11301 anywhere and you will have to make sure that it is called where appropriate. We
11302 suggest to add the above snippet as default target to your "PostCache" chain.
11306 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
11321 B<Ignorelists> are a generic framework to either ignore some metrics or report
11322 specific metircs only. Plugins usually provide one or more options to specify
11323 the items (mounts points, devices, ...) and the boolean option
11328 =item B<Select> I<String>
11330 Selects the item I<String>. This option often has a plugin specific name, e.g.
11331 B<Sensor> in the C<sensors> plugin. It is also plugin specific what this string
11332 is compared to. For example, the C<df> plugin's B<MountPoint> compares it to a
11333 mount point and the C<sensors> plugin's B<Sensor> compares it to a sensor name.
11335 By default, this option is doing a case-sensitive full-string match. The
11336 following config will match C<foo>, but not C<Foo>:
11340 If I<String> starts and ends with C</> (a slash), the string is compiled as a
11341 I<regular expression>. For example, so match all item starting with C<foo>, use
11342 could use the following syntax:
11346 The regular expression is I<not> anchored, i.e. the following config will match
11347 C<foobar>, C<barfoo> and C<AfooZ>:
11351 The B<Select> option may be repeated to select multiple items.
11353 =item B<IgnoreSelected> B<true>|B<false>
11355 If set to B<true>, matching metrics are I<ignored> and all other metrics are
11356 collected. If set to B<false>, matching metrics are I<collected> and all other
11357 metrics are ignored.
11364 L<collectd-exec(5)>,
11365 L<collectd-perl(5)>,
11366 L<collectd-unixsock(5)>,
11379 Florian Forster E<lt>octo@collectd.orgE<gt>