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<check_uptime>
1553 The I<check_uptime plugin> designed to check and notify about host or service
1554 status based on I<uptime> metric.
1556 When new metric of I<uptime> type appears in cache, OK notification is sent.
1557 When new value for metric is less than previous value, WARNING notification is
1558 sent about host/service restart.
1559 When no new updates comes for metric and cache entry expires, then FAILURE
1560 notification is sent about unreachable host or service.
1562 By default (when no explicit configuration), plugin checks for I<uptime> metric.
1566 <Plugin "check_uptime">
1568 Type "my_uptime_type"
1573 =item B<Type> I<Type>
1575 Metric type to check for status/values. The type should consist single GAUGE
1580 =head2 Plugin C<chrony>
1582 The C<chrony> plugin collects ntp data from a B<chronyd> server, such as clock
1583 skew and per-peer stratum.
1585 For talking to B<chronyd>, it mimics what the B<chronyc> control program does
1588 Available configuration options for the C<chrony> plugin:
1592 =item B<Host> I<Hostname>
1594 Hostname of the host running B<chronyd>. Defaults to B<localhost>.
1596 =item B<Port> I<Port>
1598 UDP-Port to connect to. Defaults to B<323>.
1600 =item B<Timeout> I<Timeout>
1602 Connection timeout in seconds. Defaults to B<2>.
1606 =head2 Plugin C<conntrack>
1608 This plugin collects IP conntrack statistics.
1614 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1615 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1619 =head2 Plugin C<cpu>
1621 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1622 as Jiffies, using the C<cpu> type. Two aggregations are available:
1628 Sum, per-state, over all CPUs installed in the system; and
1632 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1636 The two aggregations can be combined, leading to I<collectd> only emitting a
1637 single "active" metric for the entire system. As soon as one of these
1638 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1639 rather than Jiffies. In addition, you can request individual, per-state,
1640 per-CPU metrics to be reported as percentage.
1642 The following configuration options are available:
1646 =item B<ReportByState> B<true>|B<false>
1648 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1650 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1653 =item B<ReportByCpu> B<true>|B<false>
1655 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1656 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1657 global sum of CPU states is emitted.
1659 =item B<ValuesPercentage> B<false>|B<true>
1661 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1662 are set to B<true>. In this case, by default, metrics will be reported as
1663 Jiffies. By setting this option to B<true>, you can request percentage values
1664 in the un-aggregated (per-CPU, per-state) mode as well.
1666 =item B<ReportNumCpu> B<false>|B<true>
1668 When set to B<true>, reports the number of available CPUs.
1669 Defaults to B<false>.
1671 =item B<ReportGuestState> B<false>|B<true>
1673 When set to B<true>, reports the "guest" and "guest_nice" CPU states.
1674 Defaults to B<false>.
1676 =item B<SubtractGuestState> B<false>|B<true>
1678 This option is only considered when B<ReportGuestState> is set to B<true>.
1679 "guest" and "guest_nice" are included in respectively "user" and "nice".
1680 If set to B<true>, "guest" will be subtracted from "user" and "guest_nice"
1681 will be subtracted from "nice".
1682 Defaults to B<true>.
1686 =head2 Plugin C<cpufreq>
1688 This plugin is available on Linux and FreeBSD only. It doesn't have any
1689 options. On Linux it reads
1690 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1691 installed) to get the current CPU frequency. If this file does not exist make
1692 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1693 installed and an "cpu governor" (that's a kernel module) is loaded.
1695 On Linux, if the system has the I<cpufreq-stats> kernel module loaded, this
1696 plugin reports the rate of p-state (cpu frequency) transitions and the
1697 percentage of time spent in each p-state.
1699 On FreeBSD it does a sysctl dev.cpu.0.freq and submits this as instance 0.
1700 At this time FreeBSD only has one frequency setting for all cores.
1701 See the BUGS section in the FreeBSD man page for cpufreq(4) for more details.
1703 On FreeBSD the plugin checks the success of sysctl dev.cpu.0.freq and
1704 unregisters the plugin when this fails. A message will be logged to indicate
1707 =head2 Plugin C<cpusleep>
1709 This plugin doesn't have any options. It reads CLOCK_BOOTTIME and
1710 CLOCK_MONOTONIC and reports the difference between these clocks. Since
1711 BOOTTIME clock increments while device is suspended and MONOTONIC
1712 clock does not, the derivative of the difference between these clocks
1713 gives the relative amount of time the device has spent in suspend
1714 state. The recorded value is in milliseconds of sleep per seconds of
1717 =head2 Plugin C<csv>
1721 =item B<DataDir> I<Directory>
1723 Set the directory to store CSV-files under. Per default CSV-files are generated
1724 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1725 The special strings B<stdout> and B<stderr> can be used to write to the standard
1726 output and standard error channels, respectively. This, of course, only makes
1727 much sense when collectd is running in foreground- or non-daemon-mode.
1729 =item B<StoreRates> B<true|false>
1731 If set to B<true>, convert counter values to rates. If set to B<false> (the
1732 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1737 =head2 cURL Statistics
1739 All cURL-based plugins support collection of generic, request-based
1740 statistics. These are disabled by default and can be enabled selectively for
1741 each page or URL queried from the curl, curl_json, or curl_xml plugins. See
1742 the documentation of those plugins for specific information. This section
1743 describes the available metrics that can be configured for each plugin. All
1744 options are disabled by default.
1746 See L<http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html> for more details.
1750 =item B<TotalTime> B<true|false>
1752 Total time of the transfer, including name resolving, TCP connect, etc.
1754 =item B<NamelookupTime> B<true|false>
1756 Time it took from the start until name resolving was completed.
1758 =item B<ConnectTime> B<true|false>
1760 Time it took from the start until the connect to the remote host (or proxy)
1763 =item B<AppconnectTime> B<true|false>
1765 Time it took from the start until the SSL/SSH connect/handshake to the remote
1768 =item B<PretransferTime> B<true|false>
1770 Time it took from the start until just before the transfer begins.
1772 =item B<StarttransferTime> B<true|false>
1774 Time it took from the start until the first byte was received.
1776 =item B<RedirectTime> B<true|false>
1778 Time it took for all redirection steps include name lookup, connect,
1779 pre-transfer and transfer before final transaction was started.
1781 =item B<RedirectCount> B<true|false>
1783 The total number of redirections that were actually followed.
1785 =item B<SizeUpload> B<true|false>
1787 The total amount of bytes that were uploaded.
1789 =item B<SizeDownload> B<true|false>
1791 The total amount of bytes that were downloaded.
1793 =item B<SpeedDownload> B<true|false>
1795 The average download speed that curl measured for the complete download.
1797 =item B<SpeedUpload> B<true|false>
1799 The average upload speed that curl measured for the complete upload.
1801 =item B<HeaderSize> B<true|false>
1803 The total size of all the headers received.
1805 =item B<RequestSize> B<true|false>
1807 The total size of the issued requests.
1809 =item B<ContentLengthDownload> B<true|false>
1811 The content-length of the download.
1813 =item B<ContentLengthUpload> B<true|false>
1815 The specified size of the upload.
1817 =item B<NumConnects> B<true|false>
1819 The number of new connections that were created to achieve the transfer.
1823 =head2 Plugin C<curl>
1825 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1826 and the match infrastructure (the same code used by the tail plugin) to use
1827 regular expressions with the received data.
1829 The following example will read the current value of AMD stock from Google's
1830 finance page and dispatch the value to collectd.
1833 <Page "stock_quotes">
1835 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1842 CACert "/path/to/ca.crt"
1843 Header "X-Custom-Header: foobar"
1846 MeasureResponseTime false
1847 MeasureResponseCode false
1850 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1851 DSType "GaugeAverage"
1852 # Note: `stock_value' is not a standard type.
1859 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1860 a web page and one or more "matches" to be performed on the returned data. The
1861 string argument to the B<Page> block is used as plugin instance.
1863 The following options are valid within B<Page> blocks:
1867 =item B<Plugin> I<Plugin>
1869 Use I<Plugin> as the plugin name when submitting values.
1870 Defaults to C<curl>.
1874 URL of the web site to retrieve. Since a regular expression will be used to
1875 extract information from this data, non-binary data is a big plus here ;)
1877 =item B<AddressFamily> I<Type>
1879 IP version to resolve URL to. Useful in cases when hostname in URL resolves
1880 to both IPv4 and IPv6 addresses, and you are interested in using one of them
1882 Use C<ipv4> to enforce IPv4, C<ipv6> to enforce IPv6, or C<any> to keep the
1883 default behavior of resolving addresses to all IP versions your system allows.
1884 If C<libcurl> is compiled without IPv6 support, using C<ipv6> will result in
1885 a warning and fallback to C<any>.
1886 If C<Type> cannot be parsed, a warning will be printed and the whole B<Page>
1887 block will be ignored.
1889 =item B<User> I<Name>
1891 Username to use if authorization is required to read the page.
1893 =item B<Password> I<Password>
1895 Password to use if authorization is required to read the page.
1897 =item B<Digest> B<true>|B<false>
1899 Enable HTTP digest authentication.
1901 =item B<VerifyPeer> B<true>|B<false>
1903 Enable or disable peer SSL certificate verification. See
1904 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1906 =item B<VerifyHost> B<true>|B<false>
1908 Enable or disable peer host name verification. If enabled, the plugin checks if
1909 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1910 matches the host name provided by the B<URL> option. If this identity check
1911 fails, the connection is aborted. Obviously, only works when connecting to a
1912 SSL enabled server. Enabled by default.
1914 =item B<CACert> I<file>
1916 File that holds one or more SSL certificates. If you want to use HTTPS you will
1917 possibly need this option. What CA certificates come bundled with C<libcurl>
1918 and are checked by default depends on the distribution you use.
1920 =item B<Header> I<Header>
1922 A HTTP header to add to the request. Multiple headers are added if this option
1923 is specified more than once.
1925 =item B<Post> I<Body>
1927 Specifies that the HTTP operation should be a POST instead of a GET. The
1928 complete data to be posted is given as the argument. This option will usually
1929 need to be accompanied by a B<Header> option to set an appropriate
1930 C<Content-Type> for the post body (e.g. to
1931 C<application/x-www-form-urlencoded>).
1933 =item B<MeasureResponseTime> B<true>|B<false>
1935 Measure response time for the request. If this setting is enabled, B<Match>
1936 blocks (see below) are optional. Disabled by default.
1938 Beware that requests will get aborted if they take too long to complete. Adjust
1939 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1942 This option is similar to enabling the B<TotalTime> statistic but it's
1943 measured by collectd instead of cURL.
1945 =item B<MeasureResponseCode> B<true>|B<false>
1947 Measure response code for the request. If this setting is enabled, B<Match>
1948 blocks (see below) are optional. Disabled by default.
1950 =item B<E<lt>StatisticsE<gt>>
1952 One B<Statistics> block can be used to specify cURL statistics to be collected
1953 for each request to the remote web site. See the section "cURL Statistics"
1954 above for details. If this setting is enabled, B<Match> blocks (see below) are
1957 =item B<E<lt>MatchE<gt>>
1959 One or more B<Match> blocks that define how to match information in the data
1960 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1961 used by the C<tail> plugin, so please see the documentation of the C<tail>
1962 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1963 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1966 =item B<Interval> I<Interval>
1968 Sets the interval (in seconds) in which the values will be collected from this
1969 URL. By default the global B<Interval> setting will be used.
1971 =item B<Timeout> I<Milliseconds>
1973 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1974 milliseconds. By default, the configured B<Interval> is used to set the
1975 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1976 indefinitely. This legacy behaviour can be achieved by setting the value of
1979 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1980 network connection will stall one read thread. Adjust the B<ReadThreads> global
1981 setting accordingly to prevent this from blocking other plugins.
1985 =head2 Plugin C<curl_json>
1987 The B<curl_json plugin> collects values from JSON data to be parsed by
1988 B<libyajl> (L<https://lloyd.github.io/yajl/>) retrieved via
1989 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1990 unix socket. The former can be used, for example, to collect values
1991 from CouchDB documents (which are stored JSON notation), and the
1992 latter to collect values from a uWSGI stats socket.
1994 The following example will collect several values from the built-in
1995 C<_stats> runtime statistics module of I<CouchDB>
1996 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1999 <URL "http://localhost:5984/_stats">
2002 <Key "httpd/requests/count">
2003 Type "http_requests"
2006 <Key "httpd_request_methods/*/count">
2007 Type "http_request_methods"
2010 <Key "httpd_status_codes/*/count">
2011 Type "http_response_codes"
2016 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
2019 <Sock "/var/run/uwsgi.stats.sock">
2021 <Key "workers/*/requests">
2022 Type "http_requests"
2025 <Key "workers/*/apps/*/requests">
2026 Type "http_requests"
2031 In the B<Plugin> block, there may be one or more B<URL> blocks, each
2032 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
2033 blocks defining a unix socket to read JSON from directly. Each of
2034 these blocks may have one or more B<Key> blocks.
2036 The B<Key> string argument must be in a path format. Each component is
2037 used to match the key from a JSON map or the index of an JSON
2038 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
2039 values for all map keys or array indices will be collectd.
2041 The following options are valid within B<URL> blocks:
2045 =item B<AddressFamily> I<Type>
2047 IP version to resolve URL to. Useful in cases when hostname in URL resolves
2048 to both IPv4 and IPv6 addresses, and you are interested in using one of them
2050 Use C<ipv4> to enforce IPv4, C<ipv6> to enforce IPv6, or C<any> to keep the
2051 default behavior of resolving addresses to all IP versions your system allows.
2052 If C<libcurl> is compiled without IPv6 support, using C<ipv6> will result in
2053 a warning and fallback to C<any>.
2054 If C<Type> cannot be parsed, a warning will be printed and the whole B<URL>
2055 block will be ignored.
2057 =item B<Host> I<Name>
2059 Use I<Name> as the host name when submitting values. Defaults to the global
2062 =item B<Plugin> I<Plugin>
2064 Use I<Plugin> as the plugin name when submitting values.
2065 Defaults to C<curl_json>.
2067 =item B<Instance> I<Instance>
2069 Sets the plugin instance to I<Instance>.
2071 =item B<Interval> I<Interval>
2073 Sets the interval (in seconds) in which the values will be collected from this
2074 URL. By default the global B<Interval> setting will be used.
2076 =item B<User> I<Name>
2078 =item B<Password> I<Password>
2080 =item B<Digest> B<true>|B<false>
2082 =item B<VerifyPeer> B<true>|B<false>
2084 =item B<VerifyHost> B<true>|B<false>
2086 =item B<CACert> I<file>
2088 =item B<Header> I<Header>
2090 =item B<Post> I<Body>
2092 =item B<Timeout> I<Milliseconds>
2094 These options behave exactly equivalent to the appropriate options of the
2095 I<cURL> plugin. Please see there for a detailed description.
2097 =item B<E<lt>StatisticsE<gt>>
2099 One B<Statistics> block can be used to specify cURL statistics to be collected
2100 for each request to the remote URL. See the section "cURL Statistics" above
2105 The following options are valid within B<Key> blocks:
2109 =item B<Type> I<Type>
2111 Sets the type used to dispatch the values to the daemon. Detailed information
2112 about types and their configuration can be found in L<types.db(5)>. This
2113 option is mandatory.
2115 =item B<Instance> I<Instance>
2117 Type-instance to use. Defaults to the current map key or current string array element value.
2121 =head2 Plugin C<curl_xml>
2123 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
2124 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
2127 <URL "http://localhost/stats.xml">
2131 Instance "some_instance"
2136 CACert "/path/to/ca.crt"
2137 Header "X-Custom-Header: foobar"
2140 <XPath "table[@id=\"magic_level\"]/tr">
2142 #InstancePrefix "prefix-"
2143 InstanceFrom "td[1]"
2144 #PluginInstanceFrom "td[1]"
2145 ValuesFrom "td[2]/span[@class=\"level\"]"
2150 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
2151 URL to be fetched using libcurl. Within each B<URL> block there are
2152 options which specify the connection parameters, for example authentication
2153 information, and one or more B<XPath> blocks.
2155 Each B<XPath> block specifies how to get one type of information. The
2156 string argument must be a valid XPath expression which returns a list
2157 of "base elements". One value is dispatched for each "base element". The
2158 I<type instance> and values are looked up using further I<XPath> expressions
2159 that should be relative to the base element.
2161 Within the B<URL> block the following options are accepted:
2165 =item B<AddressFamily> I<Type>
2167 IP version to resolve URL to. Useful in cases when hostname in URL resolves
2168 to both IPv4 and IPv6 addresses, and you are interested in using one of them
2170 Use C<ipv4> to enforce IPv4, C<ipv6> to enforce IPv6, or C<any> to keep the
2171 default behavior of resolving addresses to all IP versions your system allows.
2172 If C<libcurl> is compiled without IPv6 support, using C<ipv6> will result in
2173 a warning and fallback to C<any>.
2174 If C<Type> cannot be parsed, a warning will be printed and the whole B<URL>
2175 block will be ignored.
2177 =item B<Host> I<Name>
2179 Use I<Name> as the host name when submitting values. Defaults to the global
2182 =item B<Plugin> I<Plugin>
2184 Use I<Plugin> as the plugin name when submitting values.
2185 Defaults to 'curl_xml'.
2187 =item B<Instance> I<Instance>
2189 Use I<Instance> as the plugin instance when submitting values.
2190 May be overridden by B<PluginInstanceFrom> option inside B<XPath> blocks.
2191 Defaults to an empty string (no plugin instance).
2193 =item B<Interval> I<Interval>
2195 Sets the interval (in seconds) in which the values will be collected from this
2196 URL. By default the global B<Interval> setting will be used.
2198 =item B<Namespace> I<Prefix> I<URL>
2200 If an XPath expression references namespaces, they must be specified
2201 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
2202 I<URL> is the "namespace name", an URI reference uniquely identifying the
2203 namespace. The option can be repeated to register multiple namespaces.
2207 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
2208 Namespace "m" "http://www.w3.org/1998/Math/MathML"
2210 =item B<User> I<User>
2212 =item B<Password> I<Password>
2214 =item B<Digest> B<true>|B<false>
2216 =item B<VerifyPeer> B<true>|B<false>
2218 =item B<VerifyHost> B<true>|B<false>
2220 =item B<CACert> I<CA Cert File>
2222 =item B<Header> I<Header>
2224 =item B<Post> I<Body>
2226 =item B<Timeout> I<Milliseconds>
2228 These options behave exactly equivalent to the appropriate options of the
2229 I<cURL plugin>. Please see there for a detailed description.
2231 =item B<E<lt>StatisticsE<gt>>
2233 One B<Statistics> block can be used to specify cURL statistics to be collected
2234 for each request to the remote URL. See the section "cURL Statistics" above
2237 =item E<lt>B<XPath> I<XPath-expression>E<gt>
2239 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
2240 B<XPath> block specifies how to get one type of information. The string
2241 argument must be a valid XPath expression which returns a list of "base
2242 elements". One value is dispatched for each "base element".
2244 Within the B<XPath> block the following options are accepted:
2248 =item B<Type> I<Type>
2250 Specifies the I<Type> used for submitting patches. This determines the number
2251 of values that are required / expected and whether the strings are parsed as
2252 signed or unsigned integer or as double values. See L<types.db(5)> for details.
2253 This option is required.
2255 =item B<InstancePrefix> I<InstancePrefix>
2257 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
2258 concatenated together without any separator.
2259 This option is optional.
2261 =item B<InstanceFrom> I<InstanceFrom>
2263 Specifies a XPath expression to use for determining the I<type instance>. The
2264 XPath expression must return exactly one element. The element's value is then
2265 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
2267 =item B<PluginInstanceFrom> I<PluginInstanceFrom>
2269 Specifies a XPath expression to use for determining the I<plugin instance>. The
2270 XPath expression must return exactly one element. The element's value is then
2271 used as I<plugin instance>.
2275 If the "base XPath expression" (the argument to the B<XPath> block) returns
2276 exactly one argument, then I<InstanceFrom> and I<PluginInstanceFrom> may be omitted.
2277 Otherwise, at least one of I<InstanceFrom> or I<PluginInstanceFrom> is required.
2281 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
2283 Specifies one or more XPath expression to use for reading the values. The
2284 number of XPath expressions must match the number of data sources in the
2285 I<type> specified with B<Type> (see above). Each XPath expression must return
2286 exactly one element. The element's value is then parsed as a number and used as
2287 value for the appropriate value in the value list dispatched to the daemon.
2288 This option is required.
2294 =head2 Plugin C<dbi>
2296 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
2297 connect to various databases, execute I<SQL> statements and read back the
2298 results. I<dbi> is an acronym for "database interface" in case you were
2299 wondering about the name. You can configure how each column is to be
2300 interpreted and the plugin will generate one or more data sets from each row
2301 returned according to these rules.
2303 Because the plugin is very generic, the configuration is a little more complex
2304 than those of other plugins. It usually looks something like this:
2307 <Query "out_of_stock">
2308 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
2309 # Use with MySQL 5.0.0 or later
2313 InstancePrefix "out_of_stock"
2314 InstancesFrom "category"
2318 <Database "product_information">
2322 DriverOption "host" "localhost"
2323 DriverOption "username" "collectd"
2324 DriverOption "password" "aZo6daiw"
2325 DriverOption "dbname" "prod_info"
2326 SelectDB "prod_info"
2327 Query "out_of_stock"
2331 The configuration above defines one query with one result and one database. The
2332 query is then linked to the database with the B<Query> option I<within> the
2333 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
2334 and you can also use the B<Include> statement to split up the configuration
2335 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
2336 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
2339 The following is a complete list of options:
2341 =head3 B<Query> blocks
2343 Query blocks define I<SQL> statements and how the returned data should be
2344 interpreted. They are identified by the name that is given in the opening line
2345 of the block. Thus the name needs to be unique. Other than that, the name is
2346 not used in collectd.
2348 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
2349 define which column holds which value or instance information. You can use
2350 multiple B<Result> blocks to create multiple values from one returned row. This
2351 is especially useful, when queries take a long time and sending almost the same
2352 query again and again is not desirable.
2356 <Query "environment">
2357 Statement "select station, temperature, humidity from environment"
2360 # InstancePrefix "foo"
2361 InstancesFrom "station"
2362 ValuesFrom "temperature"
2366 InstancesFrom "station"
2367 ValuesFrom "humidity"
2371 The following options are accepted:
2375 =item B<Statement> I<SQL>
2377 Sets the statement that should be executed on the server. This is B<not>
2378 interpreted by collectd, but simply passed to the database server. Therefore,
2379 the SQL dialect that's used depends on the server collectd is connected to.
2381 The query has to return at least two columns, one for the instance and one
2382 value. You cannot omit the instance, even if the statement is guaranteed to
2383 always return exactly one line. In that case, you can usually specify something
2386 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
2388 (That works with MySQL but may not be valid SQL according to the spec. If you
2389 use a more strict database server, you may have to select from a dummy table or
2392 Please note that some databases, for example B<Oracle>, will fail if you
2393 include a semicolon at the end of the statement.
2395 =item B<MinVersion> I<Version>
2397 =item B<MaxVersion> I<Value>
2399 Only use this query for the specified database version. You can use these
2400 options to provide multiple queries with the same name but with a slightly
2401 different syntax. The plugin will use only those queries, where the specified
2402 minimum and maximum versions fit the version of the database in use.
2404 The database version is determined by C<dbi_conn_get_engine_version>, see the
2405 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
2406 for details. Basically, each part of the version is assumed to be in the range
2407 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
2408 "40102", version "5.0.42" becomes "50042".
2410 B<Warning:> The plugin will use B<all> matching queries, so if you specify
2411 multiple queries with the same name and B<overlapping> ranges, weird stuff will
2412 happen. Don't to it! A valid example would be something along these lines:
2423 In the above example, there are three ranges that don't overlap. The last one
2424 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
2425 before "4.0.0" are not specified.
2427 =item B<Type> I<Type>
2429 The B<type> that's used for each line returned. See L<types.db(5)> for more
2430 details on how types are defined. In short: A type is a predefined layout of
2431 data and the number of values and type of values has to match the type
2434 If you specify "temperature" here, you need exactly one gauge column. If you
2435 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
2438 There must be exactly one B<Type> option inside each B<Result> block.
2440 =item B<InstancePrefix> I<prefix>
2442 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
2443 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
2444 all strings returned in the appropriate columns are concatenated together,
2445 separated by dashes I<("-")>.
2447 =item B<InstancesFrom> I<column0> [I<column1> ...]
2449 Specifies the columns whose values will be used to create the "type-instance"
2450 for each row. If you specify more than one column, the value of all columns
2451 will be joined together with dashes I<("-")> as separation characters.
2453 The plugin itself does not check whether or not all built instances are
2454 different. It's your responsibility to assure that each is unique. This is
2455 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
2456 sure that only one row is returned in this case.
2458 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
2461 =item B<ValuesFrom> I<column0> [I<column1> ...]
2463 Names the columns whose content is used as the actual data for the data sets
2464 that are dispatched to the daemon. How many such columns you need is determined
2465 by the B<Type> setting above. If you specify too many or not enough columns,
2466 the plugin will complain about that and no data will be submitted to the
2469 The actual data type in the columns is not that important. The plugin will
2470 automatically cast the values to the right type if it know how to do that. So
2471 it should be able to handle integer an floating point types, as well as strings
2472 (if they include a number at the beginning).
2474 There must be at least one B<ValuesFrom> option inside each B<Result> block.
2476 =item B<MetadataFrom> [I<column0> I<column1> ...]
2478 Names the columns whose content is used as metadata for the data sets
2479 that are dispatched to the daemon.
2481 The actual data type in the columns is not that important. The plugin will
2482 automatically cast the values to the right type if it know how to do that. So
2483 it should be able to handle integer an floating point types, as well as strings
2484 (if they include a number at the beginning).
2488 =head3 B<Database> blocks
2490 Database blocks define a connection to a database and which queries should be
2491 sent to that database. Since the used "dbi" library can handle a wide variety
2492 of databases, the configuration is very generic. If in doubt, refer to libdbi's
2493 documentationE<nbsp>- we stick as close to the terminology used there.
2495 Each database needs a "name" as string argument in the starting tag of the
2496 block. This name will be used as "PluginInstance" in the values submitted to
2497 the daemon. Other than that, that name is not used.
2501 =item B<Plugin> I<Plugin>
2503 Use I<Plugin> as the plugin name when submitting query results from
2504 this B<Database>. Defaults to C<dbi>.
2506 =item B<Interval> I<Interval>
2508 Sets the interval (in seconds) in which the values will be collected from this
2509 database. By default the global B<Interval> setting will be used.
2511 =item B<Driver> I<Driver>
2513 Specifies the driver to use to connect to the database. In many cases those
2514 drivers are named after the database they can connect to, but this is not a
2515 technical necessity. These drivers are sometimes referred to as "DBD",
2516 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2517 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2518 project at L<http://libdbi-drivers.sourceforge.net/>.
2520 You need to give the driver name as expected by the "dbi" library here. You
2521 should be able to find that in the documentation for each driver. If you
2522 mistype the driver name, the plugin will dump a list of all known driver names
2525 =item B<DriverOption> I<Key> I<Value>
2527 Sets driver-specific options. What option a driver supports can be found in the
2528 documentation for each driver, somewhere at
2529 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2530 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2532 DBDs can register two types of options: String options and numeric options. The
2533 plugin will use the C<dbi_conn_set_option> function when the configuration
2534 provides a string and the C<dbi_conn_require_option_numeric> function when the
2535 configuration provides a number. So these two lines will actually result in
2536 different calls being used:
2538 DriverOption "Port" 1234 # numeric
2539 DriverOption "Port" "1234" # string
2541 Unfortunately, drivers are not too keen to report errors when an unknown option
2542 is passed to them, so invalid settings here may go unnoticed. This is not the
2543 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2544 the driver. If a driver complains about an option, the plugin will dump a
2545 complete list of all options understood by that driver to the log. There is no
2546 way to programmatically find out if an option expects a string or a numeric
2547 argument, so you will have to refer to the appropriate DBD's documentation to
2548 find this out. Sorry.
2550 =item B<SelectDB> I<Database>
2552 In some cases, the database name you connect with is not the database name you
2553 want to use for querying data. If this option is set, the plugin will "select"
2554 (switch to) that database after the connection is established.
2556 =item B<Query> I<QueryName>
2558 Associates the query named I<QueryName> with this database connection. The
2559 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2560 blocks you want to refer to must be placed above the database block you want to
2563 =item B<Host> I<Hostname>
2565 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2566 values. Defaults to the global hostname setting.
2574 =item B<Device> I<Device>
2576 Select partitions based on the devicename.
2578 See F</"IGNORELISTS"> for details.
2580 =item B<MountPoint> I<Directory>
2582 Select partitions based on the mountpoint.
2584 See F</"IGNORELISTS"> for details.
2586 =item B<FSType> I<FSType>
2588 Select partitions based on the filesystem type.
2590 See F</"IGNORELISTS"> for details.
2592 =item B<IgnoreSelected> B<true>|B<false>
2594 Invert the selection: If set to true, all partitions B<except> the ones that
2595 match any one of the criteria are collected. By default only selected
2596 partitions are collected if a selection is made. If no selection is configured
2597 at all, B<all> partitions are selected.
2599 =item B<ReportByDevice> B<true>|B<false>
2601 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2602 (the default), it will report a disk as "root", but with it I<true>, it will be
2603 "sda1" (or whichever).
2605 =item B<ReportInodes> B<true>|B<false>
2607 Enables or disables reporting of free, reserved and used inodes. Defaults to
2608 inode collection being disabled.
2610 Enable this option if inodes are a scarce resource for you, usually because
2611 many small files are stored on the disk. This is a usual scenario for mail
2612 transfer agents and web caches.
2614 =item B<ValuesAbsolute> B<true>|B<false>
2616 Enables or disables reporting of free and used disk space in 1K-blocks.
2617 Defaults to B<true>.
2619 =item B<ValuesPercentage> B<false>|B<true>
2621 Enables or disables reporting of free and used disk space in percentage.
2622 Defaults to B<false>.
2624 This is useful for deploying I<collectd> on the cloud, where machines with
2625 different disk size may exist. Then it is more practical to configure
2626 thresholds based on relative disk size.
2630 =head2 Plugin C<disk>
2632 The C<disk> plugin collects information about the usage of physical disks and
2633 logical disks (partitions). Values collected are the number of octets written
2634 to and read from a disk or partition, the number of read/write operations
2635 issued to the disk and a rather complex "time" it took for these commands to be
2638 Using the following two options you can ignore some disks or configure the
2639 collection only of specific disks.
2643 =item B<Disk> I<Name>
2645 Select the disk I<Name>. Whether it is collected or ignored depends on the
2646 B<IgnoreSelected> setting, see below. As with other plugins that use the
2647 daemon's ignorelist functionality, a string that starts and ends with a slash
2648 is interpreted as a regular expression. Examples:
2653 See F</"IGNORELISTS"> for details.
2655 =item B<IgnoreSelected> B<true>|B<false>
2657 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2658 statements, are ignored or if all other disks are ignored. The behavior
2659 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2660 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2661 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2662 is set to B<true>, all disks are collected B<except> the ones matched.
2664 =item B<UseBSDName> B<true>|B<false>
2666 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2667 default major/minor numbers. Requires collectd to be built with Apple's
2670 =item B<UdevNameAttr> I<Attribute>
2672 Attempt to override disk instance name with the value of a specified udev
2673 attribute when built with B<libudev>. If the attribute is not defined for the
2674 given device, the default name is used. Example:
2676 UdevNameAttr "DM_NAME"
2680 =head2 Plugin C<dns>
2684 =item B<Interface> I<Interface>
2686 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2687 option sets the interface that should be used. If this option is not set, or
2688 set to "any", the plugin will try to get packets from B<all> interfaces. This
2689 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2691 =item B<IgnoreSource> I<IP-address>
2693 Ignore packets that originate from this address.
2695 =item B<SelectNumericQueryTypes> B<true>|B<false>
2697 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2701 =head2 Plugin C<dpdkevents>
2703 The I<dpdkevents plugin> collects events from DPDK such as link status of
2704 network ports and Keep Alive status of DPDK logical cores.
2705 In order to get Keep Alive events following requirements must be met:
2707 - support for Keep Alive implemented in DPDK application. More details can
2708 be found here: http://dpdk.org/doc/guides/sample_app_ug/keep_alive.html
2712 <Plugin "dpdkevents">
2718 <Event "link_status">
2719 SendEventsOnUpdate true
2720 EnabledPortMask 0xffff
2721 PortName "interface1"
2722 PortName "interface2"
2723 SendNotification false
2725 <Event "keep_alive">
2726 SendEventsOnUpdate true
2728 KeepAliveShmName "/dpdk_keepalive_shm_name"
2729 SendNotification false
2736 =head3 The EAL block
2740 =item B<Coremask> I<Mask>
2742 =item B<Memorychannels> I<Channels>
2744 Number of memory channels per processor socket.
2746 =item B<FilePrefix> I<File>
2748 The prefix text used for hugepage filenames. The filename will be set to
2749 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2753 =head3 The Event block
2755 The B<Event> block defines configuration for specific event. It accepts a
2756 single argument which specifies the name of the event.
2758 =head4 Link Status event
2762 =item B<SendEventOnUpdate> I<true|false>
2764 If set to true link status value will be dispatched only when it is
2765 different from previously read value. This is an optional argument - default
2768 =item B<EnabledPortMask> I<Mask>
2770 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2771 of 0x0 means that all ports will be disabled. A bitmask of all F's means
2772 that all ports will be enabled. This is an optional argument - by default
2773 all ports are enabled.
2775 =item B<PortName> I<Name>
2777 A string containing an optional name for the enabled DPDK ports. Each PortName
2778 option should contain only one port name; specify as many PortName options as
2779 desired. Default naming convention will be used if PortName is blank. If there
2780 are less PortName options than there are enabled ports, the default naming
2781 convention will be used for the additional ports.
2783 =item B<SendNotification> I<true|false>
2785 If set to true, link status notifications are sent, instead of link status
2786 being collected as a statistic. This is an optional argument - default
2791 =head4 Keep Alive event
2795 =item B<SendEventOnUpdate> I<true|false>
2797 If set to true keep alive value will be dispatched only when it is
2798 different from previously read value. This is an optional argument - default
2801 =item B<LCoreMask> I<Mask>
2803 An hexadecimal bit mask of the logical cores to monitor keep alive state.
2805 =item B<KeepAliveShmName> I<Name>
2807 Shared memory name identifier that is used by secondary process to monitor
2808 the keep alive cores state.
2810 =item B<SendNotification> I<true|false>
2812 If set to true, keep alive notifications are sent, instead of keep alive
2813 information being collected as a statistic. This is an optional
2814 argument - default value is false.
2818 =head2 Plugin C<dpdkstat>
2820 The I<dpdkstat plugin> collects information about DPDK interfaces using the
2821 extended NIC stats API in DPDK.
2832 RteDriverLibPath "/usr/lib/dpdk-pmd"
2834 SharedMemObj "dpdk_collectd_stats_0"
2835 EnabledPortMask 0xffff
2836 PortName "interface1"
2837 PortName "interface2"
2842 =head3 The EAL block
2846 =item B<Coremask> I<Mask>
2848 A string containing an hexadecimal bit mask of the cores to run on. Note that
2849 core numbering can change between platforms and should be determined beforehand.
2851 =item B<Memorychannels> I<Channels>
2853 A string containing a number of memory channels per processor socket.
2855 =item B<FilePrefix> I<File>
2857 The prefix text used for hugepage filenames. The filename will be set to
2858 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2860 =item B<SocketMemory> I<MB>
2862 A string containing amount of Memory to allocate from hugepages on specific
2863 sockets in MB. This is an optional value.
2865 =item B<LogLevel> I<LogLevel_number>
2867 A string containing log level number. This parameter is optional.
2868 If parameter is not present then default value "7" - (INFO) is used.
2869 Value "8" - (DEBUG) can be set to enable debug traces.
2871 =item B<RteDriverLibPath> I<Path>
2873 A string containing path to shared pmd driver lib or path to directory,
2874 where shared pmd driver libs are available. This parameter is optional.
2875 This parameter enable loading of shared pmd driver libs from defined path.
2876 E.g.: "/usr/lib/dpdk-pmd/librte_pmd_i40e.so"
2877 or "/usr/lib/dpdk-pmd"
2883 =item B<SharedMemObj> I<Mask>
2885 A string containing the name of the shared memory object that should be used to
2886 share stats from the DPDK secondary process to the collectd dpdkstat plugin.
2887 Defaults to dpdk_collectd_stats if no other value is configured.
2889 =item B<EnabledPortMask> I<Mask>
2891 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2892 of 0x0 means that all ports will be disabled. A bitmask of all Fs means
2893 that all ports will be enabled. This is an optional argument - default
2894 is all ports enabled.
2896 =item B<PortName> I<Name>
2898 A string containing an optional name for the enabled DPDK ports. Each PortName
2899 option should contain only one port name; specify as many PortName options as
2900 desired. Default naming convention will be used if PortName is blank. If there
2901 are less PortName options than there are enabled ports, the default naming
2902 convention will be used for the additional ports.
2906 =head2 Plugin C<email>
2910 =item B<SocketFile> I<Path>
2912 Sets the socket-file which is to be created.
2914 =item B<SocketGroup> I<Group>
2916 If running as root change the group of the UNIX-socket after it has been
2917 created. Defaults to B<collectd>.
2919 =item B<SocketPerms> I<Permissions>
2921 Change the file permissions of the UNIX-socket after it has been created. The
2922 permissions must be given as a numeric, octal value as you would pass to
2923 L<chmod(1)>. Defaults to B<0770>.
2925 =item B<MaxConns> I<Number>
2927 Sets the maximum number of connections that can be handled in parallel. Since
2928 this many threads will be started immediately setting this to a very high
2929 value will waste valuable resources. Defaults to B<5> and will be forced to be
2930 at most B<16384> to prevent typos and dumb mistakes.
2934 =head2 Plugin C<ethstat>
2936 The I<ethstat plugin> collects information about network interface cards (NICs)
2937 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2943 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2944 Map "multicast" "if_multicast"
2951 =item B<Interface> I<Name>
2953 Collect statistical information about interface I<Name>.
2955 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2957 By default, the plugin will submit values as type C<derive> and I<type
2958 instance> set to I<Name>, the name of the metric as reported by the driver. If
2959 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2960 I<TypeInstance> will be used.
2962 =item B<MappedOnly> B<true>|B<false>
2964 When set to B<true>, only metrics that can be mapped to a I<type> will be
2965 collected, all other metrics will be ignored. Defaults to B<false>.
2969 =head2 Plugin C<exec>
2971 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2972 contains valuable information on when the executable is executed and the
2973 output that is expected from it.
2977 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2979 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2981 Execute the executable I<Executable> as user I<User>. If the user name is
2982 followed by a colon and a group name, the effective group is set to that group.
2983 The real group and saved-set group will be set to the default group of that
2984 user. If no group is given the effective group ID will be the same as the real
2987 Please note that in order to change the user and/or group the daemon needs
2988 superuser privileges. If the daemon is run as an unprivileged user you must
2989 specify the same user/group here. If the daemon is run with superuser
2990 privileges, you must supply a non-root user here.
2992 The executable may be followed by optional arguments that are passed to the
2993 program. Please note that due to the configuration parsing numbers and boolean
2994 values may be changed. If you want to be absolutely sure that something is
2995 passed as-is please enclose it in quotes.
2997 The B<Exec> and B<NotificationExec> statements change the semantics of the
2998 programs executed, i.E<nbsp>e. the data passed to them and the response
2999 expected from them. This is documented in great detail in L<collectd-exec(5)>.
3003 =head2 Plugin C<fhcount>
3005 The C<fhcount> plugin provides statistics about used, unused and total number of
3006 file handles on Linux.
3008 The I<fhcount plugin> provides the following configuration options:
3012 =item B<ValuesAbsolute> B<true>|B<false>
3014 Enables or disables reporting of file handles usage in absolute numbers,
3015 e.g. file handles used. Defaults to B<true>.
3017 =item B<ValuesPercentage> B<false>|B<true>
3019 Enables or disables reporting of file handles usage in percentages, e.g.
3020 percent of file handles used. Defaults to B<false>.
3024 =head2 Plugin C<filecount>
3026 The C<filecount> plugin counts the number of files in a certain directory (and
3027 its subdirectories) and their combined size. The configuration is very straight
3030 <Plugin "filecount">
3031 <Directory "/var/qmail/queue/mess">
3032 Instance "qmail-message"
3034 <Directory "/var/qmail/queue/todo">
3035 Instance "qmail-todo"
3037 <Directory "/var/lib/php5">
3038 Instance "php5-sessions"
3043 The example above counts the number of files in QMail's queue directories and
3044 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
3045 QMail has not yet looked at, the "message" queue holds the messages that were
3046 classified into "local" and "remote".
3048 As you can see, the configuration consists of one or more C<Directory> blocks,
3049 each of which specifies a directory in which to count the files. Within those
3050 blocks, the following options are recognized:
3054 =item B<Plugin> I<Plugin>
3056 Use I<Plugin> as the plugin name when submitting values.
3057 Defaults to B<filecount>.
3059 =item B<Instance> I<Instance>
3061 Sets the plugin instance to I<Instance>. If not given, the instance is set to
3062 the directory name with all slashes replaced by underscores and all leading
3063 underscores removed. Empty value is allowed.
3065 =item B<Name> I<Pattern>
3067 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
3068 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
3069 against the pattern, not the entire path. In case this makes it easier for you:
3070 This option has been named after the B<-name> parameter to L<find(1)>.
3072 =item B<MTime> I<Age>
3074 Count only files of a specific age: If I<Age> is greater than zero, only files
3075 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
3076 a negative number, this is inversed. For example, if B<-60> is specified, only
3077 files that have been modified in the last minute will be counted.
3079 The number can also be followed by a "multiplier" to easily specify a larger
3080 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
3081 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
3082 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
3083 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
3084 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
3087 =item B<Size> I<Size>
3089 Count only files of a specific size. When I<Size> is a positive number, only
3090 files that are at least this big are counted. If I<Size> is a negative number,
3091 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
3092 I<Size> are counted.
3094 As with the B<MTime> option, a "multiplier" may be added. For a detailed
3095 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
3096 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
3097 note that there are 1000 bytes in a kilobyte, not 1024.
3099 =item B<Recursive> I<true>|I<false>
3101 Controls whether or not to recurse into subdirectories. Enabled by default.
3103 =item B<IncludeHidden> I<true>|I<false>
3105 Controls whether or not to include "hidden" files and directories in the count.
3106 "Hidden" files and directories are those, whose name begins with a dot.
3107 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
3109 =item B<RegularOnly> I<true>|I<false>
3111 Controls whether or not to include only regular files in the count.
3112 Defaults to I<true>, i.e. by default non regular files are ignored.
3114 =item B<FilesSizeType> I<Type>
3116 Sets the type used to dispatch files combined size. Empty value ("") disables
3117 reporting. Defaults to B<bytes>.
3119 =item B<FilesCountType> I<Type>
3121 Sets the type used to dispatch number of files. Empty value ("") disables
3122 reporting. Defaults to B<files>.
3124 =item B<TypeInstance> I<Instance>
3126 Sets the I<type instance> used to dispatch values. Defaults to an empty string
3127 (no plugin instance).
3131 =head2 Plugin C<GenericJMX>
3133 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
3134 L<collectd-java(5)>.
3136 =head2 Plugin C<gmond>
3138 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
3139 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
3140 are built-in, custom mappings may be added via B<Metric> blocks, see below.
3145 MCReceiveFrom "239.2.11.71" "8649"
3146 <Metric "swap_total">
3148 TypeInstance "total"
3151 <Metric "swap_free">
3158 The following metrics are built-in:
3164 load_one, load_five, load_fifteen
3168 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
3172 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
3184 Available configuration options:
3188 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
3190 Sets sets the multicast group and UDP port to which to subscribe.
3192 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
3194 =item E<lt>B<Metric> I<Name>E<gt>
3196 These blocks add a new metric conversion to the internal table. I<Name>, the
3197 string argument to the B<Metric> block, is the metric name as used by Ganglia.
3201 =item B<Type> I<Type>
3203 Type to map this metric to. Required.
3205 =item B<TypeInstance> I<Instance>
3207 Type-instance to use. Optional.
3209 =item B<DataSource> I<Name>
3211 Data source to map this metric to. If the configured type has exactly one data
3212 source, this is optional. Otherwise the option is required.
3218 =head2 Plugin C<gps>
3220 The C<gps plugin> connects to gpsd on the host machine.
3221 The host, port, timeout and pause are configurable.
3223 This is useful if you run an NTP server using a GPS for source and you want to
3226 Mind your GPS must send $--GSA for having the data reported!
3228 The following elements are collected:
3234 Number of satellites used for fix (type instance "used") and in view (type
3235 instance "visible"). 0 means no GPS satellites are visible.
3237 =item B<dilution_of_precision>
3239 Vertical and horizontal dilution (type instance "horizontal" or "vertical").
3240 It should be between 0 and 3.
3241 Look at the documentation of your GPS to know more.
3249 # Connect to localhost on gpsd regular port:
3254 # PauseConnect of 5 sec. between connection attempts.
3258 Available configuration options:
3262 =item B<Host> I<Host>
3264 The host on which gpsd daemon runs. Defaults to B<localhost>.
3266 =item B<Port> I<Port>
3268 Port to connect to gpsd on the host machine. Defaults to B<2947>.
3270 =item B<Timeout> I<Seconds>
3272 Timeout in seconds (default 0.015 sec).
3274 The GPS data stream is fetch by the plugin form the daemon.
3275 It waits for data to be available, if none arrives it times out
3276 and loop for another reading.
3277 Mind to put a low value gpsd expects value in the micro-seconds area
3278 (recommended is 500 us) since the waiting function is blocking.
3279 Value must be between 500 us and 5 sec., if outside that range the
3280 default value is applied.
3282 This only applies from gpsd release-2.95.
3284 =item B<PauseConnect> I<Seconds>
3286 Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).
3290 =head2 Plugin C<gpu_nvidia>
3292 Efficiently collects various statistics from the system's NVIDIA GPUs using the
3293 NVML library. Currently collected are fan speed, core temperature, percent
3294 load, percent memory used, compute and memory frequencies, and power
3301 If one or more of these options is specified, only GPUs at that index (as
3302 determined by nvidia-utils through I<nvidia-smi>) have statistics collected.
3303 If no instance of this option is specified, all GPUs are monitored.
3305 =item B<IgnoreSelected>
3307 If set to true, all detected GPUs B<except> the ones at indices specified by
3308 B<GPUIndex> entries are collected. For greater clarity, setting IgnoreSelected
3309 without any GPUIndex directives will result in B<no> statistics being
3314 =head2 Plugin C<grpc>
3316 The I<grpc> plugin provides an RPC interface to submit values to or query
3317 values from collectd based on the open source gRPC framework. It exposes an
3318 end-point for dispatching values to the daemon.
3320 The B<gRPC> homepage can be found at L<https://grpc.io/>.
3324 =item B<Server> I<Host> I<Port>
3326 The B<Server> statement sets the address of a server to which to send metrics
3327 via the C<DispatchValues> function.
3329 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3331 Optionally, B<Server> may be specified as a configuration block which supports
3332 the following options:
3336 =item B<EnableSSL> B<false>|B<true>
3338 Whether to require SSL for outgoing connections. Default: false.
3340 =item B<SSLCACertificateFile> I<Filename>
3342 =item B<SSLCertificateFile> I<Filename>
3344 =item B<SSLCertificateKeyFile> I<Filename>
3346 Filenames specifying SSL certificate and key material to be used with SSL
3351 =item B<Listen> I<Host> I<Port>
3353 The B<Listen> statement sets the network address to bind to. When multiple
3354 statements are specified, the daemon will bind to all of them. If none are
3355 specified, it defaults to B<0.0.0.0:50051>.
3357 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3359 Optionally, B<Listen> may be specified as a configuration block which
3360 supports the following options:
3364 =item B<EnableSSL> I<true>|I<false>
3366 Whether to enable SSL for incoming connections. Default: false.
3368 =item B<SSLCACertificateFile> I<Filename>
3370 =item B<SSLCertificateFile> I<Filename>
3372 =item B<SSLCertificateKeyFile> I<Filename>
3374 Filenames specifying SSL certificate and key material to be used with SSL
3377 =item B<VerifyPeer> B<true>|B<false>
3379 When enabled, a valid client certificate is required to connect to the server.
3380 When disabled, a client certifiacte is not requested and any unsolicited client
3381 certificate is accepted.
3388 =head2 Plugin C<hddtemp>
3390 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
3391 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
3392 default values, see below. C<hddtemp> has to be running to work correctly. If
3393 C<hddtemp> is not running timeouts may appear which may interfere with other
3396 The B<hddtemp> homepage can be found at
3397 L<http://www.guzu.net/linux/hddtemp.php>.
3401 =item B<Host> I<Hostname>
3403 Hostname to connect to. Defaults to B<127.0.0.1>.
3405 =item B<Port> I<Port>
3407 TCP-Port to connect to. Defaults to B<7634>.
3411 =head2 Plugin C<hugepages>
3413 To collect B<hugepages> information, collectd reads directories
3414 "/sys/devices/system/node/*/hugepages" and
3415 "/sys/kernel/mm/hugepages".
3416 Reading of these directories can be disabled by the following
3417 options (default is enabled).
3421 =item B<ReportPerNodeHP> B<true>|B<false>
3423 If enabled, information will be collected from the hugepage
3424 counters in "/sys/devices/system/node/*/hugepages".
3425 This is used to check the per-node hugepage statistics on
3428 =item B<ReportRootHP> B<true>|B<false>
3430 If enabled, information will be collected from the hugepage
3431 counters in "/sys/kernel/mm/hugepages".
3432 This can be used on both NUMA and non-NUMA systems to check
3433 the overall hugepage statistics.
3435 =item B<ValuesPages> B<true>|B<false>
3437 Whether to report hugepages metrics in number of pages.
3438 Defaults to B<true>.
3440 =item B<ValuesBytes> B<false>|B<true>
3442 Whether to report hugepages metrics in bytes.
3443 Defaults to B<false>.
3445 =item B<ValuesPercentage> B<false>|B<true>
3447 Whether to report hugepages metrics as percentage.
3448 Defaults to B<false>.
3452 =head2 Plugin C<intel_pmu>
3454 The I<intel_pmu> plugin collects performance counters data on Intel CPUs using
3455 Linux perf interface. All events are reported on a per core basis.
3460 ReportHardwareCacheEvents true
3461 ReportKernelPMUEvents true
3462 ReportSoftwareEvents true
3463 EventList "/var/cache/pmu/GenuineIntel-6-2D-core.json"
3464 HardwareEvents "L2_RQSTS.CODE_RD_HIT,L2_RQSTS.CODE_RD_MISS" "L2_RQSTS.ALL_CODE_RD"
3465 Cores "0-3" "4,6" "[12-15]"
3472 =item B<ReportHardwareCacheEvents> B<false>|B<true>
3474 Enable or disable measuring of hardware CPU cache events:
3476 - L1-dcache-load-misses
3478 - L1-dcache-store-misses
3479 - L1-dcache-prefetches
3480 - L1-dcache-prefetch-misses
3482 - L1-icache-load-misses
3483 - L1-icache-prefetches
3484 - L1-icache-prefetch-misses
3490 - LLC-prefetch-misses
3496 - dTLB-prefetch-misses
3500 - branch-load-misses
3502 =item B<ReportKernelPMUEvents> B<false>|B<true>
3504 Enable or disable measuring of the following events:
3513 =item B<ReportSoftwareEvents> B<false>|B<true>
3515 Enable or disable measuring of software events provided by kernel:
3526 =item B<EventList> I<filename>
3528 JSON performance counter event list file name. To be able to monitor all Intel
3529 CPU specific events JSON event list file should be downloaded. Use the pmu-tools
3530 event_download.py script to download event list for current CPU.
3532 =item B<HardwareEvents> I<events>
3534 This field is a list of event names or groups of comma separated event names.
3535 This option requires B<EventList> option to be configured.
3537 =item B<Cores> I<cores groups>
3539 All events are reported on a per core basis. Monitoring of the events can be
3540 configured for a group of cores (aggregated statistics). This field defines
3541 groups of cores on which to monitor supported events. The field is represented
3542 as list of strings with core group values. Each string represents a list of
3543 cores in a group. If a group is enclosed in square brackets each core is added
3544 individually to a separate group (that is statistics are not aggregated).
3545 Allowed formats are:
3551 If an empty string is provided as value for this field default cores
3552 configuration is applied - that is separate group is created for each core.
3556 =head2 Plugin C<intel_rdt>
3558 The I<intel_rdt> plugin collects information provided by monitoring features of
3559 Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
3560 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features provide
3561 information about utilization of shared resources. CMT monitors last level cache
3562 occupancy (LLC). MBM supports two types of events reporting local and remote
3563 memory bandwidth. Local memory bandwidth (MBL) reports the bandwidth of
3564 accessing memory associated with the local socket. Remote memory bandwidth (MBR)
3565 reports the bandwidth of accessing the remote socket. Also this technology
3566 allows to monitor instructions per clock (IPC).
3567 Monitor events are hardware dependant. Monitoring capabilities are detected on
3568 plugin initialization and only supported events are monitored.
3570 B<Note:> I<intel_rdt> plugin is using model-specific registers (MSRs), which
3571 require an additional capability to be enabled if collectd is run as a service.
3572 Please refer to I<contrib/systemd.collectd.service> file for more details.
3576 <Plugin "intel_rdt">
3577 Cores "0-2" "3,4,6" "8-10,15"
3578 Processes "sshd,qemu-system-x86" "bash"
3585 =item B<Interval> I<seconds>
3587 The interval within which to retrieve statistics on monitored events in seconds.
3588 For milliseconds divide the time by 1000 for example if the desired interval
3589 is 50ms, set interval to 0.05. Due to limited capacity of counters it is not
3590 recommended to set interval higher than 1 sec.
3592 =item B<Cores> I<cores groups>
3594 Monitoring of the events can be configured for group of cores
3595 (aggregated statistics). This field defines groups of cores on which to monitor
3596 supported events. The field is represented as list of strings with core group
3597 values. Each string represents a list of cores in a group. Allowed formats are:
3602 If an empty string is provided as value for this field default cores
3603 configuration is applied - a separate group is created for each core.
3605 =item B<Processes> I<process names groups>
3607 Monitoring of the events can be configured for group of processes
3608 (aggregated statistics). This field defines groups of processes on which to
3609 monitor supported events. The field is represented as list of strings with
3610 process names group values. Each string represents a list of processes in a
3611 group. Allowed format is:
3616 B<Note:> By default global interval is used to retrieve statistics on monitored
3617 events. To configure a plugin specific interval use B<Interval> option of the
3618 intel_rdt <LoadPlugin> block. For milliseconds divide the time by 1000 for
3619 example if the desired interval is 50ms, set interval to 0.05.
3620 Due to limited capacity of counters it is not recommended to set interval higher
3623 =head2 Plugin C<interface>
3627 =item B<Interface> I<Interface>
3629 Select this interface. By default these interfaces will then be collected. For
3630 a more detailed description see B<IgnoreSelected> below.
3632 See F</"IGNORELISTS"> for details.
3634 =item B<IgnoreSelected> I<true>|I<false>
3636 If no configuration is given, the B<interface>-plugin will collect data from
3637 all interfaces. This may not be practical, especially for loopback- and
3638 similar interfaces. Thus, you can use the B<Interface>-option to pick the
3639 interfaces you're interested in. Sometimes, however, it's easier/preferred
3640 to collect all interfaces I<except> a few ones. This option enables you to
3641 do that: By setting B<IgnoreSelected> to I<true> the effect of
3642 B<Interface> is inverted: All selected interfaces are ignored and all
3643 other interfaces are collected.
3645 It is possible to use regular expressions to match interface names, if the
3646 name is surrounded by I</.../> and collectd was compiled with support for
3647 regexps. This is useful if there's a need to collect (or ignore) data
3648 for a group of interfaces that are similarly named, without the need to
3649 explicitly list all of them (especially useful if the list is dynamic).
3654 Interface "/^tun[0-9]+/"
3655 IgnoreSelected "true"
3657 This will ignore the loopback interface, all interfaces with names starting
3658 with I<veth> and all interfaces with names starting with I<tun> followed by
3661 =item B<ReportInactive> I<true>|I<false>
3663 When set to I<false>, only interfaces with non-zero traffic will be
3664 reported. Note that the check is done by looking into whether a
3665 package was sent at any time from boot and the corresponding counter
3666 is non-zero. So, if the interface has been sending data in the past
3667 since boot, but not during the reported time-interval, it will still
3670 The default value is I<true> and results in collection of the data
3671 from all interfaces that are selected by B<Interface> and
3672 B<IgnoreSelected> options.
3674 =item B<UniqueName> I<true>|I<false>
3676 Interface name is not unique on Solaris (KSTAT), interface name is unique
3677 only within a module/instance. Following tuple is considered unique:
3678 (ks_module, ks_instance, ks_name)
3679 If this option is set to true, interface name contains above three fields
3680 separated by an underscore. For more info on KSTAT, visit
3681 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
3683 This option is only available on Solaris.
3687 =head2 Plugin C<ipmi>
3689 The B<ipmi plugin> allows to monitor server platform status using the Intelligent
3690 Platform Management Interface (IPMI). Local and remote interfaces are supported.
3692 The plugin configuration consists of one or more B<Instance> blocks which
3693 specify one I<ipmi> connection each. Each block requires one unique string
3694 argument as the instance name. If instances are not configured, an instance with
3695 the default option values will be created.
3697 For backwards compatibility, any option other than B<Instance> block will trigger
3698 legacy config handling and it will be treated as an option within B<Instance>
3699 block. This support will go away in the next major version of Collectd.
3701 Within the B<Instance> blocks, the following options are allowed:
3705 =item B<Address> I<Address>
3707 Hostname or IP to connect to. If not specified, plugin will try to connect to
3708 local management controller (BMC).
3710 =item B<Username> I<Username>
3712 =item B<Password> I<Password>
3714 The username and the password to use for the connection to remote BMC.
3716 =item B<AuthType> I<MD5>|I<rmcp+>
3718 Forces the authentication type to use for the connection to remote BMC.
3719 By default most secure type is seleted.
3721 =item B<Host> I<Hostname>
3723 Sets the B<host> field of dispatched values. Defaults to the global hostname
3726 =item B<Sensor> I<Sensor>
3728 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
3730 See F</"IGNORELISTS"> for details.
3732 =item B<IgnoreSelected> I<true>|I<false>
3734 If no configuration if given, the B<ipmi> plugin will collect data from all
3735 sensors found of type "temperature", "voltage", "current" and "fanspeed".
3736 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
3737 the effect of B<Sensor> is inverted: All selected sensors are ignored and
3738 all other sensors are collected.
3740 =item B<NotifySensorAdd> I<true>|I<false>
3742 If a sensor appears after initialization time of a minute a notification
3745 =item B<NotifySensorRemove> I<true>|I<false>
3747 If a sensor disappears a notification is sent.
3749 =item B<NotifySensorNotPresent> I<true>|I<false>
3751 If you have for example dual power supply and one of them is (un)plugged then
3752 a notification is sent.
3754 =item B<NotifyIPMIConnectionState> I<true>|I<false>
3756 If a IPMI connection state changes after initialization time of a minute
3757 a notification is sent. Defaults to B<false>.
3759 =item B<SELEnabled> I<true>|I<false>
3761 If system event log (SEL) is enabled, plugin will listen for sensor threshold
3762 and discrete events. When event is received the notification is sent.
3763 SEL event filtering can be configured using B<SELSensor> and B<SELIgnoreSelected>
3765 Defaults to B<false>.
3767 =item B<SELSensor> I<SELSensor>
3769 Selects sensors to get events from or to ignore, depending on B<SELIgnoreSelected>.
3771 See F</"IGNORELISTS"> for details.
3773 =item B<SELIgnoreSelected> I<true>|I<false>
3775 If no configuration is given, the B<ipmi> plugin will pass events from all
3776 sensors. This option enables you to do that: By setting B<SELIgnoreSelected>
3777 to I<true> the effect of B<SELSensor> is inverted: All events from selected
3778 sensors are ignored and all events from other sensors are passed.
3780 =item B<SELClearEvent> I<true>|I<false>
3782 If SEL clear event is enabled, plugin will delete event from SEL list after
3783 it is received and successfully handled. In this case other tools that are
3784 subscribed for SEL events will receive an empty event.
3785 Defaults to B<false>.
3789 =head2 Plugin C<iptables>
3793 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3795 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3797 Select the iptables/ip6tables filter rules to count packets and bytes from.
3799 If only I<Table> and I<Chain> are given, this plugin will collect the counters
3800 of all rules which have a comment-match. The comment is then used as
3803 If I<Comment> or I<Number> is given, only the rule with the matching comment or
3804 the I<n>th rule will be collected. Again, the comment (or the number) will be
3805 used as the type-instance.
3807 If I<Name> is supplied, it will be used as the type-instance instead of the
3808 comment or the number.
3812 =head2 Plugin C<irq>
3818 Select this irq. By default these irqs will then be collected. For a more
3819 detailed description see B<IgnoreSelected> below.
3821 See F</"IGNORELISTS"> for details.
3823 =item B<IgnoreSelected> I<true>|I<false>
3825 If no configuration if given, the B<irq>-plugin will collect data from all
3826 irqs. This may not be practical, especially if no interrupts happen. Thus, you
3827 can use the B<Irq>-option to pick the interrupt you're interested in.
3828 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
3829 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
3830 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
3831 and all other interrupts are collected.
3835 =head2 Plugin C<java>
3837 The I<Java> plugin makes it possible to write extensions for collectd in Java.
3838 This section only discusses the syntax and semantic of the configuration
3839 options. For more in-depth information on the I<Java> plugin, please read
3840 L<collectd-java(5)>.
3845 JVMArg "-verbose:jni"
3846 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
3847 LoadPlugin "org.collectd.java.Foobar"
3848 <Plugin "org.collectd.java.Foobar">
3849 # To be parsed by the plugin
3853 Available configuration options:
3857 =item B<JVMArg> I<Argument>
3859 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
3860 exactly the way the arguments to the I<java> binary on the command line work.
3861 Execute C<javaE<nbsp>--help> for details.
3863 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
3864 any other options! When another option is found, the JVM will be started and
3865 later options will have to be ignored!
3867 =item B<LoadPlugin> I<JavaClass>
3869 Instantiates a new I<JavaClass> object. The constructor of this object very
3870 likely then registers one or more callback methods with the server.
3872 See L<collectd-java(5)> for details.
3874 When the first such option is found, the virtual machine (JVM) is created. This
3875 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
3876 B<LoadPlugin> options!
3878 =item B<Plugin> I<Name>
3880 The entire block is passed to the Java plugin as an
3881 I<org.collectd.api.OConfigItem> object.
3883 For this to work, the plugin has to register a configuration callback first,
3884 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
3885 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
3886 depends on the (Java) plugin registering the callback and is completely
3887 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
3891 =head2 Plugin C<load>
3893 The I<Load plugin> collects the system load. These numbers give a rough overview
3894 over the utilization of a machine. The system load is defined as the number of
3895 runnable tasks in the run-queue and is provided by many operating systems as a
3896 one, five or fifteen minute average.
3898 The following configuration options are available:
3902 =item B<ReportRelative> B<false>|B<true>
3904 When enabled, system load divided by number of available CPU cores is reported
3905 for intervals 1 min, 5 min and 15 min. Defaults to false.
3910 =head2 Plugin C<logfile>
3914 =item B<LogLevel> B<debug|info|notice|warning|err>
3916 Sets the log-level. If, for example, set to B<notice>, then all events with
3917 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3919 Please note that B<debug> is only available if collectd has been compiled with
3922 =item B<File> I<File>
3924 Sets the file to write log messages to. The special strings B<stdout> and
3925 B<stderr> can be used to write to the standard output and standard error
3926 channels, respectively. This, of course, only makes much sense when I<collectd>
3927 is running in foreground- or non-daemon-mode.
3929 =item B<Timestamp> B<true>|B<false>
3931 Prefix all lines printed by the current time. Defaults to B<true>.
3933 =item B<PrintSeverity> B<true>|B<false>
3935 When enabled, all lines are prefixed by the severity of the log message, for
3936 example "warning". Defaults to B<false>.
3940 B<Note>: There is no need to notify the daemon after moving or removing the
3941 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3942 for each line it writes.
3944 =head2 Plugin C<log_logstash>
3946 The I<log logstash plugin> behaves like the logfile plugin but formats
3947 messages as JSON events for logstash to parse and input.
3951 =item B<LogLevel> B<debug|info|notice|warning|err>
3953 Sets the log-level. If, for example, set to B<notice>, then all events with
3954 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3956 Please note that B<debug> is only available if collectd has been compiled with
3959 =item B<File> I<File>
3961 Sets the file to write log messages to. The special strings B<stdout> and
3962 B<stderr> can be used to write to the standard output and standard error
3963 channels, respectively. This, of course, only makes much sense when I<collectd>
3964 is running in foreground- or non-daemon-mode.
3968 B<Note>: There is no need to notify the daemon after moving or removing the
3969 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3970 for each line it writes.
3972 =head2 Plugin C<lpar>
3974 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
3975 virtualization technique for IBM POWER processors. It takes into account CPU
3976 time stolen from or donated to a partition, in addition to the usual user,
3977 system, I/O statistics.
3979 The following configuration options are available:
3983 =item B<CpuPoolStats> B<false>|B<true>
3985 When enabled, statistics about the processor pool are read, too. The partition
3986 needs to have pool authority in order to be able to acquire this information.
3989 =item B<ReportBySerial> B<false>|B<true>
3991 If enabled, the serial of the physical machine the partition is currently
3992 running on is reported as I<hostname> and the logical hostname of the machine
3993 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
3994 used (just like other plugins) and the I<plugin instance> will be empty.
3999 =head2 Plugin C<lua>
4001 This plugin embeds a Lua interpreter into collectd and provides an interface
4002 to collectd's plugin system. See L<collectd-lua(5)> for its documentation.
4005 =head2 Plugin C<mbmon>
4007 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
4009 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
4010 B<Host> and B<Port> options can be used to change these values, see below.
4011 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
4012 timeouts may appear which may interfere with other statistics..
4014 C<mbmon> must be run with the -r option ("print TAG and Value format");
4015 Debian's F</etc/init.d/mbmon> script already does this, other people
4016 will need to ensure that this is the case.
4020 =item B<Host> I<Hostname>
4022 Hostname to connect to. Defaults to B<127.0.0.1>.
4024 =item B<Port> I<Port>
4026 TCP-Port to connect to. Defaults to B<411>.
4030 =head2 Plugin C<mcelog>
4032 The C<mcelog plugin> uses mcelog to retrieve machine check exceptions.
4034 By default the plugin connects to B<"/var/run/mcelog-client"> to check if the
4035 mcelog server is running. When the server is running, the plugin will tail the
4036 specified logfile to retrieve machine check exception information and send a
4037 notification with the details from the logfile. The plugin will use the mcelog
4038 client protocol to retrieve memory related machine check exceptions. Note that
4039 for memory exceptions, notifications are only sent when there is a change in
4040 the number of corrected/uncorrected memory errors.
4042 =head3 The Memory block
4044 Note: these options cannot be used in conjunction with the logfile options, they are mutually
4049 =item B<McelogClientSocket> I<Path>
4050 Connect to the mcelog client socket using the UNIX domain socket at I<Path>.
4051 Defaults to B<"/var/run/mcelog-client">.
4053 =item B<PersistentNotification> B<true>|B<false>
4054 Override default configuration to only send notifications when sent when there
4055 is a change in the number of corrected/uncorrected memory errors. When set to
4056 true notifications will be sent for every read cycle. Default is false. Does
4057 not affect the stats being dispatched.
4063 =item B<McelogLogfile> I<Path>
4065 The mcelog file to parse. Defaults to B<"/var/log/mcelog">. Note: this option
4066 cannot be used in conjunction with the memory block options, they are mutually
4073 The C<md plugin> collects information from Linux Software-RAID devices (md).
4075 All reported values are of the type C<md_disks>. Reported type instances are
4076 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
4077 I<missing> (physically absent) disks.
4081 =item B<Device> I<Device>
4083 Select md devices based on device name. The I<device name> is the basename of
4084 the device, i.e. the name of the block device without the leading C</dev/>.
4085 See B<IgnoreSelected> for more details.
4087 See F</"IGNORELISTS"> for details.
4089 =item B<IgnoreSelected> B<true>|B<false>
4091 Invert device selection: If set to B<true>, all md devices B<except> those
4092 listed using B<Device> are collected. If B<false> (the default), only those
4093 listed are collected. If no configuration is given, the B<md> plugin will
4094 collect data from all md devices.
4098 =head2 Plugin C<memcachec>
4100 The C<memcachec plugin> connects to a memcached server, queries one or more
4101 given I<pages> and parses the returned data according to user specification.
4102 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
4105 In order to talk to the memcached server, this plugin uses the I<libmemcached>
4106 library. Please note that there is another library with a very similar name,
4107 libmemcache (notice the missing `d'), which is not applicable.
4109 Synopsis of the configuration:
4111 <Plugin "memcachec">
4112 <Page "plugin_instance">
4115 Plugin "plugin_name"
4117 Regex "(\\d+) bytes sent"
4120 Instance "type_instance"
4125 The configuration options are:
4129 =item E<lt>B<Page> I<Name>E<gt>
4131 Each B<Page> block defines one I<page> to be queried from the memcached server.
4132 The block requires one string argument which is used as I<plugin instance>.
4134 =item B<Server> I<Address>
4136 Sets the server address to connect to when querying the page. Must be inside a
4141 When connected to the memcached server, asks for the page I<Key>.
4143 =item B<Plugin> I<Plugin>
4145 Use I<Plugin> as the plugin name when submitting values.
4146 Defaults to C<memcachec>.
4148 =item E<lt>B<Match>E<gt>
4150 Match blocks define which strings to look for and how matches substrings are
4151 interpreted. For a description of match blocks, please see L<"Plugin tail">.
4155 =head2 Plugin C<memcached>
4157 The B<memcached plugin> connects to a memcached server and queries statistics
4158 about cache utilization, memory and bandwidth used.
4159 L<http://memcached.org/>
4161 <Plugin "memcached">
4163 #Host "memcache.example.com"
4169 The plugin configuration consists of one or more B<Instance> blocks which
4170 specify one I<memcached> connection each. Within the B<Instance> blocks, the
4171 following options are allowed:
4175 =item B<Host> I<Hostname>
4177 Sets the B<host> field of dispatched values. Defaults to the global hostname
4179 For backwards compatibility, values are also dispatched with the global
4180 hostname when B<Host> is set to B<127.0.0.1> or B<localhost> and B<Address> is
4183 =item B<Address> I<Address>
4185 Hostname or IP to connect to. For backwards compatibility, defaults to the
4186 value of B<Host> or B<127.0.0.1> if B<Host> is unset.
4188 =item B<Port> I<Port>
4190 TCP port to connect to. Defaults to B<11211>.
4192 =item B<Socket> I<Path>
4194 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
4195 setting is given, the B<Address> and B<Port> settings are ignored.
4199 =head2 Plugin C<mic>
4201 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
4202 Intel's Many Integrated Core (MIC) systems.
4211 ShowTemperatures true
4214 IgnoreSelectedTemperature true
4219 IgnoreSelectedPower true
4222 The following options are valid inside the B<PluginE<nbsp>mic> block:
4226 =item B<ShowCPU> B<true>|B<false>
4228 If enabled (the default) a sum of the CPU usage across all cores is reported.
4230 =item B<ShowCPUCores> B<true>|B<false>
4232 If enabled (the default) per-core CPU usage is reported.
4234 =item B<ShowMemory> B<true>|B<false>
4236 If enabled (the default) the physical memory usage of the MIC system is
4239 =item B<ShowTemperatures> B<true>|B<false>
4241 If enabled (the default) various temperatures of the MIC system are reported.
4243 =item B<Temperature> I<Name>
4245 This option controls which temperatures are being reported. Whether matching
4246 temperatures are being ignored or I<only> matching temperatures are reported
4247 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
4248 temperatures are reported.
4250 =item B<IgnoreSelectedTemperature> B<false>|B<true>
4252 Controls the behavior of the B<Temperature> setting above. If set to B<false>
4253 (the default) only temperatures matching a B<Temperature> option are reported
4254 or, if no B<Temperature> option is specified, all temperatures are reported. If
4255 set to B<true>, matching temperatures are I<ignored> and all other temperatures
4258 Known temperature names are:
4292 =item B<ShowPower> B<true>|B<false>
4294 If enabled (the default) various temperatures of the MIC system are reported.
4296 =item B<Power> I<Name>
4298 This option controls which power readings are being reported. Whether matching
4299 power readings are being ignored or I<only> matching power readings are reported
4300 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
4301 power readings are reported.
4303 =item B<IgnoreSelectedPower> B<false>|B<true>
4305 Controls the behavior of the B<Power> setting above. If set to B<false>
4306 (the default) only power readings matching a B<Power> option are reported
4307 or, if no B<Power> option is specified, all power readings are reported. If
4308 set to B<true>, matching power readings are I<ignored> and all other power readings
4311 Known power names are:
4317 Total power utilization averaged over Time Window 0 (uWatts).
4321 Total power utilization averaged over Time Window 0 (uWatts).
4325 Instantaneous power (uWatts).
4329 Max instantaneous power (uWatts).
4333 PCI-E connector power (uWatts).
4337 2x3 connector power (uWatts).
4341 2x4 connector power (uWatts).
4349 Uncore rail (uVolts).
4353 Memory subsystem rail (uVolts).
4359 =head2 Plugin C<memory>
4361 The I<memory plugin> provides the following configuration options:
4365 =item B<ValuesAbsolute> B<true>|B<false>
4367 Enables or disables reporting of physical memory usage in absolute numbers,
4368 i.e. bytes. Defaults to B<true>.
4370 =item B<ValuesPercentage> B<false>|B<true>
4372 Enables or disables reporting of physical memory usage in percentages, e.g.
4373 percent of physical memory used. Defaults to B<false>.
4375 This is useful for deploying I<collectd> in a heterogeneous environment in
4376 which the sizes of physical memory vary.
4380 =head2 Plugin C<modbus>
4382 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
4383 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
4384 values), large integer values (unsigned 32E<nbsp>bit and 64E<nbsp>bit values) and
4385 floating point values (two registers interpreted as IEEE floats in big endian
4390 <Data "voltage-input-1">
4393 RegisterCmd ReadHolding
4400 <Data "voltage-input-2">
4403 RegisterCmd ReadHolding
4408 <Data "supply-temperature-1">
4411 RegisterCmd ReadHolding
4416 <Host "modbus.example.com">
4417 Address "192.168.0.42"
4422 Instance "power-supply"
4423 Collect "voltage-input-1"
4424 Collect "voltage-input-2"
4429 Device "/dev/ttyUSB0"
4434 Instance "temperature"
4435 Collect "supply-temperature-1"
4441 =item E<lt>B<Data> I<Name>E<gt> blocks
4443 Data blocks define a mapping between register numbers and the "types" used by
4446 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
4450 =item B<RegisterBase> I<Number>
4452 Configures the base register to read from the device. If the option
4453 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
4454 register will be read (the register number is increased by one).
4456 =item B<RegisterType> B<Int16>|B<Int32>|B<Int64>|B<Uint16>|B<Uint32>|B<UInt64>|B<Float>|B<Int32LE>|B<Uint32LE>|B<FloatLE>
4458 Specifies what kind of data is returned by the device. This defaults to
4459 B<Uint16>. If the type is B<Int32>, B<Int32LE>, B<Uint32>, B<Uint32LE>,
4460 B<Float> or B<FloatLE>, two 16E<nbsp>bit registers at B<RegisterBase>
4461 and B<RegisterBase+1> will be read and the data is combined into one
4462 32E<nbsp>value. For B<Int32>, B<Uint32> and B<Float> the most significant
4463 16E<nbsp>bits are in the register at B<RegisterBase> and the least
4464 significant 16E<nbsp>bits are in the register at B<RegisterBase+1>.
4465 For B<Int32LE>, B<Uint32LE>, or B<Float32LE>, the high and low order
4466 registers are swapped with the most significant 16E<nbsp>bits in
4467 the B<RegisterBase+1> and the least significant 16E<nbsp>bits in
4468 B<RegisterBase>. If the type is B<Int64> or B<UInt64>, four 16E<nbsp>bit
4469 registers at B<RegisterBase>, B<RegisterBase+1>, B<RegisterBase+2> and
4470 B<RegisterBase+3> will be read and the data combined into one
4473 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
4475 Specifies register type to be collected from device. Works only with libmodbus
4476 2.9.2 or higher. Defaults to B<ReadHolding>.
4478 =item B<Type> I<Type>
4480 Specifies the "type" (data set) to use when dispatching the value to
4481 I<collectd>. Currently, only data sets with exactly one data source are
4484 =item B<Instance> I<Instance>
4486 Sets the type instance to use when dispatching the value to I<Instance>. If
4487 unset, an empty string (no type instance) is used.
4489 =item B<Scale> I<Value>
4491 The values taken from device are multiplied by I<Value>. The field is optional
4492 and the default is B<1.0>.
4494 =item B<Shift> I<Value>
4496 I<Value> is added to values from device after they have been multiplied by
4497 B<Scale> value. The field is optional and the default value is B<0.0>.
4501 =item E<lt>B<Host> I<Name>E<gt> blocks
4503 Host blocks are used to specify to which hosts to connect and what data to read
4504 from their "slaves". The string argument I<Name> is used as hostname when
4505 dispatching the values to I<collectd>.
4507 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
4511 =item B<Address> I<Hostname>
4513 For Modbus/TCP, specifies the node name (the actual network address) used to
4514 connect to the host. This may be an IP address or a hostname. Please note that
4515 the used I<libmodbus> library only supports IPv4 at the moment.
4517 =item B<Port> I<Service>
4519 for Modbus/TCP, specifies the port used to connect to the host. The port can
4520 either be given as a number or as a service name. Please note that the
4521 I<Service> argument must be a string, even if ports are given in their numerical
4522 form. Defaults to "502".
4524 =item B<Device> I<Devicenode>
4526 For Modbus/RTU, specifies the path to the serial device being used.
4528 =item B<Baudrate> I<Baudrate>
4530 For Modbus/RTU, specifies the baud rate of the serial device.
4531 Note, connections currently support only 8/N/1.
4533 =item B<UARTType> I<UARTType>
4535 For Modbus/RTU, specifies the type of the serial device.
4536 RS232, RS422 and RS485 are supported. Defaults to RS232.
4537 Available only on Linux systems with libmodbus>=2.9.4.
4539 =item B<Interval> I<Interval>
4541 Sets the interval (in seconds) in which the values will be collected from this
4542 host. By default the global B<Interval> setting will be used.
4544 =item E<lt>B<Slave> I<ID>E<gt>
4546 Over each connection, multiple Modbus devices may be reached. The slave ID
4547 is used to specify which device should be addressed. For each device you want
4548 to query, one B<Slave> block must be given.
4550 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
4554 =item B<Instance> I<Instance>
4556 Specify the plugin instance to use when dispatching the values to I<collectd>.
4557 By default "slave_I<ID>" is used.
4559 =item B<Collect> I<DataName>
4561 Specifies which data to retrieve from the device. I<DataName> must be the same
4562 string as the I<Name> argument passed to a B<Data> block. You can specify this
4563 option multiple times to collect more than one value from a slave. At least one
4564 B<Collect> option is mandatory.
4572 =head2 Plugin C<mqtt>
4574 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
4575 values from MQTT (B<Subscribe> blocks).
4581 Host "mqtt.example.com"
4585 Host "mqtt.example.com"
4590 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
4591 configuring the sending and receiving direction respectively. The plugin will
4592 register a write callback named C<mqtt/I<name>> where I<name> is the string
4593 argument given to the B<Publish> block. Both types of blocks share many but not
4594 all of the following options. If an option is valid in only one of the blocks,
4595 it will be mentioned explicitly.
4601 =item B<Host> I<Hostname>
4603 Hostname of the MQTT broker to connect to.
4605 =item B<Port> I<Service>
4607 Port number or service name of the MQTT broker to connect to.
4609 =item B<User> I<UserName>
4611 Username used when authenticating to the MQTT broker.
4613 =item B<Password> I<Password>
4615 Password used when authenticating to the MQTT broker.
4617 =item B<ClientId> I<ClientId>
4619 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
4621 =item B<QoS> [B<0>-B<2>]
4623 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
4641 In B<Publish> blocks, this option determines the QoS flag set on outgoing
4642 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
4643 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
4644 on a message is larger than the maximum accepted QoS of a subscriber, the
4645 message's QoS will be downgraded.
4647 =item B<Prefix> I<Prefix> (Publish only)
4649 This plugin will use one topic per I<value list> which will looks like a path.
4650 I<Prefix> is used as the first path element and defaults to B<collectd>.
4652 An example topic name would be:
4654 collectd/cpu-0/cpu-user
4656 =item B<Retain> B<false>|B<true> (Publish only)
4658 Controls whether the MQTT broker will retain (keep a copy of) the last message
4659 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
4661 =item B<StoreRates> B<true>|B<false> (Publish only)
4663 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
4664 before sending. Defaults to B<true>.
4666 =item B<CleanSession> B<true>|B<false> (Subscribe only)
4668 Controls whether the MQTT "cleans" the session up after the subscriber
4669 disconnects or if it maintains the subscriber's subscriptions and all messages
4670 that arrive while the subscriber is disconnected. Defaults to B<true>.
4672 =item B<Topic> I<TopicName> (Subscribe only)
4674 Configures the topic(s) to subscribe to. You can use the single level C<+> and
4675 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
4676 the B<collectd> branch.
4678 =item B<CACert> I<file>
4680 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
4681 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
4682 port of the MQTT broker.
4683 This option enables the use of TLS.
4685 =item B<CertificateFile> I<file>
4687 Path to the PEM-encoded certificate file to use as client certificate when
4688 connecting to the MQTT broker.
4689 Only valid if B<CACert> and B<CertificateKeyFile> are also set.
4691 =item B<CertificateKeyFile> I<file>
4693 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
4694 Only valid if B<CACert> and B<CertificateFile> are also set.
4696 =item B<TLSProtocol> I<protocol>
4698 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
4699 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
4700 version is used which depends on the version of OpenSSL the Mosquitto library
4702 Only valid if B<CACert> is set.
4704 =item B<CipherSuite> I<ciphersuite>
4706 A string describing the ciphers available for use. See L<ciphers(1)> and the
4707 C<openssl ciphers> utility for more information. If unset, the default ciphers
4709 Only valid if B<CACert> is set.
4713 =head2 Plugin C<mysql>
4715 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
4716 one or more databases when started and keeps the connection up as long as
4717 possible. When the connection is interrupted for whatever reason it will try
4718 to re-connect. The plugin will complain loudly in case anything goes wrong.
4720 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
4721 and collects information about MySQL network traffic, executed statements,
4722 requests, the query cache and threads by evaluating the
4723 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
4724 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
4725 Status Variables> for an explanation of these values.
4727 Optionally, master and slave statistics may be collected in a MySQL
4728 replication setup. In that case, information about the synchronization state
4729 of the nodes are collected by evaluating the C<Position> return value of the
4730 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
4731 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
4732 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
4733 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
4734 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
4746 SSLKey "/path/to/key.pem"
4747 SSLCert "/path/to/cert.pem"
4748 SSLCA "/path/to/ca.pem"
4749 SSLCAPath "/path/to/cas/"
4750 SSLCipher "DHE-RSA-AES256-SHA"
4756 Socket "/var/run/mysql/mysqld.sock"
4758 SlaveNotifications true
4764 Socket "/var/run/mysql/mysqld.sock"
4769 A B<Database> block defines one connection to a MySQL database. It accepts a
4770 single argument which specifies the name of the database. None of the other
4771 options are required. MySQL will use default values as documented in the
4772 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
4773 B<MySQL reference manual>.
4777 =item B<Alias> I<Alias>
4779 Alias to use as sender instead of hostname when reporting. This may be useful
4780 when having cryptic hostnames.
4782 =item B<Host> I<Hostname>
4784 Hostname of the database server. Defaults to B<localhost>.
4786 =item B<User> I<Username>
4788 Username to use when connecting to the database. The user does not have to be
4789 granted any privileges (which is synonym to granting the C<USAGE> privilege),
4790 unless you want to collectd replication statistics (see B<MasterStats> and
4791 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
4792 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
4794 =item B<Password> I<Password>
4796 Password needed to log into the database.
4798 =item B<Database> I<Database>
4800 Select this database. Defaults to I<no database> which is a perfectly reasonable
4801 option for what this plugin does.
4803 =item B<Port> I<Port>
4805 TCP-port to connect to. The port must be specified in its numeric form, but it
4806 must be passed as a string nonetheless. For example:
4810 If B<Host> is set to B<localhost> (the default), this setting has no effect.
4811 See the documentation for the C<mysql_real_connect> function for details.
4813 =item B<Socket> I<Socket>
4815 Specifies the path to the UNIX domain socket of the MySQL server. This option
4816 only has any effect, if B<Host> is set to B<localhost> (the default).
4817 Otherwise, use the B<Port> option above. See the documentation for the
4818 C<mysql_real_connect> function for details.
4820 =item B<InnodbStats> I<true|false>
4822 If enabled, metrics about the InnoDB storage engine are collected.
4823 Disabled by default.
4825 =item B<MasterStats> I<true|false>
4827 =item B<SlaveStats> I<true|false>
4829 Enable the collection of master / slave statistics in a replication setup. In
4830 order to be able to get access to these statistics, the user needs special
4831 privileges. See the B<User> documentation above. Defaults to B<false>.
4833 =item B<SlaveNotifications> I<true|false>
4835 If enabled, the plugin sends a notification if the replication slave I/O and /
4836 or SQL threads are not running. Defaults to B<false>.
4838 =item B<WsrepStats> I<true|false>
4840 Enable the collection of wsrep plugin statistics, used in Master-Master
4841 replication setups like in MySQL Galera/Percona XtraDB Cluster.
4842 User needs only privileges to execute 'SHOW GLOBAL STATUS'
4844 =item B<ConnectTimeout> I<Seconds>
4846 Sets the connect timeout for the MySQL client.
4848 =item B<SSLKey> I<Path>
4850 If provided, the X509 key in PEM format.
4852 =item B<SSLCert> I<Path>
4854 If provided, the X509 cert in PEM format.
4856 =item B<SSLCA> I<Path>
4858 If provided, the CA file in PEM format (check OpenSSL docs).
4860 =item B<SSLCAPath> I<Path>
4862 If provided, the CA directory (check OpenSSL docs).
4864 =item B<SSLCipher> I<String>
4866 If provided, the SSL cipher to use.
4870 =head2 Plugin C<netapp>
4872 The netapp plugin can collect various performance and capacity information
4873 from a NetApp filer using the NetApp API.
4875 Please note that NetApp has a wide line of products and a lot of different
4876 software versions for each of these products. This plugin was developed for a
4877 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
4878 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
4879 model and software version but it is very hard to test this.
4880 If you have used this plugin with other models and/or software version, feel
4881 free to send us a mail to tell us about the results, even if it's just a short
4884 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
4885 basic authentication.
4887 B<Do not use a regular user for this!> Create a special collectd user with just
4888 the minimum of capabilities needed. The user only needs the "login-http-admin"
4889 capability as well as a few more depending on which data will be collected.
4890 Required capabilities are documented below.
4895 <Host "netapp1.example.com">
4919 IgnoreSelectedIO false
4921 IgnoreSelectedOps false
4922 GetLatency "volume0"
4923 IgnoreSelectedLatency false
4930 IgnoreSelectedCapacity false
4933 IgnoreSelectedSnapshot false
4961 The netapp plugin accepts the following configuration options:
4965 =item B<Host> I<Name>
4967 A host block defines one NetApp filer. It will appear in collectd with the name
4968 you specify here which does not have to be its real name nor its hostname (see
4969 the B<Address> option below).
4971 =item B<VFiler> I<Name>
4973 A B<VFiler> block may only be used inside a host block. It accepts all the
4974 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
4975 will execute all NetApp API commands in the context of the specified
4976 VFiler(R). It will appear in collectd with the name you specify here which
4977 does not have to be its real name. The VFiler name may be specified using the
4978 B<VFilerName> option. If this is not specified, it will default to the name
4981 The VFiler block inherits all connection related settings from the surrounding
4982 B<Host> block (which appear before the B<VFiler> block) but they may be
4983 overwritten inside the B<VFiler> block.
4985 This feature is useful, for example, when using a VFiler as SnapVault target
4986 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
4987 available in the host filer (vfiler0) but only in the respective VFiler
4990 =item B<Protocol> B<httpd>|B<http>
4992 The protocol collectd will use to query this host.
5000 Valid options: http, https
5002 =item B<Address> I<Address>
5004 The hostname or IP address of the host.
5010 Default: The "host" block's name.
5012 =item B<Port> I<Port>
5014 The TCP port to connect to on the host.
5020 Default: 80 for protocol "http", 443 for protocol "https"
5022 =item B<User> I<User>
5024 =item B<Password> I<Password>
5026 The username and password to use to login to the NetApp.
5032 =item B<VFilerName> I<Name>
5034 The name of the VFiler in which context to execute API commands. If not
5035 specified, the name provided to the B<VFiler> block will be used instead.
5041 Default: name of the B<VFiler> block
5043 B<Note:> This option may only be used inside B<VFiler> blocks.
5045 =item B<Interval> I<Interval>
5051 The following options decide what kind of data will be collected. You can
5052 either use them as a block and fine tune various parameters inside this block,
5053 use them as a single statement to just accept all default values, or omit it to
5054 not collect any data.
5056 The following options are valid inside all blocks:
5060 =item B<Interval> I<Seconds>
5062 Collect the respective statistics every I<Seconds> seconds. Defaults to the
5063 host specific setting.
5067 =head3 The System block
5069 This will collect various performance data about the whole system.
5071 B<Note:> To get this data the collectd user needs the
5072 "api-perf-object-get-instances" capability.
5076 =item B<Interval> I<Seconds>
5078 Collect disk statistics every I<Seconds> seconds.
5080 =item B<GetCPULoad> B<true>|B<false>
5082 If you set this option to true the current CPU usage will be read. This will be
5083 the average usage between all CPUs in your NetApp without any information about
5086 B<Note:> These are the same values that the NetApp CLI command "sysstat"
5087 returns in the "CPU" field.
5095 Result: Two value lists of type "cpu", and type instances "idle" and "system".
5097 =item B<GetInterfaces> B<true>|B<false>
5099 If you set this option to true the current traffic of the network interfaces
5100 will be read. This will be the total traffic over all interfaces of your NetApp
5101 without any information about individual interfaces.
5103 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5104 in the "Net kB/s" field.
5114 Result: One value list of type "if_octects".
5116 =item B<GetDiskIO> B<true>|B<false>
5118 If you set this option to true the current IO throughput will be read. This
5119 will be the total IO of your NetApp without any information about individual
5120 disks, volumes or aggregates.
5122 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5123 in the "DiskE<nbsp>kB/s" field.
5131 Result: One value list of type "disk_octets".
5133 =item B<GetDiskOps> B<true>|B<false>
5135 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
5136 iSCSI, etc. operations will be read. This will be the total number of
5137 operations on your NetApp without any information about individual volumes or
5140 B<Note:> These are the same values that the NetApp CLI command "sysstat"
5141 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
5149 Result: A variable number of value lists of type "disk_ops_complex". Each type
5150 of operation will result in one value list with the name of the operation as
5155 =head3 The WAFL block
5157 This will collect various performance data about the WAFL file system. At the
5158 moment this just means cache performance.
5160 B<Note:> To get this data the collectd user needs the
5161 "api-perf-object-get-instances" capability.
5163 B<Note:> The interface to get these values is classified as "Diagnostics" by
5164 NetApp. This means that it is not guaranteed to be stable even between minor
5169 =item B<Interval> I<Seconds>
5171 Collect disk statistics every I<Seconds> seconds.
5173 =item B<GetNameCache> B<true>|B<false>
5181 Result: One value list of type "cache_ratio" and type instance
5184 =item B<GetDirCache> B<true>|B<false>
5192 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
5194 =item B<GetInodeCache> B<true>|B<false>
5202 Result: One value list of type "cache_ratio" and type instance
5205 =item B<GetBufferCache> B<true>|B<false>
5207 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
5208 in the "Cache hit" field.
5216 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
5220 =head3 The Disks block
5222 This will collect performance data about the individual disks in the NetApp.
5224 B<Note:> To get this data the collectd user needs the
5225 "api-perf-object-get-instances" capability.
5229 =item B<Interval> I<Seconds>
5231 Collect disk statistics every I<Seconds> seconds.
5233 =item B<GetBusy> B<true>|B<false>
5235 If you set this option to true the busy time of all disks will be calculated
5236 and the value of the busiest disk in the system will be written.
5238 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5239 in the "Disk util" field. Probably.
5247 Result: One value list of type "percent" and type instance "disk_busy".
5251 =head3 The VolumePerf block
5253 This will collect various performance data about the individual volumes.
5255 You can select which data to collect about which volume using the following
5256 options. They follow the standard ignorelist semantic.
5258 B<Note:> To get this data the collectd user needs the
5259 I<api-perf-object-get-instances> capability.
5263 =item B<Interval> I<Seconds>
5265 Collect volume performance data every I<Seconds> seconds.
5267 =item B<GetIO> I<Volume>
5269 =item B<GetOps> I<Volume>
5271 =item B<GetLatency> I<Volume>
5273 Select the given volume for IO, operations or latency statistics collection.
5274 The argument is the name of the volume without the C</vol/> prefix.
5276 Since the standard ignorelist functionality is used here, you can use a string
5277 starting and ending with a slash to specify regular expression matching: To
5278 match the volumes "vol0", "vol2" and "vol7", you can use this regular
5281 GetIO "/^vol[027]$/"
5283 If no regular expression is specified, an exact match is required. Both,
5284 regular and exact matching are case sensitive.
5286 If no volume was specified at all for either of the three options, that data
5287 will be collected for all available volumes.
5289 See F</"IGNORELISTS"> for details.
5291 =item B<IgnoreSelectedIO> B<true>|B<false>
5293 =item B<IgnoreSelectedOps> B<true>|B<false>
5295 =item B<IgnoreSelectedLatency> B<true>|B<false>
5297 When set to B<true>, the volumes selected for IO, operations or latency
5298 statistics collection will be ignored and the data will be collected for all
5301 When set to B<false>, data will only be collected for the specified volumes and
5302 all other volumes will be ignored.
5304 If no volumes have been specified with the above B<Get*> options, all volumes
5305 will be collected regardless of the B<IgnoreSelected*> option.
5307 Defaults to B<false>
5311 =head3 The VolumeUsage block
5313 This will collect capacity data about the individual volumes.
5315 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
5320 =item B<Interval> I<Seconds>
5322 Collect volume usage statistics every I<Seconds> seconds.
5324 =item B<GetCapacity> I<VolumeName>
5326 The current capacity of the volume will be collected. This will result in two
5327 to four value lists, depending on the configuration of the volume. All data
5328 sources are of type "df_complex" with the name of the volume as
5331 There will be type_instances "used" and "free" for the number of used and
5332 available bytes on the volume. If the volume has some space reserved for
5333 snapshots, a type_instance "snap_reserved" will be available. If the volume
5334 has SIS enabled, a type_instance "sis_saved" will be available. This is the
5335 number of bytes saved by the SIS feature.
5337 B<Note:> The current NetApp API has a bug that results in this value being
5338 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
5339 number which works most of the time. If you see strange values here, bug
5340 NetApp support to fix this.
5342 Repeat this option to specify multiple volumes.
5344 =item B<IgnoreSelectedCapacity> B<true>|B<false>
5346 Specify whether to collect only the volumes selected by the B<GetCapacity>
5347 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
5348 B<false>. However, if no B<GetCapacity> option is specified at all, all
5349 capacities will be selected anyway.
5351 =item B<GetSnapshot> I<VolumeName>
5353 Select volumes from which to collect snapshot information.
5355 Usually, the space used for snapshots is included in the space reported as
5356 "used". If snapshot information is collected as well, the space used for
5357 snapshots is subtracted from the used space.
5359 To make things even more interesting, it is possible to reserve space to be
5360 used for snapshots. If the space required for snapshots is less than that
5361 reserved space, there is "reserved free" and "reserved used" space in addition
5362 to "free" and "used". If the space required for snapshots exceeds the reserved
5363 space, that part allocated in the normal space is subtracted from the "used"
5366 Repeat this option to specify multiple volumes.
5368 =item B<IgnoreSelectedSnapshot>
5370 Specify whether to collect only the volumes selected by the B<GetSnapshot>
5371 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
5372 B<false>. However, if no B<GetSnapshot> option is specified at all, all
5373 capacities will be selected anyway.
5377 =head3 The Quota block
5379 This will collect (tree) quota statistics (used disk space and number of used
5380 files). This mechanism is useful to get usage information for single qtrees.
5381 In case the quotas are not used for any other purpose, an entry similar to the
5382 following in C</etc/quotas> would be sufficient:
5384 /vol/volA/some_qtree tree - - - - -
5386 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
5390 =item B<Interval> I<Seconds>
5392 Collect SnapVault(R) statistics every I<Seconds> seconds.
5396 =head3 The SnapVault block
5398 This will collect statistics about the time and traffic of SnapVault(R)
5403 =item B<Interval> I<Seconds>
5405 Collect SnapVault(R) statistics every I<Seconds> seconds.
5409 =head2 Plugin C<netlink>
5411 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
5412 statistics of various interface and routing aspects.
5416 =item B<Interface> I<Interface>
5418 =item B<VerboseInterface> I<Interface>
5420 Instruct the plugin to collect interface statistics. This is basically the same
5421 as the statistics provided by the C<interface> plugin (see above) but
5422 potentially much more detailed.
5424 When configuring with B<Interface> only the basic statistics will be collected,
5425 namely octets, packets, and errors. These statistics are collected by
5426 the C<interface> plugin, too, so using both at the same time is no benefit.
5428 When configured with B<VerboseInterface> all counters B<except> the basic ones
5429 will be collected, so that no data needs to be collected twice if you use the
5430 C<interface> plugin.
5431 This includes dropped packets, received multicast packets, collisions and a
5432 whole zoo of differentiated RX and TX errors. You can try the following command
5433 to get an idea of what awaits you:
5437 If I<Interface> is B<All>, all interfaces will be selected.
5439 =item B<QDisc> I<Interface> [I<QDisc>]
5441 =item B<Class> I<Interface> [I<Class>]
5443 =item B<Filter> I<Interface> [I<Filter>]
5445 Collect the octets and packets that pass a certain qdisc, class or filter.
5447 QDiscs and classes are identified by their type and handle (or classid).
5448 Filters don't necessarily have a handle, therefore the parent's handle is used.
5449 The notation used in collectd differs from that used in tc(1) in that it
5450 doesn't skip the major or minor number if it's zero and doesn't print special
5451 ids by their name. So, for example, a qdisc may be identified by
5452 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
5453 thus not displayed by tc(1).
5455 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
5456 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
5457 associated with that interface will be collected.
5459 Since a filter itself doesn't necessarily have a handle, the parent's handle is
5460 used. This may lead to problems when more than one filter is attached to a
5461 qdisc or class. This isn't nice, but we don't know how this could be done any
5462 better. If you have a idea, please don't hesitate to tell us.
5464 As with the B<Interface> option you can specify B<All> as the interface,
5465 meaning all interfaces.
5467 Here are some examples to help you understand the above text more easily:
5470 VerboseInterface "All"
5471 QDisc "eth0" "pfifo_fast-1:0"
5473 Class "ppp0" "htb-1:10"
5474 Filter "ppp0" "u32-1:0"
5477 See F</"IGNORELISTS"> for details.
5479 =item B<IgnoreSelected>
5481 The behavior is the same as with all other similar plugins: If nothing is
5482 selected at all, everything is collected. If some things are selected using the
5483 options described above, only these statistics are collected. If you set
5484 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
5485 specified statistics will not be collected.
5489 =head2 Plugin C<network>
5491 The Network plugin sends data to a remote instance of collectd, receives data
5492 from a remote instance, or both at the same time. Data which has been received
5493 from the network is usually not transmitted again, but this can be activated, see
5494 the B<Forward> option below.
5496 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
5497 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
5499 Both, B<Server> and B<Listen> can be used as single option or as block. When
5500 used as block, given options are valid for this socket only. The following
5501 example will export the metrics twice: Once to an "internal" server (without
5502 encryption and signing) and one to an external server (with cryptographic
5506 # Export to an internal server
5507 # (demonstrates usage without additional options)
5508 Server "collectd.internal.tld"
5510 # Export to an external server
5511 # (demonstrates usage with signature options)
5512 <Server "collectd.external.tld">
5513 SecurityLevel "sign"
5514 Username "myhostname"
5521 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
5523 The B<Server> statement/block sets the server to send datagrams to. The
5524 statement may occur multiple times to send each datagram to multiple
5527 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
5528 optional second argument specifies a port number or a service name. If not
5529 given, the default, B<25826>, is used.
5531 The following options are recognized within B<Server> blocks:
5535 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5537 Set the security you require for network communication. When the security level
5538 has been set to B<Encrypt>, data sent over the network will be encrypted using
5539 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
5540 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
5541 authentication code. When set to B<None>, data is sent without any security.
5543 This feature is only available if the I<network> plugin was linked with
5546 =item B<Username> I<Username>
5548 Sets the username to transmit. This is used by the server to lookup the
5549 password. See B<AuthFile> below. All security levels except B<None> require
5552 This feature is only available if the I<network> plugin was linked with
5555 =item B<Password> I<Password>
5557 Sets a password (shared secret) for this socket. All security levels except
5558 B<None> require this setting.
5560 This feature is only available if the I<network> plugin was linked with
5563 =item B<Interface> I<Interface name>
5565 Set the outgoing interface for IP packets. This applies at least
5566 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5567 undefined or a non-existent interface name is specified, the default
5568 behavior is to let the kernel choose the appropriate interface. Be warned
5569 that the manual selection of an interface for unicast traffic is only
5570 necessary in rare cases.
5572 =item B<BindAddress> I<IP Address>
5574 Set the outgoing IP address for IP packets. This option can be used instead of
5575 the I<Interface> option to explicitly define the IP address which will be used
5576 to send Packets to the remote server.
5578 =item B<ResolveInterval> I<Seconds>
5580 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
5581 useful to force a regular DNS lookup to support a high availability setup. If
5582 not specified, re-resolves are never attempted.
5586 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
5588 The B<Listen> statement sets the interfaces to bind to. When multiple
5589 statements are found the daemon will bind to multiple interfaces.
5591 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
5592 the argument is a multicast address the daemon will join that multicast group.
5593 The optional second argument specifies a port number or a service name. If not
5594 given, the default, B<25826>, is used.
5596 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
5600 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5602 Set the security you require for network communication. When the security level
5603 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
5604 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
5605 signed and encrypted data is accepted. When set to B<None>, all data will be
5606 accepted. If an B<AuthFile> option was given (see below), encrypted data is
5607 decrypted if possible.
5609 This feature is only available if the I<network> plugin was linked with
5612 =item B<AuthFile> I<Filename>
5614 Sets a file in which usernames are mapped to passwords. These passwords are
5615 used to verify signatures and to decrypt encrypted network packets. If
5616 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
5617 verified and encrypted packets are decrypted. Otherwise, signed data is
5618 accepted without checking the signature and encrypted data cannot be decrypted.
5619 For the other security levels this option is mandatory.
5621 The file format is very simple: Each line consists of a username followed by a
5622 colon and any number of spaces followed by the password. To demonstrate, an
5623 example file could look like this:
5628 Each time a packet is received, the modification time of the file is checked
5629 using L<stat(2)>. If the file has been changed, the contents is re-read. While
5630 the file is being read, it is locked using L<fcntl(2)>.
5632 =item B<Interface> I<Interface name>
5634 Set the incoming interface for IP packets explicitly. This applies at least
5635 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5636 undefined or a non-existent interface name is specified, the default
5637 behavior is, to let the kernel choose the appropriate interface. Thus incoming
5638 traffic gets only accepted, if it arrives on the given interface.
5642 =item B<TimeToLive> I<1-255>
5644 Set the time-to-live of sent packets. This applies to all, unicast and
5645 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
5646 That means that multicast packets will be sent with a TTL of C<1> (one) on most
5649 =item B<MaxPacketSize> I<1024-65535>
5651 Set the maximum size for datagrams received over the network. Packets larger
5652 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
5653 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
5656 On the server side, this limit should be set to the largest value used on
5657 I<any> client. Likewise, the value on the client must not be larger than the
5658 value on the server, or data will be lost.
5660 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
5661 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
5662 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
5665 =item B<Forward> I<true|false>
5667 If set to I<true>, write packets that were received via the network plugin to
5668 the sending sockets. This should only be activated when the B<Listen>- and
5669 B<Server>-statements differ. Otherwise packets may be send multiple times to
5670 the same multicast group. While this results in more network traffic than
5671 necessary it's not a huge problem since the plugin has a duplicate detection,
5672 so the values will not loop.
5674 =item B<ReportStats> B<true>|B<false>
5676 The network plugin cannot only receive and send statistics, it can also create
5677 statistics about itself. Collectd data included the number of received and
5678 sent octets and packets, the length of the receive queue and the number of
5679 values handled. When set to B<true>, the I<Network plugin> will make these
5680 statistics available. Defaults to B<false>.
5684 =head2 Plugin C<nfs>
5686 The I<nfs plugin> collects information about the usage of the Network File
5687 System (NFS). It counts the number of procedure calls for each procedure,
5688 grouped by version and whether the system runs as server or client.
5690 It is possibly to omit metrics for a specific NFS version by setting one or
5691 more of the following options to B<false> (all of them default to B<true>).
5695 =item B<ReportV2> B<true>|B<false>
5697 =item B<ReportV3> B<true>|B<false>
5699 =item B<ReportV4> B<true>|B<false>
5703 =head2 Plugin C<nginx>
5705 This plugin collects the number of connections and requests handled by the
5706 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
5707 queries the page provided by the C<ngx_http_stub_status_module> module, which
5708 isn't compiled by default. Please refer to
5709 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
5710 how to compile and configure nginx and this module.
5712 The following options are accepted by the C<nginx plugin>:
5716 =item B<URL> I<http://host/nginx_status>
5718 Sets the URL of the C<ngx_http_stub_status_module> output.
5720 =item B<User> I<Username>
5722 Optional user name needed for authentication.
5724 =item B<Password> I<Password>
5726 Optional password needed for authentication.
5728 =item B<VerifyPeer> B<true|false>
5730 Enable or disable peer SSL certificate verification. See
5731 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5733 =item B<VerifyHost> B<true|false>
5735 Enable or disable peer host name verification. If enabled, the plugin checks
5736 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5737 certificate matches the host name provided by the B<URL> option. If this
5738 identity check fails, the connection is aborted. Obviously, only works when
5739 connecting to a SSL enabled server. Enabled by default.
5741 =item B<CACert> I<File>
5743 File that holds one or more SSL certificates. If you want to use HTTPS you will
5744 possibly need this option. What CA certificates come bundled with C<libcurl>
5745 and are checked by default depends on the distribution you use.
5747 =item B<Timeout> I<Milliseconds>
5749 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
5750 milliseconds. By default, the configured B<Interval> is used to set the
5755 =head2 Plugin C<notify_desktop>
5757 This plugin sends a desktop notification to a notification daemon, as defined
5758 in the Desktop Notification Specification. To actually display the
5759 notifications, B<notification-daemon> is required and B<collectd> has to be
5760 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
5761 environment variables have to be set correctly) and the D-Bus message bus.
5763 The Desktop Notification Specification can be found at
5764 L<http://www.galago-project.org/specs/notification/>.
5768 =item B<OkayTimeout> I<timeout>
5770 =item B<WarningTimeout> I<timeout>
5772 =item B<FailureTimeout> I<timeout>
5774 Set the I<timeout>, in milliseconds, after which to expire the notification
5775 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
5776 been specified, the displayed notification will not be closed at all - the
5777 user has to do so herself. These options default to 5000. If a negative number
5778 has been specified, the default is used as well.
5782 =head2 Plugin C<notify_email>
5784 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
5785 configured email address.
5787 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
5789 Available configuration options:
5793 =item B<From> I<Address>
5795 Email address from which the emails should appear to come from.
5797 Default: C<root@localhost>
5799 =item B<Recipient> I<Address>
5801 Configures the email address(es) to which the notifications should be mailed.
5802 May be repeated to send notifications to multiple addresses.
5804 At least one B<Recipient> must be present for the plugin to work correctly.
5806 =item B<SMTPServer> I<Hostname>
5808 Hostname of the SMTP server to connect to.
5810 Default: C<localhost>
5812 =item B<SMTPPort> I<Port>
5814 TCP port to connect to.
5818 =item B<SMTPUser> I<Username>
5820 Username for ASMTP authentication. Optional.
5822 =item B<SMTPPassword> I<Password>
5824 Password for ASMTP authentication. Optional.
5826 =item B<Subject> I<Subject>
5828 Subject-template to use when sending emails. There must be exactly two
5829 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
5830 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
5833 Default: C<Collectd notify: %s@%s>
5837 =head2 Plugin C<notify_nagios>
5839 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
5840 a I<passive service check result>.
5842 Available configuration options:
5846 =item B<CommandFile> I<Path>
5848 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
5852 =head2 Plugin C<ntpd>
5854 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
5857 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
5858 the wire - using B<mode 7> specific requests. This mode is deprecated with
5859 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
5860 correctly with them, the ntp daemon must be explicitly configured to
5861 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
5862 manual page for details.
5864 Available configuration options for the C<ntpd> plugin:
5868 =item B<Host> I<Hostname>
5870 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
5872 =item B<Port> I<Port>
5874 UDP-Port to connect to. Defaults to B<123>.
5876 =item B<ReverseLookups> B<true>|B<false>
5878 Sets whether or not to perform reverse lookups on peers. Since the name or
5879 IP-address may be used in a filename it is recommended to disable reverse
5880 lookups. The default is to do reverse lookups to preserve backwards
5881 compatibility, though.
5883 =item B<IncludeUnitID> B<true>|B<false>
5885 When a peer is a refclock, include the unit ID in the I<type instance>.
5886 Defaults to B<false> for backward compatibility.
5888 If two refclock peers use the same driver and this is B<false>, the plugin will
5889 try to write simultaneous measurements from both to the same type instance.
5890 This will result in error messages in the log and only one set of measurements
5895 =head2 Plugin C<nut>
5899 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
5901 Add a UPS to collect data from. The format is identical to the one accepted by
5904 =item B<ForceSSL> B<true>|B<false>
5906 Stops connections from falling back to unsecured if an SSL connection
5907 cannot be established. Defaults to false if undeclared.
5909 =item B<VerifyPeer> I<true>|I<false>
5911 If set to true, requires a CAPath be provided. Will use the CAPath to find
5912 certificates to use as Trusted Certificates to validate a upsd server certificate.
5913 If validation of the upsd server certificate fails, the connection will not be
5914 established. If ForceSSL is undeclared or set to false, setting VerifyPeer to true
5915 will override and set ForceSSL to true.
5917 =item B<CAPath> I/path/to/certs/folder
5919 If VerifyPeer is set to true, this is required. Otherwise this is ignored.
5920 The folder pointed at must contain certificate(s) named according to their hash.
5921 Ex: XXXXXXXX.Y where X is the hash value of a cert and Y is 0. If name collisions
5922 occur because two different certs have the same hash value, Y can be incremented
5923 in order to avoid conflict. To create a symbolic link to a certificate the following
5924 command can be used from within the directory where the cert resides:
5926 C<ln -s some.crt ./$(openssl x509 -hash -noout -in some.crt).0>
5928 Alternatively, the package openssl-perl provides a command C<c_rehash> that will
5929 generate links like the one described above for ALL certs in a given folder.
5931 C<c_rehash /path/to/certs/folder>
5933 =item B<ConnectTimeout> I<Milliseconds>
5935 The B<ConnectTimeout> option sets the connect timeout, in milliseconds.
5936 By default, the configured B<Interval> is used to set the timeout.
5940 =head2 Plugin C<olsrd>
5942 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
5943 the Optimized Link State Routing daemon and reads information about the current
5944 state of the meshed network.
5946 The following configuration options are understood:
5950 =item B<Host> I<Host>
5952 Connect to I<Host>. Defaults to B<"localhost">.
5954 =item B<Port> I<Port>
5956 Specifies the port to connect to. This must be a string, even if you give the
5957 port as a number rather than a service name. Defaults to B<"2006">.
5959 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
5961 Specifies what information to collect about links, i.E<nbsp>e. direct
5962 connections of the daemon queried. If set to B<No>, no information is
5963 collected. If set to B<Summary>, the number of links and the average of all
5964 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
5965 If set to B<Detail> LQ and NLQ are collected per link.
5967 Defaults to B<Detail>.
5969 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
5971 Specifies what information to collect about routes of the daemon queried. If
5972 set to B<No>, no information is collected. If set to B<Summary>, the number of
5973 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
5974 metric and ETX are collected per route.
5976 Defaults to B<Summary>.
5978 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
5980 Specifies what information to collect about the global topology. If set to
5981 B<No>, no information is collected. If set to B<Summary>, the number of links
5982 in the entire topology and the average I<link quality> (LQ) is calculated.
5983 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
5985 Defaults to B<Summary>.
5989 =head2 Plugin C<onewire>
5991 B<EXPERIMENTAL!> See notes below.
5993 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
5994 L<http://owfs.org/> to read sensors connected via the onewire bus.
5996 It can be used in two possible modes - standard or advanced.
5998 In the standard mode only temperature sensors (sensors with the family code
5999 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
6000 other sensors you would like to have included, please send a sort request to
6001 the mailing list. You can select sensors to be read or to be ignored depending
6002 on the option B<IgnoreSelected>). When no list is provided the whole bus is
6003 walked and all sensors are read.
6005 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
6006 experimental, below.
6008 In the advanced mode you can configure any sensor to be read (only numerical
6009 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
6010 In this mode you have to list all the sensors. Neither default bus walk nor
6011 B<IgnoreSelected> are used here. Address and type (file) is extracted from
6012 the path automatically and should produce compatible structure with the "standard"
6013 mode (basically the path is expected as for example
6014 "/uncached/10.F10FCA000800/temperature" where it would extract address part
6015 "F10FCA000800" and the rest after the slash is considered the type - here
6017 There are two advantages to this mode - you can access virtually any sensor
6018 (not just temperature), select whether to use cached or directly read values
6019 and it is slighlty faster. The downside is more complex configuration.
6021 The two modes are distinguished automatically by the format of the address.
6022 It is not possible to mix the two modes. Once a full path is detected in any
6023 B<Sensor> then the whole addressing (all sensors) is considered to be this way
6024 (and as standard addresses will fail parsing they will be ignored).
6028 =item B<Device> I<Device>
6030 Sets the device to read the values from. This can either be a "real" hardware
6031 device, such as a serial port or an USB port, or the address of the
6032 L<owserver(1)> socket, usually B<localhost:4304>.
6034 Though the documentation claims to automatically recognize the given address
6035 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
6036 with that version, the following configuration worked for us:
6039 Device "-s localhost:4304"
6042 This directive is B<required> and does not have a default value.
6044 =item B<Sensor> I<Sensor>
6046 In the standard mode selects sensors to collect or to ignore
6047 (depending on B<IgnoreSelected>, see below). Sensors are specified without
6048 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
6049 and B<not> include the leading C<10.> family byte and point.
6050 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
6051 sensors (see above) are read.
6053 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
6054 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
6055 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
6057 As there can be multiple devices on the bus you can list multiple sensor (use
6058 multiple B<Sensor> elements).
6060 See F</"IGNORELISTS"> for details.
6062 =item B<IgnoreSelected> I<true>|I<false>
6064 If no configuration is given, the B<onewire> plugin will collect data from all
6065 sensors found. This may not be practical, especially if sensors are added and
6066 removed regularly. Sometimes, however, it's easier/preferred to collect only
6067 specific sensors or all sensors I<except> a few specified ones. This option
6068 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
6069 B<Sensor> is inverted: All selected interfaces are ignored and all other
6070 interfaces are collected.
6072 Used only in the standard mode - see above.
6074 =item B<Interval> I<Seconds>
6076 Sets the interval in which all sensors should be read. If not specified, the
6077 global B<Interval> setting is used.
6081 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
6082 work with big setups. It works with one sensor being attached to one
6083 controller, but as soon as you throw in a couple more senors and maybe a hub
6084 or two, reading all values will take more than ten seconds (the default
6085 interval). We will probably add some separate thread for reading the sensors
6086 and some cache or something like that, but it's not done yet. We will try to
6087 maintain backwards compatibility in the future, but we can't promise. So in
6088 short: If it works for you: Great! But keep in mind that the config I<might>
6089 change, though this is unlikely. Oh, and if you want to help improving this
6090 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
6092 =head2 Plugin C<openldap>
6094 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
6095 server correctly. The backend database C<monitor> needs to be loaded and
6096 working. See slapd-monitor(5) for the details.
6098 The configuration of the C<openldap> plugin consists of one or more B<Instance>
6099 blocks. Each block requires one string argument as the instance name. For
6104 URL "ldap://localhost/"
6107 URL "ldaps://localhost/"
6111 The instance name will be used as the I<plugin instance>. To emulate the old
6112 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
6113 plugin to work correctly, each instance name must be unique. This is not
6114 enforced by the plugin and it is your responsibility to ensure it is.
6116 The following options are accepted within each B<Instance> block:
6120 =item B<URL> I<ldap://host/binddn>
6122 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
6125 =item B<BindDN> I<BindDN>
6127 Name in the form of an LDAP distinguished name intended to be used for
6128 authentication. Defaults to empty string to establish an anonymous authorization.
6130 =item B<Password> I<Password>
6132 Password for simple bind authentication. If this option is not set,
6133 unauthenticated bind operation is used.
6135 =item B<StartTLS> B<true|false>
6137 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
6138 Disabled by default.
6140 =item B<VerifyHost> B<true|false>
6142 Enables or disables peer host name verification. If enabled, the plugin checks
6143 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
6144 certificate matches the host name provided by the B<URL> option. If this
6145 identity check fails, the connection is aborted. Enabled by default.
6147 =item B<CACert> I<File>
6149 File that holds one or more SSL certificates. If you want to use TLS/SSL you
6150 may possibly need this option. What CA certificates are checked by default
6151 depends on the distribution you use and can be changed with the usual ldap
6152 client configuration mechanisms. See ldap.conf(5) for the details.
6154 =item B<Timeout> I<Seconds>
6156 Sets the timeout value for ldap operations, in seconds. By default, the
6157 configured B<Interval> is used to set the timeout. Use B<-1> to disable
6160 =item B<Version> I<Version>
6162 An integer which sets the LDAP protocol version number to use when connecting
6163 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
6167 =head2 Plugin C<openvpn>
6169 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
6170 traffic statistics about connected clients.
6172 To set up OpenVPN to write to the status file periodically, use the
6173 B<--status> option of OpenVPN.
6175 So, in a nutshell you need:
6177 openvpn $OTHER_OPTIONS \
6178 --status "/var/run/openvpn-status" 10
6184 =item B<StatusFile> I<File>
6186 Specifies the location of the status file.
6188 =item B<ImprovedNamingSchema> B<true>|B<false>
6190 When enabled, the filename of the status file will be used as plugin instance
6191 and the client's "common name" will be used as type instance. This is required
6192 when reading multiple status files. Enabling this option is recommended, but to
6193 maintain backwards compatibility this option is disabled by default.
6195 =item B<CollectCompression> B<true>|B<false>
6197 Sets whether or not statistics about the compression used by OpenVPN should be
6198 collected. This information is only available in I<single> mode. Enabled by
6201 =item B<CollectIndividualUsers> B<true>|B<false>
6203 Sets whether or not traffic information is collected for each connected client
6204 individually. If set to false, currently no traffic data is collected at all
6205 because aggregating this data in a save manner is tricky. Defaults to B<true>.
6207 =item B<CollectUserCount> B<true>|B<false>
6209 When enabled, the number of currently connected clients or users is collected.
6210 This is especially interesting when B<CollectIndividualUsers> is disabled, but
6211 can be configured independently from that option. Defaults to B<false>.
6215 =head2 Plugin C<oracle>
6217 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
6218 Oracle® Database and lets you execute SQL statements there. It is very similar
6219 to the "dbi" plugin, because it was written around the same time. See the "dbi"
6220 plugin's documentation above for details.
6223 <Query "out_of_stock">
6224 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
6227 # InstancePrefix "foo"
6228 InstancesFrom "category"
6232 <Database "product_information">
6237 Query "out_of_stock"
6241 =head3 B<Query> blocks
6243 The Query blocks are handled identically to the Query blocks of the "dbi"
6244 plugin. Please see its documentation above for details on how to specify
6247 =head3 B<Database> blocks
6249 Database blocks define a connection to a database and which queries should be
6250 sent to that database. Each database needs a "name" as string argument in the
6251 starting tag of the block. This name will be used as "PluginInstance" in the
6252 values submitted to the daemon. Other than that, that name is not used.
6256 =item B<Plugin> I<Plugin>
6258 Use I<Plugin> as the plugin name when submitting query results from
6259 this B<Database>. Defaults to C<oracle>.
6261 =item B<ConnectID> I<ID>
6263 Defines the "database alias" or "service name" to connect to. Usually, these
6264 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
6266 =item B<Host> I<Host>
6268 Hostname to use when dispatching values for this database. Defaults to using
6269 the global hostname of the I<collectd> instance.
6271 =item B<Username> I<Username>
6273 Username used for authentication.
6275 =item B<Password> I<Password>
6277 Password used for authentication.
6279 =item B<Query> I<QueryName>
6281 Associates the query named I<QueryName> with this database connection. The
6282 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
6283 blocks you want to refer to must be placed above the database block you want to
6288 =head2 Plugin C<ovs_events>
6290 The I<ovs_events> plugin monitors the link status of I<Open vSwitch> (OVS)
6291 connected interfaces, dispatches the values to collectd and sends the
6292 notification whenever the link state change occurs. This plugin uses OVS
6293 database to get a link state change notification.
6297 <Plugin "ovs_events">
6300 Socket "/var/run/openvswitch/db.sock"
6301 Interfaces "br0" "veth0"
6302 SendNotification true
6303 DispatchValues false
6306 The plugin provides the following configuration options:
6310 =item B<Address> I<node>
6312 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6313 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6314 option. See L<ovsdb-server(1)> for more details. The option may be either
6315 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6316 format. Defaults to C<localhost>.
6318 =item B<Port> I<service>
6320 TCP-port to connect to. Either a service name or a port number may be given.
6321 Defaults to B<6640>.
6323 =item B<Socket> I<path>
6325 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6326 plugin. To enable the interface, the OVS DB daemon should be running with
6327 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6328 option is set, B<Address> and B<Port> options are ignored.
6330 =item B<Interfaces> [I<ifname> ...]
6332 List of interface names to be monitored by this plugin. If this option is not
6333 specified or is empty then all OVS connected interfaces on all bridges are
6336 Default: empty (all interfaces on all bridges are monitored)
6338 =item B<SendNotification> I<true|false>
6340 If set to true, OVS link notifications (interface status and OVS DB connection
6341 terminate) are sent to collectd. Default value is true.
6343 =item B<DispatchValues> I<true|false>
6345 Dispatch the OVS DB interface link status value with configured plugin interval.
6346 Defaults to false. Please note, if B<SendNotification> and B<DispatchValues>
6347 options are false, no OVS information will be provided by the plugin.
6351 B<Note:> By default, the global interval setting is used within which to
6352 retrieve the OVS link status. To configure a plugin-specific interval, please
6353 use B<Interval> option of the OVS B<LoadPlugin> block settings. For milliseconds
6354 simple divide the time by 1000 for example if the desired interval is 50ms, set
6357 =head2 Plugin C<ovs_stats>
6359 The I<ovs_stats> plugin collects statistics of OVS connected interfaces.
6360 This plugin uses OVSDB management protocol (RFC7047) monitor mechanism to get
6361 statistics from OVSDB
6365 <Plugin "ovs_stats">
6368 Socket "/var/run/openvswitch/db.sock"
6369 Bridges "br0" "br_ext"
6370 InterfaceStats false
6373 The plugin provides the following configuration options:
6377 =item B<Address> I<node>
6379 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6380 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6381 option. See L<ovsdb-server(1)> for more details. The option may be either
6382 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6383 format. Defaults to C<localhost>.
6385 =item B<Port> I<service>
6387 TCP-port to connect to. Either a service name or a port number may be given.
6388 Defaults to B<6640>.
6390 =item B<Socket> I<path>
6392 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6393 plugin. To enable the interface, the OVS DB daemon should be running with
6394 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6395 option is set, B<Address> and B<Port> options are ignored.
6397 =item B<Bridges> [I<brname> ...]
6399 List of OVS bridge names to be monitored by this plugin. If this option is
6400 omitted or is empty then all OVS bridges will be monitored.
6402 Default: empty (monitor all bridges)
6404 =item B<InterfaceStats> B<false>|B<true>
6406 Indicates that the plugin should gather statistics for individual interfaces
6407 in addition to ports. This can be useful when monitoring an OVS setup with
6408 bond ports, where you might wish to know individual statistics for the
6409 interfaces included in the bonds. Defaults to B<false>.
6413 =head2 Plugin C<pcie_errors>
6415 The I<pcie_errors> plugin collects PCI Express errors from Device Status in Capability
6416 structure and from Advanced Error Reporting Extended Capability where available.
6417 At every read it polls config space of PCI Express devices and dispatches
6418 notification for every error that is set. It checks for new errors at every read.
6419 The device is indicated in plugin_instance according to format "domain:bus:dev.fn".
6420 Errors are divided into categories indicated by type_instance: "correctable", and
6421 for uncorrectable errors "non_fatal" or "fatal".
6422 Fatal errors are reported as I<NOTIF_FAILURE> and all others as I<NOTIF_WARNING>.
6426 <Plugin "pcie_errors">
6428 AccessDir "/sys/bus/pci"
6430 PersistentNotifications false
6437 =item B<Source> B<sysfs>|B<proc>
6439 Use B<sysfs> or B<proc> to read data from /sysfs or /proc.
6440 The default value is B<sysfs>.
6442 =item B<AccessDir> I<dir>
6444 Directory used to access device config space. It is optional and defaults to
6445 /sys/bus/pci for B<sysfs> and to /proc/bus/pci for B<proc>.
6447 =item B<ReportMasked> B<false>|B<true>
6449 If true plugin will notify about errors that are set to masked in Error Mask register.
6450 Such errors are not reported to the PCI Express Root Complex. Defaults to B<false>.
6452 =item B<PersistentNotifications> B<false>|B<true>
6454 If false plugin will dispatch notification only on set/clear of error.
6455 The ones already reported will be ignored. Defaults to B<false>.
6459 =head2 Plugin C<perl>
6461 This plugin embeds a Perl-interpreter into collectd and provides an interface
6462 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
6464 =head2 Plugin C<pinba>
6466 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
6467 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
6468 PHP-based webpage has been delivered, the extension will send a UDP packet
6469 containing timing information, peak memory usage and so on. The plugin will
6470 wait for such packets, parse them and account the provided information, which
6471 is then dispatched to the daemon once per interval.
6478 # Overall statistics for the website.
6480 Server "www.example.com"
6482 # Statistics for www-a only
6484 Host "www-a.example.com"
6485 Server "www.example.com"
6487 # Statistics for www-b only
6489 Host "www-b.example.com"
6490 Server "www.example.com"
6494 The plugin provides the following configuration options:
6498 =item B<Address> I<Node>
6500 Configures the address used to open a listening socket. By default, plugin will
6501 bind to the I<any> address C<::0>.
6503 =item B<Port> I<Service>
6505 Configures the port (service) to bind to. By default the default Pinba port
6506 "30002" will be used. The option accepts service names in addition to port
6507 numbers and thus requires a I<string> argument.
6509 =item E<lt>B<View> I<Name>E<gt> block
6511 The packets sent by the Pinba extension include the hostname of the server, the
6512 server name (the name of the virtual host) and the script that was executed.
6513 Using B<View> blocks it is possible to separate the data into multiple groups
6514 to get more meaningful statistics. Each packet is added to all matching groups,
6515 so that a packet may be accounted for more than once.
6519 =item B<Host> I<Host>
6521 Matches the hostname of the system the webserver / script is running on. This
6522 will contain the result of the L<gethostname(2)> system call. If not
6523 configured, all hostnames will be accepted.
6525 =item B<Server> I<Server>
6527 Matches the name of the I<virtual host>, i.e. the contents of the
6528 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
6529 server names will be accepted.
6531 =item B<Script> I<Script>
6533 Matches the name of the I<script name>, i.e. the contents of the
6534 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
6535 script names will be accepted.
6541 =head2 Plugin C<ping>
6543 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
6544 configured hosts periodically and measures the network latency. Whenever the
6545 C<read> function of the plugin is called, it submits the average latency, the
6546 standard deviation and the drop rate for each host.
6548 Available configuration options:
6552 =item B<Host> I<IP-address>
6554 Host to ping periodically. This option may be repeated several times to ping
6557 =item B<Interval> I<Seconds>
6559 Sets the interval in which to send ICMP echo packets to the configured hosts.
6560 This is B<not> the interval in which metrics are read from the plugin but the
6561 interval in which the hosts are "pinged". Therefore, the setting here should be
6562 smaller than or equal to the global B<Interval> setting. Fractional times, such
6563 as "1.24" are allowed.
6567 =item B<Timeout> I<Seconds>
6569 Time to wait for a response from the host to which an ICMP packet had been
6570 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
6571 to be down or the packet to be dropped. This setting must be smaller than the
6572 B<Interval> setting above for the plugin to work correctly. Fractional
6573 arguments are accepted.
6577 =item B<TTL> I<0-255>
6579 Sets the Time-To-Live of generated ICMP packets.
6581 =item B<Size> I<size>
6583 Sets the size of the data payload in ICMP packet to specified I<size> (it
6584 will be filled with regular ASCII pattern). If not set, default 56 byte
6585 long string is used so that the packet size of an ICMPv4 packet is exactly
6586 64 bytes, similar to the behaviour of normal ping(1) command.
6588 =item B<SourceAddress> I<host>
6590 Sets the source address to use. I<host> may either be a numerical network
6591 address or a network hostname.
6593 =item B<AddressFamily> I<af>
6595 Sets the address family to use. I<af> may be "any", "ipv4" or "ipv6". This
6596 option will be ignored if you set a B<SourceAddress>.
6598 =item B<Device> I<name>
6600 Sets the outgoing network device to be used. I<name> has to specify an
6601 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
6604 =item B<MaxMissed> I<Packets>
6606 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
6607 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
6609 Default: B<-1> (disabled)
6613 =head2 Plugin C<postgresql>
6615 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
6616 keeps a persistent connection to all configured databases and tries to
6617 reconnect if the connection has been interrupted. A database is configured by
6618 specifying a B<Database> block as described below. The default statistics are
6619 collected from PostgreSQL's B<statistics collector> which thus has to be
6620 enabled for this plugin to work correctly. This should usually be the case by
6621 default. See the section "The Statistics Collector" of the B<PostgreSQL
6622 Documentation> for details.
6624 By specifying custom database queries using a B<Query> block as described
6625 below, you may collect any data that is available from some PostgreSQL
6626 database. This way, you are able to access statistics of external daemons
6627 which are available in a PostgreSQL database or use future or special
6628 statistics provided by PostgreSQL without the need to upgrade your collectd
6631 Starting with version 5.2, the C<postgresql> plugin supports writing data to
6632 PostgreSQL databases as well. This has been implemented in a generic way. You
6633 need to specify an SQL statement which will then be executed by collectd in
6634 order to write the data (see below for details). The benefit of that approach
6635 is that there is no fixed database layout. Rather, the layout may be optimized
6636 for the current setup.
6638 The B<PostgreSQL Documentation> manual can be found at
6639 L<http://www.postgresql.org/docs/manuals/>.
6643 Statement "SELECT magic FROM wizard WHERE host = $1;"
6647 InstancePrefix "magic"
6652 <Query rt36_tickets>
6653 Statement "SELECT COUNT(type) AS count, type \
6655 WHEN resolved = 'epoch' THEN 'open' \
6656 ELSE 'resolved' END AS type \
6657 FROM tickets) type \
6661 InstancePrefix "rt36_tickets"
6662 InstancesFrom "type"
6668 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
6679 KRBSrvName "kerberos_service_name"
6685 Service "service_name"
6686 Query backends # predefined
6697 The B<Query> block defines one database query which may later be used by a
6698 database definition. It accepts a single mandatory argument which specifies
6699 the name of the query. The names of all queries have to be unique (see the
6700 B<MinVersion> and B<MaxVersion> options below for an exception to this
6703 In each B<Query> block, there is one or more B<Result> blocks. Multiple
6704 B<Result> blocks may be used to extract multiple values from a single query.
6706 The following configuration options are available to define the query:
6710 =item B<Statement> I<sql query statement>
6712 Specify the I<sql query statement> which the plugin should execute. The string
6713 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
6714 first, second, etc. parameter. The value of the parameters is specified by the
6715 B<Param> configuration option - see below for details. To include a literal
6716 B<$> character followed by a number, surround it with single quotes (B<'>).
6718 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
6719 allowed. Note, however, that only a single command may be used. Semicolons are
6720 allowed as long as a single non-empty command has been specified only.
6722 The returned lines will be handled separately one after another.
6724 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
6726 Specify the parameters which should be passed to the SQL query. The parameters
6727 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
6728 they appear in the configuration file. The value of the parameter is
6729 determined depending on the value of the B<Param> option as follows:
6735 The configured hostname of the database connection. If a UNIX domain socket is
6736 used, the parameter expands to "localhost".
6740 The name of the database of the current connection.
6744 The name of the database plugin instance. See the B<Instance> option of the
6745 database specification below for details.
6749 The username used to connect to the database.
6753 The interval with which this database is queried (as specified by the database
6754 specific or global B<Interval> options).
6758 Please note that parameters are only supported by PostgreSQL's protocol
6759 version 3 and above which was introduced in version 7.4 of PostgreSQL.
6761 =item B<PluginInstanceFrom> I<column>
6763 Specify how to create the "PluginInstance" for reporting this query results.
6764 Only one column is supported. You may concatenate fields and string values in
6765 the query statement to get the required results.
6767 =item B<MinVersion> I<version>
6769 =item B<MaxVersion> I<version>
6771 Specify the minimum or maximum version of PostgreSQL that this query should be
6772 used with. Some statistics might only be available with certain versions of
6773 PostgreSQL. This allows you to specify multiple queries with the same name but
6774 which apply to different versions, thus allowing you to use the same
6775 configuration in a heterogeneous environment.
6777 The I<version> has to be specified as the concatenation of the major, minor
6778 and patch-level versions, each represented as two-decimal-digit numbers. For
6779 example, version 8.2.3 will become 80203.
6783 The B<Result> block defines how to handle the values returned from the query.
6784 It defines which column holds which value and how to dispatch that value to
6789 =item B<Type> I<type>
6791 The I<type> name to be used when dispatching the values. The type describes
6792 how to handle the data and where to store it. See L<types.db(5)> for more
6793 details on types and their configuration. The number and type of values (as
6794 selected by the B<ValuesFrom> option) has to match the type of the given name.
6796 This option is mandatory.
6798 =item B<InstancePrefix> I<prefix>
6800 =item B<InstancesFrom> I<column0> [I<column1> ...]
6802 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
6803 B<InstancePrefix> defines a static prefix that will be prepended to all type
6804 instances. B<InstancesFrom> defines the column names whose values will be used
6805 to create the type instance. Multiple values will be joined together using the
6806 hyphen (C<->) as separation character.
6808 The plugin itself does not check whether or not all built instances are
6809 different. It is your responsibility to assure that each is unique.
6811 Both options are optional. If none is specified, the type instance will be
6814 =item B<ValuesFrom> I<column0> [I<column1> ...]
6816 Names the columns whose content is used as the actual data for the data sets
6817 that are dispatched to the daemon. How many such columns you need is
6818 determined by the B<Type> setting as explained above. If you specify too many
6819 or not enough columns, the plugin will complain about that and no data will be
6820 submitted to the daemon.
6822 The actual data type, as seen by PostgreSQL, is not that important as long as
6823 it represents numbers. The plugin will automatically cast the values to the
6824 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
6825 L<strtod(3)> functions, so anything supported by those functions is supported
6826 by the plugin as well.
6828 This option is required inside a B<Result> block and may be specified multiple
6829 times. If multiple B<ValuesFrom> options are specified, the columns are read
6834 The following predefined queries are available (the definitions can be found
6835 in the F<postgresql_default.conf> file which, by default, is available at
6836 C<I<prefix>/share/collectd/>):
6842 This query collects the number of backends, i.E<nbsp>e. the number of
6845 =item B<transactions>
6847 This query collects the numbers of committed and rolled-back transactions of
6852 This query collects the numbers of various table modifications (i.E<nbsp>e.
6853 insertions, updates, deletions) of the user tables.
6855 =item B<query_plans>
6857 This query collects the numbers of various table scans and returned tuples of
6860 =item B<table_states>
6862 This query collects the numbers of live and dead rows in the user tables.
6866 This query collects disk block access counts for user tables.
6870 This query collects the on-disk size of the database in bytes.
6874 In addition, the following detailed queries are available by default. Please
6875 note that each of those queries collects information B<by table>, thus,
6876 potentially producing B<a lot> of data. For details see the description of the
6877 non-by_table queries above.
6881 =item B<queries_by_table>
6883 =item B<query_plans_by_table>
6885 =item B<table_states_by_table>
6887 =item B<disk_io_by_table>
6891 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
6892 mandatory argument specifying the name of the writer. This will then be used
6893 in the B<Database> specification in order to activate the writer instance. The
6894 names of all writers have to be unique. The following options may be
6899 =item B<Statement> I<sql statement>
6901 This mandatory option specifies the SQL statement that will be executed for
6902 each submitted value. A single SQL statement is allowed only. Anything after
6903 the first semicolon will be ignored.
6905 Nine parameters will be passed to the statement and should be specified as
6906 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
6907 values are made available through those parameters:
6913 The timestamp of the queried value as an RFC 3339-formatted local time.
6917 The hostname of the queried value.
6921 The plugin name of the queried value.
6925 The plugin instance of the queried value. This value may be B<NULL> if there
6926 is no plugin instance.
6930 The type of the queried value (cf. L<types.db(5)>).
6934 The type instance of the queried value. This value may be B<NULL> if there is
6939 An array of names for the submitted values (i.E<nbsp>e., the name of the data
6940 sources of the submitted value-list).
6944 An array of types for the submitted values (i.E<nbsp>e., the type of the data
6945 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
6946 B<StoreRates> is enabled (which is the default, see below), all types will be
6951 An array of the submitted values. The dimensions of the value name and value
6956 In general, it is advisable to create and call a custom function in the
6957 PostgreSQL database for this purpose. Any procedural language supported by
6958 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
6961 =item B<StoreRates> B<false>|B<true>
6963 If set to B<true> (the default), convert counter values to rates. If set to
6964 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6969 The B<Database> block defines one PostgreSQL database for which to collect
6970 statistics. It accepts a single mandatory argument which specifies the
6971 database name. None of the other options are required. PostgreSQL will use
6972 default values as documented in the section "CONNECTING TO A DATABASE" in the
6973 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
6974 the user collectd is run as and special environment variables. See the manpage
6979 =item B<Interval> I<seconds>
6981 Specify the interval with which the database should be queried. The default is
6982 to use the global B<Interval> setting.
6984 =item B<CommitInterval> I<seconds>
6986 This option may be used for database connections which have "writers" assigned
6987 (see above). If specified, it causes a writer to put several updates into a
6988 single transaction. This transaction will last for the specified amount of
6989 time. By default, each update will be executed in a separate transaction. Each
6990 transaction generates a fair amount of overhead which can, thus, be reduced by
6991 activating this option. The draw-back is, that data covering the specified
6992 amount of time will be lost, for example, if a single statement within the
6993 transaction fails or if the database server crashes.
6995 =item B<Plugin> I<Plugin>
6997 Use I<Plugin> as the plugin name when submitting query results from
6998 this B<Database>. Defaults to C<postgresql>.
7000 =item B<Instance> I<name>
7002 Specify the plugin instance name that should be used instead of the database
7003 name (which is the default, if this option has not been specified). This
7004 allows one to query multiple databases of the same name on the same host (e.g.
7005 when running multiple database server versions in parallel).
7006 The plugin instance name can also be set from the query result using
7007 the B<PluginInstanceFrom> option in B<Query> block.
7009 =item B<Host> I<hostname>
7011 Specify the hostname or IP of the PostgreSQL server to connect to. If the
7012 value begins with a slash, it is interpreted as the directory name in which to
7013 look for the UNIX domain socket.
7015 This option is also used to determine the hostname that is associated with a
7016 collected data set. If it has been omitted or either begins with with a slash
7017 or equals B<localhost> it will be replaced with the global hostname definition
7018 of collectd. Any other value will be passed literally to collectd when
7019 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
7021 =item B<Port> I<port>
7023 Specify the TCP port or the local UNIX domain socket file extension of the
7026 =item B<User> I<username>
7028 Specify the username to be used when connecting to the server.
7030 =item B<Password> I<password>
7032 Specify the password to be used when connecting to the server.
7034 =item B<ExpireDelay> I<delay>
7036 Skip expired values in query output.
7038 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
7040 Specify whether to use an SSL connection when contacting the server. The
7041 following modes are supported:
7047 Do not use SSL at all.
7051 First, try to connect without using SSL. If that fails, try using SSL.
7053 =item I<prefer> (default)
7055 First, try to connect using SSL. If that fails, try without using SSL.
7063 =item B<Instance> I<name>
7065 Specify the plugin instance name that should be used instead of the database
7066 name (which is the default, if this option has not been specified). This
7067 allows one to query multiple databases of the same name on the same host (e.g.
7068 when running multiple database server versions in parallel).
7070 =item B<KRBSrvName> I<kerberos_service_name>
7072 Specify the Kerberos service name to use when authenticating with Kerberos 5
7073 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
7074 B<PostgreSQL Documentation> for details.
7076 =item B<Service> I<service_name>
7078 Specify the PostgreSQL service name to use for additional parameters. That
7079 service has to be defined in F<pg_service.conf> and holds additional
7080 connection parameters. See the section "The Connection Service File" in the
7081 B<PostgreSQL Documentation> for details.
7083 =item B<Query> I<query>
7085 Specifies a I<query> which should be executed in the context of the database
7086 connection. This may be any of the predefined or user-defined queries. If no
7087 such option is given, it defaults to "backends", "transactions", "queries",
7088 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
7089 has been specified). Else, the specified queries are used only.
7091 =item B<Writer> I<writer>
7093 Assigns the specified I<writer> backend to the database connection. This
7094 causes all collected data to be send to the database using the settings
7095 defined in the writer configuration (see the section "FILTER CONFIGURATION"
7096 below for details on how to selectively send data to certain plugins).
7098 Each writer will register a flush callback which may be used when having long
7099 transactions enabled (see the B<CommitInterval> option above). When issuing
7100 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
7101 transaction will be committed right away. Two different kinds of flush
7102 callbacks are available with the C<postgresql> plugin:
7108 Flush all writer backends.
7110 =item B<postgresql->I<database>
7112 Flush all writers of the specified I<database> only.
7118 =head2 Plugin C<powerdns>
7120 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
7121 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
7122 values, many of which are probably meaningless to most users, but may be useful
7123 for some. So you may chose which values to collect, but if you don't, some
7124 reasonable defaults will be collected.
7127 <Server "server_name">
7129 Collect "udp-answers" "udp-queries"
7130 Socket "/var/run/pdns.controlsocket"
7132 <Recursor "recursor_name">
7134 Collect "cache-hits" "cache-misses"
7135 Socket "/var/run/pdns_recursor.controlsocket"
7137 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
7142 =item B<Server> and B<Recursor> block
7144 The B<Server> block defines one authoritative server to query, the B<Recursor>
7145 does the same for an recursing server. The possible options in both blocks are
7146 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
7151 =item B<Collect> I<Field>
7153 Using the B<Collect> statement you can select which values to collect. Here,
7154 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
7155 C<dlg-only-drops>, C<answers10-100>.
7157 The method of getting the values differs for B<Server> and B<Recursor> blocks:
7158 When querying the server a C<SHOW *> command is issued in any case, because
7159 that's the only way of getting multiple values out of the server at once.
7160 collectd then picks out the values you have selected. When querying the
7161 recursor, a command is generated to query exactly these values. So if you
7162 specify invalid fields when querying the recursor, a syntax error may be
7163 returned by the daemon and collectd may not collect any values at all.
7165 If no B<Collect> statement is given, the following B<Server> values will be
7172 =item packetcache-hit
7174 =item packetcache-miss
7176 =item packetcache-size
7178 =item query-cache-hit
7180 =item query-cache-miss
7182 =item recursing-answers
7184 =item recursing-questions
7196 The following B<Recursor> values will be collected by default:
7200 =item noerror-answers
7202 =item nxdomain-answers
7204 =item servfail-answers
7222 Please note that up to that point collectd doesn't know what values are
7223 available on the server and values that are added do not need a change of the
7224 mechanism so far. However, the values must be mapped to collectd's naming
7225 scheme, which is done using a lookup table that lists all known values. If
7226 values are added in the future and collectd does not know about them, you will
7227 get an error much like this:
7229 powerdns plugin: submit: Not found in lookup table: foobar = 42
7231 In this case please file a bug report with the collectd team.
7233 =item B<Socket> I<Path>
7235 Configures the path to the UNIX domain socket to be used when connecting to the
7236 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
7237 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
7238 will be used for the recursor.
7242 =item B<LocalSocket> I<Path>
7244 Querying the recursor is done using UDP. When using UDP over UNIX domain
7245 sockets, the client socket needs a name in the file system, too. You can set
7246 this local name to I<Path> using the B<LocalSocket> option. The default is
7247 C<I<prefix>/var/run/collectd-powerdns>.
7251 =head2 Plugin C<processes>
7253 Collects information about processes of local system.
7255 By default, with no process matches configured, only general statistics is
7256 collected: the number of processes in each state and fork rate.
7258 Process matches can be configured by B<Process> and B<ProcessMatch> options.
7259 These may also be a block in which further options may be specified.
7261 The statistics collected for matched processes are:
7262 - size of the resident segment size (RSS)
7263 - user- and system-time used
7264 - number of processes
7266 - number of open files (under Linux)
7267 - number of memory mapped files (under Linux)
7268 - io data (where available)
7269 - context switches (under Linux)
7270 - minor and major pagefaults
7271 - Delay Accounting information (Linux only, requires libmnl)
7276 CollectFileDescriptor true
7277 CollectContextSwitch true
7278 CollectDelayAccounting false
7280 ProcessMatch "name" "regex"
7281 <Process "collectd">
7282 CollectFileDescriptor false
7283 CollectContextSwitch false
7284 CollectDelayAccounting true
7286 <ProcessMatch "name" "regex">
7287 CollectFileDescriptor false
7288 CollectContextSwitch true
7294 =item B<Process> I<Name>
7296 Select more detailed statistics of processes matching this name.
7298 Some platforms have a limit on the length of process names.
7299 I<Name> must stay below this limit.
7301 =item B<ProcessMatch> I<name> I<regex>
7303 Select more detailed statistics of processes matching the specified I<regex>
7304 (see L<regex(7)> for details). The statistics of all matching processes are
7305 summed up and dispatched to the daemon using the specified I<name> as an
7306 identifier. This allows one to "group" several processes together.
7307 I<name> must not contain slashes.
7309 =item B<CollectContextSwitch> I<Boolean>
7311 Collect the number of context switches for matched processes.
7312 Disabled by default.
7314 =item B<CollectDelayAccounting> I<Boolean>
7316 If enabled, collect Linux Delay Accounding information for matching processes.
7317 Delay Accounting provides the time processes wait for the CPU to become
7318 available, for I/O operations to finish, for pages to be swapped in and for
7319 freed pages to be reclaimed. The metrics are reported as "seconds per second"
7320 using the C<delay_rate> type, e.g. C<delay_rate-delay-cpu>.
7321 Disabled by default.
7323 This option is only available on Linux, requires the C<libmnl> library and
7324 requires the C<CAP_NET_ADMIN> capability at runtime.
7326 =item B<CollectFileDescriptor> I<Boolean>
7328 Collect number of file descriptors of matched processes.
7329 Disabled by default.
7331 =item B<CollectMemoryMaps> I<Boolean>
7333 Collect the number of memory mapped files of the process.
7334 The limit for this number is configured via F</proc/sys/vm/max_map_count> in
7339 The B<CollectContextSwitch>, B<CollectDelayAccounting>,
7340 B<CollectFileDescriptor> and B<CollectMemoryMaps> options may be used inside
7341 B<Process> and B<ProcessMatch> blocks. When used there, these options affect
7342 reporting the corresponding processes only. Outside of B<Process> and
7343 B<ProcessMatch> blocks these options set the default value for subsequent
7346 =head2 Plugin C<procevent>
7348 The I<procevent> plugin monitors when processes start (EXEC) and stop (EXIT).
7355 ProcessRegex "regex"
7362 =item B<BufferLength> I<length>
7364 Maximum number of process events that can be stored in plugin's ring buffer.
7365 By default, this is set to 10. Once an event has been read, its location
7366 becomes available for storing a new event.
7368 =item B<Process> I<name>
7370 Enumerate a process name to monitor. All processes that match this exact
7371 name will be monitored for EXECs and EXITs.
7373 =item B<ProcessRegex> I<regex>
7375 Enumerate a process pattern to monitor. All processes that match this
7376 regular expression will be monitored for EXECs and EXITs.
7380 =head2 Plugin C<protocols>
7382 Collects a lot of information about various network protocols, such as I<IP>,
7383 I<TCP>, I<UDP>, etc.
7385 Available configuration options:
7389 =item B<Value> I<Selector>
7391 Selects whether or not to select a specific value. The string being matched is
7392 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
7393 plugin instance and I<ValueName> will be used as type instance. An example of
7394 the string being used would be C<Tcp:RetransSegs>.
7396 You can use regular expressions to match a large number of values with just one
7397 configuration option. To select all "extended" I<TCP> values, you could use the
7398 following statement:
7402 Whether only matched values are selected or all matched values are ignored
7403 depends on the B<IgnoreSelected>. By default, only matched values are selected.
7404 If no value is configured at all, all values will be selected.
7406 See F</"IGNORELISTS"> for details.
7408 =item B<IgnoreSelected> B<true>|B<false>
7410 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
7411 matching values will be ignored.
7415 =head2 Plugin C<python>
7417 This plugin embeds a Python-interpreter into collectd and provides an interface
7418 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
7420 =head2 Plugin C<routeros>
7422 The C<routeros> plugin connects to a device running I<RouterOS>, the
7423 Linux-based operating system for routers by I<MikroTik>. The plugin uses
7424 I<librouteros> to connect and reads information about the interfaces and
7425 wireless connections of the device. The configuration supports querying
7430 Host "router0.example.com"
7433 CollectInterface true
7438 Host "router1.example.com"
7441 CollectInterface true
7442 CollectRegistrationTable true
7449 As you can see above, the configuration of the I<routeros> plugin consists of
7450 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
7451 options are understood:
7455 =item B<Host> I<Host>
7457 Hostname or IP-address of the router to connect to.
7459 =item B<Port> I<Port>
7461 Port name or port number used when connecting. If left unspecified, the default
7462 will be chosen by I<librouteros>, currently "8728". This option expects a
7463 string argument, even when a numeric port number is given.
7465 =item B<User> I<User>
7467 Use the user name I<User> to authenticate. Defaults to "admin".
7469 =item B<Password> I<Password>
7471 Set the password used to authenticate.
7473 =item B<CollectInterface> B<true>|B<false>
7475 When set to B<true>, interface statistics will be collected for all interfaces
7476 present on the device. Defaults to B<false>.
7478 =item B<CollectRegistrationTable> B<true>|B<false>
7480 When set to B<true>, information about wireless LAN connections will be
7481 collected. Defaults to B<false>.
7483 =item B<CollectCPULoad> B<true>|B<false>
7485 When set to B<true>, information about the CPU usage will be collected. The
7486 number is a dimensionless value where zero indicates no CPU usage at all.
7487 Defaults to B<false>.
7489 =item B<CollectMemory> B<true>|B<false>
7491 When enabled, the amount of used and free memory will be collected. How used
7492 memory is calculated is unknown, for example whether or not caches are counted
7494 Defaults to B<false>.
7496 =item B<CollectDF> B<true>|B<false>
7498 When enabled, the amount of used and free disk space will be collected.
7499 Defaults to B<false>.
7501 =item B<CollectDisk> B<true>|B<false>
7503 When enabled, the number of sectors written and bad blocks will be collected.
7504 Defaults to B<false>.
7506 =item B<CollectHealth> B<true>|B<false>
7508 When enabled, the health statistics will be collected. This includes the
7509 voltage and temperature on supported hardware.
7510 Defaults to B<false>.
7514 =head2 Plugin C<redis>
7516 The I<Redis plugin> connects to one or more Redis servers, gathers
7517 information about each server's state and executes user-defined queries.
7518 For each server there is a I<Node> block which configures the connection
7519 parameters and set of user-defined queries for this node.
7525 #Socket "/var/run/redis/redis.sock"
7527 ReportCommandStats false
7529 <Query "LLEN myqueue">
7539 =item B<Node> I<Nodename>
7541 The B<Node> block identifies a new Redis node, that is a new Redis instance
7542 running in an specified host and port. The name for node is a canonical
7543 identifier which is used as I<plugin instance>. It is limited to
7544 128E<nbsp>characters in length.
7546 When no B<Node> is configured explicitly, plugin connects to "localhost:6379".
7548 =item B<Host> I<Hostname>
7550 The B<Host> option is the hostname or IP-address where the Redis instance is
7553 =item B<Port> I<Port>
7555 The B<Port> option is the TCP port on which the Redis instance accepts
7556 connections. Either a service name of a port number may be given. Please note
7557 that numerical port numbers must be given as a string, too.
7559 =item B<Socket> I<Path>
7561 Connect to Redis using the UNIX domain socket at I<Path>. If this
7562 setting is given, the B<Hostname> and B<Port> settings are ignored.
7564 =item B<Password> I<Password>
7566 Use I<Password> to authenticate when connecting to I<Redis>.
7568 =item B<Timeout> I<Milliseconds>
7570 The B<Timeout> option set the socket timeout for node response. Since the Redis
7571 read function is blocking, you should keep this value as low as possible.
7572 It is expected what B<Timeout> values should be lower than B<Interval> defined
7575 Defaults to 2000 (2 seconds).
7577 =item B<ReportCommandStats> B<false>|B<true>
7579 Enables or disables reporting of statistics based on the command type, including
7580 rate of command calls and average CPU time consumed by command processing.
7581 Defaults to B<false>.
7583 =item B<ReportCpuUsage> B<true>|B<false>
7585 Enables or disables reporting of CPU consumption statistics.
7586 Defaults to B<true>.
7588 =item B<Query> I<Querystring>
7590 The B<Query> block identifies a query to execute against the redis server.
7591 There may be an arbitrary number of queries to execute. Each query should
7592 return single string or integer.
7594 =item B<Type> I<Collectd type>
7596 Within a query definition, a valid I<collectd type> to use as when submitting
7597 the result of the query. When not supplied, will default to B<gauge>.
7599 Currently only types with one datasource are supported.
7600 See L<types.db(5)> for more details on types and their configuration.
7602 =item B<Instance> I<Type instance>
7604 Within a query definition, an optional type instance to use when submitting
7605 the result of the query. When not supplied will default to the escaped
7606 command, up to 128 chars.
7608 =item B<Database> I<Index>
7610 This index selects the Redis logical database to use for query. Defaults
7615 =head2 Plugin C<rrdcached>
7617 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
7618 to store values to RRD files in an efficient manner. The combination of the
7619 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
7620 way the C<rrdtool> plugin works (see below). The added abstraction layer
7621 provides a number of benefits, though: Because the cache is not within
7622 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
7623 restarted. This results in much shorter (if any) gaps in graphs, especially
7624 under heavy load. Also, the C<rrdtool> command line utility is aware of the
7625 daemon so that it can flush values to disk automatically when needed. This
7626 allows one to integrate automated flushing of values into graphing solutions
7629 There are disadvantages, though: The daemon may reside on a different host, so
7630 it may not be possible for C<collectd> to create the appropriate RRD files
7631 anymore. And even if C<rrdcached> runs on the same host, it may run in a
7632 different base directory, so relative paths may do weird stuff if you're not
7635 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
7636 on the same host, communicating via a UNIX domain socket. The B<DataDir>
7637 setting should be set to an absolute path, so that a changed base directory
7638 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
7642 =item B<DaemonAddress> I<Address>
7644 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
7645 library. See L<rrdcached(1)> for details. Example:
7647 <Plugin "rrdcached">
7648 DaemonAddress "unix:/var/run/rrdcached.sock"
7651 =item B<DataDir> I<Directory>
7653 Set the base directory in which the RRD files reside. If this is a relative
7654 path, it is relative to the working base directory of the C<rrdcached> daemon!
7655 Use of an absolute path is recommended.
7657 =item B<CreateFiles> B<true>|B<false>
7659 Enables or disables the creation of RRD files. If the daemon is not running
7660 locally, or B<DataDir> is set to a relative path, this will not work as
7661 expected. Default is B<true>.
7663 =item B<CreateFilesAsync> B<false>|B<true>
7665 When enabled, new RRD files are enabled asynchronously, using a separate thread
7666 that runs in the background. This prevents writes to block, which is a problem
7667 especially when many hundreds of files need to be created at once. However,
7668 since the purpose of creating the files asynchronously is I<not> to block until
7669 the file is available, values before the file is available will be discarded.
7670 When disabled (the default) files are created synchronously, blocking for a
7671 short while, while the file is being written.
7673 =item B<StepSize> I<Seconds>
7675 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7676 this setting is unset and the stepsize is set to the interval in which the data
7677 is collected. Do not use this option unless you absolutely have to for some
7678 reason. Setting this option may cause problems with the C<snmp plugin>, the
7679 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7681 =item B<HeartBeat> I<Seconds>
7683 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7684 in which case the heartbeat is set to twice the B<StepSize> which should equal
7685 the interval in which data is collected. Do not set this option unless you have
7686 a very good reason to do so.
7688 =item B<RRARows> I<NumRows>
7690 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7691 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7692 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7693 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7694 week, one month, and one year.
7696 So for each timespan, it calculates how many PDPs need to be consolidated into
7697 one CDP by calculating:
7698 number of PDPs = timespan / (stepsize * rrarows)
7700 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7703 =item B<RRATimespan> I<Seconds>
7705 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7706 more then one RRA. If this option is never used, the built-in default of (3600,
7707 86400, 604800, 2678400, 31622400) is used.
7709 For more information on how RRA-sizes are calculated see B<RRARows> above.
7711 =item B<XFF> I<Factor>
7713 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7714 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7717 =item B<CollectStatistics> B<false>|B<true>
7719 When set to B<true>, various statistics about the I<rrdcached> daemon will be
7720 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
7722 Statistics are read via I<rrdcached>s socket using the STATS command.
7723 See L<rrdcached(1)> for details.
7727 =head2 Plugin C<rrdtool>
7729 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
7730 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
7731 using these settings. If you don't want to dive into the depths of RRDtool, you
7732 can safely ignore these settings.
7736 =item B<DataDir> I<Directory>
7738 Set the directory to store RRD files under. By default RRD files are generated
7739 beneath the daemon's working directory, i.e. the B<BaseDir>.
7741 =item B<CreateFilesAsync> B<false>|B<true>
7743 When enabled, new RRD files are enabled asynchronously, using a separate thread
7744 that runs in the background. This prevents writes to block, which is a problem
7745 especially when many hundreds of files need to be created at once. However,
7746 since the purpose of creating the files asynchronously is I<not> to block until
7747 the file is available, values before the file is available will be discarded.
7748 When disabled (the default) files are created synchronously, blocking for a
7749 short while, while the file is being written.
7751 =item B<StepSize> I<Seconds>
7753 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7754 this setting is unset and the stepsize is set to the interval in which the data
7755 is collected. Do not use this option unless you absolutely have to for some
7756 reason. Setting this option may cause problems with the C<snmp plugin>, the
7757 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7759 =item B<HeartBeat> I<Seconds>
7761 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7762 in which case the heartbeat is set to twice the B<StepSize> which should equal
7763 the interval in which data is collected. Do not set this option unless you have
7764 a very good reason to do so.
7766 =item B<RRARows> I<NumRows>
7768 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7769 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7770 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7771 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7772 week, one month, and one year.
7774 So for each timespan, it calculates how many PDPs need to be consolidated into
7775 one CDP by calculating:
7776 number of PDPs = timespan / (stepsize * rrarows)
7778 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7781 =item B<RRATimespan> I<Seconds>
7783 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7784 more then one RRA. If this option is never used, the built-in default of (3600,
7785 86400, 604800, 2678400, 31622400) is used.
7787 For more information on how RRA-sizes are calculated see B<RRARows> above.
7789 =item B<XFF> I<Factor>
7791 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7792 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7795 =item B<CacheFlush> I<Seconds>
7797 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
7798 it writes all values for a certain RRD-file if the oldest value is older than
7799 (or equal to) the number of seconds specified by B<CacheTimeout>.
7800 That check happens on new values arriwal. If some RRD-file is not updated
7801 anymore for some reason (the computer was shut down, the network is broken,
7802 etc.) some values may still be in the cache. If B<CacheFlush> is set, then
7803 every I<Seconds> seconds the entire cache is searched for entries older than
7804 B<CacheTimeout> + B<RandomTimeout> seconds. The entries found are written to
7805 disk. Since scanning the entire cache is kind of expensive and does nothing
7806 under normal circumstances, this value should not be too small. 900 seconds
7807 might be a good value, though setting this to 7200 seconds doesn't normally
7808 do much harm either.
7810 Defaults to 10x B<CacheTimeout>.
7811 B<CacheFlush> must be larger than or equal to B<CacheTimeout>, otherwise the
7812 above default is used.
7814 =item B<CacheTimeout> I<Seconds>
7816 If this option is set to a value greater than zero, the C<rrdtool plugin> will
7817 save values in a cache, as described above. Writing multiple values at once
7818 reduces IO-operations and thus lessens the load produced by updating the files.
7819 The trade off is that the graphs kind of "drag behind" and that more memory is
7822 =item B<WritesPerSecond> I<Updates>
7824 When collecting many statistics with collectd and the C<rrdtool> plugin, you
7825 will run serious performance problems. The B<CacheFlush> setting and the
7826 internal update queue assert that collectd continues to work just fine even
7827 under heavy load, but the system may become very unresponsive and slow. This is
7828 a problem especially if you create graphs from the RRD files on the same
7829 machine, for example using the C<graph.cgi> script included in the
7830 C<contrib/collection3/> directory.
7832 This setting is designed for very large setups. Setting this option to a value
7833 between 25 and 80 updates per second, depending on your hardware, will leave
7834 the server responsive enough to draw graphs even while all the cached values
7835 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
7836 by the B<FLUSH> command, are B<not> effected by this limit. They are still
7837 written as fast as possible, so that web frontends have up to date data when
7840 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
7841 updates per second, writing all values to disk will take approximately
7842 56E<nbsp>minutes. Together with the flushing ability that's integrated into
7843 "collection3" you'll end up with a responsive and fast system, up to date
7844 graphs and basically a "backup" of your values every hour.
7846 =item B<RandomTimeout> I<Seconds>
7848 When set, the actual timeout for each value is chosen randomly between
7849 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
7850 intention is to avoid high load situations that appear when many values timeout
7851 at the same time. This is especially a problem shortly after the daemon starts,
7852 because all values were added to the internal cache at roughly the same time.
7856 =head2 Plugin C<sensors>
7858 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
7859 that all the needed modules have to be loaded and lm_sensors has to be
7860 configured (most likely by editing F</etc/sensors.conf>. Read
7861 L<sensors.conf(5)> for details.
7863 The B<lm_sensors> homepage can be found at
7864 L<http://secure.netroedge.com/~lm78/>.
7868 =item B<SensorConfigFile> I<File>
7870 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
7871 the library's default will be used.
7873 =item B<Sensor> I<chip-bus-address/type-feature>
7875 Selects the name of the sensor which you want to collect or ignore, depending
7876 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
7877 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
7878 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
7880 See F</"IGNORELISTS"> for details.
7882 =item B<IgnoreSelected> I<true>|I<false>
7884 If no configuration if given, the B<sensors>-plugin will collect data from all
7885 sensors. This may not be practical, especially for uninteresting sensors.
7886 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
7887 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
7888 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
7889 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
7890 and all other sensors are collected.
7892 =item B<UseLabels> I<true>|I<false>
7894 Configures how sensor readings are reported. When set to I<true>, sensor
7895 readings are reported using their descriptive label (e.g. "VCore"). When set to
7896 I<false> (the default) the sensor name is used ("in0").
7900 =head2 Plugin C<sigrok>
7902 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
7903 supported by the L<sigrok|http://sigrok.org/> project.
7909 <Device "AC Voltage">
7914 <Device "Sound Level">
7915 Driver "cem-dt-885x"
7922 =item B<LogLevel> B<0-5>
7924 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
7925 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
7926 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
7927 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
7928 their level, are always submitted to I<collectd> at its INFO log level.
7930 =item E<lt>B<Device> I<Name>E<gt>
7932 A sigrok-supported device, uniquely identified by this section's options. The
7933 I<Name> is passed to I<collectd> as the I<plugin instance>.
7935 =item B<Driver> I<DriverName>
7937 The sigrok driver to use for this device.
7939 =item B<Conn> I<ConnectionSpec>
7941 If the device cannot be auto-discovered, or more than one might be discovered
7942 by the driver, I<ConnectionSpec> specifies the connection string to the device.
7943 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
7944 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
7945 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
7946 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
7948 =item B<SerialComm> I<SerialSpec>
7950 For serial devices with non-standard port settings, this option can be used
7951 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
7952 This should not be necessary; drivers know how to communicate with devices they
7955 =item B<MinimumInterval> I<Seconds>
7957 Specifies the minimum time between measurement dispatches to I<collectd>, in
7958 seconds. Since some I<sigrok> supported devices can acquire measurements many
7959 times per second, it may be necessary to throttle these. For example, the
7960 I<RRD plugin> cannot process writes more than once per second.
7962 The default B<MinimumInterval> is B<0>, meaning measurements received from the
7963 device are always dispatched to I<collectd>. When throttled, unused
7964 measurements are discarded.
7968 =head2 Plugin C<smart>
7970 The C<smart> plugin collects SMART information from physical
7971 disks. Values collectd include temperature, power cycle count, poweron
7972 time and bad sectors. Also, all SMART attributes are collected along
7973 with the normalized current value, the worst value, the threshold and
7974 a human readable value.
7976 Using the following two options you can ignore some disks or configure the
7977 collection only of specific disks.
7981 =item B<Disk> I<Name>
7983 Select the disk I<Name>. Whether it is collected or ignored depends on the
7984 B<IgnoreSelected> setting, see below. As with other plugins that use the
7985 daemon's ignorelist functionality, a string that starts and ends with a slash
7986 is interpreted as a regular expression. Examples:
7991 See F</"IGNORELISTS"> for details.
7993 =item B<IgnoreSelected> B<true>|B<false>
7995 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
7996 statements, are ignored or if all other disks are ignored. The behavior
7997 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
7998 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
7999 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
8000 is set to B<true>, all disks are collected B<except> the ones matched.
8002 =item B<IgnoreSleepMode> B<true>|B<false>
8004 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
8005 This option disables the sleep mode check and allows the plugin to collect data
8006 from these disks anyway. This is useful in cases where libatasmart mistakenly
8007 reports disks as asleep because it has not been updated to incorporate support
8008 for newer idle states in the ATA spec.
8010 =item B<UseSerial> B<true>|B<false>
8012 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
8013 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
8014 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
8015 storing data. This ensures that the data for a given disk will be kept together
8016 even if the kernel name changes.
8020 =head2 Plugin C<snmp>
8022 Since the configuration of the C<snmp plugin> is a little more complicated than
8023 other plugins, its documentation has been moved to an own manpage,
8024 L<collectd-snmp(5)>. Please see there for details.
8026 =head2 Plugin C<snmp_agent>
8028 The I<snmp_agent> plugin is an AgentX subagent that receives and handles queries
8029 from SNMP master agent and returns the data collected by read plugins.
8030 The I<snmp_agent> plugin handles requests only for OIDs specified in
8031 configuration file. To handle SNMP queries the plugin gets data from collectd
8032 and translates requested values from collectd's internal format to SNMP format.
8033 This plugin is a generic plugin and cannot work without configuration.
8034 For more details on AgentX subagent see
8035 <http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/>
8040 <Data "memAvailReal">
8042 #PluginInstance "some"
8045 OIDs "1.3.6.1.4.1.2021.4.6.0"
8048 IndexOID "IF-MIB::ifIndex"
8049 SizeOID "IF-MIB::ifNumber"
8052 Source "PluginInstance"
8055 OIDs "IF-MIB::ifDescr"
8061 OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
8064 <Table "CPUAffinityTable">
8067 Source "PluginInstance"
8070 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhAffinityDomainName"
8075 Source "TypeInstance"
8076 Regex "^vcpu_([0-9]{1,3})-cpu_[0-9]{1,3}$"
8079 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhVCPUIndex"
8084 Source "TypeInstance"
8085 Regex "^vcpu_[0-9]{1,3}-cpu_([0-9]{1,3})$"
8088 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhCPUIndex"
8090 <Data "CPUAffinity">
8093 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhCPUAffinity"
8098 There are two types of blocks that can be contained in the
8099 C<E<lt>PluginE<nbsp> snmp_agentE<gt>> block: B<Data> and B<Table>:
8101 =head3 B<Data> block
8103 The B<Data> block defines a list OIDs that are to be handled. This block can
8104 define scalar or table OIDs. If B<Data> block is defined inside of B<Table>
8105 block it reperesents table OIDs.
8106 The following options can be set:
8110 =item B<IndexKey> block
8112 B<IndexKey> block contains all data needed for proper index build of snmp table.
8114 one table B<Data> block has B<IndexKey> block present then multiple key index is
8115 built. If B<Data> block defines scalar data type B<IndexKey> has no effect and can
8120 =item B<Source> I<String>
8122 B<Source> can be set to one of the following values: "Hostname", "Plugin",
8123 "PluginInstance", "Type", "TypeInstance". This value indicates which field of
8124 corresponding collectd metric is taken as a SNMP table index.
8126 =item B<Regex> I<String>
8128 B<Regex> option can also be used to parse strings or numbers out of
8129 specific field. For example: type-instance field which is "vcpu1-cpu2" can be
8130 parsed into two numeric fields CPU = 2 and VCPU = 1 and can be later used
8133 =item B<Group> I<Number>
8135 B<Group> number can be specified in case groups are used in regex.
8139 =item B<Plugin> I<String>
8141 Read plugin name whose collected data will be mapped to specified OIDs.
8143 =item B<PluginInstance> I<String>
8145 Read plugin instance whose collected data will be mapped to specified OIDs.
8146 The field is optional and by default there is no plugin instance check.
8147 Allowed only if B<Data> block defines scalar data type.
8149 =item B<Type> I<String>
8151 Collectd's type that is to be used for specified OID, e.E<nbsp>g. "if_octets"
8152 for example. The types are read from the B<TypesDB> (see L<collectd.conf(5)>).
8154 =item B<TypeInstance> I<String>
8156 Collectd's type-instance that is to be used for specified OID.
8158 =item B<OIDs> I<OID> [I<OID> ...]
8160 Configures the OIDs to be handled by I<snmp_agent> plugin. Values for these OIDs
8161 are taken from collectd data type specified by B<Plugin>, B<PluginInstance>,
8162 B<Type>, B<TypeInstance> fields of this B<Data> block. Number of the OIDs
8163 configured should correspond to number of values in specified B<Type>.
8164 For example two OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" can be mapped to
8165 "rx" and "tx" values of "if_octets" type.
8167 =item B<Scale> I<Value>
8169 The values taken from collectd are multiplied by I<Value>. The field is optional
8170 and the default is B<1.0>.
8172 =item B<Shift> I<Value>
8174 I<Value> is added to values from collectd after they have been multiplied by
8175 B<Scale> value. The field is optional and the default value is B<0.0>.
8179 =head3 The B<Table> block
8181 The B<Table> block defines a collection of B<Data> blocks that belong to one
8182 snmp table. In addition to multiple B<Data> blocks the following options can be
8187 =item B<IndexOID> I<OID>
8189 OID that is handled by the plugin and is mapped to numerical index value that is
8190 generated by the plugin for each table record.
8192 =item B<SizeOID> I<OID>
8194 OID that is handled by the plugin. Returned value is the number of records in
8195 the table. The field is optional.
8199 =head2 Plugin C<statsd>
8201 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
8202 protocol and dispatches rates or other aggregates of these numbers
8205 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
8206 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
8207 C<objects> respectively.
8209 The following configuration options are valid:
8213 =item B<Host> I<Host>
8215 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
8216 "any" address, i.e. accept packets sent to any of the hosts addresses.
8218 =item B<Port> I<Port>
8220 UDP port to listen to. This can be either a service name or a port number.
8221 Defaults to C<8125>.
8223 =item B<DeleteCounters> B<false>|B<true>
8225 =item B<DeleteTimers> B<false>|B<true>
8227 =item B<DeleteGauges> B<false>|B<true>
8229 =item B<DeleteSets> B<false>|B<true>
8231 These options control what happens if metrics are not updated in an interval.
8232 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
8233 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
8234 are unchanged. If set to B<True>, the such metrics are not dispatched and
8235 removed from the internal cache.
8237 =item B<CounterSum> B<false>|B<true>
8239 When enabled, creates a C<count> metric which reports the change since the last
8240 read. This option primarily exists for compatibility with the I<statsd>
8241 implementation by Etsy.
8243 =item B<TimerPercentile> I<Percent>
8245 Calculate and dispatch the configured percentile, i.e. compute the latency, so
8246 that I<Percent> of all reported timers are smaller than or equal to the
8247 computed latency. This is useful for cutting off the long tail latency, as it's
8248 often done in I<Service Level Agreements> (SLAs).
8250 Different percentiles can be calculated by setting this option several times.
8251 If none are specified, no percentiles are calculated / dispatched.
8253 =item B<TimerLower> B<false>|B<true>
8255 =item B<TimerUpper> B<false>|B<true>
8257 =item B<TimerSum> B<false>|B<true>
8259 =item B<TimerCount> B<false>|B<true>
8261 Calculate and dispatch various values out of I<Timer> metrics received during
8262 an interval. If set to B<False>, the default, these values aren't calculated /
8265 Please note what reported timer values less than 0.001 are ignored in all B<Timer*> reports.
8269 =head2 Plugin C<swap>
8271 The I<Swap plugin> collects information about used and available swap space. On
8272 I<Linux> and I<Solaris>, the following options are available:
8276 =item B<ReportByDevice> B<false>|B<true>
8278 Configures how to report physical swap devices. If set to B<false> (the
8279 default), the summary over all swap devices is reported only, i.e. the globally
8280 used and available space over all devices. If B<true> is configured, the used
8281 and available space of each device will be reported separately.
8283 This option is only available if the I<Swap plugin> can read C</proc/swaps>
8284 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
8286 =item B<ReportBytes> B<false>|B<true>
8288 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
8289 I<swap I/O> is reported in pages. This option is available under Linux only.
8291 =item B<ValuesAbsolute> B<true>|B<false>
8293 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
8294 available and used. Defaults to B<true>.
8296 =item B<ValuesPercentage> B<false>|B<true>
8298 Enables or disables reporting of relative swap metrics, i.e. I<percent>
8299 available and free. Defaults to B<false>.
8301 This is useful for deploying I<collectd> in a heterogeneous environment, where
8302 swap sizes differ and you want to specify generic thresholds or similar.
8304 =item B<ReportIO> B<true>|B<false>
8306 Enables or disables reporting swap IO. Defaults to B<true>.
8308 This is useful for the cases when swap IO is not neccessary, is not available,
8313 =head2 Plugin C<sysevent>
8315 The I<sysevent> plugin monitors rsyslog messages.
8320 Listen "192.168.0.2" "6666"
8326 rsyslog should be configured such that it sends data to the IP and port you
8327 include in the plugin configuration. For example, given the configuration
8328 above, something like this would be set in /etc/rsyslog.conf:
8330 if $programname != 'collectd' then
8331 *.* @192.168.0.2:6666
8333 This plugin is designed to consume JSON rsyslog data, so a more complete
8334 rsyslog configuration would look like so (where we define a JSON template
8335 and use it when sending data to our IP and port):
8337 $template ls_json,"{%timestamp:::date-rfc3339,jsonf:@timestamp%, \
8338 %source:::jsonf:@source_host%,\"@source\":\"syslog://%fromhost-ip:::json%\", \
8339 \"@message\":\"%timestamp% %app-name%:%msg:::json%\",\"@fields\": \
8340 {%syslogfacility-text:::jsonf:facility%,%syslogseverity:::jsonf:severity-num%, \
8341 %syslogseverity-text:::jsonf:severity%,%programname:::jsonf:program%, \
8342 %procid:::jsonf:processid%}}"
8344 if $programname != 'collectd' then
8345 *.* @192.168.0.2:6666;ls_json
8347 Please note that these rsyslog.conf examples are *not* complete, as rsyslog
8348 requires more than these options in the configuration file. These examples
8349 are meant to demonstration the proper remote logging and JSON format syntax.
8355 =item B<Listen> I<host> I<port>
8357 Listen on this IP on this port for incoming rsyslog messages.
8359 =item B<BufferSize> I<length>
8361 Maximum allowed size for incoming rsyslog messages. Messages that exceed
8362 this number will be truncated to this size. Default is 4096 bytes.
8364 =item B<BufferLength> I<length>
8366 Maximum number of rsyslog events that can be stored in plugin's ring buffer.
8367 By default, this is set to 10. Once an event has been read, its location
8368 becomes available for storing a new event.
8370 =item B<RegexFilter> I<regex>
8372 Enumerate a regex filter to apply to all incoming rsyslog messages. If a
8373 message matches this filter, it will be published.
8377 =head2 Plugin C<syslog>
8381 =item B<LogLevel> B<debug|info|notice|warning|err>
8383 Sets the log-level. If, for example, set to B<notice>, then all events with
8384 severity B<notice>, B<warning>, or B<err> will be submitted to the
8387 Please note that B<debug> is only available if collectd has been compiled with
8390 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
8392 Controls which notifications should be sent to syslog. The default behaviour is
8393 not to send any. Less severe notifications always imply logging more severe
8394 notifications: Setting this to B<OKAY> means all notifications will be sent to
8395 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
8396 notifications but will dismiss B<OKAY> notifications. Setting this option to
8397 B<FAILURE> will only send failures to syslog.
8401 =head2 Plugin C<table>
8403 The C<table plugin> provides generic means to parse tabular data and dispatch
8404 user specified values. Values are selected based on column numbers. For
8405 example, this plugin may be used to get values from the Linux L<proc(5)>
8406 filesystem or CSV (comma separated values) files.
8409 <Table "/proc/slabinfo">
8415 InstancePrefix "active_objs"
8421 InstancePrefix "objperslab"
8428 The configuration consists of one or more B<Table> blocks, each of which
8429 configures one file to parse. Within each B<Table> block, there are one or
8430 more B<Result> blocks, which configure which data to select and how to
8433 The following options are available inside a B<Table> block:
8437 =item B<Plugin> I<Plugin>
8439 If specified, I<Plugin> is used as the plugin name when submitting values.
8440 Defaults to B<table>.
8442 =item B<Instance> I<instance>
8444 If specified, I<instance> is used as the plugin instance. If omitted, the
8445 filename of the table is used instead, with all special characters replaced
8446 with an underscore (C<_>).
8448 =item B<Separator> I<string>
8450 Any character of I<string> is interpreted as a delimiter between the different
8451 columns of the table. A sequence of two or more contiguous delimiters in the
8452 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
8453 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
8454 of a table - see its documentation for more details. This option is mandatory.
8456 A horizontal tab, newline and carriage return may be specified by C<\\t>,
8457 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
8458 required because of collectd's config parsing.
8462 The following options are available inside a B<Result> block:
8466 =item B<Type> I<type>
8468 Sets the type used to dispatch the values to the daemon. Detailed information
8469 about types and their configuration can be found in L<types.db(5)>. This
8470 option is mandatory.
8472 =item B<InstancePrefix> I<prefix>
8474 If specified, prepend I<prefix> to the type instance. If omitted, only the
8475 B<InstancesFrom> option is considered for the type instance.
8477 =item B<InstancesFrom> I<column0> [I<column1> ...]
8479 If specified, the content of the given columns (identified by the column
8480 number starting at zero) will be used to create the type instance for each
8481 row. Multiple values (and the instance prefix) will be joined together with
8482 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
8483 option is considered for the type instance.
8485 The plugin itself does not check whether or not all built instances are
8486 different. It’s your responsibility to assure that each is unique. This is
8487 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
8488 sure that the table only contains one row.
8490 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
8493 =item B<ValuesFrom> I<column0> [I<column1> ...]
8495 Specifies the columns (identified by the column numbers starting at zero)
8496 whose content is used as the actual data for the data sets that are dispatched
8497 to the daemon. How many such columns you need is determined by the B<Type>
8498 setting above. If you specify too many or not enough columns, the plugin will
8499 complain about that and no data will be submitted to the daemon. The plugin
8500 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
8501 respectively, so anything supported by those functions is supported by the
8502 plugin as well. This option is mandatory.
8506 =head2 Plugin C<tail>
8508 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
8509 each line and dispatches found values. What is matched can be configured by the
8510 user using (extended) regular expressions, as described in L<regex(7)>.
8513 <File "/var/log/exim4/mainlog">
8518 Regex "S=([1-9][0-9]*)"
8524 Regex "\\<R=local_user\\>"
8525 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
8528 Instance "local_user"
8531 Regex "l=([0-9]*\\.[0-9]*)"
8532 <DSType "Distribution">
8535 #BucketType "bucket"
8543 The config consists of one or more B<File> blocks, each of which configures one
8544 logfile to parse. Within each B<File> block, there are one or more B<Match>
8545 blocks, which configure a regular expression to search for.
8547 The B<Plugin> and B<Instance> options in the B<File> block may be used to set
8548 the plugin name and instance respectively. So in the above example the plugin name
8549 C<mail-exim> would be used.
8551 These options are applied for all B<Match> blocks that B<follow> it, until the
8552 next B<Plugin> or B<Instance> option. This way you can extract several plugin
8553 instances from one logfile, handy when parsing syslog and the like.
8555 The B<Interval> option allows you to define the length of time between reads. If
8556 this is not set, the default Interval will be used.
8558 Each B<Match> block has the following options to describe how the match should
8563 =item B<Regex> I<regex>
8565 Sets the regular expression to use for matching against a line. The first
8566 subexpression has to match something that can be turned into a number by
8567 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
8568 below. Because B<extended> regular expressions are used, you do not need to use
8569 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
8570 collectd's config parsing you need to escape backslashes, though. So if you
8571 want to match literal parentheses you need to do the following:
8573 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
8575 =item B<ExcludeRegex> I<regex>
8577 Sets an optional regular expression to use for excluding lines from the match.
8578 An example which excludes all connections from localhost from the match:
8580 ExcludeRegex "127\\.0\\.0\\.1"
8582 =item B<DSType> I<Type>
8584 Sets how the values are cumulated. I<Type> is one of:
8588 =item B<GaugeAverage>
8590 Calculate the average of all values matched during the interval.
8594 Report the smallest value matched during the interval.
8598 Report the greatest value matched during the interval.
8602 Report the last value matched during the interval.
8604 =item B<GaugePersist>
8606 Report the last matching value. The metric is I<not> reset to C<NaN> at the end
8607 of an interval. It is continuously reported until another value is matched.
8608 This is intended for cases in which only state changes are reported, for
8609 example a thermometer that only reports the temperature when it changes.
8615 =item B<AbsoluteSet>
8617 The matched number is a counter. Simply I<sets> the internal counter to this
8618 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
8626 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
8627 matched number may be negative, which will effectively subtract from the
8636 Increase the internal counter by one. These B<DSType> are the only ones that do
8637 not use the matched subexpression, but simply count the number of matched
8638 lines. Thus, you may use a regular expression without submatch in this case.
8640 B<GaugeInc> is reset to I<zero> after every read, unlike other B<Gauge*>
8641 metrics which are reset to C<NaN>.
8643 =item B<Distribution>
8645 Type to do calculations based on the distribution of values, primarily
8646 calculating percentiles. This is primarily geared towards latency, but can be
8647 used for other metrics as well. The range of values tracked with this setting
8648 must be in the range (0–2^34) and can be fractional. Please note that neither
8649 zero nor 2^34 are inclusive bounds, i.e. zero I<cannot> be handled by a
8652 This option must be used together with the B<Percentile> and/or B<Bucket>
8657 <DSType "Distribution">
8665 =item B<Percentile> I<Percent>
8667 Calculate and dispatch the configured percentile, i.e. compute the value, so
8668 that I<Percent> of all matched values are smaller than or equal to the computed
8671 Metrics are reported with the I<type> B<Type> (the value of the above option)
8672 and the I<type instance> C<[E<lt>InstanceE<gt>-]E<lt>PercentE<gt>>.
8674 This option may be repeated to calculate more than one percentile.
8676 =item B<Bucket> I<lower_bound> I<upper_bound>
8678 Export the number of values (a C<DERIVE>) falling within the given range. Both,
8679 I<lower_bound> and I<upper_bound> may be a fractional number, such as B<0.5>.
8680 Each B<Bucket> option specifies an interval C<(I<lower_bound>,
8681 I<upper_bound>]>, i.e. the range I<excludes> the lower bound and I<includes>
8682 the upper bound. I<lower_bound> and I<upper_bound> may be zero, meaning no
8685 To export the entire (0–inf) range without overlap, use the upper bound of the
8686 previous range as the lower bound of the following range. In other words, use
8687 the following schema:
8697 Metrics are reported with the I<type> set by B<BucketType> option (C<bucket>
8698 by default) and the I<type instance>
8699 C<E<lt>TypeE<gt>[-E<lt>InstanceE<gt>]-E<lt>lower_boundE<gt>_E<lt>upper_boundE<gt>>.
8701 This option may be repeated to calculate more than one rate.
8703 =item B<BucketType> I<Type>
8705 Sets the type used to dispatch B<Bucket> metrics.
8706 Optional, by default C<bucket> will be used.
8712 The B<Gauge*> and B<Distribution> types interpret the submatch as a floating
8713 point number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types
8714 interpret the submatch as an unsigned integer using L<strtoull(3)>. The
8715 B<Derive*> types interpret the submatch as a signed integer using
8716 L<strtoll(3)>. B<CounterInc>, B<DeriveInc> and B<GaugeInc> do not use the
8717 submatch at all and it may be omitted in this case.
8719 The B<Gauge*> types, unless noted otherwise, are reset to C<NaN> after being
8720 reported. In other words, B<GaugeAverage> reports the average of all values
8721 matched since the last metric was reported (or C<NaN> if there was no match).
8723 =item B<Type> I<Type>
8725 Sets the type used to dispatch this value. Detailed information about types and
8726 their configuration can be found in L<types.db(5)>.
8728 =item B<Instance> I<TypeInstance>
8730 This optional setting sets the type instance to use.
8734 =head2 Plugin C<tail_csv>
8736 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
8737 written by I<Snort>.
8742 <Metric "snort-dropped">
8747 <File "/var/log/snort/snort.stats">
8751 Collect "snort-dropped"
8756 The configuration consists of one or more B<Metric> blocks that define an index
8757 into the line of the CSV file and how this value is mapped to I<collectd's>
8758 internal representation. These are followed by one or more B<Instance> blocks
8759 which configure which file to read, in which interval and which metrics to
8764 =item E<lt>B<Metric> I<Name>E<gt>
8766 The B<Metric> block configures a new metric to be extracted from the statistics
8767 file and how it is mapped on I<collectd's> data model. The string I<Name> is
8768 only used inside the B<Instance> blocks to refer to this block, so you can use
8769 one B<Metric> block for multiple CSV files.
8773 =item B<Type> I<Type>
8775 Configures which I<Type> to use when dispatching this metric. Types are defined
8776 in the L<types.db(5)> file, see the appropriate manual page for more
8777 information on specifying types. Only types with a single I<data source> are
8778 supported by the I<tail_csv plugin>. The information whether the value is an
8779 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
8780 I<Type's> definition.
8782 =item B<Instance> I<TypeInstance>
8784 If set, I<TypeInstance> is used to populate the type instance field of the
8785 created value lists. Otherwise, no type instance is used.
8787 =item B<ValueFrom> I<Index>
8789 Configure to read the value from the field with the zero-based index I<Index>.
8790 If the value is parsed as signed integer, unsigned integer or double depends on
8791 the B<Type> setting, see above.
8795 =item E<lt>B<File> I<Path>E<gt>
8797 Each B<File> block represents one CSV file to read. There must be at least one
8798 I<File> block but there can be multiple if you have multiple CSV files.
8802 =item B<Plugin> I<Plugin>
8804 Use I<Plugin> as the plugin name when submitting values.
8805 Defaults to C<tail_csv>.
8807 =item B<Instance> I<PluginInstance>
8809 Sets the I<plugin instance> used when dispatching the values.
8811 =item B<Collect> I<Metric>
8813 Specifies which I<Metric> to collect. This option must be specified at least
8814 once, and you can use this option multiple times to specify more than one
8815 metric to be extracted from this statistic file.
8817 =item B<Interval> I<Seconds>
8819 Configures the interval in which to read values from this instance / file.
8820 Defaults to the plugin's default interval.
8822 =item B<TimeFrom> I<Index>
8824 Rather than using the local time when dispatching a value, read the timestamp
8825 from the field with the zero-based index I<Index>. The value is interpreted as
8826 seconds since epoch. The value is parsed as a double and may be factional.
8832 =head2 Plugin C<teamspeak2>
8834 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
8835 polls interesting global and virtual server data. The plugin can query only one
8836 physical server but unlimited virtual servers. You can use the following
8837 options to configure it:
8841 =item B<Host> I<hostname/ip>
8843 The hostname or ip which identifies the physical server.
8846 =item B<Port> I<port>
8848 The query port of the physical server. This needs to be a string.
8851 =item B<Server> I<port>
8853 This option has to be added once for every virtual server the plugin should
8854 query. If you want to query the virtual server on port 8767 this is what the
8855 option would look like:
8859 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
8860 use quotes around it! If no such statement is given only global information
8865 =head2 Plugin C<ted>
8867 The I<TED> plugin connects to a device of "The Energy Detective", a device to
8868 measure power consumption. These devices are usually connected to a serial
8869 (RS232) or USB port. The plugin opens a configured device and tries to read the
8870 current energy readings. For more information on TED, visit
8871 L<http://www.theenergydetective.com/>.
8873 Available configuration options:
8877 =item B<Device> I<Path>
8879 Path to the device on which TED is connected. collectd will need read and write
8880 permissions on that file.
8882 Default: B</dev/ttyUSB0>
8884 =item B<Retries> I<Num>
8886 Apparently reading from TED is not that reliable. You can therefore configure a
8887 number of retries here. You only configure the I<retries> here, to if you
8888 specify zero, one reading will be performed (but no retries if that fails); if
8889 you specify three, a maximum of four readings are performed. Negative values
8896 =head2 Plugin C<tcpconns>
8898 The C<tcpconns plugin> counts the number of currently established TCP
8899 connections based on the local port and/or the remote port. Since there may be
8900 a lot of connections the default if to count all connections with a local port,
8901 for which a listening socket is opened. You can use the following options to
8902 fine-tune the ports you are interested in:
8906 =item B<ListeningPorts> I<true>|I<false>
8908 If this option is set to I<true>, statistics for all local ports for which a
8909 listening socket exists are collected. The default depends on B<LocalPort> and
8910 B<RemotePort> (see below): If no port at all is specifically selected, the
8911 default is to collect listening ports. If specific ports (no matter if local or
8912 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
8913 the selected ports will be collected unless this option is set to I<true>
8916 =item B<LocalPort> I<Port>
8918 Count the connections to a specific local port. This can be used to see how
8919 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
8920 You have to specify the port in numeric form, so for the mailserver example
8921 you'd need to set B<25>.
8923 =item B<RemotePort> I<Port>
8925 Count the connections to a specific remote port. This is useful to see how
8926 much a remote service is used. This is most useful if you want to know how many
8927 connections a local service has opened to remote services, e.E<nbsp>g. how many
8928 connections a mail server or news server has to other mail or news servers, or
8929 how many connections a web proxy holds to web servers. You have to give the
8930 port in numeric form.
8932 =item B<AllPortsSummary> I<true>|I<false>
8934 If this option is set to I<true> a summary of statistics from all connections
8935 are collected. This option defaults to I<false>.
8939 =head2 Plugin C<thermal>
8943 =item B<ForceUseProcfs> I<true>|I<false>
8945 By default, the I<Thermal plugin> tries to read the statistics from the Linux
8946 C<sysfs> interface. If that is not available, the plugin falls back to the
8947 C<procfs> interface. By setting this option to I<true>, you can force the
8948 plugin to use the latter. This option defaults to I<false>.
8950 =item B<Device> I<Device>
8952 Selects the name of the thermal device that you want to collect or ignore,
8953 depending on the value of the B<IgnoreSelected> option. This option may be
8954 used multiple times to specify a list of devices.
8956 See F</"IGNORELISTS"> for details.
8958 =item B<IgnoreSelected> I<true>|I<false>
8960 Invert the selection: If set to true, all devices B<except> the ones that
8961 match the device names specified by the B<Device> option are collected. By
8962 default only selected devices are collected if a selection is made. If no
8963 selection is configured at all, B<all> devices are selected.
8967 =head2 Plugin C<threshold>
8969 The I<Threshold plugin> checks values collected or received by I<collectd>
8970 against a configurable I<threshold> and issues I<notifications> if values are
8973 Documentation for this plugin is available in the L<collectd-threshold(5)>
8976 =head2 Plugin C<tokyotyrant>
8978 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
8979 couple metrics: number of records, and database size on disk.
8983 =item B<Host> I<Hostname/IP>
8985 The hostname or IP which identifies the server.
8986 Default: B<127.0.0.1>
8988 =item B<Port> I<Service/Port>
8990 The query port of the server. This needs to be a string, even if the port is
8991 given in its numeric form.
8996 =head2 Plugin C<turbostat>
8998 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
8999 Intel processors by using I<Model Specific Registers>.
9003 =item B<CoreCstates> I<Bitmask(Integer)>
9005 Bit mask of the list of core C-states supported by the processor.
9006 This option should only be used if the automated detection fails.
9007 Default value extracted from the CPU model and family.
9009 Currently supported C-states (by this plugin): 3, 6, 7
9013 All states (3, 6 and 7):
9014 (1<<3) + (1<<6) + (1<<7) = 392
9016 =item B<PackageCstates> I<Bitmask(Integer)>
9018 Bit mask of the list of packages C-states supported by the processor. This
9019 option should only be used if the automated detection fails. Default value
9020 extracted from the CPU model and family.
9022 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
9026 States 2, 3, 6 and 7:
9027 (1<<2) + (1<<3) + (1<<6) + (1<<7) = 396
9029 =item B<SystemManagementInterrupt> I<true>|I<false>
9031 Boolean enabling the collection of the I/O System-Management Interrupt counter.
9032 This option should only be used if the automated detection fails or if you want
9033 to disable this feature.
9035 =item B<DigitalTemperatureSensor> I<true>|I<false>
9037 Boolean enabling the collection of the temperature of each core. This option
9038 should only be used if the automated detection fails or if you want to disable
9041 =item B<TCCActivationTemp> I<Temperature>
9043 I<Thermal Control Circuit Activation Temperature> of the installed CPU. This
9044 temperature is used when collecting the temperature of cores or packages. This
9045 option should only be used if the automated detection fails. Default value
9046 extracted from B<MSR_IA32_TEMPERATURE_TARGET>.
9048 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
9050 Bit mask of the list of elements to be thermally monitored. This option should
9051 only be used if the automated detection fails or if you want to disable some
9052 collections. The different bits of this bit mask accepted by this plugin are:
9056 =item 0 ('1'): Package
9060 =item 2 ('4'): Cores
9062 =item 3 ('8'): Embedded graphic device
9066 =item B<LogicalCoreNames> I<true>|I<false>
9068 Boolean enabling the use of logical core numbering for per core statistics.
9069 When enabled, C<cpuE<lt>nE<gt>> is used as plugin instance, where I<n> is a
9070 dynamic number assigned by the kernel. Otherwise, C<coreE<lt>nE<gt>> is used
9071 if there is only one package and C<pkgE<lt>nE<gt>-coreE<lt>mE<gt>> if there is
9072 more than one, where I<n> is the n-th core of package I<m>.
9074 =item B<RestoreAffinityPolicy> I<AllCPUs>|I<Restore>
9076 Reading data from CPU has side-effect: collectd process's CPU affinity mask
9077 changes. After reading data is completed, affinity mask needs to be restored.
9078 This option allows to set restore policy.
9080 B<AllCPUs> (the default): Restore the affinity by setting affinity to any/all
9083 B<Restore>: Save affinity using sched_getaffinity() before reading data and
9086 On some systems, sched_getaffinity() will fail due to inconsistency of the CPU
9087 set size between userspace and kernel. In these cases plugin will detect the
9088 unsuccessful call and fail with an error, preventing data collection.
9089 Most of configurations does not need to save affinity as Collectd process is
9090 allowed to run on any/all available CPUs.
9092 If you need to save and restore affinity and get errors like 'Unable to save
9093 the CPU affinity', setting 'possible_cpus' kernel boot option may also help.
9095 See following links for details:
9097 L<https://github.com/collectd/collectd/issues/1593>
9098 L<https://sourceware.org/bugzilla/show_bug.cgi?id=15630>
9099 L<https://bugzilla.kernel.org/show_bug.cgi?id=151821>
9103 =head2 Plugin C<unixsock>
9107 =item B<SocketFile> I<Path>
9109 Sets the socket-file which is to be created.
9111 =item B<SocketGroup> I<Group>
9113 If running as root change the group of the UNIX-socket after it has been
9114 created. Defaults to B<collectd>.
9116 =item B<SocketPerms> I<Permissions>
9118 Change the file permissions of the UNIX-socket after it has been created. The
9119 permissions must be given as a numeric, octal value as you would pass to
9120 L<chmod(1)>. Defaults to B<0770>.
9122 =item B<DeleteSocket> B<false>|B<true>
9124 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
9125 with the given name already exists. If I<collectd> crashes a socket file may be
9126 left over, preventing the daemon from opening a new socket when restarted.
9127 Since this is potentially dangerous, this defaults to B<false>.
9131 =head2 Plugin C<uuid>
9133 This plugin, if loaded, causes the Hostname to be taken from the machine's
9134 UUID. The UUID is a universally unique designation for the machine, usually
9135 taken from the machine's BIOS. This is most useful if the machine is running in
9136 a virtual environment such as Xen, in which case the UUID is preserved across
9137 shutdowns and migration.
9139 The following methods are used to find the machine's UUID, in order:
9145 Check I</etc/uuid> (or I<UUIDFile>).
9149 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
9154 Check for UUID from C<dmidecode> / SMBIOS.
9158 Check for UUID from Xen hypervisor.
9162 If no UUID can be found then the hostname is not modified.
9166 =item B<UUIDFile> I<Path>
9168 Take the UUID from the given file (default I</etc/uuid>).
9172 =head2 Plugin C<varnish>
9174 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
9175 It collects a subset of the values displayed by L<varnishstat(1)>, and
9176 organizes them in categories which can be enabled or disabled. Currently only
9177 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
9178 meaning of each metric can be found in L<varnish-counters(7)>.
9183 <Instance "example">
9187 CollectConnections true
9188 CollectDirectorDNS false
9192 CollectObjects false
9194 CollectSession false
9204 CollectWorkers false
9206 CollectMempool false
9207 CollectManagement false
9214 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
9215 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
9216 will collectd statistics from the default "varnishd" instance (this should work
9217 fine in most cases).
9219 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
9223 =item B<CollectBackend> B<true>|B<false>
9225 Back-end connection statistics, such as successful, reused,
9226 and closed connections. True by default.
9228 =item B<CollectBan> B<true>|B<false>
9230 Statistics about ban operations, such as number of bans added, retired, and
9231 number of objects tested against ban operations. Only available with Varnish
9232 3.x and above. False by default.
9234 =item B<CollectCache> B<true>|B<false>
9236 Cache hits and misses. True by default.
9238 =item B<CollectConnections> B<true>|B<false>
9240 Number of client connections received, accepted and dropped. True by default.
9242 =item B<CollectDirectorDNS> B<true>|B<false>
9244 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
9247 =item B<CollectESI> B<true>|B<false>
9249 Edge Side Includes (ESI) parse statistics. False by default.
9251 =item B<CollectFetch> B<true>|B<false>
9253 Statistics about fetches (HTTP requests sent to the backend). False by default.
9255 =item B<CollectHCB> B<true>|B<false>
9257 Inserts and look-ups in the crit bit tree based hash. Look-ups are
9258 divided into locked and unlocked look-ups. False by default.
9260 =item B<CollectObjects> B<true>|B<false>
9262 Statistics on cached objects: number of objects expired, nuked (prematurely
9263 expired), saved, moved, etc. False by default.
9265 =item B<CollectPurge> B<true>|B<false>
9267 Statistics about purge operations, such as number of purges added, retired, and
9268 number of objects tested against purge operations. Only available with Varnish
9269 2.x. False by default.
9271 =item B<CollectSession> B<true>|B<false>
9273 Client session statistics. Number of past and current sessions, session herd and
9274 linger counters, etc. False by default. Note that if using Varnish 4.x, some
9275 metrics found in the Connections and Threads sections with previous versions of
9276 Varnish have been moved here.
9278 =item B<CollectSHM> B<true>|B<false>
9280 Statistics about the shared memory log, a memory region to store
9281 log messages which is flushed to disk when full. True by default.
9283 =item B<CollectSMA> B<true>|B<false>
9285 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
9286 component is Solaris specific. Note: SMA, SMF and MSE share counters, enable
9287 only the one used by the Varnish instance. Only available with Varnish 2.x.
9290 =item B<CollectSMS> B<true>|B<false>
9292 synth (synthetic content) storage statistics. This storage
9293 component is used internally only. False by default.
9295 =item B<CollectSM> B<true>|B<false>
9297 file (memory mapped file) storage statistics. Only available with Varnish 2.x.,
9298 in varnish 4.x. use CollectSMF.
9301 =item B<CollectStruct> B<true>|B<false>
9303 Current varnish internal state statistics. Number of current sessions, objects
9304 in cache store, open connections to backends (with Varnish 2.x), etc. False by
9307 =item B<CollectTotals> B<true>|B<false>
9309 Collects overview counters, such as the number of sessions created,
9310 the number of requests and bytes transferred. False by default.
9312 =item B<CollectUptime> B<true>|B<false>
9314 Varnish uptime. Only available with Varnish 3.x and above. False by default.
9316 =item B<CollectVCL> B<true>|B<false>
9318 Number of total (available + discarded) VCL (config files). False by default.
9320 =item B<CollectVSM> B<true>|B<false>
9322 Collect statistics about Varnish's shared memory usage (used by the logging and
9323 statistics subsystems). Only available with Varnish 4.x. False by default.
9325 =item B<CollectWorkers> B<true>|B<false>
9327 Collect statistics about worker threads. False by default.
9329 =item B<CollectVBE> B<true>|B<false>
9331 Backend counters. Only available with Varnish 4.x. False by default.
9333 =item B<CollectSMF> B<true>|B<false>
9335 file (memory mapped file) storage statistics. Only available with Varnish 4.x.
9336 Note: SMA, SMF and MSE share counters, enable only the one used by the Varnish
9337 instance. Used to be called SM in Varnish 2.x. False by default.
9339 =item B<CollectManagement> B<true>|B<false>
9341 Management process counters. Only available with Varnish 4.x. False by default.
9343 =item B<CollectLock> B<true>|B<false>
9345 Lock counters. Only available with Varnish 4.x. False by default.
9347 =item B<CollectMempool> B<true>|B<false>
9349 Memory pool counters. Only available with Varnish 4.x. False by default.
9351 =item B<CollectMSE> B<true>|B<false>
9353 Varnish Massive Storage Engine 2.0 (MSE2) is an improved storage backend for
9354 Varnish, replacing the traditional malloc and file storages. Only available
9355 with Varnish-Plus 4.x. Note: SMA, SMF and MSE share counters, enable only the
9356 one used by the Varnish instance. False by default.
9360 =head2 Plugin C<virt>
9362 This plugin allows CPU, disk, network load and other metrics to be collected for
9363 virtualized guests on the machine. The statistics are collected through libvirt
9364 API (L<http://libvirt.org/>). Majority of metrics can be gathered without
9365 installing any additional software on guests, especially I<collectd>, which runs
9366 only on the host system.
9368 Only I<Connection> is required.
9370 Consider the following example config:
9373 Connection "qemu:///system"
9374 HostnameFormat "hostname"
9375 InterfaceFormat "address"
9376 PluginInstanceFormat "name"
9379 It will generate the following values:
9381 node42.example.com/virt-instance-0006f26c/disk_octets-vda
9382 node42.example.com/virt-instance-0006f26c/disk_ops-vda
9383 node42.example.com/virt-instance-0006f26c/if_dropped-ca:fe:ca:fe:ca:fe
9384 node42.example.com/virt-instance-0006f26c/if_errors-ca:fe:ca:fe:ca:fe
9385 node42.example.com/virt-instance-0006f26c/if_octets-ca:fe:ca:fe:ca:fe
9386 node42.example.com/virt-instance-0006f26c/if_packets-ca:fe:ca:fe:ca:fe
9387 node42.example.com/virt-instance-0006f26c/memory-actual_balloon
9388 node42.example.com/virt-instance-0006f26c/memory-available
9389 node42.example.com/virt-instance-0006f26c/memory-last_update
9390 node42.example.com/virt-instance-0006f26c/memory-major_fault
9391 node42.example.com/virt-instance-0006f26c/memory-minor_fault
9392 node42.example.com/virt-instance-0006f26c/memory-rss
9393 node42.example.com/virt-instance-0006f26c/memory-swap_in
9394 node42.example.com/virt-instance-0006f26c/memory-swap_out
9395 node42.example.com/virt-instance-0006f26c/memory-total
9396 node42.example.com/virt-instance-0006f26c/memory-unused
9397 node42.example.com/virt-instance-0006f26c/memory-usable
9398 node42.example.com/virt-instance-0006f26c/virt_cpu_total
9399 node42.example.com/virt-instance-0006f26c/virt_vcpu-0
9401 You can get information on the metric's units from the online libvirt documentation.
9402 For instance, I<virt_cpu_total> is in nanoseconds.
9406 =item B<Connection> I<uri>
9408 Connect to the hypervisor given by I<uri>. For example if using Xen use:
9410 Connection "xen:///"
9412 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
9414 =item B<RefreshInterval> I<seconds>
9416 Refresh the list of domains and devices every I<seconds>. The default is 60
9417 seconds. Setting this to be the same or smaller than the I<Interval> will cause
9418 the list of domains and devices to be refreshed on every iteration.
9420 Refreshing the devices in particular is quite a costly operation, so if your
9421 virtualization setup is static you might consider increasing this. If this
9422 option is set to 0, refreshing is disabled completely.
9424 =item B<Domain> I<name>
9426 =item B<BlockDevice> I<name:dev>
9428 =item B<InterfaceDevice> I<name:dev>
9430 =item B<IgnoreSelected> B<true>|B<false>
9432 Select which domains and devices are collected.
9434 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
9435 disk/network devices are collected.
9437 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
9438 domains and disk/network devices are ignored, while the rest are collected.
9440 The domain name and device names may use a regular expression, if the name is
9441 surrounded by I</.../> and collectd was compiled with support for regexps.
9443 The default is to collect statistics for all domains and all their devices.
9445 B<Note:> B<BlockDevice> and B<InterfaceDevice> options are related to
9446 corresponding B<*Format> options. Specifically, B<BlockDevice> filtering depends
9447 on B<BlockDeviceFormat> setting - if user wants to filter block devices by
9448 'target' name then B<BlockDeviceFormat> option has to be set to 'target' and
9449 B<BlockDevice> option must be set to a valid block device target
9450 name("/:hdb/"). Mixing formats and filter values from different worlds (i.e.,
9451 using 'target' name as B<BlockDevice> value with B<BlockDeviceFormat> set to
9452 'source') may lead to unexpected results (all devices filtered out or all
9453 visible, depending on the value of B<IgnoreSelected> option).
9454 Similarly, option B<InterfaceDevice> is related to B<InterfaceFormat> setting
9455 (i.e., when user wants to use MAC address as a filter then B<InterfaceFormat>
9456 has to be set to 'address' - using wrong type here may filter out all of the
9461 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
9464 BlockDevice "/:hdb/"
9465 IgnoreSelected "true"
9466 BlockDeviceFormat "target"
9470 Collect metrics only for block device on 'baremetal0' domain when its
9471 'source' matches given path:
9473 BlockDevice "baremetal0:/var/lib/libvirt/images/baremetal0.qcow2"
9474 BlockDeviceFormat source
9476 As you can see it is possible to filter devices/interfaces using
9477 various formats - for block devices 'target' or 'source' name can be
9478 used. Interfaces can be filtered using 'name', 'address' or 'number'.
9482 Collect metrics only for domains 'baremetal0' and 'baremetal1' and
9483 ignore any other domain:
9488 It is possible to filter multiple block devices/domains/interfaces by
9489 adding multiple filtering entries in separate lines.
9491 =item B<BlockDeviceFormat> B<target>|B<source>
9493 If I<BlockDeviceFormat> is set to B<target>, the default, then the device name
9494 seen by the guest will be used for reporting metrics.
9495 This corresponds to the C<E<lt>targetE<gt>> node in the XML definition of the
9498 If I<BlockDeviceFormat> is set to B<source>, then metrics will be reported
9499 using the path of the source, e.g. an image file.
9500 This corresponds to the C<E<lt>sourceE<gt>> node in the XML definition of the
9505 If the domain XML have the following device defined:
9507 <disk type='block' device='disk'>
9508 <driver name='qemu' type='raw' cache='none' io='native' discard='unmap'/>
9509 <source dev='/var/lib/libvirt/images/image1.qcow2'/>
9510 <target dev='sda' bus='scsi'/>
9512 <address type='drive' controller='0' bus='0' target='0' unit='0'/>
9515 Setting C<BlockDeviceFormat target> will cause the I<type instance> to be set
9517 Setting C<BlockDeviceFormat source> will cause the I<type instance> to be set
9518 to C<var_lib_libvirt_images_image1.qcow2>.
9520 B<Note:> this option determines also what field will be used for
9521 filtering over block devices (filter value in B<BlockDevice>
9522 will be applied to target or source). More info about filtering
9523 block devices can be found in the description of B<BlockDevice>.
9525 =item B<BlockDeviceFormatBasename> B<false>|B<true>
9527 The B<BlockDeviceFormatBasename> controls whether the full path or the
9528 L<basename(1)> of the source is being used as the I<type instance> when
9529 B<BlockDeviceFormat> is set to B<source>. Defaults to B<false>.
9533 Assume the device path (source tag) is C</var/lib/libvirt/images/image1.qcow2>.
9534 Setting C<BlockDeviceFormatBasename false> will cause the I<type instance> to
9535 be set to C<var_lib_libvirt_images_image1.qcow2>.
9536 Setting C<BlockDeviceFormatBasename true> will cause the I<type instance> to be
9537 set to C<image1.qcow2>.
9539 =item B<HostnameFormat> B<name|uuid|hostname|metadata...>
9541 When the virt plugin logs data, it sets the hostname of the collected data
9542 according to this setting. The default is to use the guest name as provided by
9543 the hypervisor, which is equal to setting B<name>.
9545 B<uuid> means use the guest's UUID. This is useful if you want to track the
9546 same guest across migrations.
9548 B<hostname> means to use the global B<Hostname> setting, which is probably not
9549 useful on its own because all guests will appear to have the same name. This is
9550 useful in conjunction with B<PluginInstanceFormat> though.
9552 B<metadata> means use information from guest's metadata. Use
9553 B<HostnameMetadataNS> and B<HostnameMetadataXPath> to localize this information.
9555 You can also specify combinations of these fields. For example B<name uuid>
9556 means to concatenate the guest name and UUID (with a literal colon character
9557 between, thus I<"foo:1234-1234-1234-1234">).
9559 At the moment of writing (collectd-5.5), hostname string is limited to 62
9560 characters. In case when combination of fields exceeds 62 characters,
9561 hostname will be truncated without a warning.
9563 =item B<InterfaceFormat> B<name>|B<address>|B<number>
9565 When the virt plugin logs interface data, it sets the name of the collected
9566 data according to this setting. The default is to use the path as provided by
9567 the hypervisor (the "dev" property of the target node), which is equal to
9570 B<address> means use the interface's mac address. This is useful since the
9571 interface path might change between reboots of a guest or across migrations.
9573 B<number> means use the interface's number in guest.
9575 B<Note:> this option determines also what field will be used for
9576 filtering over interface device (filter value in B<InterfaceDevice>
9577 will be applied to name, address or number). More info about filtering
9578 interfaces can be found in the description of B<InterfaceDevice>.
9580 =item B<PluginInstanceFormat> B<name|uuid|metadata|none>
9582 When the virt plugin logs data, it sets the plugin_instance of the collected
9583 data according to this setting. The default is to not set the plugin_instance.
9585 B<name> means use the guest's name as provided by the hypervisor.
9586 B<uuid> means use the guest's UUID.
9587 B<metadata> means use information from guest's metadata.
9589 You can also specify combinations of the B<name> and B<uuid> fields.
9590 For example B<name uuid> means to concatenate the guest name and UUID
9591 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
9593 =item B<HostnameMetadataNS> B<string>
9595 When B<metadata> is used in B<HostnameFormat> or B<PluginInstanceFormat>, this
9596 selects in which metadata namespace we will pick the hostname. The default is
9597 I<http://openstack.org/xmlns/libvirt/nova/1.0>.
9599 =item B<HostnameMetadataXPath> B<string>
9601 When B<metadata> is used in B<HostnameFormat> or B<PluginInstanceFormat>, this
9602 describes where the hostname is located in the libvirt metadata. The default is
9603 I</instance/name/text()>.
9605 =item B<ReportBlockDevices> B<true>|B<false>
9607 Enabled by default. Allows to disable stats reporting of block devices for
9610 =item B<ReportNetworkInterfaces> B<true>|B<false>
9612 Enabled by default. Allows to disable stats reporting of network interfaces for
9615 =item B<ExtraStats> B<string>
9617 Report additional extra statistics. The default is no extra statistics, preserving
9618 the previous behaviour of the plugin. If unsure, leave the default. If enabled,
9619 allows the plugin to reported more detailed statistics about the behaviour of
9620 Virtual Machines. The argument is a space-separated list of selectors.
9622 Currently supported selectors are:
9626 =item B<cpu_util>: report CPU utilization per domain in percentage.
9628 =item B<disk>: report extra statistics like number of flush operations and total
9629 service time for read, write and flush operations. Requires libvirt API version
9632 =item B<disk_err>: report disk errors if any occured. Requires libvirt API version
9635 =item B<domain_state>: report domain state and reason as 'domain_state' metric.
9637 =item B<fs_info>: report file system information as a notification. Requires
9638 libvirt API version I<1.2.11> or later. Can be collected only if I<Guest Agent>
9639 is installed and configured inside VM. Make sure that installed I<Guest Agent>
9640 version supports retrieving file system information.
9642 =item B<job_stats_background>: report statistics about progress of a background
9643 job on a domain. Only one type of job statistics can be collected at the same time.
9644 Requires libvirt API version I<1.2.9> or later.
9646 =item B<job_stats_completed>: report statistics about a recently completed job on
9647 a domain. Only one type of job statistics can be collected at the same time.
9648 Requires libvirt API version I<1.2.9> or later.
9650 =item B<memory>: report statistics about memory usage details, provided
9651 by libvirt virDomainMemoryStats() function.
9653 =item B<pcpu>: report the physical user/system cpu time consumed by the hypervisor, per-vm.
9654 Requires libvirt API version I<0.9.11> or later.
9656 =item B<perf>: report performance monitoring events. To collect performance
9657 metrics they must be enabled for domain and supported by the platform. Requires
9658 libvirt API version I<1.3.3> or later.
9659 B<Note>: I<perf> metrics can't be collected if I<intel_rdt> plugin is enabled.
9661 =item B<vcpu>: report domain virtual CPUs utilisation.
9663 =item B<vcpupin>: report pinning of domain VCPUs to host physical CPUs.
9665 =item B<disk_physical>: report 'disk_physical' statistic for disk device.
9666 B<Note>: This statistic is only reported for disk devices with 'source'
9669 =item B<disk_allocation>: report 'disk_allocation' statistic for disk device.
9670 B<Note>: This statistic is only reported for disk devices with 'source'
9673 =item B<disk_capacity>: report 'disk_capacity' statistic for disk device.
9674 B<Note>: This statistic is only reported for disk devices with 'source'
9679 =item B<PersistentNotification> B<true>|B<false>
9681 Override default configuration to only send notifications when there is a change
9682 in the lifecycle state of a domain. When set to true notifications will be sent
9683 for every read cycle. Default is false. Does not affect the stats being
9686 =item B<Instances> B<integer>
9688 How many read instances you want to use for this plugin. The default is one,
9689 and the sensible setting is a multiple of the B<ReadThreads> value.
9691 This option is only useful when domains are specially tagged.
9692 If you are not sure, just use the default setting.
9694 The reader instance will only query the domains with attached matching tag.
9695 Tags should have the form of 'virt-X' where X is the reader instance number,
9698 The special-purpose reader instance #0, guaranteed to be always present,
9699 will query all the domains with missing or unrecognized tag, so no domain will
9702 Domain tagging is done with a custom attribute in the libvirt domain metadata
9703 section. Value is selected by an XPath I</domain/metadata/ovirtmap/tag/text()>
9704 expression in the I<http://ovirt.org/ovirtmap/tag/1.0> namespace.
9705 (XPath and namespace values are not configurable yet).
9707 Tagging could be used by management applications to evenly spread the
9708 load among the reader threads, or to pin on the same threads all
9709 the libvirt domains which use the same shared storage, to minimize
9710 the disruption in presence of storage outages.
9714 =head2 Plugin C<vmem>
9716 The C<vmem> plugin collects information about the usage of virtual memory.
9717 Since the statistics provided by the Linux kernel are very detailed, they are
9718 collected very detailed. However, to get all the details, you have to switch
9719 them on manually. Most people just want an overview over, such as the number of
9720 pages read from swap space.
9724 =item B<Verbose> B<true>|B<false>
9726 Enables verbose collection of information. This will start collecting page
9727 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
9728 Part of these statistics are collected on a "per zone" basis.
9732 =head2 Plugin C<vserver>
9734 This plugin doesn't have any options. B<VServer> support is only available for
9735 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
9736 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
9737 need to apply the patches and compile your own kernel, which will then provide
9738 the F</proc/virtual> filesystem that is required by this plugin.
9740 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
9742 B<Note>: The traffic collected by this plugin accounts for the amount of
9743 traffic passing a socket which might be a lot less than the actual on-wire
9744 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
9745 collect on-wire traffic you could, for example, use the logging facilities of
9746 iptables to feed data for the guest IPs into the iptables plugin.
9748 =head2 Plugin C<write_graphite>
9750 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
9751 storage and graphing project. The plugin connects to I<Carbon>, the data layer
9752 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
9753 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
9754 of at most 1428 bytes to minimize the number of network packets.
9758 <Plugin write_graphite>
9770 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9771 blocks. Inside the B<Node> blocks, the following options are recognized:
9775 =item B<Host> I<Address>
9777 Hostname or address to connect to. Defaults to C<localhost>.
9779 =item B<Port> I<Service>
9781 Service name or port number to connect to. Defaults to C<2003>.
9783 =item B<Protocol> I<String>
9785 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
9787 =item B<ReconnectInterval> I<Seconds>
9789 When set to non-zero, forces the connection to the Graphite backend to be
9790 closed and re-opend periodically. This behavior is desirable in environments
9791 where the connection to the Graphite backend is done through load balancers,
9792 for example. When set to zero, the default, the connetion is kept open for as
9795 =item B<LogSendErrors> B<false>|B<true>
9797 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
9798 If set to B<false>, it will not log the errors. This is especially useful when
9799 using Protocol UDP since many times we want to use the "fire-and-forget"
9800 approach and logging errors fills syslog with unneeded messages.
9802 =item B<Prefix> I<String>
9804 When B<UseTags> is I<false>, B<Prefix> value is added in front of the host name.
9805 When B<UseTags> is I<true>, B<Prefix> value is added in front of series name.
9807 Dots and whitespace are I<not> escaped in this string (see B<EscapeCharacter>
9810 =item B<Postfix> I<String>
9812 When B<UseTags> is I<false>, B<Postfix> value appended to the host name.
9813 When B<UseTags> is I<true>, B<Postgix> value appended to the end of series name
9814 (before the first ; that separates the name from the tags).
9816 Dots and whitespace are I<not> escaped in this string (see B<EscapeCharacter>
9819 =item B<EscapeCharacter> I<Char>
9821 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
9822 in the identifier. The B<EscapeCharacter> option determines which character
9823 dots, whitespace and control characters are replaced with. Defaults to
9826 =item B<StoreRates> B<false>|B<true>
9828 If set to B<true> (the default), convert counter values to rates. If set to
9829 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
9832 =item B<SeparateInstances> B<false>|B<true>
9834 If set to B<true>, the plugin instance and type instance will be in their own
9835 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9836 default), the plugin and plugin instance (and likewise the type and type
9837 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9839 Option value is not used when B<UseTags> is I<true>.
9841 =item B<AlwaysAppendDS> B<false>|B<true>
9843 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9844 identifier. If set to B<false> (the default), this is only done when there is
9847 =item B<PreserveSeparator> B<false>|B<true>
9849 If set to B<false> (the default) the C<.> (dot) character is replaced with
9850 I<EscapeCharacter>. Otherwise, if set to B<true>, the C<.> (dot) character
9851 is preserved, i.e. passed through.
9853 Option value is not used when B<UseTags> is I<true>.
9855 =item B<DropDuplicateFields> B<false>|B<true>
9857 If set to B<true>, detect and remove duplicate components in Graphite metric
9858 names. For example, the metric name C<host.load.load.shortterm> will
9859 be shortened to C<host.load.shortterm>.
9861 =item B<UseTags> B<false>|B<true>
9863 If set to B<true>, Graphite metric names will be generated as tagged series.
9864 This allows for much more flexibility than the traditional hierarchical layout.
9867 C<test.single;host=example.com;plugin=test;plugin_instance=foo;type=single;type_instance=bar>
9869 You can use B<Postfix> option to add more tags by specifying it like
9870 C<;tag1=value1;tag2=value2>. Note what tagging support was added since Graphite
9873 If set to B<true>, the B<SeparateInstances> and B<PreserveSeparator> settings
9876 Default value: B<false>.
9878 =item B<ReverseHost> B<false>|B<true>
9880 If set to B<true>, the (dot separated) parts of the B<host> field of the
9881 I<value list> will be rewritten in reverse order. The rewrite happens I<before>
9882 special characters are replaced with the B<EscapeCharacter>.
9884 This option might be convenient if the metrics are presented with Graphite in a
9885 DNS like tree structure (probably without replacing dots in hostnames).
9888 Hostname "node3.cluster1.example.com"
9890 LoadPlugin "write_graphite"
9891 <Plugin "write_graphite">
9892 <Node "graphite.example.com">
9898 result on the wire: com.example.cluster1.node3.cpu-0.cpu-idle 99.900993 1543010932
9900 Default value: B<false>.
9904 =head2 Plugin C<write_log>
9906 The C<write_log> plugin writes metrics as INFO log messages.
9908 This plugin supports two output formats: I<Graphite> and I<JSON>.
9918 =item B<Format> I<Format>
9920 The output format to use. Can be one of C<Graphite> or C<JSON>.
9924 =head2 Plugin C<write_tsdb>
9926 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
9927 time series database. The plugin connects to a I<TSD>, a masterless, no shared
9928 state daemon that ingests metrics and stores them in HBase. The plugin uses
9929 I<TCP> over the "line based" protocol with a default port 4242. The data will
9930 be sent in blocks of at most 1428 bytes to minimize the number of network
9939 Host "tsd-1.my.domain"
9941 HostTags "status=production"
9945 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9946 blocks and global directives.
9948 Global directives are:
9952 =item B<ResolveInterval> I<seconds>
9954 =item B<ResolveJitter> I<seconds>
9956 When I<collectd> connects to a TSDB node, it will request the hostname from
9957 DNS. This can become a problem if the TSDB node is unavailable or badly
9958 configured because collectd will request DNS in order to reconnect for every
9959 metric, which can flood your DNS. So you can cache the last value for
9960 I<ResolveInterval> seconds.
9961 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9963 You can also define a jitter, a random interval to wait in addition to
9964 I<ResolveInterval>. This prevents all your collectd servers to resolve the
9965 hostname at the same time when the connection fails.
9966 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9968 B<Note:> If the DNS resolution has already been successful when the socket
9969 closes, the plugin will try to reconnect immediately with the cached
9970 information. DNS is queried only when the socket is closed for a longer than
9971 I<ResolveInterval> + I<ResolveJitter> seconds.
9975 Inside the B<Node> blocks, the following options are recognized:
9979 =item B<Host> I<Address>
9981 Hostname or address to connect to. Defaults to C<localhost>.
9983 =item B<Port> I<Service>
9985 Service name or port number to connect to. Defaults to C<4242>.
9988 =item B<HostTags> I<String>
9990 When set, I<HostTags> is added to the end of the metric. It is intended to be
9991 used for name=value pairs that the TSD will tag the metric with. Dots and
9992 whitespace are I<not> escaped in this string.
9994 =item B<StoreRates> B<false>|B<true>
9996 If set to B<true>, convert counter values to rates. If set to B<false>
9997 (the default) counter values are stored as is, as an increasing
10000 =item B<AlwaysAppendDS> B<false>|B<true>
10002 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
10003 identifier. If set to B<false> (the default), this is only done when there is
10008 =head2 Plugin C<write_mongodb>
10010 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
10015 <Plugin "write_mongodb">
10024 The plugin can send values to multiple instances of I<MongoDB> by specifying
10025 one B<Node> block for each instance. Within the B<Node> blocks, the following
10026 options are available:
10030 =item B<Host> I<Address>
10032 Hostname or address to connect to. Defaults to C<localhost>.
10034 =item B<Port> I<Service>
10036 Service name or port number to connect to. Defaults to C<27017>.
10038 =item B<Timeout> I<Milliseconds>
10040 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
10041 Setting this option to zero means no timeout, which is the default.
10043 =item B<StoreRates> B<false>|B<true>
10045 If set to B<true> (the default), convert counter values to rates. If set to
10046 B<false> counter values are stored as is, i.e. as an increasing integer
10049 =item B<Database> I<Database>
10051 =item B<User> I<User>
10053 =item B<Password> I<Password>
10055 Sets the information used when authenticating to a I<MongoDB> database. The
10056 fields are optional (in which case no authentication is attempted), but if you
10057 want to use authentication all three fields must be set.
10061 =head2 Plugin C<write_prometheus>
10063 The I<write_prometheus plugin> implements a tiny webserver that can be scraped
10064 using I<Prometheus>.
10070 =item B<Host> I<Host>
10072 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
10073 "any" address, i.e. accept packets sent to any of the hosts addresses.
10075 This option is supported only for libmicrohttpd newer than 0.9.0.
10077 =item B<Port> I<Port>
10079 Port the embedded webserver should listen on. Defaults to B<9103>.
10081 =item B<StalenessDelta> I<Seconds>
10083 Time in seconds after which I<Prometheus> considers a metric "stale" if it
10084 hasn't seen any update for it. This value must match the setting in Prometheus.
10085 It defaults to B<300> seconds (5 minutes), same as Prometheus.
10089 I<Prometheus> has a global setting, C<StalenessDelta>, which controls after
10090 which time a metric without updates is considered "stale". This setting
10091 effectively puts an upper limit on the interval in which metrics are reported.
10093 When the I<write_prometheus plugin> encounters a metric with an interval
10094 exceeding this limit, it will inform you, the user, and provide the metric to
10095 I<Prometheus> B<without> a timestamp. That causes I<Prometheus> to consider the
10096 metric "fresh" each time it is scraped, with the time of the scrape being
10097 considered the time of the update. The result is that there appear more
10098 datapoints in I<Prometheus> than were actually created, but at least the metric
10099 doesn't disappear periodically.
10103 =head2 Plugin C<write_http>
10105 This output plugin submits values to an HTTP server using POST requests and
10106 encoding metrics with JSON or using the C<PUTVAL> command described in
10107 L<collectd-unixsock(5)>.
10111 <Plugin "write_http">
10113 URL "http://example.com/post-collectd"
10115 Password "weCh3ik0"
10120 The plugin can send values to multiple HTTP servers by specifying one
10121 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
10122 block, the following options are available:
10126 =item B<URL> I<URL>
10128 URL to which the values are submitted to. Mandatory.
10130 =item B<User> I<Username>
10132 Optional user name needed for authentication.
10134 =item B<Password> I<Password>
10136 Optional password needed for authentication.
10138 =item B<VerifyPeer> B<true>|B<false>
10140 Enable or disable peer SSL certificate verification. See
10141 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
10143 =item B<VerifyHost> B<true|false>
10145 Enable or disable peer host name verification. If enabled, the plugin checks if
10146 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
10147 matches the host name provided by the B<URL> option. If this identity check
10148 fails, the connection is aborted. Obviously, only works when connecting to a
10149 SSL enabled server. Enabled by default.
10151 =item B<CACert> I<File>
10153 File that holds one or more SSL certificates. If you want to use HTTPS you will
10154 possibly need this option. What CA certificates come bundled with C<libcurl>
10155 and are checked by default depends on the distribution you use.
10157 =item B<CAPath> I<Directory>
10159 Directory holding one or more CA certificate files. You can use this if for
10160 some reason all the needed CA certificates aren't in the same file and can't be
10161 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
10164 =item B<ClientKey> I<File>
10166 File that holds the private key in PEM format to be used for certificate-based
10169 =item B<ClientCert> I<File>
10171 File that holds the SSL certificate to be used for certificate-based
10174 =item B<ClientKeyPass> I<Password>
10176 Password required to load the private key in B<ClientKey>.
10178 =item B<Header> I<Header>
10180 A HTTP header to add to the request. Multiple headers are added if this option is specified more than once. Example:
10182 Header "X-Custom-Header: custom_value"
10184 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
10186 Define which SSL protocol version must be used. By default C<libcurl> will
10187 attempt to figure out the remote SSL protocol version. See
10188 L<curl_easy_setopt(3)> for more details.
10190 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
10192 Format of the output to generate. If set to B<Command>, will create output that
10193 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
10194 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
10195 , will create output in the KairosDB format.
10197 Defaults to B<Command>.
10199 =item B<Attribute> I<String> I<String>
10201 Only available for the KAIROSDB output format.
10203 Consider the two given strings to be the key and value of an additional tag for
10204 each metric being sent out.
10206 You can add multiple B<Attribute>.
10208 =item B<TTL> I<Int>
10210 Only available for the KAIROSDB output format.
10212 Sets the Cassandra ttl for the data points.
10214 Please refer to L<http://kairosdb.github.io/docs/build/html/restapi/AddDataPoints.html?highlight=ttl>
10216 =item B<Prefix> I<String>
10218 Only available for the KAIROSDB output format.
10220 Sets the metrics prefix I<string>. Defaults to I<collectd>.
10222 =item B<Metrics> B<true>|B<false>
10224 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
10226 =item B<Notifications> B<false>|B<true>
10228 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
10230 =item B<StoreRates> B<true|false>
10232 If set to B<true>, convert counter values to rates. If set to B<false> (the
10233 default) counter values are stored as is, i.e. as an increasing integer number.
10235 =item B<BufferSize> I<Bytes>
10237 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
10238 requests will be generated, but more metrics will be batched / metrics are
10239 cached for longer before being sent, introducing additional delay until they
10240 are available on the server side. I<Bytes> must be at least 1024 and cannot
10241 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
10242 Defaults to C<4096>.
10244 =item B<LowSpeedLimit> I<Bytes per Second>
10246 Sets the minimal transfer rate in I<Bytes per Second> below which the
10247 connection with the HTTP server will be considered too slow and aborted. All
10248 the data submitted over this connection will probably be lost. Defaults to 0,
10249 which means no minimum transfer rate is enforced.
10251 =item B<Timeout> I<Timeout>
10253 Sets the maximum time in milliseconds given for HTTP POST operations to
10254 complete. When this limit is reached, the POST operation will be aborted, and
10255 all the data in the current send buffer will probably be lost. Defaults to 0,
10256 which means the connection never times out.
10258 =item B<LogHttpError> B<false>|B<true>
10260 Enables printing of HTTP error code to log. Turned off by default.
10262 The C<write_http> plugin regularly submits the collected values to the HTTP
10263 server. How frequently this happens depends on how much data you are collecting
10264 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
10265 slightly below this interval, which you can estimate by monitoring the network
10266 traffic between collectd and the HTTP server.
10270 =head2 Plugin C<write_kafka>
10272 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
10276 <Plugin "write_kafka">
10277 Property "metadata.broker.list" "broker1:9092,broker2:9092"
10283 The following options are understood by the I<write_kafka plugin>:
10287 =item E<lt>B<Topic> I<Name>E<gt>
10289 The plugin's configuration consists of one or more B<Topic> blocks. Each block
10290 is given a unique I<Name> and specifies one kafka producer.
10291 Inside the B<Topic> block, the following per-topic options are
10296 =item B<Property> I<String> I<String>
10298 Configure the named property for the current topic. Properties are
10299 forwarded to the kafka producer library B<librdkafka>.
10301 =item B<Key> I<String>
10303 Use the specified string as a partitioning key for the topic. Kafka breaks
10304 topic into partitions and guarantees that for a given topology, the same
10305 consumer will be used for a specific key. The special (case insensitive)
10306 string B<Random> can be used to specify that an arbitrary partition should
10309 =item B<Format> B<Command>|B<JSON>|B<Graphite>
10311 Selects the format in which messages are sent to the broker. If set to
10312 B<Command> (the default), values are sent as C<PUTVAL> commands which are
10313 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
10315 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
10316 an easy and straight forward exchange format.
10318 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
10319 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
10321 =item B<StoreRates> B<true>|B<false>
10323 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
10324 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
10325 default), no conversion is performed. Otherwise the conversion is performed
10326 using the internal value cache.
10328 Please note that currently this option is only used if the B<Format> option has
10329 been set to B<JSON>.
10331 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
10333 A prefix can be added in the metric name when outputting in the I<Graphite>
10336 When B<GraphiteUseTags> is I<false>, prefix is added before the I<Host> name.
10337 Metric name will be
10338 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>>
10340 When B<GraphiteUseTags> is I<true>, prefix is added in front of series name.
10342 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
10344 A postfix can be added in the metric name when outputting in the I<Graphite>
10347 When B<GraphiteUseTags> is I<false>, postfix is added after the I<Host> name.
10348 Metric name will be
10349 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>>
10351 When B<GraphiteUseTags> is I<true>, prefix value appended to the end of series
10352 name (before the first ; that separates the name from the tags).
10354 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
10356 Specify a character to replace dots (.) in the host part of the metric name.
10357 In I<Graphite> metric name, dots are used as separators between different
10358 metric parts (host, plugin, type).
10359 Default is C<_> (I<Underscore>).
10361 =item B<GraphiteSeparateInstances> B<false>|B<true>
10363 If set to B<true>, the plugin instance and type instance will be in their own
10364 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
10365 default), the plugin and plugin instance (and likewise the type and type
10366 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
10368 Option value is not used when B<GraphiteUseTags> is I<true>.
10370 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
10372 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
10373 identifier. If set to B<false> (the default), this is only done when there is
10376 =item B<GraphitePreserveSeparator> B<false>|B<true>
10378 If set to B<false> (the default) the C<.> (dot) character is replaced with
10379 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
10380 is preserved, i.e. passed through.
10382 Option value is not used when B<GraphiteUseTags> is I<true>.
10384 =item B<GraphiteUseTags> B<false>|B<true>
10386 If set to B<true> Graphite metric names will be generated as tagged series.
10388 Default value: B<false>.
10390 =item B<StoreRates> B<true>|B<false>
10392 If set to B<true> (the default), convert counter values to rates. If set to
10393 B<false> counter values are stored as is, i.e. as an increasing integer number.
10395 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
10396 converted values will have "rate" appended to the data source type, e.g.
10397 C<ds_type:derive:rate>.
10401 =item B<Property> I<String> I<String>
10403 Configure the kafka producer through properties, you almost always will
10404 want to set B<metadata.broker.list> to your Kafka broker list.
10408 =head2 Plugin C<write_redis>
10410 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
10414 <Plugin "write_redis">
10427 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
10428 the timestamp as the score. Retrieving a date range can then be done using the
10429 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
10430 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
10431 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
10432 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
10433 with the B<Database> parameter (default is C<0>). See
10434 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
10437 The information shown in the synopsis above is the I<default configuration>
10438 which is used by the plugin if no configuration is present.
10440 The plugin can send values to multiple instances of I<Redis> by specifying
10441 one B<Node> block for each instance. Within the B<Node> blocks, the following
10442 options are available:
10446 =item B<Node> I<Nodename>
10448 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
10449 instance running on a specified host and port. The node name is a
10450 canonical identifier which is used as I<plugin instance>. It is limited to
10451 51E<nbsp>characters in length.
10453 =item B<Host> I<Hostname>
10455 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
10458 =item B<Port> I<Port>
10460 The B<Port> option is the TCP port on which the Redis instance accepts
10461 connections. Either a service name of a port number may be given. Please note
10462 that numerical port numbers must be given as a string, too.
10464 =item B<Timeout> I<Milliseconds>
10466 The B<Timeout> option sets the socket connection timeout, in milliseconds.
10468 =item B<Prefix> I<Prefix>
10470 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
10471 containing all metrics. Defaults to C<collectd/>, so metrics will have names
10472 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
10473 is recommended but not required to include a trailing slash in I<Prefix>.
10475 =item B<Database> I<Index>
10477 This index selects the redis database to use for writing operations. Defaults
10480 =item B<MaxSetSize> I<Items>
10482 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
10483 hold. Negative values for I<Items> sets no limit, which is the default behavior.
10485 =item B<MaxSetDuration> I<Seconds>
10487 The B<MaxSetDuration> option limits the duration of items that the
10488 I<Sorted Sets> can hold. Negative values for I<Items> sets no duration, which
10489 is the default behavior.
10491 =item B<StoreRates> B<true>|B<false>
10493 If set to B<true> (the default), convert counter values to rates. If set to
10494 B<false> counter values are stored as is, i.e. as an increasing integer number.
10498 =head2 Plugin C<write_riemann>
10500 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
10501 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
10502 I<Riemann> using UDP packets.
10506 <Plugin "write_riemann">
10512 AlwaysAppendDS false
10516 Attribute "foo" "bar"
10519 The following options are understood by the I<write_riemann plugin>:
10523 =item E<lt>B<Node> I<Name>E<gt>
10525 The plugin's configuration consists of one or more B<Node> blocks. Each block
10526 is given a unique I<Name> and specifies one connection to an instance of
10527 I<Riemann>. Indise the B<Node> block, the following per-connection options are
10532 =item B<Host> I<Address>
10534 Hostname or address to connect to. Defaults to C<localhost>.
10536 =item B<Port> I<Service>
10538 Service name or port number to connect to. Defaults to C<5555>.
10540 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
10542 Specify the protocol to use when communicating with I<Riemann>. Defaults to
10545 =item B<TLSCertFile> I<Path>
10547 When using the B<TLS> protocol, path to a PEM certificate to present
10550 =item B<TLSCAFile> I<Path>
10552 When using the B<TLS> protocol, path to a PEM CA certificate to
10553 use to validate the remote hosts's identity.
10555 =item B<TLSKeyFile> I<Path>
10557 When using the B<TLS> protocol, path to a PEM private key associated
10558 with the certificate defined by B<TLSCertFile>.
10560 =item B<Batch> B<true>|B<false>
10562 If set to B<true> and B<Protocol> is set to B<TCP>,
10563 events will be batched in memory and flushed at
10564 regular intervals or when B<BatchMaxSize> is exceeded.
10566 Notifications are not batched and sent as soon as possible.
10568 When enabled, it can occur that events get processed by the Riemann server
10569 close to or after their expiration time. Tune the B<TTLFactor> and
10570 B<BatchMaxSize> settings according to the amount of values collected, if this
10575 =item B<BatchMaxSize> I<size>
10577 Maximum payload size for a riemann packet. Defaults to 8192
10579 =item B<BatchFlushTimeout> I<seconds>
10581 Maximum amount of seconds to wait in between to batch flushes.
10582 No timeout by default.
10584 =item B<StoreRates> B<true>|B<false>
10586 If set to B<true> (the default), convert counter values to rates. If set to
10587 B<false> counter values are stored as is, i.e. as an increasing integer number.
10589 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
10590 converted values will have "rate" appended to the data source type, e.g.
10591 C<ds_type:derive:rate>.
10593 =item B<AlwaysAppendDS> B<false>|B<true>
10595 If set to B<true>, append the name of the I<Data Source> (DS) to the
10596 "service", i.e. the field that, together with the "host" field, uniquely
10597 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
10598 only done when there is more than one DS.
10600 =item B<TTLFactor> I<Factor>
10602 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
10603 event is considered active. I<collectd> populates this field based on the
10604 metrics interval setting. This setting controls the factor with which the
10605 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
10606 know exactly what you're doing, you should only increase this setting from its
10609 =item B<Notifications> B<false>|B<true>
10611 If set to B<true>, create riemann events for notifications. This is B<true>
10612 by default. When processing thresholds from write_riemann, it might prove
10613 useful to avoid getting notification events.
10615 =item B<CheckThresholds> B<false>|B<true>
10617 If set to B<true>, attach state to events based on thresholds defined
10618 in the B<Threshold> plugin. Defaults to B<false>.
10620 =item B<EventServicePrefix> I<String>
10622 Add the given string as a prefix to the event service name.
10623 If B<EventServicePrefix> not set or set to an empty string (""),
10624 no prefix will be used.
10628 =item B<Tag> I<String>
10630 Add the given string as an additional tag to the metric being sent to
10633 =item B<Attribute> I<String> I<String>
10635 Consider the two given strings to be the key and value of an additional
10636 attribute for each metric being sent out to I<Riemann>.
10640 =head2 Plugin C<write_sensu>
10642 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
10643 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
10644 a local I<Sensu> client using a TCP socket.
10646 At the moment, the I<write_sensu plugin> does not send over a collectd_host
10647 parameter so it is not possible to use one collectd instance as a gateway for
10648 others. Each collectd host must pair with one I<Sensu> client.
10652 <Plugin "write_sensu">
10657 AlwaysAppendDS false
10658 MetricHandler "influx"
10659 MetricHandler "default"
10660 NotificationHandler "flapjack"
10661 NotificationHandler "howling_monkey"
10665 Attribute "foo" "bar"
10668 The following options are understood by the I<write_sensu plugin>:
10672 =item E<lt>B<Node> I<Name>E<gt>
10674 The plugin's configuration consists of one or more B<Node> blocks. Each block
10675 is given a unique I<Name> and specifies one connection to an instance of
10676 I<Sensu>. Inside the B<Node> block, the following per-connection options are
10681 =item B<Host> I<Address>
10683 Hostname or address to connect to. Defaults to C<localhost>.
10685 =item B<Port> I<Service>
10687 Service name or port number to connect to. Defaults to C<3030>.
10689 =item B<StoreRates> B<true>|B<false>
10691 If set to B<true> (the default), convert counter values to rates. If set to
10692 B<false> counter values are stored as is, i.e. as an increasing integer number.
10694 This will be reflected in the C<collectd_data_source_type> tag: If
10695 B<StoreRates> is enabled, converted values will have "rate" appended to the
10696 data source type, e.g. C<collectd_data_source_type:derive:rate>.
10698 =item B<AlwaysAppendDS> B<false>|B<true>
10700 If set the B<true>, append the name of the I<Data Source> (DS) to the
10701 "service", i.e. the field that, together with the "host" field, uniquely
10702 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
10703 only done when there is more than one DS.
10705 =item B<Notifications> B<false>|B<true>
10707 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
10708 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10710 =item B<Metrics> B<false>|B<true>
10712 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
10713 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10716 =item B<Separator> I<String>
10718 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
10720 =item B<MetricHandler> I<String>
10722 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
10723 several of them, one per line. Defaults to no handler.
10725 =item B<NotificationHandler> I<String>
10727 Add a handler that will be set when notifications are sent to I<Sensu>. You can
10728 add several of them, one per line. Defaults to no handler.
10730 =item B<EventServicePrefix> I<String>
10732 Add the given string as a prefix to the event service name.
10733 If B<EventServicePrefix> not set or set to an empty string (""),
10734 no prefix will be used.
10738 =item B<Tag> I<String>
10740 Add the given string as an additional tag to the metric being sent to
10743 =item B<Attribute> I<String> I<String>
10745 Consider the two given strings to be the key and value of an additional
10746 attribute for each metric being sent out to I<Sensu>.
10750 =head2 Plugin C<write_stackdriver>
10752 The C<write_stackdriver> plugin writes metrics to the
10753 I<Google Stackdriver Monitoring> service.
10755 This plugin supports two authentication methods: When configured, credentials
10756 are read from the JSON credentials file specified with B<CredentialFile>.
10757 Alternatively, when running on
10758 I<Google Compute Engine> (GCE), an I<OAuth> token is retrieved from the
10759 I<metadata server> and used to authenticate to GCM.
10763 <Plugin write_stackdriver>
10764 CredentialFile "/path/to/service_account.json"
10765 <Resource "global">
10766 Label "project_id" "monitored_project"
10772 =item B<CredentialFile> I<file>
10774 Path to a JSON credentials file holding the credentials for a GCP service
10777 If B<CredentialFile> is not specified, the plugin uses I<Application Default
10778 Credentials>. That means which credentials are used depends on the environment:
10784 The environment variable C<GOOGLE_APPLICATION_CREDENTIALS> is checked. If this
10785 variable is specified it should point to a JSON file that defines the
10790 The path C<${HOME}/.config/gcloud/application_default_credentials.json> is
10791 checked. This where credentials used by the I<gcloud> command line utility are
10792 stored. You can use C<gcloud auth application-default login> to create these
10795 Please note that these credentials are often of your personal account, not a
10796 service account, and are therefore unfit to be used in a production
10801 When running on GCE, the built-in service account associated with the virtual
10802 machine instance is used.
10803 See also the B<Email> option below.
10807 =item B<Project> I<Project>
10809 The I<Project ID> or the I<Project Number> of the I<Stackdriver Account>. The
10810 I<Project ID> is a string identifying the GCP project, which you can chose
10811 freely when creating a new project. The I<Project Number> is a 12-digit decimal
10812 number. You can look up both on the I<Developer Console>.
10814 This setting is optional. If not set, the project ID is read from the
10815 credentials file or determined from the GCE's metadata service.
10817 =item B<Email> I<Email> (GCE only)
10819 Choses the GCE I<Service Account> used for authentication.
10821 Each GCE instance has a C<default> I<Service Account> but may also be
10822 associated with additional I<Service Accounts>. This is often used to restrict
10823 the permissions of services running on the GCE instance to the required
10824 minimum. The I<write_stackdriver plugin> requires the
10825 C<https://www.googleapis.com/auth/monitoring> scope. When multiple I<Service
10826 Accounts> are available, this option selects which one is used by
10827 I<write_stackdriver plugin>.
10829 =item B<Resource> I<ResourceType>
10831 Configures the I<Monitored Resource> to use when storing metrics.
10832 More information on I<Monitored Resources> and I<Monitored Resource Types> are
10833 available at L<https://cloud.google.com/monitoring/api/resources>.
10835 This block takes one string argument, the I<ResourceType>. Inside the block are
10836 one or more B<Label> options which configure the resource labels.
10838 This block is optional. The default value depends on the runtime environment:
10839 on GCE, the C<gce_instance> resource type is used, otherwise the C<global>
10840 resource type ist used:
10846 B<On GCE>, defaults to the equivalent of this config:
10848 <Resource "gce_instance">
10849 Label "project_id" "<project_id>"
10850 Label "instance_id" "<instance_id>"
10851 Label "zone" "<zone>"
10854 The values for I<project_id>, I<instance_id> and I<zone> are read from the GCE
10859 B<Elsewhere>, i.e. not on GCE, defaults to the equivalent of this config:
10861 <Resource "global">
10862 Label "project_id" "<Project>"
10865 Where I<Project> refers to the value of the B<Project> option or the project ID
10866 inferred from the B<CredentialFile>.
10870 =item B<Url> I<Url>
10872 URL of the I<Stackdriver Monitoring> API. Defaults to
10873 C<https://monitoring.googleapis.com/v3>.
10877 =head2 Plugin C<write_syslog>
10879 The C<write_syslog> plugin writes data in I<syslog> format log messages.
10880 It implements the basic syslog protocol, RFC 5424, extends it with
10881 content-based filtering, rich filtering capabilities,
10882 flexible configuration options and adds features such as using TCP for transport.
10883 The plugin can connect to a I<Syslog> daemon, like syslog-ng and rsyslog, that will
10884 ingest metrics, transform and ship them to the specified output.
10885 The plugin uses I<TCP> over the "line based" protocol with a default port 44514.
10886 The data will be sent in blocks of at most 1428 bytes to minimize the number of
10891 <Plugin write_syslog>
10895 Host "syslog-1.my.domain"
10898 MessageFormat "human"
10903 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
10904 blocks and global directives.
10906 Global directives are:
10910 =item B<ResolveInterval> I<seconds>
10912 =item B<ResolveJitter> I<seconds>
10914 When I<collectd> connects to a syslog node, it will request the hostname from
10915 DNS. This can become a problem if the syslog node is unavailable or badly
10916 configured because collectd will request DNS in order to reconnect for every
10917 metric, which can flood your DNS. So you can cache the last value for
10918 I<ResolveInterval> seconds.
10919 Defaults to the I<Interval> of the I<write_syslog plugin>, e.g. 10E<nbsp>seconds.
10921 You can also define a jitter, a random interval to wait in addition to
10922 I<ResolveInterval>. This prevents all your collectd servers to resolve the
10923 hostname at the same time when the connection fails.
10924 Defaults to the I<Interval> of the I<write_syslog plugin>, e.g. 10E<nbsp>seconds.
10926 B<Note:> If the DNS resolution has already been successful when the socket
10927 closes, the plugin will try to reconnect immediately with the cached
10928 information. DNS is queried only when the socket is closed for a longer than
10929 I<ResolveInterval> + I<ResolveJitter> seconds.
10933 Inside the B<Node> blocks, the following options are recognized:
10937 =item B<Host> I<Address>
10939 Hostname or address to connect to. Defaults to C<localhost>.
10941 =item B<Port> I<Service>
10943 Service name or port number to connect to. Defaults to C<44514>.
10946 =item B<HostTags> I<String>
10948 When set, I<HostTags> is added to the end of the metric.
10949 It is intended to be used for adding additional metadata to tag the metric with.
10950 Dots and whitespace are I<not> escaped in this string.
10954 When MessageFormat is set to "human".
10956 ["prefix1" "example1"="example1_v"]["prefix2" "example2"="example2_v"]"
10958 When MessageFormat is set to "JSON", text should be in JSON format.
10959 Escaping the quotation marks is required.
10961 HostTags "\"prefix1\": {\"example1\":\"example1_v\",\"example2\":\"example2_v\"}"
10963 =item B<MessageFormat> I<String>
10965 I<MessageFormat> selects the format in which messages are sent to the
10966 syslog deamon, human or JSON. Defaults to human.
10968 Syslog message format:
10970 <priority>VERSION ISOTIMESTAMP HOSTNAME APPLICATION PID MESSAGEID STRUCTURED-DATA MSG
10972 The difference between the message formats are in the STRUCTURED-DATA and MSG parts.
10976 <166>1 ISOTIMESTAMP HOSTNAME collectd PID MESSAGEID
10977 ["collectd" "value": "v1" "plugin"="plugin_v" "plugin_instance"="plugin_instance_v"
10978 "type_instance"="type_instance_v" "type"="type_v" "ds_name"="ds_name_v" "interval"="interval_v" ]
10979 "host_tag_example"="host_tag_example_v" plugin_v.type_v.ds_name_v="v1"
10983 <166>1 ISOTIMESTAMP HOSTNAME collectd PID MESSAGEID STRUCTURED-DATA
10986 "time": time_as_epoch, "interval": interval_v, "plugin": "plugin_v",
10987 "plugin_instance": "plugin_instance_v", "type":"type_v",
10988 "type_instance": "type_instance_v", "plugin_v": {"type_v": v1}
10989 } , "host":"host_v", "host_tag_example": "host_tag_example_v"
10992 =item B<StoreRates> B<false>|B<true>
10994 If set to B<true>, convert counter values to rates. If set to B<false>
10995 (the default) counter values are stored as is, as an increasing
10998 =item B<AlwaysAppendDS> B<false>|B<true>
11000 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
11001 identifier. If set to B<false> (the default), this is only done when there is
11004 =item B<Prefix> I<String>
11006 When set, I<Prefix> is added to all metrics names as a prefix. It is intended in
11007 case you want to be able to define the source of the specific metric. Dots and
11008 whitespace are I<not> escaped in this string.
11012 =head2 Plugin C<xencpu>
11014 This plugin collects metrics of hardware CPU load for machine running Xen
11015 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
11016 Result is reported using the C<percent> type, for each CPU (core).
11018 This plugin doesn't have any options (yet).
11020 =head2 Plugin C<zookeeper>
11022 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
11023 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
11028 <Plugin "zookeeper">
11035 =item B<Host> I<Address>
11037 Hostname or address to connect to. Defaults to C<localhost>.
11039 =item B<Port> I<Service>
11041 Service name or port number to connect to. Defaults to C<2181>.
11045 =head1 THRESHOLD CONFIGURATION
11047 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
11048 we mean that the values are not only stored or sent somewhere, but that they
11049 are judged and, if a problem is recognized, acted upon. The only action
11050 collectd takes itself is to generate and dispatch a "notification". Plugins can
11051 register to receive notifications and perform appropriate further actions.
11053 Since systems and what you expect them to do differ a lot, you can configure
11054 B<thresholds> for your values freely. This gives you a lot of flexibility but
11055 also a lot of responsibility.
11057 Every time a value is out of range a notification is dispatched. This means
11058 that the idle percentage of your CPU needs to be less then the configured
11059 threshold only once for a notification to be generated. There's no such thing
11060 as a moving average or similar - at least not now.
11062 Also, all values that match a threshold are considered to be relevant or
11063 "interesting". As a consequence collectd will issue a notification if they are
11064 not received for B<Timeout> iterations. The B<Timeout> configuration option is
11065 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
11066 "2" (the default) and some hosts sends it's CPU statistics to the server every
11067 60 seconds, a notification will be dispatched after about 120 seconds. It may
11068 take a little longer because the timeout is checked only once each B<Interval>
11071 When a value comes within range again or is received after it was missing, an
11072 "OKAY-notification" is dispatched.
11074 Here is a configuration example to get you started. Read below for more
11087 <Plugin "interface">
11090 FailureMax 10000000
11104 WarningMin 100000000
11110 There are basically two types of configuration statements: The C<Host>,
11111 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
11112 configured. The C<Plugin> and C<Type> blocks may be specified further using the
11113 C<Instance> option. You can combine the block by nesting the blocks, though
11114 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
11115 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
11116 C<Type> may not contain other blocks. If multiple blocks apply to the same
11117 value the most specific block is used.
11119 The other statements specify the threshold to configure. They B<must> be
11120 included in a C<Type> block. Currently the following statements are recognized:
11124 =item B<FailureMax> I<Value>
11126 =item B<WarningMax> I<Value>
11128 Sets the upper bound of acceptable values. If unset defaults to positive
11129 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
11130 will be created. If the value is greater than B<WarningMax> but less than (or
11131 equal to) B<FailureMax> a B<WARNING> notification will be created.
11133 =item B<FailureMin> I<Value>
11135 =item B<WarningMin> I<Value>
11137 Sets the lower bound of acceptable values. If unset defaults to negative
11138 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
11139 be created. If the value is less than B<WarningMin> but greater than (or equal
11140 to) B<FailureMin> a B<WARNING> notification will be created.
11142 =item B<DataSource> I<DSName>
11144 Some data sets have more than one "data source". Interesting examples are the
11145 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
11146 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
11147 system load data set, C<load>, even has three data sources: C<shortterm>,
11148 C<midterm>, and C<longterm>.
11150 Normally, all data sources are checked against a configured threshold. If this
11151 is undesirable, or if you want to specify different limits for each data
11152 source, you can use the B<DataSource> option to have a threshold apply only to
11155 =item B<Invert> B<true>|B<false>
11157 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
11158 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
11159 B<WarningMax>) are not okay. Defaults to B<false>.
11161 =item B<Persist> B<true>|B<false>
11163 Sets how often notifications are generated. If set to B<true> one notification
11164 will be generated for each value that is out of the acceptable range. If set to
11165 B<false> (the default) then a notification is only generated if a value is out
11166 of range but the previous value was okay.
11168 This applies to missing values, too: If set to B<true> a notification about a
11169 missing value is generated once every B<Interval> seconds. If set to B<false>
11170 only one such notification is generated until the value appears again.
11172 =item B<Percentage> B<true>|B<false>
11174 If set to B<true>, the minimum and maximum values given are interpreted as
11175 percentage value, relative to the other data sources. This is helpful for
11176 example for the "df" type, where you may want to issue a warning when less than
11177 5E<nbsp>% of the total space is available. Defaults to B<false>.
11179 =item B<Hits> I<Number>
11181 Delay creating the notification until the threshold has been passed I<Number>
11182 times. When a notification has been generated, or when a subsequent value is
11183 inside the threshold, the counter is reset. If, for example, a value is
11184 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
11185 will be dispatched at most once every 30E<nbsp>seconds.
11187 This is useful when short bursts are not a problem. If, for example, 100% CPU
11188 usage for up to a minute is normal (and data is collected every
11189 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
11191 =item B<Hysteresis> I<Number>
11193 When set to non-zero, a hysteresis value is applied when checking minimum and
11194 maximum bounds. This is useful for values that increase slowly and fluctuate a
11195 bit while doing so. When these values come close to the threshold, they may
11196 "flap", i.e. switch between failure / warning case and okay case repeatedly.
11198 If, for example, the threshold is configures as
11203 then a I<Warning> notification is created when the value exceeds I<101> and the
11204 corresponding I<Okay> notification is only created once the value falls below
11205 I<99>, thus avoiding the "flapping".
11209 =head1 FILTER CONFIGURATION
11211 Starting with collectd 4.6 there is a powerful filtering infrastructure
11212 implemented in the daemon. The concept has mostly been copied from
11213 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
11214 terminology, so that users that are familiar with iptables feel right at home.
11218 The following are the terms used in the remainder of the filter configuration
11219 documentation. For an ASCII-art schema of the mechanism, see
11220 L<"General structure"> below.
11226 A I<match> is a criteria to select specific values. Examples are, of course, the
11227 name of the value or it's current value.
11229 Matches are implemented in plugins which you have to load prior to using the
11230 match. The name of such plugins starts with the "match_" prefix.
11234 A I<target> is some action that is to be performed with data. Such actions
11235 could, for example, be to change part of the value's identifier or to ignore
11236 the value completely.
11238 Some of these targets are built into the daemon, see L<"Built-in targets">
11239 below. Other targets are implemented in plugins which you have to load prior to
11240 using the target. The name of such plugins starts with the "target_" prefix.
11244 The combination of any number of matches and at least one target is called a
11245 I<rule>. The target actions will be performed for all values for which B<all>
11246 matches apply. If the rule does not have any matches associated with it, the
11247 target action will be performed for all values.
11251 A I<chain> is a list of rules and possibly default targets. The rules are tried
11252 in order and if one matches, the associated target will be called. If a value
11253 is handled by a rule, it depends on the target whether or not any subsequent
11254 rules are considered or if traversal of the chain is aborted, see
11255 L<"Flow control"> below. After all rules have been checked, the default targets
11260 =head2 General structure
11262 The following shows the resulting structure:
11269 +---------+ +---------+ +---------+ +---------+
11270 ! Rule !->! Match !->! Match !->! Target !
11271 +---------+ +---------+ +---------+ +---------+
11274 +---------+ +---------+ +---------+
11275 ! Rule !->! Target !->! Target !
11276 +---------+ +---------+ +---------+
11283 +---------+ +---------+ +---------+
11284 ! Rule !->! Match !->! Target !
11285 +---------+ +---------+ +---------+
11293 =head2 Flow control
11295 There are four ways to control which way a value takes through the filter
11302 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
11303 process the value with another chain. When the called chain finishes, usually
11304 the next target or rule after the jump is executed.
11308 The stop condition, signaled for example by the built-in target B<stop>, causes
11309 all processing of the value to be stopped immediately.
11313 Causes processing in the current chain to be aborted, but processing of the
11314 value generally will continue. This means that if the chain was called via
11315 B<Jump>, the next target or rule after the jump will be executed. If the chain
11316 was not called by another chain, control will be returned to the daemon and it
11317 may pass the value to another chain.
11321 Most targets will signal the B<continue> condition, meaning that processing
11322 should continue normally. There is no special built-in target for this
11329 The configuration reflects this structure directly:
11331 PostCacheChain "PostCache"
11332 <Chain "PostCache">
11333 <Rule "ignore_mysql_show">
11336 Type "^mysql_command$"
11337 TypeInstance "^show_"
11347 The above configuration example will ignore all values where the plugin field
11348 is "mysql", the type is "mysql_command" and the type instance begins with
11349 "show_". All other values will be sent to the C<rrdtool> write plugin via the
11350 default target of the chain. Since this chain is run after the value has been
11351 added to the cache, the MySQL C<show_*> command statistics will be available
11352 via the C<unixsock> plugin.
11354 =head2 List of configuration options
11358 =item B<PreCacheChain> I<ChainName>
11360 =item B<PostCacheChain> I<ChainName>
11362 Configure the name of the "pre-cache chain" and the "post-cache chain". The
11363 argument is the name of a I<chain> that should be executed before and/or after
11364 the values have been added to the cache.
11366 To understand the implications, it's important you know what is going on inside
11367 I<collectd>. The following diagram shows how values are passed from the
11368 read-plugins to the write-plugins:
11374 + - - - - V - - - - +
11375 : +---------------+ :
11378 : +-------+-------+ :
11381 : +-------+-------+ : +---------------+
11382 : ! Cache !--->! Value Cache !
11383 : ! insert ! : +---+---+-------+
11384 : +-------+-------+ : ! !
11385 : ! ,------------' !
11387 : +-------+---+---+ : +-------+-------+
11388 : ! Post-Cache +--->! Write-Plugins !
11389 : ! Chain ! : +---------------+
11390 : +---------------+ :
11392 : dispatch values :
11393 + - - - - - - - - - +
11395 After the values are passed from the "read" plugins to the dispatch functions,
11396 the pre-cache chain is run first. The values are added to the internal cache
11397 afterwards. The post-cache chain is run after the values have been added to the
11398 cache. So why is it such a huge deal if chains are run before or after the
11399 values have been added to this cache?
11401 Targets that change the identifier of a value list should be executed before
11402 the values are added to the cache, so that the name in the cache matches the
11403 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
11404 this cache to receive a list of all available values. If you change the
11405 identifier after the value list has been added to the cache, this may easily
11406 lead to confusion, but it's not forbidden of course.
11408 The cache is also used to convert counter values to rates. These rates are, for
11409 example, used by the C<value> match (see below). If you use the rate stored in
11410 the cache B<before> the new value is added, you will use the old, B<previous>
11411 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
11412 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
11415 Last but not last, the B<stop> target makes a difference: If the pre-cache
11416 chain returns the stop condition, the value will not be added to the cache and
11417 the post-cache chain will not be run.
11419 =item B<Chain> I<Name>
11421 Adds a new chain with a certain name. This name can be used to refer to a
11422 specific chain, for example to jump to it.
11424 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
11426 =item B<Rule> [I<Name>]
11428 Adds a new rule to the current chain. The name of the rule is optional and
11429 currently has no meaning for the daemon.
11431 Within the B<Rule> block, there may be any number of B<Match> blocks and there
11432 must be at least one B<Target> block.
11434 =item B<Match> I<Name>
11436 Adds a match to a B<Rule> block. The name specifies what kind of match should
11437 be performed. Available matches depend on the plugins that have been loaded.
11439 The arguments inside the B<Match> block are passed to the plugin implementing
11440 the match, so which arguments are valid here depends on the plugin being used.
11441 If you do not need any to pass any arguments to a match, you can use the
11446 Which is equivalent to:
11451 =item B<Target> I<Name>
11453 Add a target to a rule or a default target to a chain. The name specifies what
11454 kind of target is to be added. Which targets are available depends on the
11455 plugins being loaded.
11457 The arguments inside the B<Target> block are passed to the plugin implementing
11458 the target, so which arguments are valid here depends on the plugin being used.
11459 If you do not need any to pass any arguments to a target, you can use the
11464 This is the same as writing:
11471 =head2 Built-in targets
11473 The following targets are built into the core daemon and therefore need no
11474 plugins to be loaded:
11480 Signals the "return" condition, see the L<"Flow control"> section above. This
11481 causes the current chain to stop processing the value and returns control to
11482 the calling chain. The calling chain will continue processing targets and rules
11483 just after the B<jump> target (see below). This is very similar to the
11484 B<RETURN> target of iptables, see L<iptables(8)>.
11486 This target does not have any options.
11494 Signals the "stop" condition, see the L<"Flow control"> section above. This
11495 causes processing of the value to be aborted immediately. This is similar to
11496 the B<DROP> target of iptables, see L<iptables(8)>.
11498 This target does not have any options.
11506 Sends the value to "write" plugins.
11512 =item B<Plugin> I<Name>
11514 Name of the write plugin to which the data should be sent. This option may be
11515 given multiple times to send the data to more than one write plugin. If the
11516 plugin supports multiple instances, the plugin's instance(s) must also be
11521 If no plugin is explicitly specified, the values will be sent to all available
11524 Single-instance plugin example:
11530 Multi-instance plugin example:
11532 <Plugin "write_graphite">
11542 Plugin "write_graphite/foo"
11547 Starts processing the rules of another chain, see L<"Flow control"> above. If
11548 the end of that chain is reached, or a stop condition is encountered,
11549 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
11550 next target or the next rule. This is similar to the B<-j> command line option
11551 of iptables, see L<iptables(8)>.
11557 =item B<Chain> I<Name>
11559 Jumps to the chain I<Name>. This argument is required and may appear only once.
11571 =head2 Available matches
11577 Matches a value using regular expressions.
11583 =item B<Host> I<Regex>
11585 =item B<Plugin> I<Regex>
11587 =item B<PluginInstance> I<Regex>
11589 =item B<Type> I<Regex>
11591 =item B<TypeInstance> I<Regex>
11593 =item B<MetaData> I<String> I<Regex>
11595 Match values where the given regular expressions match the various fields of
11596 the identifier of a value. If multiple regular expressions are given, B<all>
11597 regexen must match for a value to match.
11599 =item B<Invert> B<false>|B<true>
11601 When set to B<true>, the result of the match is inverted, i.e. all value lists
11602 where all regular expressions apply are not matched, all other value lists are
11603 matched. Defaults to B<false>.
11610 Host "customer[0-9]+"
11616 Matches values that have a time which differs from the time on the server.
11618 This match is mainly intended for servers that receive values over the
11619 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
11620 is very sensitive to the timestamp used when updating the RRD files. In
11621 particular, the time must be ever increasing. If a misbehaving client sends one
11622 packet with a timestamp far in the future, all further packets with a correct
11623 time will be ignored because of that one packet. What's worse, such corrupted
11624 RRD files are hard to fix.
11626 This match lets one match all values B<outside> a specified time range
11627 (relative to the server's time), so you can use the B<stop> target (see below)
11628 to ignore the value, for example.
11634 =item B<Future> I<Seconds>
11636 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
11637 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
11640 =item B<Past> I<Seconds>
11642 Matches all values that are I<behind> of the server's time by I<Seconds> or
11643 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
11655 This example matches all values that are five minutes or more ahead of the
11656 server or one hour (or more) lagging behind.
11660 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
11661 values. If a data-set consists of more than one data-source, all data-sources
11662 must match the specified ranges for a positive match.
11668 =item B<Min> I<Value>
11670 Sets the smallest value which still results in a match. If unset, behaves like
11673 =item B<Max> I<Value>
11675 Sets the largest value which still results in a match. If unset, behaves like
11678 =item B<Invert> B<true>|B<false>
11680 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
11681 no-match is returned and vice versa. Please note that the B<Invert> setting
11682 only effects how B<Min> and B<Max> are applied to a specific value. Especially
11683 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
11685 =item B<DataSource> I<DSName> [I<DSName> ...]
11687 Select one or more of the data sources. If no data source is configured, all
11688 data sources will be checked. If the type handled by the match does not have a
11689 data source of the specified name(s), this will always result in no match
11690 (independent of the B<Invert> setting).
11692 =item B<Satisfy> B<Any>|B<All>
11694 Specifies how checking with several data sources is performed. If set to
11695 B<Any>, the match succeeds if one of the data sources is in the configured
11696 range. If set to B<All> the match only succeeds if all data sources are within
11697 the configured range. Default is B<All>.
11699 Usually B<All> is used for positive matches, B<Any> is used for negative
11700 matches. This means that with B<All> you usually check that all values are in a
11701 "good" range, while with B<Any> you check if any value is within a "bad" range
11702 (or outside the "good" range).
11706 Either B<Min> or B<Max>, but not both, may be unset.
11710 # Match all values smaller than or equal to 100. Matches only if all data
11711 # sources are below 100.
11717 # Match if the value of any data source is outside the range of 0 - 100.
11725 =item B<empty_counter>
11727 Matches all values with one or more data sources of type B<COUNTER> and where
11728 all counter values are zero. These counters usually I<never> increased since
11729 they started existing (and are therefore uninteresting), or got reset recently
11730 or overflowed and you had really, I<really> bad luck.
11732 Please keep in mind that ignoring such counters can result in confusing
11733 behavior: Counters which hardly ever increase will be zero for long periods of
11734 time. If the counter is reset for some reason (machine or service restarted,
11735 usually), the graph will be empty (NAN) for a long time. People may not
11740 Calculates a hash value of the host name and matches values according to that
11741 hash value. This makes it possible to divide all hosts into groups and match
11742 only values that are in a specific group. The intended use is in load
11743 balancing, where you want to handle only part of all data and leave the rest
11746 The hashing function used tries to distribute the hosts evenly. First, it
11747 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
11750 for (i = 0; host[i] != 0; i++)
11751 hash_value = (hash_value * 251) + host[i];
11753 The constant 251 is a prime number which is supposed to make this hash value
11754 more random. The code then checks the group for this host according to the
11755 I<Total> and I<Match> arguments:
11757 if ((hash_value % Total) == Match)
11762 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
11763 groups), then the least significant bit of the hash value will be the XOR of
11764 all least significant bits in the host name. One consequence is that when you
11765 have two hosts, "server0.example.com" and "server1.example.com", where the host
11766 name differs in one digit only and the digits differ by one, those hosts will
11767 never end up in the same group.
11773 =item B<Match> I<Match> I<Total>
11775 Divide the data into I<Total> groups and match all hosts in group I<Match> as
11776 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
11777 be smaller than I<Total>. I<Total> must be at least one, although only values
11778 greater than one really do make any sense.
11780 You can repeat this option to match multiple groups, for example:
11785 The above config will divide the data into seven groups and match groups three
11786 and five. One use would be to keep every value on two hosts so that if one
11787 fails the missing data can later be reconstructed from the second host.
11793 # Operate on the pre-cache chain, so that ignored values are not even in the
11798 # Divide all received hosts in seven groups and accept all hosts in
11802 # If matched: Return and continue.
11805 # If not matched: Return and stop.
11811 =head2 Available targets
11815 =item B<notification>
11817 Creates and dispatches a notification.
11823 =item B<Message> I<String>
11825 This required option sets the message of the notification. The following
11826 placeholders will be replaced by an appropriate value:
11834 =item B<%{plugin_instance}>
11838 =item B<%{type_instance}>
11840 These placeholders are replaced by the identifier field of the same name.
11842 =item B<%{ds:>I<name>B<}>
11844 These placeholders are replaced by a (hopefully) human readable representation
11845 of the current rate of this data source. If you changed the instance name
11846 (using the B<set> or B<replace> targets, see below), it may not be possible to
11847 convert counter values to rates.
11851 Please note that these placeholders are B<case sensitive>!
11853 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
11855 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
11862 <Target "notification">
11863 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
11869 Replaces parts of the identifier using regular expressions.
11875 =item B<Host> I<Regex> I<Replacement>
11877 =item B<Plugin> I<Regex> I<Replacement>
11879 =item B<PluginInstance> I<Regex> I<Replacement>
11881 =item B<TypeInstance> I<Regex> I<Replacement>
11883 =item B<MetaData> I<String> I<Regex> I<Replacement>
11885 =item B<DeleteMetaData> I<String> I<Regex>
11887 Match the appropriate field with the given regular expression I<Regex>. If the
11888 regular expression matches, that part that matches is replaced with
11889 I<Replacement>. If multiple places of the input buffer match a given regular
11890 expression, only the first occurrence will be replaced.
11892 You can specify each option multiple times to use multiple regular expressions
11900 # Replace "example.net" with "example.com"
11901 Host "\\<example.net\\>" "example.com"
11903 # Strip "www." from hostnames
11904 Host "\\<www\\." ""
11909 Sets part of the identifier of a value to a given string.
11915 =item B<Host> I<String>
11917 =item B<Plugin> I<String>
11919 =item B<PluginInstance> I<String>
11921 =item B<TypeInstance> I<String>
11923 =item B<MetaData> I<String> I<String>
11925 Set the appropriate field to the given string. The strings for plugin instance,
11926 type instance, and meta data may be empty, the strings for host and plugin may
11927 not be empty. It's currently not possible to set the type of a value this way.
11929 The following placeholders will be replaced by an appropriate value:
11937 =item B<%{plugin_instance}>
11941 =item B<%{type_instance}>
11943 These placeholders are replaced by the identifier field of the same name.
11945 =item B<%{meta:>I<name>B<}>
11947 These placeholders are replaced by the meta data value with the given name.
11951 Please note that these placeholders are B<case sensitive>!
11953 =item B<DeleteMetaData> I<String>
11955 Delete the named meta data field.
11962 PluginInstance "coretemp"
11963 TypeInstance "core3"
11968 =head2 Backwards compatibility
11970 If you use collectd with an old configuration, i.E<nbsp>e. one without a
11971 B<Chain> block, it will behave as it used to. This is equivalent to the
11972 following configuration:
11974 <Chain "PostCache">
11978 If you specify a B<PostCacheChain>, the B<write> target will not be added
11979 anywhere and you will have to make sure that it is called where appropriate. We
11980 suggest to add the above snippet as default target to your "PostCache" chain.
11984 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
11999 B<Ignorelists> are a generic framework to either ignore some metrics or report
12000 specific metrics only. Plugins usually provide one or more options to specify
12001 the items (mounts points, devices, ...) and the boolean option
12006 =item B<Select> I<String>
12008 Selects the item I<String>. This option often has a plugin specific name, e.g.
12009 B<Sensor> in the C<sensors> plugin. It is also plugin specific what this string
12010 is compared to. For example, the C<df> plugin's B<MountPoint> compares it to a
12011 mount point and the C<sensors> plugin's B<Sensor> compares it to a sensor name.
12013 By default, this option is doing a case-sensitive full-string match. The
12014 following config will match C<foo>, but not C<Foo>:
12018 If I<String> starts and ends with C</> (a slash), the string is compiled as a
12019 I<regular expression>. For example, so match all item starting with C<foo>, use
12020 could use the following syntax:
12024 The regular expression is I<not> anchored, i.e. the following config will match
12025 C<foobar>, C<barfoo> and C<AfooZ>:
12029 The B<Select> option may be repeated to select multiple items.
12031 =item B<IgnoreSelected> B<true>|B<false>
12033 If set to B<true>, matching metrics are I<ignored> and all other metrics are
12034 collected. If set to B<false>, matching metrics are I<collected> and all other
12035 metrics are ignored.
12042 L<collectd-exec(5)>,
12043 L<collectd-perl(5)>,
12044 L<collectd-unixsock(5)>,
12057 Florian Forster E<lt>octo@collectd.orgE<gt>