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 Connectivity
1579 connectivity - Documentation of collectd's C<connectivity plugin>
1582 LoadPlugin connectivity
1584 <Plugin connectivity>
1588 The C<connectivity plugin> queries interface status using netlink (man 7 netlink) which provides information about network interfaces via the NETLINK_ROUTE family (man 7 rtnetlink). The plugin translates the value it receives to collectd's internal format and, depending on the write plugins you have loaded, it may be written to disk or submitted to another instance.
1589 The plugin listens to interfaces enumerated within the plugin configuration (see below). If no interfaces are listed, then the default is for all interfaces to be monitored.
1591 This example shows C<connectivity plugin> monitoring all interfaces.
1592 LoadPlugin connectivity
1593 <Plugin connectivity>
1596 This example shows C<connectivity plugin> monitoring 2 interfaces, "eth0" and "eth1".
1597 LoadPlugin connectivity
1598 <Plugin connectivity>
1603 This example shows C<connectivity plugin> monitoring all interfaces except "eth1".
1604 LoadPlugin connectivity
1605 <Plugin connectivity>
1612 =item B<Interface> I<interface_name>
1614 interface(s) to monitor connect to.
1618 If I<Status> is greater than or equal to zero the message indicates interface is up,
1619 if I<Status> is less than zero the message indicates interface is down.
1623 =head2 Plugin C<conntrack>
1625 This plugin collects IP conntrack statistics.
1631 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1632 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1636 =head2 Plugin C<cpu>
1638 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1639 as Jiffies, using the C<cpu> type. Two aggregations are available:
1645 Sum, per-state, over all CPUs installed in the system; and
1649 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1653 The two aggregations can be combined, leading to I<collectd> only emitting a
1654 single "active" metric for the entire system. As soon as one of these
1655 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1656 rather than Jiffies. In addition, you can request individual, per-state,
1657 per-CPU metrics to be reported as percentage.
1659 The following configuration options are available:
1663 =item B<ReportByState> B<true>|B<false>
1665 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1667 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1670 =item B<ReportByCpu> B<true>|B<false>
1672 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1673 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1674 global sum of CPU states is emitted.
1676 =item B<ValuesPercentage> B<false>|B<true>
1678 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1679 are set to B<true>. In this case, by default, metrics will be reported as
1680 Jiffies. By setting this option to B<true>, you can request percentage values
1681 in the un-aggregated (per-CPU, per-state) mode as well.
1683 =item B<ReportNumCpu> B<false>|B<true>
1685 When set to B<true>, reports the number of available CPUs.
1686 Defaults to B<false>.
1688 =item B<ReportGuestState> B<false>|B<true>
1690 When set to B<true>, reports the "guest" and "guest_nice" CPU states.
1691 Defaults to B<false>.
1693 =item B<SubtractGuestState> B<false>|B<true>
1695 This option is only considered when B<ReportGuestState> is set to B<true>.
1696 "guest" and "guest_nice" are included in respectively "user" and "nice".
1697 If set to B<true>, "guest" will be subtracted from "user" and "guest_nice"
1698 will be subtracted from "nice".
1699 Defaults to B<true>.
1703 =head2 Plugin C<cpufreq>
1705 This plugin is available on Linux and FreeBSD only. It doesn't have any
1706 options. On Linux it reads
1707 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1708 installed) to get the current CPU frequency. If this file does not exist make
1709 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1710 installed and an "cpu governor" (that's a kernel module) is loaded.
1712 On Linux, if the system has the I<cpufreq-stats> kernel module loaded, this
1713 plugin reports the rate of p-state (cpu frequency) transitions and the
1714 percentage of time spent in each p-state.
1716 On FreeBSD it does a sysctl dev.cpu.0.freq and submits this as instance 0.
1717 At this time FreeBSD only has one frequency setting for all cores.
1718 See the BUGS section in the FreeBSD man page for cpufreq(4) for more details.
1720 On FreeBSD the plugin checks the success of sysctl dev.cpu.0.freq and
1721 unregisters the plugin when this fails. A message will be logged to indicate
1724 =head2 Plugin C<cpusleep>
1726 This plugin doesn't have any options. It reads CLOCK_BOOTTIME and
1727 CLOCK_MONOTONIC and reports the difference between these clocks. Since
1728 BOOTTIME clock increments while device is suspended and MONOTONIC
1729 clock does not, the derivative of the difference between these clocks
1730 gives the relative amount of time the device has spent in suspend
1731 state. The recorded value is in milliseconds of sleep per seconds of
1734 =head2 Plugin C<csv>
1738 =item B<DataDir> I<Directory>
1740 Set the directory to store CSV-files under. Per default CSV-files are generated
1741 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1742 The special strings B<stdout> and B<stderr> can be used to write to the standard
1743 output and standard error channels, respectively. This, of course, only makes
1744 much sense when collectd is running in foreground- or non-daemon-mode.
1746 =item B<StoreRates> B<true|false>
1748 If set to B<true>, convert counter values to rates. If set to B<false> (the
1749 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1754 =head2 cURL Statistics
1756 All cURL-based plugins support collection of generic, request-based
1757 statistics. These are disabled by default and can be enabled selectively for
1758 each page or URL queried from the curl, curl_json, or curl_xml plugins. See
1759 the documentation of those plugins for specific information. This section
1760 describes the available metrics that can be configured for each plugin. All
1761 options are disabled by default.
1763 See L<http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html> for more details.
1767 =item B<TotalTime> B<true|false>
1769 Total time of the transfer, including name resolving, TCP connect, etc.
1771 =item B<NamelookupTime> B<true|false>
1773 Time it took from the start until name resolving was completed.
1775 =item B<ConnectTime> B<true|false>
1777 Time it took from the start until the connect to the remote host (or proxy)
1780 =item B<AppconnectTime> B<true|false>
1782 Time it took from the start until the SSL/SSH connect/handshake to the remote
1785 =item B<PretransferTime> B<true|false>
1787 Time it took from the start until just before the transfer begins.
1789 =item B<StarttransferTime> B<true|false>
1791 Time it took from the start until the first byte was received.
1793 =item B<RedirectTime> B<true|false>
1795 Time it took for all redirection steps include name lookup, connect,
1796 pre-transfer and transfer before final transaction was started.
1798 =item B<RedirectCount> B<true|false>
1800 The total number of redirections that were actually followed.
1802 =item B<SizeUpload> B<true|false>
1804 The total amount of bytes that were uploaded.
1806 =item B<SizeDownload> B<true|false>
1808 The total amount of bytes that were downloaded.
1810 =item B<SpeedDownload> B<true|false>
1812 The average download speed that curl measured for the complete download.
1814 =item B<SpeedUpload> B<true|false>
1816 The average upload speed that curl measured for the complete upload.
1818 =item B<HeaderSize> B<true|false>
1820 The total size of all the headers received.
1822 =item B<RequestSize> B<true|false>
1824 The total size of the issued requests.
1826 =item B<ContentLengthDownload> B<true|false>
1828 The content-length of the download.
1830 =item B<ContentLengthUpload> B<true|false>
1832 The specified size of the upload.
1834 =item B<NumConnects> B<true|false>
1836 The number of new connections that were created to achieve the transfer.
1840 =head2 Plugin C<curl>
1842 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1843 and the match infrastructure (the same code used by the tail plugin) to use
1844 regular expressions with the received data.
1846 The following example will read the current value of AMD stock from Google's
1847 finance page and dispatch the value to collectd.
1850 <Page "stock_quotes">
1852 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1859 CACert "/path/to/ca.crt"
1860 Header "X-Custom-Header: foobar"
1863 MeasureResponseTime false
1864 MeasureResponseCode false
1867 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1868 DSType "GaugeAverage"
1869 # Note: `stock_value' is not a standard type.
1876 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1877 a web page and one or more "matches" to be performed on the returned data. The
1878 string argument to the B<Page> block is used as plugin instance.
1880 The following options are valid within B<Page> blocks:
1884 =item B<Plugin> I<Plugin>
1886 Use I<Plugin> as the plugin name when submitting values.
1887 Defaults to C<curl>.
1891 URL of the web site to retrieve. Since a regular expression will be used to
1892 extract information from this data, non-binary data is a big plus here ;)
1894 =item B<AddressFamily> I<Type>
1896 IP version to resolve URL to. Useful in cases when hostname in URL resolves
1897 to both IPv4 and IPv6 addresses, and you are interested in using one of them
1899 Use C<ipv4> to enforce IPv4, C<ipv6> to enforce IPv6, or C<any> to keep the
1900 default behavior of resolving addresses to all IP versions your system allows.
1901 If C<libcurl> is compiled without IPv6 support, using C<ipv6> will result in
1902 a warning and fallback to C<any>.
1903 If C<Type> cannot be parsed, a warning will be printed and the whole B<Page>
1904 block will be ignored.
1906 =item B<User> I<Name>
1908 Username to use if authorization is required to read the page.
1910 =item B<Password> I<Password>
1912 Password to use if authorization is required to read the page.
1914 =item B<Digest> B<true>|B<false>
1916 Enable HTTP digest authentication.
1918 =item B<VerifyPeer> B<true>|B<false>
1920 Enable or disable peer SSL certificate verification. See
1921 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1923 =item B<VerifyHost> B<true>|B<false>
1925 Enable or disable peer host name verification. If enabled, the plugin checks if
1926 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1927 matches the host name provided by the B<URL> option. If this identity check
1928 fails, the connection is aborted. Obviously, only works when connecting to a
1929 SSL enabled server. Enabled by default.
1931 =item B<CACert> I<file>
1933 File that holds one or more SSL certificates. If you want to use HTTPS you will
1934 possibly need this option. What CA certificates come bundled with C<libcurl>
1935 and are checked by default depends on the distribution you use.
1937 =item B<Header> I<Header>
1939 A HTTP header to add to the request. Multiple headers are added if this option
1940 is specified more than once.
1942 =item B<Post> I<Body>
1944 Specifies that the HTTP operation should be a POST instead of a GET. The
1945 complete data to be posted is given as the argument. This option will usually
1946 need to be accompanied by a B<Header> option to set an appropriate
1947 C<Content-Type> for the post body (e.g. to
1948 C<application/x-www-form-urlencoded>).
1950 =item B<MeasureResponseTime> B<true>|B<false>
1952 Measure response time for the request. If this setting is enabled, B<Match>
1953 blocks (see below) are optional. Disabled by default.
1955 Beware that requests will get aborted if they take too long to complete. Adjust
1956 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1959 This option is similar to enabling the B<TotalTime> statistic but it's
1960 measured by collectd instead of cURL.
1962 =item B<MeasureResponseCode> B<true>|B<false>
1964 Measure response code for the request. If this setting is enabled, B<Match>
1965 blocks (see below) are optional. Disabled by default.
1967 =item B<E<lt>StatisticsE<gt>>
1969 One B<Statistics> block can be used to specify cURL statistics to be collected
1970 for each request to the remote web site. See the section "cURL Statistics"
1971 above for details. If this setting is enabled, B<Match> blocks (see below) are
1974 =item B<E<lt>MatchE<gt>>
1976 One or more B<Match> blocks that define how to match information in the data
1977 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1978 used by the C<tail> plugin, so please see the documentation of the C<tail>
1979 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1980 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1983 =item B<Interval> I<Interval>
1985 Sets the interval (in seconds) in which the values will be collected from this
1986 URL. By default the global B<Interval> setting will be used.
1988 =item B<Timeout> I<Milliseconds>
1990 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1991 milliseconds. By default, the configured B<Interval> is used to set the
1992 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1993 indefinitely. This legacy behaviour can be achieved by setting the value of
1996 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1997 network connection will stall one read thread. Adjust the B<ReadThreads> global
1998 setting accordingly to prevent this from blocking other plugins.
2002 =head2 Plugin C<curl_json>
2004 The B<curl_json plugin> collects values from JSON data to be parsed by
2005 B<libyajl> (L<https://lloyd.github.io/yajl/>) retrieved via
2006 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
2007 unix socket. The former can be used, for example, to collect values
2008 from CouchDB documents (which are stored JSON notation), and the
2009 latter to collect values from a uWSGI stats socket.
2011 The following example will collect several values from the built-in
2012 C<_stats> runtime statistics module of I<CouchDB>
2013 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
2016 <URL "http://localhost:5984/_stats">
2019 <Key "httpd/requests/count">
2020 Type "http_requests"
2023 <Key "httpd_request_methods/*/count">
2024 Type "http_request_methods"
2027 <Key "httpd_status_codes/*/count">
2028 Type "http_response_codes"
2033 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
2036 <Sock "/var/run/uwsgi.stats.sock">
2038 <Key "workers/*/requests">
2039 Type "http_requests"
2042 <Key "workers/*/apps/*/requests">
2043 Type "http_requests"
2048 In the B<Plugin> block, there may be one or more B<URL> blocks, each
2049 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
2050 blocks defining a unix socket to read JSON from directly. Each of
2051 these blocks may have one or more B<Key> blocks.
2053 The B<Key> string argument must be in a path format. Each component is
2054 used to match the key from a JSON map or the index of an JSON
2055 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
2056 values for all map keys or array indices will be collectd.
2058 The following options are valid within B<URL> blocks:
2062 =item B<AddressFamily> I<Type>
2064 IP version to resolve URL to. Useful in cases when hostname in URL resolves
2065 to both IPv4 and IPv6 addresses, and you are interested in using one of them
2067 Use C<ipv4> to enforce IPv4, C<ipv6> to enforce IPv6, or C<any> to keep the
2068 default behavior of resolving addresses to all IP versions your system allows.
2069 If C<libcurl> is compiled without IPv6 support, using C<ipv6> will result in
2070 a warning and fallback to C<any>.
2071 If C<Type> cannot be parsed, a warning will be printed and the whole B<URL>
2072 block will be ignored.
2074 =item B<Host> I<Name>
2076 Use I<Name> as the host name when submitting values. Defaults to the global
2079 =item B<Plugin> I<Plugin>
2081 Use I<Plugin> as the plugin name when submitting values.
2082 Defaults to C<curl_json>.
2084 =item B<Instance> I<Instance>
2086 Sets the plugin instance to I<Instance>.
2088 =item B<Interval> I<Interval>
2090 Sets the interval (in seconds) in which the values will be collected from this
2091 URL. By default the global B<Interval> setting will be used.
2093 =item B<User> I<Name>
2095 =item B<Password> I<Password>
2097 =item B<Digest> B<true>|B<false>
2099 =item B<VerifyPeer> B<true>|B<false>
2101 =item B<VerifyHost> B<true>|B<false>
2103 =item B<CACert> I<file>
2105 =item B<Header> I<Header>
2107 =item B<Post> I<Body>
2109 =item B<Timeout> I<Milliseconds>
2111 These options behave exactly equivalent to the appropriate options of the
2112 I<cURL> plugin. Please see there for a detailed description.
2114 =item B<E<lt>StatisticsE<gt>>
2116 One B<Statistics> block can be used to specify cURL statistics to be collected
2117 for each request to the remote URL. See the section "cURL Statistics" above
2122 The following options are valid within B<Key> blocks:
2126 =item B<Type> I<Type>
2128 Sets the type used to dispatch the values to the daemon. Detailed information
2129 about types and their configuration can be found in L<types.db(5)>. This
2130 option is mandatory.
2132 =item B<Instance> I<Instance>
2134 Type-instance to use. Defaults to the current map key or current string array element value.
2138 =head2 Plugin C<curl_xml>
2140 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
2141 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
2144 <URL "http://localhost/stats.xml">
2148 Instance "some_instance"
2153 CACert "/path/to/ca.crt"
2154 Header "X-Custom-Header: foobar"
2157 <XPath "table[@id=\"magic_level\"]/tr">
2159 #InstancePrefix "prefix-"
2160 InstanceFrom "td[1]"
2161 #PluginInstanceFrom "td[1]"
2162 ValuesFrom "td[2]/span[@class=\"level\"]"
2167 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
2168 URL to be fetched using libcurl. Within each B<URL> block there are
2169 options which specify the connection parameters, for example authentication
2170 information, and one or more B<XPath> blocks.
2172 Each B<XPath> block specifies how to get one type of information. The
2173 string argument must be a valid XPath expression which returns a list
2174 of "base elements". One value is dispatched for each "base element". The
2175 I<type instance> and values are looked up using further I<XPath> expressions
2176 that should be relative to the base element.
2178 Within the B<URL> block the following options are accepted:
2182 =item B<AddressFamily> I<Type>
2184 IP version to resolve URL to. Useful in cases when hostname in URL resolves
2185 to both IPv4 and IPv6 addresses, and you are interested in using one of them
2187 Use C<ipv4> to enforce IPv4, C<ipv6> to enforce IPv6, or C<any> to keep the
2188 default behavior of resolving addresses to all IP versions your system allows.
2189 If C<libcurl> is compiled without IPv6 support, using C<ipv6> will result in
2190 a warning and fallback to C<any>.
2191 If C<Type> cannot be parsed, a warning will be printed and the whole B<URL>
2192 block will be ignored.
2194 =item B<Host> I<Name>
2196 Use I<Name> as the host name when submitting values. Defaults to the global
2199 =item B<Plugin> I<Plugin>
2201 Use I<Plugin> as the plugin name when submitting values.
2202 Defaults to 'curl_xml'.
2204 =item B<Instance> I<Instance>
2206 Use I<Instance> as the plugin instance when submitting values.
2207 May be overridden by B<PluginInstanceFrom> option inside B<XPath> blocks.
2208 Defaults to an empty string (no plugin instance).
2210 =item B<Interval> I<Interval>
2212 Sets the interval (in seconds) in which the values will be collected from this
2213 URL. By default the global B<Interval> setting will be used.
2215 =item B<Namespace> I<Prefix> I<URL>
2217 If an XPath expression references namespaces, they must be specified
2218 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
2219 I<URL> is the "namespace name", an URI reference uniquely identifying the
2220 namespace. The option can be repeated to register multiple namespaces.
2224 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
2225 Namespace "m" "http://www.w3.org/1998/Math/MathML"
2227 =item B<User> I<User>
2229 =item B<Password> I<Password>
2231 =item B<Digest> B<true>|B<false>
2233 =item B<VerifyPeer> B<true>|B<false>
2235 =item B<VerifyHost> B<true>|B<false>
2237 =item B<CACert> I<CA Cert File>
2239 =item B<Header> I<Header>
2241 =item B<Post> I<Body>
2243 =item B<Timeout> I<Milliseconds>
2245 These options behave exactly equivalent to the appropriate options of the
2246 I<cURL plugin>. Please see there for a detailed description.
2248 =item B<E<lt>StatisticsE<gt>>
2250 One B<Statistics> block can be used to specify cURL statistics to be collected
2251 for each request to the remote URL. See the section "cURL Statistics" above
2254 =item E<lt>B<XPath> I<XPath-expression>E<gt>
2256 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
2257 B<XPath> block specifies how to get one type of information. The string
2258 argument must be a valid XPath expression which returns a list of "base
2259 elements". One value is dispatched for each "base element".
2261 Within the B<XPath> block the following options are accepted:
2265 =item B<Type> I<Type>
2267 Specifies the I<Type> used for submitting patches. This determines the number
2268 of values that are required / expected and whether the strings are parsed as
2269 signed or unsigned integer or as double values. See L<types.db(5)> for details.
2270 This option is required.
2272 =item B<InstancePrefix> I<InstancePrefix>
2274 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
2275 concatenated together without any separator.
2276 This option is optional.
2278 =item B<InstanceFrom> I<InstanceFrom>
2280 Specifies a XPath expression to use for determining the I<type instance>. The
2281 XPath expression must return exactly one element. The element's value is then
2282 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
2284 =item B<PluginInstanceFrom> I<PluginInstanceFrom>
2286 Specifies a XPath expression to use for determining the I<plugin instance>. The
2287 XPath expression must return exactly one element. The element's value is then
2288 used as I<plugin instance>.
2292 If the "base XPath expression" (the argument to the B<XPath> block) returns
2293 exactly one argument, then I<InstanceFrom> and I<PluginInstanceFrom> may be omitted.
2294 Otherwise, at least one of I<InstanceFrom> or I<PluginInstanceFrom> is required.
2298 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
2300 Specifies one or more XPath expression to use for reading the values. The
2301 number of XPath expressions must match the number of data sources in the
2302 I<type> specified with B<Type> (see above). Each XPath expression must return
2303 exactly one element. The element's value is then parsed as a number and used as
2304 value for the appropriate value in the value list dispatched to the daemon.
2305 This option is required.
2311 =head2 Plugin C<dbi>
2313 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
2314 connect to various databases, execute I<SQL> statements and read back the
2315 results. I<dbi> is an acronym for "database interface" in case you were
2316 wondering about the name. You can configure how each column is to be
2317 interpreted and the plugin will generate one or more data sets from each row
2318 returned according to these rules.
2320 Because the plugin is very generic, the configuration is a little more complex
2321 than those of other plugins. It usually looks something like this:
2324 <Query "out_of_stock">
2325 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
2326 # Use with MySQL 5.0.0 or later
2330 InstancePrefix "out_of_stock"
2331 InstancesFrom "category"
2335 <Database "product_information">
2339 DriverOption "host" "localhost"
2340 DriverOption "username" "collectd"
2341 DriverOption "password" "aZo6daiw"
2342 DriverOption "dbname" "prod_info"
2343 SelectDB "prod_info"
2344 Query "out_of_stock"
2348 The configuration above defines one query with one result and one database. The
2349 query is then linked to the database with the B<Query> option I<within> the
2350 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
2351 and you can also use the B<Include> statement to split up the configuration
2352 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
2353 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
2356 The following is a complete list of options:
2358 =head3 B<Query> blocks
2360 Query blocks define I<SQL> statements and how the returned data should be
2361 interpreted. They are identified by the name that is given in the opening line
2362 of the block. Thus the name needs to be unique. Other than that, the name is
2363 not used in collectd.
2365 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
2366 define which column holds which value or instance information. You can use
2367 multiple B<Result> blocks to create multiple values from one returned row. This
2368 is especially useful, when queries take a long time and sending almost the same
2369 query again and again is not desirable.
2373 <Query "environment">
2374 Statement "select station, temperature, humidity from environment"
2377 # InstancePrefix "foo"
2378 InstancesFrom "station"
2379 ValuesFrom "temperature"
2383 InstancesFrom "station"
2384 ValuesFrom "humidity"
2388 The following options are accepted:
2392 =item B<Statement> I<SQL>
2394 Sets the statement that should be executed on the server. This is B<not>
2395 interpreted by collectd, but simply passed to the database server. Therefore,
2396 the SQL dialect that's used depends on the server collectd is connected to.
2398 The query has to return at least two columns, one for the instance and one
2399 value. You cannot omit the instance, even if the statement is guaranteed to
2400 always return exactly one line. In that case, you can usually specify something
2403 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
2405 (That works with MySQL but may not be valid SQL according to the spec. If you
2406 use a more strict database server, you may have to select from a dummy table or
2409 Please note that some databases, for example B<Oracle>, will fail if you
2410 include a semicolon at the end of the statement.
2412 =item B<MinVersion> I<Version>
2414 =item B<MaxVersion> I<Value>
2416 Only use this query for the specified database version. You can use these
2417 options to provide multiple queries with the same name but with a slightly
2418 different syntax. The plugin will use only those queries, where the specified
2419 minimum and maximum versions fit the version of the database in use.
2421 The database version is determined by C<dbi_conn_get_engine_version>, see the
2422 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
2423 for details. Basically, each part of the version is assumed to be in the range
2424 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
2425 "40102", version "5.0.42" becomes "50042".
2427 B<Warning:> The plugin will use B<all> matching queries, so if you specify
2428 multiple queries with the same name and B<overlapping> ranges, weird stuff will
2429 happen. Don't to it! A valid example would be something along these lines:
2440 In the above example, there are three ranges that don't overlap. The last one
2441 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
2442 before "4.0.0" are not specified.
2444 =item B<Type> I<Type>
2446 The B<type> that's used for each line returned. See L<types.db(5)> for more
2447 details on how types are defined. In short: A type is a predefined layout of
2448 data and the number of values and type of values has to match the type
2451 If you specify "temperature" here, you need exactly one gauge column. If you
2452 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
2455 There must be exactly one B<Type> option inside each B<Result> block.
2457 =item B<InstancePrefix> I<prefix>
2459 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
2460 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
2461 all strings returned in the appropriate columns are concatenated together,
2462 separated by dashes I<("-")>.
2464 =item B<InstancesFrom> I<column0> [I<column1> ...]
2466 Specifies the columns whose values will be used to create the "type-instance"
2467 for each row. If you specify more than one column, the value of all columns
2468 will be joined together with dashes I<("-")> as separation characters.
2470 The plugin itself does not check whether or not all built instances are
2471 different. It's your responsibility to assure that each is unique. This is
2472 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
2473 sure that only one row is returned in this case.
2475 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
2478 =item B<ValuesFrom> I<column0> [I<column1> ...]
2480 Names the columns whose content is used as the actual data for the data sets
2481 that are dispatched to the daemon. How many such columns you need is determined
2482 by the B<Type> setting above. If you specify too many or not enough columns,
2483 the plugin will complain about that and no data will be submitted to the
2486 The actual data type in the columns is not that important. The plugin will
2487 automatically cast the values to the right type if it know how to do that. So
2488 it should be able to handle integer an floating point types, as well as strings
2489 (if they include a number at the beginning).
2491 There must be at least one B<ValuesFrom> option inside each B<Result> block.
2493 =item B<MetadataFrom> [I<column0> I<column1> ...]
2495 Names the columns whose content is used as metadata for the data sets
2496 that are dispatched to the daemon.
2498 The actual data type in the columns is not that important. The plugin will
2499 automatically cast the values to the right type if it know how to do that. So
2500 it should be able to handle integer an floating point types, as well as strings
2501 (if they include a number at the beginning).
2505 =head3 B<Database> blocks
2507 Database blocks define a connection to a database and which queries should be
2508 sent to that database. Since the used "dbi" library can handle a wide variety
2509 of databases, the configuration is very generic. If in doubt, refer to libdbi's
2510 documentationE<nbsp>- we stick as close to the terminology used there.
2512 Each database needs a "name" as string argument in the starting tag of the
2513 block. This name will be used as "PluginInstance" in the values submitted to
2514 the daemon. Other than that, that name is not used.
2518 =item B<Plugin> I<Plugin>
2520 Use I<Plugin> as the plugin name when submitting query results from
2521 this B<Database>. Defaults to C<dbi>.
2523 =item B<Interval> I<Interval>
2525 Sets the interval (in seconds) in which the values will be collected from this
2526 database. By default the global B<Interval> setting will be used.
2528 =item B<Driver> I<Driver>
2530 Specifies the driver to use to connect to the database. In many cases those
2531 drivers are named after the database they can connect to, but this is not a
2532 technical necessity. These drivers are sometimes referred to as "DBD",
2533 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2534 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2535 project at L<http://libdbi-drivers.sourceforge.net/>.
2537 You need to give the driver name as expected by the "dbi" library here. You
2538 should be able to find that in the documentation for each driver. If you
2539 mistype the driver name, the plugin will dump a list of all known driver names
2542 =item B<DriverOption> I<Key> I<Value>
2544 Sets driver-specific options. What option a driver supports can be found in the
2545 documentation for each driver, somewhere at
2546 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2547 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2549 DBDs can register two types of options: String options and numeric options. The
2550 plugin will use the C<dbi_conn_set_option> function when the configuration
2551 provides a string and the C<dbi_conn_require_option_numeric> function when the
2552 configuration provides a number. So these two lines will actually result in
2553 different calls being used:
2555 DriverOption "Port" 1234 # numeric
2556 DriverOption "Port" "1234" # string
2558 Unfortunately, drivers are not too keen to report errors when an unknown option
2559 is passed to them, so invalid settings here may go unnoticed. This is not the
2560 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2561 the driver. If a driver complains about an option, the plugin will dump a
2562 complete list of all options understood by that driver to the log. There is no
2563 way to programmatically find out if an option expects a string or a numeric
2564 argument, so you will have to refer to the appropriate DBD's documentation to
2565 find this out. Sorry.
2567 =item B<SelectDB> I<Database>
2569 In some cases, the database name you connect with is not the database name you
2570 want to use for querying data. If this option is set, the plugin will "select"
2571 (switch to) that database after the connection is established.
2573 =item B<Query> I<QueryName>
2575 Associates the query named I<QueryName> with this database connection. The
2576 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2577 blocks you want to refer to must be placed above the database block you want to
2580 =item B<Host> I<Hostname>
2582 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2583 values. Defaults to the global hostname setting.
2591 =item B<Device> I<Device>
2593 Select partitions based on the devicename.
2595 See F</"IGNORELISTS"> for details.
2597 =item B<MountPoint> I<Directory>
2599 Select partitions based on the mountpoint.
2601 See F</"IGNORELISTS"> for details.
2603 =item B<FSType> I<FSType>
2605 Select partitions based on the filesystem type.
2607 See F</"IGNORELISTS"> for details.
2609 =item B<IgnoreSelected> B<true>|B<false>
2611 Invert the selection: If set to true, all partitions B<except> the ones that
2612 match any one of the criteria are collected. By default only selected
2613 partitions are collected if a selection is made. If no selection is configured
2614 at all, B<all> partitions are selected.
2616 =item B<ReportByDevice> B<true>|B<false>
2618 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2619 (the default), it will report a disk as "root", but with it I<true>, it will be
2620 "sda1" (or whichever).
2622 =item B<ReportInodes> B<true>|B<false>
2624 Enables or disables reporting of free, reserved and used inodes. Defaults to
2625 inode collection being disabled.
2627 Enable this option if inodes are a scarce resource for you, usually because
2628 many small files are stored on the disk. This is a usual scenario for mail
2629 transfer agents and web caches.
2631 =item B<ValuesAbsolute> B<true>|B<false>
2633 Enables or disables reporting of free and used disk space in 1K-blocks.
2634 Defaults to B<true>.
2636 =item B<ValuesPercentage> B<false>|B<true>
2638 Enables or disables reporting of free and used disk space in percentage.
2639 Defaults to B<false>.
2641 This is useful for deploying I<collectd> on the cloud, where machines with
2642 different disk size may exist. Then it is more practical to configure
2643 thresholds based on relative disk size.
2647 =head2 Plugin C<disk>
2649 The C<disk> plugin collects information about the usage of physical disks and
2650 logical disks (partitions). Values collected are the number of octets written
2651 to and read from a disk or partition, the number of read/write operations
2652 issued to the disk and a rather complex "time" it took for these commands to be
2655 Using the following two options you can ignore some disks or configure the
2656 collection only of specific disks.
2660 =item B<Disk> I<Name>
2662 Select the disk I<Name>. Whether it is collected or ignored depends on the
2663 B<IgnoreSelected> setting, see below. As with other plugins that use the
2664 daemon's ignorelist functionality, a string that starts and ends with a slash
2665 is interpreted as a regular expression. Examples:
2670 See F</"IGNORELISTS"> for details.
2672 =item B<IgnoreSelected> B<true>|B<false>
2674 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2675 statements, are ignored or if all other disks are ignored. The behavior
2676 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2677 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2678 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2679 is set to B<true>, all disks are collected B<except> the ones matched.
2681 =item B<UseBSDName> B<true>|B<false>
2683 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2684 default major/minor numbers. Requires collectd to be built with Apple's
2687 =item B<UdevNameAttr> I<Attribute>
2689 Attempt to override disk instance name with the value of a specified udev
2690 attribute when built with B<libudev>. If the attribute is not defined for the
2691 given device, the default name is used. Example:
2693 UdevNameAttr "DM_NAME"
2697 =head2 Plugin C<dns>
2701 =item B<Interface> I<Interface>
2703 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2704 option sets the interface that should be used. If this option is not set, or
2705 set to "any", the plugin will try to get packets from B<all> interfaces. This
2706 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2708 =item B<IgnoreSource> I<IP-address>
2710 Ignore packets that originate from this address.
2712 =item B<SelectNumericQueryTypes> B<true>|B<false>
2714 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2718 =head2 Plugin C<dpdkevents>
2720 The I<dpdkevents plugin> collects events from DPDK such as link status of
2721 network ports and Keep Alive status of DPDK logical cores.
2722 In order to get Keep Alive events following requirements must be met:
2724 - support for Keep Alive implemented in DPDK application. More details can
2725 be found here: http://dpdk.org/doc/guides/sample_app_ug/keep_alive.html
2729 <Plugin "dpdkevents">
2735 <Event "link_status">
2736 SendEventsOnUpdate true
2737 EnabledPortMask 0xffff
2738 PortName "interface1"
2739 PortName "interface2"
2740 SendNotification false
2742 <Event "keep_alive">
2743 SendEventsOnUpdate true
2745 KeepAliveShmName "/dpdk_keepalive_shm_name"
2746 SendNotification false
2753 =head3 The EAL block
2757 =item B<Coremask> I<Mask>
2759 =item B<Memorychannels> I<Channels>
2761 Number of memory channels per processor socket.
2763 =item B<FilePrefix> I<File>
2765 The prefix text used for hugepage filenames. The filename will be set to
2766 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2770 =head3 The Event block
2772 The B<Event> block defines configuration for specific event. It accepts a
2773 single argument which specifies the name of the event.
2775 =head4 Link Status event
2779 =item B<SendEventOnUpdate> I<true|false>
2781 If set to true link status value will be dispatched only when it is
2782 different from previously read value. This is an optional argument - default
2785 =item B<EnabledPortMask> I<Mask>
2787 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2788 of 0x0 means that all ports will be disabled. A bitmask of all F's means
2789 that all ports will be enabled. This is an optional argument - by default
2790 all ports are enabled.
2792 =item B<PortName> I<Name>
2794 A string containing an optional name for the enabled DPDK ports. Each PortName
2795 option should contain only one port name; specify as many PortName options as
2796 desired. Default naming convention will be used if PortName is blank. If there
2797 are less PortName options than there are enabled ports, the default naming
2798 convention will be used for the additional ports.
2800 =item B<SendNotification> I<true|false>
2802 If set to true, link status notifications are sent, instead of link status
2803 being collected as a statistic. This is an optional argument - default
2808 =head4 Keep Alive event
2812 =item B<SendEventOnUpdate> I<true|false>
2814 If set to true keep alive value will be dispatched only when it is
2815 different from previously read value. This is an optional argument - default
2818 =item B<LCoreMask> I<Mask>
2820 An hexadecimal bit mask of the logical cores to monitor keep alive state.
2822 =item B<KeepAliveShmName> I<Name>
2824 Shared memory name identifier that is used by secondary process to monitor
2825 the keep alive cores state.
2827 =item B<SendNotification> I<true|false>
2829 If set to true, keep alive notifications are sent, instead of keep alive
2830 information being collected as a statistic. This is an optional
2831 argument - default value is false.
2835 =head2 Plugin C<dpdkstat>
2837 The I<dpdkstat plugin> collects information about DPDK interfaces using the
2838 extended NIC stats API in DPDK.
2849 RteDriverLibPath "/usr/lib/dpdk-pmd"
2851 SharedMemObj "dpdk_collectd_stats_0"
2852 EnabledPortMask 0xffff
2853 PortName "interface1"
2854 PortName "interface2"
2859 =head3 The EAL block
2863 =item B<Coremask> I<Mask>
2865 A string containing an hexadecimal bit mask of the cores to run on. Note that
2866 core numbering can change between platforms and should be determined beforehand.
2868 =item B<Memorychannels> I<Channels>
2870 A string containing a number of memory channels per processor socket.
2872 =item B<FilePrefix> I<File>
2874 The prefix text used for hugepage filenames. The filename will be set to
2875 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2877 =item B<SocketMemory> I<MB>
2879 A string containing amount of Memory to allocate from hugepages on specific
2880 sockets in MB. This is an optional value.
2882 =item B<LogLevel> I<LogLevel_number>
2884 A string containing log level number. This parameter is optional.
2885 If parameter is not present then default value "7" - (INFO) is used.
2886 Value "8" - (DEBUG) can be set to enable debug traces.
2888 =item B<RteDriverLibPath> I<Path>
2890 A string containing path to shared pmd driver lib or path to directory,
2891 where shared pmd driver libs are available. This parameter is optional.
2892 This parameter enable loading of shared pmd driver libs from defined path.
2893 E.g.: "/usr/lib/dpdk-pmd/librte_pmd_i40e.so"
2894 or "/usr/lib/dpdk-pmd"
2900 =item B<SharedMemObj> I<Mask>
2902 A string containing the name of the shared memory object that should be used to
2903 share stats from the DPDK secondary process to the collectd dpdkstat plugin.
2904 Defaults to dpdk_collectd_stats if no other value is configured.
2906 =item B<EnabledPortMask> I<Mask>
2908 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2909 of 0x0 means that all ports will be disabled. A bitmask of all Fs means
2910 that all ports will be enabled. This is an optional argument - default
2911 is all ports enabled.
2913 =item B<PortName> I<Name>
2915 A string containing an optional name for the enabled DPDK ports. Each PortName
2916 option should contain only one port name; specify as many PortName options as
2917 desired. Default naming convention will be used if PortName is blank. If there
2918 are less PortName options than there are enabled ports, the default naming
2919 convention will be used for the additional ports.
2923 =head2 Plugin C<email>
2927 =item B<SocketFile> I<Path>
2929 Sets the socket-file which is to be created.
2931 =item B<SocketGroup> I<Group>
2933 If running as root change the group of the UNIX-socket after it has been
2934 created. Defaults to B<collectd>.
2936 =item B<SocketPerms> I<Permissions>
2938 Change the file permissions of the UNIX-socket after it has been created. The
2939 permissions must be given as a numeric, octal value as you would pass to
2940 L<chmod(1)>. Defaults to B<0770>.
2942 =item B<MaxConns> I<Number>
2944 Sets the maximum number of connections that can be handled in parallel. Since
2945 this many threads will be started immediately setting this to a very high
2946 value will waste valuable resources. Defaults to B<5> and will be forced to be
2947 at most B<16384> to prevent typos and dumb mistakes.
2951 =head2 Plugin C<ethstat>
2953 The I<ethstat plugin> collects information about network interface cards (NICs)
2954 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2960 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2961 Map "multicast" "if_multicast"
2968 =item B<Interface> I<Name>
2970 Collect statistical information about interface I<Name>.
2972 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2974 By default, the plugin will submit values as type C<derive> and I<type
2975 instance> set to I<Name>, the name of the metric as reported by the driver. If
2976 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2977 I<TypeInstance> will be used.
2979 =item B<MappedOnly> B<true>|B<false>
2981 When set to B<true>, only metrics that can be mapped to a I<type> will be
2982 collected, all other metrics will be ignored. Defaults to B<false>.
2986 =head2 Plugin C<exec>
2988 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2989 contains valuable information on when the executable is executed and the
2990 output that is expected from it.
2994 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2996 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2998 Execute the executable I<Executable> as user I<User>. If the user name is
2999 followed by a colon and a group name, the effective group is set to that group.
3000 The real group and saved-set group will be set to the default group of that
3001 user. If no group is given the effective group ID will be the same as the real
3004 Please note that in order to change the user and/or group the daemon needs
3005 superuser privileges. If the daemon is run as an unprivileged user you must
3006 specify the same user/group here. If the daemon is run with superuser
3007 privileges, you must supply a non-root user here.
3009 The executable may be followed by optional arguments that are passed to the
3010 program. Please note that due to the configuration parsing numbers and boolean
3011 values may be changed. If you want to be absolutely sure that something is
3012 passed as-is please enclose it in quotes.
3014 The B<Exec> and B<NotificationExec> statements change the semantics of the
3015 programs executed, i.E<nbsp>e. the data passed to them and the response
3016 expected from them. This is documented in great detail in L<collectd-exec(5)>.
3020 =head2 Plugin C<fhcount>
3022 The C<fhcount> plugin provides statistics about used, unused and total number of
3023 file handles on Linux.
3025 The I<fhcount plugin> provides the following configuration options:
3029 =item B<ValuesAbsolute> B<true>|B<false>
3031 Enables or disables reporting of file handles usage in absolute numbers,
3032 e.g. file handles used. Defaults to B<true>.
3034 =item B<ValuesPercentage> B<false>|B<true>
3036 Enables or disables reporting of file handles usage in percentages, e.g.
3037 percent of file handles used. Defaults to B<false>.
3041 =head2 Plugin C<filecount>
3043 The C<filecount> plugin counts the number of files in a certain directory (and
3044 its subdirectories) and their combined size. The configuration is very straight
3047 <Plugin "filecount">
3048 <Directory "/var/qmail/queue/mess">
3049 Instance "qmail-message"
3051 <Directory "/var/qmail/queue/todo">
3052 Instance "qmail-todo"
3054 <Directory "/var/lib/php5">
3055 Instance "php5-sessions"
3060 The example above counts the number of files in QMail's queue directories and
3061 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
3062 QMail has not yet looked at, the "message" queue holds the messages that were
3063 classified into "local" and "remote".
3065 As you can see, the configuration consists of one or more C<Directory> blocks,
3066 each of which specifies a directory in which to count the files. Within those
3067 blocks, the following options are recognized:
3071 =item B<Plugin> I<Plugin>
3073 Use I<Plugin> as the plugin name when submitting values.
3074 Defaults to B<filecount>.
3076 =item B<Instance> I<Instance>
3078 Sets the plugin instance to I<Instance>. If not given, the instance is set to
3079 the directory name with all slashes replaced by underscores and all leading
3080 underscores removed. Empty value is allowed.
3082 =item B<Name> I<Pattern>
3084 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
3085 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
3086 against the pattern, not the entire path. In case this makes it easier for you:
3087 This option has been named after the B<-name> parameter to L<find(1)>.
3089 =item B<MTime> I<Age>
3091 Count only files of a specific age: If I<Age> is greater than zero, only files
3092 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
3093 a negative number, this is inversed. For example, if B<-60> is specified, only
3094 files that have been modified in the last minute will be counted.
3096 The number can also be followed by a "multiplier" to easily specify a larger
3097 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
3098 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
3099 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
3100 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
3101 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
3104 =item B<Size> I<Size>
3106 Count only files of a specific size. When I<Size> is a positive number, only
3107 files that are at least this big are counted. If I<Size> is a negative number,
3108 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
3109 I<Size> are counted.
3111 As with the B<MTime> option, a "multiplier" may be added. For a detailed
3112 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
3113 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
3114 note that there are 1000 bytes in a kilobyte, not 1024.
3116 =item B<Recursive> I<true>|I<false>
3118 Controls whether or not to recurse into subdirectories. Enabled by default.
3120 =item B<IncludeHidden> I<true>|I<false>
3122 Controls whether or not to include "hidden" files and directories in the count.
3123 "Hidden" files and directories are those, whose name begins with a dot.
3124 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
3126 =item B<RegularOnly> I<true>|I<false>
3128 Controls whether or not to include only regular files in the count.
3129 Defaults to I<true>, i.e. by default non regular files are ignored.
3131 =item B<FilesSizeType> I<Type>
3133 Sets the type used to dispatch files combined size. Empty value ("") disables
3134 reporting. Defaults to B<bytes>.
3136 =item B<FilesCountType> I<Type>
3138 Sets the type used to dispatch number of files. Empty value ("") disables
3139 reporting. Defaults to B<files>.
3141 =item B<TypeInstance> I<Instance>
3143 Sets the I<type instance> used to dispatch values. Defaults to an empty string
3144 (no plugin instance).
3148 =head2 Plugin C<GenericJMX>
3150 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
3151 L<collectd-java(5)>.
3153 =head2 Plugin C<gmond>
3155 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
3156 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
3157 are built-in, custom mappings may be added via B<Metric> blocks, see below.
3162 MCReceiveFrom "239.2.11.71" "8649"
3163 <Metric "swap_total">
3165 TypeInstance "total"
3168 <Metric "swap_free">
3175 The following metrics are built-in:
3181 load_one, load_five, load_fifteen
3185 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
3189 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
3201 Available configuration options:
3205 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
3207 Sets sets the multicast group and UDP port to which to subscribe.
3209 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
3211 =item E<lt>B<Metric> I<Name>E<gt>
3213 These blocks add a new metric conversion to the internal table. I<Name>, the
3214 string argument to the B<Metric> block, is the metric name as used by Ganglia.
3218 =item B<Type> I<Type>
3220 Type to map this metric to. Required.
3222 =item B<TypeInstance> I<Instance>
3224 Type-instance to use. Optional.
3226 =item B<DataSource> I<Name>
3228 Data source to map this metric to. If the configured type has exactly one data
3229 source, this is optional. Otherwise the option is required.
3235 =head2 Plugin C<gps>
3237 The C<gps plugin> connects to gpsd on the host machine.
3238 The host, port, timeout and pause are configurable.
3240 This is useful if you run an NTP server using a GPS for source and you want to
3243 Mind your GPS must send $--GSA for having the data reported!
3245 The following elements are collected:
3251 Number of satellites used for fix (type instance "used") and in view (type
3252 instance "visible"). 0 means no GPS satellites are visible.
3254 =item B<dilution_of_precision>
3256 Vertical and horizontal dilution (type instance "horizontal" or "vertical").
3257 It should be between 0 and 3.
3258 Look at the documentation of your GPS to know more.
3266 # Connect to localhost on gpsd regular port:
3271 # PauseConnect of 5 sec. between connection attempts.
3275 Available configuration options:
3279 =item B<Host> I<Host>
3281 The host on which gpsd daemon runs. Defaults to B<localhost>.
3283 =item B<Port> I<Port>
3285 Port to connect to gpsd on the host machine. Defaults to B<2947>.
3287 =item B<Timeout> I<Seconds>
3289 Timeout in seconds (default 0.015 sec).
3291 The GPS data stream is fetch by the plugin form the daemon.
3292 It waits for data to be available, if none arrives it times out
3293 and loop for another reading.
3294 Mind to put a low value gpsd expects value in the micro-seconds area
3295 (recommended is 500 us) since the waiting function is blocking.
3296 Value must be between 500 us and 5 sec., if outside that range the
3297 default value is applied.
3299 This only applies from gpsd release-2.95.
3301 =item B<PauseConnect> I<Seconds>
3303 Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).
3307 =head2 Plugin C<gpu_nvidia>
3309 Efficiently collects various statistics from the system's NVIDIA GPUs using the
3310 NVML library. Currently collected are fan speed, core temperature, percent
3311 load, percent memory used, compute and memory frequencies, and power
3318 If one or more of these options is specified, only GPUs at that index (as
3319 determined by nvidia-utils through I<nvidia-smi>) have statistics collected.
3320 If no instance of this option is specified, all GPUs are monitored.
3322 =item B<IgnoreSelected>
3324 If set to true, all detected GPUs B<except> the ones at indices specified by
3325 B<GPUIndex> entries are collected. For greater clarity, setting IgnoreSelected
3326 without any GPUIndex directives will result in B<no> statistics being
3331 =head2 Plugin C<grpc>
3333 The I<grpc> plugin provides an RPC interface to submit values to or query
3334 values from collectd based on the open source gRPC framework. It exposes an
3335 end-point for dispatching values to the daemon.
3337 The B<gRPC> homepage can be found at L<https://grpc.io/>.
3341 =item B<Server> I<Host> I<Port>
3343 The B<Server> statement sets the address of a server to which to send metrics
3344 via the C<DispatchValues> function.
3346 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3348 Optionally, B<Server> may be specified as a configuration block which supports
3349 the following options:
3353 =item B<EnableSSL> B<false>|B<true>
3355 Whether to require SSL for outgoing connections. Default: false.
3357 =item B<SSLCACertificateFile> I<Filename>
3359 =item B<SSLCertificateFile> I<Filename>
3361 =item B<SSLCertificateKeyFile> I<Filename>
3363 Filenames specifying SSL certificate and key material to be used with SSL
3368 =item B<Listen> I<Host> I<Port>
3370 The B<Listen> statement sets the network address to bind to. When multiple
3371 statements are specified, the daemon will bind to all of them. If none are
3372 specified, it defaults to B<0.0.0.0:50051>.
3374 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3376 Optionally, B<Listen> may be specified as a configuration block which
3377 supports the following options:
3381 =item B<EnableSSL> I<true>|I<false>
3383 Whether to enable SSL for incoming connections. Default: false.
3385 =item B<SSLCACertificateFile> I<Filename>
3387 =item B<SSLCertificateFile> I<Filename>
3389 =item B<SSLCertificateKeyFile> I<Filename>
3391 Filenames specifying SSL certificate and key material to be used with SSL
3394 =item B<VerifyPeer> B<true>|B<false>
3396 When enabled, a valid client certificate is required to connect to the server.
3397 When disabled, a client certifiacte is not requested and any unsolicited client
3398 certificate is accepted.
3405 =head2 Plugin C<hddtemp>
3407 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
3408 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
3409 default values, see below. C<hddtemp> has to be running to work correctly. If
3410 C<hddtemp> is not running timeouts may appear which may interfere with other
3413 The B<hddtemp> homepage can be found at
3414 L<http://www.guzu.net/linux/hddtemp.php>.
3418 =item B<Host> I<Hostname>
3420 Hostname to connect to. Defaults to B<127.0.0.1>.
3422 =item B<Port> I<Port>
3424 TCP-Port to connect to. Defaults to B<7634>.
3428 =head2 Plugin C<hugepages>
3430 To collect B<hugepages> information, collectd reads directories
3431 "/sys/devices/system/node/*/hugepages" and
3432 "/sys/kernel/mm/hugepages".
3433 Reading of these directories can be disabled by the following
3434 options (default is enabled).
3438 =item B<ReportPerNodeHP> B<true>|B<false>
3440 If enabled, information will be collected from the hugepage
3441 counters in "/sys/devices/system/node/*/hugepages".
3442 This is used to check the per-node hugepage statistics on
3445 =item B<ReportRootHP> B<true>|B<false>
3447 If enabled, information will be collected from the hugepage
3448 counters in "/sys/kernel/mm/hugepages".
3449 This can be used on both NUMA and non-NUMA systems to check
3450 the overall hugepage statistics.
3452 =item B<ValuesPages> B<true>|B<false>
3454 Whether to report hugepages metrics in number of pages.
3455 Defaults to B<true>.
3457 =item B<ValuesBytes> B<false>|B<true>
3459 Whether to report hugepages metrics in bytes.
3460 Defaults to B<false>.
3462 =item B<ValuesPercentage> B<false>|B<true>
3464 Whether to report hugepages metrics as percentage.
3465 Defaults to B<false>.
3469 =head2 Plugin C<intel_pmu>
3471 The I<intel_pmu> plugin collects performance counters data on Intel CPUs using
3472 Linux perf interface. All events are reported on a per core basis.
3477 ReportHardwareCacheEvents true
3478 ReportKernelPMUEvents true
3479 ReportSoftwareEvents true
3480 EventList "/var/cache/pmu/GenuineIntel-6-2D-core.json"
3481 HardwareEvents "L2_RQSTS.CODE_RD_HIT,L2_RQSTS.CODE_RD_MISS" "L2_RQSTS.ALL_CODE_RD"
3482 Cores "0-3" "4,6" "[12-15]"
3489 =item B<ReportHardwareCacheEvents> B<false>|B<true>
3491 Enable or disable measuring of hardware CPU cache events:
3493 - L1-dcache-load-misses
3495 - L1-dcache-store-misses
3496 - L1-dcache-prefetches
3497 - L1-dcache-prefetch-misses
3499 - L1-icache-load-misses
3500 - L1-icache-prefetches
3501 - L1-icache-prefetch-misses
3507 - LLC-prefetch-misses
3513 - dTLB-prefetch-misses
3517 - branch-load-misses
3519 =item B<ReportKernelPMUEvents> B<false>|B<true>
3521 Enable or disable measuring of the following events:
3530 =item B<ReportSoftwareEvents> B<false>|B<true>
3532 Enable or disable measuring of software events provided by kernel:
3543 =item B<EventList> I<filename>
3545 JSON performance counter event list file name. To be able to monitor all Intel
3546 CPU specific events JSON event list file should be downloaded. Use the pmu-tools
3547 event_download.py script to download event list for current CPU.
3549 =item B<HardwareEvents> I<events>
3551 This field is a list of event names or groups of comma separated event names.
3552 This option requires B<EventList> option to be configured.
3554 =item B<Cores> I<cores groups>
3556 All events are reported on a per core basis. Monitoring of the events can be
3557 configured for a group of cores (aggregated statistics). This field defines
3558 groups of cores on which to monitor supported events. The field is represented
3559 as list of strings with core group values. Each string represents a list of
3560 cores in a group. If a group is enclosed in square brackets each core is added
3561 individually to a separate group (that is statistics are not aggregated).
3562 Allowed formats are:
3568 If an empty string is provided as value for this field default cores
3569 configuration is applied - that is separate group is created for each core.
3573 =head2 Plugin C<intel_rdt>
3575 The I<intel_rdt> plugin collects information provided by monitoring features of
3576 Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
3577 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features provide
3578 information about utilization of shared resources. CMT monitors last level cache
3579 occupancy (LLC). MBM supports two types of events reporting local and remote
3580 memory bandwidth. Local memory bandwidth (MBL) reports the bandwidth of
3581 accessing memory associated with the local socket. Remote memory bandwidth (MBR)
3582 reports the bandwidth of accessing the remote socket. Also this technology
3583 allows to monitor instructions per clock (IPC).
3584 Monitor events are hardware dependant. Monitoring capabilities are detected on
3585 plugin initialization and only supported events are monitored.
3587 B<Note:> I<intel_rdt> plugin is using model-specific registers (MSRs), which
3588 require an additional capability to be enabled if collectd is run as a service.
3589 Please refer to I<contrib/systemd.collectd.service> file for more details.
3593 <Plugin "intel_rdt">
3594 Cores "0-2" "3,4,6" "8-10,15"
3595 Processes "sshd,qemu-system-x86" "bash"
3602 =item B<Interval> I<seconds>
3604 The interval within which to retrieve statistics on monitored events in seconds.
3605 For milliseconds divide the time by 1000 for example if the desired interval
3606 is 50ms, set interval to 0.05. Due to limited capacity of counters it is not
3607 recommended to set interval higher than 1 sec.
3609 =item B<Cores> I<cores groups>
3611 Monitoring of the events can be configured for group of cores
3612 (aggregated statistics). This field defines groups of cores on which to monitor
3613 supported events. The field is represented as list of strings with core group
3614 values. Each string represents a list of cores in a group. Allowed formats are:
3619 If an empty string is provided as value for this field default cores
3620 configuration is applied - a separate group is created for each core.
3622 =item B<Processes> I<process names groups>
3624 Monitoring of the events can be configured for group of processes
3625 (aggregated statistics). This field defines groups of processes on which to
3626 monitor supported events. The field is represented as list of strings with
3627 process names group values. Each string represents a list of processes in a
3628 group. Allowed format is:
3633 B<Note:> By default global interval is used to retrieve statistics on monitored
3634 events. To configure a plugin specific interval use B<Interval> option of the
3635 intel_rdt <LoadPlugin> block. For milliseconds divide the time by 1000 for
3636 example if the desired interval is 50ms, set interval to 0.05.
3637 Due to limited capacity of counters it is not recommended to set interval higher
3640 =head2 Plugin C<interface>
3644 =item B<Interface> I<Interface>
3646 Select this interface. By default these interfaces will then be collected. For
3647 a more detailed description see B<IgnoreSelected> below.
3649 See F</"IGNORELISTS"> for details.
3651 =item B<IgnoreSelected> I<true>|I<false>
3653 If no configuration is given, the B<interface>-plugin will collect data from
3654 all interfaces. This may not be practical, especially for loopback- and
3655 similar interfaces. Thus, you can use the B<Interface>-option to pick the
3656 interfaces you're interested in. Sometimes, however, it's easier/preferred
3657 to collect all interfaces I<except> a few ones. This option enables you to
3658 do that: By setting B<IgnoreSelected> to I<true> the effect of
3659 B<Interface> is inverted: All selected interfaces are ignored and all
3660 other interfaces are collected.
3662 It is possible to use regular expressions to match interface names, if the
3663 name is surrounded by I</.../> and collectd was compiled with support for
3664 regexps. This is useful if there's a need to collect (or ignore) data
3665 for a group of interfaces that are similarly named, without the need to
3666 explicitly list all of them (especially useful if the list is dynamic).
3671 Interface "/^tun[0-9]+/"
3672 IgnoreSelected "true"
3674 This will ignore the loopback interface, all interfaces with names starting
3675 with I<veth> and all interfaces with names starting with I<tun> followed by
3678 =item B<ReportInactive> I<true>|I<false>
3680 When set to I<false>, only interfaces with non-zero traffic will be
3681 reported. Note that the check is done by looking into whether a
3682 package was sent at any time from boot and the corresponding counter
3683 is non-zero. So, if the interface has been sending data in the past
3684 since boot, but not during the reported time-interval, it will still
3687 The default value is I<true> and results in collection of the data
3688 from all interfaces that are selected by B<Interface> and
3689 B<IgnoreSelected> options.
3691 =item B<UniqueName> I<true>|I<false>
3693 Interface name is not unique on Solaris (KSTAT), interface name is unique
3694 only within a module/instance. Following tuple is considered unique:
3695 (ks_module, ks_instance, ks_name)
3696 If this option is set to true, interface name contains above three fields
3697 separated by an underscore. For more info on KSTAT, visit
3698 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
3700 This option is only available on Solaris.
3704 =head2 Plugin C<ipmi>
3706 The B<ipmi plugin> allows to monitor server platform status using the Intelligent
3707 Platform Management Interface (IPMI). Local and remote interfaces are supported.
3709 The plugin configuration consists of one or more B<Instance> blocks which
3710 specify one I<ipmi> connection each. Each block requires one unique string
3711 argument as the instance name. If instances are not configured, an instance with
3712 the default option values will be created.
3714 For backwards compatibility, any option other than B<Instance> block will trigger
3715 legacy config handling and it will be treated as an option within B<Instance>
3716 block. This support will go away in the next major version of Collectd.
3718 Within the B<Instance> blocks, the following options are allowed:
3722 =item B<Address> I<Address>
3724 Hostname or IP to connect to. If not specified, plugin will try to connect to
3725 local management controller (BMC).
3727 =item B<Username> I<Username>
3729 =item B<Password> I<Password>
3731 The username and the password to use for the connection to remote BMC.
3733 =item B<AuthType> I<MD5>|I<rmcp+>
3735 Forces the authentication type to use for the connection to remote BMC.
3736 By default most secure type is seleted.
3738 =item B<Host> I<Hostname>
3740 Sets the B<host> field of dispatched values. Defaults to the global hostname
3743 =item B<Sensor> I<Sensor>
3745 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
3747 See F</"IGNORELISTS"> for details.
3749 =item B<IgnoreSelected> I<true>|I<false>
3751 If no configuration if given, the B<ipmi> plugin will collect data from all
3752 sensors found of type "temperature", "voltage", "current" and "fanspeed".
3753 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
3754 the effect of B<Sensor> is inverted: All selected sensors are ignored and
3755 all other sensors are collected.
3757 =item B<NotifySensorAdd> I<true>|I<false>
3759 If a sensor appears after initialization time of a minute a notification
3762 =item B<NotifySensorRemove> I<true>|I<false>
3764 If a sensor disappears a notification is sent.
3766 =item B<NotifySensorNotPresent> I<true>|I<false>
3768 If you have for example dual power supply and one of them is (un)plugged then
3769 a notification is sent.
3771 =item B<NotifyIPMIConnectionState> I<true>|I<false>
3773 If a IPMI connection state changes after initialization time of a minute
3774 a notification is sent. Defaults to B<false>.
3776 =item B<SELEnabled> I<true>|I<false>
3778 If system event log (SEL) is enabled, plugin will listen for sensor threshold
3779 and discrete events. When event is received the notification is sent.
3780 SEL event filtering can be configured using B<SELSensor> and B<SELIgnoreSelected>
3782 Defaults to B<false>.
3784 =item B<SELSensor> I<SELSensor>
3786 Selects sensors to get events from or to ignore, depending on B<SELIgnoreSelected>.
3788 See F</"IGNORELISTS"> for details.
3790 =item B<SELIgnoreSelected> I<true>|I<false>
3792 If no configuration is given, the B<ipmi> plugin will pass events from all
3793 sensors. This option enables you to do that: By setting B<SELIgnoreSelected>
3794 to I<true> the effect of B<SELSensor> is inverted: All events from selected
3795 sensors are ignored and all events from other sensors are passed.
3797 =item B<SELClearEvent> I<true>|I<false>
3799 If SEL clear event is enabled, plugin will delete event from SEL list after
3800 it is received and successfully handled. In this case other tools that are
3801 subscribed for SEL events will receive an empty event.
3802 Defaults to B<false>.
3806 =head2 Plugin C<iptables>
3810 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3812 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3814 Select the iptables/ip6tables filter rules to count packets and bytes from.
3816 If only I<Table> and I<Chain> are given, this plugin will collect the counters
3817 of all rules which have a comment-match. The comment is then used as
3820 If I<Comment> or I<Number> is given, only the rule with the matching comment or
3821 the I<n>th rule will be collected. Again, the comment (or the number) will be
3822 used as the type-instance.
3824 If I<Name> is supplied, it will be used as the type-instance instead of the
3825 comment or the number.
3829 =head2 Plugin C<irq>
3835 Select this irq. By default these irqs will then be collected. For a more
3836 detailed description see B<IgnoreSelected> below.
3838 See F</"IGNORELISTS"> for details.
3840 =item B<IgnoreSelected> I<true>|I<false>
3842 If no configuration if given, the B<irq>-plugin will collect data from all
3843 irqs. This may not be practical, especially if no interrupts happen. Thus, you
3844 can use the B<Irq>-option to pick the interrupt you're interested in.
3845 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
3846 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
3847 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
3848 and all other interrupts are collected.
3852 =head2 Plugin C<java>
3854 The I<Java> plugin makes it possible to write extensions for collectd in Java.
3855 This section only discusses the syntax and semantic of the configuration
3856 options. For more in-depth information on the I<Java> plugin, please read
3857 L<collectd-java(5)>.
3862 JVMArg "-verbose:jni"
3863 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
3864 LoadPlugin "org.collectd.java.Foobar"
3865 <Plugin "org.collectd.java.Foobar">
3866 # To be parsed by the plugin
3870 Available configuration options:
3874 =item B<JVMArg> I<Argument>
3876 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
3877 exactly the way the arguments to the I<java> binary on the command line work.
3878 Execute C<javaE<nbsp>--help> for details.
3880 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
3881 any other options! When another option is found, the JVM will be started and
3882 later options will have to be ignored!
3884 =item B<LoadPlugin> I<JavaClass>
3886 Instantiates a new I<JavaClass> object. The constructor of this object very
3887 likely then registers one or more callback methods with the server.
3889 See L<collectd-java(5)> for details.
3891 When the first such option is found, the virtual machine (JVM) is created. This
3892 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
3893 B<LoadPlugin> options!
3895 =item B<Plugin> I<Name>
3897 The entire block is passed to the Java plugin as an
3898 I<org.collectd.api.OConfigItem> object.
3900 For this to work, the plugin has to register a configuration callback first,
3901 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
3902 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
3903 depends on the (Java) plugin registering the callback and is completely
3904 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
3908 =head2 Plugin C<load>
3910 The I<Load plugin> collects the system load. These numbers give a rough overview
3911 over the utilization of a machine. The system load is defined as the number of
3912 runnable tasks in the run-queue and is provided by many operating systems as a
3913 one, five or fifteen minute average.
3915 The following configuration options are available:
3919 =item B<ReportRelative> B<false>|B<true>
3921 When enabled, system load divided by number of available CPU cores is reported
3922 for intervals 1 min, 5 min and 15 min. Defaults to false.
3927 =head2 Plugin C<logfile>
3931 =item B<LogLevel> B<debug|info|notice|warning|err>
3933 Sets the log-level. If, for example, set to B<notice>, then all events with
3934 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3936 Please note that B<debug> is only available if collectd has been compiled with
3939 =item B<File> I<File>
3941 Sets the file to write log messages to. The special strings B<stdout> and
3942 B<stderr> can be used to write to the standard output and standard error
3943 channels, respectively. This, of course, only makes much sense when I<collectd>
3944 is running in foreground- or non-daemon-mode.
3946 =item B<Timestamp> B<true>|B<false>
3948 Prefix all lines printed by the current time. Defaults to B<true>.
3950 =item B<PrintSeverity> B<true>|B<false>
3952 When enabled, all lines are prefixed by the severity of the log message, for
3953 example "warning". Defaults to B<false>.
3957 B<Note>: There is no need to notify the daemon after moving or removing the
3958 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3959 for each line it writes.
3961 =head2 Plugin C<log_logstash>
3963 The I<log logstash plugin> behaves like the logfile plugin but formats
3964 messages as JSON events for logstash to parse and input.
3968 =item B<LogLevel> B<debug|info|notice|warning|err>
3970 Sets the log-level. If, for example, set to B<notice>, then all events with
3971 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3973 Please note that B<debug> is only available if collectd has been compiled with
3976 =item B<File> I<File>
3978 Sets the file to write log messages to. The special strings B<stdout> and
3979 B<stderr> can be used to write to the standard output and standard error
3980 channels, respectively. This, of course, only makes much sense when I<collectd>
3981 is running in foreground- or non-daemon-mode.
3985 B<Note>: There is no need to notify the daemon after moving or removing the
3986 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3987 for each line it writes.
3989 =head2 Plugin C<lpar>
3991 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
3992 virtualization technique for IBM POWER processors. It takes into account CPU
3993 time stolen from or donated to a partition, in addition to the usual user,
3994 system, I/O statistics.
3996 The following configuration options are available:
4000 =item B<CpuPoolStats> B<false>|B<true>
4002 When enabled, statistics about the processor pool are read, too. The partition
4003 needs to have pool authority in order to be able to acquire this information.
4006 =item B<ReportBySerial> B<false>|B<true>
4008 If enabled, the serial of the physical machine the partition is currently
4009 running on is reported as I<hostname> and the logical hostname of the machine
4010 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
4011 used (just like other plugins) and the I<plugin instance> will be empty.
4016 =head2 Plugin C<lua>
4018 This plugin embeds a Lua interpreter into collectd and provides an interface
4019 to collectd's plugin system. See L<collectd-lua(5)> for its documentation.
4022 =head2 Plugin C<mbmon>
4024 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
4026 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
4027 B<Host> and B<Port> options can be used to change these values, see below.
4028 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
4029 timeouts may appear which may interfere with other statistics..
4031 C<mbmon> must be run with the -r option ("print TAG and Value format");
4032 Debian's F</etc/init.d/mbmon> script already does this, other people
4033 will need to ensure that this is the case.
4037 =item B<Host> I<Hostname>
4039 Hostname to connect to. Defaults to B<127.0.0.1>.
4041 =item B<Port> I<Port>
4043 TCP-Port to connect to. Defaults to B<411>.
4047 =head2 Plugin C<mcelog>
4049 The C<mcelog plugin> uses mcelog to retrieve machine check exceptions.
4051 By default the plugin connects to B<"/var/run/mcelog-client"> to check if the
4052 mcelog server is running. When the server is running, the plugin will tail the
4053 specified logfile to retrieve machine check exception information and send a
4054 notification with the details from the logfile. The plugin will use the mcelog
4055 client protocol to retrieve memory related machine check exceptions. Note that
4056 for memory exceptions, notifications are only sent when there is a change in
4057 the number of corrected/uncorrected memory errors.
4059 =head3 The Memory block
4061 Note: these options cannot be used in conjunction with the logfile options, they are mutually
4066 =item B<McelogClientSocket> I<Path>
4067 Connect to the mcelog client socket using the UNIX domain socket at I<Path>.
4068 Defaults to B<"/var/run/mcelog-client">.
4070 =item B<PersistentNotification> B<true>|B<false>
4071 Override default configuration to only send notifications when sent when there
4072 is a change in the number of corrected/uncorrected memory errors. When set to
4073 true notifications will be sent for every read cycle. Default is false. Does
4074 not affect the stats being dispatched.
4080 =item B<McelogLogfile> I<Path>
4082 The mcelog file to parse. Defaults to B<"/var/log/mcelog">. Note: this option
4083 cannot be used in conjunction with the memory block options, they are mutually
4090 The C<md plugin> collects information from Linux Software-RAID devices (md).
4092 All reported values are of the type C<md_disks>. Reported type instances are
4093 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
4094 I<missing> (physically absent) disks.
4098 =item B<Device> I<Device>
4100 Select md devices based on device name. The I<device name> is the basename of
4101 the device, i.e. the name of the block device without the leading C</dev/>.
4102 See B<IgnoreSelected> for more details.
4104 See F</"IGNORELISTS"> for details.
4106 =item B<IgnoreSelected> B<true>|B<false>
4108 Invert device selection: If set to B<true>, all md devices B<except> those
4109 listed using B<Device> are collected. If B<false> (the default), only those
4110 listed are collected. If no configuration is given, the B<md> plugin will
4111 collect data from all md devices.
4115 =head2 Plugin C<memcachec>
4117 The C<memcachec plugin> connects to a memcached server, queries one or more
4118 given I<pages> and parses the returned data according to user specification.
4119 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
4122 In order to talk to the memcached server, this plugin uses the I<libmemcached>
4123 library. Please note that there is another library with a very similar name,
4124 libmemcache (notice the missing `d'), which is not applicable.
4126 Synopsis of the configuration:
4128 <Plugin "memcachec">
4129 <Page "plugin_instance">
4132 Plugin "plugin_name"
4134 Regex "(\\d+) bytes sent"
4137 Instance "type_instance"
4142 The configuration options are:
4146 =item E<lt>B<Page> I<Name>E<gt>
4148 Each B<Page> block defines one I<page> to be queried from the memcached server.
4149 The block requires one string argument which is used as I<plugin instance>.
4151 =item B<Server> I<Address>
4153 Sets the server address to connect to when querying the page. Must be inside a
4158 When connected to the memcached server, asks for the page I<Key>.
4160 =item B<Plugin> I<Plugin>
4162 Use I<Plugin> as the plugin name when submitting values.
4163 Defaults to C<memcachec>.
4165 =item E<lt>B<Match>E<gt>
4167 Match blocks define which strings to look for and how matches substrings are
4168 interpreted. For a description of match blocks, please see L<"Plugin tail">.
4172 =head2 Plugin C<memcached>
4174 The B<memcached plugin> connects to a memcached server and queries statistics
4175 about cache utilization, memory and bandwidth used.
4176 L<http://memcached.org/>
4178 <Plugin "memcached">
4180 #Host "memcache.example.com"
4186 The plugin configuration consists of one or more B<Instance> blocks which
4187 specify one I<memcached> connection each. Within the B<Instance> blocks, the
4188 following options are allowed:
4192 =item B<Host> I<Hostname>
4194 Sets the B<host> field of dispatched values. Defaults to the global hostname
4196 For backwards compatibility, values are also dispatched with the global
4197 hostname when B<Host> is set to B<127.0.0.1> or B<localhost> and B<Address> is
4200 =item B<Address> I<Address>
4202 Hostname or IP to connect to. For backwards compatibility, defaults to the
4203 value of B<Host> or B<127.0.0.1> if B<Host> is unset.
4205 =item B<Port> I<Port>
4207 TCP port to connect to. Defaults to B<11211>.
4209 =item B<Socket> I<Path>
4211 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
4212 setting is given, the B<Address> and B<Port> settings are ignored.
4216 =head2 Plugin C<mic>
4218 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
4219 Intel's Many Integrated Core (MIC) systems.
4228 ShowTemperatures true
4231 IgnoreSelectedTemperature true
4236 IgnoreSelectedPower true
4239 The following options are valid inside the B<PluginE<nbsp>mic> block:
4243 =item B<ShowCPU> B<true>|B<false>
4245 If enabled (the default) a sum of the CPU usage across all cores is reported.
4247 =item B<ShowCPUCores> B<true>|B<false>
4249 If enabled (the default) per-core CPU usage is reported.
4251 =item B<ShowMemory> B<true>|B<false>
4253 If enabled (the default) the physical memory usage of the MIC system is
4256 =item B<ShowTemperatures> B<true>|B<false>
4258 If enabled (the default) various temperatures of the MIC system are reported.
4260 =item B<Temperature> I<Name>
4262 This option controls which temperatures are being reported. Whether matching
4263 temperatures are being ignored or I<only> matching temperatures are reported
4264 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
4265 temperatures are reported.
4267 =item B<IgnoreSelectedTemperature> B<false>|B<true>
4269 Controls the behavior of the B<Temperature> setting above. If set to B<false>
4270 (the default) only temperatures matching a B<Temperature> option are reported
4271 or, if no B<Temperature> option is specified, all temperatures are reported. If
4272 set to B<true>, matching temperatures are I<ignored> and all other temperatures
4275 Known temperature names are:
4309 =item B<ShowPower> B<true>|B<false>
4311 If enabled (the default) various temperatures of the MIC system are reported.
4313 =item B<Power> I<Name>
4315 This option controls which power readings are being reported. Whether matching
4316 power readings are being ignored or I<only> matching power readings are reported
4317 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
4318 power readings are reported.
4320 =item B<IgnoreSelectedPower> B<false>|B<true>
4322 Controls the behavior of the B<Power> setting above. If set to B<false>
4323 (the default) only power readings matching a B<Power> option are reported
4324 or, if no B<Power> option is specified, all power readings are reported. If
4325 set to B<true>, matching power readings are I<ignored> and all other power readings
4328 Known power names are:
4334 Total power utilization averaged over Time Window 0 (uWatts).
4338 Total power utilization averaged over Time Window 0 (uWatts).
4342 Instantaneous power (uWatts).
4346 Max instantaneous power (uWatts).
4350 PCI-E connector power (uWatts).
4354 2x3 connector power (uWatts).
4358 2x4 connector power (uWatts).
4366 Uncore rail (uVolts).
4370 Memory subsystem rail (uVolts).
4376 =head2 Plugin C<memory>
4378 The I<memory plugin> provides the following configuration options:
4382 =item B<ValuesAbsolute> B<true>|B<false>
4384 Enables or disables reporting of physical memory usage in absolute numbers,
4385 i.e. bytes. Defaults to B<true>.
4387 =item B<ValuesPercentage> B<false>|B<true>
4389 Enables or disables reporting of physical memory usage in percentages, e.g.
4390 percent of physical memory used. Defaults to B<false>.
4392 This is useful for deploying I<collectd> in a heterogeneous environment in
4393 which the sizes of physical memory vary.
4397 =head2 Plugin C<modbus>
4399 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
4400 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
4401 values), large integer values (unsigned 32E<nbsp>bit and 64E<nbsp>bit values) and
4402 floating point values (two registers interpreted as IEEE floats in big endian
4407 <Data "voltage-input-1">
4410 RegisterCmd ReadHolding
4417 <Data "voltage-input-2">
4420 RegisterCmd ReadHolding
4425 <Data "supply-temperature-1">
4428 RegisterCmd ReadHolding
4433 <Host "modbus.example.com">
4434 Address "192.168.0.42"
4439 Instance "power-supply"
4440 Collect "voltage-input-1"
4441 Collect "voltage-input-2"
4446 Device "/dev/ttyUSB0"
4451 Instance "temperature"
4452 Collect "supply-temperature-1"
4458 =item E<lt>B<Data> I<Name>E<gt> blocks
4460 Data blocks define a mapping between register numbers and the "types" used by
4463 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
4467 =item B<RegisterBase> I<Number>
4469 Configures the base register to read from the device. If the option
4470 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
4471 register will be read (the register number is increased by one).
4473 =item B<RegisterType> B<Int16>|B<Int32>|B<Int64>|B<Uint16>|B<Uint32>|B<UInt64>|B<Float>|B<Int32LE>|B<Uint32LE>|B<FloatLE>
4475 Specifies what kind of data is returned by the device. This defaults to
4476 B<Uint16>. If the type is B<Int32>, B<Int32LE>, B<Uint32>, B<Uint32LE>,
4477 B<Float> or B<FloatLE>, two 16E<nbsp>bit registers at B<RegisterBase>
4478 and B<RegisterBase+1> will be read and the data is combined into one
4479 32E<nbsp>value. For B<Int32>, B<Uint32> and B<Float> the most significant
4480 16E<nbsp>bits are in the register at B<RegisterBase> and the least
4481 significant 16E<nbsp>bits are in the register at B<RegisterBase+1>.
4482 For B<Int32LE>, B<Uint32LE>, or B<Float32LE>, the high and low order
4483 registers are swapped with the most significant 16E<nbsp>bits in
4484 the B<RegisterBase+1> and the least significant 16E<nbsp>bits in
4485 B<RegisterBase>. If the type is B<Int64> or B<UInt64>, four 16E<nbsp>bit
4486 registers at B<RegisterBase>, B<RegisterBase+1>, B<RegisterBase+2> and
4487 B<RegisterBase+3> will be read and the data combined into one
4490 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
4492 Specifies register type to be collected from device. Works only with libmodbus
4493 2.9.2 or higher. Defaults to B<ReadHolding>.
4495 =item B<Type> I<Type>
4497 Specifies the "type" (data set) to use when dispatching the value to
4498 I<collectd>. Currently, only data sets with exactly one data source are
4501 =item B<Instance> I<Instance>
4503 Sets the type instance to use when dispatching the value to I<Instance>. If
4504 unset, an empty string (no type instance) is used.
4506 =item B<Scale> I<Value>
4508 The values taken from device are multiplied by I<Value>. The field is optional
4509 and the default is B<1.0>.
4511 =item B<Shift> I<Value>
4513 I<Value> is added to values from device after they have been multiplied by
4514 B<Scale> value. The field is optional and the default value is B<0.0>.
4518 =item E<lt>B<Host> I<Name>E<gt> blocks
4520 Host blocks are used to specify to which hosts to connect and what data to read
4521 from their "slaves". The string argument I<Name> is used as hostname when
4522 dispatching the values to I<collectd>.
4524 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
4528 =item B<Address> I<Hostname>
4530 For Modbus/TCP, specifies the node name (the actual network address) used to
4531 connect to the host. This may be an IP address or a hostname. Please note that
4532 the used I<libmodbus> library only supports IPv4 at the moment.
4534 =item B<Port> I<Service>
4536 for Modbus/TCP, specifies the port used to connect to the host. The port can
4537 either be given as a number or as a service name. Please note that the
4538 I<Service> argument must be a string, even if ports are given in their numerical
4539 form. Defaults to "502".
4541 =item B<Device> I<Devicenode>
4543 For Modbus/RTU, specifies the path to the serial device being used.
4545 =item B<Baudrate> I<Baudrate>
4547 For Modbus/RTU, specifies the baud rate of the serial device.
4548 Note, connections currently support only 8/N/1.
4550 =item B<UARTType> I<UARTType>
4552 For Modbus/RTU, specifies the type of the serial device.
4553 RS232, RS422 and RS485 are supported. Defaults to RS232.
4554 Available only on Linux systems with libmodbus>=2.9.4.
4556 =item B<Interval> I<Interval>
4558 Sets the interval (in seconds) in which the values will be collected from this
4559 host. By default the global B<Interval> setting will be used.
4561 =item E<lt>B<Slave> I<ID>E<gt>
4563 Over each connection, multiple Modbus devices may be reached. The slave ID
4564 is used to specify which device should be addressed. For each device you want
4565 to query, one B<Slave> block must be given.
4567 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
4571 =item B<Instance> I<Instance>
4573 Specify the plugin instance to use when dispatching the values to I<collectd>.
4574 By default "slave_I<ID>" is used.
4576 =item B<Collect> I<DataName>
4578 Specifies which data to retrieve from the device. I<DataName> must be the same
4579 string as the I<Name> argument passed to a B<Data> block. You can specify this
4580 option multiple times to collect more than one value from a slave. At least one
4581 B<Collect> option is mandatory.
4589 =head2 Plugin C<mqtt>
4591 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
4592 values from MQTT (B<Subscribe> blocks).
4598 Host "mqtt.example.com"
4602 Host "mqtt.example.com"
4607 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
4608 configuring the sending and receiving direction respectively. The plugin will
4609 register a write callback named C<mqtt/I<name>> where I<name> is the string
4610 argument given to the B<Publish> block. Both types of blocks share many but not
4611 all of the following options. If an option is valid in only one of the blocks,
4612 it will be mentioned explicitly.
4618 =item B<Host> I<Hostname>
4620 Hostname of the MQTT broker to connect to.
4622 =item B<Port> I<Service>
4624 Port number or service name of the MQTT broker to connect to.
4626 =item B<User> I<UserName>
4628 Username used when authenticating to the MQTT broker.
4630 =item B<Password> I<Password>
4632 Password used when authenticating to the MQTT broker.
4634 =item B<ClientId> I<ClientId>
4636 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
4638 =item B<QoS> [B<0>-B<2>]
4640 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
4658 In B<Publish> blocks, this option determines the QoS flag set on outgoing
4659 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
4660 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
4661 on a message is larger than the maximum accepted QoS of a subscriber, the
4662 message's QoS will be downgraded.
4664 =item B<Prefix> I<Prefix> (Publish only)
4666 This plugin will use one topic per I<value list> which will looks like a path.
4667 I<Prefix> is used as the first path element and defaults to B<collectd>.
4669 An example topic name would be:
4671 collectd/cpu-0/cpu-user
4673 =item B<Retain> B<false>|B<true> (Publish only)
4675 Controls whether the MQTT broker will retain (keep a copy of) the last message
4676 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
4678 =item B<StoreRates> B<true>|B<false> (Publish only)
4680 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
4681 before sending. Defaults to B<true>.
4683 =item B<CleanSession> B<true>|B<false> (Subscribe only)
4685 Controls whether the MQTT "cleans" the session up after the subscriber
4686 disconnects or if it maintains the subscriber's subscriptions and all messages
4687 that arrive while the subscriber is disconnected. Defaults to B<true>.
4689 =item B<Topic> I<TopicName> (Subscribe only)
4691 Configures the topic(s) to subscribe to. You can use the single level C<+> and
4692 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
4693 the B<collectd> branch.
4695 =item B<CACert> I<file>
4697 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
4698 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
4699 port of the MQTT broker.
4700 This option enables the use of TLS.
4702 =item B<CertificateFile> I<file>
4704 Path to the PEM-encoded certificate file to use as client certificate when
4705 connecting to the MQTT broker.
4706 Only valid if B<CACert> and B<CertificateKeyFile> are also set.
4708 =item B<CertificateKeyFile> I<file>
4710 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
4711 Only valid if B<CACert> and B<CertificateFile> are also set.
4713 =item B<TLSProtocol> I<protocol>
4715 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
4716 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
4717 version is used which depends on the version of OpenSSL the Mosquitto library
4719 Only valid if B<CACert> is set.
4721 =item B<CipherSuite> I<ciphersuite>
4723 A string describing the ciphers available for use. See L<ciphers(1)> and the
4724 C<openssl ciphers> utility for more information. If unset, the default ciphers
4726 Only valid if B<CACert> is set.
4730 =head2 Plugin C<mysql>
4732 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
4733 one or more databases when started and keeps the connection up as long as
4734 possible. When the connection is interrupted for whatever reason it will try
4735 to re-connect. The plugin will complain loudly in case anything goes wrong.
4737 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
4738 and collects information about MySQL network traffic, executed statements,
4739 requests, the query cache and threads by evaluating the
4740 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
4741 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
4742 Status Variables> for an explanation of these values.
4744 Optionally, master and slave statistics may be collected in a MySQL
4745 replication setup. In that case, information about the synchronization state
4746 of the nodes are collected by evaluating the C<Position> return value of the
4747 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
4748 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
4749 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
4750 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
4751 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
4763 SSLKey "/path/to/key.pem"
4764 SSLCert "/path/to/cert.pem"
4765 SSLCA "/path/to/ca.pem"
4766 SSLCAPath "/path/to/cas/"
4767 SSLCipher "DHE-RSA-AES256-SHA"
4773 Socket "/var/run/mysql/mysqld.sock"
4775 SlaveNotifications true
4781 Socket "/var/run/mysql/mysqld.sock"
4786 A B<Database> block defines one connection to a MySQL database. It accepts a
4787 single argument which specifies the name of the database. None of the other
4788 options are required. MySQL will use default values as documented in the
4789 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
4790 B<MySQL reference manual>.
4794 =item B<Alias> I<Alias>
4796 Alias to use as sender instead of hostname when reporting. This may be useful
4797 when having cryptic hostnames.
4799 =item B<Host> I<Hostname>
4801 Hostname of the database server. Defaults to B<localhost>.
4803 =item B<User> I<Username>
4805 Username to use when connecting to the database. The user does not have to be
4806 granted any privileges (which is synonym to granting the C<USAGE> privilege),
4807 unless you want to collectd replication statistics (see B<MasterStats> and
4808 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
4809 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
4811 =item B<Password> I<Password>
4813 Password needed to log into the database.
4815 =item B<Database> I<Database>
4817 Select this database. Defaults to I<no database> which is a perfectly reasonable
4818 option for what this plugin does.
4820 =item B<Port> I<Port>
4822 TCP-port to connect to. The port must be specified in its numeric form, but it
4823 must be passed as a string nonetheless. For example:
4827 If B<Host> is set to B<localhost> (the default), this setting has no effect.
4828 See the documentation for the C<mysql_real_connect> function for details.
4830 =item B<Socket> I<Socket>
4832 Specifies the path to the UNIX domain socket of the MySQL server. This option
4833 only has any effect, if B<Host> is set to B<localhost> (the default).
4834 Otherwise, use the B<Port> option above. See the documentation for the
4835 C<mysql_real_connect> function for details.
4837 =item B<InnodbStats> I<true|false>
4839 If enabled, metrics about the InnoDB storage engine are collected.
4840 Disabled by default.
4842 =item B<MasterStats> I<true|false>
4844 =item B<SlaveStats> I<true|false>
4846 Enable the collection of master / slave statistics in a replication setup. In
4847 order to be able to get access to these statistics, the user needs special
4848 privileges. See the B<User> documentation above. Defaults to B<false>.
4850 =item B<SlaveNotifications> I<true|false>
4852 If enabled, the plugin sends a notification if the replication slave I/O and /
4853 or SQL threads are not running. Defaults to B<false>.
4855 =item B<WsrepStats> I<true|false>
4857 Enable the collection of wsrep plugin statistics, used in Master-Master
4858 replication setups like in MySQL Galera/Percona XtraDB Cluster.
4859 User needs only privileges to execute 'SHOW GLOBAL STATUS'
4861 =item B<ConnectTimeout> I<Seconds>
4863 Sets the connect timeout for the MySQL client.
4865 =item B<SSLKey> I<Path>
4867 If provided, the X509 key in PEM format.
4869 =item B<SSLCert> I<Path>
4871 If provided, the X509 cert in PEM format.
4873 =item B<SSLCA> I<Path>
4875 If provided, the CA file in PEM format (check OpenSSL docs).
4877 =item B<SSLCAPath> I<Path>
4879 If provided, the CA directory (check OpenSSL docs).
4881 =item B<SSLCipher> I<String>
4883 If provided, the SSL cipher to use.
4887 =head2 Plugin C<netapp>
4889 The netapp plugin can collect various performance and capacity information
4890 from a NetApp filer using the NetApp API.
4892 Please note that NetApp has a wide line of products and a lot of different
4893 software versions for each of these products. This plugin was developed for a
4894 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
4895 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
4896 model and software version but it is very hard to test this.
4897 If you have used this plugin with other models and/or software version, feel
4898 free to send us a mail to tell us about the results, even if it's just a short
4901 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
4902 basic authentication.
4904 B<Do not use a regular user for this!> Create a special collectd user with just
4905 the minimum of capabilities needed. The user only needs the "login-http-admin"
4906 capability as well as a few more depending on which data will be collected.
4907 Required capabilities are documented below.
4912 <Host "netapp1.example.com">
4936 IgnoreSelectedIO false
4938 IgnoreSelectedOps false
4939 GetLatency "volume0"
4940 IgnoreSelectedLatency false
4947 IgnoreSelectedCapacity false
4950 IgnoreSelectedSnapshot false
4978 The netapp plugin accepts the following configuration options:
4982 =item B<Host> I<Name>
4984 A host block defines one NetApp filer. It will appear in collectd with the name
4985 you specify here which does not have to be its real name nor its hostname (see
4986 the B<Address> option below).
4988 =item B<VFiler> I<Name>
4990 A B<VFiler> block may only be used inside a host block. It accepts all the
4991 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
4992 will execute all NetApp API commands in the context of the specified
4993 VFiler(R). It will appear in collectd with the name you specify here which
4994 does not have to be its real name. The VFiler name may be specified using the
4995 B<VFilerName> option. If this is not specified, it will default to the name
4998 The VFiler block inherits all connection related settings from the surrounding
4999 B<Host> block (which appear before the B<VFiler> block) but they may be
5000 overwritten inside the B<VFiler> block.
5002 This feature is useful, for example, when using a VFiler as SnapVault target
5003 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
5004 available in the host filer (vfiler0) but only in the respective VFiler
5007 =item B<Protocol> B<httpd>|B<http>
5009 The protocol collectd will use to query this host.
5017 Valid options: http, https
5019 =item B<Address> I<Address>
5021 The hostname or IP address of the host.
5027 Default: The "host" block's name.
5029 =item B<Port> I<Port>
5031 The TCP port to connect to on the host.
5037 Default: 80 for protocol "http", 443 for protocol "https"
5039 =item B<User> I<User>
5041 =item B<Password> I<Password>
5043 The username and password to use to login to the NetApp.
5049 =item B<VFilerName> I<Name>
5051 The name of the VFiler in which context to execute API commands. If not
5052 specified, the name provided to the B<VFiler> block will be used instead.
5058 Default: name of the B<VFiler> block
5060 B<Note:> This option may only be used inside B<VFiler> blocks.
5062 =item B<Interval> I<Interval>
5068 The following options decide what kind of data will be collected. You can
5069 either use them as a block and fine tune various parameters inside this block,
5070 use them as a single statement to just accept all default values, or omit it to
5071 not collect any data.
5073 The following options are valid inside all blocks:
5077 =item B<Interval> I<Seconds>
5079 Collect the respective statistics every I<Seconds> seconds. Defaults to the
5080 host specific setting.
5084 =head3 The System block
5086 This will collect various performance data about the whole system.
5088 B<Note:> To get this data the collectd user needs the
5089 "api-perf-object-get-instances" capability.
5093 =item B<Interval> I<Seconds>
5095 Collect disk statistics every I<Seconds> seconds.
5097 =item B<GetCPULoad> B<true>|B<false>
5099 If you set this option to true the current CPU usage will be read. This will be
5100 the average usage between all CPUs in your NetApp without any information about
5103 B<Note:> These are the same values that the NetApp CLI command "sysstat"
5104 returns in the "CPU" field.
5112 Result: Two value lists of type "cpu", and type instances "idle" and "system".
5114 =item B<GetInterfaces> B<true>|B<false>
5116 If you set this option to true the current traffic of the network interfaces
5117 will be read. This will be the total traffic over all interfaces of your NetApp
5118 without any information about individual interfaces.
5120 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5121 in the "Net kB/s" field.
5131 Result: One value list of type "if_octects".
5133 =item B<GetDiskIO> B<true>|B<false>
5135 If you set this option to true the current IO throughput will be read. This
5136 will be the total IO of your NetApp without any information about individual
5137 disks, volumes or aggregates.
5139 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5140 in the "DiskE<nbsp>kB/s" field.
5148 Result: One value list of type "disk_octets".
5150 =item B<GetDiskOps> B<true>|B<false>
5152 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
5153 iSCSI, etc. operations will be read. This will be the total number of
5154 operations on your NetApp without any information about individual volumes or
5157 B<Note:> These are the same values that the NetApp CLI command "sysstat"
5158 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
5166 Result: A variable number of value lists of type "disk_ops_complex". Each type
5167 of operation will result in one value list with the name of the operation as
5172 =head3 The WAFL block
5174 This will collect various performance data about the WAFL file system. At the
5175 moment this just means cache performance.
5177 B<Note:> To get this data the collectd user needs the
5178 "api-perf-object-get-instances" capability.
5180 B<Note:> The interface to get these values is classified as "Diagnostics" by
5181 NetApp. This means that it is not guaranteed to be stable even between minor
5186 =item B<Interval> I<Seconds>
5188 Collect disk statistics every I<Seconds> seconds.
5190 =item B<GetNameCache> B<true>|B<false>
5198 Result: One value list of type "cache_ratio" and type instance
5201 =item B<GetDirCache> B<true>|B<false>
5209 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
5211 =item B<GetInodeCache> B<true>|B<false>
5219 Result: One value list of type "cache_ratio" and type instance
5222 =item B<GetBufferCache> B<true>|B<false>
5224 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
5225 in the "Cache hit" field.
5233 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
5237 =head3 The Disks block
5239 This will collect performance data about the individual disks in the NetApp.
5241 B<Note:> To get this data the collectd user needs the
5242 "api-perf-object-get-instances" capability.
5246 =item B<Interval> I<Seconds>
5248 Collect disk statistics every I<Seconds> seconds.
5250 =item B<GetBusy> B<true>|B<false>
5252 If you set this option to true the busy time of all disks will be calculated
5253 and the value of the busiest disk in the system will be written.
5255 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5256 in the "Disk util" field. Probably.
5264 Result: One value list of type "percent" and type instance "disk_busy".
5268 =head3 The VolumePerf block
5270 This will collect various performance data about the individual volumes.
5272 You can select which data to collect about which volume using the following
5273 options. They follow the standard ignorelist semantic.
5275 B<Note:> To get this data the collectd user needs the
5276 I<api-perf-object-get-instances> capability.
5280 =item B<Interval> I<Seconds>
5282 Collect volume performance data every I<Seconds> seconds.
5284 =item B<GetIO> I<Volume>
5286 =item B<GetOps> I<Volume>
5288 =item B<GetLatency> I<Volume>
5290 Select the given volume for IO, operations or latency statistics collection.
5291 The argument is the name of the volume without the C</vol/> prefix.
5293 Since the standard ignorelist functionality is used here, you can use a string
5294 starting and ending with a slash to specify regular expression matching: To
5295 match the volumes "vol0", "vol2" and "vol7", you can use this regular
5298 GetIO "/^vol[027]$/"
5300 If no regular expression is specified, an exact match is required. Both,
5301 regular and exact matching are case sensitive.
5303 If no volume was specified at all for either of the three options, that data
5304 will be collected for all available volumes.
5306 See F</"IGNORELISTS"> for details.
5308 =item B<IgnoreSelectedIO> B<true>|B<false>
5310 =item B<IgnoreSelectedOps> B<true>|B<false>
5312 =item B<IgnoreSelectedLatency> B<true>|B<false>
5314 When set to B<true>, the volumes selected for IO, operations or latency
5315 statistics collection will be ignored and the data will be collected for all
5318 When set to B<false>, data will only be collected for the specified volumes and
5319 all other volumes will be ignored.
5321 If no volumes have been specified with the above B<Get*> options, all volumes
5322 will be collected regardless of the B<IgnoreSelected*> option.
5324 Defaults to B<false>
5328 =head3 The VolumeUsage block
5330 This will collect capacity data about the individual volumes.
5332 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
5337 =item B<Interval> I<Seconds>
5339 Collect volume usage statistics every I<Seconds> seconds.
5341 =item B<GetCapacity> I<VolumeName>
5343 The current capacity of the volume will be collected. This will result in two
5344 to four value lists, depending on the configuration of the volume. All data
5345 sources are of type "df_complex" with the name of the volume as
5348 There will be type_instances "used" and "free" for the number of used and
5349 available bytes on the volume. If the volume has some space reserved for
5350 snapshots, a type_instance "snap_reserved" will be available. If the volume
5351 has SIS enabled, a type_instance "sis_saved" will be available. This is the
5352 number of bytes saved by the SIS feature.
5354 B<Note:> The current NetApp API has a bug that results in this value being
5355 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
5356 number which works most of the time. If you see strange values here, bug
5357 NetApp support to fix this.
5359 Repeat this option to specify multiple volumes.
5361 =item B<IgnoreSelectedCapacity> B<true>|B<false>
5363 Specify whether to collect only the volumes selected by the B<GetCapacity>
5364 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
5365 B<false>. However, if no B<GetCapacity> option is specified at all, all
5366 capacities will be selected anyway.
5368 =item B<GetSnapshot> I<VolumeName>
5370 Select volumes from which to collect snapshot information.
5372 Usually, the space used for snapshots is included in the space reported as
5373 "used". If snapshot information is collected as well, the space used for
5374 snapshots is subtracted from the used space.
5376 To make things even more interesting, it is possible to reserve space to be
5377 used for snapshots. If the space required for snapshots is less than that
5378 reserved space, there is "reserved free" and "reserved used" space in addition
5379 to "free" and "used". If the space required for snapshots exceeds the reserved
5380 space, that part allocated in the normal space is subtracted from the "used"
5383 Repeat this option to specify multiple volumes.
5385 =item B<IgnoreSelectedSnapshot>
5387 Specify whether to collect only the volumes selected by the B<GetSnapshot>
5388 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
5389 B<false>. However, if no B<GetSnapshot> option is specified at all, all
5390 capacities will be selected anyway.
5394 =head3 The Quota block
5396 This will collect (tree) quota statistics (used disk space and number of used
5397 files). This mechanism is useful to get usage information for single qtrees.
5398 In case the quotas are not used for any other purpose, an entry similar to the
5399 following in C</etc/quotas> would be sufficient:
5401 /vol/volA/some_qtree tree - - - - -
5403 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
5407 =item B<Interval> I<Seconds>
5409 Collect SnapVault(R) statistics every I<Seconds> seconds.
5413 =head3 The SnapVault block
5415 This will collect statistics about the time and traffic of SnapVault(R)
5420 =item B<Interval> I<Seconds>
5422 Collect SnapVault(R) statistics every I<Seconds> seconds.
5426 =head2 Plugin C<netlink>
5428 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
5429 statistics of various interface and routing aspects.
5433 =item B<Interface> I<Interface>
5435 =item B<VerboseInterface> I<Interface>
5437 Instruct the plugin to collect interface statistics. This is basically the same
5438 as the statistics provided by the C<interface> plugin (see above) but
5439 potentially much more detailed.
5441 When configuring with B<Interface> only the basic statistics will be collected,
5442 namely octets, packets, and errors. These statistics are collected by
5443 the C<interface> plugin, too, so using both at the same time is no benefit.
5445 When configured with B<VerboseInterface> all counters B<except> the basic ones
5446 will be collected, so that no data needs to be collected twice if you use the
5447 C<interface> plugin.
5448 This includes dropped packets, received multicast packets, collisions and a
5449 whole zoo of differentiated RX and TX errors. You can try the following command
5450 to get an idea of what awaits you:
5454 If I<Interface> is B<All>, all interfaces will be selected.
5456 =item B<QDisc> I<Interface> [I<QDisc>]
5458 =item B<Class> I<Interface> [I<Class>]
5460 =item B<Filter> I<Interface> [I<Filter>]
5462 Collect the octets and packets that pass a certain qdisc, class or filter.
5464 QDiscs and classes are identified by their type and handle (or classid).
5465 Filters don't necessarily have a handle, therefore the parent's handle is used.
5466 The notation used in collectd differs from that used in tc(1) in that it
5467 doesn't skip the major or minor number if it's zero and doesn't print special
5468 ids by their name. So, for example, a qdisc may be identified by
5469 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
5470 thus not displayed by tc(1).
5472 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
5473 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
5474 associated with that interface will be collected.
5476 Since a filter itself doesn't necessarily have a handle, the parent's handle is
5477 used. This may lead to problems when more than one filter is attached to a
5478 qdisc or class. This isn't nice, but we don't know how this could be done any
5479 better. If you have a idea, please don't hesitate to tell us.
5481 As with the B<Interface> option you can specify B<All> as the interface,
5482 meaning all interfaces.
5484 Here are some examples to help you understand the above text more easily:
5487 VerboseInterface "All"
5488 QDisc "eth0" "pfifo_fast-1:0"
5490 Class "ppp0" "htb-1:10"
5491 Filter "ppp0" "u32-1:0"
5494 See F</"IGNORELISTS"> for details.
5496 =item B<IgnoreSelected>
5498 The behavior is the same as with all other similar plugins: If nothing is
5499 selected at all, everything is collected. If some things are selected using the
5500 options described above, only these statistics are collected. If you set
5501 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
5502 specified statistics will not be collected.
5506 =head2 Plugin C<network>
5508 The Network plugin sends data to a remote instance of collectd, receives data
5509 from a remote instance, or both at the same time. Data which has been received
5510 from the network is usually not transmitted again, but this can be activated, see
5511 the B<Forward> option below.
5513 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
5514 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
5516 Both, B<Server> and B<Listen> can be used as single option or as block. When
5517 used as block, given options are valid for this socket only. The following
5518 example will export the metrics twice: Once to an "internal" server (without
5519 encryption and signing) and one to an external server (with cryptographic
5523 # Export to an internal server
5524 # (demonstrates usage without additional options)
5525 Server "collectd.internal.tld"
5527 # Export to an external server
5528 # (demonstrates usage with signature options)
5529 <Server "collectd.external.tld">
5530 SecurityLevel "sign"
5531 Username "myhostname"
5538 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
5540 The B<Server> statement/block sets the server to send datagrams to. The
5541 statement may occur multiple times to send each datagram to multiple
5544 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
5545 optional second argument specifies a port number or a service name. If not
5546 given, the default, B<25826>, is used.
5548 The following options are recognized within B<Server> blocks:
5552 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5554 Set the security you require for network communication. When the security level
5555 has been set to B<Encrypt>, data sent over the network will be encrypted using
5556 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
5557 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
5558 authentication code. When set to B<None>, data is sent without any security.
5560 This feature is only available if the I<network> plugin was linked with
5563 =item B<Username> I<Username>
5565 Sets the username to transmit. This is used by the server to lookup the
5566 password. See B<AuthFile> below. All security levels except B<None> require
5569 This feature is only available if the I<network> plugin was linked with
5572 =item B<Password> I<Password>
5574 Sets a password (shared secret) for this socket. All security levels except
5575 B<None> require this setting.
5577 This feature is only available if the I<network> plugin was linked with
5580 =item B<Interface> I<Interface name>
5582 Set the outgoing interface for IP packets. This applies at least
5583 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5584 undefined or a non-existent interface name is specified, the default
5585 behavior is to let the kernel choose the appropriate interface. Be warned
5586 that the manual selection of an interface for unicast traffic is only
5587 necessary in rare cases.
5589 =item B<BindAddress> I<IP Address>
5591 Set the outgoing IP address for IP packets. This option can be used instead of
5592 the I<Interface> option to explicitly define the IP address which will be used
5593 to send Packets to the remote server.
5595 =item B<ResolveInterval> I<Seconds>
5597 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
5598 useful to force a regular DNS lookup to support a high availability setup. If
5599 not specified, re-resolves are never attempted.
5603 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
5605 The B<Listen> statement sets the interfaces to bind to. When multiple
5606 statements are found the daemon will bind to multiple interfaces.
5608 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
5609 the argument is a multicast address the daemon will join that multicast group.
5610 The optional second argument specifies a port number or a service name. If not
5611 given, the default, B<25826>, is used.
5613 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
5617 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5619 Set the security you require for network communication. When the security level
5620 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
5621 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
5622 signed and encrypted data is accepted. When set to B<None>, all data will be
5623 accepted. If an B<AuthFile> option was given (see below), encrypted data is
5624 decrypted if possible.
5626 This feature is only available if the I<network> plugin was linked with
5629 =item B<AuthFile> I<Filename>
5631 Sets a file in which usernames are mapped to passwords. These passwords are
5632 used to verify signatures and to decrypt encrypted network packets. If
5633 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
5634 verified and encrypted packets are decrypted. Otherwise, signed data is
5635 accepted without checking the signature and encrypted data cannot be decrypted.
5636 For the other security levels this option is mandatory.
5638 The file format is very simple: Each line consists of a username followed by a
5639 colon and any number of spaces followed by the password. To demonstrate, an
5640 example file could look like this:
5645 Each time a packet is received, the modification time of the file is checked
5646 using L<stat(2)>. If the file has been changed, the contents is re-read. While
5647 the file is being read, it is locked using L<fcntl(2)>.
5649 =item B<Interface> I<Interface name>
5651 Set the incoming interface for IP packets explicitly. This applies at least
5652 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5653 undefined or a non-existent interface name is specified, the default
5654 behavior is, to let the kernel choose the appropriate interface. Thus incoming
5655 traffic gets only accepted, if it arrives on the given interface.
5659 =item B<TimeToLive> I<1-255>
5661 Set the time-to-live of sent packets. This applies to all, unicast and
5662 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
5663 That means that multicast packets will be sent with a TTL of C<1> (one) on most
5666 =item B<MaxPacketSize> I<1024-65535>
5668 Set the maximum size for datagrams received over the network. Packets larger
5669 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
5670 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
5673 On the server side, this limit should be set to the largest value used on
5674 I<any> client. Likewise, the value on the client must not be larger than the
5675 value on the server, or data will be lost.
5677 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
5678 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
5679 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
5682 =item B<Forward> I<true|false>
5684 If set to I<true>, write packets that were received via the network plugin to
5685 the sending sockets. This should only be activated when the B<Listen>- and
5686 B<Server>-statements differ. Otherwise packets may be send multiple times to
5687 the same multicast group. While this results in more network traffic than
5688 necessary it's not a huge problem since the plugin has a duplicate detection,
5689 so the values will not loop.
5691 =item B<ReportStats> B<true>|B<false>
5693 The network plugin cannot only receive and send statistics, it can also create
5694 statistics about itself. Collectd data included the number of received and
5695 sent octets and packets, the length of the receive queue and the number of
5696 values handled. When set to B<true>, the I<Network plugin> will make these
5697 statistics available. Defaults to B<false>.
5701 =head2 Plugin C<nfs>
5703 The I<nfs plugin> collects information about the usage of the Network File
5704 System (NFS). It counts the number of procedure calls for each procedure,
5705 grouped by version and whether the system runs as server or client.
5707 It is possibly to omit metrics for a specific NFS version by setting one or
5708 more of the following options to B<false> (all of them default to B<true>).
5712 =item B<ReportV2> B<true>|B<false>
5714 =item B<ReportV3> B<true>|B<false>
5716 =item B<ReportV4> B<true>|B<false>
5720 =head2 Plugin C<nginx>
5722 This plugin collects the number of connections and requests handled by the
5723 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
5724 queries the page provided by the C<ngx_http_stub_status_module> module, which
5725 isn't compiled by default. Please refer to
5726 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
5727 how to compile and configure nginx and this module.
5729 The following options are accepted by the C<nginx plugin>:
5733 =item B<URL> I<http://host/nginx_status>
5735 Sets the URL of the C<ngx_http_stub_status_module> output.
5737 =item B<User> I<Username>
5739 Optional user name needed for authentication.
5741 =item B<Password> I<Password>
5743 Optional password needed for authentication.
5745 =item B<VerifyPeer> B<true|false>
5747 Enable or disable peer SSL certificate verification. See
5748 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5750 =item B<VerifyHost> B<true|false>
5752 Enable or disable peer host name verification. If enabled, the plugin checks
5753 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5754 certificate matches the host name provided by the B<URL> option. If this
5755 identity check fails, the connection is aborted. Obviously, only works when
5756 connecting to a SSL enabled server. Enabled by default.
5758 =item B<CACert> I<File>
5760 File that holds one or more SSL certificates. If you want to use HTTPS you will
5761 possibly need this option. What CA certificates come bundled with C<libcurl>
5762 and are checked by default depends on the distribution you use.
5764 =item B<Timeout> I<Milliseconds>
5766 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
5767 milliseconds. By default, the configured B<Interval> is used to set the
5772 =head2 Plugin C<notify_desktop>
5774 This plugin sends a desktop notification to a notification daemon, as defined
5775 in the Desktop Notification Specification. To actually display the
5776 notifications, B<notification-daemon> is required and B<collectd> has to be
5777 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
5778 environment variables have to be set correctly) and the D-Bus message bus.
5780 The Desktop Notification Specification can be found at
5781 L<http://www.galago-project.org/specs/notification/>.
5785 =item B<OkayTimeout> I<timeout>
5787 =item B<WarningTimeout> I<timeout>
5789 =item B<FailureTimeout> I<timeout>
5791 Set the I<timeout>, in milliseconds, after which to expire the notification
5792 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
5793 been specified, the displayed notification will not be closed at all - the
5794 user has to do so herself. These options default to 5000. If a negative number
5795 has been specified, the default is used as well.
5799 =head2 Plugin C<notify_email>
5801 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
5802 configured email address.
5804 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
5806 Available configuration options:
5810 =item B<From> I<Address>
5812 Email address from which the emails should appear to come from.
5814 Default: C<root@localhost>
5816 =item B<Recipient> I<Address>
5818 Configures the email address(es) to which the notifications should be mailed.
5819 May be repeated to send notifications to multiple addresses.
5821 At least one B<Recipient> must be present for the plugin to work correctly.
5823 =item B<SMTPServer> I<Hostname>
5825 Hostname of the SMTP server to connect to.
5827 Default: C<localhost>
5829 =item B<SMTPPort> I<Port>
5831 TCP port to connect to.
5835 =item B<SMTPUser> I<Username>
5837 Username for ASMTP authentication. Optional.
5839 =item B<SMTPPassword> I<Password>
5841 Password for ASMTP authentication. Optional.
5843 =item B<Subject> I<Subject>
5845 Subject-template to use when sending emails. There must be exactly two
5846 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
5847 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
5850 Default: C<Collectd notify: %s@%s>
5854 =head2 Plugin C<notify_nagios>
5856 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
5857 a I<passive service check result>.
5859 Available configuration options:
5863 =item B<CommandFile> I<Path>
5865 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
5869 =head2 Plugin C<ntpd>
5871 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
5874 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
5875 the wire - using B<mode 7> specific requests. This mode is deprecated with
5876 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
5877 correctly with them, the ntp daemon must be explicitly configured to
5878 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
5879 manual page for details.
5881 Available configuration options for the C<ntpd> plugin:
5885 =item B<Host> I<Hostname>
5887 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
5889 =item B<Port> I<Port>
5891 UDP-Port to connect to. Defaults to B<123>.
5893 =item B<ReverseLookups> B<true>|B<false>
5895 Sets whether or not to perform reverse lookups on peers. Since the name or
5896 IP-address may be used in a filename it is recommended to disable reverse
5897 lookups. The default is to do reverse lookups to preserve backwards
5898 compatibility, though.
5900 =item B<IncludeUnitID> B<true>|B<false>
5902 When a peer is a refclock, include the unit ID in the I<type instance>.
5903 Defaults to B<false> for backward compatibility.
5905 If two refclock peers use the same driver and this is B<false>, the plugin will
5906 try to write simultaneous measurements from both to the same type instance.
5907 This will result in error messages in the log and only one set of measurements
5912 =head2 Plugin C<nut>
5916 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
5918 Add a UPS to collect data from. The format is identical to the one accepted by
5921 =item B<ForceSSL> B<true>|B<false>
5923 Stops connections from falling back to unsecured if an SSL connection
5924 cannot be established. Defaults to false if undeclared.
5926 =item B<VerifyPeer> I<true>|I<false>
5928 If set to true, requires a CAPath be provided. Will use the CAPath to find
5929 certificates to use as Trusted Certificates to validate a upsd server certificate.
5930 If validation of the upsd server certificate fails, the connection will not be
5931 established. If ForceSSL is undeclared or set to false, setting VerifyPeer to true
5932 will override and set ForceSSL to true.
5934 =item B<CAPath> I/path/to/certs/folder
5936 If VerifyPeer is set to true, this is required. Otherwise this is ignored.
5937 The folder pointed at must contain certificate(s) named according to their hash.
5938 Ex: XXXXXXXX.Y where X is the hash value of a cert and Y is 0. If name collisions
5939 occur because two different certs have the same hash value, Y can be incremented
5940 in order to avoid conflict. To create a symbolic link to a certificate the following
5941 command can be used from within the directory where the cert resides:
5943 C<ln -s some.crt ./$(openssl x509 -hash -noout -in some.crt).0>
5945 Alternatively, the package openssl-perl provides a command C<c_rehash> that will
5946 generate links like the one described above for ALL certs in a given folder.
5948 C<c_rehash /path/to/certs/folder>
5950 =item B<ConnectTimeout> I<Milliseconds>
5952 The B<ConnectTimeout> option sets the connect timeout, in milliseconds.
5953 By default, the configured B<Interval> is used to set the timeout.
5957 =head2 Plugin C<olsrd>
5959 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
5960 the Optimized Link State Routing daemon and reads information about the current
5961 state of the meshed network.
5963 The following configuration options are understood:
5967 =item B<Host> I<Host>
5969 Connect to I<Host>. Defaults to B<"localhost">.
5971 =item B<Port> I<Port>
5973 Specifies the port to connect to. This must be a string, even if you give the
5974 port as a number rather than a service name. Defaults to B<"2006">.
5976 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
5978 Specifies what information to collect about links, i.E<nbsp>e. direct
5979 connections of the daemon queried. If set to B<No>, no information is
5980 collected. If set to B<Summary>, the number of links and the average of all
5981 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
5982 If set to B<Detail> LQ and NLQ are collected per link.
5984 Defaults to B<Detail>.
5986 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
5988 Specifies what information to collect about routes of the daemon queried. If
5989 set to B<No>, no information is collected. If set to B<Summary>, the number of
5990 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
5991 metric and ETX are collected per route.
5993 Defaults to B<Summary>.
5995 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
5997 Specifies what information to collect about the global topology. If set to
5998 B<No>, no information is collected. If set to B<Summary>, the number of links
5999 in the entire topology and the average I<link quality> (LQ) is calculated.
6000 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
6002 Defaults to B<Summary>.
6006 =head2 Plugin C<onewire>
6008 B<EXPERIMENTAL!> See notes below.
6010 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
6011 L<http://owfs.org/> to read sensors connected via the onewire bus.
6013 It can be used in two possible modes - standard or advanced.
6015 In the standard mode only temperature sensors (sensors with the family code
6016 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
6017 other sensors you would like to have included, please send a sort request to
6018 the mailing list. You can select sensors to be read or to be ignored depending
6019 on the option B<IgnoreSelected>). When no list is provided the whole bus is
6020 walked and all sensors are read.
6022 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
6023 experimental, below.
6025 In the advanced mode you can configure any sensor to be read (only numerical
6026 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
6027 In this mode you have to list all the sensors. Neither default bus walk nor
6028 B<IgnoreSelected> are used here. Address and type (file) is extracted from
6029 the path automatically and should produce compatible structure with the "standard"
6030 mode (basically the path is expected as for example
6031 "/uncached/10.F10FCA000800/temperature" where it would extract address part
6032 "F10FCA000800" and the rest after the slash is considered the type - here
6034 There are two advantages to this mode - you can access virtually any sensor
6035 (not just temperature), select whether to use cached or directly read values
6036 and it is slighlty faster. The downside is more complex configuration.
6038 The two modes are distinguished automatically by the format of the address.
6039 It is not possible to mix the two modes. Once a full path is detected in any
6040 B<Sensor> then the whole addressing (all sensors) is considered to be this way
6041 (and as standard addresses will fail parsing they will be ignored).
6045 =item B<Device> I<Device>
6047 Sets the device to read the values from. This can either be a "real" hardware
6048 device, such as a serial port or an USB port, or the address of the
6049 L<owserver(1)> socket, usually B<localhost:4304>.
6051 Though the documentation claims to automatically recognize the given address
6052 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
6053 with that version, the following configuration worked for us:
6056 Device "-s localhost:4304"
6059 This directive is B<required> and does not have a default value.
6061 =item B<Sensor> I<Sensor>
6063 In the standard mode selects sensors to collect or to ignore
6064 (depending on B<IgnoreSelected>, see below). Sensors are specified without
6065 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
6066 and B<not> include the leading C<10.> family byte and point.
6067 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
6068 sensors (see above) are read.
6070 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
6071 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
6072 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
6074 As there can be multiple devices on the bus you can list multiple sensor (use
6075 multiple B<Sensor> elements).
6077 See F</"IGNORELISTS"> for details.
6079 =item B<IgnoreSelected> I<true>|I<false>
6081 If no configuration is given, the B<onewire> plugin will collect data from all
6082 sensors found. This may not be practical, especially if sensors are added and
6083 removed regularly. Sometimes, however, it's easier/preferred to collect only
6084 specific sensors or all sensors I<except> a few specified ones. This option
6085 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
6086 B<Sensor> is inverted: All selected interfaces are ignored and all other
6087 interfaces are collected.
6089 Used only in the standard mode - see above.
6091 =item B<Interval> I<Seconds>
6093 Sets the interval in which all sensors should be read. If not specified, the
6094 global B<Interval> setting is used.
6098 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
6099 work with big setups. It works with one sensor being attached to one
6100 controller, but as soon as you throw in a couple more senors and maybe a hub
6101 or two, reading all values will take more than ten seconds (the default
6102 interval). We will probably add some separate thread for reading the sensors
6103 and some cache or something like that, but it's not done yet. We will try to
6104 maintain backwards compatibility in the future, but we can't promise. So in
6105 short: If it works for you: Great! But keep in mind that the config I<might>
6106 change, though this is unlikely. Oh, and if you want to help improving this
6107 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
6109 =head2 Plugin C<openldap>
6111 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
6112 server correctly. The backend database C<monitor> needs to be loaded and
6113 working. See slapd-monitor(5) for the details.
6115 The configuration of the C<openldap> plugin consists of one or more B<Instance>
6116 blocks. Each block requires one string argument as the instance name. For
6121 URL "ldap://localhost/"
6124 URL "ldaps://localhost/"
6128 The instance name will be used as the I<plugin instance>. To emulate the old
6129 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
6130 plugin to work correctly, each instance name must be unique. This is not
6131 enforced by the plugin and it is your responsibility to ensure it is.
6133 The following options are accepted within each B<Instance> block:
6137 =item B<URL> I<ldap://host/binddn>
6139 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
6142 =item B<BindDN> I<BindDN>
6144 Name in the form of an LDAP distinguished name intended to be used for
6145 authentication. Defaults to empty string to establish an anonymous authorization.
6147 =item B<Password> I<Password>
6149 Password for simple bind authentication. If this option is not set,
6150 unauthenticated bind operation is used.
6152 =item B<StartTLS> B<true|false>
6154 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
6155 Disabled by default.
6157 =item B<VerifyHost> B<true|false>
6159 Enables or disables peer host name verification. If enabled, the plugin checks
6160 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
6161 certificate matches the host name provided by the B<URL> option. If this
6162 identity check fails, the connection is aborted. Enabled by default.
6164 =item B<CACert> I<File>
6166 File that holds one or more SSL certificates. If you want to use TLS/SSL you
6167 may possibly need this option. What CA certificates are checked by default
6168 depends on the distribution you use and can be changed with the usual ldap
6169 client configuration mechanisms. See ldap.conf(5) for the details.
6171 =item B<Timeout> I<Seconds>
6173 Sets the timeout value for ldap operations, in seconds. By default, the
6174 configured B<Interval> is used to set the timeout. Use B<-1> to disable
6177 =item B<Version> I<Version>
6179 An integer which sets the LDAP protocol version number to use when connecting
6180 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
6184 =head2 Plugin C<openvpn>
6186 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
6187 traffic statistics about connected clients.
6189 To set up OpenVPN to write to the status file periodically, use the
6190 B<--status> option of OpenVPN.
6192 So, in a nutshell you need:
6194 openvpn $OTHER_OPTIONS \
6195 --status "/var/run/openvpn-status" 10
6201 =item B<StatusFile> I<File>
6203 Specifies the location of the status file.
6205 =item B<ImprovedNamingSchema> B<true>|B<false>
6207 When enabled, the filename of the status file will be used as plugin instance
6208 and the client's "common name" will be used as type instance. This is required
6209 when reading multiple status files. Enabling this option is recommended, but to
6210 maintain backwards compatibility this option is disabled by default.
6212 =item B<CollectCompression> B<true>|B<false>
6214 Sets whether or not statistics about the compression used by OpenVPN should be
6215 collected. This information is only available in I<single> mode. Enabled by
6218 =item B<CollectIndividualUsers> B<true>|B<false>
6220 Sets whether or not traffic information is collected for each connected client
6221 individually. If set to false, currently no traffic data is collected at all
6222 because aggregating this data in a save manner is tricky. Defaults to B<true>.
6224 =item B<CollectUserCount> B<true>|B<false>
6226 When enabled, the number of currently connected clients or users is collected.
6227 This is especially interesting when B<CollectIndividualUsers> is disabled, but
6228 can be configured independently from that option. Defaults to B<false>.
6232 =head2 Plugin C<oracle>
6234 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
6235 Oracle® Database and lets you execute SQL statements there. It is very similar
6236 to the "dbi" plugin, because it was written around the same time. See the "dbi"
6237 plugin's documentation above for details.
6240 <Query "out_of_stock">
6241 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
6244 # InstancePrefix "foo"
6245 InstancesFrom "category"
6249 <Database "product_information">
6254 Query "out_of_stock"
6258 =head3 B<Query> blocks
6260 The Query blocks are handled identically to the Query blocks of the "dbi"
6261 plugin. Please see its documentation above for details on how to specify
6264 =head3 B<Database> blocks
6266 Database blocks define a connection to a database and which queries should be
6267 sent to that database. Each database needs a "name" as string argument in the
6268 starting tag of the block. This name will be used as "PluginInstance" in the
6269 values submitted to the daemon. Other than that, that name is not used.
6273 =item B<Plugin> I<Plugin>
6275 Use I<Plugin> as the plugin name when submitting query results from
6276 this B<Database>. Defaults to C<oracle>.
6278 =item B<ConnectID> I<ID>
6280 Defines the "database alias" or "service name" to connect to. Usually, these
6281 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
6283 =item B<Host> I<Host>
6285 Hostname to use when dispatching values for this database. Defaults to using
6286 the global hostname of the I<collectd> instance.
6288 =item B<Username> I<Username>
6290 Username used for authentication.
6292 =item B<Password> I<Password>
6294 Password used for authentication.
6296 =item B<Query> I<QueryName>
6298 Associates the query named I<QueryName> with this database connection. The
6299 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
6300 blocks you want to refer to must be placed above the database block you want to
6305 =head2 Plugin C<ovs_events>
6307 The I<ovs_events> plugin monitors the link status of I<Open vSwitch> (OVS)
6308 connected interfaces, dispatches the values to collectd and sends the
6309 notification whenever the link state change occurs. This plugin uses OVS
6310 database to get a link state change notification.
6314 <Plugin "ovs_events">
6317 Socket "/var/run/openvswitch/db.sock"
6318 Interfaces "br0" "veth0"
6319 SendNotification true
6320 DispatchValues false
6323 The plugin provides the following configuration options:
6327 =item B<Address> I<node>
6329 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6330 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6331 option. See L<ovsdb-server(1)> for more details. The option may be either
6332 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6333 format. Defaults to C<localhost>.
6335 =item B<Port> I<service>
6337 TCP-port to connect to. Either a service name or a port number may be given.
6338 Defaults to B<6640>.
6340 =item B<Socket> I<path>
6342 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6343 plugin. To enable the interface, the OVS DB daemon should be running with
6344 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6345 option is set, B<Address> and B<Port> options are ignored.
6347 =item B<Interfaces> [I<ifname> ...]
6349 List of interface names to be monitored by this plugin. If this option is not
6350 specified or is empty then all OVS connected interfaces on all bridges are
6353 Default: empty (all interfaces on all bridges are monitored)
6355 =item B<SendNotification> I<true|false>
6357 If set to true, OVS link notifications (interface status and OVS DB connection
6358 terminate) are sent to collectd. Default value is true.
6360 =item B<DispatchValues> I<true|false>
6362 Dispatch the OVS DB interface link status value with configured plugin interval.
6363 Defaults to false. Please note, if B<SendNotification> and B<DispatchValues>
6364 options are false, no OVS information will be provided by the plugin.
6368 B<Note:> By default, the global interval setting is used within which to
6369 retrieve the OVS link status. To configure a plugin-specific interval, please
6370 use B<Interval> option of the OVS B<LoadPlugin> block settings. For milliseconds
6371 simple divide the time by 1000 for example if the desired interval is 50ms, set
6374 =head2 Plugin C<ovs_stats>
6376 The I<ovs_stats> plugin collects statistics of OVS connected interfaces.
6377 This plugin uses OVSDB management protocol (RFC7047) monitor mechanism to get
6378 statistics from OVSDB
6382 <Plugin "ovs_stats">
6385 Socket "/var/run/openvswitch/db.sock"
6386 Bridges "br0" "br_ext"
6387 InterfaceStats false
6390 The plugin provides the following configuration options:
6394 =item B<Address> I<node>
6396 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6397 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6398 option. See L<ovsdb-server(1)> for more details. The option may be either
6399 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6400 format. Defaults to C<localhost>.
6402 =item B<Port> I<service>
6404 TCP-port to connect to. Either a service name or a port number may be given.
6405 Defaults to B<6640>.
6407 =item B<Socket> I<path>
6409 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6410 plugin. To enable the interface, the OVS DB daemon should be running with
6411 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6412 option is set, B<Address> and B<Port> options are ignored.
6414 =item B<Bridges> [I<brname> ...]
6416 List of OVS bridge names to be monitored by this plugin. If this option is
6417 omitted or is empty then all OVS bridges will be monitored.
6419 Default: empty (monitor all bridges)
6421 =item B<InterfaceStats> B<false>|B<true>
6423 Indicates that the plugin should gather statistics for individual interfaces
6424 in addition to ports. This can be useful when monitoring an OVS setup with
6425 bond ports, where you might wish to know individual statistics for the
6426 interfaces included in the bonds. Defaults to B<false>.
6430 =head2 Plugin C<pcie_errors>
6432 The I<pcie_errors> plugin collects PCI Express errors from Device Status in Capability
6433 structure and from Advanced Error Reporting Extended Capability where available.
6434 At every read it polls config space of PCI Express devices and dispatches
6435 notification for every error that is set. It checks for new errors at every read.
6436 The device is indicated in plugin_instance according to format "domain:bus:dev.fn".
6437 Errors are divided into categories indicated by type_instance: "correctable", and
6438 for uncorrectable errors "non_fatal" or "fatal".
6439 Fatal errors are reported as I<NOTIF_FAILURE> and all others as I<NOTIF_WARNING>.
6443 <Plugin "pcie_errors">
6445 AccessDir "/sys/bus/pci"
6447 PersistentNotifications false
6454 =item B<Source> B<sysfs>|B<proc>
6456 Use B<sysfs> or B<proc> to read data from /sysfs or /proc.
6457 The default value is B<sysfs>.
6459 =item B<AccessDir> I<dir>
6461 Directory used to access device config space. It is optional and defaults to
6462 /sys/bus/pci for B<sysfs> and to /proc/bus/pci for B<proc>.
6464 =item B<ReportMasked> B<false>|B<true>
6466 If true plugin will notify about errors that are set to masked in Error Mask register.
6467 Such errors are not reported to the PCI Express Root Complex. Defaults to B<false>.
6469 =item B<PersistentNotifications> B<false>|B<true>
6471 If false plugin will dispatch notification only on set/clear of error.
6472 The ones already reported will be ignored. Defaults to B<false>.
6476 =head2 Plugin C<perl>
6478 This plugin embeds a Perl-interpreter into collectd and provides an interface
6479 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
6481 =head2 Plugin C<pinba>
6483 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
6484 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
6485 PHP-based webpage has been delivered, the extension will send a UDP packet
6486 containing timing information, peak memory usage and so on. The plugin will
6487 wait for such packets, parse them and account the provided information, which
6488 is then dispatched to the daemon once per interval.
6495 # Overall statistics for the website.
6497 Server "www.example.com"
6499 # Statistics for www-a only
6501 Host "www-a.example.com"
6502 Server "www.example.com"
6504 # Statistics for www-b only
6506 Host "www-b.example.com"
6507 Server "www.example.com"
6511 The plugin provides the following configuration options:
6515 =item B<Address> I<Node>
6517 Configures the address used to open a listening socket. By default, plugin will
6518 bind to the I<any> address C<::0>.
6520 =item B<Port> I<Service>
6522 Configures the port (service) to bind to. By default the default Pinba port
6523 "30002" will be used. The option accepts service names in addition to port
6524 numbers and thus requires a I<string> argument.
6526 =item E<lt>B<View> I<Name>E<gt> block
6528 The packets sent by the Pinba extension include the hostname of the server, the
6529 server name (the name of the virtual host) and the script that was executed.
6530 Using B<View> blocks it is possible to separate the data into multiple groups
6531 to get more meaningful statistics. Each packet is added to all matching groups,
6532 so that a packet may be accounted for more than once.
6536 =item B<Host> I<Host>
6538 Matches the hostname of the system the webserver / script is running on. This
6539 will contain the result of the L<gethostname(2)> system call. If not
6540 configured, all hostnames will be accepted.
6542 =item B<Server> I<Server>
6544 Matches the name of the I<virtual host>, i.e. the contents of the
6545 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
6546 server names will be accepted.
6548 =item B<Script> I<Script>
6550 Matches the name of the I<script name>, i.e. the contents of the
6551 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
6552 script names will be accepted.
6558 =head2 Plugin C<ping>
6560 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
6561 configured hosts periodically and measures the network latency. Whenever the
6562 C<read> function of the plugin is called, it submits the average latency, the
6563 standard deviation and the drop rate for each host.
6565 Available configuration options:
6569 =item B<Host> I<IP-address>
6571 Host to ping periodically. This option may be repeated several times to ping
6574 =item B<Interval> I<Seconds>
6576 Sets the interval in which to send ICMP echo packets to the configured hosts.
6577 This is B<not> the interval in which metrics are read from the plugin but the
6578 interval in which the hosts are "pinged". Therefore, the setting here should be
6579 smaller than or equal to the global B<Interval> setting. Fractional times, such
6580 as "1.24" are allowed.
6584 =item B<Timeout> I<Seconds>
6586 Time to wait for a response from the host to which an ICMP packet had been
6587 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
6588 to be down or the packet to be dropped. This setting must be smaller than the
6589 B<Interval> setting above for the plugin to work correctly. Fractional
6590 arguments are accepted.
6594 =item B<TTL> I<0-255>
6596 Sets the Time-To-Live of generated ICMP packets.
6598 =item B<Size> I<size>
6600 Sets the size of the data payload in ICMP packet to specified I<size> (it
6601 will be filled with regular ASCII pattern). If not set, default 56 byte
6602 long string is used so that the packet size of an ICMPv4 packet is exactly
6603 64 bytes, similar to the behaviour of normal ping(1) command.
6605 =item B<SourceAddress> I<host>
6607 Sets the source address to use. I<host> may either be a numerical network
6608 address or a network hostname.
6610 =item B<AddressFamily> I<af>
6612 Sets the address family to use. I<af> may be "any", "ipv4" or "ipv6". This
6613 option will be ignored if you set a B<SourceAddress>.
6615 =item B<Device> I<name>
6617 Sets the outgoing network device to be used. I<name> has to specify an
6618 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
6621 =item B<MaxMissed> I<Packets>
6623 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
6624 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
6626 Default: B<-1> (disabled)
6630 =head2 Plugin C<postgresql>
6632 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
6633 keeps a persistent connection to all configured databases and tries to
6634 reconnect if the connection has been interrupted. A database is configured by
6635 specifying a B<Database> block as described below. The default statistics are
6636 collected from PostgreSQL's B<statistics collector> which thus has to be
6637 enabled for this plugin to work correctly. This should usually be the case by
6638 default. See the section "The Statistics Collector" of the B<PostgreSQL
6639 Documentation> for details.
6641 By specifying custom database queries using a B<Query> block as described
6642 below, you may collect any data that is available from some PostgreSQL
6643 database. This way, you are able to access statistics of external daemons
6644 which are available in a PostgreSQL database or use future or special
6645 statistics provided by PostgreSQL without the need to upgrade your collectd
6648 Starting with version 5.2, the C<postgresql> plugin supports writing data to
6649 PostgreSQL databases as well. This has been implemented in a generic way. You
6650 need to specify an SQL statement which will then be executed by collectd in
6651 order to write the data (see below for details). The benefit of that approach
6652 is that there is no fixed database layout. Rather, the layout may be optimized
6653 for the current setup.
6655 The B<PostgreSQL Documentation> manual can be found at
6656 L<http://www.postgresql.org/docs/manuals/>.
6660 Statement "SELECT magic FROM wizard WHERE host = $1;"
6664 InstancePrefix "magic"
6669 <Query rt36_tickets>
6670 Statement "SELECT COUNT(type) AS count, type \
6672 WHEN resolved = 'epoch' THEN 'open' \
6673 ELSE 'resolved' END AS type \
6674 FROM tickets) type \
6678 InstancePrefix "rt36_tickets"
6679 InstancesFrom "type"
6685 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
6696 KRBSrvName "kerberos_service_name"
6702 Service "service_name"
6703 Query backends # predefined
6714 The B<Query> block defines one database query which may later be used by a
6715 database definition. It accepts a single mandatory argument which specifies
6716 the name of the query. The names of all queries have to be unique (see the
6717 B<MinVersion> and B<MaxVersion> options below for an exception to this
6720 In each B<Query> block, there is one or more B<Result> blocks. Multiple
6721 B<Result> blocks may be used to extract multiple values from a single query.
6723 The following configuration options are available to define the query:
6727 =item B<Statement> I<sql query statement>
6729 Specify the I<sql query statement> which the plugin should execute. The string
6730 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
6731 first, second, etc. parameter. The value of the parameters is specified by the
6732 B<Param> configuration option - see below for details. To include a literal
6733 B<$> character followed by a number, surround it with single quotes (B<'>).
6735 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
6736 allowed. Note, however, that only a single command may be used. Semicolons are
6737 allowed as long as a single non-empty command has been specified only.
6739 The returned lines will be handled separately one after another.
6741 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
6743 Specify the parameters which should be passed to the SQL query. The parameters
6744 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
6745 they appear in the configuration file. The value of the parameter is
6746 determined depending on the value of the B<Param> option as follows:
6752 The configured hostname of the database connection. If a UNIX domain socket is
6753 used, the parameter expands to "localhost".
6757 The name of the database of the current connection.
6761 The name of the database plugin instance. See the B<Instance> option of the
6762 database specification below for details.
6766 The username used to connect to the database.
6770 The interval with which this database is queried (as specified by the database
6771 specific or global B<Interval> options).
6775 Please note that parameters are only supported by PostgreSQL's protocol
6776 version 3 and above which was introduced in version 7.4 of PostgreSQL.
6778 =item B<PluginInstanceFrom> I<column>
6780 Specify how to create the "PluginInstance" for reporting this query results.
6781 Only one column is supported. You may concatenate fields and string values in
6782 the query statement to get the required results.
6784 =item B<MinVersion> I<version>
6786 =item B<MaxVersion> I<version>
6788 Specify the minimum or maximum version of PostgreSQL that this query should be
6789 used with. Some statistics might only be available with certain versions of
6790 PostgreSQL. This allows you to specify multiple queries with the same name but
6791 which apply to different versions, thus allowing you to use the same
6792 configuration in a heterogeneous environment.
6794 The I<version> has to be specified as the concatenation of the major, minor
6795 and patch-level versions, each represented as two-decimal-digit numbers. For
6796 example, version 8.2.3 will become 80203.
6800 The B<Result> block defines how to handle the values returned from the query.
6801 It defines which column holds which value and how to dispatch that value to
6806 =item B<Type> I<type>
6808 The I<type> name to be used when dispatching the values. The type describes
6809 how to handle the data and where to store it. See L<types.db(5)> for more
6810 details on types and their configuration. The number and type of values (as
6811 selected by the B<ValuesFrom> option) has to match the type of the given name.
6813 This option is mandatory.
6815 =item B<InstancePrefix> I<prefix>
6817 =item B<InstancesFrom> I<column0> [I<column1> ...]
6819 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
6820 B<InstancePrefix> defines a static prefix that will be prepended to all type
6821 instances. B<InstancesFrom> defines the column names whose values will be used
6822 to create the type instance. Multiple values will be joined together using the
6823 hyphen (C<->) as separation character.
6825 The plugin itself does not check whether or not all built instances are
6826 different. It is your responsibility to assure that each is unique.
6828 Both options are optional. If none is specified, the type instance will be
6831 =item B<ValuesFrom> I<column0> [I<column1> ...]
6833 Names the columns whose content is used as the actual data for the data sets
6834 that are dispatched to the daemon. How many such columns you need is
6835 determined by the B<Type> setting as explained above. If you specify too many
6836 or not enough columns, the plugin will complain about that and no data will be
6837 submitted to the daemon.
6839 The actual data type, as seen by PostgreSQL, is not that important as long as
6840 it represents numbers. The plugin will automatically cast the values to the
6841 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
6842 L<strtod(3)> functions, so anything supported by those functions is supported
6843 by the plugin as well.
6845 This option is required inside a B<Result> block and may be specified multiple
6846 times. If multiple B<ValuesFrom> options are specified, the columns are read
6851 The following predefined queries are available (the definitions can be found
6852 in the F<postgresql_default.conf> file which, by default, is available at
6853 C<I<prefix>/share/collectd/>):
6859 This query collects the number of backends, i.E<nbsp>e. the number of
6862 =item B<transactions>
6864 This query collects the numbers of committed and rolled-back transactions of
6869 This query collects the numbers of various table modifications (i.E<nbsp>e.
6870 insertions, updates, deletions) of the user tables.
6872 =item B<query_plans>
6874 This query collects the numbers of various table scans and returned tuples of
6877 =item B<table_states>
6879 This query collects the numbers of live and dead rows in the user tables.
6883 This query collects disk block access counts for user tables.
6887 This query collects the on-disk size of the database in bytes.
6891 In addition, the following detailed queries are available by default. Please
6892 note that each of those queries collects information B<by table>, thus,
6893 potentially producing B<a lot> of data. For details see the description of the
6894 non-by_table queries above.
6898 =item B<queries_by_table>
6900 =item B<query_plans_by_table>
6902 =item B<table_states_by_table>
6904 =item B<disk_io_by_table>
6908 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
6909 mandatory argument specifying the name of the writer. This will then be used
6910 in the B<Database> specification in order to activate the writer instance. The
6911 names of all writers have to be unique. The following options may be
6916 =item B<Statement> I<sql statement>
6918 This mandatory option specifies the SQL statement that will be executed for
6919 each submitted value. A single SQL statement is allowed only. Anything after
6920 the first semicolon will be ignored.
6922 Nine parameters will be passed to the statement and should be specified as
6923 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
6924 values are made available through those parameters:
6930 The timestamp of the queried value as an RFC 3339-formatted local time.
6934 The hostname of the queried value.
6938 The plugin name of the queried value.
6942 The plugin instance of the queried value. This value may be B<NULL> if there
6943 is no plugin instance.
6947 The type of the queried value (cf. L<types.db(5)>).
6951 The type instance of the queried value. This value may be B<NULL> if there is
6956 An array of names for the submitted values (i.E<nbsp>e., the name of the data
6957 sources of the submitted value-list).
6961 An array of types for the submitted values (i.E<nbsp>e., the type of the data
6962 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
6963 B<StoreRates> is enabled (which is the default, see below), all types will be
6968 An array of the submitted values. The dimensions of the value name and value
6973 In general, it is advisable to create and call a custom function in the
6974 PostgreSQL database for this purpose. Any procedural language supported by
6975 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
6978 =item B<StoreRates> B<false>|B<true>
6980 If set to B<true> (the default), convert counter values to rates. If set to
6981 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6986 The B<Database> block defines one PostgreSQL database for which to collect
6987 statistics. It accepts a single mandatory argument which specifies the
6988 database name. None of the other options are required. PostgreSQL will use
6989 default values as documented in the section "CONNECTING TO A DATABASE" in the
6990 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
6991 the user collectd is run as and special environment variables. See the manpage
6996 =item B<Interval> I<seconds>
6998 Specify the interval with which the database should be queried. The default is
6999 to use the global B<Interval> setting.
7001 =item B<CommitInterval> I<seconds>
7003 This option may be used for database connections which have "writers" assigned
7004 (see above). If specified, it causes a writer to put several updates into a
7005 single transaction. This transaction will last for the specified amount of
7006 time. By default, each update will be executed in a separate transaction. Each
7007 transaction generates a fair amount of overhead which can, thus, be reduced by
7008 activating this option. The draw-back is, that data covering the specified
7009 amount of time will be lost, for example, if a single statement within the
7010 transaction fails or if the database server crashes.
7012 =item B<Plugin> I<Plugin>
7014 Use I<Plugin> as the plugin name when submitting query results from
7015 this B<Database>. Defaults to C<postgresql>.
7017 =item B<Instance> I<name>
7019 Specify the plugin instance name that should be used instead of the database
7020 name (which is the default, if this option has not been specified). This
7021 allows one to query multiple databases of the same name on the same host (e.g.
7022 when running multiple database server versions in parallel).
7023 The plugin instance name can also be set from the query result using
7024 the B<PluginInstanceFrom> option in B<Query> block.
7026 =item B<Host> I<hostname>
7028 Specify the hostname or IP of the PostgreSQL server to connect to. If the
7029 value begins with a slash, it is interpreted as the directory name in which to
7030 look for the UNIX domain socket.
7032 This option is also used to determine the hostname that is associated with a
7033 collected data set. If it has been omitted or either begins with with a slash
7034 or equals B<localhost> it will be replaced with the global hostname definition
7035 of collectd. Any other value will be passed literally to collectd when
7036 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
7038 =item B<Port> I<port>
7040 Specify the TCP port or the local UNIX domain socket file extension of the
7043 =item B<User> I<username>
7045 Specify the username to be used when connecting to the server.
7047 =item B<Password> I<password>
7049 Specify the password to be used when connecting to the server.
7051 =item B<ExpireDelay> I<delay>
7053 Skip expired values in query output.
7055 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
7057 Specify whether to use an SSL connection when contacting the server. The
7058 following modes are supported:
7064 Do not use SSL at all.
7068 First, try to connect without using SSL. If that fails, try using SSL.
7070 =item I<prefer> (default)
7072 First, try to connect using SSL. If that fails, try without using SSL.
7080 =item B<Instance> I<name>
7082 Specify the plugin instance name that should be used instead of the database
7083 name (which is the default, if this option has not been specified). This
7084 allows one to query multiple databases of the same name on the same host (e.g.
7085 when running multiple database server versions in parallel).
7087 =item B<KRBSrvName> I<kerberos_service_name>
7089 Specify the Kerberos service name to use when authenticating with Kerberos 5
7090 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
7091 B<PostgreSQL Documentation> for details.
7093 =item B<Service> I<service_name>
7095 Specify the PostgreSQL service name to use for additional parameters. That
7096 service has to be defined in F<pg_service.conf> and holds additional
7097 connection parameters. See the section "The Connection Service File" in the
7098 B<PostgreSQL Documentation> for details.
7100 =item B<Query> I<query>
7102 Specifies a I<query> which should be executed in the context of the database
7103 connection. This may be any of the predefined or user-defined queries. If no
7104 such option is given, it defaults to "backends", "transactions", "queries",
7105 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
7106 has been specified). Else, the specified queries are used only.
7108 =item B<Writer> I<writer>
7110 Assigns the specified I<writer> backend to the database connection. This
7111 causes all collected data to be send to the database using the settings
7112 defined in the writer configuration (see the section "FILTER CONFIGURATION"
7113 below for details on how to selectively send data to certain plugins).
7115 Each writer will register a flush callback which may be used when having long
7116 transactions enabled (see the B<CommitInterval> option above). When issuing
7117 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
7118 transaction will be committed right away. Two different kinds of flush
7119 callbacks are available with the C<postgresql> plugin:
7125 Flush all writer backends.
7127 =item B<postgresql->I<database>
7129 Flush all writers of the specified I<database> only.
7135 =head2 Plugin C<powerdns>
7137 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
7138 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
7139 values, many of which are probably meaningless to most users, but may be useful
7140 for some. So you may chose which values to collect, but if you don't, some
7141 reasonable defaults will be collected.
7144 <Server "server_name">
7146 Collect "udp-answers" "udp-queries"
7147 Socket "/var/run/pdns.controlsocket"
7149 <Recursor "recursor_name">
7151 Collect "cache-hits" "cache-misses"
7152 Socket "/var/run/pdns_recursor.controlsocket"
7154 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
7159 =item B<Server> and B<Recursor> block
7161 The B<Server> block defines one authoritative server to query, the B<Recursor>
7162 does the same for an recursing server. The possible options in both blocks are
7163 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
7168 =item B<Collect> I<Field>
7170 Using the B<Collect> statement you can select which values to collect. Here,
7171 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
7172 C<dlg-only-drops>, C<answers10-100>.
7174 The method of getting the values differs for B<Server> and B<Recursor> blocks:
7175 When querying the server a C<SHOW *> command is issued in any case, because
7176 that's the only way of getting multiple values out of the server at once.
7177 collectd then picks out the values you have selected. When querying the
7178 recursor, a command is generated to query exactly these values. So if you
7179 specify invalid fields when querying the recursor, a syntax error may be
7180 returned by the daemon and collectd may not collect any values at all.
7182 If no B<Collect> statement is given, the following B<Server> values will be
7189 =item packetcache-hit
7191 =item packetcache-miss
7193 =item packetcache-size
7195 =item query-cache-hit
7197 =item query-cache-miss
7199 =item recursing-answers
7201 =item recursing-questions
7213 The following B<Recursor> values will be collected by default:
7217 =item noerror-answers
7219 =item nxdomain-answers
7221 =item servfail-answers
7239 Please note that up to that point collectd doesn't know what values are
7240 available on the server and values that are added do not need a change of the
7241 mechanism so far. However, the values must be mapped to collectd's naming
7242 scheme, which is done using a lookup table that lists all known values. If
7243 values are added in the future and collectd does not know about them, you will
7244 get an error much like this:
7246 powerdns plugin: submit: Not found in lookup table: foobar = 42
7248 In this case please file a bug report with the collectd team.
7250 =item B<Socket> I<Path>
7252 Configures the path to the UNIX domain socket to be used when connecting to the
7253 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
7254 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
7255 will be used for the recursor.
7259 =item B<LocalSocket> I<Path>
7261 Querying the recursor is done using UDP. When using UDP over UNIX domain
7262 sockets, the client socket needs a name in the file system, too. You can set
7263 this local name to I<Path> using the B<LocalSocket> option. The default is
7264 C<I<prefix>/var/run/collectd-powerdns>.
7268 =head2 Plugin C<processes>
7270 Collects information about processes of local system.
7272 By default, with no process matches configured, only general statistics is
7273 collected: the number of processes in each state and fork rate.
7275 Process matches can be configured by B<Process> and B<ProcessMatch> options.
7276 These may also be a block in which further options may be specified.
7278 The statistics collected for matched processes are:
7279 - size of the resident segment size (RSS)
7280 - user- and system-time used
7281 - number of processes
7283 - number of open files (under Linux)
7284 - number of memory mapped files (under Linux)
7285 - io data (where available)
7286 - context switches (under Linux)
7287 - minor and major pagefaults
7288 - Delay Accounting information (Linux only, requires libmnl)
7293 CollectFileDescriptor true
7294 CollectContextSwitch true
7295 CollectDelayAccounting false
7297 ProcessMatch "name" "regex"
7298 <Process "collectd">
7299 CollectFileDescriptor false
7300 CollectContextSwitch false
7301 CollectDelayAccounting true
7303 <ProcessMatch "name" "regex">
7304 CollectFileDescriptor false
7305 CollectContextSwitch true
7311 =item B<Process> I<Name>
7313 Select more detailed statistics of processes matching this name.
7315 Some platforms have a limit on the length of process names.
7316 I<Name> must stay below this limit.
7318 =item B<ProcessMatch> I<name> I<regex>
7320 Select more detailed statistics of processes matching the specified I<regex>
7321 (see L<regex(7)> for details). The statistics of all matching processes are
7322 summed up and dispatched to the daemon using the specified I<name> as an
7323 identifier. This allows one to "group" several processes together.
7324 I<name> must not contain slashes.
7326 =item B<CollectContextSwitch> I<Boolean>
7328 Collect the number of context switches for matched processes.
7329 Disabled by default.
7331 =item B<CollectDelayAccounting> I<Boolean>
7333 If enabled, collect Linux Delay Accounding information for matching processes.
7334 Delay Accounting provides the time processes wait for the CPU to become
7335 available, for I/O operations to finish, for pages to be swapped in and for
7336 freed pages to be reclaimed. The metrics are reported as "seconds per second"
7337 using the C<delay_rate> type, e.g. C<delay_rate-delay-cpu>.
7338 Disabled by default.
7340 This option is only available on Linux, requires the C<libmnl> library and
7341 requires the C<CAP_NET_ADMIN> capability at runtime.
7343 =item B<CollectFileDescriptor> I<Boolean>
7345 Collect number of file descriptors of matched processes.
7346 Disabled by default.
7348 =item B<CollectMemoryMaps> I<Boolean>
7350 Collect the number of memory mapped files of the process.
7351 The limit for this number is configured via F</proc/sys/vm/max_map_count> in
7356 The B<CollectContextSwitch>, B<CollectDelayAccounting>,
7357 B<CollectFileDescriptor> and B<CollectMemoryMaps> options may be used inside
7358 B<Process> and B<ProcessMatch> blocks. When used there, these options affect
7359 reporting the corresponding processes only. Outside of B<Process> and
7360 B<ProcessMatch> blocks these options set the default value for subsequent
7363 =head2 Plugin C<procevent>
7365 The I<procevent> plugin monitors when processes start (EXEC) and stop (EXIT).
7372 ProcessRegex "regex"
7379 =item B<BufferLength> I<length>
7381 Maximum number of process events that can be stored in plugin's ring buffer.
7382 By default, this is set to 10. Once an event has been read, its location
7383 becomes available for storing a new event.
7385 =item B<Process> I<name>
7387 Enumerate a process name to monitor. All processes that match this exact
7388 name will be monitored for EXECs and EXITs.
7390 =item B<ProcessRegex> I<regex>
7392 Enumerate a process pattern to monitor. All processes that match this
7393 regular expression will be monitored for EXECs and EXITs.
7397 =head2 Plugin C<protocols>
7399 Collects a lot of information about various network protocols, such as I<IP>,
7400 I<TCP>, I<UDP>, etc.
7402 Available configuration options:
7406 =item B<Value> I<Selector>
7408 Selects whether or not to select a specific value. The string being matched is
7409 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
7410 plugin instance and I<ValueName> will be used as type instance. An example of
7411 the string being used would be C<Tcp:RetransSegs>.
7413 You can use regular expressions to match a large number of values with just one
7414 configuration option. To select all "extended" I<TCP> values, you could use the
7415 following statement:
7419 Whether only matched values are selected or all matched values are ignored
7420 depends on the B<IgnoreSelected>. By default, only matched values are selected.
7421 If no value is configured at all, all values will be selected.
7423 See F</"IGNORELISTS"> for details.
7425 =item B<IgnoreSelected> B<true>|B<false>
7427 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
7428 matching values will be ignored.
7432 =head2 Plugin C<python>
7434 This plugin embeds a Python-interpreter into collectd and provides an interface
7435 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
7437 =head2 Plugin C<routeros>
7439 The C<routeros> plugin connects to a device running I<RouterOS>, the
7440 Linux-based operating system for routers by I<MikroTik>. The plugin uses
7441 I<librouteros> to connect and reads information about the interfaces and
7442 wireless connections of the device. The configuration supports querying
7447 Host "router0.example.com"
7450 CollectInterface true
7455 Host "router1.example.com"
7458 CollectInterface true
7459 CollectRegistrationTable true
7466 As you can see above, the configuration of the I<routeros> plugin consists of
7467 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
7468 options are understood:
7472 =item B<Host> I<Host>
7474 Hostname or IP-address of the router to connect to.
7476 =item B<Port> I<Port>
7478 Port name or port number used when connecting. If left unspecified, the default
7479 will be chosen by I<librouteros>, currently "8728". This option expects a
7480 string argument, even when a numeric port number is given.
7482 =item B<User> I<User>
7484 Use the user name I<User> to authenticate. Defaults to "admin".
7486 =item B<Password> I<Password>
7488 Set the password used to authenticate.
7490 =item B<CollectInterface> B<true>|B<false>
7492 When set to B<true>, interface statistics will be collected for all interfaces
7493 present on the device. Defaults to B<false>.
7495 =item B<CollectRegistrationTable> B<true>|B<false>
7497 When set to B<true>, information about wireless LAN connections will be
7498 collected. Defaults to B<false>.
7500 =item B<CollectCPULoad> B<true>|B<false>
7502 When set to B<true>, information about the CPU usage will be collected. The
7503 number is a dimensionless value where zero indicates no CPU usage at all.
7504 Defaults to B<false>.
7506 =item B<CollectMemory> B<true>|B<false>
7508 When enabled, the amount of used and free memory will be collected. How used
7509 memory is calculated is unknown, for example whether or not caches are counted
7511 Defaults to B<false>.
7513 =item B<CollectDF> B<true>|B<false>
7515 When enabled, the amount of used and free disk space will be collected.
7516 Defaults to B<false>.
7518 =item B<CollectDisk> B<true>|B<false>
7520 When enabled, the number of sectors written and bad blocks will be collected.
7521 Defaults to B<false>.
7523 =item B<CollectHealth> B<true>|B<false>
7525 When enabled, the health statistics will be collected. This includes the
7526 voltage and temperature on supported hardware.
7527 Defaults to B<false>.
7531 =head2 Plugin C<redis>
7533 The I<Redis plugin> connects to one or more Redis servers, gathers
7534 information about each server's state and executes user-defined queries.
7535 For each server there is a I<Node> block which configures the connection
7536 parameters and set of user-defined queries for this node.
7542 #Socket "/var/run/redis/redis.sock"
7544 ReportCommandStats false
7546 <Query "LLEN myqueue">
7556 =item B<Node> I<Nodename>
7558 The B<Node> block identifies a new Redis node, that is a new Redis instance
7559 running in an specified host and port. The name for node is a canonical
7560 identifier which is used as I<plugin instance>. It is limited to
7561 128E<nbsp>characters in length.
7563 When no B<Node> is configured explicitly, plugin connects to "localhost:6379".
7565 =item B<Host> I<Hostname>
7567 The B<Host> option is the hostname or IP-address where the Redis instance is
7570 =item B<Port> I<Port>
7572 The B<Port> option is the TCP port on which the Redis instance accepts
7573 connections. Either a service name of a port number may be given. Please note
7574 that numerical port numbers must be given as a string, too.
7576 =item B<Socket> I<Path>
7578 Connect to Redis using the UNIX domain socket at I<Path>. If this
7579 setting is given, the B<Hostname> and B<Port> settings are ignored.
7581 =item B<Password> I<Password>
7583 Use I<Password> to authenticate when connecting to I<Redis>.
7585 =item B<Timeout> I<Milliseconds>
7587 The B<Timeout> option set the socket timeout for node response. Since the Redis
7588 read function is blocking, you should keep this value as low as possible.
7589 It is expected what B<Timeout> values should be lower than B<Interval> defined
7592 Defaults to 2000 (2 seconds).
7594 =item B<ReportCommandStats> B<false>|B<true>
7596 Enables or disables reporting of statistics based on the command type, including
7597 rate of command calls and average CPU time consumed by command processing.
7598 Defaults to B<false>.
7600 =item B<ReportCpuUsage> B<true>|B<false>
7602 Enables or disables reporting of CPU consumption statistics.
7603 Defaults to B<true>.
7605 =item B<Query> I<Querystring>
7607 The B<Query> block identifies a query to execute against the redis server.
7608 There may be an arbitrary number of queries to execute. Each query should
7609 return single string or integer.
7611 =item B<Type> I<Collectd type>
7613 Within a query definition, a valid I<collectd type> to use as when submitting
7614 the result of the query. When not supplied, will default to B<gauge>.
7616 Currently only types with one datasource are supported.
7617 See L<types.db(5)> for more details on types and their configuration.
7619 =item B<Instance> I<Type instance>
7621 Within a query definition, an optional type instance to use when submitting
7622 the result of the query. When not supplied will default to the escaped
7623 command, up to 128 chars.
7625 =item B<Database> I<Index>
7627 This index selects the Redis logical database to use for query. Defaults
7632 =head2 Plugin C<rrdcached>
7634 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
7635 to store values to RRD files in an efficient manner. The combination of the
7636 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
7637 way the C<rrdtool> plugin works (see below). The added abstraction layer
7638 provides a number of benefits, though: Because the cache is not within
7639 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
7640 restarted. This results in much shorter (if any) gaps in graphs, especially
7641 under heavy load. Also, the C<rrdtool> command line utility is aware of the
7642 daemon so that it can flush values to disk automatically when needed. This
7643 allows one to integrate automated flushing of values into graphing solutions
7646 There are disadvantages, though: The daemon may reside on a different host, so
7647 it may not be possible for C<collectd> to create the appropriate RRD files
7648 anymore. And even if C<rrdcached> runs on the same host, it may run in a
7649 different base directory, so relative paths may do weird stuff if you're not
7652 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
7653 on the same host, communicating via a UNIX domain socket. The B<DataDir>
7654 setting should be set to an absolute path, so that a changed base directory
7655 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
7659 =item B<DaemonAddress> I<Address>
7661 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
7662 library. See L<rrdcached(1)> for details. Example:
7664 <Plugin "rrdcached">
7665 DaemonAddress "unix:/var/run/rrdcached.sock"
7668 =item B<DataDir> I<Directory>
7670 Set the base directory in which the RRD files reside. If this is a relative
7671 path, it is relative to the working base directory of the C<rrdcached> daemon!
7672 Use of an absolute path is recommended.
7674 =item B<CreateFiles> B<true>|B<false>
7676 Enables or disables the creation of RRD files. If the daemon is not running
7677 locally, or B<DataDir> is set to a relative path, this will not work as
7678 expected. Default is B<true>.
7680 =item B<CreateFilesAsync> B<false>|B<true>
7682 When enabled, new RRD files are enabled asynchronously, using a separate thread
7683 that runs in the background. This prevents writes to block, which is a problem
7684 especially when many hundreds of files need to be created at once. However,
7685 since the purpose of creating the files asynchronously is I<not> to block until
7686 the file is available, values before the file is available will be discarded.
7687 When disabled (the default) files are created synchronously, blocking for a
7688 short while, while the file is being written.
7690 =item B<StepSize> I<Seconds>
7692 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7693 this setting is unset and the stepsize is set to the interval in which the data
7694 is collected. Do not use this option unless you absolutely have to for some
7695 reason. Setting this option may cause problems with the C<snmp plugin>, the
7696 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7698 =item B<HeartBeat> I<Seconds>
7700 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7701 in which case the heartbeat is set to twice the B<StepSize> which should equal
7702 the interval in which data is collected. Do not set this option unless you have
7703 a very good reason to do so.
7705 =item B<RRARows> I<NumRows>
7707 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7708 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7709 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7710 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7711 week, one month, and one year.
7713 So for each timespan, it calculates how many PDPs need to be consolidated into
7714 one CDP by calculating:
7715 number of PDPs = timespan / (stepsize * rrarows)
7717 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7720 =item B<RRATimespan> I<Seconds>
7722 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7723 more then one RRA. If this option is never used, the built-in default of (3600,
7724 86400, 604800, 2678400, 31622400) is used.
7726 For more information on how RRA-sizes are calculated see B<RRARows> above.
7728 =item B<XFF> I<Factor>
7730 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7731 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7734 =item B<CollectStatistics> B<false>|B<true>
7736 When set to B<true>, various statistics about the I<rrdcached> daemon will be
7737 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
7739 Statistics are read via I<rrdcached>s socket using the STATS command.
7740 See L<rrdcached(1)> for details.
7744 =head2 Plugin C<rrdtool>
7746 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
7747 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
7748 using these settings. If you don't want to dive into the depths of RRDtool, you
7749 can safely ignore these settings.
7753 =item B<DataDir> I<Directory>
7755 Set the directory to store RRD files under. By default RRD files are generated
7756 beneath the daemon's working directory, i.e. the B<BaseDir>.
7758 =item B<CreateFilesAsync> B<false>|B<true>
7760 When enabled, new RRD files are enabled asynchronously, using a separate thread
7761 that runs in the background. This prevents writes to block, which is a problem
7762 especially when many hundreds of files need to be created at once. However,
7763 since the purpose of creating the files asynchronously is I<not> to block until
7764 the file is available, values before the file is available will be discarded.
7765 When disabled (the default) files are created synchronously, blocking for a
7766 short while, while the file is being written.
7768 =item B<StepSize> I<Seconds>
7770 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7771 this setting is unset and the stepsize is set to the interval in which the data
7772 is collected. Do not use this option unless you absolutely have to for some
7773 reason. Setting this option may cause problems with the C<snmp plugin>, the
7774 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7776 =item B<HeartBeat> I<Seconds>
7778 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7779 in which case the heartbeat is set to twice the B<StepSize> which should equal
7780 the interval in which data is collected. Do not set this option unless you have
7781 a very good reason to do so.
7783 =item B<RRARows> I<NumRows>
7785 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7786 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7787 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7788 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7789 week, one month, and one year.
7791 So for each timespan, it calculates how many PDPs need to be consolidated into
7792 one CDP by calculating:
7793 number of PDPs = timespan / (stepsize * rrarows)
7795 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7798 =item B<RRATimespan> I<Seconds>
7800 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7801 more then one RRA. If this option is never used, the built-in default of (3600,
7802 86400, 604800, 2678400, 31622400) is used.
7804 For more information on how RRA-sizes are calculated see B<RRARows> above.
7806 =item B<XFF> I<Factor>
7808 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7809 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7812 =item B<CacheFlush> I<Seconds>
7814 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
7815 it writes all values for a certain RRD-file if the oldest value is older than
7816 (or equal to) the number of seconds specified by B<CacheTimeout>.
7817 That check happens on new values arriwal. If some RRD-file is not updated
7818 anymore for some reason (the computer was shut down, the network is broken,
7819 etc.) some values may still be in the cache. If B<CacheFlush> is set, then
7820 every I<Seconds> seconds the entire cache is searched for entries older than
7821 B<CacheTimeout> + B<RandomTimeout> seconds. The entries found are written to
7822 disk. Since scanning the entire cache is kind of expensive and does nothing
7823 under normal circumstances, this value should not be too small. 900 seconds
7824 might be a good value, though setting this to 7200 seconds doesn't normally
7825 do much harm either.
7827 Defaults to 10x B<CacheTimeout>.
7828 B<CacheFlush> must be larger than or equal to B<CacheTimeout>, otherwise the
7829 above default is used.
7831 =item B<CacheTimeout> I<Seconds>
7833 If this option is set to a value greater than zero, the C<rrdtool plugin> will
7834 save values in a cache, as described above. Writing multiple values at once
7835 reduces IO-operations and thus lessens the load produced by updating the files.
7836 The trade off is that the graphs kind of "drag behind" and that more memory is
7839 =item B<WritesPerSecond> I<Updates>
7841 When collecting many statistics with collectd and the C<rrdtool> plugin, you
7842 will run serious performance problems. The B<CacheFlush> setting and the
7843 internal update queue assert that collectd continues to work just fine even
7844 under heavy load, but the system may become very unresponsive and slow. This is
7845 a problem especially if you create graphs from the RRD files on the same
7846 machine, for example using the C<graph.cgi> script included in the
7847 C<contrib/collection3/> directory.
7849 This setting is designed for very large setups. Setting this option to a value
7850 between 25 and 80 updates per second, depending on your hardware, will leave
7851 the server responsive enough to draw graphs even while all the cached values
7852 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
7853 by the B<FLUSH> command, are B<not> effected by this limit. They are still
7854 written as fast as possible, so that web frontends have up to date data when
7857 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
7858 updates per second, writing all values to disk will take approximately
7859 56E<nbsp>minutes. Together with the flushing ability that's integrated into
7860 "collection3" you'll end up with a responsive and fast system, up to date
7861 graphs and basically a "backup" of your values every hour.
7863 =item B<RandomTimeout> I<Seconds>
7865 When set, the actual timeout for each value is chosen randomly between
7866 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
7867 intention is to avoid high load situations that appear when many values timeout
7868 at the same time. This is especially a problem shortly after the daemon starts,
7869 because all values were added to the internal cache at roughly the same time.
7873 =head2 Plugin C<sensors>
7875 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
7876 that all the needed modules have to be loaded and lm_sensors has to be
7877 configured (most likely by editing F</etc/sensors.conf>. Read
7878 L<sensors.conf(5)> for details.
7880 The B<lm_sensors> homepage can be found at
7881 L<http://secure.netroedge.com/~lm78/>.
7885 =item B<SensorConfigFile> I<File>
7887 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
7888 the library's default will be used.
7890 =item B<Sensor> I<chip-bus-address/type-feature>
7892 Selects the name of the sensor which you want to collect or ignore, depending
7893 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
7894 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
7895 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
7897 See F</"IGNORELISTS"> for details.
7899 =item B<IgnoreSelected> I<true>|I<false>
7901 If no configuration if given, the B<sensors>-plugin will collect data from all
7902 sensors. This may not be practical, especially for uninteresting sensors.
7903 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
7904 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
7905 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
7906 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
7907 and all other sensors are collected.
7909 =item B<UseLabels> I<true>|I<false>
7911 Configures how sensor readings are reported. When set to I<true>, sensor
7912 readings are reported using their descriptive label (e.g. "VCore"). When set to
7913 I<false> (the default) the sensor name is used ("in0").
7917 =head2 Plugin C<sigrok>
7919 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
7920 supported by the L<sigrok|http://sigrok.org/> project.
7926 <Device "AC Voltage">
7931 <Device "Sound Level">
7932 Driver "cem-dt-885x"
7939 =item B<LogLevel> B<0-5>
7941 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
7942 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
7943 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
7944 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
7945 their level, are always submitted to I<collectd> at its INFO log level.
7947 =item E<lt>B<Device> I<Name>E<gt>
7949 A sigrok-supported device, uniquely identified by this section's options. The
7950 I<Name> is passed to I<collectd> as the I<plugin instance>.
7952 =item B<Driver> I<DriverName>
7954 The sigrok driver to use for this device.
7956 =item B<Conn> I<ConnectionSpec>
7958 If the device cannot be auto-discovered, or more than one might be discovered
7959 by the driver, I<ConnectionSpec> specifies the connection string to the device.
7960 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
7961 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
7962 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
7963 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
7965 =item B<SerialComm> I<SerialSpec>
7967 For serial devices with non-standard port settings, this option can be used
7968 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
7969 This should not be necessary; drivers know how to communicate with devices they
7972 =item B<MinimumInterval> I<Seconds>
7974 Specifies the minimum time between measurement dispatches to I<collectd>, in
7975 seconds. Since some I<sigrok> supported devices can acquire measurements many
7976 times per second, it may be necessary to throttle these. For example, the
7977 I<RRD plugin> cannot process writes more than once per second.
7979 The default B<MinimumInterval> is B<0>, meaning measurements received from the
7980 device are always dispatched to I<collectd>. When throttled, unused
7981 measurements are discarded.
7985 =head2 Plugin C<smart>
7987 The C<smart> plugin collects SMART information from physical
7988 disks. Values collectd include temperature, power cycle count, poweron
7989 time and bad sectors. Also, all SMART attributes are collected along
7990 with the normalized current value, the worst value, the threshold and
7991 a human readable value.
7993 Using the following two options you can ignore some disks or configure the
7994 collection only of specific disks.
7998 =item B<Disk> I<Name>
8000 Select the disk I<Name>. Whether it is collected or ignored depends on the
8001 B<IgnoreSelected> setting, see below. As with other plugins that use the
8002 daemon's ignorelist functionality, a string that starts and ends with a slash
8003 is interpreted as a regular expression. Examples:
8008 See F</"IGNORELISTS"> for details.
8010 =item B<IgnoreSelected> B<true>|B<false>
8012 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
8013 statements, are ignored or if all other disks are ignored. The behavior
8014 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
8015 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
8016 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
8017 is set to B<true>, all disks are collected B<except> the ones matched.
8019 =item B<IgnoreSleepMode> B<true>|B<false>
8021 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
8022 This option disables the sleep mode check and allows the plugin to collect data
8023 from these disks anyway. This is useful in cases where libatasmart mistakenly
8024 reports disks as asleep because it has not been updated to incorporate support
8025 for newer idle states in the ATA spec.
8027 =item B<UseSerial> B<true>|B<false>
8029 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
8030 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
8031 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
8032 storing data. This ensures that the data for a given disk will be kept together
8033 even if the kernel name changes.
8037 =head2 Plugin C<snmp>
8039 Since the configuration of the C<snmp plugin> is a little more complicated than
8040 other plugins, its documentation has been moved to an own manpage,
8041 L<collectd-snmp(5)>. Please see there for details.
8043 =head2 Plugin C<snmp_agent>
8045 The I<snmp_agent> plugin is an AgentX subagent that receives and handles queries
8046 from SNMP master agent and returns the data collected by read plugins.
8047 The I<snmp_agent> plugin handles requests only for OIDs specified in
8048 configuration file. To handle SNMP queries the plugin gets data from collectd
8049 and translates requested values from collectd's internal format to SNMP format.
8050 This plugin is a generic plugin and cannot work without configuration.
8051 For more details on AgentX subagent see
8052 <http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/>
8057 <Data "memAvailReal">
8059 #PluginInstance "some"
8062 OIDs "1.3.6.1.4.1.2021.4.6.0"
8065 IndexOID "IF-MIB::ifIndex"
8066 SizeOID "IF-MIB::ifNumber"
8069 Source "PluginInstance"
8072 OIDs "IF-MIB::ifDescr"
8078 OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
8081 <Table "CPUAffinityTable">
8084 Source "PluginInstance"
8087 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhAffinityDomainName"
8092 Source "TypeInstance"
8093 Regex "^vcpu_([0-9]{1,3})-cpu_[0-9]{1,3}$"
8096 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhVCPUIndex"
8101 Source "TypeInstance"
8102 Regex "^vcpu_[0-9]{1,3}-cpu_([0-9]{1,3})$"
8105 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhCPUIndex"
8107 <Data "CPUAffinity">
8110 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhCPUAffinity"
8115 There are two types of blocks that can be contained in the
8116 C<E<lt>PluginE<nbsp> snmp_agentE<gt>> block: B<Data> and B<Table>:
8118 =head3 B<Data> block
8120 The B<Data> block defines a list OIDs that are to be handled. This block can
8121 define scalar or table OIDs. If B<Data> block is defined inside of B<Table>
8122 block it reperesents table OIDs.
8123 The following options can be set:
8127 =item B<IndexKey> block
8129 B<IndexKey> block contains all data needed for proper index build of snmp table.
8131 one table B<Data> block has B<IndexKey> block present then multiple key index is
8132 built. If B<Data> block defines scalar data type B<IndexKey> has no effect and can
8137 =item B<Source> I<String>
8139 B<Source> can be set to one of the following values: "Hostname", "Plugin",
8140 "PluginInstance", "Type", "TypeInstance". This value indicates which field of
8141 corresponding collectd metric is taken as a SNMP table index.
8143 =item B<Regex> I<String>
8145 B<Regex> option can also be used to parse strings or numbers out of
8146 specific field. For example: type-instance field which is "vcpu1-cpu2" can be
8147 parsed into two numeric fields CPU = 2 and VCPU = 1 and can be later used
8150 =item B<Group> I<Number>
8152 B<Group> number can be specified in case groups are used in regex.
8156 =item B<Plugin> I<String>
8158 Read plugin name whose collected data will be mapped to specified OIDs.
8160 =item B<PluginInstance> I<String>
8162 Read plugin instance whose collected data will be mapped to specified OIDs.
8163 The field is optional and by default there is no plugin instance check.
8164 Allowed only if B<Data> block defines scalar data type.
8166 =item B<Type> I<String>
8168 Collectd's type that is to be used for specified OID, e.E<nbsp>g. "if_octets"
8169 for example. The types are read from the B<TypesDB> (see L<collectd.conf(5)>).
8171 =item B<TypeInstance> I<String>
8173 Collectd's type-instance that is to be used for specified OID.
8175 =item B<OIDs> I<OID> [I<OID> ...]
8177 Configures the OIDs to be handled by I<snmp_agent> plugin. Values for these OIDs
8178 are taken from collectd data type specified by B<Plugin>, B<PluginInstance>,
8179 B<Type>, B<TypeInstance> fields of this B<Data> block. Number of the OIDs
8180 configured should correspond to number of values in specified B<Type>.
8181 For example two OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" can be mapped to
8182 "rx" and "tx" values of "if_octets" type.
8184 =item B<Scale> I<Value>
8186 The values taken from collectd are multiplied by I<Value>. The field is optional
8187 and the default is B<1.0>.
8189 =item B<Shift> I<Value>
8191 I<Value> is added to values from collectd after they have been multiplied by
8192 B<Scale> value. The field is optional and the default value is B<0.0>.
8196 =head3 The B<Table> block
8198 The B<Table> block defines a collection of B<Data> blocks that belong to one
8199 snmp table. In addition to multiple B<Data> blocks the following options can be
8204 =item B<IndexOID> I<OID>
8206 OID that is handled by the plugin and is mapped to numerical index value that is
8207 generated by the plugin for each table record.
8209 =item B<SizeOID> I<OID>
8211 OID that is handled by the plugin. Returned value is the number of records in
8212 the table. The field is optional.
8216 =head2 Plugin C<statsd>
8218 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
8219 protocol and dispatches rates or other aggregates of these numbers
8222 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
8223 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
8224 C<objects> respectively.
8226 The following configuration options are valid:
8230 =item B<Host> I<Host>
8232 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
8233 "any" address, i.e. accept packets sent to any of the hosts addresses.
8235 =item B<Port> I<Port>
8237 UDP port to listen to. This can be either a service name or a port number.
8238 Defaults to C<8125>.
8240 =item B<DeleteCounters> B<false>|B<true>
8242 =item B<DeleteTimers> B<false>|B<true>
8244 =item B<DeleteGauges> B<false>|B<true>
8246 =item B<DeleteSets> B<false>|B<true>
8248 These options control what happens if metrics are not updated in an interval.
8249 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
8250 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
8251 are unchanged. If set to B<True>, the such metrics are not dispatched and
8252 removed from the internal cache.
8254 =item B<CounterSum> B<false>|B<true>
8256 When enabled, creates a C<count> metric which reports the change since the last
8257 read. This option primarily exists for compatibility with the I<statsd>
8258 implementation by Etsy.
8260 =item B<TimerPercentile> I<Percent>
8262 Calculate and dispatch the configured percentile, i.e. compute the latency, so
8263 that I<Percent> of all reported timers are smaller than or equal to the
8264 computed latency. This is useful for cutting off the long tail latency, as it's
8265 often done in I<Service Level Agreements> (SLAs).
8267 Different percentiles can be calculated by setting this option several times.
8268 If none are specified, no percentiles are calculated / dispatched.
8270 =item B<TimerLower> B<false>|B<true>
8272 =item B<TimerUpper> B<false>|B<true>
8274 =item B<TimerSum> B<false>|B<true>
8276 =item B<TimerCount> B<false>|B<true>
8278 Calculate and dispatch various values out of I<Timer> metrics received during
8279 an interval. If set to B<False>, the default, these values aren't calculated /
8282 Please note what reported timer values less than 0.001 are ignored in all B<Timer*> reports.
8286 =head2 Plugin C<swap>
8288 The I<Swap plugin> collects information about used and available swap space. On
8289 I<Linux> and I<Solaris>, the following options are available:
8293 =item B<ReportByDevice> B<false>|B<true>
8295 Configures how to report physical swap devices. If set to B<false> (the
8296 default), the summary over all swap devices is reported only, i.e. the globally
8297 used and available space over all devices. If B<true> is configured, the used
8298 and available space of each device will be reported separately.
8300 This option is only available if the I<Swap plugin> can read C</proc/swaps>
8301 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
8303 =item B<ReportBytes> B<false>|B<true>
8305 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
8306 I<swap I/O> is reported in pages. This option is available under Linux only.
8308 =item B<ValuesAbsolute> B<true>|B<false>
8310 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
8311 available and used. Defaults to B<true>.
8313 =item B<ValuesPercentage> B<false>|B<true>
8315 Enables or disables reporting of relative swap metrics, i.e. I<percent>
8316 available and free. Defaults to B<false>.
8318 This is useful for deploying I<collectd> in a heterogeneous environment, where
8319 swap sizes differ and you want to specify generic thresholds or similar.
8321 =item B<ReportIO> B<true>|B<false>
8323 Enables or disables reporting swap IO. Defaults to B<true>.
8325 This is useful for the cases when swap IO is not neccessary, is not available,
8330 =head2 Plugin C<sysevent>
8332 The I<sysevent> plugin monitors rsyslog messages.
8337 Listen "192.168.0.2" "6666"
8343 rsyslog should be configured such that it sends data to the IP and port you
8344 include in the plugin configuration. For example, given the configuration
8345 above, something like this would be set in /etc/rsyslog.conf:
8347 if $programname != 'collectd' then
8348 *.* @192.168.0.2:6666
8350 This plugin is designed to consume JSON rsyslog data, so a more complete
8351 rsyslog configuration would look like so (where we define a JSON template
8352 and use it when sending data to our IP and port):
8354 $template ls_json,"{%timestamp:::date-rfc3339,jsonf:@timestamp%, \
8355 %source:::jsonf:@source_host%,\"@source\":\"syslog://%fromhost-ip:::json%\", \
8356 \"@message\":\"%timestamp% %app-name%:%msg:::json%\",\"@fields\": \
8357 {%syslogfacility-text:::jsonf:facility%,%syslogseverity:::jsonf:severity-num%, \
8358 %syslogseverity-text:::jsonf:severity%,%programname:::jsonf:program%, \
8359 %procid:::jsonf:processid%}}"
8361 if $programname != 'collectd' then
8362 *.* @192.168.0.2:6666;ls_json
8364 Please note that these rsyslog.conf examples are *not* complete, as rsyslog
8365 requires more than these options in the configuration file. These examples
8366 are meant to demonstration the proper remote logging and JSON format syntax.
8372 =item B<Listen> I<host> I<port>
8374 Listen on this IP on this port for incoming rsyslog messages.
8376 =item B<BufferSize> I<length>
8378 Maximum allowed size for incoming rsyslog messages. Messages that exceed
8379 this number will be truncated to this size. Default is 4096 bytes.
8381 =item B<BufferLength> I<length>
8383 Maximum number of rsyslog events that can be stored in plugin's ring buffer.
8384 By default, this is set to 10. Once an event has been read, its location
8385 becomes available for storing a new event.
8387 =item B<RegexFilter> I<regex>
8389 Enumerate a regex filter to apply to all incoming rsyslog messages. If a
8390 message matches this filter, it will be published.
8394 =head2 Plugin C<syslog>
8398 =item B<LogLevel> B<debug|info|notice|warning|err>
8400 Sets the log-level. If, for example, set to B<notice>, then all events with
8401 severity B<notice>, B<warning>, or B<err> will be submitted to the
8404 Please note that B<debug> is only available if collectd has been compiled with
8407 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
8409 Controls which notifications should be sent to syslog. The default behaviour is
8410 not to send any. Less severe notifications always imply logging more severe
8411 notifications: Setting this to B<OKAY> means all notifications will be sent to
8412 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
8413 notifications but will dismiss B<OKAY> notifications. Setting this option to
8414 B<FAILURE> will only send failures to syslog.
8418 =head2 Plugin C<table>
8420 The C<table plugin> provides generic means to parse tabular data and dispatch
8421 user specified values. Values are selected based on column numbers. For
8422 example, this plugin may be used to get values from the Linux L<proc(5)>
8423 filesystem or CSV (comma separated values) files.
8426 <Table "/proc/slabinfo">
8432 InstancePrefix "active_objs"
8438 InstancePrefix "objperslab"
8445 The configuration consists of one or more B<Table> blocks, each of which
8446 configures one file to parse. Within each B<Table> block, there are one or
8447 more B<Result> blocks, which configure which data to select and how to
8450 The following options are available inside a B<Table> block:
8454 =item B<Plugin> I<Plugin>
8456 If specified, I<Plugin> is used as the plugin name when submitting values.
8457 Defaults to B<table>.
8459 =item B<Instance> I<instance>
8461 If specified, I<instance> is used as the plugin instance. If omitted, the
8462 filename of the table is used instead, with all special characters replaced
8463 with an underscore (C<_>).
8465 =item B<Separator> I<string>
8467 Any character of I<string> is interpreted as a delimiter between the different
8468 columns of the table. A sequence of two or more contiguous delimiters in the
8469 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
8470 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
8471 of a table - see its documentation for more details. This option is mandatory.
8473 A horizontal tab, newline and carriage return may be specified by C<\\t>,
8474 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
8475 required because of collectd's config parsing.
8479 The following options are available inside a B<Result> block:
8483 =item B<Type> I<type>
8485 Sets the type used to dispatch the values to the daemon. Detailed information
8486 about types and their configuration can be found in L<types.db(5)>. This
8487 option is mandatory.
8489 =item B<InstancePrefix> I<prefix>
8491 If specified, prepend I<prefix> to the type instance. If omitted, only the
8492 B<InstancesFrom> option is considered for the type instance.
8494 =item B<InstancesFrom> I<column0> [I<column1> ...]
8496 If specified, the content of the given columns (identified by the column
8497 number starting at zero) will be used to create the type instance for each
8498 row. Multiple values (and the instance prefix) will be joined together with
8499 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
8500 option is considered for the type instance.
8502 The plugin itself does not check whether or not all built instances are
8503 different. It’s your responsibility to assure that each is unique. This is
8504 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
8505 sure that the table only contains one row.
8507 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
8510 =item B<ValuesFrom> I<column0> [I<column1> ...]
8512 Specifies the columns (identified by the column numbers starting at zero)
8513 whose content is used as the actual data for the data sets that are dispatched
8514 to the daemon. How many such columns you need is determined by the B<Type>
8515 setting above. If you specify too many or not enough columns, the plugin will
8516 complain about that and no data will be submitted to the daemon. The plugin
8517 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
8518 respectively, so anything supported by those functions is supported by the
8519 plugin as well. This option is mandatory.
8523 =head2 Plugin C<tail>
8525 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
8526 each line and dispatches found values. What is matched can be configured by the
8527 user using (extended) regular expressions, as described in L<regex(7)>.
8530 <File "/var/log/exim4/mainlog">
8535 Regex "S=([1-9][0-9]*)"
8541 Regex "\\<R=local_user\\>"
8542 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
8545 Instance "local_user"
8548 Regex "l=([0-9]*\\.[0-9]*)"
8549 <DSType "Distribution">
8552 #BucketType "bucket"
8560 The config consists of one or more B<File> blocks, each of which configures one
8561 logfile to parse. Within each B<File> block, there are one or more B<Match>
8562 blocks, which configure a regular expression to search for.
8564 The B<Plugin> and B<Instance> options in the B<File> block may be used to set
8565 the plugin name and instance respectively. So in the above example the plugin name
8566 C<mail-exim> would be used.
8568 These options are applied for all B<Match> blocks that B<follow> it, until the
8569 next B<Plugin> or B<Instance> option. This way you can extract several plugin
8570 instances from one logfile, handy when parsing syslog and the like.
8572 The B<Interval> option allows you to define the length of time between reads. If
8573 this is not set, the default Interval will be used.
8575 Each B<Match> block has the following options to describe how the match should
8580 =item B<Regex> I<regex>
8582 Sets the regular expression to use for matching against a line. The first
8583 subexpression has to match something that can be turned into a number by
8584 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
8585 below. Because B<extended> regular expressions are used, you do not need to use
8586 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
8587 collectd's config parsing you need to escape backslashes, though. So if you
8588 want to match literal parentheses you need to do the following:
8590 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
8592 =item B<ExcludeRegex> I<regex>
8594 Sets an optional regular expression to use for excluding lines from the match.
8595 An example which excludes all connections from localhost from the match:
8597 ExcludeRegex "127\\.0\\.0\\.1"
8599 =item B<DSType> I<Type>
8601 Sets how the values are cumulated. I<Type> is one of:
8605 =item B<GaugeAverage>
8607 Calculate the average of all values matched during the interval.
8611 Report the smallest value matched during the interval.
8615 Report the greatest value matched during the interval.
8619 Report the last value matched during the interval.
8621 =item B<GaugePersist>
8623 Report the last matching value. The metric is I<not> reset to C<NaN> at the end
8624 of an interval. It is continuously reported until another value is matched.
8625 This is intended for cases in which only state changes are reported, for
8626 example a thermometer that only reports the temperature when it changes.
8632 =item B<AbsoluteSet>
8634 The matched number is a counter. Simply I<sets> the internal counter to this
8635 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
8643 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
8644 matched number may be negative, which will effectively subtract from the
8653 Increase the internal counter by one. These B<DSType> are the only ones that do
8654 not use the matched subexpression, but simply count the number of matched
8655 lines. Thus, you may use a regular expression without submatch in this case.
8657 B<GaugeInc> is reset to I<zero> after every read, unlike other B<Gauge*>
8658 metrics which are reset to C<NaN>.
8660 =item B<Distribution>
8662 Type to do calculations based on the distribution of values, primarily
8663 calculating percentiles. This is primarily geared towards latency, but can be
8664 used for other metrics as well. The range of values tracked with this setting
8665 must be in the range (0–2^34) and can be fractional. Please note that neither
8666 zero nor 2^34 are inclusive bounds, i.e. zero I<cannot> be handled by a
8669 This option must be used together with the B<Percentile> and/or B<Bucket>
8674 <DSType "Distribution">
8682 =item B<Percentile> I<Percent>
8684 Calculate and dispatch the configured percentile, i.e. compute the value, so
8685 that I<Percent> of all matched values are smaller than or equal to the computed
8688 Metrics are reported with the I<type> B<Type> (the value of the above option)
8689 and the I<type instance> C<[E<lt>InstanceE<gt>-]E<lt>PercentE<gt>>.
8691 This option may be repeated to calculate more than one percentile.
8693 =item B<Bucket> I<lower_bound> I<upper_bound>
8695 Export the number of values (a C<DERIVE>) falling within the given range. Both,
8696 I<lower_bound> and I<upper_bound> may be a fractional number, such as B<0.5>.
8697 Each B<Bucket> option specifies an interval C<(I<lower_bound>,
8698 I<upper_bound>]>, i.e. the range I<excludes> the lower bound and I<includes>
8699 the upper bound. I<lower_bound> and I<upper_bound> may be zero, meaning no
8702 To export the entire (0–inf) range without overlap, use the upper bound of the
8703 previous range as the lower bound of the following range. In other words, use
8704 the following schema:
8714 Metrics are reported with the I<type> set by B<BucketType> option (C<bucket>
8715 by default) and the I<type instance>
8716 C<E<lt>TypeE<gt>[-E<lt>InstanceE<gt>]-E<lt>lower_boundE<gt>_E<lt>upper_boundE<gt>>.
8718 This option may be repeated to calculate more than one rate.
8720 =item B<BucketType> I<Type>
8722 Sets the type used to dispatch B<Bucket> metrics.
8723 Optional, by default C<bucket> will be used.
8729 The B<Gauge*> and B<Distribution> types interpret the submatch as a floating
8730 point number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types
8731 interpret the submatch as an unsigned integer using L<strtoull(3)>. The
8732 B<Derive*> types interpret the submatch as a signed integer using
8733 L<strtoll(3)>. B<CounterInc>, B<DeriveInc> and B<GaugeInc> do not use the
8734 submatch at all and it may be omitted in this case.
8736 The B<Gauge*> types, unless noted otherwise, are reset to C<NaN> after being
8737 reported. In other words, B<GaugeAverage> reports the average of all values
8738 matched since the last metric was reported (or C<NaN> if there was no match).
8740 =item B<Type> I<Type>
8742 Sets the type used to dispatch this value. Detailed information about types and
8743 their configuration can be found in L<types.db(5)>.
8745 =item B<Instance> I<TypeInstance>
8747 This optional setting sets the type instance to use.
8751 =head2 Plugin C<tail_csv>
8753 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
8754 written by I<Snort>.
8759 <Metric "snort-dropped">
8764 <File "/var/log/snort/snort.stats">
8768 Collect "snort-dropped"
8773 The configuration consists of one or more B<Metric> blocks that define an index
8774 into the line of the CSV file and how this value is mapped to I<collectd's>
8775 internal representation. These are followed by one or more B<Instance> blocks
8776 which configure which file to read, in which interval and which metrics to
8781 =item E<lt>B<Metric> I<Name>E<gt>
8783 The B<Metric> block configures a new metric to be extracted from the statistics
8784 file and how it is mapped on I<collectd's> data model. The string I<Name> is
8785 only used inside the B<Instance> blocks to refer to this block, so you can use
8786 one B<Metric> block for multiple CSV files.
8790 =item B<Type> I<Type>
8792 Configures which I<Type> to use when dispatching this metric. Types are defined
8793 in the L<types.db(5)> file, see the appropriate manual page for more
8794 information on specifying types. Only types with a single I<data source> are
8795 supported by the I<tail_csv plugin>. The information whether the value is an
8796 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
8797 I<Type's> definition.
8799 =item B<Instance> I<TypeInstance>
8801 If set, I<TypeInstance> is used to populate the type instance field of the
8802 created value lists. Otherwise, no type instance is used.
8804 =item B<ValueFrom> I<Index>
8806 Configure to read the value from the field with the zero-based index I<Index>.
8807 If the value is parsed as signed integer, unsigned integer or double depends on
8808 the B<Type> setting, see above.
8812 =item E<lt>B<File> I<Path>E<gt>
8814 Each B<File> block represents one CSV file to read. There must be at least one
8815 I<File> block but there can be multiple if you have multiple CSV files.
8819 =item B<Plugin> I<Plugin>
8821 Use I<Plugin> as the plugin name when submitting values.
8822 Defaults to C<tail_csv>.
8824 =item B<Instance> I<PluginInstance>
8826 Sets the I<plugin instance> used when dispatching the values.
8828 =item B<Collect> I<Metric>
8830 Specifies which I<Metric> to collect. This option must be specified at least
8831 once, and you can use this option multiple times to specify more than one
8832 metric to be extracted from this statistic file.
8834 =item B<Interval> I<Seconds>
8836 Configures the interval in which to read values from this instance / file.
8837 Defaults to the plugin's default interval.
8839 =item B<TimeFrom> I<Index>
8841 Rather than using the local time when dispatching a value, read the timestamp
8842 from the field with the zero-based index I<Index>. The value is interpreted as
8843 seconds since epoch. The value is parsed as a double and may be factional.
8849 =head2 Plugin C<teamspeak2>
8851 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
8852 polls interesting global and virtual server data. The plugin can query only one
8853 physical server but unlimited virtual servers. You can use the following
8854 options to configure it:
8858 =item B<Host> I<hostname/ip>
8860 The hostname or ip which identifies the physical server.
8863 =item B<Port> I<port>
8865 The query port of the physical server. This needs to be a string.
8868 =item B<Server> I<port>
8870 This option has to be added once for every virtual server the plugin should
8871 query. If you want to query the virtual server on port 8767 this is what the
8872 option would look like:
8876 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
8877 use quotes around it! If no such statement is given only global information
8882 =head2 Plugin C<ted>
8884 The I<TED> plugin connects to a device of "The Energy Detective", a device to
8885 measure power consumption. These devices are usually connected to a serial
8886 (RS232) or USB port. The plugin opens a configured device and tries to read the
8887 current energy readings. For more information on TED, visit
8888 L<http://www.theenergydetective.com/>.
8890 Available configuration options:
8894 =item B<Device> I<Path>
8896 Path to the device on which TED is connected. collectd will need read and write
8897 permissions on that file.
8899 Default: B</dev/ttyUSB0>
8901 =item B<Retries> I<Num>
8903 Apparently reading from TED is not that reliable. You can therefore configure a
8904 number of retries here. You only configure the I<retries> here, to if you
8905 specify zero, one reading will be performed (but no retries if that fails); if
8906 you specify three, a maximum of four readings are performed. Negative values
8913 =head2 Plugin C<tcpconns>
8915 The C<tcpconns plugin> counts the number of currently established TCP
8916 connections based on the local port and/or the remote port. Since there may be
8917 a lot of connections the default if to count all connections with a local port,
8918 for which a listening socket is opened. You can use the following options to
8919 fine-tune the ports you are interested in:
8923 =item B<ListeningPorts> I<true>|I<false>
8925 If this option is set to I<true>, statistics for all local ports for which a
8926 listening socket exists are collected. The default depends on B<LocalPort> and
8927 B<RemotePort> (see below): If no port at all is specifically selected, the
8928 default is to collect listening ports. If specific ports (no matter if local or
8929 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
8930 the selected ports will be collected unless this option is set to I<true>
8933 =item B<LocalPort> I<Port>
8935 Count the connections to a specific local port. This can be used to see how
8936 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
8937 You have to specify the port in numeric form, so for the mailserver example
8938 you'd need to set B<25>.
8940 =item B<RemotePort> I<Port>
8942 Count the connections to a specific remote port. This is useful to see how
8943 much a remote service is used. This is most useful if you want to know how many
8944 connections a local service has opened to remote services, e.E<nbsp>g. how many
8945 connections a mail server or news server has to other mail or news servers, or
8946 how many connections a web proxy holds to web servers. You have to give the
8947 port in numeric form.
8949 =item B<AllPortsSummary> I<true>|I<false>
8951 If this option is set to I<true> a summary of statistics from all connections
8952 are collected. This option defaults to I<false>.
8956 =head2 Plugin C<thermal>
8960 =item B<ForceUseProcfs> I<true>|I<false>
8962 By default, the I<Thermal plugin> tries to read the statistics from the Linux
8963 C<sysfs> interface. If that is not available, the plugin falls back to the
8964 C<procfs> interface. By setting this option to I<true>, you can force the
8965 plugin to use the latter. This option defaults to I<false>.
8967 =item B<Device> I<Device>
8969 Selects the name of the thermal device that you want to collect or ignore,
8970 depending on the value of the B<IgnoreSelected> option. This option may be
8971 used multiple times to specify a list of devices.
8973 See F</"IGNORELISTS"> for details.
8975 =item B<IgnoreSelected> I<true>|I<false>
8977 Invert the selection: If set to true, all devices B<except> the ones that
8978 match the device names specified by the B<Device> option are collected. By
8979 default only selected devices are collected if a selection is made. If no
8980 selection is configured at all, B<all> devices are selected.
8984 =head2 Plugin C<threshold>
8986 The I<Threshold plugin> checks values collected or received by I<collectd>
8987 against a configurable I<threshold> and issues I<notifications> if values are
8990 Documentation for this plugin is available in the L<collectd-threshold(5)>
8993 =head2 Plugin C<tokyotyrant>
8995 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
8996 couple metrics: number of records, and database size on disk.
9000 =item B<Host> I<Hostname/IP>
9002 The hostname or IP which identifies the server.
9003 Default: B<127.0.0.1>
9005 =item B<Port> I<Service/Port>
9007 The query port of the server. This needs to be a string, even if the port is
9008 given in its numeric form.
9013 =head2 Plugin C<turbostat>
9015 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
9016 Intel processors by using I<Model Specific Registers>.
9020 =item B<CoreCstates> I<Bitmask(Integer)>
9022 Bit mask of the list of core C-states supported by the processor.
9023 This option should only be used if the automated detection fails.
9024 Default value extracted from the CPU model and family.
9026 Currently supported C-states (by this plugin): 3, 6, 7
9030 All states (3, 6 and 7):
9031 (1<<3) + (1<<6) + (1<<7) = 392
9033 =item B<PackageCstates> I<Bitmask(Integer)>
9035 Bit mask of the list of packages C-states supported by the processor. This
9036 option should only be used if the automated detection fails. Default value
9037 extracted from the CPU model and family.
9039 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
9043 States 2, 3, 6 and 7:
9044 (1<<2) + (1<<3) + (1<<6) + (1<<7) = 396
9046 =item B<SystemManagementInterrupt> I<true>|I<false>
9048 Boolean enabling the collection of the I/O System-Management Interrupt counter.
9049 This option should only be used if the automated detection fails or if you want
9050 to disable this feature.
9052 =item B<DigitalTemperatureSensor> I<true>|I<false>
9054 Boolean enabling the collection of the temperature of each core. This option
9055 should only be used if the automated detection fails or if you want to disable
9058 =item B<TCCActivationTemp> I<Temperature>
9060 I<Thermal Control Circuit Activation Temperature> of the installed CPU. This
9061 temperature is used when collecting the temperature of cores or packages. This
9062 option should only be used if the automated detection fails. Default value
9063 extracted from B<MSR_IA32_TEMPERATURE_TARGET>.
9065 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
9067 Bit mask of the list of elements to be thermally monitored. This option should
9068 only be used if the automated detection fails or if you want to disable some
9069 collections. The different bits of this bit mask accepted by this plugin are:
9073 =item 0 ('1'): Package
9077 =item 2 ('4'): Cores
9079 =item 3 ('8'): Embedded graphic device
9083 =item B<LogicalCoreNames> I<true>|I<false>
9085 Boolean enabling the use of logical core numbering for per core statistics.
9086 When enabled, C<cpuE<lt>nE<gt>> is used as plugin instance, where I<n> is a
9087 dynamic number assigned by the kernel. Otherwise, C<coreE<lt>nE<gt>> is used
9088 if there is only one package and C<pkgE<lt>nE<gt>-coreE<lt>mE<gt>> if there is
9089 more than one, where I<n> is the n-th core of package I<m>.
9091 =item B<RestoreAffinityPolicy> I<AllCPUs>|I<Restore>
9093 Reading data from CPU has side-effect: collectd process's CPU affinity mask
9094 changes. After reading data is completed, affinity mask needs to be restored.
9095 This option allows to set restore policy.
9097 B<AllCPUs> (the default): Restore the affinity by setting affinity to any/all
9100 B<Restore>: Save affinity using sched_getaffinity() before reading data and
9103 On some systems, sched_getaffinity() will fail due to inconsistency of the CPU
9104 set size between userspace and kernel. In these cases plugin will detect the
9105 unsuccessful call and fail with an error, preventing data collection.
9106 Most of configurations does not need to save affinity as Collectd process is
9107 allowed to run on any/all available CPUs.
9109 If you need to save and restore affinity and get errors like 'Unable to save
9110 the CPU affinity', setting 'possible_cpus' kernel boot option may also help.
9112 See following links for details:
9114 L<https://github.com/collectd/collectd/issues/1593>
9115 L<https://sourceware.org/bugzilla/show_bug.cgi?id=15630>
9116 L<https://bugzilla.kernel.org/show_bug.cgi?id=151821>
9120 =head2 Plugin C<unixsock>
9124 =item B<SocketFile> I<Path>
9126 Sets the socket-file which is to be created.
9128 =item B<SocketGroup> I<Group>
9130 If running as root change the group of the UNIX-socket after it has been
9131 created. Defaults to B<collectd>.
9133 =item B<SocketPerms> I<Permissions>
9135 Change the file permissions of the UNIX-socket after it has been created. The
9136 permissions must be given as a numeric, octal value as you would pass to
9137 L<chmod(1)>. Defaults to B<0770>.
9139 =item B<DeleteSocket> B<false>|B<true>
9141 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
9142 with the given name already exists. If I<collectd> crashes a socket file may be
9143 left over, preventing the daemon from opening a new socket when restarted.
9144 Since this is potentially dangerous, this defaults to B<false>.
9148 =head2 Plugin C<uuid>
9150 This plugin, if loaded, causes the Hostname to be taken from the machine's
9151 UUID. The UUID is a universally unique designation for the machine, usually
9152 taken from the machine's BIOS. This is most useful if the machine is running in
9153 a virtual environment such as Xen, in which case the UUID is preserved across
9154 shutdowns and migration.
9156 The following methods are used to find the machine's UUID, in order:
9162 Check I</etc/uuid> (or I<UUIDFile>).
9166 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
9171 Check for UUID from C<dmidecode> / SMBIOS.
9175 Check for UUID from Xen hypervisor.
9179 If no UUID can be found then the hostname is not modified.
9183 =item B<UUIDFile> I<Path>
9185 Take the UUID from the given file (default I</etc/uuid>).
9189 =head2 Plugin C<varnish>
9191 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
9192 It collects a subset of the values displayed by L<varnishstat(1)>, and
9193 organizes them in categories which can be enabled or disabled. Currently only
9194 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
9195 meaning of each metric can be found in L<varnish-counters(7)>.
9200 <Instance "example">
9204 CollectConnections true
9205 CollectDirectorDNS false
9209 CollectObjects false
9211 CollectSession false
9221 CollectWorkers false
9223 CollectMempool false
9224 CollectManagement false
9231 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
9232 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
9233 will collectd statistics from the default "varnishd" instance (this should work
9234 fine in most cases).
9236 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
9240 =item B<CollectBackend> B<true>|B<false>
9242 Back-end connection statistics, such as successful, reused,
9243 and closed connections. True by default.
9245 =item B<CollectBan> B<true>|B<false>
9247 Statistics about ban operations, such as number of bans added, retired, and
9248 number of objects tested against ban operations. Only available with Varnish
9249 3.x and above. False by default.
9251 =item B<CollectCache> B<true>|B<false>
9253 Cache hits and misses. True by default.
9255 =item B<CollectConnections> B<true>|B<false>
9257 Number of client connections received, accepted and dropped. True by default.
9259 =item B<CollectDirectorDNS> B<true>|B<false>
9261 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
9264 =item B<CollectESI> B<true>|B<false>
9266 Edge Side Includes (ESI) parse statistics. False by default.
9268 =item B<CollectFetch> B<true>|B<false>
9270 Statistics about fetches (HTTP requests sent to the backend). False by default.
9272 =item B<CollectHCB> B<true>|B<false>
9274 Inserts and look-ups in the crit bit tree based hash. Look-ups are
9275 divided into locked and unlocked look-ups. False by default.
9277 =item B<CollectObjects> B<true>|B<false>
9279 Statistics on cached objects: number of objects expired, nuked (prematurely
9280 expired), saved, moved, etc. False by default.
9282 =item B<CollectPurge> B<true>|B<false>
9284 Statistics about purge operations, such as number of purges added, retired, and
9285 number of objects tested against purge operations. Only available with Varnish
9286 2.x. False by default.
9288 =item B<CollectSession> B<true>|B<false>
9290 Client session statistics. Number of past and current sessions, session herd and
9291 linger counters, etc. False by default. Note that if using Varnish 4.x, some
9292 metrics found in the Connections and Threads sections with previous versions of
9293 Varnish have been moved here.
9295 =item B<CollectSHM> B<true>|B<false>
9297 Statistics about the shared memory log, a memory region to store
9298 log messages which is flushed to disk when full. True by default.
9300 =item B<CollectSMA> B<true>|B<false>
9302 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
9303 component is Solaris specific. Note: SMA, SMF and MSE share counters, enable
9304 only the one used by the Varnish instance. Only available with Varnish 2.x.
9307 =item B<CollectSMS> B<true>|B<false>
9309 synth (synthetic content) storage statistics. This storage
9310 component is used internally only. False by default.
9312 =item B<CollectSM> B<true>|B<false>
9314 file (memory mapped file) storage statistics. Only available with Varnish 2.x.,
9315 in varnish 4.x. use CollectSMF.
9318 =item B<CollectStruct> B<true>|B<false>
9320 Current varnish internal state statistics. Number of current sessions, objects
9321 in cache store, open connections to backends (with Varnish 2.x), etc. False by
9324 =item B<CollectTotals> B<true>|B<false>
9326 Collects overview counters, such as the number of sessions created,
9327 the number of requests and bytes transferred. False by default.
9329 =item B<CollectUptime> B<true>|B<false>
9331 Varnish uptime. Only available with Varnish 3.x and above. False by default.
9333 =item B<CollectVCL> B<true>|B<false>
9335 Number of total (available + discarded) VCL (config files). False by default.
9337 =item B<CollectVSM> B<true>|B<false>
9339 Collect statistics about Varnish's shared memory usage (used by the logging and
9340 statistics subsystems). Only available with Varnish 4.x. False by default.
9342 =item B<CollectWorkers> B<true>|B<false>
9344 Collect statistics about worker threads. False by default.
9346 =item B<CollectVBE> B<true>|B<false>
9348 Backend counters. Only available with Varnish 4.x. False by default.
9350 =item B<CollectSMF> B<true>|B<false>
9352 file (memory mapped file) storage statistics. Only available with Varnish 4.x.
9353 Note: SMA, SMF and MSE share counters, enable only the one used by the Varnish
9354 instance. Used to be called SM in Varnish 2.x. False by default.
9356 =item B<CollectManagement> B<true>|B<false>
9358 Management process counters. Only available with Varnish 4.x. False by default.
9360 =item B<CollectLock> B<true>|B<false>
9362 Lock counters. Only available with Varnish 4.x. False by default.
9364 =item B<CollectMempool> B<true>|B<false>
9366 Memory pool counters. Only available with Varnish 4.x. False by default.
9368 =item B<CollectMSE> B<true>|B<false>
9370 Varnish Massive Storage Engine 2.0 (MSE2) is an improved storage backend for
9371 Varnish, replacing the traditional malloc and file storages. Only available
9372 with Varnish-Plus 4.x. Note: SMA, SMF and MSE share counters, enable only the
9373 one used by the Varnish instance. False by default.
9377 =head2 Plugin C<virt>
9379 This plugin allows CPU, disk, network load and other metrics to be collected for
9380 virtualized guests on the machine. The statistics are collected through libvirt
9381 API (L<http://libvirt.org/>). Majority of metrics can be gathered without
9382 installing any additional software on guests, especially I<collectd>, which runs
9383 only on the host system.
9385 Only I<Connection> is required.
9387 Consider the following example config:
9390 Connection "qemu:///system"
9391 HostnameFormat "hostname"
9392 InterfaceFormat "address"
9393 PluginInstanceFormat "name"
9396 It will generate the following values:
9398 node42.example.com/virt-instance-0006f26c/disk_octets-vda
9399 node42.example.com/virt-instance-0006f26c/disk_ops-vda
9400 node42.example.com/virt-instance-0006f26c/if_dropped-ca:fe:ca:fe:ca:fe
9401 node42.example.com/virt-instance-0006f26c/if_errors-ca:fe:ca:fe:ca:fe
9402 node42.example.com/virt-instance-0006f26c/if_octets-ca:fe:ca:fe:ca:fe
9403 node42.example.com/virt-instance-0006f26c/if_packets-ca:fe:ca:fe:ca:fe
9404 node42.example.com/virt-instance-0006f26c/memory-actual_balloon
9405 node42.example.com/virt-instance-0006f26c/memory-available
9406 node42.example.com/virt-instance-0006f26c/memory-last_update
9407 node42.example.com/virt-instance-0006f26c/memory-major_fault
9408 node42.example.com/virt-instance-0006f26c/memory-minor_fault
9409 node42.example.com/virt-instance-0006f26c/memory-rss
9410 node42.example.com/virt-instance-0006f26c/memory-swap_in
9411 node42.example.com/virt-instance-0006f26c/memory-swap_out
9412 node42.example.com/virt-instance-0006f26c/memory-total
9413 node42.example.com/virt-instance-0006f26c/memory-unused
9414 node42.example.com/virt-instance-0006f26c/memory-usable
9415 node42.example.com/virt-instance-0006f26c/virt_cpu_total
9416 node42.example.com/virt-instance-0006f26c/virt_vcpu-0
9418 You can get information on the metric's units from the online libvirt documentation.
9419 For instance, I<virt_cpu_total> is in nanoseconds.
9423 =item B<Connection> I<uri>
9425 Connect to the hypervisor given by I<uri>. For example if using Xen use:
9427 Connection "xen:///"
9429 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
9431 =item B<RefreshInterval> I<seconds>
9433 Refresh the list of domains and devices every I<seconds>. The default is 60
9434 seconds. Setting this to be the same or smaller than the I<Interval> will cause
9435 the list of domains and devices to be refreshed on every iteration.
9437 Refreshing the devices in particular is quite a costly operation, so if your
9438 virtualization setup is static you might consider increasing this. If this
9439 option is set to 0, refreshing is disabled completely.
9441 =item B<Domain> I<name>
9443 =item B<BlockDevice> I<name:dev>
9445 =item B<InterfaceDevice> I<name:dev>
9447 =item B<IgnoreSelected> B<true>|B<false>
9449 Select which domains and devices are collected.
9451 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
9452 disk/network devices are collected.
9454 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
9455 domains and disk/network devices are ignored, while the rest are collected.
9457 The domain name and device names may use a regular expression, if the name is
9458 surrounded by I</.../> and collectd was compiled with support for regexps.
9460 The default is to collect statistics for all domains and all their devices.
9462 B<Note:> B<BlockDevice> and B<InterfaceDevice> options are related to
9463 corresponding B<*Format> options. Specifically, B<BlockDevice> filtering depends
9464 on B<BlockDeviceFormat> setting - if user wants to filter block devices by
9465 'target' name then B<BlockDeviceFormat> option has to be set to 'target' and
9466 B<BlockDevice> option must be set to a valid block device target
9467 name("/:hdb/"). Mixing formats and filter values from different worlds (i.e.,
9468 using 'target' name as B<BlockDevice> value with B<BlockDeviceFormat> set to
9469 'source') may lead to unexpected results (all devices filtered out or all
9470 visible, depending on the value of B<IgnoreSelected> option).
9471 Similarly, option B<InterfaceDevice> is related to B<InterfaceFormat> setting
9472 (i.e., when user wants to use MAC address as a filter then B<InterfaceFormat>
9473 has to be set to 'address' - using wrong type here may filter out all of the
9478 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
9481 BlockDevice "/:hdb/"
9482 IgnoreSelected "true"
9483 BlockDeviceFormat "target"
9487 Collect metrics only for block device on 'baremetal0' domain when its
9488 'source' matches given path:
9490 BlockDevice "baremetal0:/var/lib/libvirt/images/baremetal0.qcow2"
9491 BlockDeviceFormat source
9493 As you can see it is possible to filter devices/interfaces using
9494 various formats - for block devices 'target' or 'source' name can be
9495 used. Interfaces can be filtered using 'name', 'address' or 'number'.
9499 Collect metrics only for domains 'baremetal0' and 'baremetal1' and
9500 ignore any other domain:
9505 It is possible to filter multiple block devices/domains/interfaces by
9506 adding multiple filtering entries in separate lines.
9508 =item B<BlockDeviceFormat> B<target>|B<source>
9510 If I<BlockDeviceFormat> is set to B<target>, the default, then the device name
9511 seen by the guest will be used for reporting metrics.
9512 This corresponds to the C<E<lt>targetE<gt>> node in the XML definition of the
9515 If I<BlockDeviceFormat> is set to B<source>, then metrics will be reported
9516 using the path of the source, e.g. an image file.
9517 This corresponds to the C<E<lt>sourceE<gt>> node in the XML definition of the
9522 If the domain XML have the following device defined:
9524 <disk type='block' device='disk'>
9525 <driver name='qemu' type='raw' cache='none' io='native' discard='unmap'/>
9526 <source dev='/var/lib/libvirt/images/image1.qcow2'/>
9527 <target dev='sda' bus='scsi'/>
9529 <address type='drive' controller='0' bus='0' target='0' unit='0'/>
9532 Setting C<BlockDeviceFormat target> will cause the I<type instance> to be set
9534 Setting C<BlockDeviceFormat source> will cause the I<type instance> to be set
9535 to C<var_lib_libvirt_images_image1.qcow2>.
9537 B<Note:> this option determines also what field will be used for
9538 filtering over block devices (filter value in B<BlockDevice>
9539 will be applied to target or source). More info about filtering
9540 block devices can be found in the description of B<BlockDevice>.
9542 =item B<BlockDeviceFormatBasename> B<false>|B<true>
9544 The B<BlockDeviceFormatBasename> controls whether the full path or the
9545 L<basename(1)> of the source is being used as the I<type instance> when
9546 B<BlockDeviceFormat> is set to B<source>. Defaults to B<false>.
9550 Assume the device path (source tag) is C</var/lib/libvirt/images/image1.qcow2>.
9551 Setting C<BlockDeviceFormatBasename false> will cause the I<type instance> to
9552 be set to C<var_lib_libvirt_images_image1.qcow2>.
9553 Setting C<BlockDeviceFormatBasename true> will cause the I<type instance> to be
9554 set to C<image1.qcow2>.
9556 =item B<HostnameFormat> B<name|uuid|hostname|metadata...>
9558 When the virt plugin logs data, it sets the hostname of the collected data
9559 according to this setting. The default is to use the guest name as provided by
9560 the hypervisor, which is equal to setting B<name>.
9562 B<uuid> means use the guest's UUID. This is useful if you want to track the
9563 same guest across migrations.
9565 B<hostname> means to use the global B<Hostname> setting, which is probably not
9566 useful on its own because all guests will appear to have the same name. This is
9567 useful in conjunction with B<PluginInstanceFormat> though.
9569 B<metadata> means use information from guest's metadata. Use
9570 B<HostnameMetadataNS> and B<HostnameMetadataXPath> to localize this information.
9572 You can also specify combinations of these fields. For example B<name uuid>
9573 means to concatenate the guest name and UUID (with a literal colon character
9574 between, thus I<"foo:1234-1234-1234-1234">).
9576 At the moment of writing (collectd-5.5), hostname string is limited to 62
9577 characters. In case when combination of fields exceeds 62 characters,
9578 hostname will be truncated without a warning.
9580 =item B<InterfaceFormat> B<name>|B<address>|B<number>
9582 When the virt plugin logs interface data, it sets the name of the collected
9583 data according to this setting. The default is to use the path as provided by
9584 the hypervisor (the "dev" property of the target node), which is equal to
9587 B<address> means use the interface's mac address. This is useful since the
9588 interface path might change between reboots of a guest or across migrations.
9590 B<number> means use the interface's number in guest.
9592 B<Note:> this option determines also what field will be used for
9593 filtering over interface device (filter value in B<InterfaceDevice>
9594 will be applied to name, address or number). More info about filtering
9595 interfaces can be found in the description of B<InterfaceDevice>.
9597 =item B<PluginInstanceFormat> B<name|uuid|metadata|none>
9599 When the virt plugin logs data, it sets the plugin_instance of the collected
9600 data according to this setting. The default is to not set the plugin_instance.
9602 B<name> means use the guest's name as provided by the hypervisor.
9603 B<uuid> means use the guest's UUID.
9604 B<metadata> means use information from guest's metadata.
9606 You can also specify combinations of the B<name> and B<uuid> fields.
9607 For example B<name uuid> means to concatenate the guest name and UUID
9608 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
9610 =item B<HostnameMetadataNS> B<string>
9612 When B<metadata> is used in B<HostnameFormat> or B<PluginInstanceFormat>, this
9613 selects in which metadata namespace we will pick the hostname. The default is
9614 I<http://openstack.org/xmlns/libvirt/nova/1.0>.
9616 =item B<HostnameMetadataXPath> B<string>
9618 When B<metadata> is used in B<HostnameFormat> or B<PluginInstanceFormat>, this
9619 describes where the hostname is located in the libvirt metadata. The default is
9620 I</instance/name/text()>.
9622 =item B<ReportBlockDevices> B<true>|B<false>
9624 Enabled by default. Allows to disable stats reporting of block devices for
9627 =item B<ReportNetworkInterfaces> B<true>|B<false>
9629 Enabled by default. Allows to disable stats reporting of network interfaces for
9632 =item B<ExtraStats> B<string>
9634 Report additional extra statistics. The default is no extra statistics, preserving
9635 the previous behaviour of the plugin. If unsure, leave the default. If enabled,
9636 allows the plugin to reported more detailed statistics about the behaviour of
9637 Virtual Machines. The argument is a space-separated list of selectors.
9639 Currently supported selectors are:
9643 =item B<cpu_util>: report CPU utilization per domain in percentage.
9645 =item B<disk>: report extra statistics like number of flush operations and total
9646 service time for read, write and flush operations. Requires libvirt API version
9649 =item B<disk_err>: report disk errors if any occured. Requires libvirt API version
9652 =item B<domain_state>: report domain state and reason as 'domain_state' metric.
9654 =item B<fs_info>: report file system information as a notification. Requires
9655 libvirt API version I<1.2.11> or later. Can be collected only if I<Guest Agent>
9656 is installed and configured inside VM. Make sure that installed I<Guest Agent>
9657 version supports retrieving file system information.
9659 =item B<job_stats_background>: report statistics about progress of a background
9660 job on a domain. Only one type of job statistics can be collected at the same time.
9661 Requires libvirt API version I<1.2.9> or later.
9663 =item B<job_stats_completed>: report statistics about a recently completed job on
9664 a domain. Only one type of job statistics can be collected at the same time.
9665 Requires libvirt API version I<1.2.9> or later.
9667 =item B<memory>: report statistics about memory usage details, provided
9668 by libvirt virDomainMemoryStats() function.
9670 =item B<pcpu>: report the physical user/system cpu time consumed by the hypervisor, per-vm.
9671 Requires libvirt API version I<0.9.11> or later.
9673 =item B<perf>: report performance monitoring events. To collect performance
9674 metrics they must be enabled for domain and supported by the platform. Requires
9675 libvirt API version I<1.3.3> or later.
9676 B<Note>: I<perf> metrics can't be collected if I<intel_rdt> plugin is enabled.
9678 =item B<vcpu>: report domain virtual CPUs utilisation.
9680 =item B<vcpupin>: report pinning of domain VCPUs to host physical CPUs.
9682 =item B<disk_physical>: report 'disk_physical' statistic for disk device.
9683 B<Note>: This statistic is only reported for disk devices with 'source'
9686 =item B<disk_allocation>: report 'disk_allocation' statistic for disk device.
9687 B<Note>: This statistic is only reported for disk devices with 'source'
9690 =item B<disk_capacity>: report 'disk_capacity' statistic for disk device.
9691 B<Note>: This statistic is only reported for disk devices with 'source'
9696 =item B<PersistentNotification> B<true>|B<false>
9698 Override default configuration to only send notifications when there is a change
9699 in the lifecycle state of a domain. When set to true notifications will be sent
9700 for every read cycle. Default is false. Does not affect the stats being
9703 =item B<Instances> B<integer>
9705 How many read instances you want to use for this plugin. The default is one,
9706 and the sensible setting is a multiple of the B<ReadThreads> value.
9708 This option is only useful when domains are specially tagged.
9709 If you are not sure, just use the default setting.
9711 The reader instance will only query the domains with attached matching tag.
9712 Tags should have the form of 'virt-X' where X is the reader instance number,
9715 The special-purpose reader instance #0, guaranteed to be always present,
9716 will query all the domains with missing or unrecognized tag, so no domain will
9719 Domain tagging is done with a custom attribute in the libvirt domain metadata
9720 section. Value is selected by an XPath I</domain/metadata/ovirtmap/tag/text()>
9721 expression in the I<http://ovirt.org/ovirtmap/tag/1.0> namespace.
9722 (XPath and namespace values are not configurable yet).
9724 Tagging could be used by management applications to evenly spread the
9725 load among the reader threads, or to pin on the same threads all
9726 the libvirt domains which use the same shared storage, to minimize
9727 the disruption in presence of storage outages.
9731 =head2 Plugin C<vmem>
9733 The C<vmem> plugin collects information about the usage of virtual memory.
9734 Since the statistics provided by the Linux kernel are very detailed, they are
9735 collected very detailed. However, to get all the details, you have to switch
9736 them on manually. Most people just want an overview over, such as the number of
9737 pages read from swap space.
9741 =item B<Verbose> B<true>|B<false>
9743 Enables verbose collection of information. This will start collecting page
9744 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
9745 Part of these statistics are collected on a "per zone" basis.
9749 =head2 Plugin C<vserver>
9751 This plugin doesn't have any options. B<VServer> support is only available for
9752 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
9753 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
9754 need to apply the patches and compile your own kernel, which will then provide
9755 the F</proc/virtual> filesystem that is required by this plugin.
9757 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
9759 B<Note>: The traffic collected by this plugin accounts for the amount of
9760 traffic passing a socket which might be a lot less than the actual on-wire
9761 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
9762 collect on-wire traffic you could, for example, use the logging facilities of
9763 iptables to feed data for the guest IPs into the iptables plugin.
9765 =head2 Plugin C<write_graphite>
9767 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
9768 storage and graphing project. The plugin connects to I<Carbon>, the data layer
9769 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
9770 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
9771 of at most 1428 bytes to minimize the number of network packets.
9775 <Plugin write_graphite>
9787 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9788 blocks. Inside the B<Node> blocks, the following options are recognized:
9792 =item B<Host> I<Address>
9794 Hostname or address to connect to. Defaults to C<localhost>.
9796 =item B<Port> I<Service>
9798 Service name or port number to connect to. Defaults to C<2003>.
9800 =item B<Protocol> I<String>
9802 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
9804 =item B<ReconnectInterval> I<Seconds>
9806 When set to non-zero, forces the connection to the Graphite backend to be
9807 closed and re-opend periodically. This behavior is desirable in environments
9808 where the connection to the Graphite backend is done through load balancers,
9809 for example. When set to zero, the default, the connetion is kept open for as
9812 =item B<LogSendErrors> B<false>|B<true>
9814 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
9815 If set to B<false>, it will not log the errors. This is especially useful when
9816 using Protocol UDP since many times we want to use the "fire-and-forget"
9817 approach and logging errors fills syslog with unneeded messages.
9819 =item B<Prefix> I<String>
9821 When B<UseTags> is I<false>, B<Prefix> value is added in front of the host name.
9822 When B<UseTags> is I<true>, B<Prefix> value is added in front of series name.
9824 Dots and whitespace are I<not> escaped in this string (see B<EscapeCharacter>
9827 =item B<Postfix> I<String>
9829 When B<UseTags> is I<false>, B<Postfix> value appended to the host name.
9830 When B<UseTags> is I<true>, B<Postgix> value appended to the end of series name
9831 (before the first ; that separates the name from the tags).
9833 Dots and whitespace are I<not> escaped in this string (see B<EscapeCharacter>
9836 =item B<EscapeCharacter> I<Char>
9838 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
9839 in the identifier. The B<EscapeCharacter> option determines which character
9840 dots, whitespace and control characters are replaced with. Defaults to
9843 =item B<StoreRates> B<false>|B<true>
9845 If set to B<true> (the default), convert counter values to rates. If set to
9846 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
9849 =item B<SeparateInstances> B<false>|B<true>
9851 If set to B<true>, the plugin instance and type instance will be in their own
9852 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9853 default), the plugin and plugin instance (and likewise the type and type
9854 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9856 Option value is not used when B<UseTags> is I<true>.
9858 =item B<AlwaysAppendDS> B<false>|B<true>
9860 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9861 identifier. If set to B<false> (the default), this is only done when there is
9864 =item B<PreserveSeparator> B<false>|B<true>
9866 If set to B<false> (the default) the C<.> (dot) character is replaced with
9867 I<EscapeCharacter>. Otherwise, if set to B<true>, the C<.> (dot) character
9868 is preserved, i.e. passed through.
9870 Option value is not used when B<UseTags> is I<true>.
9872 =item B<DropDuplicateFields> B<false>|B<true>
9874 If set to B<true>, detect and remove duplicate components in Graphite metric
9875 names. For example, the metric name C<host.load.load.shortterm> will
9876 be shortened to C<host.load.shortterm>.
9878 =item B<UseTags> B<false>|B<true>
9880 If set to B<true>, Graphite metric names will be generated as tagged series.
9881 This allows for much more flexibility than the traditional hierarchical layout.
9884 C<test.single;host=example.com;plugin=test;plugin_instance=foo;type=single;type_instance=bar>
9886 You can use B<Postfix> option to add more tags by specifying it like
9887 C<;tag1=value1;tag2=value2>. Note what tagging support was added since Graphite
9890 If set to B<true>, the B<SeparateInstances> and B<PreserveSeparator> settings
9893 Default value: B<false>.
9895 =item B<ReverseHost> B<false>|B<true>
9897 If set to B<true>, the (dot separated) parts of the B<host> field of the
9898 I<value list> will be rewritten in reverse order. The rewrite happens I<before>
9899 special characters are replaced with the B<EscapeCharacter>.
9901 This option might be convenient if the metrics are presented with Graphite in a
9902 DNS like tree structure (probably without replacing dots in hostnames).
9905 Hostname "node3.cluster1.example.com"
9907 LoadPlugin "write_graphite"
9908 <Plugin "write_graphite">
9909 <Node "graphite.example.com">
9915 result on the wire: com.example.cluster1.node3.cpu-0.cpu-idle 99.900993 1543010932
9917 Default value: B<false>.
9921 =head2 Plugin C<write_log>
9923 The C<write_log> plugin writes metrics as INFO log messages.
9925 This plugin supports two output formats: I<Graphite> and I<JSON>.
9935 =item B<Format> I<Format>
9937 The output format to use. Can be one of C<Graphite> or C<JSON>.
9941 =head2 Plugin C<write_tsdb>
9943 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
9944 time series database. The plugin connects to a I<TSD>, a masterless, no shared
9945 state daemon that ingests metrics and stores them in HBase. The plugin uses
9946 I<TCP> over the "line based" protocol with a default port 4242. The data will
9947 be sent in blocks of at most 1428 bytes to minimize the number of network
9956 Host "tsd-1.my.domain"
9958 HostTags "status=production"
9962 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9963 blocks and global directives.
9965 Global directives are:
9969 =item B<ResolveInterval> I<seconds>
9971 =item B<ResolveJitter> I<seconds>
9973 When I<collectd> connects to a TSDB node, it will request the hostname from
9974 DNS. This can become a problem if the TSDB node is unavailable or badly
9975 configured because collectd will request DNS in order to reconnect for every
9976 metric, which can flood your DNS. So you can cache the last value for
9977 I<ResolveInterval> seconds.
9978 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9980 You can also define a jitter, a random interval to wait in addition to
9981 I<ResolveInterval>. This prevents all your collectd servers to resolve the
9982 hostname at the same time when the connection fails.
9983 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9985 B<Note:> If the DNS resolution has already been successful when the socket
9986 closes, the plugin will try to reconnect immediately with the cached
9987 information. DNS is queried only when the socket is closed for a longer than
9988 I<ResolveInterval> + I<ResolveJitter> seconds.
9992 Inside the B<Node> blocks, the following options are recognized:
9996 =item B<Host> I<Address>
9998 Hostname or address to connect to. Defaults to C<localhost>.
10000 =item B<Port> I<Service>
10002 Service name or port number to connect to. Defaults to C<4242>.
10005 =item B<HostTags> I<String>
10007 When set, I<HostTags> is added to the end of the metric. It is intended to be
10008 used for name=value pairs that the TSD will tag the metric with. Dots and
10009 whitespace are I<not> escaped in this string.
10011 =item B<StoreRates> B<false>|B<true>
10013 If set to B<true>, convert counter values to rates. If set to B<false>
10014 (the default) counter values are stored as is, as an increasing
10017 =item B<AlwaysAppendDS> B<false>|B<true>
10019 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
10020 identifier. If set to B<false> (the default), this is only done when there is
10025 =head2 Plugin C<write_mongodb>
10027 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
10032 <Plugin "write_mongodb">
10041 The plugin can send values to multiple instances of I<MongoDB> by specifying
10042 one B<Node> block for each instance. Within the B<Node> blocks, the following
10043 options are available:
10047 =item B<Host> I<Address>
10049 Hostname or address to connect to. Defaults to C<localhost>.
10051 =item B<Port> I<Service>
10053 Service name or port number to connect to. Defaults to C<27017>.
10055 =item B<Timeout> I<Milliseconds>
10057 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
10058 Setting this option to zero means no timeout, which is the default.
10060 =item B<StoreRates> B<false>|B<true>
10062 If set to B<true> (the default), convert counter values to rates. If set to
10063 B<false> counter values are stored as is, i.e. as an increasing integer
10066 =item B<Database> I<Database>
10068 =item B<User> I<User>
10070 =item B<Password> I<Password>
10072 Sets the information used when authenticating to a I<MongoDB> database. The
10073 fields are optional (in which case no authentication is attempted), but if you
10074 want to use authentication all three fields must be set.
10078 =head2 Plugin C<write_prometheus>
10080 The I<write_prometheus plugin> implements a tiny webserver that can be scraped
10081 using I<Prometheus>.
10087 =item B<Host> I<Host>
10089 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
10090 "any" address, i.e. accept packets sent to any of the hosts addresses.
10092 This option is supported only for libmicrohttpd newer than 0.9.0.
10094 =item B<Port> I<Port>
10096 Port the embedded webserver should listen on. Defaults to B<9103>.
10098 =item B<StalenessDelta> I<Seconds>
10100 Time in seconds after which I<Prometheus> considers a metric "stale" if it
10101 hasn't seen any update for it. This value must match the setting in Prometheus.
10102 It defaults to B<300> seconds (5 minutes), same as Prometheus.
10106 I<Prometheus> has a global setting, C<StalenessDelta>, which controls after
10107 which time a metric without updates is considered "stale". This setting
10108 effectively puts an upper limit on the interval in which metrics are reported.
10110 When the I<write_prometheus plugin> encounters a metric with an interval
10111 exceeding this limit, it will inform you, the user, and provide the metric to
10112 I<Prometheus> B<without> a timestamp. That causes I<Prometheus> to consider the
10113 metric "fresh" each time it is scraped, with the time of the scrape being
10114 considered the time of the update. The result is that there appear more
10115 datapoints in I<Prometheus> than were actually created, but at least the metric
10116 doesn't disappear periodically.
10120 =head2 Plugin C<write_http>
10122 This output plugin submits values to an HTTP server using POST requests and
10123 encoding metrics with JSON or using the C<PUTVAL> command described in
10124 L<collectd-unixsock(5)>.
10128 <Plugin "write_http">
10130 URL "http://example.com/post-collectd"
10132 Password "weCh3ik0"
10137 The plugin can send values to multiple HTTP servers by specifying one
10138 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
10139 block, the following options are available:
10143 =item B<URL> I<URL>
10145 URL to which the values are submitted to. Mandatory.
10147 =item B<User> I<Username>
10149 Optional user name needed for authentication.
10151 =item B<Password> I<Password>
10153 Optional password needed for authentication.
10155 =item B<VerifyPeer> B<true>|B<false>
10157 Enable or disable peer SSL certificate verification. See
10158 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
10160 =item B<VerifyHost> B<true|false>
10162 Enable or disable peer host name verification. If enabled, the plugin checks if
10163 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
10164 matches the host name provided by the B<URL> option. If this identity check
10165 fails, the connection is aborted. Obviously, only works when connecting to a
10166 SSL enabled server. Enabled by default.
10168 =item B<CACert> I<File>
10170 File that holds one or more SSL certificates. If you want to use HTTPS you will
10171 possibly need this option. What CA certificates come bundled with C<libcurl>
10172 and are checked by default depends on the distribution you use.
10174 =item B<CAPath> I<Directory>
10176 Directory holding one or more CA certificate files. You can use this if for
10177 some reason all the needed CA certificates aren't in the same file and can't be
10178 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
10181 =item B<ClientKey> I<File>
10183 File that holds the private key in PEM format to be used for certificate-based
10186 =item B<ClientCert> I<File>
10188 File that holds the SSL certificate to be used for certificate-based
10191 =item B<ClientKeyPass> I<Password>
10193 Password required to load the private key in B<ClientKey>.
10195 =item B<Header> I<Header>
10197 A HTTP header to add to the request. Multiple headers are added if this option is specified more than once. Example:
10199 Header "X-Custom-Header: custom_value"
10201 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
10203 Define which SSL protocol version must be used. By default C<libcurl> will
10204 attempt to figure out the remote SSL protocol version. See
10205 L<curl_easy_setopt(3)> for more details.
10207 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
10209 Format of the output to generate. If set to B<Command>, will create output that
10210 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
10211 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
10212 , will create output in the KairosDB format.
10214 Defaults to B<Command>.
10216 =item B<Attribute> I<String> I<String>
10218 Only available for the KAIROSDB output format.
10220 Consider the two given strings to be the key and value of an additional tag for
10221 each metric being sent out.
10223 You can add multiple B<Attribute>.
10225 =item B<TTL> I<Int>
10227 Only available for the KAIROSDB output format.
10229 Sets the Cassandra ttl for the data points.
10231 Please refer to L<http://kairosdb.github.io/docs/build/html/restapi/AddDataPoints.html?highlight=ttl>
10233 =item B<Prefix> I<String>
10235 Only available for the KAIROSDB output format.
10237 Sets the metrics prefix I<string>. Defaults to I<collectd>.
10239 =item B<Metrics> B<true>|B<false>
10241 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
10243 =item B<Notifications> B<false>|B<true>
10245 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
10247 =item B<StoreRates> B<true|false>
10249 If set to B<true>, convert counter values to rates. If set to B<false> (the
10250 default) counter values are stored as is, i.e. as an increasing integer number.
10252 =item B<BufferSize> I<Bytes>
10254 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
10255 requests will be generated, but more metrics will be batched / metrics are
10256 cached for longer before being sent, introducing additional delay until they
10257 are available on the server side. I<Bytes> must be at least 1024 and cannot
10258 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
10259 Defaults to C<4096>.
10261 =item B<LowSpeedLimit> I<Bytes per Second>
10263 Sets the minimal transfer rate in I<Bytes per Second> below which the
10264 connection with the HTTP server will be considered too slow and aborted. All
10265 the data submitted over this connection will probably be lost. Defaults to 0,
10266 which means no minimum transfer rate is enforced.
10268 =item B<Timeout> I<Timeout>
10270 Sets the maximum time in milliseconds given for HTTP POST operations to
10271 complete. When this limit is reached, the POST operation will be aborted, and
10272 all the data in the current send buffer will probably be lost. Defaults to 0,
10273 which means the connection never times out.
10275 =item B<LogHttpError> B<false>|B<true>
10277 Enables printing of HTTP error code to log. Turned off by default.
10279 The C<write_http> plugin regularly submits the collected values to the HTTP
10280 server. How frequently this happens depends on how much data you are collecting
10281 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
10282 slightly below this interval, which you can estimate by monitoring the network
10283 traffic between collectd and the HTTP server.
10287 =head2 Plugin C<write_kafka>
10289 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
10293 <Plugin "write_kafka">
10294 Property "metadata.broker.list" "broker1:9092,broker2:9092"
10300 The following options are understood by the I<write_kafka plugin>:
10304 =item E<lt>B<Topic> I<Name>E<gt>
10306 The plugin's configuration consists of one or more B<Topic> blocks. Each block
10307 is given a unique I<Name> and specifies one kafka producer.
10308 Inside the B<Topic> block, the following per-topic options are
10313 =item B<Property> I<String> I<String>
10315 Configure the named property for the current topic. Properties are
10316 forwarded to the kafka producer library B<librdkafka>.
10318 =item B<Key> I<String>
10320 Use the specified string as a partitioning key for the topic. Kafka breaks
10321 topic into partitions and guarantees that for a given topology, the same
10322 consumer will be used for a specific key. The special (case insensitive)
10323 string B<Random> can be used to specify that an arbitrary partition should
10326 =item B<Format> B<Command>|B<JSON>|B<Graphite>
10328 Selects the format in which messages are sent to the broker. If set to
10329 B<Command> (the default), values are sent as C<PUTVAL> commands which are
10330 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
10332 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
10333 an easy and straight forward exchange format.
10335 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
10336 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
10338 =item B<StoreRates> B<true>|B<false>
10340 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
10341 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
10342 default), no conversion is performed. Otherwise the conversion is performed
10343 using the internal value cache.
10345 Please note that currently this option is only used if the B<Format> option has
10346 been set to B<JSON>.
10348 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
10350 A prefix can be added in the metric name when outputting in the I<Graphite>
10353 When B<GraphiteUseTags> is I<false>, prefix is added before the I<Host> name.
10354 Metric name will be
10355 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>>
10357 When B<GraphiteUseTags> is I<true>, prefix is added in front of series name.
10359 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
10361 A postfix can be added in the metric name when outputting in the I<Graphite>
10364 When B<GraphiteUseTags> is I<false>, postfix is added after the I<Host> name.
10365 Metric name will be
10366 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>>
10368 When B<GraphiteUseTags> is I<true>, prefix value appended to the end of series
10369 name (before the first ; that separates the name from the tags).
10371 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
10373 Specify a character to replace dots (.) in the host part of the metric name.
10374 In I<Graphite> metric name, dots are used as separators between different
10375 metric parts (host, plugin, type).
10376 Default is C<_> (I<Underscore>).
10378 =item B<GraphiteSeparateInstances> B<false>|B<true>
10380 If set to B<true>, the plugin instance and type instance will be in their own
10381 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
10382 default), the plugin and plugin instance (and likewise the type and type
10383 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
10385 Option value is not used when B<GraphiteUseTags> is I<true>.
10387 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
10389 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
10390 identifier. If set to B<false> (the default), this is only done when there is
10393 =item B<GraphitePreserveSeparator> B<false>|B<true>
10395 If set to B<false> (the default) the C<.> (dot) character is replaced with
10396 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
10397 is preserved, i.e. passed through.
10399 Option value is not used when B<GraphiteUseTags> is I<true>.
10401 =item B<GraphiteUseTags> B<false>|B<true>
10403 If set to B<true> Graphite metric names will be generated as tagged series.
10405 Default value: B<false>.
10407 =item B<StoreRates> B<true>|B<false>
10409 If set to B<true> (the default), convert counter values to rates. If set to
10410 B<false> counter values are stored as is, i.e. as an increasing integer number.
10412 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
10413 converted values will have "rate" appended to the data source type, e.g.
10414 C<ds_type:derive:rate>.
10418 =item B<Property> I<String> I<String>
10420 Configure the kafka producer through properties, you almost always will
10421 want to set B<metadata.broker.list> to your Kafka broker list.
10425 =head2 Plugin C<write_redis>
10427 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
10431 <Plugin "write_redis">
10444 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
10445 the timestamp as the score. Retrieving a date range can then be done using the
10446 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
10447 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
10448 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
10449 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
10450 with the B<Database> parameter (default is C<0>). See
10451 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
10454 The information shown in the synopsis above is the I<default configuration>
10455 which is used by the plugin if no configuration is present.
10457 The plugin can send values to multiple instances of I<Redis> by specifying
10458 one B<Node> block for each instance. Within the B<Node> blocks, the following
10459 options are available:
10463 =item B<Node> I<Nodename>
10465 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
10466 instance running on a specified host and port. The node name is a
10467 canonical identifier which is used as I<plugin instance>. It is limited to
10468 51E<nbsp>characters in length.
10470 =item B<Host> I<Hostname>
10472 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
10475 =item B<Port> I<Port>
10477 The B<Port> option is the TCP port on which the Redis instance accepts
10478 connections. Either a service name of a port number may be given. Please note
10479 that numerical port numbers must be given as a string, too.
10481 =item B<Timeout> I<Milliseconds>
10483 The B<Timeout> option sets the socket connection timeout, in milliseconds.
10485 =item B<Prefix> I<Prefix>
10487 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
10488 containing all metrics. Defaults to C<collectd/>, so metrics will have names
10489 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
10490 is recommended but not required to include a trailing slash in I<Prefix>.
10492 =item B<Database> I<Index>
10494 This index selects the redis database to use for writing operations. Defaults
10497 =item B<MaxSetSize> I<Items>
10499 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
10500 hold. Negative values for I<Items> sets no limit, which is the default behavior.
10502 =item B<MaxSetDuration> I<Seconds>
10504 The B<MaxSetDuration> option limits the duration of items that the
10505 I<Sorted Sets> can hold. Negative values for I<Items> sets no duration, which
10506 is the default behavior.
10508 =item B<StoreRates> B<true>|B<false>
10510 If set to B<true> (the default), convert counter values to rates. If set to
10511 B<false> counter values are stored as is, i.e. as an increasing integer number.
10515 =head2 Plugin C<write_riemann>
10517 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
10518 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
10519 I<Riemann> using UDP packets.
10523 <Plugin "write_riemann">
10529 AlwaysAppendDS false
10533 Attribute "foo" "bar"
10536 The following options are understood by the I<write_riemann plugin>:
10540 =item E<lt>B<Node> I<Name>E<gt>
10542 The plugin's configuration consists of one or more B<Node> blocks. Each block
10543 is given a unique I<Name> and specifies one connection to an instance of
10544 I<Riemann>. Indise the B<Node> block, the following per-connection options are
10549 =item B<Host> I<Address>
10551 Hostname or address to connect to. Defaults to C<localhost>.
10553 =item B<Port> I<Service>
10555 Service name or port number to connect to. Defaults to C<5555>.
10557 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
10559 Specify the protocol to use when communicating with I<Riemann>. Defaults to
10562 =item B<TLSCertFile> I<Path>
10564 When using the B<TLS> protocol, path to a PEM certificate to present
10567 =item B<TLSCAFile> I<Path>
10569 When using the B<TLS> protocol, path to a PEM CA certificate to
10570 use to validate the remote hosts's identity.
10572 =item B<TLSKeyFile> I<Path>
10574 When using the B<TLS> protocol, path to a PEM private key associated
10575 with the certificate defined by B<TLSCertFile>.
10577 =item B<Batch> B<true>|B<false>
10579 If set to B<true> and B<Protocol> is set to B<TCP>,
10580 events will be batched in memory and flushed at
10581 regular intervals or when B<BatchMaxSize> is exceeded.
10583 Notifications are not batched and sent as soon as possible.
10585 When enabled, it can occur that events get processed by the Riemann server
10586 close to or after their expiration time. Tune the B<TTLFactor> and
10587 B<BatchMaxSize> settings according to the amount of values collected, if this
10592 =item B<BatchMaxSize> I<size>
10594 Maximum payload size for a riemann packet. Defaults to 8192
10596 =item B<BatchFlushTimeout> I<seconds>
10598 Maximum amount of seconds to wait in between to batch flushes.
10599 No timeout by default.
10601 =item B<StoreRates> B<true>|B<false>
10603 If set to B<true> (the default), convert counter values to rates. If set to
10604 B<false> counter values are stored as is, i.e. as an increasing integer number.
10606 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
10607 converted values will have "rate" appended to the data source type, e.g.
10608 C<ds_type:derive:rate>.
10610 =item B<AlwaysAppendDS> B<false>|B<true>
10612 If set to B<true>, append the name of the I<Data Source> (DS) to the
10613 "service", i.e. the field that, together with the "host" field, uniquely
10614 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
10615 only done when there is more than one DS.
10617 =item B<TTLFactor> I<Factor>
10619 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
10620 event is considered active. I<collectd> populates this field based on the
10621 metrics interval setting. This setting controls the factor with which the
10622 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
10623 know exactly what you're doing, you should only increase this setting from its
10626 =item B<Notifications> B<false>|B<true>
10628 If set to B<true>, create riemann events for notifications. This is B<true>
10629 by default. When processing thresholds from write_riemann, it might prove
10630 useful to avoid getting notification events.
10632 =item B<CheckThresholds> B<false>|B<true>
10634 If set to B<true>, attach state to events based on thresholds defined
10635 in the B<Threshold> plugin. Defaults to B<false>.
10637 =item B<EventServicePrefix> I<String>
10639 Add the given string as a prefix to the event service name.
10640 If B<EventServicePrefix> not set or set to an empty string (""),
10641 no prefix will be used.
10645 =item B<Tag> I<String>
10647 Add the given string as an additional tag to the metric being sent to
10650 =item B<Attribute> I<String> I<String>
10652 Consider the two given strings to be the key and value of an additional
10653 attribute for each metric being sent out to I<Riemann>.
10657 =head2 Plugin C<write_sensu>
10659 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
10660 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
10661 a local I<Sensu> client using a TCP socket.
10663 At the moment, the I<write_sensu plugin> does not send over a collectd_host
10664 parameter so it is not possible to use one collectd instance as a gateway for
10665 others. Each collectd host must pair with one I<Sensu> client.
10669 <Plugin "write_sensu">
10674 AlwaysAppendDS false
10675 MetricHandler "influx"
10676 MetricHandler "default"
10677 NotificationHandler "flapjack"
10678 NotificationHandler "howling_monkey"
10682 Attribute "foo" "bar"
10685 The following options are understood by the I<write_sensu plugin>:
10689 =item E<lt>B<Node> I<Name>E<gt>
10691 The plugin's configuration consists of one or more B<Node> blocks. Each block
10692 is given a unique I<Name> and specifies one connection to an instance of
10693 I<Sensu>. Inside the B<Node> block, the following per-connection options are
10698 =item B<Host> I<Address>
10700 Hostname or address to connect to. Defaults to C<localhost>.
10702 =item B<Port> I<Service>
10704 Service name or port number to connect to. Defaults to C<3030>.
10706 =item B<StoreRates> B<true>|B<false>
10708 If set to B<true> (the default), convert counter values to rates. If set to
10709 B<false> counter values are stored as is, i.e. as an increasing integer number.
10711 This will be reflected in the C<collectd_data_source_type> tag: If
10712 B<StoreRates> is enabled, converted values will have "rate" appended to the
10713 data source type, e.g. C<collectd_data_source_type:derive:rate>.
10715 =item B<AlwaysAppendDS> B<false>|B<true>
10717 If set the B<true>, append the name of the I<Data Source> (DS) to the
10718 "service", i.e. the field that, together with the "host" field, uniquely
10719 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
10720 only done when there is more than one DS.
10722 =item B<Notifications> B<false>|B<true>
10724 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
10725 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10727 =item B<Metrics> B<false>|B<true>
10729 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
10730 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10733 =item B<Separator> I<String>
10735 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
10737 =item B<MetricHandler> I<String>
10739 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
10740 several of them, one per line. Defaults to no handler.
10742 =item B<NotificationHandler> I<String>
10744 Add a handler that will be set when notifications are sent to I<Sensu>. You can
10745 add several of them, one per line. Defaults to no handler.
10747 =item B<EventServicePrefix> I<String>
10749 Add the given string as a prefix to the event service name.
10750 If B<EventServicePrefix> not set or set to an empty string (""),
10751 no prefix will be used.
10755 =item B<Tag> I<String>
10757 Add the given string as an additional tag to the metric being sent to
10760 =item B<Attribute> I<String> I<String>
10762 Consider the two given strings to be the key and value of an additional
10763 attribute for each metric being sent out to I<Sensu>.
10767 =head2 Plugin C<write_stackdriver>
10769 The C<write_stackdriver> plugin writes metrics to the
10770 I<Google Stackdriver Monitoring> service.
10772 This plugin supports two authentication methods: When configured, credentials
10773 are read from the JSON credentials file specified with B<CredentialFile>.
10774 Alternatively, when running on
10775 I<Google Compute Engine> (GCE), an I<OAuth> token is retrieved from the
10776 I<metadata server> and used to authenticate to GCM.
10780 <Plugin write_stackdriver>
10781 CredentialFile "/path/to/service_account.json"
10782 <Resource "global">
10783 Label "project_id" "monitored_project"
10789 =item B<CredentialFile> I<file>
10791 Path to a JSON credentials file holding the credentials for a GCP service
10794 If B<CredentialFile> is not specified, the plugin uses I<Application Default
10795 Credentials>. That means which credentials are used depends on the environment:
10801 The environment variable C<GOOGLE_APPLICATION_CREDENTIALS> is checked. If this
10802 variable is specified it should point to a JSON file that defines the
10807 The path C<${HOME}/.config/gcloud/application_default_credentials.json> is
10808 checked. This where credentials used by the I<gcloud> command line utility are
10809 stored. You can use C<gcloud auth application-default login> to create these
10812 Please note that these credentials are often of your personal account, not a
10813 service account, and are therefore unfit to be used in a production
10818 When running on GCE, the built-in service account associated with the virtual
10819 machine instance is used.
10820 See also the B<Email> option below.
10824 =item B<Project> I<Project>
10826 The I<Project ID> or the I<Project Number> of the I<Stackdriver Account>. The
10827 I<Project ID> is a string identifying the GCP project, which you can chose
10828 freely when creating a new project. The I<Project Number> is a 12-digit decimal
10829 number. You can look up both on the I<Developer Console>.
10831 This setting is optional. If not set, the project ID is read from the
10832 credentials file or determined from the GCE's metadata service.
10834 =item B<Email> I<Email> (GCE only)
10836 Choses the GCE I<Service Account> used for authentication.
10838 Each GCE instance has a C<default> I<Service Account> but may also be
10839 associated with additional I<Service Accounts>. This is often used to restrict
10840 the permissions of services running on the GCE instance to the required
10841 minimum. The I<write_stackdriver plugin> requires the
10842 C<https://www.googleapis.com/auth/monitoring> scope. When multiple I<Service
10843 Accounts> are available, this option selects which one is used by
10844 I<write_stackdriver plugin>.
10846 =item B<Resource> I<ResourceType>
10848 Configures the I<Monitored Resource> to use when storing metrics.
10849 More information on I<Monitored Resources> and I<Monitored Resource Types> are
10850 available at L<https://cloud.google.com/monitoring/api/resources>.
10852 This block takes one string argument, the I<ResourceType>. Inside the block are
10853 one or more B<Label> options which configure the resource labels.
10855 This block is optional. The default value depends on the runtime environment:
10856 on GCE, the C<gce_instance> resource type is used, otherwise the C<global>
10857 resource type ist used:
10863 B<On GCE>, defaults to the equivalent of this config:
10865 <Resource "gce_instance">
10866 Label "project_id" "<project_id>"
10867 Label "instance_id" "<instance_id>"
10868 Label "zone" "<zone>"
10871 The values for I<project_id>, I<instance_id> and I<zone> are read from the GCE
10876 B<Elsewhere>, i.e. not on GCE, defaults to the equivalent of this config:
10878 <Resource "global">
10879 Label "project_id" "<Project>"
10882 Where I<Project> refers to the value of the B<Project> option or the project ID
10883 inferred from the B<CredentialFile>.
10887 =item B<Url> I<Url>
10889 URL of the I<Stackdriver Monitoring> API. Defaults to
10890 C<https://monitoring.googleapis.com/v3>.
10894 =head2 Plugin C<write_syslog>
10896 The C<write_syslog> plugin writes data in I<syslog> format log messages.
10897 It implements the basic syslog protocol, RFC 5424, extends it with
10898 content-based filtering, rich filtering capabilities,
10899 flexible configuration options and adds features such as using TCP for transport.
10900 The plugin can connect to a I<Syslog> daemon, like syslog-ng and rsyslog, that will
10901 ingest metrics, transform and ship them to the specified output.
10902 The plugin uses I<TCP> over the "line based" protocol with a default port 44514.
10903 The data will be sent in blocks of at most 1428 bytes to minimize the number of
10908 <Plugin write_syslog>
10912 Host "syslog-1.my.domain"
10915 MessageFormat "human"
10920 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
10921 blocks and global directives.
10923 Global directives are:
10927 =item B<ResolveInterval> I<seconds>
10929 =item B<ResolveJitter> I<seconds>
10931 When I<collectd> connects to a syslog node, it will request the hostname from
10932 DNS. This can become a problem if the syslog node is unavailable or badly
10933 configured because collectd will request DNS in order to reconnect for every
10934 metric, which can flood your DNS. So you can cache the last value for
10935 I<ResolveInterval> seconds.
10936 Defaults to the I<Interval> of the I<write_syslog plugin>, e.g. 10E<nbsp>seconds.
10938 You can also define a jitter, a random interval to wait in addition to
10939 I<ResolveInterval>. This prevents all your collectd servers to resolve the
10940 hostname at the same time when the connection fails.
10941 Defaults to the I<Interval> of the I<write_syslog plugin>, e.g. 10E<nbsp>seconds.
10943 B<Note:> If the DNS resolution has already been successful when the socket
10944 closes, the plugin will try to reconnect immediately with the cached
10945 information. DNS is queried only when the socket is closed for a longer than
10946 I<ResolveInterval> + I<ResolveJitter> seconds.
10950 Inside the B<Node> blocks, the following options are recognized:
10954 =item B<Host> I<Address>
10956 Hostname or address to connect to. Defaults to C<localhost>.
10958 =item B<Port> I<Service>
10960 Service name or port number to connect to. Defaults to C<44514>.
10963 =item B<HostTags> I<String>
10965 When set, I<HostTags> is added to the end of the metric.
10966 It is intended to be used for adding additional metadata to tag the metric with.
10967 Dots and whitespace are I<not> escaped in this string.
10971 When MessageFormat is set to "human".
10973 ["prefix1" "example1"="example1_v"]["prefix2" "example2"="example2_v"]"
10975 When MessageFormat is set to "JSON", text should be in JSON format.
10976 Escaping the quotation marks is required.
10978 HostTags "\"prefix1\": {\"example1\":\"example1_v\",\"example2\":\"example2_v\"}"
10980 =item B<MessageFormat> I<String>
10982 I<MessageFormat> selects the format in which messages are sent to the
10983 syslog deamon, human or JSON. Defaults to human.
10985 Syslog message format:
10987 <priority>VERSION ISOTIMESTAMP HOSTNAME APPLICATION PID MESSAGEID STRUCTURED-DATA MSG
10989 The difference between the message formats are in the STRUCTURED-DATA and MSG parts.
10993 <166>1 ISOTIMESTAMP HOSTNAME collectd PID MESSAGEID
10994 ["collectd" "value": "v1" "plugin"="plugin_v" "plugin_instance"="plugin_instance_v"
10995 "type_instance"="type_instance_v" "type"="type_v" "ds_name"="ds_name_v" "interval"="interval_v" ]
10996 "host_tag_example"="host_tag_example_v" plugin_v.type_v.ds_name_v="v1"
11000 <166>1 ISOTIMESTAMP HOSTNAME collectd PID MESSAGEID STRUCTURED-DATA
11003 "time": time_as_epoch, "interval": interval_v, "plugin": "plugin_v",
11004 "plugin_instance": "plugin_instance_v", "type":"type_v",
11005 "type_instance": "type_instance_v", "plugin_v": {"type_v": v1}
11006 } , "host":"host_v", "host_tag_example": "host_tag_example_v"
11009 =item B<StoreRates> B<false>|B<true>
11011 If set to B<true>, convert counter values to rates. If set to B<false>
11012 (the default) counter values are stored as is, as an increasing
11015 =item B<AlwaysAppendDS> B<false>|B<true>
11017 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
11018 identifier. If set to B<false> (the default), this is only done when there is
11021 =item B<Prefix> I<String>
11023 When set, I<Prefix> is added to all metrics names as a prefix. It is intended in
11024 case you want to be able to define the source of the specific metric. Dots and
11025 whitespace are I<not> escaped in this string.
11029 =head2 Plugin C<xencpu>
11031 This plugin collects metrics of hardware CPU load for machine running Xen
11032 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
11033 Result is reported using the C<percent> type, for each CPU (core).
11035 This plugin doesn't have any options (yet).
11037 =head2 Plugin C<zookeeper>
11039 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
11040 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
11045 <Plugin "zookeeper">
11052 =item B<Host> I<Address>
11054 Hostname or address to connect to. Defaults to C<localhost>.
11056 =item B<Port> I<Service>
11058 Service name or port number to connect to. Defaults to C<2181>.
11062 =head1 THRESHOLD CONFIGURATION
11064 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
11065 we mean that the values are not only stored or sent somewhere, but that they
11066 are judged and, if a problem is recognized, acted upon. The only action
11067 collectd takes itself is to generate and dispatch a "notification". Plugins can
11068 register to receive notifications and perform appropriate further actions.
11070 Since systems and what you expect them to do differ a lot, you can configure
11071 B<thresholds> for your values freely. This gives you a lot of flexibility but
11072 also a lot of responsibility.
11074 Every time a value is out of range a notification is dispatched. This means
11075 that the idle percentage of your CPU needs to be less then the configured
11076 threshold only once for a notification to be generated. There's no such thing
11077 as a moving average or similar - at least not now.
11079 Also, all values that match a threshold are considered to be relevant or
11080 "interesting". As a consequence collectd will issue a notification if they are
11081 not received for B<Timeout> iterations. The B<Timeout> configuration option is
11082 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
11083 "2" (the default) and some hosts sends it's CPU statistics to the server every
11084 60 seconds, a notification will be dispatched after about 120 seconds. It may
11085 take a little longer because the timeout is checked only once each B<Interval>
11088 When a value comes within range again or is received after it was missing, an
11089 "OKAY-notification" is dispatched.
11091 Here is a configuration example to get you started. Read below for more
11104 <Plugin "interface">
11107 FailureMax 10000000
11121 WarningMin 100000000
11127 There are basically two types of configuration statements: The C<Host>,
11128 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
11129 configured. The C<Plugin> and C<Type> blocks may be specified further using the
11130 C<Instance> option. You can combine the block by nesting the blocks, though
11131 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
11132 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
11133 C<Type> may not contain other blocks. If multiple blocks apply to the same
11134 value the most specific block is used.
11136 The other statements specify the threshold to configure. They B<must> be
11137 included in a C<Type> block. Currently the following statements are recognized:
11141 =item B<FailureMax> I<Value>
11143 =item B<WarningMax> I<Value>
11145 Sets the upper bound of acceptable values. If unset defaults to positive
11146 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
11147 will be created. If the value is greater than B<WarningMax> but less than (or
11148 equal to) B<FailureMax> a B<WARNING> notification will be created.
11150 =item B<FailureMin> I<Value>
11152 =item B<WarningMin> I<Value>
11154 Sets the lower bound of acceptable values. If unset defaults to negative
11155 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
11156 be created. If the value is less than B<WarningMin> but greater than (or equal
11157 to) B<FailureMin> a B<WARNING> notification will be created.
11159 =item B<DataSource> I<DSName>
11161 Some data sets have more than one "data source". Interesting examples are the
11162 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
11163 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
11164 system load data set, C<load>, even has three data sources: C<shortterm>,
11165 C<midterm>, and C<longterm>.
11167 Normally, all data sources are checked against a configured threshold. If this
11168 is undesirable, or if you want to specify different limits for each data
11169 source, you can use the B<DataSource> option to have a threshold apply only to
11172 =item B<Invert> B<true>|B<false>
11174 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
11175 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
11176 B<WarningMax>) are not okay. Defaults to B<false>.
11178 =item B<Persist> B<true>|B<false>
11180 Sets how often notifications are generated. If set to B<true> one notification
11181 will be generated for each value that is out of the acceptable range. If set to
11182 B<false> (the default) then a notification is only generated if a value is out
11183 of range but the previous value was okay.
11185 This applies to missing values, too: If set to B<true> a notification about a
11186 missing value is generated once every B<Interval> seconds. If set to B<false>
11187 only one such notification is generated until the value appears again.
11189 =item B<Percentage> B<true>|B<false>
11191 If set to B<true>, the minimum and maximum values given are interpreted as
11192 percentage value, relative to the other data sources. This is helpful for
11193 example for the "df" type, where you may want to issue a warning when less than
11194 5E<nbsp>% of the total space is available. Defaults to B<false>.
11196 =item B<Hits> I<Number>
11198 Delay creating the notification until the threshold has been passed I<Number>
11199 times. When a notification has been generated, or when a subsequent value is
11200 inside the threshold, the counter is reset. If, for example, a value is
11201 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
11202 will be dispatched at most once every 30E<nbsp>seconds.
11204 This is useful when short bursts are not a problem. If, for example, 100% CPU
11205 usage for up to a minute is normal (and data is collected every
11206 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
11208 =item B<Hysteresis> I<Number>
11210 When set to non-zero, a hysteresis value is applied when checking minimum and
11211 maximum bounds. This is useful for values that increase slowly and fluctuate a
11212 bit while doing so. When these values come close to the threshold, they may
11213 "flap", i.e. switch between failure / warning case and okay case repeatedly.
11215 If, for example, the threshold is configures as
11220 then a I<Warning> notification is created when the value exceeds I<101> and the
11221 corresponding I<Okay> notification is only created once the value falls below
11222 I<99>, thus avoiding the "flapping".
11226 =head1 FILTER CONFIGURATION
11228 Starting with collectd 4.6 there is a powerful filtering infrastructure
11229 implemented in the daemon. The concept has mostly been copied from
11230 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
11231 terminology, so that users that are familiar with iptables feel right at home.
11235 The following are the terms used in the remainder of the filter configuration
11236 documentation. For an ASCII-art schema of the mechanism, see
11237 L<"General structure"> below.
11243 A I<match> is a criteria to select specific values. Examples are, of course, the
11244 name of the value or it's current value.
11246 Matches are implemented in plugins which you have to load prior to using the
11247 match. The name of such plugins starts with the "match_" prefix.
11251 A I<target> is some action that is to be performed with data. Such actions
11252 could, for example, be to change part of the value's identifier or to ignore
11253 the value completely.
11255 Some of these targets are built into the daemon, see L<"Built-in targets">
11256 below. Other targets are implemented in plugins which you have to load prior to
11257 using the target. The name of such plugins starts with the "target_" prefix.
11261 The combination of any number of matches and at least one target is called a
11262 I<rule>. The target actions will be performed for all values for which B<all>
11263 matches apply. If the rule does not have any matches associated with it, the
11264 target action will be performed for all values.
11268 A I<chain> is a list of rules and possibly default targets. The rules are tried
11269 in order and if one matches, the associated target will be called. If a value
11270 is handled by a rule, it depends on the target whether or not any subsequent
11271 rules are considered or if traversal of the chain is aborted, see
11272 L<"Flow control"> below. After all rules have been checked, the default targets
11277 =head2 General structure
11279 The following shows the resulting structure:
11286 +---------+ +---------+ +---------+ +---------+
11287 ! Rule !->! Match !->! Match !->! Target !
11288 +---------+ +---------+ +---------+ +---------+
11291 +---------+ +---------+ +---------+
11292 ! Rule !->! Target !->! Target !
11293 +---------+ +---------+ +---------+
11300 +---------+ +---------+ +---------+
11301 ! Rule !->! Match !->! Target !
11302 +---------+ +---------+ +---------+
11310 =head2 Flow control
11312 There are four ways to control which way a value takes through the filter
11319 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
11320 process the value with another chain. When the called chain finishes, usually
11321 the next target or rule after the jump is executed.
11325 The stop condition, signaled for example by the built-in target B<stop>, causes
11326 all processing of the value to be stopped immediately.
11330 Causes processing in the current chain to be aborted, but processing of the
11331 value generally will continue. This means that if the chain was called via
11332 B<Jump>, the next target or rule after the jump will be executed. If the chain
11333 was not called by another chain, control will be returned to the daemon and it
11334 may pass the value to another chain.
11338 Most targets will signal the B<continue> condition, meaning that processing
11339 should continue normally. There is no special built-in target for this
11346 The configuration reflects this structure directly:
11348 PostCacheChain "PostCache"
11349 <Chain "PostCache">
11350 <Rule "ignore_mysql_show">
11353 Type "^mysql_command$"
11354 TypeInstance "^show_"
11364 The above configuration example will ignore all values where the plugin field
11365 is "mysql", the type is "mysql_command" and the type instance begins with
11366 "show_". All other values will be sent to the C<rrdtool> write plugin via the
11367 default target of the chain. Since this chain is run after the value has been
11368 added to the cache, the MySQL C<show_*> command statistics will be available
11369 via the C<unixsock> plugin.
11371 =head2 List of configuration options
11375 =item B<PreCacheChain> I<ChainName>
11377 =item B<PostCacheChain> I<ChainName>
11379 Configure the name of the "pre-cache chain" and the "post-cache chain". The
11380 argument is the name of a I<chain> that should be executed before and/or after
11381 the values have been added to the cache.
11383 To understand the implications, it's important you know what is going on inside
11384 I<collectd>. The following diagram shows how values are passed from the
11385 read-plugins to the write-plugins:
11391 + - - - - V - - - - +
11392 : +---------------+ :
11395 : +-------+-------+ :
11398 : +-------+-------+ : +---------------+
11399 : ! Cache !--->! Value Cache !
11400 : ! insert ! : +---+---+-------+
11401 : +-------+-------+ : ! !
11402 : ! ,------------' !
11404 : +-------+---+---+ : +-------+-------+
11405 : ! Post-Cache +--->! Write-Plugins !
11406 : ! Chain ! : +---------------+
11407 : +---------------+ :
11409 : dispatch values :
11410 + - - - - - - - - - +
11412 After the values are passed from the "read" plugins to the dispatch functions,
11413 the pre-cache chain is run first. The values are added to the internal cache
11414 afterwards. The post-cache chain is run after the values have been added to the
11415 cache. So why is it such a huge deal if chains are run before or after the
11416 values have been added to this cache?
11418 Targets that change the identifier of a value list should be executed before
11419 the values are added to the cache, so that the name in the cache matches the
11420 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
11421 this cache to receive a list of all available values. If you change the
11422 identifier after the value list has been added to the cache, this may easily
11423 lead to confusion, but it's not forbidden of course.
11425 The cache is also used to convert counter values to rates. These rates are, for
11426 example, used by the C<value> match (see below). If you use the rate stored in
11427 the cache B<before> the new value is added, you will use the old, B<previous>
11428 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
11429 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
11432 Last but not last, the B<stop> target makes a difference: If the pre-cache
11433 chain returns the stop condition, the value will not be added to the cache and
11434 the post-cache chain will not be run.
11436 =item B<Chain> I<Name>
11438 Adds a new chain with a certain name. This name can be used to refer to a
11439 specific chain, for example to jump to it.
11441 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
11443 =item B<Rule> [I<Name>]
11445 Adds a new rule to the current chain. The name of the rule is optional and
11446 currently has no meaning for the daemon.
11448 Within the B<Rule> block, there may be any number of B<Match> blocks and there
11449 must be at least one B<Target> block.
11451 =item B<Match> I<Name>
11453 Adds a match to a B<Rule> block. The name specifies what kind of match should
11454 be performed. Available matches depend on the plugins that have been loaded.
11456 The arguments inside the B<Match> block are passed to the plugin implementing
11457 the match, so which arguments are valid here depends on the plugin being used.
11458 If you do not need any to pass any arguments to a match, you can use the
11463 Which is equivalent to:
11468 =item B<Target> I<Name>
11470 Add a target to a rule or a default target to a chain. The name specifies what
11471 kind of target is to be added. Which targets are available depends on the
11472 plugins being loaded.
11474 The arguments inside the B<Target> block are passed to the plugin implementing
11475 the target, so which arguments are valid here depends on the plugin being used.
11476 If you do not need any to pass any arguments to a target, you can use the
11481 This is the same as writing:
11488 =head2 Built-in targets
11490 The following targets are built into the core daemon and therefore need no
11491 plugins to be loaded:
11497 Signals the "return" condition, see the L<"Flow control"> section above. This
11498 causes the current chain to stop processing the value and returns control to
11499 the calling chain. The calling chain will continue processing targets and rules
11500 just after the B<jump> target (see below). This is very similar to the
11501 B<RETURN> target of iptables, see L<iptables(8)>.
11503 This target does not have any options.
11511 Signals the "stop" condition, see the L<"Flow control"> section above. This
11512 causes processing of the value to be aborted immediately. This is similar to
11513 the B<DROP> target of iptables, see L<iptables(8)>.
11515 This target does not have any options.
11523 Sends the value to "write" plugins.
11529 =item B<Plugin> I<Name>
11531 Name of the write plugin to which the data should be sent. This option may be
11532 given multiple times to send the data to more than one write plugin. If the
11533 plugin supports multiple instances, the plugin's instance(s) must also be
11538 If no plugin is explicitly specified, the values will be sent to all available
11541 Single-instance plugin example:
11547 Multi-instance plugin example:
11549 <Plugin "write_graphite">
11559 Plugin "write_graphite/foo"
11564 Starts processing the rules of another chain, see L<"Flow control"> above. If
11565 the end of that chain is reached, or a stop condition is encountered,
11566 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
11567 next target or the next rule. This is similar to the B<-j> command line option
11568 of iptables, see L<iptables(8)>.
11574 =item B<Chain> I<Name>
11576 Jumps to the chain I<Name>. This argument is required and may appear only once.
11588 =head2 Available matches
11594 Matches a value using regular expressions.
11600 =item B<Host> I<Regex>
11602 =item B<Plugin> I<Regex>
11604 =item B<PluginInstance> I<Regex>
11606 =item B<Type> I<Regex>
11608 =item B<TypeInstance> I<Regex>
11610 =item B<MetaData> I<String> I<Regex>
11612 Match values where the given regular expressions match the various fields of
11613 the identifier of a value. If multiple regular expressions are given, B<all>
11614 regexen must match for a value to match.
11616 =item B<Invert> B<false>|B<true>
11618 When set to B<true>, the result of the match is inverted, i.e. all value lists
11619 where all regular expressions apply are not matched, all other value lists are
11620 matched. Defaults to B<false>.
11627 Host "customer[0-9]+"
11633 Matches values that have a time which differs from the time on the server.
11635 This match is mainly intended for servers that receive values over the
11636 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
11637 is very sensitive to the timestamp used when updating the RRD files. In
11638 particular, the time must be ever increasing. If a misbehaving client sends one
11639 packet with a timestamp far in the future, all further packets with a correct
11640 time will be ignored because of that one packet. What's worse, such corrupted
11641 RRD files are hard to fix.
11643 This match lets one match all values B<outside> a specified time range
11644 (relative to the server's time), so you can use the B<stop> target (see below)
11645 to ignore the value, for example.
11651 =item B<Future> I<Seconds>
11653 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
11654 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
11657 =item B<Past> I<Seconds>
11659 Matches all values that are I<behind> of the server's time by I<Seconds> or
11660 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
11672 This example matches all values that are five minutes or more ahead of the
11673 server or one hour (or more) lagging behind.
11677 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
11678 values. If a data-set consists of more than one data-source, all data-sources
11679 must match the specified ranges for a positive match.
11685 =item B<Min> I<Value>
11687 Sets the smallest value which still results in a match. If unset, behaves like
11690 =item B<Max> I<Value>
11692 Sets the largest value which still results in a match. If unset, behaves like
11695 =item B<Invert> B<true>|B<false>
11697 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
11698 no-match is returned and vice versa. Please note that the B<Invert> setting
11699 only effects how B<Min> and B<Max> are applied to a specific value. Especially
11700 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
11702 =item B<DataSource> I<DSName> [I<DSName> ...]
11704 Select one or more of the data sources. If no data source is configured, all
11705 data sources will be checked. If the type handled by the match does not have a
11706 data source of the specified name(s), this will always result in no match
11707 (independent of the B<Invert> setting).
11709 =item B<Satisfy> B<Any>|B<All>
11711 Specifies how checking with several data sources is performed. If set to
11712 B<Any>, the match succeeds if one of the data sources is in the configured
11713 range. If set to B<All> the match only succeeds if all data sources are within
11714 the configured range. Default is B<All>.
11716 Usually B<All> is used for positive matches, B<Any> is used for negative
11717 matches. This means that with B<All> you usually check that all values are in a
11718 "good" range, while with B<Any> you check if any value is within a "bad" range
11719 (or outside the "good" range).
11723 Either B<Min> or B<Max>, but not both, may be unset.
11727 # Match all values smaller than or equal to 100. Matches only if all data
11728 # sources are below 100.
11734 # Match if the value of any data source is outside the range of 0 - 100.
11742 =item B<empty_counter>
11744 Matches all values with one or more data sources of type B<COUNTER> and where
11745 all counter values are zero. These counters usually I<never> increased since
11746 they started existing (and are therefore uninteresting), or got reset recently
11747 or overflowed and you had really, I<really> bad luck.
11749 Please keep in mind that ignoring such counters can result in confusing
11750 behavior: Counters which hardly ever increase will be zero for long periods of
11751 time. If the counter is reset for some reason (machine or service restarted,
11752 usually), the graph will be empty (NAN) for a long time. People may not
11757 Calculates a hash value of the host name and matches values according to that
11758 hash value. This makes it possible to divide all hosts into groups and match
11759 only values that are in a specific group. The intended use is in load
11760 balancing, where you want to handle only part of all data and leave the rest
11763 The hashing function used tries to distribute the hosts evenly. First, it
11764 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
11767 for (i = 0; host[i] != 0; i++)
11768 hash_value = (hash_value * 251) + host[i];
11770 The constant 251 is a prime number which is supposed to make this hash value
11771 more random. The code then checks the group for this host according to the
11772 I<Total> and I<Match> arguments:
11774 if ((hash_value % Total) == Match)
11779 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
11780 groups), then the least significant bit of the hash value will be the XOR of
11781 all least significant bits in the host name. One consequence is that when you
11782 have two hosts, "server0.example.com" and "server1.example.com", where the host
11783 name differs in one digit only and the digits differ by one, those hosts will
11784 never end up in the same group.
11790 =item B<Match> I<Match> I<Total>
11792 Divide the data into I<Total> groups and match all hosts in group I<Match> as
11793 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
11794 be smaller than I<Total>. I<Total> must be at least one, although only values
11795 greater than one really do make any sense.
11797 You can repeat this option to match multiple groups, for example:
11802 The above config will divide the data into seven groups and match groups three
11803 and five. One use would be to keep every value on two hosts so that if one
11804 fails the missing data can later be reconstructed from the second host.
11810 # Operate on the pre-cache chain, so that ignored values are not even in the
11815 # Divide all received hosts in seven groups and accept all hosts in
11819 # If matched: Return and continue.
11822 # If not matched: Return and stop.
11828 =head2 Available targets
11832 =item B<notification>
11834 Creates and dispatches a notification.
11840 =item B<Message> I<String>
11842 This required option sets the message of the notification. The following
11843 placeholders will be replaced by an appropriate value:
11851 =item B<%{plugin_instance}>
11855 =item B<%{type_instance}>
11857 These placeholders are replaced by the identifier field of the same name.
11859 =item B<%{ds:>I<name>B<}>
11861 These placeholders are replaced by a (hopefully) human readable representation
11862 of the current rate of this data source. If you changed the instance name
11863 (using the B<set> or B<replace> targets, see below), it may not be possible to
11864 convert counter values to rates.
11868 Please note that these placeholders are B<case sensitive>!
11870 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
11872 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
11879 <Target "notification">
11880 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
11886 Replaces parts of the identifier using regular expressions.
11892 =item B<Host> I<Regex> I<Replacement>
11894 =item B<Plugin> I<Regex> I<Replacement>
11896 =item B<PluginInstance> I<Regex> I<Replacement>
11898 =item B<TypeInstance> I<Regex> I<Replacement>
11900 =item B<MetaData> I<String> I<Regex> I<Replacement>
11902 =item B<DeleteMetaData> I<String> I<Regex>
11904 Match the appropriate field with the given regular expression I<Regex>. If the
11905 regular expression matches, that part that matches is replaced with
11906 I<Replacement>. If multiple places of the input buffer match a given regular
11907 expression, only the first occurrence will be replaced.
11909 You can specify each option multiple times to use multiple regular expressions
11917 # Replace "example.net" with "example.com"
11918 Host "\\<example.net\\>" "example.com"
11920 # Strip "www." from hostnames
11921 Host "\\<www\\." ""
11926 Sets part of the identifier of a value to a given string.
11932 =item B<Host> I<String>
11934 =item B<Plugin> I<String>
11936 =item B<PluginInstance> I<String>
11938 =item B<TypeInstance> I<String>
11940 =item B<MetaData> I<String> I<String>
11942 Set the appropriate field to the given string. The strings for plugin instance,
11943 type instance, and meta data may be empty, the strings for host and plugin may
11944 not be empty. It's currently not possible to set the type of a value this way.
11946 The following placeholders will be replaced by an appropriate value:
11954 =item B<%{plugin_instance}>
11958 =item B<%{type_instance}>
11960 These placeholders are replaced by the identifier field of the same name.
11962 =item B<%{meta:>I<name>B<}>
11964 These placeholders are replaced by the meta data value with the given name.
11968 Please note that these placeholders are B<case sensitive>!
11970 =item B<DeleteMetaData> I<String>
11972 Delete the named meta data field.
11979 PluginInstance "coretemp"
11980 TypeInstance "core3"
11985 =head2 Backwards compatibility
11987 If you use collectd with an old configuration, i.E<nbsp>e. one without a
11988 B<Chain> block, it will behave as it used to. This is equivalent to the
11989 following configuration:
11991 <Chain "PostCache">
11995 If you specify a B<PostCacheChain>, the B<write> target will not be added
11996 anywhere and you will have to make sure that it is called where appropriate. We
11997 suggest to add the above snippet as default target to your "PostCache" chain.
12001 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
12016 B<Ignorelists> are a generic framework to either ignore some metrics or report
12017 specific metrics only. Plugins usually provide one or more options to specify
12018 the items (mounts points, devices, ...) and the boolean option
12023 =item B<Select> I<String>
12025 Selects the item I<String>. This option often has a plugin specific name, e.g.
12026 B<Sensor> in the C<sensors> plugin. It is also plugin specific what this string
12027 is compared to. For example, the C<df> plugin's B<MountPoint> compares it to a
12028 mount point and the C<sensors> plugin's B<Sensor> compares it to a sensor name.
12030 By default, this option is doing a case-sensitive full-string match. The
12031 following config will match C<foo>, but not C<Foo>:
12035 If I<String> starts and ends with C</> (a slash), the string is compiled as a
12036 I<regular expression>. For example, so match all item starting with C<foo>, use
12037 could use the following syntax:
12041 The regular expression is I<not> anchored, i.e. the following config will match
12042 C<foobar>, C<barfoo> and C<AfooZ>:
12046 The B<Select> option may be repeated to select multiple items.
12048 =item B<IgnoreSelected> B<true>|B<false>
12050 If set to B<true>, matching metrics are I<ignored> and all other metrics are
12051 collected. If set to B<false>, matching metrics are I<collected> and all other
12052 metrics are ignored.
12059 L<collectd-exec(5)>,
12060 L<collectd-perl(5)>,
12061 L<collectd-unixsock(5)>,
12074 Florian Forster E<lt>octo@collectd.orgE<gt>