5 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
9 BaseDir "/var/lib/collectd"
10 PIDFile "/run/collectd.pid"
31 This config file controls how the system statistics collection daemon
32 B<collectd> behaves. The most significant option is B<LoadPlugin>, which
33 controls which plugins to load. These plugins ultimately define collectd's
34 behavior. If the B<AutoLoadPlugin> option has been enabled, the explicit
35 B<LoadPlugin> lines may be omitted for all plugins with a configuration block,
36 i.e. a C<E<lt>PluginE<nbsp>...E<gt>> block.
38 The syntax of this config file is similar to the config file of the famous
39 I<Apache> webserver. Each line contains either an option (a key and a list of
40 one or more values) or a section-start or -end. Empty lines and everything
41 after a non-quoted hash-symbol (C<#>) are ignored. I<Keys> are unquoted
42 strings, consisting only of alphanumeric characters and the underscore (C<_>)
43 character. Keys are handled case insensitive by I<collectd> itself and all
44 plugins included with it. I<Values> can either be an I<unquoted string>, a
45 I<quoted string> (enclosed in double-quotes) a I<number> or a I<boolean>
46 expression. I<Unquoted strings> consist of only alphanumeric characters and
47 underscores (C<_>) and do not need to be quoted. I<Quoted strings> are
48 enclosed in double quotes (C<">). You can use the backslash character (C<\>)
49 to include double quotes as part of the string. I<Numbers> can be specified in
50 decimal and floating point format (using a dot C<.> as decimal separator),
51 hexadecimal when using the C<0x> prefix and octal with a leading zero (C<0>).
52 I<Boolean> values are either B<true> or B<false>.
54 Lines may be wrapped by using C<\> as the last character before the newline.
55 This allows long lines to be split into multiple lines. Quoted strings may be
56 wrapped as well. However, those are treated special in that whitespace at the
57 beginning of the following lines will be ignored, which allows for nicely
58 indenting the wrapped lines.
60 The configuration is read and processed in order, i.e. from top to bottom. So
61 the plugins are loaded in the order listed in this config file. It is a good
62 idea to load any logging plugins first in order to catch messages from plugins
63 during configuration. Also, unless B<AutoLoadPlugin> is enabled, the
64 B<LoadPlugin> option I<must> occur I<before> the appropriate
65 C<E<lt>B<Plugin> ...E<gt>> block.
71 =item B<BaseDir> I<Directory>
73 Sets the base directory. This is the directory beneath which all RRD-files are
74 created. Possibly more subdirectories are created. This is also the working
75 directory for the daemon.
77 =item B<LoadPlugin> I<Plugin>
79 Loads the plugin I<Plugin>. This is required to load plugins, unless the
80 B<AutoLoadPlugin> option is enabled (see below). Without any loaded plugins,
81 I<collectd> will be mostly useless.
83 Only the first B<LoadPlugin> statement or block for a given plugin name has any
84 effect. This is useful when you want to split up the configuration into smaller
85 files and want each file to be "self contained", i.e. it contains a B<Plugin>
86 block I<and> the appropriate B<LoadPlugin> statement. The downside is that if
87 you have multiple conflicting B<LoadPlugin> blocks, e.g. when they specify
88 different intervals, only one of them (the first one encountered) will take
89 effect and all others will be silently ignored.
91 B<LoadPlugin> may either be a simple configuration I<statement> or a I<block>
92 with additional options, affecting the behavior of B<LoadPlugin>. A simple
93 statement looks like this:
97 Options inside a B<LoadPlugin> block can override default settings and
98 influence the way plugins are loaded, e.g.:
104 The following options are valid inside B<LoadPlugin> blocks:
108 =item B<Globals> B<true|false>
110 If enabled, collectd will export all global symbols of the plugin (and of all
111 libraries loaded as dependencies of the plugin) and, thus, makes those symbols
112 available for resolving unresolved symbols in subsequently loaded plugins if
113 that is supported by your system.
115 This is useful (or possibly even required), e.g., when loading a plugin that
116 embeds some scripting language into the daemon (e.g. the I<Perl> and
117 I<Python plugins>). Scripting languages usually provide means to load
118 extensions written in C. Those extensions require symbols provided by the
119 interpreter, which is loaded as a dependency of the respective collectd plugin.
120 See the documentation of those plugins (e.g., L<collectd-perl(5)> or
121 L<collectd-python(5)>) for details.
123 By default, this is disabled. As a special exception, if the plugin name is
124 either C<perl> or C<python>, the default is changed to enabled in order to keep
125 the average user from ever having to deal with this low level linking stuff.
127 =item B<Interval> I<Seconds>
129 Sets a plugin-specific interval for collecting metrics. This overrides the
130 global B<Interval> setting. If a plugin provides its own support for specifying
131 an interval, that setting will take precedence.
133 =item B<FlushInterval> I<Seconds>
135 Specifies the interval, in seconds, to call the flush callback if it's
136 defined in this plugin. By default, this is disabled.
138 =item B<FlushTimeout> I<Seconds>
140 Specifies the value of the timeout argument of the flush callback.
144 =item B<AutoLoadPlugin> B<false>|B<true>
146 When set to B<false> (the default), each plugin needs to be loaded explicitly,
147 using the B<LoadPlugin> statement documented above. If a
148 B<E<lt>PluginE<nbsp>...E<gt>> block is encountered and no configuration
149 handling callback for this plugin has been registered, a warning is logged and
150 the block is ignored.
152 When set to B<true>, explicit B<LoadPlugin> statements are not required. Each
153 B<E<lt>PluginE<nbsp>...E<gt>> block acts as if it was immediately preceded by a
154 B<LoadPlugin> statement. B<LoadPlugin> statements are still required for
155 plugins that don't provide any configuration, e.g. the I<Load plugin>.
157 =item B<CollectInternalStats> B<false>|B<true>
159 When set to B<true>, various statistics about the I<collectd> daemon will be
160 collected, with "collectd" as the I<plugin name>. Defaults to B<false>.
162 The following metrics are reported:
166 =item C<collectd-write_queue/queue_length>
168 The number of metrics currently in the write queue. You can limit the queue
169 length with the B<WriteQueueLimitLow> and B<WriteQueueLimitHigh> options.
171 =item C<collectd-write_queue/derive-dropped>
173 The number of metrics dropped due to a queue length limitation.
174 If this value is non-zero, your system can't handle all incoming metrics and
175 protects itself against overload by dropping metrics.
177 =item C<collectd-cache/cache_size>
179 The number of elements in the metric cache (the cache you can interact with
180 using L<collectd-unixsock(5)>).
184 =item B<Include> I<Path> [I<pattern>]
186 If I<Path> points to a file, includes that file. If I<Path> points to a
187 directory, recursively includes all files within that directory and its
188 subdirectories. If the C<wordexp> function is available on your system,
189 shell-like wildcards are expanded before files are included. This means you can
190 use statements like the following:
192 Include "/etc/collectd.d/*.conf"
194 Starting with version 5.3, this may also be a block in which further options
195 affecting the behavior of B<Include> may be specified. The following option is
198 <Include "/etc/collectd.d">
204 =item B<Filter> I<pattern>
206 If the C<fnmatch> function is available on your system, a shell-like wildcard
207 I<pattern> may be specified to filter which files to include. This may be used
208 in combination with recursively including a directory to easily be able to
209 arbitrarily mix configuration files and other documents (e.g. README files).
210 The given example is similar to the first example above but includes all files
211 matching C<*.conf> in any subdirectory of C</etc/collectd.d>.
215 If more than one file is included by a single B<Include> option, the files
216 will be included in lexicographical order (as defined by the C<strcmp>
217 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
218 order in which the files are loaded.
220 To prevent loops and shooting yourself in the foot in interesting ways the
221 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
222 most uses. Since symlinks are followed it is still possible to crash the daemon
223 by looping symlinks. In our opinion significant stupidity should result in an
224 appropriate amount of pain.
226 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
227 file, but you cannot include files from within blocks.
229 =item B<PIDFile> I<File>
231 Sets where to write the PID file to. This file is overwritten when it exists
232 and deleted when the program is stopped. Some init-scripts might override this
233 setting using the B<-P> command-line option.
235 =item B<PluginDir> I<Directory>
237 Path to the plugins (shared objects) of collectd.
239 =item B<TypesDB> I<File> [I<File> ...]
241 Set one or more files that contain the data-set descriptions. See
242 L<types.db(5)> for a description of the format of this file.
244 If this option is not specified, a default file is read. If you need to define
245 custom types in addition to the types defined in the default file, you need to
246 explicitly load both. In other words, if the B<TypesDB> option is encountered
247 the default behavior is disabled and if you need the default types you have to
248 also explicitly load them.
250 =item B<Interval> I<Seconds>
252 Configures the interval in which to query the read plugins. Obviously smaller
253 values lead to a higher system load produced by collectd, while higher values
254 lead to more coarse statistics.
256 B<Warning:> You should set this once and then never touch it again. If you do,
257 I<you will have to delete all your RRD files> or know some serious RRDtool
258 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
260 =item B<MaxReadInterval> I<Seconds>
262 A read plugin doubles the interval between queries after each failed attempt
265 This options limits the maximum value of the interval. The default value is
268 =item B<Timeout> I<Iterations>
270 Consider a value list "missing" when no update has been read or received for
271 I<Iterations> iterations. By default, I<collectd> considers a value list
272 missing when no update has been received for twice the update interval. Since
273 this setting uses iterations, the maximum allowed time without update depends
274 on the I<Interval> information contained in each value list. This is used in
275 the I<Threshold> configuration to dispatch notifications about missing values,
276 see L<collectd-threshold(5)> for details.
278 =item B<ReadThreads> I<Num>
280 Number of threads to start for reading plugins. The default value is B<5>, but
281 you may want to increase this if you have more than five plugins that take a
282 long time to read. Mostly those are plugins that do network-IO. Setting this to
283 a value higher than the number of registered read callbacks is not recommended.
285 =item B<WriteThreads> I<Num>
287 Number of threads to start for dispatching value lists to write plugins. The
288 default value is B<5>, but you may want to increase this if you have more than
289 five plugins that may take relatively long to write to.
291 =item B<WriteQueueLimitHigh> I<HighNum>
293 =item B<WriteQueueLimitLow> I<LowNum>
295 Metrics are read by the I<read threads> and then put into a queue to be handled
296 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
297 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
298 running into memory issues in such a case, you can limit the size of this
301 By default, there is no limit and memory may grow indefinitely. This is most
302 likely not an issue for clients, i.e. instances that only handle the local
303 metrics. For servers it is recommended to set this to a non-zero value, though.
305 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
306 Each of them takes a numerical argument which is the number of metrics in the
307 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
308 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
309 I<will> be enqueued. If the number of metrics currently in the queue is between
310 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
311 proportional to the number of metrics in the queue (i.e. it increases linearly
312 until it reaches 100%.)
314 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
315 unset, the latter will default to half of B<WriteQueueLimitHigh>.
317 If you do not want to randomly drop values when the queue size is between
318 I<LowNum> and I<HighNum>, set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>
321 Enabling the B<CollectInternalStats> option is of great help to figure out the
322 values to set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow> to.
324 =item B<Hostname> I<Name>
326 Sets the hostname that identifies a host. If you omit this setting, the
327 hostname will be determined using the L<gethostname(2)> system call.
329 =item B<FQDNLookup> B<true|false>
331 If B<Hostname> is determined automatically this setting controls whether or not
332 the daemon should try to figure out the "fully qualified domain name", FQDN.
333 This is done using a lookup of the name returned by C<gethostname>. This option
334 is enabled by default.
336 =item B<PreCacheChain> I<ChainName>
338 =item B<PostCacheChain> I<ChainName>
340 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
341 see L</"FILTER CONFIGURATION"> below on information on chains and how these
342 setting change the daemon's behavior.
346 =head1 PLUGIN OPTIONS
348 Some plugins may register own options. These options must be enclosed in a
349 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
350 require external configuration, too. The C<apache plugin>, for example,
351 required C<mod_status> to be configured in the webserver you're going to
352 collect data from. These plugins are listed below as well, even if they don't
353 require any configuration within collectd's configuration file.
355 A list of all plugins and a short summary for each plugin can be found in the
356 F<README> file shipped with the sourcecode and hopefully binary packets as
359 =head2 Plugin C<aggregation>
361 The I<Aggregation plugin> makes it possible to aggregate several values into
362 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
363 This can be put to a wide variety of uses, e.g. average and total CPU
364 statistics for your entire fleet.
366 The grouping is powerful but, as with many powerful tools, may be a bit
367 difficult to wrap your head around. The grouping will therefore be
368 demonstrated using an example: The average and sum of the CPU usage across
369 all CPUs of each host is to be calculated.
371 To select all the affected values for our example, set C<Plugin cpu> and
372 C<Type cpu>. The other values are left unspecified, meaning "all values". The
373 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
374 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
380 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...) and
381 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
382 example, the intention is to have a new value for each host / type instance
383 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
384 It can be specified multiple times to group by more than one field.
387 GroupBy "TypeInstance"
389 We do neither specify nor group by I<plugin instance> (the CPU number), so all
390 metrics that differ in the CPU number only will be aggregated. Each
391 aggregation needs I<at least one> such field, otherwise no aggregation would
394 The full example configuration looks like this:
396 <Plugin "aggregation">
402 GroupBy "TypeInstance"
405 CalculateAverage true
409 There are a couple of limitations you should be aware of:
415 The I<Type> cannot be left unspecified, because it is not reasonable to add
416 apples to oranges. Also, the internal lookup structure won't work if you try
421 There must be at least one unspecified, ungrouped field. Otherwise nothing
426 As you can see in the example above, each aggregation has its own
427 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
428 blocks may match the same values, i.e. one value list can update multiple
429 aggregations. The following options are valid inside B<Aggregation> blocks:
433 =item B<Host> I<Host>
435 =item B<Plugin> I<Plugin>
437 =item B<PluginInstance> I<PluginInstance>
439 =item B<Type> I<Type>
441 =item B<TypeInstance> I<TypeInstance>
443 Selects the value lists to be added to this aggregation. B<Type> must be a
444 valid data set name, see L<types.db(5)> for details.
446 If the string starts with and ends with a slash (C</>), the string is
447 interpreted as a I<regular expression>. The regex flavor used are POSIX
448 extended regular expressions as described in L<regex(7)>. Example usage:
450 Host "/^db[0-9]\\.example\\.com$/"
452 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
454 Group valued by the specified field. The B<GroupBy> option may be repeated to
455 group by multiple fields.
457 =item B<SetHost> I<Host>
459 =item B<SetPlugin> I<Plugin>
461 =item B<SetPluginInstance> I<PluginInstance>
463 =item B<SetTypeInstance> I<TypeInstance>
465 Sets the appropriate part of the identifier to the provided string.
467 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
468 will be replaced with the aggregation function, e.g. "average". Not including
469 the placeholder will result in duplication warnings and/or messed up values if
470 more than one aggregation function are enabled.
472 The following example calculates the average usage of all "even" CPUs:
474 <Plugin "aggregation">
477 PluginInstance "/[0,2,4,6,8]$/"
481 SetPluginInstance "even-%{aggregation}"
484 GroupBy "TypeInstance"
486 CalculateAverage true
490 This will create the files:
496 foo.example.com/cpu-even-average/cpu-idle
500 foo.example.com/cpu-even-average/cpu-system
504 foo.example.com/cpu-even-average/cpu-user
512 =item B<CalculateNum> B<true>|B<false>
514 =item B<CalculateSum> B<true>|B<false>
516 =item B<CalculateAverage> B<true>|B<false>
518 =item B<CalculateMinimum> B<true>|B<false>
520 =item B<CalculateMaximum> B<true>|B<false>
522 =item B<CalculateStddev> B<true>|B<false>
524 Boolean options for enabling calculation of the number of value lists, their
525 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
526 are disabled by default.
530 =head2 Plugin C<amqp>
532 The I<AMQP plugin> can be used to communicate with other instances of
533 I<collectd> or third party applications using an AMQP 0.9.1 message broker.
534 Values are sent to or received from the broker, which handles routing,
535 queueing and possibly filtering out messages.
540 # Send values to an AMQP broker
541 <Publish "some_name">
547 Exchange "amq.fanout"
548 # ExchangeType "fanout"
549 # RoutingKey "collectd"
551 # ConnectionRetryDelay 0
554 # GraphitePrefix "collectd."
555 # GraphiteEscapeChar "_"
556 # GraphiteSeparateInstances false
557 # GraphiteAlwaysAppendDS false
558 # GraphitePreserveSeparator false
561 # Receive values from an AMQP broker
562 <Subscribe "some_name">
568 Exchange "amq.fanout"
569 # ExchangeType "fanout"
572 # QueueAutoDelete true
573 # RoutingKey "collectd.#"
574 # ConnectionRetryDelay 0
578 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
579 blocks, which configure sending and receiving of values respectively. The two
580 blocks are very similar, so unless otherwise noted, an option can be used in
581 either block. The name given in the blocks starting tag is only used for
582 reporting messages, but may be used to support I<flushing> of certain
583 I<Publish> blocks in the future.
587 =item B<Host> I<Host>
589 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
590 the underlying communications library, I<rabbitmq-c>, which is "localhost".
592 =item B<Port> I<Port>
594 Service name or port number on which the AMQP broker accepts connections. This
595 argument must be a string, even if the numeric form is used. Defaults to
598 =item B<VHost> I<VHost>
600 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
602 =item B<User> I<User>
604 =item B<Password> I<Password>
606 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
609 =item B<Exchange> I<Exchange>
611 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
612 By default, "amq.fanout" will be used.
614 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
615 the given exchange and the I<queue> is created, using the I<routing key> if
616 configured. See the B<Queue> and B<RoutingKey> options below.
618 =item B<ExchangeType> I<Type>
620 If given, the plugin will try to create the configured I<exchange> with this
621 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
622 be bound to this exchange.
624 =item B<Queue> I<Queue> (Subscribe only)
626 Configures the I<queue> name to subscribe to. If no queue name was configured
627 explicitly, a unique queue name will be created by the broker.
629 =item B<QueueDurable> B<true>|B<false> (Subscribe only)
631 Defines if the I<queue> subscribed to is durable (saved to persistent storage)
632 or transient (will disappear if the AMQP broker is restarted). Defaults to
635 This option should be used in conjunction with the I<Persistent> option on the
638 =item B<QueueAutoDelete> B<true>|B<false> (Subscribe only)
640 Defines if the I<queue> subscribed to will be deleted once the last consumer
641 unsubscribes. Defaults to "true".
643 =item B<RoutingKey> I<Key>
645 In I<Publish> blocks, this configures the routing key to set on all outgoing
646 messages. If not given, the routing key will be computed from the I<identifier>
647 of the value. The host, plugin, type and the two instances are concatenated
648 together using dots as the separator and all containing dots replaced with
649 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
650 possible to receive only specific values using a "topic" exchange.
652 In I<Subscribe> blocks, configures the I<routing key> used when creating a
653 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
654 used to filter messages when using a "topic" exchange. If you're only
655 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
658 =item B<Persistent> B<true>|B<false> (Publish only)
660 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
661 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
662 default), the I<transient> delivery mode will be used, i.e. messages may be
663 lost due to high load, overflowing queues or similar issues.
665 =item B<ConnectionRetryDelay> I<Delay>
667 When the connection to the AMQP broker is lost, defines the time in seconds to
668 wait before attempting to reconnect. Defaults to 0, which implies collectd will
669 attempt to reconnect at each read interval (in Subscribe mode) or each time
670 values are ready for submission (in Publish mode).
672 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
674 Selects the format in which messages are sent to the broker. If set to
675 B<Command> (the default), values are sent as C<PUTVAL> commands which are
676 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
677 case, the C<Content-Type> header field will be set to C<text/collectd>.
679 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
680 an easy and straight forward exchange format. The C<Content-Type> header field
681 will be set to C<application/json>.
683 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
684 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
687 A subscribing client I<should> use the C<Content-Type> header field to
688 determine how to decode the values. Currently, the I<AMQP plugin> itself can
689 only decode the B<Command> format.
691 =item B<StoreRates> B<true>|B<false> (Publish only)
693 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
694 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
695 default), no conversion is performed. Otherwise the conversion is performed
696 using the internal value cache.
698 Please note that currently this option is only used if the B<Format> option has
701 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
703 A prefix can be added in the metric name when outputting in the I<Graphite> format.
704 It's added before the I<Host> name.
705 Metric name will be "<prefix><host><postfix><plugin><type><name>"
707 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
709 A postfix can be added in the metric name when outputting in the I<Graphite> format.
710 It's added after the I<Host> name.
711 Metric name will be "<prefix><host><postfix><plugin><type><name>"
713 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
715 Specify a character to replace dots (.) in the host part of the metric name.
716 In I<Graphite> metric name, dots are used as separators between different
717 metric parts (host, plugin, type).
718 Default is "_" (I<Underscore>).
720 =item B<GraphiteSeparateInstances> B<true>|B<false>
722 If set to B<true>, the plugin instance and type instance will be in their own
723 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
724 default), the plugin and plugin instance (and likewise the type and type
725 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
727 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
729 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
730 identifier. If set to B<false> (the default), this is only done when there is
733 =item B<GraphitePreserveSeparator> B<false>|B<true>
735 If set to B<false> (the default) the C<.> (dot) character is replaced with
736 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
737 is preserved, i.e. passed through.
741 =head2 Plugin C<amqp1>
743 The I<AMQP1 plugin> can be used to communicate with other instances of
744 I<collectd> or third party applications using an AMQP 1.0 message
745 intermediary. Metric values or notifications are sent to the
746 messaging intermediary which may handle direct messaging or
747 queue based transfer.
752 # Send values to an AMQP 1.0 intermediary
760 <Instance "some_name">
765 # GraphitePrefix "collectd."
766 # GraphiteEscapeChar "_"
767 # GraphiteSeparateInstances false
768 # GraphiteAlwaysAppendDS false
769 # GraphitePreserveSeparator false
774 The plugin's configuration consists of a I<Transport> that configures
775 communications to the AMQP 1.0 messaging bus and one or more I<Instance>
776 corresponding to metric or event publishers to the messaging system.
778 The address in the I<Transport> block concatenated with the name given in the
779 I<Instance> block starting tag will be used as the send-to address for
780 communications over the messaging link.
782 The following options are accepted within each I<Transport> block:
786 =item B<Host> I<Host>
788 Hostname or IP-address of the AMQP 1.0 intermediary. Defaults to the
789 default behavior of the underlying communications library,
790 I<libqpid-proton>, which is "localhost".
792 =item B<Port> I<Port>
794 Service name or port number on which the AMQP 1.0 intermediary accepts
795 connections. This argument must be a string, even if the numeric form
796 is used. Defaults to "5672".
798 =item B<User> I<User>
800 =item B<Password> I<Password>
802 Credentials used to authenticate to the AMQP 1.0 intermediary. By
803 default "guest"/"guest" is used.
805 =item B<Address> I<Address>
807 This option specifies the prefix for the send-to value in the message.
808 By default, "collectd" will be used.
810 =item B<RetryDelay> I<RetryDelay>
812 When the AMQP1 connection is lost, defines the time in seconds to wait
813 before attempting to reconnect. Defaults to 1, which implies attempt
814 to reconnect at 1 second intervals.
818 The following options are accepted within each I<Instance> block:
822 =item B<Format> B<Command>|B<JSON>|B<Graphite>
824 Selects the format in which messages are sent to the intermediary. If set to
825 B<Command> (the default), values are sent as C<PUTVAL> commands which are
826 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
827 case, the C<Content-Type> header field will be set to C<text/collectd>.
829 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
830 an easy and straight forward exchange format. The C<Content-Type> header field
831 will be set to C<application/json>.
833 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
834 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
837 A subscribing client I<should> use the C<Content-Type> header field to
838 determine how to decode the values.
840 =item B<PreSettle> B<true>|B<false>
842 If set to B<false> (the default), the plugin will wait for a message
843 acknowledgement from the messaging bus before sending the next
844 message. This indicates transfer of ownership to the messaging
845 system. If set to B<true>, the plugin will not wait for a message
846 acknowledgement and the message may be dropped prior to transfer of
849 =item B<Notify> B<true>|B<false>
851 If set to B<false> (the default), the plugin will service the
852 instance write call back as a value list. If set to B<true> the
853 plugin will service the instance as a write notification callback
854 for alert formatting.
856 =item B<StoreRates> B<true>|B<false>
858 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
859 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
860 default), no conversion is performed. Otherwise the conversion is performed
861 using the internal value cache.
863 Please note that currently this option is only used if the B<Format> option has
866 =item B<GraphitePrefix>
868 A prefix can be added in the metric name when outputting in the I<Graphite> format.
869 It's added before the I<Host> name.
870 Metric name will be "<prefix><host><postfix><plugin><type><name>"
872 =item B<GraphitePostfix>
874 A postfix can be added in the metric name when outputting in the I<Graphite> format.
875 It's added after the I<Host> name.
876 Metric name will be "<prefix><host><postfix><plugin><type><name>"
878 =item B<GraphiteEscapeChar>
880 Specify a character to replace dots (.) in the host part of the metric name.
881 In I<Graphite> metric name, dots are used as separators between different
882 metric parts (host, plugin, type).
883 Default is "_" (I<Underscore>).
885 =item B<GraphiteSeparateInstances> B<true>|B<false>
887 If set to B<true>, the plugin instance and type instance will be in their own
888 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
889 default), the plugin and plugin instance (and likewise the type and type
890 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
892 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
894 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
895 identifier. If set to B<false> (the default), this is only done when there is
898 =item B<GraphitePreserveSeparator> B<false>|B<true>
900 If set to B<false> (the default) the C<.> (dot) character is replaced with
901 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
902 is preserved, i.e. passed through.
906 =head2 Plugin C<apache>
908 To configure the C<apache>-plugin you first need to configure the Apache
909 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
910 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
911 the following snipped to base your Apache config upon:
914 <IfModule mod_status.c>
915 <Location /mod_status>
916 SetHandler server-status
920 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
921 also supported. It introduces a new field, called C<BusyServers>, to count the
922 number of currently connected clients. This field is also supported.
924 The configuration of the I<Apache> plugin consists of one or more
925 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
926 as the instance name. For example:
930 URL "http://www1.example.com/mod_status?auto"
933 URL "http://www2.example.com/mod_status?auto"
937 The instance name will be used as the I<plugin instance>. To emulate the old
938 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
939 plugin to work correctly, each instance name must be unique. This is not
940 enforced by the plugin and it is your responsibility to ensure it.
942 The following options are accepted within each I<Instance> block:
946 =item B<URL> I<http://host/mod_status?auto>
948 Sets the URL of the C<mod_status> output. This needs to be the output generated
949 by C<ExtendedStatus on> and it needs to be the machine readable output
950 generated by appending the C<?auto> argument. This option is I<mandatory>.
952 =item B<User> I<Username>
954 Optional user name needed for authentication.
956 =item B<Password> I<Password>
958 Optional password needed for authentication.
960 =item B<VerifyPeer> B<true|false>
962 Enable or disable peer SSL certificate verification. See
963 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
965 =item B<VerifyHost> B<true|false>
967 Enable or disable peer host name verification. If enabled, the plugin checks
968 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
969 certificate matches the host name provided by the B<URL> option. If this
970 identity check fails, the connection is aborted. Obviously, only works when
971 connecting to a SSL enabled server. Enabled by default.
973 =item B<CACert> I<File>
975 File that holds one or more SSL certificates. If you want to use HTTPS you will
976 possibly need this option. What CA certificates come bundled with C<libcurl>
977 and are checked by default depends on the distribution you use.
979 =item B<SSLCiphers> I<list of ciphers>
981 Specifies which ciphers to use in the connection. The list of ciphers
982 must specify valid ciphers. See
983 L<http://www.openssl.org/docs/apps/ciphers.html> for details.
985 =item B<Timeout> I<Milliseconds>
987 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
988 milliseconds. By default, the configured B<Interval> is used to set the
993 =head2 Plugin C<apcups>
997 =item B<Host> I<Hostname>
999 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
1000 that IPv6 support has been disabled unless someone can confirm or decline that
1001 B<apcupsd> can handle it.
1003 =item B<Port> I<Port>
1005 TCP-Port to connect to. Defaults to B<3551>.
1007 =item B<ReportSeconds> B<true>|B<false>
1009 If set to B<true>, the time reported in the C<timeleft> metric will be
1010 converted to seconds. This is the recommended setting. If set to B<false>, the
1011 default for backwards compatibility, the time will be reported in minutes.
1013 =item B<PersistentConnection> B<true>|B<false>
1015 The plugin is designed to keep the connection to I<apcupsd> open between reads.
1016 If plugin poll interval is greater than 15 seconds (hardcoded socket close
1017 timeout in I<apcupsd> NIS), then this option is B<false> by default.
1019 You can instruct the plugin to close the connection after each read by setting
1020 this option to B<false> or force keeping the connection by setting it to B<true>.
1022 If I<apcupsd> appears to close the connection due to inactivity quite quickly,
1023 the plugin will try to detect this problem and switch to an open-read-close mode.
1027 =head2 Plugin C<aquaero>
1029 This plugin collects the value of the available sensors in an
1030 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
1031 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
1032 connection for monitoring and configuration. The board can handle multiple
1033 temperature sensors, fans, water pumps and water level sensors and adjust the
1034 output settings such as fan voltage or power used by the water pump based on
1035 the available inputs using a configurable controller included in the board.
1036 This plugin collects all the available inputs as well as some of the output
1037 values chosen by this controller. The plugin is based on the I<libaquaero5>
1038 library provided by I<aquatools-ng>.
1042 =item B<Device> I<DevicePath>
1044 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
1045 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
1046 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
1050 =head2 Plugin C<ascent>
1052 This plugin collects information about an Ascent server, a free server for the
1053 "World of Warcraft" game. This plugin gathers the information by fetching the
1054 XML status page using C<libcurl> and parses it using C<libxml2>.
1056 The configuration options are the same as for the C<apache> plugin above:
1060 =item B<URL> I<http://localhost/ascent/status/>
1062 Sets the URL of the XML status output.
1064 =item B<User> I<Username>
1066 Optional user name needed for authentication.
1068 =item B<Password> I<Password>
1070 Optional password needed for authentication.
1072 =item B<VerifyPeer> B<true|false>
1074 Enable or disable peer SSL certificate verification. See
1075 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1077 =item B<VerifyHost> B<true|false>
1079 Enable or disable peer host name verification. If enabled, the plugin checks
1080 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
1081 certificate matches the host name provided by the B<URL> option. If this
1082 identity check fails, the connection is aborted. Obviously, only works when
1083 connecting to a SSL enabled server. Enabled by default.
1085 =item B<CACert> I<File>
1087 File that holds one or more SSL certificates. If you want to use HTTPS you will
1088 possibly need this option. What CA certificates come bundled with C<libcurl>
1089 and are checked by default depends on the distribution you use.
1091 =item B<Timeout> I<Milliseconds>
1093 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1094 milliseconds. By default, the configured B<Interval> is used to set the
1099 =head2 Plugin C<barometer>
1101 This plugin reads absolute air pressure using digital barometer sensor on a I2C
1102 bus. Supported sensors are:
1106 =item I<MPL115A2> from Freescale,
1107 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A>.
1110 =item I<MPL3115> from Freescale
1111 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>.
1114 =item I<BMP085> from Bosch Sensortec
1118 The sensor type - one of the above - is detected automatically by the plugin
1119 and indicated in the plugin_instance (you will see subdirectory
1120 "barometer-mpl115" or "barometer-mpl3115", or "barometer-bmp085"). The order of
1121 detection is BMP085 -> MPL3115 -> MPL115A2, the first one found will be used
1122 (only one sensor can be used by the plugin).
1124 The plugin provides absolute barometric pressure, air pressure reduced to sea
1125 level (several possible approximations) and as an auxiliary value also internal
1126 sensor temperature. It uses (expects/provides) typical metric units - pressure
1127 in [hPa], temperature in [C], altitude in [m].
1129 It was developed and tested under Linux only. The only platform dependency is
1130 the standard Linux i2c-dev interface (the particular bus driver has to
1131 support the SM Bus command subset).
1133 The reduction or normalization to mean sea level pressure requires (depending
1134 on selected method/approximation) also altitude and reference to temperature
1135 sensor(s). When multiple temperature sensors are configured the minimum of
1136 their values is always used (expecting that the warmer ones are affected by
1137 e.g. direct sun light at that moment).
1141 <Plugin "barometer">
1142 Device "/dev/i2c-0";
1145 TemperatureOffset 0.0
1148 TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
1153 =item B<Device> I<device>
1155 The only mandatory configuration parameter.
1157 Device name of the I2C bus to which the sensor is connected. Note that
1158 typically you need to have loaded the i2c-dev module.
1159 Using i2c-tools you can check/list i2c buses available on your system by:
1163 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
1167 This way you should be able to verify that the pressure sensor (either type) is
1168 connected and detected on address 0x60.
1170 =item B<Oversampling> I<value>
1172 Optional parameter controlling the oversampling/accuracy. Default value
1173 is 1 providing fastest and least accurate reading.
1175 For I<MPL115> this is the size of the averaging window. To filter out sensor
1176 noise a simple averaging using floating window of this configurable size is
1177 used. The plugin will use average of the last C<value> measurements (value of 1
1178 means no averaging). Minimal size is 1, maximal 1024.
1180 For I<MPL3115> this is the oversampling value. The actual oversampling is
1181 performed by the sensor and the higher value the higher accuracy and longer
1182 conversion time (although nothing to worry about in the collectd context).
1183 Supported values are: 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is
1184 adjusted by the plugin to the closest supported one.
1186 For I<BMP085> this is the oversampling value. The actual oversampling is
1187 performed by the sensor and the higher value the higher accuracy and longer
1188 conversion time (although nothing to worry about in the collectd context).
1189 Supported values are: 1, 2, 4, 8. Any other value is adjusted by the plugin to
1190 the closest supported one.
1192 =item B<PressureOffset> I<offset>
1194 Optional parameter for MPL3115 only.
1196 You can further calibrate the sensor by supplying pressure and/or temperature
1197 offsets. This is added to the measured/caclulated value (i.e. if the measured
1198 value is too high then use negative offset).
1199 In hPa, default is 0.0.
1201 =item B<TemperatureOffset> I<offset>
1203 Optional parameter for MPL3115 only.
1205 You can further calibrate the sensor by supplying pressure and/or temperature
1206 offsets. This is added to the measured/caclulated value (i.e. if the measured
1207 value is too high then use negative offset).
1208 In C, default is 0.0.
1210 =item B<Normalization> I<method>
1212 Optional parameter, default value is 0.
1214 Normalization method - what approximation/model is used to compute the mean sea
1215 level pressure from the air absolute pressure.
1217 Supported values of the C<method> (integer between from 0 to 2) are:
1221 =item B<0> - no conversion, absolute pressure is simply copied over. For this method you
1222 do not need to configure C<Altitude> or C<TemperatureSensor>.
1224 =item B<1> - international formula for conversion ,
1226 L<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
1227 For this method you have to configure C<Altitude> but do not need
1228 C<TemperatureSensor> (uses fixed global temperature average instead).
1230 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
1231 Meteorological Service).
1232 See L<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
1233 For this method you have to configure both C<Altitude> and
1234 C<TemperatureSensor>.
1239 =item B<Altitude> I<altitude>
1241 The altitude (in meters) of the location where you meassure the pressure.
1243 =item B<TemperatureSensor> I<reference>
1245 Temperature sensor(s) which should be used as a reference when normalizing the
1246 pressure using C<Normalization> method 2.
1247 When specified more sensors a minimum is found and used each time. The
1248 temperature reading directly from this pressure sensor/plugin is typically not
1249 suitable as the pressure sensor will be probably inside while we want outside
1250 temperature. The collectd reference name is something like
1251 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
1252 (<type_instance> is usually omitted when there is just single value type). Or
1253 you can figure it out from the path of the output data files.
1257 =head2 Plugin C<battery>
1259 The I<battery plugin> reports the remaining capacity, power and voltage of
1264 =item B<ValuesPercentage> B<false>|B<true>
1266 When enabled, remaining capacity is reported as a percentage, e.g. "42%
1267 capacity remaining". Otherwise the capacity is stored as reported by the
1268 battery, most likely in "Wh". This option does not work with all input methods,
1269 in particular when only C</proc/pmu> is available on an old Linux system.
1270 Defaults to B<false>.
1272 =item B<ReportDegraded> B<false>|B<true>
1274 Typical laptop batteries degrade over time, meaning the capacity decreases with
1275 recharge cycles. The maximum charge of the previous charge cycle is tracked as
1276 "last full capacity" and used to determine that a battery is "fully charged".
1278 When this option is set to B<false>, the default, the I<battery plugin> will
1279 only report the remaining capacity. If the B<ValuesPercentage> option is
1280 enabled, the relative remaining capacity is calculated as the ratio of the
1281 "remaining capacity" and the "last full capacity". This is what most tools,
1282 such as the status bar of desktop environments, also do.
1284 When set to B<true>, the battery plugin will report three values: B<charged>
1285 (remaining capacity), B<discharged> (difference between "last full capacity"
1286 and "remaining capacity") and B<degraded> (difference between "design capacity"
1287 and "last full capacity").
1289 =item B<QueryStateFS> B<false>|B<true>
1291 When set to B<true>, the battery plugin will only read statistics
1292 related to battery performance as exposed by StateFS at
1293 /run/state. StateFS is used in Mer-based Sailfish OS, for
1298 =head2 Plugin C<bind>
1300 Starting with BIND 9.5.0, the most widely used DNS server software provides
1301 extensive statistics about queries, responses and lots of other information.
1302 The bind plugin retrieves this information that's encoded in XML and provided
1303 via HTTP and submits the values to collectd.
1305 To use this plugin, you first need to tell BIND to make this information
1306 available. This is done with the C<statistics-channels> configuration option:
1308 statistics-channels {
1309 inet localhost port 8053;
1312 The configuration follows the grouping that can be seen when looking at the
1313 data with an XSLT compatible viewer, such as a modern web browser. It's
1314 probably a good idea to make yourself familiar with the provided values, so you
1315 can understand what the collected statistics actually mean.
1320 URL "http://localhost:8053/"
1335 Zone "127.in-addr.arpa/IN"
1339 The bind plugin accepts the following configuration options:
1345 URL from which to retrieve the XML data. If not specified,
1346 C<http://localhost:8053/> will be used.
1348 =item B<ParseTime> B<true>|B<false>
1350 When set to B<true>, the time provided by BIND will be parsed and used to
1351 dispatch the values. When set to B<false>, the local time source is queried.
1353 This setting is set to B<true> by default for backwards compatibility; setting
1354 this to B<false> is I<recommended> to avoid problems with timezones and
1357 =item B<OpCodes> B<true>|B<false>
1359 When enabled, statistics about the I<"OpCodes">, for example the number of
1360 C<QUERY> packets, are collected.
1364 =item B<QTypes> B<true>|B<false>
1366 When enabled, the number of I<incoming> queries by query types (for example
1367 C<A>, C<MX>, C<AAAA>) is collected.
1371 =item B<ServerStats> B<true>|B<false>
1373 Collect global server statistics, such as requests received over IPv4 and IPv6,
1374 successful queries, and failed updates.
1378 =item B<ZoneMaintStats> B<true>|B<false>
1380 Collect zone maintenance statistics, mostly information about notifications
1381 (zone updates) and zone transfers.
1385 =item B<ResolverStats> B<true>|B<false>
1387 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1388 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1389 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1390 default. Use the B<ResolverStats> option within a B<View "_default"> block
1391 instead for the same functionality.
1395 =item B<MemoryStats>
1397 Collect global memory statistics.
1401 =item B<Timeout> I<Milliseconds>
1403 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1404 milliseconds. By default, the configured B<Interval> is used to set the
1407 =item B<View> I<Name>
1409 Collect statistics about a specific I<"view">. BIND can behave different,
1410 mostly depending on the source IP-address of the request. These different
1411 configurations are called "views". If you don't use this feature, you most
1412 likely are only interested in the C<_default> view.
1414 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1415 information you want to collect about a view. If no B<View> block is
1416 configured, no detailed view statistics will be collected.
1420 =item B<QTypes> B<true>|B<false>
1422 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1423 C<MX>) is collected.
1427 =item B<ResolverStats> B<true>|B<false>
1429 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1430 (e.E<nbsp>g. queries over IPv4, lame servers).
1434 =item B<CacheRRSets> B<true>|B<false>
1436 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1437 type is collected. Negative entries (queries which resulted in an error, for
1438 example names that do not exist) are reported with a leading exclamation mark,
1443 =item B<Zone> I<Name>
1445 When given, collect detailed information about the given zone in the view. The
1446 information collected if very similar to the global B<ServerStats> information
1449 You can repeat this option to collect detailed information about multiple
1452 By default no detailed zone information is collected.
1458 =head2 Plugin C<ceph>
1460 The ceph plugin collects values from JSON data to be parsed by B<libyajl>
1461 (L<https://lloyd.github.io/yajl/>) retrieved from ceph daemon admin sockets.
1463 A separate B<Daemon> block must be configured for each ceph daemon to be
1464 monitored. The following example will read daemon statistics from four
1465 separate ceph daemons running on the same device (two OSDs, one MON, one MDS) :
1468 LongRunAvgLatency false
1469 ConvertSpecialMetricTypes true
1471 SocketPath "/var/run/ceph/ceph-osd.0.asok"
1474 SocketPath "/var/run/ceph/ceph-osd.1.asok"
1477 SocketPath "/var/run/ceph/ceph-mon.ceph1.asok"
1480 SocketPath "/var/run/ceph/ceph-mds.ceph1.asok"
1484 The ceph plugin accepts the following configuration options:
1488 =item B<LongRunAvgLatency> B<true>|B<false>
1490 If enabled, latency values(sum,count pairs) are calculated as the long run
1491 average - average since the ceph daemon was started = (sum / count).
1492 When disabled, latency values are calculated as the average since the last
1493 collection = (sum_now - sum_last) / (count_now - count_last).
1497 =item B<ConvertSpecialMetricTypes> B<true>|B<false>
1499 If enabled, special metrics (metrics that differ in type from similar counters)
1500 are converted to the type of those similar counters. This currently only
1501 applies to filestore.journal_wr_bytes which is a counter for OSD daemons. The
1502 ceph schema reports this metric type as a sum,count pair while similar counters
1503 are treated as derive types. When converted, the sum is used as the counter
1504 value and is treated as a derive type.
1505 When disabled, all metrics are treated as the types received from the ceph schema.
1511 Each B<Daemon> block must have a string argument for the plugin instance name.
1512 A B<SocketPath> is also required for each B<Daemon> block:
1516 =item B<Daemon> I<DaemonName>
1518 Name to be used as the instance name for this daemon.
1520 =item B<SocketPath> I<SocketPath>
1522 Specifies the path to the UNIX admin socket of the ceph daemon.
1526 =head2 Plugin C<cgroups>
1528 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1529 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1530 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1534 =item B<CGroup> I<Directory>
1536 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1537 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1540 See F</"IGNORELISTS"> for details.
1542 =item B<IgnoreSelected> B<true>|B<false>
1544 Invert the selection: If set to true, all cgroups I<except> the ones that
1545 match any one of the criteria are collected. By default only selected
1546 cgroups are collected if a selection is made. If no selection is configured
1547 at all, B<all> cgroups are selected.
1551 =head2 Plugin C<chrony>
1553 The C<chrony> plugin collects ntp data from a B<chronyd> server, such as clock
1554 skew and per-peer stratum.
1556 For talking to B<chronyd>, it mimics what the B<chronyc> control program does
1559 Available configuration options for the C<chrony> plugin:
1563 =item B<Host> I<Hostname>
1565 Hostname of the host running B<chronyd>. Defaults to B<localhost>.
1567 =item B<Port> I<Port>
1569 UDP-Port to connect to. Defaults to B<323>.
1571 =item B<Timeout> I<Timeout>
1573 Connection timeout in seconds. Defaults to B<2>.
1577 =head2 Plugin Connectivity
1579 connectivity - Documentation of collectd's C<connectivity plugin>
1582 LoadPlugin connectivity
1584 <Plugin connectivity>
1588 The C<connectivity plugin> queries interface status using netlink (man 7 netlink) which provides information about network interfaces via the NETLINK_ROUTE family (man 7 rtnetlink). The plugin translates the value it receives to collectd's internal format and, depending on the write plugins you have loaded, it may be written to disk or submitted to another instance.
1589 The plugin listens to interfaces enumerated within the plugin configuration (see below). If no interfaces are listed, then the default is for all interfaces to be monitored.
1591 This example shows C<connectivity plugin> monitoring all interfaces.
1592 LoadPlugin connectivity
1593 <Plugin connectivity>
1596 This example shows C<connectivity plugin> monitoring 2 interfaces, "eth0" and "eth1".
1597 LoadPlugin connectivity
1598 <Plugin connectivity>
1603 This example shows C<connectivity plugin> monitoring all interfaces except "eth1".
1604 LoadPlugin connectivity
1605 <Plugin connectivity>
1612 =item B<Interface> I<interface_name>
1614 interface(s) to monitor connect to.
1618 =head2 Plugin C<conntrack>
1620 This plugin collects IP conntrack statistics.
1626 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1627 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1631 =head2 Plugin C<cpu>
1633 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1634 as Jiffies, using the C<cpu> type. Two aggregations are available:
1640 Sum, per-state, over all CPUs installed in the system; and
1644 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1648 The two aggregations can be combined, leading to I<collectd> only emitting a
1649 single "active" metric for the entire system. As soon as one of these
1650 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1651 rather than Jiffies. In addition, you can request individual, per-state,
1652 per-CPU metrics to be reported as percentage.
1654 The following configuration options are available:
1658 =item B<ReportByState> B<true>|B<false>
1660 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1662 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1665 =item B<ReportByCpu> B<true>|B<false>
1667 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1668 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1669 global sum of CPU states is emitted.
1671 =item B<ValuesPercentage> B<false>|B<true>
1673 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1674 are set to B<true>. In this case, by default, metrics will be reported as
1675 Jiffies. By setting this option to B<true>, you can request percentage values
1676 in the un-aggregated (per-CPU, per-state) mode as well.
1678 =item B<ReportNumCpu> B<false>|B<true>
1680 When set to B<true>, reports the number of available CPUs.
1681 Defaults to B<false>.
1683 =item B<ReportGuestState> B<false>|B<true>
1685 When set to B<true>, reports the "guest" and "guest_nice" CPU states.
1686 Defaults to B<false>.
1688 =item B<SubtractGuestState> B<false>|B<true>
1690 This option is only considered when B<ReportGuestState> is set to B<true>.
1691 "guest" and "guest_nice" are included in respectively "user" and "nice".
1692 If set to B<true>, "guest" will be subtracted from "user" and "guest_nice"
1693 will be subtracted from "nice".
1694 Defaults to B<true>.
1698 =head2 Plugin C<cpufreq>
1700 This plugin is available on Linux and FreeBSD only. It doesn't have any
1701 options. On Linux it reads
1702 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1703 installed) to get the current CPU frequency. If this file does not exist make
1704 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1705 installed and an "cpu governor" (that's a kernel module) is loaded.
1707 On Linux, if the system has the I<cpufreq-stats> kernel module loaded, this
1708 plugin reports the rate of p-state (cpu frequency) transitions and the
1709 percentage of time spent in each p-state.
1711 On FreeBSD it does a sysctl dev.cpu.0.freq and submits this as instance 0.
1712 At this time FreeBSD only has one frequency setting for all cores.
1713 See the BUGS section in the FreeBSD man page for cpufreq(4) for more details.
1715 On FreeBSD the plugin checks the success of sysctl dev.cpu.0.freq and
1716 unregisters the plugin when this fails. A message will be logged to indicate
1719 =head2 Plugin C<cpusleep>
1721 This plugin doesn't have any options. It reads CLOCK_BOOTTIME and
1722 CLOCK_MONOTONIC and reports the difference between these clocks. Since
1723 BOOTTIME clock increments while device is suspended and MONOTONIC
1724 clock does not, the derivative of the difference between these clocks
1725 gives the relative amount of time the device has spent in suspend
1726 state. The recorded value is in milliseconds of sleep per seconds of
1729 =head2 Plugin C<csv>
1733 =item B<DataDir> I<Directory>
1735 Set the directory to store CSV-files under. Per default CSV-files are generated
1736 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1737 The special strings B<stdout> and B<stderr> can be used to write to the standard
1738 output and standard error channels, respectively. This, of course, only makes
1739 much sense when collectd is running in foreground- or non-daemon-mode.
1741 =item B<StoreRates> B<true|false>
1743 If set to B<true>, convert counter values to rates. If set to B<false> (the
1744 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1749 =head2 cURL Statistics
1751 All cURL-based plugins support collection of generic, request-based
1752 statistics. These are disabled by default and can be enabled selectively for
1753 each page or URL queried from the curl, curl_json, or curl_xml plugins. See
1754 the documentation of those plugins for specific information. This section
1755 describes the available metrics that can be configured for each plugin. All
1756 options are disabled by default.
1758 See L<http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html> for more details.
1762 =item B<TotalTime> B<true|false>
1764 Total time of the transfer, including name resolving, TCP connect, etc.
1766 =item B<NamelookupTime> B<true|false>
1768 Time it took from the start until name resolving was completed.
1770 =item B<ConnectTime> B<true|false>
1772 Time it took from the start until the connect to the remote host (or proxy)
1775 =item B<AppconnectTime> B<true|false>
1777 Time it took from the start until the SSL/SSH connect/handshake to the remote
1780 =item B<PretransferTime> B<true|false>
1782 Time it took from the start until just before the transfer begins.
1784 =item B<StarttransferTime> B<true|false>
1786 Time it took from the start until the first byte was received.
1788 =item B<RedirectTime> B<true|false>
1790 Time it took for all redirection steps include name lookup, connect,
1791 pre-transfer and transfer before final transaction was started.
1793 =item B<RedirectCount> B<true|false>
1795 The total number of redirections that were actually followed.
1797 =item B<SizeUpload> B<true|false>
1799 The total amount of bytes that were uploaded.
1801 =item B<SizeDownload> B<true|false>
1803 The total amount of bytes that were downloaded.
1805 =item B<SpeedDownload> B<true|false>
1807 The average download speed that curl measured for the complete download.
1809 =item B<SpeedUpload> B<true|false>
1811 The average upload speed that curl measured for the complete upload.
1813 =item B<HeaderSize> B<true|false>
1815 The total size of all the headers received.
1817 =item B<RequestSize> B<true|false>
1819 The total size of the issued requests.
1821 =item B<ContentLengthDownload> B<true|false>
1823 The content-length of the download.
1825 =item B<ContentLengthUpload> B<true|false>
1827 The specified size of the upload.
1829 =item B<NumConnects> B<true|false>
1831 The number of new connections that were created to achieve the transfer.
1835 =head2 Plugin C<curl>
1837 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1838 and the match infrastructure (the same code used by the tail plugin) to use
1839 regular expressions with the received data.
1841 The following example will read the current value of AMD stock from Google's
1842 finance page and dispatch the value to collectd.
1845 <Page "stock_quotes">
1847 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1854 CACert "/path/to/ca.crt"
1855 Header "X-Custom-Header: foobar"
1858 MeasureResponseTime false
1859 MeasureResponseCode false
1862 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1863 DSType "GaugeAverage"
1864 # Note: `stock_value' is not a standard type.
1871 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1872 a web page and one or more "matches" to be performed on the returned data. The
1873 string argument to the B<Page> block is used as plugin instance.
1875 The following options are valid within B<Page> blocks:
1879 =item B<Plugin> I<Plugin>
1881 Use I<Plugin> as the plugin name when submitting values.
1882 Defaults to C<curl>.
1886 URL of the web site to retrieve. Since a regular expression will be used to
1887 extract information from this data, non-binary data is a big plus here ;)
1889 =item B<AddressFamily> I<Type>
1891 IP version to resolve URL to. Useful in cases when hostname in URL resolves
1892 to both IPv4 and IPv6 addresses, and you are interested in using one of them
1894 Use C<ipv4> to enforce IPv4, C<ipv6> to enforce IPv6, or C<any> to keep the
1895 default behavior of resolving addresses to all IP versions your system allows.
1896 If C<libcurl> is compiled without IPv6 support, using C<ipv6> will result in
1897 a warning and fallback to C<any>.
1898 If C<Type> cannot be parsed, a warning will be printed and the whole B<Page>
1899 block will be ignored.
1901 =item B<User> I<Name>
1903 Username to use if authorization is required to read the page.
1905 =item B<Password> I<Password>
1907 Password to use if authorization is required to read the page.
1909 =item B<Digest> B<true>|B<false>
1911 Enable HTTP digest authentication.
1913 =item B<VerifyPeer> B<true>|B<false>
1915 Enable or disable peer SSL certificate verification. See
1916 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1918 =item B<VerifyHost> B<true>|B<false>
1920 Enable or disable peer host name verification. If enabled, the plugin checks if
1921 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1922 matches the host name provided by the B<URL> option. If this identity check
1923 fails, the connection is aborted. Obviously, only works when connecting to a
1924 SSL enabled server. Enabled by default.
1926 =item B<CACert> I<file>
1928 File that holds one or more SSL certificates. If you want to use HTTPS you will
1929 possibly need this option. What CA certificates come bundled with C<libcurl>
1930 and are checked by default depends on the distribution you use.
1932 =item B<Header> I<Header>
1934 A HTTP header to add to the request. Multiple headers are added if this option
1935 is specified more than once.
1937 =item B<Post> I<Body>
1939 Specifies that the HTTP operation should be a POST instead of a GET. The
1940 complete data to be posted is given as the argument. This option will usually
1941 need to be accompanied by a B<Header> option to set an appropriate
1942 C<Content-Type> for the post body (e.g. to
1943 C<application/x-www-form-urlencoded>).
1945 =item B<MeasureResponseTime> B<true>|B<false>
1947 Measure response time for the request. If this setting is enabled, B<Match>
1948 blocks (see below) are optional. Disabled by default.
1950 Beware that requests will get aborted if they take too long to complete. Adjust
1951 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1954 This option is similar to enabling the B<TotalTime> statistic but it's
1955 measured by collectd instead of cURL.
1957 =item B<MeasureResponseCode> B<true>|B<false>
1959 Measure response code for the request. If this setting is enabled, B<Match>
1960 blocks (see below) are optional. Disabled by default.
1962 =item B<E<lt>StatisticsE<gt>>
1964 One B<Statistics> block can be used to specify cURL statistics to be collected
1965 for each request to the remote web site. See the section "cURL Statistics"
1966 above for details. If this setting is enabled, B<Match> blocks (see below) are
1969 =item B<E<lt>MatchE<gt>>
1971 One or more B<Match> blocks that define how to match information in the data
1972 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1973 used by the C<tail> plugin, so please see the documentation of the C<tail>
1974 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1975 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1978 =item B<Interval> I<Interval>
1980 Sets the interval (in seconds) in which the values will be collected from this
1981 URL. By default the global B<Interval> setting will be used.
1983 =item B<Timeout> I<Milliseconds>
1985 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1986 milliseconds. By default, the configured B<Interval> is used to set the
1987 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1988 indefinitely. This legacy behaviour can be achieved by setting the value of
1991 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1992 network connection will stall one read thread. Adjust the B<ReadThreads> global
1993 setting accordingly to prevent this from blocking other plugins.
1997 =head2 Plugin C<curl_json>
1999 The B<curl_json plugin> collects values from JSON data to be parsed by
2000 B<libyajl> (L<https://lloyd.github.io/yajl/>) retrieved via
2001 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
2002 unix socket. The former can be used, for example, to collect values
2003 from CouchDB documents (which are stored JSON notation), and the
2004 latter to collect values from a uWSGI stats socket.
2006 The following example will collect several values from the built-in
2007 C<_stats> runtime statistics module of I<CouchDB>
2008 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
2011 <URL "http://localhost:5984/_stats">
2014 <Key "httpd/requests/count">
2015 Type "http_requests"
2018 <Key "httpd_request_methods/*/count">
2019 Type "http_request_methods"
2022 <Key "httpd_status_codes/*/count">
2023 Type "http_response_codes"
2028 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
2031 <Sock "/var/run/uwsgi.stats.sock">
2033 <Key "workers/*/requests">
2034 Type "http_requests"
2037 <Key "workers/*/apps/*/requests">
2038 Type "http_requests"
2043 In the B<Plugin> block, there may be one or more B<URL> blocks, each
2044 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
2045 blocks defining a unix socket to read JSON from directly. Each of
2046 these blocks may have one or more B<Key> blocks.
2048 The B<Key> string argument must be in a path format. Each component is
2049 used to match the key from a JSON map or the index of an JSON
2050 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
2051 values for all map keys or array indices will be collectd.
2053 The following options are valid within B<URL> blocks:
2057 =item B<AddressFamily> I<Type>
2059 IP version to resolve URL to. Useful in cases when hostname in URL resolves
2060 to both IPv4 and IPv6 addresses, and you are interested in using one of them
2062 Use C<ipv4> to enforce IPv4, C<ipv6> to enforce IPv6, or C<any> to keep the
2063 default behavior of resolving addresses to all IP versions your system allows.
2064 If C<libcurl> is compiled without IPv6 support, using C<ipv6> will result in
2065 a warning and fallback to C<any>.
2066 If C<Type> cannot be parsed, a warning will be printed and the whole B<URL>
2067 block will be ignored.
2069 =item B<Host> I<Name>
2071 Use I<Name> as the host name when submitting values. Defaults to the global
2074 =item B<Plugin> I<Plugin>
2076 Use I<Plugin> as the plugin name when submitting values.
2077 Defaults to C<curl_json>.
2079 =item B<Instance> I<Instance>
2081 Sets the plugin instance to I<Instance>.
2083 =item B<Interval> I<Interval>
2085 Sets the interval (in seconds) in which the values will be collected from this
2086 URL. By default the global B<Interval> setting will be used.
2088 =item B<User> I<Name>
2090 =item B<Password> I<Password>
2092 =item B<Digest> B<true>|B<false>
2094 =item B<VerifyPeer> B<true>|B<false>
2096 =item B<VerifyHost> B<true>|B<false>
2098 =item B<CACert> I<file>
2100 =item B<Header> I<Header>
2102 =item B<Post> I<Body>
2104 =item B<Timeout> I<Milliseconds>
2106 These options behave exactly equivalent to the appropriate options of the
2107 I<cURL> plugin. Please see there for a detailed description.
2109 =item B<E<lt>StatisticsE<gt>>
2111 One B<Statistics> block can be used to specify cURL statistics to be collected
2112 for each request to the remote URL. See the section "cURL Statistics" above
2117 The following options are valid within B<Key> blocks:
2121 =item B<Type> I<Type>
2123 Sets the type used to dispatch the values to the daemon. Detailed information
2124 about types and their configuration can be found in L<types.db(5)>. This
2125 option is mandatory.
2127 =item B<Instance> I<Instance>
2129 Type-instance to use. Defaults to the current map key or current string array element value.
2133 =head2 Plugin C<curl_xml>
2135 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
2136 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
2139 <URL "http://localhost/stats.xml">
2143 Instance "some_instance"
2148 CACert "/path/to/ca.crt"
2149 Header "X-Custom-Header: foobar"
2152 <XPath "table[@id=\"magic_level\"]/tr">
2154 #InstancePrefix "prefix-"
2155 InstanceFrom "td[1]"
2156 #PluginInstanceFrom "td[1]"
2157 ValuesFrom "td[2]/span[@class=\"level\"]"
2162 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
2163 URL to be fetched using libcurl. Within each B<URL> block there are
2164 options which specify the connection parameters, for example authentication
2165 information, and one or more B<XPath> blocks.
2167 Each B<XPath> block specifies how to get one type of information. The
2168 string argument must be a valid XPath expression which returns a list
2169 of "base elements". One value is dispatched for each "base element". The
2170 I<type instance> and values are looked up using further I<XPath> expressions
2171 that should be relative to the base element.
2173 Within the B<URL> block the following options are accepted:
2177 =item B<AddressFamily> I<Type>
2179 IP version to resolve URL to. Useful in cases when hostname in URL resolves
2180 to both IPv4 and IPv6 addresses, and you are interested in using one of them
2182 Use C<ipv4> to enforce IPv4, C<ipv6> to enforce IPv6, or C<any> to keep the
2183 default behavior of resolving addresses to all IP versions your system allows.
2184 If C<libcurl> is compiled without IPv6 support, using C<ipv6> will result in
2185 a warning and fallback to C<any>.
2186 If C<Type> cannot be parsed, a warning will be printed and the whole B<URL>
2187 block will be ignored.
2189 =item B<Host> I<Name>
2191 Use I<Name> as the host name when submitting values. Defaults to the global
2194 =item B<Plugin> I<Plugin>
2196 Use I<Plugin> as the plugin name when submitting values.
2197 Defaults to 'curl_xml'.
2199 =item B<Instance> I<Instance>
2201 Use I<Instance> as the plugin instance when submitting values.
2202 May be overridden by B<PluginInstanceFrom> option inside B<XPath> blocks.
2203 Defaults to an empty string (no plugin instance).
2205 =item B<Interval> I<Interval>
2207 Sets the interval (in seconds) in which the values will be collected from this
2208 URL. By default the global B<Interval> setting will be used.
2210 =item B<Namespace> I<Prefix> I<URL>
2212 If an XPath expression references namespaces, they must be specified
2213 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
2214 I<URL> is the "namespace name", an URI reference uniquely identifying the
2215 namespace. The option can be repeated to register multiple namespaces.
2219 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
2220 Namespace "m" "http://www.w3.org/1998/Math/MathML"
2222 =item B<User> I<User>
2224 =item B<Password> I<Password>
2226 =item B<Digest> B<true>|B<false>
2228 =item B<VerifyPeer> B<true>|B<false>
2230 =item B<VerifyHost> B<true>|B<false>
2232 =item B<CACert> I<CA Cert File>
2234 =item B<Header> I<Header>
2236 =item B<Post> I<Body>
2238 =item B<Timeout> I<Milliseconds>
2240 These options behave exactly equivalent to the appropriate options of the
2241 I<cURL plugin>. Please see there for a detailed description.
2243 =item B<E<lt>StatisticsE<gt>>
2245 One B<Statistics> block can be used to specify cURL statistics to be collected
2246 for each request to the remote URL. See the section "cURL Statistics" above
2249 =item E<lt>B<XPath> I<XPath-expression>E<gt>
2251 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
2252 B<XPath> block specifies how to get one type of information. The string
2253 argument must be a valid XPath expression which returns a list of "base
2254 elements". One value is dispatched for each "base element".
2256 Within the B<XPath> block the following options are accepted:
2260 =item B<Type> I<Type>
2262 Specifies the I<Type> used for submitting patches. This determines the number
2263 of values that are required / expected and whether the strings are parsed as
2264 signed or unsigned integer or as double values. See L<types.db(5)> for details.
2265 This option is required.
2267 =item B<InstancePrefix> I<InstancePrefix>
2269 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
2270 concatenated together without any separator.
2271 This option is optional.
2273 =item B<InstanceFrom> I<InstanceFrom>
2275 Specifies a XPath expression to use for determining the I<type instance>. The
2276 XPath expression must return exactly one element. The element's value is then
2277 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
2279 =item B<PluginInstanceFrom> I<PluginInstanceFrom>
2281 Specifies a XPath expression to use for determining the I<plugin instance>. The
2282 XPath expression must return exactly one element. The element's value is then
2283 used as I<plugin instance>.
2287 If the "base XPath expression" (the argument to the B<XPath> block) returns
2288 exactly one argument, then I<InstanceFrom> and I<PluginInstanceFrom> may be omitted.
2289 Otherwise, at least one of I<InstanceFrom> or I<PluginInstanceFrom> is required.
2293 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
2295 Specifies one or more XPath expression to use for reading the values. The
2296 number of XPath expressions must match the number of data sources in the
2297 I<type> specified with B<Type> (see above). Each XPath expression must return
2298 exactly one element. The element's value is then parsed as a number and used as
2299 value for the appropriate value in the value list dispatched to the daemon.
2300 This option is required.
2306 =head2 Plugin C<dbi>
2308 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
2309 connect to various databases, execute I<SQL> statements and read back the
2310 results. I<dbi> is an acronym for "database interface" in case you were
2311 wondering about the name. You can configure how each column is to be
2312 interpreted and the plugin will generate one or more data sets from each row
2313 returned according to these rules.
2315 Because the plugin is very generic, the configuration is a little more complex
2316 than those of other plugins. It usually looks something like this:
2319 <Query "out_of_stock">
2320 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
2321 # Use with MySQL 5.0.0 or later
2325 InstancePrefix "out_of_stock"
2326 InstancesFrom "category"
2330 <Database "product_information">
2334 DriverOption "host" "localhost"
2335 DriverOption "username" "collectd"
2336 DriverOption "password" "aZo6daiw"
2337 DriverOption "dbname" "prod_info"
2338 SelectDB "prod_info"
2339 Query "out_of_stock"
2343 The configuration above defines one query with one result and one database. The
2344 query is then linked to the database with the B<Query> option I<within> the
2345 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
2346 and you can also use the B<Include> statement to split up the configuration
2347 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
2348 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
2351 The following is a complete list of options:
2353 =head3 B<Query> blocks
2355 Query blocks define I<SQL> statements and how the returned data should be
2356 interpreted. They are identified by the name that is given in the opening line
2357 of the block. Thus the name needs to be unique. Other than that, the name is
2358 not used in collectd.
2360 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
2361 define which column holds which value or instance information. You can use
2362 multiple B<Result> blocks to create multiple values from one returned row. This
2363 is especially useful, when queries take a long time and sending almost the same
2364 query again and again is not desirable.
2368 <Query "environment">
2369 Statement "select station, temperature, humidity from environment"
2372 # InstancePrefix "foo"
2373 InstancesFrom "station"
2374 ValuesFrom "temperature"
2378 InstancesFrom "station"
2379 ValuesFrom "humidity"
2383 The following options are accepted:
2387 =item B<Statement> I<SQL>
2389 Sets the statement that should be executed on the server. This is B<not>
2390 interpreted by collectd, but simply passed to the database server. Therefore,
2391 the SQL dialect that's used depends on the server collectd is connected to.
2393 The query has to return at least two columns, one for the instance and one
2394 value. You cannot omit the instance, even if the statement is guaranteed to
2395 always return exactly one line. In that case, you can usually specify something
2398 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
2400 (That works with MySQL but may not be valid SQL according to the spec. If you
2401 use a more strict database server, you may have to select from a dummy table or
2404 Please note that some databases, for example B<Oracle>, will fail if you
2405 include a semicolon at the end of the statement.
2407 =item B<MinVersion> I<Version>
2409 =item B<MaxVersion> I<Value>
2411 Only use this query for the specified database version. You can use these
2412 options to provide multiple queries with the same name but with a slightly
2413 different syntax. The plugin will use only those queries, where the specified
2414 minimum and maximum versions fit the version of the database in use.
2416 The database version is determined by C<dbi_conn_get_engine_version>, see the
2417 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
2418 for details. Basically, each part of the version is assumed to be in the range
2419 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
2420 "40102", version "5.0.42" becomes "50042".
2422 B<Warning:> The plugin will use B<all> matching queries, so if you specify
2423 multiple queries with the same name and B<overlapping> ranges, weird stuff will
2424 happen. Don't to it! A valid example would be something along these lines:
2435 In the above example, there are three ranges that don't overlap. The last one
2436 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
2437 before "4.0.0" are not specified.
2439 =item B<Type> I<Type>
2441 The B<type> that's used for each line returned. See L<types.db(5)> for more
2442 details on how types are defined. In short: A type is a predefined layout of
2443 data and the number of values and type of values has to match the type
2446 If you specify "temperature" here, you need exactly one gauge column. If you
2447 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
2450 There must be exactly one B<Type> option inside each B<Result> block.
2452 =item B<InstancePrefix> I<prefix>
2454 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
2455 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
2456 all strings returned in the appropriate columns are concatenated together,
2457 separated by dashes I<("-")>.
2459 =item B<InstancesFrom> I<column0> [I<column1> ...]
2461 Specifies the columns whose values will be used to create the "type-instance"
2462 for each row. If you specify more than one column, the value of all columns
2463 will be joined together with dashes I<("-")> as separation characters.
2465 The plugin itself does not check whether or not all built instances are
2466 different. It's your responsibility to assure that each is unique. This is
2467 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
2468 sure that only one row is returned in this case.
2470 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
2473 =item B<ValuesFrom> I<column0> [I<column1> ...]
2475 Names the columns whose content is used as the actual data for the data sets
2476 that are dispatched to the daemon. How many such columns you need is determined
2477 by the B<Type> setting above. If you specify too many or not enough columns,
2478 the plugin will complain about that and no data will be submitted to the
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).
2486 There must be at least one B<ValuesFrom> option inside each B<Result> block.
2488 =item B<MetadataFrom> [I<column0> I<column1> ...]
2490 Names the columns whose content is used as metadata for the data sets
2491 that are dispatched to the daemon.
2493 The actual data type in the columns is not that important. The plugin will
2494 automatically cast the values to the right type if it know how to do that. So
2495 it should be able to handle integer an floating point types, as well as strings
2496 (if they include a number at the beginning).
2500 =head3 B<Database> blocks
2502 Database blocks define a connection to a database and which queries should be
2503 sent to that database. Since the used "dbi" library can handle a wide variety
2504 of databases, the configuration is very generic. If in doubt, refer to libdbi's
2505 documentationE<nbsp>- we stick as close to the terminology used there.
2507 Each database needs a "name" as string argument in the starting tag of the
2508 block. This name will be used as "PluginInstance" in the values submitted to
2509 the daemon. Other than that, that name is not used.
2513 =item B<Plugin> I<Plugin>
2515 Use I<Plugin> as the plugin name when submitting query results from
2516 this B<Database>. Defaults to C<dbi>.
2518 =item B<Interval> I<Interval>
2520 Sets the interval (in seconds) in which the values will be collected from this
2521 database. By default the global B<Interval> setting will be used.
2523 =item B<Driver> I<Driver>
2525 Specifies the driver to use to connect to the database. In many cases those
2526 drivers are named after the database they can connect to, but this is not a
2527 technical necessity. These drivers are sometimes referred to as "DBD",
2528 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2529 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2530 project at L<http://libdbi-drivers.sourceforge.net/>.
2532 You need to give the driver name as expected by the "dbi" library here. You
2533 should be able to find that in the documentation for each driver. If you
2534 mistype the driver name, the plugin will dump a list of all known driver names
2537 =item B<DriverOption> I<Key> I<Value>
2539 Sets driver-specific options. What option a driver supports can be found in the
2540 documentation for each driver, somewhere at
2541 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2542 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2544 DBDs can register two types of options: String options and numeric options. The
2545 plugin will use the C<dbi_conn_set_option> function when the configuration
2546 provides a string and the C<dbi_conn_require_option_numeric> function when the
2547 configuration provides a number. So these two lines will actually result in
2548 different calls being used:
2550 DriverOption "Port" 1234 # numeric
2551 DriverOption "Port" "1234" # string
2553 Unfortunately, drivers are not too keen to report errors when an unknown option
2554 is passed to them, so invalid settings here may go unnoticed. This is not the
2555 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2556 the driver. If a driver complains about an option, the plugin will dump a
2557 complete list of all options understood by that driver to the log. There is no
2558 way to programmatically find out if an option expects a string or a numeric
2559 argument, so you will have to refer to the appropriate DBD's documentation to
2560 find this out. Sorry.
2562 =item B<SelectDB> I<Database>
2564 In some cases, the database name you connect with is not the database name you
2565 want to use for querying data. If this option is set, the plugin will "select"
2566 (switch to) that database after the connection is established.
2568 =item B<Query> I<QueryName>
2570 Associates the query named I<QueryName> with this database connection. The
2571 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2572 blocks you want to refer to must be placed above the database block you want to
2575 =item B<Host> I<Hostname>
2577 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2578 values. Defaults to the global hostname setting.
2586 =item B<Device> I<Device>
2588 Select partitions based on the devicename.
2590 See F</"IGNORELISTS"> for details.
2592 =item B<MountPoint> I<Directory>
2594 Select partitions based on the mountpoint.
2596 See F</"IGNORELISTS"> for details.
2598 =item B<FSType> I<FSType>
2600 Select partitions based on the filesystem type.
2602 See F</"IGNORELISTS"> for details.
2604 =item B<IgnoreSelected> B<true>|B<false>
2606 Invert the selection: If set to true, all partitions B<except> the ones that
2607 match any one of the criteria are collected. By default only selected
2608 partitions are collected if a selection is made. If no selection is configured
2609 at all, B<all> partitions are selected.
2611 =item B<ReportByDevice> B<true>|B<false>
2613 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2614 (the default), it will report a disk as "root", but with it I<true>, it will be
2615 "sda1" (or whichever).
2617 =item B<ReportInodes> B<true>|B<false>
2619 Enables or disables reporting of free, reserved and used inodes. Defaults to
2620 inode collection being disabled.
2622 Enable this option if inodes are a scarce resource for you, usually because
2623 many small files are stored on the disk. This is a usual scenario for mail
2624 transfer agents and web caches.
2626 =item B<ValuesAbsolute> B<true>|B<false>
2628 Enables or disables reporting of free and used disk space in 1K-blocks.
2629 Defaults to B<true>.
2631 =item B<ValuesPercentage> B<false>|B<true>
2633 Enables or disables reporting of free and used disk space in percentage.
2634 Defaults to B<false>.
2636 This is useful for deploying I<collectd> on the cloud, where machines with
2637 different disk size may exist. Then it is more practical to configure
2638 thresholds based on relative disk size.
2642 =head2 Plugin C<disk>
2644 The C<disk> plugin collects information about the usage of physical disks and
2645 logical disks (partitions). Values collected are the number of octets written
2646 to and read from a disk or partition, the number of read/write operations
2647 issued to the disk and a rather complex "time" it took for these commands to be
2650 Using the following two options you can ignore some disks or configure the
2651 collection only of specific disks.
2655 =item B<Disk> I<Name>
2657 Select the disk I<Name>. Whether it is collected or ignored depends on the
2658 B<IgnoreSelected> setting, see below. As with other plugins that use the
2659 daemon's ignorelist functionality, a string that starts and ends with a slash
2660 is interpreted as a regular expression. Examples:
2665 See F</"IGNORELISTS"> for details.
2667 =item B<IgnoreSelected> B<true>|B<false>
2669 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2670 statements, are ignored or if all other disks are ignored. The behavior
2671 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2672 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2673 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2674 is set to B<true>, all disks are collected B<except> the ones matched.
2676 =item B<UseBSDName> B<true>|B<false>
2678 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2679 default major/minor numbers. Requires collectd to be built with Apple's
2682 =item B<UdevNameAttr> I<Attribute>
2684 Attempt to override disk instance name with the value of a specified udev
2685 attribute when built with B<libudev>. If the attribute is not defined for the
2686 given device, the default name is used. Example:
2688 UdevNameAttr "DM_NAME"
2692 =head2 Plugin C<dns>
2696 =item B<Interface> I<Interface>
2698 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2699 option sets the interface that should be used. If this option is not set, or
2700 set to "any", the plugin will try to get packets from B<all> interfaces. This
2701 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2703 =item B<IgnoreSource> I<IP-address>
2705 Ignore packets that originate from this address.
2707 =item B<SelectNumericQueryTypes> B<true>|B<false>
2709 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2713 =head2 Plugin C<dpdkevents>
2715 The I<dpdkevents plugin> collects events from DPDK such as link status of
2716 network ports and Keep Alive status of DPDK logical cores.
2717 In order to get Keep Alive events following requirements must be met:
2719 - support for Keep Alive implemented in DPDK application. More details can
2720 be found here: http://dpdk.org/doc/guides/sample_app_ug/keep_alive.html
2724 <Plugin "dpdkevents">
2730 <Event "link_status">
2731 SendEventsOnUpdate true
2732 EnabledPortMask 0xffff
2733 PortName "interface1"
2734 PortName "interface2"
2735 SendNotification false
2737 <Event "keep_alive">
2738 SendEventsOnUpdate true
2740 KeepAliveShmName "/dpdk_keepalive_shm_name"
2741 SendNotification false
2748 =head3 The EAL block
2752 =item B<Coremask> I<Mask>
2754 =item B<Memorychannels> I<Channels>
2756 Number of memory channels per processor socket.
2758 =item B<FilePrefix> I<File>
2760 The prefix text used for hugepage filenames. The filename will be set to
2761 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2765 =head3 The Event block
2767 The B<Event> block defines configuration for specific event. It accepts a
2768 single argument which specifies the name of the event.
2770 =head4 Link Status event
2774 =item B<SendEventOnUpdate> I<true|false>
2776 If set to true link status value will be dispatched only when it is
2777 different from previously read value. This is an optional argument - default
2780 =item B<EnabledPortMask> I<Mask>
2782 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2783 of 0x0 means that all ports will be disabled. A bitmask of all F's means
2784 that all ports will be enabled. This is an optional argument - by default
2785 all ports are enabled.
2787 =item B<PortName> I<Name>
2789 A string containing an optional name for the enabled DPDK ports. Each PortName
2790 option should contain only one port name; specify as many PortName options as
2791 desired. Default naming convention will be used if PortName is blank. If there
2792 are less PortName options than there are enabled ports, the default naming
2793 convention will be used for the additional ports.
2795 =item B<SendNotification> I<true|false>
2797 If set to true, link status notifications are sent, instead of link status
2798 being collected as a statistic. This is an optional argument - default
2803 =head4 Keep Alive event
2807 =item B<SendEventOnUpdate> I<true|false>
2809 If set to true keep alive value will be dispatched only when it is
2810 different from previously read value. This is an optional argument - default
2813 =item B<LCoreMask> I<Mask>
2815 An hexadecimal bit mask of the logical cores to monitor keep alive state.
2817 =item B<KeepAliveShmName> I<Name>
2819 Shared memory name identifier that is used by secondary process to monitor
2820 the keep alive cores state.
2822 =item B<SendNotification> I<true|false>
2824 If set to true, keep alive notifications are sent, instead of keep alive
2825 information being collected as a statistic. This is an optional
2826 argument - default value is false.
2830 =head2 Plugin C<dpdkstat>
2832 The I<dpdkstat plugin> collects information about DPDK interfaces using the
2833 extended NIC stats API in DPDK.
2844 RteDriverLibPath "/usr/lib/dpdk-pmd"
2846 SharedMemObj "dpdk_collectd_stats_0"
2847 EnabledPortMask 0xffff
2848 PortName "interface1"
2849 PortName "interface2"
2854 =head3 The EAL block
2858 =item B<Coremask> I<Mask>
2860 A string containing an hexadecimal bit mask of the cores to run on. Note that
2861 core numbering can change between platforms and should be determined beforehand.
2863 =item B<Memorychannels> I<Channels>
2865 A string containing a number of memory channels per processor socket.
2867 =item B<FilePrefix> I<File>
2869 The prefix text used for hugepage filenames. The filename will be set to
2870 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2872 =item B<SocketMemory> I<MB>
2874 A string containing amount of Memory to allocate from hugepages on specific
2875 sockets in MB. This is an optional value.
2877 =item B<LogLevel> I<LogLevel_number>
2879 A string containing log level number. This parameter is optional.
2880 If parameter is not present then default value "7" - (INFO) is used.
2881 Value "8" - (DEBUG) can be set to enable debug traces.
2883 =item B<RteDriverLibPath> I<Path>
2885 A string containing path to shared pmd driver lib or path to directory,
2886 where shared pmd driver libs are available. This parameter is optional.
2887 This parameter enable loading of shared pmd driver libs from defined path.
2888 E.g.: "/usr/lib/dpdk-pmd/librte_pmd_i40e.so"
2889 or "/usr/lib/dpdk-pmd"
2895 =item B<SharedMemObj> I<Mask>
2897 A string containing the name of the shared memory object that should be used to
2898 share stats from the DPDK secondary process to the collectd dpdkstat plugin.
2899 Defaults to dpdk_collectd_stats if no other value is configured.
2901 =item B<EnabledPortMask> I<Mask>
2903 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2904 of 0x0 means that all ports will be disabled. A bitmask of all Fs means
2905 that all ports will be enabled. This is an optional argument - default
2906 is all ports enabled.
2908 =item B<PortName> I<Name>
2910 A string containing an optional name for the enabled DPDK ports. Each PortName
2911 option should contain only one port name; specify as many PortName options as
2912 desired. Default naming convention will be used if PortName is blank. If there
2913 are less PortName options than there are enabled ports, the default naming
2914 convention will be used for the additional ports.
2918 =head2 Plugin C<email>
2922 =item B<SocketFile> I<Path>
2924 Sets the socket-file which is to be created.
2926 =item B<SocketGroup> I<Group>
2928 If running as root change the group of the UNIX-socket after it has been
2929 created. Defaults to B<collectd>.
2931 =item B<SocketPerms> I<Permissions>
2933 Change the file permissions of the UNIX-socket after it has been created. The
2934 permissions must be given as a numeric, octal value as you would pass to
2935 L<chmod(1)>. Defaults to B<0770>.
2937 =item B<MaxConns> I<Number>
2939 Sets the maximum number of connections that can be handled in parallel. Since
2940 this many threads will be started immediately setting this to a very high
2941 value will waste valuable resources. Defaults to B<5> and will be forced to be
2942 at most B<16384> to prevent typos and dumb mistakes.
2946 =head2 Plugin C<ethstat>
2948 The I<ethstat plugin> collects information about network interface cards (NICs)
2949 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2955 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2956 Map "multicast" "if_multicast"
2963 =item B<Interface> I<Name>
2965 Collect statistical information about interface I<Name>.
2967 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2969 By default, the plugin will submit values as type C<derive> and I<type
2970 instance> set to I<Name>, the name of the metric as reported by the driver. If
2971 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2972 I<TypeInstance> will be used.
2974 =item B<MappedOnly> B<true>|B<false>
2976 When set to B<true>, only metrics that can be mapped to a I<type> will be
2977 collected, all other metrics will be ignored. Defaults to B<false>.
2981 =head2 Plugin C<exec>
2983 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2984 contains valuable information on when the executable is executed and the
2985 output that is expected from it.
2989 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2991 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2993 Execute the executable I<Executable> as user I<User>. If the user name is
2994 followed by a colon and a group name, the effective group is set to that group.
2995 The real group and saved-set group will be set to the default group of that
2996 user. If no group is given the effective group ID will be the same as the real
2999 Please note that in order to change the user and/or group the daemon needs
3000 superuser privileges. If the daemon is run as an unprivileged user you must
3001 specify the same user/group here. If the daemon is run with superuser
3002 privileges, you must supply a non-root user here.
3004 The executable may be followed by optional arguments that are passed to the
3005 program. Please note that due to the configuration parsing numbers and boolean
3006 values may be changed. If you want to be absolutely sure that something is
3007 passed as-is please enclose it in quotes.
3009 The B<Exec> and B<NotificationExec> statements change the semantics of the
3010 programs executed, i.E<nbsp>e. the data passed to them and the response
3011 expected from them. This is documented in great detail in L<collectd-exec(5)>.
3015 =head2 Plugin C<fhcount>
3017 The C<fhcount> plugin provides statistics about used, unused and total number of
3018 file handles on Linux.
3020 The I<fhcount plugin> provides the following configuration options:
3024 =item B<ValuesAbsolute> B<true>|B<false>
3026 Enables or disables reporting of file handles usage in absolute numbers,
3027 e.g. file handles used. Defaults to B<true>.
3029 =item B<ValuesPercentage> B<false>|B<true>
3031 Enables or disables reporting of file handles usage in percentages, e.g.
3032 percent of file handles used. Defaults to B<false>.
3036 =head2 Plugin C<filecount>
3038 The C<filecount> plugin counts the number of files in a certain directory (and
3039 its subdirectories) and their combined size. The configuration is very straight
3042 <Plugin "filecount">
3043 <Directory "/var/qmail/queue/mess">
3044 Instance "qmail-message"
3046 <Directory "/var/qmail/queue/todo">
3047 Instance "qmail-todo"
3049 <Directory "/var/lib/php5">
3050 Instance "php5-sessions"
3055 The example above counts the number of files in QMail's queue directories and
3056 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
3057 QMail has not yet looked at, the "message" queue holds the messages that were
3058 classified into "local" and "remote".
3060 As you can see, the configuration consists of one or more C<Directory> blocks,
3061 each of which specifies a directory in which to count the files. Within those
3062 blocks, the following options are recognized:
3066 =item B<Plugin> I<Plugin>
3068 Use I<Plugin> as the plugin name when submitting values.
3069 Defaults to B<filecount>.
3071 =item B<Instance> I<Instance>
3073 Sets the plugin instance to I<Instance>. If not given, the instance is set to
3074 the directory name with all slashes replaced by underscores and all leading
3075 underscores removed. Empty value is allowed.
3077 =item B<Name> I<Pattern>
3079 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
3080 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
3081 against the pattern, not the entire path. In case this makes it easier for you:
3082 This option has been named after the B<-name> parameter to L<find(1)>.
3084 =item B<MTime> I<Age>
3086 Count only files of a specific age: If I<Age> is greater than zero, only files
3087 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
3088 a negative number, this is inversed. For example, if B<-60> is specified, only
3089 files that have been modified in the last minute will be counted.
3091 The number can also be followed by a "multiplier" to easily specify a larger
3092 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
3093 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
3094 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
3095 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
3096 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
3099 =item B<Size> I<Size>
3101 Count only files of a specific size. When I<Size> is a positive number, only
3102 files that are at least this big are counted. If I<Size> is a negative number,
3103 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
3104 I<Size> are counted.
3106 As with the B<MTime> option, a "multiplier" may be added. For a detailed
3107 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
3108 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
3109 note that there are 1000 bytes in a kilobyte, not 1024.
3111 =item B<Recursive> I<true>|I<false>
3113 Controls whether or not to recurse into subdirectories. Enabled by default.
3115 =item B<IncludeHidden> I<true>|I<false>
3117 Controls whether or not to include "hidden" files and directories in the count.
3118 "Hidden" files and directories are those, whose name begins with a dot.
3119 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
3121 =item B<RegularOnly> I<true>|I<false>
3123 Controls whether or not to include only regular files in the count.
3124 Defaults to I<true>, i.e. by default non regular files are ignored.
3126 =item B<FilesSizeType> I<Type>
3128 Sets the type used to dispatch files combined size. Empty value ("") disables
3129 reporting. Defaults to B<bytes>.
3131 =item B<FilesCountType> I<Type>
3133 Sets the type used to dispatch number of files. Empty value ("") disables
3134 reporting. Defaults to B<files>.
3136 =item B<TypeInstance> I<Instance>
3138 Sets the I<type instance> used to dispatch values. Defaults to an empty string
3139 (no plugin instance).
3143 =head2 Plugin C<GenericJMX>
3145 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
3146 L<collectd-java(5)>.
3148 =head2 Plugin C<gmond>
3150 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
3151 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
3152 are built-in, custom mappings may be added via B<Metric> blocks, see below.
3157 MCReceiveFrom "239.2.11.71" "8649"
3158 <Metric "swap_total">
3160 TypeInstance "total"
3163 <Metric "swap_free">
3170 The following metrics are built-in:
3176 load_one, load_five, load_fifteen
3180 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
3184 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
3196 Available configuration options:
3200 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
3202 Sets sets the multicast group and UDP port to which to subscribe.
3204 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
3206 =item E<lt>B<Metric> I<Name>E<gt>
3208 These blocks add a new metric conversion to the internal table. I<Name>, the
3209 string argument to the B<Metric> block, is the metric name as used by Ganglia.
3213 =item B<Type> I<Type>
3215 Type to map this metric to. Required.
3217 =item B<TypeInstance> I<Instance>
3219 Type-instance to use. Optional.
3221 =item B<DataSource> I<Name>
3223 Data source to map this metric to. If the configured type has exactly one data
3224 source, this is optional. Otherwise the option is required.
3230 =head2 Plugin C<gps>
3232 The C<gps plugin> connects to gpsd on the host machine.
3233 The host, port, timeout and pause are configurable.
3235 This is useful if you run an NTP server using a GPS for source and you want to
3238 Mind your GPS must send $--GSA for having the data reported!
3240 The following elements are collected:
3246 Number of satellites used for fix (type instance "used") and in view (type
3247 instance "visible"). 0 means no GPS satellites are visible.
3249 =item B<dilution_of_precision>
3251 Vertical and horizontal dilution (type instance "horizontal" or "vertical").
3252 It should be between 0 and 3.
3253 Look at the documentation of your GPS to know more.
3261 # Connect to localhost on gpsd regular port:
3266 # PauseConnect of 5 sec. between connection attempts.
3270 Available configuration options:
3274 =item B<Host> I<Host>
3276 The host on which gpsd daemon runs. Defaults to B<localhost>.
3278 =item B<Port> I<Port>
3280 Port to connect to gpsd on the host machine. Defaults to B<2947>.
3282 =item B<Timeout> I<Seconds>
3284 Timeout in seconds (default 0.015 sec).
3286 The GPS data stream is fetch by the plugin form the daemon.
3287 It waits for data to be available, if none arrives it times out
3288 and loop for another reading.
3289 Mind to put a low value gpsd expects value in the micro-seconds area
3290 (recommended is 500 us) since the waiting function is blocking.
3291 Value must be between 500 us and 5 sec., if outside that range the
3292 default value is applied.
3294 This only applies from gpsd release-2.95.
3296 =item B<PauseConnect> I<Seconds>
3298 Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).
3302 =head2 Plugin C<gpu_nvidia>
3304 Efficiently collects various statistics from the system's NVIDIA GPUs using the
3305 NVML library. Currently collected are fan speed, core temperature, percent
3306 load, percent memory used, compute and memory frequencies, and power
3313 If one or more of these options is specified, only GPUs at that index (as
3314 determined by nvidia-utils through I<nvidia-smi>) have statistics collected.
3315 If no instance of this option is specified, all GPUs are monitored.
3317 =item B<IgnoreSelected>
3319 If set to true, all detected GPUs B<except> the ones at indices specified by
3320 B<GPUIndex> entries are collected. For greater clarity, setting IgnoreSelected
3321 without any GPUIndex directives will result in B<no> statistics being
3326 =head2 Plugin C<grpc>
3328 The I<grpc> plugin provides an RPC interface to submit values to or query
3329 values from collectd based on the open source gRPC framework. It exposes an
3330 end-point for dispatching values to the daemon.
3332 The B<gRPC> homepage can be found at L<https://grpc.io/>.
3336 =item B<Server> I<Host> I<Port>
3338 The B<Server> statement sets the address of a server to which to send metrics
3339 via the C<DispatchValues> function.
3341 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3343 Optionally, B<Server> may be specified as a configuration block which supports
3344 the following options:
3348 =item B<EnableSSL> B<false>|B<true>
3350 Whether to require SSL for outgoing connections. Default: false.
3352 =item B<SSLCACertificateFile> I<Filename>
3354 =item B<SSLCertificateFile> I<Filename>
3356 =item B<SSLCertificateKeyFile> I<Filename>
3358 Filenames specifying SSL certificate and key material to be used with SSL
3363 =item B<Listen> I<Host> I<Port>
3365 The B<Listen> statement sets the network address to bind to. When multiple
3366 statements are specified, the daemon will bind to all of them. If none are
3367 specified, it defaults to B<0.0.0.0:50051>.
3369 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3371 Optionally, B<Listen> may be specified as a configuration block which
3372 supports the following options:
3376 =item B<EnableSSL> I<true>|I<false>
3378 Whether to enable SSL for incoming connections. Default: false.
3380 =item B<SSLCACertificateFile> I<Filename>
3382 =item B<SSLCertificateFile> I<Filename>
3384 =item B<SSLCertificateKeyFile> I<Filename>
3386 Filenames specifying SSL certificate and key material to be used with SSL
3389 =item B<VerifyPeer> B<true>|B<false>
3391 When enabled, a valid client certificate is required to connect to the server.
3392 When disabled, a client certifiacte is not requested and any unsolicited client
3393 certificate is accepted.
3400 =head2 Plugin C<hddtemp>
3402 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
3403 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
3404 default values, see below. C<hddtemp> has to be running to work correctly. If
3405 C<hddtemp> is not running timeouts may appear which may interfere with other
3408 The B<hddtemp> homepage can be found at
3409 L<http://www.guzu.net/linux/hddtemp.php>.
3413 =item B<Host> I<Hostname>
3415 Hostname to connect to. Defaults to B<127.0.0.1>.
3417 =item B<Port> I<Port>
3419 TCP-Port to connect to. Defaults to B<7634>.
3423 =head2 Plugin C<hugepages>
3425 To collect B<hugepages> information, collectd reads directories
3426 "/sys/devices/system/node/*/hugepages" and
3427 "/sys/kernel/mm/hugepages".
3428 Reading of these directories can be disabled by the following
3429 options (default is enabled).
3433 =item B<ReportPerNodeHP> B<true>|B<false>
3435 If enabled, information will be collected from the hugepage
3436 counters in "/sys/devices/system/node/*/hugepages".
3437 This is used to check the per-node hugepage statistics on
3440 =item B<ReportRootHP> B<true>|B<false>
3442 If enabled, information will be collected from the hugepage
3443 counters in "/sys/kernel/mm/hugepages".
3444 This can be used on both NUMA and non-NUMA systems to check
3445 the overall hugepage statistics.
3447 =item B<ValuesPages> B<true>|B<false>
3449 Whether to report hugepages metrics in number of pages.
3450 Defaults to B<true>.
3452 =item B<ValuesBytes> B<false>|B<true>
3454 Whether to report hugepages metrics in bytes.
3455 Defaults to B<false>.
3457 =item B<ValuesPercentage> B<false>|B<true>
3459 Whether to report hugepages metrics as percentage.
3460 Defaults to B<false>.
3464 =head2 Plugin C<intel_pmu>
3466 The I<intel_pmu> plugin collects performance counters data on Intel CPUs using
3467 Linux perf interface. All events are reported on a per core basis.
3472 ReportHardwareCacheEvents true
3473 ReportKernelPMUEvents true
3474 ReportSoftwareEvents true
3475 EventList "/var/cache/pmu/GenuineIntel-6-2D-core.json"
3476 HardwareEvents "L2_RQSTS.CODE_RD_HIT,L2_RQSTS.CODE_RD_MISS" "L2_RQSTS.ALL_CODE_RD"
3477 Cores "0-3" "4,6" "[12-15]"
3484 =item B<ReportHardwareCacheEvents> B<false>|B<true>
3486 Enable or disable measuring of hardware CPU cache events:
3488 - L1-dcache-load-misses
3490 - L1-dcache-store-misses
3491 - L1-dcache-prefetches
3492 - L1-dcache-prefetch-misses
3494 - L1-icache-load-misses
3495 - L1-icache-prefetches
3496 - L1-icache-prefetch-misses
3502 - LLC-prefetch-misses
3508 - dTLB-prefetch-misses
3512 - branch-load-misses
3514 =item B<ReportKernelPMUEvents> B<false>|B<true>
3516 Enable or disable measuring of the following events:
3525 =item B<ReportSoftwareEvents> B<false>|B<true>
3527 Enable or disable measuring of software events provided by kernel:
3538 =item B<EventList> I<filename>
3540 JSON performance counter event list file name. To be able to monitor all Intel
3541 CPU specific events JSON event list file should be downloaded. Use the pmu-tools
3542 event_download.py script to download event list for current CPU.
3544 =item B<HardwareEvents> I<events>
3546 This field is a list of event names or groups of comma separated event names.
3547 This option requires B<EventList> option to be configured.
3549 =item B<Cores> I<cores groups>
3551 All events are reported on a per core basis. Monitoring of the events can be
3552 configured for a group of cores (aggregated statistics). This field defines
3553 groups of cores on which to monitor supported events. The field is represented
3554 as list of strings with core group values. Each string represents a list of
3555 cores in a group. If a group is enclosed in square brackets each core is added
3556 individually to a separate group (that is statistics are not aggregated).
3557 Allowed formats are:
3563 If an empty string is provided as value for this field default cores
3564 configuration is applied - that is separate group is created for each core.
3568 =head2 Plugin C<intel_rdt>
3570 The I<intel_rdt> plugin collects information provided by monitoring features of
3571 Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
3572 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features provide
3573 information about utilization of shared resources. CMT monitors last level cache
3574 occupancy (LLC). MBM supports two types of events reporting local and remote
3575 memory bandwidth. Local memory bandwidth (MBL) reports the bandwidth of
3576 accessing memory associated with the local socket. Remote memory bandwidth (MBR)
3577 reports the bandwidth of accessing the remote socket. Also this technology
3578 allows to monitor instructions per clock (IPC).
3579 Monitor events are hardware dependant. Monitoring capabilities are detected on
3580 plugin initialization and only supported events are monitored.
3582 B<Note:> I<intel_rdt> plugin is using model-specific registers (MSRs), which
3583 require an additional capability to be enabled if collectd is run as a service.
3584 Please refer to I<contrib/systemd.collectd.service> file for more details.
3588 <Plugin "intel_rdt">
3589 Cores "0-2" "3,4,6" "8-10,15"
3590 Processes "sshd,qemu-system-x86" "bash"
3597 =item B<Interval> I<seconds>
3599 The interval within which to retrieve statistics on monitored events in seconds.
3600 For milliseconds divide the time by 1000 for example if the desired interval
3601 is 50ms, set interval to 0.05. Due to limited capacity of counters it is not
3602 recommended to set interval higher than 1 sec.
3604 =item B<Cores> I<cores groups>
3606 Monitoring of the events can be configured for group of cores
3607 (aggregated statistics). This field defines groups of cores on which to monitor
3608 supported events. The field is represented as list of strings with core group
3609 values. Each string represents a list of cores in a group. Allowed formats are:
3614 If an empty string is provided as value for this field default cores
3615 configuration is applied - a separate group is created for each core.
3617 =item B<Processes> I<process names groups>
3619 Monitoring of the events can be configured for group of processes
3620 (aggregated statistics). This field defines groups of processes on which to
3621 monitor supported events. The field is represented as list of strings with
3622 process names group values. Each string represents a list of processes in a
3623 group. Allowed format is:
3628 B<Note:> By default global interval is used to retrieve statistics on monitored
3629 events. To configure a plugin specific interval use B<Interval> option of the
3630 intel_rdt <LoadPlugin> block. For milliseconds divide the time by 1000 for
3631 example if the desired interval is 50ms, set interval to 0.05.
3632 Due to limited capacity of counters it is not recommended to set interval higher
3635 =head2 Plugin C<interface>
3639 =item B<Interface> I<Interface>
3641 Select this interface. By default these interfaces will then be collected. For
3642 a more detailed description see B<IgnoreSelected> below.
3644 See F</"IGNORELISTS"> for details.
3646 =item B<IgnoreSelected> I<true>|I<false>
3648 If no configuration is given, the B<interface>-plugin will collect data from
3649 all interfaces. This may not be practical, especially for loopback- and
3650 similar interfaces. Thus, you can use the B<Interface>-option to pick the
3651 interfaces you're interested in. Sometimes, however, it's easier/preferred
3652 to collect all interfaces I<except> a few ones. This option enables you to
3653 do that: By setting B<IgnoreSelected> to I<true> the effect of
3654 B<Interface> is inverted: All selected interfaces are ignored and all
3655 other interfaces are collected.
3657 It is possible to use regular expressions to match interface names, if the
3658 name is surrounded by I</.../> and collectd was compiled with support for
3659 regexps. This is useful if there's a need to collect (or ignore) data
3660 for a group of interfaces that are similarly named, without the need to
3661 explicitly list all of them (especially useful if the list is dynamic).
3666 Interface "/^tun[0-9]+/"
3667 IgnoreSelected "true"
3669 This will ignore the loopback interface, all interfaces with names starting
3670 with I<veth> and all interfaces with names starting with I<tun> followed by
3673 =item B<ReportInactive> I<true>|I<false>
3675 When set to I<false>, only interfaces with non-zero traffic will be
3676 reported. Note that the check is done by looking into whether a
3677 package was sent at any time from boot and the corresponding counter
3678 is non-zero. So, if the interface has been sending data in the past
3679 since boot, but not during the reported time-interval, it will still
3682 The default value is I<true> and results in collection of the data
3683 from all interfaces that are selected by B<Interface> and
3684 B<IgnoreSelected> options.
3686 =item B<UniqueName> I<true>|I<false>
3688 Interface name is not unique on Solaris (KSTAT), interface name is unique
3689 only within a module/instance. Following tuple is considered unique:
3690 (ks_module, ks_instance, ks_name)
3691 If this option is set to true, interface name contains above three fields
3692 separated by an underscore. For more info on KSTAT, visit
3693 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
3695 This option is only available on Solaris.
3699 =head2 Plugin C<ipmi>
3701 The B<ipmi plugin> allows to monitor server platform status using the Intelligent
3702 Platform Management Interface (IPMI). Local and remote interfaces are supported.
3704 The plugin configuration consists of one or more B<Instance> blocks which
3705 specify one I<ipmi> connection each. Each block requires one unique string
3706 argument as the instance name. If instances are not configured, an instance with
3707 the default option values will be created.
3709 For backwards compatibility, any option other than B<Instance> block will trigger
3710 legacy config handling and it will be treated as an option within B<Instance>
3711 block. This support will go away in the next major version of Collectd.
3713 Within the B<Instance> blocks, the following options are allowed:
3717 =item B<Address> I<Address>
3719 Hostname or IP to connect to. If not specified, plugin will try to connect to
3720 local management controller (BMC).
3722 =item B<Username> I<Username>
3724 =item B<Password> I<Password>
3726 The username and the password to use for the connection to remote BMC.
3728 =item B<AuthType> I<MD5>|I<rmcp+>
3730 Forces the authentication type to use for the connection to remote BMC.
3731 By default most secure type is seleted.
3733 =item B<Host> I<Hostname>
3735 Sets the B<host> field of dispatched values. Defaults to the global hostname
3738 =item B<Sensor> I<Sensor>
3740 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
3742 See F</"IGNORELISTS"> for details.
3744 =item B<IgnoreSelected> I<true>|I<false>
3746 If no configuration if given, the B<ipmi> plugin will collect data from all
3747 sensors found of type "temperature", "voltage", "current" and "fanspeed".
3748 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
3749 the effect of B<Sensor> is inverted: All selected sensors are ignored and
3750 all other sensors are collected.
3752 =item B<NotifySensorAdd> I<true>|I<false>
3754 If a sensor appears after initialization time of a minute a notification
3757 =item B<NotifySensorRemove> I<true>|I<false>
3759 If a sensor disappears a notification is sent.
3761 =item B<NotifySensorNotPresent> I<true>|I<false>
3763 If you have for example dual power supply and one of them is (un)plugged then
3764 a notification is sent.
3766 =item B<NotifyIPMIConnectionState> I<true>|I<false>
3768 If a IPMI connection state changes after initialization time of a minute
3769 a notification is sent. Defaults to B<false>.
3771 =item B<SELEnabled> I<true>|I<false>
3773 If system event log (SEL) is enabled, plugin will listen for sensor threshold
3774 and discrete events. When event is received the notification is sent.
3775 SEL event filtering can be configured using B<SELSensor> and B<SELIgnoreSelected>
3777 Defaults to B<false>.
3779 =item B<SELSensor> I<SELSensor>
3781 Selects sensors to get events from or to ignore, depending on B<SELIgnoreSelected>.
3783 See F</"IGNORELISTS"> for details.
3785 =item B<SELIgnoreSelected> I<true>|I<false>
3787 If no configuration is given, the B<ipmi> plugin will pass events from all
3788 sensors. This option enables you to do that: By setting B<SELIgnoreSelected>
3789 to I<true> the effect of B<SELSensor> is inverted: All events from selected
3790 sensors are ignored and all events from other sensors are passed.
3792 =item B<SELClearEvent> I<true>|I<false>
3794 If SEL clear event is enabled, plugin will delete event from SEL list after
3795 it is received and successfully handled. In this case other tools that are
3796 subscribed for SEL events will receive an empty event.
3797 Defaults to B<false>.
3801 =head2 Plugin C<iptables>
3805 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3807 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3809 Select the iptables/ip6tables filter rules to count packets and bytes from.
3811 If only I<Table> and I<Chain> are given, this plugin will collect the counters
3812 of all rules which have a comment-match. The comment is then used as
3815 If I<Comment> or I<Number> is given, only the rule with the matching comment or
3816 the I<n>th rule will be collected. Again, the comment (or the number) will be
3817 used as the type-instance.
3819 If I<Name> is supplied, it will be used as the type-instance instead of the
3820 comment or the number.
3824 =head2 Plugin C<irq>
3830 Select this irq. By default these irqs will then be collected. For a more
3831 detailed description see B<IgnoreSelected> below.
3833 See F</"IGNORELISTS"> for details.
3835 =item B<IgnoreSelected> I<true>|I<false>
3837 If no configuration if given, the B<irq>-plugin will collect data from all
3838 irqs. This may not be practical, especially if no interrupts happen. Thus, you
3839 can use the B<Irq>-option to pick the interrupt you're interested in.
3840 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
3841 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
3842 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
3843 and all other interrupts are collected.
3847 =head2 Plugin C<java>
3849 The I<Java> plugin makes it possible to write extensions for collectd in Java.
3850 This section only discusses the syntax and semantic of the configuration
3851 options. For more in-depth information on the I<Java> plugin, please read
3852 L<collectd-java(5)>.
3857 JVMArg "-verbose:jni"
3858 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
3859 LoadPlugin "org.collectd.java.Foobar"
3860 <Plugin "org.collectd.java.Foobar">
3861 # To be parsed by the plugin
3865 Available configuration options:
3869 =item B<JVMArg> I<Argument>
3871 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
3872 exactly the way the arguments to the I<java> binary on the command line work.
3873 Execute C<javaE<nbsp>--help> for details.
3875 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
3876 any other options! When another option is found, the JVM will be started and
3877 later options will have to be ignored!
3879 =item B<LoadPlugin> I<JavaClass>
3881 Instantiates a new I<JavaClass> object. The constructor of this object very
3882 likely then registers one or more callback methods with the server.
3884 See L<collectd-java(5)> for details.
3886 When the first such option is found, the virtual machine (JVM) is created. This
3887 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
3888 B<LoadPlugin> options!
3890 =item B<Plugin> I<Name>
3892 The entire block is passed to the Java plugin as an
3893 I<org.collectd.api.OConfigItem> object.
3895 For this to work, the plugin has to register a configuration callback first,
3896 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
3897 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
3898 depends on the (Java) plugin registering the callback and is completely
3899 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
3903 =head2 Plugin C<load>
3905 The I<Load plugin> collects the system load. These numbers give a rough overview
3906 over the utilization of a machine. The system load is defined as the number of
3907 runnable tasks in the run-queue and is provided by many operating systems as a
3908 one, five or fifteen minute average.
3910 The following configuration options are available:
3914 =item B<ReportRelative> B<false>|B<true>
3916 When enabled, system load divided by number of available CPU cores is reported
3917 for intervals 1 min, 5 min and 15 min. Defaults to false.
3922 =head2 Plugin C<logfile>
3926 =item B<LogLevel> B<debug|info|notice|warning|err>
3928 Sets the log-level. If, for example, set to B<notice>, then all events with
3929 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3931 Please note that B<debug> is only available if collectd has been compiled with
3934 =item B<File> I<File>
3936 Sets the file to write log messages to. The special strings B<stdout> and
3937 B<stderr> can be used to write to the standard output and standard error
3938 channels, respectively. This, of course, only makes much sense when I<collectd>
3939 is running in foreground- or non-daemon-mode.
3941 =item B<Timestamp> B<true>|B<false>
3943 Prefix all lines printed by the current time. Defaults to B<true>.
3945 =item B<PrintSeverity> B<true>|B<false>
3947 When enabled, all lines are prefixed by the severity of the log message, for
3948 example "warning". Defaults to B<false>.
3952 B<Note>: There is no need to notify the daemon after moving or removing the
3953 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3954 for each line it writes.
3956 =head2 Plugin C<log_logstash>
3958 The I<log logstash plugin> behaves like the logfile plugin but formats
3959 messages as JSON events for logstash to parse and input.
3963 =item B<LogLevel> B<debug|info|notice|warning|err>
3965 Sets the log-level. If, for example, set to B<notice>, then all events with
3966 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3968 Please note that B<debug> is only available if collectd has been compiled with
3971 =item B<File> I<File>
3973 Sets the file to write log messages to. The special strings B<stdout> and
3974 B<stderr> can be used to write to the standard output and standard error
3975 channels, respectively. This, of course, only makes much sense when I<collectd>
3976 is running in foreground- or non-daemon-mode.
3980 B<Note>: There is no need to notify the daemon after moving or removing the
3981 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3982 for each line it writes.
3984 =head2 Plugin C<lpar>
3986 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
3987 virtualization technique for IBM POWER processors. It takes into account CPU
3988 time stolen from or donated to a partition, in addition to the usual user,
3989 system, I/O statistics.
3991 The following configuration options are available:
3995 =item B<CpuPoolStats> B<false>|B<true>
3997 When enabled, statistics about the processor pool are read, too. The partition
3998 needs to have pool authority in order to be able to acquire this information.
4001 =item B<ReportBySerial> B<false>|B<true>
4003 If enabled, the serial of the physical machine the partition is currently
4004 running on is reported as I<hostname> and the logical hostname of the machine
4005 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
4006 used (just like other plugins) and the I<plugin instance> will be empty.
4011 =head2 Plugin C<lua>
4013 This plugin embeds a Lua interpreter into collectd and provides an interface
4014 to collectd's plugin system. See L<collectd-lua(5)> for its documentation.
4017 =head2 Plugin C<mbmon>
4019 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
4021 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
4022 B<Host> and B<Port> options can be used to change these values, see below.
4023 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
4024 timeouts may appear which may interfere with other statistics..
4026 C<mbmon> must be run with the -r option ("print TAG and Value format");
4027 Debian's F</etc/init.d/mbmon> script already does this, other people
4028 will need to ensure that this is the case.
4032 =item B<Host> I<Hostname>
4034 Hostname to connect to. Defaults to B<127.0.0.1>.
4036 =item B<Port> I<Port>
4038 TCP-Port to connect to. Defaults to B<411>.
4042 =head2 Plugin C<mcelog>
4044 The C<mcelog plugin> uses mcelog to retrieve machine check exceptions.
4046 By default the plugin connects to B<"/var/run/mcelog-client"> to check if the
4047 mcelog server is running. When the server is running, the plugin will tail the
4048 specified logfile to retrieve machine check exception information and send a
4049 notification with the details from the logfile. The plugin will use the mcelog
4050 client protocol to retrieve memory related machine check exceptions. Note that
4051 for memory exceptions, notifications are only sent when there is a change in
4052 the number of corrected/uncorrected memory errors.
4054 =head3 The Memory block
4056 Note: these options cannot be used in conjunction with the logfile options, they are mutually
4061 =item B<McelogClientSocket> I<Path>
4062 Connect to the mcelog client socket using the UNIX domain socket at I<Path>.
4063 Defaults to B<"/var/run/mcelog-client">.
4065 =item B<PersistentNotification> B<true>|B<false>
4066 Override default configuration to only send notifications when sent when there
4067 is a change in the number of corrected/uncorrected memory errors. When set to
4068 true notifications will be sent for every read cycle. Default is false. Does
4069 not affect the stats being dispatched.
4075 =item B<McelogLogfile> I<Path>
4077 The mcelog file to parse. Defaults to B<"/var/log/mcelog">. Note: this option
4078 cannot be used in conjunction with the memory block options, they are mutually
4085 The C<md plugin> collects information from Linux Software-RAID devices (md).
4087 All reported values are of the type C<md_disks>. Reported type instances are
4088 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
4089 I<missing> (physically absent) disks.
4093 =item B<Device> I<Device>
4095 Select md devices based on device name. The I<device name> is the basename of
4096 the device, i.e. the name of the block device without the leading C</dev/>.
4097 See B<IgnoreSelected> for more details.
4099 See F</"IGNORELISTS"> for details.
4101 =item B<IgnoreSelected> B<true>|B<false>
4103 Invert device selection: If set to B<true>, all md devices B<except> those
4104 listed using B<Device> are collected. If B<false> (the default), only those
4105 listed are collected. If no configuration is given, the B<md> plugin will
4106 collect data from all md devices.
4110 =head2 Plugin C<memcachec>
4112 The C<memcachec plugin> connects to a memcached server, queries one or more
4113 given I<pages> and parses the returned data according to user specification.
4114 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
4117 In order to talk to the memcached server, this plugin uses the I<libmemcached>
4118 library. Please note that there is another library with a very similar name,
4119 libmemcache (notice the missing `d'), which is not applicable.
4121 Synopsis of the configuration:
4123 <Plugin "memcachec">
4124 <Page "plugin_instance">
4127 Plugin "plugin_name"
4129 Regex "(\\d+) bytes sent"
4132 Instance "type_instance"
4137 The configuration options are:
4141 =item E<lt>B<Page> I<Name>E<gt>
4143 Each B<Page> block defines one I<page> to be queried from the memcached server.
4144 The block requires one string argument which is used as I<plugin instance>.
4146 =item B<Server> I<Address>
4148 Sets the server address to connect to when querying the page. Must be inside a
4153 When connected to the memcached server, asks for the page I<Key>.
4155 =item B<Plugin> I<Plugin>
4157 Use I<Plugin> as the plugin name when submitting values.
4158 Defaults to C<memcachec>.
4160 =item E<lt>B<Match>E<gt>
4162 Match blocks define which strings to look for and how matches substrings are
4163 interpreted. For a description of match blocks, please see L<"Plugin tail">.
4167 =head2 Plugin C<memcached>
4169 The B<memcached plugin> connects to a memcached server and queries statistics
4170 about cache utilization, memory and bandwidth used.
4171 L<http://memcached.org/>
4173 <Plugin "memcached">
4175 #Host "memcache.example.com"
4181 The plugin configuration consists of one or more B<Instance> blocks which
4182 specify one I<memcached> connection each. Within the B<Instance> blocks, the
4183 following options are allowed:
4187 =item B<Host> I<Hostname>
4189 Sets the B<host> field of dispatched values. Defaults to the global hostname
4191 For backwards compatibility, values are also dispatched with the global
4192 hostname when B<Host> is set to B<127.0.0.1> or B<localhost> and B<Address> is
4195 =item B<Address> I<Address>
4197 Hostname or IP to connect to. For backwards compatibility, defaults to the
4198 value of B<Host> or B<127.0.0.1> if B<Host> is unset.
4200 =item B<Port> I<Port>
4202 TCP port to connect to. Defaults to B<11211>.
4204 =item B<Socket> I<Path>
4206 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
4207 setting is given, the B<Address> and B<Port> settings are ignored.
4211 =head2 Plugin C<mic>
4213 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
4214 Intel's Many Integrated Core (MIC) systems.
4223 ShowTemperatures true
4226 IgnoreSelectedTemperature true
4231 IgnoreSelectedPower true
4234 The following options are valid inside the B<PluginE<nbsp>mic> block:
4238 =item B<ShowCPU> B<true>|B<false>
4240 If enabled (the default) a sum of the CPU usage across all cores is reported.
4242 =item B<ShowCPUCores> B<true>|B<false>
4244 If enabled (the default) per-core CPU usage is reported.
4246 =item B<ShowMemory> B<true>|B<false>
4248 If enabled (the default) the physical memory usage of the MIC system is
4251 =item B<ShowTemperatures> B<true>|B<false>
4253 If enabled (the default) various temperatures of the MIC system are reported.
4255 =item B<Temperature> I<Name>
4257 This option controls which temperatures are being reported. Whether matching
4258 temperatures are being ignored or I<only> matching temperatures are reported
4259 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
4260 temperatures are reported.
4262 =item B<IgnoreSelectedTemperature> B<false>|B<true>
4264 Controls the behavior of the B<Temperature> setting above. If set to B<false>
4265 (the default) only temperatures matching a B<Temperature> option are reported
4266 or, if no B<Temperature> option is specified, all temperatures are reported. If
4267 set to B<true>, matching temperatures are I<ignored> and all other temperatures
4270 Known temperature names are:
4304 =item B<ShowPower> B<true>|B<false>
4306 If enabled (the default) various temperatures of the MIC system are reported.
4308 =item B<Power> I<Name>
4310 This option controls which power readings are being reported. Whether matching
4311 power readings are being ignored or I<only> matching power readings are reported
4312 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
4313 power readings are reported.
4315 =item B<IgnoreSelectedPower> B<false>|B<true>
4317 Controls the behavior of the B<Power> setting above. If set to B<false>
4318 (the default) only power readings matching a B<Power> option are reported
4319 or, if no B<Power> option is specified, all power readings are reported. If
4320 set to B<true>, matching power readings are I<ignored> and all other power readings
4323 Known power names are:
4329 Total power utilization averaged over Time Window 0 (uWatts).
4333 Total power utilization averaged over Time Window 0 (uWatts).
4337 Instantaneous power (uWatts).
4341 Max instantaneous power (uWatts).
4345 PCI-E connector power (uWatts).
4349 2x3 connector power (uWatts).
4353 2x4 connector power (uWatts).
4361 Uncore rail (uVolts).
4365 Memory subsystem rail (uVolts).
4371 =head2 Plugin C<memory>
4373 The I<memory plugin> provides the following configuration options:
4377 =item B<ValuesAbsolute> B<true>|B<false>
4379 Enables or disables reporting of physical memory usage in absolute numbers,
4380 i.e. bytes. Defaults to B<true>.
4382 =item B<ValuesPercentage> B<false>|B<true>
4384 Enables or disables reporting of physical memory usage in percentages, e.g.
4385 percent of physical memory used. Defaults to B<false>.
4387 This is useful for deploying I<collectd> in a heterogeneous environment in
4388 which the sizes of physical memory vary.
4392 =head2 Plugin C<modbus>
4394 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
4395 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
4396 values), large integer values (unsigned 32E<nbsp>bit and 64E<nbsp>bit values) and
4397 floating point values (two registers interpreted as IEEE floats in big endian
4402 <Data "voltage-input-1">
4405 RegisterCmd ReadHolding
4412 <Data "voltage-input-2">
4415 RegisterCmd ReadHolding
4420 <Data "supply-temperature-1">
4423 RegisterCmd ReadHolding
4428 <Host "modbus.example.com">
4429 Address "192.168.0.42"
4434 Instance "power-supply"
4435 Collect "voltage-input-1"
4436 Collect "voltage-input-2"
4441 Device "/dev/ttyUSB0"
4446 Instance "temperature"
4447 Collect "supply-temperature-1"
4453 =item E<lt>B<Data> I<Name>E<gt> blocks
4455 Data blocks define a mapping between register numbers and the "types" used by
4458 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
4462 =item B<RegisterBase> I<Number>
4464 Configures the base register to read from the device. If the option
4465 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
4466 register will be read (the register number is increased by one).
4468 =item B<RegisterType> B<Int16>|B<Int32>|B<Int64>|B<Uint16>|B<Uint32>|B<UInt64>|B<Float>|B<Int32LE>|B<Uint32LE>|B<FloatLE>
4470 Specifies what kind of data is returned by the device. This defaults to
4471 B<Uint16>. If the type is B<Int32>, B<Int32LE>, B<Uint32>, B<Uint32LE>,
4472 B<Float> or B<FloatLE>, two 16E<nbsp>bit registers at B<RegisterBase>
4473 and B<RegisterBase+1> will be read and the data is combined into one
4474 32E<nbsp>value. For B<Int32>, B<Uint32> and B<Float> the most significant
4475 16E<nbsp>bits are in the register at B<RegisterBase> and the least
4476 significant 16E<nbsp>bits are in the register at B<RegisterBase+1>.
4477 For B<Int32LE>, B<Uint32LE>, or B<Float32LE>, the high and low order
4478 registers are swapped with the most significant 16E<nbsp>bits in
4479 the B<RegisterBase+1> and the least significant 16E<nbsp>bits in
4480 B<RegisterBase>. If the type is B<Int64> or B<UInt64>, four 16E<nbsp>bit
4481 registers at B<RegisterBase>, B<RegisterBase+1>, B<RegisterBase+2> and
4482 B<RegisterBase+3> will be read and the data combined into one
4485 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
4487 Specifies register type to be collected from device. Works only with libmodbus
4488 2.9.2 or higher. Defaults to B<ReadHolding>.
4490 =item B<Type> I<Type>
4492 Specifies the "type" (data set) to use when dispatching the value to
4493 I<collectd>. Currently, only data sets with exactly one data source are
4496 =item B<Instance> I<Instance>
4498 Sets the type instance to use when dispatching the value to I<Instance>. If
4499 unset, an empty string (no type instance) is used.
4501 =item B<Scale> I<Value>
4503 The values taken from device are multiplied by I<Value>. The field is optional
4504 and the default is B<1.0>.
4506 =item B<Shift> I<Value>
4508 I<Value> is added to values from device after they have been multiplied by
4509 B<Scale> value. The field is optional and the default value is B<0.0>.
4513 =item E<lt>B<Host> I<Name>E<gt> blocks
4515 Host blocks are used to specify to which hosts to connect and what data to read
4516 from their "slaves". The string argument I<Name> is used as hostname when
4517 dispatching the values to I<collectd>.
4519 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
4523 =item B<Address> I<Hostname>
4525 For Modbus/TCP, specifies the node name (the actual network address) used to
4526 connect to the host. This may be an IP address or a hostname. Please note that
4527 the used I<libmodbus> library only supports IPv4 at the moment.
4529 =item B<Port> I<Service>
4531 for Modbus/TCP, specifies the port used to connect to the host. The port can
4532 either be given as a number or as a service name. Please note that the
4533 I<Service> argument must be a string, even if ports are given in their numerical
4534 form. Defaults to "502".
4536 =item B<Device> I<Devicenode>
4538 For Modbus/RTU, specifies the path to the serial device being used.
4540 =item B<Baudrate> I<Baudrate>
4542 For Modbus/RTU, specifies the baud rate of the serial device.
4543 Note, connections currently support only 8/N/1.
4545 =item B<UARTType> I<UARTType>
4547 For Modbus/RTU, specifies the type of the serial device.
4548 RS232, RS422 and RS485 are supported. Defaults to RS232.
4549 Available only on Linux systems with libmodbus>=2.9.4.
4551 =item B<Interval> I<Interval>
4553 Sets the interval (in seconds) in which the values will be collected from this
4554 host. By default the global B<Interval> setting will be used.
4556 =item E<lt>B<Slave> I<ID>E<gt>
4558 Over each connection, multiple Modbus devices may be reached. The slave ID
4559 is used to specify which device should be addressed. For each device you want
4560 to query, one B<Slave> block must be given.
4562 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
4566 =item B<Instance> I<Instance>
4568 Specify the plugin instance to use when dispatching the values to I<collectd>.
4569 By default "slave_I<ID>" is used.
4571 =item B<Collect> I<DataName>
4573 Specifies which data to retrieve from the device. I<DataName> must be the same
4574 string as the I<Name> argument passed to a B<Data> block. You can specify this
4575 option multiple times to collect more than one value from a slave. At least one
4576 B<Collect> option is mandatory.
4584 =head2 Plugin C<mqtt>
4586 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
4587 values from MQTT (B<Subscribe> blocks).
4593 Host "mqtt.example.com"
4597 Host "mqtt.example.com"
4602 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
4603 configuring the sending and receiving direction respectively. The plugin will
4604 register a write callback named C<mqtt/I<name>> where I<name> is the string
4605 argument given to the B<Publish> block. Both types of blocks share many but not
4606 all of the following options. If an option is valid in only one of the blocks,
4607 it will be mentioned explicitly.
4613 =item B<Host> I<Hostname>
4615 Hostname of the MQTT broker to connect to.
4617 =item B<Port> I<Service>
4619 Port number or service name of the MQTT broker to connect to.
4621 =item B<User> I<UserName>
4623 Username used when authenticating to the MQTT broker.
4625 =item B<Password> I<Password>
4627 Password used when authenticating to the MQTT broker.
4629 =item B<ClientId> I<ClientId>
4631 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
4633 =item B<QoS> [B<0>-B<2>]
4635 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
4653 In B<Publish> blocks, this option determines the QoS flag set on outgoing
4654 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
4655 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
4656 on a message is larger than the maximum accepted QoS of a subscriber, the
4657 message's QoS will be downgraded.
4659 =item B<Prefix> I<Prefix> (Publish only)
4661 This plugin will use one topic per I<value list> which will looks like a path.
4662 I<Prefix> is used as the first path element and defaults to B<collectd>.
4664 An example topic name would be:
4666 collectd/cpu-0/cpu-user
4668 =item B<Retain> B<false>|B<true> (Publish only)
4670 Controls whether the MQTT broker will retain (keep a copy of) the last message
4671 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
4673 =item B<StoreRates> B<true>|B<false> (Publish only)
4675 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
4676 before sending. Defaults to B<true>.
4678 =item B<CleanSession> B<true>|B<false> (Subscribe only)
4680 Controls whether the MQTT "cleans" the session up after the subscriber
4681 disconnects or if it maintains the subscriber's subscriptions and all messages
4682 that arrive while the subscriber is disconnected. Defaults to B<true>.
4684 =item B<Topic> I<TopicName> (Subscribe only)
4686 Configures the topic(s) to subscribe to. You can use the single level C<+> and
4687 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
4688 the B<collectd> branch.
4690 =item B<CACert> I<file>
4692 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
4693 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
4694 port of the MQTT broker.
4695 This option enables the use of TLS.
4697 =item B<CertificateFile> I<file>
4699 Path to the PEM-encoded certificate file to use as client certificate when
4700 connecting to the MQTT broker.
4701 Only valid if B<CACert> and B<CertificateKeyFile> are also set.
4703 =item B<CertificateKeyFile> I<file>
4705 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
4706 Only valid if B<CACert> and B<CertificateFile> are also set.
4708 =item B<TLSProtocol> I<protocol>
4710 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
4711 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
4712 version is used which depends on the version of OpenSSL the Mosquitto library
4714 Only valid if B<CACert> is set.
4716 =item B<CipherSuite> I<ciphersuite>
4718 A string describing the ciphers available for use. See L<ciphers(1)> and the
4719 C<openssl ciphers> utility for more information. If unset, the default ciphers
4721 Only valid if B<CACert> is set.
4725 =head2 Plugin C<mysql>
4727 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
4728 one or more databases when started and keeps the connection up as long as
4729 possible. When the connection is interrupted for whatever reason it will try
4730 to re-connect. The plugin will complain loudly in case anything goes wrong.
4732 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
4733 and collects information about MySQL network traffic, executed statements,
4734 requests, the query cache and threads by evaluating the
4735 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
4736 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
4737 Status Variables> for an explanation of these values.
4739 Optionally, master and slave statistics may be collected in a MySQL
4740 replication setup. In that case, information about the synchronization state
4741 of the nodes are collected by evaluating the C<Position> return value of the
4742 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
4743 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
4744 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
4745 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
4746 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
4758 SSLKey "/path/to/key.pem"
4759 SSLCert "/path/to/cert.pem"
4760 SSLCA "/path/to/ca.pem"
4761 SSLCAPath "/path/to/cas/"
4762 SSLCipher "DHE-RSA-AES256-SHA"
4768 Socket "/var/run/mysql/mysqld.sock"
4770 SlaveNotifications true
4776 Socket "/var/run/mysql/mysqld.sock"
4781 A B<Database> block defines one connection to a MySQL database. It accepts a
4782 single argument which specifies the name of the database. None of the other
4783 options are required. MySQL will use default values as documented in the
4784 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
4785 B<MySQL reference manual>.
4789 =item B<Alias> I<Alias>
4791 Alias to use as sender instead of hostname when reporting. This may be useful
4792 when having cryptic hostnames.
4794 =item B<Host> I<Hostname>
4796 Hostname of the database server. Defaults to B<localhost>.
4798 =item B<User> I<Username>
4800 Username to use when connecting to the database. The user does not have to be
4801 granted any privileges (which is synonym to granting the C<USAGE> privilege),
4802 unless you want to collectd replication statistics (see B<MasterStats> and
4803 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
4804 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
4806 =item B<Password> I<Password>
4808 Password needed to log into the database.
4810 =item B<Database> I<Database>
4812 Select this database. Defaults to I<no database> which is a perfectly reasonable
4813 option for what this plugin does.
4815 =item B<Port> I<Port>
4817 TCP-port to connect to. The port must be specified in its numeric form, but it
4818 must be passed as a string nonetheless. For example:
4822 If B<Host> is set to B<localhost> (the default), this setting has no effect.
4823 See the documentation for the C<mysql_real_connect> function for details.
4825 =item B<Socket> I<Socket>
4827 Specifies the path to the UNIX domain socket of the MySQL server. This option
4828 only has any effect, if B<Host> is set to B<localhost> (the default).
4829 Otherwise, use the B<Port> option above. See the documentation for the
4830 C<mysql_real_connect> function for details.
4832 =item B<InnodbStats> I<true|false>
4834 If enabled, metrics about the InnoDB storage engine are collected.
4835 Disabled by default.
4837 =item B<MasterStats> I<true|false>
4839 =item B<SlaveStats> I<true|false>
4841 Enable the collection of master / slave statistics in a replication setup. In
4842 order to be able to get access to these statistics, the user needs special
4843 privileges. See the B<User> documentation above. Defaults to B<false>.
4845 =item B<SlaveNotifications> I<true|false>
4847 If enabled, the plugin sends a notification if the replication slave I/O and /
4848 or SQL threads are not running. Defaults to B<false>.
4850 =item B<WsrepStats> I<true|false>
4852 Enable the collection of wsrep plugin statistics, used in Master-Master
4853 replication setups like in MySQL Galera/Percona XtraDB Cluster.
4854 User needs only privileges to execute 'SHOW GLOBAL STATUS'
4856 =item B<ConnectTimeout> I<Seconds>
4858 Sets the connect timeout for the MySQL client.
4860 =item B<SSLKey> I<Path>
4862 If provided, the X509 key in PEM format.
4864 =item B<SSLCert> I<Path>
4866 If provided, the X509 cert in PEM format.
4868 =item B<SSLCA> I<Path>
4870 If provided, the CA file in PEM format (check OpenSSL docs).
4872 =item B<SSLCAPath> I<Path>
4874 If provided, the CA directory (check OpenSSL docs).
4876 =item B<SSLCipher> I<String>
4878 If provided, the SSL cipher to use.
4882 =head2 Plugin C<netapp>
4884 The netapp plugin can collect various performance and capacity information
4885 from a NetApp filer using the NetApp API.
4887 Please note that NetApp has a wide line of products and a lot of different
4888 software versions for each of these products. This plugin was developed for a
4889 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
4890 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
4891 model and software version but it is very hard to test this.
4892 If you have used this plugin with other models and/or software version, feel
4893 free to send us a mail to tell us about the results, even if it's just a short
4896 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
4897 basic authentication.
4899 B<Do not use a regular user for this!> Create a special collectd user with just
4900 the minimum of capabilities needed. The user only needs the "login-http-admin"
4901 capability as well as a few more depending on which data will be collected.
4902 Required capabilities are documented below.
4907 <Host "netapp1.example.com">
4931 IgnoreSelectedIO false
4933 IgnoreSelectedOps false
4934 GetLatency "volume0"
4935 IgnoreSelectedLatency false
4942 IgnoreSelectedCapacity false
4945 IgnoreSelectedSnapshot false
4973 The netapp plugin accepts the following configuration options:
4977 =item B<Host> I<Name>
4979 A host block defines one NetApp filer. It will appear in collectd with the name
4980 you specify here which does not have to be its real name nor its hostname (see
4981 the B<Address> option below).
4983 =item B<VFiler> I<Name>
4985 A B<VFiler> block may only be used inside a host block. It accepts all the
4986 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
4987 will execute all NetApp API commands in the context of the specified
4988 VFiler(R). It will appear in collectd with the name you specify here which
4989 does not have to be its real name. The VFiler name may be specified using the
4990 B<VFilerName> option. If this is not specified, it will default to the name
4993 The VFiler block inherits all connection related settings from the surrounding
4994 B<Host> block (which appear before the B<VFiler> block) but they may be
4995 overwritten inside the B<VFiler> block.
4997 This feature is useful, for example, when using a VFiler as SnapVault target
4998 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
4999 available in the host filer (vfiler0) but only in the respective VFiler
5002 =item B<Protocol> B<httpd>|B<http>
5004 The protocol collectd will use to query this host.
5012 Valid options: http, https
5014 =item B<Address> I<Address>
5016 The hostname or IP address of the host.
5022 Default: The "host" block's name.
5024 =item B<Port> I<Port>
5026 The TCP port to connect to on the host.
5032 Default: 80 for protocol "http", 443 for protocol "https"
5034 =item B<User> I<User>
5036 =item B<Password> I<Password>
5038 The username and password to use to login to the NetApp.
5044 =item B<VFilerName> I<Name>
5046 The name of the VFiler in which context to execute API commands. If not
5047 specified, the name provided to the B<VFiler> block will be used instead.
5053 Default: name of the B<VFiler> block
5055 B<Note:> This option may only be used inside B<VFiler> blocks.
5057 =item B<Interval> I<Interval>
5063 The following options decide what kind of data will be collected. You can
5064 either use them as a block and fine tune various parameters inside this block,
5065 use them as a single statement to just accept all default values, or omit it to
5066 not collect any data.
5068 The following options are valid inside all blocks:
5072 =item B<Interval> I<Seconds>
5074 Collect the respective statistics every I<Seconds> seconds. Defaults to the
5075 host specific setting.
5079 =head3 The System block
5081 This will collect various performance data about the whole system.
5083 B<Note:> To get this data the collectd user needs the
5084 "api-perf-object-get-instances" capability.
5088 =item B<Interval> I<Seconds>
5090 Collect disk statistics every I<Seconds> seconds.
5092 =item B<GetCPULoad> B<true>|B<false>
5094 If you set this option to true the current CPU usage will be read. This will be
5095 the average usage between all CPUs in your NetApp without any information about
5098 B<Note:> These are the same values that the NetApp CLI command "sysstat"
5099 returns in the "CPU" field.
5107 Result: Two value lists of type "cpu", and type instances "idle" and "system".
5109 =item B<GetInterfaces> B<true>|B<false>
5111 If you set this option to true the current traffic of the network interfaces
5112 will be read. This will be the total traffic over all interfaces of your NetApp
5113 without any information about individual interfaces.
5115 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5116 in the "Net kB/s" field.
5126 Result: One value list of type "if_octects".
5128 =item B<GetDiskIO> B<true>|B<false>
5130 If you set this option to true the current IO throughput will be read. This
5131 will be the total IO of your NetApp without any information about individual
5132 disks, volumes or aggregates.
5134 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5135 in the "DiskE<nbsp>kB/s" field.
5143 Result: One value list of type "disk_octets".
5145 =item B<GetDiskOps> B<true>|B<false>
5147 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
5148 iSCSI, etc. operations will be read. This will be the total number of
5149 operations on your NetApp without any information about individual volumes or
5152 B<Note:> These are the same values that the NetApp CLI command "sysstat"
5153 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
5161 Result: A variable number of value lists of type "disk_ops_complex". Each type
5162 of operation will result in one value list with the name of the operation as
5167 =head3 The WAFL block
5169 This will collect various performance data about the WAFL file system. At the
5170 moment this just means cache performance.
5172 B<Note:> To get this data the collectd user needs the
5173 "api-perf-object-get-instances" capability.
5175 B<Note:> The interface to get these values is classified as "Diagnostics" by
5176 NetApp. This means that it is not guaranteed to be stable even between minor
5181 =item B<Interval> I<Seconds>
5183 Collect disk statistics every I<Seconds> seconds.
5185 =item B<GetNameCache> B<true>|B<false>
5193 Result: One value list of type "cache_ratio" and type instance
5196 =item B<GetDirCache> B<true>|B<false>
5204 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
5206 =item B<GetInodeCache> B<true>|B<false>
5214 Result: One value list of type "cache_ratio" and type instance
5217 =item B<GetBufferCache> B<true>|B<false>
5219 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
5220 in the "Cache hit" field.
5228 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
5232 =head3 The Disks block
5234 This will collect performance data about the individual disks in the NetApp.
5236 B<Note:> To get this data the collectd user needs the
5237 "api-perf-object-get-instances" capability.
5241 =item B<Interval> I<Seconds>
5243 Collect disk statistics every I<Seconds> seconds.
5245 =item B<GetBusy> B<true>|B<false>
5247 If you set this option to true the busy time of all disks will be calculated
5248 and the value of the busiest disk in the system will be written.
5250 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5251 in the "Disk util" field. Probably.
5259 Result: One value list of type "percent" and type instance "disk_busy".
5263 =head3 The VolumePerf block
5265 This will collect various performance data about the individual volumes.
5267 You can select which data to collect about which volume using the following
5268 options. They follow the standard ignorelist semantic.
5270 B<Note:> To get this data the collectd user needs the
5271 I<api-perf-object-get-instances> capability.
5275 =item B<Interval> I<Seconds>
5277 Collect volume performance data every I<Seconds> seconds.
5279 =item B<GetIO> I<Volume>
5281 =item B<GetOps> I<Volume>
5283 =item B<GetLatency> I<Volume>
5285 Select the given volume for IO, operations or latency statistics collection.
5286 The argument is the name of the volume without the C</vol/> prefix.
5288 Since the standard ignorelist functionality is used here, you can use a string
5289 starting and ending with a slash to specify regular expression matching: To
5290 match the volumes "vol0", "vol2" and "vol7", you can use this regular
5293 GetIO "/^vol[027]$/"
5295 If no regular expression is specified, an exact match is required. Both,
5296 regular and exact matching are case sensitive.
5298 If no volume was specified at all for either of the three options, that data
5299 will be collected for all available volumes.
5301 See F</"IGNORELISTS"> for details.
5303 =item B<IgnoreSelectedIO> B<true>|B<false>
5305 =item B<IgnoreSelectedOps> B<true>|B<false>
5307 =item B<IgnoreSelectedLatency> B<true>|B<false>
5309 When set to B<true>, the volumes selected for IO, operations or latency
5310 statistics collection will be ignored and the data will be collected for all
5313 When set to B<false>, data will only be collected for the specified volumes and
5314 all other volumes will be ignored.
5316 If no volumes have been specified with the above B<Get*> options, all volumes
5317 will be collected regardless of the B<IgnoreSelected*> option.
5319 Defaults to B<false>
5323 =head3 The VolumeUsage block
5325 This will collect capacity data about the individual volumes.
5327 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
5332 =item B<Interval> I<Seconds>
5334 Collect volume usage statistics every I<Seconds> seconds.
5336 =item B<GetCapacity> I<VolumeName>
5338 The current capacity of the volume will be collected. This will result in two
5339 to four value lists, depending on the configuration of the volume. All data
5340 sources are of type "df_complex" with the name of the volume as
5343 There will be type_instances "used" and "free" for the number of used and
5344 available bytes on the volume. If the volume has some space reserved for
5345 snapshots, a type_instance "snap_reserved" will be available. If the volume
5346 has SIS enabled, a type_instance "sis_saved" will be available. This is the
5347 number of bytes saved by the SIS feature.
5349 B<Note:> The current NetApp API has a bug that results in this value being
5350 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
5351 number which works most of the time. If you see strange values here, bug
5352 NetApp support to fix this.
5354 Repeat this option to specify multiple volumes.
5356 =item B<IgnoreSelectedCapacity> B<true>|B<false>
5358 Specify whether to collect only the volumes selected by the B<GetCapacity>
5359 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
5360 B<false>. However, if no B<GetCapacity> option is specified at all, all
5361 capacities will be selected anyway.
5363 =item B<GetSnapshot> I<VolumeName>
5365 Select volumes from which to collect snapshot information.
5367 Usually, the space used for snapshots is included in the space reported as
5368 "used". If snapshot information is collected as well, the space used for
5369 snapshots is subtracted from the used space.
5371 To make things even more interesting, it is possible to reserve space to be
5372 used for snapshots. If the space required for snapshots is less than that
5373 reserved space, there is "reserved free" and "reserved used" space in addition
5374 to "free" and "used". If the space required for snapshots exceeds the reserved
5375 space, that part allocated in the normal space is subtracted from the "used"
5378 Repeat this option to specify multiple volumes.
5380 =item B<IgnoreSelectedSnapshot>
5382 Specify whether to collect only the volumes selected by the B<GetSnapshot>
5383 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
5384 B<false>. However, if no B<GetSnapshot> option is specified at all, all
5385 capacities will be selected anyway.
5389 =head3 The Quota block
5391 This will collect (tree) quota statistics (used disk space and number of used
5392 files). This mechanism is useful to get usage information for single qtrees.
5393 In case the quotas are not used for any other purpose, an entry similar to the
5394 following in C</etc/quotas> would be sufficient:
5396 /vol/volA/some_qtree tree - - - - -
5398 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
5402 =item B<Interval> I<Seconds>
5404 Collect SnapVault(R) statistics every I<Seconds> seconds.
5408 =head3 The SnapVault block
5410 This will collect statistics about the time and traffic of SnapVault(R)
5415 =item B<Interval> I<Seconds>
5417 Collect SnapVault(R) statistics every I<Seconds> seconds.
5421 =head2 Plugin C<netlink>
5423 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
5424 statistics of various interface and routing aspects.
5428 =item B<Interface> I<Interface>
5430 =item B<VerboseInterface> I<Interface>
5432 Instruct the plugin to collect interface statistics. This is basically the same
5433 as the statistics provided by the C<interface> plugin (see above) but
5434 potentially much more detailed.
5436 When configuring with B<Interface> only the basic statistics will be collected,
5437 namely octets, packets, and errors. These statistics are collected by
5438 the C<interface> plugin, too, so using both at the same time is no benefit.
5440 When configured with B<VerboseInterface> all counters B<except> the basic ones
5441 will be collected, so that no data needs to be collected twice if you use the
5442 C<interface> plugin.
5443 This includes dropped packets, received multicast packets, collisions and a
5444 whole zoo of differentiated RX and TX errors. You can try the following command
5445 to get an idea of what awaits you:
5449 If I<Interface> is B<All>, all interfaces will be selected.
5451 =item B<QDisc> I<Interface> [I<QDisc>]
5453 =item B<Class> I<Interface> [I<Class>]
5455 =item B<Filter> I<Interface> [I<Filter>]
5457 Collect the octets and packets that pass a certain qdisc, class or filter.
5459 QDiscs and classes are identified by their type and handle (or classid).
5460 Filters don't necessarily have a handle, therefore the parent's handle is used.
5461 The notation used in collectd differs from that used in tc(1) in that it
5462 doesn't skip the major or minor number if it's zero and doesn't print special
5463 ids by their name. So, for example, a qdisc may be identified by
5464 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
5465 thus not displayed by tc(1).
5467 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
5468 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
5469 associated with that interface will be collected.
5471 Since a filter itself doesn't necessarily have a handle, the parent's handle is
5472 used. This may lead to problems when more than one filter is attached to a
5473 qdisc or class. This isn't nice, but we don't know how this could be done any
5474 better. If you have a idea, please don't hesitate to tell us.
5476 As with the B<Interface> option you can specify B<All> as the interface,
5477 meaning all interfaces.
5479 Here are some examples to help you understand the above text more easily:
5482 VerboseInterface "All"
5483 QDisc "eth0" "pfifo_fast-1:0"
5485 Class "ppp0" "htb-1:10"
5486 Filter "ppp0" "u32-1:0"
5489 See F</"IGNORELISTS"> for details.
5491 =item B<IgnoreSelected>
5493 The behavior is the same as with all other similar plugins: If nothing is
5494 selected at all, everything is collected. If some things are selected using the
5495 options described above, only these statistics are collected. If you set
5496 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
5497 specified statistics will not be collected.
5501 =head2 Plugin C<network>
5503 The Network plugin sends data to a remote instance of collectd, receives data
5504 from a remote instance, or both at the same time. Data which has been received
5505 from the network is usually not transmitted again, but this can be activated, see
5506 the B<Forward> option below.
5508 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
5509 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
5511 Both, B<Server> and B<Listen> can be used as single option or as block. When
5512 used as block, given options are valid for this socket only. The following
5513 example will export the metrics twice: Once to an "internal" server (without
5514 encryption and signing) and one to an external server (with cryptographic
5518 # Export to an internal server
5519 # (demonstrates usage without additional options)
5520 Server "collectd.internal.tld"
5522 # Export to an external server
5523 # (demonstrates usage with signature options)
5524 <Server "collectd.external.tld">
5525 SecurityLevel "sign"
5526 Username "myhostname"
5533 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
5535 The B<Server> statement/block sets the server to send datagrams to. The
5536 statement may occur multiple times to send each datagram to multiple
5539 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
5540 optional second argument specifies a port number or a service name. If not
5541 given, the default, B<25826>, is used.
5543 The following options are recognized within B<Server> blocks:
5547 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5549 Set the security you require for network communication. When the security level
5550 has been set to B<Encrypt>, data sent over the network will be encrypted using
5551 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
5552 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
5553 authentication code. When set to B<None>, data is sent without any security.
5555 This feature is only available if the I<network> plugin was linked with
5558 =item B<Username> I<Username>
5560 Sets the username to transmit. This is used by the server to lookup the
5561 password. See B<AuthFile> below. All security levels except B<None> require
5564 This feature is only available if the I<network> plugin was linked with
5567 =item B<Password> I<Password>
5569 Sets a password (shared secret) for this socket. All security levels except
5570 B<None> require this setting.
5572 This feature is only available if the I<network> plugin was linked with
5575 =item B<Interface> I<Interface name>
5577 Set the outgoing interface for IP packets. This applies at least
5578 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5579 undefined or a non-existent interface name is specified, the default
5580 behavior is to let the kernel choose the appropriate interface. Be warned
5581 that the manual selection of an interface for unicast traffic is only
5582 necessary in rare cases.
5584 =item B<BindAddress> I<IP Address>
5586 Set the outgoing IP address for IP packets. This option can be used instead of
5587 the I<Interface> option to explicitly define the IP address which will be used
5588 to send Packets to the remote server.
5590 =item B<ResolveInterval> I<Seconds>
5592 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
5593 useful to force a regular DNS lookup to support a high availability setup. If
5594 not specified, re-resolves are never attempted.
5598 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
5600 The B<Listen> statement sets the interfaces to bind to. When multiple
5601 statements are found the daemon will bind to multiple interfaces.
5603 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
5604 the argument is a multicast address the daemon will join that multicast group.
5605 The optional second argument specifies a port number or a service name. If not
5606 given, the default, B<25826>, is used.
5608 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
5612 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5614 Set the security you require for network communication. When the security level
5615 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
5616 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
5617 signed and encrypted data is accepted. When set to B<None>, all data will be
5618 accepted. If an B<AuthFile> option was given (see below), encrypted data is
5619 decrypted if possible.
5621 This feature is only available if the I<network> plugin was linked with
5624 =item B<AuthFile> I<Filename>
5626 Sets a file in which usernames are mapped to passwords. These passwords are
5627 used to verify signatures and to decrypt encrypted network packets. If
5628 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
5629 verified and encrypted packets are decrypted. Otherwise, signed data is
5630 accepted without checking the signature and encrypted data cannot be decrypted.
5631 For the other security levels this option is mandatory.
5633 The file format is very simple: Each line consists of a username followed by a
5634 colon and any number of spaces followed by the password. To demonstrate, an
5635 example file could look like this:
5640 Each time a packet is received, the modification time of the file is checked
5641 using L<stat(2)>. If the file has been changed, the contents is re-read. While
5642 the file is being read, it is locked using L<fcntl(2)>.
5644 =item B<Interface> I<Interface name>
5646 Set the incoming interface for IP packets explicitly. This applies at least
5647 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5648 undefined or a non-existent interface name is specified, the default
5649 behavior is, to let the kernel choose the appropriate interface. Thus incoming
5650 traffic gets only accepted, if it arrives on the given interface.
5654 =item B<TimeToLive> I<1-255>
5656 Set the time-to-live of sent packets. This applies to all, unicast and
5657 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
5658 That means that multicast packets will be sent with a TTL of C<1> (one) on most
5661 =item B<MaxPacketSize> I<1024-65535>
5663 Set the maximum size for datagrams received over the network. Packets larger
5664 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
5665 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
5668 On the server side, this limit should be set to the largest value used on
5669 I<any> client. Likewise, the value on the client must not be larger than the
5670 value on the server, or data will be lost.
5672 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
5673 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
5674 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
5677 =item B<Forward> I<true|false>
5679 If set to I<true>, write packets that were received via the network plugin to
5680 the sending sockets. This should only be activated when the B<Listen>- and
5681 B<Server>-statements differ. Otherwise packets may be send multiple times to
5682 the same multicast group. While this results in more network traffic than
5683 necessary it's not a huge problem since the plugin has a duplicate detection,
5684 so the values will not loop.
5686 =item B<ReportStats> B<true>|B<false>
5688 The network plugin cannot only receive and send statistics, it can also create
5689 statistics about itself. Collectd data included the number of received and
5690 sent octets and packets, the length of the receive queue and the number of
5691 values handled. When set to B<true>, the I<Network plugin> will make these
5692 statistics available. Defaults to B<false>.
5696 =head2 Plugin C<nfs>
5698 The I<nfs plugin> collects information about the usage of the Network File
5699 System (NFS). It counts the number of procedure calls for each procedure,
5700 grouped by version and whether the system runs as server or client.
5702 It is possibly to omit metrics for a specific NFS version by setting one or
5703 more of the following options to B<false> (all of them default to B<true>).
5707 =item B<ReportV2> B<true>|B<false>
5709 =item B<ReportV3> B<true>|B<false>
5711 =item B<ReportV4> B<true>|B<false>
5715 =head2 Plugin C<nginx>
5717 This plugin collects the number of connections and requests handled by the
5718 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
5719 queries the page provided by the C<ngx_http_stub_status_module> module, which
5720 isn't compiled by default. Please refer to
5721 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
5722 how to compile and configure nginx and this module.
5724 The following options are accepted by the C<nginx plugin>:
5728 =item B<URL> I<http://host/nginx_status>
5730 Sets the URL of the C<ngx_http_stub_status_module> output.
5732 =item B<User> I<Username>
5734 Optional user name needed for authentication.
5736 =item B<Password> I<Password>
5738 Optional password needed for authentication.
5740 =item B<VerifyPeer> B<true|false>
5742 Enable or disable peer SSL certificate verification. See
5743 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5745 =item B<VerifyHost> B<true|false>
5747 Enable or disable peer host name verification. If enabled, the plugin checks
5748 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5749 certificate matches the host name provided by the B<URL> option. If this
5750 identity check fails, the connection is aborted. Obviously, only works when
5751 connecting to a SSL enabled server. Enabled by default.
5753 =item B<CACert> I<File>
5755 File that holds one or more SSL certificates. If you want to use HTTPS you will
5756 possibly need this option. What CA certificates come bundled with C<libcurl>
5757 and are checked by default depends on the distribution you use.
5759 =item B<Timeout> I<Milliseconds>
5761 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
5762 milliseconds. By default, the configured B<Interval> is used to set the
5767 =head2 Plugin C<notify_desktop>
5769 This plugin sends a desktop notification to a notification daemon, as defined
5770 in the Desktop Notification Specification. To actually display the
5771 notifications, B<notification-daemon> is required and B<collectd> has to be
5772 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
5773 environment variables have to be set correctly) and the D-Bus message bus.
5775 The Desktop Notification Specification can be found at
5776 L<http://www.galago-project.org/specs/notification/>.
5780 =item B<OkayTimeout> I<timeout>
5782 =item B<WarningTimeout> I<timeout>
5784 =item B<FailureTimeout> I<timeout>
5786 Set the I<timeout>, in milliseconds, after which to expire the notification
5787 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
5788 been specified, the displayed notification will not be closed at all - the
5789 user has to do so herself. These options default to 5000. If a negative number
5790 has been specified, the default is used as well.
5794 =head2 Plugin C<notify_email>
5796 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
5797 configured email address.
5799 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
5801 Available configuration options:
5805 =item B<From> I<Address>
5807 Email address from which the emails should appear to come from.
5809 Default: C<root@localhost>
5811 =item B<Recipient> I<Address>
5813 Configures the email address(es) to which the notifications should be mailed.
5814 May be repeated to send notifications to multiple addresses.
5816 At least one B<Recipient> must be present for the plugin to work correctly.
5818 =item B<SMTPServer> I<Hostname>
5820 Hostname of the SMTP server to connect to.
5822 Default: C<localhost>
5824 =item B<SMTPPort> I<Port>
5826 TCP port to connect to.
5830 =item B<SMTPUser> I<Username>
5832 Username for ASMTP authentication. Optional.
5834 =item B<SMTPPassword> I<Password>
5836 Password for ASMTP authentication. Optional.
5838 =item B<Subject> I<Subject>
5840 Subject-template to use when sending emails. There must be exactly two
5841 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
5842 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
5845 Default: C<Collectd notify: %s@%s>
5849 =head2 Plugin C<notify_nagios>
5851 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
5852 a I<passive service check result>.
5854 Available configuration options:
5858 =item B<CommandFile> I<Path>
5860 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
5864 =head2 Plugin C<ntpd>
5866 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
5869 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
5870 the wire - using B<mode 7> specific requests. This mode is deprecated with
5871 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
5872 correctly with them, the ntp daemon must be explicitly configured to
5873 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
5874 manual page for details.
5876 Available configuration options for the C<ntpd> plugin:
5880 =item B<Host> I<Hostname>
5882 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
5884 =item B<Port> I<Port>
5886 UDP-Port to connect to. Defaults to B<123>.
5888 =item B<ReverseLookups> B<true>|B<false>
5890 Sets whether or not to perform reverse lookups on peers. Since the name or
5891 IP-address may be used in a filename it is recommended to disable reverse
5892 lookups. The default is to do reverse lookups to preserve backwards
5893 compatibility, though.
5895 =item B<IncludeUnitID> B<true>|B<false>
5897 When a peer is a refclock, include the unit ID in the I<type instance>.
5898 Defaults to B<false> for backward compatibility.
5900 If two refclock peers use the same driver and this is B<false>, the plugin will
5901 try to write simultaneous measurements from both to the same type instance.
5902 This will result in error messages in the log and only one set of measurements
5907 =head2 Plugin C<nut>
5911 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
5913 Add a UPS to collect data from. The format is identical to the one accepted by
5916 =item B<ForceSSL> B<true>|B<false>
5918 Stops connections from falling back to unsecured if an SSL connection
5919 cannot be established. Defaults to false if undeclared.
5921 =item B<VerifyPeer> I<true>|I<false>
5923 If set to true, requires a CAPath be provided. Will use the CAPath to find
5924 certificates to use as Trusted Certificates to validate a upsd server certificate.
5925 If validation of the upsd server certificate fails, the connection will not be
5926 established. If ForceSSL is undeclared or set to false, setting VerifyPeer to true
5927 will override and set ForceSSL to true.
5929 =item B<CAPath> I/path/to/certs/folder
5931 If VerifyPeer is set to true, this is required. Otherwise this is ignored.
5932 The folder pointed at must contain certificate(s) named according to their hash.
5933 Ex: XXXXXXXX.Y where X is the hash value of a cert and Y is 0. If name collisions
5934 occur because two different certs have the same hash value, Y can be incremented
5935 in order to avoid conflict. To create a symbolic link to a certificate the following
5936 command can be used from within the directory where the cert resides:
5938 C<ln -s some.crt ./$(openssl x509 -hash -noout -in some.crt).0>
5940 Alternatively, the package openssl-perl provides a command C<c_rehash> that will
5941 generate links like the one described above for ALL certs in a given folder.
5943 C<c_rehash /path/to/certs/folder>
5945 =item B<ConnectTimeout> I<Milliseconds>
5947 The B<ConnectTimeout> option sets the connect timeout, in milliseconds.
5948 By default, the configured B<Interval> is used to set the timeout.
5952 =head2 Plugin C<olsrd>
5954 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
5955 the Optimized Link State Routing daemon and reads information about the current
5956 state of the meshed network.
5958 The following configuration options are understood:
5962 =item B<Host> I<Host>
5964 Connect to I<Host>. Defaults to B<"localhost">.
5966 =item B<Port> I<Port>
5968 Specifies the port to connect to. This must be a string, even if you give the
5969 port as a number rather than a service name. Defaults to B<"2006">.
5971 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
5973 Specifies what information to collect about links, i.E<nbsp>e. direct
5974 connections of the daemon queried. If set to B<No>, no information is
5975 collected. If set to B<Summary>, the number of links and the average of all
5976 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
5977 If set to B<Detail> LQ and NLQ are collected per link.
5979 Defaults to B<Detail>.
5981 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
5983 Specifies what information to collect about routes of the daemon queried. If
5984 set to B<No>, no information is collected. If set to B<Summary>, the number of
5985 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
5986 metric and ETX are collected per route.
5988 Defaults to B<Summary>.
5990 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
5992 Specifies what information to collect about the global topology. If set to
5993 B<No>, no information is collected. If set to B<Summary>, the number of links
5994 in the entire topology and the average I<link quality> (LQ) is calculated.
5995 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
5997 Defaults to B<Summary>.
6001 =head2 Plugin C<onewire>
6003 B<EXPERIMENTAL!> See notes below.
6005 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
6006 L<http://owfs.org/> to read sensors connected via the onewire bus.
6008 It can be used in two possible modes - standard or advanced.
6010 In the standard mode only temperature sensors (sensors with the family code
6011 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
6012 other sensors you would like to have included, please send a sort request to
6013 the mailing list. You can select sensors to be read or to be ignored depending
6014 on the option B<IgnoreSelected>). When no list is provided the whole bus is
6015 walked and all sensors are read.
6017 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
6018 experimental, below.
6020 In the advanced mode you can configure any sensor to be read (only numerical
6021 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
6022 In this mode you have to list all the sensors. Neither default bus walk nor
6023 B<IgnoreSelected> are used here. Address and type (file) is extracted from
6024 the path automatically and should produce compatible structure with the "standard"
6025 mode (basically the path is expected as for example
6026 "/uncached/10.F10FCA000800/temperature" where it would extract address part
6027 "F10FCA000800" and the rest after the slash is considered the type - here
6029 There are two advantages to this mode - you can access virtually any sensor
6030 (not just temperature), select whether to use cached or directly read values
6031 and it is slighlty faster. The downside is more complex configuration.
6033 The two modes are distinguished automatically by the format of the address.
6034 It is not possible to mix the two modes. Once a full path is detected in any
6035 B<Sensor> then the whole addressing (all sensors) is considered to be this way
6036 (and as standard addresses will fail parsing they will be ignored).
6040 =item B<Device> I<Device>
6042 Sets the device to read the values from. This can either be a "real" hardware
6043 device, such as a serial port or an USB port, or the address of the
6044 L<owserver(1)> socket, usually B<localhost:4304>.
6046 Though the documentation claims to automatically recognize the given address
6047 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
6048 with that version, the following configuration worked for us:
6051 Device "-s localhost:4304"
6054 This directive is B<required> and does not have a default value.
6056 =item B<Sensor> I<Sensor>
6058 In the standard mode selects sensors to collect or to ignore
6059 (depending on B<IgnoreSelected>, see below). Sensors are specified without
6060 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
6061 and B<not> include the leading C<10.> family byte and point.
6062 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
6063 sensors (see above) are read.
6065 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
6066 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
6067 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
6069 As there can be multiple devices on the bus you can list multiple sensor (use
6070 multiple B<Sensor> elements).
6072 See F</"IGNORELISTS"> for details.
6074 =item B<IgnoreSelected> I<true>|I<false>
6076 If no configuration is given, the B<onewire> plugin will collect data from all
6077 sensors found. This may not be practical, especially if sensors are added and
6078 removed regularly. Sometimes, however, it's easier/preferred to collect only
6079 specific sensors or all sensors I<except> a few specified ones. This option
6080 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
6081 B<Sensor> is inverted: All selected interfaces are ignored and all other
6082 interfaces are collected.
6084 Used only in the standard mode - see above.
6086 =item B<Interval> I<Seconds>
6088 Sets the interval in which all sensors should be read. If not specified, the
6089 global B<Interval> setting is used.
6093 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
6094 work with big setups. It works with one sensor being attached to one
6095 controller, but as soon as you throw in a couple more senors and maybe a hub
6096 or two, reading all values will take more than ten seconds (the default
6097 interval). We will probably add some separate thread for reading the sensors
6098 and some cache or something like that, but it's not done yet. We will try to
6099 maintain backwards compatibility in the future, but we can't promise. So in
6100 short: If it works for you: Great! But keep in mind that the config I<might>
6101 change, though this is unlikely. Oh, and if you want to help improving this
6102 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
6104 =head2 Plugin C<openldap>
6106 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
6107 server correctly. The backend database C<monitor> needs to be loaded and
6108 working. See slapd-monitor(5) for the details.
6110 The configuration of the C<openldap> plugin consists of one or more B<Instance>
6111 blocks. Each block requires one string argument as the instance name. For
6116 URL "ldap://localhost/"
6119 URL "ldaps://localhost/"
6123 The instance name will be used as the I<plugin instance>. To emulate the old
6124 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
6125 plugin to work correctly, each instance name must be unique. This is not
6126 enforced by the plugin and it is your responsibility to ensure it is.
6128 The following options are accepted within each B<Instance> block:
6132 =item B<URL> I<ldap://host/binddn>
6134 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
6137 =item B<BindDN> I<BindDN>
6139 Name in the form of an LDAP distinguished name intended to be used for
6140 authentication. Defaults to empty string to establish an anonymous authorization.
6142 =item B<Password> I<Password>
6144 Password for simple bind authentication. If this option is not set,
6145 unauthenticated bind operation is used.
6147 =item B<StartTLS> B<true|false>
6149 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
6150 Disabled by default.
6152 =item B<VerifyHost> B<true|false>
6154 Enables or disables peer host name verification. If enabled, the plugin checks
6155 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
6156 certificate matches the host name provided by the B<URL> option. If this
6157 identity check fails, the connection is aborted. Enabled by default.
6159 =item B<CACert> I<File>
6161 File that holds one or more SSL certificates. If you want to use TLS/SSL you
6162 may possibly need this option. What CA certificates are checked by default
6163 depends on the distribution you use and can be changed with the usual ldap
6164 client configuration mechanisms. See ldap.conf(5) for the details.
6166 =item B<Timeout> I<Seconds>
6168 Sets the timeout value for ldap operations, in seconds. By default, the
6169 configured B<Interval> is used to set the timeout. Use B<-1> to disable
6172 =item B<Version> I<Version>
6174 An integer which sets the LDAP protocol version number to use when connecting
6175 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
6179 =head2 Plugin C<openvpn>
6181 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
6182 traffic statistics about connected clients.
6184 To set up OpenVPN to write to the status file periodically, use the
6185 B<--status> option of OpenVPN.
6187 So, in a nutshell you need:
6189 openvpn $OTHER_OPTIONS \
6190 --status "/var/run/openvpn-status" 10
6196 =item B<StatusFile> I<File>
6198 Specifies the location of the status file.
6200 =item B<ImprovedNamingSchema> B<true>|B<false>
6202 When enabled, the filename of the status file will be used as plugin instance
6203 and the client's "common name" will be used as type instance. This is required
6204 when reading multiple status files. Enabling this option is recommended, but to
6205 maintain backwards compatibility this option is disabled by default.
6207 =item B<CollectCompression> B<true>|B<false>
6209 Sets whether or not statistics about the compression used by OpenVPN should be
6210 collected. This information is only available in I<single> mode. Enabled by
6213 =item B<CollectIndividualUsers> B<true>|B<false>
6215 Sets whether or not traffic information is collected for each connected client
6216 individually. If set to false, currently no traffic data is collected at all
6217 because aggregating this data in a save manner is tricky. Defaults to B<true>.
6219 =item B<CollectUserCount> B<true>|B<false>
6221 When enabled, the number of currently connected clients or users is collected.
6222 This is especially interesting when B<CollectIndividualUsers> is disabled, but
6223 can be configured independently from that option. Defaults to B<false>.
6227 =head2 Plugin C<oracle>
6229 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
6230 Oracle® Database and lets you execute SQL statements there. It is very similar
6231 to the "dbi" plugin, because it was written around the same time. See the "dbi"
6232 plugin's documentation above for details.
6235 <Query "out_of_stock">
6236 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
6239 # InstancePrefix "foo"
6240 InstancesFrom "category"
6244 <Database "product_information">
6249 Query "out_of_stock"
6253 =head3 B<Query> blocks
6255 The Query blocks are handled identically to the Query blocks of the "dbi"
6256 plugin. Please see its documentation above for details on how to specify
6259 =head3 B<Database> blocks
6261 Database blocks define a connection to a database and which queries should be
6262 sent to that database. Each database needs a "name" as string argument in the
6263 starting tag of the block. This name will be used as "PluginInstance" in the
6264 values submitted to the daemon. Other than that, that name is not used.
6268 =item B<Plugin> I<Plugin>
6270 Use I<Plugin> as the plugin name when submitting query results from
6271 this B<Database>. Defaults to C<oracle>.
6273 =item B<ConnectID> I<ID>
6275 Defines the "database alias" or "service name" to connect to. Usually, these
6276 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
6278 =item B<Host> I<Host>
6280 Hostname to use when dispatching values for this database. Defaults to using
6281 the global hostname of the I<collectd> instance.
6283 =item B<Username> I<Username>
6285 Username used for authentication.
6287 =item B<Password> I<Password>
6289 Password used for authentication.
6291 =item B<Query> I<QueryName>
6293 Associates the query named I<QueryName> with this database connection. The
6294 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
6295 blocks you want to refer to must be placed above the database block you want to
6300 =head2 Plugin C<ovs_events>
6302 The I<ovs_events> plugin monitors the link status of I<Open vSwitch> (OVS)
6303 connected interfaces, dispatches the values to collectd and sends the
6304 notification whenever the link state change occurs. This plugin uses OVS
6305 database to get a link state change notification.
6309 <Plugin "ovs_events">
6312 Socket "/var/run/openvswitch/db.sock"
6313 Interfaces "br0" "veth0"
6314 SendNotification true
6315 DispatchValues false
6318 The plugin provides the following configuration options:
6322 =item B<Address> I<node>
6324 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6325 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6326 option. See L<ovsdb-server(1)> for more details. The option may be either
6327 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6328 format. Defaults to C<localhost>.
6330 =item B<Port> I<service>
6332 TCP-port to connect to. Either a service name or a port number may be given.
6333 Defaults to B<6640>.
6335 =item B<Socket> I<path>
6337 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6338 plugin. To enable the interface, the OVS DB daemon should be running with
6339 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6340 option is set, B<Address> and B<Port> options are ignored.
6342 =item B<Interfaces> [I<ifname> ...]
6344 List of interface names to be monitored by this plugin. If this option is not
6345 specified or is empty then all OVS connected interfaces on all bridges are
6348 Default: empty (all interfaces on all bridges are monitored)
6350 =item B<SendNotification> I<true|false>
6352 If set to true, OVS link notifications (interface status and OVS DB connection
6353 terminate) are sent to collectd. Default value is true.
6355 =item B<DispatchValues> I<true|false>
6357 Dispatch the OVS DB interface link status value with configured plugin interval.
6358 Defaults to false. Please note, if B<SendNotification> and B<DispatchValues>
6359 options are false, no OVS information will be provided by the plugin.
6363 B<Note:> By default, the global interval setting is used within which to
6364 retrieve the OVS link status. To configure a plugin-specific interval, please
6365 use B<Interval> option of the OVS B<LoadPlugin> block settings. For milliseconds
6366 simple divide the time by 1000 for example if the desired interval is 50ms, set
6369 =head2 Plugin C<ovs_stats>
6371 The I<ovs_stats> plugin collects statistics of OVS connected interfaces.
6372 This plugin uses OVSDB management protocol (RFC7047) monitor mechanism to get
6373 statistics from OVSDB
6377 <Plugin "ovs_stats">
6380 Socket "/var/run/openvswitch/db.sock"
6381 Bridges "br0" "br_ext"
6382 InterfaceStats false
6385 The plugin provides the following configuration options:
6389 =item B<Address> I<node>
6391 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6392 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6393 option. See L<ovsdb-server(1)> for more details. The option may be either
6394 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6395 format. Defaults to C<localhost>.
6397 =item B<Port> I<service>
6399 TCP-port to connect to. Either a service name or a port number may be given.
6400 Defaults to B<6640>.
6402 =item B<Socket> I<path>
6404 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6405 plugin. To enable the interface, the OVS DB daemon should be running with
6406 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6407 option is set, B<Address> and B<Port> options are ignored.
6409 =item B<Bridges> [I<brname> ...]
6411 List of OVS bridge names to be monitored by this plugin. If this option is
6412 omitted or is empty then all OVS bridges will be monitored.
6414 Default: empty (monitor all bridges)
6416 =item B<InterfaceStats> B<false>|B<true>
6418 Indicates that the plugin should gather statistics for individual interfaces
6419 in addition to ports. This can be useful when monitoring an OVS setup with
6420 bond ports, where you might wish to know individual statistics for the
6421 interfaces included in the bonds. Defaults to B<false>.
6425 =head2 Plugin C<pcie_errors>
6427 The I<pcie_errors> plugin collects PCI Express errors from Device Status in Capability
6428 structure and from Advanced Error Reporting Extended Capability where available.
6429 At every read it polls config space of PCI Express devices and dispatches
6430 notification for every error that is set. It checks for new errors at every read.
6431 The device is indicated in plugin_instance according to format "domain:bus:dev.fn".
6432 Errors are divided into categories indicated by type_instance: "correctable", and
6433 for uncorrectable errors "non_fatal" or "fatal".
6434 Fatal errors are reported as I<NOTIF_FAILURE> and all others as I<NOTIF_WARNING>.
6438 <Plugin "pcie_errors">
6440 AccessDir "/sys/bus/pci"
6442 PersistentNotifications false
6449 =item B<Source> B<sysfs>|B<proc>
6451 Use B<sysfs> or B<proc> to read data from /sysfs or /proc.
6452 The default value is B<sysfs>.
6454 =item B<AccessDir> I<dir>
6456 Directory used to access device config space. It is optional and defaults to
6457 /sys/bus/pci for B<sysfs> and to /proc/bus/pci for B<proc>.
6459 =item B<ReportMasked> B<false>|B<true>
6461 If true plugin will notify about errors that are set to masked in Error Mask register.
6462 Such errors are not reported to the PCI Express Root Complex. Defaults to B<false>.
6464 =item B<PersistentNotifications> B<false>|B<true>
6466 If false plugin will dispatch notification only on set/clear of error.
6467 The ones already reported will be ignored. Defaults to B<false>.
6471 =head2 Plugin C<perl>
6473 This plugin embeds a Perl-interpreter into collectd and provides an interface
6474 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
6476 =head2 Plugin C<pinba>
6478 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
6479 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
6480 PHP-based webpage has been delivered, the extension will send a UDP packet
6481 containing timing information, peak memory usage and so on. The plugin will
6482 wait for such packets, parse them and account the provided information, which
6483 is then dispatched to the daemon once per interval.
6490 # Overall statistics for the website.
6492 Server "www.example.com"
6494 # Statistics for www-a only
6496 Host "www-a.example.com"
6497 Server "www.example.com"
6499 # Statistics for www-b only
6501 Host "www-b.example.com"
6502 Server "www.example.com"
6506 The plugin provides the following configuration options:
6510 =item B<Address> I<Node>
6512 Configures the address used to open a listening socket. By default, plugin will
6513 bind to the I<any> address C<::0>.
6515 =item B<Port> I<Service>
6517 Configures the port (service) to bind to. By default the default Pinba port
6518 "30002" will be used. The option accepts service names in addition to port
6519 numbers and thus requires a I<string> argument.
6521 =item E<lt>B<View> I<Name>E<gt> block
6523 The packets sent by the Pinba extension include the hostname of the server, the
6524 server name (the name of the virtual host) and the script that was executed.
6525 Using B<View> blocks it is possible to separate the data into multiple groups
6526 to get more meaningful statistics. Each packet is added to all matching groups,
6527 so that a packet may be accounted for more than once.
6531 =item B<Host> I<Host>
6533 Matches the hostname of the system the webserver / script is running on. This
6534 will contain the result of the L<gethostname(2)> system call. If not
6535 configured, all hostnames will be accepted.
6537 =item B<Server> I<Server>
6539 Matches the name of the I<virtual host>, i.e. the contents of the
6540 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
6541 server names will be accepted.
6543 =item B<Script> I<Script>
6545 Matches the name of the I<script name>, i.e. the contents of the
6546 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
6547 script names will be accepted.
6553 =head2 Plugin C<ping>
6555 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
6556 configured hosts periodically and measures the network latency. Whenever the
6557 C<read> function of the plugin is called, it submits the average latency, the
6558 standard deviation and the drop rate for each host.
6560 Available configuration options:
6564 =item B<Host> I<IP-address>
6566 Host to ping periodically. This option may be repeated several times to ping
6569 =item B<Interval> I<Seconds>
6571 Sets the interval in which to send ICMP echo packets to the configured hosts.
6572 This is B<not> the interval in which metrics are read from the plugin but the
6573 interval in which the hosts are "pinged". Therefore, the setting here should be
6574 smaller than or equal to the global B<Interval> setting. Fractional times, such
6575 as "1.24" are allowed.
6579 =item B<Timeout> I<Seconds>
6581 Time to wait for a response from the host to which an ICMP packet had been
6582 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
6583 to be down or the packet to be dropped. This setting must be smaller than the
6584 B<Interval> setting above for the plugin to work correctly. Fractional
6585 arguments are accepted.
6589 =item B<TTL> I<0-255>
6591 Sets the Time-To-Live of generated ICMP packets.
6593 =item B<Size> I<size>
6595 Sets the size of the data payload in ICMP packet to specified I<size> (it
6596 will be filled with regular ASCII pattern). If not set, default 56 byte
6597 long string is used so that the packet size of an ICMPv4 packet is exactly
6598 64 bytes, similar to the behaviour of normal ping(1) command.
6600 =item B<SourceAddress> I<host>
6602 Sets the source address to use. I<host> may either be a numerical network
6603 address or a network hostname.
6605 =item B<AddressFamily> I<af>
6607 Sets the address family to use. I<af> may be "any", "ipv4" or "ipv6". This
6608 option will be ignored if you set a B<SourceAddress>.
6610 =item B<Device> I<name>
6612 Sets the outgoing network device to be used. I<name> has to specify an
6613 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
6616 =item B<MaxMissed> I<Packets>
6618 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
6619 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
6621 Default: B<-1> (disabled)
6625 =head2 Plugin C<postgresql>
6627 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
6628 keeps a persistent connection to all configured databases and tries to
6629 reconnect if the connection has been interrupted. A database is configured by
6630 specifying a B<Database> block as described below. The default statistics are
6631 collected from PostgreSQL's B<statistics collector> which thus has to be
6632 enabled for this plugin to work correctly. This should usually be the case by
6633 default. See the section "The Statistics Collector" of the B<PostgreSQL
6634 Documentation> for details.
6636 By specifying custom database queries using a B<Query> block as described
6637 below, you may collect any data that is available from some PostgreSQL
6638 database. This way, you are able to access statistics of external daemons
6639 which are available in a PostgreSQL database or use future or special
6640 statistics provided by PostgreSQL without the need to upgrade your collectd
6643 Starting with version 5.2, the C<postgresql> plugin supports writing data to
6644 PostgreSQL databases as well. This has been implemented in a generic way. You
6645 need to specify an SQL statement which will then be executed by collectd in
6646 order to write the data (see below for details). The benefit of that approach
6647 is that there is no fixed database layout. Rather, the layout may be optimized
6648 for the current setup.
6650 The B<PostgreSQL Documentation> manual can be found at
6651 L<http://www.postgresql.org/docs/manuals/>.
6655 Statement "SELECT magic FROM wizard WHERE host = $1;"
6659 InstancePrefix "magic"
6664 <Query rt36_tickets>
6665 Statement "SELECT COUNT(type) AS count, type \
6667 WHEN resolved = 'epoch' THEN 'open' \
6668 ELSE 'resolved' END AS type \
6669 FROM tickets) type \
6673 InstancePrefix "rt36_tickets"
6674 InstancesFrom "type"
6680 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
6691 KRBSrvName "kerberos_service_name"
6697 Service "service_name"
6698 Query backends # predefined
6709 The B<Query> block defines one database query which may later be used by a
6710 database definition. It accepts a single mandatory argument which specifies
6711 the name of the query. The names of all queries have to be unique (see the
6712 B<MinVersion> and B<MaxVersion> options below for an exception to this
6715 In each B<Query> block, there is one or more B<Result> blocks. Multiple
6716 B<Result> blocks may be used to extract multiple values from a single query.
6718 The following configuration options are available to define the query:
6722 =item B<Statement> I<sql query statement>
6724 Specify the I<sql query statement> which the plugin should execute. The string
6725 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
6726 first, second, etc. parameter. The value of the parameters is specified by the
6727 B<Param> configuration option - see below for details. To include a literal
6728 B<$> character followed by a number, surround it with single quotes (B<'>).
6730 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
6731 allowed. Note, however, that only a single command may be used. Semicolons are
6732 allowed as long as a single non-empty command has been specified only.
6734 The returned lines will be handled separately one after another.
6736 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
6738 Specify the parameters which should be passed to the SQL query. The parameters
6739 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
6740 they appear in the configuration file. The value of the parameter is
6741 determined depending on the value of the B<Param> option as follows:
6747 The configured hostname of the database connection. If a UNIX domain socket is
6748 used, the parameter expands to "localhost".
6752 The name of the database of the current connection.
6756 The name of the database plugin instance. See the B<Instance> option of the
6757 database specification below for details.
6761 The username used to connect to the database.
6765 The interval with which this database is queried (as specified by the database
6766 specific or global B<Interval> options).
6770 Please note that parameters are only supported by PostgreSQL's protocol
6771 version 3 and above which was introduced in version 7.4 of PostgreSQL.
6773 =item B<PluginInstanceFrom> I<column>
6775 Specify how to create the "PluginInstance" for reporting this query results.
6776 Only one column is supported. You may concatenate fields and string values in
6777 the query statement to get the required results.
6779 =item B<MinVersion> I<version>
6781 =item B<MaxVersion> I<version>
6783 Specify the minimum or maximum version of PostgreSQL that this query should be
6784 used with. Some statistics might only be available with certain versions of
6785 PostgreSQL. This allows you to specify multiple queries with the same name but
6786 which apply to different versions, thus allowing you to use the same
6787 configuration in a heterogeneous environment.
6789 The I<version> has to be specified as the concatenation of the major, minor
6790 and patch-level versions, each represented as two-decimal-digit numbers. For
6791 example, version 8.2.3 will become 80203.
6795 The B<Result> block defines how to handle the values returned from the query.
6796 It defines which column holds which value and how to dispatch that value to
6801 =item B<Type> I<type>
6803 The I<type> name to be used when dispatching the values. The type describes
6804 how to handle the data and where to store it. See L<types.db(5)> for more
6805 details on types and their configuration. The number and type of values (as
6806 selected by the B<ValuesFrom> option) has to match the type of the given name.
6808 This option is mandatory.
6810 =item B<InstancePrefix> I<prefix>
6812 =item B<InstancesFrom> I<column0> [I<column1> ...]
6814 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
6815 B<InstancePrefix> defines a static prefix that will be prepended to all type
6816 instances. B<InstancesFrom> defines the column names whose values will be used
6817 to create the type instance. Multiple values will be joined together using the
6818 hyphen (C<->) as separation character.
6820 The plugin itself does not check whether or not all built instances are
6821 different. It is your responsibility to assure that each is unique.
6823 Both options are optional. If none is specified, the type instance will be
6826 =item B<ValuesFrom> I<column0> [I<column1> ...]
6828 Names the columns whose content is used as the actual data for the data sets
6829 that are dispatched to the daemon. How many such columns you need is
6830 determined by the B<Type> setting as explained above. If you specify too many
6831 or not enough columns, the plugin will complain about that and no data will be
6832 submitted to the daemon.
6834 The actual data type, as seen by PostgreSQL, is not that important as long as
6835 it represents numbers. The plugin will automatically cast the values to the
6836 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
6837 L<strtod(3)> functions, so anything supported by those functions is supported
6838 by the plugin as well.
6840 This option is required inside a B<Result> block and may be specified multiple
6841 times. If multiple B<ValuesFrom> options are specified, the columns are read
6846 The following predefined queries are available (the definitions can be found
6847 in the F<postgresql_default.conf> file which, by default, is available at
6848 C<I<prefix>/share/collectd/>):
6854 This query collects the number of backends, i.E<nbsp>e. the number of
6857 =item B<transactions>
6859 This query collects the numbers of committed and rolled-back transactions of
6864 This query collects the numbers of various table modifications (i.E<nbsp>e.
6865 insertions, updates, deletions) of the user tables.
6867 =item B<query_plans>
6869 This query collects the numbers of various table scans and returned tuples of
6872 =item B<table_states>
6874 This query collects the numbers of live and dead rows in the user tables.
6878 This query collects disk block access counts for user tables.
6882 This query collects the on-disk size of the database in bytes.
6886 In addition, the following detailed queries are available by default. Please
6887 note that each of those queries collects information B<by table>, thus,
6888 potentially producing B<a lot> of data. For details see the description of the
6889 non-by_table queries above.
6893 =item B<queries_by_table>
6895 =item B<query_plans_by_table>
6897 =item B<table_states_by_table>
6899 =item B<disk_io_by_table>
6903 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
6904 mandatory argument specifying the name of the writer. This will then be used
6905 in the B<Database> specification in order to activate the writer instance. The
6906 names of all writers have to be unique. The following options may be
6911 =item B<Statement> I<sql statement>
6913 This mandatory option specifies the SQL statement that will be executed for
6914 each submitted value. A single SQL statement is allowed only. Anything after
6915 the first semicolon will be ignored.
6917 Nine parameters will be passed to the statement and should be specified as
6918 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
6919 values are made available through those parameters:
6925 The timestamp of the queried value as an RFC 3339-formatted local time.
6929 The hostname of the queried value.
6933 The plugin name of the queried value.
6937 The plugin instance of the queried value. This value may be B<NULL> if there
6938 is no plugin instance.
6942 The type of the queried value (cf. L<types.db(5)>).
6946 The type instance of the queried value. This value may be B<NULL> if there is
6951 An array of names for the submitted values (i.E<nbsp>e., the name of the data
6952 sources of the submitted value-list).
6956 An array of types for the submitted values (i.E<nbsp>e., the type of the data
6957 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
6958 B<StoreRates> is enabled (which is the default, see below), all types will be
6963 An array of the submitted values. The dimensions of the value name and value
6968 In general, it is advisable to create and call a custom function in the
6969 PostgreSQL database for this purpose. Any procedural language supported by
6970 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
6973 =item B<StoreRates> B<false>|B<true>
6975 If set to B<true> (the default), convert counter values to rates. If set to
6976 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6981 The B<Database> block defines one PostgreSQL database for which to collect
6982 statistics. It accepts a single mandatory argument which specifies the
6983 database name. None of the other options are required. PostgreSQL will use
6984 default values as documented in the section "CONNECTING TO A DATABASE" in the
6985 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
6986 the user collectd is run as and special environment variables. See the manpage
6991 =item B<Interval> I<seconds>
6993 Specify the interval with which the database should be queried. The default is
6994 to use the global B<Interval> setting.
6996 =item B<CommitInterval> I<seconds>
6998 This option may be used for database connections which have "writers" assigned
6999 (see above). If specified, it causes a writer to put several updates into a
7000 single transaction. This transaction will last for the specified amount of
7001 time. By default, each update will be executed in a separate transaction. Each
7002 transaction generates a fair amount of overhead which can, thus, be reduced by
7003 activating this option. The draw-back is, that data covering the specified
7004 amount of time will be lost, for example, if a single statement within the
7005 transaction fails or if the database server crashes.
7007 =item B<Plugin> I<Plugin>
7009 Use I<Plugin> as the plugin name when submitting query results from
7010 this B<Database>. Defaults to C<postgresql>.
7012 =item B<Instance> I<name>
7014 Specify the plugin instance name that should be used instead of the database
7015 name (which is the default, if this option has not been specified). This
7016 allows one to query multiple databases of the same name on the same host (e.g.
7017 when running multiple database server versions in parallel).
7018 The plugin instance name can also be set from the query result using
7019 the B<PluginInstanceFrom> option in B<Query> block.
7021 =item B<Host> I<hostname>
7023 Specify the hostname or IP of the PostgreSQL server to connect to. If the
7024 value begins with a slash, it is interpreted as the directory name in which to
7025 look for the UNIX domain socket.
7027 This option is also used to determine the hostname that is associated with a
7028 collected data set. If it has been omitted or either begins with with a slash
7029 or equals B<localhost> it will be replaced with the global hostname definition
7030 of collectd. Any other value will be passed literally to collectd when
7031 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
7033 =item B<Port> I<port>
7035 Specify the TCP port or the local UNIX domain socket file extension of the
7038 =item B<User> I<username>
7040 Specify the username to be used when connecting to the server.
7042 =item B<Password> I<password>
7044 Specify the password to be used when connecting to the server.
7046 =item B<ExpireDelay> I<delay>
7048 Skip expired values in query output.
7050 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
7052 Specify whether to use an SSL connection when contacting the server. The
7053 following modes are supported:
7059 Do not use SSL at all.
7063 First, try to connect without using SSL. If that fails, try using SSL.
7065 =item I<prefer> (default)
7067 First, try to connect using SSL. If that fails, try without using SSL.
7075 =item B<Instance> I<name>
7077 Specify the plugin instance name that should be used instead of the database
7078 name (which is the default, if this option has not been specified). This
7079 allows one to query multiple databases of the same name on the same host (e.g.
7080 when running multiple database server versions in parallel).
7082 =item B<KRBSrvName> I<kerberos_service_name>
7084 Specify the Kerberos service name to use when authenticating with Kerberos 5
7085 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
7086 B<PostgreSQL Documentation> for details.
7088 =item B<Service> I<service_name>
7090 Specify the PostgreSQL service name to use for additional parameters. That
7091 service has to be defined in F<pg_service.conf> and holds additional
7092 connection parameters. See the section "The Connection Service File" in the
7093 B<PostgreSQL Documentation> for details.
7095 =item B<Query> I<query>
7097 Specifies a I<query> which should be executed in the context of the database
7098 connection. This may be any of the predefined or user-defined queries. If no
7099 such option is given, it defaults to "backends", "transactions", "queries",
7100 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
7101 has been specified). Else, the specified queries are used only.
7103 =item B<Writer> I<writer>
7105 Assigns the specified I<writer> backend to the database connection. This
7106 causes all collected data to be send to the database using the settings
7107 defined in the writer configuration (see the section "FILTER CONFIGURATION"
7108 below for details on how to selectively send data to certain plugins).
7110 Each writer will register a flush callback which may be used when having long
7111 transactions enabled (see the B<CommitInterval> option above). When issuing
7112 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
7113 transaction will be committed right away. Two different kinds of flush
7114 callbacks are available with the C<postgresql> plugin:
7120 Flush all writer backends.
7122 =item B<postgresql->I<database>
7124 Flush all writers of the specified I<database> only.
7130 =head2 Plugin C<powerdns>
7132 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
7133 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
7134 values, many of which are probably meaningless to most users, but may be useful
7135 for some. So you may chose which values to collect, but if you don't, some
7136 reasonable defaults will be collected.
7139 <Server "server_name">
7141 Collect "udp-answers" "udp-queries"
7142 Socket "/var/run/pdns.controlsocket"
7144 <Recursor "recursor_name">
7146 Collect "cache-hits" "cache-misses"
7147 Socket "/var/run/pdns_recursor.controlsocket"
7149 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
7154 =item B<Server> and B<Recursor> block
7156 The B<Server> block defines one authoritative server to query, the B<Recursor>
7157 does the same for an recursing server. The possible options in both blocks are
7158 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
7163 =item B<Collect> I<Field>
7165 Using the B<Collect> statement you can select which values to collect. Here,
7166 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
7167 C<dlg-only-drops>, C<answers10-100>.
7169 The method of getting the values differs for B<Server> and B<Recursor> blocks:
7170 When querying the server a C<SHOW *> command is issued in any case, because
7171 that's the only way of getting multiple values out of the server at once.
7172 collectd then picks out the values you have selected. When querying the
7173 recursor, a command is generated to query exactly these values. So if you
7174 specify invalid fields when querying the recursor, a syntax error may be
7175 returned by the daemon and collectd may not collect any values at all.
7177 If no B<Collect> statement is given, the following B<Server> values will be
7184 =item packetcache-hit
7186 =item packetcache-miss
7188 =item packetcache-size
7190 =item query-cache-hit
7192 =item query-cache-miss
7194 =item recursing-answers
7196 =item recursing-questions
7208 The following B<Recursor> values will be collected by default:
7212 =item noerror-answers
7214 =item nxdomain-answers
7216 =item servfail-answers
7234 Please note that up to that point collectd doesn't know what values are
7235 available on the server and values that are added do not need a change of the
7236 mechanism so far. However, the values must be mapped to collectd's naming
7237 scheme, which is done using a lookup table that lists all known values. If
7238 values are added in the future and collectd does not know about them, you will
7239 get an error much like this:
7241 powerdns plugin: submit: Not found in lookup table: foobar = 42
7243 In this case please file a bug report with the collectd team.
7245 =item B<Socket> I<Path>
7247 Configures the path to the UNIX domain socket to be used when connecting to the
7248 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
7249 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
7250 will be used for the recursor.
7254 =item B<LocalSocket> I<Path>
7256 Querying the recursor is done using UDP. When using UDP over UNIX domain
7257 sockets, the client socket needs a name in the file system, too. You can set
7258 this local name to I<Path> using the B<LocalSocket> option. The default is
7259 C<I<prefix>/var/run/collectd-powerdns>.
7263 =head2 Plugin C<processes>
7265 Collects information about processes of local system.
7267 By default, with no process matches configured, only general statistics is
7268 collected: the number of processes in each state and fork rate.
7270 Process matches can be configured by B<Process> and B<ProcessMatch> options.
7271 These may also be a block in which further options may be specified.
7273 The statistics collected for matched processes are:
7274 - size of the resident segment size (RSS)
7275 - user- and system-time used
7276 - number of processes
7278 - number of open files (under Linux)
7279 - number of memory mapped files (under Linux)
7280 - io data (where available)
7281 - context switches (under Linux)
7282 - minor and major pagefaults
7283 - Delay Accounting information (Linux only, requires libmnl)
7288 CollectFileDescriptor true
7289 CollectContextSwitch true
7290 CollectDelayAccounting false
7292 ProcessMatch "name" "regex"
7293 <Process "collectd">
7294 CollectFileDescriptor false
7295 CollectContextSwitch false
7296 CollectDelayAccounting true
7298 <ProcessMatch "name" "regex">
7299 CollectFileDescriptor false
7300 CollectContextSwitch true
7306 =item B<Process> I<Name>
7308 Select more detailed statistics of processes matching this name.
7310 Some platforms have a limit on the length of process names.
7311 I<Name> must stay below this limit.
7313 =item B<ProcessMatch> I<name> I<regex>
7315 Select more detailed statistics of processes matching the specified I<regex>
7316 (see L<regex(7)> for details). The statistics of all matching processes are
7317 summed up and dispatched to the daemon using the specified I<name> as an
7318 identifier. This allows one to "group" several processes together.
7319 I<name> must not contain slashes.
7321 =item B<CollectContextSwitch> I<Boolean>
7323 Collect the number of context switches for matched processes.
7324 Disabled by default.
7326 =item B<CollectDelayAccounting> I<Boolean>
7328 If enabled, collect Linux Delay Accounding information for matching processes.
7329 Delay Accounting provides the time processes wait for the CPU to become
7330 available, for I/O operations to finish, for pages to be swapped in and for
7331 freed pages to be reclaimed. The metrics are reported as "seconds per second"
7332 using the C<delay_rate> type, e.g. C<delay_rate-delay-cpu>.
7333 Disabled by default.
7335 This option is only available on Linux, requires the C<libmnl> library and
7336 requires the C<CAP_NET_ADMIN> capability at runtime.
7338 =item B<CollectFileDescriptor> I<Boolean>
7340 Collect number of file descriptors of matched processes.
7341 Disabled by default.
7343 =item B<CollectMemoryMaps> I<Boolean>
7345 Collect the number of memory mapped files of the process.
7346 The limit for this number is configured via F</proc/sys/vm/max_map_count> in
7351 The B<CollectContextSwitch>, B<CollectDelayAccounting>,
7352 B<CollectFileDescriptor> and B<CollectMemoryMaps> options may be used inside
7353 B<Process> and B<ProcessMatch> blocks. When used there, these options affect
7354 reporting the corresponding processes only. Outside of B<Process> and
7355 B<ProcessMatch> blocks these options set the default value for subsequent
7358 =head2 Plugin C<protocols>
7360 Collects a lot of information about various network protocols, such as I<IP>,
7361 I<TCP>, I<UDP>, etc.
7363 Available configuration options:
7367 =item B<Value> I<Selector>
7369 Selects whether or not to select a specific value. The string being matched is
7370 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
7371 plugin instance and I<ValueName> will be used as type instance. An example of
7372 the string being used would be C<Tcp:RetransSegs>.
7374 You can use regular expressions to match a large number of values with just one
7375 configuration option. To select all "extended" I<TCP> values, you could use the
7376 following statement:
7380 Whether only matched values are selected or all matched values are ignored
7381 depends on the B<IgnoreSelected>. By default, only matched values are selected.
7382 If no value is configured at all, all values will be selected.
7384 See F</"IGNORELISTS"> for details.
7386 =item B<IgnoreSelected> B<true>|B<false>
7388 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
7389 matching values will be ignored.
7393 =head2 Plugin C<python>
7395 This plugin embeds a Python-interpreter into collectd and provides an interface
7396 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
7398 =head2 Plugin C<routeros>
7400 The C<routeros> plugin connects to a device running I<RouterOS>, the
7401 Linux-based operating system for routers by I<MikroTik>. The plugin uses
7402 I<librouteros> to connect and reads information about the interfaces and
7403 wireless connections of the device. The configuration supports querying
7408 Host "router0.example.com"
7411 CollectInterface true
7416 Host "router1.example.com"
7419 CollectInterface true
7420 CollectRegistrationTable true
7427 As you can see above, the configuration of the I<routeros> plugin consists of
7428 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
7429 options are understood:
7433 =item B<Host> I<Host>
7435 Hostname or IP-address of the router to connect to.
7437 =item B<Port> I<Port>
7439 Port name or port number used when connecting. If left unspecified, the default
7440 will be chosen by I<librouteros>, currently "8728". This option expects a
7441 string argument, even when a numeric port number is given.
7443 =item B<User> I<User>
7445 Use the user name I<User> to authenticate. Defaults to "admin".
7447 =item B<Password> I<Password>
7449 Set the password used to authenticate.
7451 =item B<CollectInterface> B<true>|B<false>
7453 When set to B<true>, interface statistics will be collected for all interfaces
7454 present on the device. Defaults to B<false>.
7456 =item B<CollectRegistrationTable> B<true>|B<false>
7458 When set to B<true>, information about wireless LAN connections will be
7459 collected. Defaults to B<false>.
7461 =item B<CollectCPULoad> B<true>|B<false>
7463 When set to B<true>, information about the CPU usage will be collected. The
7464 number is a dimensionless value where zero indicates no CPU usage at all.
7465 Defaults to B<false>.
7467 =item B<CollectMemory> B<true>|B<false>
7469 When enabled, the amount of used and free memory will be collected. How used
7470 memory is calculated is unknown, for example whether or not caches are counted
7472 Defaults to B<false>.
7474 =item B<CollectDF> B<true>|B<false>
7476 When enabled, the amount of used and free disk space will be collected.
7477 Defaults to B<false>.
7479 =item B<CollectDisk> B<true>|B<false>
7481 When enabled, the number of sectors written and bad blocks will be collected.
7482 Defaults to B<false>.
7484 =item B<CollectHealth> B<true>|B<false>
7486 When enabled, the health statistics will be collected. This includes the
7487 voltage and temperature on supported hardware.
7488 Defaults to B<false>.
7492 =head2 Plugin C<redis>
7494 The I<Redis plugin> connects to one or more Redis servers, gathers
7495 information about each server's state and executes user-defined queries.
7496 For each server there is a I<Node> block which configures the connection
7497 parameters and set of user-defined queries for this node.
7503 #Socket "/var/run/redis/redis.sock"
7505 ReportCommandStats false
7507 <Query "LLEN myqueue">
7517 =item B<Node> I<Nodename>
7519 The B<Node> block identifies a new Redis node, that is a new Redis instance
7520 running in an specified host and port. The name for node is a canonical
7521 identifier which is used as I<plugin instance>. It is limited to
7522 128E<nbsp>characters in length.
7524 When no B<Node> is configured explicitly, plugin connects to "localhost:6379".
7526 =item B<Host> I<Hostname>
7528 The B<Host> option is the hostname or IP-address where the Redis instance is
7531 =item B<Port> I<Port>
7533 The B<Port> option is the TCP port on which the Redis instance accepts
7534 connections. Either a service name of a port number may be given. Please note
7535 that numerical port numbers must be given as a string, too.
7537 =item B<Socket> I<Path>
7539 Connect to Redis using the UNIX domain socket at I<Path>. If this
7540 setting is given, the B<Hostname> and B<Port> settings are ignored.
7542 =item B<Password> I<Password>
7544 Use I<Password> to authenticate when connecting to I<Redis>.
7546 =item B<Timeout> I<Milliseconds>
7548 The B<Timeout> option set the socket timeout for node response. Since the Redis
7549 read function is blocking, you should keep this value as low as possible.
7550 It is expected what B<Timeout> values should be lower than B<Interval> defined
7553 Defaults to 2000 (2 seconds).
7555 =item B<ReportCommandStats> B<false>|B<true>
7557 Enables or disables reporting of statistics based on the command type, including
7558 rate of command calls and average CPU time consumed by command processing.
7559 Defaults to B<false>.
7561 =item B<ReportCpuUsage> B<true>|B<false>
7563 Enables or disables reporting of CPU consumption statistics.
7564 Defaults to B<true>.
7566 =item B<Query> I<Querystring>
7568 The B<Query> block identifies a query to execute against the redis server.
7569 There may be an arbitrary number of queries to execute. Each query should
7570 return single string or integer.
7572 =item B<Type> I<Collectd type>
7574 Within a query definition, a valid I<collectd type> to use as when submitting
7575 the result of the query. When not supplied, will default to B<gauge>.
7577 Currently only types with one datasource are supported.
7578 See L<types.db(5)> for more details on types and their configuration.
7580 =item B<Instance> I<Type instance>
7582 Within a query definition, an optional type instance to use when submitting
7583 the result of the query. When not supplied will default to the escaped
7584 command, up to 128 chars.
7586 =item B<Database> I<Index>
7588 This index selects the Redis logical database to use for query. Defaults
7593 =head2 Plugin C<rrdcached>
7595 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
7596 to store values to RRD files in an efficient manner. The combination of the
7597 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
7598 way the C<rrdtool> plugin works (see below). The added abstraction layer
7599 provides a number of benefits, though: Because the cache is not within
7600 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
7601 restarted. This results in much shorter (if any) gaps in graphs, especially
7602 under heavy load. Also, the C<rrdtool> command line utility is aware of the
7603 daemon so that it can flush values to disk automatically when needed. This
7604 allows one to integrate automated flushing of values into graphing solutions
7607 There are disadvantages, though: The daemon may reside on a different host, so
7608 it may not be possible for C<collectd> to create the appropriate RRD files
7609 anymore. And even if C<rrdcached> runs on the same host, it may run in a
7610 different base directory, so relative paths may do weird stuff if you're not
7613 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
7614 on the same host, communicating via a UNIX domain socket. The B<DataDir>
7615 setting should be set to an absolute path, so that a changed base directory
7616 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
7620 =item B<DaemonAddress> I<Address>
7622 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
7623 library. See L<rrdcached(1)> for details. Example:
7625 <Plugin "rrdcached">
7626 DaemonAddress "unix:/var/run/rrdcached.sock"
7629 =item B<DataDir> I<Directory>
7631 Set the base directory in which the RRD files reside. If this is a relative
7632 path, it is relative to the working base directory of the C<rrdcached> daemon!
7633 Use of an absolute path is recommended.
7635 =item B<CreateFiles> B<true>|B<false>
7637 Enables or disables the creation of RRD files. If the daemon is not running
7638 locally, or B<DataDir> is set to a relative path, this will not work as
7639 expected. Default is B<true>.
7641 =item B<CreateFilesAsync> B<false>|B<true>
7643 When enabled, new RRD files are enabled asynchronously, using a separate thread
7644 that runs in the background. This prevents writes to block, which is a problem
7645 especially when many hundreds of files need to be created at once. However,
7646 since the purpose of creating the files asynchronously is I<not> to block until
7647 the file is available, values before the file is available will be discarded.
7648 When disabled (the default) files are created synchronously, blocking for a
7649 short while, while the file is being written.
7651 =item B<StepSize> I<Seconds>
7653 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7654 this setting is unset and the stepsize is set to the interval in which the data
7655 is collected. Do not use this option unless you absolutely have to for some
7656 reason. Setting this option may cause problems with the C<snmp plugin>, the
7657 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7659 =item B<HeartBeat> I<Seconds>
7661 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7662 in which case the heartbeat is set to twice the B<StepSize> which should equal
7663 the interval in which data is collected. Do not set this option unless you have
7664 a very good reason to do so.
7666 =item B<RRARows> I<NumRows>
7668 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7669 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7670 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7671 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7672 week, one month, and one year.
7674 So for each timespan, it calculates how many PDPs need to be consolidated into
7675 one CDP by calculating:
7676 number of PDPs = timespan / (stepsize * rrarows)
7678 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7681 =item B<RRATimespan> I<Seconds>
7683 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7684 more then one RRA. If this option is never used, the built-in default of (3600,
7685 86400, 604800, 2678400, 31622400) is used.
7687 For more information on how RRA-sizes are calculated see B<RRARows> above.
7689 =item B<XFF> I<Factor>
7691 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7692 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7695 =item B<CollectStatistics> B<false>|B<true>
7697 When set to B<true>, various statistics about the I<rrdcached> daemon will be
7698 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
7700 Statistics are read via I<rrdcached>s socket using the STATS command.
7701 See L<rrdcached(1)> for details.
7705 =head2 Plugin C<rrdtool>
7707 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
7708 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
7709 using these settings. If you don't want to dive into the depths of RRDtool, you
7710 can safely ignore these settings.
7714 =item B<DataDir> I<Directory>
7716 Set the directory to store RRD files under. By default RRD files are generated
7717 beneath the daemon's working directory, i.e. the B<BaseDir>.
7719 =item B<CreateFilesAsync> B<false>|B<true>
7721 When enabled, new RRD files are enabled asynchronously, using a separate thread
7722 that runs in the background. This prevents writes to block, which is a problem
7723 especially when many hundreds of files need to be created at once. However,
7724 since the purpose of creating the files asynchronously is I<not> to block until
7725 the file is available, values before the file is available will be discarded.
7726 When disabled (the default) files are created synchronously, blocking for a
7727 short while, while the file is being written.
7729 =item B<StepSize> I<Seconds>
7731 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7732 this setting is unset and the stepsize is set to the interval in which the data
7733 is collected. Do not use this option unless you absolutely have to for some
7734 reason. Setting this option may cause problems with the C<snmp plugin>, the
7735 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7737 =item B<HeartBeat> I<Seconds>
7739 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7740 in which case the heartbeat is set to twice the B<StepSize> which should equal
7741 the interval in which data is collected. Do not set this option unless you have
7742 a very good reason to do so.
7744 =item B<RRARows> I<NumRows>
7746 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7747 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7748 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7749 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7750 week, one month, and one year.
7752 So for each timespan, it calculates how many PDPs need to be consolidated into
7753 one CDP by calculating:
7754 number of PDPs = timespan / (stepsize * rrarows)
7756 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7759 =item B<RRATimespan> I<Seconds>
7761 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7762 more then one RRA. If this option is never used, the built-in default of (3600,
7763 86400, 604800, 2678400, 31622400) is used.
7765 For more information on how RRA-sizes are calculated see B<RRARows> above.
7767 =item B<XFF> I<Factor>
7769 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7770 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7773 =item B<CacheFlush> I<Seconds>
7775 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
7776 it writes all values for a certain RRD-file if the oldest value is older than
7777 (or equal to) the number of seconds specified by B<CacheTimeout>.
7778 That check happens on new values arriwal. If some RRD-file is not updated
7779 anymore for some reason (the computer was shut down, the network is broken,
7780 etc.) some values may still be in the cache. If B<CacheFlush> is set, then
7781 every I<Seconds> seconds the entire cache is searched for entries older than
7782 B<CacheTimeout> + B<RandomTimeout> seconds. The entries found are written to
7783 disk. Since scanning the entire cache is kind of expensive and does nothing
7784 under normal circumstances, this value should not be too small. 900 seconds
7785 might be a good value, though setting this to 7200 seconds doesn't normally
7786 do much harm either.
7788 Defaults to 10x B<CacheTimeout>.
7789 B<CacheFlush> must be larger than or equal to B<CacheTimeout>, otherwise the
7790 above default is used.
7792 =item B<CacheTimeout> I<Seconds>
7794 If this option is set to a value greater than zero, the C<rrdtool plugin> will
7795 save values in a cache, as described above. Writing multiple values at once
7796 reduces IO-operations and thus lessens the load produced by updating the files.
7797 The trade off is that the graphs kind of "drag behind" and that more memory is
7800 =item B<WritesPerSecond> I<Updates>
7802 When collecting many statistics with collectd and the C<rrdtool> plugin, you
7803 will run serious performance problems. The B<CacheFlush> setting and the
7804 internal update queue assert that collectd continues to work just fine even
7805 under heavy load, but the system may become very unresponsive and slow. This is
7806 a problem especially if you create graphs from the RRD files on the same
7807 machine, for example using the C<graph.cgi> script included in the
7808 C<contrib/collection3/> directory.
7810 This setting is designed for very large setups. Setting this option to a value
7811 between 25 and 80 updates per second, depending on your hardware, will leave
7812 the server responsive enough to draw graphs even while all the cached values
7813 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
7814 by the B<FLUSH> command, are B<not> effected by this limit. They are still
7815 written as fast as possible, so that web frontends have up to date data when
7818 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
7819 updates per second, writing all values to disk will take approximately
7820 56E<nbsp>minutes. Together with the flushing ability that's integrated into
7821 "collection3" you'll end up with a responsive and fast system, up to date
7822 graphs and basically a "backup" of your values every hour.
7824 =item B<RandomTimeout> I<Seconds>
7826 When set, the actual timeout for each value is chosen randomly between
7827 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
7828 intention is to avoid high load situations that appear when many values timeout
7829 at the same time. This is especially a problem shortly after the daemon starts,
7830 because all values were added to the internal cache at roughly the same time.
7834 =head2 Plugin C<sensors>
7836 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
7837 that all the needed modules have to be loaded and lm_sensors has to be
7838 configured (most likely by editing F</etc/sensors.conf>. Read
7839 L<sensors.conf(5)> for details.
7841 The B<lm_sensors> homepage can be found at
7842 L<http://secure.netroedge.com/~lm78/>.
7846 =item B<SensorConfigFile> I<File>
7848 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
7849 the library's default will be used.
7851 =item B<Sensor> I<chip-bus-address/type-feature>
7853 Selects the name of the sensor which you want to collect or ignore, depending
7854 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
7855 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
7856 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
7858 See F</"IGNORELISTS"> for details.
7860 =item B<IgnoreSelected> I<true>|I<false>
7862 If no configuration if given, the B<sensors>-plugin will collect data from all
7863 sensors. This may not be practical, especially for uninteresting sensors.
7864 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
7865 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
7866 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
7867 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
7868 and all other sensors are collected.
7870 =item B<UseLabels> I<true>|I<false>
7872 Configures how sensor readings are reported. When set to I<true>, sensor
7873 readings are reported using their descriptive label (e.g. "VCore"). When set to
7874 I<false> (the default) the sensor name is used ("in0").
7878 =head2 Plugin C<sigrok>
7880 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
7881 supported by the L<sigrok|http://sigrok.org/> project.
7887 <Device "AC Voltage">
7892 <Device "Sound Level">
7893 Driver "cem-dt-885x"
7900 =item B<LogLevel> B<0-5>
7902 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
7903 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
7904 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
7905 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
7906 their level, are always submitted to I<collectd> at its INFO log level.
7908 =item E<lt>B<Device> I<Name>E<gt>
7910 A sigrok-supported device, uniquely identified by this section's options. The
7911 I<Name> is passed to I<collectd> as the I<plugin instance>.
7913 =item B<Driver> I<DriverName>
7915 The sigrok driver to use for this device.
7917 =item B<Conn> I<ConnectionSpec>
7919 If the device cannot be auto-discovered, or more than one might be discovered
7920 by the driver, I<ConnectionSpec> specifies the connection string to the device.
7921 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
7922 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
7923 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
7924 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
7926 =item B<SerialComm> I<SerialSpec>
7928 For serial devices with non-standard port settings, this option can be used
7929 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
7930 This should not be necessary; drivers know how to communicate with devices they
7933 =item B<MinimumInterval> I<Seconds>
7935 Specifies the minimum time between measurement dispatches to I<collectd>, in
7936 seconds. Since some I<sigrok> supported devices can acquire measurements many
7937 times per second, it may be necessary to throttle these. For example, the
7938 I<RRD plugin> cannot process writes more than once per second.
7940 The default B<MinimumInterval> is B<0>, meaning measurements received from the
7941 device are always dispatched to I<collectd>. When throttled, unused
7942 measurements are discarded.
7946 =head2 Plugin C<smart>
7948 The C<smart> plugin collects SMART information from physical
7949 disks. Values collectd include temperature, power cycle count, poweron
7950 time and bad sectors. Also, all SMART attributes are collected along
7951 with the normalized current value, the worst value, the threshold and
7952 a human readable value.
7954 Using the following two options you can ignore some disks or configure the
7955 collection only of specific disks.
7959 =item B<Disk> I<Name>
7961 Select the disk I<Name>. Whether it is collected or ignored depends on the
7962 B<IgnoreSelected> setting, see below. As with other plugins that use the
7963 daemon's ignorelist functionality, a string that starts and ends with a slash
7964 is interpreted as a regular expression. Examples:
7969 See F</"IGNORELISTS"> for details.
7971 =item B<IgnoreSelected> B<true>|B<false>
7973 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
7974 statements, are ignored or if all other disks are ignored. The behavior
7975 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
7976 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
7977 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
7978 is set to B<true>, all disks are collected B<except> the ones matched.
7980 =item B<IgnoreSleepMode> B<true>|B<false>
7982 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
7983 This option disables the sleep mode check and allows the plugin to collect data
7984 from these disks anyway. This is useful in cases where libatasmart mistakenly
7985 reports disks as asleep because it has not been updated to incorporate support
7986 for newer idle states in the ATA spec.
7988 =item B<UseSerial> B<true>|B<false>
7990 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
7991 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
7992 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
7993 storing data. This ensures that the data for a given disk will be kept together
7994 even if the kernel name changes.
7998 =head2 Plugin C<snmp>
8000 Since the configuration of the C<snmp plugin> is a little more complicated than
8001 other plugins, its documentation has been moved to an own manpage,
8002 L<collectd-snmp(5)>. Please see there for details.
8004 =head2 Plugin C<snmp_agent>
8006 The I<snmp_agent> plugin is an AgentX subagent that receives and handles queries
8007 from SNMP master agent and returns the data collected by read plugins.
8008 The I<snmp_agent> plugin handles requests only for OIDs specified in
8009 configuration file. To handle SNMP queries the plugin gets data from collectd
8010 and translates requested values from collectd's internal format to SNMP format.
8011 This plugin is a generic plugin and cannot work without configuration.
8012 For more details on AgentX subagent see
8013 <http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/>
8018 <Data "memAvailReal">
8020 #PluginInstance "some"
8023 OIDs "1.3.6.1.4.1.2021.4.6.0"
8026 IndexOID "IF-MIB::ifIndex"
8027 SizeOID "IF-MIB::ifNumber"
8030 Source "PluginInstance"
8033 OIDs "IF-MIB::ifDescr"
8039 OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
8042 <Table "CPUAffinityTable">
8045 Source "PluginInstance"
8048 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhAffinityDomainName"
8053 Source "TypeInstance"
8054 Regex "^vcpu_([0-9]{1,3})-cpu_[0-9]{1,3}$"
8057 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhVCPUIndex"
8062 Source "TypeInstance"
8063 Regex "^vcpu_[0-9]{1,3}-cpu_([0-9]{1,3})$"
8066 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhCPUIndex"
8068 <Data "CPUAffinity">
8071 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhCPUAffinity"
8076 There are two types of blocks that can be contained in the
8077 C<E<lt>PluginE<nbsp> snmp_agentE<gt>> block: B<Data> and B<Table>:
8079 =head3 B<Data> block
8081 The B<Data> block defines a list OIDs that are to be handled. This block can
8082 define scalar or table OIDs. If B<Data> block is defined inside of B<Table>
8083 block it reperesents table OIDs.
8084 The following options can be set:
8088 =item B<IndexKey> block
8090 B<IndexKey> block contains all data needed for proper index build of snmp table.
8092 one table B<Data> block has B<IndexKey> block present then multiple key index is
8093 built. If B<Data> block defines scalar data type B<IndexKey> has no effect and can
8098 =item B<Source> I<String>
8100 B<Source> can be set to one of the following values: "Hostname", "Plugin",
8101 "PluginInstance", "Type", "TypeInstance". This value indicates which field of
8102 corresponding collectd metric is taken as a SNMP table index.
8104 =item B<Regex> I<String>
8106 B<Regex> option can also be used to parse strings or numbers out of
8107 specific field. For example: type-instance field which is "vcpu1-cpu2" can be
8108 parsed into two numeric fields CPU = 2 and VCPU = 1 and can be later used
8111 =item B<Group> I<Number>
8113 B<Group> number can be specified in case groups are used in regex.
8117 =item B<Plugin> I<String>
8119 Read plugin name whose collected data will be mapped to specified OIDs.
8121 =item B<PluginInstance> I<String>
8123 Read plugin instance whose collected data will be mapped to specified OIDs.
8124 The field is optional and by default there is no plugin instance check.
8125 Allowed only if B<Data> block defines scalar data type.
8127 =item B<Type> I<String>
8129 Collectd's type that is to be used for specified OID, e.E<nbsp>g. "if_octets"
8130 for example. The types are read from the B<TypesDB> (see L<collectd.conf(5)>).
8132 =item B<TypeInstance> I<String>
8134 Collectd's type-instance that is to be used for specified OID.
8136 =item B<OIDs> I<OID> [I<OID> ...]
8138 Configures the OIDs to be handled by I<snmp_agent> plugin. Values for these OIDs
8139 are taken from collectd data type specified by B<Plugin>, B<PluginInstance>,
8140 B<Type>, B<TypeInstance> fields of this B<Data> block. Number of the OIDs
8141 configured should correspond to number of values in specified B<Type>.
8142 For example two OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" can be mapped to
8143 "rx" and "tx" values of "if_octets" type.
8145 =item B<Scale> I<Value>
8147 The values taken from collectd are multiplied by I<Value>. The field is optional
8148 and the default is B<1.0>.
8150 =item B<Shift> I<Value>
8152 I<Value> is added to values from collectd after they have been multiplied by
8153 B<Scale> value. The field is optional and the default value is B<0.0>.
8157 =head3 The B<Table> block
8159 The B<Table> block defines a collection of B<Data> blocks that belong to one
8160 snmp table. In addition to multiple B<Data> blocks the following options can be
8165 =item B<IndexOID> I<OID>
8167 OID that is handled by the plugin and is mapped to numerical index value that is
8168 generated by the plugin for each table record.
8170 =item B<SizeOID> I<OID>
8172 OID that is handled by the plugin. Returned value is the number of records in
8173 the table. The field is optional.
8177 =head2 Plugin C<statsd>
8179 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
8180 protocol and dispatches rates or other aggregates of these numbers
8183 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
8184 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
8185 C<objects> respectively.
8187 The following configuration options are valid:
8191 =item B<Host> I<Host>
8193 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
8194 "any" address, i.e. accept packets sent to any of the hosts addresses.
8196 =item B<Port> I<Port>
8198 UDP port to listen to. This can be either a service name or a port number.
8199 Defaults to C<8125>.
8201 =item B<DeleteCounters> B<false>|B<true>
8203 =item B<DeleteTimers> B<false>|B<true>
8205 =item B<DeleteGauges> B<false>|B<true>
8207 =item B<DeleteSets> B<false>|B<true>
8209 These options control what happens if metrics are not updated in an interval.
8210 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
8211 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
8212 are unchanged. If set to B<True>, the such metrics are not dispatched and
8213 removed from the internal cache.
8215 =item B<CounterSum> B<false>|B<true>
8217 When enabled, creates a C<count> metric which reports the change since the last
8218 read. This option primarily exists for compatibility with the I<statsd>
8219 implementation by Etsy.
8221 =item B<TimerPercentile> I<Percent>
8223 Calculate and dispatch the configured percentile, i.e. compute the latency, so
8224 that I<Percent> of all reported timers are smaller than or equal to the
8225 computed latency. This is useful for cutting off the long tail latency, as it's
8226 often done in I<Service Level Agreements> (SLAs).
8228 Different percentiles can be calculated by setting this option several times.
8229 If none are specified, no percentiles are calculated / dispatched.
8231 =item B<TimerLower> B<false>|B<true>
8233 =item B<TimerUpper> B<false>|B<true>
8235 =item B<TimerSum> B<false>|B<true>
8237 =item B<TimerCount> B<false>|B<true>
8239 Calculate and dispatch various values out of I<Timer> metrics received during
8240 an interval. If set to B<False>, the default, these values aren't calculated /
8243 Please note what reported timer values less than 0.001 are ignored in all B<Timer*> reports.
8247 =head2 Plugin C<swap>
8249 The I<Swap plugin> collects information about used and available swap space. On
8250 I<Linux> and I<Solaris>, the following options are available:
8254 =item B<ReportByDevice> B<false>|B<true>
8256 Configures how to report physical swap devices. If set to B<false> (the
8257 default), the summary over all swap devices is reported only, i.e. the globally
8258 used and available space over all devices. If B<true> is configured, the used
8259 and available space of each device will be reported separately.
8261 This option is only available if the I<Swap plugin> can read C</proc/swaps>
8262 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
8264 =item B<ReportBytes> B<false>|B<true>
8266 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
8267 I<swap I/O> is reported in pages. This option is available under Linux only.
8269 =item B<ValuesAbsolute> B<true>|B<false>
8271 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
8272 available and used. Defaults to B<true>.
8274 =item B<ValuesPercentage> B<false>|B<true>
8276 Enables or disables reporting of relative swap metrics, i.e. I<percent>
8277 available and free. Defaults to B<false>.
8279 This is useful for deploying I<collectd> in a heterogeneous environment, where
8280 swap sizes differ and you want to specify generic thresholds or similar.
8282 =item B<ReportIO> B<true>|B<false>
8284 Enables or disables reporting swap IO. Defaults to B<true>.
8286 This is useful for the cases when swap IO is not neccessary, is not available,
8291 =head2 Plugin C<sysevent>
8293 The I<sysevent> plugin monitors rsyslog messages.
8298 Listen "192.168.0.2" "6666"
8304 rsyslog should be configured such that it sends data to the IP and port you
8305 include in the plugin configuration. For example, given the configuration
8306 above, something like this would be set in /etc/rsyslog.conf:
8308 if $programname != 'collectd' then
8309 *.* @192.168.0.2:6666
8311 This plugin is designed to consume JSON rsyslog data, so a more complete
8312 rsyslog configuration would look like so (where we define a JSON template
8313 and use it when sending data to our IP and port):
8315 $template ls_json,"{%timestamp:::date-rfc3339,jsonf:@timestamp%, \
8316 %source:::jsonf:@source_host%,\"@source\":\"syslog://%fromhost-ip:::json%\", \
8317 \"@message\":\"%timestamp% %app-name%:%msg:::json%\",\"@fields\": \
8318 {%syslogfacility-text:::jsonf:facility%,%syslogseverity:::jsonf:severity-num%, \
8319 %syslogseverity-text:::jsonf:severity%,%programname:::jsonf:program%, \
8320 %procid:::jsonf:processid%}}"
8322 if $programname != 'collectd' then
8323 *.* @192.168.0.2:6666;ls_json
8325 Please note that these rsyslog.conf examples are *not* complete, as rsyslog
8326 requires more than these options in the configuration file. These examples
8327 are meant to demonstration the proper remote logging and JSON format syntax.
8333 =item B<Listen> I<host> I<port>
8335 Listen on this IP on this port for incoming rsyslog messages.
8337 =item B<BufferSize> I<length>
8339 Maximum allowed size for incoming rsyslog messages. Messages that exceed
8340 this number will be truncated to this size. Default is 4096 bytes.
8342 =item B<BufferLength> I<length>
8344 Maximum number of rsyslog events that can be stored in plugin's ring buffer.
8345 By default, this is set to 10. Once an event has been read, its location
8346 becomes available for storing a new event.
8348 =item B<RegexFilter> I<regex>
8350 Enumerate a regex filter to apply to all incoming rsyslog messages. If a
8351 message matches this filter, it will be published.
8355 =head2 Plugin C<syslog>
8359 =item B<LogLevel> B<debug|info|notice|warning|err>
8361 Sets the log-level. If, for example, set to B<notice>, then all events with
8362 severity B<notice>, B<warning>, or B<err> will be submitted to the
8365 Please note that B<debug> is only available if collectd has been compiled with
8368 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
8370 Controls which notifications should be sent to syslog. The default behaviour is
8371 not to send any. Less severe notifications always imply logging more severe
8372 notifications: Setting this to B<OKAY> means all notifications will be sent to
8373 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
8374 notifications but will dismiss B<OKAY> notifications. Setting this option to
8375 B<FAILURE> will only send failures to syslog.
8379 =head2 Plugin C<table>
8381 The C<table plugin> provides generic means to parse tabular data and dispatch
8382 user specified values. Values are selected based on column numbers. For
8383 example, this plugin may be used to get values from the Linux L<proc(5)>
8384 filesystem or CSV (comma separated values) files.
8387 <Table "/proc/slabinfo">
8393 InstancePrefix "active_objs"
8399 InstancePrefix "objperslab"
8406 The configuration consists of one or more B<Table> blocks, each of which
8407 configures one file to parse. Within each B<Table> block, there are one or
8408 more B<Result> blocks, which configure which data to select and how to
8411 The following options are available inside a B<Table> block:
8415 =item B<Plugin> I<Plugin>
8417 If specified, I<Plugin> is used as the plugin name when submitting values.
8418 Defaults to B<table>.
8420 =item B<Instance> I<instance>
8422 If specified, I<instance> is used as the plugin instance. If omitted, the
8423 filename of the table is used instead, with all special characters replaced
8424 with an underscore (C<_>).
8426 =item B<Separator> I<string>
8428 Any character of I<string> is interpreted as a delimiter between the different
8429 columns of the table. A sequence of two or more contiguous delimiters in the
8430 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
8431 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
8432 of a table - see its documentation for more details. This option is mandatory.
8434 A horizontal tab, newline and carriage return may be specified by C<\\t>,
8435 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
8436 required because of collectd's config parsing.
8440 The following options are available inside a B<Result> block:
8444 =item B<Type> I<type>
8446 Sets the type used to dispatch the values to the daemon. Detailed information
8447 about types and their configuration can be found in L<types.db(5)>. This
8448 option is mandatory.
8450 =item B<InstancePrefix> I<prefix>
8452 If specified, prepend I<prefix> to the type instance. If omitted, only the
8453 B<InstancesFrom> option is considered for the type instance.
8455 =item B<InstancesFrom> I<column0> [I<column1> ...]
8457 If specified, the content of the given columns (identified by the column
8458 number starting at zero) will be used to create the type instance for each
8459 row. Multiple values (and the instance prefix) will be joined together with
8460 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
8461 option is considered for the type instance.
8463 The plugin itself does not check whether or not all built instances are
8464 different. It’s your responsibility to assure that each is unique. This is
8465 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
8466 sure that the table only contains one row.
8468 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
8471 =item B<ValuesFrom> I<column0> [I<column1> ...]
8473 Specifies the columns (identified by the column numbers starting at zero)
8474 whose content is used as the actual data for the data sets that are dispatched
8475 to the daemon. How many such columns you need is determined by the B<Type>
8476 setting above. If you specify too many or not enough columns, the plugin will
8477 complain about that and no data will be submitted to the daemon. The plugin
8478 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
8479 respectively, so anything supported by those functions is supported by the
8480 plugin as well. This option is mandatory.
8484 =head2 Plugin C<tail>
8486 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
8487 each line and dispatches found values. What is matched can be configured by the
8488 user using (extended) regular expressions, as described in L<regex(7)>.
8491 <File "/var/log/exim4/mainlog">
8496 Regex "S=([1-9][0-9]*)"
8502 Regex "\\<R=local_user\\>"
8503 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
8506 Instance "local_user"
8509 Regex "l=([0-9]*\\.[0-9]*)"
8510 <DSType "Distribution">
8513 #BucketType "bucket"
8521 The config consists of one or more B<File> blocks, each of which configures one
8522 logfile to parse. Within each B<File> block, there are one or more B<Match>
8523 blocks, which configure a regular expression to search for.
8525 The B<Plugin> and B<Instance> options in the B<File> block may be used to set
8526 the plugin name and instance respectively. So in the above example the plugin name
8527 C<mail-exim> would be used.
8529 These options are applied for all B<Match> blocks that B<follow> it, until the
8530 next B<Plugin> or B<Instance> option. This way you can extract several plugin
8531 instances from one logfile, handy when parsing syslog and the like.
8533 The B<Interval> option allows you to define the length of time between reads. If
8534 this is not set, the default Interval will be used.
8536 Each B<Match> block has the following options to describe how the match should
8541 =item B<Regex> I<regex>
8543 Sets the regular expression to use for matching against a line. The first
8544 subexpression has to match something that can be turned into a number by
8545 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
8546 below. Because B<extended> regular expressions are used, you do not need to use
8547 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
8548 collectd's config parsing you need to escape backslashes, though. So if you
8549 want to match literal parentheses you need to do the following:
8551 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
8553 =item B<ExcludeRegex> I<regex>
8555 Sets an optional regular expression to use for excluding lines from the match.
8556 An example which excludes all connections from localhost from the match:
8558 ExcludeRegex "127\\.0\\.0\\.1"
8560 =item B<DSType> I<Type>
8562 Sets how the values are cumulated. I<Type> is one of:
8566 =item B<GaugeAverage>
8568 Calculate the average of all values matched during the interval.
8572 Report the smallest value matched during the interval.
8576 Report the greatest value matched during the interval.
8580 Report the last value matched during the interval.
8582 =item B<GaugePersist>
8584 Report the last matching value. The metric is I<not> reset to C<NaN> at the end
8585 of an interval. It is continuously reported until another value is matched.
8586 This is intended for cases in which only state changes are reported, for
8587 example a thermometer that only reports the temperature when it changes.
8593 =item B<AbsoluteSet>
8595 The matched number is a counter. Simply I<sets> the internal counter to this
8596 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
8604 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
8605 matched number may be negative, which will effectively subtract from the
8614 Increase the internal counter by one. These B<DSType> are the only ones that do
8615 not use the matched subexpression, but simply count the number of matched
8616 lines. Thus, you may use a regular expression without submatch in this case.
8618 B<GaugeInc> is reset to I<zero> after every read, unlike other B<Gauge*>
8619 metrics which are reset to C<NaN>.
8621 =item B<Distribution>
8623 Type to do calculations based on the distribution of values, primarily
8624 calculating percentiles. This is primarily geared towards latency, but can be
8625 used for other metrics as well. The range of values tracked with this setting
8626 must be in the range (0–2^34) and can be fractional. Please note that neither
8627 zero nor 2^34 are inclusive bounds, i.e. zero I<cannot> be handled by a
8630 This option must be used together with the B<Percentile> and/or B<Bucket>
8635 <DSType "Distribution">
8643 =item B<Percentile> I<Percent>
8645 Calculate and dispatch the configured percentile, i.e. compute the value, so
8646 that I<Percent> of all matched values are smaller than or equal to the computed
8649 Metrics are reported with the I<type> B<Type> (the value of the above option)
8650 and the I<type instance> C<[E<lt>InstanceE<gt>-]E<lt>PercentE<gt>>.
8652 This option may be repeated to calculate more than one percentile.
8654 =item B<Bucket> I<lower_bound> I<upper_bound>
8656 Export the number of values (a C<DERIVE>) falling within the given range. Both,
8657 I<lower_bound> and I<upper_bound> may be a fractional number, such as B<0.5>.
8658 Each B<Bucket> option specifies an interval C<(I<lower_bound>,
8659 I<upper_bound>]>, i.e. the range I<excludes> the lower bound and I<includes>
8660 the upper bound. I<lower_bound> and I<upper_bound> may be zero, meaning no
8663 To export the entire (0–inf) range without overlap, use the upper bound of the
8664 previous range as the lower bound of the following range. In other words, use
8665 the following schema:
8675 Metrics are reported with the I<type> set by B<BucketType> option (C<bucket>
8676 by default) and the I<type instance>
8677 C<E<lt>TypeE<gt>[-E<lt>InstanceE<gt>]-E<lt>lower_boundE<gt>_E<lt>upper_boundE<gt>>.
8679 This option may be repeated to calculate more than one rate.
8681 =item B<BucketType> I<Type>
8683 Sets the type used to dispatch B<Bucket> metrics.
8684 Optional, by default C<bucket> will be used.
8690 The B<Gauge*> and B<Distribution> types interpret the submatch as a floating
8691 point number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types
8692 interpret the submatch as an unsigned integer using L<strtoull(3)>. The
8693 B<Derive*> types interpret the submatch as a signed integer using
8694 L<strtoll(3)>. B<CounterInc>, B<DeriveInc> and B<GaugeInc> do not use the
8695 submatch at all and it may be omitted in this case.
8697 The B<Gauge*> types, unless noted otherwise, are reset to C<NaN> after being
8698 reported. In other words, B<GaugeAverage> reports the average of all values
8699 matched since the last metric was reported (or C<NaN> if there was no match).
8701 =item B<Type> I<Type>
8703 Sets the type used to dispatch this value. Detailed information about types and
8704 their configuration can be found in L<types.db(5)>.
8706 =item B<Instance> I<TypeInstance>
8708 This optional setting sets the type instance to use.
8712 =head2 Plugin C<tail_csv>
8714 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
8715 written by I<Snort>.
8720 <Metric "snort-dropped">
8725 <File "/var/log/snort/snort.stats">
8729 Collect "snort-dropped"
8734 The configuration consists of one or more B<Metric> blocks that define an index
8735 into the line of the CSV file and how this value is mapped to I<collectd's>
8736 internal representation. These are followed by one or more B<Instance> blocks
8737 which configure which file to read, in which interval and which metrics to
8742 =item E<lt>B<Metric> I<Name>E<gt>
8744 The B<Metric> block configures a new metric to be extracted from the statistics
8745 file and how it is mapped on I<collectd's> data model. The string I<Name> is
8746 only used inside the B<Instance> blocks to refer to this block, so you can use
8747 one B<Metric> block for multiple CSV files.
8751 =item B<Type> I<Type>
8753 Configures which I<Type> to use when dispatching this metric. Types are defined
8754 in the L<types.db(5)> file, see the appropriate manual page for more
8755 information on specifying types. Only types with a single I<data source> are
8756 supported by the I<tail_csv plugin>. The information whether the value is an
8757 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
8758 I<Type's> definition.
8760 =item B<Instance> I<TypeInstance>
8762 If set, I<TypeInstance> is used to populate the type instance field of the
8763 created value lists. Otherwise, no type instance is used.
8765 =item B<ValueFrom> I<Index>
8767 Configure to read the value from the field with the zero-based index I<Index>.
8768 If the value is parsed as signed integer, unsigned integer or double depends on
8769 the B<Type> setting, see above.
8773 =item E<lt>B<File> I<Path>E<gt>
8775 Each B<File> block represents one CSV file to read. There must be at least one
8776 I<File> block but there can be multiple if you have multiple CSV files.
8780 =item B<Plugin> I<Plugin>
8782 Use I<Plugin> as the plugin name when submitting values.
8783 Defaults to C<tail_csv>.
8785 =item B<Instance> I<PluginInstance>
8787 Sets the I<plugin instance> used when dispatching the values.
8789 =item B<Collect> I<Metric>
8791 Specifies which I<Metric> to collect. This option must be specified at least
8792 once, and you can use this option multiple times to specify more than one
8793 metric to be extracted from this statistic file.
8795 =item B<Interval> I<Seconds>
8797 Configures the interval in which to read values from this instance / file.
8798 Defaults to the plugin's default interval.
8800 =item B<TimeFrom> I<Index>
8802 Rather than using the local time when dispatching a value, read the timestamp
8803 from the field with the zero-based index I<Index>. The value is interpreted as
8804 seconds since epoch. The value is parsed as a double and may be factional.
8810 =head2 Plugin C<teamspeak2>
8812 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
8813 polls interesting global and virtual server data. The plugin can query only one
8814 physical server but unlimited virtual servers. You can use the following
8815 options to configure it:
8819 =item B<Host> I<hostname/ip>
8821 The hostname or ip which identifies the physical server.
8824 =item B<Port> I<port>
8826 The query port of the physical server. This needs to be a string.
8829 =item B<Server> I<port>
8831 This option has to be added once for every virtual server the plugin should
8832 query. If you want to query the virtual server on port 8767 this is what the
8833 option would look like:
8837 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
8838 use quotes around it! If no such statement is given only global information
8843 =head2 Plugin C<ted>
8845 The I<TED> plugin connects to a device of "The Energy Detective", a device to
8846 measure power consumption. These devices are usually connected to a serial
8847 (RS232) or USB port. The plugin opens a configured device and tries to read the
8848 current energy readings. For more information on TED, visit
8849 L<http://www.theenergydetective.com/>.
8851 Available configuration options:
8855 =item B<Device> I<Path>
8857 Path to the device on which TED is connected. collectd will need read and write
8858 permissions on that file.
8860 Default: B</dev/ttyUSB0>
8862 =item B<Retries> I<Num>
8864 Apparently reading from TED is not that reliable. You can therefore configure a
8865 number of retries here. You only configure the I<retries> here, to if you
8866 specify zero, one reading will be performed (but no retries if that fails); if
8867 you specify three, a maximum of four readings are performed. Negative values
8874 =head2 Plugin C<tcpconns>
8876 The C<tcpconns plugin> counts the number of currently established TCP
8877 connections based on the local port and/or the remote port. Since there may be
8878 a lot of connections the default if to count all connections with a local port,
8879 for which a listening socket is opened. You can use the following options to
8880 fine-tune the ports you are interested in:
8884 =item B<ListeningPorts> I<true>|I<false>
8886 If this option is set to I<true>, statistics for all local ports for which a
8887 listening socket exists are collected. The default depends on B<LocalPort> and
8888 B<RemotePort> (see below): If no port at all is specifically selected, the
8889 default is to collect listening ports. If specific ports (no matter if local or
8890 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
8891 the selected ports will be collected unless this option is set to I<true>
8894 =item B<LocalPort> I<Port>
8896 Count the connections to a specific local port. This can be used to see how
8897 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
8898 You have to specify the port in numeric form, so for the mailserver example
8899 you'd need to set B<25>.
8901 =item B<RemotePort> I<Port>
8903 Count the connections to a specific remote port. This is useful to see how
8904 much a remote service is used. This is most useful if you want to know how many
8905 connections a local service has opened to remote services, e.E<nbsp>g. how many
8906 connections a mail server or news server has to other mail or news servers, or
8907 how many connections a web proxy holds to web servers. You have to give the
8908 port in numeric form.
8910 =item B<AllPortsSummary> I<true>|I<false>
8912 If this option is set to I<true> a summary of statistics from all connections
8913 are collected. This option defaults to I<false>.
8917 =head2 Plugin C<thermal>
8921 =item B<ForceUseProcfs> I<true>|I<false>
8923 By default, the I<Thermal plugin> tries to read the statistics from the Linux
8924 C<sysfs> interface. If that is not available, the plugin falls back to the
8925 C<procfs> interface. By setting this option to I<true>, you can force the
8926 plugin to use the latter. This option defaults to I<false>.
8928 =item B<Device> I<Device>
8930 Selects the name of the thermal device that you want to collect or ignore,
8931 depending on the value of the B<IgnoreSelected> option. This option may be
8932 used multiple times to specify a list of devices.
8934 See F</"IGNORELISTS"> for details.
8936 =item B<IgnoreSelected> I<true>|I<false>
8938 Invert the selection: If set to true, all devices B<except> the ones that
8939 match the device names specified by the B<Device> option are collected. By
8940 default only selected devices are collected if a selection is made. If no
8941 selection is configured at all, B<all> devices are selected.
8945 =head2 Plugin C<threshold>
8947 The I<Threshold plugin> checks values collected or received by I<collectd>
8948 against a configurable I<threshold> and issues I<notifications> if values are
8951 Documentation for this plugin is available in the L<collectd-threshold(5)>
8954 =head2 Plugin C<tokyotyrant>
8956 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
8957 couple metrics: number of records, and database size on disk.
8961 =item B<Host> I<Hostname/IP>
8963 The hostname or IP which identifies the server.
8964 Default: B<127.0.0.1>
8966 =item B<Port> I<Service/Port>
8968 The query port of the server. This needs to be a string, even if the port is
8969 given in its numeric form.
8974 =head2 Plugin C<turbostat>
8976 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
8977 Intel processors by using I<Model Specific Registers>.
8981 =item B<CoreCstates> I<Bitmask(Integer)>
8983 Bit mask of the list of core C-states supported by the processor.
8984 This option should only be used if the automated detection fails.
8985 Default value extracted from the CPU model and family.
8987 Currently supported C-states (by this plugin): 3, 6, 7
8991 All states (3, 6 and 7):
8992 (1<<3) + (1<<6) + (1<<7) = 392
8994 =item B<PackageCstates> I<Bitmask(Integer)>
8996 Bit mask of the list of packages C-states supported by the processor. This
8997 option should only be used if the automated detection fails. Default value
8998 extracted from the CPU model and family.
9000 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
9004 States 2, 3, 6 and 7:
9005 (1<<2) + (1<<3) + (1<<6) + (1<<7) = 396
9007 =item B<SystemManagementInterrupt> I<true>|I<false>
9009 Boolean enabling the collection of the I/O System-Management Interrupt counter.
9010 This option should only be used if the automated detection fails or if you want
9011 to disable this feature.
9013 =item B<DigitalTemperatureSensor> I<true>|I<false>
9015 Boolean enabling the collection of the temperature of each core. This option
9016 should only be used if the automated detection fails or if you want to disable
9019 =item B<TCCActivationTemp> I<Temperature>
9021 I<Thermal Control Circuit Activation Temperature> of the installed CPU. This
9022 temperature is used when collecting the temperature of cores or packages. This
9023 option should only be used if the automated detection fails. Default value
9024 extracted from B<MSR_IA32_TEMPERATURE_TARGET>.
9026 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
9028 Bit mask of the list of elements to be thermally monitored. This option should
9029 only be used if the automated detection fails or if you want to disable some
9030 collections. The different bits of this bit mask accepted by this plugin are:
9034 =item 0 ('1'): Package
9038 =item 2 ('4'): Cores
9040 =item 3 ('8'): Embedded graphic device
9044 =item B<LogicalCoreNames> I<true>|I<false>
9046 Boolean enabling the use of logical core numbering for per core statistics.
9047 When enabled, C<cpuE<lt>nE<gt>> is used as plugin instance, where I<n> is a
9048 dynamic number assigned by the kernel. Otherwise, C<coreE<lt>nE<gt>> is used
9049 if there is only one package and C<pkgE<lt>nE<gt>-coreE<lt>mE<gt>> if there is
9050 more than one, where I<n> is the n-th core of package I<m>.
9052 =item B<RestoreAffinityPolicy> I<AllCPUs>|I<Restore>
9054 Reading data from CPU has side-effect: collectd process's CPU affinity mask
9055 changes. After reading data is completed, affinity mask needs to be restored.
9056 This option allows to set restore policy.
9058 B<AllCPUs> (the default): Restore the affinity by setting affinity to any/all
9061 B<Restore>: Save affinity using sched_getaffinity() before reading data and
9064 On some systems, sched_getaffinity() will fail due to inconsistency of the CPU
9065 set size between userspace and kernel. In these cases plugin will detect the
9066 unsuccessful call and fail with an error, preventing data collection.
9067 Most of configurations does not need to save affinity as Collectd process is
9068 allowed to run on any/all available CPUs.
9070 If you need to save and restore affinity and get errors like 'Unable to save
9071 the CPU affinity', setting 'possible_cpus' kernel boot option may also help.
9073 See following links for details:
9075 L<https://github.com/collectd/collectd/issues/1593>
9076 L<https://sourceware.org/bugzilla/show_bug.cgi?id=15630>
9077 L<https://bugzilla.kernel.org/show_bug.cgi?id=151821>
9081 =head2 Plugin C<unixsock>
9085 =item B<SocketFile> I<Path>
9087 Sets the socket-file which is to be created.
9089 =item B<SocketGroup> I<Group>
9091 If running as root change the group of the UNIX-socket after it has been
9092 created. Defaults to B<collectd>.
9094 =item B<SocketPerms> I<Permissions>
9096 Change the file permissions of the UNIX-socket after it has been created. The
9097 permissions must be given as a numeric, octal value as you would pass to
9098 L<chmod(1)>. Defaults to B<0770>.
9100 =item B<DeleteSocket> B<false>|B<true>
9102 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
9103 with the given name already exists. If I<collectd> crashes a socket file may be
9104 left over, preventing the daemon from opening a new socket when restarted.
9105 Since this is potentially dangerous, this defaults to B<false>.
9109 =head2 Plugin C<uuid>
9111 This plugin, if loaded, causes the Hostname to be taken from the machine's
9112 UUID. The UUID is a universally unique designation for the machine, usually
9113 taken from the machine's BIOS. This is most useful if the machine is running in
9114 a virtual environment such as Xen, in which case the UUID is preserved across
9115 shutdowns and migration.
9117 The following methods are used to find the machine's UUID, in order:
9123 Check I</etc/uuid> (or I<UUIDFile>).
9127 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
9132 Check for UUID from C<dmidecode> / SMBIOS.
9136 Check for UUID from Xen hypervisor.
9140 If no UUID can be found then the hostname is not modified.
9144 =item B<UUIDFile> I<Path>
9146 Take the UUID from the given file (default I</etc/uuid>).
9150 =head2 Plugin C<varnish>
9152 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
9153 It collects a subset of the values displayed by L<varnishstat(1)>, and
9154 organizes them in categories which can be enabled or disabled. Currently only
9155 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
9156 meaning of each metric can be found in L<varnish-counters(7)>.
9161 <Instance "example">
9165 CollectConnections true
9166 CollectDirectorDNS false
9170 CollectObjects false
9172 CollectSession false
9182 CollectWorkers false
9184 CollectMempool false
9185 CollectManagement false
9192 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
9193 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
9194 will collectd statistics from the default "varnishd" instance (this should work
9195 fine in most cases).
9197 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
9201 =item B<CollectBackend> B<true>|B<false>
9203 Back-end connection statistics, such as successful, reused,
9204 and closed connections. True by default.
9206 =item B<CollectBan> B<true>|B<false>
9208 Statistics about ban operations, such as number of bans added, retired, and
9209 number of objects tested against ban operations. Only available with Varnish
9210 3.x and above. False by default.
9212 =item B<CollectCache> B<true>|B<false>
9214 Cache hits and misses. True by default.
9216 =item B<CollectConnections> B<true>|B<false>
9218 Number of client connections received, accepted and dropped. True by default.
9220 =item B<CollectDirectorDNS> B<true>|B<false>
9222 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
9225 =item B<CollectESI> B<true>|B<false>
9227 Edge Side Includes (ESI) parse statistics. False by default.
9229 =item B<CollectFetch> B<true>|B<false>
9231 Statistics about fetches (HTTP requests sent to the backend). False by default.
9233 =item B<CollectHCB> B<true>|B<false>
9235 Inserts and look-ups in the crit bit tree based hash. Look-ups are
9236 divided into locked and unlocked look-ups. False by default.
9238 =item B<CollectObjects> B<true>|B<false>
9240 Statistics on cached objects: number of objects expired, nuked (prematurely
9241 expired), saved, moved, etc. False by default.
9243 =item B<CollectPurge> B<true>|B<false>
9245 Statistics about purge operations, such as number of purges added, retired, and
9246 number of objects tested against purge operations. Only available with Varnish
9247 2.x. False by default.
9249 =item B<CollectSession> B<true>|B<false>
9251 Client session statistics. Number of past and current sessions, session herd and
9252 linger counters, etc. False by default. Note that if using Varnish 4.x, some
9253 metrics found in the Connections and Threads sections with previous versions of
9254 Varnish have been moved here.
9256 =item B<CollectSHM> B<true>|B<false>
9258 Statistics about the shared memory log, a memory region to store
9259 log messages which is flushed to disk when full. True by default.
9261 =item B<CollectSMA> B<true>|B<false>
9263 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
9264 component is Solaris specific. Note: SMA, SMF and MSE share counters, enable
9265 only the one used by the Varnish instance. Only available with Varnish 2.x.
9268 =item B<CollectSMS> B<true>|B<false>
9270 synth (synthetic content) storage statistics. This storage
9271 component is used internally only. False by default.
9273 =item B<CollectSM> B<true>|B<false>
9275 file (memory mapped file) storage statistics. Only available with Varnish 2.x.,
9276 in varnish 4.x. use CollectSMF.
9279 =item B<CollectStruct> B<true>|B<false>
9281 Current varnish internal state statistics. Number of current sessions, objects
9282 in cache store, open connections to backends (with Varnish 2.x), etc. False by
9285 =item B<CollectTotals> B<true>|B<false>
9287 Collects overview counters, such as the number of sessions created,
9288 the number of requests and bytes transferred. False by default.
9290 =item B<CollectUptime> B<true>|B<false>
9292 Varnish uptime. Only available with Varnish 3.x and above. False by default.
9294 =item B<CollectVCL> B<true>|B<false>
9296 Number of total (available + discarded) VCL (config files). False by default.
9298 =item B<CollectVSM> B<true>|B<false>
9300 Collect statistics about Varnish's shared memory usage (used by the logging and
9301 statistics subsystems). Only available with Varnish 4.x. False by default.
9303 =item B<CollectWorkers> B<true>|B<false>
9305 Collect statistics about worker threads. False by default.
9307 =item B<CollectVBE> B<true>|B<false>
9309 Backend counters. Only available with Varnish 4.x. False by default.
9311 =item B<CollectSMF> B<true>|B<false>
9313 file (memory mapped file) storage statistics. Only available with Varnish 4.x.
9314 Note: SMA, SMF and MSE share counters, enable only the one used by the Varnish
9315 instance. Used to be called SM in Varnish 2.x. False by default.
9317 =item B<CollectManagement> B<true>|B<false>
9319 Management process counters. Only available with Varnish 4.x. False by default.
9321 =item B<CollectLock> B<true>|B<false>
9323 Lock counters. Only available with Varnish 4.x. False by default.
9325 =item B<CollectMempool> B<true>|B<false>
9327 Memory pool counters. Only available with Varnish 4.x. False by default.
9329 =item B<CollectMSE> B<true>|B<false>
9331 Varnish Massive Storage Engine 2.0 (MSE2) is an improved storage backend for
9332 Varnish, replacing the traditional malloc and file storages. Only available
9333 with Varnish-Plus 4.x. Note: SMA, SMF and MSE share counters, enable only the
9334 one used by the Varnish instance. False by default.
9338 =head2 Plugin C<virt>
9340 This plugin allows CPU, disk, network load and other metrics to be collected for
9341 virtualized guests on the machine. The statistics are collected through libvirt
9342 API (L<http://libvirt.org/>). Majority of metrics can be gathered without
9343 installing any additional software on guests, especially I<collectd>, which runs
9344 only on the host system.
9346 Only I<Connection> is required.
9348 Consider the following example config:
9351 Connection "qemu:///system"
9352 HostnameFormat "hostname"
9353 InterfaceFormat "address"
9354 PluginInstanceFormat "name"
9357 It will generate the following values:
9359 node42.example.com/virt-instance-0006f26c/disk_octets-vda
9360 node42.example.com/virt-instance-0006f26c/disk_ops-vda
9361 node42.example.com/virt-instance-0006f26c/if_dropped-ca:fe:ca:fe:ca:fe
9362 node42.example.com/virt-instance-0006f26c/if_errors-ca:fe:ca:fe:ca:fe
9363 node42.example.com/virt-instance-0006f26c/if_octets-ca:fe:ca:fe:ca:fe
9364 node42.example.com/virt-instance-0006f26c/if_packets-ca:fe:ca:fe:ca:fe
9365 node42.example.com/virt-instance-0006f26c/memory-actual_balloon
9366 node42.example.com/virt-instance-0006f26c/memory-available
9367 node42.example.com/virt-instance-0006f26c/memory-last_update
9368 node42.example.com/virt-instance-0006f26c/memory-major_fault
9369 node42.example.com/virt-instance-0006f26c/memory-minor_fault
9370 node42.example.com/virt-instance-0006f26c/memory-rss
9371 node42.example.com/virt-instance-0006f26c/memory-swap_in
9372 node42.example.com/virt-instance-0006f26c/memory-swap_out
9373 node42.example.com/virt-instance-0006f26c/memory-total
9374 node42.example.com/virt-instance-0006f26c/memory-unused
9375 node42.example.com/virt-instance-0006f26c/memory-usable
9376 node42.example.com/virt-instance-0006f26c/virt_cpu_total
9377 node42.example.com/virt-instance-0006f26c/virt_vcpu-0
9379 You can get information on the metric's units from the online libvirt documentation.
9380 For instance, I<virt_cpu_total> is in nanoseconds.
9384 =item B<Connection> I<uri>
9386 Connect to the hypervisor given by I<uri>. For example if using Xen use:
9388 Connection "xen:///"
9390 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
9392 =item B<RefreshInterval> I<seconds>
9394 Refresh the list of domains and devices every I<seconds>. The default is 60
9395 seconds. Setting this to be the same or smaller than the I<Interval> will cause
9396 the list of domains and devices to be refreshed on every iteration.
9398 Refreshing the devices in particular is quite a costly operation, so if your
9399 virtualization setup is static you might consider increasing this. If this
9400 option is set to 0, refreshing is disabled completely.
9402 =item B<Domain> I<name>
9404 =item B<BlockDevice> I<name:dev>
9406 =item B<InterfaceDevice> I<name:dev>
9408 =item B<IgnoreSelected> B<true>|B<false>
9410 Select which domains and devices are collected.
9412 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
9413 disk/network devices are collected.
9415 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
9416 domains and disk/network devices are ignored, while the rest are collected.
9418 The domain name and device names may use a regular expression, if the name is
9419 surrounded by I</.../> and collectd was compiled with support for regexps.
9421 The default is to collect statistics for all domains and all their devices.
9423 B<Note:> B<BlockDevice> and B<InterfaceDevice> options are related to
9424 corresponding B<*Format> options. Specifically, B<BlockDevice> filtering depends
9425 on B<BlockDeviceFormat> setting - if user wants to filter block devices by
9426 'target' name then B<BlockDeviceFormat> option has to be set to 'target' and
9427 B<BlockDevice> option must be set to a valid block device target
9428 name("/:hdb/"). Mixing formats and filter values from different worlds (i.e.,
9429 using 'target' name as B<BlockDevice> value with B<BlockDeviceFormat> set to
9430 'source') may lead to unexpected results (all devices filtered out or all
9431 visible, depending on the value of B<IgnoreSelected> option).
9432 Similarly, option B<InterfaceDevice> is related to B<InterfaceFormat> setting
9433 (i.e., when user wants to use MAC address as a filter then B<InterfaceFormat>
9434 has to be set to 'address' - using wrong type here may filter out all of the
9439 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
9442 BlockDevice "/:hdb/"
9443 IgnoreSelected "true"
9444 BlockDeviceFormat "target"
9448 Collect metrics only for block device on 'baremetal0' domain when its
9449 'source' matches given path:
9451 BlockDevice "baremetal0:/var/lib/libvirt/images/baremetal0.qcow2"
9452 BlockDeviceFormat source
9454 As you can see it is possible to filter devices/interfaces using
9455 various formats - for block devices 'target' or 'source' name can be
9456 used. Interfaces can be filtered using 'name', 'address' or 'number'.
9460 Collect metrics only for domains 'baremetal0' and 'baremetal1' and
9461 ignore any other domain:
9466 It is possible to filter multiple block devices/domains/interfaces by
9467 adding multiple filtering entries in separate lines.
9469 =item B<BlockDeviceFormat> B<target>|B<source>
9471 If I<BlockDeviceFormat> is set to B<target>, the default, then the device name
9472 seen by the guest will be used for reporting metrics.
9473 This corresponds to the C<E<lt>targetE<gt>> node in the XML definition of the
9476 If I<BlockDeviceFormat> is set to B<source>, then metrics will be reported
9477 using the path of the source, e.g. an image file.
9478 This corresponds to the C<E<lt>sourceE<gt>> node in the XML definition of the
9483 If the domain XML have the following device defined:
9485 <disk type='block' device='disk'>
9486 <driver name='qemu' type='raw' cache='none' io='native' discard='unmap'/>
9487 <source dev='/var/lib/libvirt/images/image1.qcow2'/>
9488 <target dev='sda' bus='scsi'/>
9490 <address type='drive' controller='0' bus='0' target='0' unit='0'/>
9493 Setting C<BlockDeviceFormat target> will cause the I<type instance> to be set
9495 Setting C<BlockDeviceFormat source> will cause the I<type instance> to be set
9496 to C<var_lib_libvirt_images_image1.qcow2>.
9498 B<Note:> this option determines also what field will be used for
9499 filtering over block devices (filter value in B<BlockDevice>
9500 will be applied to target or source). More info about filtering
9501 block devices can be found in the description of B<BlockDevice>.
9503 =item B<BlockDeviceFormatBasename> B<false>|B<true>
9505 The B<BlockDeviceFormatBasename> controls whether the full path or the
9506 L<basename(1)> of the source is being used as the I<type instance> when
9507 B<BlockDeviceFormat> is set to B<source>. Defaults to B<false>.
9511 Assume the device path (source tag) is C</var/lib/libvirt/images/image1.qcow2>.
9512 Setting C<BlockDeviceFormatBasename false> will cause the I<type instance> to
9513 be set to C<var_lib_libvirt_images_image1.qcow2>.
9514 Setting C<BlockDeviceFormatBasename true> will cause the I<type instance> to be
9515 set to C<image1.qcow2>.
9517 =item B<HostnameFormat> B<name|uuid|hostname|metadata...>
9519 When the virt plugin logs data, it sets the hostname of the collected data
9520 according to this setting. The default is to use the guest name as provided by
9521 the hypervisor, which is equal to setting B<name>.
9523 B<uuid> means use the guest's UUID. This is useful if you want to track the
9524 same guest across migrations.
9526 B<hostname> means to use the global B<Hostname> setting, which is probably not
9527 useful on its own because all guests will appear to have the same name. This is
9528 useful in conjunction with B<PluginInstanceFormat> though.
9530 B<metadata> means use information from guest's metadata. Use
9531 B<HostnameMetadataNS> and B<HostnameMetadataXPath> to localize this information.
9533 You can also specify combinations of these fields. For example B<name uuid>
9534 means to concatenate the guest name and UUID (with a literal colon character
9535 between, thus I<"foo:1234-1234-1234-1234">).
9537 At the moment of writing (collectd-5.5), hostname string is limited to 62
9538 characters. In case when combination of fields exceeds 62 characters,
9539 hostname will be truncated without a warning.
9541 =item B<InterfaceFormat> B<name>|B<address>|B<number>
9543 When the virt plugin logs interface data, it sets the name of the collected
9544 data according to this setting. The default is to use the path as provided by
9545 the hypervisor (the "dev" property of the target node), which is equal to
9548 B<address> means use the interface's mac address. This is useful since the
9549 interface path might change between reboots of a guest or across migrations.
9551 B<number> means use the interface's number in guest.
9553 B<Note:> this option determines also what field will be used for
9554 filtering over interface device (filter value in B<InterfaceDevice>
9555 will be applied to name, address or number). More info about filtering
9556 interfaces can be found in the description of B<InterfaceDevice>.
9558 =item B<PluginInstanceFormat> B<name|uuid|metadata|none>
9560 When the virt plugin logs data, it sets the plugin_instance of the collected
9561 data according to this setting. The default is to not set the plugin_instance.
9563 B<name> means use the guest's name as provided by the hypervisor.
9564 B<uuid> means use the guest's UUID.
9565 B<metadata> means use information from guest's metadata.
9567 You can also specify combinations of the B<name> and B<uuid> fields.
9568 For example B<name uuid> means to concatenate the guest name and UUID
9569 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
9571 =item B<HostnameMetadataNS> B<string>
9573 When B<metadata> is used in B<HostnameFormat> or B<PluginInstanceFormat>, this
9574 selects in which metadata namespace we will pick the hostname. The default is
9575 I<http://openstack.org/xmlns/libvirt/nova/1.0>.
9577 =item B<HostnameMetadataXPath> B<string>
9579 When B<metadata> is used in B<HostnameFormat> or B<PluginInstanceFormat>, this
9580 describes where the hostname is located in the libvirt metadata. The default is
9581 I</instance/name/text()>.
9583 =item B<ReportBlockDevices> B<true>|B<false>
9585 Enabled by default. Allows to disable stats reporting of block devices for
9588 =item B<ReportNetworkInterfaces> B<true>|B<false>
9590 Enabled by default. Allows to disable stats reporting of network interfaces for
9593 =item B<ExtraStats> B<string>
9595 Report additional extra statistics. The default is no extra statistics, preserving
9596 the previous behaviour of the plugin. If unsure, leave the default. If enabled,
9597 allows the plugin to reported more detailed statistics about the behaviour of
9598 Virtual Machines. The argument is a space-separated list of selectors.
9600 Currently supported selectors are:
9604 =item B<cpu_util>: report CPU utilization per domain in percentage.
9606 =item B<disk>: report extra statistics like number of flush operations and total
9607 service time for read, write and flush operations. Requires libvirt API version
9610 =item B<disk_err>: report disk errors if any occured. Requires libvirt API version
9613 =item B<domain_state>: report domain state and reason as 'domain_state' metric.
9615 =item B<fs_info>: report file system information as a notification. Requires
9616 libvirt API version I<1.2.11> or later. Can be collected only if I<Guest Agent>
9617 is installed and configured inside VM. Make sure that installed I<Guest Agent>
9618 version supports retrieving file system information.
9620 =item B<job_stats_background>: report statistics about progress of a background
9621 job on a domain. Only one type of job statistics can be collected at the same time.
9622 Requires libvirt API version I<1.2.9> or later.
9624 =item B<job_stats_completed>: report statistics about a recently completed job on
9625 a domain. Only one type of job statistics can be collected at the same time.
9626 Requires libvirt API version I<1.2.9> or later.
9628 =item B<memory>: report statistics about memory usage details, provided
9629 by libvirt virDomainMemoryStats() function.
9631 =item B<pcpu>: report the physical user/system cpu time consumed by the hypervisor, per-vm.
9632 Requires libvirt API version I<0.9.11> or later.
9634 =item B<perf>: report performance monitoring events. To collect performance
9635 metrics they must be enabled for domain and supported by the platform. Requires
9636 libvirt API version I<1.3.3> or later.
9637 B<Note>: I<perf> metrics can't be collected if I<intel_rdt> plugin is enabled.
9639 =item B<vcpu>: report domain virtual CPUs utilisation.
9641 =item B<vcpupin>: report pinning of domain VCPUs to host physical CPUs.
9643 =item B<disk_physical>: report 'disk_physical' statistic for disk device.
9644 B<Note>: This statistic is only reported for disk devices with 'source'
9647 =item B<disk_allocation>: report 'disk_allocation' statistic for disk device.
9648 B<Note>: This statistic is only reported for disk devices with 'source'
9651 =item B<disk_capacity>: report 'disk_capacity' statistic for disk device.
9652 B<Note>: This statistic is only reported for disk devices with 'source'
9657 =item B<PersistentNotification> B<true>|B<false>
9659 Override default configuration to only send notifications when there is a change
9660 in the lifecycle state of a domain. When set to true notifications will be sent
9661 for every read cycle. Default is false. Does not affect the stats being
9664 =item B<Instances> B<integer>
9666 How many read instances you want to use for this plugin. The default is one,
9667 and the sensible setting is a multiple of the B<ReadThreads> value.
9669 This option is only useful when domains are specially tagged.
9670 If you are not sure, just use the default setting.
9672 The reader instance will only query the domains with attached matching tag.
9673 Tags should have the form of 'virt-X' where X is the reader instance number,
9676 The special-purpose reader instance #0, guaranteed to be always present,
9677 will query all the domains with missing or unrecognized tag, so no domain will
9680 Domain tagging is done with a custom attribute in the libvirt domain metadata
9681 section. Value is selected by an XPath I</domain/metadata/ovirtmap/tag/text()>
9682 expression in the I<http://ovirt.org/ovirtmap/tag/1.0> namespace.
9683 (XPath and namespace values are not configurable yet).
9685 Tagging could be used by management applications to evenly spread the
9686 load among the reader threads, or to pin on the same threads all
9687 the libvirt domains which use the same shared storage, to minimize
9688 the disruption in presence of storage outages.
9692 =head2 Plugin C<vmem>
9694 The C<vmem> plugin collects information about the usage of virtual memory.
9695 Since the statistics provided by the Linux kernel are very detailed, they are
9696 collected very detailed. However, to get all the details, you have to switch
9697 them on manually. Most people just want an overview over, such as the number of
9698 pages read from swap space.
9702 =item B<Verbose> B<true>|B<false>
9704 Enables verbose collection of information. This will start collecting page
9705 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
9706 Part of these statistics are collected on a "per zone" basis.
9710 =head2 Plugin C<vserver>
9712 This plugin doesn't have any options. B<VServer> support is only available for
9713 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
9714 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
9715 need to apply the patches and compile your own kernel, which will then provide
9716 the F</proc/virtual> filesystem that is required by this plugin.
9718 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
9720 B<Note>: The traffic collected by this plugin accounts for the amount of
9721 traffic passing a socket which might be a lot less than the actual on-wire
9722 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
9723 collect on-wire traffic you could, for example, use the logging facilities of
9724 iptables to feed data for the guest IPs into the iptables plugin.
9726 =head2 Plugin C<write_graphite>
9728 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
9729 storage and graphing project. The plugin connects to I<Carbon>, the data layer
9730 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
9731 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
9732 of at most 1428 bytes to minimize the number of network packets.
9736 <Plugin write_graphite>
9748 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9749 blocks. Inside the B<Node> blocks, the following options are recognized:
9753 =item B<Host> I<Address>
9755 Hostname or address to connect to. Defaults to C<localhost>.
9757 =item B<Port> I<Service>
9759 Service name or port number to connect to. Defaults to C<2003>.
9761 =item B<Protocol> I<String>
9763 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
9765 =item B<ReconnectInterval> I<Seconds>
9767 When set to non-zero, forces the connection to the Graphite backend to be
9768 closed and re-opend periodically. This behavior is desirable in environments
9769 where the connection to the Graphite backend is done through load balancers,
9770 for example. When set to zero, the default, the connetion is kept open for as
9773 =item B<LogSendErrors> B<false>|B<true>
9775 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
9776 If set to B<false>, it will not log the errors. This is especially useful when
9777 using Protocol UDP since many times we want to use the "fire-and-forget"
9778 approach and logging errors fills syslog with unneeded messages.
9780 =item B<Prefix> I<String>
9782 When B<UseTags> is I<false>, B<Prefix> value is added in front of the host name.
9783 When B<UseTags> is I<true>, B<Prefix> value is added in front of series name.
9785 Dots and whitespace are I<not> escaped in this string (see B<EscapeCharacter>
9788 =item B<Postfix> I<String>
9790 When B<UseTags> is I<false>, B<Postfix> value appended to the host name.
9791 When B<UseTags> is I<true>, B<Postgix> value appended to the end of series name
9792 (before the first ; that separates the name from the tags).
9794 Dots and whitespace are I<not> escaped in this string (see B<EscapeCharacter>
9797 =item B<EscapeCharacter> I<Char>
9799 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
9800 in the identifier. The B<EscapeCharacter> option determines which character
9801 dots, whitespace and control characters are replaced with. Defaults to
9804 =item B<StoreRates> B<false>|B<true>
9806 If set to B<true> (the default), convert counter values to rates. If set to
9807 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
9810 =item B<SeparateInstances> B<false>|B<true>
9812 If set to B<true>, the plugin instance and type instance will be in their own
9813 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9814 default), the plugin and plugin instance (and likewise the type and type
9815 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9817 Option value is not used when B<UseTags> is I<true>.
9819 =item B<AlwaysAppendDS> B<false>|B<true>
9821 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9822 identifier. If set to B<false> (the default), this is only done when there is
9825 =item B<PreserveSeparator> B<false>|B<true>
9827 If set to B<false> (the default) the C<.> (dot) character is replaced with
9828 I<EscapeCharacter>. Otherwise, if set to B<true>, the C<.> (dot) character
9829 is preserved, i.e. passed through.
9831 Option value is not used when B<UseTags> is I<true>.
9833 =item B<DropDuplicateFields> B<false>|B<true>
9835 If set to B<true>, detect and remove duplicate components in Graphite metric
9836 names. For example, the metric name C<host.load.load.shortterm> will
9837 be shortened to C<host.load.shortterm>.
9839 =item B<UseTags> B<false>|B<true>
9841 If set to B<true>, Graphite metric names will be generated as tagged series.
9842 This allows for much more flexibility than the traditional hierarchical layout.
9845 C<test.single;host=example.com;plugin=test;plugin_instance=foo;type=single;type_instance=bar>
9847 You can use B<Postfix> option to add more tags by specifying it like
9848 C<;tag1=value1;tag2=value2>. Note what tagging support was added since Graphite
9851 If set to B<true>, the B<SeparateInstances> and B<PreserveSeparator> settings
9854 Default value: B<false>.
9856 =item B<ReverseHost> B<false>|B<true>
9858 If set to B<true>, the (dot separated) parts of the B<host> field of the
9859 I<value list> will be rewritten in reverse order. The rewrite happens I<before>
9860 special characters are replaced with the B<EscapeCharacter>.
9862 This option might be convenient if the metrics are presented with Graphite in a
9863 DNS like tree structure (probably without replacing dots in hostnames).
9866 Hostname "node3.cluster1.example.com"
9868 LoadPlugin "write_graphite"
9869 <Plugin "write_graphite">
9870 <Node "graphite.example.com">
9876 result on the wire: com.example.cluster1.node3.cpu-0.cpu-idle 99.900993 1543010932
9878 Default value: B<false>.
9882 =head2 Plugin C<write_log>
9884 The C<write_log> plugin writes metrics as INFO log messages.
9886 This plugin supports two output formats: I<Graphite> and I<JSON>.
9896 =item B<Format> I<Format>
9898 The output format to use. Can be one of C<Graphite> or C<JSON>.
9902 =head2 Plugin C<write_tsdb>
9904 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
9905 time series database. The plugin connects to a I<TSD>, a masterless, no shared
9906 state daemon that ingests metrics and stores them in HBase. The plugin uses
9907 I<TCP> over the "line based" protocol with a default port 4242. The data will
9908 be sent in blocks of at most 1428 bytes to minimize the number of network
9917 Host "tsd-1.my.domain"
9919 HostTags "status=production"
9923 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9924 blocks and global directives.
9926 Global directives are:
9930 =item B<ResolveInterval> I<seconds>
9932 =item B<ResolveJitter> I<seconds>
9934 When I<collectd> connects to a TSDB node, it will request the hostname from
9935 DNS. This can become a problem if the TSDB node is unavailable or badly
9936 configured because collectd will request DNS in order to reconnect for every
9937 metric, which can flood your DNS. So you can cache the last value for
9938 I<ResolveInterval> seconds.
9939 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9941 You can also define a jitter, a random interval to wait in addition to
9942 I<ResolveInterval>. This prevents all your collectd servers to resolve the
9943 hostname at the same time when the connection fails.
9944 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9946 B<Note:> If the DNS resolution has already been successful when the socket
9947 closes, the plugin will try to reconnect immediately with the cached
9948 information. DNS is queried only when the socket is closed for a longer than
9949 I<ResolveInterval> + I<ResolveJitter> seconds.
9953 Inside the B<Node> blocks, the following options are recognized:
9957 =item B<Host> I<Address>
9959 Hostname or address to connect to. Defaults to C<localhost>.
9961 =item B<Port> I<Service>
9963 Service name or port number to connect to. Defaults to C<4242>.
9966 =item B<HostTags> I<String>
9968 When set, I<HostTags> is added to the end of the metric. It is intended to be
9969 used for name=value pairs that the TSD will tag the metric with. Dots and
9970 whitespace are I<not> escaped in this string.
9972 =item B<StoreRates> B<false>|B<true>
9974 If set to B<true>, convert counter values to rates. If set to B<false>
9975 (the default) counter values are stored as is, as an increasing
9978 =item B<AlwaysAppendDS> B<false>|B<true>
9980 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
9981 identifier. If set to B<false> (the default), this is only done when there is
9986 =head2 Plugin C<write_mongodb>
9988 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
9993 <Plugin "write_mongodb">
10002 The plugin can send values to multiple instances of I<MongoDB> by specifying
10003 one B<Node> block for each instance. Within the B<Node> blocks, the following
10004 options are available:
10008 =item B<Host> I<Address>
10010 Hostname or address to connect to. Defaults to C<localhost>.
10012 =item B<Port> I<Service>
10014 Service name or port number to connect to. Defaults to C<27017>.
10016 =item B<Timeout> I<Milliseconds>
10018 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
10019 Setting this option to zero means no timeout, which is the default.
10021 =item B<StoreRates> B<false>|B<true>
10023 If set to B<true> (the default), convert counter values to rates. If set to
10024 B<false> counter values are stored as is, i.e. as an increasing integer
10027 =item B<Database> I<Database>
10029 =item B<User> I<User>
10031 =item B<Password> I<Password>
10033 Sets the information used when authenticating to a I<MongoDB> database. The
10034 fields are optional (in which case no authentication is attempted), but if you
10035 want to use authentication all three fields must be set.
10039 =head2 Plugin C<write_prometheus>
10041 The I<write_prometheus plugin> implements a tiny webserver that can be scraped
10042 using I<Prometheus>.
10048 =item B<Host> I<Host>
10050 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
10051 "any" address, i.e. accept packets sent to any of the hosts addresses.
10053 This option is supported only for libmicrohttpd newer than 0.9.0.
10055 =item B<Port> I<Port>
10057 Port the embedded webserver should listen on. Defaults to B<9103>.
10059 =item B<StalenessDelta> I<Seconds>
10061 Time in seconds after which I<Prometheus> considers a metric "stale" if it
10062 hasn't seen any update for it. This value must match the setting in Prometheus.
10063 It defaults to B<300> seconds (5 minutes), same as Prometheus.
10067 I<Prometheus> has a global setting, C<StalenessDelta>, which controls after
10068 which time a metric without updates is considered "stale". This setting
10069 effectively puts an upper limit on the interval in which metrics are reported.
10071 When the I<write_prometheus plugin> encounters a metric with an interval
10072 exceeding this limit, it will inform you, the user, and provide the metric to
10073 I<Prometheus> B<without> a timestamp. That causes I<Prometheus> to consider the
10074 metric "fresh" each time it is scraped, with the time of the scrape being
10075 considered the time of the update. The result is that there appear more
10076 datapoints in I<Prometheus> than were actually created, but at least the metric
10077 doesn't disappear periodically.
10081 =head2 Plugin C<write_http>
10083 This output plugin submits values to an HTTP server using POST requests and
10084 encoding metrics with JSON or using the C<PUTVAL> command described in
10085 L<collectd-unixsock(5)>.
10089 <Plugin "write_http">
10091 URL "http://example.com/post-collectd"
10093 Password "weCh3ik0"
10098 The plugin can send values to multiple HTTP servers by specifying one
10099 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
10100 block, the following options are available:
10104 =item B<URL> I<URL>
10106 URL to which the values are submitted to. Mandatory.
10108 =item B<User> I<Username>
10110 Optional user name needed for authentication.
10112 =item B<Password> I<Password>
10114 Optional password needed for authentication.
10116 =item B<VerifyPeer> B<true>|B<false>
10118 Enable or disable peer SSL certificate verification. See
10119 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
10121 =item B<VerifyHost> B<true|false>
10123 Enable or disable peer host name verification. If enabled, the plugin checks if
10124 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
10125 matches the host name provided by the B<URL> option. If this identity check
10126 fails, the connection is aborted. Obviously, only works when connecting to a
10127 SSL enabled server. Enabled by default.
10129 =item B<CACert> I<File>
10131 File that holds one or more SSL certificates. If you want to use HTTPS you will
10132 possibly need this option. What CA certificates come bundled with C<libcurl>
10133 and are checked by default depends on the distribution you use.
10135 =item B<CAPath> I<Directory>
10137 Directory holding one or more CA certificate files. You can use this if for
10138 some reason all the needed CA certificates aren't in the same file and can't be
10139 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
10142 =item B<ClientKey> I<File>
10144 File that holds the private key in PEM format to be used for certificate-based
10147 =item B<ClientCert> I<File>
10149 File that holds the SSL certificate to be used for certificate-based
10152 =item B<ClientKeyPass> I<Password>
10154 Password required to load the private key in B<ClientKey>.
10156 =item B<Header> I<Header>
10158 A HTTP header to add to the request. Multiple headers are added if this option is specified more than once. Example:
10160 Header "X-Custom-Header: custom_value"
10162 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
10164 Define which SSL protocol version must be used. By default C<libcurl> will
10165 attempt to figure out the remote SSL protocol version. See
10166 L<curl_easy_setopt(3)> for more details.
10168 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
10170 Format of the output to generate. If set to B<Command>, will create output that
10171 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
10172 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
10173 , will create output in the KairosDB format.
10175 Defaults to B<Command>.
10177 =item B<Attribute> I<String> I<String>
10179 Only available for the KAIROSDB output format.
10181 Consider the two given strings to be the key and value of an additional tag for
10182 each metric being sent out.
10184 You can add multiple B<Attribute>.
10186 =item B<TTL> I<Int>
10188 Only available for the KAIROSDB output format.
10190 Sets the Cassandra ttl for the data points.
10192 Please refer to L<http://kairosdb.github.io/docs/build/html/restapi/AddDataPoints.html?highlight=ttl>
10194 =item B<Prefix> I<String>
10196 Only available for the KAIROSDB output format.
10198 Sets the metrics prefix I<string>. Defaults to I<collectd>.
10200 =item B<Metrics> B<true>|B<false>
10202 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
10204 =item B<Notifications> B<false>|B<true>
10206 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
10208 =item B<StoreRates> B<true|false>
10210 If set to B<true>, convert counter values to rates. If set to B<false> (the
10211 default) counter values are stored as is, i.e. as an increasing integer number.
10213 =item B<BufferSize> I<Bytes>
10215 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
10216 requests will be generated, but more metrics will be batched / metrics are
10217 cached for longer before being sent, introducing additional delay until they
10218 are available on the server side. I<Bytes> must be at least 1024 and cannot
10219 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
10220 Defaults to C<4096>.
10222 =item B<LowSpeedLimit> I<Bytes per Second>
10224 Sets the minimal transfer rate in I<Bytes per Second> below which the
10225 connection with the HTTP server will be considered too slow and aborted. All
10226 the data submitted over this connection will probably be lost. Defaults to 0,
10227 which means no minimum transfer rate is enforced.
10229 =item B<Timeout> I<Timeout>
10231 Sets the maximum time in milliseconds given for HTTP POST operations to
10232 complete. When this limit is reached, the POST operation will be aborted, and
10233 all the data in the current send buffer will probably be lost. Defaults to 0,
10234 which means the connection never times out.
10236 =item B<LogHttpError> B<false>|B<true>
10238 Enables printing of HTTP error code to log. Turned off by default.
10240 The C<write_http> plugin regularly submits the collected values to the HTTP
10241 server. How frequently this happens depends on how much data you are collecting
10242 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
10243 slightly below this interval, which you can estimate by monitoring the network
10244 traffic between collectd and the HTTP server.
10248 =head2 Plugin C<write_kafka>
10250 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
10254 <Plugin "write_kafka">
10255 Property "metadata.broker.list" "broker1:9092,broker2:9092"
10261 The following options are understood by the I<write_kafka plugin>:
10265 =item E<lt>B<Topic> I<Name>E<gt>
10267 The plugin's configuration consists of one or more B<Topic> blocks. Each block
10268 is given a unique I<Name> and specifies one kafka producer.
10269 Inside the B<Topic> block, the following per-topic options are
10274 =item B<Property> I<String> I<String>
10276 Configure the named property for the current topic. Properties are
10277 forwarded to the kafka producer library B<librdkafka>.
10279 =item B<Key> I<String>
10281 Use the specified string as a partitioning key for the topic. Kafka breaks
10282 topic into partitions and guarantees that for a given topology, the same
10283 consumer will be used for a specific key. The special (case insensitive)
10284 string B<Random> can be used to specify that an arbitrary partition should
10287 =item B<Format> B<Command>|B<JSON>|B<Graphite>
10289 Selects the format in which messages are sent to the broker. If set to
10290 B<Command> (the default), values are sent as C<PUTVAL> commands which are
10291 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
10293 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
10294 an easy and straight forward exchange format.
10296 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
10297 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
10299 =item B<StoreRates> B<true>|B<false>
10301 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
10302 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
10303 default), no conversion is performed. Otherwise the conversion is performed
10304 using the internal value cache.
10306 Please note that currently this option is only used if the B<Format> option has
10307 been set to B<JSON>.
10309 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
10311 A prefix can be added in the metric name when outputting in the I<Graphite>
10314 When B<GraphiteUseTags> is I<false>, prefix is added before the I<Host> name.
10315 Metric name will be
10316 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>>
10318 When B<GraphiteUseTags> is I<true>, prefix is added in front of series name.
10320 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
10322 A postfix can be added in the metric name when outputting in the I<Graphite>
10325 When B<GraphiteUseTags> is I<false>, postfix is added after the I<Host> name.
10326 Metric name will be
10327 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>>
10329 When B<GraphiteUseTags> is I<true>, prefix value appended to the end of series
10330 name (before the first ; that separates the name from the tags).
10332 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
10334 Specify a character to replace dots (.) in the host part of the metric name.
10335 In I<Graphite> metric name, dots are used as separators between different
10336 metric parts (host, plugin, type).
10337 Default is C<_> (I<Underscore>).
10339 =item B<GraphiteSeparateInstances> B<false>|B<true>
10341 If set to B<true>, the plugin instance and type instance will be in their own
10342 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
10343 default), the plugin and plugin instance (and likewise the type and type
10344 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
10346 Option value is not used when B<GraphiteUseTags> is I<true>.
10348 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
10350 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
10351 identifier. If set to B<false> (the default), this is only done when there is
10354 =item B<GraphitePreserveSeparator> B<false>|B<true>
10356 If set to B<false> (the default) the C<.> (dot) character is replaced with
10357 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
10358 is preserved, i.e. passed through.
10360 Option value is not used when B<GraphiteUseTags> is I<true>.
10362 =item B<GraphiteUseTags> B<false>|B<true>
10364 If set to B<true> Graphite metric names will be generated as tagged series.
10366 Default value: B<false>.
10368 =item B<StoreRates> B<true>|B<false>
10370 If set to B<true> (the default), convert counter values to rates. If set to
10371 B<false> counter values are stored as is, i.e. as an increasing integer number.
10373 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
10374 converted values will have "rate" appended to the data source type, e.g.
10375 C<ds_type:derive:rate>.
10379 =item B<Property> I<String> I<String>
10381 Configure the kafka producer through properties, you almost always will
10382 want to set B<metadata.broker.list> to your Kafka broker list.
10386 =head2 Plugin C<write_redis>
10388 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
10392 <Plugin "write_redis">
10405 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
10406 the timestamp as the score. Retrieving a date range can then be done using the
10407 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
10408 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
10409 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
10410 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
10411 with the B<Database> parameter (default is C<0>). See
10412 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
10415 The information shown in the synopsis above is the I<default configuration>
10416 which is used by the plugin if no configuration is present.
10418 The plugin can send values to multiple instances of I<Redis> by specifying
10419 one B<Node> block for each instance. Within the B<Node> blocks, the following
10420 options are available:
10424 =item B<Node> I<Nodename>
10426 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
10427 instance running on a specified host and port. The node name is a
10428 canonical identifier which is used as I<plugin instance>. It is limited to
10429 51E<nbsp>characters in length.
10431 =item B<Host> I<Hostname>
10433 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
10436 =item B<Port> I<Port>
10438 The B<Port> option is the TCP port on which the Redis instance accepts
10439 connections. Either a service name of a port number may be given. Please note
10440 that numerical port numbers must be given as a string, too.
10442 =item B<Timeout> I<Milliseconds>
10444 The B<Timeout> option sets the socket connection timeout, in milliseconds.
10446 =item B<Prefix> I<Prefix>
10448 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
10449 containing all metrics. Defaults to C<collectd/>, so metrics will have names
10450 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
10451 is recommended but not required to include a trailing slash in I<Prefix>.
10453 =item B<Database> I<Index>
10455 This index selects the redis database to use for writing operations. Defaults
10458 =item B<MaxSetSize> I<Items>
10460 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
10461 hold. Negative values for I<Items> sets no limit, which is the default behavior.
10463 =item B<MaxSetDuration> I<Seconds>
10465 The B<MaxSetDuration> option limits the duration of items that the
10466 I<Sorted Sets> can hold. Negative values for I<Items> sets no duration, which
10467 is the default behavior.
10469 =item B<StoreRates> B<true>|B<false>
10471 If set to B<true> (the default), convert counter values to rates. If set to
10472 B<false> counter values are stored as is, i.e. as an increasing integer number.
10476 =head2 Plugin C<write_riemann>
10478 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
10479 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
10480 I<Riemann> using UDP packets.
10484 <Plugin "write_riemann">
10490 AlwaysAppendDS false
10494 Attribute "foo" "bar"
10497 The following options are understood by the I<write_riemann plugin>:
10501 =item E<lt>B<Node> I<Name>E<gt>
10503 The plugin's configuration consists of one or more B<Node> blocks. Each block
10504 is given a unique I<Name> and specifies one connection to an instance of
10505 I<Riemann>. Indise the B<Node> block, the following per-connection options are
10510 =item B<Host> I<Address>
10512 Hostname or address to connect to. Defaults to C<localhost>.
10514 =item B<Port> I<Service>
10516 Service name or port number to connect to. Defaults to C<5555>.
10518 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
10520 Specify the protocol to use when communicating with I<Riemann>. Defaults to
10523 =item B<TLSCertFile> I<Path>
10525 When using the B<TLS> protocol, path to a PEM certificate to present
10528 =item B<TLSCAFile> I<Path>
10530 When using the B<TLS> protocol, path to a PEM CA certificate to
10531 use to validate the remote hosts's identity.
10533 =item B<TLSKeyFile> I<Path>
10535 When using the B<TLS> protocol, path to a PEM private key associated
10536 with the certificate defined by B<TLSCertFile>.
10538 =item B<Batch> B<true>|B<false>
10540 If set to B<true> and B<Protocol> is set to B<TCP>,
10541 events will be batched in memory and flushed at
10542 regular intervals or when B<BatchMaxSize> is exceeded.
10544 Notifications are not batched and sent as soon as possible.
10546 When enabled, it can occur that events get processed by the Riemann server
10547 close to or after their expiration time. Tune the B<TTLFactor> and
10548 B<BatchMaxSize> settings according to the amount of values collected, if this
10553 =item B<BatchMaxSize> I<size>
10555 Maximum payload size for a riemann packet. Defaults to 8192
10557 =item B<BatchFlushTimeout> I<seconds>
10559 Maximum amount of seconds to wait in between to batch flushes.
10560 No timeout by default.
10562 =item B<StoreRates> B<true>|B<false>
10564 If set to B<true> (the default), convert counter values to rates. If set to
10565 B<false> counter values are stored as is, i.e. as an increasing integer number.
10567 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
10568 converted values will have "rate" appended to the data source type, e.g.
10569 C<ds_type:derive:rate>.
10571 =item B<AlwaysAppendDS> B<false>|B<true>
10573 If set to B<true>, append the name of the I<Data Source> (DS) to the
10574 "service", i.e. the field that, together with the "host" field, uniquely
10575 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
10576 only done when there is more than one DS.
10578 =item B<TTLFactor> I<Factor>
10580 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
10581 event is considered active. I<collectd> populates this field based on the
10582 metrics interval setting. This setting controls the factor with which the
10583 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
10584 know exactly what you're doing, you should only increase this setting from its
10587 =item B<Notifications> B<false>|B<true>
10589 If set to B<true>, create riemann events for notifications. This is B<true>
10590 by default. When processing thresholds from write_riemann, it might prove
10591 useful to avoid getting notification events.
10593 =item B<CheckThresholds> B<false>|B<true>
10595 If set to B<true>, attach state to events based on thresholds defined
10596 in the B<Threshold> plugin. Defaults to B<false>.
10598 =item B<EventServicePrefix> I<String>
10600 Add the given string as a prefix to the event service name.
10601 If B<EventServicePrefix> not set or set to an empty string (""),
10602 no prefix will be used.
10606 =item B<Tag> I<String>
10608 Add the given string as an additional tag to the metric being sent to
10611 =item B<Attribute> I<String> I<String>
10613 Consider the two given strings to be the key and value of an additional
10614 attribute for each metric being sent out to I<Riemann>.
10618 =head2 Plugin C<write_sensu>
10620 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
10621 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
10622 a local I<Sensu> client using a TCP socket.
10624 At the moment, the I<write_sensu plugin> does not send over a collectd_host
10625 parameter so it is not possible to use one collectd instance as a gateway for
10626 others. Each collectd host must pair with one I<Sensu> client.
10630 <Plugin "write_sensu">
10635 AlwaysAppendDS false
10636 MetricHandler "influx"
10637 MetricHandler "default"
10638 NotificationHandler "flapjack"
10639 NotificationHandler "howling_monkey"
10643 Attribute "foo" "bar"
10646 The following options are understood by the I<write_sensu plugin>:
10650 =item E<lt>B<Node> I<Name>E<gt>
10652 The plugin's configuration consists of one or more B<Node> blocks. Each block
10653 is given a unique I<Name> and specifies one connection to an instance of
10654 I<Sensu>. Inside the B<Node> block, the following per-connection options are
10659 =item B<Host> I<Address>
10661 Hostname or address to connect to. Defaults to C<localhost>.
10663 =item B<Port> I<Service>
10665 Service name or port number to connect to. Defaults to C<3030>.
10667 =item B<StoreRates> B<true>|B<false>
10669 If set to B<true> (the default), convert counter values to rates. If set to
10670 B<false> counter values are stored as is, i.e. as an increasing integer number.
10672 This will be reflected in the C<collectd_data_source_type> tag: If
10673 B<StoreRates> is enabled, converted values will have "rate" appended to the
10674 data source type, e.g. C<collectd_data_source_type:derive:rate>.
10676 =item B<AlwaysAppendDS> B<false>|B<true>
10678 If set the B<true>, append the name of the I<Data Source> (DS) to the
10679 "service", i.e. the field that, together with the "host" field, uniquely
10680 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
10681 only done when there is more than one DS.
10683 =item B<Notifications> B<false>|B<true>
10685 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
10686 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10688 =item B<Metrics> B<false>|B<true>
10690 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
10691 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10694 =item B<Separator> I<String>
10696 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
10698 =item B<MetricHandler> I<String>
10700 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
10701 several of them, one per line. Defaults to no handler.
10703 =item B<NotificationHandler> I<String>
10705 Add a handler that will be set when notifications are sent to I<Sensu>. You can
10706 add several of them, one per line. Defaults to no handler.
10708 =item B<EventServicePrefix> I<String>
10710 Add the given string as a prefix to the event service name.
10711 If B<EventServicePrefix> not set or set to an empty string (""),
10712 no prefix will be used.
10716 =item B<Tag> I<String>
10718 Add the given string as an additional tag to the metric being sent to
10721 =item B<Attribute> I<String> I<String>
10723 Consider the two given strings to be the key and value of an additional
10724 attribute for each metric being sent out to I<Sensu>.
10728 =head2 Plugin C<write_stackdriver>
10730 The C<write_stackdriver> plugin writes metrics to the
10731 I<Google Stackdriver Monitoring> service.
10733 This plugin supports two authentication methods: When configured, credentials
10734 are read from the JSON credentials file specified with B<CredentialFile>.
10735 Alternatively, when running on
10736 I<Google Compute Engine> (GCE), an I<OAuth> token is retrieved from the
10737 I<metadata server> and used to authenticate to GCM.
10741 <Plugin write_stackdriver>
10742 CredentialFile "/path/to/service_account.json"
10743 <Resource "global">
10744 Label "project_id" "monitored_project"
10750 =item B<CredentialFile> I<file>
10752 Path to a JSON credentials file holding the credentials for a GCP service
10755 If B<CredentialFile> is not specified, the plugin uses I<Application Default
10756 Credentials>. That means which credentials are used depends on the environment:
10762 The environment variable C<GOOGLE_APPLICATION_CREDENTIALS> is checked. If this
10763 variable is specified it should point to a JSON file that defines the
10768 The path C<${HOME}/.config/gcloud/application_default_credentials.json> is
10769 checked. This where credentials used by the I<gcloud> command line utility are
10770 stored. You can use C<gcloud auth application-default login> to create these
10773 Please note that these credentials are often of your personal account, not a
10774 service account, and are therefore unfit to be used in a production
10779 When running on GCE, the built-in service account associated with the virtual
10780 machine instance is used.
10781 See also the B<Email> option below.
10785 =item B<Project> I<Project>
10787 The I<Project ID> or the I<Project Number> of the I<Stackdriver Account>. The
10788 I<Project ID> is a string identifying the GCP project, which you can chose
10789 freely when creating a new project. The I<Project Number> is a 12-digit decimal
10790 number. You can look up both on the I<Developer Console>.
10792 This setting is optional. If not set, the project ID is read from the
10793 credentials file or determined from the GCE's metadata service.
10795 =item B<Email> I<Email> (GCE only)
10797 Choses the GCE I<Service Account> used for authentication.
10799 Each GCE instance has a C<default> I<Service Account> but may also be
10800 associated with additional I<Service Accounts>. This is often used to restrict
10801 the permissions of services running on the GCE instance to the required
10802 minimum. The I<write_stackdriver plugin> requires the
10803 C<https://www.googleapis.com/auth/monitoring> scope. When multiple I<Service
10804 Accounts> are available, this option selects which one is used by
10805 I<write_stackdriver plugin>.
10807 =item B<Resource> I<ResourceType>
10809 Configures the I<Monitored Resource> to use when storing metrics.
10810 More information on I<Monitored Resources> and I<Monitored Resource Types> are
10811 available at L<https://cloud.google.com/monitoring/api/resources>.
10813 This block takes one string argument, the I<ResourceType>. Inside the block are
10814 one or more B<Label> options which configure the resource labels.
10816 This block is optional. The default value depends on the runtime environment:
10817 on GCE, the C<gce_instance> resource type is used, otherwise the C<global>
10818 resource type ist used:
10824 B<On GCE>, defaults to the equivalent of this config:
10826 <Resource "gce_instance">
10827 Label "project_id" "<project_id>"
10828 Label "instance_id" "<instance_id>"
10829 Label "zone" "<zone>"
10832 The values for I<project_id>, I<instance_id> and I<zone> are read from the GCE
10837 B<Elsewhere>, i.e. not on GCE, defaults to the equivalent of this config:
10839 <Resource "global">
10840 Label "project_id" "<Project>"
10843 Where I<Project> refers to the value of the B<Project> option or the project ID
10844 inferred from the B<CredentialFile>.
10848 =item B<Url> I<Url>
10850 URL of the I<Stackdriver Monitoring> API. Defaults to
10851 C<https://monitoring.googleapis.com/v3>.
10855 =head2 Plugin C<write_syslog>
10857 The C<write_syslog> plugin writes data in I<syslog> format log messages.
10858 It implements the basic syslog protocol, RFC 5424, extends it with
10859 content-based filtering, rich filtering capabilities,
10860 flexible configuration options and adds features such as using TCP for transport.
10861 The plugin can connect to a I<Syslog> daemon, like syslog-ng and rsyslog, that will
10862 ingest metrics, transform and ship them to the specified output.
10863 The plugin uses I<TCP> over the "line based" protocol with a default port 44514.
10864 The data will be sent in blocks of at most 1428 bytes to minimize the number of
10869 <Plugin write_syslog>
10873 Host "syslog-1.my.domain"
10876 MessageFormat "human"
10881 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
10882 blocks and global directives.
10884 Global directives are:
10888 =item B<ResolveInterval> I<seconds>
10890 =item B<ResolveJitter> I<seconds>
10892 When I<collectd> connects to a syslog node, it will request the hostname from
10893 DNS. This can become a problem if the syslog node is unavailable or badly
10894 configured because collectd will request DNS in order to reconnect for every
10895 metric, which can flood your DNS. So you can cache the last value for
10896 I<ResolveInterval> seconds.
10897 Defaults to the I<Interval> of the I<write_syslog plugin>, e.g. 10E<nbsp>seconds.
10899 You can also define a jitter, a random interval to wait in addition to
10900 I<ResolveInterval>. This prevents all your collectd servers to resolve the
10901 hostname at the same time when the connection fails.
10902 Defaults to the I<Interval> of the I<write_syslog plugin>, e.g. 10E<nbsp>seconds.
10904 B<Note:> If the DNS resolution has already been successful when the socket
10905 closes, the plugin will try to reconnect immediately with the cached
10906 information. DNS is queried only when the socket is closed for a longer than
10907 I<ResolveInterval> + I<ResolveJitter> seconds.
10911 Inside the B<Node> blocks, the following options are recognized:
10915 =item B<Host> I<Address>
10917 Hostname or address to connect to. Defaults to C<localhost>.
10919 =item B<Port> I<Service>
10921 Service name or port number to connect to. Defaults to C<44514>.
10924 =item B<HostTags> I<String>
10926 When set, I<HostTags> is added to the end of the metric.
10927 It is intended to be used for adding additional metadata to tag the metric with.
10928 Dots and whitespace are I<not> escaped in this string.
10932 When MessageFormat is set to "human".
10934 ["prefix1" "example1"="example1_v"]["prefix2" "example2"="example2_v"]"
10936 When MessageFormat is set to "JSON", text should be in JSON format.
10937 Escaping the quotation marks is required.
10939 HostTags "\"prefix1\": {\"example1\":\"example1_v\",\"example2\":\"example2_v\"}"
10941 =item B<MessageFormat> I<String>
10943 I<MessageFormat> selects the format in which messages are sent to the
10944 syslog deamon, human or JSON. Defaults to human.
10946 Syslog message format:
10948 <priority>VERSION ISOTIMESTAMP HOSTNAME APPLICATION PID MESSAGEID STRUCTURED-DATA MSG
10950 The difference between the message formats are in the STRUCTURED-DATA and MSG parts.
10954 <166>1 ISOTIMESTAMP HOSTNAME collectd PID MESSAGEID
10955 ["collectd" "value": "v1" "plugin"="plugin_v" "plugin_instance"="plugin_instance_v"
10956 "type_instance"="type_instance_v" "type"="type_v" "ds_name"="ds_name_v" "interval"="interval_v" ]
10957 "host_tag_example"="host_tag_example_v" plugin_v.type_v.ds_name_v="v1"
10961 <166>1 ISOTIMESTAMP HOSTNAME collectd PID MESSAGEID STRUCTURED-DATA
10964 "time": time_as_epoch, "interval": interval_v, "plugin": "plugin_v",
10965 "plugin_instance": "plugin_instance_v", "type":"type_v",
10966 "type_instance": "type_instance_v", "plugin_v": {"type_v": v1}
10967 } , "host":"host_v", "host_tag_example": "host_tag_example_v"
10970 =item B<StoreRates> B<false>|B<true>
10972 If set to B<true>, convert counter values to rates. If set to B<false>
10973 (the default) counter values are stored as is, as an increasing
10976 =item B<AlwaysAppendDS> B<false>|B<true>
10978 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
10979 identifier. If set to B<false> (the default), this is only done when there is
10982 =item B<Prefix> I<String>
10984 When set, I<Prefix> is added to all metrics names as a prefix. It is intended in
10985 case you want to be able to define the source of the specific metric. Dots and
10986 whitespace are I<not> escaped in this string.
10990 =head2 Plugin C<xencpu>
10992 This plugin collects metrics of hardware CPU load for machine running Xen
10993 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
10994 Result is reported using the C<percent> type, for each CPU (core).
10996 This plugin doesn't have any options (yet).
10998 =head2 Plugin C<zookeeper>
11000 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
11001 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
11006 <Plugin "zookeeper">
11013 =item B<Host> I<Address>
11015 Hostname or address to connect to. Defaults to C<localhost>.
11017 =item B<Port> I<Service>
11019 Service name or port number to connect to. Defaults to C<2181>.
11023 =head1 THRESHOLD CONFIGURATION
11025 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
11026 we mean that the values are not only stored or sent somewhere, but that they
11027 are judged and, if a problem is recognized, acted upon. The only action
11028 collectd takes itself is to generate and dispatch a "notification". Plugins can
11029 register to receive notifications and perform appropriate further actions.
11031 Since systems and what you expect them to do differ a lot, you can configure
11032 B<thresholds> for your values freely. This gives you a lot of flexibility but
11033 also a lot of responsibility.
11035 Every time a value is out of range a notification is dispatched. This means
11036 that the idle percentage of your CPU needs to be less then the configured
11037 threshold only once for a notification to be generated. There's no such thing
11038 as a moving average or similar - at least not now.
11040 Also, all values that match a threshold are considered to be relevant or
11041 "interesting". As a consequence collectd will issue a notification if they are
11042 not received for B<Timeout> iterations. The B<Timeout> configuration option is
11043 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
11044 "2" (the default) and some hosts sends it's CPU statistics to the server every
11045 60 seconds, a notification will be dispatched after about 120 seconds. It may
11046 take a little longer because the timeout is checked only once each B<Interval>
11049 When a value comes within range again or is received after it was missing, an
11050 "OKAY-notification" is dispatched.
11052 Here is a configuration example to get you started. Read below for more
11065 <Plugin "interface">
11068 FailureMax 10000000
11082 WarningMin 100000000
11088 There are basically two types of configuration statements: The C<Host>,
11089 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
11090 configured. The C<Plugin> and C<Type> blocks may be specified further using the
11091 C<Instance> option. You can combine the block by nesting the blocks, though
11092 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
11093 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
11094 C<Type> may not contain other blocks. If multiple blocks apply to the same
11095 value the most specific block is used.
11097 The other statements specify the threshold to configure. They B<must> be
11098 included in a C<Type> block. Currently the following statements are recognized:
11102 =item B<FailureMax> I<Value>
11104 =item B<WarningMax> I<Value>
11106 Sets the upper bound of acceptable values. If unset defaults to positive
11107 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
11108 will be created. If the value is greater than B<WarningMax> but less than (or
11109 equal to) B<FailureMax> a B<WARNING> notification will be created.
11111 =item B<FailureMin> I<Value>
11113 =item B<WarningMin> I<Value>
11115 Sets the lower bound of acceptable values. If unset defaults to negative
11116 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
11117 be created. If the value is less than B<WarningMin> but greater than (or equal
11118 to) B<FailureMin> a B<WARNING> notification will be created.
11120 =item B<DataSource> I<DSName>
11122 Some data sets have more than one "data source". Interesting examples are the
11123 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
11124 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
11125 system load data set, C<load>, even has three data sources: C<shortterm>,
11126 C<midterm>, and C<longterm>.
11128 Normally, all data sources are checked against a configured threshold. If this
11129 is undesirable, or if you want to specify different limits for each data
11130 source, you can use the B<DataSource> option to have a threshold apply only to
11133 =item B<Invert> B<true>|B<false>
11135 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
11136 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
11137 B<WarningMax>) are not okay. Defaults to B<false>.
11139 =item B<Persist> B<true>|B<false>
11141 Sets how often notifications are generated. If set to B<true> one notification
11142 will be generated for each value that is out of the acceptable range. If set to
11143 B<false> (the default) then a notification is only generated if a value is out
11144 of range but the previous value was okay.
11146 This applies to missing values, too: If set to B<true> a notification about a
11147 missing value is generated once every B<Interval> seconds. If set to B<false>
11148 only one such notification is generated until the value appears again.
11150 =item B<Percentage> B<true>|B<false>
11152 If set to B<true>, the minimum and maximum values given are interpreted as
11153 percentage value, relative to the other data sources. This is helpful for
11154 example for the "df" type, where you may want to issue a warning when less than
11155 5E<nbsp>% of the total space is available. Defaults to B<false>.
11157 =item B<Hits> I<Number>
11159 Delay creating the notification until the threshold has been passed I<Number>
11160 times. When a notification has been generated, or when a subsequent value is
11161 inside the threshold, the counter is reset. If, for example, a value is
11162 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
11163 will be dispatched at most once every 30E<nbsp>seconds.
11165 This is useful when short bursts are not a problem. If, for example, 100% CPU
11166 usage for up to a minute is normal (and data is collected every
11167 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
11169 =item B<Hysteresis> I<Number>
11171 When set to non-zero, a hysteresis value is applied when checking minimum and
11172 maximum bounds. This is useful for values that increase slowly and fluctuate a
11173 bit while doing so. When these values come close to the threshold, they may
11174 "flap", i.e. switch between failure / warning case and okay case repeatedly.
11176 If, for example, the threshold is configures as
11181 then a I<Warning> notification is created when the value exceeds I<101> and the
11182 corresponding I<Okay> notification is only created once the value falls below
11183 I<99>, thus avoiding the "flapping".
11187 =head1 FILTER CONFIGURATION
11189 Starting with collectd 4.6 there is a powerful filtering infrastructure
11190 implemented in the daemon. The concept has mostly been copied from
11191 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
11192 terminology, so that users that are familiar with iptables feel right at home.
11196 The following are the terms used in the remainder of the filter configuration
11197 documentation. For an ASCII-art schema of the mechanism, see
11198 L<"General structure"> below.
11204 A I<match> is a criteria to select specific values. Examples are, of course, the
11205 name of the value or it's current value.
11207 Matches are implemented in plugins which you have to load prior to using the
11208 match. The name of such plugins starts with the "match_" prefix.
11212 A I<target> is some action that is to be performed with data. Such actions
11213 could, for example, be to change part of the value's identifier or to ignore
11214 the value completely.
11216 Some of these targets are built into the daemon, see L<"Built-in targets">
11217 below. Other targets are implemented in plugins which you have to load prior to
11218 using the target. The name of such plugins starts with the "target_" prefix.
11222 The combination of any number of matches and at least one target is called a
11223 I<rule>. The target actions will be performed for all values for which B<all>
11224 matches apply. If the rule does not have any matches associated with it, the
11225 target action will be performed for all values.
11229 A I<chain> is a list of rules and possibly default targets. The rules are tried
11230 in order and if one matches, the associated target will be called. If a value
11231 is handled by a rule, it depends on the target whether or not any subsequent
11232 rules are considered or if traversal of the chain is aborted, see
11233 L<"Flow control"> below. After all rules have been checked, the default targets
11238 =head2 General structure
11240 The following shows the resulting structure:
11247 +---------+ +---------+ +---------+ +---------+
11248 ! Rule !->! Match !->! Match !->! Target !
11249 +---------+ +---------+ +---------+ +---------+
11252 +---------+ +---------+ +---------+
11253 ! Rule !->! Target !->! Target !
11254 +---------+ +---------+ +---------+
11261 +---------+ +---------+ +---------+
11262 ! Rule !->! Match !->! Target !
11263 +---------+ +---------+ +---------+
11271 =head2 Flow control
11273 There are four ways to control which way a value takes through the filter
11280 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
11281 process the value with another chain. When the called chain finishes, usually
11282 the next target or rule after the jump is executed.
11286 The stop condition, signaled for example by the built-in target B<stop>, causes
11287 all processing of the value to be stopped immediately.
11291 Causes processing in the current chain to be aborted, but processing of the
11292 value generally will continue. This means that if the chain was called via
11293 B<Jump>, the next target or rule after the jump will be executed. If the chain
11294 was not called by another chain, control will be returned to the daemon and it
11295 may pass the value to another chain.
11299 Most targets will signal the B<continue> condition, meaning that processing
11300 should continue normally. There is no special built-in target for this
11307 The configuration reflects this structure directly:
11309 PostCacheChain "PostCache"
11310 <Chain "PostCache">
11311 <Rule "ignore_mysql_show">
11314 Type "^mysql_command$"
11315 TypeInstance "^show_"
11325 The above configuration example will ignore all values where the plugin field
11326 is "mysql", the type is "mysql_command" and the type instance begins with
11327 "show_". All other values will be sent to the C<rrdtool> write plugin via the
11328 default target of the chain. Since this chain is run after the value has been
11329 added to the cache, the MySQL C<show_*> command statistics will be available
11330 via the C<unixsock> plugin.
11332 =head2 List of configuration options
11336 =item B<PreCacheChain> I<ChainName>
11338 =item B<PostCacheChain> I<ChainName>
11340 Configure the name of the "pre-cache chain" and the "post-cache chain". The
11341 argument is the name of a I<chain> that should be executed before and/or after
11342 the values have been added to the cache.
11344 To understand the implications, it's important you know what is going on inside
11345 I<collectd>. The following diagram shows how values are passed from the
11346 read-plugins to the write-plugins:
11352 + - - - - V - - - - +
11353 : +---------------+ :
11356 : +-------+-------+ :
11359 : +-------+-------+ : +---------------+
11360 : ! Cache !--->! Value Cache !
11361 : ! insert ! : +---+---+-------+
11362 : +-------+-------+ : ! !
11363 : ! ,------------' !
11365 : +-------+---+---+ : +-------+-------+
11366 : ! Post-Cache +--->! Write-Plugins !
11367 : ! Chain ! : +---------------+
11368 : +---------------+ :
11370 : dispatch values :
11371 + - - - - - - - - - +
11373 After the values are passed from the "read" plugins to the dispatch functions,
11374 the pre-cache chain is run first. The values are added to the internal cache
11375 afterwards. The post-cache chain is run after the values have been added to the
11376 cache. So why is it such a huge deal if chains are run before or after the
11377 values have been added to this cache?
11379 Targets that change the identifier of a value list should be executed before
11380 the values are added to the cache, so that the name in the cache matches the
11381 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
11382 this cache to receive a list of all available values. If you change the
11383 identifier after the value list has been added to the cache, this may easily
11384 lead to confusion, but it's not forbidden of course.
11386 The cache is also used to convert counter values to rates. These rates are, for
11387 example, used by the C<value> match (see below). If you use the rate stored in
11388 the cache B<before> the new value is added, you will use the old, B<previous>
11389 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
11390 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
11393 Last but not last, the B<stop> target makes a difference: If the pre-cache
11394 chain returns the stop condition, the value will not be added to the cache and
11395 the post-cache chain will not be run.
11397 =item B<Chain> I<Name>
11399 Adds a new chain with a certain name. This name can be used to refer to a
11400 specific chain, for example to jump to it.
11402 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
11404 =item B<Rule> [I<Name>]
11406 Adds a new rule to the current chain. The name of the rule is optional and
11407 currently has no meaning for the daemon.
11409 Within the B<Rule> block, there may be any number of B<Match> blocks and there
11410 must be at least one B<Target> block.
11412 =item B<Match> I<Name>
11414 Adds a match to a B<Rule> block. The name specifies what kind of match should
11415 be performed. Available matches depend on the plugins that have been loaded.
11417 The arguments inside the B<Match> block are passed to the plugin implementing
11418 the match, so which arguments are valid here depends on the plugin being used.
11419 If you do not need any to pass any arguments to a match, you can use the
11424 Which is equivalent to:
11429 =item B<Target> I<Name>
11431 Add a target to a rule or a default target to a chain. The name specifies what
11432 kind of target is to be added. Which targets are available depends on the
11433 plugins being loaded.
11435 The arguments inside the B<Target> block are passed to the plugin implementing
11436 the target, so which arguments are valid here depends on the plugin being used.
11437 If you do not need any to pass any arguments to a target, you can use the
11442 This is the same as writing:
11449 =head2 Built-in targets
11451 The following targets are built into the core daemon and therefore need no
11452 plugins to be loaded:
11458 Signals the "return" condition, see the L<"Flow control"> section above. This
11459 causes the current chain to stop processing the value and returns control to
11460 the calling chain. The calling chain will continue processing targets and rules
11461 just after the B<jump> target (see below). This is very similar to the
11462 B<RETURN> target of iptables, see L<iptables(8)>.
11464 This target does not have any options.
11472 Signals the "stop" condition, see the L<"Flow control"> section above. This
11473 causes processing of the value to be aborted immediately. This is similar to
11474 the B<DROP> target of iptables, see L<iptables(8)>.
11476 This target does not have any options.
11484 Sends the value to "write" plugins.
11490 =item B<Plugin> I<Name>
11492 Name of the write plugin to which the data should be sent. This option may be
11493 given multiple times to send the data to more than one write plugin. If the
11494 plugin supports multiple instances, the plugin's instance(s) must also be
11499 If no plugin is explicitly specified, the values will be sent to all available
11502 Single-instance plugin example:
11508 Multi-instance plugin example:
11510 <Plugin "write_graphite">
11520 Plugin "write_graphite/foo"
11525 Starts processing the rules of another chain, see L<"Flow control"> above. If
11526 the end of that chain is reached, or a stop condition is encountered,
11527 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
11528 next target or the next rule. This is similar to the B<-j> command line option
11529 of iptables, see L<iptables(8)>.
11535 =item B<Chain> I<Name>
11537 Jumps to the chain I<Name>. This argument is required and may appear only once.
11549 =head2 Available matches
11555 Matches a value using regular expressions.
11561 =item B<Host> I<Regex>
11563 =item B<Plugin> I<Regex>
11565 =item B<PluginInstance> I<Regex>
11567 =item B<Type> I<Regex>
11569 =item B<TypeInstance> I<Regex>
11571 =item B<MetaData> I<String> I<Regex>
11573 Match values where the given regular expressions match the various fields of
11574 the identifier of a value. If multiple regular expressions are given, B<all>
11575 regexen must match for a value to match.
11577 =item B<Invert> B<false>|B<true>
11579 When set to B<true>, the result of the match is inverted, i.e. all value lists
11580 where all regular expressions apply are not matched, all other value lists are
11581 matched. Defaults to B<false>.
11588 Host "customer[0-9]+"
11594 Matches values that have a time which differs from the time on the server.
11596 This match is mainly intended for servers that receive values over the
11597 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
11598 is very sensitive to the timestamp used when updating the RRD files. In
11599 particular, the time must be ever increasing. If a misbehaving client sends one
11600 packet with a timestamp far in the future, all further packets with a correct
11601 time will be ignored because of that one packet. What's worse, such corrupted
11602 RRD files are hard to fix.
11604 This match lets one match all values B<outside> a specified time range
11605 (relative to the server's time), so you can use the B<stop> target (see below)
11606 to ignore the value, for example.
11612 =item B<Future> I<Seconds>
11614 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
11615 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
11618 =item B<Past> I<Seconds>
11620 Matches all values that are I<behind> of the server's time by I<Seconds> or
11621 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
11633 This example matches all values that are five minutes or more ahead of the
11634 server or one hour (or more) lagging behind.
11638 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
11639 values. If a data-set consists of more than one data-source, all data-sources
11640 must match the specified ranges for a positive match.
11646 =item B<Min> I<Value>
11648 Sets the smallest value which still results in a match. If unset, behaves like
11651 =item B<Max> I<Value>
11653 Sets the largest value which still results in a match. If unset, behaves like
11656 =item B<Invert> B<true>|B<false>
11658 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
11659 no-match is returned and vice versa. Please note that the B<Invert> setting
11660 only effects how B<Min> and B<Max> are applied to a specific value. Especially
11661 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
11663 =item B<DataSource> I<DSName> [I<DSName> ...]
11665 Select one or more of the data sources. If no data source is configured, all
11666 data sources will be checked. If the type handled by the match does not have a
11667 data source of the specified name(s), this will always result in no match
11668 (independent of the B<Invert> setting).
11670 =item B<Satisfy> B<Any>|B<All>
11672 Specifies how checking with several data sources is performed. If set to
11673 B<Any>, the match succeeds if one of the data sources is in the configured
11674 range. If set to B<All> the match only succeeds if all data sources are within
11675 the configured range. Default is B<All>.
11677 Usually B<All> is used for positive matches, B<Any> is used for negative
11678 matches. This means that with B<All> you usually check that all values are in a
11679 "good" range, while with B<Any> you check if any value is within a "bad" range
11680 (or outside the "good" range).
11684 Either B<Min> or B<Max>, but not both, may be unset.
11688 # Match all values smaller than or equal to 100. Matches only if all data
11689 # sources are below 100.
11695 # Match if the value of any data source is outside the range of 0 - 100.
11703 =item B<empty_counter>
11705 Matches all values with one or more data sources of type B<COUNTER> and where
11706 all counter values are zero. These counters usually I<never> increased since
11707 they started existing (and are therefore uninteresting), or got reset recently
11708 or overflowed and you had really, I<really> bad luck.
11710 Please keep in mind that ignoring such counters can result in confusing
11711 behavior: Counters which hardly ever increase will be zero for long periods of
11712 time. If the counter is reset for some reason (machine or service restarted,
11713 usually), the graph will be empty (NAN) for a long time. People may not
11718 Calculates a hash value of the host name and matches values according to that
11719 hash value. This makes it possible to divide all hosts into groups and match
11720 only values that are in a specific group. The intended use is in load
11721 balancing, where you want to handle only part of all data and leave the rest
11724 The hashing function used tries to distribute the hosts evenly. First, it
11725 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
11728 for (i = 0; host[i] != 0; i++)
11729 hash_value = (hash_value * 251) + host[i];
11731 The constant 251 is a prime number which is supposed to make this hash value
11732 more random. The code then checks the group for this host according to the
11733 I<Total> and I<Match> arguments:
11735 if ((hash_value % Total) == Match)
11740 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
11741 groups), then the least significant bit of the hash value will be the XOR of
11742 all least significant bits in the host name. One consequence is that when you
11743 have two hosts, "server0.example.com" and "server1.example.com", where the host
11744 name differs in one digit only and the digits differ by one, those hosts will
11745 never end up in the same group.
11751 =item B<Match> I<Match> I<Total>
11753 Divide the data into I<Total> groups and match all hosts in group I<Match> as
11754 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
11755 be smaller than I<Total>. I<Total> must be at least one, although only values
11756 greater than one really do make any sense.
11758 You can repeat this option to match multiple groups, for example:
11763 The above config will divide the data into seven groups and match groups three
11764 and five. One use would be to keep every value on two hosts so that if one
11765 fails the missing data can later be reconstructed from the second host.
11771 # Operate on the pre-cache chain, so that ignored values are not even in the
11776 # Divide all received hosts in seven groups and accept all hosts in
11780 # If matched: Return and continue.
11783 # If not matched: Return and stop.
11789 =head2 Available targets
11793 =item B<notification>
11795 Creates and dispatches a notification.
11801 =item B<Message> I<String>
11803 This required option sets the message of the notification. The following
11804 placeholders will be replaced by an appropriate value:
11812 =item B<%{plugin_instance}>
11816 =item B<%{type_instance}>
11818 These placeholders are replaced by the identifier field of the same name.
11820 =item B<%{ds:>I<name>B<}>
11822 These placeholders are replaced by a (hopefully) human readable representation
11823 of the current rate of this data source. If you changed the instance name
11824 (using the B<set> or B<replace> targets, see below), it may not be possible to
11825 convert counter values to rates.
11829 Please note that these placeholders are B<case sensitive>!
11831 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
11833 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
11840 <Target "notification">
11841 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
11847 Replaces parts of the identifier using regular expressions.
11853 =item B<Host> I<Regex> I<Replacement>
11855 =item B<Plugin> I<Regex> I<Replacement>
11857 =item B<PluginInstance> I<Regex> I<Replacement>
11859 =item B<TypeInstance> I<Regex> I<Replacement>
11861 =item B<MetaData> I<String> I<Regex> I<Replacement>
11863 =item B<DeleteMetaData> I<String> I<Regex>
11865 Match the appropriate field with the given regular expression I<Regex>. If the
11866 regular expression matches, that part that matches is replaced with
11867 I<Replacement>. If multiple places of the input buffer match a given regular
11868 expression, only the first occurrence will be replaced.
11870 You can specify each option multiple times to use multiple regular expressions
11878 # Replace "example.net" with "example.com"
11879 Host "\\<example.net\\>" "example.com"
11881 # Strip "www." from hostnames
11882 Host "\\<www\\." ""
11887 Sets part of the identifier of a value to a given string.
11893 =item B<Host> I<String>
11895 =item B<Plugin> I<String>
11897 =item B<PluginInstance> I<String>
11899 =item B<TypeInstance> I<String>
11901 =item B<MetaData> I<String> I<String>
11903 Set the appropriate field to the given string. The strings for plugin instance,
11904 type instance, and meta data may be empty, the strings for host and plugin may
11905 not be empty. It's currently not possible to set the type of a value this way.
11907 The following placeholders will be replaced by an appropriate value:
11915 =item B<%{plugin_instance}>
11919 =item B<%{type_instance}>
11921 These placeholders are replaced by the identifier field of the same name.
11923 =item B<%{meta:>I<name>B<}>
11925 These placeholders are replaced by the meta data value with the given name.
11929 Please note that these placeholders are B<case sensitive>!
11931 =item B<DeleteMetaData> I<String>
11933 Delete the named meta data field.
11940 PluginInstance "coretemp"
11941 TypeInstance "core3"
11946 =head2 Backwards compatibility
11948 If you use collectd with an old configuration, i.E<nbsp>e. one without a
11949 B<Chain> block, it will behave as it used to. This is equivalent to the
11950 following configuration:
11952 <Chain "PostCache">
11956 If you specify a B<PostCacheChain>, the B<write> target will not be added
11957 anywhere and you will have to make sure that it is called where appropriate. We
11958 suggest to add the above snippet as default target to your "PostCache" chain.
11962 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
11977 B<Ignorelists> are a generic framework to either ignore some metrics or report
11978 specific metrics only. Plugins usually provide one or more options to specify
11979 the items (mounts points, devices, ...) and the boolean option
11984 =item B<Select> I<String>
11986 Selects the item I<String>. This option often has a plugin specific name, e.g.
11987 B<Sensor> in the C<sensors> plugin. It is also plugin specific what this string
11988 is compared to. For example, the C<df> plugin's B<MountPoint> compares it to a
11989 mount point and the C<sensors> plugin's B<Sensor> compares it to a sensor name.
11991 By default, this option is doing a case-sensitive full-string match. The
11992 following config will match C<foo>, but not C<Foo>:
11996 If I<String> starts and ends with C</> (a slash), the string is compiled as a
11997 I<regular expression>. For example, so match all item starting with C<foo>, use
11998 could use the following syntax:
12002 The regular expression is I<not> anchored, i.e. the following config will match
12003 C<foobar>, C<barfoo> and C<AfooZ>:
12007 The B<Select> option may be repeated to select multiple items.
12009 =item B<IgnoreSelected> B<true>|B<false>
12011 If set to B<true>, matching metrics are I<ignored> and all other metrics are
12012 collected. If set to B<false>, matching metrics are I<collected> and all other
12013 metrics are ignored.
12020 L<collectd-exec(5)>,
12021 L<collectd-perl(5)>,
12022 L<collectd-unixsock(5)>,
12035 Florian Forster E<lt>octo@collectd.orgE<gt>